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.
12 use UNIVERSAL qw(isa);
13 use vars qw(@ISA @EXPORT @EXPORT_OK $VERSION $Too_Big
14 © &syscopy &cp &mv);
16 # Note that this module implements only *part* of the API defined by
17 # the File/Copy.pm module of the File-Tools-2.0 package. However, that
18 # package has not yet been updated to work with Perl 5.004, and so it
19 # would be a Bad Thing for the CPAN module to grab it and replace this
20 # module. Therefore, we set this module's version higher than 2.0.
25 @EXPORT = qw(copy move);
26 @EXPORT_OK = qw(cp mv);
28 $Too_Big = 1024 * 1024 * 2;
30 sub _catname { # Will be replaced by File::Spec when it arrives
32 if (not defined &basename) {
33 require File::Basename;
34 import File::Basename 'basename';
36 if ($^O eq 'VMS') { $to = VMS::Filespec::vmspath($to) . basename($from); }
37 elsif ($^O eq 'MacOS') { $to .= ':' . basename($from); }
38 elsif ($to =~ m|\\|) { $to .= '\\' . basename($from); }
39 else { $to .= '/' . basename($from); }
43 croak("Usage: copy(FROM, TO [, BUFFERSIZE]) ")
44 unless(@_ == 2 || @_ == 3);
49 my $from_a_handle = (ref($from)
50 ? (ref($from) eq 'GLOB'
51 || isa($from, 'GLOB') || isa($from, 'IO::Handle'))
52 : (ref(\$from) eq 'GLOB'));
53 my $to_a_handle = (ref($to)
55 || isa($to, 'GLOB') || isa($to, 'IO::Handle'))
56 : (ref(\$to) eq 'GLOB'));
58 if (!$from_a_handle && !$to_a_handle && -d $to && ! -d $from) {
59 $to = _catname($from, $to);
62 if (defined &syscopy && \&syscopy != \©
64 && !($from_a_handle && $^O eq 'os2')) # OS/2 cannot handle handles
66 return syscopy($from, $to);
71 my ($size, $status, $r, $buf);
76 *FROM = *$from{FILEHANDLE};
78 $from = "./$from" if $from =~ /^\s/;
79 open(FROM, "< $from\0") or goto fail_open1;
80 binmode FROM or die "($!,$^E)";
85 *TO = *$to{FILEHANDLE};
87 $to = "./$to" if $to =~ /^\s/;
88 open(TO,"> $to\0") or goto fail_open2;
89 binmode TO or die "($!,$^E)";
94 $size = shift(@_) + 0;
95 croak("Bad buffer size for copy: $size\n") unless ($size > 0);
98 $size = 1024 if ($size < 512);
99 $size = $Too_Big if ($size > $Too_Big);
105 defined($r = sysread(FROM, $buf, $size))
108 for ($w = 0; $w < $r; $w += $t) {
109 $t = syswrite(TO, $buf, $r - $w, $w)
114 close(TO) || goto fail_open2 if $closeto;
115 close(FROM) || goto fail_open1 if $closefrom;
117 # Use this idiom to avoid uninitialized value warning.
120 # All of these contortions try to preserve error messages...
126 $! = $status unless $!;
133 $! = $status unless $!;
141 my($copied,$fromsz,$tosz1,$tomt1,$tosz2,$tomt2,$sts,$ossts);
143 if (-d $to && ! -d $from) {
144 $to = _catname($from, $to);
147 ($tosz1,$tomt1) = (stat($to))[7,9];
149 if ($^O eq 'os2' and defined $tosz1 and defined $fromsz) {
150 # will not rename with overwrite
153 return 1 if rename $from, $to;
155 ($sts,$ossts) = ($! + 0, $^E + 0);
156 # Did rename return an error even though it succeeded, because $to
157 # is on a remote NFS file system, and NFS lost the server's ack?
158 return 1 if defined($fromsz) && !-e $from && # $from disappeared
159 (($tosz2,$tomt2) = (stat($to))[7,9]) && # $to's there
160 ($tosz1 != $tosz2 or $tomt1 != $tomt2) && # and changed
161 $tosz2 == $fromsz; # it's all there
163 ($tosz1,$tomt1) = (stat($to))[7,9]; # just in case rename did something
164 return 1 if ($copied = copy($from,$to)) && unlink($from);
166 ($tosz2,$tomt2) = ((stat($to))[7,9],0,0) if defined $tomt1;
167 unlink($to) if !defined($tomt1) or $tomt1 != $tomt2 or $tosz1 != $tosz2;
168 ($!,$^E) = ($sts,$ossts);
175 # &syscopy is an XSUB under OS/2
176 *syscopy = ($^O eq 'VMS' ? \&rmscopy : \©) unless defined &syscopy;
184 File::Copy - Copy files or filehandles
190 copy("file1","file2");
191 copy("Copy.pm",\*STDOUT);'
192 move("/dev1/fileA","/dev2/fileB");
197 $n=FileHandle->new("/dev/null","r");
202 The File::Copy module provides two basic functions, C<copy> and
203 C<move>, which are useful for getting the contents of a file from
204 one place to another.
210 The C<copy> function takes two
211 parameters: a file to copy from and a file to copy to. Either
212 argument may be a string, a FileHandle reference or a FileHandle
213 glob. Obviously, if the first argument is a filehandle of some
214 sort, it will be read from, and if it is a file I<name> it will
215 be opened for reading. Likewise, the second argument will be
216 written to (and created if need be).
218 B<Note that passing in
219 files as handles instead of names may lead to loss of information
220 on some operating systems; it is recommended that you use file
221 names whenever possible.> Files are opened in binary mode where
222 applicable. To get a consistent behavour when copying from a
223 filehandle to a file, use C<binmode> on the filehandle.
225 An optional third parameter can be used to specify the buffer
226 size used for copying. This is the number of bytes from the
227 first file, that wil be held in memory at any given time, before
228 being written to the second file. The default buffer size depends
229 upon the file, but will generally be the whole file (up to 2Mb), or
230 1k for filehandles that do not reference files (eg. sockets).
232 You may use the syntax C<use File::Copy "cp"> to get at the
233 "cp" alias for this function. The syntax is I<exactly> the same.
237 The C<move> function also takes two parameters: the current name
238 and the intended name of the file to be moved. If the destination
239 already exists and is a directory, and the source is not a
240 directory, then the source file will be renamed into the directory
241 specified by the destination.
243 If possible, move() will simply rename the file. Otherwise, it copies
244 the file to the new location and deletes the original. If an error occurs
245 during this copy-and-delete process, you may be left with a (possibly partial)
246 copy of the file under the destination name.
248 You may use the "mv" alias for this function in the same way that
249 you may use the "cp" alias for C<copy>.
253 File::Copy also provides the C<syscopy> routine, which copies the
254 file specified in the first parameter to the file specified in the
255 second parameter, preserving OS-specific attributes and file
256 structure. For Unix systems, this is equivalent to the simple
257 C<copy> routine. For VMS systems, this calls the C<rmscopy>
258 routine (see below). For OS/2 systems, this calls the C<syscopy>
261 =head2 Special behavior if C<syscopy> is defined (VMS and OS/2)
263 If both arguments to C<copy> are not file handles,
264 then C<copy> will perform a "system copy" of
265 the input file to a new output file, in order to preserve file
266 attributes, indexed file structure, I<etc.> The buffer size
267 parameter is ignored. If either argument to C<copy> is a
268 handle to an opened file, then data is copied using Perl
269 operators, and no effort is made to preserve file attributes
272 The system copy routine may also be called directly under VMS and OS/2
273 as C<File::Copy::syscopy> (or under VMS as C<File::Copy::rmscopy>, which
274 is the routine that does the actual work for syscopy).
278 =item rmscopy($from,$to[,$date_flag])
280 The first and second arguments may be strings, typeglobs, typeglob
281 references, or objects inheriting from IO::Handle;
282 they are used in all cases to obtain the
283 I<filespec> of the input and output files, respectively. The
284 name and type of the input file are used as defaults for the
285 output file, if necessary.
287 A new version of the output file is always created, which
288 inherits the structure and RMS attributes of the input file,
289 except for owner and protections (and possibly timestamps;
290 see below). All data from the input file is copied to the
291 output file; if either of the first two parameters to C<rmscopy>
292 is a file handle, its position is unchanged. (Note that this
293 means a file handle pointing to the output file will be
294 associated with an old version of that file after C<rmscopy>
295 returns, not the newly created version.)
297 The third parameter is an integer flag, which tells C<rmscopy>
298 how to handle timestamps. If it is E<lt> 0, none of the input file's
299 timestamps are propagated to the output file. If it is E<gt> 0, then
300 it is interpreted as a bitmask: if bit 0 (the LSB) is set, then
301 timestamps other than the revision date are propagated; if bit 1
302 is set, the revision date is propagated. If the third parameter
303 to C<rmscopy> is 0, then it behaves much like the DCL COPY command:
304 if the name or type of the output file was explicitly specified,
305 then no timestamps are propagated, but if they were taken implicitly
306 from the input filespec, then all timestamps other than the
307 revision date are propagated. If this parameter is not supplied,
310 Like C<copy>, C<rmscopy> returns 1 on success. If an error occurs,
311 it sets C<$!>, deletes the output file, and returns 0.
317 All functions return 1 on success, 0 on failure.
318 $! will be set if an error was encountered.
322 File::Copy was written by Aaron Sherman I<E<lt>ajs@ajs.comE<gt>> in 1995,
323 and updated by Charles Bailey I<E<lt>bailey@genetics.upenn.eduE<gt>> in 1996.