#-*- perl -*-
#
# Copyright (C) 2004,2005,2007,2008 Ken'ichi Fukamachi
# All rights reserved. This program is free software; you can
# redistribute it and/or modify it under the same terms as Perl itself.
#
# $FML: External.pm,v 1.7 2007/01/16 11:24:27 fukachan Exp $
#
package FML::Filter::External;
use strict;
use vars qw(@ISA @EXPORT @EXPORT_OK $AUTOLOAD);
use Carp;
use FML::Filter::ErrorStatus qw(error_set error error_clear);
=head1 NAME
FML::Filter::External - spawn external checker program.
=head1 SYNOPSIS
use FML::Filter::External;
$ext_filter = new FML::Filter::External;
$ext_filter->spawn($curproc, $mesg, $driver);
if ($ext_filter->error()) {
... error handling ...
}
=head1 DESCRIPTION
This module spawns an specified external checker program.
=head1 METHODS
=head2 new()
constructor.
=cut
# Descriptions: constructor.
# Arguments: OBJ($self) OBJ($curproc)
# Side Effects: none
# Return Value: OBJ
sub new
{
my ($self, $curproc) = @_;
my ($type) = ref($self) || $self;
my $me = { _curproc => $curproc };
return bless $me, $type;
}
=head2 spawn($curproc, $msg, $driver)
spawn external driver e.g. virus checker, spam checker,
which checks the specified message $msg.
When somthing strange happens and the process not returns,
this sub-routine timeouts and return temporary failure.
The timeout is 120 seconds by default (not customizable now).
=cut
# Descriptions: spawn external driver e.g. virus checker, spam checker.
# Arguments: OBJ($self) OBJ($curproc) OBJ($msg) STR($driver)
# Side Effects: none
# Return Value: none
sub spawn
{
my ($self, $curproc, $msg, $driver) = @_;
my $timeout = 120;
my $id = sprintf("%s-%s", time, $$);
my $_driver = sprintf("%s::%s", "FML::Filter::External", $driver);
eval qq{
local(\$SIG{ALRM}) = sub { croak(\"\$id timeout\");};
alarm( \$timeout );
use $_driver;
my \$ext_filter = new $_driver;
\$ext_filter->process(\$curproc, \$msg);
};
my $r;
if ($r = $@) {
$curproc->logerror($@);
if ($r =~ /$id timeout/) {
$curproc->logwarn("$driver timeout.");
}
else {
$self->error_set($@);
}
# retry later regardless of error reason if something error occurs.
$curproc->filter_state_set_tempfail_request();
}
}
=head1 CODING STYLE
See C on fml coding style guide.
=head1 AUTHOR
Ken'ichi Fukamachi
=head1 COPYRIGHT
Copyright (C) 2004,2005,2007,2008 Ken'ichi Fukamachi
All rights reserved. This program is free software; you can
redistribute it and/or modify it under the same terms as Perl itself.
=head1 HISTORY
FML::Filter::External appeared in fml8 mailing list driver package.
See C for more details.
=cut
1;