Commit | Line | Data |
---|---|---|
f716a1dd | 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. | |
4 | # | |
71be2cbc | 5 | # Additions copyright 1996 by Charles Bailey. Permission is granted |
6 | # to distribute the revised code under the same terms as Perl itself. | |
f716a1dd | 7 | |
8 | package File::Copy; | |
9 | ||
3b825e41 | 10 | use 5.006; |
71be2cbc | 11 | use strict; |
b395063c | 12 | use warnings; |
6c254d95 | 13 | use File::Spec; |
96a91e01 | 14 | use Config; |
17f410f9 GS |
15 | our(@ISA, @EXPORT, @EXPORT_OK, $VERSION, $Too_Big, $Syscopy_is_copy); |
16 | sub copy; | |
17 | sub syscopy; | |
18 | sub cp; | |
19 | sub mv; | |
71be2cbc | 20 | |
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. | |
98225a64 | 26 | $VERSION = '2.09'; |
f716a1dd | 27 | |
71be2cbc | 28 | require Exporter; |
29 | @ISA = qw(Exporter); | |
30 | @EXPORT = qw(copy move); | |
31 | @EXPORT_OK = qw(cp mv); | |
f716a1dd | 32 | |
441496b2 | 33 | $Too_Big = 1024 * 1024 * 2; |
f716a1dd | 34 | |
8878f897 T |
35 | sub croak { |
36 | require Carp; | |
37 | goto &Carp::croak; | |
38 | } | |
39 | ||
754f2cd0 MS |
40 | sub carp { |
41 | require Carp; | |
42 | goto &Carp::carp; | |
43 | } | |
44 | ||
bcdb689b JH |
45 | my $macfiles; |
46 | if ($^O eq 'MacOS') { | |
47 | $macfiles = eval { require Mac::MoreFiles }; | |
48 | warn 'Mac::MoreFiles could not be loaded; using non-native syscopy' | |
3a2263fe | 49 | if $@ && $^W; |
bcdb689b JH |
50 | } |
51 | ||
6c254d95 | 52 | sub _catname { |
71be2cbc | 53 | my($from, $to) = @_; |
54 | if (not defined &basename) { | |
55 | require File::Basename; | |
56 | import File::Basename 'basename'; | |
57 | } | |
6c254d95 CN |
58 | |
59 | if ($^O eq 'MacOS') { | |
60 | # a partial dir name that's valid only in the cwd (e.g. 'tmp') | |
61 | $to = ':' . $to if $to !~ /:/; | |
62 | } | |
63 | ||
64 | return File::Spec->catfile($to, basename($from)); | |
f716a1dd | 65 | } |
66 | ||
67 | sub copy { | |
71be2cbc | 68 | croak("Usage: copy(FROM, TO [, BUFFERSIZE]) ") |
f716a1dd | 69 | unless(@_ == 2 || @_ == 3); |
70 | ||
71 | my $from = shift; | |
72 | my $to = shift; | |
71be2cbc | 73 | |
74 | my $from_a_handle = (ref($from) | |
75 | ? (ref($from) eq 'GLOB' | |
d704f39a MG |
76 | || UNIVERSAL::isa($from, 'GLOB') |
77 | || UNIVERSAL::isa($from, 'IO::Handle')) | |
71be2cbc | 78 | : (ref(\$from) eq 'GLOB')); |
79 | my $to_a_handle = (ref($to) | |
80 | ? (ref($to) eq 'GLOB' | |
d704f39a MG |
81 | || UNIVERSAL::isa($to, 'GLOB') |
82 | || UNIVERSAL::isa($to, 'IO::Handle')) | |
71be2cbc | 83 | : (ref(\$to) eq 'GLOB')); |
84 | ||
96a91e01 | 85 | if ($from eq $to) { # works for references, too |
754f2cd0 MS |
86 | carp("'$from' and '$to' are identical (not copied)"); |
87 | # The "copy" was a success as the source and destination contain | |
88 | # the same data. | |
89 | return 1; | |
96a91e01 | 90 | } |
91 | ||
ac7b122d | 92 | if ((($Config{d_symlink} && $Config{d_readlink}) || $Config{d_link}) && |
b8ccb221 | 93 | !($^O eq 'MSWin32' || $^O eq 'os2' || $^O eq 'vms')) { |
ac7b122d SR |
94 | my @fs = stat($from); |
95 | if (@fs) { | |
96a91e01 | 96 | my @ts = stat($to); |
ac7b122d | 97 | if (@ts && $fs[0] == $ts[0] && $fs[1] == $ts[1]) { |
754f2cd0 MS |
98 | carp("'$from' and '$to' are identical (not copied)"); |
99 | return 0; | |
96a91e01 | 100 | } |
101 | } | |
102 | } | |
103 | ||
71be2cbc | 104 | if (!$from_a_handle && !$to_a_handle && -d $to && ! -d $from) { |
105 | $to = _catname($from, $to); | |
106 | } | |
107 | ||
1a04d035 | 108 | if (defined &syscopy && !$Syscopy_is_copy |
e6434134 | 109 | && !$to_a_handle |
1d84e8df JH |
110 | && !($from_a_handle && $^O eq 'os2' ) # OS/2 cannot handle handles |
111 | && !($from_a_handle && $^O eq 'mpeix') # and neither can MPE/iX. | |
7509b657 | 112 | && !($from_a_handle && $^O eq 'MSWin32') |
fa648be5 | 113 | && !($from_a_handle && $^O eq 'MacOS') |
2986a63f | 114 | && !($from_a_handle && $^O eq 'NetWare') |
1a04d035 | 115 | ) |
71be2cbc | 116 | { |
117 | return syscopy($from, $to); | |
118 | } | |
119 | ||
120 | my $closefrom = 0; | |
121 | my $closeto = 0; | |
f716a1dd | 122 | my ($size, $status, $r, $buf); |
48a5c399 | 123 | local($\) = ''; |
f716a1dd | 124 | |
23ba2776 | 125 | my $from_h; |
71be2cbc | 126 | if ($from_a_handle) { |
23ba2776 | 127 | $from_h = $from; |
f716a1dd | 128 | } else { |
fa648be5 | 129 | $from = _protect($from) if $from =~ /^\s/s; |
23ba2776 DW |
130 | $from_h = \do { local *FH }; |
131 | open($from_h, "< $from\0") or goto fail_open1; | |
132 | binmode $from_h or die "($!,$^E)"; | |
f716a1dd | 133 | $closefrom = 1; |
1a04d035 A |
134 | } |
135 | ||
23ba2776 | 136 | my $to_h; |
71be2cbc | 137 | if ($to_a_handle) { |
23ba2776 | 138 | $to_h = $to; |
1a04d035 | 139 | } else { |
fa648be5 | 140 | $to = _protect($to) if $to =~ /^\s/s; |
23ba2776 DW |
141 | $to_h = \do { local *FH }; |
142 | open($to_h,"> $to\0") or goto fail_open2; | |
143 | binmode $to_h or die "($!,$^E)"; | |
71be2cbc | 144 | $closeto = 1; |
1a04d035 | 145 | } |
f716a1dd | 146 | |
147 | if (@_) { | |
148 | $size = shift(@_) + 0; | |
149 | croak("Bad buffer size for copy: $size\n") unless ($size > 0); | |
150 | } else { | |
025a6ea3 | 151 | $size = tied(*$from_h) ? 0 : -s $from_h || 0; |
f716a1dd | 152 | $size = 1024 if ($size < 512); |
441496b2 | 153 | $size = $Too_Big if ($size > $Too_Big); |
f716a1dd | 154 | } |
155 | ||
71be2cbc | 156 | $! = 0; |
157 | for (;;) { | |
158 | my ($r, $w, $t); | |
23ba2776 | 159 | defined($r = sysread($from_h, $buf, $size)) |
71be2cbc | 160 | or goto fail_inner; |
161 | last unless $r; | |
162 | for ($w = 0; $w < $r; $w += $t) { | |
23ba2776 | 163 | $t = syswrite($to_h, $buf, $r - $w, $w) |
71be2cbc | 164 | or goto fail_inner; |
f716a1dd | 165 | } |
166 | } | |
71be2cbc | 167 | |
23ba2776 DW |
168 | close($to_h) || goto fail_open2 if $closeto; |
169 | close($from_h) || goto fail_open1 if $closefrom; | |
71be2cbc | 170 | |
48a5c399 | 171 | # Use this idiom to avoid uninitialized value warning. |
f716a1dd | 172 | return 1; |
1a04d035 | 173 | |
f716a1dd | 174 | # All of these contortions try to preserve error messages... |
175 | fail_inner: | |
176 | if ($closeto) { | |
177 | $status = $!; | |
178 | $! = 0; | |
23ba2776 | 179 | close $to_h; |
f716a1dd | 180 | $! = $status unless $!; |
181 | } | |
182 | fail_open2: | |
183 | if ($closefrom) { | |
184 | $status = $!; | |
185 | $! = 0; | |
23ba2776 | 186 | close $from_h; |
f716a1dd | 187 | $! = $status unless $!; |
188 | } | |
189 | fail_open1: | |
f716a1dd | 190 | return 0; |
191 | } | |
9b957b78 | 192 | |
441496b2 | 193 | sub move { |
754f2cd0 MS |
194 | croak("Usage: move(FROM, TO) ") unless @_ == 2; |
195 | ||
71be2cbc | 196 | my($from,$to) = @_; |
754f2cd0 | 197 | |
fa76202e | 198 | my($fromsz,$tosz1,$tomt1,$tosz2,$tomt2,$sts,$ossts); |
441496b2 | 199 | |
71be2cbc | 200 | if (-d $to && ! -d $from) { |
201 | $to = _catname($from, $to); | |
202 | } | |
203 | ||
204 | ($tosz1,$tomt1) = (stat($to))[7,9]; | |
205 | $fromsz = -s $from; | |
e6434134 IZ |
206 | if ($^O eq 'os2' and defined $tosz1 and defined $fromsz) { |
207 | # will not rename with overwrite | |
208 | unlink $to; | |
209 | } | |
71be2cbc | 210 | return 1 if rename $from, $to; |
211 | ||
71be2cbc | 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 | |
1a04d035 | 218 | |
71be2cbc | 219 | ($tosz1,$tomt1) = (stat($to))[7,9]; # just in case rename did something |
762548ba MS |
220 | |
221 | { | |
222 | local $@; | |
223 | eval { | |
754f2cd0 | 224 | local $SIG{__DIE__}; |
762548ba MS |
225 | copy($from,$to) or die; |
226 | my($atime, $mtime) = (stat($from))[8,9]; | |
227 | utime($atime, $mtime, $to); | |
228 | unlink($from) or die; | |
229 | }; | |
230 | return 1 unless $@; | |
231 | } | |
fa76202e | 232 | ($sts,$ossts) = ($! + 0, $^E + 0); |
1a04d035 | 233 | |
71be2cbc | 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); | |
237 | return 0; | |
441496b2 | 238 | } |
9b957b78 | 239 | |
71be2cbc | 240 | *cp = \© |
241 | *mv = \&move; | |
242 | ||
fa648be5 CN |
243 | |
244 | if ($^O eq 'MacOS') { | |
245 | *_protect = sub { MacPerl::MakeFSSpec($_[0]) }; | |
246 | } else { | |
247 | *_protect = sub { "./$_[0]" }; | |
248 | } | |
249 | ||
9b957b78 | 250 | # &syscopy is an XSUB under OS/2 |
1d84e8df JH |
251 | unless (defined &syscopy) { |
252 | if ($^O eq 'VMS') { | |
253 | *syscopy = \&rmscopy; | |
254 | } elsif ($^O eq 'mpeix') { | |
255 | *syscopy = sub { | |
3f5ee302 | 256 | return 0 unless @_ == 2; |
1d84e8df JH |
257 | # Use the MPE cp program in order to |
258 | # preserve MPE file attributes. | |
259 | return system('/bin/cp', '-f', $_[0], $_[1]) == 0; | |
260 | }; | |
7509b657 GS |
261 | } elsif ($^O eq 'MSWin32') { |
262 | *syscopy = sub { | |
263 | return 0 unless @_ == 2; | |
264 | return Win32::CopyFile(@_, 1); | |
265 | }; | |
bcdb689b | 266 | } elsif ($macfiles) { |
fa648be5 CN |
267 | *syscopy = sub { |
268 | my($from, $to) = @_; | |
269 | my($dir, $toname); | |
270 | ||
271 | return 0 unless -e $from; | |
272 | ||
273 | if ($to =~ /(.*:)([^:]+):?$/) { | |
274 | ($dir, $toname) = ($1, $2); | |
275 | } else { | |
276 | ($dir, $toname) = (":", $to); | |
277 | } | |
278 | ||
279 | unlink($to); | |
280 | Mac::MoreFiles::FSpFileCopy($from, $dir, $toname, 1); | |
281 | }; | |
1d84e8df | 282 | } else { |
1a04d035 | 283 | $Syscopy_is_copy = 1; |
1d84e8df JH |
284 | *syscopy = \© |
285 | } | |
286 | } | |
f716a1dd | 287 | |
288 | 1; | |
289 | ||
290 | __END__ | |
a5f75d66 | 291 | |
f716a1dd | 292 | =head1 NAME |
293 | ||
294 | File::Copy - Copy files or filehandles | |
295 | ||
a5f75d66 | 296 | =head1 SYNOPSIS |
f716a1dd | 297 | |
5ce10329 | 298 | use File::Copy; |
f716a1dd | 299 | |
5ce10329 NC |
300 | copy("file1","file2") or die "Copy failed: $!"; |
301 | copy("Copy.pm",\*STDOUT); | |
441496b2 | 302 | move("/dev1/fileA","/dev2/fileB"); |
f716a1dd | 303 | |
78e38bb6 | 304 | use File::Copy "cp"; |
f716a1dd | 305 | |
23f3aea0 | 306 | $n = FileHandle->new("/a/file","r"); |
c6dfe06b | 307 | cp($n,"x"); |
f716a1dd | 308 | |
309 | =head1 DESCRIPTION | |
310 | ||
441496b2 CB |
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. | |
314 | ||
315 | =over 4 | |
316 | ||
317 | =item * | |
318 | ||
319 | The C<copy> function takes two | |
f716a1dd | 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 | |
96a91e01 | 325 | written to (and created if need be). Trying to copy a file on top |
326 | of itself is a fatal error. | |
71be2cbc | 327 | |
328 | B<Note that passing in | |
9b957b78 | 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 | |
e6434134 | 331 | names whenever possible.> Files are opened in binary mode where |
8dcee03e | 332 | applicable. To get a consistent behaviour when copying from a |
e6434134 | 333 | filehandle to a file, use C<binmode> on the filehandle. |
f716a1dd | 334 | |
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). | |
341 | ||
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. | |
344 | ||
441496b2 CB |
345 | =item * |
346 | ||
347 | The C<move> function also takes two parameters: the current name | |
71be2cbc | 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. | |
352 | ||
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) | |
441496b2 CB |
356 | copy of the file under the destination name. |
357 | ||
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>. | |
360 | ||
361 | =back | |
362 | ||
9b957b78 | 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 | |
f1442e8b SB |
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>. | |
9b957b78 | 371 | |
bcdb689b JH |
372 | On Mac OS (Classic), C<syscopy> calls C<Mac::MoreFiles::FSpFileCopy>, |
373 | if available. | |
374 | ||
7509b657 | 375 | =head2 Special behaviour if C<syscopy> is defined (OS/2, VMS and Win32) |
9b957b78 | 376 | |
71be2cbc | 377 | If both arguments to C<copy> are not file handles, |
378 | then C<copy> will perform a "system copy" of | |
9b957b78 | 379 | the input file to a new output file, in order to preserve file |
380 | attributes, indexed file structure, I<etc.> The buffer size | |
71be2cbc | 381 | parameter is ignored. If either argument to C<copy> is a |
382 | handle to an opened file, then data is copied using Perl | |
9b957b78 | 383 | operators, and no effort is made to preserve file attributes |
384 | or record structure. | |
385 | ||
55497cff | 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 | |
71be2cbc | 388 | is the routine that does the actual work for syscopy). |
9b957b78 | 389 | |
441496b2 | 390 | =over 4 |
55497cff | 391 | |
9b957b78 | 392 | =item rmscopy($from,$to[,$date_flag]) |
393 | ||
71be2cbc | 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 | |
9b957b78 | 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. | |
400 | ||
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.) | |
410 | ||
411 | The third parameter is an integer flag, which tells C<rmscopy> | |
1fef88e7 JM |
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 | |
9b957b78 | 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, | |
422 | it defaults to 0. | |
423 | ||
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. | |
426 | ||
55497cff | 427 | =back |
428 | ||
f716a1dd | 429 | =head1 RETURN |
430 | ||
441496b2 CB |
431 | All functions return 1 on success, 0 on failure. |
432 | $! will be set if an error was encountered. | |
f716a1dd | 433 | |
6c254d95 CN |
434 | =head1 NOTES |
435 | ||
436 | =over 4 | |
437 | ||
438 | =item * | |
439 | ||
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. | |
445 | ||
446 | E.g. | |
447 | ||
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 | |
456 | ||
457 | move("MacintoshHD:fileA", "DataHD:fileB"); # moves (don't copies) files from one | |
458 | # volume to another | |
459 | ||
460 | =back | |
461 | ||
f716a1dd | 462 | =head1 AUTHOR |
463 | ||
441496b2 | 464 | File::Copy was written by Aaron Sherman I<E<lt>ajs@ajs.comE<gt>> in 1995, |
bd3fa61c | 465 | and updated by Charles Bailey I<E<lt>bailey@newman.upenn.eduE<gt>> in 1996. |
f716a1dd | 466 | |
467 | =cut | |
441496b2 | 468 |