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));
68 croak("Usage: copy(FROM, TO [, BUFFERSIZE]) ")
69 unless(@_ == 2 || @_ == 3);
74 my $from_a_handle = (ref($from)
75 ? (ref($from) eq 'GLOB'
76 || UNIVERSAL::isa($from, 'GLOB')
77 || UNIVERSAL::isa($from, 'IO::Handle'))
78 : (ref(\$from) eq 'GLOB'));
79 my $to_a_handle = (ref($to)
81 || UNIVERSAL::isa($to, 'GLOB')
82 || UNIVERSAL::isa($to, 'IO::Handle'))
83 : (ref(\$to) eq 'GLOB'));
85 if ($from eq $to) { # works for references, too
86 carp("'$from' and '$to' are identical (not copied)");
87 # The "copy" was a success as the source and destination contain
92 if ((($Config{d_symlink} && $Config{d_readlink}) || $Config{d_link}) &&
93 !($^O eq 'MSWin32' || $^O eq 'os2' || $^O eq 'vms')) {
97 if (@ts && $fs[0] == $ts[0] && $fs[1] == $ts[1]) {
98 carp("'$from' and '$to' are identical (not copied)");
104 if (!$from_a_handle && !$to_a_handle && -d $to && ! -d $from) {
105 $to = _catname($from, $to);
108 if (defined &syscopy && !$Syscopy_is_copy
110 && !($from_a_handle && $^O eq 'os2' ) # OS/2 cannot handle handles
111 && !($from_a_handle && $^O eq 'mpeix') # and neither can MPE/iX.
112 && !($from_a_handle && $^O eq 'MSWin32')
113 && !($from_a_handle && $^O eq 'MacOS')
114 && !($from_a_handle && $^O eq 'NetWare')
117 return syscopy($from, $to);
122 my ($size, $status, $r, $buf);
126 if ($from_a_handle) {
129 $from = _protect($from) if $from =~ /^\s/s;
130 $from_h = \do { local *FH };
131 open($from_h, "< $from\0") or goto fail_open1;
132 binmode $from_h or die "($!,$^E)";
140 $to = _protect($to) if $to =~ /^\s/s;
141 $to_h = \do { local *FH };
142 open($to_h,"> $to\0") or goto fail_open2;
143 binmode $to_h or die "($!,$^E)";
148 $size = shift(@_) + 0;
149 croak("Bad buffer size for copy: $size\n") unless ($size > 0);
151 $size = tied(*$from_h) ? 0 : -s $from_h || 0;
152 $size = 1024 if ($size < 512);
153 $size = $Too_Big if ($size > $Too_Big);
159 defined($r = sysread($from_h, $buf, $size))
162 for ($w = 0; $w < $r; $w += $t) {
163 $t = syswrite($to_h, $buf, $r - $w, $w)
168 close($to_h) || goto fail_open2 if $closeto;
169 close($from_h) || goto fail_open1 if $closefrom;
171 # Use this idiom to avoid uninitialized value warning.
174 # All of these contortions try to preserve error messages...
180 $! = $status unless $!;
187 $! = $status unless $!;
194 croak("Usage: move(FROM, TO) ") unless @_ == 2;
198 my($fromsz,$tosz1,$tomt1,$tosz2,$tomt2,$sts,$ossts);
200 if (-d $to && ! -d $from) {
201 $to = _catname($from, $to);
204 ($tosz1,$tomt1) = (stat($to))[7,9];
206 if ($^O eq 'os2' and defined $tosz1 and defined $fromsz) {
207 # will not rename with overwrite
210 return 1 if rename $from, $to;
212 # Did rename return an error even though it succeeded, because $to
213 # is on a remote NFS file system, and NFS lost the server's ack?
214 return 1 if defined($fromsz) && !-e $from && # $from disappeared
215 (($tosz2,$tomt2) = (stat($to))[7,9]) && # $to's there
216 ($tosz1 != $tosz2 or $tomt1 != $tomt2) && # and changed
217 $tosz2 == $fromsz; # it's all there
219 ($tosz1,$tomt1) = (stat($to))[7,9]; # just in case rename did something
225 copy($from,$to) or die;
226 my($atime, $mtime) = (stat($from))[8,9];
227 utime($atime, $mtime, $to);
228 unlink($from) or die;
232 ($sts,$ossts) = ($! + 0, $^E + 0);
234 ($tosz2,$tomt2) = ((stat($to))[7,9],0,0) if defined $tomt1;
235 unlink($to) if !defined($tomt1) or $tomt1 != $tomt2 or $tosz1 != $tosz2;
236 ($!,$^E) = ($sts,$ossts);
244 if ($^O eq 'MacOS') {
245 *_protect = sub { MacPerl::MakeFSSpec($_[0]) };
247 *_protect = sub { "./$_[0]" };
250 # &syscopy is an XSUB under OS/2
251 unless (defined &syscopy) {
253 *syscopy = \&rmscopy;
254 } elsif ($^O eq 'mpeix') {
256 return 0 unless @_ == 2;
257 # Use the MPE cp program in order to
258 # preserve MPE file attributes.
259 return system('/bin/cp', '-f', $_[0], $_[1]) == 0;
261 } elsif ($^O eq 'MSWin32') {
263 return 0 unless @_ == 2;
264 return Win32::CopyFile(@_, 1);
266 } elsif ($macfiles) {
271 return 0 unless -e $from;
273 if ($to =~ /(.*:)([^:]+):?$/) {
274 ($dir, $toname) = ($1, $2);
276 ($dir, $toname) = (":", $to);
280 Mac::MoreFiles::FSpFileCopy($from, $dir, $toname, 1);
283 $Syscopy_is_copy = 1;
294 File::Copy - Copy files or filehandles
300 copy("file1","file2") or die "Copy failed: $!";
301 copy("Copy.pm",\*STDOUT);
302 move("/dev1/fileA","/dev2/fileB");
306 $n = FileHandle->new("/a/file","r");
311 The File::Copy module provides two basic functions, C<copy> and
312 C<move>, which are useful for getting the contents of a file from
313 one place to another.
319 The C<copy> function takes two
320 parameters: a file to copy from and a file to copy to. Either
321 argument may be a string, a FileHandle reference or a FileHandle
322 glob. Obviously, if the first argument is a filehandle of some
323 sort, it will be read from, and if it is a file I<name> it will
324 be opened for reading. Likewise, the second argument will be
325 written to (and created if need be). Trying to copy a file on top
326 of itself is a fatal error.
328 B<Note that passing in
329 files as handles instead of names may lead to loss of information
330 on some operating systems; it is recommended that you use file
331 names whenever possible.> Files are opened in binary mode where
332 applicable. To get a consistent behaviour when copying from a
333 filehandle to a file, use C<binmode> on the filehandle.
335 An optional third parameter can be used to specify the buffer
336 size used for copying. This is the number of bytes from the
337 first file, that wil be held in memory at any given time, before
338 being written to the second file. The default buffer size depends
339 upon the file, but will generally be the whole file (up to 2Mb), or
340 1k for filehandles that do not reference files (eg. sockets).
342 You may use the syntax C<use File::Copy "cp"> to get at the
343 "cp" alias for this function. The syntax is I<exactly> the same.
347 The C<move> function also takes two parameters: the current name
348 and the intended name of the file to be moved. If the destination
349 already exists and is a directory, and the source is not a
350 directory, then the source file will be renamed into the directory
351 specified by the destination.
353 If possible, move() will simply rename the file. Otherwise, it copies
354 the file to the new location and deletes the original. If an error occurs
355 during this copy-and-delete process, you may be left with a (possibly partial)
356 copy of the file under the destination name.
358 You may use the "mv" alias for this function in the same way that
359 you may use the "cp" alias for C<copy>.
363 File::Copy also provides the C<syscopy> routine, which copies the
364 file specified in the first parameter to the file specified in the
365 second parameter, preserving OS-specific attributes and file
366 structure. For Unix systems, this is equivalent to the simple
367 C<copy> routine, which doesn't preserve OS-specific attributes. For
368 VMS systems, this calls the C<rmscopy> routine (see below). For OS/2
369 systems, this calls the C<syscopy> XSUB directly. For Win32 systems,
370 this calls C<Win32::CopyFile>.
372 On Mac OS (Classic), C<syscopy> calls C<Mac::MoreFiles::FSpFileCopy>,
375 =head2 Special behaviour if C<syscopy> is defined (OS/2, VMS and Win32)
377 If both arguments to C<copy> are not file handles,
378 then C<copy> will perform a "system copy" of
379 the input file to a new output file, in order to preserve file
380 attributes, indexed file structure, I<etc.> The buffer size
381 parameter is ignored. If either argument to C<copy> is a
382 handle to an opened file, then data is copied using Perl
383 operators, and no effort is made to preserve file attributes
386 The system copy routine may also be called directly under VMS and OS/2
387 as C<File::Copy::syscopy> (or under VMS as C<File::Copy::rmscopy>, which
388 is the routine that does the actual work for syscopy).
392 =item rmscopy($from,$to[,$date_flag])
394 The first and second arguments may be strings, typeglobs, typeglob
395 references, or objects inheriting from IO::Handle;
396 they are used in all cases to obtain the
397 I<filespec> of the input and output files, respectively. The
398 name and type of the input file are used as defaults for the
399 output file, if necessary.
401 A new version of the output file is always created, which
402 inherits the structure and RMS attributes of the input file,
403 except for owner and protections (and possibly timestamps;
404 see below). All data from the input file is copied to the
405 output file; if either of the first two parameters to C<rmscopy>
406 is a file handle, its position is unchanged. (Note that this
407 means a file handle pointing to the output file will be
408 associated with an old version of that file after C<rmscopy>
409 returns, not the newly created version.)
411 The third parameter is an integer flag, which tells C<rmscopy>
412 how to handle timestamps. If it is E<lt> 0, none of the input file's
413 timestamps are propagated to the output file. If it is E<gt> 0, then
414 it is interpreted as a bitmask: if bit 0 (the LSB) is set, then
415 timestamps other than the revision date are propagated; if bit 1
416 is set, the revision date is propagated. If the third parameter
417 to C<rmscopy> is 0, then it behaves much like the DCL COPY command:
418 if the name or type of the output file was explicitly specified,
419 then no timestamps are propagated, but if they were taken implicitly
420 from the input filespec, then all timestamps other than the
421 revision date are propagated. If this parameter is not supplied,
424 Like C<copy>, C<rmscopy> returns 1 on success. If an error occurs,
425 it sets C<$!>, deletes the output file, and returns 0.
431 All functions return 1 on success, 0 on failure.
432 $! will be set if an error was encountered.
440 On Mac OS (Classic), the path separator is ':', not '/', and the
441 current directory is denoted as ':', not '.'. You should be careful
442 about specifying relative pathnames. While a full path always begins
443 with a volume name, a relative pathname should always begin with a
444 ':'. If specifying a volume name only, a trailing ':' is required.
448 copy("file1", "tmp"); # creates the file 'tmp' in the current directory
449 copy("file1", ":tmp:"); # creates :tmp:file1
450 copy("file1", ":tmp"); # same as above
451 copy("file1", "tmp"); # same as above, if 'tmp' is a directory (but don't do
452 # that, since it may cause confusion, see example #1)
453 copy("file1", "tmp:file1"); # error, since 'tmp:' is not a volume
454 copy("file1", ":tmp:file1"); # ok, partial path
455 copy("file1", "DataHD:"); # creates DataHD:file1
457 move("MacintoshHD:fileA", "DataHD:fileB"); # moves (don't copies) files from one
464 File::Copy was written by Aaron Sherman I<E<lt>ajs@ajs.comE<gt>> in 1995,
465 and updated by Charles Bailey I<E<lt>bailey@newman.upenn.eduE<gt>> in 1996.