+Config comments.
[PerlMail.git] / PerlMail / Config.pm
1 #! /usr/bin/perl
2
3 #       $Id$
4 # Copyright (C) 2002-2003 Jan Kratochvil <project-PerlMail@jankratochvil.net>
5
6 # This program is free software; you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation; either version 2 of the License, or
9 # (at your option) any later version.
10
11 # This program is distributed in the hope that it will be useful,
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 # GNU General Public License for more details.
15
16 # You should have received a copy of the GNU General Public License
17 # along with this program; if not, write to the Free Software
18 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19
20
21 package PerlMail::Config;
22 use vars qw($VERSION);
23 $VERSION=do { my @r=(q$Revision$=~/\d+/g); sprintf "%d.".("%03d"x$#r),@r; };
24 use strict;
25 use warnings;
26
27 require Exporter;
28 use vars qw(@ISA @EXPORT);
29 @ISA=qw(Exporter);
30 @EXPORT=qw(
31                 $HOME
32                 $Mail @ValidUsers $IdleMax $MaxBodySMS @SMSwebRcpt $SMSwebRcpt_username
33                 $Lock_pathname $PeerAddr $Socket_timeout $DB_table $DBI_database $DBI_user $DBI_pwd
34                 $sendmail_orig @addr_addon &FromAddress @h_rcpt @h_from
35                 %audit_profile @sms_squeezes @alternates_host @dnsbl_whitelist
36
37                 $Audit $is_pgp $opt_F $procmailFROM_MAILER $store_ignore $store_ignorenewmail
38                 $store_profile
39                 );
40
41 require Mail::Alias;
42
43
44 BEGIN {
45         for (qw(headerhas store headeris did dnsbl store_muttrc_alternates Received_for parts_linear mime_type
46                         body_first mimehead razor2 header_remap)) {
47                 eval 'sub '.$_.' { return ::'.$_.'(@_); }';
48                 }
49         }
50
51
52 # perlmail-accept & perlmail-sendmail
53
54 # Various configuration files location is derived from it:
55 our $HOME="/home/lace";
56
57
58 # perlmail-accept
59
60 # Mail folder:
61 our $Mail="$HOME/Mail";
62 # Users respected for the 'idle' state (see $IdleMax):
63 our @ValidUsers=qw(root lace short kratochvil _local);
64 # Maximum number of local console idle seconds while still considered as 'active user':
65 our $IdleMax=10;
66 # Maxium number of bytes to pass to Lingua::EN::Squeeze (performance optimization):
67 our $MaxBodySMS=0x1000;
68 # Telephone number to send SMSes by WWW::SMS to:
69 our @SMSwebRcpt=qw(420 602 431329);
70 # Some WWW::SMS modules require username:
71 our $SMSwebRcpt_username="lace2";
72
73
74 # perlmail-submit
75
76 # Global system lock for exclusive $DB_table access:
77 our $Lock_pathname="/tmp/PerlMail.lock";
78 # 'workstation' hostname and port. Hostname may be dyndns:
79 our $PeerAddr="exuhome.dyn.jankratochvil.net.:852";
80 #our $PeerAddr="127.0.0.1:2852";
81 # 15sec is NOT enough as the remote peer must complete mail store:
82 our $Socket_timeout=7600;
83 # MySQL table name:
84 our $DB_table="PerlMail_folder";
85 # MySQL database name:
86 our $DBI_database="short";
87 # MySQL user name:
88 our $DBI_user="short";
89 # MySQL user password:
90 our $DBI_pwd=$ENV{"HOME"}."/priv/mysql.".$DBI_user.".pwd";
91
92
93 # perlmail-sendmail
94
95 # Lists where <rcpt-USER.AT.HOST@jankratochvil.net> address is generated:
96 my @lists=qw(
97                 tacplus-l@disaster.com
98                 gsm@sh.cvut.cz
99                 linux-fsdevel@vger.kernel.org
100                 n9k@pandora.cz
101                 dev9k@pandora.cz
102                 gsm@pandora.cz
103                 ros-general@reactos.com
104                 ros-kernel@reactos.com
105                 ros-cvs@reactos.com
106                 4cinfo@atrey.karlin.mff.cuni.cz
107                 libtool@gnu.org
108                 libtool-patches@gnu.org
109                 wine-license@winehq.com
110                 wine-devel@winehq.com
111                 wine-patches@winehq.com
112                 gtk-devel-list@gnome.org
113                 gnome-vfs-list@gnome.org
114                 captive-announce-list@jankratochvil.net
115                 captive-list@jankratochvil.net
116                 captive-devel-list@jankratochvil.net
117                 );
118
119 # Pathname of the original sendmail(8) binary:
120 our $sendmail_orig=(-x ($_="/usr/sbin/sendmail-orig") ? $_ : "/usr/sbin/sendmail");
121 # List of addresses to locally Bcc all mails to:
122 # Mail-Alias-1.12 defaults to "/etc/mail/aliases" which does not exist on RedHat sendmail-8.12.5-7
123 # Mail-Alias-1.12 will clutter $_ !
124 our @addr_addon=(Mail::Alias->new("/etc/aliases")->exists("sentout") ? ("sentout") : ());
125
126 our $opt_F;     # imported
127 our $is_pgp;    # imported
128 my %lists=map(($_=>1),@lists);
129 # Generate new From address for the target $rcpt of type Mail::Address.
130 # $iserror is true for "MAIL FROM" RFC821 address, false for "From:" RFC822 address.
131 # Returns: Mail::Address instance.
132 sub FromAddress
133 {
134 my($rcpt,$iserror)=@_;
135
136         my $phrase=(defined $opt_F ? $opt_F : "Jan Kratochvil");
137         {
138                 last if !$is_pgp;
139                 last if $iserror;
140                 local *F;
141                 local $_;
142                 my $filename="$HOME/.gnupg/options";
143                 open F,$filename or do { warn "Open \"$filename\": $!"; last; };
144                 local $/="\n";
145                 my @keys=map((/^\s*default-key\s+(\S+)\s*$/),<F>);
146                 @keys==1 or do { warn "Found ".scalar(@keys)." 'default-key's in your \"$filename\", ignoring"; last; };
147                 close F or warn "Close \"$filename\": $!";
148                 my $default_key=$keys[0];
149                 $default_key=~/^[[:xdigit:]]{8}$/ or do { warn "Invalid 'default-key', ignoring: $default_key"; last; };
150                 return Mail::Address->new(
151                                 $phrase,
152                                 'pgp-'.uc($default_key).'@jankratochvil.net',
153                                 );
154                 }
155         return Mail::Address->new($phrase,'lace@jankratochvil.net') if !$lists{$rcpt->address()};
156         return Mail::Address->new(
157                         $phrase,
158                         'rcpt'
159                                         .'-'
160                                         .(defined($rcpt->user()) ? $rcpt->user() : "NOUSER")
161                                         .".AT."
162                                         .(defined($rcpt->host()) ? $rcpt->host() : "LOCAL")
163                                         .'@jankratochvil.net',
164                         );
165 }
166
167 # RedHat sendmail-8.9.3-20/src/conf.c/HdrInfo[]/\Q/* destination fields */\E
168 # FIXME: Recognize "Resent-$_" headers for -t but when we are in 'resent' mode?
169 our @h_rcpt=(   # case in-sensitive!
170                 "To",
171                 "Cc",
172                 "Bcc",
173                 "Apparently-To",
174                 );
175 # ordering matters; first header found is substituted
176 # last header is subsituted if no one is found
177 our @h_from=(
178                 "Resent-From",
179                 "From",
180                 );
181
182
183 # My-Audit
184
185 # Setup profile names.
186 # First element of /^=/ form copies it referenced profile to be extended.
187 # 'did'    =>did() subroutine will return true for it.
188 # 'syslog' =>Use syslog(3).
189 # 'bell'   =>Bell sound.
190 # 'sms=\d+'=>Send SMS by WWW::SMS with specified maximum # of parts
191 our %audit_profile=(
192                 "btw"   =>[],
193                 "silent"=>["=btw"   ,"did"],
194                 "log"   =>["=silent","syslog"],
195                 "bell"  =>["=log"   ,"bell"],
196                 "sms"   =>["=bell"  ,"sms=1"],
197                 "crit"  =>["=sms"   ,"sms=3"],
198                 );
199 # Try the squeezing methods in this order:
200 our @sms_squeezes=(
201                 { "SqueezeControl"=>"noconv"                         },
202                 { "SqueezeControl"=>"conv"  ,"SQZ_OPTIMIZE_LEVEL"=>0 },
203                 { "SqueezeControl"=>"conv"  ,"SQZ_OPTIMIZE_LEVEL"=>1 },
204                 { "SqueezeControl"=>"med"   ,"SQZ_OPTIMIZE_LEVEL"=>0 },
205                 { "SqueezeControl"=>"med"   ,"SQZ_OPTIMIZE_LEVEL"=>1 },
206                 { "SqueezeControl"=>"max"   ,"SQZ_OPTIMIZE_LEVEL"=>0 },
207                 { "SqueezeControl"=>"max"   ,"SQZ_OPTIMIZE_LEVEL"=>1 },
208                 );
209 # Hostnames where we had alternate e-mail addresses:
210 our @alternates_host=(
211                 "jabberwock.ucw.cz",    # short@ucw.cz
212                 "atrey.karlin.mff.cuni.cz",     # short@atrey.karlin.mff.cuni.cz
213                 "k332.feld.cvut.cz",    # short@k332.feld.cvut.cz
214                 );
215 # Override DNS blacklists:
216 our @dnsbl_whitelist=(
217                 "195.250.128.83",       # smtp3.vol.cz; vol.cz.multistage.blackholes.five-ten-sg.com.
218                 "64.49.222.22",         # mail.pm.org: rackspace.com.spam-support.blackholes.five-ten-sg.com.
219                 "208.147.243.5",        # gambit.liquidcomm.net: cw.net.spam-support.blackholes.five-ten-sg.com.
220                 "213.235.135.70",       # smtp.tiscali.cz: tiscali.cz.multistage.blackholes.five-ten-sg.com.
221                 "205.139.198.11",       # eniac.disaster.com: cw.net.spam-support.blackholes.five-ten-sg.com.
222                 "127.0.0.2",                    # 2.0.0.127.relays.ordb.org.
223                 "65.113.40.131",        # bozo.vmware.com: qwest.net.spam-support.blackholes.five-ten-sg.com.
224                 "66.218.85.33",         # mta2.wss.scd.yahoo.com: yahoo.com.spam.blackholes.five-ten-sg.com.
225                 "212.80.76.42",         # mx2.seznam.cz: seznam.cz.free.blackholes.five-ten-sg.com.
226                 );
227
228 our $Audit;     # imported
229 our $procmailFROM_MAILER;       # imported
230 our $store_ignorenewmail;       # imported
231 our $store_profile;     # imported
232 our $store_ignore;      # imported
233 sub audit
234 {
235         $store_profile=undef();
236         # TODO: <short-m@> storage?
237
238         # never spawn new mail if FROM_MAILER
239         # $isFROM_MAILER postponed after maillists as they may look as FROM_MAILER
240         #use re 'debug';
241         my $isFROM_MAILER=$Audit->header()=~/$procmailFROM_MAILER/mio;
242         $store_ignorenewmail=(0
243                         || $isFROM_MAILER
244                         || headerhas "From",'<Regexp:^owner->'
245                         );
246
247         # spam honeypots
248         return if did sub {
249                 local $_;
250                 # Do not local $store_file as it is our-imported
251                 $store_profile="silent";
252                 store "=spam"         if grep /^\Qshort\@k332.feld.cvut.cz\E/i,Received_for();
253                 # TODO: foreign violation of RFC 822 section 4.4.4, Subject:.*Automatick.+odpov.+v.+nep.+tomnosti
254                 store "=spam"         if headeris "From",'<ghandchi@hotmail.com>';
255                 store "=spam"         if headeris "From",'<newsletter@levnapc.cz>';
256                 store "=spam"         if headeris "From",'<Tomas@dtpstudio.cz>';
257                 store "=spam"         if headeris "From",'<BNcom@email.bn.com>';
258                 store "=spam"         if headeris "From",'<e4luck@lists.opt4email.com>';
259                 store "=spam"         if headeris "From",'<mailcontests@lists.servitall.com>';
260                 store "=spam"         if headeris "From",'<canda@lica.cz>';
261                 {
262                         # weak detection: files with text/html w/o text/plain are usually a spam
263                         my @types_linear=map({ mime_type($_); } parts_linear());
264                         store "=spam"       if grep({ $_ eq "text/html"; } @types_linear) && !grep({ $_ eq "text/plain"; } @types_linear);
265                         }
266                 store "=spam"         if ($_=mimehead(body_first())->mime_attr("Content-Type.charset")) && /^big5/i;
267                 };
268         $store_profile=undef();
269
270         # spam detection
271         return if did sub {
272                 # Do not local $store_file as it is our-imported
273                 $store_profile="silent";
274                 local $_;
275                 store "=spam".($_ eq 1 ? "" : ";$_")      if $_=razor2();
276                 };
277         $store_profile=undef();
278         return if did sub {
279                 # Do not local $store_file as it is our-imported
280                 $store_profile="silent";
281                 local $_;
282                 store "=spam"                      .";$_","log" if $_=dnsbl '.relays.ordb.org.' ,1;     # all hosts
283                 store "=spam"                      .";$_","log" if $_=dnsbl '.blackholes.mail-abuse.org.' ,1;   # all hosts
284                 # we don't check all hosts as they can be "dialup" category, FIXME: check for it
285                 store "=spam"                      .";$_","log" if $_=dnsbl '.blackholes.five-ten-sg.com.',0; # just first
286                 # I don't send viruses but viruses propagate mails of mine
287                 store "=spam"                                   if headeris "X-Mailer",'ravmd/8.3.2';
288                 };
289         $store_profile=undef();
290
291         # special delivery
292         store "=err","bell" and return if headerhas \&Received_for,'<short+err@>';
293
294         # ppl-wished foreign remapping, Reply-To is left untouched!
295         # FIXME: modifications are now being dropped by &write_message!
296         header_remap("From",{
297                         'kerere@post.cz'               =>'kamzik@k332.feld.cvut.cz',
298                         'profes@mbox.vol.cz'           =>'kratochvilova@egp.cz',
299                         'jkrouzek@mbox.vol.cz'         =>'krouzek@mbox.fsv.cuni.cz',
300                         'jakub.gorner@lidovky.cz'      =>'tonda@disnet.cz',
301                         'jan.kolar@videoprogress.cz'   =>'jenda.kolar@volny.cz',
302                         'daniel.rulicek@cponline.cz'   =>'daniel.rulicek@cpress.cz',
303                         'pavel@suse.cz'                =>'pavel@ucw.cz',
304                         });
305
306         # My obsolete e-mail addresses
307         store_muttrc_alternates "=redirect-","btw";
308
309         # nasty public lists with $store_ignore
310         {
311                 # Do not local $store_file as it is our-imported
312                 $store_profile="log";
313                 local $store_ignore;
314                 $store_ignore="smsmail"    if 1==$Audit->body() && length(join "",$Audit->body())<180;  # SMS mail
315                 $store_ignore="sms OS"     if $Audit->subject()=~/^Email pro: /;        # "^Email pro: gsm@sh\.cvut\.cz$";
316                 $store_ignore="list-moron" if grep { headeris "From",$_; } qw(
317                                 <kempny@>
318                                 <help.me@wo.cz>
319                                 <mr.death@mail.cz>
320                                 <danx3@centrum.cz>
321                                 <@mujoskar.cz>
322                                 <satko@quanto.nr.sanet.sk>
323                                 <vithous@attorney.cz> <viroman@attorney.cz>
324                                 <konf@klain.cz>
325                                 <stein@tiscali.cz>
326                                 <barevnej@volny.cz>
327                                 );
328
329                 store "=gsm"               if headeris  "Sender"   ,'<owner-gsm@sh.cvut.cz>';
330                 store "=gsmpand"           if headeris  "List-Post",'<gsm@pandora.cz>';
331                 store "=9kc","log"         if headeris  "List-Post",'<n9k@pandora.cz>';
332                 store "=9kcd","log"        if headeris  "List-Post",'<dev9k@pandora.cz>';
333                 }
334         $store_profile=undef();
335
336         # lists
337         store "=mozillabug","log"    if headeris "From"     ,'<bugzilla-daemon@mozilla.org>';
338         store "=9ku","log"           if headeris "List-Id"  ,'<9000.listman.net>';
339         store "=9kd","log"           if headeris "Sender"   ,'<owner-9000-developers@geekstuff.co.uk>';
340         store "=spong","log"         if headeris "List-Id"  ,'<spong-users.lists.sourceforge.net>';
341         store "=gtkd","silent"       if headeris "List-Id"  ,'<gtk-devel-list.gnome.org>';
342         store "=gnomevfs","log"      if headeris "List-Id"  ,'<gnome-vfs-list.gnome.org>';
343         store "=mffstatnice","bell"  if headeris "List-Post",'<statnice@atrey.karlin.mff.cuni.cz>';
344         store "=hw","log"            if headeris "List-Post",'<hw-news@list.gin.cz>';
345         store "=gnokii","log"        if headeris "List-Id"  ,'<gnokii-users.mail.freesoftware.fsf.org>';
346         store "=winelic","log"       if headeris "List-Id"  ,'<wine-license.winehq.com>';
347         store "=wined","silent"      if headeris "List-Id"  ,'<wine-devel.winehq.org>';
348         store "=winepat","silent"    if headeris "List-Id"  ,'<wine-patches.winehq.com>';
349         store "=winecvs","silent"    if headeris "List-Id"  ,'<wine-cvs.winehq.com>';
350         store "=wineann","log"       if headeris "List-Id"  ,'<wine-announce.winehq.com>';
351         store "=ros","log"           if headeris "List-Id"  ,'<ros-general.reactos.geldorp.nl>';
352         store "=roskernel","log"     if headeris "List-Id"  ,'<ros-kernel.reactos.com>';
353         store "=roscvs","silent"     if headeris "List-Id"  ,'<ros-cvs.reactos.com>';
354         store "=rosbug","log"        if headeris "Reply-To" ,'<scarab@reactos.wox.org>';
355         store "=fsd","silent"        if headeris "X-Mailing-List",'<linux-fsdevel@vger.kernel.org>';
356         store "=kerneld","silent"    if headeris "X-Mailing-List",'<linux-kernel@vger.kernel.org>';
357         store "=surprise","sms"      if headeris "List-Post",'<surprise@atrey.karlin.mff.cuni.cz>';
358         store "=surprisesuse","sms"  if headeris "Sender"   ,'<owner-surprise@suse.cz>';
359         store "=tacacs","log"        if headeris "Sender"   ,'<tacplus-l@disaster.com>';
360         store "=tacacs","log"        if headeris "Sender"   ,'<owner-tacplus-l@disaster.com>';
361         store "=tacacs","log"        if headeris "List-Id"  ,'<devel.lists.tacplus.org>';
362         store "=pm","sms"            if headeris "Sender"   ,'<owner-prague-pm@pm.org>';
363         store "=radary","log"        if headeris "Reply-To" ,'<pha@radary.cz>';
364         store "=dnet","log"          if headeris "Sender"   ,'<@lists.distributed.net>';
365         store "=linux-input","log"   if headeris "List-Post",'<linux-input@atrey.karlin.mff.cuni.cz>';
366         store "=strom","bell"        if headeris "List-Post",'<vodni-strom@atrey.karlin.mff.cuni.cz>';
367         store "=netinfo","log"       if headeris "Sender"   ,'<owner-netinfo-l@vol.cz>';
368         store "=saintmj","log"       if headeris "From"     ,'<netsaint@kam-enterprise.ms.mff.cuni.cz>';
369         store "=saintmj","log"       if headeris "From"     ,'<netsaint@kam.mff.cuni.cz>';
370         store "=4cerr","bell"        if headeris "From"     ,'<owner-4cinfo@atrey.karlin.mff.cuni.cz>';
371         store "=4c","sms"            if headeris "List-Post",'<4cinfo@atrey.karlin.mff.cuni.cz>';
372         store "=slashdot","bell"     if headeris "From"     ,'<slashdot@slashdot.org>';
373         store "=freshmeat","bell"    if headeris "From"     ,'<noreply@freshmeat.net>';
374         store "=sourceforge","bell"  if headeris "From"     ,'<noreply@sourceforge.net>';
375         store "=gsmperlcvs","silent" if headeris("From"     ,'<johan@intra.tektonica.com>')
376                                         && $Audit->subject()=~/^'.*' has been updated!$/;
377         store "=libtoold","log"      if headeris "List-Id"  ,'<libtool.gnu.org>';
378         store "=libtoolpat","log"    if headeris "List-Id"  ,'<libtool-patches.gnu.org>';
379         store "=cap","bell"          if headeris "List-Id"  ,'<captive-list.jankratochvil.net>';
380         store "=capd","bell"         if headeris "List-Id"  ,'<captive-devel-list.jankratochvil.net>';
381         store "=capann","bell"       if headeris "List-Id"  ,'<captive-announce-list.jankratochvil.net>';
382         # own webs
383         store "=energie","bell"      if headeris "From"     ,qr/^EnergieWeb/;
384         store "=ats","log"           if headeris("From"     ,'<root@ms.atspraha.cz>')
385                                         || (headeris("From",'<online@ringier.cz>') && headerhas("To",'<blesk@atspraha.cz>'));
386         store "=atscasablanca","log" if headeris "From"     ,'<casablanca@ms.atspraha.cz>';
387         store "=www-sms","log"       if headeris "List-Id"  ,'<www-sms-developers.lists.sourceforge.net>';
388
389         # Petr Koutecky does not mark his Stuff
390         store "=koutecky","log"      if headeris "From"     ,'<velkyhroch@seznam.cz>';
391
392         store "=errm","bell"         if $isFROM_MAILER && !did();
393
394         store "==","sms"             if !did;
395 }
396
397 sub audit_sms_address
398 {
399 my($obj)=@_;
400
401         my $address=$obj->address();
402         if (my $alternates=muttrc_get("alternates")) {
403                 return "I" if $address=~/$alternates/si;
404                 }
405         my %aliases=muttrc_aliases();
406         if (my $alias=$aliases{lc $address}) {
407                 local $_=$alias;
408                 s/\b(Bus)siness$/$1/i;
409                 s/\.ident$//i;
410                 return $_;
411                 }
412         local $_=$address;
413         s/\.cz$//i;
414         return $_;
415 }
416
417 # $args{"from"}
418 # $args{"subject"}
419 # $args{"body"}
420 sub audit_sms
421 {
422 my(%args)=@_;
423
424         my $from=(@{$args{"from"}} ? join(",",map({ audit_sms_address($_); } @{$args{"from"}})) : "?");
425         local $_;
426
427         $_=$args{"subject"};
428         # headers
429         s/(?:Re|Aw|Odp|Fw|Fwd|OT)(?:\[\d+\])?://ig;
430         # former subject
431         s/\bbylo:.*$//i;
432         s/\[\s*WAS:.*\]\s*$//i;
433         # trim
434         s/^\s*//s;
435         s/\s*$//s;
436         my $subject=$_;
437
438         $_=$args{"body"};
439         # max. 9 lines of .sig
440         s/\n-- (?:\n[^\n]*){0,9}$//gs;
441         # "Original Message"/"Puvodni zprava" etc. up to empty line
442         # "- - - Original message: - - -" is by "Lotus Notes Release 5.0.5  September 22, 2000"
443         s/(^|\n)[\s^\n]*(?:-----[\w\s]*-----|- - - Original message: - - -)[\s^\n]*(?:\n[^\n]+)*\n{2,}(?:\s*[^>\s].*$)?/\n/gs;
444         # Remove "..." lines (is it used by anyone except me?)
445         s/^\Q...\E$/*/gm;
446         # quoting "> "
447         s/^(?:\s*[[:upper:]]{0,3}>)+.*$/*/gm;
448         s/(?:^|\n)(?:\*\n+)+/\n*\n/gs;
449         # attributions
450         s/^.*\b(?:wrote|writes|napsal jste):\s*$//gm;
451         my $body=$_;
452
453         return [$from,"($subject)$body"];
454 }
455
456 1;