/usr/share/perl5/Lintian/CheckScript.pm is in lintian 2.5.81ubuntu1.
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 | # Copyright (C) 2012 Niels Thykier <niels@thykier.net>
#
# 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::CheckScript;
use strict;
use warnings;
use Cwd qw(realpath);
use File::Basename qw(dirname);
use parent 'Class::Accessor::Fast';
use Carp qw(croak);
use Lintian::Tag::Info ();
use Lintian::Util qw(read_dpkg_control_utf8);
=head1 NAME
Lintian::CheckScript - Check script meta data
=head1 SYNOPSIS
use Lintian::CheckScript;
my $cs = Lintian::CheckScript->new ("$ENV{'LINTIAN_ROOT'}/checks/",
'files');
my $name = $cs->name;
foreach my $tag ($cs->tags) {
# $ti is an instance of Lintian::Tag::Info
my $ti = $cs->get_tag ($tag);
print "$tag is a part of the check $name\n";
# Do something with $ti / $tag
}
foreach my $needs ($cs->needs_info) {
print "$name needs $needs\n";
}
if ($cs->is_check_type ('binary') && $cs->is_check_type ('source')) {
# Check applies to binary pkgs AND source pkgs
}
=head1 DESCRIPTION
Instances of this class represents the data in the check ".desc"
files. It allows access to the tags (as Lintian::Tag::Info) and the
common meta data of the check (such as Needs-Info).
=head1 CLASS METHODS
=over 4
=item Lintian::CheckScript->new($basedir, $checkname)
Parses the $file as a check desc file.
=cut
sub new {
my ($class, $basedir, $checkname) = @_;
my ($header, @tags) = read_dpkg_control_utf8("$basedir/${checkname}.desc");
my ($self, $name);
unless ($name = $header->{'check-script'}) {
croak "Missing Check-Script field in $basedir/${checkname}.desc";
}
$self = {
'name' => $header->{'check-script'},
'type' => $header->{'type'}, # lintian.desc has no type
'abbrev' => $header->{'abbrev'},
'needs_info' => [split /\s*,\s*/, $header->{'needs-info'}//''],
};
$self->{'script_pkg'} = $self->{'name'};
$self->{'script_pkg'} =~ s,/,::,go;
$self->{'script_pkg'} =~ s,[-.],_,go;
$self->{'script_path'} = $basedir . '/' . $self->{'name'} . '.pm';
$self->{'script_run'} = undef; # init'ed with $self->load_check later
if ($self->{'type'}//'ALL' ne 'ALL') {
$self->{'type-table'} = {};
for my $t (split /\s*,\s*/o, $self->{'type'}) {
$self->{'type-table'}{$t} = 1;
}
}
for my $pg (@tags) {
my $ti;
croak "Missing Tag field for tag in $basedir/${checkname}.desc"
unless $pg->{'tag'};
$ti = Lintian::Tag::Info->new($pg, $self->{'name'}, $self->{'type'});
$self->{'tag-table'}{$ti->tag} = $ti;
}
bless $self, $class;
return $self;
}
=item $cs->name
Returns the "name" of the check script. This is the value in the
Check-Script field in the file.
=item $cs->type
Returns the value stored in the "Type" field of the file. For the
purpose of testing if the check applies to a given package type, the
L</is_check_type> method can be used instead.
Note in rare cases this may return undef. This is the case for the
lintian.desc, where this field is simply not present.
=item $cs->abbrev
Returns the value of the Abbrev field from the desc file.
=item $cs->script_path
Returns the (expected) path to the script implementing this check.
=cut
Lintian::CheckScript->mk_ro_accessors(qw(name type abbrev script_path));
=item needs_info
Returns a list of all items listed in the Needs-Info field. Neither
the list nor its contents should be modified.
=cut
sub needs_info {
my ($self) = @_;
return @{ $self->{'needs_info'} };
}
=item $cs->is_check_type ($type)
Returns a truth value if this check can be applied to a $type package.
Note if $cs->type return undef, this will return a truth value for all
inputs.
=cut
sub is_check_type {
my ($self, $type) = @_;
return 1 if ($self->{'type'}//'ALL') eq 'ALL';
return $self->{'type-table'}{$type};
}
=item $cs->get_tag ($tagname)
Return the L<tag|Lintian::Tag::Info> or undef (if the tag is not in
this check).
=cut
sub get_tag {
my ($self, $tag) = @_;
return $self->{'tag-table'}{$tag};
}
=item $cs->tags
Returns the list of tag names in the check. The list nor its contents
should be modified.
=cut
sub tags {
my ($self) = @_;
return keys %{ $self->{'tag-table'}};
}
=item $cs->load_check
Attempts to load the check. On failure, the load error will be
propagated to the caller. On success it returns normally.
=cut
sub load_check {
my ($self) = @_;
return if defined $self->{'script_run'};
# Special-case: has no perl module
return if $self->name eq 'lintian';
my $cs_path = $self->{'script_path'};
my $cs_pkg = $self->{'script_pkg'};
my $run;
require $cs_path;
{
# minimal "no strict refs" scope.
no strict 'refs';
$run = \&{'Lintian::' . $cs_pkg . '::run'}
if defined &{'Lintian::' . $cs_pkg . '::run'};
}
die "$cs_path does not have a run-sub.\n"
unless defined $run;
$self->{'script_run'} = $run;
return;
}
=item $cs->run_check ($proc, $group)
Run the check on C<$proc>, which is in the
L<group|Lintian::ProcessableGroup> C<$group>. C<$proc> should be
a L<lab entry|Lintian::Lab::Entry> and must have the proper
collections run on it prior to calling this method (See
L<Lintian::Unpacker>).
The method may error out if loading the check failed or if the check
itself calls die/croak/fail/etc.
Returns normally on success; the return value has no semantic meaning
and is currently C<undef>.
NB: load_check can be used to determine if the check itself is
loadable.
=cut
sub run_check {
my ($self, $proc, $group) = @_;
# Special-case: has no perl module
return if $self->name eq 'lintian';
my @args = ($proc->pkg_name,$proc->pkg_type,$proc->info,$proc,$group);
my $cs_run = $self->{'script_run'};
unless (defined $cs_run) {
$self->load_check;
$cs_run = $self->{'script_run'};
}
$cs_run->(@args);
return;
}
=back
=head1 AUTHOR
Originally written by Niels Thykier <niels@thykier.net> for Lintian.
=head1 SEE ALSO
lintian(1), Lintian::Profile(3), Lintian::Tag::Info(3)
=cut
1;
__END__
# Local Variables:
# indent-tabs-mode: nil
# cperl-indent-level: 4
# End:
# vim: syntax=perl sw=4 sts=4 sr et
|