1 # File/Copy.pm. Written in 1994 by Aaron Sherman <ajs@ajs.com>. This
2 # source code has been placed in the public domain by the author.
3 # Please be kind and preserve the documentation.
5 # Additions copyright 1996 by Charles Bailey. Permission is granted
6 # to distribute the revised code under the same terms as Perl itself.
15 our(@ISA, @EXPORT, @EXPORT_OK, $VERSION, $Too_Big, $Syscopy_is_copy);
21 # Note that this module implements only *part* of the API defined by
22 # the File/Copy.pm module of the File-Tools-2.0 package. However, that
23 # package has not yet been updated to work with Perl 5.004, and so it
24 # would be a Bad Thing for the CPAN module to grab it and replace this
25 # module. Therefore, we set this module's version higher than 2.0.
30 @EXPORT = qw(copy move);
31 @EXPORT_OK = qw(cp mv);
33 $Too_Big = 1024 * 1024 * 2;
47 $macfiles = eval { require Mac::MoreFiles };
48 warn 'Mac::MoreFiles could not be loaded; using non-native syscopy'
54 if (not defined &basename) {
55 require File::Basename;
56 import File::Basename 'basename';
60 # a partial dir name that's valid only in the cwd (e.g. 'tmp')
61 $to = ':' . $to if $to !~ /:/;
64 return File::Spec->catfile($to, basename($from));
67 # _eq($from, $to) tells whether $from and $to are identical
68 # works for strings and references
70 return $_[0] == $_[1] if ref $_[0] && ref $_[1];
71 return $_[0] eq $_[1] if !ref $_[0] && !ref $_[1];
76 croak("Usage: copy(FROM, TO [, BUFFERSIZE]) ")
77 unless(@_ == 2 || @_ == 3);
82 my $from_a_handle = (ref($from)
83 ? (ref($from) eq 'GLOB'
84 || UNIVERSAL::isa($from, 'GLOB')
85 || UNIVERSAL::isa($from, 'IO::Handle'))
86 : (ref(\$from) eq 'GLOB'));
87 my $to_a_handle = (ref($to)
89 || UNIVERSAL::isa($to, 'GLOB')
90 || UNIVERSAL::isa($to, 'IO::Handle'))
91 : (ref(\$to) eq 'GLOB'));
93 if (_eq($from, $to)) { # works for references, too
94 carp("'$from' and '$to' are identical (not copied)");
95 # The "copy" was a success as the source and destination contain
100 if ((($Config{d_symlink} && $Config{d_readlink}) || $Config{d_link}) &&
101 !($^O eq 'MSWin32' || $^O eq 'os2' || $^O eq 'vms')) {
102 my @fs = stat($from);
105 if (@ts && $fs[0] == $ts[0] && $fs[1] == $ts[1]) {
106 carp("'$from' and '$to' are identical (not copied)");
112 if (!$from_a_handle && !$to_a_handle && -d $to && ! -d $from) {
113 $to = _catname($from, $to);
116 if (defined &syscopy && !$Syscopy_is_copy
118 && !($from_a_handle && $^O eq 'os2' ) # OS/2 cannot handle handles
119 && !($from_a_handle && $^O eq 'mpeix') # and neither can MPE/iX.
120 && !($from_a_handle && $^O eq 'MSWin32')
121 && !($from_a_handle && $^O eq 'MacOS')
122 && !($from_a_handle && $^O eq 'NetWare')
125 return syscopy($from, $to);
130 my ($size, $status, $r, $buf);
134 if ($from_a_handle) {
137 $from = _protect($from) if $from =~ /^\s/s;
138 $from_h = \do { local *FH };
139 open($from_h, "< $from\0") or goto fail_open1;
140 binmode $from_h or die "($!,$^E)";
148 $to = _protect($to) if $to =~ /^\s/s;
149 $to_h = \do { local *FH };
150 open($to_h,"> $to\0") or goto fail_open2;
151 binmode $to_h or die "($!,$^E)";
156 $size = shift(@_) + 0;
157 croak("Bad buffer size for copy: $size\n") unless ($size > 0);
159 $size = tied(*$from_h) ? 0 : -s $from_h || 0;
160 $size = 1024 if ($size < 512);
161 $size = $Too_Big if ($size > $Too_Big);
167 defined($r = sysread($from_h, $buf, $size))
170 for ($w = 0; $w < $r; $w += $t) {
171 $t = syswrite($to_h, $buf, $r - $w, $w)
176 close($to_h) || goto fail_open2 if $closeto;
177 close($from_h) || goto fail_open1 if $closefrom;
179 # Use this idiom to avoid uninitialized value warning.
182 # All of these contortions try to preserve error messages...
188 $! = $status unless $!;
195 $! = $status unless $!;
202 croak("Usage: move(FROM, TO) ") unless @_ == 2;
206 my($fromsz,$tosz1,$tomt1,$tosz2,$tomt2,$sts,$ossts);
208 if (-d $to && ! -d $from) {
209 $to = _catname($from, $to);
212 ($tosz1,$tomt1) = (stat($to))[7,9];
214 if ($^O eq 'os2' and defined $tosz1 and defined $fromsz) {
215 # will not rename with overwrite
218 return 1 if rename $from, $to;
220 # Did rename return an error even though it succeeded, because $to
221 # is on a remote NFS file system, and NFS lost the server's ack?
222 return 1 if defined($fromsz) && !-e $from && # $from disappeared
223 (($tosz2,$tomt2) = (stat($to))[7,9]) && # $to's there
224 ((!defined $tosz1) || # not before or
225 ($tosz1 != $tosz2 or $tomt1 != $tomt2)) && # was changed
226 $tosz2 == $fromsz; # it's all there
228 ($tosz1,$tomt1) = (stat($to))[7,9]; # just in case rename did something
234 copy($from,$to) or die;
235 my($atime, $mtime) = (stat($from))[8,9];
236 utime($atime, $mtime, $to);
237 unlink($from) or die;
241 ($sts,$ossts) = ($! + 0, $^E + 0);
243 ($tosz2,$tomt2) = ((stat($to))[7,9],0,0) if defined $tomt1;
244 unlink($to) if !defined($tomt1) or $tomt1 != $tomt2 or $tosz1 != $tosz2;
245 ($!,$^E) = ($sts,$ossts);
253 if ($^O eq 'MacOS') {
254 *_protect = sub { MacPerl::MakeFSSpec($_[0]) };
256 *_protect = sub { "./$_[0]" };
259 # &syscopy is an XSUB under OS/2
260 unless (defined &syscopy) {
262 *syscopy = \&rmscopy;
263 } elsif ($^O eq 'mpeix') {
265 return 0 unless @_ == 2;
266 # Use the MPE cp program in order to
267 # preserve MPE file attributes.
268 return system('/bin/cp', '-f', $_[0], $_[1]) == 0;
270 } elsif ($^O eq 'MSWin32' && defined &DynaLoader::boot_DynaLoader) {
271 # Win32::CopyFile() fill only work if we can load Win32.xs
273 return 0 unless @_ == 2;
274 return Win32::CopyFile(@_, 1);
276 } elsif ($macfiles) {
281 return 0 unless -e $from;
283 if ($to =~ /(.*:)([^:]+):?$/) {
284 ($dir, $toname) = ($1, $2);
286 ($dir, $toname) = (":", $to);
290 Mac::MoreFiles::FSpFileCopy($from, $dir, $toname, 1);
293 $Syscopy_is_copy = 1;
304 File::Copy - Copy files or filehandles
310 copy("file1","file2") or die "Copy failed: $!";
311 copy("Copy.pm",\*STDOUT);
312 move("/dev1/fileA","/dev2/fileB");
316 $n = FileHandle->new("/a/file","r");
321 The File::Copy module provides two basic functions, C<copy> and
322 C<move>, which are useful for getting the contents of a file from
323 one place to another.
330 The C<copy> function takes two
331 parameters: a file to copy from and a file to copy to. Either
332 argument may be a string, a FileHandle reference or a FileHandle
333 glob. Obviously, if the first argument is a filehandle of some
334 sort, it will be read from, and if it is a file I<name> it will
335 be opened for reading. Likewise, the second argument will be
336 written to (and created if need be). Trying to copy a file on top
337 of itself is a fatal error.
339 B<Note that passing in
340 files as handles instead of names may lead to loss of information
341 on some operating systems; it is recommended that you use file
342 names whenever possible.> Files are opened in binary mode where
343 applicable. To get a consistent behaviour when copying from a
344 filehandle to a file, use C<binmode> on the filehandle.
346 An optional third parameter can be used to specify the buffer
347 size used for copying. This is the number of bytes from the
348 first file, that will be held in memory at any given time, before
349 being written to the second file. The default buffer size depends
350 upon the file, but will generally be the whole file (up to 2MB), or
351 1k for filehandles that do not reference files (eg. sockets).
353 You may use the syntax C<use File::Copy "cp"> to get at the
354 "cp" alias for this function. The syntax is I<exactly> the same.
357 X<move> X<mv> X<rename>
359 The C<move> function also takes two parameters: the current name
360 and the intended name of the file to be moved. If the destination
361 already exists and is a directory, and the source is not a
362 directory, then the source file will be renamed into the directory
363 specified by the destination.
365 If possible, move() will simply rename the file. Otherwise, it copies
366 the file to the new location and deletes the original. If an error occurs
367 during this copy-and-delete process, you may be left with a (possibly partial)
368 copy of the file under the destination name.
370 You may use the "mv" alias for this function in the same way that
371 you may use the "cp" alias for C<copy>.
376 File::Copy also provides the C<syscopy> routine, which copies the
377 file specified in the first parameter to the file specified in the
378 second parameter, preserving OS-specific attributes and file
379 structure. For Unix systems, this is equivalent to the simple
380 C<copy> routine, which doesn't preserve OS-specific attributes. For
381 VMS systems, this calls the C<rmscopy> routine (see below). For OS/2
382 systems, this calls the C<syscopy> XSUB directly. For Win32 systems,
383 this calls C<Win32::CopyFile>.
385 On Mac OS (Classic), C<syscopy> calls C<Mac::MoreFiles::FSpFileCopy>,
388 B<Special behaviour if C<syscopy> is defined (OS/2, VMS and Win32)>:
390 If both arguments to C<copy> are not file handles,
391 then C<copy> will perform a "system copy" of
392 the input file to a new output file, in order to preserve file
393 attributes, indexed file structure, I<etc.> The buffer size
394 parameter is ignored. If either argument to C<copy> is a
395 handle to an opened file, then data is copied using Perl
396 operators, and no effort is made to preserve file attributes
399 The system copy routine may also be called directly under VMS and OS/2
400 as C<File::Copy::syscopy> (or under VMS as C<File::Copy::rmscopy>, which
401 is the routine that does the actual work for syscopy).
403 =item rmscopy($from,$to[,$date_flag])
406 The first and second arguments may be strings, typeglobs, typeglob
407 references, or objects inheriting from IO::Handle;
408 they are used in all cases to obtain the
409 I<filespec> of the input and output files, respectively. The
410 name and type of the input file are used as defaults for the
411 output file, if necessary.
413 A new version of the output file is always created, which
414 inherits the structure and RMS attributes of the input file,
415 except for owner and protections (and possibly timestamps;
416 see below). All data from the input file is copied to the
417 output file; if either of the first two parameters to C<rmscopy>
418 is a file handle, its position is unchanged. (Note that this
419 means a file handle pointing to the output file will be
420 associated with an old version of that file after C<rmscopy>
421 returns, not the newly created version.)
423 The third parameter is an integer flag, which tells C<rmscopy>
424 how to handle timestamps. If it is E<lt> 0, none of the input file's
425 timestamps are propagated to the output file. If it is E<gt> 0, then
426 it is interpreted as a bitmask: if bit 0 (the LSB) is set, then
427 timestamps other than the revision date are propagated; if bit 1
428 is set, the revision date is propagated. If the third parameter
429 to C<rmscopy> is 0, then it behaves much like the DCL COPY command:
430 if the name or type of the output file was explicitly specified,
431 then no timestamps are propagated, but if they were taken implicitly
432 from the input filespec, then all timestamps other than the
433 revision date are propagated. If this parameter is not supplied,
436 Like C<copy>, C<rmscopy> returns 1 on success. If an error occurs,
437 it sets C<$!>, deletes the output file, and returns 0.
443 All functions return 1 on success, 0 on failure.
444 $! will be set if an error was encountered.
452 On Mac OS (Classic), the path separator is ':', not '/', and the
453 current directory is denoted as ':', not '.'. You should be careful
454 about specifying relative pathnames. While a full path always begins
455 with a volume name, a relative pathname should always begin with a
456 ':'. If specifying a volume name only, a trailing ':' is required.
460 copy("file1", "tmp"); # creates the file 'tmp' in the current directory
461 copy("file1", ":tmp:"); # creates :tmp:file1
462 copy("file1", ":tmp"); # same as above
463 copy("file1", "tmp"); # same as above, if 'tmp' is a directory (but don't do
464 # that, since it may cause confusion, see example #1)
465 copy("file1", "tmp:file1"); # error, since 'tmp:' is not a volume
466 copy("file1", ":tmp:file1"); # ok, partial path
467 copy("file1", "DataHD:"); # creates DataHD:file1
469 move("MacintoshHD:fileA", "DataHD:fileB"); # moves (doesn't copy) files from one
476 File::Copy was written by Aaron Sherman I<E<lt>ajs@ajs.comE<gt>> in 1995,
477 and updated by Charles Bailey I<E<lt>bailey@newman.upenn.eduE<gt>> in 1996.