1 # Copyright (C) 2015-2021 all contributors <meta@public-inbox.org>
2 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
4 # Streaming interface for mboxrd HTTP responses
5 # See PublicInbox::GzipFilter for details.
6 package PublicInbox::Mbox;
8 use parent 'PublicInbox::GzipFilter';
9 use PublicInbox::MID qw/mid_escape/;
10 use PublicInbox::Hval qw/to_filename/;
11 use PublicInbox::Smsg;
14 # called by PSGI server as body response
15 # this gets called twice for every message, once to return the header,
16 # once to retrieve the body
19 my $smsg = $ctx->{smsg} or return;
20 my $ibx = $ctx->{ibx};
21 my $eml = $ibx->smsg_eml($smsg) or return;
22 my $n = $ctx->{smsg} = $ibx->over->next_by_mid(@{$ctx->{next_arg}});
23 $ctx->zmore(msg_hdr($ctx, $eml));
25 $ctx->translate(msg_body($eml));
26 } else { # last message
27 $ctx->zmore(msg_body($eml));
32 # called by PublicInbox::DS::write after http->next_step
34 my ($http) = @_; # PublicInbox::HTTP
35 my $ctx = $http->{forward} or return; # client aborted
37 my $smsg = $ctx->{smsg} or return $ctx->close;
38 $ctx->smsg_blob($smsg);
43 sub async_eml { # for async_blob_cb
45 my $smsg = delete $ctx->{smsg};
47 $ctx->{smsg} = $ctx->{ibx}->over->next_by_mid(@{$ctx->{next_arg}});
49 $ctx->zmore(msg_hdr($ctx, $eml));
50 $ctx->{http_out}->write($ctx->translate(msg_body($eml)));
54 my ($ctx, $subject) = @_;
55 my $fn = $subject // '';
57 $fn = to_filename($fn) // 'no-subject';
58 my @hdr = ('Content-Type');
59 if ($ctx->{ibx}->{obfuscate}) {
60 # obfuscation is stupid, but maybe scrapers are, too...
61 push @hdr, 'application/mbox';
64 push @hdr, 'text/plain';
67 push @hdr, 'Content-Disposition', "inline; filename=$fn";
71 # for rare cases where v1 inboxes aren't indexed w/ ->over at all
74 my $mref = $ctx->{ibx}->msg_by_mid($ctx->{mid}) or return;
75 my $eml = PublicInbox::Eml->new($mref);
76 [ 200, res_hdr($ctx, $eml->header_str('Subject')),
77 [ msg_hdr($ctx, $eml) . msg_body($eml) ] ]
80 # /$INBOX/$MESSAGE_ID/raw
83 $ctx->{base_url} = $ctx->{ibx}->base_url($ctx->{env});
84 my $over = $ctx->{ibx}->over or return no_over_raw($ctx);
86 my $mip = $ctx->{next_arg} = [ $ctx->{mid}, \$id, \$prev ];
87 my $smsg = $ctx->{smsg} = $over->next_by_mid(@$mip) or return;
88 my $res_hdr = res_hdr($ctx, $smsg->{subject});
89 bless $ctx, __PACKAGE__;
90 $ctx->psgi_response(200, $res_hdr);
95 my $header_obj = $eml->header_obj;
97 # drop potentially confusing headers, ssoma already should've dropped
98 # Lines and Content-Length
99 foreach my $d (qw(Lines Bytes Content-Length Status)) {
100 $header_obj->header_set($d);
102 my $crlf = $header_obj->crlf;
103 my $buf = $header_obj->as_string;
104 # fixup old bug from import (pre-a0c07cba0e5d8b6a)
105 $buf =~ s/\A[\r\n]*From [^\r\n]*\r?\n//s;
106 "From mboxrd\@z Thu Jan 1 00:00:00 1970" . $crlf . $buf . $crlf;
110 my $bdy = $_[0]->{bdy} // return "\n";
111 # mboxrd quoting style
112 # https://en.wikipedia.org/wiki/Mbox#Modified_mbox
113 # https://www.loc.gov/preservation/digital/formats/fdd/fdd000385.shtml
114 # https://web.archive.org/http://www.qmail.org/man/man5/mbox.html
115 $$bdy =~ s/^(>*From )/>$1/gm;
121 my $msgs = $ctx->{msgs};
123 if (my $smsg = shift @$msgs) {
127 $ctx->{msgs} = $msgs = $ctx->{over}->get_thread($ctx->{mid},
129 return unless @$msgs;
130 $ctx->{prev} = $msgs->[-1];
135 my ($ctx, $over, $sfx) = @_;
136 my $msgs = $ctx->{msgs} = $over->get_thread($ctx->{mid}, {});
137 return [404, [qw(Content-Type text/plain)], []] if !@$msgs;
138 $ctx->{prev} = $msgs->[-1];
139 $ctx->{over} = $over; # bump refcnt
140 require PublicInbox::MboxGz;
141 PublicInbox::MboxGz::mbox_gz($ctx, \&thread_cb, $msgs->[0]->{subject});
145 my ($ctx, $range) = @_;
148 if ($range eq 'all') { # TODO: YYYY[-MM]
151 return [404, [qw(Content-Type text/plain)], []];
153 mbox_all($ctx, { q => $q });
158 my $ids = $ctx->{ids};
160 while ((my $num = shift @$ids)) {
161 my $smsg = $ctx->{over}->get_art($num) or next;
164 $ctx->{ids} = $ids = $ctx->{over}->ids_after(\($ctx->{prev}));
171 $ctx->{over} = $ctx->{ibx}->over or
172 return PublicInbox::WWW::need($ctx, 'Overview');
173 my $ids = $ctx->{over}->ids_after(\$prev) or return
174 [404, [qw(Content-Type text/plain)], ["No results found\n"]];
176 $ctx->{prev} = $prev;
177 require PublicInbox::MboxGz;
178 PublicInbox::MboxGz::mbox_gz($ctx, \&all_ids_cb, 'all');
182 my ($ctx, $what) = @_;
183 warn "W: `$ctx->{ibx}->{inboxdir}' $what went away unexpectedly\n";
189 my $over = $ctx->{ibx}->over or return gone($ctx, 'over');
191 while (defined(my $num = shift(@{$ctx->{ids}}))) {
192 my $smsg = $over->get_art($num) or next;
196 my $srch = $ctx->{ibx}->isrch or return gone($ctx, 'search');
197 my $mset = $srch->mset($ctx->{query}, $ctx->{qopts});
198 my $size = $mset->size or return;
199 $ctx->{qopts}->{offset} += $size;
200 $ctx->{ids} = $srch->mset_to_artnums($mset, $ctx->{qopts});
204 sub results_thread_cb {
207 my $over = $ctx->{ibx}->over or return gone($ctx, 'over');
209 while (defined(my $num = shift(@{$ctx->{xids}}))) {
210 my $smsg = $over->get_art($num) or next;
214 # refills ctx->{xids}
215 next if $over->expand_thread($ctx);
218 my $srch = $ctx->{ibx}->isrch or return gone($ctx, 'search');
219 my $mset = $srch->mset($ctx->{query}, $ctx->{qopts});
220 my $size = $mset->size or return;
221 $ctx->{qopts}->{offset} += $size;
222 $ctx->{ids} = $srch->mset_to_artnums($mset, $ctx->{qopts});
229 my $q_string = $q->{'q'};
230 return mbox_all_ids($ctx) if $q_string !~ /\S/;
231 my $srch = $ctx->{ibx}->isrch or
232 return PublicInbox::WWW::need($ctx, 'Search');
233 my $over = $ctx->{ibx}->over or
234 return PublicInbox::WWW::need($ctx, 'Overview');
236 my $qopts = $ctx->{qopts} = { relevance => -2 }; # ORDER BY docid DESC
237 $qopts->{threads} = 1 if $q->{t};
238 $srch->query_approxidate($ctx->{ibx}->git, $q_string);
239 my $mset = $srch->mset($q_string, $qopts);
240 $qopts->{offset} = $mset->size or
241 return [404, [qw(Content-Type text/plain)],
242 ["No results found\n"]];
243 $ctx->{query} = $q_string;
244 $ctx->{ids} = $srch->mset_to_artnums($mset, $qopts);
245 require PublicInbox::MboxGz;
247 if ($q->{t} && $srch->has_threadid) {
248 $fn = 'results-thread-'.$q_string;
249 PublicInbox::MboxGz::mbox_gz($ctx, \&results_thread_cb, $fn);
251 $fn = 'results-'.$q_string;
252 PublicInbox::MboxGz::mbox_gz($ctx, \&results_cb, $fn);