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

Annotation of /FigKernelPackages/Subsystem.pm

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.83 - (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.82 next if ($seen{$genome} || (! $self->{fig}->is_genome($genome)));
1073 : parrello 1.69 $seen{$genome}++;
1074 :    
1075 :     my $j = 0;
1076 :    
1077 :     $self->{genome}->[$i] = $genome;
1078 :     $self->{genome_index}->{$genome} = $i;
1079 :     $self->{variant_code}->[$i] = $variant_code;
1080 : olson 1.1
1081 : parrello 1.69 my $thislen = @row;
1082 :    
1083 :     # if ($thislen != $nr)
1084 :     # {
1085 :     # warn "Genome $genome has wrong column count ($thislen != $nr)\n";
1086 :     # warn "<$_> $genome $variant_code '", join(":", @row), "'\n";
1087 :     # }
1088 :    
1089 :     for my $j (0..$nr - 1)
1090 :     {
1091 :     my $entry = $row[$j];
1092 :     my $e2 = [map("fig|$genome.peg.$_", split(/,/, $entry))];
1093 :     $self->{spreadsheet}->[$i]->[$j] = $e2;
1094 :     $self->{spreadsheet_inv}->[$j]->[$i] = $e2;
1095 :     $j++;
1096 :     }
1097 :     $i++;
1098 : parrello 1.60
1099 : olson 1.1 }
1100 :     }
1101 :    
1102 : parrello 1.73 =head3 write_subsystem
1103 : olson 1.25
1104 :     Write the subsystem to the disk. Updates on-disk data with notes,
1105 :     etc. Perform backups when necessary.
1106 :    
1107 :     =cut
1108 :    
1109 :     sub write_subsystem
1110 :     {
1111 : olson 1.68 my($self, $force_backup) = @_;
1112 : olson 1.25
1113 :     my $dir = $self->{dir};
1114 :     my $fig = $self->{fig};
1115 :    
1116 :     #
1117 :     # We first move the existing spreadsheet and notes files (if present)
1118 :     # to spreadsheet~ and notes~, and current state.
1119 :     #
1120 :    
1121 :     my $ss_file = "$dir/spreadsheet";
1122 :     my $ss_bak = "$dir/spreadsheet~";
1123 :     my $notes_file = "$dir/notes";
1124 :     my $notes_bak = "$dir/notes~";
1125 : overbeek 1.58 my $reactions_file = "$dir/reactions";
1126 :     my $reactions_bak = "$dir/reactions~";
1127 : redwards 1.44 my $classification_file = "$dir/CLASSIFICATION";
1128 : olson 1.25
1129 :     if (-f $ss_file)
1130 :     {
1131 : parrello 1.69 rename($ss_file, $ss_bak);
1132 : olson 1.25 }
1133 :    
1134 :     if (-f $notes_file)
1135 :     {
1136 : parrello 1.69 rename($notes_file, $notes_bak);
1137 : olson 1.25 }
1138 :    
1139 : overbeek 1.58 if (-f $reactions_file)
1140 :     {
1141 : parrello 1.69 rename($reactions_file, $reactions_bak) or warn "rename $reactions_file $reactions_bak failed $!";
1142 :     # print STDERR "wrote $reactions_bak\n";
1143 : overbeek 1.58 }
1144 :    
1145 : olson 1.25 #
1146 :     # Eval this whole chunk, so that if we get any fatal errors, we can
1147 :     # roll back to the old saved data.
1148 :     #
1149 : parrello 1.60
1150 : olson 1.25 eval {
1151 : parrello 1.69 my $fh;
1152 :     open($fh, ">$ss_file") or die "Cannot open $ss_file for writing: $!\n";
1153 :     $self->write_spreadsheet($fh);
1154 :     close($fh);
1155 :     chmod(0777,$ss_file);
1156 :    
1157 :     open($fh, ">$notes_file") or die "Cannot open $notes_file for writing: $!\n";
1158 :     print $fh "$self->{notes}\n";
1159 :     close($fh);
1160 :     chmod(0777,$notes_file);
1161 :    
1162 :     open($fh, ">$reactions_file") or die "Cannot open $reactions_file for writing: $!\n";
1163 :     my $reactions = $self->{reactions};
1164 :     foreach $_ (sort keys(%$reactions))
1165 :     {
1166 :     print $fh "$_\t" . join(",", @{$reactions->{$_}}), "\n";
1167 :     }
1168 :     close($fh);
1169 :     chmod(0777,$reactions_file);
1170 :    
1171 :     open($fh, ">$classification_file") or die "Can not open $classification_file for writing: $!\n";
1172 :     print $fh join "\t", (@{$self->{classification}}), "\n";
1173 :     close($fh);
1174 :     chmod(0777,$classification_file);
1175 :    
1176 :     $self->update_curation_log();
1177 :    
1178 :     #
1179 :     # Write out the piddly stuff.
1180 :     #
1181 :    
1182 :     open($fh, ">$dir/EXCHANGABLE") or die "Cannot write $dir/EXCHANGABLE: $!\n";
1183 :     print $fh "$self->{exchangable}\n";
1184 :     close($fh);
1185 :     chmod(0777,"EXCHANGABLE");
1186 :    
1187 :     #
1188 :     # Process backup files. This is the smae process that determines when the
1189 :     # version number should be bumped, so write the version file afterward.
1190 :     #
1191 :    
1192 :     $self->update_backups($force_backup);
1193 :    
1194 :     if ($self->{version} < 100) { $self->{version} += 100 }
1195 :     open($fh, ">$dir/VERSION") or die "Cannot write $dir/VERSION: $!\n";
1196 :     print $fh "$self->{version}\n";
1197 :     close($fh);
1198 :     chmod(0777,"VERSION");
1199 : olson 1.25 };
1200 :    
1201 :     if ($@ ne "")
1202 :     {
1203 : parrello 1.69 warn "Spreadsheet write failed, reverting to backup. Error was\n$@\n";
1204 : olson 1.25 }
1205 : parrello 1.60
1206 : olson 1.25 }
1207 :    
1208 :     sub update_curation_log
1209 :     {
1210 :     my($self) = @_;
1211 :    
1212 :     my $fh;
1213 :     my $file = "$self->{dir}/curation.log";
1214 :    
1215 :     my $now = time;
1216 :     my $user = $self->{fig}->get_user();
1217 :    
1218 :     if (-f $file)
1219 :     {
1220 : parrello 1.69 open($fh, ">>$file") or die "Cannot open $file for writing: $!\n";
1221 : olson 1.25 }
1222 :     else
1223 :     {
1224 : parrello 1.69 open($fh, ">$file") or die "Cannot open $file for writing: $!\n";
1225 :     print $fh "$now\t$user\tstarted\n";
1226 : olson 1.25 }
1227 :     print $fh "$now\t$user\tupdated\n";
1228 :     close($fh);
1229 :     }
1230 :    
1231 :     sub update_backups
1232 :     {
1233 : olson 1.68 my($self, $force_backup) = @_;
1234 : olson 1.25
1235 :     my $dir = $self->{dir};
1236 :     my $fig = $self->{fig};
1237 :    
1238 :     my $ss_file = "$dir/spreadsheet";
1239 :     my $ss_bak = "$dir/spreadsheet~";
1240 :     my $notes_file = "$dir/notes";
1241 :     my $notes_bak = "$dir/notes~";
1242 : overbeek 1.58 my $reactions_file = "$dir/reactions";
1243 :     my $reactions_bak = "$dir/reactions~";
1244 : olson 1.25
1245 :     my $ss_diff = abs((-s $ss_file) - (-s $ss_bak));
1246 :     my $notes_diff = abs((-s $notes_file) - (-s $notes_bak));
1247 : olson 1.68 my $reactions_diff = (system("cmp", "-s", $reactions_file, $reactions_bak) != 0);
1248 : overbeek 1.59 # print STDERR "reactions_file=$reactions_file reactions_bak=$reactions_bak dif=$reactions_diff\n";
1249 : olson 1.25
1250 : olson 1.68 if ($force_backup or ($ss_diff > 10) or ($notes_diff > 10) or $reactions_diff)
1251 : olson 1.25 {
1252 : parrello 1.69 $self->make_backup();
1253 : olson 1.25 }
1254 :     }
1255 :    
1256 :     sub make_backup
1257 :     {
1258 :     my($self) = @_;
1259 :    
1260 :     my $dir = $self->{dir};
1261 :     my $bak = "$dir/Backup";
1262 :    
1263 :     $self->{fig}->verify_dir($bak);
1264 :    
1265 :     my $ts = time;
1266 :    
1267 :     rename("$dir/spreadsheet~", "$bak/spreadsheet.$ts");
1268 :     rename("$dir/notes~", "$bak/notes.$ts");
1269 : overbeek 1.58 rename("$dir/reactions~", "$bak/reactions.$ts");
1270 : olson 1.25 $self->{version}++;
1271 :     }
1272 :    
1273 :    
1274 :    
1275 : parrello 1.73 =head3 write_spreadsheet
1276 : olson 1.25
1277 : parrello 1.73 C<< $sub->write_spreadsheet($fh); >>
1278 : olson 1.25
1279 :     Write the spreadsheet for this subsystem to filehandle $fh.
1280 :    
1281 :     =cut
1282 :    
1283 :     sub write_spreadsheet
1284 :     {
1285 :     my($self, $fh) = @_;
1286 :    
1287 :     $self->_write_roles($fh);
1288 :     print $fh "//\n";
1289 :    
1290 :     $self->_write_subsets($fh);
1291 :     print $fh "//\n";
1292 :    
1293 :     $self->_write_spreadsheet($fh);
1294 :     }
1295 :    
1296 :     sub _write_roles
1297 :     {
1298 :     my($self, $fh) = @_;
1299 :    
1300 :     my(@roles, @abbrs);
1301 :    
1302 :     @roles = $self->get_roles();
1303 :     @abbrs = $self->get_abbrs();
1304 :    
1305 :     while (@roles)
1306 :     {
1307 : parrello 1.69 my $role = shift(@roles);
1308 :     my $abbr = shift(@abbrs);
1309 : olson 1.25
1310 : parrello 1.69 print $fh "$abbr\t$role\n";
1311 : olson 1.25 }
1312 :     }
1313 :    
1314 :     sub _write_subsets
1315 :     {
1316 :     my($self, $fh) = @_;
1317 :    
1318 : overbeek 1.31 for my $sub ($self->get_subset_namesC())
1319 : olson 1.25 {
1320 : parrello 1.69 next if ($sub eq "All");
1321 :     my @members= $self->get_subsetC($sub);
1322 : olson 1.25
1323 : parrello 1.69 #
1324 :     # member list on disk is 1-based
1325 :     #
1326 : olson 1.25
1327 : parrello 1.69 @members = map { $_ + 1 } @members;
1328 :     print $fh join("\t", $sub, @members), "\n";
1329 : olson 1.25 }
1330 : overbeek 1.39 my $active_row_subset = $self->{row_active_subset};
1331 :     my $active_col_subset = $self->{col_active_subset};
1332 :    
1333 :     print $fh "$active_col_subset\n";
1334 : olson 1.25
1335 :     #
1336 :     # separator
1337 :     #
1338 :    
1339 :     print $fh "\n";
1340 : parrello 1.60
1341 : olson 1.25 #
1342 :     # genome subsets.
1343 :     #
1344 :    
1345 : overbeek 1.39 print $fh "$active_row_subset\n";
1346 : olson 1.25 }
1347 :    
1348 :     sub _write_spreadsheet
1349 :     {
1350 :     my($self, $fh) = @_;
1351 :    
1352 :     my(@genomes);
1353 :    
1354 :     @genomes= $self->get_genomes();
1355 :    
1356 :     for (my $i = 0; $i < @genomes; $i++)
1357 :     {
1358 : parrello 1.69 my $genome = $genomes[$i];
1359 :     my $vc = $self->get_variant_code($i);
1360 :    
1361 :     my $row = $self->get_row($i);
1362 :    
1363 :     if ($vc eq "")
1364 :     {
1365 :     $vc = "0";
1366 :     }
1367 :     print $fh "$genome\t$vc";
1368 : olson 1.25
1369 : parrello 1.69 for my $entry (@$row)
1370 :     {
1371 :     my(@p);
1372 : olson 1.25
1373 : parrello 1.69 for my $peg (@$entry)
1374 :     {
1375 :     if ($peg =~ /fig\|$genome\.peg\.(\d+)$/)
1376 :     {
1377 :     push(@p, $1);
1378 :     }
1379 :     else
1380 :     {
1381 :     warn "Bad peg $peg in cell for $genome";
1382 :     }
1383 :     }
1384 :     print $fh "\t", join(",", @p);
1385 :     }
1386 :     print $fh "\n";
1387 : olson 1.25 }
1388 :     }
1389 :    
1390 : parrello 1.73 =head3 get_genomes
1391 : olson 1.25
1392 : parrello 1.73 C<< my @genomeList = $sub->get_genomes(); >>
1393 : olson 1.25
1394 : parrello 1.73 Return a list of the genome IDs for this subsystem. Each genome corresponds to a row
1395 :     in the subsystem spreadsheet. Indexing into this list returns the ID of the genome
1396 :     in the specified row.
1397 : olson 1.2
1398 :     =cut
1399 : olson 1.25
1400 : olson 1.2 sub get_genomes
1401 :     {
1402 :     my($self) = @_;
1403 :    
1404 :     my $glist = $self->{genome};
1405 :    
1406 : olson 1.25 return @$glist;
1407 : olson 1.2 }
1408 :    
1409 : parrello 1.73 =head3 get_variant_codes
1410 :    
1411 :     C<< my @codes = $sub->get_variant_codes(); >>
1412 : olson 1.2
1413 : parrello 1.73 Return a list of the variant codes for each genome, in row index order. The variant
1414 :     code indicates which variation of the subsystem is used by the given genome.
1415 : olson 1.2
1416 :     =cut
1417 : olson 1.25
1418 : olson 1.2 sub get_variant_codes
1419 :     {
1420 :     my($self) = @_;
1421 :    
1422 :     my $glist = $self->{variant_code};
1423 :    
1424 : olson 1.25 return @$glist;
1425 :     }
1426 :    
1427 : parrello 1.73 =head3 get_variant_code
1428 :    
1429 :     C<< my $code = $sub->get_variant_code($gidx); >>
1430 :    
1431 :     Return the variant code for the specified genome. Each subsystem has multiple
1432 :     variants which involve slightly different chemical reactions, and each variant
1433 :     has an associated variant code. When a genome is connected to the spreadsheet,
1434 :     the subsystem variant used by the genome must be specified.
1435 :    
1436 :     =over 4
1437 :    
1438 :     =item gidx
1439 :    
1440 :     Row index for the genome whose variant code is desired.
1441 :    
1442 :     =item RETURN
1443 :    
1444 :     Returns the variant code for the specified genome.
1445 :    
1446 :     =back
1447 :    
1448 :     =cut
1449 :    
1450 : olson 1.25 sub get_variant_code
1451 :     {
1452 :     my($self, $gidx) = @_;
1453 : overbeek 1.46 my $c = $self->{variant_code}->[$gidx];
1454 :     $c =~ s/ //g;
1455 :     return $c;
1456 : olson 1.2 }
1457 :    
1458 : overbeek 1.34 sub set_variant_code
1459 :     {
1460 :     my($self, $gidx, $val) = @_;
1461 :     $self->{variant_code}->[$gidx] = $val;
1462 : olson 1.70
1463 :     #
1464 :     # Update the index for all the pegs in this row.
1465 :     # (only if we have a new database)
1466 :     #
1467 :    
1468 :     if ($self->{old_database})
1469 :     {
1470 :     return;
1471 :     }
1472 : parrello 1.73
1473 : olson 1.70 my $rdbH = $self->{fig}->db_handle();
1474 :     my $dbh = $rdbH->{_dbh};
1475 :     my $cells = $self->get_row($gidx);
1476 :     my $sub_name = $self->{name};
1477 :    
1478 :     my $sth = $dbh->prepare(qq(UPDATE subsystem_index
1479 :     SET variant = ?
1480 :     WHERE (subsystem = ? AND
1481 :     role = ? AND
1482 :     protein = ?)
1483 :     ));
1484 :     for my $i (0 .. $#$cells)
1485 :     {
1486 :     my $cell = $cells->[$i];
1487 :     my $role = $self->get_role($i);
1488 :    
1489 :     for my $peg (@$cell)
1490 :     {
1491 :     $sth->execute($val, $sub_name, $role, $peg);
1492 : olson 1.79 #warn "Update variant $sub_name $role $peg v='$val'\n";
1493 : olson 1.70 }
1494 :     }
1495 :    
1496 : overbeek 1.34 return;
1497 :     }
1498 :    
1499 : olson 1.25
1500 : olson 1.2 sub get_variant_code_for_genome
1501 :     {
1502 :     my($self, $genome) = @_;
1503 :     my $index = $self->{genome_index}->{$genome};
1504 : redwards 1.55 if (defined $index) {
1505 :     return $self->{variant_code}->[$index];
1506 :     }
1507 :     else {
1508 :     return undef;
1509 :     }
1510 : olson 1.2 }
1511 :    
1512 : parrello 1.73 =head3 get_roles
1513 :    
1514 :     C<< my @roles = $sub->get_roles(); >>
1515 :    
1516 :     Return a list of the subsystem's roles. Each role corresponds to a column
1517 :     in the subsystem spreadsheet. The list entry at a specified position in
1518 :     the list will contain the ID of that column's role.
1519 :    
1520 :     =cut
1521 :    
1522 : olson 1.2 sub get_roles
1523 :     {
1524 :     my($self) = @_;
1525 :    
1526 :     my $rlist = $self->{roles};
1527 :    
1528 : olson 1.83 return ref($rlist) ? @$rlist : ();
1529 : olson 1.25 }
1530 :    
1531 :     sub get_abbrs
1532 :     {
1533 :     my($self) = @_;
1534 :    
1535 :     my $rlist = $self->{role_abbrs};
1536 :    
1537 : olson 1.83 return ref($rlist) ? @$rlist : ();
1538 : olson 1.2 }
1539 :    
1540 : olson 1.29 sub roles_with_abbreviations
1541 :     {
1542 :     my($self) = @_;
1543 :    
1544 :     my @ret;
1545 :    
1546 :     for my $i (0..@{$self->{roles}} - 1)
1547 :     {
1548 : parrello 1.69 push(@ret, [$self->{role_abbrs}->[$i], $self->{roles}->[$i]]);
1549 : olson 1.29 }
1550 :     return @ret;
1551 :     }
1552 :    
1553 :    
1554 : olson 1.52 sub get_sorted_rows
1555 :     {
1556 :     my($self, $sort_order) = @_;
1557 :    
1558 :     my $fig = $self->{fig};
1559 :    
1560 :     my @rows;
1561 :     for (my $i = 0; $i < @{$self->{genome}}; $i++)
1562 :     {
1563 : parrello 1.69 my $gid = $self->{genome}->[$i];
1564 :     my $gs = $fig->genus_species($gid);
1565 : olson 1.52
1566 : parrello 1.69 my $q = quotemeta($gid);
1567 :     my $cells = [];
1568 :     for my $c (@{$self->{spreadsheet}->[$i]})
1569 :     {
1570 :     push(@$cells, [map { s/^fig\|$q\.peg\.//; $_ } @$c]);
1571 :     }
1572 : olson 1.52
1573 : parrello 1.69 push(@rows, [$self->{genome}->[$i], $gs, $self->{variant_code}->[$i], $cells]);
1574 : olson 1.52 }
1575 :    
1576 :     if ($sort_order eq "by_phylo")
1577 :     {
1578 : parrello 1.69 return(map { $_->[0] }
1579 :     sort { ($a->[1] cmp $b->[1]) or ($a->[0]->[1] cmp $b->[0]->[1]) }
1580 :     map { [$_, $fig->taxonomy_of($_->[0]) ] } @rows);
1581 : olson 1.52 }
1582 :     elsif ($sort_order eq "alphabetic")
1583 :     {
1584 : parrello 1.69 return sort { ($a->[1] cmp $b->[1]) or ($a->[0] <=> $b->[0]) } @rows;
1585 : olson 1.52 }
1586 :     elsif ($sort_order eq "by_tax_id")
1587 :     {
1588 : parrello 1.69 return sort { $a->[0] <=> $b->[0] } @rows;
1589 : olson 1.52 }
1590 :     else
1591 :     {
1592 : parrello 1.69 return @rows;
1593 : olson 1.52 }
1594 :     }
1595 :    
1596 :    
1597 : parrello 1.60 sub get_row :Scalar
1598 : olson 1.1 {
1599 :     my($self, $row) = @_;
1600 :    
1601 :     return $self->{spreadsheet}->[$row];
1602 :     }
1603 :    
1604 : parrello 1.60 sub get_col :Scalar
1605 : olson 1.1 {
1606 :     my($self, $col) = @_;
1607 :    
1608 :     return $self->{spreadsheet_inv}->[$col];
1609 :     }
1610 :    
1611 : parrello 1.60 sub get_cell :Scalar
1612 : olson 1.1 {
1613 :     my($self, $row, $col) = @_;
1614 :    
1615 : olson 1.5 my $cell = $self->{spreadsheet}->[$row]->[$col];
1616 : overbeek 1.37 if (! defined($cell))
1617 :     {
1618 : parrello 1.69 $cell = $self->{spreadsheet}->[$row]->[$col] = [];
1619 : overbeek 1.37 }
1620 : olson 1.5 return $cell;
1621 : olson 1.1 }
1622 :    
1623 : parrello 1.73 =head3 get_genome_index
1624 :    
1625 :     C<< my $idx = $sub->get_genome_index($genome); >>
1626 :    
1627 :     Return the row index for the genome with the specified ID.
1628 :    
1629 :     =over 4
1630 :    
1631 :     =item genome
1632 :    
1633 :     ID of the genome whose row index is desired.
1634 :    
1635 :     =item RETURN
1636 :    
1637 :     Returns the row index for the genome with the specified ID, or an undefined
1638 :     value if the genome does not participate in the subsystem.
1639 :    
1640 :     =back
1641 :    
1642 :     =cut
1643 :    
1644 : parrello 1.60 sub get_genome_index :Scalar
1645 : olson 1.3 {
1646 :     my($self, $genome) = @_;
1647 :    
1648 :     return $self->{genome_index}->{$genome};
1649 :     }
1650 :    
1651 : parrello 1.60 sub get_genome :Scalar
1652 : olson 1.3 {
1653 :     my($self, $gidx) = @_;
1654 :    
1655 :     return $self->{genome}->[$gidx];
1656 :     }
1657 :    
1658 : parrello 1.73 =head3 get_role_index
1659 :    
1660 :     C<< my $idx = $sub->get_role_index($role); >>
1661 :    
1662 :     Return the column index for the role with the specified ID.
1663 :    
1664 :     =over 4
1665 :    
1666 :     =item role
1667 :    
1668 :     ID (full name) of the role whose column index is desired.
1669 :    
1670 :     =item RETURN
1671 :    
1672 :     Returns the column index for the role with the specified name.
1673 :    
1674 :     =back
1675 :    
1676 :     =cut
1677 :    
1678 : parrello 1.60 sub get_role_index :Scalar
1679 : olson 1.5 {
1680 :     my($self, $role) = @_;
1681 :    
1682 :     return $self->{role_index}->{$role};
1683 :     }
1684 :    
1685 : parrello 1.60 sub get_role :Scalar
1686 : olson 1.3 {
1687 :     my($self, $ridx) = @_;
1688 :    
1689 :     return $self->{roles}->[$ridx];
1690 :     }
1691 :    
1692 : parrello 1.73 =head3 get_role_abbr
1693 :    
1694 :     C<< my $abbr = $sub->get_role_abbr($ridx); >>
1695 :    
1696 :     Return the abbreviation for the role in the specified column. The abbreviation
1697 :     is a shortened identifier that is not necessarily unique, but is more likely to
1698 :     fit in a column heading.
1699 :    
1700 :     =over 4
1701 :    
1702 :     =item ridx
1703 :    
1704 :     Column index for the role whose abbreviation is desired.
1705 :    
1706 :     =item RETURN
1707 :    
1708 :     Returns an abbreviated name for the role corresponding to the indexed column.
1709 :    
1710 :     =back
1711 :    
1712 :     =cut
1713 :    
1714 : parrello 1.60 sub get_role_abbr :Scalar
1715 : olson 1.4 {
1716 :     my($self, $ridx) = @_;
1717 :    
1718 :     return $self->{role_abbrs}->[$ridx];
1719 :     }
1720 :    
1721 : parrello 1.60 sub get_role_from_abbr :Scalar
1722 : olson 1.20 {
1723 :     my($self, $abbr) = @_;
1724 :    
1725 :     return $self->{abbr}->{$abbr};
1726 :     }
1727 :    
1728 : parrello 1.73 =head3 set_pegs_in_cell
1729 : olson 1.26
1730 : parrello 1.73 C<< $sub->set_pegs_in_cell($genome, $role, $peg_list); >>
1731 : olson 1.26
1732 :     Set the cell for the given genome and role to $peg_list.
1733 :    
1734 :     =cut
1735 :    
1736 :     sub set_pegs_in_cell
1737 :     {
1738 :     my($self, $genome, $role, $peg_list) = @_;
1739 :     my($row, $col);
1740 :    
1741 :     #
1742 :     # If row isn't numeric, look it up in the genomes list.
1743 :     #
1744 : parrello 1.60
1745 : olson 1.26 if ($genome !~ /^\d+$/)
1746 :     {
1747 : parrello 1.69 $row = $self->{genome_index}->{$genome};
1748 : olson 1.26 }
1749 :     else
1750 :     {
1751 : parrello 1.69 $row = $genome
1752 : olson 1.26 }
1753 : parrello 1.60
1754 : overbeek 1.37 if (! defined($row))
1755 : olson 1.26 {
1756 : parrello 1.69 print &Dumper($self->{genome_index});
1757 :     confess "Cannot find row for $genome\n";
1758 :     return undef;
1759 : olson 1.26 }
1760 :    
1761 :     #
1762 :     # If col isn't numeric, look it up in the roles and role abbreviations.
1763 :     #
1764 : parrello 1.60
1765 : olson 1.26 if ($role !~ /^\d+$/)
1766 :     {
1767 : parrello 1.69 #
1768 :     # See if it's an abbr
1769 :     #
1770 : olson 1.26
1771 : parrello 1.69 my $a = $self->{abbr}->{$role};
1772 :     $role = $a if $a;
1773 : olson 1.26
1774 : parrello 1.69 $col = $self->{role_index}->{$role};
1775 : olson 1.26 }
1776 :     else
1777 :     {
1778 : parrello 1.69 $col = $role;
1779 : olson 1.26 }
1780 : parrello 1.60
1781 : overbeek 1.37 if (! defined($col))
1782 : olson 1.26 {
1783 : parrello 1.69 print &Dumper($self->{role_index});
1784 :     confess "Cannot find col for $role\n";
1785 :     return undef;
1786 : olson 1.26 }
1787 :     my $cell = $self->get_cell($row, $col);
1788 :    
1789 : olson 1.70
1790 : overbeek 1.37 if (defined($cell))
1791 : olson 1.26 {
1792 : olson 1.70 my $sub_name = $self->{name};
1793 :     my $peg;
1794 :     my $rdbH = $self->{fig}->db_handle();
1795 :     my $dbh = $rdbH->{_dbh};
1796 :    
1797 :     my $variant = $self->get_variant_code($row);
1798 : parrello 1.73
1799 : olson 1.70 if (@$cell > 0)
1800 :     {
1801 :     my $sth = $dbh->prepare(qq(DELETE FROM subsystem_index
1802 :     WHERE (subsystem = ? AND
1803 :     role = ? AND
1804 :     protein = ?)
1805 :     ));
1806 :     foreach $peg (@$cell)
1807 :     {
1808 :     $sth->execute($sub_name, $role, $peg);
1809 :     warn "Deleting $sub_name $role $peg\n";
1810 :     }
1811 :     }
1812 : parrello 1.73
1813 : olson 1.70 @$cell = @$peg_list;
1814 :    
1815 :     if ($self->{old_database})
1816 :     {
1817 :     my $sth = $rdbH->{_dbh}->prepare(qq(INSERT INTO subsystem_index (protein,subsystem,role)
1818 :     VALUES (?, ?, ?)));
1819 :     foreach $peg (@$cell)
1820 :     {
1821 :     $sth->execute($peg, $sub_name, $role);
1822 :     warn "Add old $peg $sub_name $role\n";
1823 :     }
1824 :     }
1825 :     else
1826 :     {
1827 :     my $sth = $rdbH->{_dbh}->prepare(qq(INSERT INTO subsystem_index (protein,subsystem,role,variant)
1828 :     VALUES (?, ?, ?, ?)));
1829 :     foreach $peg (@$cell)
1830 :     {
1831 :     $sth->execute($peg, $sub_name, $role, $variant);
1832 : olson 1.79 #warn "Add new $peg $sub_name $role v='$variant'\n";
1833 : olson 1.70 }
1834 :     }
1835 : olson 1.26 }
1836 :     else
1837 :     {
1838 : parrello 1.69 warn "set_pegs_in_cell: Could not find cell!";
1839 : olson 1.26 }
1840 :     }
1841 :    
1842 : parrello 1.73 =head3 get_pegs_from_cell
1843 :    
1844 :     C<< my @pegs = $sub->get_pegs_from_cell($rowstr, $colstr); >>
1845 :    
1846 :     Return a list of the peg IDs for the features in the specified spreadsheet cell.
1847 :    
1848 :     =over 4
1849 :    
1850 :     =item rowstr
1851 :    
1852 :     Genome row, specified either as a row index or a genome ID.
1853 :    
1854 :     =item colstr
1855 :    
1856 :     Role column, specified either as a column index, a role name, or a role
1857 :     abbreviation.
1858 :    
1859 :     =item RETURN
1860 :    
1861 :     Returns a list of PEG IDs. The PEGs in the list belong to the genome in the
1862 :     specified row and perform the role in the specified column. If the indicated
1863 :     row and column does not exist, returns an empty list.
1864 :    
1865 :     =back
1866 :    
1867 :     =cut
1868 :    
1869 : olson 1.1 sub get_pegs_from_cell
1870 :     {
1871 :     my($self, $rowstr, $colstr) = @_;
1872 :     my($row, $col);
1873 :    
1874 :     #
1875 :     # If row isn't numeric, look it up in the genomes list.
1876 :     #
1877 : parrello 1.60
1878 : olson 1.1 if ($rowstr !~ /^\d+$/)
1879 :     {
1880 : parrello 1.69 $row = $self->{genome_index}->{$rowstr};
1881 : olson 1.1 }
1882 :     else
1883 :     {
1884 : parrello 1.69 $row = $rowstr;
1885 : olson 1.1 }
1886 : parrello 1.60
1887 : overbeek 1.31 if (! defined($row))
1888 : olson 1.1 {
1889 : parrello 1.69 print &Dumper($self->{genome_index});
1890 :     confess "Cannot find row for $rowstr\n";
1891 :     return undef;
1892 : olson 1.1 }
1893 :    
1894 :     #
1895 :     # If col isn't numeric, look it up in the roles and role abbreviations.
1896 :     #
1897 : parrello 1.60
1898 : olson 1.1 if ($colstr !~ /^\d+$/)
1899 :     {
1900 : parrello 1.69 #
1901 :     # See if it's an abbr
1902 :     #
1903 : olson 1.1
1904 : parrello 1.69 my $a = $self->{abbr}->{$colstr};
1905 :     $colstr = $a if $a;
1906 : olson 1.1
1907 : parrello 1.69 $col = $self->{role_index}->{$colstr};
1908 : olson 1.1 }
1909 :     else
1910 :     {
1911 : parrello 1.69 $col = $colstr;
1912 : olson 1.1 }
1913 : overbeek 1.32
1914 : overbeek 1.31 if (! defined($col))
1915 : olson 1.1 {
1916 : parrello 1.69 warn "Cannot find col for $colstr\n";
1917 :     return undef;
1918 : olson 1.1 }
1919 : olson 1.12 my $cell = $self->get_cell($row, $col);
1920 : olson 1.1
1921 :     if ($cell)
1922 :     {
1923 : parrello 1.69 return @$cell;
1924 : olson 1.1 }
1925 :     else
1926 :     {
1927 : parrello 1.69 return undef;
1928 : olson 1.1 }
1929 :     }
1930 :    
1931 : olson 1.25 #
1932 :     # Subset support
1933 :     #
1934 :    
1935 : olson 1.30 sub get_active_subsetC
1936 :     {
1937 :     my($self) = @_;
1938 :    
1939 :     return $self->{col_active_subset};
1940 :     }
1941 :    
1942 :     sub get_active_subsetR
1943 :     {
1944 :     my($self) = @_;
1945 :    
1946 :     return $self->{row_active_subset};
1947 :     }
1948 :    
1949 :     sub set_active_subsetC
1950 :     {
1951 :     my($self, $subset) = @_;
1952 :    
1953 :     $self->{col_active_subset} = $subset;
1954 :     }
1955 :    
1956 :    
1957 :     sub set_active_subsetR
1958 :     {
1959 :     my($self, $subset) = @_;
1960 :    
1961 :     $self->{row_active_subset} = $subset;
1962 :     }
1963 :    
1964 :    
1965 : olson 1.25 sub get_subset_names
1966 : olson 1.17 {
1967 :     my($self) = @_;
1968 : olson 1.25
1969 : overbeek 1.31 return $self->get_subset_namesC;
1970 :     }
1971 :    
1972 : parrello 1.73 =head3 get_subset_namesC
1973 :    
1974 :     C<< my @subsetNames = $sub->get_subset_namesC(); >>
1975 :    
1976 :     Return a list of the names for all the column (role) subsets. Given a subset
1977 :     name, you can use the L</get_subsetC_roles> method to get the roles in the
1978 :     subset.
1979 :    
1980 :     =cut
1981 :    
1982 : overbeek 1.31 sub get_subset_namesC
1983 :     {
1984 :     my($self) = @_;
1985 :    
1986 : overbeek 1.35 return ("All",@{$self->{col_subsets}});
1987 : overbeek 1.31 }
1988 :    
1989 :     sub get_subset_namesR
1990 :     {
1991 :     my($self) = @_;
1992 :    
1993 : overbeek 1.35 return ("All",@{$self->{row_subsets}});
1994 : olson 1.17 }
1995 :    
1996 : parrello 1.73 =head3 get_subsetC_roles
1997 :    
1998 :     C<< my @roles = $sub->get_subsetC_roles($subname); >>
1999 :    
2000 :     Return the names of the roles contained in the specified role (column) subset.
2001 :    
2002 :     =over 4
2003 :    
2004 :     =item subname
2005 :    
2006 :     Name of the role subset whose roles are desired.
2007 :    
2008 :     =item RETURN
2009 :    
2010 :     Returns a list of the role names for the columns in the named subset.
2011 :    
2012 :     =back
2013 :    
2014 :     =cut
2015 :    
2016 : overbeek 1.33 sub get_subsetC_roles
2017 :     {
2018 :     my($self, $subname) = @_;
2019 :     return map { $self->get_role($_) } $self->get_subsetC($subname);
2020 :     }
2021 :    
2022 : overbeek 1.31 sub get_subsetC
2023 :     {
2024 :     my($self, $subname) = @_;
2025 : overbeek 1.33 if ($subname eq "All") { return map { $self->get_role_index($_) } $self->get_roles }
2026 : overbeek 1.31
2027 : olson 1.52 if (!defined($self->{col_subset_members}->{$subname}))
2028 :     {
2029 : parrello 1.69 $self->{col_subset_members}->{$subname} = [];
2030 : olson 1.52 }
2031 : parrello 1.60
2032 : overbeek 1.31 return @{$self->{col_subset_members}->{$subname}};
2033 :     }
2034 :    
2035 : olson 1.25 sub get_subset
2036 : olson 1.17 {
2037 : olson 1.25 my($self, $subname) = @_;
2038 : overbeek 1.33 return $self->get_subsetC($subname);
2039 : overbeek 1.31 }
2040 :    
2041 :     sub get_subsetR
2042 :     {
2043 :     my($self, $subname) = @_;
2044 :     my($pair,$id,$members,$genome);
2045 :    
2046 :     if ($subname eq "All") { return $self->get_genomes }
2047 : overbeek 1.38 my %genomes = map { $_ => 1 } $self->get_genomes;
2048 :    
2049 :     return grep { $genomes{$_} } @{$self->{row_subset_members}->{$subname}};
2050 : overbeek 1.35 }
2051 :    
2052 :     sub load_row_subsets {
2053 :     my($self) = @_;
2054 :     my($id,$members,$pair);
2055 : overbeek 1.31
2056 : overbeek 1.35 my $taxonomic_groups = $self->{fig}->taxonomic_groups_of_complete(10);
2057 :     foreach $pair (@$taxonomic_groups)
2058 : overbeek 1.31 {
2059 : parrello 1.69 ($id,$members) = @$pair;
2060 :     if ($id ne "All")
2061 :     {
2062 :     push(@{$self->{row_subsets}},$id);
2063 :     }
2064 :     $self->{row_subset_members}->{$id} = $members;
2065 : overbeek 1.31 }
2066 : olson 1.25 }
2067 :    
2068 : parrello 1.73 =head3 load_row_subsets_by_kv
2069 : redwards 1.48
2070 :     Load a row subset based on a key/value pair. This will take a single key/value pair and only show that subset
2071 :    
2072 :     It is just a modification of load_row_subsets to deal with kv pairs
2073 :    
2074 :     This takes a required argument: the key that the genome must have, and a second optional argument, the value that key must hold.
2075 :    
2076 :     =cut
2077 :    
2078 :     sub load_row_subsets_by_kv {
2079 :     my ($self, $key, $want) = @_;
2080 :     my($id,$members,$pair);
2081 :     my $keep;
2082 :     foreach my $genome (@{$self->{genome}}) {
2083 : redwards 1.50 my @results=$self->{fig}->get_attributes($genome, $key);
2084 :     foreach my $res (@results) {
2085 : redwards 1.51 my ($gotid, $gottag, $value, $url)=@$res;
2086 : redwards 1.50 next if (!$value);
2087 :     next if ($want && $value ne $want);
2088 :     push @$keep, $genome;
2089 :     last;
2090 :     }
2091 : redwards 1.48 }
2092 :     $self->{row_subset_members}->{$key}=$keep;
2093 :     }
2094 : overbeek 1.35
2095 : parrello 1.73 =head3 set_subsetC
2096 : olson 1.25
2097 : parrello 1.73 C<< $sub->set_subsetC($name, $members); >>
2098 : olson 1.25
2099 :     Create a subset with the given name and members.
2100 :    
2101 :     $members is a list of role names.
2102 :    
2103 :     =cut
2104 :    
2105 : overbeek 1.31 sub set_subsetC
2106 : olson 1.25 {
2107 :     my($self, $subname, $list) = @_;
2108 :    
2109 :     my $nl = [map { $self->get_role_index($_) } @$list];
2110 : parrello 1.60
2111 : olson 1.25 $self->_set_subset($subname, $nl);
2112 :     }
2113 :    
2114 : overbeek 1.31 sub set_subset
2115 :     {
2116 :     my($self, $subname, $list) = @_;
2117 :    
2118 :     $self->set_subsetsC($subname,$list);
2119 :     }
2120 :    
2121 : parrello 1.73 =head3 _set_subset
2122 : olson 1.25
2123 :     Create a subset with the given name and members.
2124 :    
2125 :     Internal version - here, members is a list of role indices.
2126 :    
2127 :     =cut
2128 :    
2129 :     sub _set_subset
2130 :     {
2131 :     my($self, $subname, $list) = @_;
2132 :     $self->{col_subset_members}->{$subname} = $list;
2133 : overbeek 1.37 my($i,$x);
2134 :     $x = $self->{col_subsets};
2135 :     for ($i=0; ($i < @$x) && ($x->[$i] ne $subname); $i++) {}
2136 :     if ($i == @$x)
2137 :     {
2138 : parrello 1.69 push(@$x,$subname);
2139 : overbeek 1.37 }
2140 :     }
2141 : parrello 1.60
2142 : overbeek 1.37 sub delete_subsetC
2143 :     {
2144 :     my($self, $subname) = @_;
2145 :     my($i,$x);
2146 :    
2147 :     $x = $self->{col_subsets};
2148 :     for ($i=0; ($i < @$x) && ($x->[$i] ne $subname); $i++) {}
2149 :     if ($i < @$x)
2150 :     {
2151 : parrello 1.69 splice(@$x,$i,1);
2152 : overbeek 1.37 }
2153 :     delete $self->{col_subset_members}->{$subname};
2154 : olson 1.25 }
2155 : parrello 1.60
2156 : olson 1.25 #
2157 :     # Role manipulation.
2158 :     #
2159 :    
2160 :    
2161 : parrello 1.73 =head3 set_roles
2162 : olson 1.25
2163 : parrello 1.73 C<< $sub->set_roles($role_list); >>
2164 : olson 1.25
2165 :     Set the list of roles. C<$role_list> is a list of tuples C<[$role_name, $abbreviation]>.
2166 :    
2167 :     If a role already exists, it is used. If it does not exist, it is created empty.
2168 :    
2169 :     =cut
2170 :    
2171 :     sub set_roles
2172 :     {
2173 :     my($self, $roles) = @_;
2174 :    
2175 :     #
2176 :     # We do this by first creating a new spreadsheet.
2177 :     #
2178 :     # It is easiest to do this by manipulating the inverted spreadsheet
2179 :     # (role-major), and then creating the non-inverted spreadsheet from it.
2180 :     #
2181 :    
2182 :     my $oldss = $self->{spreadsheet};
2183 :     my $oldssinv = $self->{spreadsheet_inv};
2184 :    
2185 :     my $ss = [];
2186 :     my $ssinv = [];
2187 :    
2188 :     my $g = $self->{genome};
2189 :     my $ng = @$g;
2190 :    
2191 :     my $old_roles = $self->{role_index};
2192 :    
2193 :     my @role_index_conversion;
2194 : olson 1.70 my @old_role_list = @{$self->{roles}};
2195 : olson 1.25
2196 : olson 1.70 #
2197 :     # Since we're setting up completely new roles, wipe the
2198 :     # existing state.
2199 :     #
2200 : olson 1.25
2201 :     $self->{abbr} = {};
2202 :     $self->{role_index} = {};
2203 :     $self->{roles} = [];
2204 :     $self->{role_abbrs} = [];
2205 :    
2206 : olson 1.70 #
2207 :     # Initialize %defunct_roles with the list of all roles.
2208 :     # Remove entries as we walk the list of new roles below.
2209 :     # Any that are remaining need to be pulled from the index.
2210 :     #
2211 : olson 1.25
2212 : olson 1.70 my %defunct_roles = map { $_ => 1 } @old_role_list;
2213 : parrello 1.73
2214 : olson 1.70 # warn "Defunct at start: ", Dumper(\%defunct_roles);
2215 : olson 1.25 for (my $idx = 0; $idx < @$roles; $idx++)
2216 :     {
2217 : parrello 1.69 my $role = $roles->[$idx]->[0];
2218 :     my $abbr = $roles->[$idx]->[1];
2219 :    
2220 :     my $old_idx = $old_roles->{$role};
2221 : olson 1.25
2222 : olson 1.70 if (defined($old_idx))
2223 :     {
2224 :     # warn "Found old idx $old_idx for $role $idx\n";
2225 :     # warn $oldssinv->[$old_idx];
2226 :     $ssinv->[$idx] = $oldssinv->[$old_idx];
2227 :    
2228 :     $role_index_conversion[$old_idx] = $idx;
2229 :    
2230 :     #
2231 :     # We're keeping it, so it's not defunct anymore.
2232 :     #
2233 :     delete $defunct_roles{$role};
2234 :     }
2235 :     else
2236 :     {
2237 :     # warn "Did not find old role for $role $idx\n";
2238 :     # warn Dumper($old_roles);
2239 :     my $l = [];
2240 :     for (my $j = 0; $j < $ng; $j++)
2241 :     {
2242 :     $l->[$j] = [];
2243 :     }
2244 :    
2245 :     $ssinv->[$idx] = $l;
2246 :     }
2247 :    
2248 : parrello 1.73
2249 : olson 1.70 #
2250 :     # While we're here, update the new role and abbrev indexes
2251 :     #
2252 :     $self->{role_index}->{$role} = $idx;
2253 :     $self->{abbr}->{$abbr} = $role;
2254 :     $self->{roles}->[$idx] = $role;
2255 :     $self->{role_abbrs}->[$idx] = $abbr;
2256 :     }
2257 : olson 1.25
2258 : olson 1.70 #
2259 :     # Now we delete the pegs showing up for the list of defunct roles.
2260 :     #
2261 :     # warn "Defunct at finish: ", Dumper(\%defunct_roles);
2262 : parrello 1.73
2263 : olson 1.70 my $rdbH = $self->{fig}->db_handle();
2264 :     my $dbh = $rdbH->{_dbh};
2265 :     my $sub_name = $self->{name};
2266 : parrello 1.73
2267 : olson 1.70 my $sth = $dbh->prepare(qq(DELETE FROM subsystem_index
2268 :     WHERE (subsystem = ? AND
2269 :     role = ? AND
2270 :     protein = ?)
2271 :     ));
2272 : parrello 1.73
2273 :    
2274 : olson 1.70 for my $defunct_role (keys(%defunct_roles))
2275 :     {
2276 :     my $defunct_role_idx = $old_roles->{$defunct_role};
2277 :     my $col = $oldssinv->[$defunct_role_idx];
2278 :     # warn "Handle defunct role $defunct_role idx=$defunct_role_idx\n", Dumper($col);
2279 : parrello 1.73
2280 : olson 1.70 for my $cell (@$col)
2281 :     {
2282 :     for my $peg (@$cell)
2283 :     {
2284 :     $sth->execute($sub_name, $defunct_role, $peg);
2285 :     warn "Deleting $sub_name $defunct_role $peg\n";
2286 :     }
2287 :     }
2288 : olson 1.25 }
2289 : parrello 1.73
2290 : olson 1.25
2291 :     #
2292 :     # Now create the uninverted spreadsheet.
2293 :     #
2294 :    
2295 :     for (my $gidx = 0; $gidx < $ng; $gidx++)
2296 :     {
2297 : parrello 1.69 my $row = [];
2298 :     $ss->[$gidx] = $row;
2299 :     for (my $ridx = 0; $ridx < @$roles; $ridx++)
2300 :     {
2301 :     $row->[$ridx] = $ssinv->[$ridx]->[$gidx];
2302 :     }
2303 : olson 1.25 }
2304 :    
2305 :     $self->{spreadsheet} = $ss;
2306 :     $self->{spreadsheet_inv} = $ssinv;
2307 :    
2308 :     #
2309 :     # Fix up the subsets.
2310 :     #
2311 :    
2312 :    
2313 : overbeek 1.37 for my $subset (grep { $_ ne "All" } $self->get_subset_names())
2314 : olson 1.25 {
2315 : parrello 1.69 my $n = [];
2316 :     for my $idx ($self->get_subset($subset))
2317 :     {
2318 :     my $new = $role_index_conversion[$idx];
2319 :     if (defined($new))
2320 :     {
2321 :     push(@$n, $new);
2322 :     }
2323 :     }
2324 :     $self->_set_subset($subset, $n);
2325 : olson 1.25 }
2326 :    
2327 :     }
2328 :    
2329 : parrello 1.73 =head3 add_role($role, $abbr)
2330 : olson 1.25
2331 :     Add the given role to the spreadsheet.
2332 :    
2333 :     This causes a new column to be added, with empty values in each cell.
2334 :    
2335 :     We do nothing if the role is already present.
2336 :    
2337 :     Return the index of the new role.
2338 :    
2339 :     =cut
2340 :    
2341 :     sub add_role
2342 :     {
2343 :     my($self, $role, $abbr) = @_;
2344 :    
2345 :     if (defined($self->get_role_index($role)))
2346 :     {
2347 : parrello 1.69 warn "Role $role already present\n";
2348 :     return undef;
2349 : olson 1.25 }
2350 :    
2351 :     #
2352 :     # Add to the roles list. It goes at the end.
2353 :     #
2354 :    
2355 :     my $idx = @{$self->{roles}};
2356 :     $self->{roles}->[$idx] = $role;
2357 :     $self->{role_abbrs}->[$idx] = $abbr;
2358 :     $self->{role_index}->{$role} = $idx;
2359 :     $self->{abbr}->{$abbr} = $role;
2360 :    
2361 :     #
2362 :     # Update the spreadsheet.
2363 :     # On the standard one, we have to go through all the rows adding
2364 :     # a columnt to each.
2365 :     #
2366 :     # On the inverted one, we add a column with [] in each entry.
2367 :     #
2368 :    
2369 :     my $ng = @{$self->{genome}};
2370 :     my $newcol = [];
2371 :    
2372 :     for (my $i = 0; $i < $ng; $i++)
2373 :     {
2374 : parrello 1.69 my $cell = [];
2375 :     # print "nr: Adding cell $cell for gidx=$i ridx=$idx\n";
2376 :     $self->{spreadsheet}->[$i]->[$idx] = $cell;
2377 :     $newcol->[$i] = $cell;
2378 : olson 1.25 }
2379 :    
2380 :     $self->{spreadsheet_inv}->[$idx] = $newcol;
2381 :    
2382 :     return $idx;
2383 :     }
2384 :    
2385 : parrello 1.73 =head3 remove_role
2386 : olson 1.25
2387 :     Remove the role from the spreadsheet.
2388 :    
2389 :     We do nothing if the role is not present.
2390 :    
2391 :     =cut
2392 :    
2393 :     sub remove_role
2394 :     {
2395 :     my($self, $role) = @_;
2396 :    
2397 :     my $idx = $self->get_role_index($role);
2398 :     if (!defined($idx))
2399 :     {
2400 : parrello 1.69 warn "Role $role not present\n";
2401 :     return undef;
2402 : olson 1.25 }
2403 :    
2404 :     #
2405 : olson 1.70 # Update the index. Again, do this before removing roles
2406 :     # so we have full data to work with.
2407 :     # We walk the role's column of the spreadsheet removing pegs from the index.
2408 :     #
2409 :    
2410 :     my $rdbH = $self->{fig}->db_handle();
2411 :     my $dbh = $rdbH->{_dbh};
2412 :     my $sub_name = $self->{name};
2413 :    
2414 :     my $sth = $dbh->prepare(qq(DELETE FROM subsystem_index
2415 :     WHERE (subsystem = ? AND
2416 :     role = ? AND
2417 :     protein = ?)
2418 :     ));
2419 :     my $col = $self->get_col($idx);
2420 :     for my $cell (@$col)
2421 :     {
2422 :     for my $peg (@$cell)
2423 :     {
2424 :     $sth->execute($sub_name, $role, $peg);
2425 :     warn "Deleting $sub_name $role $peg\n";
2426 :     }
2427 :     }
2428 :    
2429 :     #
2430 : parrello 1.60 # Remove from the roles list.
2431 : olson 1.25 #
2432 :    
2433 :     my $abbr = $self->{role_abbrs}->[$idx];
2434 : parrello 1.60
2435 : olson 1.25 splice(@{$self->{roles}}, $idx, 1);
2436 :     splice(@{$self->{role_abbrs}}, $idx, 1);
2437 :     delete $self->{role_index}->{$role};
2438 :     delete $self->{abbr}->{$abbr};
2439 :    
2440 : olson 1.70
2441 : olson 1.25 #
2442 :     # Update the spreadsheet.
2443 :     # On the standard one, we have to go through all the rows removing
2444 :     # the column from each.
2445 :     #
2446 :     # On the inverted one, we just remove the column.
2447 :     #
2448 :    
2449 :     my $ng = @{$self->{genome}};
2450 :     my $newcol = [];
2451 :    
2452 :     for (my $i = 0; $i < $ng; $i++)
2453 :     {
2454 : parrello 1.69 splice(@{$self->{spreadsheet}->[$i]}, $idx, 1);
2455 : olson 1.25 }
2456 :    
2457 :     splice(@{$self->{spreadsheet_inv}}, $idx, 1);
2458 :    
2459 :     #
2460 :     # We need to rewrite the subsets. if $idx was present in one, it is
2461 :     # removed. Any index >$idx is decremented.
2462 :     #
2463 :    
2464 :     for my $subset ($self->get_subset_names())
2465 :     {
2466 : parrello 1.69 my @n;
2467 : olson 1.25
2468 : parrello 1.69 for my $sidx ($self->get_subset($subset))
2469 :     {
2470 :     if ($sidx < $idx)
2471 :     {
2472 :     push(@n, $sidx);
2473 :     }
2474 :     elsif ($sidx > $idx)
2475 :     {
2476 :     push(@n, $sidx - 1);
2477 :     }
2478 :     }
2479 : olson 1.25
2480 : parrello 1.69 $self->_set_subset($subset, [@n]);
2481 : olson 1.25 }
2482 :     }
2483 :    
2484 : parrello 1.73 =head3 add_genome($genome, $abbr)
2485 : olson 1.25
2486 :     Add the given genome to the spreadsheet.
2487 :    
2488 :     This causes a new row to be added, with empty values in each cell.
2489 :    
2490 :     We do nothing if the genome is already present.
2491 :    
2492 :     Return the index of the new genome.
2493 :    
2494 :     =cut
2495 :    
2496 :     sub add_genome
2497 :     {
2498 :     my($self, $genome) = @_;
2499 :    
2500 :     my $idx = $self->get_genome_index($genome);
2501 :     if (defined($idx))
2502 :     {
2503 : parrello 1.64 warn "Genome $genome already present\n";
2504 :     return $idx;
2505 : olson 1.25 }
2506 :    
2507 :     #
2508 :     # Add to the genomes list. It goes at the end.
2509 :     #
2510 :    
2511 : parrello 1.64 $idx = @{$self->{genome}};
2512 : olson 1.26 $self->{variant_code}->[$idx] = 0;
2513 : olson 1.25 $self->{genome}->[$idx] = $genome;
2514 :     $self->{genome_index}->{$genome} = $idx;
2515 :    
2516 :     #
2517 :     # Update the spreadsheet.
2518 :     # On the inverted one, we have to go through all the columns adding
2519 :     # a row to each.
2520 :     #
2521 :     # On the regular one, we add a row with [] in each entry.
2522 :     #
2523 :    
2524 :     my $nr = @{$self->{roles}};
2525 :     my $newrow = [];
2526 :    
2527 :     for my $i (0.. $nr - 1)
2528 :     {
2529 : parrello 1.69 my $cell = [];
2530 :     # print "ng: Adding cell $cell for gidx=$idx ridx=$i\n";
2531 :     $self->{spreadsheet_inv}->[$i]->[$idx] = $cell;
2532 :     $newrow->[$i] = $cell;
2533 : olson 1.25 }
2534 :    
2535 :     $self->{spreadsheet}->[$idx] = $newrow;
2536 :    
2537 :     return $idx;
2538 :     }
2539 :    
2540 : parrello 1.73 =head3 remove_genome
2541 : olson 1.25
2542 :     Remove the genome from the spreadsheet.
2543 :    
2544 :     We do nothing if the genome is not present.
2545 :    
2546 :     =cut
2547 :    
2548 :     sub remove_genome
2549 :     {
2550 :     my($self, $genome) = @_;
2551 :    
2552 :     my $idx = $self->get_genome_index($genome);
2553 :     if (!defined($idx))
2554 :     {
2555 : parrello 1.69 warn "Genome $genome not present\n";
2556 :     return undef;
2557 : olson 1.25 }
2558 :    
2559 :     #
2560 : olson 1.70 # Remove from database index (before we delete stuff from here,
2561 :     # so we have access to th e data structures).
2562 :     #
2563 :    
2564 :     my $rdbH = $self->{fig}->db_handle();
2565 :     my $dbh = $rdbH->{_dbh};
2566 :     my $cells = $self->get_row($idx);
2567 :     my $sub_name = $self->{name};
2568 :    
2569 :     my $sth = $dbh->prepare(qq(DELETE FROM subsystem_index
2570 :     WHERE (subsystem = ? AND
2571 :     role = ? AND
2572 :     protein = ?)
2573 :     ));
2574 :     for my $i (0 .. $#$cells)
2575 :     {
2576 :     my $cell = $cells->[$i];
2577 :     my $role = $self->get_role($i);
2578 :    
2579 :     for my $peg (@$cell)
2580 :     {
2581 :     $sth->execute($sub_name, $role, $peg);
2582 :     warn "Deleting $sub_name $role $peg\n";
2583 :     }
2584 :     }
2585 :    
2586 :     #
2587 : parrello 1.60 # Remove from the genomes list.
2588 : olson 1.25 #
2589 :    
2590 :     splice(@{$self->{genome}}, $idx, 1);
2591 : overbeek 1.43
2592 :     my $genome1;
2593 :     foreach $genome1 (@{$self->{genome}})
2594 :     {
2595 : parrello 1.69 if ($self->{genome_index}->{$genome1} > $idx)
2596 :     {
2597 :     $self->{genome_index}->{$genome1}--;
2598 :     }
2599 : overbeek 1.43 }
2600 : olson 1.25 splice(@{$self->{variant_code}}, $idx, 1);
2601 :    
2602 :     delete $self->{genome_index}->{$genome};
2603 :    
2604 :     #
2605 :     # Update the spreadsheet.
2606 :     # On the inverted one, we have to go through all the columns removing
2607 :     # the row from each.
2608 :     #
2609 :     # On the standard one, we just remove the row.
2610 :     #
2611 :    
2612 :     my $nr = @{$self->{roles}};
2613 :    
2614 :     for my $i (0 .. $nr - 1)
2615 :     {
2616 : parrello 1.69 splice(@{$self->{spreadsheet_inv}->[$i]}, $idx, 1);
2617 : olson 1.25 }
2618 :    
2619 :     splice(@{$self->{spreadsheet}}, $idx, 1);
2620 :    
2621 :     }
2622 :    
2623 : parrello 1.60 sub get_name :Scalar
2624 : olson 1.25 {
2625 :     my($self) = @_;
2626 : overbeek 1.53 my $name = $self->{name};
2627 :     $name =~ s/ /_/g;
2628 :     return $name;
2629 : olson 1.25 }
2630 : parrello 1.60
2631 :     sub get_dir :Scalar
2632 : overbeek 1.41 {
2633 :     my($self) = @_;
2634 :     return $self->{dir};
2635 :     }
2636 : olson 1.25
2637 : parrello 1.60
2638 :     sub get_version :Scalar
2639 : olson 1.25 {
2640 :     my($self) = @_;
2641 :     return $self->{version};
2642 : olson 1.17 }
2643 :    
2644 : parrello 1.73 =head3 get_notes
2645 :    
2646 :     C<< my $text = $sub->get_notes(); >>
2647 :    
2648 :     Return the descriptive notes for this subsystem.
2649 :    
2650 :     =cut
2651 :    
2652 : parrello 1.60 sub get_notes :Scalar
2653 : olson 1.26 {
2654 :     my($self) = @_;
2655 :    
2656 :     return $self->{notes};
2657 :     }
2658 :    
2659 : parrello 1.73 =head3 get_reactions
2660 :    
2661 :     C<< my $reactHash = $sub->get_reactions(); >>
2662 :    
2663 :     Return a reference to a hash that maps each role ID to a list of the reactions
2664 :     catalyzed by the role.
2665 :    
2666 :     =cut
2667 :    
2668 : overbeek 1.58 sub get_reactions
2669 :     {
2670 :     my($self) = @_;
2671 :    
2672 :     return $self->{reactions};
2673 :     }
2674 :    
2675 : overbeek 1.59 sub set_reaction {
2676 :     my($self,$role,$rstring) = @_;
2677 :    
2678 :     $self->{reactions}->{$role} = [split(/,\s*/,$rstring)];
2679 :     }
2680 :    
2681 :    
2682 : olson 1.26 sub set_notes
2683 :     {
2684 :     my($self, $notes) = @_;
2685 :    
2686 : olson 1.28 $self->{notes} = $notes;
2687 : olson 1.26 }
2688 :    
2689 : redwards 1.44 sub get_classification
2690 :     {
2691 :     my($self) = @_;
2692 :    
2693 :     return $self->{classification};
2694 :     }
2695 :    
2696 :     sub set_classification
2697 :     {
2698 :     my($self, $classification) = @_;
2699 :    
2700 :     $self->{classification}=$classification;
2701 :     }
2702 :    
2703 :    
2704 : parrello 1.73 =head3 get_curator
2705 :    
2706 :     C<< my $userName = $sub->get_curator(); >>
2707 :    
2708 :     Return the name of this subsystem's official curator.
2709 :    
2710 :     =cut
2711 : parrello 1.60
2712 :     sub get_curator :Scalar
2713 : olson 1.17 {
2714 :     my($self) = @_;
2715 :     return $self->{curator};
2716 :     }
2717 : overbeek 1.47
2718 : olson 1.25 #
2719 :     # Subsystem copying logic
2720 :     #
2721 :    
2722 : parrello 1.73 =head3 add_to_subsystem($subsystem_name, $columns, $notes_flag)
2723 : olson 1.25
2724 :     Merge the given columns from $subsystem_name into this subsystem. Append the
2725 :     notes from the subsystem if $notes_flag is true.
2726 :    
2727 :     =cut
2728 :    
2729 :     sub add_to_subsystem
2730 :     {
2731 :     my($self, $subsystem_name, $cols, $add_notes) = @_;
2732 :    
2733 :     my $ss = $self->{fig}->get_subsystem($subsystem_name);
2734 :    
2735 :     if (!$ss)
2736 :     {
2737 : parrello 1.69 warn "Cannot open subsystem '$subsystem_name' to copy from";
2738 :     return;
2739 : olson 1.25 }
2740 :    
2741 :     #
2742 :     # Merge the data from the other subsystem.
2743 :     #
2744 :     # First we assure ourselves that we have the appropriate roles. While
2745 :     # we do this, build the list of row indices (in this subsystem) that
2746 :     # map to the roles we are adding.
2747 :     #
2748 :    
2749 :     #
2750 :     # local_roles[$his_role] = $my_role (map from other role idx to local role idx)
2751 :     #
2752 : parrello 1.60
2753 : olson 1.25 my @local_roles;
2754 :    
2755 :     #
2756 :     # his_roles = list of role indices corresponding to the remote roles.
2757 :     #
2758 : overbeek 1.36 if ($cols->[0] eq "all")
2759 :     {
2760 : parrello 1.69 $cols = [$ss->get_roles];
2761 : overbeek 1.36 }
2762 :    
2763 : olson 1.25 my @his_roles;
2764 : parrello 1.60
2765 : olson 1.25 for my $his_role (@$cols)
2766 :     {
2767 : parrello 1.69 my $idx = $self->get_role_index($his_role);
2768 :     my $his_idx = $ss->get_role_index($his_role);
2769 :    
2770 :     if (!defined($his_idx))
2771 :     {
2772 :     confess "Cannot map his role $his_role\n";
2773 :     }
2774 :     push(@his_roles, $his_idx);
2775 : olson 1.25
2776 : parrello 1.69 if (!defined($idx))
2777 :     {
2778 :     my $his_abbr = $ss->get_role_abbr($his_idx);
2779 : parrello 1.60
2780 : parrello 1.69 $idx = $self->add_role($his_role, $his_abbr);
2781 :     # print "Adding missing role $his_role idx=$idx\n";
2782 :     }
2783 :     else
2784 :     {
2785 :     # print "Found existing role $his_role idx=$idx\n";
2786 :     }
2787 : olson 1.25
2788 : parrello 1.69
2789 :     $local_roles[$his_idx] = $idx;
2790 : olson 1.25 }
2791 :    
2792 :     #
2793 :     # Similar scan to ensure that we have rows for the genomes
2794 :     # that are in the other subsystem.
2795 :     #
2796 :    
2797 :     my @local_genomes;
2798 :    
2799 :     my @his_genomes = $ss->get_genomes();
2800 :    
2801 :     for my $his_idx (0..@his_genomes - 1)
2802 :     {
2803 : parrello 1.69 my $genome = $his_genomes[$his_idx];
2804 :    
2805 : overbeek 1.37
2806 : parrello 1.69 my $my_idx = $self->get_genome_index($genome);
2807 : parrello 1.60
2808 : parrello 1.69 if (!defined($my_idx))
2809 :     {
2810 :     #
2811 :     # Not there, need to add.
2812 :     #
2813 : olson 1.25
2814 : parrello 1.69 $my_idx = $self->add_genome($genome);
2815 :     # print "Adding missing genome $genome idx=$my_idx\n";
2816 :     }
2817 :     else
2818 :     {
2819 :     # print "Found existing genome $genome idx=$my_idx\n";
2820 :     }
2821 : parrello 1.60
2822 : parrello 1.69 $local_genomes[$his_idx] = $my_idx;
2823 : olson 1.25 }
2824 :    
2825 : parrello 1.60
2826 : olson 1.25 #
2827 :     # Now that we have our local roles set up to receive the data,
2828 :     # process the incoming roles one at a time.
2829 :     #
2830 :    
2831 :    
2832 :     for my $his_role (@his_roles)
2833 :     {
2834 : parrello 1.69 my $my_col = $self->get_col($local_roles[$his_role]);
2835 :     my $his_col = $ss->get_col($his_role);
2836 : olson 1.25
2837 : parrello 1.69 #
2838 :     # $his_col is the information for $his_role, indexed by
2839 :     # genome in @his_genomes.
2840 :     #
2841 :     # $my_col is hte information for my copy of $his_role,
2842 :     # indexed by genome in MY genome list.
2843 :     #
2844 : olson 1.25
2845 : parrello 1.69 my $my_role = $local_roles[$his_role];
2846 : olson 1.25
2847 : parrello 1.69 # print "merging: $self->{roles}->[$my_role] $ss->{roles}->[$his_role] his_role=$his_role my_role=$my_role\n";
2848 : olson 1.25
2849 : parrello 1.69 for my $his_gidx (0 .. @his_genomes - 1)
2850 :     {
2851 :     my $hisent = $his_col->[$his_gidx];
2852 : olson 1.25
2853 : parrello 1.69 my $my_gidx = $local_genomes[$his_gidx];
2854 : parrello 1.60
2855 : overbeek 1.37
2856 : parrello 1.69 my $myent = $my_col->[$my_gidx];
2857 : olson 1.25
2858 : parrello 1.69 # print " his_gidx=$his_gidx my_gidx=$my_gidx hisent=@$hisent myent=@$myent\n";
2859 : olson 1.25
2860 : parrello 1.69 my %new;
2861 :     map { $new{$_}++ } @$hisent;
2862 :     map { $new{$_}++ } @$myent;
2863 : olson 1.25
2864 : parrello 1.69 @$myent = keys(%new);
2865 : olson 1.25
2866 : parrello 1.69 # print " new entry: @$myent\n";
2867 :     }
2868 : olson 1.25 }
2869 : olson 1.26
2870 :     #
2871 :     # Fix up the variant codes.
2872 :     #
2873 :    
2874 :     for my $his_gidx (0 .. @his_genomes - 1)
2875 :     {
2876 : parrello 1.69 my $his_code = $ss->get_variant_code($his_gidx);
2877 :     my $my_gidx = $local_genomes[$his_gidx];
2878 : olson 1.26
2879 : parrello 1.69 if (!$self->get_variant_code($my_gidx))
2880 :     {
2881 :     $self->{variant_code}->[$my_gidx] = $his_code;
2882 :     }
2883 : olson 1.26 }
2884 :    
2885 :     #
2886 :     # If we are to add notes, append the other subsystem's notes text.
2887 :     #
2888 :    
2889 :     if ($add_notes)
2890 :     {
2891 : parrello 1.69 my $his_notes = $ss->get_notes();
2892 : olson 1.26
2893 : parrello 1.69 $self->{notes} .= "\nNotes copied from $ss->{name}:\n$his_notes\n";
2894 : olson 1.26 }
2895 : olson 1.25 }
2896 : olson 1.17
2897 : olson 1.1 sub dump
2898 :     {
2899 :     my($self) = @_;
2900 :    
2901 :     for my $k (keys(%$self))
2902 :     {
2903 : parrello 1.69 next if $k eq "spreadsheet" or $k eq "spreadsheet_inv";
2904 :     print "Key \"$k\": ", Dumper($self->{$k});
2905 : olson 1.1 }
2906 :     }
2907 : parrello 1.60
2908 : olson 1.14 #
2909 :     # Increment the subsystem's version number.
2910 :     #
2911 :     sub incr_version {
2912 :     my($self) = @_;
2913 :    
2914 :     my $dir = $self->{dir};
2915 :     my $vfile = "$dir/VERSION";
2916 :     my($ver);
2917 :    
2918 :     if (open(my $fh,"<$vfile"))
2919 :     {
2920 :     if (defined($ver = <$fh>) && ($ver =~ /^(\S+)/))
2921 :     {
2922 :     $ver = $1;
2923 :     }
2924 :     else
2925 :     {
2926 :     $ver = 0;
2927 :     }
2928 :     close($fh);
2929 :     }
2930 :     else
2931 :     {
2932 :     $ver = 0;
2933 :     }
2934 :    
2935 :     $ver++;
2936 :    
2937 :     open(my $fh, ">$vfile") || die "could not open $vfile";
2938 :     print $fh "$ver\n";
2939 :     close($fh);
2940 :    
2941 :     chmod(0777, $vfile);
2942 :    
2943 :     $self->load_version();
2944 :     }
2945 : olson 1.1
2946 : heiko 1.78
2947 :     =head3 functional_role_instances
2948 :    
2949 :     C<< my @role_instances = $sub->functional_role_instances($role); >>
2950 :    
2951 :     Returns the set of genes for a functional role that belong to
2952 :     genomes with functional variants (> 0).
2953 :    
2954 :     =cut
2955 :    
2956 :     sub functional_role_instances {
2957 :    
2958 :     my ($self, $role) = @_;
2959 :     my $i =0;
2960 :    
2961 :     my @instances;
2962 :    
2963 :     foreach my $cell (@{$self->get_col($self->get_role_index($role))}) {
2964 :    
2965 :     if ((scalar @$cell > 0) && ($self->get_variant_code($i) > 0)) {
2966 :     foreach (@$cell) {
2967 :     push @instances, $_;
2968 :     }
2969 :     }
2970 :     $i++;
2971 :     }
2972 :    
2973 :    
2974 :     return @instances if wantarray;
2975 :     return \@instances;
2976 :    
2977 :     }
2978 :    
2979 :    
2980 :    
2981 :    
2982 : parrello 1.75 =head3 get_dir_from_name
2983 :    
2984 :     C<< my $dirName = Subsystem::get_dir_from_name($name); >>
2985 :    
2986 :     Return the name of the directory containing the SEED data for the specified
2987 :     subsystem.
2988 :    
2989 :     =over 4
2990 :    
2991 :     =item name
2992 :    
2993 :     Name of the subsystem whose directory is desired.
2994 :    
2995 :     =item RETURN
2996 :    
2997 :     Returns the fully-qualified directory name for the subsystem.
2998 :    
2999 :     =back
3000 :    
3001 :     =cut
3002 :    
3003 : olson 1.1 sub get_dir_from_name
3004 :     {
3005 :     my($name) = @_;
3006 :    
3007 :     my $b = $name;
3008 :     $b =~ s/ /_/g;
3009 :     my $dir = File::Spec->catfile($FIG_Config::data, 'Subsystems', $b);
3010 :     return $dir;
3011 :     }
3012 :    
3013 : olson 1.12 #
3014 :     # Code for dealing with Bill McCune's prolog code for extending subsystems.
3015 :     #
3016 :     # The code here is a reconstruction of Bill's "go" script in perl with
3017 :     # data pulled from the local SEED configuration.
3018 :     #
3019 :    
3020 :     sub extend_with_billogix
3021 :     {
3022 : olson 1.42 my($self, $muser, $genomes) = @_;
3023 : olson 1.12 my($isMaster, $user);
3024 : parrello 1.60
3025 : olson 1.12 my $now = time();
3026 :    
3027 :     if ($muser =~ /master:(.*)/)
3028 :     {
3029 : parrello 1.69 $isMaster = 1;
3030 :     $user = $1;
3031 : olson 1.12 }
3032 :     else
3033 :     {
3034 : parrello 1.69 $isMaster = 0;
3035 :     $user = $muser;
3036 : olson 1.12 }
3037 :    
3038 :     #
3039 : olson 1.42 # initialize the genome list to all complete genomes, if none was passed in.
3040 :     #
3041 :    
3042 :     if (!$genomes)
3043 :     {
3044 : parrello 1.69 $genomes = [$self->{fig}->genomes("complete")];
3045 :     warn "getting genome list from fig $self->{fig}";
3046 : olson 1.42 }
3047 :    
3048 :     #
3049 :     # Ensure genome list is of the right form.
3050 :     #
3051 :    
3052 :     if (ref($genomes) ne "ARRAY")
3053 :     {
3054 : parrello 1.69 warn "billogix: genome list is not a list reference";
3055 :     return;
3056 : olson 1.42 }
3057 :    
3058 :     for my $g (@$genomes)
3059 :     {
3060 : parrello 1.69 if ($g !~ /^\d+\.\d+/)
3061 :     {
3062 :     warn "billogix: genome '$g' is not of the proper form, aborting billogix run.";
3063 :     return;
3064 :     }
3065 : olson 1.42 }
3066 : parrello 1.60
3067 : olson 1.42 my $genome_list = "[" . join(", ", map { "'$_'" } @$genomes) . "]";
3068 :    
3069 :     warn "Genomes: $genome_list\n";
3070 :     warn Dumper($genomes);
3071 : parrello 1.60
3072 : olson 1.42 #
3073 : olson 1.12 # Find the executable.
3074 :     #
3075 :    
3076 :     my $exe = "$FIG_Config::bin/billogix";
3077 :    
3078 :     if (! -x $exe)
3079 :     {
3080 : parrello 1.69 warn "Cannot find billogix exe at $exe\n";
3081 :     return;
3082 : olson 1.12 }
3083 : parrello 1.60
3084 : olson 1.12 my $ss_name = $self->{name};
3085 : olson 1.18
3086 :     $ss_name =~ s/\s+/_/g;
3087 : parrello 1.60
3088 : olson 1.14 my $ss_dir = "$self->{dir}/";
3089 : olson 1.15 my $assign_dir = "$FIG_Config::data/Assignments/$user/";
3090 : olson 1.12 &FIG::verify_dir($assign_dir);
3091 :    
3092 : olson 1.16 my $when= strftime("%m-%d-%y:%H:%M:%S", localtime($now));
3093 :     my $job_id = "${when}:sss:$ss_name";
3094 :    
3095 : olson 1.12 my $seed = &FIG::cgi_url() . "/";
3096 : olson 1.13 my $export_part = "ssa.cgi?user=$muser&request=delete_or_export_ssa&export=";
3097 : olson 1.12
3098 :     #
3099 :     # Have the prereq stuff, now start up the app.
3100 :     #
3101 :    
3102 :     $ENV{LOCALSZ} = "80000";
3103 :     $ENV{GLOBALSZ} = "80000";
3104 :     $ENV{TRAILSZ} = "30000";
3105 : olson 1.13
3106 :     my $arch = &FIG::get_current_arch();
3107 :    
3108 :     $ENV{BILLOGIX} = "$FIG_Config::fig_disk/dist/releases/current/$arch/lib/Billogix";
3109 :    
3110 :     #
3111 :     # Need to ensure pl2wam is in our path
3112 :     #
3113 :    
3114 :     $ENV{PATH} = "${FIG_Config::ext_bin}:$ENV{PATH}";
3115 : olson 1.12
3116 : olson 1.23 #
3117 :     # We're going to divide the run into $n_chunks chunks.
3118 :     #
3119 :    
3120 :     my $n_chunks = 10;
3121 :    
3122 :     my($log);
3123 :     open($log, ">$ss_dir/$job_id.log");
3124 :    
3125 :     for (my $this_chunk = 1; $this_chunk <= $n_chunks; $this_chunk++)
3126 :     {
3127 : parrello 1.69 my $app_input = <<EOINP;
3128 : olson 1.12 ['\$BILLOGIX/top'].
3129 :     loadup.
3130 : olson 1.42 asserta(job_genome_list($genome_list)).
3131 : olson 1.23 asserta(part($this_chunk, $n_chunks)).
3132 : olson 1.12 asserta(url_default_seed('$seed')).
3133 : olson 1.13 asserta(url_export_part('$export_part')).
3134 : olson 1.12 asserta(ss_directory('$ss_dir')).
3135 :     asserta(assign_directory('$assign_dir')).
3136 :     asserta(job_id('$job_id')).
3137 :     extend_test3('$ss_name').
3138 :     EOINP
3139 :    
3140 : olson 1.23 print STDERR <<EOF;
3141 : olson 1.12 Starting app
3142 :    
3143 : olson 1.23 chunk $this_chunk of $n_chunks
3144 : olson 1.12 ss_name = $ss_name
3145 :     ss_dir = $ss_dir
3146 :     user = $user
3147 :     assign_dir = $assign_dir
3148 :     exe = $exe
3149 : olson 1.13 libdir = $ENV{BILLOGIX}
3150 :     path = $ENV{PATH}
3151 : olson 1.12
3152 :     App input
3153 :     $app_input
3154 :     EOF
3155 :     # feh, put in a block to reset perlmode indentation.
3156 : olson 1.23 {
3157 : parrello 1.69 my($app_read, $app_write);
3158 : parrello 1.60
3159 : parrello 1.69 #
3160 :     # Start the actual application with stdin and stdout redirected
3161 :     # to pipes.
3162 :     #
3163 :     # We write $app_input to the stdin pipe, and close it.
3164 :     # Then loop reading stdout, logging that output.
3165 :     #
3166 :     my $pid = open2($app_read, $app_write, $exe);
3167 :    
3168 :     if (!$pid)
3169 :     {
3170 :     warn "open2 $exe failed: $!\n";
3171 :     print $log "open2 $exe failed: $!\n";
3172 :     return;
3173 :     }
3174 :    
3175 :     print $app_write $app_input;
3176 :     close($app_write);
3177 :    
3178 :     #
3179 :     # Set autoflush on the logfile.
3180 :     #
3181 :    
3182 :     my $old = select($log);
3183 :     $| = 1;
3184 :     select(STDERR);
3185 :     $| = 1;
3186 :     select($old);
3187 :    
3188 :     warn "Starting $exe with pid $pid\n";
3189 :     print $log "Starting $exe with pid $pid\n";
3190 :    
3191 :     while (<$app_read>)
3192 :     {
3193 :     print STDERR $_;
3194 :     print $log $_;
3195 :     }
3196 :    
3197 :     print STDERR "App done\n";
3198 :     print $log "App done\n";
3199 :    
3200 :     close($app_read);
3201 :    
3202 :     my $ret = waitpid($pid, 0);
3203 :     my $stat = $?;
3204 :     print STDERR "Return status is $?\n";
3205 :     print $log "Return status is $?\n";
3206 :    
3207 :     #
3208 :     # This chunk has finished. We should see a file
3209 :     # rows.$this_chunk.$n_chunks.
3210 :     #
3211 :     }
3212 : olson 1.23 }
3213 :     #
3214 :     # At this point, the extension is finished (we've run the
3215 :     # $n_chunks parts of the extension job).
3216 :     #
3217 : olson 1.12
3218 : olson 1.14 #
3219 : olson 1.23 # We read in all the individual rows files, writing the single
3220 :     # concatenation of rows.
3221 : olson 1.14 #
3222 : olson 1.12
3223 : olson 1.23 my $ssaD = $self->{dir};
3224 : parrello 1.60
3225 : olson 1.23 my $rows_file = "$ssaD/rows";
3226 :    
3227 :     my $rowFH;
3228 :     if (!open($rowFH, ">$rows_file"))
3229 : olson 1.12 {
3230 : parrello 1.69 my $err = "Cannot open rows file $ssaD/rows for writing: $!\n";
3231 :     print STDERR $err;
3232 :     print $log $err;
3233 :     return;
3234 : olson 1.12 }
3235 :    
3236 : olson 1.23 for (my $this_chunk = 1; $this_chunk <= $n_chunks; $this_chunk++)
3237 :     {
3238 : parrello 1.69 my $chunkFH;
3239 :     my $cfile = "$ssaD/rows.$this_chunk.$n_chunks";
3240 :     if (!open($chunkFH, "<$cfile"))
3241 :     {
3242 :     my $err = "Cannot open rows file $cfile for reading: $!\n";
3243 :     print STDERR $err;
3244 :     print $log $err;
3245 :     return;
3246 :     }
3247 :     while (<$chunkFH>)
3248 :     {
3249 :     print $rowFH $_;
3250 :     }
3251 :     close($chunkFH);
3252 : olson 1.23 }
3253 :     close($rowFH);
3254 : olson 1.12
3255 :     #
3256 : olson 1.23 # Concatenate the assignments into the assignment directory.
3257 : olson 1.12 #
3258 :    
3259 : olson 1.23 my $assignments_file = "$assign_dir$job_id";
3260 :     my $assignFH;
3261 : olson 1.12
3262 : olson 1.23 if (!open($assignFH, ">$assignments_file"))
3263 : olson 1.12 {
3264 : parrello 1.69 my $err = "Cannot open assignments file $assignments_file for writing: $!\n";
3265 :     print STDERR $err;
3266 :     print $log $err;
3267 :     return;
3268 : olson 1.12 }
3269 :    
3270 : olson 1.23 for (my $this_chunk = 1; $this_chunk <= $n_chunks; $this_chunk++)
3271 : olson 1.19 {
3272 : parrello 1.69 my $aFH;
3273 :     my $afile = "$ssaD/assignments.$this_chunk.$n_chunks";
3274 :     if (!open($aFH, "<$afile"))
3275 :     {
3276 :     my $err = "Cannot open assignments file $afile for reading: $!\n";
3277 :     print STDERR $err;
3278 :     print $log $err;
3279 :     return;
3280 :     }
3281 :     while (<$aFH>)
3282 :     {
3283 :     print $assignFH $_;
3284 :     }
3285 :     close($aFH);
3286 : olson 1.19 }
3287 : olson 1.23 close($assignFH);
3288 : olson 1.19
3289 : parrello 1.60
3290 :    
3291 : olson 1.19 #
3292 : olson 1.14 # Back up the spreadsheet, and append the rows file to it.
3293 :     #
3294 :    
3295 :     &FIG::verify_dir("$ssaD/Backup");
3296 :     my $ts = time;
3297 :     rename("$ssaD/spreadsheet~","$ssaD/Backup/spreadsheet.$ts");
3298 :     copy("$ssaD/spreadsheet","$ssaD/spreadsheet~");
3299 :     rename("$ssaD/notes~","$ssaD/Backup/notes.$ts");
3300 :    
3301 :     #
3302 :     # Append the new rows to the spreadsheet.
3303 :     #
3304 :    
3305 :     my($ssafh, $rowsfh);
3306 :     open($ssafh, ">>$ssaD/spreadsheet") or die "Cannot open $ssaD/spreadsheet for append: $!\n";
3307 :     open($rowsfh, "<$ssaD/rows") or die "Cannot open $ssaD/rows for reading: $!\n";
3308 : parrello 1.60
3309 : olson 1.14 while (<$rowsfh>)
3310 :     {
3311 : parrello 1.69 print $ssafh $_;
3312 : olson 1.14 }
3313 :     close($ssafh);
3314 :     close($rowsfh);
3315 :    
3316 :     $self->incr_version();
3317 : olson 1.12 }
3318 : olson 1.13
3319 : olson 1.14
3320 : olson 1.13 sub set_current_extend_pid
3321 :     {
3322 :     my($self, $pid) = @_;
3323 :    
3324 :     if (open(my $fh, ">$self->{dir}/EXTEND_PID"))
3325 :     {
3326 : parrello 1.69 print $fh "$pid\n";
3327 : olson 1.13 }
3328 :     else
3329 :     {
3330 : parrello 1.69 warn "Cannot open $self->{dir}/EXTEND_PID: $!\n";
3331 : olson 1.13 }
3332 :     }
3333 :    
3334 :     sub get_current_extend_pid
3335 :     {
3336 :     my($self) = @_;
3337 :    
3338 :     if (open(my $fh, "<$self->{dir}/EXTEND_PID"))
3339 :     {
3340 : parrello 1.69 my $pid = <$fh>;
3341 :     close($fh);
3342 :     if ($pid)
3343 :     {
3344 :     chomp $pid;
3345 : parrello 1.60
3346 : parrello 1.69 return $pid;
3347 :     }
3348 : olson 1.13 }
3349 :     return undef;
3350 :     }
3351 : parrello 1.60
3352 : parrello 1.75 =head2 Static Utilities
3353 :    
3354 :     These are internal static methods used by the Sprout Subsystem object
3355 :     (SproutSubsys.pm). They insure that common functions are implemented with
3356 :     common code.
3357 :    
3358 :     =head3 GetDiagramIDs
3359 :    
3360 :     C<< my @diagramIDs = Subsystem::GetDiagramIDs($subDir); >>
3361 :    
3362 :     Return a list of the subsystem diagram IDs. The parameters are
3363 :    
3364 :     =over 4
3365 :    
3366 :     =item subDir
3367 :    
3368 :     Fully-qualified directory name for the subsystem.
3369 :    
3370 :     =item RETURN
3371 :    
3372 :     Returns a list of the diagram IDs for this subsystem. Each diagram ID corresponds
3373 :     to a diagram subdirectory in the subsystem's directory.
3374 :    
3375 :     =back
3376 :    
3377 :     =cut
3378 :    
3379 :     sub GetDiagramIDs {
3380 :     # Get the parameters.
3381 :     my ($subDir) = @_;
3382 :     # Read the diagram subdirectories.
3383 :     opendir(D, "$subDir/diagrams");
3384 :     my @ids = grep { not /^\./ and -d "$subDir/diagrams/$_" } readdir(D);
3385 :     closedir(D);
3386 :     # Return the IDs.
3387 :     return @ids;
3388 :    
3389 :     }
3390 :    
3391 :     =head3 GetDiagramName
3392 :    
3393 :     C<< my $name = Subsystem::GetDiagramName($subDir, $diagramID); >>
3394 :    
3395 :     Return the name of the subsystem diagram with the specified ID.
3396 :    
3397 :     =over 4
3398 :    
3399 :     =item subDir
3400 :    
3401 :     Subsystem directory name.
3402 :    
3403 :     =item diagramID
3404 :    
3405 :     ID of the diagram whose name is desired.
3406 :    
3407 :     =item RETURN
3408 :    
3409 :     Returns the name of the specified diagram, or C<undef> if the diagram does
3410 :     not exist.
3411 :    
3412 :     =back
3413 :    
3414 :     =cut
3415 :    
3416 :     sub GetDiagramName {
3417 :     # Get the parameters.
3418 :     my ($subDir, $diagramID) = @_;
3419 : parrello 1.77 # Declare the return value.
3420 :     my $retVal;
3421 : parrello 1.75 # Get the diagram's directory.
3422 :     my $ddir = "$subDir/diagrams/$diagramID";
3423 : parrello 1.77 Trace("Looking for directory $ddir.") if T(3);
3424 : parrello 1.75 # Only proceed if the directory exists.
3425 : parrello 1.77 if (-d $ddir) {
3426 :     # Read the name.
3427 :     my $name = &FIG::file_head("$ddir/NAME", 1);
3428 :     # If there was no name, use the diagram ID.
3429 :     Trace("Diagram name is \"$name\".") if T(3);
3430 :     if (! $name) {
3431 :     Trace("Using default name $diagramID.") if T(3);
3432 :     $name = $diagramID;
3433 :     }
3434 :     # Lop off the line terminator.
3435 :     chomp ($name);
3436 :     # Return the result.
3437 :     $retVal = $name;
3438 :     }
3439 :     Trace("Returning diagram name \"$retVal\".") if T(3);
3440 :     return $retVal;
3441 : parrello 1.75 }
3442 :    
3443 :     =head3 ComputeDiagramURLs
3444 :    
3445 :     C<< my ($link, $imgLink) = Subsystem::ComputeDiagramURLs($ssName, $diagramID); >>
3446 :    
3447 :     This is an internal static method that computes the URLs for a subsystem diagram.
3448 :     It insures that both SEED and Sprout use the same rules for generating the
3449 :     diagram URLs. The parameters are as follows.
3450 :    
3451 :     =over 4
3452 :    
3453 :     =item ssName
3454 :    
3455 :     Name of the relevant subsystem.
3456 :    
3457 :     =item diagramID
3458 :    
3459 :     ID of the relevant diagram.
3460 :    
3461 :     =item RETURN
3462 :    
3463 :     Returns a two-element list, the first element of which is a link to the diagram
3464 :     page, and the second of which is a link to the diagram image.
3465 :    
3466 :     =back
3467 :    
3468 :     =cut
3469 :    
3470 :     sub ComputeDiagramURLs {
3471 :     # Get the parameters.
3472 :     my ($ssName, $diagramID) = @_;
3473 :     # Compute the CGI directory base. Originally this was a configuration
3474 :     # parameter. Now we use a dot to force a relative URL.
3475 :     # my $base = $FIG_Config::cgi_base;
3476 :     my $base = './';
3477 :     # Create the links.
3478 :     my $link = $base . "subsys_diagram.cgi?ssa=$ssName&diagram=$diagramID";
3479 :     my $img_link = $link . "&image=1";
3480 :     # Return them.
3481 :     return ($link, $img_link);
3482 :     }
3483 :    
3484 : olson 1.7 package Subsystem::Diagram;
3485 :    
3486 :     sub new
3487 :     {
3488 :     my($class, $sub, $fig, $name, $dir) = @_;
3489 :    
3490 :     if (!-d $dir)
3491 :     {
3492 : parrello 1.69 return undef;
3493 : olson 1.7 }
3494 :    
3495 :     my $self = {
3496 : parrello 1.69 fig => $fig,
3497 :     subsystem => $sub,
3498 :     name => $name,
3499 :     dir =>$ dir,
3500 : olson 1.7 };
3501 :     bless $self, $class;
3502 :    
3503 :     $self->load();
3504 :    
3505 :     return $self;
3506 :     }
3507 :    
3508 :     #
3509 :     # Parse the diagram into internal data structure.
3510 :     #
3511 :    
3512 :     sub load
3513 :     {
3514 :     my($self) = @_;
3515 :    
3516 :     $self->load_area();
3517 :     }
3518 :    
3519 :     sub load_area
3520 :     {
3521 :     my($self) = @_;
3522 :     my $fh;
3523 :    
3524 : olson 1.8 if (!open($fh, "<$self->{dir}/area_table"))
3525 : olson 1.7 {
3526 : parrello 1.69 warn "Could not load $self->{dir}/area_table: $!\n";
3527 :     return;
3528 : olson 1.7 }
3529 :    
3530 :     $self->{areas} = [];
3531 :    
3532 :     my $area_list = $self->{areas};
3533 : parrello 1.60
3534 : olson 1.7 while (<$fh>)
3535 :     {
3536 : parrello 1.69 chomp;
3537 :     s/#.*$//;
3538 :     s/^\s+//;
3539 :     s/\s+$//;
3540 :     next if $_ eq '';
3541 :     my ($area, $tag, $value) = split(/\s+/, $_, 3);
3542 :     # print "area=$area tag=$tag value=$value\n";
3543 :    
3544 :     push(@$area_list, [$area, $tag, $value]);
3545 :    
3546 :     #
3547 :     # Do a little checking.
3548 :     #
3549 :    
3550 :     if ($tag eq "role")
3551 :     {
3552 :     my $idx = $self->{subsystem}->get_role_index($value);
3553 :     if (!defined($idx))
3554 :     {
3555 :     warn "Role not found for \"$value\" in subsystem $self->{subsystem}->{name}\n";
3556 :     }
3557 :     }
3558 : olson 1.7 }
3559 :     close($fh);
3560 :     }
3561 :    
3562 :     sub get_areas
3563 :     {
3564 :     my($self) = @_;
3565 :    
3566 :     return @{$self->{areas}};
3567 :     }
3568 :    
3569 : parrello 1.75
3570 : olson 1.1 1;
3571 : olson 1.7
3572 : parrello 1.73 =head2 Method Listing
3573 :    
3574 :     =over 4
3575 :    
3576 :     =item index_cell
3577 :    
3578 :     Create the subsystem_index entries for the given cell.
3579 :     (NEW).
3580 :    
3581 :     =item delete_role(name)
3582 :    
3583 :     Delete the given role.
3584 :    
3585 :     =item add_role(name, abbr)
3586 :    
3587 :     Add a new role.
3588 :    
3589 :     =item get_subset(name)
3590 :    
3591 :     A deprecated form of get_subsetC
3592 :    
3593 :     =item get_subsetC(name)
3594 :    
3595 :     Returns a given subset. A subset is an object, implemented as a blessed array
3596 :     of roles.
3597 :    
3598 :     =item add_genome(genome_id, variant_code)
3599 :    
3600 :     =item remove_genome(genome_id)
3601 :    
3602 :     =back
3603 :    
3604 :     =cut
3605 : olson 1.7

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3