/
IO.pm
1098 lines (906 loc) · 34.1 KB
/
IO.pm
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package Bio::Root::IO;
use strict;
use Symbol;
use IO::Handle;
use Fcntl;
use base qw(Bio::Root::Root);
# ABSTRACT: module providing several methods often needed when dealing with file IO
# AUTHOR: Hilmar Lapp <hlapp@gmx.net>
# OWNER: Hilmar Lapp
# LICENSE: Perl_5
# CONTRIBUTOR: Mark A. Jensen <maj@fortinbras.us>
=head1 SYNOPSIS
# Use stream I/O in your module
$self->{'io'} = Bio::Root::IO->new(-file => "myfile");
$self->{'io'}->_print("some stuff");
my $line = $self->{'io'}->_readline();
$self->{'io'}->_pushback($line);
$self->{'io'}->close();
# obtain platform-compatible filenames
$path = Bio::Root::IO->catfile($dir, $subdir, $filename);
# obtain a temporary file (created in $TEMPDIR)
($handle) = $io->tempfile();
=head1 DESCRIPTION
This module provides methods that will usually be needed for any sort
of file- or stream-related input/output, e.g., keeping track of a file
handle, transient printing and reading from the file handle, a close
method, automatically closing the handle on garbage collection, etc.
To use this for your own code you will either want to inherit from
this module, or instantiate an object for every file or stream you are
dealing with. In the first case this module will most likely not be
the first class off which your class inherits; therefore you need to
call _initialize_io() with the named parameters in order to set file
handle, open file, etc automatically.
Most methods start with an underscore, indicating they are private. In
OO speak, they are not private but protected, that is, use them in
your module code, but a client code of your module will usually not
want to call them (except those not starting with an underscore).
In addition this module contains a couple of convenience methods for
cross-platform safe tempfile creation and similar tasks. There are
some CPAN modules related that may not be available on all
platforms. At present, File::Spec and File::Temp are attempted. This
module defines $PATHSEP, $TEMPDIR, and $ROOTDIR, which will always be set,
and $OPENFLAGS, which will be set if either of File::Spec or File::Temp fails.
The -noclose boolean (accessed via the noclose method) prevents a
filehandle from being closed when the IO object is cleaned up. This
is special behavior when a object like a parser might share a
filehandle with an object like an indexer where it is not proper to
close the filehandle as it will continue to be reused until the end of the
stream is reached. In general you won't want to play with this flag.
=cut
our ($FILESPECLOADED, $FILETEMPLOADED,
$FILEPATHLOADED, $TEMPDIR,
$PATHSEP, $ROOTDIR,
$OPENFLAGS, $VERBOSE,
$ONMAC, $HAS_EOL, );
my $TEMPCOUNTER;
my $HAS_WIN32 = 0;
BEGIN {
$TEMPCOUNTER = 0;
$FILESPECLOADED = 0;
$FILETEMPLOADED = 0;
$FILEPATHLOADED = 0;
$VERBOSE = 0;
# try to load those modules that may cause trouble on some systems
eval {
require File::Path;
$FILEPATHLOADED = 1;
};
if( $@ ) {
print STDERR "Cannot load File::Path: $@" if( $VERBOSE > 0 );
# do nothing
}
# If on Win32, attempt to find Win32 package
if($^O =~ /mswin/i) {
eval {
require Win32;
$HAS_WIN32 = 1;
};
}
# Try to provide a path separator. Why doesn't File::Spec export this,
# or did I miss it?
if ($^O =~ /mswin/i) {
$PATHSEP = "\\";
} elsif($^O =~ /macos/i) {
$PATHSEP = ":";
} else { # unix
$PATHSEP = "/";
}
eval {
require File::Spec;
$FILESPECLOADED = 1;
$TEMPDIR = File::Spec->tmpdir();
$ROOTDIR = File::Spec->rootdir();
require File::Temp; # tempfile creation
$FILETEMPLOADED = 1;
};
if( $@ ) {
if(! defined($TEMPDIR)) { # File::Spec failed
# determine tempdir
if (defined $ENV{'TEMPDIR'} && -d $ENV{'TEMPDIR'} ) {
$TEMPDIR = $ENV{'TEMPDIR'};
} elsif( defined $ENV{'TMPDIR'} && -d $ENV{'TMPDIR'} ) {
$TEMPDIR = $ENV{'TMPDIR'};
}
if($^O =~ /mswin/i) {
$TEMPDIR = 'C:\TEMP' unless $TEMPDIR;
$ROOTDIR = 'C:';
} elsif($^O =~ /macos/i) {
$TEMPDIR = "" unless $TEMPDIR; # what is a reasonable default on Macs?
$ROOTDIR = ""; # what is reasonable??
} else { # unix
$TEMPDIR = "/tmp" unless $TEMPDIR;
$ROOTDIR = "/";
}
if (!( -d $TEMPDIR && -w $TEMPDIR )) {
$TEMPDIR = '.'; # last resort
}
}
# File::Temp failed (alone, or File::Spec already failed)
# determine open flags for tempfile creation using Fcntl
$OPENFLAGS = O_CREAT | O_EXCL | O_RDWR;
for my $oflag (qw/FOLLOW BINARY LARGEFILE EXLOCK NOINHERIT TEMPORARY/){
my ($bit, $func) = (0, "Fcntl::O_" . $oflag);
no strict 'refs';
$OPENFLAGS |= $bit if eval { $bit = &$func(); 1 };
}
}
$ONMAC = "\015" eq "\n";
}
=head2 new
Title : new
Usage : my $io = Bio::Root::IO->new( -file => 'data.txt' );
Function: Create new class instance. It automatically calls C<_initialize_io>.
Args : Same named parameters as C<_initialize_io>.
Returns : A Bio::Root::IO object
=cut
sub new {
my ($caller, @args) = @_;
my $self = $caller->SUPER::new(@args);
$self->_initialize_io(@args);
return $self;
}
=head2 _initialize_io
Title : _initialize_io
Usage : $io->_initialize_io(@params);
Function: Initializes filehandle and other properties from the parameters.
Args : The following named parameters are currently recognized:
-file name of file to read or write to
-fh file handle to read or write to (mutually exclusive
with -file and -string)
-input name of file, or filehandle (GLOB or IO::Handle object)
to read of write to
-string string to read from (will be converted to filehandle)
-url name of URL to open
-flush boolean flag to autoflush after each write
-noclose boolean flag, when set to true will not close a
filehandle (must explicitly call close($io->_fh)
-retries number of times to try a web fetch before failure
-ua_parms when using -url, hashref of key => value parameters
to pass to LWP::UserAgent->new(). A useful value might
be, for example, {timeout => 60 } (ua defaults to 180s)
Returns : True
=cut
sub _initialize_io {
my($self, @args) = @_;
$self->_register_for_cleanup(\&_io_cleanup);
my ($input, $noclose, $file, $fh, $string, $flush, $url,
$retries, $ua_parms) =
$self->_rearrange([qw(INPUT NOCLOSE FILE FH STRING FLUSH URL RETRIES UA_PARMS)],
@args);
if ($url) {
$retries ||= 5;
require LWP::UserAgent;
my $ua = LWP::UserAgent->new(%$ua_parms);
my $http_result;
my($handle,$tempfile) = $self->tempfile();
CORE::close($handle);
for (my $try = 1 ; $try <= $retries ; $try++) {
$http_result = $ua->get($url, ':content_file' => $tempfile);
$self->warn("[$try/$retries] tried to fetch $url, but server ".
"threw ". $http_result->code . ". retrying...")
if !$http_result->is_success;
last if $http_result->is_success;
}
$self->throw("failed to fetch $url, server threw ".$http_result->code)
if !$http_result->is_success;
$input = $tempfile;
$file = $tempfile;
}
delete $self->{'_readbuffer'};
delete $self->{'_filehandle'};
$self->noclose( $noclose) if defined $noclose;
# determine whether the input is a file(name) or a stream
if ($input) {
if (ref(\$input) eq 'SCALAR') {
# we assume that a scalar is a filename
if($file && ($file ne $input)) {
$self->throw("input file given twice: $file and $input disagree");
}
$file = $input;
} elsif (ref($input) &&
((ref($input) eq 'GLOB') || $input->isa('IO::Handle'))) {
# input is a stream
$fh = $input;
} else {
# let's be strict for now
$self->throw("Unable to determine type of input $input: ".
"not string and not GLOB");
}
}
if (defined($file) && defined($fh)) {
$self->throw("Providing both a file and a filehandle for reading - ".
"only one please!");
}
if ($string) {
if(defined($file) || defined($fh)) {
$self->throw("File or filehandle provided with -string, ".
"please unset if you are using -string as a file");
}
open $fh, '<', \$string or $self->throw("Could not read string: $!");
}
if (defined($file) && ($file ne '')) {
$fh = Symbol::gensym();
open $fh, $file or $self->throw("Could not open file $file: $!");
$self->file($file);
}
if (defined $fh) {
# check filehandle to ensure it's one of:
# a GLOB reference, as in: open(my $fh, "myfile");
# an IO::Handle or IO::String object
# the UNIVERSAL::can added to fix Bug2863
unless ( ( ref $fh && ( ref $fh eq 'GLOB' ) )
|| ( ref $fh && ( UNIVERSAL::can( $fh, 'can' )
&& ( $fh->isa('IO::Handle') || $fh->isa('IO::String') ) ) )
) {
$self->throw("Object $fh does not appear to be a file handle");
}
}
if ($HAS_EOL) {
binmode $fh, ':raw:eol(LF-Native)';
}
$self->_fh($fh) if $fh; # if not provided, defaults to STDIN and STDOUT
$self->_flush_on_write(defined $flush ? $flush : 1);
return 1;
}
=head2 _fh
Title : _fh
Usage : $io->_fh($newval);
Function: Get or set the file handle for the stream encapsulated.
Args : Optional filehandle to use
Returns : Filehandle for the stream
=cut
sub _fh {
my ($obj, $value) = @_;
if ( defined $value) {
$obj->{'_filehandle'} = $value;
}
return $obj->{'_filehandle'};
}
=head2 mode
Title : mode
Usage : $io->mode();
$io->mode(-force => 1);
Function: Determine if the object was opened for reading or writing
Args : -force: Boolean. Once mode() has been called, the mode is cached for
further calls to mode(). Use this argument to override this
behavior and re-check the object's mode.
Returns : Mode of the object:
'r' for readable
'w' for writable
'rw' for readable and writable
'?' if mode could not be determined (e.g. for a -url)
=cut
sub mode {
my ($self, %arg) = @_;
# Method 1: IO::Handle::fdopen
# my $iotest = new IO::Handle;
# $iotest->fdopen( dup(fileno($fh)) , 'r' );
# if ($iotest->error == 0) { ... }
# It did not actually seem to work under any platform, since there would no
# error if the filehandle had been opened writable only. It could not be
# hacked around when dealing with unseekable (piped) filehandles.
# Method 2: readline, a.k.a. the <> operator
# no warnings "io";
# my $line = <$fh>;
# if (defined $line) {
# $obj->{'_mode'} = 'r';
# ...
# It did not work well either because <> returns undef, i.e. querying the
# mode() after having read an entire file returned 'w'.
if ( $arg{-force} || not exists $self->{'_mode'} ) {
# Determine stream mode
my $mode;
my $fh = $self->_fh;
if (defined $fh) {
# Determine read/write status of filehandle
no warnings 'io';
if ( defined( read $fh, my $content, 0 ) ) {
# Successfully read 0 bytes
$mode = 'r'
}
if ( defined( syswrite $fh, '') ) {
# Successfully wrote 0 bytes
$mode ||= '';
$mode .= 'w';
}
} else {
# Stream does not have a filehandle... cannot determine mode
$mode = '?';
}
# Save mode for future use
$self->{'_mode'} = $mode;
}
return $self->{'_mode'};
}
=head2 file
Title : file
Usage : $io->file($newval)
Function: Get or set the name of the file to read or write.
Args : Optional file name
Returns : File name
=cut
sub file {
my ($obj, $value) = @_;
if ( defined $value) {
$obj->{'_file'} = $value;
}
return $obj->{'_file'};
}
=head2 format
Title : format
Usage : $io->format($newval)
Function: Get the format of a Bio::Root::IO sequence file or filehandle. Every
object inheriting Bio::Root::IO is guaranteed to have a format.
Args : None
Returns : Format of the file or filehandle, e.g. fasta, fastq, genbank, embl.
=cut
sub format {
my ($self) = @_;
my $format = (split '::', ref($self))[-1];
return $format;
}
=head2 variant
Title : format
Usage : $io->format($newval)
Function: Get the variant of a Bio::Root::IO sequence file or filehandle.
The format variant depends on the specific format used. Note that
not all formats have variants. Also, the Bio::Root::IO-implementing
modules that require access to variants need to define a global hash
that has the allowed variants as its keys.
Args : None
Returns : Variant of the file or filehandle, e.g. sanger, solexa or illumina for
the fastq format, or undef for formats that do not have variants.
=cut
sub variant {
my ($self, $variant) = @_;
if (defined $variant) {
$variant = lc $variant;
my $var_name = '%'.ref($self).'::variant';
my %ok_variants = eval $var_name; # e.g. %Bio::Assembly::IO::ace::variant
if (scalar keys %ok_variants == 0) {
$self->throw('Cannot check for validity of variant because global '.
"variant $var_name is not set or is empty\n");
}
if (not exists $ok_variants{$variant}) {
$self->throw($variant.' is not a valid variant of the '.$self->format.
' format');
}
$self->{variant} = $variant;
}
return $self->{variant};
}
=head2 _print
Title : _print
Usage : $io->_print(@lines)
Function: Print lines of text to the IO stream object.
Args : List of strings to print
Returns : True on success, undef on failure
=cut
sub _print {
my $self = shift;
my $fh = $self->_fh() || \*STDOUT;
my $ret = print $fh @_;
return $ret;
}
=head2 _insert
Title : _insert
Usage : $io->_insert($string,1)
Function: Insert some text in a file at the given line number (1-based).
Args : * string to write in file
* line number to insert the string at
Returns : True
=cut
sub _insert {
my ($self, $string, $line_num) = @_;
# Line number check
if ($line_num < 1) {
$self->throw("Cannot insert text at line $line_num because the minimum".
" line number possible is 1");
}
# File check
my $file = $self->file;
if (not defined $file) {
$self->throw('Cannot insert a line in a IO object initialized with ".
"anything else than a file.');
}
$file =~ s/^\+?[><]?//; # transform '+>output.ace' into 'output.ace'
# Everything that needs to be written is written before we read it
$self->flush;
# Edit the file in place, line by line (no slurping)
{
local @ARGV = ($file); # input file
#local $^I = '~'; # backup file extension, e.g. ~, .bak, .ori
local $^I = ''; # no backup file
while (<>) {
if ($. == $line_num) { # right line for new data
print $string.$_;
} else {
print;
}
}
}
# Line number check (again)
if ( $. > 0 && $line_num > $. ) {
$self->throw("Cannot insert text at line $line_num because there are ".
"only $. lines in file $file");
}
# Re-open the file in append mode to be ready to add text at the end of it
# when the next _print() statement comes
open my $new_fh, ">>$file" or $self->throw("Cannot append to file $file: $!");
$self->_fh($new_fh);
# If file is empty and we're inserting at line 1, simply append text to file
if ( $. == 0 && $line_num == 1 ) {
$self->_print($string);
}
return 1;
}
=head2 _readline
Title : _readline
Usage : local $Bio::Root::IO::HAS_EOL = 1;
my $io = Bio::Root::IO->new(-file => 'data.txt');
my $line = $io->_readline();
$io->close;
Function: Read a line of input and normalize all end of line characters.
End of line characters are typically "\n" on Linux platforms, "\r\n"
on Windows and "\r" on older Mac OS. By default, the _readline()
method uses the value of $/, Perl's input record separator, to
detect the end of each line. This means that you will not get the
expected lines if your input has Mac-formatted end of line characters.
Also, note that the current implementation does not handle pushed
back input correctly unless the pushed back input ends with the
value of $/. For each line parsed, its line ending, e.g. "\r\n" is
converted to "\n", unless you provide the -raw argument.
Altogether it is easier to let the PerlIO::eol module automatically
detect the proper end of line character and normalize it to "\n". Do
so by setting $Bio::Root::IO::HAS_EOL to 1.
Args : -raw : Avoid converting end of line characters to "\n" This option
has no effect when using $Bio::Root::IO::HAS_EOL = 1.
Returns : Line of input, or undef when there is nothing to read anymore
=cut
sub _readline {
my ($self, %param) = @_;
my $fh = $self->_fh or return;
my $line;
# if the buffer been filled by _pushback then return the buffer
# contents, rather than read from the filehandle
if( @{$self->{'_readbuffer'} || [] } ) {
$line = shift @{$self->{'_readbuffer'}};
} else {
$line = <$fh>;
}
if( !$HAS_EOL && !$param{-raw} && (defined $line) ) {
# don't strip line endings if -raw or $HAS_EOL is specified
$line =~ s/\015\012/\012/g; # Change all CR/LF pairs to LF
$line =~ tr/\015/\n/ unless $ONMAC; # Change all single CRs to NEWLINE
}
return $line;
}
=head2 _pushback
Title : _pushback
Usage : $io->_pushback($newvalue)
Function: Puts a line previously read with _readline back into a buffer.
buffer can hold as many lines as system memory permits.
Note that this is only supported for pushing back data ending with
the current, localized value of $/. Using this method to push
modified data back onto the buffer stack is not supported; see bug
843.
Args : newvalue
Returns : True
=cut
# fix for bug 843, this reveals some unsupported behavior
#sub _pushback {
# my ($obj, $value) = @_;
# if (index($value, $/) >= 0) {
# push @{$obj->{'_readbuffer'}}, $value;
# } else {
# $obj->throw("Pushing modifed data back not supported: $value");
# }
#}
sub _pushback {
my ($obj, $value) = @_;
return unless $value;
unshift @{$obj->{'_readbuffer'}}, $value;
return 1;
}
=head2 close
Title : close
Usage : $io->close()
Function: Closes the file handle associated with this IO instance,
excepted if -noclose was specified.
Args : None
Returns : True
=cut
sub close {
my ($self) = @_;
# do not close if we explicitly asked not to
return if $self->noclose;
if( defined( my $fh = $self->{'_filehandle'} )) {
$self->flush;
return if ref $fh eq 'GLOB' && (
\*STDOUT == $fh || \*STDERR == $fh || \*STDIN == $fh
);
# don't close IO::Strings
close $fh unless ref $fh && $fh->isa('IO::String');
}
$self->{'_filehandle'} = undef;
delete $self->{'_readbuffer'};
return 1;
}
=head2 flush
Title : flush
Usage : $io->flush()
Function: Flushes the filehandle
Args : None
Returns : True
=cut
sub flush {
my ($self) = shift;
if( !defined $self->{'_filehandle'} ) {
$self->throw("Attempting to call flush but no filehandle active");
}
if( ref($self->{'_filehandle'}) =~ /GLOB/ ) {
my $oldh = select($self->{'_filehandle'});
$| = 1;
select($oldh);
} else {
$self->{'_filehandle'}->flush();
}
return 1;
}
=head2 noclose
Title : noclose
Usage : $io->noclose($newval)
Function: Get or set the NOCLOSE flag - setting this to true will prevent a
filehandle from being closed when an object is cleaned up or
explicitly closed.
Args : Optional new value (a scalar or undef)
Returns : Value of noclose (a scalar)
=cut
sub noclose {
my $self = shift;
return $self->{'_noclose'} = shift if @_;
return $self->{'_noclose'};
}
=head2 _io_cleanup
=cut
sub _io_cleanup {
my ($self) = @_;
$self->close();
my $v = $self->verbose;
# we are planning to cleanup temp files no matter what
if( exists($self->{'_rootio_tempfiles'}) &&
ref($self->{'_rootio_tempfiles'}) =~ /array/i &&
!$self->save_tempfiles) {
if( $v > 0 ) {
warn( "going to remove files ",
join(",", @{$self->{'_rootio_tempfiles'}}), "\n");
}
unlink (@{$self->{'_rootio_tempfiles'}} );
}
# cleanup if we are not using File::Temp
if( $self->{'_cleanuptempdir'} &&
exists($self->{'_rootio_tempdirs'}) &&
ref($self->{'_rootio_tempdirs'}) =~ /array/i &&
!$self->save_tempfiles) {
if( $v > 0 ) {
warn( "going to remove dirs ",
join(",", @{$self->{'_rootio_tempdirs'}}), "\n");
}
$self->rmtree( $self->{'_rootio_tempdirs'});
}
}
=head2 exists_exe
Title : exists_exe
Usage : $exists = $io->exists_exe('clustalw');
$exists = Bio::Root::IO->exists_exe('clustalw')
$exists = Bio::Root::IO::exists_exe('clustalw')
Function: Determines whether the given executable exists either as file
or within the path environment. The latter requires File::Spec
to be installed.
On Win32-based system, .exe is automatically appended to the program
name unless the program name already ends in .exe.
Args : Name of the executable
Returns : 1 if the given program is callable as an executable, and 0 otherwise
=cut
sub exists_exe {
my ($self, $exe) = @_;
$self->throw("Must pass a defined value to exists_exe") unless defined $exe;
$exe = $self if (!(ref($self) || $exe));
$exe .= '.exe' if(($^O =~ /mswin/i) && ($exe !~ /\.(exe|com|bat|cmd)$/i));
return $exe if ( -f $exe && -x $exe ); # full path and exists
# Ewan's comment. I don't think we need this. People should not be
# asking for a program with a pathseparator starting it
# $exe =~ s/^$PATHSEP//;
# Not a full path, or does not exist. Let's see whether it's in the path.
if($FILESPECLOADED) {
for my $dir (File::Spec->path()) {
my $f = Bio::Root::IO->catfile($dir, $exe);
return $f if( -f $f && -x $f );
}
}
return 0;
}
=head2 tempfile
Title : tempfile
Usage : my ($handle,$tempfile) = $io->tempfile();
Function: Create a temporary filename and a handle opened for reading and
writing.
Caveats: If you do not have File::Temp on your system you should
avoid specifying TEMPLATE and SUFFIX.
Args : Named parameters compatible with File::Temp: DIR (defaults to
$Bio::Root::IO::TEMPDIR), TEMPLATE, SUFFIX.
Returns : A 2-element array, consisting of temporary handle and temporary
file name.
=cut
sub tempfile {
my ($self, @args) = @_;
my ($tfh, $file);
my %params = @args;
# map between naming with and without dash
for my $key (keys(%params)) {
if( $key =~ /^-/ ) {
my $v = $params{$key};
delete $params{$key};
$params{uc(substr($key,1))} = $v;
} else {
# this is to upper case
my $v = $params{$key};
delete $params{$key};
$params{uc($key)} = $v;
}
}
$params{'DIR'} = $TEMPDIR if(! exists($params{'DIR'}));
unless (exists $params{'UNLINK'} &&
defined $params{'UNLINK'} &&
! $params{'UNLINK'} ) {
$params{'UNLINK'} = 1;
} else {
$params{'UNLINK'} = 0;
}
if($FILETEMPLOADED) {
if(exists($params{'TEMPLATE'})) {
my $template = $params{'TEMPLATE'};
delete $params{'TEMPLATE'};
($tfh, $file) = File::Temp::tempfile($template, %params);
} else {
($tfh, $file) = File::Temp::tempfile(%params);
}
} else {
my $dir = $params{'DIR'};
$file = $self->catfile(
$dir,
(exists($params{'TEMPLATE'}) ?
$params{'TEMPLATE'} :
sprintf( "%s.%s.%s", $ENV{USER} || 'unknown', $$, $TEMPCOUNTER++))
);
# sneakiness for getting around long filenames on Win32?
if( $HAS_WIN32 ) {
$file = Win32::GetShortPathName($file);
}
# Try to make sure this will be marked close-on-exec
# XXX: Win32 doesn't respect this, nor the proper fcntl,
# but may have O_NOINHERIT. This may or may not be in Fcntl.
local $^F = 2;
# Store callers umask
my $umask = umask();
# Set a known umaskr
umask(066);
# Attempt to open the file
if ( sysopen($tfh, $file, $OPENFLAGS, 0600) ) {
# Reset umask
umask($umask);
} else {
$self->throw("Could not open tempfile $file: $!\n");
}
}
if( $params{'UNLINK'} ) {
push @{$self->{'_rootio_tempfiles'}}, $file;
}
return wantarray ? ($tfh,$file) : $tfh;
}
=head2 tempdir
Title : tempdir
Usage : my ($tempdir) = $io->tempdir(CLEANUP=>1);
Function: Creates and returns the name of a new temporary directory.
Note that you should not use this function for obtaining "the"
temp directory. Use $Bio::Root::IO::TEMPDIR for that. Calling this
method will in fact create a new directory.
Args : args - ( key CLEANUP ) indicates whether or not to cleanup
dir on object destruction, other keys as specified by File::Temp
Returns : The name of a new temporary directory.
=cut
sub tempdir {
my ($self, @args) = @_;
if ($FILETEMPLOADED && File::Temp->can('tempdir')) {
return File::Temp::tempdir(@args);
}
# we have to do this ourselves, not good
# we are planning to cleanup temp files no matter what
my %params = @args;
print "cleanup is " . $params{CLEANUP} . "\n";
$self->{'_cleanuptempdir'} = ( defined $params{CLEANUP} &&
$params{CLEANUP} == 1);
my $tdir = $self->catfile($TEMPDIR,
sprintf("dir_%s-%s-%s",
$ENV{USER} || 'unknown', $$,
$TEMPCOUNTER++));
mkdir($tdir, 0755);
push @{$self->{'_rootio_tempdirs'}}, $tdir;
return $tdir;
}
=head2 catfile
Title : catfile
Usage : $path = Bio::Root::IO->catfile(@dirs, $filename);
Function: Constructs a full pathname in a cross-platform safe way.
If File::Spec exists on your system, this routine will merely
delegate to it. Otherwise it tries to make a good guess.
You should use this method whenever you construct a path name
from directory and filename. Otherwise you risk cross-platform
compatibility of your code.
You can call this method both as a class and an instance method.
Args : components of the pathname (directories and filename, NOT an
extension)
Returns : a string
=cut
sub catfile {
my ($self, @args) = @_;
return File::Spec->catfile(@args) if $FILESPECLOADED;
# this is clumsy and not very appealing, but how do we specify the
# root directory?
if($args[0] eq '/') {
$args[0] = $ROOTDIR;
}
return join($PATHSEP, @args);
}
=head2 rmtree
Title : rmtree
Usage : Bio::Root::IO->rmtree($dirname );
Function: Remove a full directory tree
If File::Path exists on your system, this routine will merely
delegate to it. Otherwise it runs a local version of that code.
You should use this method to remove directories which contain
files.
You can call this method both as a class and an instance method.
Args : roots - rootdir to delete or reference to list of dirs
verbose - a boolean value, which if TRUE will cause
C<rmtree> to print a message each time it
examines a file, giving the name of the file, and
indicating whether it's using C<rmdir> or
C<unlink> to remove it, or that it's skipping it.
(defaults to FALSE)
safe - a boolean value, which if TRUE will cause C<rmtree>
to skip any files to which you do not have delete
access (if running under VMS) or write access (if
running under another OS). This will change in the
future when a criterion for 'delete permission'
under OSs other than VMS is settled. (defaults to
FALSE)
Returns : number of files successfully deleted
=cut
# taken straight from File::Path VERSION = "1.0403"
sub rmtree {
my ($self, $roots, $verbose, $safe) = @_;
if ( $FILEPATHLOADED ) {
return File::Path::rmtree ($roots, $verbose, $safe);
}
my $force_writable = ($^O eq 'os2' || $^O eq 'dos' || $^O eq 'MSWin32' ||
$^O eq 'amigaos' || $^O eq 'cygwin');
my $Is_VMS = $^O eq 'VMS';
my @files;
my $count = 0;
$verbose ||= 0;
$safe ||= 0;
if ( defined($roots) && length($roots) ) {
$roots = [$roots] unless ref $roots;
} else {
$self->warn("No root path(s) specified\n");
return 0;
}
my $root;
for $root (@{$roots}) {
$root =~ s#/\z##;
(undef, undef, my $rp) = lstat $root or next;
$rp &= 07777; # don't forget setuid, setgid, sticky bits
if ( -d _ ) {
# notabene: 0777 is for making readable in the first place,
# it's also intended to change it to writable in case we have
# to recurse in which case we are better than rm -rf for
# subtrees with strange permissions
chmod(0777, ($Is_VMS ? VMS::Filespec::fileify($root) : $root))
or $self->warn("Can't make directory $root read+writable: $!")
unless $safe;
if (opendir(DIR, $root) ){
@files = readdir DIR;
closedir DIR;
} else {
$self->warn( "Can't read $root: $!");
@files = ();
}
# Deleting large numbers of files from VMS Files-11 filesystems
# is faster if done in reverse ASCIIbetical order
@files = reverse @files if $Is_VMS;
($root = VMS::Filespec::unixify($root)) =~ s#\.dir\z## if $Is_VMS;