[p5sagit/p5-mst-13.2.git] / lib / File / Copy.pm

# File/Copy.pm. Written in 1994 by Aaron Sherman <ajs@ajs.com>. This
# source code has been placed in the public domain by the author.
# Please be kind and preserve the documentation.
#
# Additions copyright 1996 by Charles Bailey.  Permission is granted
# to distribute the revised code under the same terms as Perl itself.

package File::Copy;

use 5.006;
use strict;
use warnings;
use File::Spec;
use Config;
# During perl build, we need File::Copy but Fcntl might not be built yet
my $Fcntl_loaded = eval q{ use Fcntl qw [O_CREAT O_WRONLY O_TRUNC]; 1 };
our(@ISA, @EXPORT, @EXPORT_OK, $VERSION, $Too_Big, $Syscopy_is_copy);
sub copy;
sub syscopy;
sub cp;
sub mv;

$VERSION = '2.13';

require Exporter;
@ISA = qw(Exporter);
@EXPORT = qw(copy move);
@EXPORT_OK = qw(cp mv);

$Too_Big = 1024 * 1024 * 2;

sub croak {
    require Carp;
    goto &Carp::croak;
}

sub carp {
    require Carp;
    goto &Carp::carp;
}

my $macfiles;
if ($^O eq 'MacOS') {
	$macfiles = eval { require Mac::MoreFiles };
	warn 'Mac::MoreFiles could not be loaded; using non-native syscopy'
		if $@ && $^W;
}

sub _catname {
    my($from, $to) = @_;
    if (not defined &basename) {
	require File::Basename;
	import  File::Basename 'basename';
    }

    if ($^O eq 'MacOS') {
	# a partial dir name that's valid only in the cwd (e.g. 'tmp')
	$to = ':' . $to if $to !~ /:/;
    }

    return File::Spec->catfile($to, basename($from));
}

# _eq($from, $to) tells whether $from and $to are identical
# works for strings and references
sub _eq {
    return $_[0] == $_[1] if ref $_[0] && ref $_[1];
    return $_[0] eq $_[1] if !ref $_[0] && !ref $_[1];
    return "";
}

sub copy {
    croak("Usage: copy(FROM, TO [, BUFFERSIZE]) ")
      unless(@_ == 2 || @_ == 3);

    my $from = shift;
    my $to = shift;

    my $size;
    if (@_) {
	$size = shift(@_) + 0;
	croak("Bad buffer size for copy: $size\n") unless ($size > 0);
    }

    my $from_a_handle = (ref($from)
			 ? (ref($from) eq 'GLOB'
			    || UNIVERSAL::isa($from, 'GLOB')
                            || UNIVERSAL::isa($from, 'IO::Handle'))
			 : (ref(\$from) eq 'GLOB'));
    my $to_a_handle =   (ref($to)
			 ? (ref($to) eq 'GLOB'
			    || UNIVERSAL::isa($to, 'GLOB')
                            || UNIVERSAL::isa($to, 'IO::Handle'))
			 : (ref(\$to) eq 'GLOB'));

    if (_eq($from, $to)) { # works for references, too
	carp("'$from' and '$to' are identical (not copied)");
        # The "copy" was a success as the source and destination contain
        # the same data.
        return 1;
    }

    if ((($Config{d_symlink} && $Config{d_readlink}) || $Config{d_link}) &&
	!($^O eq 'MSWin32' || $^O eq 'os2')) {
	my @fs = stat($from);
	if (@fs) {
	    my @ts = stat($to);
	    if (@ts && $fs[0] == $ts[0] && $fs[1] == $ts[1]) {
		carp("'$from' and '$to' are identical (not copied)");
                return 0;
	    }
	}
    }

    if (!$from_a_handle && !$to_a_handle && -d $to && ! -d $from) {
	$to = _catname($from, $to);
    }

    if (defined &syscopy && !$Syscopy_is_copy
	&& !$to_a_handle
	&& !($from_a_handle && $^O eq 'os2' )	# OS/2 cannot handle handles
	&& !($from_a_handle && $^O eq 'mpeix')	# and neither can MPE/iX.
	&& !($from_a_handle && $^O eq 'MSWin32')
	&& !($from_a_handle && $^O eq 'MacOS')
	&& !($from_a_handle && $^O eq 'NetWare')
       )
    {
	my $copy_to = $to;

        if ($^O eq 'VMS' && -e $from) {

            if (! -d $to && ! -d $from) {

                # VMS has sticky defaults on extensions, which means that
                # if there is a null extension on the destination file, it
                # will inherit the extension of the source file
                # So add a '.' for a null extension.

                $copy_to = VMS::Filespec::vmsify($to);
                my ($vol, $dirs, $file) = File::Spec->splitpath($copy_to);
                $file = $file . '.' unless ($file =~ /(?<!\^)\./);
                $copy_to = File::Spec->catpath($vol, $dirs, $file);

                # Get rid of the old versions to be like UNIX
                1 while unlink $copy_to;
            }
        }

        return syscopy($from, $copy_to);
    }

    my $closefrom = 0;
    my $closeto = 0;
    my ($status, $r, $buf);
    local($\) = '';

    my $from_h;
    if ($from_a_handle) {
       $from_h = $from;
    } else {
       open $from_h, "<", $from or goto fail_open1;
       binmode $from_h or die "($!,$^E)";
	$closefrom = 1;
    }

    # Seems most logical to do this here, in case future changes would want to
    # make this croak for some reason.
    unless (defined $size) {
	$size = tied(*$from_h) ? 0 : -s $from_h || 0;
	$size = 1024 if ($size < 512);
	$size = $Too_Big if ($size > $Too_Big);
    }

    my $to_h;
    if ($to_a_handle) {
       $to_h = $to;
    } else {
	$to = _protect($to) if $to =~ /^\s/s;
	if ($Fcntl_loaded) {
	    my $perm = (stat $from_h) [2] & 0xFFF;
	    sysopen $to_h, $to, O_CREAT() | O_TRUNC() | O_WRONLY(), $perm
		or goto fail_open2;
	}
	else {
	    $to_h = \do { local *FH };
	    open $to_h, ">", $to or goto fail_open2;
	}
	binmode $to_h or die "($!,$^E)";
	$closeto = 1;
    }

    $! = 0;
    for (;;) {
	my ($r, $w, $t);
       defined($r = sysread($from_h, $buf, $size))
	    or goto fail_inner;
	last unless $r;
	for ($w = 0; $w < $r; $w += $t) {
           $t = syswrite($to_h, $buf, $r - $w, $w)
		or goto fail_inner;
	}
    }

    close($to_h) || goto fail_open2 if $closeto;
    close($from_h) || goto fail_open1 if $closefrom;

    # Use this idiom to avoid uninitialized value warning.
    return 1;

    # All of these contortions try to preserve error messages...
  fail_inner:
    if ($closeto) {
	$status = $!;
	$! = 0;
       close $to_h;
	$! = $status unless $!;
    }
  fail_open2:
    if ($closefrom) {
	$status = $!;
	$! = 0;
       close $from_h;
	$! = $status unless $!;
    }
  fail_open1:
    return 0;
}

sub move {
    croak("Usage: move(FROM, TO) ") unless @_ == 2;

    my($from,$to) = @_;

    my($fromsz,$tosz1,$tomt1,$tosz2,$tomt2,$sts,$ossts);

    if (-d $to && ! -d $from) {
	$to = _catname($from, $to);
    }

    ($tosz1,$tomt1) = (stat($to))[7,9];
    $fromsz = -s $from;
    if ($^O eq 'os2' and defined $tosz1 and defined $fromsz) {
      # will not rename with overwrite
      unlink $to;
    }

    my $rename_to = $to;
    if (-$^O eq 'VMS' && -e $from) {

        if (! -d $to && ! -d $from) {
            # VMS has sticky defaults on extensions, which means that
            # if there is a null extension on the destination file, it
            # will inherit the extension of the source file
            # So add a '.' for a null extension.

            $rename_to = VMS::Filespec::vmsify($to);
            my ($vol, $dirs, $file) = File::Spec->splitpath($rename_to);
            $file = $file . '.' unless ($file =~ /(?<!\^)\./);
            $rename_to = File::Spec->catpath($vol, $dirs, $file);

            # Get rid of the old versions to be like UNIX
            1 while unlink $rename_to;
        }
    }

    return 1 if rename $from, $rename_to;

    # Did rename return an error even though it succeeded, because $to
    # is on a remote NFS file system, and NFS lost the server's ack?
    return 1 if defined($fromsz) && !-e $from &&           # $from disappeared
                (($tosz2,$tomt2) = (stat($to))[7,9]) &&    # $to's there
                  ((!defined $tosz1) ||			   #  not before or
		   ($tosz1 != $tosz2 or $tomt1 != $tomt2)) &&  #   was changed
                $tosz2 == $fromsz;                         # it's all there

    ($tosz1,$tomt1) = (stat($to))[7,9];  # just in case rename did something

    {
        local $@;
        eval {
            local $SIG{__DIE__};
            copy($from,$to) or die;
            my($atime, $mtime) = (stat($from))[8,9];
            utime($atime, $mtime, $to);
            unlink($from)   or die;
        };
        return 1 unless $@;
    }
    ($sts,$ossts) = ($! + 0, $^E + 0);

    ($tosz2,$tomt2) = ((stat($to))[7,9],0,0) if defined $tomt1;
    unlink($to) if !defined($tomt1) or $tomt1 != $tomt2 or $tosz1 != $tosz2;
    ($!,$^E) = ($sts,$ossts);
    return 0;
}

*cp = \&copy;
*mv = \&move;

# &syscopy is an XSUB under OS/2
unless (defined &syscopy) {
    if ($^O eq 'VMS') {
	*syscopy = \&rmscopy;
    } elsif ($^O eq 'mpeix') {
	*syscopy = sub {
	    return 0 unless @_ == 2;
	    # Use the MPE cp program in order to
	    # preserve MPE file attributes.
	    return system('/bin/cp', '-f', $_[0], $_[1]) == 0;
	};
    } elsif ($^O eq 'MSWin32' && defined &DynaLoader::boot_DynaLoader) {
	# Win32::CopyFile() fill only work if we can load Win32.xs
	*syscopy = sub {
	    return 0 unless @_ == 2;
	    return Win32::CopyFile(@_, 1);
	};
    } elsif ($macfiles) {
	*syscopy = sub {
	    my($from, $to) = @_;
	    my($dir, $toname);

	    return 0 unless -e $from;

	    if ($to =~ /(.*:)([^:]+):?$/) {
		($dir, $toname) = ($1, $2);
	    } else {
		($dir, $toname) = (":", $to);
	    }

	    unlink($to);
	    Mac::MoreFiles::FSpFileCopy($from, $dir, $toname, 1);
	};
    } else {
	$Syscopy_is_copy = 1;
	*syscopy = \&copy;
    }
}

1;

__END__

=head1 NAME

File::Copy - Copy files or filehandles

=head1 SYNOPSIS

	use File::Copy;

	copy("file1","file2") or die "Copy failed: $!";
	copy("Copy.pm",\*STDOUT);
	move("/dev1/fileA","/dev2/fileB");

	use File::Copy "cp";

	$n = FileHandle->new("/a/file","r");
	cp($n,"x");

=head1 DESCRIPTION

The File::Copy module provides two basic functions, C<copy> and
C<move>, which are useful for getting the contents of a file from
one place to another.

=over 4

=item copy
X<copy> X<cp>

The C<copy> function takes two
parameters: a file to copy from and a file to copy to. Either
argument may be a string, a FileHandle reference or a FileHandle
glob. Obviously, if the first argument is a filehandle of some
sort, it will be read from, and if it is a file I<name> it will
be opened for reading. Likewise, the second argument will be
written to (and created if need be).  Trying to copy a file on top
of itself is a fatal error.

B<Note that passing in
files as handles instead of names may lead to loss of information
on some operating systems; it is recommended that you use file
names whenever possible.>  Files are opened in binary mode where
applicable.  To get a consistent behaviour when copying from a
filehandle to a file, use C<binmode> on the filehandle.

An optional third parameter can be used to specify the buffer
size used for copying. This is the number of bytes from the
first file, that will be held in memory at any given time, before
being written to the second file. The default buffer size depends
upon the file, but will generally be the whole file (up to 2MB), or
1k for filehandles that do not reference files (eg. sockets).

You may use the syntax C<use File::Copy "cp"> to get at the
"cp" alias for this function. The syntax is I<exactly> the same.

As of version 2.13, on UNIX systems, "copy" will preserve permission
bits like the shell utility C<cp> would do.

=item move
X<move> X<mv> X<rename>

The C<move> function also takes two parameters: the current name
and the intended name of the file to be moved.  If the destination
already exists and is a directory, and the source is not a
directory, then the source file will be renamed into the directory
specified by the destination.

If possible, move() will simply rename the file.  Otherwise, it copies
the file to the new location and deletes the original.  If an error occurs
during this copy-and-delete process, you may be left with a (possibly partial)
copy of the file under the destination name.

You may use the "mv" alias for this function in the same way that
you may use the "cp" alias for C<copy>.

=item syscopy
X<syscopy>

File::Copy also provides the C<syscopy> routine, which copies the
file specified in the first parameter to the file specified in the
second parameter, preserving OS-specific attributes and file
structure.  For Unix systems, this is equivalent to the simple
C<copy> routine, which doesn't preserve OS-specific attributes.  For
VMS systems, this calls the C<rmscopy> routine (see below).  For OS/2
systems, this calls the C<syscopy> XSUB directly. For Win32 systems,
this calls C<Win32::CopyFile>.

On Mac OS (Classic), C<syscopy> calls C<Mac::MoreFiles::FSpFileCopy>,
if available.

B<Special behaviour if C<syscopy> is defined (OS/2, VMS and Win32)>:

If both arguments to C<copy> are not file handles,
then C<copy> will perform a "system copy" of
the input file to a new output file, in order to preserve file
attributes, indexed file structure, I<etc.>  The buffer size
parameter is ignored.  If either argument to C<copy> is a
handle to an opened file, then data is copied using Perl
operators, and no effort is made to preserve file attributes
or record structure.

The system copy routine may also be called directly under VMS and OS/2
as C<File::Copy::syscopy> (or under VMS as C<File::Copy::rmscopy>, which
is the routine that does the actual work for syscopy).

=item rmscopy($from,$to[,$date_flag])
X<rmscopy>

The first and second arguments may be strings, typeglobs, typeglob
references, or objects inheriting from IO::Handle;
they are used in all cases to obtain the
I<filespec> of the input and output files, respectively.  The
name and type of the input file are used as defaults for the
output file, if necessary.

A new version of the output file is always created, which
inherits the structure and RMS attributes of the input file,
except for owner and protections (and possibly timestamps;
see below).  All data from the input file is copied to the
output file; if either of the first two parameters to C<rmscopy>
is a file handle, its position is unchanged.  (Note that this
means a file handle pointing to the output file will be
associated with an old version of that file after C<rmscopy>
returns, not the newly created version.)

The third parameter is an integer flag, which tells C<rmscopy>
how to handle timestamps.  If it is E<lt> 0, none of the input file's
timestamps are propagated to the output file.  If it is E<gt> 0, then
it is interpreted as a bitmask: if bit 0 (the LSB) is set, then
timestamps other than the revision date are propagated; if bit 1
is set, the revision date is propagated.  If the third parameter
to C<rmscopy> is 0, then it behaves much like the DCL COPY command:
if the name or type of the output file was explicitly specified,
then no timestamps are propagated, but if they were taken implicitly
from the input filespec, then all timestamps other than the
revision date are propagated.  If this parameter is not supplied,
it defaults to 0.

Like C<copy>, C<rmscopy> returns 1 on success.  If an error occurs,
it sets C<$!>, deletes the output file, and returns 0.

=back

=head1 RETURN

All functions return 1 on success, 0 on failure.
$! will be set if an error was encountered.

=head1 NOTES

=over 4

=item *

On Mac OS (Classic), the path separator is ':', not '/', and the 
current directory is denoted as ':', not '.'. You should be careful 
about specifying relative pathnames. While a full path always begins 
with a volume name, a relative pathname should always begin with a 
':'.  If specifying a volume name only, a trailing ':' is required.

E.g.

  copy("file1", "tmp");        # creates the file 'tmp' in the current directory
  copy("file1", ":tmp:");      # creates :tmp:file1
  copy("file1", ":tmp");       # same as above
  copy("file1", "tmp");        # same as above, if 'tmp' is a directory (but don't do
                               # that, since it may cause confusion, see example #1)
  copy("file1", "tmp:file1");  # error, since 'tmp:' is not a volume
  copy("file1", ":tmp:file1"); # ok, partial path
  copy("file1", "DataHD:");    # creates DataHD:file1

  move("MacintoshHD:fileA", "DataHD:fileB"); # moves (doesn't copy) files from one
                                             # volume to another

=back

=head1 AUTHOR

File::Copy was written by Aaron Sherman I<E<lt>ajs@ajs.comE<gt>> in 1995,
and updated by Charles Bailey I<E<lt>bailey@newman.upenn.eduE<gt>> in 1996.

=cut
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
71be2cbc	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;
91ca337e	15	# During perl build, we need File::Copy but Fcntl might not be built yet
91ca337e	16	my $Fcntl_loaded = eval q{ use Fcntl qw [O_CREAT O_WRONLY O_TRUNC]; 1 };
17f410f9	17	our(@ISA, @EXPORT, @EXPORT_OK, $VERSION, $Too_Big, $Syscopy_is_copy);
	18	sub copy;
	19	sub syscopy;
	20	sub cp;
	21	sub mv;
71be2cbc	22
9c76cba2	23	$VERSION = '2.13';
f716a1dd	24
71be2cbc	25	require Exporter;
	26	@ISA = qw(Exporter);
	27	@EXPORT = qw(copy move);
	28	@EXPORT_OK = qw(cp mv);
f716a1dd	29
441496b2	30	$Too_Big = 1024 * 1024 * 2;
f716a1dd	31
8878f897	32	sub croak {
	33	require Carp;
	34	goto &Carp::croak;
	35	}
	36
754f2cd0	37	sub carp {
	38	require Carp;
	39	goto &Carp::carp;
	40	}
	41
bcdb689b	42	my $macfiles;
	43	if ($^O eq 'MacOS') {
	44	$macfiles = eval { require Mac::MoreFiles };
	45	warn 'Mac::MoreFiles could not be loaded; using non-native syscopy'
3a2263fe	46	if $@ && $^W;
bcdb689b	47	}
bcdb689b	48
6c254d95	49	sub _catname {
71be2cbc	50	my($from, $to) = @_;
	51	if (not defined &basename) {
	52	require File::Basename;
	53	import File::Basename 'basename';
	54	}
6c254d95	55
	56	if ($^O eq 'MacOS') {
	57	# a partial dir name that's valid only in the cwd (e.g. 'tmp')
	58	$to = ':' . $to if $to !~ /:/;
	59	}
	60
	61	return File::Spec->catfile($to, basename($from));
f716a1dd	62	}
f716a1dd	63
236a0738	64	# _eq($from, $to) tells whether $from and $to are identical
	65	# works for strings and references
	66	sub _eq {
	67	return $_[0] == $_[1] if ref $_[0] && ref $_[1];
	68	return $_[0] eq $_[1] if !ref $_[0] && !ref $_[1];
	69	return "";
	70	}
	71
f716a1dd	72	sub copy {
71be2cbc	73	croak("Usage: copy(FROM, TO [, BUFFERSIZE]) ")
f716a1dd	74	unless(@_ == 2 \|\| @_ == 3);
	75
	76	my $from = shift;
	77	my $to = shift;
71be2cbc	78
671637fe	79	my $size;
	80	if (@_) {
	81	$size = shift(@_) + 0;
	82	croak("Bad buffer size for copy: $size\n") unless ($size > 0);
	83	}
	84
71be2cbc	85	my $from_a_handle = (ref($from)
71be2cbc	86	? (ref($from) eq 'GLOB'
d704f39a	87	\|\| UNIVERSAL::isa($from, 'GLOB')
d704f39a	88	\|\| UNIVERSAL::isa($from, 'IO::Handle'))
71be2cbc	89	: (ref(\$from) eq 'GLOB'));
	90	my $to_a_handle = (ref($to)
	91	? (ref($to) eq 'GLOB'
d704f39a	92	\|\| UNIVERSAL::isa($to, 'GLOB')
d704f39a	93	\|\| UNIVERSAL::isa($to, 'IO::Handle'))
71be2cbc	94	: (ref(\$to) eq 'GLOB'));
71be2cbc	95
236a0738	96	if (_eq($from, $to)) { # works for references, too
754f2cd0	97	carp("'$from' and '$to' are identical (not copied)");
	98	# The "copy" was a success as the source and destination contain
	99	# the same data.
	100	return 1;
96a91e01	101	}
96a91e01	102
ac7b122d	103	if ((($Config{d_symlink} && $Config{d_readlink}) \|\| $Config{d_link}) &&
4c38808d	104	!($^O eq 'MSWin32' \|\| $^O eq 'os2')) {
ac7b122d	105	my @fs = stat($from);
ac7b122d	106	if (@fs) {
96a91e01	107	my @ts = stat($to);
ac7b122d	108	if (@ts && $fs[0] == $ts[0] && $fs[1] == $ts[1]) {
754f2cd0	109	carp("'$from' and '$to' are identical (not copied)");
754f2cd0	110	return 0;
96a91e01	111	}
	112	}
	113	}
	114
71be2cbc	115	if (!$from_a_handle && !$to_a_handle && -d $to && ! -d $from) {
	116	$to = _catname($from, $to);
	117	}
	118
1a04d035	119	if (defined &syscopy && !$Syscopy_is_copy
e6434134	120	&& !$to_a_handle
1d84e8df	121	&& !($from_a_handle && $^O eq 'os2' ) # OS/2 cannot handle handles
1d84e8df	122	&& !($from_a_handle && $^O eq 'mpeix') # and neither can MPE/iX.
7509b657	123	&& !($from_a_handle && $^O eq 'MSWin32')
fa648be5	124	&& !($from_a_handle && $^O eq 'MacOS')
2986a63f	125	&& !($from_a_handle && $^O eq 'NetWare')
1a04d035	126	)
71be2cbc	127	{
4c38808d	128	my $copy_to = $to;
	129
	130	if ($^O eq 'VMS' && -e $from) {
	131
	132	if (! -d $to && ! -d $from) {
	133
	134	# VMS has sticky defaults on extensions, which means that
	135	# if there is a null extension on the destination file, it
	136	# will inherit the extension of the source file
	137	# So add a '.' for a null extension.
	138
	139	$copy_to = VMS::Filespec::vmsify($to);
	140	my ($vol, $dirs, $file) = File::Spec->splitpath($copy_to);
	141	$file = $file . '.' unless ($file =~ /(?<!\^)\./);
	142	$copy_to = File::Spec->catpath($vol, $dirs, $file);
	143
	144	# Get rid of the old versions to be like UNIX
	145	1 while unlink $copy_to;
	146	}
	147	}
	148
	149	return syscopy($from, $copy_to);
71be2cbc	150	}
	151
	152	my $closefrom = 0;
	153	my $closeto = 0;
671637fe	154	my ($status, $r, $buf);
48a5c399	155	local($\) = '';
f716a1dd	156
23ba2776	157	my $from_h;
71be2cbc	158	if ($from_a_handle) {
23ba2776	159	$from_h = $from;
f716a1dd	160	} else {
cfa308ca	161	open $from_h, "<", $from or goto fail_open1;
23ba2776	162	binmode $from_h or die "($!,$^E)";
f716a1dd	163	$closefrom = 1;
1a04d035	164	}
1a04d035	165
671637fe	166	# Seems most logical to do this here, in case future changes would want to
	167	# make this croak for some reason.
	168	unless (defined $size) {
	169	$size = tied(*$from_h) ? 0 : -s $from_h \|\| 0;
	170	$size = 1024 if ($size < 512);
	171	$size = $Too_Big if ($size > $Too_Big);
	172	}
	173
23ba2776	174	my $to_h;
71be2cbc	175	if ($to_a_handle) {
23ba2776	176	$to_h = $to;
1a04d035	177	} else {
fa648be5	178	$to = _protect($to) if $to =~ /^\s/s;
91ca337e	179	if ($Fcntl_loaded) {
	180	my $perm = (stat $from_h) [2] & 0xFFF;
	181	sysopen $to_h, $to, O_CREAT() \| O_TRUNC() \| O_WRONLY(), $perm
	182	or goto fail_open2;
	183	}
	184	else {
	185	$to_h = \do { local *FH };
	186	open $to_h, ">", $to or goto fail_open2;
	187	}
	188	binmode $to_h or die "($!,$^E)";
71be2cbc	189	$closeto = 1;
1a04d035	190	}
f716a1dd	191
71be2cbc	192	$! = 0;
	193	for (;;) {
	194	my ($r, $w, $t);
23ba2776	195	defined($r = sysread($from_h, $buf, $size))
71be2cbc	196	or goto fail_inner;
	197	last unless $r;
	198	for ($w = 0; $w < $r; $w += $t) {
23ba2776	199	$t = syswrite($to_h, $buf, $r - $w, $w)
71be2cbc	200	or goto fail_inner;
f716a1dd	201	}
f716a1dd	202	}
71be2cbc	203
23ba2776	204	close($to_h) \|\| goto fail_open2 if $closeto;
23ba2776	205	close($from_h) \|\| goto fail_open1 if $closefrom;
71be2cbc	206
48a5c399	207	# Use this idiom to avoid uninitialized value warning.
f716a1dd	208	return 1;
1a04d035	209
f716a1dd	210	# All of these contortions try to preserve error messages...
	211	fail_inner:
	212	if ($closeto) {
	213	$status = $!;
	214	$! = 0;
23ba2776	215	close $to_h;
f716a1dd	216	$! = $status unless $!;
	217	}
	218	fail_open2:
	219	if ($closefrom) {
	220	$status = $!;
	221	$! = 0;
23ba2776	222	close $from_h;
f716a1dd	223	$! = $status unless $!;
	224	}
	225	fail_open1:
f716a1dd	226	return 0;
f716a1dd	227	}
9b957b78	228
441496b2	229	sub move {
754f2cd0	230	croak("Usage: move(FROM, TO) ") unless @_ == 2;
754f2cd0	231
71be2cbc	232	my($from,$to) = @_;
754f2cd0	233
fa76202e	234	my($fromsz,$tosz1,$tomt1,$tosz2,$tomt2,$sts,$ossts);
441496b2	235
71be2cbc	236	if (-d $to && ! -d $from) {
	237	$to = _catname($from, $to);
	238	}
	239
	240	($tosz1,$tomt1) = (stat($to))[7,9];
	241	$fromsz = -s $from;
e6434134	242	if ($^O eq 'os2' and defined $tosz1 and defined $fromsz) {
	243	# will not rename with overwrite
	244	unlink $to;
	245	}
4c38808d	246
	247	my $rename_to = $to;
	248	if (-$^O eq 'VMS' && -e $from) {
	249
	250	if (! -d $to && ! -d $from) {
	251	# VMS has sticky defaults on extensions, which means that
	252	# if there is a null extension on the destination file, it
	253	# will inherit the extension of the source file
	254	# So add a '.' for a null extension.
	255
	256	$rename_to = VMS::Filespec::vmsify($to);
	257	my ($vol, $dirs, $file) = File::Spec->splitpath($rename_to);
	258	$file = $file . '.' unless ($file =~ /(?<!\^)\./);
	259	$rename_to = File::Spec->catpath($vol, $dirs, $file);
	260
	261	# Get rid of the old versions to be like UNIX
	262	1 while unlink $rename_to;
	263	}
	264	}
	265
	266	return 1 if rename $from, $rename_to;
71be2cbc	267
71be2cbc	268	# Did rename return an error even though it succeeded, because $to
	269	# is on a remote NFS file system, and NFS lost the server's ack?
	270	return 1 if defined($fromsz) && !-e $from && # $from disappeared
	271	(($tosz2,$tomt2) = (stat($to))[7,9]) && # $to's there
c9fbd0c8	272	((!defined $tosz1) \|\| # not before or
c9fbd0c8	273	($tosz1 != $tosz2 or $tomt1 != $tomt2)) && # was changed
71be2cbc	274	$tosz2 == $fromsz; # it's all there
1a04d035	275
71be2cbc	276	($tosz1,$tomt1) = (stat($to))[7,9]; # just in case rename did something
762548ba	277
	278	{
	279	local $@;
	280	eval {
754f2cd0	281	local $SIG{__DIE__};
762548ba	282	copy($from,$to) or die;
	283	my($atime, $mtime) = (stat($from))[8,9];
	284	utime($atime, $mtime, $to);
	285	unlink($from) or die;
	286	};
	287	return 1 unless $@;
	288	}
fa76202e	289	($sts,$ossts) = ($! + 0, $^E + 0);
1a04d035	290
71be2cbc	291	($tosz2,$tomt2) = ((stat($to))[7,9],0,0) if defined $tomt1;
	292	unlink($to) if !defined($tomt1) or $tomt1 != $tomt2 or $tosz1 != $tosz2;
	293	($!,$^E) = ($sts,$ossts);
	294	return 0;
441496b2	295	}
9b957b78	296
71be2cbc	297	*cp = \©
	298	*mv = \&move;
	299
9b957b78	300	# &syscopy is an XSUB under OS/2
1d84e8df	301	unless (defined &syscopy) {
	302	if ($^O eq 'VMS') {
	303	*syscopy = \&rmscopy;
	304	} elsif ($^O eq 'mpeix') {
	305	*syscopy = sub {
3f5ee302	306	return 0 unless @_ == 2;
1d84e8df	307	# Use the MPE cp program in order to
	308	# preserve MPE file attributes.
	309	return system('/bin/cp', '-f', $_[0], $_[1]) == 0;
	310	};
cf2f24a4	311	} elsif ($^O eq 'MSWin32' && defined &DynaLoader::boot_DynaLoader) {
cf2f24a4	312	# Win32::CopyFile() fill only work if we can load Win32.xs
7509b657	313	*syscopy = sub {
	314	return 0 unless @_ == 2;
	315	return Win32::CopyFile(@_, 1);
	316	};
bcdb689b	317	} elsif ($macfiles) {
fa648be5	318	*syscopy = sub {
	319	my($from, $to) = @_;
	320	my($dir, $toname);
	321
	322	return 0 unless -e $from;
	323
	324	if ($to =~ /(.*:)([^:]+):?$/) {
	325	($dir, $toname) = ($1, $2);
	326	} else {
	327	($dir, $toname) = (":", $to);
	328	}
	329
	330	unlink($to);
	331	Mac::MoreFiles::FSpFileCopy($from, $dir, $toname, 1);
	332	};
1d84e8df	333	} else {
1a04d035	334	$Syscopy_is_copy = 1;
1d84e8df	335	*syscopy = \©
	336	}
	337	}
f716a1dd	338
	339	1;
	340
	341	__END__
a5f75d66	342
f716a1dd	343	=head1 NAME
	344
	345	File::Copy - Copy files or filehandles
	346
a5f75d66	347	=head1 SYNOPSIS
f716a1dd	348
5ce10329	349	use File::Copy;
f716a1dd	350
5ce10329	351	copy("file1","file2") or die "Copy failed: $!";
5ce10329	352	copy("Copy.pm",\*STDOUT);
441496b2	353	move("/dev1/fileA","/dev2/fileB");
f716a1dd	354
78e38bb6	355	use File::Copy "cp";
f716a1dd	356
23f3aea0	357	$n = FileHandle->new("/a/file","r");
c6dfe06b	358	cp($n,"x");
f716a1dd	359
	360	=head1 DESCRIPTION
	361
441496b2	362	The File::Copy module provides two basic functions, C<copy> and
	363	C<move>, which are useful for getting the contents of a file from
	364	one place to another.
	365
	366	=over 4
	367
0cdecedb	368	=item copy
0cdecedb	369	X<copy> X<cp>
441496b2	370
441496b2	371	The C<copy> function takes two
f716a1dd	372	parameters: a file to copy from and a file to copy to. Either
	373	argument may be a string, a FileHandle reference or a FileHandle
	374	glob. Obviously, if the first argument is a filehandle of some
	375	sort, it will be read from, and if it is a file I<name> it will
	376	be opened for reading. Likewise, the second argument will be
96a91e01	377	written to (and created if need be). Trying to copy a file on top
96a91e01	378	of itself is a fatal error.
71be2cbc	379
71be2cbc	380	B<Note that passing in
9b957b78	381	files as handles instead of names may lead to loss of information
9b957b78	382	on some operating systems; it is recommended that you use file
e6434134	383	names whenever possible.> Files are opened in binary mode where
8dcee03e	384	applicable. To get a consistent behaviour when copying from a
e6434134	385	filehandle to a file, use C<binmode> on the filehandle.
f716a1dd	386
	387	An optional third parameter can be used to specify the buffer
	388	size used for copying. This is the number of bytes from the
3a964d77	389	first file, that will be held in memory at any given time, before
f716a1dd	390	being written to the second file. The default buffer size depends
338de517	391	upon the file, but will generally be the whole file (up to 2MB), or
f716a1dd	392	1k for filehandles that do not reference files (eg. sockets).
	393
	394	You may use the syntax C<use File::Copy "cp"> to get at the
	395	"cp" alias for this function. The syntax is I<exactly> the same.
	396
9c76cba2	397	As of version 2.13, on UNIX systems, "copy" will preserve permission
	398	bits like the shell utility C<cp> would do.
	399
0cdecedb	400	=item move
0cdecedb	401	X<move> X<mv> X<rename>
441496b2	402
441496b2	403	The C<move> function also takes two parameters: the current name
71be2cbc	404	and the intended name of the file to be moved. If the destination
	405	already exists and is a directory, and the source is not a
	406	directory, then the source file will be renamed into the directory
	407	specified by the destination.
	408
	409	If possible, move() will simply rename the file. Otherwise, it copies
	410	the file to the new location and deletes the original. If an error occurs
	411	during this copy-and-delete process, you may be left with a (possibly partial)
441496b2	412	copy of the file under the destination name.
	413
	414	You may use the "mv" alias for this function in the same way that
	415	you may use the "cp" alias for C<copy>.
	416
0cdecedb	417	=item syscopy
0cdecedb	418	X<syscopy>
441496b2	419
9b957b78	420	File::Copy also provides the C<syscopy> routine, which copies the
	421	file specified in the first parameter to the file specified in the
	422	second parameter, preserving OS-specific attributes and file
	423	structure. For Unix systems, this is equivalent to the simple
f1442e8b	424	C<copy> routine, which doesn't preserve OS-specific attributes. For
	425	VMS systems, this calls the C<rmscopy> routine (see below). For OS/2
	426	systems, this calls the C<syscopy> XSUB directly. For Win32 systems,
	427	this calls C<Win32::CopyFile>.
9b957b78	428
bcdb689b	429	On Mac OS (Classic), C<syscopy> calls C<Mac::MoreFiles::FSpFileCopy>,
	430	if available.
	431
338de517	432	B<Special behaviour if C<syscopy> is defined (OS/2, VMS and Win32)>:
9b957b78	433
71be2cbc	434	If both arguments to C<copy> are not file handles,
71be2cbc	435	then C<copy> will perform a "system copy" of
9b957b78	436	the input file to a new output file, in order to preserve file
9b957b78	437	attributes, indexed file structure, I<etc.> The buffer size
71be2cbc	438	parameter is ignored. If either argument to C<copy> is a
71be2cbc	439	handle to an opened file, then data is copied using Perl
9b957b78	440	operators, and no effort is made to preserve file attributes
	441	or record structure.
	442
55497cff	443	The system copy routine may also be called directly under VMS and OS/2
55497cff	444	as C<File::Copy::syscopy> (or under VMS as C<File::Copy::rmscopy>, which
71be2cbc	445	is the routine that does the actual work for syscopy).
9b957b78	446
9b957b78	447	=item rmscopy($from,$to[,$date_flag])
0cdecedb	448	X<rmscopy>
9b957b78	449
71be2cbc	450	The first and second arguments may be strings, typeglobs, typeglob
	451	references, or objects inheriting from IO::Handle;
	452	they are used in all cases to obtain the
9b957b78	453	I<filespec> of the input and output files, respectively. The
	454	name and type of the input file are used as defaults for the
	455	output file, if necessary.
	456
	457	A new version of the output file is always created, which
	458	inherits the structure and RMS attributes of the input file,
	459	except for owner and protections (and possibly timestamps;
	460	see below). All data from the input file is copied to the
	461	output file; if either of the first two parameters to C<rmscopy>
	462	is a file handle, its position is unchanged. (Note that this
	463	means a file handle pointing to the output file will be
	464	associated with an old version of that file after C<rmscopy>
	465	returns, not the newly created version.)
	466
	467	The third parameter is an integer flag, which tells C<rmscopy>
1fef88e7	468	how to handle timestamps. If it is E<lt> 0, none of the input file's
1fef88e7	469	timestamps are propagated to the output file. If it is E<gt> 0, then
9b957b78	470	it is interpreted as a bitmask: if bit 0 (the LSB) is set, then
	471	timestamps other than the revision date are propagated; if bit 1
	472	is set, the revision date is propagated. If the third parameter
	473	to C<rmscopy> is 0, then it behaves much like the DCL COPY command:
	474	if the name or type of the output file was explicitly specified,
	475	then no timestamps are propagated, but if they were taken implicitly
	476	from the input filespec, then all timestamps other than the
	477	revision date are propagated. If this parameter is not supplied,
	478	it defaults to 0.
	479
	480	Like C<copy>, C<rmscopy> returns 1 on success. If an error occurs,
	481	it sets C<$!>, deletes the output file, and returns 0.
	482
55497cff	483	=back
55497cff	484
f716a1dd	485	=head1 RETURN
f716a1dd	486
441496b2	487	All functions return 1 on success, 0 on failure.
441496b2	488	$! will be set if an error was encountered.
f716a1dd	489
6c254d95	490	=head1 NOTES
	491
	492	=over 4
	493
	494	=item *
	495
	496	On Mac OS (Classic), the path separator is ':', not '/', and the
	497	current directory is denoted as ':', not '.'. You should be careful
	498	about specifying relative pathnames. While a full path always begins
	499	with a volume name, a relative pathname should always begin with a
	500	':'. If specifying a volume name only, a trailing ':' is required.
	501
	502	E.g.
	503
	504	copy("file1", "tmp"); # creates the file 'tmp' in the current directory
	505	copy("file1", ":tmp:"); # creates :tmp:file1
	506	copy("file1", ":tmp"); # same as above
0cdecedb	507	copy("file1", "tmp"); # same as above, if 'tmp' is a directory (but don't do
6c254d95	508	# that, since it may cause confusion, see example #1)
	509	copy("file1", "tmp:file1"); # error, since 'tmp:' is not a volume
	510	copy("file1", ":tmp:file1"); # ok, partial path
	511	copy("file1", "DataHD:"); # creates DataHD:file1
0cdecedb	512
907fbfa1	513	move("MacintoshHD:fileA", "DataHD:fileB"); # moves (doesn't copy) files from one
6c254d95	514	# volume to another
	515
	516	=back
	517
f716a1dd	518	=head1 AUTHOR
f716a1dd	519
441496b2	520	File::Copy was written by Aaron Sherman I<E<lt>ajs@ajs.comE<gt>> in 1995,
bd3fa61c	521	and updated by Charles Bailey I<E<lt>bailey@newman.upenn.eduE<gt>> in 1996.
f716a1dd	522
f716a1dd	523	=cut
441496b2	524