1 files changed, 306 insertions, 0 deletions
diff --git a/lib/Lintian/Data/Debhelper/Commands.pm b/lib/Lintian/Data/Debhelper/Commands.pm
new file mode 100644
index 0000000..bd1ea67
--- /dev/null
+++ b/lib/Lintian/Data/Debhelper/Commands.pm
@@ -0,0 +1,306 @@
+# -*- perl -*-
+#
+# Copyright (C) 2008 by Raphael Geissert <atomo64@gmail.com>
+# Copyright (C) 2017-2018 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, see <http://www.gnu.org/licenses/>.
+
+package Lintian::Data::Debhelper::Commands;
+
+use v5.20;
+use warnings;
+use utf8;
+
+use Const::Fast;
+use File::Basename;
+use IPC::Run3;
+use List::SomeUtils qw(first_value any uniq);
+use Path::Tiny;
+use PerlIO::gzip;
+use Unicode::UTF8 qw(encode_utf8);
+
+const my $SPACE => q{ };
+const my $SLASH => q{/};
+
+const my $WAIT_STATUS_SHIFT => 8;
+
+const my $COMMANDS => 'commands';
+
+use Moo;
+use namespace::clean;
+
+with 'Lintian::Data::PreambledJSON';
+
+=head1 NAME
+
+Lintian::Data::Debhelper::Commands - Lintian interface for debhelper commands.
+
+=head1 SYNOPSIS
+
+    use Lintian::Data::Debhelper::Commands;
+
+=head1 DESCRIPTION
+
+This module provides a way to load data files for debhelper.
+
+=head1 INSTANCE METHODS
+
+=over 4
+
+=item title
+
+=item location
+
+=item installable_names_by_command
+
+=item maint_commands
+
+=item misc_depends_commands
+
+=cut
+
+has title => (
+    is => 'rw',
+    default => 'Debhelper Commands'
+);
+
+has location => (
+    is => 'rw',
+    default => 'debhelper/commands.json'
+);
+
+has installable_names_by_command => (is => 'rw', default => sub { {} });
+has maint_commands => (is => 'rw', default => sub { [] });
+has misc_depends_commands => (is => 'rw', default => sub { [] });
+
+=item all
+
+=cut
+
+sub all {
+    my ($self) = @_;
+
+    return keys %{$self->installable_names_by_command};
+}
+
+=item installed_by
+
+=cut
+
+sub installed_by {
+    my ($self, $name) = @_;
+
+    return ()
+      unless exists $self->installable_names_by_command->{$name};
+
+    my @installed_by = @{$self->installable_names_by_command->{$name} // []};
+
+    push(@installed_by, 'debhelper-compat')
+      if any { $_ eq 'debhelper' } @installed_by;
+
+    return @installed_by;
+}
+
+=item load
+
+=cut
+
+sub load {
+    my ($self, $search_space, $our_vendor) = @_;
+
+    my @candidates = map { $_ . $SLASH . $self->location } @{$search_space};
+    my $path = first_value { -e } @candidates;
+
+    my $reference;
+    return 0
+      unless $self->read_file($path, \$reference);
+
+    my %commands = %{$reference // {}};
+
+    my %installable_names_by_command;
+    my @maint_commands;
+    my @misc_depends_commands;
+
+    for my $name (keys %commands) {
+
+        my @installable_names;
+        push(@installable_names, @{$commands{$name}{installed_by}});
+
+        $installable_names_by_command{$name} = \@installable_names;
+
+        push(@maint_commands, $name)
+          if $commands{$name}{uses_autoscript};
+
+        push(@misc_depends_commands, $name)
+          if $commands{$name}{uses_misc_depends}
+          && $name ne 'dh_gencontrol';
+    }
+
+    $self->installable_names_by_command(\%installable_names_by_command);
+    $self->maint_commands(\@maint_commands);
+    $self->misc_depends_commands(\@misc_depends_commands);
+
+    return 1;
+}
+
+=item refresh
+
+=cut
+
+sub refresh {
+    my ($self, $archive, $basedir) = @_;
+
+    # neutral sort order
+    local $ENV{LC_ALL} = 'C';
+
+    my $port = 'amd64';
+
+    my %commands;
+
+    for my $installable_architecture ('all', $port) {
+
+        my $local_path
+          = $archive->contents_gz('sid', 'main', $installable_architecture);
+
+        open(my $fd, '<:gzip', $local_path)
+          or die encode_utf8("Cannot open $local_path.");
+
+        while (my $line = <$fd>) {
+
+            chomp $line;
+
+            my ($path, $finder) = split($SPACE, $line, 2);
+            next
+              unless length $path
+              && length $finder;
+
+            if ($path =~ m{^ usr/bin/ (dh_ \S+) $}x) {
+
+                my $name = $1;
+
+                my @locations = split(m{,}, $finder);
+                for my $location (@locations) {
+
+                    my ($section, $installable)= split(m{/}, $location, 2);
+
+                    $commands{$name}{installed_by} //= [];
+                    push(@{$commands{$name}{installed_by}}, $installable);
+                }
+
+                next;
+            }
+        }
+
+        close $fd;
+    }
+
+    my $deb822_by_installable_name
+      = $archive->deb822_packages_by_installable_name('sid', 'main', $port);
+
+    my $work_folder
+      = Path::Tiny->tempdir(
+        TEMPLATE => 'refresh-debhelper-add-ons-XXXXXXXXXX');
+
+    my @uses_autoscript;
+    my @uses_misc_depends;
+
+    my @installable_names= uniq map { @{$_->{installed_by}} }values %commands;
+
+    for my $installable_name (sort @installable_names) {
+
+        next
+          unless exists $deb822_by_installable_name->{$installable_name};
+
+        my $deb822 = $deb822_by_installable_name->{$installable_name};
+
+        my $pool_path = $deb822->value('Filename');
+
+        my $deb_filename = basename($pool_path);
+        my $deb_local_path = "$work_folder/$deb_filename";
+        my $deb_url = $archive->mirror_base . $SLASH . $pool_path;
+
+        my $stderr;
+        run3(
+            [qw{wget --quiet}, "--output-document=$deb_local_path", $deb_url],
+            undef, \$stderr
+        );
+        my $status = ($? >> $WAIT_STATUS_SHIFT);
+
+        # stderr already in UTF-8
+        die $stderr
+          if $status;
+
+        my $extract_folder = "$work_folder/pool/$pool_path";
+        path($extract_folder)->mkpath;
+
+        run3([qw{dpkg-deb --extract}, $deb_local_path, $extract_folder],
+            undef, \$stderr);
+        $status = ($? >> $WAIT_STATUS_SHIFT);
+
+        # stderr already in UTF-8
+        die $stderr
+          if $status;
+
+        unlink($deb_local_path)
+          or die encode_utf8("Cannot delete $deb_local_path");
+
+        my $autoscript_rule = File::Find::Rule->file;
+        $autoscript_rule->name(qr{^dh_});
+        $autoscript_rule->grep(qr{autoscript});
+        my @autoscript_matches
+          = $autoscript_rule->in("$extract_folder/usr/bin");
+
+        push(@uses_autoscript, map { basename($_) } @autoscript_matches);
+
+        my $misc_depends_rule = File::Find::Rule->file;
+        $misc_depends_rule->name(qr{^dh_});
+        $misc_depends_rule->grep(qr{misc:Depends});
+        my @misc_depends_matches
+          = $misc_depends_rule->in("$extract_folder/usr/bin");
+
+        push(@uses_misc_depends, map { basename($_) } @misc_depends_matches);
+
+        path("$work_folder/pool")->remove_tree;
+    }
+
+    $commands{$_}{uses_autoscript} = 1 for @uses_autoscript;
+
+    $commands{$_}{uses_misc_depends} = 1 for @uses_misc_depends;
+
+    my $data_path = "$basedir/" . $self->location;
+    my $status = $self->write_file($COMMANDS, \%commands,$data_path);
+
+    return $status;
+}
+
+=back
+
+=head1 AUTHOR
+
+Originally written by Felix Lechner <felix.lechner@lease-up.com> for Lintian.
+
+=head1 SEE ALSO
+
+lintian(1)
+
+=cut
+
+1;
+
+# Local Variables:
+# indent-tabs-mode: nil
+# cperl-indent-level: 4
+# End:
+# vim: syntax=perl sw=4 sts=4 sr et