summaryrefslogtreecommitdiffstats
path: root/lib/Devscripts/Packages.pm
blob: 75acb45d6bc77c23e0bab8b35fc96036fb3f4d1d (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
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
#! /usr/bin/perl

# Copyright Bill Allombert <ballombe@debian.org> 2001.
# Modifications copyright 2002 Julian Gilbey <jdg@debian.org>

# 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 <https://www.gnu.org/licenses/>.

package Devscripts::Packages;

use strict;
use warnings;
use Carp;
use Dpkg::Control;
use Dpkg::IPC;
use FileHandle;

BEGIN {
    use Exporter ();
    use vars     qw(@EXPORT @ISA %EXPORT_TAGS);
    @EXPORT
      = qw(PackagesToFiles FilesToPackages PackagesMatch InstalledPackages);
    @ISA         = qw(Exporter);
    %EXPORT_TAGS = ();
}

=head1 NAME

Devscript::Packages - Interface to the dpkg package database

=head1 SYNOPSIS

use Devscript::Packages;

@files=PackagesToFiles(@packages);

@packages=FilesToPackages(@files);

@packages=PackagesMatch($regexp);

$packages_hashref=InstalledPackages($sources);

=head1 DESCRIPTION


PackagesToFiles: Return a list of files contained in a list of packages.

FilesToPackages: Return a list of packages containing at least
one file in a list of files, taking care to handle diversions correctly.

PackagesMatch: list of packages whose status match regexp.

InstalledPackages: ref to hash with keys being installed packages
(status = install ok installed).  If $sources is true, then include
the corresponding source packages as well in the list.

=cut

my $multiarch;

sub multiarch () {
    if (!defined $multiarch) {
        $multiarch
          = (system('dpkg --assert-multi-arch >/dev/null 2>&1') >> 8) == 0;
    }
    return $multiarch;
}

# input: a list of packages names.
# output: list of files they contain.

sub PackagesToFiles (@) {
    return () if @_ == 0;

    my %files = ();

    # We fork and use an exec, so that we don't have to worry how long an
    # input string the shell can handle.

    my $pid;
    my $sleep_count = 0;
    do {
        $pid = open(DPKG, "-|");
        unless (defined $pid) {
            carp("cannot fork: $!");
            croak("bailing out") if $sleep_count++ > 6;
            sleep 10;
        }
    } until defined $pid;

    if ($pid) {    # parent
        while (<DPKG>) {
            chomp;
            next if /^package diverts others to: / or -d $_;
            $files{$_} = 1;
        }
        close DPKG or croak("dpkg -L failed: $!");
    } else {       # child
            # We must use C locale, else diversion messages may be translated.
        $ENV{'LC_ALL'} = 'C';
        exec('dpkg', '-L', @_)
          or croak("can't exec dpkg -L: $!");
    }

    return keys %files;
}

# This basically runs a dpkg -S with a few bells and whistles
#
# input:  a list of files.
# output: list of packages they belong to.

sub FilesToPackages (@) {
    return () if @_ == 0;

    # We fork and use an exec, so that we don't have to worry how long an
    # input string the shell can handle.

    my @dpkg_out;
    my $pid;
    my $sleep_count = 0;
    do {
        $pid = open(DPKG, "-|");
        unless (defined $pid) {
            carp("cannot fork: $!");
            croak("bailing out") if $sleep_count++ > 6;
            sleep 10;
        }
    } until defined $pid;

    if ($pid) {    # parent
        while (<DPKG>) {
            # We'll process it later
            chomp;
            push @dpkg_out, $_;
        }
        if (!close DPKG) {
            # exit status of 1 just indicates unrecognised files
            if ($? & 0xff || $? >> 8 != 1) {
                carp(   "warning: dpkg -S exited with signal "
                      . ($? & 0xff)
                      . " and status "
                      . ($? >> 8));
            }
        }
    } else {    # child
            # We must use C locale, else diversion messages may be translated.
        $ENV{'LC_ALL'} = 'C';
        open STDERR, '>& STDOUT';    # Capture STDERR as well
        exec('dpkg', '-S', @_)
          or croak("can't exec dpkg -S: $!");
    }

    my %packages = ();
    foreach my $curfile (@_) {
        my $pkgfrom;
        foreach my $line (@dpkg_out) {
            # We want to handle diversions nicely.
            # Ignore local diversions
            if ($line =~ /^local diversion from: /) {
                # Do nothing
            } elsif ($line =~ /^local diversion to: (.+)$/) {
                if ($curfile eq $1) {
                    last;
                }
            } elsif ($line =~ /^diversion by (\S+) from: (.+)$/) {
                if ($curfile eq $2) {
                    # So the file we're looking has been diverted
                    $pkgfrom = $1;
                }
            } elsif ($line =~ /^diversion by (\S+) to: (.+)$/) {
                if ($curfile eq $2) {
                    # So the file we're looking is a diverted file
                    # We shouldn't see it again
                    $packages{$1} = 1;
                    last;
                }
            } elsif ($line =~ /^dpkg: \Q$curfile\E not found\.$/) {
                last;
            } elsif ($line
                =~ /^dpkg-query: no path found matching pattern \Q$curfile\E\.$/
            ) {
                last;
            } elsif ($line =~ /^(.*): \Q$curfile\E$/) {
                my @pkgs = split /,\s+/, $1;
                if (@pkgs == 1 || !grep /:/, @pkgs) {
                    # Only one package, or all Multi-Arch packages
                    map { $packages{$_} = 1 } @pkgs;
                } else {
                    # We've got a file which has been diverted by some package
                    # or is Multi-Arch and so is listed in two packages.  If it
                    # was diverted, the *diverting* package is the one with the
                    # file that was actually used.
                    my $found = 0;
                    foreach my $pkg (@pkgs) {
                        if ($pkg eq $pkgfrom) {
                            $packages{$pkgfrom} = 1;
                            $found = 1;
                            last;
                        }
                    }
                    if (!$found) {
                        carp(
"Something wicked happened to the output of dpkg -S $curfile"
                        );
                    }
                }
                # Prepare for the next round
                last;
            }
        }
    }

    return keys %packages;
}

# Return a list of packages whose status entries match a given pattern

sub PackagesMatch ($) {
    my $match   = $_[0];
    my @matches = ();

    my $fout = FileHandle->new;
    my $pid  = spawn(
        exec    => ['dpkg', '--status'],
        to_pipe => $fout
    );
    unless (defined $pid) {
        croak("Unable to run \"dpkg --status\": $!");
    }

    my $ctrl;
    while (defined($ctrl = Dpkg::Control->new())
        && $ctrl->parse($fout, 'dpkg --status')) {
        if ("$ctrl" =~ m/$match/m) {
            my $package = $ctrl->{Package};
            if ($ctrl->{Architecture} ne 'all' && multiarch) {
                $package .= ":$ctrl->{Architecture}";
            }
            push @matches, $package;
        }
        undef $ctrl;
    }

    wait_child($pid, cmdline => 'dpkg --status', nocheck => 1);
    return @matches;
}

# Which packages are installed (Package and Source)?

sub InstalledPackages ($) {
    my $source = $_[0];

    my $fout = FileHandle->new;
    my $pid  = spawn(
        exec    => ['dpkg', '--status'],
        to_pipe => $fout
    );
    unless (defined $pid) {
        croak("Unable to run \"dpkg --status\": $!");
    }

    my $ctrl;
    my %matches;
    while (defined($ctrl = Dpkg::Control->new(type => CTRL_FILE_STATUS))
        && $ctrl->parse($fout, 'dpkg --status')) {
        if ($ctrl->{Status} !~ /^install\s+ok\s+installed$/) {
            next;
        }
        if ($source) {
            if (exists $ctrl->{Source}) {
                $matches{ $ctrl->{Source} } = 1;
            }
        }
        if (exists $ctrl->{Package}) {
            $matches{ $ctrl->{Package} } = 1;
            if ($ctrl->{Architecture} ne 'all' && multiarch) {
                $matches{"$ctrl->{Package}:$ctrl->{Architecture}"} = 1;
            }
        }
        undef $ctrl;
    }

    wait_child($pid, cmdline => 'dpkg --status', nocheck => 1);

    return \%matches;
}

1;

=head1 AUTHOR

Bill Allombert <ballombe@debian.org>

=head1 COPYING

Copyright 2001 Bill Allombert <ballombe@debian.org>
Modifications copyright 2002 Julian Gilbey <jdg@debian.org>
dpkg-depcheck is free software, covered by the GNU General Public License, and
you are welcome to change it and/or distribute copies of it under
certain conditions.  There is absolutely no warranty for dpkg-depcheck.

=cut