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 # http://wiki2.dovecot.org/MailboxFormat/Maildir
6 package PublicInbox::Watch;
10 use PublicInbox::InboxWritable qw(eml_from_path warn_ignore_cb);
11 use PublicInbox::Filter::Base qw(REJECT);
12 use PublicInbox::Spamcheck;
13 use PublicInbox::Sigfd;
14 use PublicInbox::DS qw(now);
15 use PublicInbox::MID qw(mids);
16 use PublicInbox::ContentHash qw(content_hash);
17 use PublicInbox::EOFpipe;
18 use POSIX qw(_exit WNOHANG);
20 sub compile_watchheaders ($) {
23 if (my $whs = $ibx->{watchheader}) {
25 my ($k, $v) = split(/:/, $_, 2);
26 # XXX should this be case-insensitive?
27 # Or, mutt-style, case-sensitive iff
28 # a capital letter exists?
29 push @$watch_hdrs, [ $k, qr/\Q$v\E/ ];
32 if (my $list_ids = $ibx->{listid}) {
34 # RFC2919 section 6 stipulates
35 # "case insensitive equality"
36 my $re = qr/<[ \t]*\Q$_\E[ \t]*>/i;
37 push @$watch_hdrs, ['List-Id', $re ];
40 $ibx->{-watchheaders} = $watch_hdrs if scalar @$watch_hdrs;
44 my ($class, $cfg) = @_;
46 my (%imap, %nntp); # url => [inbox objects] or 'watchspam'
48 # "publicinboxwatch" is the documented namespace
49 # "publicinboxlearn" is legacy but may be supported
51 foreach my $pfx (qw(publicinboxwatch publicinboxlearn)) {
52 my $k = "$pfx.watchspam";
53 defined(my $dirs = $cfg->{$k}) or next;
54 $dirs = PublicInbox::Config::_array($dirs);
55 for my $dir (@$dirs) {
57 if (is_maildir($dir)) {
58 # skip "new", no MUA has seen it, yet.
59 $mdmap{"$dir/cur"} = 'watchspam';
60 } elsif ($url = imap_url($dir)) {
61 $imap{$url} = 'watchspam';
62 } elsif ($url = nntp_url($dir)) {
63 $nntp{$url} = 'watchspam';
65 warn "unsupported $k=$dir\n";
70 my $k = 'publicinboxwatch.spamcheck';
72 my $spamcheck = PublicInbox::Spamcheck::get($cfg, $k, $default);
73 $spamcheck = _spamcheck_cb($spamcheck) if $spamcheck;
75 $cfg->each_inbox(sub {
76 # need to make all inboxes writable for spam removal:
77 my $ibx = $_[0] = PublicInbox::InboxWritable->new($_[0]);
79 my $watches = $ibx->{watch} or return;
80 $watches = PublicInbox::Config::_array($watches);
81 for my $watch (@$watches) {
83 if (is_maildir($watch)) {
84 compile_watchheaders($ibx);
85 my ($new, $cur) = ("$watch/new", "$watch/cur");
86 my $cur_dst = $mdmap{$cur} //= [];
87 return if is_watchspam($cur, $cur_dst, $ibx);
88 push @{$mdmap{$new} //= []}, $ibx;
90 } elsif ($url = imap_url($watch)) {
91 return if is_watchspam($url, $imap{$url}, $ibx);
92 compile_watchheaders($ibx);
93 push @{$imap{$url} ||= []}, $ibx;
94 } elsif ($url = nntp_url($watch)) {
95 return if is_watchspam($url, $nntp{$url}, $ibx);
96 compile_watchheaders($ibx);
97 push @{$nntp{$url} ||= []}, $ibx;
99 warn "watch unsupported: $k=$watch\n";
105 if (scalar keys %mdmap) {
106 $mdre = join('|', map { quotemeta($_) } keys %mdmap);
107 $mdre = qr!\A($mdre)/!;
109 return unless $mdre || scalar(keys %imap) || scalar(keys %nntp);
112 max_batch => 10, # avoid hogging locks for too long
113 spamcheck => $spamcheck,
117 imap => scalar keys %imap ? \%imap : undef,
118 nntp => scalar keys %nntp? \%nntp : undef,
120 opendirs => {}, # dirname => dirhandle (in progress scans)
121 ops => [], # 'quit', 'full'
127 local $PublicInbox::DS::in_loop = 0; # waitpid() synchronously
128 for my $im (values %{$self->{importers}}) {
129 next if !$im; # $im may be undef during cleanup
131 warn "$im->{ibx}->{name} ->done: $@\n" if $@;
135 sub remove_eml_i { # each_inbox callback
136 my ($ibx, $self, $eml, $loc) = @_;
139 # try to avoid taking a lock or unnecessary spawning
140 my $im = $self->{importers}->{"$ibx"};
142 if ((!$im || !$im->active) && $ibx->over) {
143 if (content_exists($ibx, $eml)) {
145 } elsif (my $scrub = $ibx->filter($im)) {
146 $scrubbed = $scrub->scrub($eml, 1);
147 if ($scrubbed && $scrubbed != REJECT &&
148 !content_exists($ibx, $scrubbed)) {
156 $im //= _importer_for($self, $ibx); # may spawn fast-import
157 $im->remove($eml, 'spam');
159 my $scrub = $ibx->filter($im);
160 $scrub ? $scrub->scrub($eml, 1) : undef;
162 if ($scrubbed && $scrubbed != REJECT) {
163 $im->remove($scrubbed, 'spam');
167 warn "error removing spam at: $loc from $ibx->{name}: $@\n";
168 _done_for_now($self);
173 my ($self, $path) = @_;
174 # path must be marked as (S)een
175 $path =~ /:2,[A-R]*S[T-Za-z]*\z/ or return;
176 my $eml = eml_from_path($path) or return;
177 local $SIG{__WARN__} = warn_ignore_cb();
178 $self->{pi_cfg}->each_inbox(\&remove_eml_i, $self, $eml, $path);
181 sub import_eml ($$$) {
182 my ($self, $ibx, $eml) = @_;
184 # any header match means it's eligible for the inbox:
185 if (my $watch_hdrs = $ibx->{-watchheaders}) {
187 for my $wh (@$watch_hdrs) {
188 my @v = $eml->header_raw($wh->[0]);
189 $ok = grep(/$wh->[1]/, @v) and last;
194 my $im = _importer_for($self, $ibx);
195 if (my $scrub = $ibx->filter($im)) {
196 my $scrubbed = $scrub->scrub($eml) or return;
197 $scrubbed == REJECT and return;
200 $im->add($eml, $self->{spamcheck});
203 warn "$ibx->{name} add failed: $@\n";
204 _done_for_now($self);
209 my ($self, $path) = @_;
210 return unless PublicInbox::InboxWritable::is_maildir_path($path);
211 if ($path !~ $self->{mdre}) {
212 warn "unrecognized path: $path\n";
215 my $inboxes = $self->{mdmap}->{$1};
217 warn "unmappable dir: $1\n";
220 my $warn_cb = $SIG{__WARN__} || \&CORE::warn;
221 local $SIG{__WARN__} = sub {
222 my $pfx = ($_[0] // '') =~ /^([A-Z]: )/g ? $1 : '';
223 $warn_cb->($pfx, "path: $path\n", @_);
225 if (!ref($inboxes) && $inboxes eq 'watchspam') {
226 return _remove_spam($self, $path);
228 foreach my $ibx (@$inboxes) {
229 my $eml = eml_from_path($path) or next;
230 import_eml($self, $ibx, $eml);
236 return unless $self->{quit};
238 # don't have reliable wakeups, keep signalling
240 for (qw(idle_pids poll_pids)) {
241 my $pids = $self->{$_} or next;
243 $done = undef if kill('QUIT', $_);
252 %{$self->{opendirs}} = ();
253 _done_for_now($self);
255 if (my $idle_mic = $self->{idle_mic}) {
256 eval { $idle_mic->done };
258 warn "IDLE DONE error: $@\n";
259 eval { $idle_mic->disconnect };
260 warn "IDLE LOGOUT error: $@\n" if $@;
265 sub watch_fs_init ($) {
268 delete $self->{done_timer};
269 _done_for_now($self);
271 my $cb = sub { # called by PublicInbox::DirIdle::event_step
272 _try_path($self, $_[0]->fullname);
273 $self->{done_timer} //= PublicInbox::DS::requeue($done);
275 require PublicInbox::DirIdle;
276 # inotify_create + EPOLL_CTL_ADD
277 PublicInbox::DirIdle->new([keys %{$self->{mdmap}}], $cb);
280 # avoid exposing deprecated "snews" to users.
281 my %SCHEME_MAP = ('snews' => 'nntps');
285 my $scheme = $uri->scheme;
286 $SCHEME_MAP{$scheme} // $scheme;
289 # returns the git config section name, e.g [imap "imaps://user@example.com"]
290 # without the mailbox, so we can share connections between different inboxes
291 sub uri_section ($) {
293 uri_scheme($uri) . '://' . $uri->authority;
296 sub cfg_intvl ($$$) {
297 my ($cfg, $key, $url) = @_;
298 my $v = $cfg->urlmatch($key, $url) // return;
299 $v =~ /\A[0-9]+(?:\.[0-9]+)?\z/s and return $v + 0;
300 if (ref($v) eq 'ARRAY') {
301 $v = join(', ', @$v);
302 warn "W: $key has multiple values: $v\nW: $key ignored\n";
304 warn "W: $key=$v is not a numeric value in seconds\n";
309 my ($cfg, $key, $url) = @_;
310 my $orig = $cfg->urlmatch($key, $url) // return;
311 my $bool = $cfg->git_bool($orig);
312 warn "W: $key=$orig for $url is not boolean\n" unless defined($bool);
316 # flesh out common IMAP-specific data structures
317 sub imap_common_init ($) {
319 my $cfg = $self->{pi_cfg};
320 my $mic_args = {}; # scheme://authority => Mail:IMAPClient arg
321 for my $url (sort keys %{$self->{imap}}) {
322 my $uri = PublicInbox::URIimap->new($url);
323 my $sec = uri_section($uri);
324 for my $k (qw(Starttls Debug Compress)) {
325 my $bool = cfg_bool($cfg, "imap.$k", $url) // next;
326 $mic_args->{$sec}->{$k} = $bool;
328 my $to = cfg_intvl($cfg, 'imap.timeout', $url);
329 $mic_args->{$sec}->{Timeout} = $to if $to;
330 for my $k (qw(pollInterval idleInterval)) {
331 $to = cfg_intvl($cfg, "imap.$k", $url) // next;
332 $self->{imap_opt}->{$sec}->{$k} = $to;
334 my $k = 'imap.fetchBatchSize';
335 my $bs = $cfg->urlmatch($k, $url) // next;
336 if ($bs =~ /\A([0-9]+)\z/) {
337 $self->{imap_opt}->{$sec}->{batch_size} = $bs;
339 warn "$k=$bs is not an integer\n";
345 sub auth_anon_cb { '' }; # for Mail::IMAPClient::Authcallback
347 sub mic_for ($$$) { # mic = Mail::IMAPClient
348 my ($self, $url, $mic_args) = @_;
349 my $uri = PublicInbox::URIimap->new($url);
350 require PublicInbox::GitCredential;
353 protocol => $uri->scheme,
355 username => $uri->user,
356 password => $uri->password,
357 }, 'PublicInbox::GitCredential';
358 my $common = $mic_args->{uri_section($uri)} // {};
359 # IMAPClient and Net::Netrc both mishandles `0', so we pass `127.0.0.1'
360 my $host = $cred->{host};
361 $host = '127.0.0.1' if $host eq '0';
365 Ssl => $uri->scheme eq 'imaps',
366 Keepalive => 1, # SO_KEEPALIVE
367 %$common, # may set Starttls, Compress, Debug ....
369 my $mic = PublicInbox::IMAPClient->new(%$mic_arg) or
370 die "E: <$url> new: $@\n";
372 # default to using STARTTLS if it's available, but allow
373 # it to be disabled since I usually connect to localhost
374 if (!$mic_arg->{Ssl} && !defined($mic_arg->{Starttls}) &&
375 $mic->has_capability('STARTTLS') &&
376 $mic->can('starttls')) {
377 $mic->starttls or die "E: <$url> STARTTLS: $@\n";
380 # do we even need credentials?
381 if (!defined($cred->{username}) &&
382 $mic->has_capability('AUTH=ANONYMOUS')) {
386 $cred->check_netrc unless defined $cred->{password};
387 $cred->fill; # may prompt user here
388 $mic->User($mic_arg->{User} = $cred->{username});
389 $mic->Password($mic_arg->{Password} = $cred->{password});
390 } else { # AUTH=ANONYMOUS
391 $mic->Authmechanism($mic_arg->{Authmechanism} = 'ANONYMOUS');
392 $mic->Authcallback($mic_arg->{Authcallback} = \&auth_anon_cb);
394 if ($mic->login && $mic->IsAuthenticated) {
395 # success! keep IMAPClient->new arg in case we get disconnected
396 $self->{mic_arg}->{uri_section($uri)} = $mic_arg;
398 warn "E: <$url> LOGIN: $@\n";
401 $cred->run($mic ? 'approve' : 'reject') if $cred;
405 sub imap_import_msg ($$$$$) {
406 my ($self, $url, $uid, $raw, $flags) = @_;
407 # our target audience expects LF-only, save storage
408 $$raw =~ s/\r\n/\n/sg;
410 my $inboxes = $self->{imap}->{$url};
412 for my $ibx (@$inboxes) {
413 my $eml = PublicInbox::Eml->new($$raw);
414 import_eml($self, $ibx, $eml);
416 } elsif ($inboxes eq 'watchspam') {
417 # we don't remove unseen messages
418 if ($flags =~ /\\Seen\b/) {
419 local $SIG{__WARN__} = warn_ignore_cb();
420 my $eml = PublicInbox::Eml->new($raw);
421 $self->{pi_cfg}->each_inbox(\&remove_eml_i,
422 $self, $eml, "$url UID:$uid");
425 die "BUG: destination unknown $inboxes";
429 sub imap_fetch_all ($$$) {
430 my ($self, $mic, $url) = @_;
431 my $uri = PublicInbox::URIimap->new($url);
432 my $sec = uri_section($uri);
433 my $mbx = $uri->mailbox;
434 $mic->Clear(1); # trim results history
435 $mic->examine($mbx) or return "E: EXAMINE $mbx ($sec) failed: $!";
436 my ($r_uidval, $r_uidnext);
437 for ($mic->Results) {
438 /^\* OK \[UIDVALIDITY ([0-9]+)\].*/ and $r_uidval = $1;
439 /^\* OK \[UIDNEXT ([0-9]+)\].*/ and $r_uidnext = $1;
440 last if $r_uidval && $r_uidnext;
442 $r_uidval //= $mic->uidvalidity($mbx) //
443 return "E: $url cannot get UIDVALIDITY";
444 $r_uidnext //= $mic->uidnext($mbx) //
445 return "E: $url cannot get UIDNEXT";
446 my $itrk = PublicInbox::IMAPTracker->new($url);
447 my ($l_uidval, $l_uid) = $itrk->get_last;
448 $l_uidval //= $r_uidval; # first time
450 if ($l_uidval != $r_uidval) {
451 return "E: $url UIDVALIDITY mismatch\n".
452 "E: local=$l_uidval != remote=$r_uidval";
454 my $r_uid = $r_uidnext - 1;
455 if ($l_uid != 1 && $l_uid > $r_uid) {
456 return "E: $url local UID exceeds remote ($l_uid > $r_uid)\n".
457 "E: $url strangely, UIDVALIDLITY matches ($l_uidval)\n";
459 return if $l_uid >= $r_uid; # nothing to do
461 warn "I: $url fetching UID $l_uid:$r_uid\n";
462 $mic->Uid(1); # the default, we hope
463 my $bs = $self->{imap_opt}->{$sec}->{batch_size} // 1;
464 my $req = $mic->imap4rev1 ? 'BODY.PEEK[]' : 'RFC822.PEEK';
466 # TODO: FLAGS may be useful for personal use
470 my $warn_cb = $SIG{__WARN__} || \&CORE::warn;
471 local $SIG{__WARN__} = sub {
472 my $pfx = ($_[0] // '') =~ /^([A-Z]: )/g ? $1 : '';
474 $warn_cb->("$pfx$url UID:$batch\n", @_);
478 # I wish "UID FETCH $START:*" could work, but:
479 # 1) servers do not need to return results in any order
480 # 2) Mail::IMAPClient doesn't offer a streaming API
481 $uids = $mic->search("UID $l_uid:*") or
482 return "E: $url UID SEARCH $l_uid:* error: $!";
483 return if scalar(@$uids) == 0;
485 # RFC 3501 doesn't seem to indicate order of UID SEARCH
486 # responses, so sort it ourselves. Order matters so
487 # IMAPTracker can store the newest UID.
488 @$uids = sort { $a <=> $b } @$uids;
490 # Did we actually get new messages?
491 return if $uids->[0] < $l_uid;
493 $l_uid = $uids->[-1] + 1; # for next search
495 my $n = $self->{max_batch};
497 while (scalar @$uids) {
499 _done_for_now($self);
500 $itrk->update_last($r_uidval, $last_uid);
501 $n = $self->{max_batch};
503 my @batch = splice(@$uids, 0, $bs);
504 $batch = join(',', @batch);
505 local $0 = "UID:$batch $mbx $sec";
506 my $r = $mic->fetch_hash($batch, $req, 'FLAGS');
507 unless ($r) { # network error?
508 $err = "E: $url UID FETCH $batch error: $!";
511 for my $uid (@batch) {
512 # messages get deleted, so holes appear
513 my $per_uid = delete $r->{$uid} // next;
514 my $raw = delete($per_uid->{$key}) // next;
515 my $fl = $per_uid->{FLAGS} // '';
516 imap_import_msg($self, $url, $uid, \$raw, $fl);
518 last if $self->{quit};
520 last if $self->{quit};
522 _done_for_now($self);
523 $itrk->update_last($r_uidval, $last_uid);
524 } until ($err || $self->{quit});
528 sub imap_idle_once ($$$$) {
529 my ($self, $mic, $intvl, $url) = @_;
530 my $i = $intvl //= (29 * 60);
531 my $end = now() + $intvl;
532 warn "I: $url idling for ${intvl}s\n";
533 local $0 = "IDLE $0";
534 unless ($mic->idle) {
535 return if $self->{quit};
536 return "E: IDLE failed on $url: $!";
538 $self->{idle_mic} = $mic; # for ->quit
540 until ($self->{quit} || !$mic->IsConnected ||
541 grep(/^\* [0-9]+ EXISTS/, @res) || $i <= 0) {
542 @res = $mic->idle_data($i);
545 delete $self->{idle_mic};
546 unless ($self->{quit}) {
547 $mic->IsConnected or return "E: IDLE disconnected on $url";
548 $mic->done or return "E: IDLE DONE failed on $url: $!";
553 # idles on a single URI
554 sub watch_imap_idle_1 ($$$) {
555 my ($self, $url, $intvl) = @_;
556 my $uri = PublicInbox::URIimap->new($url);
557 my $sec = uri_section($uri);
558 my $mic_arg = $self->{mic_arg}->{$sec} or
559 die "BUG: no Mail::IMAPClient->new arg for $sec";
561 local $0 = $uri->mailbox." $sec";
562 until ($self->{quit}) {
563 $mic //= PublicInbox::IMAPClient->new(%$mic_arg);
565 if ($mic && $mic->IsConnected) {
566 $err = imap_fetch_all($self, $mic, $url);
567 $err //= imap_idle_once($self, $mic, $intvl, $url);
569 $err = "E: not connected: $!";
571 if ($err && !$self->{quit}) {
574 sleep 60 unless $self->{quit};
579 sub watch_atfork_child ($) {
581 delete $self->{idle_pids};
582 delete $self->{poll_pids};
583 delete $self->{opendirs};
584 PublicInbox::DS->Reset;
585 %SIG = (%SIG, %{$self->{sig}}, CHLD => 'DEFAULT');
586 PublicInbox::DS::sig_setmask($self->{oldset});
589 sub watch_atfork_parent ($) {
591 _done_for_now($self);
592 PublicInbox::DS::block_signals();
595 sub imap_idle_requeue ($) { # DS::add_timer callback
596 my ($self, $url_intvl) = @{$_[0]};
597 return if $self->{quit};
598 push @{$self->{idle_todo}}, $url_intvl;
602 sub imap_idle_reap { # PublicInbox::DS::dwaitpid callback
603 my ($self, $pid) = @_;
604 my $url_intvl = delete $self->{idle_pids}->{$pid} or
605 die "BUG: PID=$pid (unknown) reaped: \$?=$?\n";
607 my ($url, $intvl) = @$url_intvl;
608 return if $self->{quit};
609 warn "W: PID=$pid on $url died: \$?=$?\n" if $?;
610 PublicInbox::DS::add_timer(60,
611 \&imap_idle_requeue, [ $self, $url_intvl ]);
614 sub reap { # callback for EOFpipe
615 my ($pid, $cb, $self) = @{$_[0]};
616 my $ret = waitpid($pid, 0);
618 $cb->($self, $pid); # poll_fetch_reap || imap_idle_reap
620 warn "W: waitpid($pid) => ", $ret // "($!)", "\n";
624 sub imap_idle_fork ($$) {
625 my ($self, $url_intvl) = @_;
626 my ($url, $intvl) = @$url_intvl;
627 pipe(my ($r, $w)) or die "pipe: $!";
628 my $seed = rand(0xffffffff);
629 defined(my $pid = fork) or die "fork: $!";
632 eval { Net::SSLeay::randomize() };
634 watch_atfork_child($self);
635 watch_imap_idle_1($self, $url, $intvl);
639 $self->{idle_pids}->{$pid} = $url_intvl;
640 PublicInbox::EOFpipe->new($r, \&reap, [$pid, \&imap_idle_reap, $self]);
645 return if $self->{quit};
646 my $idle_todo = $self->{idle_todo};
647 if ($idle_todo && @$idle_todo) {
648 my $oldset = watch_atfork_parent($self);
650 while (my $url_intvl = shift(@$idle_todo)) {
651 imap_idle_fork($self, $url_intvl);
654 PublicInbox::DS::sig_setmask($oldset);
657 fs_scan_step($self) if $self->{mdre};
660 sub watch_imap_fetch_all ($$) {
661 my ($self, $urls) = @_;
662 for my $url (@$urls) {
663 my $uri = PublicInbox::URIimap->new($url);
664 my $sec = uri_section($uri);
665 my $mic_arg = $self->{mic_arg}->{$sec} or
666 die "BUG: no Mail::IMAPClient->new arg for $sec";
667 my $mic = PublicInbox::IMAPClient->new(%$mic_arg) or next;
668 my $err = imap_fetch_all($self, $mic, $url);
669 last if $self->{quit};
670 warn $err, "\n" if $err;
674 sub watch_nntp_fetch_all ($$) {
675 my ($self, $urls) = @_;
676 for my $url (@$urls) {
677 my $uri = uri_new($url);
678 my $sec = uri_section($uri);
679 my $nn_arg = $self->{nn_arg}->{$sec} or
680 die "BUG: no Net::NNTP->new arg for $sec";
681 my $nntp_opt = $self->{nntp_opt}->{$sec};
682 my $nn = nn_new($nn_arg, $nntp_opt, $url);
684 warn "E: $url: \$!=$!\n";
687 last if $self->{quit};
688 if (my $postconn = $nntp_opt->{-postconn}) {
689 for my $m_arg (@$postconn) {
690 my ($method, @args) = @$m_arg;
691 $nn->$method(@args) and next;
692 warn "E: <$url> $method failed\n";
697 last if $self->{quit};
699 my $err = nntp_fetch_all($self, $nn, $url);
700 warn $err, "\n" if $err;
705 sub poll_fetch_fork ($) { # DS::add_timer callback
706 my ($self, $intvl, $urls) = @{$_[0]};
707 return if $self->{quit};
708 pipe(my ($r, $w)) or die "pipe: $!";
709 my $oldset = watch_atfork_parent($self);
710 my $seed = rand(0xffffffff);
712 if (defined($pid) && $pid == 0) {
714 eval { Net::SSLeay::randomize() };
716 watch_atfork_child($self);
717 if ($urls->[0] =~ m!\Aimaps?://!i) {
718 watch_imap_fetch_all($self, $urls);
720 watch_nntp_fetch_all($self, $urls);
725 PublicInbox::DS::sig_setmask($oldset);
726 die "fork: $!" unless defined $pid;
727 $self->{poll_pids}->{$pid} = [ $intvl, $urls ];
728 PublicInbox::EOFpipe->new($r, \&reap, [$pid, \&poll_fetch_reap, $self]);
731 sub poll_fetch_reap {
732 my ($self, $pid) = @_;
733 my $intvl_urls = delete $self->{poll_pids}->{$pid} or
734 die "BUG: PID=$pid (unknown) reaped: \$?=$?\n";
735 return if $self->{quit};
736 my ($intvl, $urls) = @$intvl_urls;
738 warn "W: PID=$pid died: \$?=$?\n", map { "$_\n" } @$urls;
740 warn("I: will check $_ in ${intvl}s\n") for @$urls;
741 PublicInbox::DS::add_timer($intvl, \&poll_fetch_fork,
742 [$self, $intvl, $urls]);
745 sub watch_imap_init ($$) {
746 my ($self, $poll) = @_;
747 eval { require PublicInbox::IMAPClient } or
748 die "Mail::IMAPClient is required for IMAP:\n$@\n";
749 eval { require PublicInbox::IMAPTracker } or
750 die "DBD::SQLite is required for IMAP\n:$@\n";
752 my $mic_args = imap_common_init($self); # read args from config
754 # make sure we can connect and cache the credentials in memory
755 $self->{mic_arg} = {}; # schema://authority => IMAPClient->new args
756 my $mics = {}; # schema://authority => IMAPClient obj
757 for my $url (sort keys %{$self->{imap}}) {
758 my $uri = PublicInbox::URIimap->new($url);
759 $mics->{uri_section($uri)} //= mic_for($self, $url, $mic_args);
762 my $idle = []; # [ [ url1, intvl1 ], [url2, intvl2] ]
763 for my $url (keys %{$self->{imap}}) {
764 my $uri = PublicInbox::URIimap->new($url);
765 my $sec = uri_section($uri);
766 my $mic = $mics->{$sec};
767 my $intvl = $self->{imap_opt}->{$sec}->{pollInterval};
768 if ($mic->has_capability('IDLE') && !$intvl) {
769 $intvl = $self->{imap_opt}->{$sec}->{idleInterval};
770 push @$idle, [ $url, $intvl // () ];
772 push @{$poll->{$intvl || 120}}, $url;
776 $self->{idle_todo} = $idle;
777 PublicInbox::DS::requeue($self); # ->event_step to fork
781 # flesh out common NNTP-specific data structures
782 sub nntp_common_init ($) {
784 my $cfg = $self->{pi_cfg};
785 my $nn_args = {}; # scheme://authority => Net::NNTP->new arg
786 for my $url (sort keys %{$self->{nntp}}) {
787 my $sec = uri_section(uri_new($url));
789 # Debug and Timeout are passed to Net::NNTP->new
790 my $v = cfg_bool($cfg, 'nntp.Debug', $url);
791 $nn_args->{$sec}->{Debug} = $v if defined $v;
792 my $to = cfg_intvl($cfg, 'nntp.Timeout', $url);
793 $nn_args->{$sec}->{Timeout} = $to if $to;
795 # Net::NNTP post-connect commands
796 for my $k (qw(starttls compress)) {
797 $v = cfg_bool($cfg, "nntp.$k", $url) // next;
798 $self->{nntp_opt}->{$sec}->{$k} = $v;
802 for my $k (qw(pollInterval)) {
803 $to = cfg_intvl($cfg, "nntp.$k", $url) // next;
804 $self->{nntp_opt}->{$sec}->{$k} = $to;
810 # Net::NNTP doesn't support CAPABILITIES, yet
811 sub try_starttls ($) {
813 return if $host =~ /\.onion\z/s;
814 return if $host =~ /\A127\.[0-9]+\.[0-9]+\.[0-9]+\z/s;
815 return if $host eq '::1';
820 my ($nn_arg, $nntp_opt, $url) = @_;
821 my $nn = Net::NNTP->new(%$nn_arg) or die "E: <$url> new: $!\n";
823 # default to using STARTTLS if it's available, but allow
824 # it to be disabled for localhost/VPN users
825 if (!$nn_arg->{SSL} && $nn->can('starttls')) {
826 if (!defined($nntp_opt->{starttls}) &&
827 try_starttls($nn_arg->{Host})) {
828 # soft fail by default
829 $nn->starttls or warn <<"";
830 W: <$url> STARTTLS tried and failed (not requested)
832 } elsif ($nntp_opt->{starttls}) {
833 # hard fail if explicitly configured
834 $nn->starttls or die <<"";
835 E: <$url> STARTTLS requested and failed
838 } elsif ($nntp_opt->{starttls}) {
839 $nn->can('starttls') or
840 die "E: <$url> Net::NNTP too old for STARTTLS\n";
841 $nn->starttls or die <<"";
842 E: <$url> STARTTLS requested and failed
848 sub nn_for ($$$) { # nn = Net::NNTP
849 my ($self, $url, $nn_args) = @_;
850 my $uri = uri_new($url);
851 my $sec = uri_section($uri);
852 my $nntp_opt = $self->{nntp_opt}->{$sec} //= {};
853 my $host = $uri->host;
854 # Net::NNTP and Net::Netrc both mishandle `0', so we pass `127.0.0.1'
855 $host = '127.0.0.1' if $host eq '0';
858 if (defined(my $ui = $uri->userinfo)) {
859 require PublicInbox::GitCredential;
862 protocol => uri_scheme($uri),
864 }, 'PublicInbox::GitCredential';
865 ($u, $p) = split(/:/, $ui, 2);
866 ($cred->{username}, $cred->{password}) = ($u, $p);
867 $cred->check_netrc unless defined $p;
869 my $common = $nn_args->{$sec} // {};
873 SSL => $uri->secure, # snews == nntps
874 %$common, # may Debug ....
876 my $nn = nn_new($nn_arg, $nntp_opt, $url);
879 $cred->fill; # may prompt user here
880 if ($nn->authinfo($u, $p)) {
881 push @{$nntp_opt->{-postconn}}, [ 'authinfo', $u, $p ];
883 warn "E: <$url> AUTHINFO $u XXXX failed\n";
888 if ($nntp_opt->{compress}) {
889 # https://rt.cpan.org/Ticket/Display.html?id=129967
890 if ($nn->can('compress')) {
892 push @{$nntp_opt->{-postconn}}, [ 'compress' ];
894 warn "W: <$url> COMPRESS failed\n";
897 delete $nntp_opt->{compress};
899 W: <$url> COMPRESS not supported by Net::NNTP
900 W: see https://rt.cpan.org/Ticket/Display.html?id=129967 for updates
905 $self->{nn_arg}->{$sec} = $nn_arg;
906 $cred->run($nn ? 'approve' : 'reject') if $cred;
910 sub nntp_fetch_all ($$$) {
911 my ($self, $nn, $url) = @_;
912 my $uri = uri_new($url);
913 my ($group, $num_a, $num_b) = $uri->group;
914 my $sec = uri_section($uri);
915 my ($nr, $beg, $end) = $nn->group($group);
916 unless (defined($nr)) {
917 chomp(my $msg = $nn->message);
918 return "E: GROUP $group <$sec> $msg";
921 # IMAPTracker is also used for tracking NNTP, UID == article number
922 # LIST.ACTIVE can get the equivalent of UIDVALIDITY, but that's
923 # expensive. So we assume newsgroups don't change:
924 my $itrk = PublicInbox::IMAPTracker->new($url);
925 my (undef, $l_art) = $itrk->get_last;
926 $l_art //= $beg; # initial import
928 # allow users to specify articles to refetch
929 # cf. https://tools.ietf.org/id/draft-gilman-news-url-01.txt
930 # nntp://example.com/inbox.foo/$num_a-$num_b
931 $l_art = $num_a if defined($num_a) && $num_a < $l_art;
932 $end = $num_b if defined($num_b) && $num_b < $end;
934 return if $l_art >= $end; # nothing to do
937 warn "I: $url fetching ARTICLE $beg..$end\n";
938 my $warn_cb = $SIG{__WARN__} || \&CORE::warn;
940 local $SIG{__WARN__} = sub {
941 my $pfx = ($_[0] // '') =~ /^([A-Z]: )/g ? $1 : '';
942 $warn_cb->("$pfx$url ", $art ? ("ARTICLE $art") : (), "\n", @_);
944 my $inboxes = $self->{nntp}->{$url};
946 my $n = $self->{max_batch};
948 last if $self->{quit};
951 _done_for_now($self);
952 $itrk->update_last(0, $last_art);
953 $n = $self->{max_batch};
955 my $raw = $nn->article($art);
956 unless (defined($raw)) {
957 my $msg = $nn->message;
958 if ($nn->code == 421) { # pseudo response from Net::Cmd
961 } else { # probably just a deleted message (spam)
966 s/\r\n/\n/ for @$raw;
967 $raw = join('', @$raw);
969 for my $ibx (@$inboxes) {
970 my $eml = PublicInbox::Eml->new($raw);
971 import_eml($self, $ibx, $eml);
973 } elsif ($inboxes eq 'watchspam') {
974 my $eml = PublicInbox::Eml->new(\$raw);
975 $self->{pi_cfg}->each_inbox(\&remove_eml_i,
976 $self, $eml, "$url ARTICLE $art");
978 die "BUG: destination unknown $inboxes";
982 _done_for_now($self);
983 $itrk->update_last(0, $last_art);
987 sub watch_nntp_init ($$) {
988 my ($self, $poll) = @_;
989 eval { require Net::NNTP } or
990 die "Net::NNTP is required for NNTP:\n$@\n";
991 eval { require PublicInbox::IMAPTracker } or
992 die "DBD::SQLite is required for NNTP\n:$@\n";
994 my $nn_args = nntp_common_init($self); # read args from config
996 # make sure we can connect and cache the credentials in memory
997 $self->{nn_arg} = {}; # schema://authority => Net::NNTP->new args
998 for my $url (sort keys %{$self->{nntp}}) {
999 nn_for($self, $url, $nn_args);
1001 for my $url (keys %{$self->{nntp}}) {
1002 my $uri = uri_new($url);
1003 my $sec = uri_section($uri);
1004 my $intvl = $self->{nntp_opt}->{$sec}->{pollInterval};
1005 push @{$poll->{$intvl || 120}}, $url;
1009 sub watch { # main entry point
1010 my ($self, $sig, $oldset) = @_;
1011 $self->{oldset} = $oldset;
1012 $self->{sig} = $sig;
1013 my $poll = {}; # intvl_seconds => [ url1, url2 ]
1014 watch_imap_init($self, $poll) if $self->{imap};
1015 watch_nntp_init($self, $poll) if $self->{nntp};
1016 while (my ($intvl, $urls) = each %$poll) {
1017 # poll all URLs for a given interval sequentially
1018 PublicInbox::DS::add_timer(0, \&poll_fetch_fork,
1019 [$self, $intvl, $urls]);
1021 watch_fs_init($self) if $self->{mdre};
1022 PublicInbox::DS->SetPostLoopCallback(sub { !$self->quit_done });
1023 PublicInbox::DS->EventLoop; # calls ->event_step
1024 _done_for_now($self);
1028 my ($self, $op) = @_;
1029 push @{$self->{ops}}, $op;
1030 PublicInbox::DS::requeue($self);
1035 return if $self->{quit};
1036 my $op = shift @{$self->{ops}};
1037 local $PublicInbox::DS::in_loop = 0; # waitpid() synchronously
1039 # continue existing scan
1040 my $opendirs = $self->{opendirs};
1041 my @dirnames = keys %$opendirs;
1042 foreach my $dir (@dirnames) {
1043 my $dh = delete $opendirs->{$dir};
1044 my $n = $self->{max_batch};
1045 while (my $fn = readdir($dh)) {
1046 _try_path($self, "$dir/$fn");
1049 $opendirs->{$dir} = $dh if $n < 0;
1051 if ($op && $op eq 'full') {
1052 foreach my $dir (keys %{$self->{mdmap}}) {
1053 next if $opendirs->{$dir}; # already in progress
1054 my $ok = opendir(my $dh, $dir);
1056 warn "failed to open $dir: $!\n";
1059 my $n = $self->{max_batch};
1060 while (my $fn = readdir($dh)) {
1061 _try_path($self, "$dir/$fn");
1064 $opendirs->{$dir} = $dh if $n < 0;
1067 _done_for_now($self);
1068 # do we have more work to do?
1069 PublicInbox::DS::requeue($self) if keys %$opendirs;
1073 my ($self, $op) = @_;
1074 push @{$self->{ops}}, $op;
1075 fs_scan_step($self);
1079 my ($self, $ibx) = @_;
1080 my $importers = $self->{importers};
1081 my $im = $importers->{"$ibx"} ||= $ibx->importer(0);
1082 if (scalar(keys(%$importers)) > 2) {
1083 delete $importers->{"$ibx"};
1084 _done_for_now($self);
1087 $importers->{"$ibx"} = $im;
1090 # XXX consider sharing with V2Writable, this only requires read-only access
1091 sub content_exists ($$) {
1092 my ($ibx, $eml) = @_;
1093 my $over = $ibx->over or return;
1094 my $mids = mids($eml);
1095 my $chash = content_hash($eml);
1097 for my $mid (@$mids) {
1098 while (my $smsg = $over->next_by_mid($mid, \$id, \$prev)) {
1099 my $cmp = $ibx->smsg_eml($smsg) or return;
1100 return 1 if $chash eq content_hash($cmp);
1108 sub { # this gets called by (V2Writable||Import)->add
1109 my ($mime, $ibx) = @_;
1110 return if content_exists($ibx, $mime);
1112 if ($sc->spamcheck($mime, \$tmp)) {
1113 return PublicInbox::Eml->new(\$tmp);
1115 warn $mime->header('Message-ID')." failed spam check\n";
1121 $_[0] =~ s!\Amaildir:!! or return;
1128 my ($cur, $ws, $ibx) = @_;
1129 if ($ws && !ref($ws) && $ws eq 'watchspam') {
1131 E: $cur is a spam folder and cannot be used for `$ibx->{name}' input
1141 # URI::snews exists, URI::nntps does not, so use URI::snews
1142 $url =~ s!\Anntps://!snews://!i;
1148 require PublicInbox::URIimap;
1149 my $uri = PublicInbox::URIimap->new($url);
1150 $uri ? $uri->canonical->as_string : undef;
1153 my %IS_NNTP = (news => 1, snews => 1, nntp => 1);
1157 my $uri = uri_new($url);
1158 return unless $uri && $IS_NNTP{$uri->scheme} && $uri->group;
1159 $url = $uri->canonical->as_string;
1160 # nntps is IANA registered, snews is deprecated
1161 $url =~ s!\Asnews://!nntps://!;