lib/PublicInbox/WatchMaildir.pm

   1 # Copyright (C) 2016-2018 all contributors <meta@public-inbox.org>
   2 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
   3 #
   4 # ref: https://cr.yp.to/proto/maildir.html
   5 #       http://wiki2.dovecot.org/MailboxFormat/Maildir
   6 package PublicInbox::WatchMaildir;
   7 use strict;
   8 use warnings;
   9 use PublicInbox::MIME;
  10 use PublicInbox::Git;
  11 use PublicInbox::Import;
  12 use PublicInbox::MDA;
  13 use PublicInbox::Spawn qw(spawn);
  14 use PublicInbox::InboxWritable;
  15 use File::Temp qw//;
  16 use PublicInbox::Filter::Base;
  17 *REJECT = *PublicInbox::Filter::Base::REJECT;
  18
  19 sub new {
  20         my ($class, $config) = @_;
  21         my (%mdmap, @mdir, $spamc, $spamdir);
  22
  23         # "publicinboxwatch" is the documented namespace
  24         # "publicinboxlearn" is legacy but may be supported
  25         # indefinitely...
  26         foreach my $pfx (qw(publicinboxwatch publicinboxlearn)) {
  27                 my $k = "$pfx.watchspam";
  28                 if (my $dir = $config->{$k}) {
  29                         if ($dir =~ s/\Amaildir://) {
  30                                 $dir =~ s!/+\z!!;
  31                                 # skip "new", no MUA has seen it, yet.
  32                                 my $cur = "$dir/cur";
  33                                 $spamdir = $cur;
  34                                 push @mdir, $cur;
  35                                 $mdmap{$cur} = 'watchspam';
  36                         } else {
  37                                 warn "unsupported $k=$dir\n";
  38                         }
  39                 }
  40         }
  41
  42         my $k = 'publicinboxwatch.spamcheck';
  43         my $spamcheck = $config->{$k};
  44         if ($spamcheck) {
  45                 if ($spamcheck eq 'spamc') {
  46                         $spamcheck = 'PublicInbox::Spamcheck::Spamc';
  47                 }
  48                 if ($spamcheck =~ /::/) {
  49                         eval "require $spamcheck";
  50                         $spamcheck = _spamcheck_cb($spamcheck->new);
  51                 } else {
  52                         warn "unsupported $k=$spamcheck\n";
  53                         $spamcheck = undef;
  54                 }
  55         }
  56
  57         # need to make all inboxes writable for spam removal:
  58         $config->each_inbox(sub { PublicInbox::InboxWritable->new($_[0]) });
  59
  60         foreach $k (keys %$config) {
  61                 $k =~ /\Apublicinbox\.([^\.]+)\.watch\z/ or next;
  62                 my $name = $1;
  63                 my $watch = $config->{$k};
  64                 if ($watch =~ s/\Amaildir://) {
  65                         $watch =~ s!/+\z!!;
  66                         my $inbox = $config->lookup_name($name);
  67                         if (my $wm = $inbox->{watchheader}) {
  68                                 my ($k, $v) = split(/:/, $wm, 2);
  69                                 $inbox->{-watchheader} = [ $k, qr/\Q$v\E/ ];
  70                         }
  71                         my $new = "$watch/new";
  72                         my $cur = "$watch/cur";
  73                         push @mdir, $new, $cur;
  74                         die "$new already in use\n" if $mdmap{$new};
  75                         die "$cur already in use\n" if $mdmap{$cur};
  76                         $mdmap{$new} = $mdmap{$cur} = $inbox;
  77                 } else {
  78                         warn "watch unsupported: $k=$watch\n";
  79                 }
  80         }
  81         return unless @mdir;
  82
  83         my $mdre = join('|', map { quotemeta($_) } @mdir);
  84         $mdre = qr!\A($mdre)/!;
  85         bless {
  86                 spamcheck => $spamcheck,
  87                 spamdir => $spamdir,
  88                 mdmap => \%mdmap,
  89                 mdir => \@mdir,
  90                 mdre => $mdre,
  91                 config => $config,
  92                 importers => {},
  93                 opendirs => {}, # dirname => dirhandle (in progress scans)
  94         }, $class;
  95 }
  96
  97 sub _done_for_now {
  98         my ($self) = @_;
  99         my $importers = $self->{importers};
 100         foreach my $im (values %$importers) {
 101                 $im->done;
 102         }
 103 }
 104
 105 sub _try_fsn_paths {
 106         my ($self, $scan_re, $paths) = @_;
 107         foreach (@$paths) {
 108                 my $path = $_->{path};
 109                 if ($path =~ $scan_re) {
 110                         scan($self, $path);
 111                 } else {
 112                         _try_path($self, $path);
 113                 }
 114         }
 115         _done_for_now($self);
 116 }
 117
 118 sub _remove_spam {
 119         my ($self, $path) = @_;
 120         # path must be marked as (S)een
 121         $path =~ /:2,[A-R]*S[T-Za-z]*\z/ or return;
 122         my $mime = _path_to_mime($path) or return;
 123         $self->{config}->each_inbox(sub {
 124                 my ($ibx) = @_;
 125                 eval {
 126                         my $im = _importer_for($self, $ibx);
 127                         $im->remove($mime, 'spam');
 128                         if (my $scrub = $ibx->filter) {
 129                                 my $scrubbed = $scrub->scrub($mime) or return;
 130                                 $scrubbed == REJECT() and return;
 131                                 $im->remove($scrubbed, 'spam');
 132                         }
 133                 };
 134                 if ($@) {
 135                         warn "error removing spam at: ", $path,
 136                                 " from ", $ibx->{name}, ': ', $@, "\n";
 137                 }
 138         })
 139 }
 140
 141 sub _try_path {
 142         my ($self, $path) = @_;
 143         return unless PublicInbox::InboxWritable::is_maildir_path($path);
 144         if ($path !~ $self->{mdre}) {
 145                 warn "unrecognized path: $path\n";
 146                 return;
 147         }
 148         my $inbox = $self->{mdmap}->{$1};
 149         unless ($inbox) {
 150                 warn "unmappable dir: $1\n";
 151                 return;
 152         }
 153         if (!ref($inbox) && $inbox eq 'watchspam') {
 154                 return _remove_spam($self, $path);
 155         }
 156         my $im = _importer_for($self, $inbox);
 157         my $mime = _path_to_mime($path) or return;
 158         my $wm = $inbox->{-watchheader};
 159         if ($wm) {
 160                 my $v = $mime->header_obj->header_raw($wm->[0]);
 161                 return unless ($v && $v =~ $wm->[1]);
 162         }
 163         if (my $scrub = $inbox->filter) {
 164                 my $ret = $scrub->scrub($mime) or return;
 165                 $ret == REJECT() and return;
 166                 $mime = $ret;
 167         }
 168
 169         $im->add($mime, $self->{spamcheck});
 170 }
 171
 172 sub quit { trigger_scan($_[0], 'quit') }
 173
 174 sub watch {
 175         my ($self) = @_;
 176         my $scan = File::Temp->newdir("public-inbox-watch.$$.scan.XXXXXX",
 177                                         TMPDIR => 1);
 178         my $scandir = $self->{scandir} = $scan->dirname;
 179         my $re = qr!\A$scandir/!;
 180         my $cb = sub { _try_fsn_paths($self, $re, \@_) };
 181
 182         # lazy load here, we may support watching via IMAP IDLE
 183         # in the future...
 184         require Filesys::Notify::Simple;
 185         my $fsn = Filesys::Notify::Simple->new([@{$self->{mdir}}, $scandir]);
 186         $fsn->wait($cb) until $self->{quit};
 187 }
 188
 189 sub trigger_scan {
 190         my ($self, $base) = @_;
 191         my $dir = $self->{scandir} or return;
 192         open my $fh, '>', "$dir/$base" or die "open $dir/$base failed: $!\n";
 193         close $fh or die "close $dir/$base failed: $!\n";
 194 }
 195
 196 sub scan {
 197         my ($self, $path) = @_;
 198         if ($path =~ /quit\z/) {
 199                 %{$self->{opendirs}} = ();
 200                 _done_for_now($self);
 201                 delete $self->{scandir};
 202                 $self->{quit} = 1;
 203                 return;
 204         }
 205         # else: $path =~ /(cont|full)\z/
 206         return if $self->{quit};
 207         my $max = 10;
 208         my $opendirs = $self->{opendirs};
 209         my @dirnames = keys %$opendirs;
 210         foreach my $dir (@dirnames) {
 211                 my $dh = delete $opendirs->{$dir};
 212                 my $n = $max;
 213                 while (my $fn = readdir($dh)) {
 214                         _try_path($self, "$dir/$fn");
 215                         last if --$n < 0;
 216                 }
 217                 $opendirs->{$dir} = $dh if $n < 0;
 218         }
 219         if ($path =~ /full\z/) {
 220                 foreach my $dir (@{$self->{mdir}}) {
 221                         next if $opendirs->{$dir}; # already in progress
 222                         my $ok = opendir(my $dh, $dir);
 223                         unless ($ok) {
 224                                 warn "failed to open $dir: $!\n";
 225                                 next;
 226                         }
 227                         my $n = $max;
 228                         while (my $fn = readdir($dh)) {
 229                                 _try_path($self, "$dir/$fn");
 230                                 last if --$n < 0;
 231                         }
 232                         $opendirs->{$dir} = $dh if $n < 0;
 233                 }
 234         }
 235         _done_for_now($self);
 236         # do we have more work to do?
 237         trigger_scan($self, 'cont') if keys %$opendirs;
 238 }
 239
 240 sub _path_to_mime {
 241         my ($path) = @_;
 242         if (open my $fh, '<', $path) {
 243                 local $/;
 244                 my $str = <$fh>;
 245                 $str or return;
 246                 return PublicInbox::MIME->new(\$str);
 247         } elsif ($!{ENOENT}) {
 248                 return;
 249         } else {
 250                 warn "failed to open $path: $!\n";
 251                 return;
 252         }
 253 }
 254
 255 sub _importer_for {
 256         my ($self, $ibx) = @_;
 257         my $importers = $self->{importers};
 258         my $im = $importers->{"$ibx"} ||= $ibx->importer(0);
 259         if (scalar(keys(%$importers)) > 2) {
 260                 delete $importers->{"$ibx"};
 261                 _done_for_now($self);
 262         }
 263
 264         $importers->{"$ibx"} = $im;
 265 }
 266
 267 sub _spamcheck_cb {
 268         my ($sc) = @_;
 269         sub {
 270                 my ($mime) = @_;
 271                 my $tmp = '';
 272                 if ($sc->spamcheck($mime, \$tmp)) {
 273                         return PublicInbox::MIME->new(\$tmp);
 274                 }
 275                 warn $mime->header('Message-ID')." failed spam check\n";
 276                 undef;
 277         }
 278 }
 279
 280 1;