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
|
# maintainer-scripts/empty -- lintian check script -*- perl -*-
#
# Copyright (C) 1998 Richard Braakman
# Copyright (C) 2002 Josip Rodin
# Copyright (C) 2016-2019 Chris Lamb <lamby@debian.org>
# Copyright (C) 2021 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, you can find it on the World Wide
# Web at https://www.gnu.org/copyleft/gpl.html, or write to the Free
# Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,
# MA 02110-1301, USA.
package Lintian::Check::MaintainerScripts::Empty;
use v5.20;
use warnings;
use utf8;
use Const::Fast;
use Unicode::UTF8 qw(encode_utf8);
use Moo;
use namespace::clean;
with 'Lintian::Check';
const my $EMPTY => q{};
sub visit_control_files {
my ($self, $item) = @_;
return
unless $item->is_maintainer_script;
return
unless length $item->interpreter;
return
unless $item->is_open_ok;
open(my $fd, '<', $item->unpacked_path)
or die encode_utf8('Cannot open ' . $item->unpacked_path);
my $stashed = $EMPTY;
my $has_code = 0;
my $position = 1;
while (my $possible_continuation = <$fd>) {
chomp $possible_continuation;
# skip empty lines
next
if $possible_continuation =~ /^\s*$/;
# skip comment lines
next
if $possible_continuation =~ /^\s*\#/;
my $no_comment = remove_comments($possible_continuation);
# Concatenate lines containing continuation character (\)
# at the end
if ($no_comment =~ s{\\$}{}) {
$stashed .= $no_comment;
next;
}
my $line = $stashed . $no_comment;
$stashed = $EMPTY;
# Don't consider the standard dh-make boilerplate to be code. This
# means ignoring the framework of a case statement, the labels, the
# echo complaining about unknown arguments, and an exit.
if ( $line !~ /^\s*set\s+-\w+\s*$/
&& $line !~ /^\s*case\s+\"?\$1\"?\s+in\s*$/
&& $line !~ /^\s*(?:[a-z|-]+|\*)\)\s*$/
&& $line !~ /^\s*[:;]+\s*$/
&& $line !~ /^\s*echo\s+\"[^\"]+\"(?:\s*>&2)?\s*$/
&& $line !~ /^\s*esac\s*$/
&& $line !~ /^\s*exit\s+\d+\s*$/) {
$has_code = 1;
last;
}
} continue {
++$position;
}
$self->pointed_hint('maintainer-script-empty', $item->pointer)
unless $has_code;
return;
}
sub remove_comments {
my ($line) = @_;
return $line
unless length $line;
my $simplified = $line;
# Remove quoted strings so we can more easily ignore comments
# inside them
$simplified =~ s/(^|[^\\](?:\\\\)*)\'(?:\\.|[^\\\'])+\'/$1''/g;
$simplified =~ s/(^|[^\\](?:\\\\)*)\"(?:\\.|[^\\\"])+\"/$1""/g;
# If the remaining string contains what looks like a comment,
# eat it. In either case, swap the unmodified script line
# back in for processing (if required) and return it.
if ($simplified =~ m/(?:^|[^[\\])[\s\&;\(\)](\#.*$)/) {
my $comment = $1;
# eat comment
$line =~ s/\Q$comment\E//;
}
return $line;
}
1;
# Local Variables:
# indent-tabs-mode: nil
# cperl-indent-level: 4
# End:
# vim: syntax=perl sw=4 sts=4 sr et
|