[Bio] / FigKernelPackages / Subsystem.pm Repository:
ViewVC logotype

Annotation of /FigKernelPackages/Subsystem.pm

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.81 - (view) (download) (as text)

1 : olson 1.76 #
2 :     # Copyright (c) 2003-2006 University of Chicago and Fellowship
3 :     # for Interpretations of Genomes. All Rights Reserved.
4 :     #
5 :     # This file is part of the SEED Toolkit.
6 :     #
7 :     # The SEED Toolkit is free software. You can redistribute
8 :     # it and/or modify it under the terms of the SEED Toolkit
9 :     # Public License.
10 :     #
11 :     # You should have received a copy of the SEED Toolkit Public License
12 :     # along with this program; if not write to the University of Chicago
13 :     # at info@ci.uchicago.edu or the Fellowship for Interpretation of
14 :     # Genomes at veronika@thefig.info or download a copy from
15 :     # http://www.theseed.org/LICENSE.TXT.
16 :     #
17 :    
18 : olson 1.1 package Subsystem;
19 :    
20 : olson 1.25 use Carp;
21 : olson 1.1 use FIG;
22 :    
23 : olson 1.10 use FIGAttributes;
24 :     use base 'FIGAttributes';
25 :    
26 : olson 1.12 use POSIX;
27 : olson 1.7 use DirHandle;
28 : olson 1.1 use Data::Dumper;
29 : olson 1.14 use File::Copy;
30 : olson 1.1 use File::Spec;
31 : olson 1.12 use IPC::Open2;
32 : parrello 1.77 use Tracer;
33 : olson 1.1
34 :     use strict;
35 :    
36 : parrello 1.73 =head1 Subsystem Manipulation
37 : olson 1.2
38 :     Any manipulation of subsystem data should happen through this interface.
39 : parrello 1.60 This allows us to assure ourselves that the relational tables that
40 :     mirror and index the subsystem data are kept up to date with the
41 : olson 1.2 canonical version of the subsystem information in the flat-files
42 :     kept in $FIG_Config::data/Subsystems.
43 :    
44 : olson 1.25 =head2 Objects.
45 :    
46 :     We define the following perl objects:
47 :    
48 :     Subsystem: represents a subsystem. It can be read from disk and
49 :     written to disk, and manipulated via its methods when in memory.
50 :    
51 :     If we were completely on the OO side of the world, we would also
52 :     define the following set of objects. However, we are not, so they are
53 :     only objects in a conceptual sense. They are implemented using the
54 : parrello 1.60 basic perl datatypes.
55 : olson 1.25
56 :     Role: represents a single role. A role has a name and an abbreviation.
57 :    
58 :     RoleSubset: represents a subset of available roles. A subset has a
59 :     name and a list of role names that comprise the subset.
60 :    
61 : olson 1.2 =head2 Thoughts on locking
62 :    
63 :     It is currently dangerous for multiple users to modify spreadsheets at once.
64 :     It will likely remain dangerous while the subsystem backend is fairly
65 :     stateless, as it is with the CGI mechanism.
66 :    
67 :     We'd like to make this a little safer. One mechanism might be to allow
68 :     a user to open a subsystem for modification, and others for readonly access.
69 :     For this to work we have to be able to tell which users is allowed; current
70 :     implementation uses the curator of the subsystem for this purpose.
71 :    
72 :     NB: This module does not currently attempt to handle locking or exclusion.
73 :     It is up to the caller (user application, CGI script, etc) to do so.
74 :     It does attempt to use locking internally where appropriate.
75 :    
76 :     =head2 Data structures
77 :    
78 :     We maintain the following data structures (all members of %$self).
79 :    
80 :     =over 4
81 :    
82 :     =item dir
83 :    
84 :     Directory in which the subsystem is stored.
85 :    
86 :     =item notes
87 :    
88 :     The current notes contents for the subsystem
89 :    
90 :     =item version
91 :    
92 :     Current subsystem version.
93 :    
94 :     =item exchangable
95 :    
96 :     1 if subsystem is exchangable, 0 otherwise.
97 :    
98 :     =item roles
99 :    
100 : olson 1.25 List of role names.
101 : olson 1.2
102 :     =item role_index
103 :    
104 :     hash that maps from role name to index
105 :    
106 :     =item role_abbrs
107 :    
108 :     list of role abbreviations
109 :    
110 :     =item abbr
111 :    
112 :     hash mapping from role abbreviation to role name
113 :    
114 :     =item col_subsets
115 :    
116 :     list of column subset names
117 :    
118 :     =item col_subset_members
119 :    
120 :     hash that maps from column subset name to subset members
121 :    
122 :     =item col_active_subset
123 :    
124 :     currently-active column subset
125 :    
126 :     =item row_active_subset
127 :    
128 :     currently-active row subset
129 :    
130 :     =item genome
131 :    
132 : olson 1.25 List of genome IDs.
133 : olson 1.2
134 :     =item variant_code
135 :    
136 : olson 1.25 List of variant codes.
137 : olson 1.2
138 :     =item genome_index
139 :    
140 :     Hash mapping from genome ID to genome index.
141 :    
142 :     =item spreadsheet
143 :    
144 :     Spreadsheet data. Structured as a list of rows, each of which
145 :     is a list of entries. An entry is a list of PEG numbers.
146 :    
147 :     =item spreadsheet_inv
148 :    
149 :     Inverted structure of spreadsheet - list of columns, each of which is a list
150 :     of rows.
151 :    
152 :     =back
153 :    
154 : parrello 1.73 =head2 Public Methods
155 : olson 1.25
156 : parrello 1.73 =head3 new
157 : olson 1.25
158 : parrello 1.73 C<< my $sub = Subsystem->new($subName, $fig, $createFlag); >>
159 : olson 1.25
160 : parrello 1.73 Load the subsystem. If it does not exist, and $createFlag is true, create
161 :     a new, empty subsystem.
162 : olson 1.25
163 : parrello 1.73 =over 4
164 : olson 1.25
165 : parrello 1.73 =item subName
166 : olson 1.25
167 : parrello 1.73 Name of the desired subsystem.
168 : olson 1.25
169 : parrello 1.73 =item fig
170 : olson 1.25
171 : parrello 1.73 FIG object for accessing the SEED data store.
172 : olson 1.25
173 : parrello 1.73 =item createFlag
174 : overbeek 1.31
175 : parrello 1.73 TRUE if an empty subsystem should be created with the given name, else FALSE. If a
176 :     subsystem with the name already exists, this parameter has no effect.
177 : olson 1.25
178 :     =back
179 :    
180 : olson 1.2 =cut
181 : olson 1.1
182 :     sub new
183 :     {
184 :     my($class, $name, $fig, $create) = @_;
185 :    
186 :     my $ssa_dir = get_dir_from_name($name);
187 :     #
188 :     # For loading, the subsystem directory must already exist.
189 :     #
190 : parrello 1.60
191 : olson 1.25 if (! -d $ssa_dir and not $create)
192 : olson 1.1 {
193 : parrello 1.69 # warn "Subsystem $name does not exist\n";
194 :     return undef;
195 : olson 1.1 }
196 : olson 1.56
197 : redwards 1.72 # RAE: Please do this:
198 :     $name =~ s/^\s+//; $name =~ s/\s+$//;
199 : olson 1.56 $name =~ s/ /_/g;
200 :    
201 : olson 1.1 my $self = {
202 : parrello 1.69 dir => $ssa_dir,
203 :     name => $name,
204 :     fig => $fig,
205 : olson 1.1 };
206 :    
207 :     bless($self, $class);
208 :    
209 : olson 1.70 #
210 :     # Check to see if the database we're running against has a variant column.
211 :     #
212 :     $self->detect_db_version();
213 :    
214 : olson 1.25 if ($create)
215 :     {
216 : parrello 1.69 $self->create_subsystem();
217 : olson 1.25 }
218 :     else
219 :     {
220 : parrello 1.69 $self->load();
221 : olson 1.25 }
222 : olson 1.1
223 :     return $self;
224 :     }
225 :    
226 : olson 1.70 sub detect_db_version
227 :     {
228 :     my($self) = @_;
229 :     my $db = $self->{fig}->db_handle();
230 :     my $dbh = $db->{_dbh};
231 :     local $dbh->{RaiseError} = 1;
232 :     local $dbh->{PrintError} = 0;
233 :    
234 :     eval {
235 :     my $x = $db->SQL("select variant from subsystem_index where subsystem = '' limit 1");
236 :     };
237 :    
238 :     #
239 :     # If this failed, it's an old database.
240 :     #
241 :     if ($@ =~ /variant/)
242 :     {
243 :     warn "Please rerun index_subsystems: current table does not have a variant column\n";
244 :     $self->{old_database} = 1;
245 :     }
246 :     }
247 :    
248 :    
249 : olson 1.19 sub new_from_dir
250 :     {
251 :     my($class, $dir, $fig) = @_;
252 :    
253 :     my $ssa_dir = $dir;
254 : olson 1.29 my $name = $dir;
255 :     $name =~ s,.*/,,;
256 : olson 1.19
257 :     #
258 :     # For loading, the subsystem directory must already exist.
259 :     #
260 : parrello 1.60
261 : olson 1.19 my $self = {
262 : parrello 1.69 dir => $ssa_dir,
263 :     name => $name,
264 :     fig => $fig,
265 : olson 1.19 };
266 :    
267 :     bless($self, $class);
268 :    
269 :     $self->load();
270 :    
271 :     return $self;
272 :     }
273 :    
274 : parrello 1.73 =head3 create_subsystem
275 : olson 1.25
276 :     Create a new subsystem. This creates the subsystem directory in the
277 :     correct place ($FIG_Config::data/Subsystems), and populates it with
278 :     the correct initial data.
279 :    
280 :     =cut
281 :    
282 : olson 1.1 sub create_subsystem
283 :     {
284 : olson 1.25 my($self) = @_;
285 :    
286 :     my $dir = $self->{dir};
287 :     my $fig = $self->{fig};
288 :    
289 :     if (-d $dir)
290 :     {
291 : parrello 1.69 warn "Not creating: Subsystem directory $dir already exists";
292 :     return;
293 : olson 1.25 }
294 :    
295 :     $fig->verify_dir($dir);
296 :    
297 :     #
298 :     # Initialize empty data structures.
299 :     #
300 : parrello 1.60
301 : olson 1.25 $self->{genome} = [];
302 :     $self->{genome_index} = {};
303 :     $self->{variant_code} = [];
304 :    
305 :     $self->{abbr} = {};
306 :     $self->{role_index} = {};
307 :     $self->{roles} = [];
308 :     $self->{role_abbrs} = [];
309 : olson 1.1
310 : olson 1.25 $self->{spreadsheet} = [];
311 :     $self->{spreadsheet_inv} = [];
312 :    
313 :     $self->{col_subsets} = [];
314 :     $self->{col_subset_members} = {};
315 :    
316 : overbeek 1.31 $self->{row_subsets} = [];
317 :     $self->{row_subset_members} = {};
318 : overbeek 1.35 $self->load_row_subsets();
319 : overbeek 1.31
320 : olson 1.25 $self->{row_active_subset} = "All";
321 :     $self->{col_active_subset} = "All";
322 :    
323 :     $self->{version} = 0;
324 :     $self->{exchangable} = 0;
325 : overbeek 1.45 $self->{classification} = [];
326 : olson 1.25
327 :     $self->write_subsystem();
328 : olson 1.1 }
329 :    
330 : parrello 1.75 =head3 get_diagrams
331 :    
332 :     C<< my @list = $sub->get_diagrams(); >>
333 :    
334 :     Return a list of the diagrams associated with this subsystem. Each diagram
335 :     is represented in the return list as a 4-tuple C<[diagram_id, diagram_name,
336 :     page_link, img_link]> where
337 :    
338 :     =over 4
339 :    
340 :     =item diagram_id
341 :    
342 :     ID code for this diagram.
343 :    
344 :     =item diagram_name
345 :    
346 :     Displayable name of the diagram.
347 :    
348 :     =item page_link
349 :    
350 :     URL of an HTML page containing information about the diagram.
351 :    
352 :     =item img_link
353 :    
354 :     URL of an HTML page containing an image for the diagram.
355 :    
356 :     =back
357 : olson 1.7
358 : parrello 1.75 Note that the URLs are in fact for CGI scripts with parameters that point them
359 :     to the correct place.
360 : olson 1.7
361 : parrello 1.75 =cut
362 : olson 1.61
363 : parrello 1.75 sub get_diagrams {
364 :     # Get the parameters.
365 :     my ($self) = @_;
366 :     # Look for all the sub-directories in the subsystem's diagram directory. Each
367 :     # one of these will be a diagram ID. If the diagram directory doesn't exist,
368 :     # we'll get an empty list.
369 :     my @ids = GetDiagramIDs($self->{dir});
370 :     # Declare the return variable.
371 : olson 1.61 my @ret;
372 : parrello 1.75 # Loop through the diagram IDs found (if any).
373 :     for my $id (@ids) {
374 :     # Get the name and URLs for this diagram.
375 : parrello 1.69 my(@diag) = $self->get_diagram($id);
376 : parrello 1.75 # If we found a name and URLs, then this diagram must be added to the
377 :     # return list.
378 :     if (@diag) {
379 : parrello 1.69 push(@ret, [$id, @diag]);
380 :     }
381 : olson 1.61 }
382 : parrello 1.75 # Return the list of diagrams.
383 : olson 1.61 return @ret;
384 :     }
385 :    
386 : parrello 1.75 =head3 get_diagram
387 :    
388 :     C<< my ($name, $pageURL, $imgURL) = $sub->get_diagram($id); >>
389 :    
390 :     Get the information (if any) for the specified diagram. The diagram corresponds
391 :     to a subdirectory of the subsystem's C<diagrams> directory. For example, if the
392 :     diagram ID is C<d03>, the diagram's subdirectory would be C<$dir/diagrams/d03>,
393 :     where I<$dir> is the subsystem directory. The diagram's name is extracted from
394 :     a tiny file containing the name, and then the links are computed using the
395 :     subsystem name and the diagram ID. The parameters are as follows.
396 :    
397 :     =over 4
398 :    
399 :     =item id
400 :    
401 :     ID code for the desired diagram.
402 :    
403 :     =item RETURN
404 :    
405 :     Returns a three-element list. The first element is the diagram name, the second
406 :     a URL for displaying information about the diagram, and the third a URL for
407 :     displaying the diagram image.
408 :    
409 :     =back
410 :    
411 :     =cut
412 :    
413 : olson 1.61 sub get_diagram
414 :     {
415 :     my($self, $id) = @_;
416 :    
417 : parrello 1.75 my $name = GetDiagramName($self->{dir}, $id);
418 :     my ($link, $img_link) = ComputeDiagramURLs($self->{name}, $id);
419 : olson 1.61
420 :     return($name, $link, $img_link);
421 :     }
422 :    
423 : olson 1.66 sub get_diagram_html_file
424 :     {
425 :     my($self, $id) = @_;
426 :    
427 :     my $ddir = "$self->{dir}/diagrams/$id";
428 :    
429 :     return unless -d $ddir;
430 :    
431 :     my $html = "$ddir/diagram.html";
432 :    
433 :     if (-f $html)
434 :     {
435 : parrello 1.69 return $html;
436 : olson 1.66 }
437 :     else
438 :     {
439 : parrello 1.69 return undef;
440 : olson 1.66 }
441 :     }
442 :    
443 : olson 1.61 sub open_diagram_image
444 :     {
445 :     my($self, $id) = @_;
446 :    
447 :     my $img_base = "$self->{dir}/diagrams/$id/diagram";
448 :    
449 :     my @types = ([".png", "image/png"],
450 : parrello 1.69 [".gif", "image/gif"],
451 :     [".jpg", "image/jpeg"]);
452 : olson 1.61
453 :     for my $tent (@types)
454 :     {
455 : parrello 1.69 my($ext, $type) = @$tent;
456 : olson 1.61
457 : parrello 1.69 my $file = "$img_base$ext";
458 : olson 1.61
459 : parrello 1.69 if (open(my $fh, "<$file"))
460 :     {
461 :     return($type, $fh);
462 :     }
463 : olson 1.61 }
464 :    
465 :     return undef;
466 :     }
467 : olson 1.7
468 : olson 1.61 sub delete_diagram
469 :     {
470 :     my($self, $id) = @_;
471 : parrello 1.60
472 : olson 1.61 my $dir = "$self->{dir}/diagrams/$id";
473 : olson 1.7
474 : olson 1.61 if (-d $dir)
475 :     {
476 : parrello 1.69 system("rm", "-r", $dir);
477 : olson 1.61 }
478 : olson 1.7 }
479 :    
480 : olson 1.61 sub rename_diagram
481 : olson 1.7 {
482 : olson 1.61 my($self, $id, $new_name) = @_;
483 : olson 1.7
484 : olson 1.61 my $dir = "$self->{dir}/diagrams/$id";
485 : olson 1.7
486 :     if (-d $dir)
487 :     {
488 : parrello 1.69 open(F, ">$dir/NAME");
489 :     $new_name =~ s/\n.*$//s;
490 :     print F "$new_name\n";
491 :     close(F);
492 : olson 1.61 }
493 :     }
494 :    
495 :     sub create_new_diagram
496 :     {
497 : olson 1.65 my($self, $fh, $html_fh, $name, $id) = @_;
498 : olson 1.61
499 :     #
500 :     # Get a new id.
501 :     #
502 :    
503 :     my $dir = "$self->{dir}/diagrams";
504 :    
505 :     &FIG::verify_dir($dir);
506 :    
507 :     my $path;
508 :    
509 :     if (defined($id))
510 :     {
511 : parrello 1.69 #
512 :     # Ensure this id doesn't already exist.
513 :     #
514 :    
515 :     $path = "$dir/$id";
516 :    
517 :     if (-d $path)
518 :     {
519 :     confess "Diagram id $id already exists in subsystem $self->{name}";
520 :     }
521 : olson 1.61
522 : olson 1.7 }
523 :     else
524 :     {
525 : parrello 1.69 $id = "d01";
526 : olson 1.61
527 : parrello 1.69 while (1)
528 :     {
529 :     $path = "$dir/$id";
530 :     last unless -e $path;
531 :     $id++;
532 :     }
533 : olson 1.61 }
534 :    
535 :     &FIG::verify_dir($path);
536 :    
537 :     if ($name)
538 :     {
539 : parrello 1.69 open(F, ">$path/NAME");
540 :     $name =~ s/\n.*$//s;
541 :     print F "$name\n";
542 :     close(F);
543 : olson 1.61 }
544 :    
545 :     #
546 :     # Write the file if we have one.
547 :     #
548 :    
549 :     if ($fh)
550 :     {
551 : parrello 1.69 my($ext, $buf);
552 : parrello 1.73
553 : parrello 1.69 if (read($fh, $buf, 4096))
554 :     {
555 :     my($ext) = $self->classify_image_type($buf);
556 :     open(D, ">$path/diagram$ext");
557 :     print D $buf;
558 : parrello 1.73
559 : parrello 1.69 while (read($fh, $buf, 4096))
560 :     {
561 :     print D $buf;
562 :     }
563 :     close(D);
564 :     }
565 :     close($fh);
566 : olson 1.7 }
567 : olson 1.65
568 :     #
569 :     # And write the HTML file if we have one.
570 :     #
571 :     if ($html_fh)
572 :     {
573 : parrello 1.69 my $buf;
574 :     open(D, ">$path/diagram.html");
575 : parrello 1.73
576 : parrello 1.69 while (read($html_fh, $buf, 4096))
577 :     {
578 :     print D $buf;
579 :     }
580 :     close(D);
581 :     close($html_fh);
582 : olson 1.65 }
583 : olson 1.7 }
584 : parrello 1.60
585 : olson 1.65 sub upload_new_image
586 :     {
587 :     my($self, $id, $fh) = @_;
588 :    
589 : olson 1.67 if (!$fh)
590 :     {
591 : parrello 1.69 warn "Subsystem::upload_new_image aborting: fh is undef\n";
592 :     return;
593 : olson 1.67 }
594 :    
595 : olson 1.65
596 :     my $dir = "$self->{dir}/diagrams/$id";
597 :    
598 : olson 1.67 if (not -d $dir)
599 :     {
600 : parrello 1.69 warn "Subsystem::upload_new_image aborting: $dir does not exist\n";
601 :     return;
602 : olson 1.67 }
603 : olson 1.65
604 :     #
605 :     # remove any old diagram images.
606 :     #
607 :    
608 :     for my $path (<$dir/diagram.{png,gif,jpg}>)
609 :     {
610 : parrello 1.69 unlink($path);
611 : olson 1.65 }
612 :    
613 :     my($ext, $buf);
614 : parrello 1.73
615 : olson 1.65 if (read($fh, $buf, 4096))
616 :     {
617 : parrello 1.69 my($ext) = $self->classify_image_type($buf);
618 : olson 1.67
619 : parrello 1.69 if (!open(D, ">$dir/diagram$ext"))
620 :     {
621 :     warn "Subsystem::upload_new_image open failed for $dir/diagram$ext: $!\n";
622 :     close($fh);
623 :     return;
624 :     }
625 :    
626 :     warn "Subsystem::upload_new_image classified new image as $ext\n";
627 :     print D $buf;
628 : parrello 1.73
629 : parrello 1.69 while (read($fh, $buf, 4096))
630 :     {
631 :     print D $buf;
632 :     }
633 :     close(D);
634 : olson 1.65 }
635 : olson 1.67 else
636 :     {
637 : parrello 1.69 warn "Subsystem::upload_new_image read failed for $fh: $!\n";
638 : olson 1.67 }
639 :    
640 :     warn "Subsystem::upload_new_image complete: " . `/bin/ls -l '$dir'`;
641 :    
642 : olson 1.65 close($fh);
643 :     }
644 :    
645 :     sub upload_new_html
646 :     {
647 :     my($self, $id, $fh) = @_;
648 :    
649 : olson 1.67 if (!$fh)
650 :     {
651 : parrello 1.69 warn "Subsystem::upload_new_html aborting: fh is undef\n";
652 :     return;
653 : olson 1.67 }
654 : olson 1.65
655 :     my $dir = "$self->{dir}/diagrams/$id";
656 :    
657 : olson 1.67 if (not -d $dir)
658 :     {
659 : parrello 1.69 warn "Subsystem::upload_new_html aborting: $dir does not exist\n";
660 :     return;
661 : olson 1.67 }
662 : olson 1.65
663 :     my($buf);
664 :    
665 : olson 1.67 if (!open(D, ">$dir/diagram.html"))
666 :     {
667 : parrello 1.69 warn "Subsystem::upload_new_html open failed for $dir/diagram.html: $!\n";
668 :     return;
669 : olson 1.67 }
670 : olson 1.65
671 : olson 1.67 my $rc;
672 :     while ($rc = read($fh, $buf, 4096))
673 : olson 1.65 {
674 : parrello 1.69 print D $buf;
675 : olson 1.65 }
676 : olson 1.67 if (!defined($rc))
677 :     {
678 : parrello 1.69 warn "Subsystem::upload_new_html read failed for $fh: $!\n";
679 : olson 1.67 }
680 :    
681 :     warn "Subsystem::upload_new_html complete: " . `/bin/ls -l '$dir'`;
682 :    
683 : olson 1.65 close(D);
684 :     close($fh);
685 :     }
686 :    
687 :     sub classify_image_type
688 :     {
689 :     my($self, $buf) = @_;
690 :    
691 :     my $ext;
692 : parrello 1.73
693 : olson 1.65 #
694 :     # Determine file type, for PNG / JPG / GIF. If we could be assured
695 :     # the ImageMagick identify app worked properly, we'd use that instead.
696 :     #
697 :     # Maybe later.
698 :     #
699 : parrello 1.73
700 : olson 1.65 if (substr($buf, 0, 8) eq "\x89\x50\x4e\x47\x0d\x0a\x1a\x0a")
701 :     {
702 : parrello 1.69 $ext = ".png";
703 : olson 1.65 }
704 :     elsif (substr($buf, 0, 3) eq "GIF")
705 :     {
706 : parrello 1.69 $ext = ".gif";
707 : olson 1.65 }
708 :     elsif (substr($buf, 0, 2) eq "\xff\xd8" and substr($buf, 6, 4) eq "JFIF")
709 :     {
710 : parrello 1.69 $ext = ".jpg";
711 : olson 1.65 }
712 :     else
713 :     {
714 : parrello 1.69 warn "Unknown file type in new diagram\n";
715 :     $ext = ".png";
716 : olson 1.65 }
717 :    
718 :     return $ext;
719 :     }
720 :    
721 :    
722 : olson 1.7 #
723 : olson 1.5 # Synchronize the database index for this subsystem to the
724 :     # subsystem data.
725 :     #
726 :     # We assume the table already exists.
727 : parrello 1.60 #
728 : olson 1.5
729 :     sub db_sync
730 :     {
731 :     my($self, $skip_delete) = @_;
732 :    
733 :     my $rdbH = $self->{fig}->db_handle();
734 :    
735 :     if (!$skip_delete)
736 :     {
737 : parrello 1.69 $self->delete_indices();
738 : olson 1.5 }
739 :    
740 : olson 1.57 my $tmp = "$FIG_Config::temp/ixsub.$$";
741 :     open(TMP, ">$tmp") or die "Cannot open tmpfile $tmp: $!\n";
742 :    
743 : olson 1.5 #
744 :     # We run thru all the cells, writing an entry in the database for the peg/subsystem/role.
745 :     #
746 :    
747 : olson 1.70 # my $sth = $rdbH->{_dbh}->prepare("INSERT INTO subsystem_index values(?, ?, ?, ?)");
748 : olson 1.6
749 : olson 1.70 my @roles = $self->get_roles();
750 :     for my $genome ($self->get_genomes())
751 : olson 1.5 {
752 : olson 1.70 my $gidx = $self->get_genome_index($genome);
753 :     my $variant = $self->get_variant_code($gidx);
754 : olson 1.71 # print "Index $genome variant=$variant\n";
755 : olson 1.70 my $row = $self->get_row($gidx);
756 :    
757 :     for my $i (0..$#$row)
758 :     {
759 :     my $cell = $row->[$i];
760 :     my $role = $roles[$i];
761 :     if ($cell)
762 :     {
763 :     for my $peg (@$cell)
764 :     {
765 :     # $sth->execute($peg, $self->{name}, $role);
766 :     if ($self->{old_database})
767 :     {
768 :     print TMP "$peg\t$self->{name}\t$role\n";
769 :     }
770 :     else
771 :     {
772 :     print TMP "$peg\t$self->{name}\t$role\t$variant\n";
773 :     }
774 :     }
775 :     }
776 :     }
777 : olson 1.5 }
778 : olson 1.57 close(TMP);
779 :     $rdbH->load_table(file => $tmp,
780 : parrello 1.69 tbl => 'subsystem_index');
781 : olson 1.5 }
782 :    
783 : olson 1.22 #
784 :     # Delete this subsystem's entries from the database index.
785 :     #
786 :     sub delete_indices
787 :     {
788 :     my($self) = @_;
789 :    
790 :     my $rdbH = $self->{fig}->db_handle();
791 :    
792 : olson 1.70 $rdbH->SQL("DELETE FROM subsystem_index where subsystem = ?", undef, $self->{name});
793 : olson 1.22 }
794 :    
795 : olson 1.1 sub load
796 :     {
797 :     my($self) = @_;
798 :    
799 :     #
800 :     # Load the subsystem.
801 :     #
802 :    
803 :     my $ssa;
804 :     if (!open($ssa,"<$self->{dir}/spreadsheet"))
805 :     {
806 : parrello 1.69 warn "Spreadsheet does not exist in subsystem\n";
807 :     return;
808 : olson 1.1 }
809 :    
810 :     local $/ = "//\n";
811 :    
812 :     my $roles = <$ssa>;
813 :     if ($roles)
814 :     {
815 : parrello 1.69 $roles =~ s,$/$,,;
816 :     #
817 :     # Split on newline, filter for non-empty lines.
818 :     #
819 :     my @roles = split("\n", $roles);
820 : parrello 1.60
821 : parrello 1.69 @roles = grep { $_ ne "" } @roles;
822 : parrello 1.60
823 : parrello 1.69 $self->load_roles(@roles);
824 : olson 1.1 }
825 :    
826 :     my $subsets = <$ssa>;
827 :     if ($subsets)
828 :     {
829 : parrello 1.69 $subsets =~ s,$/$,,;
830 :     $self->load_subsets($subsets);
831 : olson 1.1 }
832 :    
833 :     $/ = "\n";
834 :    
835 : overbeek 1.35 $self->load_row_subsets();
836 : olson 1.1 $self->load_genomes($ssa);
837 :    
838 :     #
839 :     # Now load the rest of the info.
840 :     #
841 :    
842 : overbeek 1.58 $self->load_reactions();
843 : olson 1.1 $self->load_notes();
844 : redwards 1.44 $self->load_classification();
845 : olson 1.1 $self->load_version();
846 :     $self->load_exchangable();
847 : olson 1.17 $self->load_curation();
848 : olson 1.1 }
849 :    
850 :     sub load_notes
851 :     {
852 :     my($self) = @_;
853 :    
854 :     $self->{notes} = &FIG::file_read(File::Spec->catfile($self->{dir}, "notes"));
855 :     }
856 :    
857 : overbeek 1.58 sub load_reactions
858 :     {
859 :     my($self) = @_;
860 :    
861 :     my $reactions = undef;
862 :     if (open(REACT,"<$self->{dir}/reactions"))
863 :     {
864 : parrello 1.69 while (defined($_ = <REACT>))
865 :     {
866 :     if ($_ =~ /^(\S.*\S)\t(\S+)/)
867 :     {
868 :     push(@{$reactions->{$1}},split(/,\s*/,$2));
869 :     }
870 :     }
871 :     close(REACT);
872 : overbeek 1.58 }
873 :    
874 :     $self->{reactions} = $reactions;
875 :     }
876 :    
877 :    
878 :    
879 :    
880 : redwards 1.44 sub load_classification
881 :     {
882 :     my($self) = @_;
883 :    
884 :     my $class = &FIG::file_read(File::Spec->catfile($self->{dir}, "CLASSIFICATION"));
885 :     if ($class) {$self->{classification} = [split /\t/, $class]} else {$self->{classification} = ['', '', '']}
886 :     }
887 :    
888 : olson 1.17 sub load_curation
889 :     {
890 :     my($self) = @_;
891 :    
892 : overbeek 1.47 # my @l = &FIG::file_head(File::Spec->catfile($self->{dir}, "curation.log"), 1);
893 :     #
894 :     # $_ = $l[0];
895 :     # chomp;
896 : olson 1.17
897 : overbeek 1.47 if (open(LOG,"<$self->{dir}/curation.log"))
898 : olson 1.17 {
899 : parrello 1.69 while (defined($_ = <LOG>))
900 :     {
901 :     if (/^\d+\t(\S+)\s+started/)
902 :     {
903 :     $self->{curator} = $1;
904 :     }
905 :     }
906 :     close(LOG);
907 : olson 1.17 }
908 :     }
909 :    
910 : olson 1.1 sub load_version
911 :     {
912 :     my($self) = @_;
913 :    
914 :     my @l = &FIG::file_head(File::Spec->catfile($self->{dir}, "VERSION"), 1);
915 :     my $l = $l[0];
916 :     chomp $l;
917 :     $self->{version} = $l;
918 :     }
919 :    
920 :     sub load_exchangable
921 :     {
922 :     my($self) = @_;
923 :    
924 :     my $file = File::Spec->catfile($self->{dir}, "EXCHANGABLE");
925 :    
926 :     if (-f $file)
927 :     {
928 : parrello 1.69 my($l, @l);
929 : olson 1.1
930 : parrello 1.69 @l = &FIG::file_head($file, 1);
931 :     $l = $l[0];
932 :     chomp $l;
933 :     $self->{exchangable} = $l;
934 : olson 1.1 }
935 :     else
936 :     {
937 : parrello 1.69 $self->{exchangable} = 0;
938 : olson 1.1 }
939 :     }
940 :    
941 :    
942 :     sub load_roles
943 :     {
944 :     my($self, @roles) = @_;
945 :    
946 : olson 1.5 $self->{abbr} = {};
947 :     $self->{role_index} = {};
948 :     $self->{roles} = [];
949 :     $self->{role_abbrs} = [];
950 :    
951 : olson 1.25 my $i = 0;
952 : olson 1.1 for my $role (@roles)
953 :     {
954 : parrello 1.69 my($abbr, $name) = split(/\t/, $role);
955 :     $abbr =~ s/^\s+//;
956 :     $abbr =~ s/\s+$//;
957 :     $name =~ s/^\s+//;
958 :     $name =~ s/\s+$//;
959 :     # print "Role $i: abbr=$abbr name=$name\n";
960 :    
961 :     $self->{abbr}->{$abbr} = $name;
962 :     $self->{role_index}->{$name} = $i;
963 :     $self->{roles}->[$i] = $name;
964 :     $self->{role_abbrs}->[$i] = $abbr;
965 :     $i++;
966 : olson 1.1 }
967 :     }
968 : parrello 1.60
969 : olson 1.1 sub load_subsets
970 :     {
971 :     my($self, $subsets) = @_;
972 :    
973 :     #
974 :     # Column and row subsets.
975 :     #
976 :     my($subsetsC, $subsetsR) = split(/\n\n/, $subsets);
977 :    
978 :     #
979 :     # Handle column subsets.
980 :     #
981 :    
982 :     my @subsetsC = split(/\n/, $subsetsC);
983 :    
984 :     #
985 :     # Determine active subset.
986 :     #
987 :    
988 :     my $active_subsetC;
989 :     if (@subsetsC > 0)
990 :     {
991 : parrello 1.69 $active_subsetC = pop(@subsetsC);
992 : olson 1.1 }
993 :     else
994 :     {
995 : parrello 1.69 $active_subsetC = 'All';
996 : olson 1.1 }
997 :    
998 :     $self->{col_active_subset} = $active_subsetC;
999 :    
1000 :     $self->{col_subsets} = [];
1001 : olson 1.5 $self->{col_subset_members} = {};
1002 : parrello 1.60
1003 : olson 1.1 for my $subset (@subsetsC)
1004 :     {
1005 : parrello 1.69 my($name, @members) = split(/\s+/, $subset);
1006 : olson 1.1
1007 : parrello 1.69 #
1008 :     # File format has members 1-based.
1009 :     #
1010 :    
1011 :     @members = map { $_ - 1 } @members;
1012 :    
1013 :     push(@{$self->{col_subsets}}, $name);
1014 :    
1015 :     #
1016 :     # Map role members from name to index if necessary.
1017 :     #
1018 :     # Is it really necessary? ssa2 code was looking up in %pos for this.
1019 :     #
1020 :     @members = map {
1021 :     if (my $new = $self->{role_index}->{$_})
1022 :     {
1023 :     $new;
1024 :     }
1025 :     else
1026 :     {
1027 :     $_;
1028 :     }
1029 :     } @members;
1030 : olson 1.1
1031 : parrello 1.69 @{$self->{col_subset_members}->{$name}} = @members;
1032 : olson 1.1 }
1033 :    
1034 :     #
1035 :     # Now the row subsets.
1036 :     #
1037 :    
1038 :     chomp($subsetsR);
1039 :    
1040 :     if ($subsetsR =~ /(\S+.*\S+)/)
1041 :     {
1042 : parrello 1.69 $self->{row_active_subset} = $1;
1043 : olson 1.1 }
1044 :     else
1045 :     {
1046 : parrello 1.69 $self->{row_active_subset} = 'All';
1047 : olson 1.1 }
1048 : overbeek 1.35 $self->{row_subsets} = [];
1049 : olson 1.1 }
1050 :    
1051 :     sub load_genomes
1052 :     {
1053 :     my($self, $fh) = @_;
1054 :     my(%seen);
1055 :    
1056 : olson 1.5 $self->{spreadsheet} = [];
1057 : olson 1.29 $self->{spreadsheet_inv} = [];
1058 : olson 1.5 $self->{genome} = [];
1059 :     $self->{genome_index} = {};
1060 :     $self->{variant_code} = [];
1061 :    
1062 : olson 1.25 my $nr = @{$self->{roles}};
1063 :    
1064 :     my $i = 0;
1065 : olson 1.1 while (<$fh>)
1066 :     {
1067 : parrello 1.69 next if ($_ =~ /^\/\//);
1068 :     chomp;
1069 :    
1070 :     my($genome, $variant_code, @row) = split(/\t/, $_, $nr + 2);
1071 :     $variant_code =~ s/ //g;
1072 : overbeek 1.81 next if ($seen{$genome});
1073 :     # next if ($seen{$genome} || (! $self->{fig}->is_genome($genome)));
1074 : parrello 1.69 $seen{$genome}++;
1075 :    
1076 :     my $j = 0;
1077 :    
1078 :     $self->{genome}->[$i] = $genome;
1079 :     $self->{genome_index}->{$genome} = $i;
1080 :     $self->{variant_code}->[$i] = $variant_code;
1081 : olson 1.1
1082 : parrello 1.69 my $thislen = @row;
1083 :    
1084 :     # if ($thislen != $nr)
1085 :     # {
1086 :     # warn "Genome $genome has wrong column count ($thislen != $nr)\n";
1087 :     # warn "<$_> $genome $variant_code '", join(":", @row), "'\n";
1088 :     # }
1089 :    
1090 :     for my $j (0..$nr - 1)
1091 :     {
1092 :     my $entry = $row[$j];
1093 :     my $e2 = [map("fig|$genome.peg.$_", split(/,/, $entry))];
1094 :     $self->{spreadsheet}->[$i]->[$j] = $e2;
1095 :     $self->{spreadsheet_inv}->[$j]->[$i] = $e2;
1096 :     $j++;
1097 :     }
1098 :     $i++;
1099 : parrello 1.60
1100 : olson 1.1 }
1101 :     }
1102 :    
1103 : parrello 1.73 =head3 write_subsystem
1104 : olson 1.25
1105 :     Write the subsystem to the disk. Updates on-disk data with notes,
1106 :     etc. Perform backups when necessary.
1107 :    
1108 :     =cut
1109 :    
1110 :     sub write_subsystem
1111 :     {
1112 : olson 1.68 my($self, $force_backup) = @_;
1113 : olson 1.25
1114 :     my $dir = $self->{dir};
1115 :     my $fig = $self->{fig};
1116 :    
1117 :     #
1118 :     # We first move the existing spreadsheet and notes files (if present)
1119 :     # to spreadsheet~ and notes~, and current state.
1120 :     #
1121 :    
1122 :     my $ss_file = "$dir/spreadsheet";
1123 :     my $ss_bak = "$dir/spreadsheet~";
1124 :     my $notes_file = "$dir/notes";
1125 :     my $notes_bak = "$dir/notes~";
1126 : overbeek 1.58 my $reactions_file = "$dir/reactions";
1127 :     my $reactions_bak = "$dir/reactions~";
1128 : redwards 1.44 my $classification_file = "$dir/CLASSIFICATION";
1129 : olson 1.25
1130 :     if (-f $ss_file)
1131 :     {
1132 : parrello 1.69 rename($ss_file, $ss_bak);
1133 : olson 1.25 }
1134 :    
1135 :     if (-f $notes_file)
1136 :     {
1137 : parrello 1.69 rename($notes_file, $notes_bak);
1138 : olson 1.25 }
1139 :    
1140 : overbeek 1.58 if (-f $reactions_file)
1141 :     {
1142 : parrello 1.69 rename($reactions_file, $reactions_bak) or warn "rename $reactions_file $reactions_bak failed $!";
1143 :     # print STDERR "wrote $reactions_bak\n";
1144 : overbeek 1.58 }
1145 :    
1146 : olson 1.25 #
1147 :     # Eval this whole chunk, so that if we get any fatal errors, we can
1148 :     # roll back to the old saved data.
1149 :     #
1150 : parrello 1.60
1151 : olson 1.25 eval {
1152 : parrello 1.69 my $fh;
1153 :     open($fh, ">$ss_file") or die "Cannot open $ss_file for writing: $!\n";
1154 :     $self->write_spreadsheet($fh);
1155 :     close($fh);
1156 :     chmod(0777,$ss_file);
1157 :    
1158 :     open($fh, ">$notes_file") or die "Cannot open $notes_file for writing: $!\n";
1159 :     print $fh "$self->{notes}\n";
1160 :     close($fh);
1161 :     chmod(0777,$notes_file);
1162 :    
1163 :     open($fh, ">$reactions_file") or die "Cannot open $reactions_file for writing: $!\n";
1164 :     my $reactions = $self->{reactions};
1165 :     foreach $_ (sort keys(%$reactions))
1166 :     {
1167 :     print $fh "$_\t" . join(",", @{$reactions->{$_}}), "\n";
1168 :     }
1169 :     close($fh);
1170 :     chmod(0777,$reactions_file);
1171 :    
1172 :     open($fh, ">$classification_file") or die "Can not open $classification_file for writing: $!\n";
1173 :     print $fh join "\t", (@{$self->{classification}}), "\n";
1174 :     close($fh);
1175 :     chmod(0777,$classification_file);
1176 :    
1177 :     $self->update_curation_log();
1178 :    
1179 :     #
1180 :     # Write out the piddly stuff.
1181 :     #
1182 :    
1183 :     open($fh, ">$dir/EXCHANGABLE") or die "Cannot write $dir/EXCHANGABLE: $!\n";
1184 :     print $fh "$self->{exchangable}\n";
1185 :     close($fh);
1186 :     chmod(0777,"EXCHANGABLE");
1187 :    
1188 :     #
1189 :     # Process backup files. This is the smae process that determines when the
1190 :     # version number should be bumped, so write the version file afterward.
1191 :     #
1192 :    
1193 :     $self->update_backups($force_backup);
1194 :    
1195 :     if ($self->{version} < 100) { $self->{version} += 100 }
1196 :     open($fh, ">$dir/VERSION") or die "Cannot write $dir/VERSION: $!\n";
1197 :     print $fh "$self->{version}\n";
1198 :     close($fh);
1199 :     chmod(0777,"VERSION");
1200 : olson 1.25 };
1201 :    
1202 :     if ($@ ne "")
1203 :     {
1204 : parrello 1.69 warn "Spreadsheet write failed, reverting to backup. Error was\n$@\n";
1205 : olson 1.25 }
1206 : parrello 1.60
1207 : olson 1.25 }
1208 :    
1209 :     sub update_curation_log
1210 :     {
1211 :     my($self) = @_;
1212 :    
1213 :     my $fh;
1214 :     my $file = "$self->{dir}/curation.log";
1215 :    
1216 :     my $now = time;
1217 :     my $user = $self->{fig}->get_user();
1218 :    
1219 :     if (-f $file)
1220 :     {
1221 : parrello 1.69 open($fh, ">>$file") or die "Cannot open $file for writing: $!\n";
1222 : olson 1.25 }
1223 :     else
1224 :     {
1225 : parrello 1.69 open($fh, ">$file") or die "Cannot open $file for writing: $!\n";
1226 :     print $fh "$now\t$user\tstarted\n";
1227 : olson 1.25 }
1228 :     print $fh "$now\t$user\tupdated\n";
1229 :     close($fh);
1230 :     }
1231 :    
1232 :     sub update_backups
1233 :     {
1234 : olson 1.68 my($self, $force_backup) = @_;
1235 : olson 1.25
1236 :     my $dir = $self->{dir};
1237 :     my $fig = $self->{fig};
1238 :    
1239 :     my $ss_file = "$dir/spreadsheet";
1240 :     my $ss_bak = "$dir/spreadsheet~";
1241 :     my $notes_file = "$dir/notes";
1242 :     my $notes_bak = "$dir/notes~";
1243 : overbeek 1.58 my $reactions_file = "$dir/reactions";
1244 :     my $reactions_bak = "$dir/reactions~";
1245 : olson 1.25
1246 :     my $ss_diff = abs((-s $ss_file) - (-s $ss_bak));
1247 :     my $notes_diff = abs((-s $notes_file) - (-s $notes_bak));
1248 : olson 1.68 my $reactions_diff = (system("cmp", "-s", $reactions_file, $reactions_bak) != 0);
1249 : overbeek 1.59 # print STDERR "reactions_file=$reactions_file reactions_bak=$reactions_bak dif=$reactions_diff\n";
1250 : olson 1.25
1251 : olson 1.68 if ($force_backup or ($ss_diff > 10) or ($notes_diff > 10) or $reactions_diff)
1252 : olson 1.25 {
1253 : parrello 1.69 $self->make_backup();
1254 : olson 1.25 }
1255 :     }
1256 :    
1257 :     sub make_backup
1258 :     {
1259 :     my($self) = @_;
1260 :    
1261 :     my $dir = $self->{dir};
1262 :     my $bak = "$dir/Backup";
1263 :    
1264 :     $self->{fig}->verify_dir($bak);
1265 :    
1266 :     my $ts = time;
1267 :    
1268 :     rename("$dir/spreadsheet~", "$bak/spreadsheet.$ts");
1269 :     rename("$dir/notes~", "$bak/notes.$ts");
1270 : overbeek 1.58 rename("$dir/reactions~", "$bak/reactions.$ts");
1271 : olson 1.25 $self->{version}++;
1272 :     }
1273 :    
1274 :    
1275 :    
1276 : parrello 1.73 =head3 write_spreadsheet
1277 : olson 1.25
1278 : parrello 1.73 C<< $sub->write_spreadsheet($fh); >>
1279 : olson 1.25
1280 :     Write the spreadsheet for this subsystem to filehandle $fh.
1281 :    
1282 :     =cut
1283 :    
1284 :     sub write_spreadsheet
1285 :     {
1286 :     my($self, $fh) = @_;
1287 :    
1288 :     $self->_write_roles($fh);
1289 :     print $fh "//\n";
1290 :    
1291 :     $self->_write_subsets($fh);
1292 :     print $fh "//\n";
1293 :    
1294 :     $self->_write_spreadsheet($fh);
1295 :     }
1296 :    
1297 :     sub _write_roles
1298 :     {
1299 :     my($self, $fh) = @_;
1300 :    
1301 :     my(@roles, @abbrs);
1302 :    
1303 :     @roles = $self->get_roles();
1304 :     @abbrs = $self->get_abbrs();
1305 :    
1306 :     while (@roles)
1307 :     {
1308 : parrello 1.69 my $role = shift(@roles);
1309 :     my $abbr = shift(@abbrs);
1310 : olson 1.25
1311 : parrello 1.69 print $fh "$abbr\t$role\n";
1312 : olson 1.25 }
1313 :     }
1314 :    
1315 :     sub _write_subsets
1316 :     {
1317 :     my($self, $fh) = @_;
1318 :    
1319 : overbeek 1.31 for my $sub ($self->get_subset_namesC())
1320 : olson 1.25 {
1321 : parrello 1.69 next if ($sub eq "All");
1322 :     my @members= $self->get_subsetC($sub);
1323 : olson 1.25
1324 : parrello 1.69 #
1325 :     # member list on disk is 1-based
1326 :     #
1327 : olson 1.25
1328 : parrello 1.69 @members = map { $_ + 1 } @members;
1329 :     print $fh join("\t", $sub, @members), "\n";
1330 : olson 1.25 }
1331 : overbeek 1.39 my $active_row_subset = $self->{row_active_subset};
1332 :     my $active_col_subset = $self->{col_active_subset};
1333 :    
1334 :     print $fh "$active_col_subset\n";
1335 : olson 1.25
1336 :     #
1337 :     # separator
1338 :     #
1339 :    
1340 :     print $fh "\n";
1341 : parrello 1.60
1342 : olson 1.25 #
1343 :     # genome subsets.
1344 :     #
1345 :    
1346 : overbeek 1.39 print $fh "$active_row_subset\n";
1347 : olson 1.25 }
1348 :    
1349 :     sub _write_spreadsheet
1350 :     {
1351 :     my($self, $fh) = @_;
1352 :    
1353 :     my(@genomes);
1354 :    
1355 :     @genomes= $self->get_genomes();
1356 :    
1357 :     for (my $i = 0; $i < @genomes; $i++)
1358 :     {
1359 : parrello 1.69 my $genome = $genomes[$i];
1360 :     my $vc = $self->get_variant_code($i);
1361 :    
1362 :     my $row = $self->get_row($i);
1363 :    
1364 :     if ($vc eq "")
1365 :     {
1366 :     $vc = "0";
1367 :     }
1368 :     print $fh "$genome\t$vc";
1369 : olson 1.25
1370 : parrello 1.69 for my $entry (@$row)
1371 :     {
1372 :     my(@p);
1373 : olson 1.25
1374 : parrello 1.69 for my $peg (@$entry)
1375 :     {
1376 :     if ($peg =~ /fig\|$genome\.peg\.(\d+)$/)
1377 :     {
1378 :     push(@p, $1);
1379 :     }
1380 :     else
1381 :     {
1382 :     warn "Bad peg $peg in cell for $genome";
1383 :     }
1384 :     }
1385 :     print $fh "\t", join(",", @p);
1386 :     }
1387 :     print $fh "\n";
1388 : olson 1.25 }
1389 :     }
1390 :    
1391 : parrello 1.73 =head3 get_genomes
1392 : olson 1.25
1393 : parrello 1.73 C<< my @genomeList = $sub->get_genomes(); >>
1394 : olson 1.25
1395 : parrello 1.73 Return a list of the genome IDs for this subsystem. Each genome corresponds to a row
1396 :     in the subsystem spreadsheet. Indexing into this list returns the ID of the genome
1397 :     in the specified row.
1398 : olson 1.2
1399 :     =cut
1400 : olson 1.25
1401 : olson 1.2 sub get_genomes
1402 :     {
1403 :     my($self) = @_;
1404 :    
1405 :     my $glist = $self->{genome};
1406 :    
1407 : olson 1.25 return @$glist;
1408 : olson 1.2 }
1409 :    
1410 : parrello 1.73 =head3 get_variant_codes
1411 :    
1412 :     C<< my @codes = $sub->get_variant_codes(); >>
1413 : olson 1.2
1414 : parrello 1.73 Return a list of the variant codes for each genome, in row index order. The variant
1415 :     code indicates which variation of the subsystem is used by the given genome.
1416 : olson 1.2
1417 :     =cut
1418 : olson 1.25
1419 : olson 1.2 sub get_variant_codes
1420 :     {
1421 :     my($self) = @_;
1422 :    
1423 :     my $glist = $self->{variant_code};
1424 :    
1425 : olson 1.25 return @$glist;
1426 :     }
1427 :    
1428 : parrello 1.73 =head3 get_variant_code
1429 :    
1430 :     C<< my $code = $sub->get_variant_code($gidx); >>
1431 :    
1432 :     Return the variant code for the specified genome. Each subsystem has multiple
1433 :     variants which involve slightly different chemical reactions, and each variant
1434 :     has an associated variant code. When a genome is connected to the spreadsheet,
1435 :     the subsystem variant used by the genome must be specified.
1436 :    
1437 :     =over 4
1438 :    
1439 :     =item gidx
1440 :    
1441 :     Row index for the genome whose variant code is desired.
1442 :    
1443 :     =item RETURN
1444 :    
1445 :     Returns the variant code for the specified genome.
1446 :    
1447 :     =back
1448 :    
1449 :     =cut
1450 :    
1451 : olson 1.25 sub get_variant_code
1452 :     {
1453 :     my($self, $gidx) = @_;
1454 : overbeek 1.46 my $c = $self->{variant_code}->[$gidx];
1455 :     $c =~ s/ //g;
1456 :     return $c;
1457 : olson 1.2 }
1458 :    
1459 : overbeek 1.34 sub set_variant_code
1460 :     {
1461 :     my($self, $gidx, $val) = @_;
1462 :     $self->{variant_code}->[$gidx] = $val;
1463 : olson 1.70
1464 :     #
1465 :     # Update the index for all the pegs in this row.
1466 :     # (only if we have a new database)
1467 :     #
1468 :    
1469 :     if ($self->{old_database})
1470 :     {
1471 :     return;
1472 :     }
1473 : parrello 1.73
1474 : olson 1.70 my $rdbH = $self->{fig}->db_handle();
1475 :     my $dbh = $rdbH->{_dbh};
1476 :     my $cells = $self->get_row($gidx);
1477 :     my $sub_name = $self->{name};
1478 :    
1479 :     my $sth = $dbh->prepare(qq(UPDATE subsystem_index
1480 :     SET variant = ?
1481 :     WHERE (subsystem = ? AND
1482 :     role = ? AND
1483 :     protein = ?)
1484 :     ));
1485 :     for my $i (0 .. $#$cells)
1486 :     {
1487 :     my $cell = $cells->[$i];
1488 :     my $role = $self->get_role($i);
1489 :    
1490 :     for my $peg (@$cell)
1491 :     {
1492 :     $sth->execute($val, $sub_name, $role, $peg);
1493 : olson 1.79 #warn "Update variant $sub_name $role $peg v='$val'\n";
1494 : olson 1.70 }
1495 :     }
1496 :    
1497 : overbeek 1.34 return;
1498 :     }
1499 :    
1500 : olson 1.25
1501 : olson 1.2 sub get_variant_code_for_genome
1502 :     {
1503 :     my($self, $genome) = @_;
1504 :     my $index = $self->{genome_index}->{$genome};
1505 : redwards 1.55 if (defined $index) {
1506 :     return $self->{variant_code}->[$index];
1507 :     }
1508 :     else {
1509 :     return undef;
1510 :     }
1511 : olson 1.2 }
1512 :    
1513 : parrello 1.73 =head3 get_roles
1514 :    
1515 :     C<< my @roles = $sub->get_roles(); >>
1516 :    
1517 :     Return a list of the subsystem's roles. Each role corresponds to a column
1518 :     in the subsystem spreadsheet. The list entry at a specified position in
1519 :     the list will contain the ID of that column's role.
1520 :    
1521 :     =cut
1522 :    
1523 : olson 1.2 sub get_roles
1524 :     {
1525 :     my($self) = @_;
1526 :    
1527 :     my $rlist = $self->{roles};
1528 :    
1529 : olson 1.25 return @$rlist;
1530 :     }
1531 :    
1532 :     sub get_abbrs
1533 :     {
1534 :     my($self) = @_;
1535 :    
1536 :     my $rlist = $self->{role_abbrs};
1537 :    
1538 :     return @$rlist;
1539 : olson 1.2 }
1540 :    
1541 : olson 1.29 sub roles_with_abbreviations
1542 :     {
1543 :     my($self) = @_;
1544 :    
1545 :     my @ret;
1546 :    
1547 :     for my $i (0..@{$self->{roles}} - 1)
1548 :     {
1549 : parrello 1.69 push(@ret, [$self->{role_abbrs}->[$i], $self->{roles}->[$i]]);
1550 : olson 1.29 }
1551 :     return @ret;
1552 :     }
1553 :    
1554 :    
1555 : olson 1.52 sub get_sorted_rows
1556 :     {
1557 :     my($self, $sort_order) = @_;
1558 :    
1559 :     my $fig = $self->{fig};
1560 :    
1561 :     my @rows;
1562 :     for (my $i = 0; $i < @{$self->{genome}}; $i++)
1563 :     {
1564 : parrello 1.69 my $gid = $self->{genome}->[$i];
1565 :     my $gs = $fig->genus_species($gid);
1566 : olson 1.52
1567 : parrello 1.69 my $q = quotemeta($gid);
1568 :     my $cells = [];
1569 :     for my $c (@{$self->{spreadsheet}->[$i]})
1570 :     {
1571 :     push(@$cells, [map { s/^fig\|$q\.peg\.//; $_ } @$c]);
1572 :     }
1573 : olson 1.52
1574 : parrello 1.69 push(@rows, [$self->{genome}->[$i], $gs, $self->{variant_code}->[$i], $cells]);
1575 : olson 1.52 }
1576 :    
1577 :     if ($sort_order eq "by_phylo")
1578 :     {
1579 : parrello 1.69 return(map { $_->[0] }
1580 :     sort { ($a->[1] cmp $b->[1]) or ($a->[0]->[1] cmp $b->[0]->[1]) }
1581 :     map { [$_, $fig->taxonomy_of($_->[0]) ] } @rows);
1582 : olson 1.52 }
1583 :     elsif ($sort_order eq "alphabetic")
1584 :     {
1585 : parrello 1.69 return sort { ($a->[1] cmp $b->[1]) or ($a->[0] <=> $b->[0]) } @rows;
1586 : olson 1.52 }
1587 :     elsif ($sort_order eq "by_tax_id")
1588 :     {
1589 : parrello 1.69 return sort { $a->[0] <=> $b->[0] } @rows;
1590 : olson 1.52 }
1591 :     else
1592 :     {
1593 : parrello 1.69 return @rows;
1594 : olson 1.52 }
1595 :     }
1596 :    
1597 :    
1598 : parrello 1.60 sub get_row :Scalar
1599 : olson 1.1 {
1600 :     my($self, $row) = @_;
1601 :    
1602 :     return $self->{spreadsheet}->[$row];
1603 :     }
1604 :    
1605 : parrello 1.60 sub get_col :Scalar
1606 : olson 1.1 {
1607 :     my($self, $col) = @_;
1608 :    
1609 :     return $self->{spreadsheet_inv}->[$col];
1610 :     }
1611 :    
1612 : parrello 1.60 sub get_cell :Scalar
1613 : olson 1.1 {
1614 :     my($self, $row, $col) = @_;
1615 :    
1616 : olson 1.5 my $cell = $self->{spreadsheet}->[$row]->[$col];
1617 : overbeek 1.37 if (! defined($cell))
1618 :     {
1619 : parrello 1.69 $cell = $self->{spreadsheet}->[$row]->[$col] = [];
1620 : overbeek 1.37 }
1621 : olson 1.5 return $cell;
1622 : olson 1.1 }
1623 :    
1624 : parrello 1.73 =head3 get_genome_index
1625 :    
1626 :     C<< my $idx = $sub->get_genome_index($genome); >>
1627 :    
1628 :     Return the row index for the genome with the specified ID.
1629 :    
1630 :     =over 4
1631 :    
1632 :     =item genome
1633 :    
1634 :     ID of the genome whose row index is desired.
1635 :    
1636 :     =item RETURN
1637 :    
1638 :     Returns the row index for the genome with the specified ID, or an undefined
1639 :     value if the genome does not participate in the subsystem.
1640 :    
1641 :     =back
1642 :    
1643 :     =cut
1644 :    
1645 : parrello 1.60 sub get_genome_index :Scalar
1646 : olson 1.3 {
1647 :     my($self, $genome) = @_;
1648 :    
1649 :     return $self->{genome_index}->{$genome};
1650 :     }
1651 :    
1652 : parrello 1.60 sub get_genome :Scalar
1653 : olson 1.3 {
1654 :     my($self, $gidx) = @_;
1655 :    
1656 :     return $self->{genome}->[$gidx];
1657 :     }
1658 :    
1659 : parrello 1.73 =head3 get_role_index
1660 :    
1661 :     C<< my $idx = $sub->get_role_index($role); >>
1662 :    
1663 :     Return the column index for the role with the specified ID.
1664 :    
1665 :     =over 4
1666 :    
1667 :     =item role
1668 :    
1669 :     ID (full name) of the role whose column index is desired.
1670 :    
1671 :     =item RETURN
1672 :    
1673 :     Returns the column index for the role with the specified name.
1674 :    
1675 :     =back
1676 :    
1677 :     =cut
1678 :    
1679 : parrello 1.60 sub get_role_index :Scalar
1680 : olson 1.5 {
1681 :     my($self, $role) = @_;
1682 :    
1683 :     return $self->{role_index}->{$role};
1684 :     }
1685 :    
1686 : parrello 1.60 sub get_role :Scalar
1687 : olson 1.3 {
1688 :     my($self, $ridx) = @_;
1689 :    
1690 :     return $self->{roles}->[$ridx];
1691 :     }
1692 :    
1693 : parrello 1.73 =head3 get_role_abbr
1694 :    
1695 :     C<< my $abbr = $sub->get_role_abbr($ridx); >>
1696 :    
1697 :     Return the abbreviation for the role in the specified column. The abbreviation
1698 :     is a shortened identifier that is not necessarily unique, but is more likely to
1699 :     fit in a column heading.
1700 :    
1701 :     =over 4
1702 :    
1703 :     =item ridx
1704 :    
1705 :     Column index for the role whose abbreviation is desired.
1706 :    
1707 :     =item RETURN
1708 :    
1709 :     Returns an abbreviated name for the role corresponding to the indexed column.
1710 :    
1711 :     =back
1712 :    
1713 :     =cut
1714 :    
1715 : parrello 1.60 sub get_role_abbr :Scalar
1716 : olson 1.4 {
1717 :     my($self, $ridx) = @_;
1718 :    
1719 :     return $self->{role_abbrs}->[$ridx];
1720 :     }
1721 :    
1722 : parrello 1.60 sub get_role_from_abbr :Scalar
1723 : olson 1.20 {
1724 :     my($self, $abbr) = @_;
1725 :    
1726 :     return $self->{abbr}->{$abbr};
1727 :     }
1728 :    
1729 : parrello 1.73 =head3 set_pegs_in_cell
1730 : olson 1.26
1731 : parrello 1.73 C<< $sub->set_pegs_in_cell($genome, $role, $peg_list); >>
1732 : olson 1.26
1733 :     Set the cell for the given genome and role to $peg_list.
1734 :    
1735 :     =cut
1736 :    
1737 :     sub set_pegs_in_cell
1738 :     {
1739 :     my($self, $genome, $role, $peg_list) = @_;
1740 :     my($row, $col);
1741 :    
1742 :     #
1743 :     # If row isn't numeric, look it up in the genomes list.
1744 :     #
1745 : parrello 1.60
1746 : olson 1.26 if ($genome !~ /^\d+$/)
1747 :     {
1748 : parrello 1.69 $row = $self->{genome_index}->{$genome};
1749 : olson 1.26 }
1750 :     else
1751 :     {
1752 : parrello 1.69 $row = $genome
1753 : olson 1.26 }
1754 : parrello 1.60
1755 : overbeek 1.37 if (! defined($row))
1756 : olson 1.26 {
1757 : parrello 1.69 print &Dumper($self->{genome_index});
1758 :     confess "Cannot find row for $genome\n";
1759 :     return undef;
1760 : olson 1.26 }
1761 :    
1762 :     #
1763 :     # If col isn't numeric, look it up in the roles and role abbreviations.
1764 :     #
1765 : parrello 1.60
1766 : olson 1.26 if ($role !~ /^\d+$/)
1767 :     {
1768 : parrello 1.69 #
1769 :     # See if it's an abbr
1770 :     #
1771 : olson 1.26
1772 : parrello 1.69 my $a = $self->{abbr}->{$role};
1773 :     $role = $a if $a;
1774 : olson 1.26
1775 : parrello 1.69 $col = $self->{role_index}->{$role};
1776 : olson 1.26 }
1777 :     else
1778 :     {
1779 : parrello 1.69 $col = $role;
1780 : olson 1.26 }
1781 : parrello 1.60
1782 : overbeek 1.37 if (! defined($col))
1783 : olson 1.26 {
1784 : parrello 1.69 print &Dumper($self->{role_index});
1785 :     confess "Cannot find col for $role\n";
1786 :     return undef;
1787 : olson 1.26 }
1788 :     my $cell = $self->get_cell($row, $col);
1789 :    
1790 : olson 1.70
1791 : overbeek 1.37 if (defined($cell))
1792 : olson 1.26 {
1793 : olson 1.70 my $sub_name = $self->{name};
1794 :     my $peg;
1795 :     my $rdbH = $self->{fig}->db_handle();
1796 :     my $dbh = $rdbH->{_dbh};
1797 :    
1798 :     my $variant = $self->get_variant_code($row);
1799 : parrello 1.73
1800 : olson 1.70 if (@$cell > 0)
1801 :     {
1802 :     my $sth = $dbh->prepare(qq(DELETE FROM subsystem_index
1803 :     WHERE (subsystem = ? AND
1804 :     role = ? AND
1805 :     protein = ?)
1806 :     ));
1807 :     foreach $peg (@$cell)
1808 :     {
1809 :     $sth->execute($sub_name, $role, $peg);
1810 :     warn "Deleting $sub_name $role $peg\n";
1811 :     }
1812 :     }
1813 : parrello 1.73
1814 : olson 1.70 @$cell = @$peg_list;
1815 :    
1816 :     if ($self->{old_database})
1817 :     {
1818 :     my $sth = $rdbH->{_dbh}->prepare(qq(INSERT INTO subsystem_index (protein,subsystem,role)
1819 :     VALUES (?, ?, ?)));
1820 :     foreach $peg (@$cell)
1821 :     {
1822 :     $sth->execute($peg, $sub_name, $role);
1823 :     warn "Add old $peg $sub_name $role\n";
1824 :     }
1825 :     }
1826 :     else
1827 :     {
1828 :     my $sth = $rdbH->{_dbh}->prepare(qq(INSERT INTO subsystem_index (protein,subsystem,role,variant)
1829 :     VALUES (?, ?, ?, ?)));
1830 :     foreach $peg (@$cell)
1831 :     {
1832 :     $sth->execute($peg, $sub_name, $role, $variant);
1833 : olson 1.79 #warn "Add new $peg $sub_name $role v='$variant'\n";
1834 : olson 1.70 }
1835 :     }
1836 : olson 1.26 }
1837 :     else
1838 :     {
1839 : parrello 1.69 warn "set_pegs_in_cell: Could not find cell!";
1840 : olson 1.26 }
1841 :     }
1842 :    
1843 : parrello 1.73 =head3 get_pegs_from_cell
1844 :    
1845 :     C<< my @pegs = $sub->get_pegs_from_cell($rowstr, $colstr); >>
1846 :    
1847 :     Return a list of the peg IDs for the features in the specified spreadsheet cell.
1848 :    
1849 :     =over 4
1850 :    
1851 :     =item rowstr
1852 :    
1853 :     Genome row, specified either as a row index or a genome ID.
1854 :    
1855 :     =item colstr
1856 :    
1857 :     Role column, specified either as a column index, a role name, or a role
1858 :     abbreviation.
1859 :    
1860 :     =item RETURN
1861 :    
1862 :     Returns a list of PEG IDs. The PEGs in the list belong to the genome in the
1863 :     specified row and perform the role in the specified column. If the indicated
1864 :     row and column does not exist, returns an empty list.
1865 :    
1866 :     =back
1867 :    
1868 :     =cut
1869 :    
1870 : olson 1.1 sub get_pegs_from_cell
1871 :     {
1872 :     my($self, $rowstr, $colstr) = @_;
1873 :     my($row, $col);
1874 :    
1875 :     #
1876 :     # If row isn't numeric, look it up in the genomes list.
1877 :     #
1878 : parrello 1.60
1879 : olson 1.1 if ($rowstr !~ /^\d+$/)
1880 :     {
1881 : parrello 1.69 $row = $self->{genome_index}->{$rowstr};
1882 : olson 1.1 }
1883 :     else
1884 :     {
1885 : parrello 1.69 $row = $rowstr;
1886 : olson 1.1 }
1887 : parrello 1.60
1888 : overbeek 1.31 if (! defined($row))
1889 : olson 1.1 {
1890 : parrello 1.69 print &Dumper($self->{genome_index});
1891 :     confess "Cannot find row for $rowstr\n";
1892 :     return undef;
1893 : olson 1.1 }
1894 :    
1895 :     #
1896 :     # If col isn't numeric, look it up in the roles and role abbreviations.
1897 :     #
1898 : parrello 1.60
1899 : olson 1.1 if ($colstr !~ /^\d+$/)
1900 :     {
1901 : parrello 1.69 #
1902 :     # See if it's an abbr
1903 :     #
1904 : olson 1.1
1905 : parrello 1.69 my $a = $self->{abbr}->{$colstr};
1906 :     $colstr = $a if $a;
1907 : olson 1.1
1908 : parrello 1.69 $col = $self->{role_index}->{$colstr};
1909 : olson 1.1 }
1910 :     else
1911 :     {
1912 : parrello 1.69 $col = $colstr;
1913 : olson 1.1 }
1914 : overbeek 1.32
1915 : overbeek 1.31 if (! defined($col))
1916 : olson 1.1 {
1917 : parrello 1.69 warn "Cannot find col for $colstr\n";
1918 :     return undef;
1919 : olson 1.1 }
1920 : olson 1.12 my $cell = $self->get_cell($row, $col);
1921 : olson 1.1
1922 :     if ($cell)
1923 :     {
1924 : parrello 1.69 return @$cell;
1925 : olson 1.1 }
1926 :     else
1927 :     {
1928 : parrello 1.69 return undef;
1929 : olson 1.1 }
1930 :     }
1931 :    
1932 : olson 1.25 #
1933 :     # Subset support
1934 :     #
1935 :    
1936 : olson 1.30 sub get_active_subsetC
1937 :     {
1938 :     my($self) = @_;
1939 :    
1940 :     return $self->{col_active_subset};
1941 :     }
1942 :    
1943 :     sub get_active_subsetR
1944 :     {
1945 :     my($self) = @_;
1946 :    
1947 :     return $self->{row_active_subset};
1948 :     }
1949 :    
1950 :     sub set_active_subsetC
1951 :     {
1952 :     my($self, $subset) = @_;
1953 :    
1954 :     $self->{col_active_subset} = $subset;
1955 :     }
1956 :    
1957 :    
1958 :     sub set_active_subsetR
1959 :     {
1960 :     my($self, $subset) = @_;
1961 :    
1962 :     $self->{row_active_subset} = $subset;
1963 :     }
1964 :    
1965 :    
1966 : olson 1.25 sub get_subset_names
1967 : olson 1.17 {
1968 :     my($self) = @_;
1969 : olson 1.25
1970 : overbeek 1.31 return $self->get_subset_namesC;
1971 :     }
1972 :    
1973 : parrello 1.73 =head3 get_subset_namesC
1974 :    
1975 :     C<< my @subsetNames = $sub->get_subset_namesC(); >>
1976 :    
1977 :     Return a list of the names for all the column (role) subsets. Given a subset
1978 :     name, you can use the L</get_subsetC_roles> method to get the roles in the
1979 :     subset.
1980 :    
1981 :     =cut
1982 :    
1983 : overbeek 1.31 sub get_subset_namesC
1984 :     {
1985 :     my($self) = @_;
1986 :    
1987 : overbeek 1.35 return ("All",@{$self->{col_subsets}});
1988 : overbeek 1.31 }
1989 :    
1990 :     sub get_subset_namesR
1991 :     {
1992 :     my($self) = @_;
1993 :    
1994 : overbeek 1.35 return ("All",@{$self->{row_subsets}});
1995 : olson 1.17 }
1996 :    
1997 : parrello 1.73 =head3 get_subsetC_roles
1998 :    
1999 :     C<< my @roles = $sub->get_subsetC_roles($subname); >>
2000 :    
2001 :     Return the names of the roles contained in the specified role (column) subset.
2002 :    
2003 :     =over 4
2004 :    
2005 :     =item subname
2006 :    
2007 :     Name of the role subset whose roles are desired.
2008 :    
2009 :     =item RETURN
2010 :    
2011 :     Returns a list of the role names for the columns in the named subset.
2012 :    
2013 :     =back
2014 :    
2015 :     =cut
2016 :    
2017 : overbeek 1.33 sub get_subsetC_roles
2018 :     {
2019 :     my($self, $subname) = @_;
2020 :     return map { $self->get_role($_) } $self->get_subsetC($subname);
2021 :     }
2022 :    
2023 : overbeek 1.31 sub get_subsetC
2024 :     {
2025 :     my($self, $subname) = @_;
2026 : overbeek 1.33 if ($subname eq "All") { return map { $self->get_role_index($_) } $self->get_roles }
2027 : overbeek 1.31
2028 : olson 1.52 if (!defined($self->{col_subset_members}->{$subname}))
2029 :     {
2030 : parrello 1.69 $self->{col_subset_members}->{$subname} = [];
2031 : olson 1.52 }
2032 : parrello 1.60
2033 : overbeek 1.31 return @{$self->{col_subset_members}->{$subname}};
2034 :     }
2035 :    
2036 : olson 1.25 sub get_subset
2037 : olson 1.17 {
2038 : olson 1.25 my($self, $subname) = @_;
2039 : overbeek 1.33 return $self->get_subsetC($subname);
2040 : overbeek 1.31 }
2041 :    
2042 :     sub get_subsetR
2043 :     {
2044 :     my($self, $subname) = @_;
2045 :     my($pair,$id,$members,$genome);
2046 :    
2047 :     if ($subname eq "All") { return $self->get_genomes }
2048 : overbeek 1.38 my %genomes = map { $_ => 1 } $self->get_genomes;
2049 :    
2050 :     return grep { $genomes{$_} } @{$self->{row_subset_members}->{$subname}};
2051 : overbeek 1.35 }
2052 :    
2053 :     sub load_row_subsets {
2054 :     my($self) = @_;
2055 :     my($id,$members,$pair);
2056 : overbeek 1.31
2057 : overbeek 1.35 my $taxonomic_groups = $self->{fig}->taxonomic_groups_of_complete(10);
2058 :     foreach $pair (@$taxonomic_groups)
2059 : overbeek 1.31 {
2060 : parrello 1.69 ($id,$members) = @$pair;
2061 :     if ($id ne "All")
2062 :     {
2063 :     push(@{$self->{row_subsets}},$id);
2064 :     }
2065 :     $self->{row_subset_members}->{$id} = $members;
2066 : overbeek 1.31 }
2067 : olson 1.25 }
2068 :    
2069 : parrello 1.73 =head3 load_row_subsets_by_kv
2070 : redwards 1.48
2071 :     Load a row subset based on a key/value pair. This will take a single key/value pair and only show that subset
2072 :    
2073 :     It is just a modification of load_row_subsets to deal with kv pairs
2074 :    
2075 :     This takes a required argument: the key that the genome must have, and a second optional argument, the value that key must hold.
2076 :    
2077 :     =cut
2078 :    
2079 :     sub load_row_subsets_by_kv {
2080 :     my ($self, $key, $want) = @_;
2081 :     my($id,$members,$pair);
2082 :     my $keep;
2083 :     foreach my $genome (@{$self->{genome}}) {
2084 : redwards 1.50 my @results=$self->{fig}->get_attributes($genome, $key);
2085 :     foreach my $res (@results) {
2086 : redwards 1.51 my ($gotid, $gottag, $value, $url)=@$res;
2087 : redwards 1.50 next if (!$value);
2088 :     next if ($want && $value ne $want);
2089 :     push @$keep, $genome;
2090 :     last;
2091 :     }
2092 : redwards 1.48 }
2093 :     $self->{row_subset_members}->{$key}=$keep;
2094 :     }
2095 : overbeek 1.35
2096 : parrello 1.73 =head3 set_subsetC
2097 : olson 1.25
2098 : parrello 1.73 C<< $sub->set_subsetC($name, $members); >>
2099 : olson 1.25
2100 :     Create a subset with the given name and members.
2101 :    
2102 :     $members is a list of role names.
2103 :    
2104 :     =cut
2105 :    
2106 : overbeek 1.31 sub set_subsetC
2107 : olson 1.25 {
2108 :     my($self, $subname, $list) = @_;
2109 :    
2110 :     my $nl = [map { $self->get_role_index($_) } @$list];
2111 : parrello 1.60
2112 : olson 1.25 $self->_set_subset($subname, $nl);
2113 :     }
2114 :    
2115 : overbeek 1.31 sub set_subset
2116 :     {
2117 :     my($self, $subname, $list) = @_;
2118 :    
2119 :     $self->set_subsetsC($subname,$list);
2120 :     }
2121 :    
2122 : parrello 1.73 =head3 _set_subset
2123 : olson 1.25
2124 :     Create a subset with the given name and members.
2125 :    
2126 :     Internal version - here, members is a list of role indices.
2127 :    
2128 :     =cut
2129 :    
2130 :     sub _set_subset
2131 :     {
2132 :     my($self, $subname, $list) = @_;
2133 :     $self->{col_subset_members}->{$subname} = $list;
2134 : overbeek 1.37 my($i,$x);
2135 :     $x = $self->{col_subsets};
2136 :     for ($i=0; ($i < @$x) && ($x->[$i] ne $subname); $i++) {}
2137 :     if ($i == @$x)
2138 :     {
2139 : parrello 1.69 push(@$x,$subname);
2140 : overbeek 1.37 }
2141 :     }
2142 : parrello 1.60
2143 : overbeek 1.37 sub delete_subsetC
2144 :     {
2145 :     my($self, $subname) = @_;
2146 :     my($i,$x);
2147 :    
2148 :     $x = $self->{col_subsets};
2149 :     for ($i=0; ($i < @$x) && ($x->[$i] ne $subname); $i++) {}
2150 :     if ($i < @$x)
2151 :     {
2152 : parrello 1.69 splice(@$x,$i,1);
2153 : overbeek 1.37 }
2154 :     delete $self->{col_subset_members}->{$subname};
2155 : olson 1.25 }
2156 : parrello 1.60
2157 : olson 1.25 #
2158 :     # Role manipulation.
2159 :     #
2160 :    
2161 :    
2162 : parrello 1.73 =head3 set_roles
2163 : olson 1.25
2164 : parrello 1.73 C<< $sub->set_roles($role_list); >>
2165 : olson 1.25
2166 :     Set the list of roles. C<$role_list> is a list of tuples C<[$role_name, $abbreviation]>.
2167 :    
2168 :     If a role already exists, it is used. If it does not exist, it is created empty.
2169 :    
2170 :     =cut
2171 :    
2172 :     sub set_roles
2173 :     {
2174 :     my($self, $roles) = @_;
2175 :    
2176 :     #
2177 :     # We do this by first creating a new spreadsheet.
2178 :     #
2179 :     # It is easiest to do this by manipulating the inverted spreadsheet
2180 :     # (role-major), and then creating the non-inverted spreadsheet from it.
2181 :     #
2182 :    
2183 :     my $oldss = $self->{spreadsheet};
2184 :     my $oldssinv = $self->{spreadsheet_inv};
2185 :    
2186 :     my $ss = [];
2187 :     my $ssinv = [];
2188 :    
2189 :     my $g = $self->{genome};
2190 :     my $ng = @$g;
2191 :    
2192 :     my $old_roles = $self->{role_index};
2193 :    
2194 :     my @role_index_conversion;
2195 : olson 1.70 my @old_role_list = @{$self->{roles}};
2196 : olson 1.25
2197 : olson 1.70 #
2198 :     # Since we're setting up completely new roles, wipe the
2199 :     # existing state.
2200 :     #
2201 : olson 1.25
2202 :     $self->{abbr} = {};
2203 :     $self->{role_index} = {};
2204 :     $self->{roles} = [];
2205 :     $self->{role_abbrs} = [];
2206 :    
2207 : olson 1.70 #
2208 :     # Initialize %defunct_roles with the list of all roles.
2209 :     # Remove entries as we walk the list of new roles below.
2210 :     # Any that are remaining need to be pulled from the index.
2211 :     #
2212 : olson 1.25
2213 : olson 1.70 my %defunct_roles = map { $_ => 1 } @old_role_list;
2214 : parrello 1.73
2215 : olson 1.70 # warn "Defunct at start: ", Dumper(\%defunct_roles);
2216 : olson 1.25 for (my $idx = 0; $idx < @$roles; $idx++)
2217 :     {
2218 : parrello 1.69 my $role = $roles->[$idx]->[0];
2219 :     my $abbr = $roles->[$idx]->[1];
2220 :    
2221 :     my $old_idx = $old_roles->{$role};
2222 : olson 1.25
2223 : olson 1.70 if (defined($old_idx))
2224 :     {
2225 :     # warn "Found old idx $old_idx for $role $idx\n";
2226 :     # warn $oldssinv->[$old_idx];
2227 :     $ssinv->[$idx] = $oldssinv->[$old_idx];
2228 :    
2229 :     $role_index_conversion[$old_idx] = $idx;
2230 :    
2231 :     #
2232 :     # We're keeping it, so it's not defunct anymore.
2233 :     #
2234 :     delete $defunct_roles{$role};
2235 :     }
2236 :     else
2237 :     {
2238 :     # warn "Did not find old role for $role $idx\n";
2239 :     # warn Dumper($old_roles);
2240 :     my $l = [];
2241 :     for (my $j = 0; $j < $ng; $j++)
2242 :     {
2243 :     $l->[$j] = [];
2244 :     }
2245 :    
2246 :     $ssinv->[$idx] = $l;
2247 :     }
2248 :    
2249 : parrello 1.73
2250 : olson 1.70 #
2251 :     # While we're here, update the new role and abbrev indexes
2252 :     #
2253 :     $self->{role_index}->{$role} = $idx;
2254 :     $self->{abbr}->{$abbr} = $role;
2255 :     $self->{roles}->[$idx] = $role;
2256 :     $self->{role_abbrs}->[$idx] = $abbr;
2257 :     }
2258 : olson 1.25
2259 : olson 1.70 #
2260 :     # Now we delete the pegs showing up for the list of defunct roles.
2261 :     #
2262 :     # warn "Defunct at finish: ", Dumper(\%defunct_roles);
2263 : parrello 1.73
2264 : olson 1.70 my $rdbH = $self->{fig}->db_handle();
2265 :     my $dbh = $rdbH->{_dbh};
2266 :     my $sub_name = $self->{name};
2267 : parrello 1.73
2268 : olson 1.70 my $sth = $dbh->prepare(qq(DELETE FROM subsystem_index
2269 :     WHERE (subsystem = ? AND
2270 :     role = ? AND
2271 :     protein = ?)
2272 :     ));
2273 : parrello 1.73
2274 :    
2275 : olson 1.70 for my $defunct_role (keys(%defunct_roles))
2276 :     {
2277 :     my $defunct_role_idx = $old_roles->{$defunct_role};
2278 :     my $col = $oldssinv->[$defunct_role_idx];
2279 :     # warn "Handle defunct role $defunct_role idx=$defunct_role_idx\n", Dumper($col);
2280 : parrello 1.73
2281 : olson 1.70 for my $cell (@$col)
2282 :     {
2283 :     for my $peg (@$cell)
2284 :     {
2285 :     $sth->execute($sub_name, $defunct_role, $peg);
2286 :     warn "Deleting $sub_name $defunct_role $peg\n";
2287 :     }
2288 :     }
2289 : olson 1.25 }
2290 : parrello 1.73
2291 : olson 1.25
2292 :     #
2293 :     # Now create the uninverted spreadsheet.
2294 :     #
2295 :    
2296 :     for (my $gidx = 0; $gidx < $ng; $gidx++)
2297 :     {
2298 : parrello 1.69 my $row = [];
2299 :     $ss->[$gidx] = $row;
2300 :     for (my $ridx = 0; $ridx < @$roles; $ridx++)
2301 :     {
2302 :     $row->[$ridx] = $ssinv->[$ridx]->[$gidx];
2303 :     }
2304 : olson 1.25 }
2305 :    
2306 :     $self->{spreadsheet} = $ss;
2307 :     $self->{spreadsheet_inv} = $ssinv;
2308 :    
2309 :     #
2310 :     # Fix up the subsets.
2311 :     #
2312 :    
2313 :    
2314 : overbeek 1.37 for my $subset (grep { $_ ne "All" } $self->get_subset_names())
2315 : olson 1.25 {
2316 : parrello 1.69 my $n = [];
2317 :     for my $idx ($self->get_subset($subset))
2318 :     {
2319 :     my $new = $role_index_conversion[$idx];
2320 :     if (defined($new))
2321 :     {
2322 :     push(@$n, $new);
2323 :     }
2324 :     }
2325 :     $self->_set_subset($subset, $n);
2326 : olson 1.25 }
2327 :    
2328 :     }
2329 :    
2330 : parrello 1.73 =head3 add_role($role, $abbr)
2331 : olson 1.25
2332 :     Add the given role to the spreadsheet.
2333 :    
2334 :     This causes a new column to be added, with empty values in each cell.
2335 :    
2336 :     We do nothing if the role is already present.
2337 :    
2338 :     Return the index of the new role.
2339 :    
2340 :     =cut
2341 :    
2342 :     sub add_role
2343 :     {
2344 :     my($self, $role, $abbr) = @_;
2345 :    
2346 :     if (defined($self->get_role_index($role)))
2347 :     {
2348 : parrello 1.69 warn "Role $role already present\n";
2349 :     return undef;
2350 : olson 1.25 }
2351 :    
2352 :     #
2353 :     # Add to the roles list. It goes at the end.
2354 :     #
2355 :    
2356 :     my $idx = @{$self->{roles}};
2357 :     $self->{roles}->[$idx] = $role;
2358 :     $self->{role_abbrs}->[$idx] = $abbr;
2359 :     $self->{role_index}->{$role} = $idx;
2360 :     $self->{abbr}->{$abbr} = $role;
2361 :    
2362 :     #
2363 :     # Update the spreadsheet.
2364 :     # On the standard one, we have to go through all the rows adding
2365 :     # a columnt to each.
2366 :     #
2367 :     # On the inverted one, we add a column with [] in each entry.
2368 :     #
2369 :    
2370 :     my $ng = @{$self->{genome}};
2371 :     my $newcol = [];
2372 :    
2373 :     for (my $i = 0; $i < $ng; $i++)
2374 :     {
2375 : parrello 1.69 my $cell = [];
2376 :     # print "nr: Adding cell $cell for gidx=$i ridx=$idx\n";
2377 :     $self->{spreadsheet}->[$i]->[$idx] = $cell;
2378 :     $newcol->[$i] = $cell;
2379 : olson 1.25 }
2380 :    
2381 :     $self->{spreadsheet_inv}->[$idx] = $newcol;
2382 :    
2383 :     return $idx;
2384 :     }
2385 :    
2386 : parrello 1.73 =head3 remove_role
2387 : olson 1.25
2388 :     Remove the role from the spreadsheet.
2389 :    
2390 :     We do nothing if the role is not present.
2391 :    
2392 :     =cut
2393 :    
2394 :     sub remove_role
2395 :     {
2396 :     my($self, $role) = @_;
2397 :    
2398 :     my $idx = $self->get_role_index($role);
2399 :     if (!defined($idx))
2400 :     {
2401 : parrello 1.69 warn "Role $role not present\n";
2402 :     return undef;
2403 : olson 1.25 }
2404 :    
2405 :     #
2406 : olson 1.70 # Update the index. Again, do this before removing roles
2407 :     # so we have full data to work with.
2408 :     # We walk the role's column of the spreadsheet removing pegs from the index.
2409 :     #
2410 :    
2411 :     my $rdbH = $self->{fig}->db_handle();
2412 :     my $dbh = $rdbH->{_dbh};
2413 :     my $sub_name = $self->{name};
2414 :    
2415 :     my $sth = $dbh->prepare(qq(DELETE FROM subsystem_index
2416 :     WHERE (subsystem = ? AND
2417 :     role = ? AND
2418 :     protein = ?)
2419 :     ));
2420 :     my $col = $self->get_col($idx);
2421 :     for my $cell (@$col)
2422 :     {
2423 :     for my $peg (@$cell)
2424 :     {
2425 :     $sth->execute($sub_name, $role, $peg);
2426 :     warn "Deleting $sub_name $role $peg\n";
2427 :     }
2428 :     }
2429 :    
2430 :     #
2431 : parrello 1.60 # Remove from the roles list.
2432 : olson 1.25 #
2433 :    
2434 :     my $abbr = $self->{role_abbrs}->[$idx];
2435 : parrello 1.60
2436 : olson 1.25 splice(@{$self->{roles}}, $idx, 1);
2437 :     splice(@{$self->{role_abbrs}}, $idx, 1);
2438 :     delete $self->{role_index}->{$role};
2439 :     delete $self->{abbr}->{$abbr};
2440 :    
2441 : olson 1.70
2442 : olson 1.25 #
2443 :     # Update the spreadsheet.
2444 :     # On the standard one, we have to go through all the rows removing
2445 :     # the column from each.
2446 :     #
2447 :     # On the inverted one, we just remove the column.
2448 :     #
2449 :    
2450 :     my $ng = @{$self->{genome}};
2451 :     my $newcol = [];
2452 :    
2453 :     for (my $i = 0; $i < $ng; $i++)
2454 :     {
2455 : parrello 1.69 splice(@{$self->{spreadsheet}->[$i]}, $idx, 1);
2456 : olson 1.25 }
2457 :    
2458 :     splice(@{$self->{spreadsheet_inv}}, $idx, 1);
2459 :    
2460 :     #
2461 :     # We need to rewrite the subsets. if $idx was present in one, it is
2462 :     # removed. Any index >$idx is decremented.
2463 :     #
2464 :    
2465 :     for my $subset ($self->get_subset_names())
2466 :     {
2467 : parrello 1.69 my @n;
2468 : olson 1.25
2469 : parrello 1.69 for my $sidx ($self->get_subset($subset))
2470 :     {
2471 :     if ($sidx < $idx)
2472 :     {
2473 :     push(@n, $sidx);
2474 :     }
2475 :     elsif ($sidx > $idx)
2476 :     {
2477 :     push(@n, $sidx - 1);
2478 :     }
2479 :     }
2480 : olson 1.25
2481 : parrello 1.69 $self->_set_subset($subset, [@n]);
2482 : olson 1.25 }
2483 :     }
2484 :    
2485 : parrello 1.73 =head3 add_genome($genome, $abbr)
2486 : olson 1.25
2487 :     Add the given genome to the spreadsheet.
2488 :    
2489 :     This causes a new row to be added, with empty values in each cell.
2490 :    
2491 :     We do nothing if the genome is already present.
2492 :    
2493 :     Return the index of the new genome.
2494 :    
2495 :     =cut
2496 :    
2497 :     sub add_genome
2498 :     {
2499 :     my($self, $genome) = @_;
2500 :    
2501 :     my $idx = $self->get_genome_index($genome);
2502 :     if (defined($idx))
2503 :     {
2504 : parrello 1.64 warn "Genome $genome already present\n";
2505 :     return $idx;
2506 : olson 1.25 }
2507 :    
2508 :     #
2509 :     # Add to the genomes list. It goes at the end.
2510 :     #
2511 :    
2512 : parrello 1.64 $idx = @{$self->{genome}};
2513 : olson 1.26 $self->{variant_code}->[$idx] = 0;
2514 : olson 1.25 $self->{genome}->[$idx] = $genome;
2515 :     $self->{genome_index}->{$genome} = $idx;
2516 :    
2517 :     #
2518 :     # Update the spreadsheet.
2519 :     # On the inverted one, we have to go through all the columns adding
2520 :     # a row to each.
2521 :     #
2522 :     # On the regular one, we add a row with [] in each entry.
2523 :     #
2524 :    
2525 :     my $nr = @{$self->{roles}};
2526 :     my $newrow = [];
2527 :    
2528 :     for my $i (0.. $nr - 1)
2529 :     {
2530 : parrello 1.69 my $cell = [];
2531 :     # print "ng: Adding cell $cell for gidx=$idx ridx=$i\n";
2532 :     $self->{spreadsheet_inv}->[$i]->[$idx] = $cell;
2533 :     $newrow->[$i] = $cell;
2534 : olson 1.25 }
2535 :    
2536 :     $self->{spreadsheet}->[$idx] = $newrow;
2537 :    
2538 :     return $idx;
2539 :     }
2540 :    
2541 : parrello 1.73 =head3 remove_genome
2542 : olson 1.25
2543 :     Remove the genome from the spreadsheet.
2544 :    
2545 :     We do nothing if the genome is not present.
2546 :    
2547 :     =cut
2548 :    
2549 :     sub remove_genome
2550 :     {
2551 :     my($self, $genome) = @_;
2552 :    
2553 :     my $idx = $self->get_genome_index($genome);
2554 :     if (!defined($idx))
2555 :     {
2556 : parrello 1.69 warn "Genome $genome not present\n";
2557 :     return undef;
2558 : olson 1.25 }
2559 :    
2560 :     #
2561 : olson 1.70 # Remove from database index (before we delete stuff from here,
2562 :     # so we have access to th e data structures).
2563 :     #
2564 :    
2565 :     my $rdbH = $self->{fig}->db_handle();
2566 :     my $dbh = $rdbH->{_dbh};
2567 :     my $cells = $self->get_row($idx);
2568 :     my $sub_name = $self->{name};
2569 :    
2570 :     my $sth = $dbh->prepare(qq(DELETE FROM subsystem_index
2571 :     WHERE (subsystem = ? AND
2572 :     role = ? AND
2573 :     protein = ?)
2574 :     ));
2575 :     for my $i (0 .. $#$cells)
2576 :     {
2577 :     my $cell = $cells->[$i];
2578 :     my $role = $self->get_role($i);
2579 :    
2580 :     for my $peg (@$cell)
2581 :     {
2582 :     $sth->execute($sub_name, $role, $peg);
2583 :     warn "Deleting $sub_name $role $peg\n";
2584 :     }
2585 :     }
2586 :    
2587 :     #
2588 : parrello 1.60 # Remove from the genomes list.
2589 : olson 1.25 #
2590 :    
2591 :     splice(@{$self->{genome}}, $idx, 1);
2592 : overbeek 1.43
2593 :     my $genome1;
2594 :     foreach $genome1 (@{$self->{genome}})
2595 :     {
2596 : parrello 1.69 if ($self->{genome_index}->{$genome1} > $idx)
2597 :     {
2598 :     $self->{genome_index}->{$genome1}--;
2599 :     }
2600 : overbeek 1.43 }
2601 : olson 1.25 splice(@{$self->{variant_code}}, $idx, 1);
2602 :    
2603 :     delete $self->{genome_index}->{$genome};
2604 :    
2605 :     #
2606 :     # Update the spreadsheet.
2607 :     # On the inverted one, we have to go through all the columns removing
2608 :     # the row from each.
2609 :     #
2610 :     # On the standard one, we just remove the row.
2611 :     #
2612 :    
2613 :     my $nr = @{$self->{roles}};
2614 :    
2615 :     for my $i (0 .. $nr - 1)
2616 :     {
2617 : parrello 1.69 splice(@{$self->{spreadsheet_inv}->[$i]}, $idx, 1);
2618 : olson 1.25 }
2619 :    
2620 :     splice(@{$self->{spreadsheet}}, $idx, 1);
2621 :    
2622 :     }
2623 :    
2624 : parrello 1.60 sub get_name :Scalar
2625 : olson 1.25 {
2626 :     my($self) = @_;
2627 : overbeek 1.53 my $name = $self->{name};
2628 :     $name =~ s/ /_/g;
2629 :     return $name;
2630 : olson 1.25 }
2631 : parrello 1.60
2632 :     sub get_dir :Scalar
2633 : overbeek 1.41 {
2634 :     my($self) = @_;
2635 :     return $self->{dir};
2636 :     }
2637 : olson 1.25
2638 : parrello 1.60
2639 :     sub get_version :Scalar
2640 : olson 1.25 {
2641 :     my($self) = @_;
2642 :     return $self->{version};
2643 : olson 1.17 }
2644 :    
2645 : parrello 1.73 =head3 get_notes
2646 :    
2647 :     C<< my $text = $sub->get_notes(); >>
2648 :    
2649 :     Return the descriptive notes for this subsystem.
2650 :    
2651 :     =cut
2652 :    
2653 : parrello 1.60 sub get_notes :Scalar
2654 : olson 1.26 {
2655 :     my($self) = @_;
2656 :    
2657 :     return $self->{notes};
2658 :     }
2659 :    
2660 : parrello 1.73 =head3 get_reactions
2661 :    
2662 :     C<< my $reactHash = $sub->get_reactions(); >>
2663 :    
2664 :     Return a reference to a hash that maps each role ID to a list of the reactions
2665 :     catalyzed by the role.
2666 :    
2667 :     =cut
2668 :    
2669 : overbeek 1.58 sub get_reactions
2670 :     {
2671 :     my($self) = @_;
2672 :    
2673 :     return $self->{reactions};
2674 :     }
2675 :    
2676 : overbeek 1.59 sub set_reaction {
2677 :     my($self,$role,$rstring) = @_;
2678 :    
2679 :     $self->{reactions}->{$role} = [split(/,\s*/,$rstring)];
2680 :     }
2681 :    
2682 :    
2683 : olson 1.26 sub set_notes
2684 :     {
2685 :     my($self, $notes) = @_;
2686 :    
2687 : olson 1.28 $self->{notes} = $notes;
2688 : olson 1.26 }
2689 :    
2690 : redwards 1.44 sub get_classification
2691 :     {
2692 :     my($self) = @_;
2693 :    
2694 :     return $self->{classification};
2695 :     }
2696 :    
2697 :     sub set_classification
2698 :     {
2699 :     my($self, $classification) = @_;
2700 :    
2701 :     $self->{classification}=$classification;
2702 :     }
2703 :    
2704 :    
2705 : parrello 1.73 =head3 get_curator
2706 :    
2707 :     C<< my $userName = $sub->get_curator(); >>
2708 :    
2709 :     Return the name of this subsystem's official curator.
2710 :    
2711 :     =cut
2712 : parrello 1.60
2713 :     sub get_curator :Scalar
2714 : olson 1.17 {
2715 :     my($self) = @_;
2716 :     return $self->{curator};
2717 :     }
2718 : overbeek 1.47
2719 : olson 1.25 #
2720 :     # Subsystem copying logic
2721 :     #
2722 :    
2723 : parrello 1.73 =head3 add_to_subsystem($subsystem_name, $columns, $notes_flag)
2724 : olson 1.25
2725 :     Merge the given columns from $subsystem_name into this subsystem. Append the
2726 :     notes from the subsystem if $notes_flag is true.
2727 :    
2728 :     =cut
2729 :    
2730 :     sub add_to_subsystem
2731 :     {
2732 :     my($self, $subsystem_name, $cols, $add_notes) = @_;
2733 :    
2734 :     my $ss = $self->{fig}->get_subsystem($subsystem_name);
2735 :    
2736 :     if (!$ss)
2737 :     {
2738 : parrello 1.69 warn "Cannot open subsystem '$subsystem_name' to copy from";
2739 :     return;
2740 : olson 1.25 }
2741 :    
2742 :     #
2743 :     # Merge the data from the other subsystem.
2744 :     #
2745 :     # First we assure ourselves that we have the appropriate roles. While
2746 :     # we do this, build the list of row indices (in this subsystem) that
2747 :     # map to the roles we are adding.
2748 :     #
2749 :    
2750 :     #
2751 :     # local_roles[$his_role] = $my_role (map from other role idx to local role idx)
2752 :     #
2753 : parrello 1.60
2754 : olson 1.25 my @local_roles;
2755 :    
2756 :     #
2757 :     # his_roles = list of role indices corresponding to the remote roles.
2758 :     #
2759 : overbeek 1.36 if ($cols->[0] eq "all")
2760 :     {
2761 : parrello 1.69 $cols = [$ss->get_roles];
2762 : overbeek 1.36 }
2763 :    
2764 : olson 1.25 my @his_roles;
2765 : parrello 1.60
2766 : olson 1.25 for my $his_role (@$cols)
2767 :     {
2768 : parrello 1.69 my $idx = $self->get_role_index($his_role);
2769 :     my $his_idx = $ss->get_role_index($his_role);
2770 :    
2771 :     if (!defined($his_idx))
2772 :     {
2773 :     confess "Cannot map his role $his_role\n";
2774 :     }
2775 :     push(@his_roles, $his_idx);
2776 : olson 1.25
2777 : parrello 1.69 if (!defined($idx))
2778 :     {
2779 :     my $his_abbr = $ss->get_role_abbr($his_idx);
2780 : parrello 1.60
2781 : parrello 1.69 $idx = $self->add_role($his_role, $his_abbr);
2782 :     # print "Adding missing role $his_role idx=$idx\n";
2783 :     }
2784 :     else
2785 :     {
2786 :     # print "Found existing role $his_role idx=$idx\n";
2787 :     }
2788 : olson 1.25
2789 : parrello 1.69
2790 :     $local_roles[$his_idx] = $idx;
2791 : olson 1.25 }
2792 :    
2793 :     #
2794 :     # Similar scan to ensure that we have rows for the genomes
2795 :     # that are in the other subsystem.
2796 :     #
2797 :    
2798 :     my @local_genomes;
2799 :    
2800 :     my @his_genomes = $ss->get_genomes();
2801 :    
2802 :     for my $his_idx (0..@his_genomes - 1)
2803 :     {
2804 : parrello 1.69 my $genome = $his_genomes[$his_idx];
2805 :    
2806 : overbeek 1.37
2807 : parrello 1.69 my $my_idx = $self->get_genome_index($genome);
2808 : parrello 1.60
2809 : parrello 1.69 if (!defined($my_idx))
2810 :     {
2811 :     #
2812 :     # Not there, need to add.
2813 :     #
2814 : olson 1.25
2815 : parrello 1.69 $my_idx = $self->add_genome($genome);
2816 :     # print "Adding missing genome $genome idx=$my_idx\n";
2817 :     }
2818 :     else
2819 :     {
2820 :     # print "Found existing genome $genome idx=$my_idx\n";
2821 :     }
2822 : parrello 1.60
2823 : parrello 1.69 $local_genomes[$his_idx] = $my_idx;
2824 : olson 1.25 }
2825 :    
2826 : parrello 1.60
2827 : olson 1.25 #
2828 :     # Now that we have our local roles set up to receive the data,
2829 :     # process the incoming roles one at a time.
2830 :     #
2831 :    
2832 :    
2833 :     for my $his_role (@his_roles)
2834 :     {
2835 : parrello 1.69 my $my_col = $self->get_col($local_roles[$his_role]);
2836 :     my $his_col = $ss->get_col($his_role);
2837 : olson 1.25
2838 : parrello 1.69 #
2839 :     # $his_col is the information for $his_role, indexed by
2840 :     # genome in @his_genomes.
2841 :     #
2842 :     # $my_col is hte information for my copy of $his_role,
2843 :     # indexed by genome in MY genome list.
2844 :     #
2845 : olson 1.25
2846 : parrello 1.69 my $my_role = $local_roles[$his_role];
2847 : olson 1.25
2848 : parrello 1.69 # print "merging: $self->{roles}->[$my_role] $ss->{roles}->[$his_role] his_role=$his_role my_role=$my_role\n";
2849 : olson 1.25
2850 : parrello 1.69 for my $his_gidx (0 .. @his_genomes - 1)
2851 :     {
2852 :     my $hisent = $his_col->[$his_gidx];
2853 : olson 1.25
2854 : parrello 1.69 my $my_gidx = $local_genomes[$his_gidx];
2855 : parrello 1.60
2856 : overbeek 1.37
2857 : parrello 1.69 my $myent = $my_col->[$my_gidx];
2858 : olson 1.25
2859 : parrello 1.69 # print " his_gidx=$his_gidx my_gidx=$my_gidx hisent=@$hisent myent=@$myent\n";
2860 : olson 1.25
2861 : parrello 1.69 my %new;
2862 :     map { $new{$_}++ } @$hisent;
2863 :     map { $new{$_}++ } @$myent;
2864 : olson 1.25
2865 : parrello 1.69 @$myent = keys(%new);
2866 : olson 1.25
2867 : parrello 1.69 # print " new entry: @$myent\n";
2868 :     }
2869 : olson 1.25 }
2870 : olson 1.26
2871 :     #
2872 :     # Fix up the variant codes.
2873 :     #
2874 :    
2875 :     for my $his_gidx (0 .. @his_genomes - 1)
2876 :     {
2877 : parrello 1.69 my $his_code = $ss->get_variant_code($his_gidx);
2878 :     my $my_gidx = $local_genomes[$his_gidx];
2879 : olson 1.26
2880 : parrello 1.69 if (!$self->get_variant_code($my_gidx))
2881 :     {
2882 :     $self->{variant_code}->[$my_gidx] = $his_code;
2883 :     }
2884 : olson 1.26 }
2885 :    
2886 :     #
2887 :     # If we are to add notes, append the other subsystem's notes text.
2888 :     #
2889 :    
2890 :     if ($add_notes)
2891 :     {
2892 : parrello 1.69 my $his_notes = $ss->get_notes();
2893 : olson 1.26
2894 : parrello 1.69 $self->{notes} .= "\nNotes copied from $ss->{name}:\n$his_notes\n";
2895 : olson 1.26 }
2896 : olson 1.25 }
2897 : olson 1.17
2898 : olson 1.1 sub dump
2899 :     {
2900 :     my($self) = @_;
2901 :    
2902 :     for my $k (keys(%$self))
2903 :     {
2904 : parrello 1.69 next if $k eq "spreadsheet" or $k eq "spreadsheet_inv";
2905 :     print "Key \"$k\": ", Dumper($self->{$k});
2906 : olson 1.1 }
2907 :     }
2908 : parrello 1.60
2909 : olson 1.14 #
2910 :     # Increment the subsystem's version number.
2911 :     #
2912 :     sub incr_version {
2913 :     my($self) = @_;
2914 :    
2915 :     my $dir = $self->{dir};
2916 :     my $vfile = "$dir/VERSION";
2917 :     my($ver);
2918 :    
2919 :     if (open(my $fh,"<$vfile"))
2920 :     {
2921 :     if (defined($ver = <$fh>) && ($ver =~ /^(\S+)/))
2922 :     {
2923 :     $ver = $1;
2924 :     }
2925 :     else
2926 :     {
2927 :     $ver = 0;
2928 :     }
2929 :     close($fh);
2930 :     }
2931 :     else
2932 :     {
2933 :     $ver = 0;
2934 :     }
2935 :    
2936 :     $ver++;
2937 :    
2938 :     open(my $fh, ">$vfile") || die "could not open $vfile";
2939 :     print $fh "$ver\n";
2940 :     close($fh);
2941 :    
2942 :     chmod(0777, $vfile);
2943 :    
2944 :     $self->load_version();
2945 :     }
2946 : olson 1.1
2947 : heiko 1.78
2948 :     =head3 functional_role_instances
2949 :    
2950 :     C<< my @role_instances = $sub->functional_role_instances($role); >>
2951 :    
2952 :     Returns the set of genes for a functional role that belong to
2953 :     genomes with functional variants (> 0).
2954 :    
2955 :     =cut
2956 :    
2957 :     sub functional_role_instances {
2958 :    
2959 :     my ($self, $role) = @_;
2960 :     my $i =0;
2961 :    
2962 :     my @instances;
2963 :    
2964 :     foreach my $cell (@{$self->get_col($self->get_role_index($role))}) {
2965 :    
2966 :     if ((scalar @$cell > 0) && ($self->get_variant_code($i) > 0)) {
2967 :     foreach (@$cell) {
2968 :     push @instances, $_;
2969 :     }
2970 :     }
2971 :     $i++;
2972 :     }
2973 :    
2974 :    
2975 :     return @instances if wantarray;
2976 :     return \@instances;
2977 :    
2978 :     }
2979 :    
2980 :    
2981 :    
2982 :    
2983 : parrello 1.75 =head3 get_dir_from_name
2984 :    
2985 :     C<< my $dirName = Subsystem::get_dir_from_name($name); >>
2986 :    
2987 :     Return the name of the directory containing the SEED data for the specified
2988 :     subsystem.
2989 :    
2990 :     =over 4
2991 :    
2992 :     =item name
2993 :    
2994 :     Name of the subsystem whose directory is desired.
2995 :    
2996 :     =item RETURN
2997 :    
2998 :     Returns the fully-qualified directory name for the subsystem.
2999 :    
3000 :     =back
3001 :    
3002 :     =cut
3003 :    
3004 : olson 1.1 sub get_dir_from_name
3005 :     {
3006 :     my($name) = @_;
3007 :    
3008 :     my $b = $name;
3009 :     $b =~ s/ /_/g;
3010 :     my $dir = File::Spec->catfile($FIG_Config::data, 'Subsystems', $b);
3011 :     return $dir;
3012 :     }
3013 :    
3014 : olson 1.12 #
3015 :     # Code for dealing with Bill McCune's prolog code for extending subsystems.
3016 :     #
3017 :     # The code here is a reconstruction of Bill's "go" script in perl with
3018 :     # data pulled from the local SEED configuration.
3019 :     #
3020 :    
3021 :     sub extend_with_billogix
3022 :     {
3023 : olson 1.42 my($self, $muser, $genomes) = @_;
3024 : olson 1.12 my($isMaster, $user);
3025 : parrello 1.60
3026 : olson 1.12 my $now = time();
3027 :    
3028 :     if ($muser =~ /master:(.*)/)
3029 :     {
3030 : parrello 1.69 $isMaster = 1;
3031 :     $user = $1;
3032 : olson 1.12 }
3033 :     else
3034 :     {
3035 : parrello 1.69 $isMaster = 0;
3036 :     $user = $muser;
3037 : olson 1.12 }
3038 :    
3039 :     #
3040 : olson 1.42 # initialize the genome list to all complete genomes, if none was passed in.
3041 :     #
3042 :    
3043 :     if (!$genomes)
3044 :     {
3045 : parrello 1.69 $genomes = [$self->{fig}->genomes("complete")];
3046 :     warn "getting genome list from fig $self->{fig}";
3047 : olson 1.42 }
3048 :    
3049 :     #
3050 :     # Ensure genome list is of the right form.
3051 :     #
3052 :    
3053 :     if (ref($genomes) ne "ARRAY")
3054 :     {
3055 : parrello 1.69 warn "billogix: genome list is not a list reference";
3056 :     return;
3057 : olson 1.42 }
3058 :    
3059 :     for my $g (@$genomes)
3060 :     {
3061 : parrello 1.69 if ($g !~ /^\d+\.\d+/)
3062 :     {
3063 :     warn "billogix: genome '$g' is not of the proper form, aborting billogix run.";
3064 :     return;
3065 :     }
3066 : olson 1.42 }
3067 : parrello 1.60
3068 : olson 1.42 my $genome_list = "[" . join(", ", map { "'$_'" } @$genomes) . "]";
3069 :    
3070 :     warn "Genomes: $genome_list\n";
3071 :     warn Dumper($genomes);
3072 : parrello 1.60
3073 : olson 1.42 #
3074 : olson 1.12 # Find the executable.
3075 :     #
3076 :    
3077 :     my $exe = "$FIG_Config::bin/billogix";
3078 :    
3079 :     if (! -x $exe)
3080 :     {
3081 : parrello 1.69 warn "Cannot find billogix exe at $exe\n";
3082 :     return;
3083 : olson 1.12 }
3084 : parrello 1.60
3085 : olson 1.12 my $ss_name = $self->{name};
3086 : olson 1.18
3087 :     $ss_name =~ s/\s+/_/g;
3088 : parrello 1.60
3089 : olson 1.14 my $ss_dir = "$self->{dir}/";
3090 : olson 1.15 my $assign_dir = "$FIG_Config::data/Assignments/$user/";
3091 : olson 1.12 &FIG::verify_dir($assign_dir);
3092 :    
3093 : olson 1.16 my $when= strftime("%m-%d-%y:%H:%M:%S", localtime($now));
3094 :     my $job_id = "${when}:sss:$ss_name";
3095 :    
3096 : olson 1.12 my $seed = &FIG::cgi_url() . "/";
3097 : olson 1.13 my $export_part = "ssa.cgi?user=$muser&request=delete_or_export_ssa&export=";
3098 : olson 1.12
3099 :     #
3100 :     # Have the prereq stuff, now start up the app.
3101 :     #
3102 :    
3103 :     $ENV{LOCALSZ} = "80000";
3104 :     $ENV{GLOBALSZ} = "80000";
3105 :     $ENV{TRAILSZ} = "30000";
3106 : olson 1.13
3107 :     my $arch = &FIG::get_current_arch();
3108 :    
3109 :     $ENV{BILLOGIX} = "$FIG_Config::fig_disk/dist/releases/current/$arch/lib/Billogix";
3110 :    
3111 :     #
3112 :     # Need to ensure pl2wam is in our path
3113 :     #
3114 :    
3115 :     $ENV{PATH} = "${FIG_Config::ext_bin}:$ENV{PATH}";
3116 : olson 1.12
3117 : olson 1.23 #
3118 :     # We're going to divide the run into $n_chunks chunks.
3119 :     #
3120 :    
3121 :     my $n_chunks = 10;
3122 :    
3123 :     my($log);
3124 :     open($log, ">$ss_dir/$job_id.log");
3125 :    
3126 :     for (my $this_chunk = 1; $this_chunk <= $n_chunks; $this_chunk++)
3127 :     {
3128 : parrello 1.69 my $app_input = <<EOINP;
3129 : olson 1.12 ['\$BILLOGIX/top'].
3130 :     loadup.
3131 : olson 1.42 asserta(job_genome_list($genome_list)).
3132 : olson 1.23 asserta(part($this_chunk, $n_chunks)).
3133 : olson 1.12 asserta(url_default_seed('$seed')).
3134 : olson 1.13 asserta(url_export_part('$export_part')).
3135 : olson 1.12 asserta(ss_directory('$ss_dir')).
3136 :     asserta(assign_directory('$assign_dir')).
3137 :     asserta(job_id('$job_id')).
3138 :     extend_test3('$ss_name').
3139 :     EOINP
3140 :    
3141 : olson 1.23 print STDERR <<EOF;
3142 : olson 1.12 Starting app
3143 :    
3144 : olson 1.23 chunk $this_chunk of $n_chunks
3145 : olson 1.12 ss_name = $ss_name
3146 :     ss_dir = $ss_dir
3147 :     user = $user
3148 :     assign_dir = $assign_dir
3149 :     exe = $exe
3150 : olson 1.13 libdir = $ENV{BILLOGIX}
3151 :     path = $ENV{PATH}
3152 : olson 1.12
3153 :     App input
3154 :     $app_input
3155 :     EOF
3156 :     # feh, put in a block to reset perlmode indentation.
3157 : olson 1.23 {
3158 : parrello 1.69 my($app_read, $app_write);
3159 : parrello 1.60
3160 : parrello 1.69 #
3161 :     # Start the actual application with stdin and stdout redirected
3162 :     # to pipes.
3163 :     #
3164 :     # We write $app_input to the stdin pipe, and close it.
3165 :     # Then loop reading stdout, logging that output.
3166 :     #
3167 :     my $pid = open2($app_read, $app_write, $exe);
3168 :    
3169 :     if (!$pid)
3170 :     {
3171 :     warn "open2 $exe failed: $!\n";
3172 :     print $log "open2 $exe failed: $!\n";
3173 :     return;
3174 :     }
3175 :    
3176 :     print $app_write $app_input;
3177 :     close($app_write);
3178 :    
3179 :     #
3180 :     # Set autoflush on the logfile.
3181 :     #
3182 :    
3183 :     my $old = select($log);
3184 :     $| = 1;
3185 :     select(STDERR);
3186 :     $| = 1;
3187 :     select($old);
3188 :    
3189 :     warn "Starting $exe with pid $pid\n";
3190 :     print $log "Starting $exe with pid $pid\n";
3191 :    
3192 :     while (<$app_read>)
3193 :     {
3194 :     print STDERR $_;
3195 :     print $log $_;
3196 :     }
3197 :    
3198 :     print STDERR "App done\n";
3199 :     print $log "App done\n";
3200 :    
3201 :     close($app_read);
3202 :    
3203 :     my $ret = waitpid($pid, 0);
3204 :     my $stat = $?;
3205 :     print STDERR "Return status is $?\n";
3206 :     print $log "Return status is $?\n";
3207 :    
3208 :     #
3209 :     # This chunk has finished. We should see a file
3210 :     # rows.$this_chunk.$n_chunks.
3211 :     #
3212 :     }
3213 : olson 1.23 }
3214 :     #
3215 :     # At this point, the extension is finished (we've run the
3216 :     # $n_chunks parts of the extension job).
3217 :     #
3218 : olson 1.12
3219 : olson 1.14 #
3220 : olson 1.23 # We read in all the individual rows files, writing the single
3221 :     # concatenation of rows.
3222 : olson 1.14 #
3223 : olson 1.12
3224 : olson 1.23 my $ssaD = $self->{dir};
3225 : parrello 1.60
3226 : olson 1.23 my $rows_file = "$ssaD/rows";
3227 :    
3228 :     my $rowFH;
3229 :     if (!open($rowFH, ">$rows_file"))
3230 : olson 1.12 {
3231 : parrello 1.69 my $err = "Cannot open rows file $ssaD/rows for writing: $!\n";
3232 :     print STDERR $err;
3233 :     print $log $err;
3234 :     return;
3235 : olson 1.12 }
3236 :    
3237 : olson 1.23 for (my $this_chunk = 1; $this_chunk <= $n_chunks; $this_chunk++)
3238 :     {
3239 : parrello 1.69 my $chunkFH;
3240 :     my $cfile = "$ssaD/rows.$this_chunk.$n_chunks";
3241 :     if (!open($chunkFH, "<$cfile"))
3242 :     {
3243 :     my $err = "Cannot open rows file $cfile for reading: $!\n";
3244 :     print STDERR $err;
3245 :     print $log $err;
3246 :     return;
3247 :     }
3248 :     while (<$chunkFH>)
3249 :     {
3250 :     print $rowFH $_;
3251 :     }
3252 :     close($chunkFH);
3253 : olson 1.23 }
3254 :     close($rowFH);
3255 : olson 1.12
3256 :     #
3257 : olson 1.23 # Concatenate the assignments into the assignment directory.
3258 : olson 1.12 #
3259 :    
3260 : olson 1.23 my $assignments_file = "$assign_dir$job_id";
3261 :     my $assignFH;
3262 : olson 1.12
3263 : olson 1.23 if (!open($assignFH, ">$assignments_file"))
3264 : olson 1.12 {
3265 : parrello 1.69 my $err = "Cannot open assignments file $assignments_file for writing: $!\n";
3266 :     print STDERR $err;
3267 :     print $log $err;
3268 :     return;
3269 : olson 1.12 }
3270 :    
3271 : olson 1.23 for (my $this_chunk = 1; $this_chunk <= $n_chunks; $this_chunk++)
3272 : olson 1.19 {
3273 : parrello 1.69 my $aFH;
3274 :     my $afile = "$ssaD/assignments.$this_chunk.$n_chunks";
3275 :     if (!open($aFH, "<$afile"))
3276 :     {
3277 :     my $err = "Cannot open assignments file $afile for reading: $!\n";
3278 :     print STDERR $err;
3279 :     print $log $err;
3280 :     return;
3281 :     }
3282 :     while (<$aFH>)
3283 :     {
3284 :     print $assignFH $_;
3285 :     }
3286 :     close($aFH);
3287 : olson 1.19 }
3288 : olson 1.23 close($assignFH);
3289 : olson 1.19
3290 : parrello 1.60
3291 :    
3292 : olson 1.19 #
3293 : olson 1.14 # Back up the spreadsheet, and append the rows file to it.
3294 :     #
3295 :    
3296 :     &FIG::verify_dir("$ssaD/Backup");
3297 :     my $ts = time;
3298 :     rename("$ssaD/spreadsheet~","$ssaD/Backup/spreadsheet.$ts");
3299 :     copy("$ssaD/spreadsheet","$ssaD/spreadsheet~");
3300 :     rename("$ssaD/notes~","$ssaD/Backup/notes.$ts");
3301 :    
3302 :     #
3303 :     # Append the new rows to the spreadsheet.
3304 :     #
3305 :    
3306 :     my($ssafh, $rowsfh);
3307 :     open($ssafh, ">>$ssaD/spreadsheet") or die "Cannot open $ssaD/spreadsheet for append: $!\n";
3308 :     open($rowsfh, "<$ssaD/rows") or die "Cannot open $ssaD/rows for reading: $!\n";
3309 : parrello 1.60
3310 : olson 1.14 while (<$rowsfh>)
3311 :     {
3312 : parrello 1.69 print $ssafh $_;
3313 : olson 1.14 }
3314 :     close($ssafh);
3315 :     close($rowsfh);
3316 :    
3317 :     $self->incr_version();
3318 : olson 1.12 }
3319 : olson 1.13
3320 : olson 1.14
3321 : olson 1.13 sub set_current_extend_pid
3322 :     {
3323 :     my($self, $pid) = @_;
3324 :    
3325 :     if (open(my $fh, ">$self->{dir}/EXTEND_PID"))
3326 :     {
3327 : parrello 1.69 print $fh "$pid\n";
3328 : olson 1.13 }
3329 :     else
3330 :     {
3331 : parrello 1.69 warn "Cannot open $self->{dir}/EXTEND_PID: $!\n";
3332 : olson 1.13 }
3333 :     }
3334 :    
3335 :     sub get_current_extend_pid
3336 :     {
3337 :     my($self) = @_;
3338 :    
3339 :     if (open(my $fh, "<$self->{dir}/EXTEND_PID"))
3340 :     {
3341 : parrello 1.69 my $pid = <$fh>;
3342 :     close($fh);
3343 :     if ($pid)
3344 :     {
3345 :     chomp $pid;
3346 : parrello 1.60
3347 : parrello 1.69 return $pid;
3348 :     }
3349 : olson 1.13 }
3350 :     return undef;
3351 :     }
3352 : parrello 1.60
3353 : parrello 1.75 =head2 Static Utilities
3354 :    
3355 :     These are internal static methods used by the Sprout Subsystem object
3356 :     (SproutSubsys.pm). They insure that common functions are implemented with
3357 :     common code.
3358 :    
3359 :     =head3 GetDiagramIDs
3360 :    
3361 :     C<< my @diagramIDs = Subsystem::GetDiagramIDs($subDir); >>
3362 :    
3363 :     Return a list of the subsystem diagram IDs. The parameters are
3364 :    
3365 :     =over 4
3366 :    
3367 :     =item subDir
3368 :    
3369 :     Fully-qualified directory name for the subsystem.
3370 :    
3371 :     =item RETURN
3372 :    
3373 :     Returns a list of the diagram IDs for this subsystem. Each diagram ID corresponds
3374 :     to a diagram subdirectory in the subsystem's directory.
3375 :    
3376 :     =back
3377 :    
3378 :     =cut
3379 :    
3380 :     sub GetDiagramIDs {
3381 :     # Get the parameters.
3382 :     my ($subDir) = @_;
3383 :     # Read the diagram subdirectories.
3384 :     opendir(D, "$subDir/diagrams");
3385 :     my @ids = grep { not /^\./ and -d "$subDir/diagrams/$_" } readdir(D);
3386 :     closedir(D);
3387 :     # Return the IDs.
3388 :     return @ids;
3389 :    
3390 :     }
3391 :    
3392 :     =head3 GetDiagramName
3393 :    
3394 :     C<< my $name = Subsystem::GetDiagramName($subDir, $diagramID); >>
3395 :    
3396 :     Return the name of the subsystem diagram with the specified ID.
3397 :    
3398 :     =over 4
3399 :    
3400 :     =item subDir
3401 :    
3402 :     Subsystem directory name.
3403 :    
3404 :     =item diagramID
3405 :    
3406 :     ID of the diagram whose name is desired.
3407 :    
3408 :     =item RETURN
3409 :    
3410 :     Returns the name of the specified diagram, or C<undef> if the diagram does
3411 :     not exist.
3412 :    
3413 :     =back
3414 :    
3415 :     =cut
3416 :    
3417 :     sub GetDiagramName {
3418 :     # Get the parameters.
3419 :     my ($subDir, $diagramID) = @_;
3420 : parrello 1.77 # Declare the return value.
3421 :     my $retVal;
3422 : parrello 1.75 # Get the diagram's directory.
3423 :     my $ddir = "$subDir/diagrams/$diagramID";
3424 : parrello 1.77 Trace("Looking for directory $ddir.") if T(3);
3425 : parrello 1.75 # Only proceed if the directory exists.
3426 : parrello 1.77 if (-d $ddir) {
3427 :     # Read the name.
3428 :     my $name = &FIG::file_head("$ddir/NAME", 1);
3429 :     # If there was no name, use the diagram ID.
3430 :     Trace("Diagram name is \"$name\".") if T(3);
3431 :     if (! $name) {
3432 :     Trace("Using default name $diagramID.") if T(3);
3433 :     $name = $diagramID;
3434 :     }
3435 :     # Lop off the line terminator.
3436 :     chomp ($name);
3437 :     # Return the result.
3438 :     $retVal = $name;
3439 :     }
3440 :     Trace("Returning diagram name \"$retVal\".") if T(3);
3441 :     return $retVal;
3442 : parrello 1.75 }
3443 :    
3444 :     =head3 ComputeDiagramURLs
3445 :    
3446 :     C<< my ($link, $imgLink) = Subsystem::ComputeDiagramURLs($ssName, $diagramID); >>
3447 :    
3448 :     This is an internal static method that computes the URLs for a subsystem diagram.
3449 :     It insures that both SEED and Sprout use the same rules for generating the
3450 :     diagram URLs. The parameters are as follows.
3451 :    
3452 :     =over 4
3453 :    
3454 :     =item ssName
3455 :    
3456 :     Name of the relevant subsystem.
3457 :    
3458 :     =item diagramID
3459 :    
3460 :     ID of the relevant diagram.
3461 :    
3462 :     =item RETURN
3463 :    
3464 :     Returns a two-element list, the first element of which is a link to the diagram
3465 :     page, and the second of which is a link to the diagram image.
3466 :    
3467 :     =back
3468 :    
3469 :     =cut
3470 :    
3471 :     sub ComputeDiagramURLs {
3472 :     # Get the parameters.
3473 :     my ($ssName, $diagramID) = @_;
3474 :     # Compute the CGI directory base. Originally this was a configuration
3475 :     # parameter. Now we use a dot to force a relative URL.
3476 :     # my $base = $FIG_Config::cgi_base;
3477 :     my $base = './';
3478 :     # Create the links.
3479 :     my $link = $base . "subsys_diagram.cgi?ssa=$ssName&diagram=$diagramID";
3480 :     my $img_link = $link . "&image=1";
3481 :     # Return them.
3482 :     return ($link, $img_link);
3483 :     }
3484 :    
3485 : olson 1.7 package Subsystem::Diagram;
3486 :    
3487 :     sub new
3488 :     {
3489 :     my($class, $sub, $fig, $name, $dir) = @_;
3490 :    
3491 :     if (!-d $dir)
3492 :     {
3493 : parrello 1.69 return undef;
3494 : olson 1.7 }
3495 :    
3496 :     my $self = {
3497 : parrello 1.69 fig => $fig,
3498 :     subsystem => $sub,
3499 :     name => $name,
3500 :     dir =>$ dir,
3501 : olson 1.7 };
3502 :     bless $self, $class;
3503 :    
3504 :     $self->load();
3505 :    
3506 :     return $self;
3507 :     }
3508 :    
3509 :     #
3510 :     # Parse the diagram into internal data structure.
3511 :     #
3512 :    
3513 :     sub load
3514 :     {
3515 :     my($self) = @_;
3516 :    
3517 :     $self->load_area();
3518 :     }
3519 :    
3520 :     sub load_area
3521 :     {
3522 :     my($self) = @_;
3523 :     my $fh;
3524 :    
3525 : olson 1.8 if (!open($fh, "<$self->{dir}/area_table"))
3526 : olson 1.7 {
3527 : parrello 1.69 warn "Could not load $self->{dir}/area_table: $!\n";
3528 :     return;
3529 : olson 1.7 }
3530 :    
3531 :     $self->{areas} = [];
3532 :    
3533 :     my $area_list = $self->{areas};
3534 : parrello 1.60
3535 : olson 1.7 while (<$fh>)
3536 :     {
3537 : parrello 1.69 chomp;
3538 :     s/#.*$//;
3539 :     s/^\s+//;
3540 :     s/\s+$//;
3541 :     next if $_ eq '';
3542 :     my ($area, $tag, $value) = split(/\s+/, $_, 3);
3543 :     # print "area=$area tag=$tag value=$value\n";
3544 :    
3545 :     push(@$area_list, [$area, $tag, $value]);
3546 :    
3547 :     #
3548 :     # Do a little checking.
3549 :     #
3550 :    
3551 :     if ($tag eq "role")
3552 :     {
3553 :     my $idx = $self->{subsystem}->get_role_index($value);
3554 :     if (!defined($idx))
3555 :     {
3556 :     warn "Role not found for \"$value\" in subsystem $self->{subsystem}->{name}\n";
3557 :     }
3558 :     }
3559 : olson 1.7 }
3560 :     close($fh);
3561 :     }
3562 :    
3563 :     sub get_areas
3564 :     {
3565 :     my($self) = @_;
3566 :    
3567 :     return @{$self->{areas}};
3568 :     }
3569 :    
3570 : parrello 1.75
3571 : olson 1.1 1;
3572 : olson 1.7
3573 : parrello 1.73 =head2 Method Listing
3574 :    
3575 :     =over 4
3576 :    
3577 :     =item index_cell
3578 :    
3579 :     Create the subsystem_index entries for the given cell.
3580 :     (NEW).
3581 :    
3582 :     =item delete_role(name)
3583 :    
3584 :     Delete the given role.
3585 :    
3586 :     =item add_role(name, abbr)
3587 :    
3588 :     Add a new role.
3589 :    
3590 :     =item get_subset(name)
3591 :    
3592 :     A deprecated form of get_subsetC
3593 :    
3594 :     =item get_subsetC(name)
3595 :    
3596 :     Returns a given subset. A subset is an object, implemented as a blessed array
3597 :     of roles.
3598 :    
3599 :     =item add_genome(genome_id, variant_code)
3600 :    
3601 :     =item remove_genome(genome_id)
3602 :    
3603 :     =back
3604 :    
3605 :     =cut
3606 : olson 1.7

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3