File: Downloader.pm

package info (click to toggle)
libcsaf-perl 0.26-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 2,280 kB
  • sloc: perl: 7,583; makefile: 2
file content (148 lines) | stat: -rw-r--r-- 3,141 bytes parent folder | download
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
package CSAF::Options::Downloader;

use 5.010001;
use strict;
use warnings;
use utf8;

use CSAF::Util qw(parse_datetime);

use Moo;
with 'CSAF::Util::Options';

use constant TRUE  => !!1;
use constant FALSE => !!0;

has directory => (
    is      => 'rw',
    default => '.',
    coerce  => sub { my $dir = $_[0]; $dir =~ s{\$}{}; return $dir },
    isa     => sub { Carp::croak 'Unknown directory' unless -e -d $_[0] }
);

has exclude_pattern => (is => 'rw', default => FALSE);
has include_pattern => (is => 'rw', default => FALSE);

has validate        => (is => 'rw', default => FALSE);
has integrity_check => (is => 'rw', default => FALSE);
has signature_check => (is => 'rw', default => FALSE);

has parallel_downloads =>
    (is => 'rw', default => 4, isa => sub { Carp::croak "$_[0] is not a number" unless $_[0] =~ /^\d+$/ });

# TODO
has timeout_after_download =>
    (is => 'rw' => default => 0, isa => sub { Carp::croak "$_[0] is not a number" unless $_[0] =~ /^\d+$/ });

has url      => (is => 'rw');
has insecure => (is => 'rw', default => FALSE);

has after_date => (
    is     => 'rw',
    coerce => \&parse_datetime,
    isa    => sub { Carp::croak 'MUST BE an instance of "Time::Piece"' unless ref($_[0]) eq 'Time::Piece' }
);

has before_date => (
    is     => 'rw',
    coerce => \&parse_datetime,
    isa    => sub { Carp::croak 'MUST BE an instance of "Time::Piece"' unless ref($_[0]) eq 'Time::Piece' }
);

1;

__END__

=encoding utf-8

=head1 NAME

CSAF::Options::Downloader - CSAF::Downloader configurator

=head1 SYNOPSIS

    use CSAF::Options::Downloader;
    my $options = CSAF::Options::Downloader->new( );

    $options->configure(
        url             => 'https://security.acme.tld/advisories/csaf/index.txt',
        insecure        => 1,
        directory       => './csaf-acme-advisories',
        include_pattern => qr{acme-sa-2024-\d+\.json}
    );


=head1 DESCRIPTION

L<CSAF::Options::Downloader> is a configurator of L<CSAF::Downloader>.


=head2 METHODS

L<CSAF::Options::Downloader> inherits all methods from L<CSAF::Util::Options>.


=head2 ATTRIBUTES

=over

=item directory

=item exclude_pattern

=item include_pattern

=item insecure

=item integrity_check

=item parallel_downloads

=item signature_check

=item url

=item validate

=item after_date

=item before_date

=back


=head1 SUPPORT

=head2 Bugs / Feature Requests

Please report any bugs or feature requests through the issue tracker
at L<https://github.com/giterlizzi/perl-CSAF/issues>.
You will be notified automatically of any progress on your issue.

=head2 Source Code

This is open source software.  The code repository is available for
public review and contribution under the terms of the license.

L<https://github.com/giterlizzi/perl-CSAF>

    git clone https://github.com/giterlizzi/perl-CSAF.git


=head1 AUTHOR

=over 4

=item * Giuseppe Di Terlizzi <gdt@cpan.org>

=back


=head1 LICENSE AND COPYRIGHT

This software is copyright (c) 2023-2025 by Giuseppe Di Terlizzi.

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