+Config comments.
[PerlMail.git] / PerlMail / Config.pm
index e06be0c..49f6a58 100644 (file)
@@ -1,7 +1,7 @@
 #! /usr/bin/perl
 # 
 #      $Id$
-# Copyright (C) 2002-2003 Jan Kratochvil <short@ucw.cz>
+# Copyright (C) 2002-2003 Jan Kratochvil <project-PerlMail@jankratochvil.net>
 # 
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -31,47 +31,104 @@ use vars qw(@ISA @EXPORT);
                $HOME
                $Mail @ValidUsers $IdleMax $MaxBodySMS @SMSwebRcpt $SMSwebRcpt_username
                $Lock_pathname $PeerAddr $Socket_timeout $DB_table $DBI_database $DBI_user $DBI_pwd
-               $sendmail_orig @addr_addon &FromAddress @h_rcpt @h_from);
+               $sendmail_orig @addr_addon &FromAddress @h_rcpt @h_from
+               %audit_profile @sms_squeezes @alternates_host @dnsbl_whitelist
+
+               $Audit $is_pgp $opt_F $procmailFROM_MAILER $store_ignore $store_ignorenewmail
+               $store_profile
+               );
 
 require Mail::Alias;
 
 
+BEGIN {
+       for (qw(headerhas store headeris did dnsbl store_muttrc_alternates Received_for parts_linear mime_type
+                       body_first mimehead razor2 header_remap)) {
+               eval 'sub '.$_.' { return ::'.$_.'(@_); }';
+               }
+       }
+
+
 # perlmail-accept & perlmail-sendmail
 
+# Various configuration files location is derived from it:
 our $HOME="/home/lace";
 
 
 # perlmail-accept
 
+# Mail folder:
 our $Mail="$HOME/Mail";
+# Users respected for the 'idle' state (see $IdleMax):
 our @ValidUsers=qw(root lace short kratochvil _local);
+# Maximum number of local console idle seconds while still considered as 'active user':
 our $IdleMax=10;
-our $MaxBodySMS=0x1000;        # max bytes to pass to Lingua::EN::Squeeze
+# Maxium number of bytes to pass to Lingua::EN::Squeeze (performance optimization):
+our $MaxBodySMS=0x1000;
+# Telephone number to send SMSes by WWW::SMS to:
 our @SMSwebRcpt=qw(420 602 431329);
+# Some WWW::SMS modules require username:
 our $SMSwebRcpt_username="lace2";
 
 
 # perlmail-submit
 
+# Global system lock for exclusive $DB_table access:
 our $Lock_pathname="/tmp/PerlMail.lock";
+# 'workstation' hostname and port. Hostname may be dyndns:
 our $PeerAddr="exuhome.dyn.jankratochvil.net.:852";
 #our $PeerAddr="127.0.0.1:2852";
-our $Socket_timeout=7600;       # 15sec is NOT enough!
+# 15sec is NOT enough as the remote peer must complete mail store:
+our $Socket_timeout=7600;
+# MySQL table name:
 our $DB_table="PerlMail_folder";
+# MySQL database name:
 our $DBI_database="short";
+# MySQL user name:
 our $DBI_user="short";
+# MySQL user password:
 our $DBI_pwd=$ENV{"HOME"}."/priv/mysql.".$DBI_user.".pwd";
 
 
 # perlmail-sendmail
 
+# Lists where <rcpt-USER.AT.HOST@jankratochvil.net> address is generated:
+my @lists=qw(
+               tacplus-l@disaster.com
+               gsm@sh.cvut.cz
+               linux-fsdevel@vger.kernel.org
+               n9k@pandora.cz
+               dev9k@pandora.cz
+               gsm@pandora.cz
+               ros-general@reactos.com
+               ros-kernel@reactos.com
+               ros-cvs@reactos.com
+               4cinfo@atrey.karlin.mff.cuni.cz
+               libtool@gnu.org
+               libtool-patches@gnu.org
+               wine-license@winehq.com
+               wine-devel@winehq.com
+               wine-patches@winehq.com
+               gtk-devel-list@gnome.org
+               gnome-vfs-list@gnome.org
+               captive-announce-list@jankratochvil.net
+               captive-list@jankratochvil.net
+               captive-devel-list@jankratochvil.net
+               );
+
+# Pathname of the original sendmail(8) binary:
 our $sendmail_orig=(-x ($_="/usr/sbin/sendmail-orig") ? $_ : "/usr/sbin/sendmail");
+# List of addresses to locally Bcc all mails to:
 # Mail-Alias-1.12 defaults to "/etc/mail/aliases" which does not exist on RedHat sendmail-8.12.5-7
 # Mail-Alias-1.12 will clutter $_ !
 our @addr_addon=(Mail::Alias->new("/etc/aliases")->exists("sentout") ? ("sentout") : ());
 
 our $opt_F;    # imported
 our $is_pgp;   # imported
+my %lists=map(($_=>1),@lists);
+# Generate new From address for the target $rcpt of type Mail::Address.
+# $iserror is true for "MAIL FROM" RFC821 address, false for "From:" RFC822 address.
+# Returns: Mail::Address instance.
 sub FromAddress
 {
 my($rcpt,$iserror)=@_;
@@ -95,10 +152,10 @@ my($rcpt,$iserror)=@_;
                                'pgp-'.uc($default_key).'@jankratochvil.net',
                                );
                }
-       # !$is_pgp or fallback
+       return Mail::Address->new($phrase,'lace@jankratochvil.net') if !$lists{$rcpt->address()};
        return Mail::Address->new(
                        $phrase,
-                       (!$iserror ? 'rcpt' : 'rcpterr')
+                       'rcpt'
                                        .'-'
                                        .(defined($rcpt->user()) ? $rcpt->user() : "NOUSER")
                                        .".AT."
@@ -121,3 +178,279 @@ our @h_from=(
                "Resent-From",
                "From",
                );
+
+
+# My-Audit
+
+# Setup profile names.
+# First element of /^=/ form copies it referenced profile to be extended.
+# 'did'    =>did() subroutine will return true for it.
+# 'syslog' =>Use syslog(3).
+# 'bell'   =>Bell sound.
+# 'sms=\d+'=>Send SMS by WWW::SMS with specified maximum # of parts
+our %audit_profile=(
+               "btw"   =>[],
+               "silent"=>["=btw"   ,"did"],
+               "log"   =>["=silent","syslog"],
+               "bell"  =>["=log"   ,"bell"],
+               "sms"   =>["=bell"  ,"sms=1"],
+               "crit"  =>["=sms"   ,"sms=3"],
+               );
+# Try the squeezing methods in this order:
+our @sms_squeezes=(
+               { "SqueezeControl"=>"noconv"                         },
+               { "SqueezeControl"=>"conv"  ,"SQZ_OPTIMIZE_LEVEL"=>0 },
+               { "SqueezeControl"=>"conv"  ,"SQZ_OPTIMIZE_LEVEL"=>1 },
+               { "SqueezeControl"=>"med"   ,"SQZ_OPTIMIZE_LEVEL"=>0 },
+               { "SqueezeControl"=>"med"   ,"SQZ_OPTIMIZE_LEVEL"=>1 },
+               { "SqueezeControl"=>"max"   ,"SQZ_OPTIMIZE_LEVEL"=>0 },
+               { "SqueezeControl"=>"max"   ,"SQZ_OPTIMIZE_LEVEL"=>1 },
+               );
+# Hostnames where we had alternate e-mail addresses:
+our @alternates_host=(
+               "jabberwock.ucw.cz",    # short@ucw.cz
+               "atrey.karlin.mff.cuni.cz",     # short@atrey.karlin.mff.cuni.cz
+               "k332.feld.cvut.cz",    # short@k332.feld.cvut.cz
+               );
+# Override DNS blacklists:
+our @dnsbl_whitelist=(
+               "195.250.128.83",       # smtp3.vol.cz; vol.cz.multistage.blackholes.five-ten-sg.com.
+               "64.49.222.22",         # mail.pm.org: rackspace.com.spam-support.blackholes.five-ten-sg.com.
+               "208.147.243.5",        # gambit.liquidcomm.net: cw.net.spam-support.blackholes.five-ten-sg.com.
+               "213.235.135.70",       # smtp.tiscali.cz: tiscali.cz.multistage.blackholes.five-ten-sg.com.
+               "205.139.198.11",       # eniac.disaster.com: cw.net.spam-support.blackholes.five-ten-sg.com.
+               "127.0.0.2",                    # 2.0.0.127.relays.ordb.org.
+               "65.113.40.131",        # bozo.vmware.com: qwest.net.spam-support.blackholes.five-ten-sg.com.
+               "66.218.85.33",         # mta2.wss.scd.yahoo.com: yahoo.com.spam.blackholes.five-ten-sg.com.
+               "212.80.76.42",         # mx2.seznam.cz: seznam.cz.free.blackholes.five-ten-sg.com.
+               );
+
+our $Audit;    # imported
+our $procmailFROM_MAILER;      # imported
+our $store_ignorenewmail;      # imported
+our $store_profile;    # imported
+our $store_ignore;     # imported
+sub audit
+{
+       $store_profile=undef();
+       # TODO: <short-m@> storage?
+
+       # never spawn new mail if FROM_MAILER
+       # $isFROM_MAILER postponed after maillists as they may look as FROM_MAILER
+       #use re 'debug';
+       my $isFROM_MAILER=$Audit->header()=~/$procmailFROM_MAILER/mio;
+       $store_ignorenewmail=(0
+                       || $isFROM_MAILER
+                       || headerhas "From",'<Regexp:^owner->'
+                       );
+
+       # spam honeypots
+       return if did sub {
+               local $_;
+               # Do not local $store_file as it is our-imported
+               $store_profile="silent";
+               store "=spam"         if grep /^\Qshort\@k332.feld.cvut.cz\E/i,Received_for();
+               # TODO: foreign violation of RFC 822 section 4.4.4, Subject:.*Automatick.+odpov.+v.+nep.+tomnosti
+               store "=spam"         if headeris "From",'<ghandchi@hotmail.com>';
+               store "=spam"         if headeris "From",'<newsletter@levnapc.cz>';
+               store "=spam"         if headeris "From",'<Tomas@dtpstudio.cz>';
+               store "=spam"         if headeris "From",'<BNcom@email.bn.com>';
+               store "=spam"         if headeris "From",'<e4luck@lists.opt4email.com>';
+               store "=spam"         if headeris "From",'<mailcontests@lists.servitall.com>';
+               store "=spam"         if headeris "From",'<canda@lica.cz>';
+               {
+                       # weak detection: files with text/html w/o text/plain are usually a spam
+                       my @types_linear=map({ mime_type($_); } parts_linear());
+                       store "=spam"       if grep({ $_ eq "text/html"; } @types_linear) && !grep({ $_ eq "text/plain"; } @types_linear);
+                       }
+               store "=spam"         if ($_=mimehead(body_first())->mime_attr("Content-Type.charset")) && /^big5/i;
+               };
+       $store_profile=undef();
+
+       # spam detection
+       return if did sub {
+               # Do not local $store_file as it is our-imported
+               $store_profile="silent";
+               local $_;
+               store "=spam".($_ eq 1 ? "" : ";$_")      if $_=razor2();
+               };
+       $store_profile=undef();
+       return if did sub {
+               # Do not local $store_file as it is our-imported
+               $store_profile="silent";
+               local $_;
+               store "=spam"                      .";$_","log" if $_=dnsbl '.relays.ordb.org.' ,1;     # all hosts
+               store "=spam"                      .";$_","log" if $_=dnsbl '.blackholes.mail-abuse.org.' ,1;   # all hosts
+               # we don't check all hosts as they can be "dialup" category, FIXME: check for it
+               store "=spam"                      .";$_","log" if $_=dnsbl '.blackholes.five-ten-sg.com.',0; # just first
+               # I don't send viruses but viruses propagate mails of mine
+               store "=spam"                                   if headeris "X-Mailer",'ravmd/8.3.2';
+               };
+       $store_profile=undef();
+
+       # special delivery
+       store "=err","bell" and return if headerhas \&Received_for,'<short+err@>';
+
+       # ppl-wished foreign remapping, Reply-To is left untouched!
+       # FIXME: modifications are now being dropped by &write_message!
+       header_remap("From",{
+                       'kerere@post.cz'               =>'kamzik@k332.feld.cvut.cz',
+                       'profes@mbox.vol.cz'           =>'kratochvilova@egp.cz',
+                       'jkrouzek@mbox.vol.cz'         =>'krouzek@mbox.fsv.cuni.cz',
+                       'jakub.gorner@lidovky.cz'      =>'tonda@disnet.cz',
+                       'jan.kolar@videoprogress.cz'   =>'jenda.kolar@volny.cz',
+                       'daniel.rulicek@cponline.cz'   =>'daniel.rulicek@cpress.cz',
+                       'pavel@suse.cz'                =>'pavel@ucw.cz',
+                       });
+
+       # My obsolete e-mail addresses
+       store_muttrc_alternates "=redirect-","btw";
+
+       # nasty public lists with $store_ignore
+       {
+               # Do not local $store_file as it is our-imported
+               $store_profile="log";
+               local $store_ignore;
+               $store_ignore="smsmail"    if 1==$Audit->body() && length(join "",$Audit->body())<180;  # SMS mail
+               $store_ignore="sms OS"     if $Audit->subject()=~/^Email pro: /;        # "^Email pro: gsm@sh\.cvut\.cz$";
+               $store_ignore="list-moron" if grep { headeris "From",$_; } qw(
+                               <kempny@>
+                               <help.me@wo.cz>
+                               <mr.death@mail.cz>
+                               <danx3@centrum.cz>
+                               <@mujoskar.cz>
+                               <satko@quanto.nr.sanet.sk>
+                               <vithous@attorney.cz> <viroman@attorney.cz>
+                               <konf@klain.cz>
+                               <stein@tiscali.cz>
+                               <barevnej@volny.cz>
+                               );
+
+               store "=gsm"               if headeris  "Sender"   ,'<owner-gsm@sh.cvut.cz>';
+               store "=gsmpand"           if headeris  "List-Post",'<gsm@pandora.cz>';
+               store "=9kc","log"         if headeris  "List-Post",'<n9k@pandora.cz>';
+               store "=9kcd","log"        if headeris  "List-Post",'<dev9k@pandora.cz>';
+               }
+       $store_profile=undef();
+
+       # lists
+       store "=mozillabug","log"    if headeris "From"     ,'<bugzilla-daemon@mozilla.org>';
+       store "=9ku","log"           if headeris "List-Id"  ,'<9000.listman.net>';
+       store "=9kd","log"           if headeris "Sender"   ,'<owner-9000-developers@geekstuff.co.uk>';
+       store "=spong","log"         if headeris "List-Id"  ,'<spong-users.lists.sourceforge.net>';
+       store "=gtkd","silent"       if headeris "List-Id"  ,'<gtk-devel-list.gnome.org>';
+       store "=gnomevfs","log"      if headeris "List-Id"  ,'<gnome-vfs-list.gnome.org>';
+       store "=mffstatnice","bell"  if headeris "List-Post",'<statnice@atrey.karlin.mff.cuni.cz>';
+       store "=hw","log"            if headeris "List-Post",'<hw-news@list.gin.cz>';
+       store "=gnokii","log"        if headeris "List-Id"  ,'<gnokii-users.mail.freesoftware.fsf.org>';
+       store "=winelic","log"       if headeris "List-Id"  ,'<wine-license.winehq.com>';
+       store "=wined","silent"      if headeris "List-Id"  ,'<wine-devel.winehq.org>';
+       store "=winepat","silent"    if headeris "List-Id"  ,'<wine-patches.winehq.com>';
+       store "=winecvs","silent"    if headeris "List-Id"  ,'<wine-cvs.winehq.com>';
+       store "=wineann","log"       if headeris "List-Id"  ,'<wine-announce.winehq.com>';
+       store "=ros","log"           if headeris "List-Id"  ,'<ros-general.reactos.geldorp.nl>';
+       store "=roskernel","log"     if headeris "List-Id"  ,'<ros-kernel.reactos.com>';
+       store "=roscvs","silent"     if headeris "List-Id"  ,'<ros-cvs.reactos.com>';
+       store "=rosbug","log"        if headeris "Reply-To" ,'<scarab@reactos.wox.org>';
+       store "=fsd","silent"        if headeris "X-Mailing-List",'<linux-fsdevel@vger.kernel.org>';
+       store "=kerneld","silent"    if headeris "X-Mailing-List",'<linux-kernel@vger.kernel.org>';
+       store "=surprise","sms"      if headeris "List-Post",'<surprise@atrey.karlin.mff.cuni.cz>';
+       store "=surprisesuse","sms"  if headeris "Sender"   ,'<owner-surprise@suse.cz>';
+       store "=tacacs","log"        if headeris "Sender"   ,'<tacplus-l@disaster.com>';
+       store "=tacacs","log"        if headeris "Sender"   ,'<owner-tacplus-l@disaster.com>';
+       store "=tacacs","log"        if headeris "List-Id"  ,'<devel.lists.tacplus.org>';
+       store "=pm","sms"            if headeris "Sender"   ,'<owner-prague-pm@pm.org>';
+       store "=radary","log"        if headeris "Reply-To" ,'<pha@radary.cz>';
+       store "=dnet","log"          if headeris "Sender"   ,'<@lists.distributed.net>';
+       store "=linux-input","log"   if headeris "List-Post",'<linux-input@atrey.karlin.mff.cuni.cz>';
+       store "=strom","bell"        if headeris "List-Post",'<vodni-strom@atrey.karlin.mff.cuni.cz>';
+       store "=netinfo","log"       if headeris "Sender"   ,'<owner-netinfo-l@vol.cz>';
+       store "=saintmj","log"       if headeris "From"     ,'<netsaint@kam-enterprise.ms.mff.cuni.cz>';
+       store "=saintmj","log"       if headeris "From"     ,'<netsaint@kam.mff.cuni.cz>';
+       store "=4cerr","bell"        if headeris "From"     ,'<owner-4cinfo@atrey.karlin.mff.cuni.cz>';
+       store "=4c","sms"            if headeris "List-Post",'<4cinfo@atrey.karlin.mff.cuni.cz>';
+       store "=slashdot","bell"     if headeris "From"     ,'<slashdot@slashdot.org>';
+       store "=freshmeat","bell"    if headeris "From"     ,'<noreply@freshmeat.net>';
+       store "=sourceforge","bell"  if headeris "From"     ,'<noreply@sourceforge.net>';
+       store "=gsmperlcvs","silent" if headeris("From"     ,'<johan@intra.tektonica.com>')
+                                       && $Audit->subject()=~/^'.*' has been updated!$/;
+       store "=libtoold","log"      if headeris "List-Id"  ,'<libtool.gnu.org>';
+       store "=libtoolpat","log"    if headeris "List-Id"  ,'<libtool-patches.gnu.org>';
+       store "=cap","bell"          if headeris "List-Id"  ,'<captive-list.jankratochvil.net>';
+       store "=capd","bell"         if headeris "List-Id"  ,'<captive-devel-list.jankratochvil.net>';
+       store "=capann","bell"       if headeris "List-Id"  ,'<captive-announce-list.jankratochvil.net>';
+       # own webs
+       store "=energie","bell"      if headeris "From"     ,qr/^EnergieWeb/;
+       store "=ats","log"           if headeris("From"     ,'<root@ms.atspraha.cz>')
+                                       || (headeris("From",'<online@ringier.cz>') && headerhas("To",'<blesk@atspraha.cz>'));
+       store "=atscasablanca","log" if headeris "From"     ,'<casablanca@ms.atspraha.cz>';
+       store "=www-sms","log"       if headeris "List-Id"  ,'<www-sms-developers.lists.sourceforge.net>';
+
+       # Petr Koutecky does not mark his Stuff
+       store "=koutecky","log"      if headeris "From"     ,'<velkyhroch@seznam.cz>';
+
+       store "=errm","bell"         if $isFROM_MAILER && !did();
+
+       store "==","sms"             if !did;
+}
+
+sub audit_sms_address
+{
+my($obj)=@_;
+
+       my $address=$obj->address();
+       if (my $alternates=muttrc_get("alternates")) {
+               return "I" if $address=~/$alternates/si;
+               }
+       my %aliases=muttrc_aliases();
+       if (my $alias=$aliases{lc $address}) {
+               local $_=$alias;
+               s/\b(Bus)siness$/$1/i;
+               s/\.ident$//i;
+               return $_;
+               }
+       local $_=$address;
+       s/\.cz$//i;
+       return $_;
+}
+
+# $args{"from"}
+# $args{"subject"}
+# $args{"body"}
+sub audit_sms
+{
+my(%args)=@_;
+
+       my $from=(@{$args{"from"}} ? join(",",map({ audit_sms_address($_); } @{$args{"from"}})) : "?");
+       local $_;
+
+       $_=$args{"subject"};
+       # headers
+       s/(?:Re|Aw|Odp|Fw|Fwd|OT)(?:\[\d+\])?://ig;
+       # former subject
+       s/\bbylo:.*$//i;
+       s/\[\s*WAS:.*\]\s*$//i;
+       # trim
+       s/^\s*//s;
+       s/\s*$//s;
+       my $subject=$_;
+
+       $_=$args{"body"};
+       # max. 9 lines of .sig
+       s/\n-- (?:\n[^\n]*){0,9}$//gs;
+       # "Original Message"/"Puvodni zprava" etc. up to empty line
+       # "- - - Original message: - - -" is by "Lotus Notes Release 5.0.5  September 22, 2000"
+       s/(^|\n)[\s^\n]*(?:-----[\w\s]*-----|- - - Original message: - - -)[\s^\n]*(?:\n[^\n]+)*\n{2,}(?:\s*[^>\s].*$)?/\n/gs;
+       # Remove "..." lines (is it used by anyone except me?)
+       s/^\Q...\E$/*/gm;
+       # quoting "> "
+       s/^(?:\s*[[:upper:]]{0,3}>)+.*$/*/gm;
+       s/(?:^|\n)(?:\*\n+)+/\n*\n/gs;
+       # attributions
+       s/^.*\b(?:wrote|writes|napsal jste):\s*$//gm;
+       my $body=$_;
+
+       return [$from,"($subject)$body"];
+}
+
+1;