summaryrefslogtreecommitdiffstats
path: root/lib/Lintian/Processable/Installable/Class.pm
blob: 00520be0aaebefb1d06291be1070b9f366ced4ad (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
# -*- perl -*-
# Lintian::Processable::Installable::Class -- interface to binary package data collection

# Copyright (C) 2008, 2009 Russ Allbery
# Copyright (C) 2008 Frank Lichtenheld
# Copyright (C) 2012 Kees Cook
# Copyright (C) 2020-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::Processable::Installable::Class;

use v5.20;
use warnings;
use utf8;

use Moo::Role;
use namespace::clean;

=head1 NAME

Lintian::Processable::Installable::Class - Lintian interface to binary package data collection

=head1 SYNOPSIS

    my ($name, $type, $dir) = ('foobar', 'binary', '/path/to/lab-entry');
    my $collect = Lintian::Processable::Installable::Class->new($name);

=head1 DESCRIPTION

Lintian::Processable::Installable::Class provides an interface to package data for binary
packages.

=head1 INSTANCE METHODS

=over 4

=item is_debug_package

The package probably contains only debug symbols.

=cut

sub is_debug_package {
    my ($self) = @_;

    return 1
      if $self->name =~ /-dbg(?:sym)?/;

    return 0;
}

=item is_auto_generated

The package was probably generated automatically.

=cut

sub is_auto_generated {
    my ($self) = @_;

    return 1
      if $self->fields->declares('Auto-Built-Package');

    return 0;
}

=item is_transitional

The package is probably transitional, i.e. it probably depends
 on stuff will eventually disappear.

=cut

sub is_transitional {
    my ($self) = @_;

    return 1
      if $self->fields->value('Description') =~ /transitional package/i;

    return 0;
}

=item is_meta_package

This package is probably some kind of meta or task package.  A meta
package is usually empty and just depend on stuff.  It also returns
a true value for "tasks" (i.e. tasksel "tasks").

=cut

sub is_meta_package {
    my ($self) = @_;

    return 1
      if $self->fields->value('Description')
      =~ /meta[ -]?package|(?:dependency|dummy|empty) package/i;

    # section "tasks" or "metapackages" qualifies too
    return 1
      if $self->fields->value('Section') =~ m{(?:^|/)(?:tasks|metapackages)$};

    return 1
      if $self->name =~ /^task-/;

    return 0;
}

=back

=head1 AUTHOR

Originally written by Frank Lichtenheld <djpig@debian.org> for Lintian.
Amended 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