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.
16 our(@ISA, @EXPORT, @EXPORT_OK, $VERSION, $Too_Big, $Syscopy_is_copy);
22 # Note that this module implements only *part* of the API defined by
23 # the File/Copy.pm module of the File-Tools-2.0 package. However, that
24 # package has not yet been updated to work with Perl 5.004, and so it
25 # would be a Bad Thing for the CPAN module to grab it and replace this
26 # module. Therefore, we set this module's version higher than 2.0.
31 @EXPORT = qw(copy move);
32 @EXPORT_OK = qw(cp mv);
34 $Too_Big = 1024 * 1024 * 2;
38 if (not defined &basename) {
39 require File::Basename;
40 import File::Basename 'basename';
44 # a partial dir name that's valid only in the cwd (e.g. 'tmp')
45 $to = ':' . $to if $to !~ /:/;
48 return File::Spec->catfile($to, basename($from));
52 croak("Usage: copy(FROM, TO [, BUFFERSIZE]) ")
53 unless(@_ == 2 || @_ == 3);
58 my $from_a_handle = (ref($from)
59 ? (ref($from) eq 'GLOB'
60 || UNIVERSAL::isa($from, 'GLOB')
61 || UNIVERSAL::isa($from, 'IO::Handle'))
62 : (ref(\$from) eq 'GLOB'));
63 my $to_a_handle = (ref($to)
65 || UNIVERSAL::isa($to, 'GLOB')
66 || UNIVERSAL::isa($to, 'IO::Handle'))
67 : (ref(\$to) eq 'GLOB'));
69 if ($from eq $to) { # works for references, too
70 croak("'$from' and '$to' are identical (not copied)");
73 if ($Config{d_symlink} && $Config{d_readlink} &&
74 !($^O eq 'Win32' || $^O eq 'os2' || $^O eq 'vms')) {
75 no warnings 'io'; # don't warn if -l on filehandle
76 if ((-e $from && -l $from) || (-e $to && -l $to)) {
79 if (@fs && @ts && $fs[0] == $ts[0] && $fs[1] == $ts[1]) {
80 croak("'$from' and '$to' are identical (not copied)");
85 if (!$from_a_handle && !$to_a_handle && -d $to && ! -d $from) {
86 $to = _catname($from, $to);
89 if (defined &syscopy && !$Syscopy_is_copy
91 && !($from_a_handle && $^O eq 'os2' ) # OS/2 cannot handle handles
92 && !($from_a_handle && $^O eq 'mpeix') # and neither can MPE/iX.
93 && !($from_a_handle && $^O eq 'MSWin32')
94 && !($from_a_handle && $^O eq 'MacOS')
95 && !($from_a_handle && $^O eq 'NetWare')
98 return syscopy($from, $to);
103 my ($size, $status, $r, $buf);
107 if ($from_a_handle) {
110 $from = _protect($from) if $from =~ /^\s/s;
111 $from_h = \do { local *FH };
112 open($from_h, "< $from\0") or goto fail_open1;
113 binmode $from_h or die "($!,$^E)";
121 $to = _protect($to) if $to =~ /^\s/s;
122 $to_h = \do { local *FH };
123 open($to_h,"> $to\0") or goto fail_open2;
124 binmode $to_h or die "($!,$^E)";
129 $size = shift(@_) + 0;
130 croak("Bad buffer size for copy: $size\n") unless ($size > 0);
132 $size = tied(*$from_h) ? 0 : -s $from_h || 0;
133 $size = 1024 if ($size < 512);
134 $size = $Too_Big if ($size > $Too_Big);
140 defined($r = sysread($from_h, $buf, $size))
143 for ($w = 0; $w < $r; $w += $t) {
144 $t = syswrite($to_h, $buf, $r - $w, $w)
149 close($to_h) || goto fail_open2 if $closeto;
150 close($from_h) || goto fail_open1 if $closefrom;
152 # Use this idiom to avoid uninitialized value warning.
155 # All of these contortions try to preserve error messages...
161 $! = $status unless $!;
168 $! = $status unless $!;
176 my($copied,$fromsz,$tosz1,$tomt1,$tosz2,$tomt2,$sts,$ossts);
178 if (-d $to && ! -d $from) {
179 $to = _catname($from, $to);
182 ($tosz1,$tomt1) = (stat($to))[7,9];
184 if ($^O eq 'os2' and defined $tosz1 and defined $fromsz) {
185 # will not rename with overwrite
188 return 1 if rename $from, $to;
190 ($sts,$ossts) = ($! + 0, $^E + 0);
191 # Did rename return an error even though it succeeded, because $to
192 # is on a remote NFS file system, and NFS lost the server's ack?
193 return 1 if defined($fromsz) && !-e $from && # $from disappeared
194 (($tosz2,$tomt2) = (stat($to))[7,9]) && # $to's there
195 ($tosz1 != $tosz2 or $tomt1 != $tomt2) && # and changed
196 $tosz2 == $fromsz; # it's all there
198 ($tosz1,$tomt1) = (stat($to))[7,9]; # just in case rename did something
199 return 1 if ($copied = copy($from,$to)) && unlink($from);
201 ($tosz2,$tomt2) = ((stat($to))[7,9],0,0) if defined $tomt1;
202 unlink($to) if !defined($tomt1) or $tomt1 != $tomt2 or $tosz1 != $tosz2;
203 ($!,$^E) = ($sts,$ossts);
211 if ($^O eq 'MacOS') {
212 *_protect = sub { MacPerl::MakeFSSpec($_[0]) };
214 *_protect = sub { "./$_[0]" };
217 # &syscopy is an XSUB under OS/2
218 unless (defined &syscopy) {
220 *syscopy = \&rmscopy;
221 } elsif ($^O eq 'mpeix') {
223 return 0 unless @_ == 2;
224 # Use the MPE cp program in order to
225 # preserve MPE file attributes.
226 return system('/bin/cp', '-f', $_[0], $_[1]) == 0;
228 } elsif ($^O eq 'MSWin32') {
230 return 0 unless @_ == 2;
231 return Win32::CopyFile(@_, 1);
233 } elsif ($^O eq 'MacOS') {
234 require Mac::MoreFiles;
239 return 0 unless -e $from;
241 if ($to =~ /(.*:)([^:]+):?$/) {
242 ($dir, $toname) = ($1, $2);
244 ($dir, $toname) = (":", $to);
248 Mac::MoreFiles::FSpFileCopy($from, $dir, $toname, 1);
251 $Syscopy_is_copy = 1;
262 File::Copy - Copy files or filehandles
268 copy("file1","file2");
269 copy("Copy.pm",\*STDOUT);'
270 move("/dev1/fileA","/dev2/fileB");
275 $n = FileHandle->new("/a/file","r");
280 The File::Copy module provides two basic functions, C<copy> and
281 C<move>, which are useful for getting the contents of a file from
282 one place to another.
288 The C<copy> function takes two
289 parameters: a file to copy from and a file to copy to. Either
290 argument may be a string, a FileHandle reference or a FileHandle
291 glob. Obviously, if the first argument is a filehandle of some
292 sort, it will be read from, and if it is a file I<name> it will
293 be opened for reading. Likewise, the second argument will be
294 written to (and created if need be). Trying to copy a file on top
295 of itself is a fatal error.
297 B<Note that passing in
298 files as handles instead of names may lead to loss of information
299 on some operating systems; it is recommended that you use file
300 names whenever possible.> Files are opened in binary mode where
301 applicable. To get a consistent behaviour when copying from a
302 filehandle to a file, use C<binmode> on the filehandle.
304 An optional third parameter can be used to specify the buffer
305 size used for copying. This is the number of bytes from the
306 first file, that wil be held in memory at any given time, before
307 being written to the second file. The default buffer size depends
308 upon the file, but will generally be the whole file (up to 2Mb), or
309 1k for filehandles that do not reference files (eg. sockets).
311 You may use the syntax C<use File::Copy "cp"> to get at the
312 "cp" alias for this function. The syntax is I<exactly> the same.
316 The C<move> function also takes two parameters: the current name
317 and the intended name of the file to be moved. If the destination
318 already exists and is a directory, and the source is not a
319 directory, then the source file will be renamed into the directory
320 specified by the destination.
322 If possible, move() will simply rename the file. Otherwise, it copies
323 the file to the new location and deletes the original. If an error occurs
324 during this copy-and-delete process, you may be left with a (possibly partial)
325 copy of the file under the destination name.
327 You may use the "mv" alias for this function in the same way that
328 you may use the "cp" alias for C<copy>.
332 File::Copy also provides the C<syscopy> routine, which copies the
333 file specified in the first parameter to the file specified in the
334 second parameter, preserving OS-specific attributes and file
335 structure. For Unix systems, this is equivalent to the simple
336 C<copy> routine, which doesn't preserve OS-specific attributes. For
337 VMS systems, this calls the C<rmscopy> routine (see below). For OS/2
338 systems, this calls the C<syscopy> XSUB directly. For Win32 systems,
339 this calls C<Win32::CopyFile>.
341 =head2 Special behaviour if C<syscopy> is defined (OS/2, VMS and Win32)
343 If both arguments to C<copy> are not file handles,
344 then C<copy> will perform a "system copy" of
345 the input file to a new output file, in order to preserve file
346 attributes, indexed file structure, I<etc.> The buffer size
347 parameter is ignored. If either argument to C<copy> is a
348 handle to an opened file, then data is copied using Perl
349 operators, and no effort is made to preserve file attributes
352 The system copy routine may also be called directly under VMS and OS/2
353 as C<File::Copy::syscopy> (or under VMS as C<File::Copy::rmscopy>, which
354 is the routine that does the actual work for syscopy).
358 =item rmscopy($from,$to[,$date_flag])
360 The first and second arguments may be strings, typeglobs, typeglob
361 references, or objects inheriting from IO::Handle;
362 they are used in all cases to obtain the
363 I<filespec> of the input and output files, respectively. The
364 name and type of the input file are used as defaults for the
365 output file, if necessary.
367 A new version of the output file is always created, which
368 inherits the structure and RMS attributes of the input file,
369 except for owner and protections (and possibly timestamps;
370 see below). All data from the input file is copied to the
371 output file; if either of the first two parameters to C<rmscopy>
372 is a file handle, its position is unchanged. (Note that this
373 means a file handle pointing to the output file will be
374 associated with an old version of that file after C<rmscopy>
375 returns, not the newly created version.)
377 The third parameter is an integer flag, which tells C<rmscopy>
378 how to handle timestamps. If it is E<lt> 0, none of the input file's
379 timestamps are propagated to the output file. If it is E<gt> 0, then
380 it is interpreted as a bitmask: if bit 0 (the LSB) is set, then
381 timestamps other than the revision date are propagated; if bit 1
382 is set, the revision date is propagated. If the third parameter
383 to C<rmscopy> is 0, then it behaves much like the DCL COPY command:
384 if the name or type of the output file was explicitly specified,
385 then no timestamps are propagated, but if they were taken implicitly
386 from the input filespec, then all timestamps other than the
387 revision date are propagated. If this parameter is not supplied,
390 Like C<copy>, C<rmscopy> returns 1 on success. If an error occurs,
391 it sets C<$!>, deletes the output file, and returns 0.
397 All functions return 1 on success, 0 on failure.
398 $! will be set if an error was encountered.
406 On Mac OS (Classic), the path separator is ':', not '/', and the
407 current directory is denoted as ':', not '.'. You should be careful
408 about specifying relative pathnames. While a full path always begins
409 with a volume name, a relative pathname should always begin with a
410 ':'. If specifying a volume name only, a trailing ':' is required.
414 copy("file1", "tmp"); # creates the file 'tmp' in the current directory
415 copy("file1", ":tmp:"); # creates :tmp:file1
416 copy("file1", ":tmp"); # same as above
417 copy("file1", "tmp"); # same as above, if 'tmp' is a directory (but don't do
418 # that, since it may cause confusion, see example #1)
419 copy("file1", "tmp:file1"); # error, since 'tmp:' is not a volume
420 copy("file1", ":tmp:file1"); # ok, partial path
421 copy("file1", "DataHD:"); # creates DataHD:file1
423 move("MacintoshHD:fileA", "DataHD:fileB"); # moves (don't copies) files from one
430 File::Copy was written by Aaron Sherman I<E<lt>ajs@ajs.comE<gt>> in 1995,
431 and updated by Charles Bailey I<E<lt>bailey@newman.upenn.eduE<gt>> in 1996.