script/public-inbox-mda

   1 #!/usr/bin/perl -w
   2 # Copyright (C) 2013-2015 all contributors <meta@public-inbox.org>
   3 # License: AGPLv3 or later (https://www.gnu.org/licenses/agpl-3.0.txt)
   4 #
   5 # Mail delivery agent for public-inbox, run from your MTA upon mail delivery
   6 use strict;
   7 use warnings;
   8 my $usage = 'public-inbox-mda < rfc2822_message';
   9
  10 use Email::Filter;
  11 use Email::MIME;
  12 use Email::Address;
  13 use File::Path::Expand qw/expand_filename/;
  14 use IPC::Run qw(run);
  15 use PublicInbox::MDA;
  16 use PublicInbox::Filter;
  17 use PublicInbox::Config;
  18 use PublicInbox::Import;
  19 use PublicInbox::Git;
  20
  21 # n.b: hopefully we can setup the emergency path without bailing due to
  22 # user error, we really want to setup the emergency destination ASAP
  23 # in case there's bugs in our code or user error.
  24 my $emergency = $ENV{PI_EMERGENCY} || '~/.public-inbox/emergency/';
  25 $emergency = expand_filename($emergency);
  26
  27 # this reads the message from stdin
  28 my $filter = Email::Filter->new(emergency => $emergency);
  29 my $config = PublicInbox::Config->new;
  30
  31 my $recipient = $ENV{ORIGINAL_RECIPIENT};
  32 defined $recipient or die "ORIGINAL_RECIPIENT not defined in ENV\n";
  33 my $dst = $config->lookup($recipient); # first check
  34 defined $dst or exit(1);
  35 my $main_repo = $dst->{mainrepo} or exit(1);
  36 my $filtered; # string dest
  37
  38 if (PublicInbox::MDA->precheck($filter, $dst->{address}) &&
  39     do_spamc($filter->simple, \$filtered)) {
  40         # update our message with SA headers (in case our filter rejects it)
  41         my $msg = Email::MIME->new(\$filtered);
  42         $filtered = undef;
  43         $filter->simple($msg);
  44
  45         my $filter_arg;
  46         my $fcfg = $dst->{filter};
  47         if (!defined $fcfg || $filter eq 'reject') {
  48                 $filter_arg = $filter;
  49         } elsif ($fcfg eq 'scrub') {
  50                 $filter_arg = undef; # the default for legacy versions
  51         } else {
  52                 warn "publicinbox.$dst->{name}.filter=$fcfg invalid\n";
  53                 warn "must be either 'scrub' or 'reject' (the default)\n";
  54         }
  55
  56         if (PublicInbox::Filter->run($msg, $filter_arg)) {
  57                 # run spamc again on the HTML-free message
  58                 if (do_spamc($msg, \$filtered)) {
  59                         $msg = Email::MIME->new(\$filtered);
  60                         PublicInbox::MDA->set_list_headers($msg, $dst);
  61                         $filter->simple($msg);
  62
  63                         END {
  64                                 index_sync($main_repo) if ($? == 0);
  65                         };
  66                         my $git = PublicInbox::Git->new($main_repo);
  67                         my $im = PublicInbox::Import->new($git,
  68                                                 $dst->{name}, $recipient);
  69                         if (defined $im->add($msg)) {
  70                                 $im->done;
  71                                 $filter->ignore; # exits
  72                         }
  73                         # this message is similar to what ssoma-mda shows:
  74                         print STDERR "CONFLICT: Message-ID: ",
  75                                 $msg->header_obj->header_raw('Message-ID'),
  76                                 " exists\n";
  77                 }
  78         }
  79 } else {
  80         # Ensure emergency spam gets spamassassin headers.
  81         # This makes it easier to prioritize obvious spam from less obvious
  82         if (defined($filtered) && $filtered ne '') {
  83                 my $drop = Email::MIME->new(\$filtered);
  84                 $filtered = undef;
  85                 $filter->simple($drop);
  86         }
  87 }
  88 exit 0; # goes to emergency
  89
  90 # we depend on "report_safe 0" in /etc/spamassassin/*.cf with --headers
  91 # not using Email::Filter->pipe here since we want the stdout of
  92 # the command even on failure (spamc will set $? on error).
  93 sub do_spamc {
  94         my ($msg, $out) = @_;
  95         eval {
  96                 my $orig = $msg->as_string;
  97                 run([qw/spamc -E --headers/], \$orig, $out);
  98         };
  99
 100         return ($@ || $? || !defined($$out) || $$out eq '') ? 0 : 1;
 101 }
 102
 103 sub index_sync {
 104         my ($git_dir) = @_;
 105         eval {
 106                 require PublicInbox::SearchIdx;
 107                 PublicInbox::SearchIdx->new($git_dir, 2)->index_sync;
 108         };
 109 }