This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Multiple modules didn't work; plus typo fixes.
[perl5.git] / lib / File / Copy.pm
CommitLineData
f716a1dd
PP
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
PP
5# Additions copyright 1996 by Charles Bailey. Permission is granted
6# to distribute the revised code under the same terms as Perl itself.
f716a1dd
PP
7
8package File::Copy;
9
b395063c 10use 5.6.0;
71be2cbc 11use strict;
b395063c 12use warnings;
f716a1dd 13use Carp;
6c254d95 14use File::Spec;
17f410f9
GS
15our(@ISA, @EXPORT, @EXPORT_OK, $VERSION, $Too_Big, $Syscopy_is_copy);
16sub copy;
17sub syscopy;
18sub cp;
19sub mv;
71be2cbc
PP
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.
6c254d95 26$VERSION = '2.04';
f716a1dd 27
71be2cbc
PP
28require 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
6c254d95 35sub _catname {
71be2cbc
PP
36 my($from, $to) = @_;
37 if (not defined &basename) {
38 require File::Basename;
39 import File::Basename 'basename';
40 }
6c254d95
CN
41
42 if ($^O eq 'MacOS') {
43 # a partial dir name that's valid only in the cwd (e.g. 'tmp')
44 $to = ':' . $to if $to !~ /:/;
45 }
46
47 return File::Spec->catfile($to, basename($from));
f716a1dd
PP
48}
49
50sub copy {
71be2cbc 51 croak("Usage: copy(FROM, TO [, BUFFERSIZE]) ")
f716a1dd
PP
52 unless(@_ == 2 || @_ == 3);
53
54 my $from = shift;
55 my $to = shift;
71be2cbc
PP
56
57 my $from_a_handle = (ref($from)
58 ? (ref($from) eq 'GLOB'
d704f39a
G
59 || UNIVERSAL::isa($from, 'GLOB')
60 || UNIVERSAL::isa($from, 'IO::Handle'))
71be2cbc
PP
61 : (ref(\$from) eq 'GLOB'));
62 my $to_a_handle = (ref($to)
63 ? (ref($to) eq 'GLOB'
d704f39a
G
64 || UNIVERSAL::isa($to, 'GLOB')
65 || UNIVERSAL::isa($to, 'IO::Handle'))
71be2cbc
PP
66 : (ref(\$to) eq 'GLOB'));
67
68 if (!$from_a_handle && !$to_a_handle && -d $to && ! -d $from) {
69 $to = _catname($from, $to);
70 }
71
1a04d035 72 if (defined &syscopy && !$Syscopy_is_copy
e6434134 73 && !$to_a_handle
1d84e8df
JH
74 && !($from_a_handle && $^O eq 'os2' ) # OS/2 cannot handle handles
75 && !($from_a_handle && $^O eq 'mpeix') # and neither can MPE/iX.
7509b657 76 && !($from_a_handle && $^O eq 'MSWin32')
fa648be5 77 && !($from_a_handle && $^O eq 'MacOS')
2986a63f 78 && !($from_a_handle && $^O eq 'NetWare')
1a04d035 79 )
71be2cbc
PP
80 {
81 return syscopy($from, $to);
82 }
83
84 my $closefrom = 0;
85 my $closeto = 0;
f716a1dd 86 my ($size, $status, $r, $buf);
48a5c399 87 local($\) = '';
f716a1dd 88
23ba2776 89 my $from_h;
71be2cbc 90 if ($from_a_handle) {
23ba2776 91 $from_h = $from;
f716a1dd 92 } else {
fa648be5 93 $from = _protect($from) if $from =~ /^\s/s;
23ba2776
WD
94 $from_h = \do { local *FH };
95 open($from_h, "< $from\0") or goto fail_open1;
96 binmode $from_h or die "($!,$^E)";
f716a1dd 97 $closefrom = 1;
1a04d035
A
98 }
99
23ba2776 100 my $to_h;
71be2cbc 101 if ($to_a_handle) {
23ba2776 102 $to_h = $to;
1a04d035 103 } else {
fa648be5 104 $to = _protect($to) if $to =~ /^\s/s;
23ba2776
WD
105 $to_h = \do { local *FH };
106 open($to_h,"> $to\0") or goto fail_open2;
107 binmode $to_h or die "($!,$^E)";
71be2cbc 108 $closeto = 1;
1a04d035 109 }
f716a1dd
PP
110
111 if (@_) {
112 $size = shift(@_) + 0;
113 croak("Bad buffer size for copy: $size\n") unless ($size > 0);
114 } else {
23ba2776
WD
115 no warnings 'uninitialized';
116 $size = -s $from_h;
f716a1dd 117 $size = 1024 if ($size < 512);
441496b2 118 $size = $Too_Big if ($size > $Too_Big);
f716a1dd
PP
119 }
120
71be2cbc
PP
121 $! = 0;
122 for (;;) {
123 my ($r, $w, $t);
23ba2776 124 defined($r = sysread($from_h, $buf, $size))
71be2cbc
PP
125 or goto fail_inner;
126 last unless $r;
127 for ($w = 0; $w < $r; $w += $t) {
23ba2776 128 $t = syswrite($to_h, $buf, $r - $w, $w)
71be2cbc 129 or goto fail_inner;
f716a1dd
PP
130 }
131 }
71be2cbc 132
23ba2776
WD
133 close($to_h) || goto fail_open2 if $closeto;
134 close($from_h) || goto fail_open1 if $closefrom;
71be2cbc 135
48a5c399 136 # Use this idiom to avoid uninitialized value warning.
f716a1dd 137 return 1;
1a04d035 138
f716a1dd
PP
139 # All of these contortions try to preserve error messages...
140 fail_inner:
141 if ($closeto) {
142 $status = $!;
143 $! = 0;
23ba2776 144 close $to_h;
f716a1dd
PP
145 $! = $status unless $!;
146 }
147 fail_open2:
148 if ($closefrom) {
149 $status = $!;
150 $! = 0;
23ba2776 151 close $from_h;
f716a1dd
PP
152 $! = $status unless $!;
153 }
154 fail_open1:
f716a1dd
PP
155 return 0;
156}
9b957b78 157
441496b2 158sub move {
71be2cbc
PP
159 my($from,$to) = @_;
160 my($copied,$fromsz,$tosz1,$tomt1,$tosz2,$tomt2,$sts,$ossts);
441496b2 161
71be2cbc
PP
162 if (-d $to && ! -d $from) {
163 $to = _catname($from, $to);
164 }
165
166 ($tosz1,$tomt1) = (stat($to))[7,9];
167 $fromsz = -s $from;
e6434134
IZ
168 if ($^O eq 'os2' and defined $tosz1 and defined $fromsz) {
169 # will not rename with overwrite
170 unlink $to;
171 }
71be2cbc
PP
172 return 1 if rename $from, $to;
173
174 ($sts,$ossts) = ($! + 0, $^E + 0);
175 # Did rename return an error even though it succeeded, because $to
176 # is on a remote NFS file system, and NFS lost the server's ack?
177 return 1 if defined($fromsz) && !-e $from && # $from disappeared
178 (($tosz2,$tomt2) = (stat($to))[7,9]) && # $to's there
179 ($tosz1 != $tosz2 or $tomt1 != $tomt2) && # and changed
180 $tosz2 == $fromsz; # it's all there
1a04d035 181
71be2cbc
PP
182 ($tosz1,$tomt1) = (stat($to))[7,9]; # just in case rename did something
183 return 1 if ($copied = copy($from,$to)) && unlink($from);
1a04d035 184
71be2cbc
PP
185 ($tosz2,$tomt2) = ((stat($to))[7,9],0,0) if defined $tomt1;
186 unlink($to) if !defined($tomt1) or $tomt1 != $tomt2 or $tosz1 != $tosz2;
187 ($!,$^E) = ($sts,$ossts);
188 return 0;
441496b2 189}
9b957b78 190
71be2cbc
PP
191*cp = \&copy;
192*mv = \&move;
193
fa648be5
CN
194
195if ($^O eq 'MacOS') {
196 *_protect = sub { MacPerl::MakeFSSpec($_[0]) };
197} else {
198 *_protect = sub { "./$_[0]" };
199}
200
9b957b78 201# &syscopy is an XSUB under OS/2
1d84e8df
JH
202unless (defined &syscopy) {
203 if ($^O eq 'VMS') {
204 *syscopy = \&rmscopy;
205 } elsif ($^O eq 'mpeix') {
206 *syscopy = sub {
3f5ee302 207 return 0 unless @_ == 2;
1d84e8df
JH
208 # Use the MPE cp program in order to
209 # preserve MPE file attributes.
210 return system('/bin/cp', '-f', $_[0], $_[1]) == 0;
211 };
7509b657
GS
212 } elsif ($^O eq 'MSWin32') {
213 *syscopy = sub {
214 return 0 unless @_ == 2;
215 return Win32::CopyFile(@_, 1);
216 };
fa648be5
CN
217 } elsif ($^O eq 'MacOS') {
218 require Mac::MoreFiles;
219 *syscopy = sub {
220 my($from, $to) = @_;
221 my($dir, $toname);
222
223 return 0 unless -e $from;
224
225 if ($to =~ /(.*:)([^:]+):?$/) {
226 ($dir, $toname) = ($1, $2);
227 } else {
228 ($dir, $toname) = (":", $to);
229 }
230
231 unlink($to);
232 Mac::MoreFiles::FSpFileCopy($from, $dir, $toname, 1);
233 };
1d84e8df 234 } else {
1a04d035 235 $Syscopy_is_copy = 1;
1d84e8df
JH
236 *syscopy = \&copy;
237 }
238}
f716a1dd
PP
239
2401;
241
242__END__
a5f75d66 243
f716a1dd
PP
244=head1 NAME
245
246File::Copy - Copy files or filehandles
247
a5f75d66 248=head1 SYNOPSIS
f716a1dd
PP
249
250 use File::Copy;
251
252 copy("file1","file2");
253 copy("Copy.pm",\*STDOUT);'
441496b2 254 move("/dev1/fileA","/dev2/fileB");
f716a1dd
PP
255
256 use POSIX;
257 use File::Copy cp;
258
23f3aea0 259 $n = FileHandle->new("/a/file","r");
f716a1dd
PP
260 cp($n,"x");'
261
262=head1 DESCRIPTION
263
441496b2
CB
264The File::Copy module provides two basic functions, C<copy> and
265C<move>, which are useful for getting the contents of a file from
266one place to another.
267
268=over 4
269
270=item *
271
272The C<copy> function takes two
f716a1dd
PP
273parameters: a file to copy from and a file to copy to. Either
274argument may be a string, a FileHandle reference or a FileHandle
275glob. Obviously, if the first argument is a filehandle of some
276sort, it will be read from, and if it is a file I<name> it will
277be opened for reading. Likewise, the second argument will be
e6434134 278written to (and created if need be).
71be2cbc
PP
279
280B<Note that passing in
9b957b78
PP
281files as handles instead of names may lead to loss of information
282on some operating systems; it is recommended that you use file
e6434134 283names whenever possible.> Files are opened in binary mode where
8dcee03e 284applicable. To get a consistent behaviour when copying from a
e6434134 285filehandle to a file, use C<binmode> on the filehandle.
f716a1dd
PP
286
287An optional third parameter can be used to specify the buffer
288size used for copying. This is the number of bytes from the
289first file, that wil be held in memory at any given time, before
290being written to the second file. The default buffer size depends
291upon the file, but will generally be the whole file (up to 2Mb), or
2921k for filehandles that do not reference files (eg. sockets).
293
294You may use the syntax C<use File::Copy "cp"> to get at the
295"cp" alias for this function. The syntax is I<exactly> the same.
296
441496b2
CB
297=item *
298
299The C<move> function also takes two parameters: the current name
71be2cbc
PP
300and the intended name of the file to be moved. If the destination
301already exists and is a directory, and the source is not a
302directory, then the source file will be renamed into the directory
303specified by the destination.
304
305If possible, move() will simply rename the file. Otherwise, it copies
306the file to the new location and deletes the original. If an error occurs
307during this copy-and-delete process, you may be left with a (possibly partial)
441496b2
CB
308copy of the file under the destination name.
309
310You may use the "mv" alias for this function in the same way that
311you may use the "cp" alias for C<copy>.
312
313=back
314
9b957b78
PP
315File::Copy also provides the C<syscopy> routine, which copies the
316file specified in the first parameter to the file specified in the
317second parameter, preserving OS-specific attributes and file
318structure. For Unix systems, this is equivalent to the simple
319C<copy> routine. For VMS systems, this calls the C<rmscopy>
320routine (see below). For OS/2 systems, this calls the C<syscopy>
7509b657 321XSUB directly. For Win32 systems, this calls C<Win32::CopyFile>.
9b957b78 322
7509b657 323=head2 Special behaviour if C<syscopy> is defined (OS/2, VMS and Win32)
9b957b78 324
71be2cbc
PP
325If both arguments to C<copy> are not file handles,
326then C<copy> will perform a "system copy" of
9b957b78
PP
327the input file to a new output file, in order to preserve file
328attributes, indexed file structure, I<etc.> The buffer size
71be2cbc
PP
329parameter is ignored. If either argument to C<copy> is a
330handle to an opened file, then data is copied using Perl
9b957b78
PP
331operators, and no effort is made to preserve file attributes
332or record structure.
333
55497cff
PP
334The system copy routine may also be called directly under VMS and OS/2
335as C<File::Copy::syscopy> (or under VMS as C<File::Copy::rmscopy>, which
71be2cbc 336is the routine that does the actual work for syscopy).
9b957b78 337
441496b2 338=over 4
55497cff 339
9b957b78
PP
340=item rmscopy($from,$to[,$date_flag])
341
71be2cbc
PP
342The first and second arguments may be strings, typeglobs, typeglob
343references, or objects inheriting from IO::Handle;
344they are used in all cases to obtain the
9b957b78
PP
345I<filespec> of the input and output files, respectively. The
346name and type of the input file are used as defaults for the
347output file, if necessary.
348
349A new version of the output file is always created, which
350inherits the structure and RMS attributes of the input file,
351except for owner and protections (and possibly timestamps;
352see below). All data from the input file is copied to the
353output file; if either of the first two parameters to C<rmscopy>
354is a file handle, its position is unchanged. (Note that this
355means a file handle pointing to the output file will be
356associated with an old version of that file after C<rmscopy>
357returns, not the newly created version.)
358
359The third parameter is an integer flag, which tells C<rmscopy>
1fef88e7
JM
360how to handle timestamps. If it is E<lt> 0, none of the input file's
361timestamps are propagated to the output file. If it is E<gt> 0, then
9b957b78
PP
362it is interpreted as a bitmask: if bit 0 (the LSB) is set, then
363timestamps other than the revision date are propagated; if bit 1
364is set, the revision date is propagated. If the third parameter
365to C<rmscopy> is 0, then it behaves much like the DCL COPY command:
366if the name or type of the output file was explicitly specified,
367then no timestamps are propagated, but if they were taken implicitly
368from the input filespec, then all timestamps other than the
369revision date are propagated. If this parameter is not supplied,
370it defaults to 0.
371
372Like C<copy>, C<rmscopy> returns 1 on success. If an error occurs,
373it sets C<$!>, deletes the output file, and returns 0.
374
55497cff
PP
375=back
376
f716a1dd
PP
377=head1 RETURN
378
441496b2
CB
379All functions return 1 on success, 0 on failure.
380$! will be set if an error was encountered.
f716a1dd 381
6c254d95
CN
382=head1 NOTES
383
384=over 4
385
386=item *
387
388On Mac OS (Classic), the path separator is ':', not '/', and the
389current directory is denoted as ':', not '.'. You should be careful
390about specifying relative pathnames. While a full path always begins
391with a volume name, a relative pathname should always begin with a
392':'. If specifying a volume name only, a trailing ':' is required.
393
394E.g.
395
396 copy("file1", "tmp"); # creates the file 'tmp' in the current directory
397 copy("file1", ":tmp:"); # creates :tmp:file1
398 copy("file1", ":tmp"); # same as above
399 copy("file1", "tmp"); # same as above, if 'tmp' is a directory (but don't do
400 # that, since it may cause confusion, see example #1)
401 copy("file1", "tmp:file1"); # error, since 'tmp:' is not a volume
402 copy("file1", ":tmp:file1"); # ok, partial path
403 copy("file1", "DataHD:"); # creates DataHD:file1
404
405 move("MacintoshHD:fileA", "DataHD:fileB"); # moves (don't copies) files from one
406 # volume to another
407
408=back
409
f716a1dd
PP
410=head1 AUTHOR
411
441496b2 412File::Copy was written by Aaron Sherman I<E<lt>ajs@ajs.comE<gt>> in 1995,
bd3fa61c 413and updated by Charles Bailey I<E<lt>bailey@newman.upenn.eduE<gt>> in 1996.
f716a1dd
PP
414
415=cut
441496b2 416