1 package File::Spec::Unix;
12 File::Spec::Unix - File::Spec for Unix, base for other File::Spec modules
16 require File::Spec::Unix; # Done automatically by File::Spec
20 Methods for manipulating file specifications. Other File::Spec
21 modules, such as File::Spec::Mac, inherit from File::Spec::Unix and
22 override specific methods.
30 No physical check on the filesystem, but a logical cleanup of a
31 path. On UNIX eliminates successive slashes and successive "/.".
33 $cpath = File::Spec->canonpath( $path ) ;
38 my ($self,$path) = @_;
40 # Handle POSIX-style node names beginning with double slash (qnx, nto)
41 # Handle network path names beginning with double slash (cygwin)
42 # (POSIX says: "a pathname that begins with two successive slashes
43 # may be interpreted in an implementation-defined manner, although
44 # more than two leading slashes shall be treated as a single slash.")
46 if ( $^O =~ m/^(?:qnx|nto|cygwin)$/ && $path =~ s:^(//[^/]+)(/|\z):/:s ) {
50 # $path =~ s|/+|/|g unless($^O eq 'cygwin');
51 # but that made tests 29, 30, 35, 46, and 213 (as of #13272) to fail
52 # (Mainly because trailing "" directories didn't get stripped).
53 # Why would cygwin avoid collapsing multiple slashes into one? --jhi
54 $path =~ s|/+|/|g; # xx////xx -> xx/xx
55 $path =~ s@(/\.)+(/|\Z(?!\n))@/@g; # xx/././xx -> xx/xx
56 $path =~ s|^(\./)+||s unless $path eq "./"; # ./xx -> xx
57 $path =~ s|^/(\.\./)+|/|s; # /../../xx -> xx
58 $path =~ s|/\Z(?!\n)|| unless $path eq "/"; # xx/ -> xx
64 Concatenate two or more directory names to form a complete path ending
65 with a directory. But remove the trailing slash from the resulting
66 string, because it doesn't look good, isn't necessary and confuses
67 OS2. Of course, if this is the root directory, don't cut off the
76 # append a slash to each argument unless it has one there
77 $_ .= "/" if $_ eq '' || substr($_,-1) ne "/";
79 return $self->canonpath(join('', @args));
84 Concatenate one or more directory names and a filename to form a
85 complete path ending with a filename
92 return $file unless @_;
93 my $dir = $self->catdir(@_);
94 $dir .= "/" unless substr($dir,-1) eq "/";
100 Returns a string representation of the current directory. "." on UNIX.
110 Returns a string representation of the null device. "/dev/null" on UNIX.
120 Returns a string representation of the root directory. "/" on UNIX.
130 Returns a string representation of the first writable directory
131 from the following list or "" if none are writable:
136 Since perl 5.8.0, if running under taint mode, and if $ENV{TMPDIR}
137 is tainted, it is not used.
143 return $tmpdir if defined $tmpdir;
144 my @dirlist = ( "/tmp" );
145 if ( exists $ENV{TMPDIR} )
147 unshift @dirlist, $ENV{TMPDIR};
149 if (${"\cTAINT"}) { # Check for taint mode on perl >= 5.8.0
150 require Scalar::Util;
151 shift @dirlist if Scalar::Util::tainted($ENV{TMPDIR});
155 next unless defined && -d && -w _;
159 $tmpdir = '' unless defined $tmpdir;
165 Returns a string representation of the parent directory. ".." on UNIX.
175 Given a list of file names, strip out those that refer to a parent
176 directory. (Does not strip symlinks, only '.', '..', and equivalents.)
182 return grep(!/^\.{1,2}\Z(?!\n)/s, @_);
187 Returns a true or false value indicating, respectively, that alphabetic
188 is not or is significant when comparing file specifications.
196 =item file_name_is_absolute
198 Takes as argument a path and returns true if it is an absolute path.
200 This does not consult the local filesystem on Unix, Win32, OS/2 or Mac
201 OS (Classic). It does consult the working environment for VMS (see
202 L<File::Spec::VMS/file_name_is_absolute>).
206 sub file_name_is_absolute {
207 my ($self,$file) = @_;
208 return scalar($file =~ m:^/:s);
213 Takes no argument, returns the environment variable PATH as an array.
218 my @path = split(':', $ENV{PATH});
219 foreach (@path) { $_ = '.' if $_ eq '' }
225 join is the same as catfile.
231 return $self->catfile(@_);
236 ($volume,$directories,$file) = File::Spec->splitpath( $path );
237 ($volume,$directories,$file) = File::Spec->splitpath( $path, $no_file );
239 Splits a path in to volume, directory, and filename portions. On systems
240 with no concept of volume, returns undef for volume.
242 For systems with no syntax differentiating filenames from directories,
243 assumes that the last file is a path unless $no_file is true or a
244 trailing separator or /. or /.. is present. On Unix this means that $no_file
245 true makes this return ( '', $path, '' ).
247 The directory portion may or may not be returned with a trailing '/'.
249 The results can be passed to L</catpath()> to get back a path equivalent to
250 (usually identical to) the original path.
255 my ($self,$path, $nofile) = @_;
257 my ($volume,$directory,$file) = ('','','');
263 $path =~ m|^ ( (?: .* / (?: \.\.?\Z(?!\n) )? )? ) ([^/]*) |xs;
268 return ($volume,$directory,$file);
274 The opposite of L</catdir()>.
276 @dirs = File::Spec->splitdir( $directories );
278 $directories must be only the directory portion of the path on systems
279 that have the concept of a volume or that have path syntax that differentiates
280 files from directories.
282 Unlike just splitting the directories on the separator, empty
283 directory names (C<''>) can be returned, because these are significant
288 File::Spec->splitdir( "/a/b//c/" );
292 ( '', 'a', 'b', '', 'c', '' )
297 my ($self,$directories) = @_ ;
299 # split() likes to forget about trailing null fields, so here we
300 # check to be sure that there will not be any before handling the
303 if ( $directories !~ m|/\Z(?!\n)| ) {
304 return split( m|/|, $directories );
308 # since there was a trailing separator, add a file name to the end,
309 # then do the split, then replace it with ''.
311 my( @directories )= split( m|/|, "${directories}dummy" ) ;
312 $directories[ $#directories ]= '' ;
313 return @directories ;
320 Takes volume, directory and file portions and returns an entire path. Under
321 Unix, $volume is ignored, and directory and file are catenated. A '/' is
322 inserted if needed (though if the directory portion doesn't start with
323 '/' it is not added). On other OSs, $volume is significant.
328 my ($self,$volume,$directory,$file) = @_;
330 if ( $directory ne '' &&
332 substr( $directory, -1 ) ne '/' &&
333 substr( $file, 0, 1 ) ne '/'
335 $directory .= "/$file" ;
338 $directory .= $file ;
346 Takes a destination path and an optional base path returns a relative path
347 from the base path to the destination path:
349 $rel_path = File::Spec->abs2rel( $path ) ;
350 $rel_path = File::Spec->abs2rel( $path, $base ) ;
352 If $base is not present or '', then L<cwd()|Cwd> is used. If $base is relative,
353 then it is converted to absolute form using L</rel2abs()>. This means that it
354 is taken to be relative to L<cwd()|Cwd>.
356 On systems with the concept of a volume, this assumes that both paths
357 are on the $destination volume, and ignores the $base volume.
359 On systems that have a grammar that indicates filenames, this ignores the
360 $base filename as well. Otherwise all path components are assumed to be
363 If $path is relative, it is converted to absolute form using L</rel2abs()>.
364 This means that it is taken to be relative to L<cwd()|Cwd>.
366 No checks against the filesystem are made. On VMS, there is
367 interaction with the working environment, as logicals and
370 Based on code written by Shigio Yamaguchi.
375 my($self,$path,$base) = @_;
378 if ( ! $self->file_name_is_absolute( $path ) ) {
379 $path = $self->rel2abs( $path ) ;
382 $path = $self->canonpath( $path ) ;
385 # Figure out the effective $base and clean it up.
386 if ( !defined( $base ) || $base eq '' ) {
389 elsif ( ! $self->file_name_is_absolute( $base ) ) {
390 $base = $self->rel2abs( $base ) ;
393 $base = $self->canonpath( $base ) ;
396 # Now, remove all leading components that are the same
397 my @pathchunks = $self->splitdir( $path);
398 my @basechunks = $self->splitdir( $base);
400 while (@pathchunks && @basechunks && $pathchunks[0] eq $basechunks[0]) {
405 $path = CORE::join( '/', @pathchunks );
406 $base = CORE::join( '/', @basechunks );
408 # $base now contains the directories the resulting relative path
409 # must ascend out of before it can descend to $path_directory. So,
410 # replace all names with $parentDir
411 $base =~ s|[^/]+|..|g ;
413 # Glue the two together, using a separator if necessary, and preventing an
415 if ( $path ne '' && $base ne '' ) {
416 $path = "$base/$path" ;
418 $path = "$base$path" ;
421 return $self->canonpath( $path ) ;
426 Converts a relative path to an absolute path.
428 $abs_path = File::Spec->rel2abs( $path ) ;
429 $abs_path = File::Spec->rel2abs( $path, $base ) ;
431 If $base is not present or '', then L<cwd()|Cwd> is used. If $base is relative,
432 then it is converted to absolute form using L</rel2abs()>. This means that it
433 is taken to be relative to L<cwd()|Cwd>.
435 On systems with the concept of a volume, this assumes that both paths
436 are on the $base volume, and ignores the $path volume.
438 On systems that have a grammar that indicates filenames, this ignores the
439 $base filename as well. Otherwise all path components are assumed to be
442 If $path is absolute, it is cleaned up and returned using L</canonpath()>.
444 No checks against the filesystem are made. On VMS, there is
445 interaction with the working environment, as logicals and
448 Based on code written by Shigio Yamaguchi.
453 my ($self,$path,$base ) = @_;
456 if ( ! $self->file_name_is_absolute( $path ) ) {
457 # Figure out the effective $base and clean it up.
458 if ( !defined( $base ) || $base eq '' ) {
461 elsif ( ! $self->file_name_is_absolute( $base ) ) {
462 $base = $self->rel2abs( $base ) ;
465 $base = $self->canonpath( $base ) ;
469 $path = $self->catdir( $base, $path ) ;
472 return $self->canonpath( $path ) ;