5 Cwd - get pathname of current working directory
13 my $abs_path = abs_path($file);
17 This module provides functions for determining the pathname of the
18 current working directory. It is recommended that getcwd (or another
19 *cwd() function) be used in I<all> code to ensure portability.
21 By default, it exports the functions cwd(), getcwd(), fastcwd(), and
22 fastgetcwd() (and, on Win32, getdcwd()) into the caller's namespace.
25 =head2 getcwd and friends
27 Each of these functions are called without arguments and return the
28 absolute path of the current working directory.
36 Returns the current working directory.
38 Exposes the POSIX function getcwd(3) or re-implements it if it's not
45 The cwd() is the most natural form for the current architecture. For
46 most systems it is identical to `pwd` (but without the trailing line
53 A more dangerous version of getcwd(), but potentially faster.
55 It might conceivably chdir() you out of a directory that it can't
56 chdir() you back into. If fastcwd encounters a problem it will return
57 undef but will probably leave you in a different directory. For a
58 measure of extra security, if everything appears to have worked, the
59 fastcwd() function will check that it leaves you in the same directory
60 that it started in. If it has changed it will C<die> with the message
61 "Unstable directory path, current directory changed
62 unexpectedly". That should never happen.
66 my $cwd = fastgetcwd();
68 The fastgetcwd() function is provided as a synonym for cwd().
73 my $cwd = getdcwd('C:');
75 The getdcwd() function is also provided on Win32 to get the current working
76 directory on the specified drive, since Windows maintains a separate current
77 working directory for each drive. If no drive is specified then the current
80 This function simply calls the Microsoft C library _getdcwd() function.
85 =head2 abs_path and friends
87 These functions are exported only on request. They each take a single
88 argument and return the absolute pathname for it. If no argument is
89 given they'll use the current working directory.
95 my $abs_path = abs_path($file);
97 Uses the same algorithm as getcwd(). Symbolic links and relative-path
98 components ("." and "..") are resolved to return the canonical
99 pathname, just like realpath(3).
103 my $abs_path = realpath($file);
105 A synonym for abs_path().
109 my $abs_path = fast_abs_path($file);
111 A more dangerous, but potentially faster version of abs_path.
117 If you ask to override your chdir() built-in function,
121 then your PWD environment variable will be kept up to date. Note that
122 it will only be kept up to date if all packages which use chdir import
132 Since the path separators are different on some operating systems ('/'
133 on Unix, ':' on MacPerl, etc...) we recommend you use the File::Spec
134 modules wherever portability is a concern.
138 Actually, on Mac OS, the C<getcwd()>, C<fastgetcwd()> and C<fastcwd()>
139 functions are all aliases for the C<cwd()> function, which, on Mac OS,
140 calls `pwd`. Likewise, the C<abs_path()> function is an alias for
147 Originally by the perl5-porters.
149 Maintained by Ken Williams <KWILLIAMS@cpan.org>
153 Copyright (c) 2004 by the Perl 5 Porters. All rights reserved.
155 This program is free software; you can redistribute it and/or modify
156 it under the same terms as Perl itself.
158 Portions of the C code in this library are copyright (c) 1994 by the
159 Regents of the University of California. All rights reserved. The
160 license on this code is compatible with the licensing of the rest of
161 the distribution - please see the source code in F<Cwd.xs> for the
172 use vars qw(@ISA @EXPORT @EXPORT_OK $VERSION);
175 my $xs_version = $VERSION;
178 @ISA = qw/ Exporter /;
179 @EXPORT = qw(cwd getcwd fastcwd fastgetcwd);
180 push @EXPORT, qw(getdcwd) if $^O eq 'MSWin32';
181 @EXPORT_OK = qw(chdir abs_path fast_abs_path realpath fast_realpath);
183 # sys_cwd may keep the builtin command
185 # All the functionality of this module may provided by builtins,
186 # there is no sense to process the rest of the file.
187 # The best choice may be to have this in BEGIN, but how to return from BEGIN?
192 *cwd = defined &sys_cwd ? \&sys_cwd : \&_os2_cwd;
197 *fast_abs_path = \&sys_abspath if defined &sys_abspath;
198 *abs_path = \&fast_abs_path;
199 *realpath = \&fast_abs_path;
200 *fast_realpath = \&fast_abs_path;
205 # Need to look up the feature settings on VMS. The preferred way is to use the
206 # VMS::Feature module, but that may not be available to dual life modules.
211 if (eval { local $SIG{__DIE__}; require VMS::Feature; }) {
212 $use_vms_feature = 1;
217 # Need to look up the UNIX report mode. This may become a dynamic mode
221 if ($use_vms_feature) {
222 $unix_rpt = VMS::Feature::current("filename_unix_report");
224 my $env_unix_rpt = $ENV{'DECC$FILENAME_UNIX_REPORT'} || '';
225 $unix_rpt = $env_unix_rpt =~ /^[ET1]/i;
230 # Need to look up the EFS character set mode. This may become a dynamic
231 # mode in the future.
234 if ($use_vms_feature) {
235 $efs = VMS::Feature::current("efs_charset");
237 my $env_efs = $ENV{'DECC$EFS_CHARSET'} || '';
238 $efs = $env_efs =~ /^[ET1]/i;
244 # If loading the XS stuff doesn't work, we can fall back to pure perl
245 unless (defined &getcwd) {
249 XSLoader::load( __PACKAGE__, $xs_version);
252 push @ISA, 'DynaLoader';
253 __PACKAGE__->bootstrap( $xs_version );
258 # Big nasty table of function aliases
264 getcwd => '_vms_cwd',
265 fastcwd => '_vms_cwd',
266 fastgetcwd => '_vms_cwd',
267 abs_path => '_vms_abs_path',
268 fast_abs_path => '_vms_abs_path',
273 # We assume that &_NT_cwd is defined as an XSUB or in the core.
276 fastcwd => '_NT_cwd',
277 fastgetcwd => '_NT_cwd',
278 abs_path => 'fast_abs_path',
279 realpath => 'fast_abs_path',
285 getcwd => '_dos_cwd',
286 fastgetcwd => '_dos_cwd',
287 fastcwd => '_dos_cwd',
288 abs_path => 'fast_abs_path',
291 # QNX4. QNX6 has a $os of 'nto'.
295 getcwd => '_qnx_cwd',
296 fastgetcwd => '_qnx_cwd',
297 fastcwd => '_qnx_cwd',
298 abs_path => '_qnx_abs_path',
299 fast_abs_path => '_qnx_abs_path',
307 abs_path => 'fast_abs_path',
308 realpath => 'fast_abs_path',
314 getcwd => '_epoc_cwd',
315 fastgetcwd => '_epoc_cwd',
316 fastcwd => '_epoc_cwd',
317 abs_path => 'fast_abs_path',
325 abs_path => 'fast_abs_path',
329 $METHOD_MAP{NT} = $METHOD_MAP{MSWin32};
332 # Find the pwd command in the expected locations. We assume these
333 # are safe. This prevents _backtick_pwd() consulting $ENV{PATH}
334 # so everything works under taint mode.
336 foreach my $try ('/bin/pwd',
338 '/QOpenSys/bin/pwd', # OS/400 PASE.
346 my $found_pwd_cmd = defined($pwd_cmd);
348 # Isn't this wrong? _backtick_pwd() will fail if someone has
349 # pwd in their path but it is not /bin/pwd or /usr/bin/pwd?
350 # See [perl #16774]. --jhi
355 sub _carp { require Carp; Carp::carp(@_) }
356 sub _croak { require Carp; Carp::croak(@_) }
358 # The 'natural and safe form' for UNIX (pwd may be setuid root)
360 # Localize %ENV entries in a way that won't create new hash keys
361 my @localize = grep exists $ENV{$_}, qw(PATH IFS CDPATH ENV BASH_ENV);
362 local @ENV{@localize};
364 my $cwd = `$pwd_cmd`;
365 # Belt-and-suspenders in case someone said "undef $/".
367 # `pwd` may fail e.g. if the disk is full
368 chomp($cwd) if defined $cwd;
372 # Since some ports may predefine cwd internally (e.g., NT)
373 # we take care not to override an existing definition for cwd().
375 unless ($METHOD_MAP{$^O}{cwd} or defined &cwd) {
376 # The pwd command is not available in some chroot(2)'ed environments
377 my $sep = $Config::Config{path_sep} || ':';
378 my $os = $^O; # Protect $^O from tainting
381 # Try again to find a pwd, this time searching the whole PATH.
382 if (defined $ENV{PATH} and $os ne 'MSWin32') { # no pwd on Windows
383 my @candidates = split($sep, $ENV{PATH});
384 while (!$found_pwd_cmd and @candidates) {
385 my $candidate = shift @candidates;
386 $found_pwd_cmd = 1 if -x "$candidate/pwd";
390 # MacOS has some special magic to make `pwd` work.
391 if( $os eq 'MacOS' || $found_pwd_cmd )
393 *cwd = \&_backtick_pwd;
400 if ($^O eq 'cygwin') {
401 # We need to make sure cwd() is called with no args, because it's
402 # got an arg-less prototype and will die if args are present.
404 my $orig_cwd = \&cwd;
405 *cwd = sub { &$orig_cwd() }
409 # set a reasonable (and very safe) default for fastgetcwd, in case it
410 # isn't redefined later (20001212 rspier)
413 # A non-XS version of getcwd() - also used to bootstrap the perl build
414 # process, when miniperl is running and no XS loading happens.
422 # Usage: $cwd = &fastcwd;
424 # This is a faster version of getcwd. It's also more dangerous because
425 # you might chdir out of a directory that you can't chdir back into.
428 my($odev, $oino, $cdev, $cino, $tdev, $tino);
432 my($orig_cdev, $orig_cino) = stat('.');
433 ($cdev, $cino) = ($orig_cdev, $orig_cino);
436 ($odev, $oino) = ($cdev, $cino);
437 CORE::chdir('..') || return undef;
438 ($cdev, $cino) = stat('.');
439 last if $odev == $cdev && $oino == $cino;
440 opendir(DIR, '.') || return undef;
442 $direntry = readdir(DIR);
443 last unless defined $direntry;
444 next if $direntry eq '.';
445 next if $direntry eq '..';
447 ($tdev, $tino) = lstat($direntry);
448 last unless $tdev != $odev || $tino != $oino;
451 return undef unless defined $direntry; # should never happen
452 unshift(@path, $direntry);
454 $path = '/' . join('/', @path);
455 if ($^O eq 'apollo') { $path = "/".$path; }
456 # At this point $path may be tainted (if tainting) and chdir would fail.
457 # Untaint it then check that we landed where we started.
458 $path =~ /^(.*)\z/s # untaint
459 && CORE::chdir($1) or return undef;
460 ($cdev, $cino) = stat('.');
461 die "Unstable directory path, current directory changed unexpectedly"
462 if $cdev != $orig_cdev || $cino != $orig_cino;
465 if (not defined &fastcwd) { *fastcwd = \&fastcwd_ }
468 # Keeps track of current working directory in PWD environment var
476 if ($ENV{'PWD'} and $^O ne 'os2' and $^O ne 'dos' and $^O ne 'MSWin32') {
477 my($dd,$di) = stat('.');
478 my($pd,$pi) = stat($ENV{'PWD'});
479 if (!defined $dd or !defined $pd or $di != $pi or $dd != $pd) {
485 $wd = Win32::GetFullPathName($wd) if $^O eq 'MSWin32';
488 # Strip an automounter prefix (where /tmp_mnt/foo/bar == /foo/bar)
489 if ($^O ne 'MSWin32' and $ENV{'PWD'} =~ m|(/[^/]+(/[^/]+/[^/]+))(.*)|s) {
490 my($pd,$pi) = stat($2);
491 my($dd,$di) = stat($1);
492 if (defined $pd and defined $dd and $di == $pi and $dd == $pd) {
500 my $newdir = @_ ? shift : ''; # allow for no arg (chdir to HOME dir)
501 $newdir =~ s|///*|/|g unless $^O eq 'MSWin32';
502 chdir_init() unless $chdir_init;
504 if ($^O eq 'MSWin32') {
505 # get the full path name *before* the chdir()
506 $newpwd = Win32::GetFullPathName($newdir);
509 return 0 unless CORE::chdir $newdir;
512 return $ENV{'PWD'} = $ENV{'DEFAULT'}
514 elsif ($^O eq 'MacOS') {
515 return $ENV{'PWD'} = cwd();
517 elsif ($^O eq 'MSWin32') {
518 $ENV{'PWD'} = $newpwd;
522 if (ref $newdir eq 'GLOB') { # in case a file/dir handle is passed in
524 } elsif ($newdir =~ m#^/#s) {
525 $ENV{'PWD'} = $newdir;
527 my @curdir = split(m#/#,$ENV{'PWD'});
528 @curdir = ('') unless @curdir;
530 foreach $component (split(m#/#, $newdir)) {
531 next if $component eq '.';
532 pop(@curdir),next if $component eq '..';
533 push(@curdir,$component);
535 $ENV{'PWD'} = join('/',@curdir) || '/';
543 my $start = @_ ? shift : '.';
544 my($dotdots, $cwd, @pst, @cst, $dir, @tst);
546 unless (@cst = stat( $start ))
548 _carp("stat($start): $!");
553 # Make sure we can be invoked on plain files, not just directories.
554 # NOTE that this routine assumes that '/' is the only directory separator.
556 my ($dir, $file) = $start =~ m{^(.*)/(.+)$}
557 or return cwd() . '/' . $start;
559 # Can't use "-l _" here, because the previous stat was a stat(), not an lstat().
561 my $link_target = readlink($start);
562 die "Can't resolve link $start: $!" unless defined $link_target;
565 $link_target = $dir . '/' . $link_target
566 unless File::Spec->file_name_is_absolute($link_target);
568 return abs_path($link_target);
571 return $dir ? abs_path($dir) . "/$file" : "/$file";
581 unless (opendir(PARENT, $dotdots))
583 # probably a permissions issue. Try the native command.
585 return File::Spec->rel2abs( $start, _backtick_pwd() );
587 unless (@cst = stat($dotdots))
589 _carp("stat($dotdots): $!");
593 if ($pst[0] == $cst[0] && $pst[1] == $cst[1])
601 unless (defined ($dir = readdir(PARENT)))
603 _carp("readdir($dotdots): $!");
607 $tst[0] = $pst[0]+1 unless (@tst = lstat("$dotdots/$dir"))
609 while ($dir eq '.' || $dir eq '..' || $tst[0] != $pst[0] ||
612 $cwd = (defined $dir ? "$dir" : "" ) . "/$cwd" ;
614 } while (defined $dir);
615 chop($cwd) unless $cwd eq '/'; # drop the trailing /
622 local $ENV{PWD} = $ENV{PWD} || ''; # Guard against clobberage
625 my $path = @_ ? shift : ($Curdir ||= File::Spec->curdir);
627 # Detaint else we'll explode in taint mode. This is safe because
628 # we're not doing anything dangerous with it.
629 ($path) = $path =~ /(.*)/s;
630 ($cwd) = $cwd =~ /(.*)/s;
633 _croak("$path: No such file or directory");
637 # Make sure we can be invoked on plain files, not just directories.
639 my ($vol, $dir, $file) = File::Spec->splitpath($path);
640 return File::Spec->catfile($cwd, $path) unless length $dir;
643 my $link_target = readlink($path);
644 die "Can't resolve link $path: $!" unless defined $link_target;
646 $link_target = File::Spec->catpath($vol, $dir, $link_target)
647 unless File::Spec->file_name_is_absolute($link_target);
649 return fast_abs_path($link_target);
652 return $dir eq File::Spec->rootdir
653 ? File::Spec->catpath($vol, $dir, $file)
654 : fast_abs_path(File::Spec->catpath($vol, $dir, '')) . '/' . $file;
657 if (!CORE::chdir($path)) {
658 _croak("Cannot chdir to $path: $!");
660 my $realpath = getcwd();
661 if (! ((-d $cwd) && (CORE::chdir($cwd)))) {
662 _croak("Cannot chdir back to $cwd: $!");
667 # added function alias to follow principle of least surprise
668 # based on previous aliasing. --tchrist 27-Jan-00
669 *fast_realpath = \&fast_abs_path;
672 # --- PORTING SECTION ---
674 # VMS: $ENV{'DEFAULT'} points to default directory at all times
675 # 06-Mar-1996 Charles Bailey bailey@newman.upenn.edu
676 # Note: Use of Cwd::chdir() causes the logical name PWD to be defined
677 # in the process logical name table as the default device and directory
678 # seen by Perl. This may not be the same as the default device
679 # and directory seen by DCL after Perl exits, since the effects
680 # the CRTL chdir() function persist only until Perl exits.
683 return $ENV{'DEFAULT'};
687 return $ENV{'DEFAULT'} unless @_;
691 my $unix_rpt = _vms_unix_rpt;
693 if (defined &VMS::Filespec::vmsrealpath) {
697 $path_unix = 1 if ($path =~ m#(?<=\^)/#);
698 $path_unix = 1 if ($path =~ /^\.\.?$/);
699 $path_vms = 1 if ($path =~ m#[\[<\]]#);
700 $path_vms = 1 if ($path =~ /^--?$/);
702 my $unix_mode = $path_unix;
704 # In case of a tie, the Unix report mode decides.
705 if ($path_vms == $path_unix) {
706 $unix_mode = $unix_rpt;
708 $unix_mode = 0 if $path_vms;
714 return VMS::Filespec::unixrealpath($path);
719 my $new_path = VMS::Filespec::vmsrealpath($path);
721 # Perl expects directories to be in directory format
722 $new_path = VMS::Filespec::pathify($new_path) if -d $path;
726 # Fallback to older algorithm if correct ones are not
730 my $link_target = readlink($path);
731 die "Can't resolve link $path: $!" unless defined $link_target;
733 return _vms_abs_path($link_target);
736 # may need to turn foo.dir into [.foo]
737 my $pathified = VMS::Filespec::pathify($path);
738 $path = $pathified if defined $pathified;
740 return VMS::Filespec::rmsexpand($path);
744 $ENV{'PWD'} = `cmd /c cd`;
746 $ENV{'PWD'} =~ s:\\:/:g ;
750 sub _win32_cwd_simple {
753 $ENV{'PWD'} =~ s:\\:/:g ;
758 # Need to avoid taking any sort of reference to the typeglob or the code in
759 # the optree, so that this tests the runtime state of things, as the
760 # ExtUtils::MakeMaker tests for "miniperl" need to be able to fake things at
761 # runtime by deleting the subroutine. *foo{THING} syntax on a symbol table
762 # lookup avoids needing a string eval, which has been reported to cause
763 # problems (for reasons that we haven't been able to get to the bottom of -
764 # rt.cpan.org #56225)
765 if (*{$DynaLoader::{boot_DynaLoader}}{CODE}) {
766 $ENV{'PWD'} = Win32::GetCwd();
769 chomp($ENV{'PWD'} = `cd`);
771 $ENV{'PWD'} =~ s:\\:/:g ;
775 *_NT_cwd = defined &Win32::GetCwd ? \&_win32_cwd : \&_win32_cwd_simple;
778 if (!defined &Dos::GetCwd) {
779 $ENV{'PWD'} = `command /c cd`;
781 $ENV{'PWD'} =~ s:\\:/:g ;
783 $ENV{'PWD'} = Dos::GetCwd();
789 local $ENV{PATH} = '';
790 local $ENV{CDPATH} = '';
791 local $ENV{ENV} = '';
792 $ENV{'PWD'} = `/usr/bin/fullpath -t`;
798 local $ENV{PATH} = '';
799 local $ENV{CDPATH} = '';
800 local $ENV{ENV} = '';
801 my $path = @_ ? shift : '.';
804 defined( open(REALPATH, '-|') || exec '/usr/bin/fullpath', '-t', $path ) or
805 die "Can't open /usr/bin/fullpath: $!";
806 my $realpath = <REALPATH>;
813 $ENV{'PWD'} = EPOC::getcwd();
818 # Now that all the base-level functions are set up, alias the
819 # user-level functions to the right places
821 if (exists $METHOD_MAP{$^O}) {
822 my $map = $METHOD_MAP{$^O};
823 foreach my $name (keys %$map) {
824 local $^W = 0; # assignments trigger 'subroutine redefined' warning
826 *{$name} = \&{$map->{$name}};
830 # In case the XS version doesn't load.
831 *abs_path = \&_perl_abs_path unless defined &abs_path;
832 *getcwd = \&_perl_getcwd unless defined &getcwd;
834 # added function alias for those of us more
835 # used to the libc function. --tchrist 27-Jan-00
836 *realpath = \&abs_path;