/usr/share/lintian/checks/debhelper is in lintian 2.5.10.4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 | # debhelper format -- lintian check script -*- perl -*-
# Copyright (C) 1999 by Joey Hess
#
# 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 http://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::debhelper;
use strict;
use warnings;
use Lintian::Data;
use Lintian::Relation;
use Lintian::Tags qw(tag);
use Lintian::Util qw(fail slurp_entire_file);
# If compat is less than or equal to this, then a missing version
# for this level is only a pedantic issue.
use constant PEDANTIC_COMPAT => 7;
# If there is no debian/compat file present but cdbs is being used, cdbs will
# create one automatically. Currently it always uses compatibility level 5.
# It may be better to look at what version of cdbs the package depends on and
# from that derive the compatibility level....
my $cdbscompat = 5;
my $maint_commands = Lintian::Data->new ('debhelper/maint_commands');
my $dh_commands_depends = Lintian::Data->new ('debhelper/dh_commands', '=');
my $filename_configs = Lintian::Data->new ('debhelper/filename-config-files');
my $dh_ver_deps = Lintian::Data->new ('debhelper/dh_commands-manual', qr/\|\|/o);
my $dh_addons = Lintian::Data->new ('debhelper/dh_addons', '=');
my $dh_addons_manual = Lintian::Data->new ('debhelper/dh_addons-manual', qr/\|\|/o);
# The version at which debhelper commands were introduced. Packages that use
# one of these commands must have a dependency on that version of debhelper or
# newer.
my %versions = (
dh_bugfiles => '7.2.3~',
dh_installgsettings => '8.1.3~',
dh_ucf => '8.1.5~',
);
my $MISC_DEPENDS = Lintian::Relation->new ('${misc:Depends}');
sub run {
my $pkg = shift;
my $type = shift;
my $info = shift;
my $droot = $info->debfiles;
my $seencommand = '';
my $needbuilddepends = '';
my $needdhexecbuilddepends = '';
my $needtomodifyscripts = '';
my $level;
my $seenversiondepends = '0';
my $compat = 0;
my $usescdbs = '';
my $seendhcleank = '';
my $overridetargets = 0;
my %missingbdeps;
my %missingbdeps_addons;
my $maybe_skipping;
my $dhcompatvalue;
my @versioncheck;
my $inclcdbs = 0;
my $seenmaintscript = 0;
my $bdepends_noarch;
my $bdepends;
my $seen_dh = 0;
my $seen_python_helper = 0;
my $seen_python3_helper = 0;
open(RULES, '<', "$droot/rules") or fail("cannot read debian/rules: $!");
while (<RULES>) {
while (s,\\$,, and defined (my $cont = <RULES>)) {
$_ .= $cont;
}
if (/^ifn?(?:eq|def)\s/) {
$maybe_skipping++;
} elsif (/^endif\s/) {
$maybe_skipping--;
}
if (m/^\s+-?(dh_\S+)/) {
my $dhcommand = $1;
if ($dhcommand eq 'dh_suidregister') {
tag 'dh_suidregister-is-obsolete', "line $.";
}
if ($dhcommand eq 'dh_undocumented') {
tag 'dh_undocumented-is-obsolete', "line $.";
}
if ($dhcommand eq 'dh_python') {
tag 'dh_python-is-obsolete', "line $.";
$seen_python_helper = 1;
}
if ($dhcommand eq 'dh_pycentral') {
tag 'dh_pycentral-is-obsolete', "line $.";
$seen_python_helper = 1;
}
if ($dhcommand eq 'dh_installmanpages') {
tag 'dh_installmanpages-is-obsolete', "line $.";
}
if ($dhcommand eq 'dh_python3') {
$seen_python3_helper = 1;
}
if ($dhcommand =~ m,^dh_(?:pysupport$|python(?:2$|\$.*)),) {
$seen_python_helper = 1;
}
# Don't warn about recently deprecated commands in code that may be
# optional. It may be there only for backports.
unless ($maybe_skipping) {
if ($dhcommand eq 'dh_desktop') {
tag 'dh_desktop-is-deprecated', "line $.";
}
if ($dhcommand eq 'dh_scrollkeeper') {
tag 'dh_scrollkeeper-is-deprecated', "line $.";
}
if ($dhcommand eq 'dh_clean' and m/\s+\-k(?:\s+.*)?$/s) {
$seendhcleank = 1;
}
}
# if command is passed -n, it does not modify the scripts
if ($maint_commands->known($dhcommand) and not m/\s+\-n\s+/) {
$needtomodifyscripts = 1;
}
# If debhelper commands are wrapped in make conditionals, assume the
# maintainer knows what they're doing and don't check build
# dependencies.
unless ($maybe_skipping) {
if ($dh_ver_deps->known ($dhcommand)) {
my $dep = $dh_ver_deps->value($dhcommand);
$missingbdeps{$dep} = $dhcommand;
} elsif ($dh_commands_depends->known($dhcommand)) {
my $dep = $dh_commands_depends->value($dhcommand);
$missingbdeps{$dep} = $dhcommand;
}
if ($versions{$dhcommand}) {
push (@versioncheck, $dhcommand);
}
}
$seencommand = 1;
$needbuilddepends = 1;
} elsif (m,^\s+dh\s+,) {
$seen_dh = 1;
$seencommand = 1;
$needbuilddepends = 1;
$needtomodifyscripts = 1;
while (m/\s--with(?:=|\s+)(\S+)/go) {
for my $addon (split(m/,/o, $1)) {
$addon =~ y,-,_,;
my $depends =
$dh_addons_manual->value($addon) ||
$dh_addons->value($addon);
if (defined $depends) {
$missingbdeps_addons{$depends} = $addon;
}
if ($addon =~ m,python(?:2|_central|_support)$,) {
$seen_python_helper = 1;
} elsif ($addon eq 'python3') {
$seen_python3_helper = 1;
}
}
}
if ($seen_python_helper == 0) {
$seen_python_helper = -1; # maybe; we'll check that later
}
} elsif (m,^include\s+/usr/share/cdbs/1/rules/debhelper.mk,) {
$seencommand = 1;
$needbuilddepends = 1;
$needtomodifyscripts = 1;
$inclcdbs = 1;
# CDBS sets DH_COMPAT but doesn't export it. It does, however, create
# a debian/compat file if none was found; that logic is handled later.
$dhcompatvalue = $cdbscompat;
$usescdbs = 1;
} elsif (/^\s*export\s+DH_COMPAT\s*:?=\s*([^\s]+)/) {
$level = $1;
} elsif (/^\s*export\s+DH_COMPAT/) {
$level = $dhcompatvalue if $dhcompatvalue;
} elsif (/^\s*DH_COMPAT\s*:?=\s*([^\s]+)/) {
$dhcompatvalue = $1;
# one can export and then set the value:
$level = $1 if ($level);
} elsif (/^override_dh_/) {
$needbuilddepends = 1;
$overridetargets = 1;
} elsif (m,^include\s+/usr/share/cdbs/, or m,^include\s+/usr/share/R/debian/r-cran.mk,o){
$inclcdbs = 1;
}
}
close RULES;
unless ($inclcdbs){
my $bdepends = $info->relation('build-depends-all');
# Okay - d/rules does not include any file in /usr/share/cdbs/
tag 'unused-build-dependency-on-cdbs' if ($bdepends->implies('cdbs'));
}
return unless $seencommand;
my $pkgs = $info->binaries;
my $single_pkg = keys(%$pkgs) == 1 ? $pkgs->{(keys(%$pkgs))[0]} : '';
for my $binpkg (keys %$pkgs) {
next if $pkgs->{$binpkg} ne 'deb';
my $strong = $info->binary_relation ($binpkg, 'strong');
my $all = $info->binary_relation ($binpkg, 'all');
if (!$all->implies ($MISC_DEPENDS)) {
tag 'debhelper-but-no-misc-depends', $binpkg;
} else {
tag 'weak-dependency-on-misc-depends', $binpkg
unless $strong->implies ($MISC_DEPENDS);
}
}
my $compatnan = 0;
# Check the compat file. Do this separately from looping over all of the
# other files since we use the compat value when checking for brace expansion.
if (-f "$droot/compat") {
my $compat_file = slurp_entire_file("$droot/compat");
($compat) = split(/\n/, $compat_file);
$compat =~ s/^\s+$//;
if ($compat) {
$compat =~ s/^\s+//;
$compat =~ s/\s+$//;
if ($compat !~ m/^\d+$/) {
tag 'debhelper-compat-not-a-number', $compat;
$compat =~ s/[^\d]//g;
$compatnan = 1;
}
if ($level) {
tag 'declares-possibly-conflicting-debhelper-compat-versions',
"rules=$level compat=$compat";
} else {
# this is not just to fill in the gap, but because debhelper
# prefers DH_COMPAT over debian/compat
$level = $compat;
}
} else {
tag 'debhelper-compat-file-is-empty';
}
} else {
tag 'debhelper-compat-file-is-missing';
}
if (defined($level) and $level !~ m/^\d+$/ and not $compatnan) {
tag 'debhelper-compatibility-level-not-a-number', $level;
$level =~ s/[^\d]//g;
$compatnan = 1;
}
if ($usescdbs and not defined($level)) {
$level = $cdbscompat;
}
$level ||= 1;
if ($level < 5) {
tag 'package-uses-deprecated-debhelper-compat-version', $level;
}
if ($seendhcleank and $level >= 7) {
tag 'dh-clean-k-is-deprecated';
}
# Check the files in the debian directory for various debhelper-related
# things.
my @indebfiles = ();
opendir(DEBIAN, $droot)
or fail("Can't open debfiles directory.");
foreach my $file (sort readdir(DEBIAN)) {
next if $file eq 'rules' or not -f "$droot/$file";
if ($file =~ m/^(?:(.*)\.)?(?:post|pre)(?:inst|rm)$/) {
next unless $needtomodifyscripts;
# They need to have #DEBHELPER# in their scripts. Search for scripts
# that look like maintainer scripts and make sure the token is there.
my $binpkg = $1 || '';
open(IN, '<', "$droot/$file")
or fail("Can't open debfiles/$file: $!");
my $seentag = '';
while (<IN>) {
if (m/\#DEBHELPER\#/) {
$seentag = 1;
last;
}
}
close IN;
if (!$seentag) {
unless (($binpkg && exists($pkgs->{$binpkg})
&& ($pkgs->{$binpkg} eq 'udeb'))
or (!$binpkg && ($single_pkg eq 'udeb'))) {
tag 'maintainer-script-lacks-debhelper-token', "debian/$file";
}
}
} elsif ($file eq 'control' or $file =~ m/^(?:.*\.)?(?:copyright|changelog|NEWS)$/o) {
# Handle "control", [<pkg>.]copyright, [<pkg>.]changelog and [<pkg>.]NEWS
_tag_if_executable ($file, "$droot/$file");
} elsif ($file =~ m/^ex\.|\.ex$/i) {
tag 'dh-make-template-in-source', "debian/$file";
} elsif ($file =~ m/^(?:.+\.)?debhelper(?:\.log)?$/){
# The regex matches "debhelper", but debhelper/Dh_Lib does not
# make those, so skip it.
if ($file ne 'debhelper') {
push(@indebfiles, $file);
}
} elsif ($file =~ m/^(?:(.*)\.)?maintscript$/) {
$seenmaintscript = 1;
} else {
my $base = $file;
$base =~ s/^.+\.//;
# Check whether this is a debhelper config file that takes a list of
# filenames.
if ($filename_configs->known($base)) {
if ($level < 9) {
# debhelper only use executable files in compat 9
_tag_if_executable ($file, "$droot/$file");
} else {
if ( -x "$droot/$file") {
my $cmd = _shebang_cmd ("debian/$file", "$droot/$file");
unless ( $cmd ) {
tag 'executable-debhelper-file-without-being-executable', "debian/$file";
}
# Do not make assumptions about the contents of an
# executable debhelper file, unless it's a dh-exec
# script.
if ( $cmd =~ /dh-exec/) {
$needdhexecbuilddepends = 1;
_check_dh_exec ($cmd, $base, "debian/$file", "$droot/$file");
}
next;
}
}
# Skip brace expansion check for compat < 3 as those files
# do not allow any form for wildcards.
next if $level < 3;
open (IN, '<', "$droot/$file")
or fail("Can't open debfiles/$file: $!");
local $_;
while (<IN>) {
next if /^\s*$/;
next if (/^\#/ and $level >= 5);
if (m/(?<!\\)\{(?:[^\s\\\}]+?,)+[^\\\}\s]+\}/) {
tag 'brace-expansion-in-debhelper-config-file',
"debian/$file";
last;
}
}
close IN;
}
}
}
closedir(DEBIAN);
$bdepends_noarch = $info->relation_noarch('build-depends-all');
$bdepends = $info->relation('build-depends-all');
if ($needbuilddepends && ! $bdepends->implies('debhelper')) {
tag 'package-uses-debhelper-but-lacks-build-depends';
}
if ($needdhexecbuilddepends && ! $bdepends->implies('dh-exec')) {
tag 'package-uses-dh-exec-but-lacks-build-depends';
}
while (my ($dep, $command) = each %missingbdeps) {
next if $dep eq 'debhelper'; #handled above
tag 'missing-build-dependency-for-dh_-command', "$command => $dep"
unless ($bdepends_noarch->implies($dep));
}
while (my ($dep, $addon) = each %missingbdeps_addons) {
tag 'missing-build-dependency-for-dh-addon', "$addon => $dep"
unless ($bdepends_noarch->implies($dep));
}
unless ($bdepends->implies("debhelper (>= $level~)")){
my $tagname = 'package-needs-versioned-debhelper-build-depends';
$tagname = 'package-lacks-versioned-build-depends-on-debhelper'
if ($level <= PEDANTIC_COMPAT);
tag $tagname, $level;
}
if (@versioncheck) {
my %seen;
@versioncheck = grep { !$seen{$_}++ } @versioncheck;
for my $program (@versioncheck) {
my $required = $versions{$program};
my $needed = "debhelper (>= $required)";
unless ($bdepends->implies($needed)) {
tag 'debhelper-script-needs-versioned-build-depends',
$program, "(>= $required)";
}
}
}
if ($overridetargets) {
my $required = '7.0.50~';
my $needed = "debhelper (>= $required)";
unless ($bdepends->implies($needed)) {
tag 'debhelper-overrides-need-versioned-build-depends',
"(>= $required)";
}
}
if ($seenmaintscript) {
my $required = '8.1.0~';
my $needed = "debhelper (>= $required)";
unless ($bdepends->implies($needed)) {
tag 'debhelper-maintscript-needs-versioned-build-depends',
"(>= $required)";
}
}
if(scalar(@indebfiles)){
my $f = pop(@indebfiles);
my $others = scalar(@indebfiles);
my $otext = '';
if($others > 1){
$otext = " and $others others";
} elsif($others == 1){
$otext = ' and 1 other';
}
tag 'temporary-debhelper-file', "$f$otext";
}
if ($seen_python_helper == -1 and $level >= 9) {
$seen_python_helper = 0;
}
if ($seen_dh and $seen_python_helper != 1) {
my %python_depends = ();
for my $binpkg (keys %$pkgs) {
if ($info->binary_relation($binpkg, 'all')->implies('${python:Depends}')) {
$python_depends{$binpkg} = 1;
}
}
if (%python_depends) {
if ($seen_python_helper == -1) {
$seen_python_helper = $bdepends_noarch->implies('python-support');
}
if (not $seen_python_helper) {
tag 'python-depends-but-no-python-helper', sort(keys %python_depends);
}
}
}
if ($seen_dh and $seen_python3_helper != 1) {
my %python3_depends = ();
for my $binpkg (keys %$pkgs) {
if ($info->binary_relation($binpkg, 'all')->implies('${python3:Depends}')) {
$python3_depends{$binpkg} = 1;
}
}
if (%python3_depends and not $seen_python3_helper) {
tag 'python3-depends-but-no-python3-helper', sort(keys %python3_depends);
}
}
}
sub _tag_if_executable {
my ($file, $path) = @_;
tag 'package-file-is-executable', "debian/$file" if -f $path && -x _;
}
# Perform various checks on a dh-exec file.
sub _check_dh_exec {
my ($cmd, $base, $pkgpath, $fspath) = @_;
# Only /usr/bin/dh-exec is allowed, even if
# /usr/lib/dh-exec/dh-exec-subst works too.
if ( $cmd =~ m,/usr/lib/dh-exec/, ) {
tag 'dh-exec-private-helper', $pkgpath;
}
open (my $fd, '<', $fspath)
or fail ("Can't open $pkgpath: $!");
my ($dhe_subst, $dhe_install) = (0, 0);
while (<$fd>) {
if (/\$\{([^\}]+)\}/) {
my $sv = $1;
$dhe_subst = 1;
if ($sv !~ /^DEB_(?:BUILD|HOST)_(?:ARCH(?:_OS|_CPU|_BITS|_ENDIAN)?|GNU_(?:CPU|SYSTEM|TYPE)|MULTIARCH)$/) {
tag 'dh-exec-subst-unknown-variable', $pkgpath, $sv;
}
}
$dhe_install = 1 if / => /;
}
close $fd;
if ( ! ( $dhe_subst || $dhe_install ) ) {
tag 'dh-exec-script-without-dh-exec-features', $pkgpath;
}
if ( $dhe_install && $base ne 'install') {
tag 'dh-exec-install-not-allowed-here', $pkgpath;
}
}
# Return the command after the #! in the file (if any).
# - if there is no command or no #! line, the empty string is returned.
sub _shebang_cmd {
my ($pkgpath, $fspath) = @_;
my $magic;
my $cmd = '';
open my $fd, '<', $fspath or fail "opening $pkgpath: $!";
if (read $fd, $magic, 2) {
if ($magic eq '#!') {
$cmd = <$fd>;
chomp $cmd;
# It is beyond me why anyone would place a lincity data
# file here... but if they do, we will handle it
# correctly.
$cmd = '' if $cmd =~ m/^#!/o;
# Strip whitespace if any
$cmd =~ s/^\s++//o;
$cmd =~ s/\s++$//o;
}
}
close $fd;
# We are not checking if it is an ELF executable. While debhelper
# allows this (i.e. it also checks for <pkg>.<file>.<arch>), it is
# no cross-compilation safe. This is because debhelper uses
# "HOST" (and not "BUILD") arch, despite its documentation and
# code (incorrectly) suggests it is using "build".
#
# Oh yeah, it is also a terrible waste to keep pre-compiled
# binaries for all architectures in the source as well. :)
return $cmd;
}
1;
# Local Variables:
# indent-tabs-mode: nil
# cperl-indent-level: 4
# End:
# vim: syntax=perl sw=4 sts=4 sr et
|