svn commit: r152620 - in spamassassin/trunk: lib/Mail/SpamAssassin/Plugin/MIMEHeader.pm rules/init.pre t/mimeheader.t

[jm...@apache.org]

Author: jm
Date: Mon Feb  7 21:03:38 2005
New Revision: 152620

URL: http://svn.apache.org/viewcvs?view=rev&rev=152620
Log:
bug 3781: a new plugin to support writing rules against headers in the message's internal MIME structure

Added:
    spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/MIMEHeader.pm
    spamassassin/trunk/t/mimeheader.t   (with props)
Modified:
    spamassassin/trunk/rules/init.pre

Added: spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/MIMEHeader.pm
URL: http://svn.apache.org/viewcvs/spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/MIMEHeader.pm?view=auto&rev=152620
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/MIMEHeader.pm (added)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/MIMEHeader.pm Mon Feb  7 21:03:38 2005
@@ -0,0 +1,206 @@
+# <@LICENSE>
+# Copyright 2004 Apache Software Foundation
+# 
+# Licensed 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
+
+MIMEHeader - perform regexp tests against MIME headers
+
+=head1 SYNOPSIS
+
+  loadplugin    Mail::SpamAssassin::Plugin::MIMEHeader
+  mimeheader	NAME_OF_RULE    Content-Id =~ /foo/
+
+=head1 DESCRIPTION
+
+This plugin allows regexp rules to be written against MIME headers in the
+message.
+
+=head1 CONFIGURATION
+
+=over 4
+
+=item mimeheader NAME_OF_RULE Header-Name =~ /pattern/modifiers
+
+Specify a rule.  C<NAME_OF_RULE> is the name of the rule to be used,
+C<Header-Name> is the name of the MIME header to check, and
+C</pattern/modifiers> is the Perl regular expression to match against this.
+
+Note that in a message of multiple parts, each header will be checked
+against the pattern separately.  In other words, if multiple parts
+have a 'Content-Type' header, each header's value will be tested
+individually as a separate string.
+
+Header names are considered case-insensitive.
+
+The header values are normally cleaned up a little. Append C<:raw> to the
+header name to retrieve the raw, undecoded value instead.
+
+=back
+
+=cut
+
+package Mail::SpamAssassin::Plugin::MIMEHeader;
+
+# Make the main dbg() accessible in our package w/o an extra function
+*dbg=\&Mail::SpamAssassin::Plugin::dbg;
+
+use Mail::SpamAssassin::Plugin;
+use Mail::SpamAssassin::Conf;
+use strict;
+use warnings;
+use bytes;
+
+use vars qw(@ISA);
+@ISA = qw(Mail::SpamAssassin::Plugin);
+
+# ---------------------------------------------------------------------------
+
+# constructor
+sub new {
+  my $class = shift;
+  my $samain = shift;
+
+  # some boilerplate...
+  $class = ref($class) || $class;
+  my $self = $class->SUPER::new($samain);
+  bless ($self, $class);
+
+  $self->set_config($samain->{conf});
+
+  return $self;
+}
+
+# ---------------------------------------------------------------------------
+
+sub set_config {
+  my($self, $conf) = @_;
+  my @cmds = ();
+
+  my $pluginobj = $self;        # allow use inside the closure below
+
+  push (@cmds, {
+    setting => 'mimeheader',
+    code => sub {
+      my ($self, $key, $value, $line) = @_;
+      if ($value !~ /^(\S+)\s+(\S+)\s+([\=\!]\~)\s+(.+)$/) {
+        return $Mail::SpamAssassin::Conf::INVALID_VALUE;
+      }
+
+      my $rulename = $1;
+      my $hdrname = $2;
+      my $negated = ($3 eq '!~') ? 1 : 0;
+      my $pattern = $4;
+
+      $pattern = $pluginobj->make_qr($pattern);
+
+      if (!$pattern || !$self->{parser}->is_regexp_valid($rulename, $pattern))
+      {
+        return $Mail::SpamAssassin::Conf::INVALID_VALUE;
+      }
+
+      $self->{mimeheader_tests}->{$rulename} = {
+        hdr => $hdrname,
+        negated => $negated,
+        if_unset => '',             # TODO!
+        pattern => $pattern
+      };
+
+      # now here's a hack; generate a fake eval rule function to
+      # call this rule's _real_ code!
+      # TODO: we should have a more elegant way for new rule types to
+      # be defined
+      my $evalfn = "_mimeheader_eval_$rulename";
+      $evalfn =~ s/[^a-zA-Z0-9_]/_/gs;
+
+      $self->{parser}->add_test($rulename, $evalfn."()",
+                $Mail::SpamAssassin::Conf::TYPE_BODY_EVALS);
+      my $evalcode = '
+        sub Mail::SpamAssassin::Plugin::MIMEHeader::'.$evalfn.' {
+          $_[0]->eval_hook_called($_[1], q{'.$rulename.'});
+        }
+      ';
+
+      eval $evalcode;
+      if ($@) {
+        warn "plugin error: $@";
+        return $Mail::SpamAssassin::Conf::INVALID_VALUE;
+      }
+
+      $pluginobj->register_eval_rule($evalfn);
+    }
+  });
+
+  $conf->{parser}->register_commands(\@cmds);
+}
+
+# ---------------------------------------------------------------------------
+
+sub eval_hook_called {
+  my ($pobj, $scanner, $rulename) = @_;
+
+  my $rule = $scanner->{conf}->{mimeheader_tests}->{$rulename};
+  my $hdr = $rule->{hdr};
+  my $negated = $rule->{negated};
+  my $if_unset = $rule->{if_unset};
+  my $pattern = $rule->{pattern};
+
+
+  my $getraw;
+  if ($hdr =~ s/:raw$//i) {
+    $getraw = 1;
+  } else {
+    $getraw = 0;
+  }
+
+  foreach my $p ($scanner->{msg}->find_parts(qr/./)) {
+    my $val = $p->get_header($hdr, $getraw);
+    $val ||= $if_unset;
+
+    if ($val =~ ${pattern}) {
+      return ($negated ? 0 : 1);
+    }
+  }
+
+  return ($negated ? 1 : 0);
+}
+
+# ---------------------------------------------------------------------------
+
+# turn "/foobar/i" into qr/(?i)foobar/
+sub make_qr {
+  my ($self, $pattern) = @_;
+
+  my $re_delim;
+  if ($pattern =~ s/^m(\W)//) {     # m!foo/bar!
+    $re_delim = $1;
+  } else {                          # /foo\/bar/ or !foo/bar!
+    $pattern =~ s/^(\W)//; $re_delim = $1;
+  }
+  if (!$re_delim) {
+    return;
+  }
+
+  $pattern =~ s/${re_delim}([imsx]*)$//;
+
+  my $mods = $1;
+  if ($mods) { $pattern = "(?".$mods.")".$pattern; }
+
+  return qr/$pattern/;
+}
+
+# ---------------------------------------------------------------------------
+
+1;

Modified: spamassassin/trunk/rules/init.pre
URL: http://svn.apache.org/viewcvs/spamassassin/trunk/rules/init.pre?view=diff&r1=152619&r2=152620
==============================================================================
--- spamassassin/trunk/rules/init.pre (original)
+++ spamassassin/trunk/rules/init.pre Mon Feb  7 21:03:38 2005
@@ -59,3 +59,8 @@
 # AutoLearnThreshold - threshold-based discriminator for Bayes auto-learning
 #
 loadplugin Mail::SpamAssassin::Plugin::AutoLearnThreshold
+
+# MIMEHeader - apply regexp rules against MIME headers in the message
+#
+loadplugin Mail::SpamAssassin::Plugin::MIMEHeader
+

Added: spamassassin/trunk/t/mimeheader.t
URL: http://svn.apache.org/viewcvs/spamassassin/trunk/t/mimeheader.t?view=auto&rev=152620
==============================================================================
--- spamassassin/trunk/t/mimeheader.t (added)
+++ spamassassin/trunk/t/mimeheader.t Mon Feb  7 21:03:38 2005
@@ -0,0 +1,27 @@
+#!/usr/bin/perl
+
+use lib '.'; use lib 't';
+use SATest; sa_t_init("mimeheader");
+use Test; BEGIN { plan tests => 2 };
+
+$ENV{'LC_ALL'} = 'C';             # a cheat, but we need the patterns to work
+
+# ---------------------------------------------------------------------------
+
+%patterns = (
+
+  q{ MIMEHEADER_TEST1 }, q{ test1 },
+  q{ MIMEHEADER_TEST2 }, q{ test2 },
+
+);
+
+tstprefs ("
+
+  loadplugin Mail::SpamAssassin::Plugin::MIMEHeader
+  mimeheader MIMEHEADER_TEST1 content-type =~ /application\/msword/
+  mimeheader MIMEHEADER_TEST2 content-type =~ m!APPLICATION/MSWORD!i
+
+	");
+
+sarun ("-L -t < data/nice/004", \&patterns_run_cb);
+ok_all_patterns();

Propchange: spamassassin/trunk/t/mimeheader.t
------------------------------------------------------------------------------
    svn:executable = *