File Coverage

blib/lib/Net/FTP/Rule.pm

Criterion	Covered	Total	%
statement	52	55	94.5
branch	6	12	50.0
condition			n/a
subroutine	14	16	87.5
pod	1	1	100.0
total	73	84	86.9

package Net::FTP::Rule;

# ABSTRACT: Iterative, recursive, FTP file finder

use 5.010;

use strict;
use warnings;
use Carp;

our $VERSION = '0.01'; # TRIAL

use Net::FTP;
use File::Spec::Functions qw[ splitpath ];

use parent 'Path::Iterator::Rule';

use Net::FTP::Rule::Dir;

use namespace::clean;

#pod =method new
#pod
#pod   $ftp = Net::FTP::Rule->new( [$host], %options );
#pod
#pod Open up a connection to an FTP host and log in.  The arguments
#pod are the same as for L, with the addition of two
#pod mandatory options,
#pod
#pod =over
#pod
#pod =item C
#pod
#pod The user name
#pod
#pod =item C
#pod
#pod The password
#pod
#pod =back
#pod
#pod =cut


sub new {

    my $class = shift;

    my %attr;
    if (@_ % 2) {
        my $host = shift;
        %attr  = @_;
        $attr{Host} = $host;
    }
    else {
        %attr = @_;
    }

    my $self = $class->SUPER::new();

    defined( my $host = delete $attr{Host} )
      or croak( "missing Host attribute\n" );

    defined( my $user = delete $attr{user} )
      or croak( "missing user attribute\n" );

    defined( my $password = delete $attr{password} )
      or croak( "missing password attribute\n" );

    $self->{server} = Net::FTP->new($host, %attr)
      or croak("unable to connect to server $host\n");

    $self->{server}->login( $user, $password )
      or croak("unable to log in to $host\n");

    return $self;
}

sub _defaults {
    return (
        _stringify      => 0,
        follow_symlinks => 1,
        depthfirst      => 0,
        sorted          => 1,
        loop_safe       => 0,
        error_handler   => sub { die sprintf( "%s: %s", @_ ) },
        visitor         => undef,
    );
}

sub _fast_defaults {

    return (
        _stringify      => 0,
        follow_symlinks => 1,
        depthfirst      => -1,
        sorted          => 0,
        loop_safe       => 0,
        error_handler   => undef,
        visitor         => undef,
    );
}

sub _objectify {

    my ( $self, $path ) = @_;

    my ( $volume, $directories, $name ) = splitpath($path);

    $directories =~ s{(.+)/$}{$1};

    my %attr = (
        parent  => $directories,
        name => $name,
        path => $path,
    );

    return Net::FTP::Rule::Dir->new( server => $self->{server}, %attr );
}

sub _children {

    my ( $self, $path ) = @_;

    return map { [ $_->{name}, $_ ] } $path->_children;
}

sub _iter {

    my $self     = shift;
    my $defaults = shift;

    $defaults->{loop_safe} = 0;

    $self->SUPER::_iter( $defaults, @_ );

}

1;

#
# This file is part of Net-FTP-Rule
#
# This software is Copyright (c) 2017 by Smithsonian Astrophysical Observatory.
#
# This is free software, licensed under:
#
#   The GNU General Public License, Version 3, June 2007
#

=pod

=head1 NAME

Net::FTP::Rule - Iterative, recursive, FTP file finder

=head1 VERSION

version 0.01

=head1 SYNOPSIS

    use Net::FTP::Rule;

    # connect to the FTP site
    my $ftp = Net::FTP::Rule->new( $ftp_site, $user, $password );

    # define a visitor callback routine. It will recieve a
    # Net::FTP::Rule::Entry object.
    sub visitor { my ($entry) = @_ }

    # use the Path::Iterator::Rule all() method to traverse the
    # site;
    $ftp->all( '/', \&visitor );

=head1 DESCRIPTION

B is a subclass of L which
iterates over an FTP site rather than a local filesystem.

See the documentation L for how to filter and
traverse paths.  When B passes a path to a callback or
returns one from an iterator, it will be in the form of a
L object.

B uses L to connect to the FTP site.

=head2 Symbolic Links

At present, B does not handle symbolic links. It will
output an error and skip them.

=head1 METHODS

=head2 new

  $ftp = Net::FTP::Rule->new( [$host], %options );

Open up a connection to an FTP host and log in.  The arguments
are the same as for L, with the addition of two
mandatory options,

=over

=item C

The user name

=item C

The password

=back

=head1 ATTRIBUTES

B subclasses L. It is a hash based object
and has the following additional attributes:

=over

=item C

The B object representing the connection to the FTP server.

=back

=head1 BUGS AND LIMITATIONS

You can make new bug reports, and view existing ones, through the
web interface at L.

=head1 AUTHOR

Diab Jerius

=head1 COPYRIGHT AND LICENSE

This software is Copyright (c) 2017 by Smithsonian Astrophysical Observatory.

This is free software, licensed under:

  The GNU General Public License, Version 3, June 2007

=cut

__END__