1 # Copyright (C) 2016-2021 all contributors <meta@public-inbox.org>
2 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
4 # ref: https://cr.yp.to/proto/maildir.html
5 # https://wiki2.dovecot.org/MailboxFormat/Maildir
6 package PublicInbox::Watch;
10 use PublicInbox::InboxWritable qw(eml_from_path);
11 use PublicInbox::MdirReader;
12 use PublicInbox::NetReader;
13 use PublicInbox::Filter::Base qw(REJECT);
14 use PublicInbox::Spamcheck;
15 use PublicInbox::Sigfd;
16 use PublicInbox::DS qw(now add_timer);
17 use PublicInbox::MID qw(mids);
18 use PublicInbox::ContentHash qw(content_hash);
19 use PublicInbox::EOFpipe;
20 use POSIX qw(_exit WNOHANG);
22 sub compile_watchheaders ($) {
25 if (my $whs = $ibx->{watchheader}) {
27 my ($k, $v) = split(/:/, $_, 2);
28 # XXX should this be case-insensitive?
29 # Or, mutt-style, case-sensitive iff
30 # a capital letter exists?
31 push @$watch_hdrs, [ $k, qr/\Q$v\E/ ];
34 if (my $list_ids = $ibx->{listid}) {
36 # RFC2919 section 6 stipulates
37 # "case insensitive equality"
38 my $re = qr/<[ \t]*\Q$_\E[ \t]*>/i;
39 push @$watch_hdrs, ['List-Id', $re ];
42 $ibx->{-watchheaders} = $watch_hdrs if scalar @$watch_hdrs;
46 my ($class, $cfg) = @_;
48 my (%imap, %nntp); # url => [inbox objects] or 'watchspam'
51 # "publicinboxwatch" is the documented namespace
52 # "publicinboxlearn" is legacy but may be supported
54 foreach my $pfx (qw(publicinboxwatch publicinboxlearn)) {
55 my $k = "$pfx.watchspam";
56 defined(my $dirs = $cfg->{$k}) or next;
57 $dirs = PublicInbox::Config::_array($dirs);
58 for my $dir (@$dirs) {
60 if (is_maildir($dir)) {
61 # skip "new", no MUA has seen it, yet.
62 $mdmap{"$dir/cur"} = 'watchspam';
63 } elsif ($uri = imap_uri($dir)) {
64 $imap{$$uri} = 'watchspam';
66 } elsif ($uri = nntp_uri($dir)) {
67 $nntp{$$uri} = 'watchspam';
70 warn "unsupported $k=$dir\n";
75 my $k = 'publicinboxwatch.spamcheck';
77 my $spamcheck = PublicInbox::Spamcheck::get($cfg, $k, $default);
78 $spamcheck = _spamcheck_cb($spamcheck) if $spamcheck;
80 $cfg->each_inbox(sub {
81 # need to make all inboxes writable for spam removal:
82 my $ibx = $_[0] = PublicInbox::InboxWritable->new($_[0]);
84 my $watches = $ibx->{watch} or return;
85 $watches = PublicInbox::Config::_array($watches);
86 for my $watch (@$watches) {
88 if (is_maildir($watch)) {
89 compile_watchheaders($ibx);
90 my ($new, $cur) = ("$watch/new", "$watch/cur");
91 my $cur_dst = $mdmap{$cur} //= [];
92 return if is_watchspam($cur, $cur_dst, $ibx);
93 push @{$mdmap{$new} //= []}, $ibx;
95 } elsif ($uri = imap_uri($watch)) {
96 my $cur_dst = $imap{$$uri} //= [];
97 return if is_watchspam($uri, $cur_dst, $ibx);
98 compile_watchheaders($ibx);
99 push(@imap, $uri) if 1 == push(@$cur_dst, $ibx);
100 } elsif ($uri = nntp_uri($watch)) {
101 my $cur_dst = $nntp{$$uri} //= [];
102 return if is_watchspam($uri, $cur_dst, $ibx);
103 compile_watchheaders($ibx);
104 push(@nntp, $uri) if 1 == push(@$cur_dst, $ibx);
106 warn "watch unsupported: $k=$watch\n";
112 if (scalar keys %mdmap) {
113 $mdre = join('|', map { quotemeta($_) } keys %mdmap);
114 $mdre = qr!\A($mdre)/!;
116 return unless $mdre || scalar(keys %imap) || scalar(keys %nntp);
119 max_batch => 10, # avoid hogging locks for too long
120 spamcheck => $spamcheck,
124 imap => scalar keys %imap ? \%imap : undef,
125 nntp => scalar keys %nntp? \%nntp : undef,
126 imap_order => scalar(@imap) ? \@imap : undef,
127 nntp_order => scalar(@nntp) ? \@nntp: undef,
129 opendirs => {}, # dirname => dirhandle (in progress scans)
130 ops => [], # 'quit', 'full'
136 local $PublicInbox::DS::in_loop = 0; # waitpid() synchronously
137 for my $im (values %{$self->{importers}}) {
138 next if !$im; # $im may be undef during cleanup
140 warn "$im->{ibx}->{name} ->done: $@\n" if $@;
144 sub remove_eml_i { # each_inbox callback
145 my ($ibx, $self, $eml, $loc) = @_;
148 # try to avoid taking a lock or unnecessary spawning
149 my $im = $self->{importers}->{"$ibx"};
151 if ((!$im || !$im->active) && $ibx->over) {
152 if (content_exists($ibx, $eml)) {
154 } elsif (my $scrub = $ibx->filter($im)) {
155 $scrubbed = $scrub->scrub($eml, 1);
156 if ($scrubbed && $scrubbed != REJECT &&
157 !content_exists($ibx, $scrubbed)) {
165 $im //= _importer_for($self, $ibx); # may spawn fast-import
166 $im->remove($eml, 'spam');
168 my $scrub = $ibx->filter($im);
169 $scrub ? $scrub->scrub($eml, 1) : undef;
171 if ($scrubbed && $scrubbed != REJECT) {
172 $im->remove($scrubbed, 'spam');
176 warn "error removing spam at: $loc from $ibx->{name}: $@\n";
177 _done_for_now($self);
182 my ($self, $path) = @_;
183 # path must be marked as (S)een
184 $path =~ /:2,[A-R]*S[T-Za-z]*\z/ or return;
185 my $eml = eml_from_path($path) or return;
186 local $SIG{__WARN__} = PublicInbox::Eml::warn_ignore_cb();
187 $self->{pi_cfg}->each_inbox(\&remove_eml_i, $self, $eml, $path);
190 sub import_eml ($$$) {
191 my ($self, $ibx, $eml) = @_;
193 # any header match means it's eligible for the inbox:
194 if (my $watch_hdrs = $ibx->{-watchheaders}) {
196 for my $wh (@$watch_hdrs) {
197 my @v = $eml->header_raw($wh->[0]);
198 $ok = grep(/$wh->[1]/, @v) and last;
203 my $im = _importer_for($self, $ibx);
204 if (my $scrub = $ibx->filter($im)) {
205 my $scrubbed = $scrub->scrub($eml) or return;
206 $scrubbed == REJECT and return;
209 $im->add($eml, $self->{spamcheck});
212 warn "$ibx->{name} add failed: $@\n";
213 _done_for_now($self);
218 my ($self, $path) = @_;
219 my $fl = PublicInbox::MdirReader::maildir_path_flags($path) // return;
220 return if $fl =~ /[DT]/; # no Drafts or Trash
221 if ($path !~ $self->{mdre}) {
222 warn "unrecognized path: $path\n";
225 my $inboxes = $self->{mdmap}->{$1};
227 warn "unmappable dir: $1\n";
230 my $warn_cb = $SIG{__WARN__} || \&CORE::warn;
231 local $SIG{__WARN__} = sub {
232 my $pfx = ($_[0] // '') =~ /^([A-Z]: )/g ? $1 : '';
233 $warn_cb->($pfx, "path: $path\n", @_);
235 if (!ref($inboxes) && $inboxes eq 'watchspam') {
236 return _remove_spam($self, $path);
238 foreach my $ibx (@$inboxes) {
239 my $eml = eml_from_path($path) or next;
240 import_eml($self, $ibx, $eml);
246 return unless $self->{quit};
248 # don't have reliable wakeups, keep signalling
250 for (qw(idle_pids poll_pids)) {
251 my $pids = $self->{$_} or next;
253 $done = undef if kill('QUIT', $_);
262 %{$self->{opendirs}} = ();
263 _done_for_now($self);
265 if (my $idle_mic = $self->{idle_mic}) {
266 eval { $idle_mic->done };
268 warn "IDLE DONE error: $@\n";
269 eval { $idle_mic->disconnect };
270 warn "IDLE LOGOUT error: $@\n" if $@;
275 sub watch_fs_init ($) {
278 delete $self->{done_timer};
279 _done_for_now($self);
281 my $cb = sub { # called by PublicInbox::DirIdle::event_step
282 _try_path($self, $_[0]->fullname);
283 $self->{done_timer} //= PublicInbox::DS::requeue($done);
285 require PublicInbox::DirIdle;
286 # inotify_create + EPOLL_CTL_ADD
287 PublicInbox::DirIdle->new([keys %{$self->{mdmap}}], $cb);
290 sub net_cb { # NetReader::(nntp|imap)_each callback
291 my ($uri, $art, $kw, $eml, $self, $inboxes) = @_;
292 return if grep(/\Adraft\z/, @$kw);
293 local $self->{cur_uid} = $art; # IMAP UID or NNTP article
298 my $tmp = PublicInbox::Eml->new(\($eml->as_string));
299 import_eml($self, $ibx, $tmp);
301 import_eml($self, $last, $eml);
302 } elsif ($inboxes eq 'watchspam') {
303 if ($uri->scheme =~ /\Aimaps?\z/ && !grep(/\Aseen\z/, @$kw)) {
306 $self->{pi_cfg}->each_inbox(\&remove_eml_i,
307 $self, $eml, "$uri #$art");
309 die "BUG: destination unknown $inboxes";
313 sub imap_fetch_all ($$) {
314 my ($self, $uri) = @_;
315 my $warn_cb = $SIG{__WARN__} || \&CORE::warn;
316 $self->{incremental} = 1;
317 $self->{on_commit} = [ \&_done_for_now, $self ];
318 local $self->{cur_uid};
319 local $SIG{__WARN__} = sub {
320 my $pfx = ($_[0] // '') =~ /^([A-Z]: |# )/g ? $1 : '';
321 my $uid = $self->{cur_uid};
322 $warn_cb->("$pfx$uri", $uid ? ("UID:$uid") : (), "\n", @_);
324 PublicInbox::NetReader::imap_each($self, $uri, \&net_cb, $self,
325 $self->{imap}->{$$uri});
328 sub imap_idle_once ($$$$) {
329 my ($self, $mic, $intvl, $uri) = @_;
330 my $i = $intvl //= (29 * 60);
331 my $end = now() + $intvl;
332 warn "I: $uri idling for ${intvl}s\n";
333 local $0 = "IDLE $0";
334 unless ($mic->idle) {
335 return if $self->{quit};
336 return "E: IDLE failed on $uri: $!";
338 $self->{idle_mic} = $mic; # for ->quit
340 until ($self->{quit} || !$mic->IsConnected ||
341 grep(/^\* [0-9]+ EXISTS/, @res) || $i <= 0) {
342 @res = $mic->idle_data($i);
345 delete $self->{idle_mic};
346 unless ($self->{quit}) {
347 $mic->IsConnected or return "E: IDLE disconnected on $uri";
348 $mic->done or return "E: IDLE DONE failed on $uri: $!";
353 # idles on a single URI
354 sub watch_imap_idle_1 ($$$) {
355 my ($self, $uri, $intvl) = @_;
356 my $sec = uri_section($uri);
357 my $mic_arg = $self->{mic_arg}->{$sec} or
358 die "BUG: no Mail::IMAPClient->new arg for $sec";
360 local $0 = $uri->mailbox." $sec";
361 until ($self->{quit}) {
362 $mic //= PublicInbox::IMAPClient->new(%$mic_arg);
364 if ($mic && $mic->IsConnected) {
365 local $self->{mics_cached}->{$sec} = $mic;
366 my $m = imap_fetch_all($self, $uri);
367 $m == $mic or die "BUG: wrong mic";
368 $mic->IsConnected and
369 $err = imap_idle_once($self, $mic, $intvl, $uri)
371 $err = "E: not connected: $!";
373 if ($err && !$self->{quit}) {
376 sleep 60 unless $self->{quit};
381 sub watch_atfork_child ($) {
383 delete $self->{idle_pids};
384 delete $self->{poll_pids};
385 delete $self->{opendirs};
386 PublicInbox::DS->Reset;
387 %SIG = (%SIG, %{$self->{sig}}, CHLD => 'DEFAULT');
388 PublicInbox::DS::sig_setmask($self->{oldset});
391 sub watch_atfork_parent ($) {
393 _done_for_now($self);
394 PublicInbox::DS::block_signals();
397 sub imap_idle_requeue { # DS::add_timer callback
398 my ($self, $uri_intvl) = @_;
399 return if $self->{quit};
400 push @{$self->{idle_todo}}, $uri_intvl;
404 sub imap_idle_reap { # PublicInbox::DS::dwaitpid callback
405 my ($self, $pid) = @_;
406 my $uri_intvl = delete $self->{idle_pids}->{$pid} or
407 die "BUG: PID=$pid (unknown) reaped: \$?=$?\n";
409 my ($uri, $intvl) = @$uri_intvl;
410 return if $self->{quit};
411 warn "W: PID=$pid on $uri died: \$?=$?\n" if $?;
412 add_timer(60, \&imap_idle_requeue, $self, $uri_intvl);
415 sub reap { # callback for EOFpipe
416 my ($pid, $cb, $self) = @{$_[0]};
417 my $ret = waitpid($pid, 0);
419 $cb->($self, $pid); # poll_fetch_reap || imap_idle_reap
421 warn "W: waitpid($pid) => ", $ret // "($!)", "\n";
425 sub imap_idle_fork ($$) {
426 my ($self, $uri_intvl) = @_;
427 my ($uri, $intvl) = @$uri_intvl;
428 pipe(my ($r, $w)) or die "pipe: $!";
429 my $seed = rand(0xffffffff);
430 my $pid = fork // die "fork: $!";
433 eval { Net::SSLeay::randomize() };
435 watch_atfork_child($self);
436 watch_imap_idle_1($self, $uri, $intvl);
440 $self->{idle_pids}->{$pid} = $uri_intvl;
441 PublicInbox::EOFpipe->new($r, \&reap, [$pid, \&imap_idle_reap, $self]);
446 return if $self->{quit};
447 my $idle_todo = $self->{idle_todo};
448 if ($idle_todo && @$idle_todo) {
449 my $oldset = watch_atfork_parent($self);
451 while (my $uri_intvl = shift(@$idle_todo)) {
452 imap_idle_fork($self, $uri_intvl);
455 PublicInbox::DS::sig_setmask($oldset);
458 fs_scan_step($self) if $self->{mdre};
461 sub watch_imap_fetch_all ($$) {
462 my ($self, $uris) = @_;
463 for my $uri (@$uris) {
464 imap_fetch_all($self, $uri);
465 last if $self->{quit};
469 sub watch_nntp_fetch_all ($$) {
470 my ($self, $uris) = @_;
471 $self->{incremental} = 1;
472 $self->{on_commit} = [ \&_done_for_now, $self ];
473 my $warn_cb = $SIG{__WARN__} || \&CORE::warn;
474 local $self->{cur_uid};
476 local $SIG{__WARN__} = sub {
477 my $pfx = ($_[0] // '') =~ /^([A-Z]: |# )/g ? $1 : '';
478 my $art = $self->{cur_uid};
479 $warn_cb->("$pfx$uri", $art ? ("ARTICLE $art") : (), "\n", @_);
482 PublicInbox::NetReader::nntp_each($self, $uri, \&net_cb, $self,
483 $self->{nntp}->{$$uri});
484 last if $self->{quit};
488 sub poll_fetch_fork { # DS::add_timer callback
489 my ($self, $intvl, $uris) = @_;
490 return if $self->{quit};
491 pipe(my ($r, $w)) or die "pipe: $!";
492 my $oldset = watch_atfork_parent($self);
493 my $seed = rand(0xffffffff);
495 if (defined($pid) && $pid == 0) {
497 eval { Net::SSLeay::randomize() };
499 watch_atfork_child($self);
500 if ($uris->[0]->scheme =~ m!\Aimaps?!i) {
501 watch_imap_fetch_all($self, $uris);
503 watch_nntp_fetch_all($self, $uris);
508 PublicInbox::DS::sig_setmask($oldset);
509 die "fork: $!" unless defined $pid;
510 $self->{poll_pids}->{$pid} = [ $intvl, $uris ];
511 PublicInbox::EOFpipe->new($r, \&reap, [$pid, \&poll_fetch_reap, $self]);
514 sub poll_fetch_reap {
515 my ($self, $pid) = @_;
516 my $intvl_uris = delete $self->{poll_pids}->{$pid} or
517 die "BUG: PID=$pid (unknown) reaped: \$?=$?\n";
518 return if $self->{quit};
519 my ($intvl, $uris) = @$intvl_uris;
521 warn "W: PID=$pid died: \$?=$?\n", map { "$_\n" } @$uris;
523 warn("I: will check $_ in ${intvl}s\n") for @$uris;
524 add_timer($intvl, \&poll_fetch_fork, $self, $intvl, $uris);
527 sub watch_imap_init ($$) {
528 my ($self, $poll) = @_;
529 my $mics = PublicInbox::NetReader::imap_common_init($self);
530 my $idle = []; # [ [ uri1, intvl1 ], [uri2, intvl2] ]
531 for my $uri (@{$self->{imap_order}}) {
532 my $sec = uri_section($uri);
533 my $mic = $mics->{$sec};
534 my $intvl = $self->{imap_opt}->{$sec}->{pollInterval};
535 if ($mic->has_capability('IDLE') && !$intvl) {
536 $intvl = $self->{imap_opt}->{$sec}->{idleInterval};
537 push @$idle, [ $uri, $intvl // () ];
539 push @{$poll->{$intvl || 120}}, $uri;
543 $self->{idle_todo} = $idle;
544 PublicInbox::DS::requeue($self); # ->event_step to fork
548 sub watch_nntp_init ($$) {
549 my ($self, $poll) = @_;
550 PublicInbox::NetReader::nntp_common_init($self);
551 for my $uri (@{$self->{nntp_order}}) {
552 my $sec = uri_section($uri);
553 my $intvl = $self->{nntp_opt}->{$sec}->{pollInterval};
554 push @{$poll->{$intvl || 120}}, $uri;
558 sub watch { # main entry point
559 my ($self, $sig, $oldset) = @_;
560 $self->{oldset} = $oldset;
562 my $poll = {}; # intvl_seconds => [ uri1, uri2 ]
563 watch_imap_init($self, $poll) if $self->{imap};
564 watch_nntp_init($self, $poll) if $self->{nntp};
565 while (my ($intvl, $uris) = each %$poll) {
566 # poll all URIs for a given interval sequentially
567 add_timer(0, \&poll_fetch_fork, $self, $intvl, $uris);
569 watch_fs_init($self) if $self->{mdre};
570 PublicInbox::DS->SetPostLoopCallback(sub { !$self->quit_done });
571 PublicInbox::DS->EventLoop; # calls ->event_step
572 _done_for_now($self);
576 my ($self, $op) = @_;
577 push @{$self->{ops}}, $op;
578 PublicInbox::DS::requeue($self);
583 return if $self->{quit};
584 my $op = shift @{$self->{ops}};
585 local $PublicInbox::DS::in_loop = 0; # waitpid() synchronously
587 # continue existing scan
588 my $opendirs = $self->{opendirs};
589 my @dirnames = keys %$opendirs;
590 foreach my $dir (@dirnames) {
591 my $dh = delete $opendirs->{$dir};
592 my $n = $self->{max_batch};
593 while (my $fn = readdir($dh)) {
594 _try_path($self, "$dir/$fn");
597 $opendirs->{$dir} = $dh if $n < 0;
599 if ($op && $op eq 'full') {
600 foreach my $dir (keys %{$self->{mdmap}}) {
601 next if $opendirs->{$dir}; # already in progress
602 my $ok = opendir(my $dh, $dir);
604 warn "failed to open $dir: $!\n";
607 my $n = $self->{max_batch};
608 while (my $fn = readdir($dh)) {
609 _try_path($self, "$dir/$fn");
612 $opendirs->{$dir} = $dh if $n < 0;
615 _done_for_now($self);
616 # do we have more work to do?
617 PublicInbox::DS::requeue($self) if keys %$opendirs;
621 my ($self, $op) = @_;
622 push @{$self->{ops}}, $op;
627 my ($self, $ibx) = @_;
628 my $importers = $self->{importers};
629 my $im = $importers->{"$ibx"} ||= $ibx->importer(0);
630 if (scalar(keys(%$importers)) > 2) {
631 delete $importers->{"$ibx"};
632 _done_for_now($self);
635 $importers->{"$ibx"} = $im;
638 # XXX consider sharing with V2Writable, this only requires read-only access
639 sub content_exists ($$) {
640 my ($ibx, $eml) = @_;
641 my $over = $ibx->over or return;
642 my $mids = mids($eml);
643 my $chash = content_hash($eml);
645 for my $mid (@$mids) {
646 while (my $smsg = $over->next_by_mid($mid, \$id, \$prev)) {
647 my $cmp = $ibx->smsg_eml($smsg) or return;
648 return 1 if $chash eq content_hash($cmp);
656 sub { # this gets called by (V2Writable||Import)->add
657 my ($mime, $ibx) = @_;
658 return if content_exists($ibx, $mime);
660 if ($sc->spamcheck($mime, \$tmp)) {
661 return PublicInbox::Eml->new(\$tmp);
663 warn $mime->header('Message-ID')." failed spam check\n";
669 $_[0] =~ s!\Amaildir:!! or return;
676 my ($cur, $ws, $ibx) = @_;
677 if ($ws && !ref($ws) && $ws eq 'watchspam') {
679 E: $cur is a spam folder and cannot be used for `$ibx->{name}' input