]> git.donarmstrong.com Git - biopieces.git/blobdiff - code_perl/Maasha/Biopieces.pm
fixes and stuff
[biopieces.git] / code_perl / Maasha / Biopieces.pm
index 44369a8ad626b4a373c389cf498e64b32df1caa6..867f71b011aaf90326ed38ace14927007623d933 100644 (file)
@@ -56,6 +56,76 @@ $SIG{ 'INT' }     = \&sig_handler;
 $SIG{ 'TERM' }    = \&sig_handler;
 
 
+sub status_set
+{
+    my ( $time_stamp, $script, $user, $pid, $file, $fh );
+
+    $time_stamp = Maasha::Common::time_stamp();
+    $user       = Maasha::Common::get_user();
+    $script     = Maasha::Common::get_scriptname();
+    $pid        = Maasha::Common::get_processid();
+
+    $file = "$ENV{ 'BP_TMP' }/" . join( ".", $user, $script, $pid ) . ".status";
+    $fh   = Maasha::Filesys::file_write_open( $file );
+
+    print $fh join( ";", $time_stamp, join( " ", @ARGV ) ) . "\n";
+
+    close $fh;
+}
+
+
+sub status_log
+{
+    # Martin A. Hansen, June 2009.
+
+    # Retrieves initial status information written with status_set and uses this
+    # to write a status entry to the log file.
+
+    my ( $status,   # status - OPTIONAL
+       ) = @_;
+
+    # Returns nothing.
+
+    my ( $time0, $time1, $script, $user, $pid, $file, $fh, $elap, $fh_global, $fh_local, $line, $args, $tmp_dir );
+
+    $status ||= "OK";
+
+    $time1      = Maasha::Common::time_stamp();
+    $user       = Maasha::Common::get_user();
+    $script     = Maasha::Common::get_scriptname();
+    $pid        = Maasha::Common::get_processid();
+
+    $file = "$ENV{ 'BP_TMP' }/" . join( ".", $user, $script, $pid ) . ".status";
+
+    return if not -f $file;
+
+    $fh   = Maasha::Filesys::file_read_open( $file );
+    $line = <$fh>;
+    chomp $line;
+    close $fh;
+
+    unlink $file;
+
+    ( $time0, $args, $tmp_dir ) = split /;/, $line;
+
+    Maasha::Filesys::dir_remove( $tmp_dir ) if defined $tmp_dir;
+
+    $elap = Maasha::Common::time_stamp_diff( $time0, $time1 );
+
+    $fh_global = Maasha::Filesys::file_append_open( "$ENV{ 'BP_LOG' }/biopieces.log" );
+    $fh_local  = Maasha::Filesys::file_append_open( "$ENV{ 'HOME' }/.biopieces.log" );
+
+    print $fh_global join( "\t", $time0, $time1, $elap, $user, $status, "$script $args" ) . "\n";
+    print $fh_local  join( "\t", $time0, $time1, $elap, $user, $status, "$script $args" ) . "\n";
+
+    $fh_global->autoflush( 1 );
+    $fh_local->autoflush( 1 );
+
+    close $fh_global;
+    close $fh_local;
+}
+
+
 sub log_biopiece
 {
     # Martin A. Hansen, January 2008.
@@ -219,7 +289,12 @@ sub parse_options
 {
     # Martin A. Hansen, May 2009
 
-    # 
+    # Parses and checks options for Biopieces.
+
+    # First the argument list is checked for duplicates and then
+    # options are parsed from ARGV after which it is checked if
+    # the Biopieces usage information should be printed. Finally,
+    # all options from ARGV are checked according to the argument list.
 
     my ( $arg_list,   # data structure with argument description
        ) = @_;
@@ -232,10 +307,10 @@ sub parse_options
 
     push @{ $arg_list }, (
     
-        { long => 'help',       short => '?', type => 'flag',  mandatory => 'no',  default => undef, allowed => undef, disallowed => undef },
-        { long => 'stream_in',  short => 'I', type => 'file!', mandatory => 'no',  default => undef, allowed => undef, disallowed => undef },
-        { long => 'stream_out', short => 'O', type => 'file',  mandatory => 'no',  default => undef, allowed => undef, disallowed => undef },
-        { long => 'verbose',    short => 'v', type => 'flag',  mandatory => 'no',  default => undef, allowed => undef, disallowed => undef },
+        { long => 'help',       short => '?', type => 'flag',  mandatory => 'no', default => undef, allowed => undef, disallowed => undef },
+        { long => 'stream_in',  short => 'I', type => 'file!', mandatory => 'no', default => undef, allowed => undef, disallowed => undef },
+        { long => 'stream_out', short => 'O', type => 'file',  mandatory => 'no', default => undef, allowed => undef, disallowed => undef },
+        { long => 'verbose',    short => 'v', type => 'flag',  mandatory => 'no', default => undef, allowed => undef, disallowed => undef },
     );
 
     check_duplicates_args( $arg_list );
@@ -339,7 +414,7 @@ sub check_print_usage
                
                     if ( exists $options->{ 'help' } ) {
                         `print_wiki --data_in=$wiki --help`;
-                    } elsif ( $script =~ /^(list_biopieces|list_genomes)$/ ) {
+                    } elsif ( $script =~ /^(list_biopieces|list_genomes|biostat)$/ ) {
                         return;
                     } else {
                         `print_wiki --data_in=$wiki`;
@@ -664,20 +739,28 @@ sub sig_handler
 
     sleep 1;
 
-#    if ( -d $BP_TMP )
+    if ( $sig =~ /MAASHA_ERROR/ )
     {
-        if ( $sig =~ /MAASHA_ERROR/ ) {
-            print STDERR "\nProgram '$script' had an error"                     . "  -  Please wait for temporary data to be removed\n";
-        } elsif ( $sig eq "INT" ) {
-            print STDERR "\nProgram '$script' interrupted (ctrl-c was pressed)" . "  -  Please wait for temporary data to be removed\n";
-        } elsif ( $sig eq "TERM" ) {
-            print STDERR "\nProgram '$script' terminated (someone used kill?)"  . "  -  Please wait for temporary data to be removed\n";
-        } else {
-            print STDERR "\nProgram '$script' died->$sig"                       . "  -  Please wait for temporary data to be removed\n";
-        }
-
-        clean_tmp();
+        print STDERR "\nProgram '$script' had an error"                     . "  -  Please wait for temporary data to be removed\n";
+        status_log( "ERROR" );
     }
+    elsif ( $sig eq "INT" )
+    {
+        print STDERR "\nProgram '$script' interrupted (ctrl-c was pressed)" . "  -  Please wait for temporary data to be removed\n";
+        status_log( "INTERUPTED" );
+    }
+    elsif ( $sig eq "TERM" )
+    {
+        print STDERR "\nProgram '$script' terminated (someone used kill?)"  . "  -  Please wait for temporary data to be removed\n";
+        status_log( "TERMINATED" );
+    }
+    else
+    {
+        print STDERR "\nProgram '$script' died->$sig"                       . "  -  Please wait for temporary data to be removed\n";
+        status_log( "DIED" );
+    }
+
+    clean_tmp();
 
     exit( 0 );
 }
@@ -727,59 +810,37 @@ sub clean_tmp
 }
 
 
-sub run_time
-{
-    # Martin A. Hansen, May 2009.
-
-    # Returns a precision timestamp for calculating
-    # run time.
-
-    return Maasha::Common::get_time_hires();
-}
-
-
-sub run_time_print
-{
-    # Martin A. Hansen, May 2009
-
-    # Print the run time to STDERR for the current script if
-    # the verbose switch is set in the option hash.
-
-    my ( $t0,       # run time begin
-         $t1,       # run time end
-         $options,  # options hash
-       ) = @_;
-
-    # Returns nothing
-
-    my $script = Maasha::Common::get_scriptname();
-
-    print STDERR "Program: $script" . ( " " x ( 25 - length( $script ) ) ) . sprintf( "Run time: %.4f\n", ( $t1 - $t0 ) ) if $options->{ 'verbose' };
-
-}
-
-
 sub get_tmpdir
 {
     # Martin A. Hansen, April 2008.
 
     # Create a temporary directory based on
-    # $ENV{ 'BP_TMP' } and sessionid.
-
-    # this thing is a really bad solution and needs to be removed.
+    # $ENV{ 'BP_TMP' } and sessionid. The directory
+    # name is written to the status file.
 
     # Returns a path.
 
-    my ( $user, $sid, $pid, $path );
+    my ( $user, $sid, $pid, $script, $path, $file, $fh, $line );
 
     Maasha::Common::error( qq(no BP_TMP set in %ENV) ) if not -d $ENV{ 'BP_TMP' };
 
-    $user = Maasha::Common::get_user();
-    $sid  = Maasha::Common::get_sessionid();
-    $pid  = Maasha::Common::get_processid();
+    $user   = Maasha::Common::get_user();
+    $sid    = Maasha::Common::get_sessionid();
+    $pid    = Maasha::Common::get_processid();
+    $script = Maasha::Common::get_scriptname();
 
     $path = "$ENV{ 'BP_TMP' }/" . join( "_", $user, $sid, $pid, "bp_tmp" );
+    $file = "$ENV{ 'BP_TMP' }/" . join( ".", $user, $script, $pid ) . ".status";
     
+    $fh   = Maasha::Filesys::file_read_open( $file );
+    $line = <$fh>;
+    chomp $line;
+    close $fh;
+
+    $fh   = Maasha::Filesys::file_write_open( $file );
+    print $fh "$line;$path\n";
+    close $fh;
+
     Maasha::Filesys::dir_create( $path );
 
     return $path;