This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
RT#123754 Add security note to File::Spec::no_upwards
[perl5.git] / dist / PathTools / lib / File / Spec.pm
1 package File::Spec;
2
3 use strict;
4 use vars qw(@ISA $VERSION);
5
6 $VERSION = '3.67';
7 $VERSION =~ tr/_//d;
8
9 my %module = (MacOS   => 'Mac',
10               MSWin32 => 'Win32',
11               os2     => 'OS2',
12               VMS     => 'VMS',
13               epoc    => 'Epoc',
14               NetWare => 'Win32', # Yes, File::Spec::Win32 works on NetWare.
15               symbian => 'Win32', # Yes, File::Spec::Win32 works on symbian.
16               dos     => 'OS2',   # Yes, File::Spec::OS2 works on DJGPP.
17               cygwin  => 'Cygwin',
18               amigaos => 'AmigaOS');
19
20
21 my $module = $module{$^O} || 'Unix';
22
23 require "File/Spec/$module.pm";
24 @ISA = ("File::Spec::$module");
25
26 1;
27
28 __END__
29
30 =head1 NAME
31
32 File::Spec - portably perform operations on file names
33
34 =head1 SYNOPSIS
35
36         use File::Spec;
37
38         $x=File::Spec->catfile('a', 'b', 'c');
39
40 which returns 'a/b/c' under Unix. Or:
41
42         use File::Spec::Functions;
43
44         $x = catfile('a', 'b', 'c');
45
46 =head1 DESCRIPTION
47
48 This module is designed to support operations commonly performed on file
49 specifications (usually called "file names", but not to be confused with the
50 contents of a file, or Perl's file handles), such as concatenating several
51 directory and file names into a single path, or determining whether a path
52 is rooted. It is based on code directly taken from MakeMaker 5.17, code
53 written by Andreas KE<ouml>nig, Andy Dougherty, Charles Bailey, Ilya
54 Zakharevich, Paul Schinder, and others.
55
56 Since these functions are different for most operating systems, each set of
57 OS specific routines is available in a separate module, including:
58
59         File::Spec::Unix
60         File::Spec::Mac
61         File::Spec::OS2
62         File::Spec::Win32
63         File::Spec::VMS
64
65 The module appropriate for the current OS is automatically loaded by
66 File::Spec. Since some modules (like VMS) make use of facilities available
67 only under that OS, it may not be possible to load all modules under all
68 operating systems.
69
70 Since File::Spec is object oriented, subroutines should not be called directly,
71 as in:
72
73         File::Spec::catfile('a','b');
74
75 but rather as class methods:
76
77         File::Spec->catfile('a','b');
78
79 For simple uses, L<File::Spec::Functions> provides convenient functional
80 forms of these methods.
81
82 =head1 METHODS
83
84 =over 2
85
86 =item canonpath
87 X<canonpath>
88
89 No physical check on the filesystem, but a logical cleanup of a
90 path.
91
92     $cpath = File::Spec->canonpath( $path ) ;
93
94 Note that this does *not* collapse F<x/../y> sections into F<y>.  This
95 is by design.  If F</foo> on your system is a symlink to F</bar/baz>,
96 then F</foo/../quux> is actually F</bar/quux>, not F</quux> as a naive
97 F<../>-removal would give you.  If you want to do this kind of
98 processing, you probably want C<Cwd>'s C<realpath()> function to
99 actually traverse the filesystem cleaning up paths like this.
100
101 =item catdir
102 X<catdir>
103
104 Concatenate two or more directory names to form a complete path ending
105 with a directory. But remove the trailing slash from the resulting
106 string, because it doesn't look good, isn't necessary and confuses
107 OS/2. Of course, if this is the root directory, don't cut off the
108 trailing slash :-)
109
110     $path = File::Spec->catdir( @directories );
111
112 =item catfile
113 X<catfile>
114
115 Concatenate one or more directory names and a filename to form a
116 complete path ending with a filename
117
118     $path = File::Spec->catfile( @directories, $filename );
119
120 =item curdir
121 X<curdir>
122
123 Returns a string representation of the current directory.
124
125     $curdir = File::Spec->curdir();
126
127 =item devnull
128 X<devnull>
129
130 Returns a string representation of the null device.
131
132     $devnull = File::Spec->devnull();
133
134 =item rootdir
135 X<rootdir>
136
137 Returns a string representation of the root directory.
138
139     $rootdir = File::Spec->rootdir();
140
141 =item tmpdir
142 X<tmpdir>
143
144 Returns a string representation of the first writable directory from a
145 list of possible temporary directories.  Returns the current directory
146 if no writable temporary directories are found.  The list of directories
147 checked depends on the platform; e.g. File::Spec::Unix checks C<$ENV{TMPDIR}>
148 (unless taint is on) and F</tmp>.
149
150     $tmpdir = File::Spec->tmpdir();
151
152 =item updir
153 X<updir>
154
155 Returns a string representation of the parent directory.
156
157     $updir = File::Spec->updir();
158
159 =item no_upwards
160
161 Given a list of files in a directory (such as from C<readdir()>),
162 strip out C<'.'> and C<'..'>.
163
164 B<SECURITY NOTE:> This does NOT filter paths containing C<'..'>, like
165 C<'../../../../etc/passwd'>, only literal matches to C<'.'> and C<'..'>.
166
167     @paths = File::Spec->no_upwards( readdir $dirhandle );
168
169 =item case_tolerant
170
171 Returns a true or false value indicating, respectively, that alphabetic
172 case is not or is significant when comparing file specifications.
173 Cygwin and Win32 accept an optional drive argument.
174
175     $is_case_tolerant = File::Spec->case_tolerant();
176
177 =item file_name_is_absolute
178
179 Takes as its argument a path, and returns true if it is an absolute path.
180
181     $is_absolute = File::Spec->file_name_is_absolute( $path );
182
183 This does not consult the local filesystem on Unix, Win32, OS/2, or
184 Mac OS (Classic).  It does consult the working environment for VMS
185 (see L<File::Spec::VMS/file_name_is_absolute>).
186
187 =item path
188 X<path>
189
190 Takes no argument.  Returns the environment variable C<PATH> (or the local
191 platform's equivalent) as a list.
192
193     @PATH = File::Spec->path();
194
195 =item join
196 X<join, path>
197
198 join is the same as catfile.
199
200 =item splitpath
201 X<splitpath> X<split, path>
202
203 Splits a path in to volume, directory, and filename portions. On systems
204 with no concept of volume, returns '' for volume. 
205
206     ($volume,$directories,$file) =
207                        File::Spec->splitpath( $path );
208     ($volume,$directories,$file) =
209                        File::Spec->splitpath( $path, $no_file );
210
211 For systems with no syntax differentiating filenames from directories, 
212 assumes that the last file is a path unless C<$no_file> is true or a
213 trailing separator or F</.> or F</..> is present. On Unix, this means that C<$no_file>
214 true makes this return ( '', $path, '' ).
215
216 The directory portion may or may not be returned with a trailing '/'.
217
218 The results can be passed to L</catpath()> to get back a path equivalent to
219 (usually identical to) the original path.
220
221 =item splitdir
222 X<splitdir> X<split, dir>
223
224 The opposite of L</catdir>.
225
226     @dirs = File::Spec->splitdir( $directories );
227
228 C<$directories> must be only the directory portion of the path on systems 
229 that have the concept of a volume or that have path syntax that differentiates
230 files from directories.
231
232 Unlike just splitting the directories on the separator, empty
233 directory names (C<''>) can be returned, because these are significant
234 on some OSes.
235
236 =item catpath()
237
238 Takes volume, directory and file portions and returns an entire path. Under
239 Unix, C<$volume> is ignored, and directory and file are concatenated.  A '/' is
240 inserted if need be.  On other OSes, C<$volume> is significant.
241
242     $full_path = File::Spec->catpath( $volume, $directory, $file );
243
244 =item abs2rel
245 X<abs2rel> X<absolute, path> X<relative, path>
246
247 Takes a destination path and an optional base path returns a relative path
248 from the base path to the destination path:
249
250     $rel_path = File::Spec->abs2rel( $path ) ;
251     $rel_path = File::Spec->abs2rel( $path, $base ) ;
252
253 If C<$base> is not present or '', then L<Cwd::cwd()|Cwd> is used. If C<$base> is
254 relative, then it is converted to absolute form using
255 L</rel2abs()>. This means that it is taken to be relative to
256 L<Cwd::cwd()|Cwd>.
257
258 On systems with the concept of volume, if C<$path> and C<$base> appear to be
259 on two different volumes, we will not attempt to resolve the two
260 paths, and we will instead simply return C<$path>.  Note that previous
261 versions of this module ignored the volume of C<$base>, which resulted in
262 garbage results part of the time.
263
264 On systems that have a grammar that indicates filenames, this ignores the 
265 C<$base> filename as well. Otherwise all path components are assumed to be
266 directories.
267
268 If C<$path> is relative, it is converted to absolute form using L</rel2abs()>.
269 This means that it is taken to be relative to L<Cwd::cwd()|Cwd>.
270
271 No checks against the filesystem are made.  On VMS, there is
272 interaction with the working environment, as logicals and
273 macros are expanded.
274
275 Based on code written by Shigio Yamaguchi.
276
277 =item rel2abs()
278 X<rel2abs> X<absolute, path> X<relative, path>
279
280 Converts a relative path to an absolute path. 
281
282     $abs_path = File::Spec->rel2abs( $path ) ;
283     $abs_path = File::Spec->rel2abs( $path, $base ) ;
284
285 If C<$base> is not present or '', then L<Cwd::cwd()|Cwd> is used. If C<$base> is relative,
286 then it is converted to absolute form using L</rel2abs()>. This means that it
287 is taken to be relative to L<Cwd::cwd()|Cwd>.
288
289 On systems with the concept of volume, if C<$path> and C<$base> appear to be
290 on two different volumes, we will not attempt to resolve the two
291 paths, and we will instead simply return C<$path>.  Note that previous
292 versions of this module ignored the volume of C<$base>, which resulted in
293 garbage results part of the time.
294
295 On systems that have a grammar that indicates filenames, this ignores the 
296 C<$base> filename as well. Otherwise all path components are assumed to be
297 directories.
298
299 If C<$path> is absolute, it is cleaned up and returned using L</canonpath>.
300
301 No checks against the filesystem are made.  On VMS, there is
302 interaction with the working environment, as logicals and
303 macros are expanded.
304
305 Based on code written by Shigio Yamaguchi.
306
307 =back
308
309 For further information, please see L<File::Spec::Unix>,
310 L<File::Spec::Mac>, L<File::Spec::OS2>, L<File::Spec::Win32>, or
311 L<File::Spec::VMS>.
312
313 =head1 SEE ALSO
314
315 L<File::Spec::Unix>, L<File::Spec::Mac>, L<File::Spec::OS2>,
316 L<File::Spec::Win32>, L<File::Spec::VMS>, L<File::Spec::Functions>,
317 L<ExtUtils::MakeMaker>
318
319 =head1 AUTHOR
320
321 Currently maintained by Ken Williams C<< <KWILLIAMS@cpan.org> >>.
322
323 The vast majority of the code was written by
324 Kenneth Albanowski C<< <kjahds@kjahds.com> >>,
325 Andy Dougherty C<< <doughera@lafayette.edu> >>,
326 Andreas KE<ouml>nig C<< <A.Koenig@franz.ww.TU-Berlin.DE> >>,
327 Tim Bunce C<< <Tim.Bunce@ig.co.uk> >>.
328 VMS support by Charles Bailey C<< <bailey@newman.upenn.edu> >>.
329 OS/2 support by Ilya Zakharevich C<< <ilya@math.ohio-state.edu> >>.
330 Mac support by Paul Schinder C<< <schinder@pobox.com> >>, and
331 Thomas Wegner C<< <wegner_thomas@yahoo.com> >>.
332 abs2rel() and rel2abs() written by Shigio Yamaguchi C<< <shigio@tamacom.com> >>,
333 modified by Barrie Slaymaker C<< <barries@slaysys.com> >>.
334 splitpath(), splitdir(), catpath() and catdir() by Barrie Slaymaker.
335
336 =head1 COPYRIGHT
337
338 Copyright (c) 2004-2013 by the Perl 5 Porters.  All rights reserved.
339
340 This program is free software; you can redistribute it and/or modify
341 it under the same terms as Perl itself.
342
343 =cut