B<File::Copy> - Provides the essential functions of the POSIX C<cp> command


TITLE

SYNOPSIS

code

=begin code
use File::Copy; # exports routine 'cp'
cp "/usr/share/fonts/", "/home/fonts"; # the trailing slash is not required
=end code


head

Exported function C<cp> copies files and directories from one location to another.
Its behavior is intended to be very similar to the POSIX C<cp> utility program.


If the C<$from> location is a directory, it and all its top-level files will
copied to the C<$to> location. A fatal error will be
thrown if C<$from> is a directory and C<$to> is a file.
If the recursive option (C<:r>) is used, all below the C<from> path
will be copied.


Errors will also be thrown if the permissions in either location are
not appropriate for the selected operation.


Existing files B<will> be overwritten unless the C<:createonly> option
is selected.


item

See an example Raku program using this module in the module package repository
at L<examples>.


This library is free software; you may redistribute it or modify it under the Artistic License 2.0.


root

para

L<Examples| file:../examples/index.podlite>


L<Download |file:../download/index.podlite>


React

=begin React :component<HeaderCol> :id<menu> 
=para L<Documentation|/doc/introduction>
=para L<Modules| /mods>
=para L<Examples| file:../examples/index.podlite>
=para L<Download |file:../download/index.podlite>
=para L<About|file:../about/index.podlite>
=para 🔍 K<⌘K>/K<ctrl-K>
=end React


HEADER

FOOTER

File::Copy - Provides the essential functions of the POSIX cp command


unit module File::Copy;

use File::Find;

#`{{

'cp' should act like *nix cp

Possible copy LHS (from), RHS (to) situations:

  Without :createonly

    LHS        RHS        RESULT
    ===        ===        ======
    from.f     to.f       copy from.f -> to.f
               !to.e      copy from.f -> to.f
               to.d       copy from.f -> to.d/from.f

    from.d     to.f       THROW
               to.d       mkdir to.d/from.d.basename
                          recursively copy from.d/* -> to.d/from.d.basename/*
               !to.e      mkdir to.d
                          recursively copy from.d/* -> to.d/*

    !from.e    Any        THROW

}}



B<cp> copies files and directories from one location to another.


If the C<$from> location is a directory, all files and directories
B<below> C<$from> will be copied to the C<$to> location. A fatal error
will be thrown (by the core) if C<$from> is a directory and C<$to> is a file.


Errors will also be thrown (by the core) if the permissions in either location are
not appropriate for the selected operation.


Existing files B<will> be overwritten unless the C<:c> (C<:createonly>) option
is selected.



my $debug = 0;

sub cp(IO() $from, 
       IO() $to, 
       Bool :createonly(:$c), 
       Bool :recursive(:$r), 
       Bool :interactive(:$i), 
       Bool :verbose(:$v),
       Bool :$debug,
      ) is export {
   
    # take care of the easy part first
    if $from.f and not $to.d {
        # the core should take care of this okay
        say "Copying file '$from' to file '$to'." if $v;
        my $createonly = $c ?? True !! False;
        $from.copy($to, :$createonly);
        return;
    }

    if $from.d and $to.f {
        # the core should fail on this
        $from.copy($to);
        return;
    }

    if $from.d and $to.d {
        # collect all files and dirs in $from and
        # transfer them as individual files, making
        # subdirs as needed in $to

        # must consider the options recurse, interactive, createonly, verbose
        my @frompaths;
        if not $r {
            note "Collecting paths (non-recursively) from directory '$from'." if $v;
            @frompaths = find :dir($from), :!recursive;
        }
        else {
            note "Collecting paths (recursively) from directory '$from'." if $v;
            @frompaths = find :dir($from);
        }

        # cycle through the paths and ensure all subdirs are created
        # in the new directory
        my $subpath;
        my $topath;
        PATH: for @frompaths -> $frompath {
            # transform the from path to the new path 
            $subpath = $frompath;
            $subpath ~~ s/$from\///;
            $topath = "$to/$subpath";

            #note "DEBUG: full path: |$path|";
            # say the subdir part;
            #note "DEBUG: subdir path: |$subdir|";
            #exit;

            if $r and $frompath.IO.d {
                # create the subdir in the $to directory
                say "Creating directory '$topath'." if $v;
                mkdir $topath;
            }
            else {
                say "Copying file '$frompath' to '$topath'." if $v;
                if $topath.IO.f {
                    if $c {
                        # createonly takes precedence
                        say "Skipping existing file '$topath'" if $v;
                        next PATH;
                    }
                    unless $i {
                        # overwrite is default
                        say "Overwriting existing file '$topath'" if $v;
                        copy $frompath, $topath;
                        next PATH;
                    } 
                    my $repeat = 1;
                    while $repeat {
                        my $res = prompt "Overwrite the existing file '$topath'(y/N)? ";
                        if $res ~~ /:i y/ {
                            say "Overwriting '$topath'...";
                            $repeat = 0;
                        }
                        elsif $res ~~ /:i n/ {
                            say "Skipping this file...";
                            next PATH;
                        }
                        else {
                            say "'$res' is an invalid response.";
                        }
                    }
                }
                copy $frompath, $topath;
            }
        }
        return
    }

    if $from.f and $to.d {
        my $topath = "$to/{$from.basename}";
        say "Copying file '$from' to directory '$to'." if $v;
        my $createonly = $c ?? True !! False;
        copy $from, $topath, :$createonly;
        return;
    }

    die q:to/HERE/;
        FATAL: Unexpected situation.
               Please file an issue with as much detail as possible.
        HERE
}

=finish

#| Copy a file to an existing directory
multi sub copy(IO::Path $from where {$from.e and $from.f},
               IO::Path $to is copy where {$to.e and $to.d},
               :$createonly,
               --> True
              ) is export {

    note "DEBUG-2: trying to copy file to a dir" if 1;

    my $topath = "{$to.absolute}/{$from.basename}".IO;
    copy $from.absolute, $topath, :$createonly;

    

# this doesn't work
    copy $from, "{$to}/{$from.basename}", :$createonly;


comment

    =begin comment
    # get the parent directory of the file
    my $dir = $from.dirname;
    # the basename, too
    my $f = $from.basename;
    my @fils;
    my @dirs;
    for $dir.IO.dir -> $p {
        if $p.d {
            next;
            #@dirs.push: $p;
        }
        else {
            @fils.push($p) if $p.Str eq $from.Str;
        }
    }
    for @fils -> $ff {
        note "    $ff" if $debug;
        copy $ff, "{$to}/{$ff.basename}";
    }
    =end comment


}

#| Copy a directory's files and directories to another directory
multi sub copy(IO::Path $from where {$from.e and $from.d},
               IO::Path $to where {$to.e and $to.d},
               :$createonly,
               --> True
              ) is export {

    note "DEBUG-3: trying to copy dir to a dir" if 1;

    

my $F = CPath.new: $from;
    $F.copy($to, :$createonly);



    if 1 or $debug {
        my $f = $from.d ?? "$from/" !! $from;
        my $t = $to.d ?? "$to/" !! $to;
        note "DEBUG: from: '$f'; to: '$t'";
    }

    # copy from a dir and its files to a dir:
    #   from/           to/
    #   from/a          to/a
    #   from/A/         to/A/
    #          b        to/A/b
    #          c        to/A/c
    #        D/         to/D/
    #          e        to/D/e

    # the recursive example from the docs:
    # search for routine 'dir'
    # important: use $ instead of @ for lazyness??
    #            see module IO::Dir for hints
    # important: ensure the starting dir path is absolute!!
    #   e.g.:
    #   sub MAIN($dir = '.'.IO.d.absolute) {
    #       my @todo = $dir.IO;
    #       while @todo {
    #           for @todo.pop.dir -> $path {
    #               say $path.Str;
    #               @todo.push: $path if $path.d;
    #           }
    #       }
    #   }

    my @fils;
    my @dirs;
    for $from.IO.dir -> $p {
        if $p.d {
            @dirs.push: $p;
        }
        else {
            @fils.push: $p;
        }
    }

    note "DEBUG: from dir: '$from'" if $debug;
    note "DEBUG: files:" if $debug;

    #| Copy all the files in $from first
    for @fils -> $f {
        note "    $f" if $debug;
        copy $f, "{$to}/{$f.basename}";
    }

    note "DEBUG: dirs:" if $debug;
    #| Then recursively copy the sub directories
    for @dirs -> $d {
        $*ERR.say: "debug: copy $d, {$to}/{$d.basename}" if $debug;
        my $todir = "{$to}/{$d.basename}";
        mkdir $todir;
        copy $d, "{$to}/{$d.basename}".IO;
    }
    #die "DEBUG exit" if $debug;

}

=finish

# for future use:
sub rename($from, $to, :$force, :$prompt) is export(:rename) {
    move($from, $to, :$force, :$prompt) is export(:move);
}
sub move($from, $to, :$force, :$prompt) is export(:move) {
}
sub rmdir($dir, :$force, :$prompt) is export(:rmdir) {
}


Copy

Image

README

The Raku Knowledge Base


=begin React :component<HeaderCol> :id<footer>  
=begin nested :!nested
=item1 B<Language>
    =item2 L<Get started|file:../getting-started/getting-started.podlite>
    =item2 L<Why Raku?|/doc/language/faq#Why-should-I-learn-Raku-What's-so-great-about-it>
    =item2 L<Try Raku|https://glot.io/new/raku>
    =item2 L<Raku cheat sheet|https://github.com/Raku/mu/blob/master/docs/Perl6/Cheatsheet/cheatsheet.txt>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<Raku on Exercism|https://exercism.org/tracks/raku>
    =item2 L<Wikipedia|https://en.wikipedia.org/wiki/Raku_(programming_language)>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=end nested
=begin nested :!nested

=item1 B<L<Documentation|/doc>>
    =item2 L<Getting started, Migration guides from other languages, & Tutorials | file:../doc/introduction.podlite>
    =item2 L<Language References|file:../doc/reference.podlite>
    =item2 L<Type Reference| file:../doc/types.podlite>
    =item2 L<Miscellaneous| file:../doc/miscellaneous.podlite>
    =item2 L<FAQs (Frequently Asked Questions)|/doc/language/faq>
    =item2 L<Community|/doc/language/community>
    =item2 L<The list of all documents|file:../doc/index.podlite>

=item1 B<Resources>
    =item2 L<The Raku Guide|https://raku.guide/>
    =item2 L<Books |https://perl6book.com/>
    =item2 L<Rosetta Code | https://www.raku.org/community/rosettacode>

=end nested
=begin nested :!nested

=item1 B<Resoures>
    =item2 L<Download | file:../download/index.podlite>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=item1 B<Learning>
    =item2 L<The Raku Guide|https://raku.guide/>
    =item2 L<Wikibook |https://en.wikibooks.org/wiki/Raku_Programming>
    =item2 L<Books |https://perl6book.com/>
    =item2 L<Rosetta Code | https://www.raku.org/community/rosettacode>
    =item2 L<Learn Raku in Y minutes|https://learnxinyminutes.com/docs/raku/>
    =item2 L<Golfing |https://github.com/AlexDaniel/raku-golf-cheatsheet>
=end nested
=begin nested :!nested

=item1 B<Explore>
    =item2 L<Raku Blog Aggregator|https://planet.raku.org/>
    =item2 L<Rakudo Weekly|https://rakudoweekly.blog/>
    =item2 L<The Weekly Challenge |https://perlweeklychallenge.org/>
    =item2 L<Raku Advent Calendar|https://raku-advent.blog/>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=end nested
=end React


=begin React :component<CookieConsent> :id<CookieConsent> :buttonCaption("Got it!")
=para
This website uses cookies for analytics.
=end React


File::Copy - Provides the essential functions of the POSIX cp command

SYNOPSIS

DESCRIPTION

AUTHOR

COPYRIGHT AND LICENSE

File::Copy v0.1.0

Authors

License

Dependencies

Test Dependencies

Provides

Documentation