]> git.deb.at Git - pkg/t-prot.git/blob - t-prot
Imported Upstream version 2.7.1
[pkg/t-prot.git] / t-prot
1 #!/usr/bin/perl -w
2 # $Id: t-prot,v 1.261 2009/08/24 20:32:11 jochen Exp $
3
4 require 5.006;
5 use strict;
6 use Fcntl qw(O_EXCL O_WRONLY O_CREAT);
7 use Getopt::Mixed qw(nextOption);
8 use constant VER            => '2.7';
9 use constant REV            => '';
10 use constant REL            => q$Revision: 1.261 $=~m/(\d+(?:\.\d+)+)/;
11 # MTA expecting mail on STDIN
12 # (you might have to adjust this if using a different MTA)
13 use constant SENDMAIL       => '/usr/sbin/sendmail -oi';
14 # From <sysexits.h>
15 # (you might have to adjust those if your libc wants different values)
16 use constant EX_OK          =>  0;
17 use constant EX_USAGE       => 64;
18 use constant EX_DATAERR     => 65;
19 use constant EX_UNAVAILABLE => 69;
20 use constant EX_SOFTWARE    => 70;
21 use constant EX_IOERR       => 74;
22 use constant EX_BOUNCE      => EX_UNAVAILABLE;
23 use vars qw(
24     $ad $ads $bigqn $bigqx $boun $check $check_ratio $cr $diff $elli
25     $footers $ftr_ad $ftr_ml $hdrs $indent $kamm $kdiff $kminl $kmaxl
26     $lax $lsig $maxsig $maxlines $mda $ml $gw $ms $ms_smart $msg_quote
27     $msg_ratio $mua $nohdr $ofile $pgpshort $pgpmove $pgpmovevrf $sig
28     $sigint $sign $spass $spass_prefix $sysl $trad $trsp
29
30     $gpg_WARNING $gpg_Warning $gpg_Cantcheck $gpg_aka $gpg_bad
31     $gpg_expired $gpg_good $gpg_bug
32
33     $mutt_attachment $mutt_contenttype $mutt_pgpsigned $mutt_beginsigned
34     $mutt_pgpclearsigned $mutt_pgpclearsigstart $mutt_pgpencrypted
35     $mutt_pgpoutstart $mutt_pgpoutend
36 );
37
38
39 # Please adjust these vals to your needs (they are no constants because
40 # command line can change them or they are used in rexexp's):
41 $0 =~ s!^.*/!!;
42 $maxsig         = 4;      # max. valid signature length
43 $maxlines       = undef;  # no limit of message lines
44 $indent         = '>';    # Indent string, regexp to identify a quoted line
45 $kminl          = 65;     # see decomb() for details
46 $kmaxl          = 80;
47 $kdiff          = 20;
48 $pgpshort       = 0;      # hide pgp key ids if set
49 $pgpmove        = 0;      # move pgp output to bottom if set
50 $pgpmovevrf     = 0;
51 $sign           = 1;      # max number of sigs tolerated, undef for no limit
52 $boun           = "Blocked by $0: This user does not accept TOFUed email. Please see <http://learn.to/quote/> and <http://www.escape.de/users/tolot/mutt/> for more info. Have a nice day!\n";
53 $ftr_ad         = undef;  # too hard on performance to be default
54 $ftr_ml         = undef;  # too hard on performance to be default
55 $ofile          = '-';    # use STDOUT if nothing is specified
56 $spass_prefix   = 'SPAM: ';
57 $check_ratio    = .75;    # 3/4 tofu is enough not to accept the message
58 $msg_quote      = "Blocked by $0: This message has been rejected because of a full quote. Please see http://learn.to/quote/ and http://www.escape.de/users/tolot/mutt/ for more info. Have a nice day!\n";
59 $msg_ratio      = "Blocked by $0: This message has been rejected because of excessive quoting. Please see http://learn.to/quote/ and http://www.escape.de/users/tolot/mutt/ for more info. Have a nice day!\n";
60 # end of user adjusted vals
61
62
63 # set the defaults to the C locale
64 $mutt_attachment        = '[-- Attachment #';
65 $mutt_contenttype       = '[-- Type: ';
66 $mutt_pgpsigned         = '[-- End of signed data --]';
67 $mutt_beginsigned       = '[-- The following data is signed --]';
68 $mutt_pgpclearsigstart  = '[-- BEGIN PGP SIGNED MESSAGE --]';
69 $mutt_pgpclearsigned    = '[-- END PGP SIGNED MESSAGE --]';
70 $mutt_pgpencrypted      = '[-- End of PGP/MIME encrypted data --]';
71 $mutt_pgpoutstart       = '[-- PGP output follows (current time:';
72 $mutt_pgpoutend         = '[-- End of PGP output --]';
73
74 # set the defaults to the C locale
75 $gpg_WARNING            = 'WARNING: ';
76 # (yes, the translations in gnupg's po files *are* braindamaged):
77 $gpg_Warning            = 'WARNING: ';
78 $gpg_Cantcheck          = 'Can\'t check signature: ';
79 $gpg_aka                = '                aka ';
80 $gpg_bad                = 'BAD signature from ';
81 $gpg_expired            = 'Note: This key has expired!';
82 $gpg_good               = 'Good signature from';
83 # (actually, this bugs me quite often since upgrading gpg from v1.0.7):
84 $gpg_bug                = '... this is a bug (';
85
86
87 # help(): print help text and exit with appropriate exit code
88 sub help {
89     print "Usage: $0 [options] 
90   -A=DIRECTORY    ad footer directory, treat ad footers as signature
91   -a              remove ad footers; requires -A
92   --bigq[=n[,x]]  remove all but x lines of quotes with more than n
93                   lines; default is n=30 and x=10
94   --body          input has no headers; does not work with --pgp-short;
95                   multipart messages will not be detected
96   -c              merge multiple blank lines
97   --check[=FLAGS] check various criteria, print error message and quit;
98                   see man page for details
99   -d, --debug     print notice to syslog when bouncing; requires -p
100   --diff          tolerate diffs appended *after* the signature
101   -e              force ellipsis for excessive punctuation
102   --ftr-ad        enable aggressive ad footer matching; requires -A
103   --ftr-ml        enable aggressive mailing list footer matching; req. -L
104   --groupwise     delete Novell Groupwise style TOFU
105   -h, --help      show this short help and exit
106   -i=INFILE       file to be read; '-' for STDIN (default)
107   -k              try to fix \"Kammquotes\"
108   --kminl=n       min. line length for wrapped line; requires -k
109   --kmaxl=n       max. line length for wrapped line; requires -k
110   --kdiff=n       max. length difference between wrapped lines; req. -k
111   -L=DIRECTORY    mailing list footer directory, treat mailing list
112                   footers as signature
113   -l              delete mailing list footer; requires -L
114   --lax-security  use unsafe writing method; USE ON YOUR OWN RISK!
115   --locale=LOCALE internationalization; currently only used with -Mmutt
116   -M, --mua=MUA   turn on special treatment for some mail user agents
117   -m              delete MS style TOFU; careful: might be too agressive
118   --max-lines=x   maximum number of message lines
119   --ms-smart      try to be smart with MS style TOFU; req. -Mmutt and -m
120   -o=OUTFILE      file to be written to; '-' for STDOUT (default), 'NONE'
121                   for no output at all
122   -P=MESSAGE      user defined bounce message; requires -p
123   -p[=ADDRESS]    redirect to ADDRESS if no TOFU was found
124   --pgp-move      move pgp verification output to bottom; requires -Mmutt
125   --pgp-move-vrf  move pgp output if verified and good; requires -Mmutt
126   --pgp-short     hide non-relevant pgp key uids; requires -Mmutt
127   -r              delete mail header lines
128   -S[=n]          supress signatures with more than n lines; 
129                   default is $maxsig if n not specified
130   -s              delete signature
131   --sigsmax[=n]   max number of sigs tolerated, no value for unlimited
132   --spass         enable SpamAssassin workaround
133   -t              delete traditional style TOFU
134   -v, --version   show version string and exit
135   -w              delete trailing whitespaces\n";
136     exit(EX_USAGE);
137 }
138
139 # version(): print version info and exit with appropriate exit code
140 sub version {
141     print "$0 v".VER.REV." (Rev. ".REL."), Jochen Striepe <t-prot\@tolot.escape.de>
142 Get the latest version at <http://www.escape.de/users/tolot/mutt/>\n";
143     exit(EX_OK);
144 }
145
146 # sigint_handler(): what to do if we receive a single SIGINT
147 sub sigint_handler {
148     $sigint = 1;
149 }
150
151 # remove_footers(): remove any trailing appearance of footers contained
152 # in the given directory.
153 sub remove_footers {
154     my $L = shift;        # array of message lines
155     my $S = shift;        # array to store removed lines in
156     my $F = shift;        # footers dir name
157     my $O = shift;        # remove only one footer?
158     my $V = shift;        # allow footers match before end of message
159     my $off;
160
161     if (!defined $V) {
162         for ($off = 0; $#$L>=$off && $$L[$#$L-$off] =~ /^\s*$/; $off++) {;};
163     }
164
165     if ($F && scalar(@$L)) {
166         if (!opendir(DIR, $F))
167             { print STDERR "Could not open $F: $!\n"; exit(EX_IOERR); }
168         my @feet = grep { /^[^.]/ && -f "$F/$_" } readdir DIR;
169         closedir DIR;
170
171         foreach my $f (@feet) {
172             if (!open(IN, "$F/$f"))
173                 { print STDERR "Could not open $F/$f: $!\n"; exit(EX_IOERR); }
174             my @l = <IN>;
175             close IN;
176
177             if (!scalar(@l)) { next; }
178             for (my $z=0; $z<=$#l; $z++) { chomp($l[$z]); }
179
180             if (defined $V) {
181                 WIPE: for (my $z=scalar(@$L)-scalar(@l); $z>=0; $z--) {
182                     if (scalar(@l)+$z<=scalar(@$L)) {
183                         my $y = 0;
184                         for(my $x=1; $x<=scalar(@l); $x++) {
185                             if (index($$L[scalar(@$L)-$x-$z],
186                                           $l[scalar(@l)-$x])!=0) {
187                                 $y = 1;
188                             }
189                         }
190                         if (!$y) {
191                             unshift(@$S, @$L[$#$L-$#l-$z..$#$L]);
192                             splice(@$L, $#$L-$#l-$z);
193                             while (scalar(@$L) && $$L[$#$L] =~ /^\s*$/) {
194                                 unshift(@$S, pop(@$L));
195                             }
196                             if ($O) { last; } else { goto WIPE; }
197                         }
198                     }
199                 }
200             }
201             else {
202                 while (scalar(@l)<=scalar(@$L)) {
203                     for(my $x=1; $x<=scalar(@l); $x++) {
204                         if (index($$L[scalar(@$L)-$x-$off], $l[scalar(@l)-$x])!=0) { 
205                             goto FINISH;
206                         }
207                     }
208                     unshift(@$S, @$L[$#$L-$off-$#l..$#$L]);
209                     splice(@$L, $#$L-$off-$#l);
210                     while (scalar(@$L) && $$L[$#$L] =~ /^\s*$/) {
211                         unshift(@$S, pop(@$L));
212                     }
213                     if ($O) { last; }
214                 }
215                 FINISH:
216             }
217         }
218     }
219 }
220
221 # decomb(): Try to detect and fix zig-zag shaped quoting (a.k.a. German
222 # "Kammquoting").
223 sub decomb {
224     my $L = shift;        # array of message lines
225     my $V = shift;        # array with verbatim list
226     my $max = 0;        # plausible wraparound pos
227
228     # We scan the whole message first for a plausible common maximum line
229     # length where longer lines would be wrapped.
230     for (my $x=0; $x<$#$L; $x++) {
231         if ($$V[$x]!=1 && $max<length($$L[$x])) { $max = length($$L[$x]); }
232     }
233
234     # Next we see if there are plausible wraparounds.    
235     for (my $x=0; $x+1<$#$L; $x++) {
236
237         # OK, 
238         # * it must not be verbatim,
239         # * the 2nd line must not be quoted nor empty nor just 
240         #   underlining some part of the line above (using '^')
241         #   nor begin with a whitespace,
242         # * the 1st line must not end with a hyphen,
243         # * the 2nd line must not indicate content was deleted,
244         # * the 2nd line must not be some mutt(1) commentary,
245         # * there must not be a valid word wrap to produce a longer
246         #   1st line (if not quoted),
247         # * the 1st and 2nd line together must not be longer than some
248         #   magical upper limit nor shorter than some magical lower
249         #   bound nor nearly of the same length, and
250         # * the 3rd line must not be empty.
251         # With all that odds should be quite good that we have an
252         # automatedly wrapped line. Please send a note if you have
253         # additional good criteria. Thanks.
254         if (($$V[$x]!=1 && $$V[$x+1]!=1) &&
255             (index($$L[$x+1], $indent)!=0) &&
256             ($$L[$x+1] !~ /^$/) &&
257             ($$L[$x+1] !~ /^[\s^]/) &&
258             ($$L[$x]   !~ /-$/) &&
259             ($$L[$x+1] !~ /^\Q[...]\E\s*$/) &&
260             ($mua ne 'mutt' || $$L[$x+1] !~ /^(?:\e[^\a]+\a)?\[-- /) &&
261             (length($$L[$x])+index($$L[$x+1], ' ')>$max ||
262                 (index($$L[$x+1], ' ')<0 &&
263                  length($$L[$x])+length($$L[$x+1])>$max)) &&
264             (length($$L[$x])+length($$L[$x+1])<$kmaxl) &&
265             (length($$L[$x])+length($$L[$x+1])>$kminl) &&
266             (length($$L[$x])-length($$L[$x+1])>$kdiff) &&
267             ($$L[$x+2] !~ /^\s*$/))
268         {
269             $$L[$x] =~ s/\s*$/' ' . $$L[$x+1]/e;
270             splice(@$L, $x+1, 1);
271             splice(@$V, $x+1, 1);
272         }
273     }
274 }
275
276 # debigq(): Finds big quotes (more than $n lines quoted) and deletes all
277 # but $x lines of them.
278 sub debigq {
279     my $L = shift;        # array of message lines
280     my $V = shift;        # array with verbatim list
281     my $k = 0;
282
283     for (my $i=0; $i<=$#$L; $i++) {
284
285         if ($$V[$i]) { 
286             $k = 0;
287             next;
288         }
289
290         if (index($$L[$i], $indent)==0) { $k++; } else { 
291             if ($k>$bigqn) {
292                 my $x = $k-$bigqx;
293                 $i -= $k;
294
295                 $$L[$i] = "[---=| Quote block shrinked by $0: " .
296                     "$x lines snipped |=---]\n";
297                 $i++;
298                 splice(@$L, $i, $x-1);
299                 splice(@$V, $i, $x-1);
300
301                 $i++;
302             }
303             $k = 0;
304         }
305     }
306 }
307
308 # pgp(): treat mutt(1)'s pgp/gpg output contained in signed or encrypted
309 # messages
310 sub pgp {
311
312     sub verified {
313         my $L = shift;    # message body
314         my $X = shift;    # start line
315         my $Z = shift;    # end line
316
317                 my $ok = 0;
318
319         while ($X<$Z) {
320             if (index($$L[$X], "gpg: $gpg_WARNING")==0 ||
321                 index($$L[$X], "gpg: $gpg_Warning")==0 ||
322                 index($$L[$X], "gpg: $gpg_bad")==0 ||
323                 index($$L[$X], "gpg: $gpg_Cantcheck")==0 ||
324                 index($$L[$X], "gpg: $gpg_expired")==0 ||
325                 index($$L[$X], "gpg: $gpg_bug")==0)
326                 { return 0; }
327             if (index($$L[$X], "gpg: $gpg_good")==0)
328                 { $ok = 1; }
329             $X++;
330         }
331
332         return $ok;
333     }
334
335     my $L = shift;        # message body
336     my $V = shift;        # verbatim list
337     my $H = shift;        # headers
338
339     my @tmp = ();
340     my $tmp = 0;
341
342     for (my $x=0; $x<scalar(@$L); $x++) {
343         if ($$V[$x]) { next; }
344
345         if ($$L[$x]=~/^(?:\e[^\a]+\a)?(?:\Q$mutt_pgpoutstart\E)/o)
346         {
347             my $from;
348             for (my $m=0; $m<scalar(@$H); $m++) {
349                 if (index($$H[$m], 'From:')==0) {
350                     $from = $$H[$m];
351                     $m++;
352                     while (exists($$H[$m]) && $$H[$m] =~ /^\s/)
353                         { $from .= $$H[$m]; $m++; }
354                     last;
355                 }
356             }
357             ($from) = $from=~m/(\w[\w.+-]*@(?:[\w.+-]+\.)+[A-Za-z]{2,})/;
358
359             my $uid = 1;
360
361             for (my $i=$x+1; $i<scalar(@$L); $i++) {
362                 if ($pgpshort && index($$L[$i], "gpg: $gpg_aka")==0)
363                     { $uid++; }
364
365                 if ($pgpshort && $uid>1 &&
366                     index($$L[$i], "gpg: $gpg_aka")==0 &&
367                     index($$L[$i], $from)<0)
368                 { 
369                     splice(@$L, $i, 1);
370                     splice(@$V, $i, 1);
371                     $i--;
372                 }
373                 elsif ($$L[$i]=~/^(?:\e[^\a]+\a)?(?:\Q$mutt_pgpoutend\E)/o)
374                 {
375                     if ($pgpmove ||
376                         ($pgpmovevrf && (!$sigint) && verified($L, $x+1, $i)))
377                     {
378                         push(@{$tmp[++$tmp]}, "\n", @$L[$x..($i+1)]);
379                         splice(@$L, $x, $i-$x+2);
380                         splice(@$V, $x, $i-$x+2);
381                         $i -= $#{$tmp[$tmp]}-2;
382                     }
383                     $x = $i;
384                     last;
385                 }
386             }
387         }
388         elsif ($tmp &&
389             $$L[$x] =~ /^
390                         (?:\e[^\a]+\a)?
391                         (?:\Q$mutt_pgpencrypted\E  |
392                            \Q$mutt_pgpclearsigned\E|
393                            \Q$mutt_pgpsigned\E)
394                        /ox)
395         {
396             splice(@$L, $x+1, 0, @{$tmp[$tmp]});
397             for (my $i=$x; $i<scalar(@{$tmp[$tmp]}); $i++) {
398                 splice(@$V, $x+1, 0, (0));
399             }
400             $x += scalar(@{$tmp[$tmp--]});
401             pop(@tmp);
402         }
403     }
404
405     while ($tmp>0) {
406         push(@$L, @{$tmp[$tmp--]});
407         pop(@tmp);
408         for (my $i=$#$V; $i<$#$L; $i++) { push(@$V, 0); }
409     }
410 }
411
412 # write_msg(): output
413 sub write_msg {
414     my $O = shift;
415     my $l;
416
417     if ((!$lax) && ($O =~ /^>(.*)/) && ($1 ne '-')) {
418         if (!sysopen(OUT, $1, O_EXCL|O_CREAT|O_WRONLY)) { 
419             print STDERR "Could not open $1: $!\n"; exit(EX_IOERR);
420         }
421     }
422     elsif (!open(OUT, $O)) { 
423         print STDERR "Could not open $O: $!\n"; exit(EX_IOERR);
424     }
425     while (scalar(@_)) {
426         $l = shift;
427         if (defined $l) {
428             $^W = 0;
429             print OUT @$l;
430             $^W = 1;
431         }
432     }
433     close OUT;
434 }
435
436 # process_msg(): This one proc does *everything* what has to be done with
437 # the lines of the message
438 sub process_msg {
439     my $lines = shift;
440
441     my ($j, $x, $verb) = (0, 0, 0);
442     my (@ads, @hdr, @bo1, @bo2, @ftr, @sig, @vrb, @att) = 
443         ((), (), (), (), (), (), (), (), ());
444
445     # First, remove and store lines we might need later...
446     # Remove headers:
447     if (!$nohdr) {
448         for ($x=0; $x<$#$lines; $x++) { if (@$lines[$x] =~ /^$/) { last; }; }
449
450         # check body length and stop processing silently if msg is too long:
451         if ((defined $maxlines) && (@$lines-$x > $maxlines)) {
452             return;
453         }
454
455         @hdr = @$lines[0..$x];
456         splice(@$lines, 0, $x+1);
457     }
458     elsif ((defined $maxlines) && (@$lines > $maxlines)) {
459         # check body length and stop processing silently if msg is too long:
460         return;
461     }
462     # remember the original body lines count
463     my $linecount = scalar(@$lines);
464
465     # Remove ML footers:
466     remove_footers($lines, \@ftr, $footers, undef, $ftr_ml);
467
468     # Remove ad footers:
469     remove_footers($lines, \@ads, $ads, undef, $ftr_ad);
470
471     # See if we have a multipart content type. If yes, see if it is already
472     # ripped (e.g. by you MUA, assuming it does not get special treatment with
473     # --mua=foo), otherwise only leave the first part if it is plain text (if
474     # not, we are done - non-text messages are not our business).
475     if ($mua ne 'mutt') { 
476         for ($x=0; $x<scalar(@hdr); $x++) {
477             if ($hdr[$x] =~ /^Content-[Tt]ype:\s+(.*)$/) {
478                 my $foo = $1;
479
480                 if ($foo =~ m!^multipart/!) {
481                     undef $foo;
482
483                     if ($hdr[$x] =~ /\Wboundary="([^"]+)"/i) { $foo = $1; }
484                     else { 
485                         for (my $z=1; $x+$z<@hdr && $hdr[$x+$z]=~/^\s/; $z++) {
486                             if ($hdr[$x] =~ /\Wboundary="?([^"\s]+)"?$/i) { 
487                                 $foo = $1;
488                                 last;
489                             }
490                         }
491                     }
492
493                     if (defined $foo) {
494                         for (my $x=0; $x<scalar(@$lines); $x++) {
495                             if (index($$lines[$x], '--'.$foo)!=0) { next; }
496
497                             my $bar = 'text/plain';
498                             for ($x++; $x<@$lines && $$lines[$x]!~/^$/; $x++)
499                             {
500                                 if ($$lines[$x] =~ /^Content-[Tt]ype:\s+(.*)/) { 
501                                     $bar = $1;
502                                 }
503                             }
504                             if ($x>=scalar(@$lines)) { exit(EX_DATAERR); }
505
506                             if ($bar =~ m!^text/plain!) {
507                                 my $z;
508                                 for ($z=1; $x+$z<@$lines; $z++) {
509                                     if (index($$lines[$x+$z], '--'.$foo)==0) {
510                                         last;
511                                     }
512                                 }
513                                 if ($x+$z>=scalar(@$lines)) { exit(EX_DATAERR); }
514
515                                 @bo2 = @$lines[$x+$z..$#$lines];
516                                 splice(@$lines, $x+$z);
517                                 if ($$lines[$#$lines] =~ /^\s*$/) {
518                                     unshift(@bo2, pop @$lines);
519                                 }
520                                 @bo1 = @$lines[0..$x];
521                                 splice(@$lines, 0, $x+1);
522
523                                 # remove mailing list and ad footers within this
524                                 # attachment:
525                                 remove_footers($lines, \@ftr, $footers, undef, $ftr_ml);
526                                 remove_footers($lines, \@ads, $ads, undef, $ftr_ad);
527
528                                 last;
529                             }
530                             else { 
531                                 write_msg(($mda?'|'.SENDMAIL." $mda":">$ofile"),
532                                     ($hdrs?undef:\@hdr), $lines);
533                                 exit;
534                             }
535                         }
536                     }
537                 }
538                 last;
539             }
540         } 
541     }
542
543
544     # Protect verbatims:
545     $verb = 0;
546     for ($x=0; $x<scalar(@$lines); $x++) {
547         if ($$lines[$x] =~ /^\s*#v([+-])$/) { 
548             $verb = $1 eq '+' ? 1 : 0;
549             $vrb[$x] = 1;
550         } else { $vrb[$x] = $verb; }
551     }
552
553     # Calculate quoting ratio (with respect to verbatims):
554     if ($check && scalar(@$lines)) {
555         my ($y, $z) = (0, 0);
556         for ($x=0; $x<scalar(@$lines); $x++) {
557             if (!$vrb[$x]) {
558                 $z++;
559                 if (index($$lines[$x], $indent)==0) { $y++; }
560             }
561         }
562         $y = $y/$z;
563
564         if ($y>=$check_ratio) {
565             print $msg_ratio;
566             exit EX_UNAVAILABLE;
567         }
568     }
569
570     if ($mua eq 'mutt') {
571         # See if we find pgp output generated by mutt before we scramble
572         # the thing. If yes, see if we can beautify it.
573         if ($pgpshort || $pgpmove || $pgpmovevrf) { pgp($lines, \@vrb, \@hdr); }
574
575         # Remove all but the first attachment (if this is text/plain)
576         # mutt did introduce (bah!). Remember, all this ugliness could
577         # be replaced with a proper and clean edit_filter patch in 
578         # mutt(1) itself...
579         for ($x=$#$lines; $x>=0; $x--) {
580             if ($vrb[$x]) { next; }
581             # The following regexp's are quite ugly because for most users
582             # these lines are coloured using termcap... (bah!)
583             if (($$lines[$x] =~
584                      /^(?:\e[^\a]+\a)?\Q$mutt_attachment\E(\d+)/o &&
585                     (($1 ne '1') ||
586                     ($x<$#$lines &&
587                         $$lines[$x+1] !~ m!^
588                             (?:\e[^\a]+\a)?
589                             (?:\Q$mutt_contenttype\E)
590                             (?:text/plain|application/pgp)
591                         !ox))) ||
592                 ($$lines[$x] =~ /^
593                     (?:\e[^\a]+\a)?
594                     (?:\Q$mutt_pgpsigned\E     |
595                        \Q$mutt_pgpclearsigned\E|
596                        \Q$mutt_pgpencrypted\E)
597                 /ox))
598             { 
599                 # Strip attachments to prepare further processing
600                 unshift(@att, @$lines[$x..$#$lines]);
601                 splice(@$lines, $x);
602                 # Try to fix trailing empty lines
603                 while (scalar(@$lines) && $$lines[$#$lines] =~
604                     /^(?:\e[^\a]+\a)?\s*$/) { 
605                     unshift(@att, pop(@$lines));
606                 }
607
608                 # Remove ML and ad footers within attachments:
609                 my @tmp;
610                 if ($ml) { remove_footers($lines, \@tmp, $footers, undef); }
611                 if ($ad) { remove_footers($lines, \@tmp, $ads,     undef); }
612                 $x = scalar(@$lines);
613             }
614         }
615
616         # care about the rest
617         if (scalar(@att)) {
618             for ($x=0; $x<$#att; $x++) {
619                 if ($vrb[scalar(@$lines)+$x]) { next; }
620
621                 # Pipe message/rfc822 parts to another instance of
622                 # process_msg() for further processing.
623                 # Please note that we cannot see what a hierarchy the
624                 # original message had -- if there were message/rfc822
625                 # parts within other message/rfc822 parts constellations
626                 # can occur which we cannot resolve. Therefore we simply
627                 # do not even try to be smart. This should work for most
628                 # situations.
629                 # The following regexp is quite ugly because for most
630                 # users the line is coloured using termcap... (bah!)
631                 if ($att[$x] =~
632                         /^(?:\e[^\a]+\a)?\Q$mutt_attachment\E\d+/o &&
633                     $att[$x+1] =~ m!^
634                         (?:\e[^\a]+\a)?
635                         (?:\Q$mutt_contenttype\E) (?:message/rfc822|multipart/alternative)
636                     !ox)
637                 {
638                     $x += 2;
639                     while ($att[$x] !~ /^\s*$/) { $x++; }
640                     $x++;
641
642                     my @tmp = @att[$x..$#att];
643                     process_msg(\@tmp);
644                     splice(@att, $x, scalar(@att)-$x, @tmp);
645                     $x += scalar(@tmp);
646                 }
647             }
648         }
649     }
650
651     # Remove signature:
652     if (scalar(@$lines)) { 
653         my $sn = 0;
654         my $chk_empty = 1;
655         my $empty = 0;
656
657         for ($x = $#$lines; $x>=0; $x--) {
658             if (!$vrb[$x]) {
659                 if ($$lines[$x] =~ /^-- $/) {
660                     if ($diff) {
661                         for (my $i=1; $x+$i+1<scalar(@$lines); $i++) {
662                             if ($$lines[$x+$i] =~ /^-{3}\s+\S/ &&
663                                 $$lines[$x+$i+1] =~ /^\+{3}\s+\S/)
664                             {
665                                 $sig = 0;
666                                 unshift(@sig, @$lines[$x..$#$lines]);
667                                 splice(@$lines, $x);
668                                 last;
669                             }
670                         }
671                         if (scalar(@sig)) {
672                             if (defined($sign) && ++$sn==$sign) { last; } else { next; }
673                         }
674                     }
675
676                     if ($sig || ($lsig && ($#$lines-$x-$empty>$lsig))) {
677                         if ($lsig && !$sig) {
678                             unshift(@sig, "[---=| Overlong signature removed by $0: " .
679                                 (scalar(@$lines)-$x) . " lines snipped |=---]\n");
680                         }
681                         splice(@$lines, $x);
682                     }
683                     else {
684                         unshift(@sig, @$lines[$x..$#$lines]);
685                         splice(@$lines, $x);
686                     }
687                     if (defined($sign) && ++$sn==$sign) { last; } else { next; }
688                 }
689                 # any trailing newlines?
690                 elsif ($chk_empty && $$lines[$x] =~ /^\s*$/) { $empty++; }
691                 elsif ($chk_empty) { $chk_empty = 0; }
692             }
693         }
694     }
695
696     # See if there is some Kammquoting to fix:
697     if ($kamm) { decomb($lines, \@vrb); }
698
699     # Now care about TOFU.
700     # One common mispractice is M$ and Groupwise style TOFU:
701     if ($ms||$gw) {
702         # bloat this array if you want more internationalization:
703         my @tofu = ('Original Message',
704                     'Original-Nachricht',
705                     'Ursprüngliche Nachricht',
706                     'Ursprüngliche Nachricht',
707                     'Ursprungliche Nachricht',
708                     'Mensagem original',
709                     'Ursprungligt meddelande',
710                     'Oorspronkelijk bericht',
711                     'Message d\'origine',
712                     'Forwarded message',
713                     'Weitergeleitete Nachricht / Forwarded Message');
714         my $k = 0;    # any text above?
715         my $tmp = 0;  # flagged if inside PGP output
716
717         DONE: for ($x=0; $x<scalar(@$lines); $x++) { 
718             if (!$vrb[$x]) {
719                 foreach my $tmp (@tofu) {
720                     if (($ms && $$lines[$x] =~ /^\s?-+\s?$tmp\s?-+/) ||
721                         ($gw &&
722                             ($$lines[$x] =~ /^>>>[^\<]+<[^\>]+> \d\d?\/\d\d?\/\d\d? \d\d?:\d\d [AP]M >>>/ ||
723                              $$lines[$x] =~ /^>>> On [A-Z][a-z][a-z]?, [A-Z][a-z][a-z]? \d\d?, \d\d\d\d at [ \d]\d:\d\d [AP]M, in message/))) { 
724                         $x++;
725                         $trad = 0;
726                         $bigqn = 0;
727                         last DONE; 
728                     }
729                 }
730
731                 if ((!$k) && $$lines[$x] !~ /^\s*$/o &&
732                     ((!$mua) ||
733                      ($mua eq 'mutt' &&
734                          $$lines[$x] !~
735                              /^(?:\e[^\a]+\a)?(?:\Q$mutt_attachment\E)/o &&
736                          $$lines[$x] !~
737                              /^(?:\e[^\a]+\a)?(?:\Q$mutt_contenttype\E)/o)) &&
738                     ((!$spass) || index($$lines[$x], $spass_prefix)!=0))
739                 {
740                     if ($mua eq 'mutt' && (!$tmp) &&
741                         $$lines[$x] =~
742                              /^(?:\e[^\a]+\a)?(?:\Q$mutt_pgpoutstart\E)/o) {
743                         $tmp = 1; 
744                     } elsif ($mua eq 'mutt' && $tmp && 
745                         ($$lines[$x] =~
746                              /^(?:\e[^\a]+\a)?(?:\Q$mutt_beginsigned\E)/o ||
747                          $$lines[$x] =~
748                              /^(?:\e[^\a]+\a)?(?:\Q$mutt_pgpclearsigstart\E)/o)) {
749                         $tmp = 0;
750                     } elsif (!$tmp) {
751                         $k = 1;
752                     }
753                 }
754             }
755         }
756
757         # try to avoid false positives and only delete m$ style tofu if
758         # there is text above
759         if ($k) {
760             if (!$ms_smart) { goto CLEAN; }
761
762             # first, see if there is pgp stuff inside the tofu:
763             my $p = 0;    # levels of pgp signed parts
764
765             for (my $i=$x+1; $i<scalar(@$lines); $i++) {
766                 if ($$lines[$i] =~
767                         /^(?:\e[^\a]+\a)?(?:\Q$mutt_pgpclearsigstart\E)/o) {
768                     $p++;
769                 }
770             }
771             if ($p) {
772                 STAIRS: for (my $i=0; $i<scalar(@att); $i++) {
773                     if ($p==0 && $att[$i] =~ /^(?:\e[^\a]+\a)?\[-- /o) {
774                         splice(@att, 0, $i);
775                         unshift(@att, "\n");
776                         goto CLEAN;
777                     } elsif ($att[$i] =~
778                             /^(?:\e[^\a]+\a)?(?:\Q$mutt_pgpclearsigned\E)/o) {
779                         splice(@att, 0, $i+1);
780                         $p--;
781                         goto STAIRS;
782                     }
783                 }
784                 splice(@att);
785             }
786
787             # now removing is safe:
788             CLEAN: $j = scalar(@$lines)-$x;
789             splice(@$lines, $x);
790         }
791     }
792
793     # Nothing? Then try traditional TOFU (deleting M$ style TOFU is done
794     # much more aggressively, so we won't need to search any more if we
795     # did find some):
796     if ($trad && (!$j) && !$vrb[$#$lines]) {
797         if (scalar(@$lines) && $$lines[$#$lines] =~ /^\s*$/) { 
798             unshift(@sig, pop(@$lines));
799         }
800
801         my $k;
802         my $x = 1;
803
804         for (my $i=$#$lines; $i>=0; $i--) {
805             if ($$lines[$i] =~ /^$indent/o) {
806                 $j++;
807                 $k = $i;
808             }
809             elsif ($$lines[$i] !~ /^\s*$/) { last; }
810         }
811
812         if ($j) {
813             # if there is no text above, we will assume the message is meant
814             # as forwarding and therefore OK
815             for (my $i=$k-1; $i>=0; $i--) {
816                 if ($$lines[$i] !~ /^\s*$/o) {
817                    $x = 0;
818                    last;
819                 }
820             }
821             if ($x) {
822                 $j = 0;
823             } else {
824                 splice(@$lines, $k);
825             }
826         }
827     }
828
829     # OK, if we found TOFU, we will leave a message that we were here...
830     if ($j) { 
831         # make sendmail bounce if we shall be picky 
832         # and indeed found something:
833         if ($mda) { 
834             if ($mda ne '1') { 
835                 print STDERR $boun;
836
837                 if ($sysl) {
838                     eval { require Sys::Syslog; }; 
839                     if ($@) { warn $@; } else {
840                         Sys::Syslog::setlogsock('unix');
841                         Sys::Syslog::openlog("$0[$$]", 'pid', 'mail');
842                         Sys::Syslog::syslog('debug', 'bounced message %s', $hdr[0]);
843                         Sys::Syslog::closelog();
844                     }
845                 }
846             }
847
848             exit EX_BOUNCE;
849         }
850
851         # if we were invoked just for checking and indeed found something,
852         # print out the error message and quit:
853         if ($check) {
854             print $msg_quote;
855             exit EX_UNAVAILABLE;
856         }
857
858         push(@$lines, "[---=| TOFU protection by $0: " .
859             "$j lines snipped |=---]\n");
860     }
861     elsif ($mda eq '1') { exit EX_OK; }
862
863     # Care for huge blocks of quoted original message:
864     if ($bigqn) { debigq($lines, \@vrb); }
865
866     # Care for trailing whitespaces:
867     if ($trsp) {
868         for ($x=0; $x<scalar(@$lines); $x++) { 
869             if (!$vrb[$x]) { $$lines[$x] =~ s/[\ \t]+$//; }
870         }
871     }
872
873     # Care for punctuation abuse:
874     if ($elli) {
875         for ($x=0; $x<scalar(@$lines); $x++) { 
876             if (!$vrb[$x]) { $$lines[$x] =~ s/(([.?!])\2\2)\2+/$1/g; }
877         }
878     }
879
880     # (Nearly) at last care for multiple blank lines. (Do not do this
881     # earlier -- the way it is done right now would screw up the verbatim
882     # list)
883     if ($cr) {
884         my $t = 0;
885         for ($x=scalar(@$lines)-1; $x>=0; $x--) {
886             if ((!$vrb[$x]) && $$lines[$x] =~ /^\s*$/) { 
887                 if ($t<2) { $t++; } else { splice(@$lines, $x, 1); }
888             }
889             else { $t = 0; }
890         }
891     }
892
893     # Everything changing the body is done now. Time to fix the line count
894     # header so naive clients do not get confused. Just to be sure, append
895     # the old line count to X-headers.
896     my $l = scalar(@bo1) + scalar(@$lines) + scalar(@att) + scalar(@bo2) +
897                 (!$sig?scalar(@sig):0) + (!$ml?scalar(@ftr):0) + 
898                 (!$ad?scalar(@ads):0);
899     if ($linecount-$l!=0) {
900         for ($x=0; $x<scalar(@hdr); $x++) {
901             if ($hdr[$x] =~ 
902                 s/^(Lines:\s+)(\d+)/$1.($2-$linecount+$l)/e)
903             { 
904                 $hdr[$#hdr] = "X-Old-Lines: $2\n";
905                 push(@hdr, "\n");
906             }
907         }
908     }
909
910     # Finally, before leaving we put everything back in right order.
911     unshift(@$lines, (!$hdrs?@hdr:()), @bo1);
912     push(@$lines, (!$sig?@sig:()), (!$ad?@ads:()), (!$ml?@ftr:()), @att,
913         @bo2);
914 }
915
916
917 # environment
918 my $locale = $ENV{'LC_ALL'}?$ENV{'LC_ALL'}:
919                  ($ENV{'LC_MESSAGES'}?$ENV{'LC_MESSAGES'}:$ENV{'LANG'});
920
921 # command line switches
922 ($ad, $ads, $bigqn, $bigqx, $check, $cr, $sysl, $diff, $elli, $footers, $lax,
923     $ml, $gw, $ms, $ms_smart, $mda, $mua, $hdrs, $kamm, $lsig, $nohdr, $sig,
924     $sigint, $spass, $trad, $trsp) =
925     (0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0);
926 my $ifile   = '-';    # use STDIN if nothing specified
927
928 # get command line params:
929 Getopt::Mixed::init('a A=s c d e h i=s k L=s l m M=s o=s P=s p:s r S:i'.
930     ' s t v w bigq:s body check:s debug>d diff ftr-ad ftr-ml groupwise'.
931     ' help>h kminl=i kmaxl=i kdiff=i lax-security locale=s max-lines=i'.
932     ' ms-smart mua>M pgp-short pgp-move pgp-move-vrf sigsmax:i spass'.
933     ' version>v');
934 while (my ($opt, $val, $pretty) = nextOption()) {
935     if    ($opt eq 'a')     { $ad = 1; }
936     elsif ($opt eq 'A')     { $ads = $val; }
937     elsif ($opt eq 'bigq')  { 
938         if ($val !~ /^(?:(\d+)(?:,(\d+))?)?$/) { help(); }
939         $bigqn = $1?$1:30; 
940         $bigqx = $2?$2:10;
941         if ($bigqn<=0 || $bigqx<=0 || $bigqn<=$bigqx) { help(); }
942     }
943     elsif ($opt eq 'body')  { $nohdr = 1; $hdrs = 1; }
944     elsif ($opt eq 'c')     { $cr = 1; }
945     elsif ($opt eq 'check') {
946         $check = 1;
947         while ($val && $val =~ s/^([^,\s]+)(?:,(\S+))?$/$2/) {
948             my $foo = $1;
949
950             if ($foo =~ /^ratio=(0?\.\d+)$/) {
951                 $check_ratio = $1?$1:1;
952             }
953         }
954     }
955     elsif ($opt eq 'd')     { $sysl = 1; }
956     elsif ($opt eq 'diff')  { $diff = 1; }
957     elsif ($opt eq 'e')     { $elli = 1; }
958     elsif ($opt eq 'ftr-ad') { $ftr_ad = 1; $ad = 1; }
959     elsif ($opt eq 'ftr-ml') { $ftr_ml = 1; $ml = 1; }
960     elsif ($opt eq 'groupwise') { $gw = 1; }
961     elsif ($opt eq 'i')     { $ifile = $val; }
962     elsif ($opt eq 'k')     { $kamm = 1; }
963     elsif ($opt eq 'kminl') { $kminl = $val; $kamm = 1; }
964     elsif ($opt eq 'kmaxl') { $kmaxl = $val; $kamm = 1; }
965     elsif ($opt eq 'kdiff') { $kdiff = $val; $kamm = 1; }
966     elsif ($opt eq 'L')     { $footers = $val; }
967     elsif ($opt eq 'l')     { $ml = 1; }
968     elsif ($opt eq 'lax-security') { $lax = 1; }
969     elsif ($opt eq 'locale') { $locale = $val; }
970     elsif ($opt eq 'm')     { $ms = 1; }
971     elsif ($opt eq 'max-lines') { $maxlines = $val; }
972     elsif ($opt eq 'ms-smart') { $ms_smart = 1; $ms = 1; }
973     elsif ($opt eq 'M') {
974         $mua = lc($val);
975
976         if ($mua eq 'mutt') {
977             # mutt still displays the message when ^C'ing pgp verification:
978             $SIG{'INT'} = 'sigint_handler';
979         }
980     }
981     elsif ($opt eq 'o')     { $ofile = $val; }
982     elsif ($opt eq 'P')     { $boun = $val; }
983     elsif ($opt eq 'p')     { $mda = $val ? $val : '1'; }
984     elsif ($opt eq 'pgp-short') { $pgpshort = 1; }
985     elsif ($opt eq 'pgp-move') { $pgpmove = 1; }
986     elsif ($opt eq 'pgp-move-vrf') { $pgpmovevrf = 1; }
987     elsif ($opt eq 'r')     { $hdrs = 1; }
988     elsif ($opt eq 'S')     { $lsig = $val ? $val : $maxsig; }
989     elsif ($opt eq 's')     { $sig = 1; }
990     elsif ($opt eq 'sigsmax') { $sign = $val ? $val : undef; }
991     elsif ($opt eq 'spass') { $spass = 1; }
992     elsif ($opt eq 't')     { $trad = 1; }
993     elsif ($opt eq 'v')     { version(); }
994     elsif ($opt eq 'w')     { $trsp = 1; }
995     else                    { help(); }
996 }
997 Getopt::Mixed::cleanup();
998 if (($ml && $footers eq '')||    # no -l without -L
999     ($ad && $ads eq '')||        # no -a without -A
1000     ($nohdr && $pgpshort)||      # --body and --pgp-short are like oil and water
1001     ($ifile eq '')||             # no empty -i
1002     ($ofile eq ''))              # no empty -o
1003 { help(); }
1004
1005
1006 if ($mua eq 'mutt') {
1007     if (defined $locale && $locale ne '' && $locale ne 'C' && $locale ne 'POSIX') {
1008         eval { require Locale::gettext; };
1009         if ($@) { warn $@; exit(EX_SOFTWARE); } else {
1010             Locale::gettext::textdomain('mutt');
1011             ($mutt_attachment) =
1012                 Locale::gettext::gettext("[-- Attachment #%d") =~
1013                 m/^([^%]*)/;
1014             ($mutt_contenttype) =
1015                 Locale::gettext::gettext("[-- Type: %s/%s, Encoding: %s, Size: %s --]\n") =~
1016                 m/^([^%]*)/;
1017             ($mutt_pgpsigned) =
1018                 Locale::gettext::gettext("[-- End of signed data --]\n")  =~
1019                 m/^(.*)\n/m;
1020             ($mutt_beginsigned) =
1021                 Locale::gettext::gettext("[-- The following data is signed --]\n\n") =~
1022                 m/^(.*)\n/m;
1023             ($mutt_pgpclearsigned) =
1024                 Locale::gettext::gettext("[-- END PGP SIGNED MESSAGE --]\n") =~
1025                 m/^(.*)\n/m;
1026             ($mutt_pgpclearsigstart) =
1027                 Locale::gettext::gettext("[-- BEGIN PGP SIGNED MESSAGE --]\n") =~
1028                 m/^(.*)\n/m;
1029             ($mutt_pgpencrypted) =
1030                 Locale::gettext::gettext("[-- End of PGP/MIME encrypted data --]\n") =~
1031                 m/^(.*)\n/m;
1032             ($mutt_pgpoutstart) =
1033                 Locale::gettext::gettext("[-- PGP output follows (current time: %c) --]\n") =~
1034                 m/^([^%]*)/;
1035             ($mutt_pgpoutend) =
1036                 Locale::gettext::gettext("[-- End of PGP output --]\n") =~
1037                 m/^(.*)\n/m;
1038
1039             Locale::gettext::textdomain('gnupg');
1040             ($gpg_WARNING) =
1041                 Locale::gettext::gettext("WARNING: using insecure random number generator!!\n") =~
1042                 m/^([^:]*: )/;
1043             ($gpg_Warning) =
1044                 Locale::gettext::gettext("WARNING: message was encrypted with a weak key in the symmetric cipher.\n") =~
1045                 m/^([^:]*: )/;
1046             ($gpg_Cantcheck) =
1047                 Locale::gettext::gettext("Can't check signature: %s\n") =~
1048                 m/^([^%]*)/;
1049             ($gpg_aka) =
1050                 Locale::gettext::gettext((' 'x16).'aka "%s"') =~
1051                 m/^([^"«%]*)["«%]/;
1052             ($gpg_bad) =
1053                 Locale::gettext::gettext('BAD signature from "%s"') =~
1054                 m/^([^"«%]*)["«%]/;
1055             ($gpg_expired) =
1056                 Locale::gettext::gettext("Note: This key has expired!\n") =~
1057                 m/^(.*)\n/m;
1058             ($gpg_good) =
1059                 Locale::gettext::gettext('Good signature from "%s"') =~
1060                 m/^(([^"«%]*))["«%]/;
1061             ($gpg_bug) =
1062                 Locale::gettext::gettext("... this is a bug (%s:%d:%s)\n") =~
1063                 m/^([^%]*)/;
1064         }
1065     }
1066
1067 }
1068 else {
1069     if ($ms_smart || $pgpshort || $pgpmove || $pgpmovevrf) { help(); }
1070 }
1071
1072
1073 # Read message:
1074 if (!open(IN, $ifile))
1075     { print STDERR "Could not open $ifile: $!\n"; exit(EX_IOERR); }
1076 my @message = <IN>;
1077 close IN;
1078
1079 # this should be self-explanatory:
1080 process_msg(\@message);
1081
1082 # Finally, print clean lines:
1083 if ($ofile ne 'NONE') {
1084     write_msg(($mda?'|'.SENDMAIL." $mda":">$ofile"), \@message);
1085 }
1086
1087 # vim600:set foldmethod=marker:
1088 # eof