=head1 NAME
Mail::SpamAssassin - Spam detector and markup engine
=head1 SYNOPSIS
my $spamtest = Mail::SpamAssassin->new();
my $mail = $spamtest->parse( $message );
my $status = $spamtest->check( $mail );
if ($status->is_spam()) {
$mail = $status->rewrite_mail();
} else {
...
}
...
$status->finish();
$mail->finish();
=head1 DESCRIPTION
Mail::SpamAssassin is a module to identify spam using several methods
including text analysis, internet-based realtime blacklists, statistical
analysis, and internet-based hashing algorithms.
Using its rule base, it uses a wide range of heuristic tests on mail headers
and body text to identify "spam", also known as unsolicited bulk email.
Once identified, the mail can then be tagged as spam for later filtering
using the user's own mail user-agent application or at the mail transfer
agent.
If you wish to use a command-line filter tool, try the C<spamassassin>
or the C<spamd>/C<spamc> tools provided.
SpamAssassin also includes support for reporting spam messages to collaborative
filtering databases, such as Vipul's Razor ( http://razor.sourceforge.net/ ).
=head1 METHODS
=over 4
=cut
package Mail::SpamAssassin;
use strict;
use warnings;
use bytes;
require 5.006_001;
use Mail::SpamAssassin::Constants;
use Mail::SpamAssassin::Conf;
use Mail::SpamAssassin::Conf::SQL;
use Mail::SpamAssassin::Conf::LDAP;
use Mail::SpamAssassin::PerMsgStatus;
use Mail::SpamAssassin::Message;
use Mail::SpamAssassin::Bayes;
use Mail::SpamAssassin::PluginHandler;
use File::Basename;
use File::Path;
use File::Spec 0.8;
use File::Copy;
use Cwd;
use Config;
BEGIN {
eval { require Time::HiRes };
Time::HiRes->import( qw(time) ) unless $@;
}
use vars qw{
@ISA $VERSION $SUB_VERSION @EXTRA_VERSION $IS_DEVEL_BUILD $HOME_URL
$DEBUG
@default_rules_path @default_prefs_path
@default_userprefs_path @default_userstate_dir
@site_rules_path
};
$VERSION = "3.000001";
@ISA = qw();
$SUB_VERSION = (split(/\s+/,'$LastChangedDate: 2004-10-22 18:40:58 -0700 (Fri, 22 Oct 2004) $ updated by SVN'))[1];
@EXTRA_VERSION = qw();
if (defined $IS_DEVEL_BUILD && $IS_DEVEL_BUILD) {
push(@EXTRA_VERSION, ( 'r' . qw{$LastChangedRevision: 55343 $ updated by SVN}[1] ));
}
sub Version { $VERSION=~/^(\d+)\.(\d\d\d)(\d\d\d)$/; join('-', sprintf("%d.%d.%d",$1,$2,$3), @EXTRA_VERSION) }
$HOME_URL = "http://spamassassin.apache.org/";
@default_rules_path = (
'./rules', '../rules', '__def_rules_dir__',
'__prefix__/share/spamassassin',
'/usr/local/share/spamassassin',
'/usr/share/spamassassin',
);
@site_rules_path = (
'__local_rules_dir__',
'__prefix__/etc/mail/spamassassin',
'__prefix__/etc/spamassassin',
'/usr/local/etc/spamassassin',
'/usr/pkg/etc/spamassassin',
'/usr/etc/spamassassin',
'/etc/mail/spamassassin',
'/etc/spamassassin',
);
@default_prefs_path = (
'__local_rules_dir__/user_prefs.template',
'__prefix__/etc/mail/spamassassin/user_prefs.template',
'__prefix__/share/spamassassin/user_prefs.template',
'/etc/spamassassin/user_prefs.template',
'/etc/mail/spamassassin/user_prefs.template',
'/usr/local/share/spamassassin/user_prefs.template',
'/usr/share/spamassassin/user_prefs.template',
);
@default_userprefs_path = (
'~/.spamassassin/user_prefs',
);
@default_userstate_dir = (
'~/.spamassassin',
);
=item $f = new Mail::SpamAssassin( [ { opt => val, ... } ] )
Constructs a new C<Mail::SpamAssassin> object. You may pass the
following attribute-value pairs to the constructor.
=over 4
=item rules_filename
The filename to load spam-identifying rules from. (optional)
=item site_rules_filename
The directory to load site-specific spam-identifying rules from. (optional)
=item userprefs_filename
The filename to load preferences from. (optional)
=item userstate_dir
The directory user state is stored in. (optional)
=item config_text
The text of all rules and preferences. If you prefer not to load the rules
from files, read them in yourself and set this instead. As a result, this will
override the settings for C<rules_filename>, C<site_rules_filename>,
and C<userprefs_filename>.
=item languages_filename
If you want to be able to use the language-guessing rule
C<UNWANTED_LANGUAGE_BODY>, and are using C<config_text> instead of
C<rules_filename>, C<site_rules_filename>, and C<userprefs_filename>, you will
need to set this. It should be the path to the B<languages> file normally
found in the SpamAssassin B<rules> directory.
=item local_tests_only
If set to 1, no tests that require internet access will be performed. (default:
0)
=item dont_copy_prefs
If set to 1, the user preferences file will not be created if it doesn't
already exist. (default: 0)
=item save_pattern_hits
If set to 1, the patterns hit can be retrieved from the
C<Mail::SpamAssassin::PerMsgStatus> object. Used for debugging.
=item home_dir_for_helpers
If set, the B<HOME> environment variable will be set to this value
when using test applications that require their configuration data,
such as Razor, Pyzor and DCC.
=item username
If set, the C<username> attribute will use this as the current user's name.
Otherwise, the default is taken from the runtime environment (ie. this process'
effective UID under UNIX).
=back
If none of C<rules_filename>, C<site_rules_filename>, C<userprefs_filename>, or
C<config_text> is set, the C<Mail::SpamAssassin> module will search for the
configuration files in the usual installed locations.
=cut
sub new {
my $class = shift;
$class = ref($class) || $class;
my $self = shift;
if (!defined $self) { $self = { }; }
bless ($self, $class);
$DEBUG->{enabled} = 0;
if (defined $self->{debug} && $self->{debug} > 0) { $DEBUG->{enabled} = 1; }
dbg("SpamAssassin version ".Version());
$self->{PREFIX} ||= '@@PREFIX@@';
$DEBUG->{datediff}=-1;
$DEBUG->{razor}=-3;
$DEBUG->{dcc}=0;
$DEBUG->{pyzor}=0;
$DEBUG->{rbl}=0;
$DEBUG->{dnsavailable}=-2;
$DEBUG->{bayes}=0;
$DEBUG->{rulesrun}=64;
$self->{conf} ||= new Mail::SpamAssassin::Conf ($self);
$self->{plugins} = Mail::SpamAssassin::PluginHandler->new ($self);
$self->{save_pattern_hits} ||= 0;
Mail::SpamAssassin::Util::clean_path_in_taint_mode();
$self->{encapsulated_content_description} = 'original message before SpamAssassin';
if (!defined $self->{username}) {
$self->{username} = (Mail::SpamAssassin::Util::portable_getpwuid ($>))[0];
}
$self->create_locker();
$self;
}
sub create_locker {
my ($self) = @_;
my $class;
my $m = $self->{conf}->{lock_method};
if ($m eq 'win32') { $class = 'Win32'; }
elsif ($m eq 'flock') { $class = 'Flock'; }
elsif ($m eq 'nfssafe') { $class = 'UnixNFSSafe'; }
else {
if (Mail::SpamAssassin::Util::am_running_on_windows()) {
$class = 'Win32';
} else {
$class = 'UnixNFSSafe';
}
}
eval '
use Mail::SpamAssassin::Locker::'.$class.';
$self->{locker} = new Mail::SpamAssassin::Locker::'.$class.' ($self);
'; ($@) and die $@;
if (!defined $self->{locker}) { die "oops! no locker"; }
}
=item parse($message, $parse_now)
Parse will return a Mail::SpamAssassin::Message object with just the
headers parsed. When calling this function, there are two optional
parameters that can be passed in: $message is either undef (which will
use STDIN), a scalar of the entire message, an array reference of the
message with 1 line per array element, or a file glob which holds the
entire contents of the message; and $parse_now, which specifies whether
or not to create the MIME tree at parse time or later as necessary.
The I<$parse_now> option, by default, is set to false (0).
This allows SpamAssassin to not have to generate the tree of
Mail::SpamAssassin::Message::Node objects and their related data if the
tree is not going to be used. This is handy, for instance, when running
C<spamassassin -d>, which only needs the pristine header and body which
is always parsed and stored by this function.
=cut
sub parse {
my($self, $message, $parsenow) = @_;
my $msg = Mail::SpamAssassin::Message->new({message=>$message, parsenow=>$parsenow});
return $msg;
}
=item $status = $f->check ($mail)
Check a mail, encapsulated in a C<Mail::SpamAssassin::Message> object,
to determine if it is spam or not.
Returns a C<Mail::SpamAssassin::PerMsgStatus> object which can be
used to test or manipulate the mail message.
Note that the C<Mail::SpamAssassin> object can be re-used for further messages
without affecting this check; in OO terminology, the C<Mail::SpamAssassin>
object is a "factory". However, if you do this, be sure to call the
C<finish()> method on the status objects when you're done with them.
=cut
sub check {
my ($self, $mail_obj) = @_;
local ($_);
$self->init(1);
my $msg = Mail::SpamAssassin::PerMsgStatus->new($self, $mail_obj);
$msg->check();
$msg;
}
=item $status = $f->check_message_text ($mailtext)
Check a mail, encapsulated in a plain string C<$mailtext>, to determine if it
is spam or not.
Otherwise identical to C<check()> above.
=cut
sub check_message_text {
my ($self, $mailtext) = @_;
my $msg = $self->parse($mailtext, 1);
my $result = $self->check($msg);
$msg->finish_metadata();
return $result;
}
=item $status = $f->learn ($mail, $id, $isspam, $forget)
Learn from a mail, encapsulated in a C<Mail::SpamAssassin::Message> object.
If C<$isspam> is set, the mail is assumed to be spam, otherwise it will
be learnt as non-spam.
If C<$forget> is set, the attributes of the mail will be removed from
both the non-spam and spam learning databases.
C<$id> is an optional message-identification string, used internally
to tag the message. If it is C<undef>, the Message-Id of the message
will be used. It should be unique to that message.
Returns a C<Mail::SpamAssassin::PerMsgLearner> object which can be used to
manipulate the learning process for each mail.
Note that the C<Mail::SpamAssassin> object can be re-used for further messages
without affecting this check; in OO terminology, the C<Mail::SpamAssassin>
object is a "factory". However, if you do this, be sure to call the
C<finish()> method on the learner objects when you're done with them.
C<learn()> and C<check()> can be run using the same factory. C<init_learner()>
must be called before using this method.
=cut
sub learn {
my ($self, $mail_obj, $id, $isspam, $forget) = @_;
local ($_);
require Mail::SpamAssassin::PerMsgLearner;
$self->init(1);
my $msg = Mail::SpamAssassin::PerMsgLearner->new($self, $mail_obj);
if ($forget) {
$msg->forget($id);
} elsif ($isspam) {
dbg("Learning Spam");
$msg->learn_spam($id);
} else {
dbg("Learning Ham");
$msg->learn_ham($id);
}
$msg;
}
=item $f->init_learner ( [ { opt => val, ... } ] )
Initialise learning. You may pass the following attribute-value pairs to this
method.
=over 4
=item caller_will_untie
Whether or not the code calling this method will take care of untie'ing
from the Bayes databases (by calling C<finish_learner()>) (optional, default 0).
=item force_expire
Should an expiration run be forced to occur immediately? (optional, default 0).
=item learn_to_journal
Should learning data be written to the journal, instead of directly to the
databases? (optional, default 0).
=item wait_for_lock
Whether or not to wait a long time for locks to complete (optional, default 0).
=back
=cut
sub init_learner {
my $self = shift;
my $opts = shift;
dbg ("Initialising learner");
$self->init(1);
if (defined $opts->{force_expire}) { $self->{learn_force_expire} = $opts->{force_expire}; }
if (defined $opts->{learn_to_journal}) { $self->{learn_to_journal} = $opts->{learn_to_journal}; }
if (defined $opts->{caller_will_untie}) { $self->{learn_caller_will_untie} = $opts->{caller_will_untie}; }
if (defined $opts->{wait_for_lock}) { $self->{learn_wait_for_lock} = $opts->{wait_for_lock}; }
1;
}
=item $f->rebuild_learner_caches ({ opt => val })
Rebuild any cache databases; should be called after the learning process.
Options include: C<verbose>, which will output diagnostics to C<stdout>
if set to 1.
=cut
sub rebuild_learner_caches {
my $self = shift;
my $opts = shift;
$self->{bayes_scanner}->sync(1,1,$opts);
1;
}
=item $f->finish_learner ()
Finish learning.
=cut
sub finish_learner {
my $self = shift;
$self->{bayes_scanner}->finish();
1;
}
=item $f->dump_bayes_db()
Dump the contents of the Bayes DB
=cut
sub dump_bayes_db {
my($self,@opts) = @_;
$self->{bayes_scanner}->dump_bayes_db(@opts);
}
=item $f->signal_user_changed ( [ { opt => val, ... } ] )
Signals that the current user has changed (possibly using C<setuid>), meaning
that SpamAssassin should close any per-user databases it has open, and re-open
using ones appropriate for the new user.
Note that this should be called I<after> reading any per-user configuration, as
that data may override some paths opened in this method. You may pass the
following attribute-value pairs:
=over 4
=item username
The username of the user. This will be used for the C<username> attribute.
=item user_dir
A directory to use as a 'home directory' for the current user's data,
overriding the system default. This directory must be readable and writable by
the process. Note that the resulting C<userstate_dir> will be the
C<.spamassassin> subdirectory of this dir.
=item userstate_dir
A directory to use as a directory for the current user's data, overriding the
system default. This directory must be readable and writable by the process.
The default is C<user_dir/.spamassassin>.
=back
=cut
sub signal_user_changed {
my $self = shift;
my $opts = shift;
my $set = 0;
dbg ("user has changed");
if (defined $opts && $opts->{username}) {
$self->{username} = $opts->{username};
}
if (defined $opts && $opts->{user_dir}) {
$self->{user_dir} = $opts->{user_dir};
}
if (defined $opts && $opts->{userstate_dir}) {
$self->{userstate_dir} = $opts->{userstate_dir};
}
$self->{bayes_scanner}->finish();
$self->{bayes_scanner} = new Mail::SpamAssassin::Bayes ($self);
$self->{'learn_to_journal'} = $self->{conf}->{bayes_learn_to_journal};
$set |= 1 unless $self->{local_tests_only};
$set |= 2 if $self->{bayes_scanner}->is_scan_available();
$self->{conf}->set_score_set ($set);
$self->call_plugins ("signal_user_changed", {
username => $self->{username},
userstate_dir => $self->{userstate_dir},
user_dir => $self->{user_dir},
});
1;
}
=item $f->report_as_spam ($mail, $options)
Report a mail, encapsulated in a C<Mail::SpamAssassin::Message> object, as
human-verified spam. This will submit the mail message to live,
collaborative, spam-blocker databases, allowing other users to block this
message.
It will also submit the mail to SpamAssassin's Bayesian learner.
Options is an optional reference to a hash of options. Currently these
can be:
=over 4
=item dont_report_to_dcc
Inhibits reporting of the spam to DCC.
=item dont_report_to_pyzor
Inhibits reporting of the spam to Pyzor.
=item dont_report_to_razor
Inhibits reporting of the spam to Razor.
=item dont_report_to_spamcop
Inhibits reporting of the spam to SpamCop.
=back
=cut
sub report_as_spam {
my ($self, $mail, $options) = @_;
local ($_);
$self->init(1);
if ( $self->{conf}->{bayes_learn_during_report} ) {
$self->learn ($mail, undef, 1, 0);
}
require Mail::SpamAssassin::Reporter;
$mail = Mail::SpamAssassin::Reporter->new($self, $mail, $options);
$mail->report ();
}
=item $f->revoke_as_spam ($mail, $options)
Revoke a mail, encapsulated in a C<Mail::SpamAssassin::Message> object, as
human-verified ham (non-spam). This will revoke the mail message from live,
collaborative, spam-blocker databases, allowing other users to block this
message.
It will also submit the mail to SpamAssassin's Bayesian learner as nonspam.
Options is an optional reference to a hash of options. Currently these
can be:
=over 4
=item dont_report_to_razor
Inhibits revoking of the spam to Razor.
=back
=cut
sub revoke_as_spam {
my ($self, $mail, $options) = @_;
local ($_);
$self->init(1);
$self->learn ($mail, undef, 0, 0);
require Mail::SpamAssassin::Reporter;
$mail = Mail::SpamAssassin::Reporter->new($self, $mail, $options);
$mail->revoke ();
}
=item $f->add_address_to_whitelist ($addr)
Given a string containing an email address, add it to the automatic
whitelist database.
=cut
sub add_address_to_whitelist {
my ($self, $addr) = @_;
my $list = Mail::SpamAssassin::AutoWhitelist->new($self);
if ($list->add_known_good_address ($addr)) {
print "SpamAssassin auto-whitelist: adding address: $addr\n";
}
$list->finish();
}
=item $f->add_all_addresses_to_whitelist ($mail)
Given a mail message, find as many addresses in the usual headers (To, Cc, From
etc.), and the message body, and add them to the automatic whitelist database.
=cut
sub add_all_addresses_to_whitelist {
my ($self, $mail_obj) = @_;
my $list = Mail::SpamAssassin::AutoWhitelist->new($self);
foreach my $addr ($self->find_all_addrs_in_mail ($mail_obj)) {
if ($list->add_known_good_address ($addr)) {
print "SpamAssassin auto-whitelist: adding address: $addr\n";
}
}
$list->finish();
}
=item $f->remove_address_from_whitelist ($addr)
Given a string containing an email address, remove it from the automatic
whitelist database.
=cut
sub remove_address_from_whitelist {
my ($self, $addr) = @_;
my $list = Mail::SpamAssassin::AutoWhitelist->new($self);
if ($list->remove_address ($addr)) {
print "SpamAssassin auto-whitelist: removing address: $addr\n";
}
$list->finish();
}
=item $f->remove_all_addresses_from_whitelist ($mail)
Given a mail message, find as many addresses in the usual headers (To, Cc, From
etc.), and the message body, and remove them from the automatic whitelist
database.
=cut
sub remove_all_addresses_from_whitelist {
my ($self, $mail_obj) = @_;
my $list = Mail::SpamAssassin::AutoWhitelist->new($self);
foreach my $addr ($self->find_all_addrs_in_mail ($mail_obj)) {
if ($list->remove_address ($addr)) {
print "SpamAssassin auto-whitelist: removing address: $addr\n";
}
}
$list->finish();
}
=item $f->add_address_to_blacklist ($addr)
Given a string containing an email address, add it to the automatic
whitelist database with a high score, effectively blacklisting them.
=cut
sub add_address_to_blacklist {
my ($self, $addr) = @_;
my $list = Mail::SpamAssassin::AutoWhitelist->new($self);
if ($list->add_known_bad_address ($addr)) {
print "SpamAssassin auto-whitelist: blacklisting address: $addr\n";
}
$list->finish();
}
=item $f->add_all_addresses_to_blacklist ($mail)
Given a mail message, find addresses in the From headers and add them to the
automatic whitelist database with a high score, effectively blacklisting them.
Note that To and Cc addresses are not used.
=cut
sub add_all_addresses_to_blacklist {
my ($self, $mail_obj) = @_;
my $list = Mail::SpamAssassin::AutoWhitelist->new($self);
$self->init(1);
my @addrlist = ();
my @hdrs = $mail_obj->get_header ('From');
if ($ push (@addrlist, $self->find_all_addrs_in_line (join (" ", @hdrs)));
}
foreach my $addr (@addrlist) {
if ($list->add_known_bad_address ($addr)) {
print "SpamAssassin auto-whitelist: blacklisting address: $addr\n";
}
}
$list->finish();
}
=item $text = $f->remove_spamassassin_markup ($mail)
Returns the text of the message, with any SpamAssassin-added text (such
as the report, or X-Spam-Status headers) stripped.
Note that the B<$mail> object is not modified.
=cut
sub remove_spamassassin_markup {
my ($self, $mail_obj) = @_;
local ($_);
my $mbox = $mail_obj->get_mbox_separator() || '';
dbg("Removing Markup");
my $ct = $mail_obj->get_header("Content-Type") || '';
if ( $ct =~ m!^\s*multipart/mixed;\s+boundary\s*=\s*["']?(.+?)["']?(?:;|$)!i ) {
# Ok, this is a possible encapsulated message, search for the
# appropriate mime part and deal with it if necessary.
my $boundary = "\Q$1\E";
my @msg = split(/^/,$mail_obj->get_pristine_body());
my $flag = 0;
$ct = '';
my $cd = '';
for ( my $i = 0 ; $i <= $#msg ; $i++ ) {
# only look at mime part headers
next unless ( $msg[$i] =~ /^--$boundary$/ || $flag );
if ( $msg[$i] =~ /^\s*$/ ) { # end of mime header
# Ok, we found the encapsulated piece ...
if ($ct =~ m@^(?:message/rfc822|text/plain);\s+x-spam-type=original@ ||
($ct eq "message/rfc822" &&
$cd eq $self->{'encapsulated_content_description'}))
{
splice @msg, 0, $i+1; # remove the front part, including the blank line
# find the end and chop it off
for ( $i = 0 ; $i <= $#msg ; $i++ ) {
if ( $msg[$i] =~ /^--$boundary/ ) {
splice @msg, ($msg[$i-1] =~ /\S/ ? $i : $i-1);
# will remove the blank line (not sure it'll always be
}
}
return join('', $mbox, @msg);
}
$flag = 0;
$ct = '';
$cd = '';
next;
}
$flag = 1;
if ( $msg[$i] =~ /^Content-Type:\s+(.+?)\s*$/i ) {
$ct = $1;
}
elsif ( $msg[$i] =~ /^Content-Description:\s+(.+?)\s*$/i ) {
$cd = $1;
}
}
}
my $hdrs = $mail_obj->get_pristine_header();
my $body = $mail_obj->get_pristine_body();
$hdrs =~ s/\r//gs;
1 while $hdrs =~ s/(\nX-Spam-(?!Prev).+?)\n[ \t]+/$1 /g;
$self->init(1);
foreach my $header ( keys %{$self->{conf}->{rewrite_header}} ) {
next if ($hdrs =~ /^X-Spam-Prev-$header:/im);
dbg ("Removing markup in $header");
if ($header eq 'Subject') {
my $tag = $self->{conf}->{rewrite_header}->{'Subject'};
$tag = quotemeta($tag);
$tag =~ s/_HITS_/\\d{2}\\.\\d{2}/g;
$tag =~ s/_SCORE_/\\d{2}\\.\\d{2}/g;
$tag =~ s/_REQD_/\\d{2}\\.\\d{2}/g;
1 while $hdrs =~ s/^Subject: ${tag} /Subject: /gm;
} else {
$hdrs =~ s/^(${header}:[ \t].*?)\t\([^)]*\)$/$1/gm;
}
}
1 while ($body =~ s/^\n?SPAM: ----.+\n(?:SPAM:.*\n)*SPAM: ----.+\n\n//);
while ($hdrs =~ s/^X-Spam-Prev-(([^:]+:)[ \t]*.*\n(?:\s+\S.*\n)*)//m) {
my($hdr, $name) = ($1,$2);
unless ($hdrs =~ s/^$name[ \t]*.*\n(?:\s+\S.*\n)*/$hdr/m) {
$hdrs =~ s/\n\n/\n$hdr\n/;
}
}
1 while $hdrs =~ s/\nX-Spam-.*\n/\n/g;
return join ('', $mbox, $hdrs, $body);
}
=item $f->read_scoreonly_config ($filename)
Read a configuration file and parse user preferences from it.
User preferences are as defined in the C<Mail::SpamAssassin::Conf> manual page.
In other words, they include scoring options, scores, whitelists and
blacklists, and so on, but do not include rule definitions, privileged
settings, etc. unless C<allow_user_rules> is enabled; and they never include
the administrator settings.
=cut
sub read_scoreonly_config {
my ($self, $filename) = @_;
if (!open(IN,"<$filename")) {
dbg ("read_scoreonly_config: cannot open \"$filename\": $!");
return;
}
my $text = join ('',<IN>);
close IN;
$self->{conf}->{main} = $self;
$self->{conf}->parse_scores_only ($text);
if ($self->{conf}->{allow_user_rules}) {
dbg("finishing parsing!");
$self->{conf}->finish_parsing();
}
delete $self->{conf}->{main}; }
=item $f->load_scoreonly_sql ($username)
Read configuration paramaters from SQL database and parse scores from it. This
will only take effect if the perl C<DBI> module is installed, and the
configuration parameters C<user_scores_dsn>, C<user_scores_sql_username>, and
C<user_scores_sql_password> are set correctly.
The username in C<$username> will also be used for the C<username> attribute of
the Mail::SpamAssassin object.
=cut
sub load_scoreonly_sql {
my ($self, $username) = @_;
my $src = Mail::SpamAssassin::Conf::SQL->new ($self);
$self->{username} = $username;
unless ($src->load($username)) {
return 0;
}
return 1;
}
=item $f->load_scoreonly_ldap ($username)
Read configuration paramaters from an LDAP server and parse scores from it.
This will only take effect if the perl C<Net::LDAP> and C<URI> modules are
installed, and the configuration parameters C<user_scores_dsn>,
C<user_scores_ldap_username>, and C<user_scores_ldap_password> are set
correctly.
The username in C<$username> will also be used for the C<username> attribute of
the Mail::SpamAssassin object.
=cut
sub load_scoreonly_ldap {
my ($self, $username) = @_;
dbg("load_scoreonly_ldap($username)");
my $src = Mail::SpamAssassin::Conf::LDAP->new ($self);
$self->{username} = $username;
$src->load($username);
}
=item $f->set_persistent_address_list_factory ($factoryobj)
Set the persistent address list factory, used to create objects for the
automatic whitelist algorithm's persistent-storage back-end. See
C<Mail::SpamAssassin::PersistentAddrList> for the API these factory objects
must implement, and the API the objects they produce must implement.
=cut
sub set_persistent_address_list_factory {
my ($self, $fac) = @_;
$self->{pers_addr_list_factory} = $fac;
}
=item $f->compile_now ($use_user_prefs, $keep_userstate)
Compile all patterns, load all configuration files, and load all
possibly-required Perl modules.
Normally, Mail::SpamAssassin uses lazy evaluation where possible, but if you
plan to fork() or start a new perl interpreter thread to process a message,
this is suboptimal, as each process/thread will have to perform these actions.
Call this function in the master thread or process to perform the actions
straightaway, so that the sub-processes will not have to.
If C<$use_user_prefs> is 0, this will initialise the SpamAssassin
configuration without reading the per-user configuration file and it will
assume that you will call C<read_scoreonly_config> at a later point.
If C<$keep_userstate> is true, compile_now() will revert any configuration
options which have a default with I<__userstate__> in it post-init(),
and then re-change the option before returning. This lets you change
I<$ENV{'HOME'}> to a temp directory, have compile_now() and create any
files there as necessary (auto-whitelist, etc,) without disturbing the
actual files as changed by a configuration option. By default, this
is disabled.
=cut
sub compile_now {
my ($self, $use_user_prefs, $deal_with_userstate) = @_;
my @testmsg = ("From: ignore\@compiling.spamassassin.taint.org\n",
"Message-Id: <".time."\@spamassassin_spamd_init>\n", "\n",
"I need to make this message body somewhat long so TextCat preloads\n"x20);
dbg ("ignore: test message to precompile patterns and load modules");
my %backup = ();
if (defined $deal_with_userstate && $deal_with_userstate) {
while(my($k,$v) = each %{$self->{conf}}) {
$backup{$k} = $v if (defined $v && !ref($v) && $v =~/__userstate__/);
}
}
$self->init($use_user_prefs);
while(my($k,$v) = each %backup) {
if ($self->{conf}->{$k} eq $v) {
delete $backup{$k};
}
else {
my $backup = $backup{$k};
$backup{$k} = $self->{conf}->{$k};
$self->{conf}->{$k} = $backup;
}
}
my $mail = $self->parse(\@testmsg, 1);
my $status = Mail::SpamAssassin::PerMsgStatus->new($self, $mail,
{ disable_auto_learning => 1 } );
$status->word_is_in_dictionary("aba"); my $use_bayes_rules_value = $self->{conf}->{use_bayes_rules};
$self->{conf}->{use_bayes_rules} = 0;
$status->check();
$self->{conf}->{use_bayes_rules} = $use_bayes_rules_value;
$status->finish();
$mail->finish();
$self->finish_learner();
my $dsn = $self->{conf}->{user_scores_dsn};
if ($dsn ne '') {
if ($dsn =~ /^ldap:/i) {
Mail::SpamAssassin::Conf::LDAP::load_modules();
} else {
Mail::SpamAssassin::Conf::SQL::load_modules();
}
}
$self->{bayes_scanner}->sanity_check_is_untied();
while(my($k,$v) = each %backup) {
$self->{conf}->{$k} = $v;
}
delete $self->{conf}->{sed_path_cache};
1;
}
=item $f->debug_diagnostics ()
Output some diagnostic information, useful for debugging SpamAssassin
problems.
=cut
sub debug_diagnostics {
my ($self) = @_;
foreach my $module (sort qw(
Net::DNS Razor2::Client::Agent MIME::Base64
IO::Socket::UNIX DB_File Digest::SHA1
DBI URI Net::LDAP Storable
))
{
my $modver;
if (eval ' require '.$module.'; $modver = $'.$module.'::VERSION; 1;')
{
$modver ||= '(undef)';
dbg ("diag: module installed: $module, version $modver");
} else {
dbg ("diag: module not installed: $module ('require' failed)");
}
}
}
=item $failed = $f->lint_rules ()
Syntax-check the current set of rules. Returns the number of
syntax errors discovered, or 0 if the configuration is valid.
=cut
sub lint_rules {
my ($self) = @_;
dbg ("ignore: using a test message to lint rules");
my @testmsg = ("From: ignore\@compiling.spamassassin.taint.org\n",
"Subject: \n",
"Message-Id: <".CORE::time()."\@lint_rules>\n", "\n",
"I need to make this message body somewhat long so TextCat preloads\n"x20);
$self->{lint_rules} = $self->{conf}->{lint_rules} = 1;
$self->{syntax_errors} = 0;
$self->init(1);
$self->{syntax_errors} += $self->{conf}->{errors};
my $mail = $self->parse(\@testmsg, 1);
my $status = Mail::SpamAssassin::PerMsgStatus->new($self, $mail,
{ disable_auto_learning => 1 } );
$status->check();
$self->{syntax_errors} += $status->{rule_errors};
$status->finish();
$mail->finish();
return ($self->{syntax_errors});
}
=item $f->finish()
Destroy this object, so that it will be garbage-collected once it
goes out of scope. The object will no longer be usable after this
method is called.
=cut
sub finish {
my ($self) = @_;
$self->{conf}->finish(); delete $self->{conf};
$self->{plugins}->finish(); delete $self->{plugins};
if ($self->{bayes_scanner}) {
$self->{bayes_scanner}->finish();
delete $self->{bayes_scanner};
}
foreach(keys %{$self}) {
delete $self->{$_};
}
}
sub init {
my ($self, $use_user_pref) = @_;
if (defined $self->{_initted}) {
if ($self->{_initted} != $$) {
$self->{_initted} = $$;
srand;
}
return;
}
$self->{_initted} = $$;
if (!defined $use_user_pref) {
$use_user_pref = 1;
}
if (!defined $self->{config_text}) {
$self->{config_text} = '';
my $fname;
my $siterules = $self->{site_rules_filename};
$siterules ||= $self->first_existing_path (@site_rules_path);
my $sysrules = $self->{rules_filename};
$sysrules ||= $self->first_existing_path (@default_rules_path);
if ($siterules) {
$fname = File::Spec->catfile ($siterules, "init.pre");
if (-f $fname) {
$self->{config_text} .= $self->read_cf ($fname, 'site rules init.pre');
} else {
$fname = File::Spec->catfile ($sysrules, "init.pre");
if (-f $fname) {
$self->{config_text} .= $self->read_cf ($fname, 'sys rules init.pre');
}
}
}
$fname = $sysrules;
if ($fname) {
$self->{config_text} .= $self->read_cf ($fname, 'default rules dir');
if (-f "$fname/languages") {
$self->{languages_filename} = "$fname/languages";
}
}
$fname = $siterules;
if ($fname) {
$self->{config_text} .= $self->read_cf ($fname, 'site rules dir');
}
if ( $use_user_pref != 0 ) {
$self->get_and_create_userstate_dir();
$fname = $self->{userprefs_filename};
$fname ||= $self->first_existing_path (@default_userprefs_path);
if (defined $fname) {
if (!-f $fname && !$self->{dont_copy_prefs} && !$self->create_default_prefs($fname)) {
warn "Failed to create default user preference file $fname\n";
}
}
$self->{config_text} .= $self->read_cf ($fname, 'user prefs file');
}
}
if ($self->{config_text} !~ /\S/) {
warn "No configuration text or files found! Please check your setup.\n";
}
$self->{conf}->{main} = $self;
$self->{conf}->parse_rules ($self->{config_text});
$self->{conf}->finish_parsing ();
delete $self->{conf}->{main}; delete $self->{config_text};
$self->{bayes_scanner} = new Mail::SpamAssassin::Bayes ($self);
$self->{'learn_to_journal'} = $self->{conf}->{bayes_learn_to_journal};
my $set = 0;
$set |= 1 unless $self->{local_tests_only};
$set |= 2 if $self->{bayes_scanner}->is_scan_available();
$self->{conf}->set_score_set ($set);
if ($self->{conf}->{use_auto_whitelist} &&
$self->{conf}->{auto_whitelist_factory})
{
my $factory;
my $type = $self->{conf}->{auto_whitelist_factory};
if ($type =~ /^([_A-Za-z0-9:]+)$/) {
$type = $1;
eval '
require '.$type.';
$factory = '.$type.'->new();
';
if ($@) { warn $@; undef $factory; }
}
else {
warn "illegal auto_whitelist_factory setting\n";
}
$self->set_persistent_address_list_factory($factory) if defined $factory;
}
if ($self->{only_these_rules}) {
$self->{conf}->trim_rules($self->{only_these_rules});
}
}
sub read_cf {
my ($self, $path, $desc) = @_;
return '' unless defined ($path);
dbg ("using \"$path\" for $desc");
my $txt = '';
if (-d $path) {
foreach my $file ($self->get_cf_files_in_dir ($path)) {
if (open (IN, "<".$file)) {
$txt .= "file start $file\n"; $txt .= join ('', <IN>);
$txt .= "\nfile end $file\n";
close IN;
dbg("config: read file $file");
}
else {
warn "cannot open \"$file\": $!\n";
next;
}
}
} elsif (-f $path && -s _ && -r _) {
if (open (IN, "<".$path)) {
$txt .= "file start $path\n";
$txt = join ('', <IN>);
$txt .= "file end $path\n";
close IN;
dbg("config: read file $path");
}
else {
warn "cannot open \"$path\": $!\n";
}
}
return $txt;
}
sub get_and_create_userstate_dir {
my ($self) = @_;
my $fname;
if (defined $self->{userstate_dir}) {
$fname = $self->{userstate_dir};
}
elsif (defined $self->{user_dir}) {
$fname = File::Spec->catdir ($self->{user_dir}, ".spamassassin");
}
$fname ||= $self->first_existing_path (@default_userstate_dir);
if (defined $fname && !$self->{dont_copy_prefs}) {
dbg ("using \"$fname\" for user state dir");
}
if (!-d $fname) {
eval { mkpath ($fname, 0, 0700) } or dbg ("mkdir $fname failed: $@ $!\n");
}
$fname;
}
=item $f->create_default_prefs ($filename, $username [ , $userdir ] )
Copy default preferences file into home directory for later use and
modification, if it does not already exist and C<dont_copy_prefs> is
not set.
=cut
sub create_default_prefs {
my ($self, $fname, $user, $userdir) = @_;
if ($self->{dont_copy_prefs}) {
return(0);
}
if ($userdir && $userdir ne $self->{user_dir}) {
warn "Oops! user_dirs don't match! '$userdir' vs '$self->{user_dir}'\n";
}
if (!-f $fname)
{
$self->get_and_create_userstate_dir();
my $defprefs = $self->first_existing_path (@Mail::SpamAssassin::default_prefs_path);
if (open (IN, "<$defprefs")) {
$fname = Mail::SpamAssassin::Util::untaint_file_path($fname);
if (open (OUT, ">$fname")) {
while (<IN>) {
/^\ print OUT;
}
close OUT;
close IN;
if (($< == 0) && ($> == 0) && defined($user)) { my ($uid,$gid) = (getpwnam($user))[2,3];
unless (chown($uid, $gid, $fname)) {
warn "Couldn't chown $fname to $uid:$gid for $user: $!\n";
}
}
warn "Created user preferences file: $fname\n";
return(1);
}
else {
warn "Cannot write to $fname: $!\n";
}
}
else {
warn "Cannot open $defprefs: $!\n";
}
}
return(0);
}
sub expand_name ($) {
my ($self, $name) = @_;
my $home = $self->{user_dir} || $ENV{HOME} || '';
if (Mail::SpamAssassin::Util::am_running_on_windows()) {
my $userprofile = $ENV{USERPROFILE} || '';
return $userprofile if ($userprofile && $userprofile =~ m/^[a-z]\:[\/\\]/oi);
return $userprofile if ($userprofile =~ m/^\\\\/o);
return $home if ($home && $home =~ m/^[a-z]\:[\/\\]/oi);
return $home if ($home =~ m/^\\\\/o);
return '';
} else {
return $home if ($home && $home =~ /\//o);
return (getpwnam($name))[7] if ($name ne '');
return (getpwuid($>))[7];
}
}
sub sed_path {
my ($self, $path) = @_;
return undef if (!defined $path);
if (exists($self->{conf}->{sed_path_cache}->{$path})) {
return $self->{conf}->{sed_path_cache}->{$path};
}
my $orig_path = $path;
$path =~ s/__local_rules_dir__/$self->{LOCAL_RULES_DIR} || ''/ges;
$path =~ s/__def_rules_dir__/$self->{DEF_RULES_DIR} || ''/ges;
$path =~ s{__prefix__}{$self->{PREFIX} || $Config{prefix} || '/usr'}ges;
$path =~ s{__userstate__}{$self->get_and_create_userstate_dir()}ges;
$path =~ s/^\~([^\/]*)/$self->expand_name($1)/es;
$path = Mail::SpamAssassin::Util::untaint_file_path ($path);
$self->{conf}->{sed_path_cache}->{$orig_path} = $path;
return $path;
}
sub first_existing_path {
my $self = shift;
my $path;
foreach my $p (@_) {
$path = $self->sed_path ($p);
if (defined $path && -e $path) { return $path; }
}
$path;
}
sub get_cf_files_in_dir {
my ($self, $dir) = @_;
opendir(SA_CF_DIR, $dir) or warn "cannot opendir $dir: $!\n";
my @cfs = grep { /\.cf$/i && -f "$dir/$_" } readdir(SA_CF_DIR);
closedir SA_CF_DIR;
return map { "$dir/$_" } sort { $a cmp $b } @cfs; }
sub call_plugins {
my $self = shift;
return unless $self->{plugins};
my $subname = shift;
return $self->{plugins}->callback ($subname, @_);
}
sub find_all_addrs_in_mail {
my ($self, $mail_obj) = @_;
$self->init(1);
my @addrlist = ();
foreach my $header (qw(To From Cc Reply-To Sender
Errors-To Mail-Followup-To))
{
my @hdrs = $mail_obj->get_header ($header);
if ($ push (@addrlist, $self->find_all_addrs_in_line (join (" ", @hdrs)));
}
foreach my $line (@{$mail_obj->get_body()}) {
push (@addrlist, $self->find_all_addrs_in_line ($line));
}
my @ret = ();
my %done = ();
foreach $_ (@addrlist) {
s/^mailto://; # from Outlook "forwarded" message
next if defined ($done{$_}); $done{$_} = 1;
push (@ret, $_);
}
@ret;
}
sub find_all_addrs_in_line {
my ($self, $line) = @_;
my $ID_PATTERN = '[-a-z0-9_\+\:\=\!\#\$\%\&\*\^\?\{\}\|\~\/\.]+';
my $HOST_PATTERN = '[-a-z0-9_\+\:\/]+';
my @addrs = ();
my %seen = ();
while ($line =~ s/(?:mailto:)?\s*
($ID_PATTERN \@
$HOST_PATTERN(?:\.$HOST_PATTERN)+)//oix)
{
my $addr = $1;
$addr =~ s/^mailto://;
next if (defined ($seen{$addr})); $seen{$addr} = 1;
push (@addrs, $addr);
}
return @addrs;
}
sub dbg {
my $dbg=$Mail::SpamAssassin::DEBUG;
return unless $dbg->{enabled};
my ($msg, $codepath, $level) = @_;
$msg=join('',@{$msg}) if (ref $msg);
if (defined $codepath) {
if (not defined $dbg->{$codepath}) {
warn("dbg called with codepath $codepath, but it's not defined, skipping (message was \"$msg\"\n");
return 0;
} elsif (not defined $level) {
warn("dbg called with codepath $codepath, but no level threshold (message was \"$msg\"\n");
}
}
return if (defined $level and $level<0 and not $dbg->{$codepath} <= $level);
return if (defined $level and $level>0 and not $dbg->{$codepath} & $level);
warn "debug: $msg\n";
}
sub sa_die {
my $exitcode = shift;
warn @_;
exit $exitcode;
}
sub _is_storable_available {
my($self) = @_;
if (exists $self->{storable_available}) {
}
elsif (!eval { require Storable; }) {
$self->{storable_available} = 0;
dbg("no Storable module found");
}
else {
$self->{storable_available} = 1;
dbg("Storable module v".$Storable::VERSION." found");
}
return $self->{storable_available};
}
=item $f->copy_config ( [ $source ], [ $dest ] )
Used for daemons to keep a persistent Mail::SpamAssassin object's
configuration correct if switching between users. Pass an associative
array reference as either $source or $dest, and set the other to 'undef'
so that the object will use its current configuration. i.e.:
# create object w/ configuration
my $spamtest = Mail::SpamAssassin->new( ... );
# backup configuration to %conf_backup
my %conf_backup = ();
$spamtest->copy_config(undef, \%conf_backup) ||
die "error returned from copy_config!\n";
... do stuff, perhaps modify the config, etc ...
# reset the configuration back to the original
$spamtest->copy_config(\%conf_backup, undef) ||
die "error returned from copy_config!\n";
=cut
sub copy_config {
my($self, $source, $dest) = @_;
unless ((defined $source && ref($source) eq 'HASH') ||
(defined $dest && ref($dest) eq 'HASH')) {
return 0;
}
return 0 if (!$self->_is_storable_available());
$source ||= $self->{conf};
$dest ||= $self->{conf};
delete $dest->{sed_path_cache};
while(my($k,$v) = each %{$source}) {
next if ($k eq 'main' || $k =~ /plugin/ || $k eq 'registered_commands');
my $i = ref($v);
if (!$i) {
$dest->{$k} = $v;
}
elsif ($k =~ /^(internal|trusted)_networks$/) {
if ($v->{nets}) {
$dest->{$k}->{nets} = Storable::dclone($v->{nets});
}
else {
if (exists $dest->{$k}) {
delete $dest->{$k}->{nets};
}
else {
$dest->{$k}->{nets} = undef;
}
}
}
elsif ($i eq 'SCALAR' || $i eq 'ARRAY' || $i eq 'HASH') {
$dest->{$k} = Storable::dclone($v);
}
}
return 1;
}
1;
__END__
=back
=head1 PREREQUISITES
C<HTML::Parser>
C<Sys::Syslog>
=head1 MORE DOCUMENTATION
See also E<lt>http://spamassassin.apache.org/E<gt> and
E<lt>http://wiki.apache.org/spamassassin/E<gt> for more information.
=head1 SEE ALSO
Mail::SpamAssassin::Conf(3)
Mail::SpamAssassin::PerMsgStatus(3)
spamassassin(1)
=head1 BUGS
See E<lt>http://bugzilla.spamassassin.org/E<gt>
=head1 AUTHORS
The SpamAssassin(tm) Project E<lt>http://spamassassin.apache.org/E<gt>
=head1 COPYRIGHT
SpamAssassin is distributed under the Apache License, Version 2.0, as
described in the file C<LICENSE> included with the distribution.
=head1 AVAILABILITY
The latest version of this library is likely to be available from CPAN
as well as:
E<lt>http://spamassassin.apache.org/E<gt>
=cut