code_perl/Maasha/Biopieces.pm

   1 package Maasha::Biopieces;
   2
   3
   4 # Copyright (C) 2007-2009 Martin A. Hansen.
   5
   6 # This program is free software; you can redistribute it and/or
   7 # modify it under the terms of the GNU General Public License
   8 # as published by the Free Software Foundation; either version 2
   9 # of the License, or (at your option) any later version.
  10
  11 # This program is distributed in the hope that it will be useful,
  12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 # GNU General Public License for more details.
  15
  16 # You should have received a copy of the GNU General Public License
  17 # along with this program; if not, write to the Free Software
  18 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  19
  20 # http://www.gnu.org/copyleft/gpl.html
  21
  22
  23 # >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> DESCRIPTION <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
  24
  25
  26 # Routines for manipulation, parsing and emitting of human/machine readable biopieces records.
  27
  28
  29 # >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>><<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
  30
  31
  32 use Getopt::Long qw( :config bundling );
  33 use Data::Dumper;
  34 use Maasha::Match;
  35 use Maasha::Common;
  36 use Maasha::Filesys;
  37 use vars qw( @ISA @EXPORT_OK );
  38
  39 require Exporter;
  40
  41 @ISA = qw( Exporter );
  42
  43 @EXPORT_OK = qw(
  44     read_stream
  45     write_stream
  46     get_record
  47     put_record
  48 );
  49
  50
  51 # >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> SIGNAL HANDLER <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
  52
  53
  54 $SIG{ '__DIE__' } = \&sig_handler;
  55 $SIG{ 'INT' }     = \&sig_handler;
  56 $SIG{ 'TERM' }    = \&sig_handler;
  57
  58
  59 sub status_set
  60 {
  61     my ( $time_stamp, $script, $user, $pid, $file, $fh );
  62
  63     $time_stamp = Maasha::Common::time_stamp();
  64     $user       = Maasha::Common::get_user();
  65     $script     = Maasha::Common::get_scriptname();
  66     $pid        = Maasha::Common::get_processid();
  67
  68     $file = "$ENV{ 'BP_TMP' }/" . join( ".", $user, $script, $pid ) . ".status";
  69     $fh   = Maasha::Filesys::file_write_open( $file );
  70
  71     print $fh join( ";", $time_stamp, join( " ", @ARGV ) ) . "\n";
  72
  73     close $fh;
  74 }
  75
  76
  77 sub status_log
  78 {
  79     # Martin A. Hansen, June 2009.
  80
  81     # Retrieves initial status information written with status_set and uses this
  82     # to write a status entry to the log file.
  83
  84     my ( $status,   # status - OPTIONAL
  85        ) = @_;
  86
  87     # Returns nothing.
  88
  89     my ( $time0, $time1, $script, $user, $pid, $file, $fh, $elap, $fh_global, $fh_local, $line, $args, $tmp_dir );
  90
  91     $status ||= "OK";
  92
  93     $time1      = Maasha::Common::time_stamp();
  94     $user       = Maasha::Common::get_user();
  95     $script     = Maasha::Common::get_scriptname();
  96     $pid        = Maasha::Common::get_processid();
  97
  98     $file = "$ENV{ 'BP_TMP' }/" . join( ".", $user, $script, $pid ) . ".status";
  99
 100     return if not -f $file;
 101
 102     $fh   = Maasha::Filesys::file_read_open( $file );
 103     $line = <$fh>;
 104     chomp $line;
 105     close $fh;
 106
 107     unlink $file;
 108
 109     ( $time0, $args, $tmp_dir ) = split /;/, $line;
 110
 111     Maasha::Filesys::dir_remove( $tmp_dir ) if defined $tmp_dir;
 112
 113     $elap = Maasha::Common::time_stamp_diff( $time0, $time1 );
 114
 115     $fh_global = Maasha::Filesys::file_append_open( "$ENV{ 'BP_LOG' }/biopieces.log" );
 116     $fh_local  = Maasha::Filesys::file_append_open( "$ENV{ 'HOME' }/.biopieces.log" );
 117
 118     print $fh_global join( "\t", $time0, $time1, $elap, $user, $status, "$script $args" ) . "\n";
 119     print $fh_local  join( "\t", $time0, $time1, $elap, $user, $status, "$script $args" ) . "\n";
 120
 121     $fh_global->autoflush( 1 );
 122     $fh_local->autoflush( 1 );
 123
 124     close $fh_global;
 125     close $fh_local;
 126 }
 127
 128
 129 sub log_biopiece
 130 {
 131     # Martin A. Hansen, January 2008.
 132
 133     # Log messages to logfile.
 134
 135     # Returns nothing.
 136
 137     my ( $time_stamp, $user, $script, $fh_global, $fh_local );
 138
 139     $time_stamp = Maasha::Common::time_stamp();
 140     $user       = Maasha::Common::get_user();
 141     $script     = Maasha::Common::get_scriptname();
 142
 143     $fh_global  = Maasha::Filesys::file_append_open( "$ENV{ 'BP_LOG' }/biopieces.log" );
 144     $fh_local   = Maasha::Filesys::file_append_open( "$ENV{ 'HOME' }/.biopieces.log" );
 145
 146     print $fh_global "$time_stamp\t$user\t$script ", join( " ", @ARGV ), "\n";
 147     print $fh_local  "$time_stamp\t$user\t$script ", join( " ", @ARGV ), "\n";
 148
 149     $fh_global->autoflush( 1 );
 150     $fh_local->autoflush( 1 );
 151
 152     close $fh_global;
 153     close $fh_local;
 154 }
 155
 156
 157 sub read_stream
 158 {
 159     # Martin A. Hansen, July 2007.
 160
 161     # Opens a stream to STDIN or a file,
 162
 163     my ( $file,   # file - OPTIONAL
 164        ) = @_;
 165
 166     # Returns filehandle.
 167
 168     my ( $fh );
 169
 170     if ( not -t STDIN ) {
 171         $fh = Maasha::Filesys::stdin_read();
 172     } elsif ( not $file ) {
 173         # Maasha::Common::error( qq(no data stream) );
 174     } else {
 175         $fh = Maasha::Filesys::file_read_open( $file );
 176     }
 177
 178     return $fh;
 179 }
 180
 181
 182 sub write_stream
 183 {
 184     # Martin A. Hansen, August 2007.
 185
 186     # Opens a stream to STDOUT or a file.
 187
 188     my ( $path,   # path          - OPTIONAL
 189          $gzip,   # compress data - OPTIONAL
 190        ) = @_;
 191
 192     # Returns filehandle.
 193
 194     my ( $fh );
 195
 196     if ( $path ) {
 197         $fh = Maasha::Filesys::file_write_open( $path, $gzip );
 198     } else {
 199         $fh = Maasha::Filesys::stdout_write();
 200     }
 201
 202     return $fh;
 203 }
 204
 205
 206 sub close_stream
 207 {
 208     # Martin A. Hansen, May 2009.
 209
 210     # Close stream if open.
 211
 212     my ( $fh,   # filehandle
 213        ) = @_;
 214
 215     # Returns nothing.
 216
 217     close $fh if defined $fh;
 218 }
 219
 220
 221 sub get_record
 222 {
 223     # Martin A. Hansen, July 2007.
 224
 225     # Reads one record at a time and converts that record
 226     # to a Perl data structure (a hash) which is returned.
 227
 228     my ( $fh,   # handle to stream
 229        ) = @_;
 230
 231     # Returns a hash.
 232
 233     my ( $block, @lines, $line, $key, $value, %record );
 234
 235     return if not defined $fh;
 236
 237     local $/ = "\n---\n";
 238
 239     $block = <$fh>;
 240
 241     return if not defined $block;
 242
 243     chomp $block;
 244
 245     @lines = split "\n", $block;
 246
 247     foreach $line ( @lines )
 248     {
 249         ( $key, $value ) = split ": ", $line, 2;
 250
 251         $record{ $key } = $value;
 252     }
 253
 254     return wantarray ? %record : \%record;
 255 }
 256
 257
 258 sub put_record
 259 {
 260     # Martin A. Hansen, July 2007.
 261
 262     # Given a Perl datastructure (a hash ref) emits this to STDOUT or a filehandle.
 263
 264     my ( $data,   # data structure
 265          $fh,     # file handle - OPTIONAL
 266        ) = @_;
 267
 268     # Returns nothing.
 269
 270     if ( scalar keys %{ $data } )
 271     {
 272         if ( $fh )
 273         {
 274             map { print $fh "$_: $data->{ $_ }\n" } keys %{ $data };
 275             print $fh "---\n";
 276         }
 277         else
 278         {
 279             map { print "$_: $data->{ $_ }\n" } keys %{ $data };
 280             print "---\n";
 281         }
 282     }
 283
 284     undef $data;
 285 }
 286
 287
 288 sub parse_options
 289 {
 290     # Martin A. Hansen, May 2009
 291
 292     #
 293
 294     my ( $arg_list,   # data structure with argument description
 295        ) = @_;
 296
 297     # Returns hashref.
 298
 299     my ( $arg, @list, $options );
 300
 301     # ---- Adding the mandatory arguments to the arg_list ----
 302
 303     push @{ $arg_list }, (
 304
 305         { long => 'help',       short => '?', type => 'flag',  mandatory => 'no',  default => undef, allowed => undef, disallowed => undef },
 306         { long => 'stream_in',  short => 'I', type => 'file!', mandatory => 'no',  default => undef, allowed => undef, disallowed => undef },
 307         { long => 'stream_out', short => 'O', type => 'file',  mandatory => 'no',  default => undef, allowed => undef, disallowed => undef },
 308         { long => 'verbose',    short => 'v', type => 'flag',  mandatory => 'no',  default => undef, allowed => undef, disallowed => undef },
 309     );
 310
 311     check_duplicates_args( $arg_list );
 312
 313     # ---- Compiling options list ----
 314
 315     foreach $arg ( @{ $arg_list } )
 316     {
 317         if ( $arg->{ 'type' } eq 'flag' ) {
 318             push @list, "$arg->{ 'long' }|$arg->{ 'short' }";
 319         } else {
 320             push @list, "$arg->{ 'long' }|$arg->{ 'short' }=s";
 321         }
 322     }
 323
 324     # ---- Parsing options from @ARGV ----
 325
 326     $options = {};
 327
 328     Getopt::Long::GetOptions( $options, @list );
 329
 330     # print Dumper( $options );
 331
 332     check_print_usage( $options );
 333
 334     # ---- Expanding and checking options ----
 335
 336     foreach $arg ( @{ $arg_list } )
 337     {
 338         check_mandatory(  $arg, $options );
 339         set_default(      $arg, $options );
 340         check_uint(       $arg, $options );
 341         check_int(        $arg, $options );
 342         set_list(         $arg, $options );
 343         check_dir(        $arg, $options );
 344         check_file(       $arg, $options );
 345         set_files(        $arg, $options );
 346         check_files(      $arg, $options );
 347         check_allowed(    $arg, $options );
 348         check_disallowed( $arg, $options );
 349     }
 350
 351     # print Dumper( $options );
 352
 353     # return wantarray ? $options : %{ $options }; # WTF! Someone changed the behaviour of wantarray???
 354
 355     return $options;
 356 }
 357
 358
 359 sub check_duplicates_args
 360 {
 361     # Martin A. Hansen, May 2009
 362
 363     # Check if there are duplicate long or short arguments,
 364     # and raise an error if so.
 365
 366     my ( $arg_list,   # List of argument hashrefs,
 367        ) = @_;
 368
 369     # Returns nothing.
 370
 371     my ( $arg, %check_hash );
 372
 373     foreach $arg ( @{ $arg_list } )
 374     {
 375         Maasha::Common::error( qq(Duplicate long argument: $arg->{ 'long' }) )   if exists $check_hash{ $arg->{ 'long' } };
 376         Maasha::Common::error( qq(Duplicate short argument: $arg->{ 'short' }) ) if exists $check_hash{ $arg->{ 'short' } };
 377
 378         $check_hash{ $arg->{ 'long' } } = 1;
 379         $check_hash{ $arg->{ 'short' } } = 1;
 380     }
 381 }
 382
 383
 384 sub check_print_usage
 385 {
 386     # Martin A. Hansen, May 2009.
 387
 388     # Check if we need to print usage and print usage
 389     # and exit if that is the case.
 390
 391     my ( $options,   # option hash
 392        ) = @_;
 393
 394     # Returns nothing.
 395
 396     my ( $script, $wiki );
 397
 398     $script = Maasha::Common::get_scriptname();
 399
 400     if ( $script ne 'print_wiki' )
 401     {
 402         if ( exists $options->{ 'help' } or -t STDIN )
 403         {
 404             if ( not ( exists $options->{ 'stream_in' } or $options->{ 'data_in' } ) )
 405             {
 406                 if ( scalar keys %{ $options } <= 1 )
 407                 {
 408                     $wiki = $ENV{ 'BP_DIR' } . "/bp_usage/$script.wiki";
 409
 410                     if ( exists $options->{ 'help' } ) {
 411                         `print_wiki --data_in=$wiki --help`;
 412                     } elsif ( $script =~ /^(list_biopieces|list_genomes)$/ ) {
 413                         return;
 414                     } else {
 415                         `print_wiki --data_in=$wiki`;
 416                     }
 417
 418                     exit;
 419                 }
 420             }
 421         }
 422     }
 423 }
 424
 425
 426 sub check_mandatory
 427 {
 428     # Martin A. Hansen, May 2009.
 429
 430     # Check if mandatory arguments are set and raises an error if not.
 431
 432     my ( $arg,       # hashref
 433          $options,   # options hash
 434        ) = @_;
 435
 436     # Returns nothing.
 437
 438     if ( $arg->{ 'mandatory' } eq 'yes' and not defined $options->{ $arg->{ 'long' } } ) {
 439         Maasha::Common::error( qq(Argument --$arg->{ 'long' } is mandatory) );
 440     }
 441 }
 442
 443
 444 sub set_default
 445 {
 446     # Martin A. Hansen, May 2009.
 447
 448     # Set default values in option hash.
 449
 450     my ( $arg,      # hashref
 451          $options,  # options hash
 452        ) = @_;
 453
 454     # Returns nothing.
 455
 456     if ( not defined $options->{ $arg->{ 'long' } } ) {
 457         $options->{ $arg->{ 'long' } } = $arg->{ 'default' }
 458     }
 459 }
 460
 461
 462 sub check_uint
 463 {
 464     # Martin A. Hansen, May 2009.
 465
 466     # Check if value to argument is an unsigned integer and
 467     # raises an error if not.
 468
 469     my ( $arg,      # hashref
 470          $options,  # options hash
 471        ) = @_;
 472
 473     # Returns nothing.
 474
 475     if ( $arg->{ 'type' } eq 'uint' and defined $options->{ $arg->{ 'long' } } )
 476     {
 477         if ( $options->{ $arg->{ 'long' } } !~ /^\d+$/ ) {
 478             Maasha::Common::error( qq(Argument --$arg->{ 'long' } must be an unsigned integer - not $options->{ $arg->{ 'long' } }) );
 479         }
 480     }
 481 }
 482
 483
 484 sub check_int
 485 {
 486     # Martin A. Hansen, May 2009.
 487
 488     # Check if value to argument is an integer and
 489     # raises an error if not.
 490
 491     my ( $arg,      # hashref
 492          $options,  # options hash
 493        ) = @_;
 494
 495     # Returns nothing.
 496
 497     if ( $arg->{ 'type' } eq 'int' and defined $options{ $arg->{ 'long' } } )
 498     {
 499         if ( $options->{ $arg->{ 'long' } } !~ /^-?\d+$/ ) {
 500             Maasha::Common::error( qq(Argument --$arg->{ 'long' } must be an integer - not $options->{ $arg->{ 'long' } }) );
 501         }
 502     }
 503 }
 504
 505
 506 sub set_list
 507 {
 508     # Martin A. Hansen, May 2009.
 509
 510     # Splits an argument of type 'list' into a list that is put
 511     # in the options hash.
 512
 513     my ( $arg,      # hashref
 514          $options,  # options hash
 515        ) = @_;
 516
 517     # Returns nothing.
 518
 519     if ( $arg->{ 'type' } eq 'list' and defined $options->{ $arg->{ 'long' } } ) {
 520         $options->{ $arg->{ 'long' } } = [ split /,/, $options->{ $arg->{ 'long' } } ];
 521     }
 522 }
 523
 524
 525 sub check_dir
 526 {
 527     # Martin A. Hansen, May 2009.
 528
 529     # Check if an argument of type 'dir!' truly is a directory and
 530     # raises an error if not.
 531
 532     my ( $arg,      # hashref
 533          $options,  # options hash
 534        ) = @_;
 535
 536     # Returns nothing.
 537
 538     if ( $arg->{ 'type' } eq 'dir!' and defined $options->{ $arg->{ 'long' } } )
 539     {
 540         if ( not -d $options->{ $arg->{ 'long' } } ) {
 541             Maasha::Common::error( qq(No such directory: "$options->{ $arg->{ 'long' } }") );
 542         }
 543     }
 544 }
 545
 546
 547 sub check_file
 548 {
 549     # Martin A. Hansen, May 2009.
 550
 551     # Check if an argument of type 'file!' truly is a file and
 552     # raises an error if not.
 553
 554     my ( $arg,      # hashref
 555          $options,  # options hash
 556        ) = @_;
 557
 558     # Returns nothing.
 559
 560     if ( $arg->{ 'type' } eq 'file!' and defined $options->{ $arg->{ 'long' } } )
 561     {
 562         if ( not -f $options->{ $arg->{ 'long' } } ) {
 563             Maasha::Common::error( qq(No such file: "$options->{ $arg->{ 'long' } }") );
 564         }
 565     }
 566 }
 567
 568
 569 sub set_files
 570 {
 571     # Martin A. Hansen, May 2009.
 572
 573     # Split the argument to 'files' into a list that is put on the options hash.
 574
 575     my ( $arg,      # hashref
 576          $options,  # options hash
 577        ) = @_;
 578
 579     # Returns nothing.
 580
 581     if ( $arg->{ 'type' } eq 'files' and defined $options->{ $arg->{ 'long' } } ) {
 582         $options->{ $arg->{ 'long' } } = [ split /,/, $options->{ $arg->{ 'long' } } ];
 583     }
 584 }
 585
 586
 587 sub check_files
 588 {
 589     # Martin A. Hansen, May 2009.
 590
 591     # Split the argument to 'files!' and check if each file do exists before adding
 592     # the file list to the options hash.
 593
 594     my ( $arg,      # hashref
 595          $options,  # options hash
 596        ) = @_;
 597
 598     # Returns nothing.
 599
 600     my ( $elem, @files );
 601
 602     if ( $arg->{ 'type' } eq 'files!' and defined $options->{ $arg->{ 'long' } } )
 603     {
 604         foreach $elem ( split /,/, $options->{ $arg->{ 'long' } } )
 605         {
 606             if ( -f $elem ) {
 607                 push @files, $elem;
 608             } elsif ( $elem =~ /\*/ ) {
 609                 push @files, glob( $elem );
 610             }
 611         }
 612
 613         if ( scalar @files == 0 ) {
 614             Maasha::Common::error( qq(Argument to --$arg->{ 'long' } must be a valid file or fileglob expression - not $options->{ $arg->{ 'long' } }) );
 615         }
 616
 617         $options->{ $arg->{ 'long' } } = [ @files ];
 618     }
 619 }
 620
 621
 622 sub check_allowed
 623 {
 624     # Martin A. Hansen, May 2009.
 625
 626     # Check if all values to all arguement are allowed and raise an
 627     # error if not.
 628
 629     my ( $arg,      # hashref
 630          $options,  # options hash
 631        ) = @_;
 632
 633     # Returns nothing.
 634
 635     my ( $elem );
 636
 637     if ( defined $arg->{ 'allowed' } and defined $options->{ $arg->{ 'long' } } )
 638     {
 639         map { $val_hash{ $_ } = 1 } split /,/, $arg->{ 'allowed' };
 640
 641         if ( $arg->{ 'type' } =~ /^(list|files|files!)$/ )
 642         {
 643             foreach $elem ( @{ $options->{ $arg->{ 'long' } } } )
 644             {
 645                 if ( not exists $val_hash{ $elem } ) {
 646                     Maasha::Common::error( qq(Argument to --$arg->{ 'long' } $elem is not allowed) );
 647                 }
 648             }
 649         }
 650         else
 651         {
 652             if ( not exists $val_hash{ $options->{ $arg->{ 'long' } } } ) {
 653                 Maasha::Common::error( qq(Argument to --$arg->{ 'long' } $options->{ $arg->{ 'long' } } is not allowed) );
 654             }
 655         }
 656     }
 657 }
 658
 659
 660 sub check_disallowed
 661 {
 662     # Martin A. Hansen, May 2009.
 663
 664     # Check if any values to all arguemnts are disallowed and raise an error if so.
 665
 666     my ( $arg,      # hashref
 667          $options,  # options hash
 668        ) = @_;
 669
 670     # Returns nothing.
 671
 672     my ( $val, %val_hash );
 673
 674     if ( defined $arg->{ 'disallowed' } and defined $options->{ $arg->{ 'long' } } )
 675     {
 676         foreach $val ( split /,/, $arg->{ 'disallowed' } )
 677         {
 678             if ( $options->{ $arg->{ 'long' } } eq $val ) {
 679                 Maasha::Common::error( qq(Argument to --$arg->{ 'long' } $val is disallowed) );
 680             }
 681         }
 682     }
 683 }
 684
 685
 686 sub getopt_files
 687 {
 688     # Martin A. Hansen, November 2007.
 689
 690     # Extracts files from an explicit GetOpt::Long argument
 691     # allowing for the use of glob. E.g.
 692     # --data_in=test.fna
 693     # --data_in=test.fna,test2.fna
 694     # --data_in=*.fna
 695     # --data_in=test.fna,/dir/*.fna
 696
 697     my ( $option,   # option from GetOpt::Long
 698        ) = @_;
 699
 700     # Returns a list.
 701
 702     my ( $elem, @files );
 703
 704     foreach $elem ( split ",", $option )
 705     {
 706         if ( -f $elem ) {
 707             push @files, $elem;
 708         } elsif ( $elem =~ /\*/ ) {
 709             push @files, glob( $elem );
 710         }
 711     }
 712
 713     return wantarray ? @files : \@files;
 714 }
 715
 716
 717 sub sig_handler
 718 {
 719     # Martin A. Hansen, April 2008.
 720
 721     # Removes temporary directory and exits gracefully.
 722     # This subroutine is meant to be run always as the last
 723     # thing even if a script is dies or is interrupted
 724     # or killed.
 725
 726     my ( $sig,   # signal from the %SIG
 727        ) = @_;
 728
 729     # print STDERR "signal->$sig<-\n";
 730
 731     my $script = Maasha::Common::get_scriptname();
 732
 733     chomp $sig;
 734
 735     sleep 1;
 736
 737     if ( $sig =~ /MAASHA_ERROR/ )
 738     {
 739         print STDERR "\nProgram '$script' had an error"                     . "  -  Please wait for temporary data to be removed\n";
 740         status_log( "ERROR" );
 741     }
 742     elsif ( $sig eq "INT" )
 743     {
 744         print STDERR "\nProgram '$script' interrupted (ctrl-c was pressed)" . "  -  Please wait for temporary data to be removed\n";
 745         status_log( "INTERUPTED" );
 746     }
 747     elsif ( $sig eq "TERM" )
 748     {
 749         print STDERR "\nProgram '$script' terminated (someone used kill?)"  . "  -  Please wait for temporary data to be removed\n";
 750         status_log( "TERMINATED" );
 751     }
 752     else
 753     {
 754         print STDERR "\nProgram '$script' died->$sig"                       . "  -  Please wait for temporary data to be removed\n";
 755         status_log( "DIED" );
 756     }
 757
 758     clean_tmp();
 759
 760     exit( 0 );
 761 }
 762
 763
 764 sub clean_tmp
 765 {
 766     # Martin A. Hansen, July 2008.
 767
 768     # Cleans out any unused temporary files and directories in BP_TMP.
 769
 770     # Returns nothing.
 771
 772     my ( $tmpdir, @dirs, $curr_pid, $dir, $user, $sid, $pid );
 773
 774     $tmpdir = $ENV{ 'BP_TMP' } || Maasha::Common::error( 'No BP_TMP variable in environment.' );
 775
 776     $curr_pid = Maasha::Common::get_processid();
 777
 778     @dirs = Maasha::Filesys::ls_dirs( $tmpdir );
 779
 780     foreach $dir ( @dirs )
 781     {
 782         if ( $dir =~ /^$tmpdir\/(.+)_(\d+)_(\d+)_bp_tmp$/ )
 783         {
 784             $user = $1;
 785             $sid  = $2;
 786             $pid  = $3;
 787
 788 #            next if $user eq "maasha"; # DEBUG
 789
 790             if ( $user eq Maasha::Common::get_user() )
 791             {
 792                 if ( not Maasha::Common::process_running( $pid ) )
 793                 {
 794                     # print STDERR "Removing stale dir: $dir\n";
 795                     Maasha::Filesys::dir_remove( $dir );
 796                 }
 797                 elsif ( $pid == $curr_pid )
 798                 {
 799                     # print STDERR "Removing current dir: $dir\n";
 800                     Maasha::Filesys::dir_remove( $dir );
 801                 }
 802             }
 803         }
 804     }
 805 }
 806
 807
 808 sub run_time
 809 {
 810     # Martin A. Hansen, May 2009.
 811
 812     # Returns a precision timestamp for calculating
 813     # run time.
 814
 815     return Maasha::Common::get_time_hires();
 816 }
 817
 818
 819 sub run_time_print
 820 {
 821     # Martin A. Hansen, May 2009
 822
 823     # Print the run time to STDERR for the current script if
 824     # the verbose switch is set in the option hash.
 825
 826     my ( $t0,       # run time begin
 827          $t1,       # run time end
 828          $options,  # options hash
 829        ) = @_;
 830
 831     # Returns nothing
 832
 833     my $script = Maasha::Common::get_scriptname();
 834
 835     print STDERR "Program: $script" . ( " " x ( 25 - length( $script ) ) ) . sprintf( "Run time: %.4f\n", ( $t1 - $t0 ) ) if $options->{ 'verbose' };
 836
 837 }
 838
 839
 840 sub get_tmpdir
 841 {
 842     # Martin A. Hansen, April 2008.
 843
 844     # Create a temporary directory based on
 845     # $ENV{ 'BP_TMP' } and sessionid. The directory
 846     # name is written to the status file.
 847
 848     # Returns a path.
 849
 850     my ( $user, $sid, $pid, $script, $path, $file, $fh, $line );
 851
 852     Maasha::Common::error( qq(no BP_TMP set in %ENV) ) if not -d $ENV{ 'BP_TMP' };
 853
 854     $user   = Maasha::Common::get_user();
 855     $sid    = Maasha::Common::get_sessionid();
 856     $pid    = Maasha::Common::get_processid();
 857     $script = Maasha::Common::get_scriptname();
 858
 859     $path = "$ENV{ 'BP_TMP' }/" . join( "_", $user, $sid, $pid, "bp_tmp" );
 860     $file = "$ENV{ 'BP_TMP' }/" . join( ".", $user, $script, $pid ) . ".status";
 861
 862     $fh   = Maasha::Filesys::file_read_open( $file );
 863     $line = <$fh>;
 864     chomp $line;
 865     close $fh;
 866
 867     $fh   = Maasha::Filesys::file_write_open( $file );
 868     print $fh "$line;$path\n";
 869     close $fh;
 870
 871     Maasha::Filesys::dir_create( $path );
 872
 873     return $path;
 874 }
 875
 876
 877 END
 878 {
 879     clean_tmp();
 880 }
 881
 882
 883 # >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>><<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
 884
 885
 886 1;
 887
 888 __END__