]> Sergey Matveev's repositories - public-inbox.git/blob - lib/PublicInbox/LeiInput.pm
lei import: avoid IMAPTracker, use LeiMailSync more
[public-inbox.git] / lib / PublicInbox / LeiInput.pm
1 # Copyright (C) 2021 all contributors <meta@public-inbox.org>
2 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
3
4 # parent class for LeiImport, LeiConvert
5 package PublicInbox::LeiInput;
6 use strict;
7 use v5.10.1;
8 use PublicInbox::DS;
9 use PublicInbox::Spawn qw(which popen_rd);
10
11 # JMAP RFC 8621 4.1.1
12 # https://www.iana.org/assignments/imap-jmap-keywords/imap-jmap-keywords.xhtml
13 our @KW = (qw(seen answered flagged draft), # widely-compatible
14         qw(forwarded), # IMAP + Maildir
15         qw(phishing junk notjunk)); # rarely supported
16
17 # note: RFC 8621 states "Users may add arbitrary keywords to an Email",
18 # but is it good idea?  Stick to the system and reserved ones, for now.
19 # The widely-compatible ones map to IMAP system flags, Maildir flags
20 # and mbox Status/X-Status headers.
21 my %KW = map { $_ => 1 } @KW;
22 my $L_MAX = 244; # Xapian term limit - length('L')
23
24 # RFC 8621, sec 2 (Mailboxes) a "label" for us is a JMAP Mailbox "name"
25 # "Servers MAY reject names that violate server policy"
26 my %ERR = (
27         L => sub {
28                 my ($label) = @_;
29                 length($label) >= $L_MAX and
30                         return "`$label' too long (must be <= $L_MAX)";
31                 $label =~ m{\A[a-z0-9_](?:[a-z0-9_\-\./\@,]*[a-z0-9])?\z}i ?
32                         undef : "`$label' is invalid";
33         },
34         kw => sub {
35                 my ($kw) = @_;
36                 $KW{$kw} ? undef : <<EOM;
37 `$kw' is not one of: `seen', `flagged', `answered', `draft'
38 `junk', `notjunk', `phishing' or `forwarded'
39 EOM
40         }
41 );
42
43 sub check_input_format ($;$) {
44         my ($lei, $files) = @_;
45         my $opt_key = 'in-format';
46         my $fmt = $lei->{opt}->{$opt_key};
47         if (!$fmt) {
48                 my $err = $files ? "regular file(s):\n@$files" : '--stdin';
49                 return $lei->fail("--$opt_key unset for $err");
50         }
51         return 1 if $fmt eq 'eml';
52         require PublicInbox::MboxLock if $files;
53         require PublicInbox::MboxReader;
54         PublicInbox::MboxReader->reads($fmt) or
55                 return $lei->fail("--$opt_key=$fmt unrecognized");
56         1;
57 }
58
59 # import a single file handle of $name
60 # Subclass must define ->input_eml_cb and ->input_mbox_cb
61 sub input_fh {
62         my ($self, $ifmt, $fh, $name, @args) = @_;
63         if ($ifmt eq 'eml') {
64                 my $buf = do { local $/; <$fh> } //
65                         return $self->{lei}->child_error(1 << 8, <<"");
66 error reading $name: $!
67
68                 # mutt pipes single RFC822 messages with a "From " line,
69                 # but no Content-Length or "From " escaping.
70                 # "git format-patch" also generates such files by default.
71                 $buf =~ s/\A[\r\n]*From [^\r\n]*\r?\n//s;
72                 $self->input_eml_cb(PublicInbox::Eml->new(\$buf), @args);
73         } else {
74                 # prepare_inputs already validated $ifmt
75                 my $cb = PublicInbox::MboxReader->reads($ifmt) //
76                                 die "BUG: bad fmt=$ifmt";
77                 $cb->(undef, $fh, $self->can('input_mbox_cb'), $self, @args);
78         }
79 }
80
81 # handles mboxrd endpoints described in Documentation/design_notes.txt
82 sub handle_http_input ($$@) {
83         my ($self, $url, @args) = @_;
84         my $lei = $self->{lei} or die 'BUG: {lei} missing';
85         my $curl_opt = delete $self->{"-curl-$url"} or
86                                 die("BUG: $url curl options not prepared");
87         my $uri = pop @$curl_opt;
88         my $curl = PublicInbox::LeiCurl->new($lei, $self->{curl}) or return;
89         push @$curl, '-s', @$curl_opt;
90         my $cmd = $curl->for_uri($lei, $uri);
91         $lei->qerr("# $cmd");
92         my $rdr = { 2 => $lei->{2}, pgid => 0 };
93         my ($fh, $pid) = popen_rd($cmd, undef, $rdr);
94         grep(/\A--compressed\z/, @$curl) or
95                 $fh = IO::Uncompress::Gunzip->new($fh, MultiStream => 1);
96         eval {
97                 PublicInbox::MboxReader->mboxrd($fh,
98                                                 $self->can('input_mbox_cb'),
99                                                 $self, @args);
100         };
101         my $err = $@;
102         waitpid($pid, 0);
103         $? || $err and
104                 $lei->child_error($? || 1, "@$cmd failed".$err ? " $err" : '');
105 }
106
107 sub input_path_url {
108         my ($self, $input, @args) = @_;
109         my $lei = $self->{lei};
110         my $ifmt = lc($lei->{opt}->{'in-format'} // '');
111         # TODO auto-detect?
112         if ($input =~ m!\Aimaps?://!i) {
113                 $lei->{net}->imap_each($input, $self->can('input_net_cb'),
114                                                 $self, @args);
115                 return;
116         } elsif ($input =~ m!\A(?:nntps?|s?news)://!i) {
117                 $lei->{net}->nntp_each($input, $self->can('input_net_cb'),
118                                                 $self, @args);
119                 return;
120         } elsif ($input =~ m!\Ahttps?://!i) {
121                 handle_http_input($self, $input, @args);
122                 return;
123         }
124         if ($input =~ s!\A([a-z0-9]+):!!i) {
125                 $ifmt = lc($1);
126         } elsif ($input =~ /\.(?:patch|eml)\z/i) {
127                 $ifmt = 'eml';
128         }
129         my $devfd = $lei->path_to_fd($input) // return;
130         if ($devfd >= 0) {
131                 $self->input_fh($ifmt, $lei->{$devfd}, $input, @args);
132         } elsif (-f $input && $ifmt eq 'eml') {
133                 open my $fh, '<', $input or
134                                         return $lei->fail("open($input): $!");
135                 $self->input_fh($ifmt, $fh, $input, @args);
136         } elsif (-f _) {
137                 my $m = $lei->{opt}->{'lock'} //
138                         PublicInbox::MboxLock->defaults;
139                 my $mbl = PublicInbox::MboxLock->acq($input, 0, $m);
140                 my $zsfx = PublicInbox::MboxReader::zsfx($input);
141                 if ($zsfx) {
142                         my $in = delete $mbl->{fh};
143                         $mbl->{fh} =
144                              PublicInbox::MboxReader::zsfxcat($in, $zsfx, $lei);
145                 }
146                 local $PublicInbox::DS::in_loop = 0 if $zsfx; # dwaitpid
147                 $self->input_fh($ifmt, $mbl->{fh}, $input, @args);
148         } elsif (-d _ && (-d "$input/cur" || -d "$input/new")) {
149                 return $lei->fail(<<EOM) if $ifmt && $ifmt ne 'maildir';
150 $input appears to a be a maildir, not $ifmt
151 EOM
152                 PublicInbox::MdirReader->new->maildir_each_eml($input,
153                                         $self->can('input_maildir_cb'),
154                                         $self, @args);
155         } else {
156                 $lei->fail("$input unsupported (TODO)");
157         }
158 }
159
160 sub bad_http ($$;$) {
161         my ($lei, $url, $alt) = @_;
162         my $x = $alt ? "did you mean <$alt>?" : 'download and import manually';
163         $lei->fail("E: <$url> not recognized, $x");
164 }
165
166 sub prepare_http_input ($$$) {
167         my ($self, $lei, $url) = @_;
168         require URI;
169         require PublicInbox::MboxReader;
170         require PublicInbox::LeiCurl;
171         require IO::Uncompress::Gunzip;
172         $self->{curl} //= which('curl') or
173                                 return $lei->fail("curl missing for <$url>");
174         my $uri = URI->new($url);
175         my $path = $uri->path;
176         my %qf = $uri->query_form;
177         my @curl_opt;
178         if ($path =~ m!/(?:t\.mbox\.gz|all\.mbox\.gz)\z!) {
179                 # OK
180         } elsif ($path =~ m!/raw\z!) {
181                 push @curl_opt, '--compressed';
182         # convert search query to mboxrd request since they require POST
183         # this is only intended for PublicInbox::WWW, and will false-positive
184         # on many other search engines... oh well
185         } elsif (defined $qf{'q'}) {
186                 $qf{x} = 'm';
187                 $uri->query_form(\%qf);
188                 push @curl_opt, '-d', '';
189                 $$uri ne $url and $lei->qerr(<<"");
190 # <$url> rewritten to <$$uri> with HTTP POST
191
192         # try to provide hints for /$INBOX/$MSGID/T/ and /$INBOX/
193         } elsif ($path =~ s!/[tT]/\z!/t.mbox.gz! ||
194                         $path =~ s!/t\.atom\z!/t.mbox.gz! ||
195                         $path =~ s!/([^/]+\@[^/]+)/\z!/$1/raw!) {
196                 $uri->path($path);
197                 return bad_http($lei, $url, $$uri);
198         } else {
199                 return bad_http($lei, $url);
200         }
201         $self->{"-curl-$url"} = [ @curl_opt, $uri ]; # for handle_http_input
202 }
203
204 sub prepare_inputs { # returns undef on error
205         my ($self, $lei, $inputs) = @_;
206         my $in_fmt = $lei->{opt}->{'in-format'};
207         my $sync = $lei->{opt}->{sync} ? {} : undef; # using LeiMailSync
208         if ($lei->{opt}->{stdin}) {
209                 @$inputs and return
210                         $lei->fail("--stdin and @$inputs do not mix");
211                 check_input_format($lei) or return;
212                 push @$inputs, '/dev/stdin';
213                 push @{$sync->{no}}, '/dev/stdin' if $sync;
214         }
215         my $net = $lei->{net}; # NetWriter may be created by l2m
216         my (@f, @d);
217         # e.g. Maildir:/home/user/Mail/ or imaps://example.com/INBOX
218         for my $input (@$inputs) {
219                 my $input_path = $input;
220                 if ($input =~ m!\A(?:imaps?|nntps?|s?news)://!i) {
221                         require PublicInbox::NetReader;
222                         $net //= PublicInbox::NetReader->new;
223                         $net->add_url($input);
224                         if ($sync) {
225                                 if ($input =~ m!\Aimaps?://!) {
226                                         push @{$sync->{ok}}, $input;
227                                 } else {
228                                         push @{$sync->{no}}, $input;
229                                 }
230                         }
231                 } elsif ($input_path =~ m!\Ahttps?://!i) {
232                         prepare_http_input($self, $lei, $input_path) or return;
233                 } elsif ($input_path =~ s/\A([a-z0-9]+)://is) {
234                         my $ifmt = lc $1;
235                         if (($in_fmt // $ifmt) ne $ifmt) {
236                                 return $lei->fail(<<"");
237 --in-format=$in_fmt and `$ifmt:' conflict
238
239                         }
240                         if ($sync) {
241                                 if ($ifmt =~ /\A(?:maildir|mh)\z/i) {
242                                         push @{$sync->{ok}}, $input;
243                                 } else {
244                                         push @{$sync->{no}}, $input;
245                                 }
246                         }
247                         my $devfd = $lei->path_to_fd($input_path) // return;
248                         if ($devfd >= 0 || (-f $input_path || -p _)) {
249                                 require PublicInbox::MboxLock;
250                                 require PublicInbox::MboxReader;
251                                 PublicInbox::MboxReader->reads($ifmt) or return
252                                         $lei->fail("$ifmt not supported");
253                         } elsif (-d $input_path) {
254                                 require PublicInbox::MdirReader;
255                                 $ifmt eq 'maildir' or return
256                                         $lei->fail("$ifmt not supported");
257                                 $input = $lei->abs_path($input) if $sync;
258                         } else {
259                                 return $lei->fail("Unable to handle $input");
260                         }
261                 } elsif ($input =~ /\.(eml|patch)\z/i && -f $input) {
262                         lc($in_fmt//'eml') eq 'eml' or return $lei->fail(<<"");
263 $input is `eml', not --in-format=$in_fmt
264
265                         require PublicInbox::Eml;
266                         push @{$sync->{no}}, $input if $sync;
267                 } else {
268                         my $devfd = $lei->path_to_fd($input) // return;
269                         if ($devfd >= 0 || -f $input || -p _) {
270                                 push @{$sync->{no}}, $input if $sync;
271                                 push @f, $input;
272                         } elsif (-d $input) {
273                                 if ($sync) {
274                                         $input = $lei->abs_path($input);
275                                         push @{$sync->{ok}}, $input;
276                                 }
277                                 push @d, $input;
278                         } else {
279                                 return $lei->fail("Unable to handle $input")
280                         }
281                 }
282         }
283         if (@f) { check_input_format($lei, \@f) or return }
284         if (@d) { # TODO: check for MH vs Maildir, here
285                 require PublicInbox::MdirReader;
286         }
287         if ($sync && $sync->{no}) {
288                 return $lei->fail(<<"") if !$sync->{ok};
289 --sync specified but no inputs support it
290
291                 # non-fatal if some inputs support support sync
292                 $lei->err("# --sync will only be used for @{$sync->{ok}}");
293                 $lei->err("# --sync is not supported for: @{$sync->{no}}");
294         }
295         if ($net) {
296                 if (my $err = $net->errors) {
297                         return $lei->fail($err);
298                 }
299                 $net->{quiet} = $lei->{opt}->{quiet};
300                 require PublicInbox::LeiAuth;
301                 $lei->{auth} //= PublicInbox::LeiAuth->new;
302                 $lei->{net} //= $net;
303         }
304         $self->{inputs} = $inputs;
305 }
306
307 sub process_inputs {
308         my ($self) = @_;
309         for my $input (@{$self->{inputs}}) {
310                 $self->input_path_url($input);
311         }
312         my $wait = $self->{lei}->{sto}->ipc_do('done') if $self->{lei}->{sto};
313 }
314
315 sub input_only_atfork_child {
316         my ($self) = @_;
317         my $lei = $self->{lei};
318         $lei->_lei_atfork_child;
319         PublicInbox::IPC::ipc_atfork_child($self);
320         $lei->{auth}->do_auth_atfork($self) if $lei->{auth};
321         undef;
322 }
323
324 # like Getopt::Long, but for +kw:FOO and -kw:FOO to prepare
325 # for update_xvmd -> update_vmd
326 sub vmd_mod_extract {
327         my $argv = $_[-1];
328         my $vmd_mod = {};
329         my @new_argv;
330         for my $x (@$argv) {
331                 if ($x =~ /\A(\+|\-)(kw|L):(.+)\z/) {
332                         my ($op, $pfx, $val) = ($1, $2, $3);
333                         if (my $err = $ERR{$pfx}->($val)) {
334                                 push @{$vmd_mod->{err}}, $err;
335                         } else { # set "+kw", "+L", "-L", "-kw"
336                                 push @{$vmd_mod->{$op.$pfx}}, $val;
337                         }
338                 } else {
339                         push @new_argv, $x;
340                 }
341         }
342         @$argv = @new_argv;
343         $vmd_mod;
344 }
345
346 1;