From Code to Community: Sponsoring The Perl and Raku Conference 2025 Learn more

THALJEF / Pinto-0.084_01 / lib / Pinto / Role / FileFetcher.pm 

            

              
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
—
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169

              
# ABSTRACT: Something that fetches remote files
package Pinto::Role::FileFetcher;
use Moose::Role;
use MooseX::MarkAsMethods (autoclean => 1);
use File::Temp;
use Path::Class;
use LWP::UserAgent;
use Pinto::Util qw(itis debug mtime throw);
#------------------------------------------------------------------------------
our $VERSION = '0.084_01'; # VERSION
#------------------------------------------------------------------------------
# Attributes
has ua => (
    is      => 'ro',
    isa     => 'LWP::UserAgent',
    builder => '_build_ua',
    lazy    => 1,
);
#------------------------------------------------------------------------------
sub fetch {
    my ($self, %args) = @_;
    my $from     = $args{from};
    my $from_uri = _make_uri($from);
    my $to       = itis($args{to}, 'Path::Class') ? $args{to} : file($args{to});
    debug("Skipping $from: already fetched to $to") and return 0 if -e $to;
    $to->parent->mkpath if not -e $to->parent;
    my $has_changed = $self->_fetch($from_uri, $to);
    return $has_changed;
}
#------------------------------------------------------------------------------
sub fetch_temporary {
    my ($self, %args) = @_;
    my $url  = URI->new($args{url})->canonical();
    my $path = Path::Class::file( $url->path() );
    return $path if $url->scheme() eq 'file';
    my $base     = $path->basename();
    my $tempdir  = File::Temp::tempdir(CLEANUP => 1);
    my $tempfile = Path::Class::file($tempdir, $base);
    $self->fetch(from => $url, to => $tempfile);
    return Path::Class::file($tempfile);
}
#------------------------------------------------------------------------------
sub _fetch {
    my ($self, $url, $to) = @_;
    debug("Fetching $url");
    my $result = eval { $self->ua->mirror($url, $to) }
        or throw $@;
    if ($result->is_success()) {
        return 1;
    }
    elsif ($result->code() == 304) {
        return 0;
    }
    else {
        throw "Failed to fetch $url: " . $result->status_line;
    }
    # Should never get here
}
#------------------------------------------------------------------------------
sub _build_ua {
    my ($self) = @_;
    # TODO: Do we need to make some of this configurable?
    my $agent = sprintf "%s/%s", ref $self, 'VERSION';
    my $ua = LWP::UserAgent->new( agent      => $agent,
                                  env_proxy  => 1,
                                  keep_alive => 5 );
    return $ua;
}
#------------------------------------------------------------------------------
sub _make_uri {
    my ($it) = @_;
    return $it
        if itis($it, 'URI');
    return URI::file->new( $it->absolute )
        if itis($it, 'Path::Class::File');
    return URI::file->new( file($it)->absolute )
        if -e $it;
    return URI->new($it);
}
#------------------------------------------------------------------------------
1;
__END__
=pod
=for :stopwords Jeffrey Ryan Thalhammer
=head1 NAME
Pinto::Role::FileFetcher - Something that fetches remote files
=head1 VERSION
version 0.084_01
=head1 METHODS
=head2 fetch(from => 'http://someplace' to => 'some/path')
Fetches the file located at C<from> to the file located at C<to>, if
the file at C<from> is newer than the file at C<to>.  If the
intervening directories do not exist, they will be created for you.
Returns a true value if the file has changed, returns false if it has
not changed.  Throws and exception if anything goes wrong.
The C<from> argument can be either a L<URI> or L<Path::Class::File>
object, or a string that represents either of those.  The C<to>
attribute can be a L<Path::Class::File> object or a string that
represents one.
=head2 fetch_temporary(url => 'http://someplace')
Fetches the file located at the C<url> to a file in a temporary
directory.  The file will have the same basename as the C<url>.
Returns a L<Path::Class::File> that points to the new file.  Throws
and exception if anything goes wrong.  Note the temporary directory
and all its contents will be deleted when the process terminates.
=head1 AUTHOR
Jeffrey Ryan Thalhammer <jeff@stratopan.com>
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2013 by Jeffrey Ryan Thalhammer.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=cut