1 # Copyright (C) 2021 all contributors <meta@public-inbox.org>
2 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
4 # common reader code for IMAP and NNTP (and maybe JMAP)
5 package PublicInbox::NetReader;
8 use parent qw(Exporter PublicInbox::IPC);
11 our %IMAPflags2kw = map {; "\\\u$_" => $_ } qw(seen answered flagged draft);
13 # TODO: trim this down, this is huge
14 our @EXPORT = qw(uri_new uri_section
15 nn_new imap_uri nntp_uri
16 cfg_bool cfg_intvl imap_common_init nntp_common_init
19 # returns the git config section name, e.g [imap "imaps://user@example.com"]
20 # without the mailbox, so we can share connections between different inboxes
23 $uri->scheme . '://' . $uri->authority;
26 sub auth_anon_cb { '' }; # for Mail::IMAPClient::Authcallback
28 # mic_for may prompt the user and store auth info, prepares mic_get
29 sub mic_for { # mic = Mail::IMAPClient
30 my ($self, $url, $mic_args, $lei) = @_;
31 require PublicInbox::URIimap;
32 my $uri = PublicInbox::URIimap->new($url);
33 require PublicInbox::GitCredential;
36 protocol => $uri->scheme,
38 username => $uri->user,
39 password => $uri->password,
40 }, 'PublicInbox::GitCredential';
41 my $common = $mic_args->{uri_section($uri)} // {};
42 # IMAPClient and Net::Netrc both mishandles `0', so we pass `127.0.0.1'
43 my $host = $cred->{host};
44 $host = '127.0.0.1' if $host eq '0';
48 Ssl => $uri->scheme eq 'imaps',
49 Keepalive => 1, # SO_KEEPALIVE
50 %$common, # may set Starttls, Compress, Debug ....
52 require PublicInbox::IMAPClient;
53 my $mic = PublicInbox::IMAPClient->new(%$mic_arg) or
54 die "E: <$url> new: $@\n";
56 # default to using STARTTLS if it's available, but allow
57 # it to be disabled since I usually connect to localhost
58 if (!$mic_arg->{Ssl} && !defined($mic_arg->{Starttls}) &&
59 $mic->has_capability('STARTTLS') &&
60 $mic->can('starttls')) {
61 $mic->starttls or die "E: <$url> STARTTLS: $@\n";
64 # do we even need credentials?
65 if (!defined($cred->{username}) &&
66 $mic->has_capability('AUTH=ANONYMOUS')) {
70 $cred->check_netrc unless defined $cred->{password};
71 $cred->fill($lei); # may prompt user here
72 $mic->User($mic_arg->{User} = $cred->{username});
73 $mic->Password($mic_arg->{Password} = $cred->{password});
74 } else { # AUTH=ANONYMOUS
75 $mic->Authmechanism($mic_arg->{Authmechanism} = 'ANONYMOUS');
76 $mic_arg->{Authcallback} = 'auth_anon_cb';
77 $mic->Authcallback(\&auth_anon_cb);
80 if ($mic->login && $mic->IsAuthenticated) {
81 # success! keep IMAPClient->new arg in case we get disconnected
82 $self->{mic_arg}->{uri_section($uri)} = $mic_arg;
84 $err = "E: <$url> LOGIN: $@\n";
85 if ($cred && defined($cred->{password})) {
86 $err =~ s/\Q$cred->{password}\E/*******/g;
90 $cred->run($mic ? 'approve' : 'reject') if $cred;
92 $lei ? $lei->fail($err) : warn($err);
101 # URI::snews exists, URI::nntps does not, so use URI::snews
102 $url =~ s!\Anntps://!snews://!i;
106 # Net::NNTP doesn't support CAPABILITIES, yet
107 sub try_starttls ($) {
109 return if $host =~ /\.onion\z/s;
110 return if $host =~ /\A127\.[0-9]+\.[0-9]+\.[0-9]+\z/s;
111 return if $host eq '::1';
116 my ($nn_arg, $nntp_opt, $uri) = @_;
117 my $nn = Net::NNTP->new(%$nn_arg) or die "E: <$uri> new: $!\n";
119 # default to using STARTTLS if it's available, but allow
120 # it to be disabled for localhost/VPN users
121 if (!$nn_arg->{SSL} && $nn->can('starttls')) {
122 if (!defined($nntp_opt->{starttls}) &&
123 try_starttls($nn_arg->{Host})) {
124 # soft fail by default
125 $nn->starttls or warn <<"";
126 W: <$uri> STARTTLS tried and failed (not requested)
128 } elsif ($nntp_opt->{starttls}) {
129 # hard fail if explicitly configured
130 $nn->starttls or die <<"";
131 E: <$uri> STARTTLS requested and failed
134 } elsif ($nntp_opt->{starttls}) {
135 $nn->can('starttls') or
136 die "E: <$uri> Net::NNTP too old for STARTTLS\n";
137 $nn->starttls or die <<"";
138 E: <$uri> STARTTLS requested and failed
144 sub nn_for ($$$;$) { # nn = Net::NNTP
145 my ($self, $uri, $nn_args, $lei) = @_;
146 my $sec = uri_section($uri);
147 my $nntp_opt = $self->{nntp_opt}->{$sec} //= {};
148 my $host = $uri->host;
149 # Net::NNTP and Net::Netrc both mishandle `0', so we pass `127.0.0.1'
150 $host = '127.0.0.1' if $host eq '0';
153 if (defined(my $ui = $uri->userinfo)) {
154 require PublicInbox::GitCredential;
157 protocol => $uri->scheme,
159 }, 'PublicInbox::GitCredential';
160 ($u, $p) = split(/:/, $ui, 2);
161 ($cred->{username}, $cred->{password}) = ($u, $p);
162 $cred->check_netrc unless defined $p;
164 my $common = $nn_args->{$sec} // {};
168 SSL => $uri->secure, # snews == nntps
169 %$common, # may Debug ....
171 my $nn = nn_new($nn_arg, $nntp_opt, $uri);
173 $cred->fill($lei); # may prompt user here
174 if ($nn->authinfo($u, $p)) {
175 push @{$nntp_opt->{-postconn}}, [ 'authinfo', $u, $p ];
177 warn "E: <$uri> AUTHINFO $u XXXX failed\n";
182 if ($nntp_opt->{compress}) {
183 # https://rt.cpan.org/Ticket/Display.html?id=129967
184 if ($nn->can('compress')) {
186 push @{$nntp_opt->{-postconn}}, [ 'compress' ];
188 warn "W: <$uri> COMPRESS failed\n";
191 delete $nntp_opt->{compress};
193 W: <$uri> COMPRESS not supported by Net::NNTP
194 W: see https://rt.cpan.org/Ticket/Display.html?id=129967 for updates
199 $self->{nn_arg}->{$sec} = $nn_arg;
200 $cred->run($nn ? 'approve' : 'reject') if $cred;
206 require PublicInbox::URIimap;
207 my $uri = PublicInbox::URIimap->new($url);
208 $uri ? $uri->canonical : undef;
211 my %IS_NNTP = (news => 1, snews => 1, nntp => 1, nntps => 1);
214 require PublicInbox::URInntps;
215 my $uri = PublicInbox::URInntps->new($url);
216 $uri && $IS_NNTP{$uri->scheme} && $uri->group ? $uri->canonical : undef;
219 sub cfg_intvl ($$$) {
220 my ($cfg, $key, $url) = @_;
221 my $v = $cfg->urlmatch($key, $url) // return;
222 $v =~ /\A[0-9]+(?:\.[0-9]+)?\z/s and return $v + 0;
223 if (ref($v) eq 'ARRAY') {
224 $v = join(', ', @$v);
225 warn "W: $key has multiple values: $v\nW: $key ignored\n";
227 warn "W: $key=$v is not a numeric value in seconds\n";
232 my ($cfg, $key, $url) = @_;
233 my $orig = $cfg->urlmatch($key, $url) // return;
234 my $bool = $cfg->git_bool($orig);
235 warn "W: $key=$orig for $url is not boolean\n" unless defined($bool);
239 # flesh out common IMAP-specific data structures
240 sub imap_common_init ($;$) {
241 my ($self, $lei) = @_;
242 return unless $self->{imap_order};
243 $self->{quiet} = 1 if $lei && $lei->{opt}->{quiet};
244 eval { require PublicInbox::IMAPClient } or
245 die "Mail::IMAPClient is required for IMAP:\n$@\n";
246 eval { require PublicInbox::IMAPTracker } or
247 die "DBD::SQLite is required for IMAP\n:$@\n";
248 require PublicInbox::URIimap;
249 my $cfg = $self->{pi_cfg} // $lei->_lei_cfg;
250 my $mic_args = {}; # scheme://authority => Mail:IMAPClient arg
251 for my $uri (@{$self->{imap_order}}) {
252 my $sec = uri_section($uri);
253 for my $k (qw(Starttls Debug Compress)) {
254 my $bool = cfg_bool($cfg, "imap.$k", $$uri) // next;
255 $mic_args->{$sec}->{$k} = $bool;
257 my $to = cfg_intvl($cfg, 'imap.timeout', $$uri);
258 $mic_args->{$sec}->{Timeout} = $to if $to;
259 for my $k (qw(pollInterval idleInterval)) {
260 $to = cfg_intvl($cfg, "imap.$k", $$uri) // next;
261 $self->{imap_opt}->{$sec}->{$k} = $to;
263 my $k = 'imap.fetchBatchSize';
264 my $bs = $cfg->urlmatch($k, $$uri) // next;
265 if ($bs =~ /\A([0-9]+)\z/) {
266 $self->{imap_opt}->{$sec}->{batch_size} = $bs;
268 warn "$k=$bs is not an integer\n";
271 # make sure we can connect and cache the credentials in memory
272 $self->{mic_arg} = {}; # schema://authority => IMAPClient->new args
273 my $mics = {}; # schema://authority => IMAPClient obj
274 for my $uri (@{$self->{imap_order}}) {
275 my $sec = uri_section($uri);
276 $mics->{$sec} //= mic_for($self, "$sec/", $mic_args, $lei);
277 next unless $self->isa('PublicInbox::NetWriter');
278 my $dst = $uri->mailbox // next;
279 my $mic = $mics->{$sec};
280 next if $mic->exists($dst); # already exists
281 $mic->create($dst) or die "CREATE $dst failed <$uri>: $@";
286 # flesh out common NNTP-specific data structures
287 sub nntp_common_init ($;$) {
288 my ($self, $lei) = @_;
289 return unless $self->{nntp_order};
290 $self->{quiet} = 1 if $lei && $lei->{opt}->{quiet};
291 eval { require Net::NNTP } or
292 die "Net::NNTP is required for NNTP:\n$@\n";
293 eval { require PublicInbox::IMAPTracker } or
294 die "DBD::SQLite is required for NNTP\n:$@\n";
295 my $cfg = $self->{pi_cfg} // $lei->_lei_cfg;
296 my $nn_args = {}; # scheme://authority => Net::NNTP->new arg
297 for my $uri (@{$self->{nntp_order}}) {
298 my $sec = uri_section($uri);
300 # Debug and Timeout are passed to Net::NNTP->new
301 my $v = cfg_bool($cfg, 'nntp.Debug', $$uri);
302 $nn_args->{$sec}->{Debug} = $v if defined $v;
303 my $to = cfg_intvl($cfg, 'nntp.Timeout', $$uri);
304 $nn_args->{$sec}->{Timeout} = $to if $to;
306 # Net::NNTP post-connect commands
307 for my $k (qw(starttls compress)) {
308 $v = cfg_bool($cfg, "nntp.$k", $$uri) // next;
309 $self->{nntp_opt}->{$sec}->{$k} = $v;
313 for my $k (qw(pollInterval)) {
314 $to = cfg_intvl($cfg, "nntp.$k", $$uri) // next;
315 $self->{nntp_opt}->{$sec}->{$k} = $to;
318 # make sure we can connect and cache the credentials in memory
319 $self->{nn_arg} = {}; # schema://authority => Net::NNTP->new args
320 my %nn; # schema://authority => Net::NNTP object
321 for my $uri (@{$self->{nntp_order}}) {
322 my $sec = uri_section($uri);
323 $nn{$sec} //= nn_for($self, $uri, $nn_args, $lei);
325 \%nn; # for optional {nn_cached}
329 my ($self, $arg) = @_;
331 if ($uri = imap_uri($arg)) {
332 push @{$self->{imap_order}}, $uri;
333 } elsif ($uri = nntp_uri($arg)) {
334 push @{$self->{nntp_order}}, $uri;
336 push @{$self->{unsupported_url}}, $arg;
342 if (my $u = $self->{unsupported_url}) {
343 return "Unsupported URL(s): @$u";
345 if ($self->{imap_order}) {
346 eval { require PublicInbox::IMAPClient } or
347 die "Mail::IMAPClient is required for IMAP:\n$@\n";
349 if ($self->{nntp_order}) {
350 eval { require Net::NNTP } or
351 die "Net::NNTP is required for NNTP:\n$@\n";
356 sub _imap_do_msg ($$$$$) {
357 my ($self, $uri, $uid, $raw, $flags) = @_;
358 # our target audience expects LF-only, save storage
359 $$raw =~ s/\r\n/\n/sg;
361 for my $f (split(/ /, $flags)) {
362 my $k = $IMAPflags2kw{$f} // next; # TODO: X-Label?
365 my ($eml_cb, @args) = @{$self->{eml_each}};
366 $eml_cb->($uri, $uid, $kw, PublicInbox::Eml->new($raw), @args);
369 sub _imap_fetch_all ($$$) {
370 my ($self, $mic, $uri) = @_;
371 my $sec = uri_section($uri);
372 my $mbx = $uri->mailbox;
373 $mic->Clear(1); # trim results history
374 $mic->examine($mbx) or return "E: EXAMINE $mbx ($sec) failed: $!";
375 my ($r_uidval, $r_uidnext);
376 for ($mic->Results) {
377 /^\* OK \[UIDVALIDITY ([0-9]+)\].*/ and $r_uidval = $1;
378 /^\* OK \[UIDNEXT ([0-9]+)\].*/ and $r_uidnext = $1;
379 last if $r_uidval && $r_uidnext;
381 $r_uidval //= $mic->uidvalidity($mbx) //
382 return "E: $uri cannot get UIDVALIDITY";
383 $r_uidnext //= $mic->uidnext($mbx) //
384 return "E: $uri cannot get UIDNEXT";
385 my $itrk = $self->{incremental} ?
386 PublicInbox::IMAPTracker->new($$uri) : 0;
387 my ($l_uidval, $l_uid) = $itrk ? $itrk->get_last : ();
388 $l_uidval //= $r_uidval; # first time
390 if ($l_uidval != $r_uidval) {
391 return "E: $uri UIDVALIDITY mismatch\n".
392 "E: local=$l_uidval != remote=$r_uidval";
394 my $r_uid = $r_uidnext - 1;
395 if ($l_uid > $r_uid) {
396 return "E: $uri local UID exceeds remote ($l_uid > $r_uid)\n".
397 "E: $uri strangely, UIDVALIDLITY matches ($l_uidval)\n";
399 return if $l_uid >= $r_uid; # nothing to do
401 my ($mod, $shard) = @{$self->{shard_info} // []};
402 unless ($self->{quiet}) {
403 my $m = $mod ? " [(UID % $mod) == $shard]" : '';
404 warn "# $uri fetching UID $l_uid:$r_uid$m\n";
406 $mic->Uid(1); # the default, we hope
407 my $bs = $self->{imap_opt}->{$sec}->{batch_size} // 1;
408 my $req = $mic->imap4rev1 ? 'BODY.PEEK[]' : 'RFC822.PEEK';
414 # I wish "UID FETCH $START:*" could work, but:
415 # 1) servers do not need to return results in any order
416 # 2) Mail::IMAPClient doesn't offer a streaming API
417 $uids = $mic->search("UID $l_uid:*") or
418 return "E: $uri UID SEARCH $l_uid:* error: $!";
419 return if scalar(@$uids) == 0;
421 # RFC 3501 doesn't seem to indicate order of UID SEARCH
422 # responses, so sort it ourselves. Order matters so
423 # IMAPTracker can store the newest UID.
424 @$uids = sort { $a <=> $b } @$uids;
426 # Did we actually get new messages?
427 return if $uids->[0] < $l_uid;
429 $l_uid = $uids->[-1] + 1; # for next search
431 my $n = $self->{max_batch};
433 @$uids = grep { ($_ % $mod) == $shard } @$uids if $mod;
434 while (scalar @$uids) {
435 my @batch = splice(@$uids, 0, $bs);
436 $batch = join(',', @batch);
437 local $0 = "UID:$batch $mbx $sec";
438 my $r = $mic->fetch_hash($batch, $req, 'FLAGS');
439 unless ($r) { # network error?
440 $err = "E: $uri UID FETCH $batch error: $!";
443 for my $uid (@batch) {
444 # messages get deleted, so holes appear
445 my $per_uid = delete $r->{$uid} // next;
446 my $raw = delete($per_uid->{$key}) // next;
447 _imap_do_msg($self, $uri, $uid, \$raw,
450 last if $self->{quit};
452 last if $self->{quit};
454 $itrk->update_last($r_uidval, $last_uid) if $itrk;
455 } until ($err || $self->{quit});
459 # uses cached auth info prepared by mic_for
461 my ($self, $uri) = @_;
462 my $sec = uri_section($uri);
463 # see if caller saved result of imap_common_init
464 my $cached = $self->{mics_cached};
466 my $mic = $cached->{$sec};
467 return $mic if $mic && $mic->IsConnected;
468 delete $cached->{$sec};
470 my $mic_arg = $self->{mic_arg}->{$sec} or
471 die "BUG: no Mail::IMAPClient->new arg for $sec";
472 if (defined(my $cb_name = $mic_arg->{Authcallback})) {
473 if (ref($cb_name) ne 'CODE') {
474 $mic_arg->{Authcallback} = $self->can($cb_name);
477 my $mic = PublicInbox::IMAPClient->new(%$mic_arg);
478 $cached //= {}; # invalid placeholder if no cache enabled
479 $mic && $mic->IsConnected ? ($cached->{$sec} = $mic) : undef;
483 my ($self, $url, $eml_cb, @args) = @_;
484 my $uri = ref($url) ? $url : PublicInbox::URIimap->new($url);
485 my $sec = uri_section($uri);
486 local $0 = $uri->mailbox." $sec";
487 my $mic = mic_get($self, $uri);
490 local $self->{eml_each} = [ $eml_cb, @args ];
491 $err = _imap_fetch_all($self, $mic, $uri);
493 $err = "E: not connected: $!";
499 # may used cached auth info prepared by nn_for once
501 my ($self, $uri) = @_;
502 my $sec = uri_section($uri);
503 # see if caller saved result of nntp_common_init
504 my $cached = $self->{nn_cached} // {};
506 $nn = delete($cached->{$sec}) and return $nn;
507 my $nn_arg = $self->{nn_arg}->{$sec} or
508 die "BUG: no Net::NNTP->new arg for $sec";
509 my $nntp_opt = $self->{nntp_opt}->{$sec};
510 $nn = nn_new($nn_arg, $nntp_opt, $uri) or return;
511 if (my $postconn = $nntp_opt->{-postconn}) {
512 for my $m_arg (@$postconn) {
513 my ($method, @args) = @$m_arg;
514 $nn->$method(@args) and next;
515 die "E: <$uri> $method failed\n";
522 sub _nntp_fetch_all ($$$) {
523 my ($self, $nn, $uri) = @_;
524 my ($group, $num_a, $num_b) = $uri->group;
525 my $sec = uri_section($uri);
526 my ($nr, $beg, $end) = $nn->group($group);
527 unless (defined($nr)) {
528 chomp(my $msg = $nn->message);
529 return "E: GROUP $group <$sec> $msg";
532 # IMAPTracker is also used for tracking NNTP, UID == article number
533 # LIST.ACTIVE can get the equivalent of UIDVALIDITY, but that's
534 # expensive. So we assume newsgroups don't change:
535 my $itrk = $self->{incremental} ?
536 PublicInbox::IMAPTracker->new($$uri) : 0;
537 my (undef, $l_art) = $itrk ? $itrk->get_last : ();
539 # allow users to specify articles to refetch
540 # cf. https://tools.ietf.org/id/draft-gilman-news-url-01.txt
541 # nntp://example.com/inbox.foo/$num_a-$num_b
542 $beg = $num_a if defined($num_a) && $num_a < $beg;
543 $end = $num_b if defined($num_b) && $num_b < $end;
544 if (defined $l_art) {
545 return if $l_art >= $end; # nothing to do
549 unless ($self->{quiet}) {
550 warn "# $uri fetching ARTICLE $beg..$end\n";
553 my $n = $self->{max_batch};
555 last if $self->{quit};
558 $itrk->update_last(0, $last_art) if $itrk;
559 $n = $self->{max_batch};
561 my $raw = $nn->article($art);
562 unless (defined($raw)) {
563 my $msg = $nn->message;
564 if ($nn->code == 421) { # pseudo response from Net::Cmd
567 } else { # probably just a deleted message (spam)
572 $raw = join('', @$raw);
573 $raw =~ s/\r\n/\n/sg;
574 my ($eml_cb, @args) = @{$self->{eml_each}};
575 $eml_cb->($uri, $art, [], PublicInbox::Eml->new(\$raw), @args);
578 $itrk->update_last(0, $last_art) if $itrk;
583 my ($self, $url, $eml_cb, @args) = @_;
584 my $uri = ref($url) ? $url : PublicInbox::URInntps->new($url);
585 my $sec = uri_section($uri);
586 local $0 = $uri->group ." $sec";
587 my $nn = nn_get($self, $uri);
590 local $self->{eml_each} = [ $eml_cb, @args ];
591 $err = _nntp_fetch_all($self, $nn, $uri);
593 $err = "E: not connected: $!";
599 sub new { bless {}, shift };