/usr/share/perl5/Mail/SpamAssassin/Util/DependencyInfo.pm is in spamassassin 3.3.2-5+deb7u3.
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 | # Helper code to debug dependencies and their versions.
# <@LICENSE>
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to you under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License. You may obtain a copy of the License at:
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# </@LICENSE>
=head1 NAME
Mail:SpamAssassin::Util::DependencyInfo - spamassassin debugging helpers
=head1 SYNOPSIS
loadplugin Mail:SpamAssassin::Util::DependencyInfo
=cut
package Mail::SpamAssassin::Util::DependencyInfo;
use strict;
use warnings;
use bytes;
use re 'taint';
use vars qw (
@MODULES @OPTIONAL_MODULES $EXIT_STATUS $WARNINGS
);
my $have_sha = eval { require Digest::SHA };
my $have_sha1 = eval { require Digest::SHA1 };
@MODULES = (
$have_sha1 ? {
'module' => 'Digest::SHA1',
'version' => 0,
'desc' => 'The Digest::SHA1 module is used as a cryptographic hash for some
tests and the Bayes subsystem. It is also required by the Razor2 plugin.',
} : {
'module' => 'Digest::SHA',
'version' => 0,
'desc' => 'The Digest::SHA module is used as a cryptographic hash for some
tests and the Bayes subsystem. It is also required by the DKIM plugin.',
},
{
'module' => 'HTML::Parser',
'version' => '3.43',
'desc' => 'HTML is used for an ever-increasing amount of email so this dependency
is unavoidable. Run "perldoc -q html" for additional information.',
},
{
module => 'Net::DNS',
version => ($^O =~ /^(mswin|dos|os2)/oi ? '0.46' : '0.34'),
desc => 'Used for all DNS-based tests (SBL, XBL, SpamCop, DSBL, etc.),
perform MX checks, and is also used when manually reporting spam to
SpamCop.
You need to make sure the Net::DNS version is sufficiently up-to-date:
- version 0.34 or higher on Unix systems
- version 0.46 or higher on Windows systems',
},
{
'module' => 'NetAddr::IP',
'version' => '4.000',
'desc' => "Used in determining which DNS tests are to be done for each of
the header's received fields, and used by AWL plugin for extracting network
address from an IPv6 addresses (and from IPv4 address on nondefault mask).",
},
{
module => 'Time::HiRes',
version => 0,
desc => 'Used by asynchronous DNS lookups to operate timeouts with subsecond
precision and to report processing times accurately.'
},
{
module => 'Archive::Tar',
version => '1.23',
desc => 'The "sa-update" program requires this module to access tar update
archive files.',
},
{
module => 'IO::Zlib',
version => '1.04',
desc => 'The "sa-update" program requires this module to access compressed
update archive files.',
},
);
my @OPTIONAL_MODULES = (
$have_sha ? {
'module' => 'Digest::SHA1',
'version' => 0,
'desc' => 'The Digest::SHA1 module is required by the Razor2 plugin.',
} : {
'module' => 'Digest::SHA',
'version' => 0,
'desc' => 'The Digest::SHA module is required by the DKIM plugin.',
},
{
module => 'MIME::Base64',
version => 0,
desc => 'This module is highly recommended to increase the speed with which
Base64 encoded messages/mail parts are decoded.',
},
{
module => 'DB_File',
version => 0,
desc => 'Used to store data on-disk, for the Bayes-style logic and
auto-whitelist. *Much* more efficient than the other standard Perl
database packages. Strongly recommended.',
},
{
module => 'Net::SMTP',
alt_name => 'libnet',
version => 0,
desc => 'Used when manually reporting spam to SpamCop with "spamassassin -r".',
},
{
module => 'Mail::SPF',
version => 0,
desc => 'Used to check DNS Sender Policy Framework (SPF) records to fight email
address forgery and make it easier to identify spams.',
},
{
module => 'IP::Country::Fast',
alt_name => 'IP::Country',
version => 0,
desc => 'Used by the RelayCountry plugin (not enabled by default) to determine
the domain country codes of each relay in the path of an email.',
},
{
module => 'Razor2::Client::Agent',
alt_name => 'Razor2',
version => '2.61',
desc => 'Used to check message signatures against Vipul\'s Razor collaborative
filtering network. Razor has a large number of dependencies on CPAN
modules. Feel free to skip installing it, if this makes you nervous;
SpamAssassin will still work well without it.
More info on installing and using Razor can be found
at http://wiki.apache.org/spamassassin/InstallingRazor .',
},
{
module => 'Net::Ident',
version => 0,
desc => 'If you plan to use the --auth-ident option to spamd, you will need
to install this module.',
},
{
module => 'IO::Socket::INET6',
version => 0,
desc => 'This is required if the first nameserver listed in your IP
configuration or /etc/resolv.conf file is available only via an
IPv6 address. Also used by a DCC plugin to access dccifd over network.',
},
{
module => 'IO::Socket::SSL',
version => 0,
desc => 'If you wish to use SSL encryption to communicate between spamc and
spamd (the --ssl option to spamd), you need to install this
module. (You will need the OpenSSL libraries and use the
ENABLE_SSL="yes" argument to Makefile.PL to build and run an SSL
compatibile spamc.)',
},
{
module => 'Compress::Zlib',
version => 0,
desc => 'If you wish to use the optional zlib compression for communication
between spamc and spamd (the -z option to spamc), you need to install
this module.',
},
{
module => 'Mail::DKIM',
version => '0.31',
recommended_min_version => '0.37',
desc => 'If this module is installed and the DKIM plugin is enabled,
SpamAssassin will perform DKIM signature verification when DKIM-Signature
header fields are present in the message headers, and check ADSP rules
(e.g. anti-phishing) when a mail message does not contain a valid author
domain signature. Version 0.37 or later is needed to fully support ADSP.'
},
{
module => 'DBI',
version => 0,
desc => 'If you intend to use SpamAssassin with an SQL database backend for
user configuration data, Bayes storage, or other storage, you will need
to have these installed; both the basic DBI module and the DBD driver for
your database.',
},
{
module => 'Getopt::Long',
version => '2.32', # min version was included in 5.8.0, which works
desc => 'The "sa-stats.pl" program included in "tools", used to generate
summary reports from spamd\'s syslog messages, requires this version
of Getopt::Long or newer.',
},
{
module => 'LWP::UserAgent',
version => 0,
desc => 'The "sa-update" program requires this module to make HTTP requests.',
},
{
module => 'HTTP::Date',
version => 0,
desc => 'The "sa-update" program requires this module to make HTTP
If-Modified-Since GET requests.',
},
{
module => 'Encode::Detect',
version => 0,
desc => 'If you plan to use the normalize_charset config setting to detect
charsets and convert them into Unicode, you will need to install
this module.',
},
);
###########################################################################
=head1 METHODS
=over 4
=item $f->debug_diagnostics ()
Output some diagnostic information, useful for debugging SpamAssassin
problems.
=back
=cut
sub debug_diagnostics {
my $out = "diag: perl platform: $] $^O\n";
# this avoids an unsightly warning due to a shortcoming of Net::Ident;
# "Net::Ident::_export_hooks() called too early to check prototype at
# /usr/share/perl5/Net/Ident.pm line 29." It only needs to be
# called here.
eval '
sub Net::Ident::_export_hooks;
';
foreach my $moddef (@MODULES, @OPTIONAL_MODULES) {
my $module = $moddef->{module};
my $modver;
if (eval ' require '.$module.'; $modver = $'.$module.'::VERSION; 1;')
{
$modver ||= '(undef)';
$out .= "module installed: $module, version $modver\n";
} else {
$out .= "module not installed: $module ('require' failed)\n";
}
}
return $out;
}
sub long_diagnostics {
my $summary = "";
print "checking module dependencies and their versions...\n";
$EXIT_STATUS = 0;
$WARNINGS = 0;
foreach my $moddef (@MODULES) {
try_module(1, $moddef, \$summary);
}
foreach my $moddef (@OPTIONAL_MODULES) {
try_module(0, $moddef, \$summary);
}
print $summary;
if ($EXIT_STATUS || $WARNINGS) {
print "\nwarning: some functionality may not be available,\n".
"please read the above report before continuing!\n\n";
}
return $EXIT_STATUS;
}
sub try_module {
my ($required, $moddef, $summref) = @_;
my $module_version;
my $installed = 0;
my $version_meets_required = 0;
my $version_meets_recommended = 0;
my $required_version = $moddef->{version};
my $recommended_version = $moddef->{recommended_min_version};
if (eval "use $moddef->{module} $required_version; 1") {
$installed = 1; $version_meets_required = 1;
} else {
my $eval_stat;
if (eval "use $moddef->{module}; 1") {
$installed = 1;
} else {
$eval_stat = $@ ne '' ? $@ : "errno=$!"; chomp $eval_stat;
# dbg("dependency: $eval_stat");
};
}
if ($installed) {
eval { $module_version = $moddef->{module}->VERSION }; # wrap just in case
if (!$recommended_version ||
($module_version && $module_version >= $recommended_version)) {
$version_meets_recommended = 1;
}
}
my $errtype;
if (!$installed) {
$errtype = "is not installed";
if ($required_version || $recommended_version) {
$errtype .= ",\n";
if ($required_version) {
$errtype .= "minimum required version is $required_version";
}
if ($recommended_version) {
$errtype .= ", " if $required_version;
$errtype .= "recommended version is $recommended_version or higher";
}
}
$errtype .= ".";
} elsif (!$version_meets_required) {
$errtype = "is installed ($module_version),\nbut is below the ".
"minimum required version $required_version,\n".
"some functionality will not be available.";
$errtype .= "\nRecommended version is $recommended_version or higher."
if $recommended_version;
} elsif (!$version_meets_recommended) {
$errtype = "is installed ($module_version),\nbut is below the ".
"recommended version $recommended_version,\n".
"some functionality may not be available,\n".
"and some of the tests in the SpamAssassin test suite may fail.";
}
if (defined $errtype) {
my $pretty_name = $moddef->{alt_name} || $moddef->{module};
my $desc = $moddef->{desc}; $desc =~ s/^(\S)/ $1/gm;
my $pretty_min_version =
!$required_version ? '' : "(version $required_version) ";
print "\n", ("*" x 75), "\n";
if ($required) {
$EXIT_STATUS++;
warn "\aERROR: the required $pretty_name module $errtype\n";
if (!$installed) {
$$summref .= "REQUIRED module missing: $pretty_name\n";
} elsif (!$version_meets_required) {
$$summref .= "REQUIRED module out of date: $pretty_name\n";
} else {
$$summref .= "REQUIRED module older than recommended: $pretty_name\n";
}
}
else {
$WARNINGS++;
print "NOTE: the optional $pretty_name module $errtype\n";
if (!$installed) {
$$summref .= "optional module missing: $pretty_name\n";
} elsif (!$version_meets_required) {
$$summref .= "optional module out of date: $pretty_name\n";
} else {
$$summref .= "optional module older than recommended: $pretty_name\n";
}
}
print "\n".$desc."\n\n";
}
}
1;
|