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
91 my $file = $self->canonpath(pop @_);
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 from
131 the following list or the current directory if none from the list are
137 Since perl 5.8.0, if running under taint mode, and if $ENV{TMPDIR}
138 is tainted, it is not used.
144 return $tmpdir if defined $tmpdir;
149 if (${"\cTAINT"}) { # Check for taint mode on perl >= 5.8.0
150 require Scalar::Util;
151 @dirlist = grep { ! Scalar::Util::tainted($_) } @dirlist;
155 next unless defined && -d && -w _;
159 $tmpdir = $self->curdir unless defined $tmpdir;
160 $tmpdir = defined $tmpdir && $self->canonpath($tmpdir);
165 return $tmpdir if defined $tmpdir;
166 $tmpdir = _tmpdir( $ENV{TMPDIR}, "/tmp" );
171 Returns a string representation of the parent directory. ".." on UNIX.
181 Given a list of file names, strip out those that refer to a parent
182 directory. (Does not strip symlinks, only '.', '..', and equivalents.)
188 return grep(!/^\.{1,2}\Z(?!\n)/s, @_);
193 Returns a true or false value indicating, respectively, that alphabetic
194 is not or is significant when comparing file specifications.
202 =item file_name_is_absolute
204 Takes as argument a path and returns true if it is an absolute path.
206 This does not consult the local filesystem on Unix, Win32, OS/2 or Mac
207 OS (Classic). It does consult the working environment for VMS (see
208 L<File::Spec::VMS/file_name_is_absolute>).
212 sub file_name_is_absolute {
213 my ($self,$file) = @_;
214 return scalar($file =~ m:^/:s);
219 Takes no argument, returns the environment variable PATH as an array.
224 return () unless exists $ENV{PATH};
225 my @path = split(':', $ENV{PATH});
226 foreach (@path) { $_ = '.' if $_ eq '' }
232 join is the same as catfile.
238 return $self->catfile(@_);
243 ($volume,$directories,$file) = File::Spec->splitpath( $path );
244 ($volume,$directories,$file) = File::Spec->splitpath( $path, $no_file );
246 Splits a path into volume, directory, and filename portions. On systems
247 with no concept of volume, returns '' for volume.
249 For systems with no syntax differentiating filenames from directories,
250 assumes that the last file is a path unless $no_file is true or a
251 trailing separator or /. or /.. is present. On Unix this means that $no_file
252 true makes this return ( '', $path, '' ).
254 The directory portion may or may not be returned with a trailing '/'.
256 The results can be passed to L</catpath()> to get back a path equivalent to
257 (usually identical to) the original path.
262 my ($self,$path, $nofile) = @_;
264 my ($volume,$directory,$file) = ('','','');
270 $path =~ m|^ ( (?: .* / (?: \.\.?\Z(?!\n) )? )? ) ([^/]*) |xs;
275 return ($volume,$directory,$file);
281 The opposite of L</catdir()>.
283 @dirs = File::Spec->splitdir( $directories );
285 $directories must be only the directory portion of the path on systems
286 that have the concept of a volume or that have path syntax that differentiates
287 files from directories.
289 Unlike just splitting the directories on the separator, empty
290 directory names (C<''>) can be returned, because these are significant
295 File::Spec->splitdir( "/a/b//c/" );
299 ( '', 'a', 'b', '', 'c', '' )
304 my ($self,$directories) = @_ ;
306 # split() likes to forget about trailing null fields, so here we
307 # check to be sure that there will not be any before handling the
310 if ( $directories !~ m|/\Z(?!\n)| ) {
311 return split( m|/|, $directories );
315 # since there was a trailing separator, add a file name to the end,
316 # then do the split, then replace it with ''.
318 my( @directories )= split( m|/|, "${directories}dummy" ) ;
319 $directories[ $#directories ]= '' ;
320 return @directories ;
327 Takes volume, directory and file portions and returns an entire path. Under
328 Unix, $volume is ignored, and directory and file are catenated. A '/' is
329 inserted if needed (though if the directory portion doesn't start with
330 '/' it is not added). On other OSs, $volume is significant.
335 my ($self,$volume,$directory,$file) = @_;
337 if ( $directory ne '' &&
339 substr( $directory, -1 ) ne '/' &&
340 substr( $file, 0, 1 ) ne '/'
342 $directory .= "/$file" ;
345 $directory .= $file ;
353 Takes a destination path and an optional base path returns a relative path
354 from the base path to the destination path:
356 $rel_path = File::Spec->abs2rel( $path ) ;
357 $rel_path = File::Spec->abs2rel( $path, $base ) ;
359 If $base is not present or '', then L<cwd()|Cwd> is used. If $base is relative,
360 then it is converted to absolute form using L</rel2abs()>. This means that it
361 is taken to be relative to L<cwd()|Cwd>.
363 On systems with the concept of a volume, this assumes that both paths
364 are on the $destination volume, and ignores the $base volume.
366 On systems that have a grammar that indicates filenames, this ignores the
367 $base filename as well. Otherwise all path components are assumed to be
370 If $path is relative, it is converted to absolute form using L</rel2abs()>.
371 This means that it is taken to be relative to L<cwd()|Cwd>.
373 No checks against the filesystem are made. On VMS, there is
374 interaction with the working environment, as logicals and
377 Based on code written by Shigio Yamaguchi.
382 my($self,$path,$base) = @_;
385 if ( ! $self->file_name_is_absolute( $path ) ) {
386 $path = $self->rel2abs( $path ) ;
389 $path = $self->canonpath( $path ) ;
392 # Figure out the effective $base and clean it up.
393 if ( !defined( $base ) || $base eq '' ) {
396 elsif ( ! $self->file_name_is_absolute( $base ) ) {
397 $base = $self->rel2abs( $base ) ;
400 $base = $self->canonpath( $base ) ;
403 # Now, remove all leading components that are the same
404 my @pathchunks = $self->splitdir( $path);
405 my @basechunks = $self->splitdir( $base);
407 while (@pathchunks && @basechunks && $pathchunks[0] eq $basechunks[0]) {
412 $path = CORE::join( '/', @pathchunks );
413 $base = CORE::join( '/', @basechunks );
415 # $base now contains the directories the resulting relative path
416 # must ascend out of before it can descend to $path_directory. So,
417 # replace all names with $parentDir
418 $base =~ s|[^/]+|..|g ;
420 # Glue the two together, using a separator if necessary, and preventing an
422 if ( $path ne '' && $base ne '' ) {
423 $path = "$base/$path" ;
425 $path = "$base$path" ;
428 return $self->canonpath( $path ) ;
433 Converts a relative path to an absolute path.
435 $abs_path = File::Spec->rel2abs( $path ) ;
436 $abs_path = File::Spec->rel2abs( $path, $base ) ;
438 If $base is not present or '', then L<cwd()|Cwd> is used. If $base is relative,
439 then it is converted to absolute form using L</rel2abs()>. This means that it
440 is taken to be relative to L<cwd()|Cwd>.
442 On systems with the concept of a volume, this assumes that both paths
443 are on the $base volume, and ignores the $path volume.
445 On systems that have a grammar that indicates filenames, this ignores the
446 $base filename as well. Otherwise all path components are assumed to be
449 If $path is absolute, it is cleaned up and returned using L</canonpath()>.
451 No checks against the filesystem are made. On VMS, there is
452 interaction with the working environment, as logicals and
455 Based on code written by Shigio Yamaguchi.
460 my ($self,$path,$base ) = @_;
463 if ( ! $self->file_name_is_absolute( $path ) ) {
464 # Figure out the effective $base and clean it up.
465 if ( !defined( $base ) || $base eq '' ) {
468 elsif ( ! $self->file_name_is_absolute( $base ) ) {
469 $base = $self->rel2abs( $base ) ;
472 $base = $self->canonpath( $base ) ;
476 $path = $self->catdir( $base, $path ) ;
479 return $self->canonpath( $path ) ;