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     # Parses and checks options for Biopieces.
 293
 294     # First the argument list is checked for duplicates and then
 295     # options are parsed from ARGV after which it is checked if
 296     # the Biopieces usage information should be printed. Finally,
 297     # all options from ARGV are checked according to the argument list.
 298
 299     my ( $arg_list,   # data structure with argument description
 300        ) = @_;
 301
 302     # Returns hashref.
 303
 304     my ( $arg, @list, $options );
 305
 306     # ---- Adding the mandatory arguments to the arg_list ----
 307
 308     push @{ $arg_list }, (
 309
 310         { long => 'help',       short => '?', type => 'flag',  mandatory => 'no', default => undef, allowed => undef, disallowed => undef },
 311         { long => 'stream_in',  short => 'I', type => 'file!', mandatory => 'no', default => undef, allowed => undef, disallowed => undef },
 312         { long => 'stream_out', short => 'O', type => 'file',  mandatory => 'no', default => undef, allowed => undef, disallowed => undef },
 313         { long => 'verbose',    short => 'v', type => 'flag',  mandatory => 'no', default => undef, allowed => undef, disallowed => undef },
 314     );
 315
 316     check_duplicates_args( $arg_list );
 317
 318     # ---- Compiling options list ----
 319
 320     foreach $arg ( @{ $arg_list } )
 321     {
 322         if ( $arg->{ 'type' } eq 'flag' ) {
 323             push @list, "$arg->{ 'long' }|$arg->{ 'short' }";
 324         } else {
 325             push @list, "$arg->{ 'long' }|$arg->{ 'short' }=s";
 326         }
 327     }
 328
 329     # ---- Parsing options from @ARGV ----
 330
 331     $options = {};
 332
 333     Getopt::Long::GetOptions( $options, @list );
 334
 335     # print Dumper( $options );
 336
 337     check_print_usage( $options );
 338
 339     # ---- Expanding and checking options ----
 340
 341     foreach $arg ( @{ $arg_list } )
 342     {
 343         check_mandatory(  $arg, $options );
 344         set_default(      $arg, $options );
 345         check_uint(       $arg, $options );
 346         check_int(        $arg, $options );
 347         set_list(         $arg, $options );
 348         check_dir(        $arg, $options );
 349         check_file(       $arg, $options );
 350         set_files(        $arg, $options );
 351         check_files(      $arg, $options );
 352         check_allowed(    $arg, $options );
 353         check_disallowed( $arg, $options );
 354     }
 355
 356     # print Dumper( $options );
 357
 358     # return wantarray ? $options : %{ $options }; # WTF! Someone changed the behaviour of wantarray???
 359
 360     return $options;
 361 }
 362
 363
 364 sub check_duplicates_args
 365 {
 366     # Martin A. Hansen, May 2009
 367
 368     # Check if there are duplicate long or short arguments,
 369     # and raise an error if so.
 370
 371     my ( $arg_list,   # List of argument hashrefs,
 372        ) = @_;
 373
 374     # Returns nothing.
 375
 376     my ( $arg, %check_hash );
 377
 378     foreach $arg ( @{ $arg_list } )
 379     {
 380         Maasha::Common::error( qq(Duplicate long argument: $arg->{ 'long' }) )   if exists $check_hash{ $arg->{ 'long' } };
 381         Maasha::Common::error( qq(Duplicate short argument: $arg->{ 'short' }) ) if exists $check_hash{ $arg->{ 'short' } };
 382
 383         $check_hash{ $arg->{ 'long' } } = 1;
 384         $check_hash{ $arg->{ 'short' } } = 1;
 385     }
 386 }
 387
 388
 389 sub check_print_usage
 390 {
 391     # Martin A. Hansen, May 2009.
 392
 393     # Check if we need to print usage and print usage
 394     # and exit if that is the case.
 395
 396     my ( $options,   # option hash
 397        ) = @_;
 398
 399     # Returns nothing.
 400
 401     my ( $script, $wiki );
 402
 403     $script = Maasha::Common::get_scriptname();
 404
 405     if ( $script ne 'print_wiki' )
 406     {
 407         if ( exists $options->{ 'help' } or -t STDIN )
 408         {
 409             if ( not ( exists $options->{ 'stream_in' } or $options->{ 'data_in' } ) )
 410             {
 411                 if ( scalar keys %{ $options } <= 1 )
 412                 {
 413                     $wiki = $ENV{ 'BP_DIR' } . "/bp_usage/$script.wiki";
 414
 415                     if ( exists $options->{ 'help' } ) {
 416                         `print_wiki --data_in=$wiki --help`;
 417                     } elsif ( $script =~ /^(list_biopieces|list_genomes|biostat)$/ ) {
 418                         return;
 419                     } else {
 420                         `print_wiki --data_in=$wiki`;
 421                     }
 422
 423                     exit;
 424                 }
 425             }
 426         }
 427     }
 428 }
 429
 430
 431 sub check_mandatory
 432 {
 433     # Martin A. Hansen, May 2009.
 434
 435     # Check if mandatory arguments are set and raises an error if not.
 436
 437     my ( $arg,       # hashref
 438          $options,   # options hash
 439        ) = @_;
 440
 441     # Returns nothing.
 442
 443     if ( $arg->{ 'mandatory' } eq 'yes' and not defined $options->{ $arg->{ 'long' } } ) {
 444         Maasha::Common::error( qq(Argument --$arg->{ 'long' } is mandatory) );
 445     }
 446 }
 447
 448
 449 sub set_default
 450 {
 451     # Martin A. Hansen, May 2009.
 452
 453     # Set default values in option hash.
 454
 455     my ( $arg,      # hashref
 456          $options,  # options hash
 457        ) = @_;
 458
 459     # Returns nothing.
 460
 461     if ( not defined $options->{ $arg->{ 'long' } } ) {
 462         $options->{ $arg->{ 'long' } } = $arg->{ 'default' }
 463     }
 464 }
 465
 466
 467 sub check_uint
 468 {
 469     # Martin A. Hansen, May 2009.
 470
 471     # Check if value to argument is an unsigned integer and
 472     # raises an error if not.
 473
 474     my ( $arg,      # hashref
 475          $options,  # options hash
 476        ) = @_;
 477
 478     # Returns nothing.
 479
 480     if ( $arg->{ 'type' } eq 'uint' and defined $options->{ $arg->{ 'long' } } )
 481     {
 482         if ( $options->{ $arg->{ 'long' } } !~ /^\d+$/ ) {
 483             Maasha::Common::error( qq(Argument --$arg->{ 'long' } must be an unsigned integer - not $options->{ $arg->{ 'long' } }) );
 484         }
 485     }
 486 }
 487
 488
 489 sub check_int
 490 {
 491     # Martin A. Hansen, May 2009.
 492
 493     # Check if value to argument is an integer and
 494     # raises an error if not.
 495
 496     my ( $arg,      # hashref
 497          $options,  # options hash
 498        ) = @_;
 499
 500     # Returns nothing.
 501
 502     if ( $arg->{ 'type' } eq 'int' and defined $options{ $arg->{ 'long' } } )
 503     {
 504         if ( $options->{ $arg->{ 'long' } } !~ /^-?\d+$/ ) {
 505             Maasha::Common::error( qq(Argument --$arg->{ 'long' } must be an integer - not $options->{ $arg->{ 'long' } }) );
 506         }
 507     }
 508 }
 509
 510
 511 sub set_list
 512 {
 513     # Martin A. Hansen, May 2009.
 514
 515     # Splits an argument of type 'list' into a list that is put
 516     # in the options hash.
 517
 518     my ( $arg,      # hashref
 519          $options,  # options hash
 520        ) = @_;
 521
 522     # Returns nothing.
 523
 524     if ( $arg->{ 'type' } eq 'list' and defined $options->{ $arg->{ 'long' } } ) {
 525         $options->{ $arg->{ 'long' } } = [ split /,/, $options->{ $arg->{ 'long' } } ];
 526     }
 527 }
 528
 529
 530 sub check_dir
 531 {
 532     # Martin A. Hansen, May 2009.
 533
 534     # Check if an argument of type 'dir!' truly is a directory and
 535     # raises an error if not.
 536
 537     my ( $arg,      # hashref
 538          $options,  # options hash
 539        ) = @_;
 540
 541     # Returns nothing.
 542
 543     if ( $arg->{ 'type' } eq 'dir!' and defined $options->{ $arg->{ 'long' } } )
 544     {
 545         if ( not -d $options->{ $arg->{ 'long' } } ) {
 546             Maasha::Common::error( qq(No such directory: "$options->{ $arg->{ 'long' } }") );
 547         }
 548     }
 549 }
 550
 551
 552 sub check_file
 553 {
 554     # Martin A. Hansen, May 2009.
 555
 556     # Check if an argument of type 'file!' truly is a file and
 557     # raises an error if not.
 558
 559     my ( $arg,      # hashref
 560          $options,  # options hash
 561        ) = @_;
 562
 563     # Returns nothing.
 564
 565     if ( $arg->{ 'type' } eq 'file!' and defined $options->{ $arg->{ 'long' } } )
 566     {
 567         if ( not -f $options->{ $arg->{ 'long' } } ) {
 568             Maasha::Common::error( qq(No such file: "$options->{ $arg->{ 'long' } }") );
 569         }
 570     }
 571 }
 572
 573
 574 sub set_files
 575 {
 576     # Martin A. Hansen, May 2009.
 577
 578     # Split the argument to 'files' into a list that is put on the options hash.
 579
 580     my ( $arg,      # hashref
 581          $options,  # options hash
 582        ) = @_;
 583
 584     # Returns nothing.
 585
 586     if ( $arg->{ 'type' } eq 'files' and defined $options->{ $arg->{ 'long' } } ) {
 587         $options->{ $arg->{ 'long' } } = [ split /,/, $options->{ $arg->{ 'long' } } ];
 588     }
 589 }
 590
 591
 592 sub check_files
 593 {
 594     # Martin A. Hansen, May 2009.
 595
 596     # Split the argument to 'files!' and check if each file do exists before adding
 597     # the file list to the options hash.
 598
 599     my ( $arg,      # hashref
 600          $options,  # options hash
 601        ) = @_;
 602
 603     # Returns nothing.
 604
 605     my ( $elem, @files );
 606
 607     if ( $arg->{ 'type' } eq 'files!' and defined $options->{ $arg->{ 'long' } } )
 608     {
 609         foreach $elem ( split /,/, $options->{ $arg->{ 'long' } } )
 610         {
 611             if ( -f $elem ) {
 612                 push @files, $elem;
 613             } elsif ( $elem =~ /\*/ ) {
 614                 push @files, glob( $elem );
 615             }
 616         }
 617
 618         if ( scalar @files == 0 ) {
 619             Maasha::Common::error( qq(Argument to --$arg->{ 'long' } must be a valid file or fileglob expression - not $options->{ $arg->{ 'long' } }) );
 620         }
 621
 622         $options->{ $arg->{ 'long' } } = [ @files ];
 623     }
 624 }
 625
 626
 627 sub check_allowed
 628 {
 629     # Martin A. Hansen, May 2009.
 630
 631     # Check if all values to all arguement are allowed and raise an
 632     # error if not.
 633
 634     my ( $arg,      # hashref
 635          $options,  # options hash
 636        ) = @_;
 637
 638     # Returns nothing.
 639
 640     my ( $elem );
 641
 642     if ( defined $arg->{ 'allowed' } and defined $options->{ $arg->{ 'long' } } )
 643     {
 644         map { $val_hash{ $_ } = 1 } split /,/, $arg->{ 'allowed' };
 645
 646         if ( $arg->{ 'type' } =~ /^(list|files|files!)$/ )
 647         {
 648             foreach $elem ( @{ $options->{ $arg->{ 'long' } } } )
 649             {
 650                 if ( not exists $val_hash{ $elem } ) {
 651                     Maasha::Common::error( qq(Argument to --$arg->{ 'long' } $elem is not allowed) );
 652                 }
 653             }
 654         }
 655         else
 656         {
 657             if ( not exists $val_hash{ $options->{ $arg->{ 'long' } } } ) {
 658                 Maasha::Common::error( qq(Argument to --$arg->{ 'long' } $options->{ $arg->{ 'long' } } is not allowed) );
 659             }
 660         }
 661     }
 662 }
 663
 664
 665 sub check_disallowed
 666 {
 667     # Martin A. Hansen, May 2009.
 668
 669     # Check if any values to all arguemnts are disallowed and raise an error if so.
 670
 671     my ( $arg,      # hashref
 672          $options,  # options hash
 673        ) = @_;
 674
 675     # Returns nothing.
 676
 677     my ( $val, %val_hash );
 678
 679     if ( defined $arg->{ 'disallowed' } and defined $options->{ $arg->{ 'long' } } )
 680     {
 681         foreach $val ( split /,/, $arg->{ 'disallowed' } )
 682         {
 683             if ( $options->{ $arg->{ 'long' } } eq $val ) {
 684                 Maasha::Common::error( qq(Argument to --$arg->{ 'long' } $val is disallowed) );
 685             }
 686         }
 687     }
 688 }
 689
 690
 691 sub getopt_files
 692 {
 693     # Martin A. Hansen, November 2007.
 694
 695     # Extracts files from an explicit GetOpt::Long argument
 696     # allowing for the use of glob. E.g.
 697     # --data_in=test.fna
 698     # --data_in=test.fna,test2.fna
 699     # --data_in=*.fna
 700     # --data_in=test.fna,/dir/*.fna
 701
 702     my ( $option,   # option from GetOpt::Long
 703        ) = @_;
 704
 705     # Returns a list.
 706
 707     my ( $elem, @files );
 708
 709     foreach $elem ( split ",", $option )
 710     {
 711         if ( -f $elem ) {
 712             push @files, $elem;
 713         } elsif ( $elem =~ /\*/ ) {
 714             push @files, glob( $elem );
 715         }
 716     }
 717
 718     return wantarray ? @files : \@files;
 719 }
 720
 721
 722 sub sig_handler
 723 {
 724     # Martin A. Hansen, April 2008.
 725
 726     # Removes temporary directory and exits gracefully.
 727     # This subroutine is meant to be run always as the last
 728     # thing even if a script is dies or is interrupted
 729     # or killed.
 730
 731     my ( $sig,   # signal from the %SIG
 732        ) = @_;
 733
 734     # print STDERR "signal->$sig<-\n";
 735
 736     my $script = Maasha::Common::get_scriptname();
 737
 738     chomp $sig;
 739
 740     sleep 1;
 741
 742     if ( $sig =~ /MAASHA_ERROR/ )
 743     {
 744         print STDERR "\nProgram '$script' had an error"                     . "  -  Please wait for temporary data to be removed\n";
 745         status_log( "ERROR" );
 746     }
 747     elsif ( $sig eq "INT" )
 748     {
 749         print STDERR "\nProgram '$script' interrupted (ctrl-c was pressed)" . "  -  Please wait for temporary data to be removed\n";
 750         status_log( "INTERUPTED" );
 751     }
 752     elsif ( $sig eq "TERM" )
 753     {
 754         print STDERR "\nProgram '$script' terminated (someone used kill?)"  . "  -  Please wait for temporary data to be removed\n";
 755         status_log( "TERMINATED" );
 756     }
 757     else
 758     {
 759         print STDERR "\nProgram '$script' died->$sig"                       . "  -  Please wait for temporary data to be removed\n";
 760         status_log( "DIED" );
 761     }
 762
 763     clean_tmp();
 764
 765     exit( 0 );
 766 }
 767
 768
 769 sub clean_tmp
 770 {
 771     # Martin A. Hansen, July 2008.
 772
 773     # Cleans out any unused temporary files and directories in BP_TMP.
 774
 775     # Returns nothing.
 776
 777     my ( $tmpdir, @dirs, $curr_pid, $dir, $user, $sid, $pid );
 778
 779     $tmpdir = $ENV{ 'BP_TMP' } || Maasha::Common::error( 'No BP_TMP variable in environment.' );
 780
 781     $curr_pid = Maasha::Common::get_processid();
 782
 783     @dirs = Maasha::Filesys::ls_dirs( $tmpdir );
 784
 785     foreach $dir ( @dirs )
 786     {
 787         if ( $dir =~ /^$tmpdir\/(.+)_(\d+)_(\d+)_bp_tmp$/ )
 788         {
 789             $user = $1;
 790             $sid  = $2;
 791             $pid  = $3;
 792
 793 #            next if $user eq "maasha"; # DEBUG
 794
 795             if ( $user eq Maasha::Common::get_user() )
 796             {
 797                 if ( not Maasha::Common::process_running( $pid ) )
 798                 {
 799                     # print STDERR "Removing stale dir: $dir\n";
 800                     Maasha::Filesys::dir_remove( $dir );
 801                 }
 802                 elsif ( $pid == $curr_pid )
 803                 {
 804                     # print STDERR "Removing current dir: $dir\n";
 805                     Maasha::Filesys::dir_remove( $dir );
 806                 }
 807             }
 808         }
 809     }
 810 }
 811
 812
 813 sub get_tmpdir
 814 {
 815     # Martin A. Hansen, April 2008.
 816
 817     # Create a temporary directory based on
 818     # $ENV{ 'BP_TMP' } and sessionid. The directory
 819     # name is written to the status file.
 820
 821     # Returns a path.
 822
 823     my ( $user, $sid, $pid, $script, $path, $file, $fh, $line );
 824
 825     Maasha::Common::error( qq(no BP_TMP set in %ENV) ) if not -d $ENV{ 'BP_TMP' };
 826
 827     $user   = Maasha::Common::get_user();
 828     $sid    = Maasha::Common::get_sessionid();
 829     $pid    = Maasha::Common::get_processid();
 830     $script = Maasha::Common::get_scriptname();
 831
 832     $path = "$ENV{ 'BP_TMP' }/" . join( "_", $user, $sid, $pid, "bp_tmp" );
 833     $file = "$ENV{ 'BP_TMP' }/" . join( ".", $user, $script, $pid ) . ".status";
 834
 835     $fh   = Maasha::Filesys::file_read_open( $file );
 836     $line = <$fh>;
 837     chomp $line;
 838     close $fh;
 839
 840     $fh   = Maasha::Filesys::file_write_open( $file );
 841     print $fh "$line;$path\n";
 842     close $fh;
 843
 844     Maasha::Filesys::dir_create( $path );
 845
 846     return $path;
 847 }
 848
 849
 850 END
 851 {
 852     clean_tmp();
 853 }
 854
 855
 856 # >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>><<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
 857
 858
 859 1;
 860
 861 __END__