/usr/share/perl5/Mail/SpamAssassin/PluginHandler.pm is in spamassassin 3.4.2-0ubuntu0.14.04.1.
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 | # <@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::PluginHandler - SpamAssassin plugin handler
=cut
package Mail::SpamAssassin::PluginHandler;
use Mail::SpamAssassin;
use Mail::SpamAssassin::Plugin;
use Mail::SpamAssassin::Util;
use Mail::SpamAssassin::Logger;
use strict;
use warnings;
# use bytes;
use re 'taint';
use File::Spec;
our @ISA = qw();
#Removed $VERSION per BUG 6422
#$VERSION = 'bogus'; # avoid CPAN.pm picking up version strings later
# Normally, the list of active plugins that should be called for a given hook
# method name is compiled and cached at runtime. This means that later calls
# will not have to traverse the entire plugin list more than once, since the
# list of plugins that implement that hook is already cached.
#
# However, some hooks should not receive this treatment. One of these is
# parse_config, which may be compiled before all config files have been read;
# if a plugin is loaded from a config file after this has been compiled, it
# will not get callbacks.
#
# Any other such hooks that may be compiled at config-parse-time should be
# listed here.
our @CONFIG_TIME_HOOKS = qw( parse_config );
###########################################################################
sub new {
my $class = shift;
my $main = shift;
$class = ref($class) || $class;
my $self = {
plugins => [ ],
cbs => { },
main => $main
};
bless ($self, $class);
$self;
}
###########################################################################
sub load_plugin {
my ($self, $package, $path, $silent) = @_;
# Don't load the same plugin twice!
# Do this *before* calling ->new(), otherwise eval rules will be
# registered on a nonexistent object
foreach my $old_plugin (@{$self->{plugins}}) {
if (ref($old_plugin) eq $package) {
dbg("plugin: did not register $package, already registered");
return;
}
}
my $ret;
if ($path) {
# bug 3717:
# At least Perl 5.8.0 seems to confuse $cwd internally at some point -- we
# need to use an absolute path here else we get a "File not found" error.
$path = Mail::SpamAssassin::Util::untaint_file_path(
File::Spec->rel2abs($path)
);
# if (exists $INC{$path}) {
# dbg("plugin: not loading $package from $path, already loaded");
# return;
# }
dbg("plugin: loading $package from $path");
# use require instead of "do", so we get built-in $INC{filename}
# smarts
$ret = eval { require $path; };
}
else {
dbg("plugin: loading $package from \@INC");
$ret = eval qq{ require $package; };
$path = "(from \@INC)";
}
if (!$ret) {
if ($silent) {
if ($@) { dbg("plugin: failed to parse tryplugin $path: $@\n"); }
elsif ($!) { dbg("plugin: failed to load tryplugin $path: $!\n"); }
}
else {
if ($@) { warn "plugin: failed to parse plugin $path: $@\n"; }
elsif ($!) { warn "plugin: failed to load plugin $path: $!\n"; }
}
return; # failure! no point in continuing here
}
my $plugin = eval $package.q{->new ($self->{main}); };
if ($@ || !$plugin) {
warn "plugin: failed to create instance of plugin $package: $@\n";
}
if ($plugin) {
$self->{main}->{plugins}->register_plugin ($plugin);
$self->{main}->{conf}->load_plugin_succeeded ($plugin, $package, $path);
}
}
sub register_plugin {
my ($self, $plugin) = @_;
$plugin->{main} = $self->{main};
push (@{$self->{plugins}}, $plugin);
# dbg("plugin: registered $plugin");
# invalidate cache entries for any configuration-time hooks, in case
# one has already been built; this plugin may implement that hook!
foreach my $subname (@CONFIG_TIME_HOOKS) {
delete $self->{cbs}->{$subname};
}
}
###########################################################################
sub have_callback {
my ($self, $subname) = @_;
# have we set up the cache entry for this callback type?
if (!exists $self->{cbs}->{$subname}) {
# nope. run through all registered plugins and see which ones
# implement this type of callback. sort by priority
my %subsbypri;
foreach my $plugin (@{$self->{plugins}}) {
my $methodref = $plugin->can ($subname);
if (defined $methodref) {
my $pri = $plugin->{method_priority}->{$subname} || 0;
$subsbypri{$pri} ||= [];
push (@{$subsbypri{$pri}}, [ $plugin, $methodref ]);
dbg("plugin: ${plugin} implements '$subname', priority $pri");
}
}
my @subs;
foreach my $pri (sort { $a <=> $b } keys %subsbypri) {
push @subs, @{$subsbypri{$pri}};
}
$self->{cbs}->{$subname} = \@subs;
}
return scalar(@{$self->{cbs}->{$subname}});
}
sub callback {
my $self = shift;
my $subname = shift;
my ($ret, $overallret);
# have we set up the cache entry for this callback type?
if (!exists $self->{cbs}->{$subname}) {
return unless $self->have_callback($subname);
}
foreach my $cbpair (@{$self->{cbs}->{$subname}}) {
my ($plugin, $methodref) = @$cbpair;
$plugin->{_inhibit_further_callbacks} = 0;
eval {
$ret = &$methodref ($plugin, @_);
1;
} or do {
my $eval_stat = $@ ne '' ? $@ : "errno=$!"; chomp $eval_stat;
warn "plugin: eval failed: $eval_stat\n";
};
if (defined $ret) {
# dbg("plugin: ${plugin}->${methodref} => $ret");
# we are interested in defined but false results too
$overallret = $ret if $ret || !defined $overallret;
}
if ($plugin->{_inhibit_further_callbacks}) {
# dbg("plugin: $plugin inhibited further callbacks");
last;
}
}
return $overallret;
}
###########################################################################
sub get_loaded_plugins_list {
my ($self) = @_;
return @{$self->{plugins}};
}
###########################################################################
sub finish {
my $self = shift;
delete $self->{cbs};
foreach my $plugin (@{$self->{plugins}}) {
$plugin->finish();
delete $plugin->{main};
}
delete $self->{plugins};
delete $self->{main};
}
###########################################################################
1;
|