=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 File::Spec;
use vars qw{
@ISA $VERSION @CONFIG_TIME_HOOKS
};
@ISA = qw();
$VERSION = 'bogus';
@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) = @_;
my $ret;
if ($path) {
$path = Mail::SpamAssassin::Util::untaint_file_path(
File::Spec->rel2abs($path)
);
dbg("plugin: loading $package from $path");
$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; }
my $plugin = eval $package.q{->new ($self->{main}); };
if ($@ || !$plugin) {
warn "plugin: failed to create instance of plugin $package: $@\n";
}
foreach my $old_plugin (@{$self->{plugins}}) {
if (ref($old_plugin) eq ref($plugin)) {
dbg("plugin: did not register $plugin, already registered");
return;
}
}
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);
foreach my $subname (@CONFIG_TIME_HOOKS) {
delete $self->{cbs}->{$subname};
}
}
sub have_callback {
my ($self, $subname) = @_;
if (!exists $self->{cbs}->{$subname}) {
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);
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, @_);
};
if ($@) {
warn "plugin: eval failed: $@";
}
if ($ret) {
$overallret = $ret;
}
if ($plugin->{_inhibit_further_callbacks}) {
last;
}
}
$overallret ||= $ret;
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;