summaryrefslogtreecommitdiffstats
path: root/lib/Lintian/Processable/Fields/Files.pm
blob: df213523b841f2a9c2d2307c0bdf484562f4692a (plain)
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
170
171
172
173
174
175
176
177
178
179
180
181
# -*- perl -*-
# Lintian::Processable::Fields::Files -- interface to .buildinfo file data collection
#
# Copyright (C) 2010 Adam D. Barratt
# Copyright (C) 2018 Chris Lamb
# Copyright (C) 2019-2020 Felix Lechner
#
# This program is free software; you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by the Free
# Software Foundation; either version 2 of the License, or (at your option)
# any later version.
#
# This program is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
# more details.
#
# You should have received a copy of the GNU General Public License along with
# this program.  If not, see <http://www.gnu.org/licenses/>.

package Lintian::Processable::Fields::Files;

use v5.20;
use warnings;
use utf8;

use Moo::Role;
use namespace::clean;

=head1 NAME

Lintian::Processable::Fields::Files - Lintian interface to .buildinfo or changes file data collection

=head1 SYNOPSIS

   use Moo;

   with 'Lintian::Processable::Fields::Files';

=head1 DESCRIPTION

Lintian::Processable::Fields::Files provides an interface to data for .buildinfo
and changes files.  It implements data collection methods specific to .buildinfo
and changes files.

=head1 INSTANCE METHODS

=over 4

=item files

Returns a reference to a hash containing information about files listed
in the .buildinfo file.  Each hash may have the following keys:

=over 4

=item name

Name of the file.

=item size

The size of the file in bytes.

=item section

The archive section to which the file belongs.

=item priority

The priority of the file.

=item checksums

A hash with the keys being checksum algorithms and the values themselves being
hashes containing

=over 4

=item sum

The result of applying the given algorithm to the file.

=item filesize

The size of the file as given in the .buildinfo section relating to the given
checksum.

=back

=back

=cut

has files => (
    is => 'rw',
    lazy => 1,
    default =>

      sub {
        my ($self) = @_;

        my %files;

        my @files_lines = split(/\n/, $self->fields->value('Files'));

        # trim both ends of each line
        s/^\s+|\s+$//g for @files_lines;

        for my $line (grep { length } @files_lines) {

            my @fields = split(/\s+/, $line);
            my $basename = $fields[-1];

            # ignore traversals
            next
              if $basename =~ m{/};

            my ($md5sum, $size, $section, $priority) = @fields;

            $files{$basename}{checksums}{Md5} = {
                'sum' => $md5sum,
                'filesize' => $size,
            };

            $files{$basename}{name} = $basename;
            $files{$basename}{size} = $size;

            unless ($self->type eq 'source') {

                $files{$basename}{section} = $section;
                $files{$basename}{priority} = $priority;
            }
        }

        for my $algorithm (qw(Sha1 Sha256)) {

            my @lines
              = split(/\n/, $self->fields->value("Checksums-$algorithm"));

            # trim both ends of each line
            s/^\s+|\s+$//g for @lines;

            for my $line (grep { length } @lines) {

                my ($checksum, $size, $basename) = split(/\s+/, $line);

                # ignore traversals
                next
                  if $basename =~ m{/};

                $files{$basename}{checksums}{$algorithm} = {
                    'sum' => $checksum,
                    'filesize' => $size
                };
            }
        }

        return \%files;
    }
);

=back

=head1 AUTHOR

Originally written by Adam D. Barratt <adsb@debian.org> for Lintian.

=head1 SEE ALSO

lintian(1), L<Lintian::Processable>

=cut

1;

# Local Variables:
# indent-tabs-mode: nil
# cperl-indent-level: 4
# End:
# vim: syntax=perl sw=4 sts=4 sr et