Bump versions of non dual-life modules
[p5sagit/p5-mst-13.2.git] / lib / File / Path.pm
index daa2eae..f96dc06 100644 (file)
@@ -33,13 +33,22 @@ to print the name of each directory as it is created
 =item *
 
 the numeric mode to use when creating the directories
-(defaults to 0777)
+(defaults to 0777), to be modified by the current umask.
 
 =back
 
 It returns a list of all directories (including intermediates, determined
 using the Unix '/' separator) created.
 
+If a system error prevents a directory from being created, then the
+C<mkpath> function throws a fatal error with C<Carp::croak>. This error
+can be trapped with an C<eval> block:
+
+  eval { mkpath($dir) };
+  if ($@) {
+    print "Couldn't create $dir: $@";
+  }
+
 Similarly, the C<rmtree> function provides a convenient way to delete a
 subtree from the directory structure, much like the Unix command C<rm -r>.
 C<rmtree> takes three arguments:
@@ -75,14 +84,32 @@ than VMS is settled.  (defaults to FALSE)
 It returns the number of files successfully deleted.  Symlinks are
 simply deleted and not followed.
 
-B<NOTE:> If the third parameter is not TRUE, C<rmtree> is B<unsecure>
-in the face of failure or interruption.  Files and directories which
-were not deleted may be left with permissions reset to allow world
-read and write access.  Note also that the occurrence of errors in
-rmtree can be determined I<only> by trapping diagnostic messages
-using C<$SIG{__WARN__}>; it is not apparent from the return value.
-Therefore, you must be extremely careful about using C<rmtree($foo,$bar,0>
-in situations where security is an issue.
+B<NOTE:> There are race conditions internal to the implementation of
+C<rmtree> making it unsafe to use on directory trees which may be
+altered or moved while C<rmtree> is running, and in particular on any
+directory trees with any path components or subdirectories potentially
+writable by untrusted users.
+
+Additionally, if the third parameter is not TRUE and C<rmtree> is
+interrupted, it may leave files and directories with permissions altered
+to allow deletion (and older versions of this module would even set
+files and directories to world-read/writable!)
+
+Note also that the occurrence of errors in C<rmtree> can be determined I<only>
+by trapping diagnostic messages using C<$SIG{__WARN__}>; it is not apparent
+from the return value.
+
+=head1 DIAGNOSTICS
+
+=over 4
+
+=item *
+
+On Windows, if C<mkpath> gives you the warning: B<No such file or
+directory>, this may mean that you've exceeded your filesystem's
+maximum path length.
+
+=back
 
 =head1 AUTHORS
 
@@ -91,44 +118,49 @@ Charles Bailey <F<bailey@newman.upenn.edu>>
 
 =cut
 
-use 5.005_64;
+use 5.006;
 use Carp;
 use File::Basename ();
 use Exporter ();
 use strict;
+use warnings;
 
-our $VERSION = "1.0403";
+our $VERSION = "1.07";
 our @ISA = qw( Exporter );
 our @EXPORT = qw( mkpath rmtree );
 
 my $Is_VMS = $^O eq 'VMS';
+my $Is_MacOS = $^O eq 'MacOS';
 
 # These OSes complain if you want to remove a file that you have no
 # write permission to:
 my $force_writeable = ($^O eq 'os2' || $^O eq 'dos' || $^O eq 'MSWin32' ||
-                      $^O eq 'amigaos' || $^O eq 'MacOS');
+                      $^O eq 'amigaos' || $^O eq 'MacOS' || $^O eq 'epoc');
 
 sub mkpath {
     my($paths, $verbose, $mode) = @_;
     # $paths   -- either a path string or ref to list of paths
     # $verbose -- optional print "mkdir $path" for each directory created
     # $mode    -- optional permissions, defaults to 0777
-    local($")="/";
+    local($")=$Is_MacOS ? ":" : "/";
     $mode = 0777 unless defined($mode);
     $paths = [$paths] unless ref $paths;
     my(@created,$path);
     foreach $path (@$paths) {
        $path .= '/' if $^O eq 'os2' and $path =~ /^\w:\z/s; # feature of CRT 
-       next if -d $path;
        # Logic wants Unix paths, so go with the flow.
-       $path = VMS::Filespec::unixify($path) if $Is_VMS;
-       my $parent = File::Basename::dirname($path);
-       # Allow for creation of new logical filesystems under VMS
-       if (not $Is_VMS or $parent !~ m:/[^/]+/000000/?:) {
-           unless (-d $parent or $path eq $parent) {
-               push(@created,mkpath($parent, $verbose, $mode));
+       if ($Is_VMS) {
+           next if $path eq '/';
+           $path = VMS::Filespec::unixify($path);
+           if ($path =~ m:^(/[^/]+)/?\z:) {
+               $path = $1.'/000000';
            }
        }
+       next if -d $path;
+       my $parent = File::Basename::dirname($path);
+       unless (-d $parent or $path eq $parent) {
+           push(@created,mkpath($parent, $verbose, $mode));
+       }
        print "mkdir $path\n" if $verbose;
        unless (mkdir($path,$mode)) {
            my $e = $!;
@@ -157,20 +189,31 @@ sub rmtree {
 
     my($root);
     foreach $root (@{$roots}) {
-       $root =~ s#/\z##;
+       if ($Is_MacOS) {
+           $root = ":$root" if $root !~ /:/;
+           $root =~ s#([^:])\z#$1:#;
+       } else {
+           $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,
+           # notabene: 0700 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))
+           chmod($rp | 0700, ($Is_VMS ? VMS::Filespec::fileify($root) : $root))
              or carp "Can't make directory $root read+writeable: $!"
                unless $safe;
 
            if (opendir my $d, $root) {
-               @files = readdir $d;
+               no strict 'refs';
+               if (!defined ${"\cTAINT"} or ${"\cTAINT"}) {
+                   # Blindly untaint dir names
+                   @files = map { /^(.*)$/s ; $1 } readdir $d;
+               } else {
+                   @files = readdir $d;
+               }
                closedir $d;
            }
            else {
@@ -182,14 +225,18 @@ sub rmtree {
            # 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;
-           @files = map("$root/$_", grep $_!~/^\.{1,2}\z/s,@files);
+           if ($Is_MacOS) {
+               @files = map("$root$_", @files);
+           } else {
+               @files = map("$root/$_", grep $_!~/^\.{1,2}\z/s,@files);
+           }
            $count += rmtree(\@files,$verbose,$safe);
            if ($safe &&
                ($Is_VMS ? !&VMS::Filespec::candelete($root) : !-w $root)) {
                print "skipped $root\n" if $verbose;
                next;
            }
-           chmod 0777, $root
+           chmod $rp | 0700, $root
              or carp "Can't make directory $root writeable: $!"
                if $force_writeable;
            print "rmdir $root\n" if $verbose;
@@ -211,7 +258,7 @@ sub rmtree {
                print "skipped $root\n" if $verbose;
                next;
            }
-           chmod 0666, $root
+           chmod $rp | 0600, $root
              or carp "Can't make file $root writeable: $!"
                if $force_writeable;
            print "unlink $root\n" if $verbose;