summaryrefslogtreecommitdiffstats
path: root/lib/Lintian/Processable/Diffstat.pm
blob: 82a3b282ba6b1818f7bf4a9208990beff49236db (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
# -*- perl -*- Lintian::Processable::Diffstat -- access to collected diffstat data
#
# Copyright (C) 1998 Richard Braakman
# 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::Diffstat;

use v5.20;
use warnings;
use utf8;

use Const::Fast;
use IPC::Run3;
use Path::Tiny;
use Unicode::UTF8 qw(encode_utf8 decode_utf8);

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

const my $COLON => q{:};
const my $UNDERSCORE => q{_};
const my $NEWLINE => qq{\n};

const my $OPEN_PIPE => q{-|};
const my $WAIT_STATUS_SHIFT => 8;

=head1 NAME

Lintian::Processable::Diffstat - access to collected diffstat data

=head1 SYNOPSIS

    use Lintian::Processable;

=head1 DESCRIPTION

Lintian::Processable::Diffstat provides an interface to diffstat data.

=head1 INSTANCE METHODS

=over 4

=item diffstat

Returns the path to diffstat output run on the Debian packaging diff
(a.k.a. the "diff.gz") for 1.0 non-native packages.  For source
packages without a "diff.gz" component, this returns the path to an
empty file (this may be a device like /dev/null).

=cut

has diffstat => (
    is => 'rw',
    lazy => 1,
    default => sub {
        my ($self) = @_;

        my $noepoch = $self->fields->value('Version');

        # strip epoch
        $noepoch =~ s/^\d://;

        # look for a format 1.0 diff.gz near the input file
        my $diffname = $self->name . $UNDERSCORE . $noepoch . '.diff.gz';
        return {}
          unless exists $self->files->{$diffname};

        my $diffpath = path($self->path)->parent->child($diffname)->stringify;
        return {}
          unless -e $diffpath;

        my @gunzip_command = ('gunzip', '--stdout', $diffpath);
        my $gunzip_pid = open(my $from_gunzip, $OPEN_PIPE, @gunzip_command)
          or die encode_utf8("Cannot run @gunzip_command: $!");

        my $stdout;
        my $stderr;
        my @diffstat_command = qw(diffstat -p1);
        run3(\@diffstat_command, $from_gunzip, \$stdout, \$stderr);
        my $status = ($? >> $WAIT_STATUS_SHIFT);

        $stdout = decode_utf8($stdout)
          if length $stdout;
        $stderr = decode_utf8($stderr)
          if length $stderr;

        if ($status) {

            my $message= "Non-zero status $status from @diffstat_command";
            $message .= $COLON . $NEWLINE . $stderr
              if length $stderr;

            die encode_utf8($message);
        }

        close $from_gunzip
          or
          warn encode_utf8("close failed for handle from @gunzip_command: $!");

        waitpid($gunzip_pid, 0);

        # remove summary in last line
        chomp $stdout;
        $stdout =~ s/.*\Z//;

        my %diffstat;

        my @lines = split(/\n/, $stdout);
        for my $line (@lines) {

            next
              unless $line =~ s/\|\s*([^|]*)\s*$//;

            my $stats = $1;
            my $file = $line;

            # trim both ends
            $file =~ s/^\s+|\s+$//g;

            die encode_utf8("syntax error in diffstat file: $line")
              unless length $file;

            $diffstat{$file} = $stats;
        }

        return \%diffstat;
    }
);

1;

=back

=head1 AUTHOR

Originally written by Felix Lechner <felix.lechner@lease-up.com> for
Lintian.

=head1 SEE ALSO

lintian(1)

=cut

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