home *** CD-ROM | disk | FTP | other *** search
/ ftp.f-secure.com / 2014.06.ftp.f-secure.com.tar / ftp.f-secure.com / support / hotfix / fsis / IS-SpamControl.fsfix / iufssc / lib / Mail / SpamAssassin / PerMsgLearner.pm < prev    next >
Text File  |  2006-11-29  |  5KB  |  198 lines
  1. # <@LICENSE>
  2. # Licensed to the Apache Software Foundation (ASF) under one or more
  3. # contributor license agreements.  See the NOTICE file distributed with
  4. # this work for additional information regarding copyright ownership.
  5. # The ASF licenses this file to you under the Apache License, Version 2.0
  6. # (the "License"); you may not use this file except in compliance with
  7. # the License.  You may obtain a copy of the License at:
  8. # 
  9. #     http://www.apache.org/licenses/LICENSE-2.0
  10. # 
  11. # Unless required by applicable law or agreed to in writing, software
  12. # distributed under the License is distributed on an "AS IS" BASIS,
  13. # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14. # See the License for the specific language governing permissions and
  15. # limitations under the License.
  16. # </@LICENSE>
  17.  
  18. =head1 NAME
  19.  
  20. Mail::SpamAssassin::PerMsgLearner - per-message status (spam or not-spam)
  21.  
  22. =head1 SYNOPSIS
  23.  
  24.   my $spamtest = new Mail::SpamAssassin ({
  25.     'rules_filename'      => '/etc/spamassassin.rules',
  26.     'userprefs_filename'  => $ENV{HOME}.'/.spamassassin/user_prefs'
  27.   });
  28.   my $mail = $spamtest->parse();
  29.  
  30.   my $status = $spamtest->learn($mail,$id,$isspam,$forget);
  31.   my $didlearn = $status->did_learn();
  32.   $status->finish();
  33.  
  34.  
  35. =head1 DESCRIPTION
  36.  
  37. The Mail::SpamAssassin C<learn()> method returns an object of this
  38. class.  This object encapsulates all the per-message state for
  39. the learning process.
  40.  
  41. =head1 METHODS
  42.  
  43. =over 4
  44.  
  45. =cut
  46.  
  47. package Mail::SpamAssassin::PerMsgLearner;
  48.  
  49. use strict;
  50. use warnings;
  51. use bytes;
  52.  
  53. use Mail::SpamAssassin;
  54. use Mail::SpamAssassin::PerMsgStatus;
  55. use Mail::SpamAssassin::Bayes;
  56. use Mail::SpamAssassin::Logger;
  57.  
  58. use vars qw{
  59.   @ISA
  60. };
  61.  
  62. @ISA = qw();
  63.  
  64. ###########################################################################
  65.  
  66. sub new {
  67.   my $class = shift;
  68.   $class = ref($class) || $class;
  69.   my ($main, $msg) = @_;
  70.  
  71.   my $self = {
  72.     'main'              => $main,
  73.     'msg'               => $msg,
  74.     'learned'        => 0,
  75.   };
  76.  
  77.   $self->{conf} = $self->{main}->{conf};
  78.  
  79.   $self->{bayes_scanner} = $self->{main}->{bayes_scanner};
  80.  
  81.   bless ($self, $class);
  82.   $self;
  83. }
  84.  
  85. ###########################################################################
  86.  
  87. # $status->learn_spam($id)
  88. # 
  89. # Learn the message as spam.
  90. # 
  91. # C<$id> is an optional message-identification string, used internally
  92. # to tag the message.  If it is C<undef>, the Message-Id of the message
  93. # will be used.  It should be unique to that message.
  94. # 
  95. # This is a semi-private API; callers should use
  96. # C<$spamtest-E<gt>learn($mail,$id,$isspam,$forget)> instead.
  97.  
  98. sub learn_spam {
  99.   my ($self, $id) = @_;
  100.  
  101.   if ($self->{main}->{learn_with_whitelist}) {
  102.     $self->{main}->add_all_addresses_to_blacklist ($self->{msg});
  103.   }
  104.  
  105.   # use the real message-id here instead of mass-check's idea of an "id",
  106.   # as we may deliver the msg into another mbox format but later need
  107.   # to forget it's training.
  108.   $self->{learned} = $self->{bayes_scanner}->learn (1, $self->{msg}, $id);
  109. }
  110.  
  111. ###########################################################################
  112.  
  113. # $status->learn_ham($id)
  114. # 
  115. # Learn the message as ham.
  116. # 
  117. # C<$id> is an optional message-identification string, used internally
  118. # to tag the message.  If it is C<undef>, the Message-Id of the message
  119. # will be used.  It should be unique to that message.
  120. # 
  121. # This is a semi-private API; callers should use
  122. # C<$spamtest-E<gt>learn($mail,$id,$isspam,$forget)> instead.
  123.  
  124. sub learn_ham {
  125.   my ($self, $id) = @_;
  126.  
  127.   if ($self->{main}->{learn_with_whitelist}) {
  128.     $self->{main}->add_all_addresses_to_whitelist ($self->{msg});
  129.   }
  130.  
  131.   $self->{learned} = $self->{bayes_scanner}->learn (0, $self->{msg}, $id);
  132. }
  133.  
  134. ###########################################################################
  135.  
  136. # $status->forget($id)
  137. # 
  138. # Forget about a previously-learned message.
  139. # 
  140. # C<$id> is an optional message-identification string, used internally
  141. # to tag the message.  If it is C<undef>, the Message-Id of the message
  142. # will be used.  It should be unique to that message.
  143. # 
  144. # This is a semi-private API; callers should use
  145. # C<$spamtest-E<gt>learn($mail,$id,$isspam,$forget)> instead.
  146.  
  147. sub forget {
  148.   my ($self, $id) = @_;
  149.  
  150.   if ($self->{main}->{learn_with_whitelist}) {
  151.     $self->{main}->remove_all_addresses_from_whitelist ($self->{msg});
  152.   }
  153.  
  154.   $self->{learned} = $self->{bayes_scanner}->forget ($self->{msg}, $id);
  155. }
  156.  
  157. ###########################################################################
  158.  
  159. =item $didlearn = $status->did_learn()
  160.  
  161. Returns C<1> if the message was learned from or forgotten succesfully.
  162.  
  163. =cut
  164.  
  165. sub did_learn {
  166.   my ($self) = @_;
  167.   return ($self->{learned});
  168. }
  169.  
  170. ###########################################################################
  171.  
  172. =item $status->finish()
  173.  
  174. Finish with the object.
  175.  
  176. =cut
  177.  
  178. sub finish {
  179.   my $self = shift;
  180.   delete $self->{main};
  181.   delete $self->{msg};
  182.   delete $self->{conf};
  183.   delete $self->{bayes_scanner};
  184. }
  185.  
  186. ###########################################################################
  187.  
  188. 1;
  189. __END__
  190.  
  191. =back
  192.  
  193. =head1 SEE ALSO
  194.  
  195. C<Mail::SpamAssassin>
  196. C<spamassassin>
  197.  
  198.