/usr/share/perl5/Mail/SpamAssassin/Plugin/Shortcircuit.pm is in spamassassin 3.4.1-8build1.
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 | # <@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::Plugin::Shortcircuit - short-circuit evaluation for certain rules
=head1 SYNOPSIS
loadplugin Mail::SpamAssassin::Plugin::Shortcircuit
report Content analysis details: (_SCORE_ points, _REQD_ required, s/c _SCTYPE_)
add_header all Status "_YESNO_, score=_SCORE_ required=_REQD_ tests=_TESTS_ shortcircuit=_SCTYPE_ autolearn=_AUTOLEARN_ version=_VERSION_"
=head1 DESCRIPTION
This plugin implements simple, test-based shortcircuiting. Shortcircuiting a
test will force all other pending rules to be skipped, if that test is hit.
In addition, a symbolic rule, C<SHORTCIRCUIT>, will fire.
Recomended usage is to use C<priority> to set rules with strong S/O values (ie.
1.0) to be run first, and make instant spam or ham classification based on
that.
=cut
package Mail::SpamAssassin::Plugin::Shortcircuit;
use Mail::SpamAssassin::Plugin;
use Mail::SpamAssassin::Logger;
use strict;
use warnings;
use bytes;
use re 'taint';
use vars qw(@ISA);
@ISA = qw(Mail::SpamAssassin::Plugin);
sub new {
my $class = shift;
my $mailsaobject = shift;
$class = ref($class) || $class;
my $self = $class->SUPER::new($mailsaobject);
bless ($self, $class);
$self->register_eval_rule("check_shortcircuit");
$self->set_config($mailsaobject->{conf});
return $self;
}
sub check_shortcircuit { return 0; } # never used
sub set_config {
my($self, $conf) = @_;
my @cmds;
=head1 CONFIGURATION SETTINGS
The following configuration settings are used to control shortcircuiting:
=over 4
=item shortcircuit SYMBOLIC_TEST_NAME {ham|spam|on|off}
Shortcircuiting a test will force all other pending rules to be skipped, if
that test is hit.
Recomended usage is to use C<priority> to set rules with strong S/O values (ie.
1.0) to be run first, and make instant spam or ham classification based on
that.
To override a test that uses shortcircuiting, you can set the classification
type to C<off>.
=over 4
=item on
Shortcircuits the rest of the tests, but does not make a strict classification
of spam or ham. Rather, it uses the default score for the rule being
shortcircuited. This would allow you, for example, to define a rule such as
body TEST /test/
describe TEST test rule that scores barely over spam threshold
score TEST 5.5
priority TEST -100
shortcircuit TEST on
The result of a message hitting the above rule would be a final score of 5.5,
as opposed to 100 (default) if it were classified as spam.
=item off
Disables shortcircuiting on said rule.
=item spam
Shortcircuit the rule using a set of defaults; override the default score of
this rule with the score from C<shortcircuit_spam_score>, set the
C<noautolearn> tflag, and set priority to C<-100>. In other words,
equivalent to:
shortcircuit TEST on
priority TEST -100
score TEST 100
tflags TEST noautolearn
=item ham
Shortcircuit the rule using a set of defaults; override the default score of
this rule with the score from C<shortcircuit_ham_score>, set the C<noautolearn>
and C<nice> tflags, and set priority to C<-100>. In other words, equivalent
to:
shortcircuit TEST on
priority TEST -100
score TEST -100
tflags TEST noautolearn nice
=back
=cut
push (@cmds, {
setting => 'shortcircuit',
code => sub {
my ($self, $key, $value, $line) = @_;
my ($rule,$type);
unless (defined $value && $value !~ /^$/) {
return $Mail::SpamAssassin::Conf::MISSING_REQUIRED_VALUE;
}
if ($value =~ /^(\S+)\s+(\S+)$/) {
$rule=$1;
$type=$2;
} else {
return $Mail::SpamAssassin::Conf::INVALID_VALUE;
}
if ($type =~ m/^(?:spam|ham)$/) {
dbg("shortcircuit: adding $rule using abbreviation $type");
# set the defaults:
$self->{shortcircuit}->{$rule} = $type;
$self->{priority}->{$rule} = -100;
my $tf = $self->{tflags}->{$rule};
$self->{tflags}->{$rule} = ($tf ? $tf." " : "") .
($type eq 'ham' ? "nice " : "") .
"noautolearn";
}
elsif ($type eq "on") {
$self->{shortcircuit}->{$rule} = "on";
}
elsif ($type eq "off") {
delete $self->{shortcircuit}->{$rule};
}
else {
return $Mail::SpamAssassin::Conf::INVALID_VALUE;
}
}
});
=item shortcircuit_spam_score n.nn (default: 100)
When shortcircuit is used on a rule, and the shortcircuit classification type
is set to C<spam>, this value should be applied in place of the default score
for that rule.
=cut
push (@cmds, {
setting => 'shortcircuit_spam_score',
default => 100,
type => $Mail::SpamAssassin::Conf::CONF_TYPE_NUMERIC
});
=item shortcircuit_ham_score n.nn (default: -100)
When shortcircuit is used on a rule, and the shortcircuit classification type
is set to C<ham>, this value should be applied in place of the default score
for that rule.
=cut
push (@cmds, {
setting => 'shortcircuit_ham_score',
default => -100,
type => $Mail::SpamAssassin::Conf::CONF_TYPE_NUMERIC
});
$conf->{parser}->register_commands(\@cmds);
}
=back
=head1 TAGS
The following tags are added to the set available for use in reports, headers
etc.:
_SC_ shortcircuit status (classification and rule name)
_SCRULE_ rulename that caused the shortcircuit
_SCTYPE_ shortcircuit classification ("spam", "ham", "default", "none")
=cut
sub hit_rule {
my ($self, $params) = @_;
my $scan = $params->{permsgstatus};
my $rule = $params->{rulename};
# don't s/c if we're linting
return if ($scan->{lint_rules});
# don't s/c if we're in compile_now()
return if ($self->{am_compiling});
my $sctype = $scan->{conf}->{shortcircuit}->{$rule};
return unless $sctype;
my $conf = $scan->{conf};
my $score = $params->{score};
$scan->{shortcircuit_rule} = $rule;
my $scscore;
if ($sctype eq 'on') { # guess by rule score
dbg("shortcircuit: s/c due to $rule, using score of $score");
$scan->{shortcircuit_type} = ($score < 0 ? 'ham' : 'spam');
$scscore = ($score < 0) ? -0.0001 : 0.0001;
}
else {
$scan->{shortcircuit_type} = $sctype;
if ($sctype eq 'ham') {
$score = $conf->{shortcircuit_ham_score};
} else {
$score = $conf->{shortcircuit_spam_score};
}
dbg("shortcircuit: s/c $sctype due to $rule, using score of $score");
$scscore = $score;
}
# bug 5256: if we short-circuit, don't do auto-learning
$scan->{disable_auto_learning} = 1;
$scan->got_hit('SHORTCIRCUIT', '', score => $scscore);
}
sub parsed_metadata {
my ($self, $params) = @_;
my $scan = $params->{permsgstatus};
$scan->set_tag ('SC', sub {
my $rule = $scan->{shortcircuit_rule};
my $type = $scan->{shortcircuit_type};
return "$rule ($type)" if ($rule);
return "no";
});
$scan->set_tag ('SCRULE', sub {
my $rule = $scan->{shortcircuit_rule};
return ($rule || "none");
});
$scan->set_tag ('SCTYPE', sub {
my $type = $scan->{shortcircuit_type};
return ($type || "no");
});
$scan->set_spamd_result_item (sub {
"shortcircuit=".$scan->get_tag("SCTYPE");
});
}
sub have_shortcircuited {
my ($self, $params) = @_;
return (exists $params->{permsgstatus}->{shortcircuit_type}) ? 1 : 0;
}
sub compile_now_start {
my ($self, $params) = @_;
$self->{am_compiling} = 1;
}
sub compile_now_finish {
my ($self, $params) = @_;
delete $self->{am_compiling};
}
1;
=head1 SEE ALSO
C<http://issues.apache.org/SpamAssassin/show_bug.cgi?id=3109>
=cut
|