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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
|
# documentation/texinfo -- lintian check script -*- perl -*-
# Copyright (C) 1998 Christian Schwarz
# Copyright (C) 2001 Josip Rodin
#
# 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::Documentation::Texinfo;
use v5.20;
use warnings;
use utf8;
use Const::Fast;
use Unicode::UTF8 qw(encode_utf8);
use List::SomeUtils qw(uniq);
use Lintian::Util qw(normalize_link_target);
use Moo;
use namespace::clean;
with 'Lintian::Check';
const my $EMPTY => q{};
sub binary {
my ($self) = @_;
my $info_dir
= $self->processable->installed->resolve_path('usr/share/info/');
return
unless $info_dir;
# Read package contents...
for my $item ($info_dir->descendants) {
next
unless $item->is_symlink
|| $item->is_file;
# Ignore dir files. That's a different error which we already catch in
# the files check.
next
if $item->basename =~ /^dir(?:\.old)?(?:\.gz)?/;
# Analyze the file names making sure the documents are named
# properly. Note that Emacs 22 added support for images in
# info files, so we have to accept those and ignore them.
# Just ignore .png files for now.
my @fname_pieces = split(m{ [.] }x, $item->basename);
my $extension = pop @fname_pieces;
if ($extension eq 'gz') { # ok!
if ($item->is_file) {
# compressed with maximum compression rate?
if ($item->file_type !~ m/gzip compressed data/) {
$self->pointed_hint(
'info-document-not-compressed-with-gzip',
$item->pointer);
} else {
if ($item->file_type !~ m/max compression/) {
$self->pointed_hint(
'info-document-not-compressed-with-max-compression',
$item->pointer
);
}
}
}
} elsif ($extension =~ m/^(?:png|jpe?g)$/) {
next;
} else {
push(@fname_pieces, $extension);
$self->pointed_hint('info-document-not-compressed',$item->pointer);
}
my $infoext = pop @fname_pieces;
unless ($infoext && $infoext =~ /^info(-\d+)?$/) { # it's not foo.info
# it's not foo{,-{1,2,3,...}}
$self->pointed_hint('info-document-has-wrong-extension',
$item->pointer)
if @fname_pieces;
}
# If this is the main info file (no numeric extension). make
# sure it has appropriate dir entry information.
if ( $item->basename !~ /-\d+\.gz/
&& $item->file_type =~ /gzip compressed data/) {
# unsafe symlink, skip. Actually, this should never
# be true as "$file_type" for symlinks will not be
# "gzip compressed data". But for good measure.
next
unless $item->is_open_ok;
open(my $fd, '<:gzip', $item->unpacked_path)
or die encode_utf8('Cannot open ' . $item->unpacked_path);
my ($section, $start, $end);
while (my $line = <$fd>) {
$section = 1
if $line =~ /^INFO-DIR-SECTION\s+\S/;
$start = 1
if $line =~ /^START-INFO-DIR-ENTRY\b/;
$end = 1
if $line =~ /^END-INFO-DIR-ENTRY\b/;
}
close $fd;
$self->pointed_hint('info-document-missing-dir-section',
$item->pointer)
unless $section;
$self->pointed_hint('info-document-missing-dir-entry',
$item->pointer)
unless $start && $end;
}
# Check each [image src=""] form in the info files. The src
# filename should be in the package. As of Texinfo 5 it will
# be something.png or something.jpg, but that's not enforced.
#
# See Texinfo manual (info "(texinfo)Info Format Image") for
# details of the [image] form. Bytes \x00,\x08 introduce it
# (and distinguishes it from [image] appearing as plain text).
#
# String src="..." part has \" for literal " and \\ for
# literal \, though that would be unlikely in filenames. For
# the tag() message show $src unbackslashed since that's the
# filename sought.
#
if ($item->is_file && $item->basename =~ /\.info(?:-\d+)?\.gz$/) {
open(my $fd, '<:gzip', $item->unpacked_path)
or die encode_utf8('Cannot open ' . $item->unpacked_path);
my $position = 1;
while (my $line = <$fd>) {
my @missing;
while ($line =~ /[\0][\b]\[image src="((?:\\.|[^\"])+)"/smg) {
my $src = $1;
$src =~ s/\\(.)/$1/g; # unbackslash
push(@missing, $src)
unless $self->processable->installed->lookup(
normalize_link_target('usr/share/info', $src));
}
$self->pointed_hint('info-document-missing-image-file',
$item->pointer($position), $_)
for uniq @missing;
} continue {
++$position;
}
close $fd;
}
}
return;
}
1;
# Local Variables:
# indent-tabs-mode: nil
# cperl-indent-level: 4
# End:
# vim: syntax=perl sw=4 sts=4 sr et
|
