X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=lib%2FPublicInbox%2FMbox.pm;h=c88350c90599e1b2739f05f5a3c87a856c61b854;hb=db7c206a4e2c71d08dd286d6dfa92431976e9693;hp=84cc384529f174cd020bbfb2360519720b5d0929;hpb=3d41aa23f35501ca92aab8aa42980fa73f7fa74f;p=public-inbox.git diff --git a/lib/PublicInbox/Mbox.pm b/lib/PublicInbox/Mbox.pm index 84cc3845..c88350c9 100644 --- a/lib/PublicInbox/Mbox.pm +++ b/lib/PublicInbox/Mbox.pm @@ -1,37 +1,62 @@ -# Copyright (C) 2015-2018 all contributors +# Copyright (C) 2015-2020 all contributors # License: AGPL-3.0+ -# Streaming interface for formatting messages as an mboxrd. -# Used by the web interface +# Streaming interface for mboxrd HTTP responses +# See PublicInbox::GzipFilter for details. package PublicInbox::Mbox; use strict; -use warnings; -use PublicInbox::MID qw/mid_clean mid_escape/; +use parent 'PublicInbox::GzipFilter'; +use PublicInbox::MID qw/mid_escape/; use PublicInbox::Hval qw/to_filename/; -use Email::Simple; -use Email::MIME::Encode; - -sub subject_fn ($) { - my ($simple) = @_; - my $fn = $simple->header('Subject'); - return 'no-subject' unless defined($fn); - - # no need for full Email::MIME, here - if ($fn =~ /=\?/) { - eval { $fn = Encode::decode('MIME-Header', $fn) }; - $fn = 'no-subject' if $@; +use PublicInbox::Smsg; +use PublicInbox::Eml; + +# called by PSGI server as body response +# this gets called twice for every message, once to return the header, +# once to retrieve the body +sub getline { + my ($ctx) = @_; # ctx + my $smsg = $ctx->{smsg} or return; + my $ibx = $ctx->{ibx}; + my $eml = $ibx->smsg_eml($smsg) or return; + my $n = $ctx->{smsg} = $ibx->over->next_by_mid(@{$ctx->{next_arg}}); + $ctx->zmore(msg_hdr($ctx, $eml, $smsg->{mid})); + if ($n) { + $ctx->translate(msg_body($eml)); + } else { # last message + $ctx->zmore(msg_body($eml)); + $ctx->zflush; } - $fn =~ s/^re:\s+//i; - $fn = to_filename($fn); - $fn eq '' ? 'no-subject' : $fn; } -sub emit1 { - my ($ctx, $msg) = @_; - $msg = Email::Simple->new($msg); - my $fn = subject_fn($msg); +# called by PublicInbox::DS::write after http->next_step +sub async_next { + my ($http) = @_; # PublicInbox::HTTP + my $ctx = $http->{forward} or return; # client aborted + eval { + my $smsg = $ctx->{smsg} or return $ctx->close; + $ctx->smsg_blob($smsg); + }; + warn "E: $@" if $@; +} + +sub async_eml { # for async_blob_cb + my ($ctx, $eml) = @_; + my $smsg = delete $ctx->{smsg}; + # next message + $ctx->{smsg} = $ctx->{ibx}->over->next_by_mid(@{$ctx->{next_arg}}); + + $ctx->zmore(msg_hdr($ctx, $eml, $smsg->{mid})); + $ctx->{http_out}->write($ctx->translate(msg_body($eml))); +} + +sub res_hdr ($$) { + my ($ctx, $subject) = @_; + my $fn = $subject // ''; + $fn =~ s/^re:\s+//i; + $fn = to_filename($fn) // 'no-subject'; my @hdr = ('Content-Type'); - if ($ctx->{-inbox}->{obfuscate}) { + if ($ctx->{ibx}->{obfuscate}) { # obfuscation is stupid, but maybe scrapers are, too... push @hdr, 'application/mbox'; $fn .= '.mbox'; @@ -40,177 +65,213 @@ sub emit1 { $fn .= '.txt'; } push @hdr, 'Content-Disposition', "inline; filename=$fn"; + \@hdr; +} + +# for rare cases where v1 inboxes aren't indexed w/ ->over at all +sub no_over_raw ($) { + my ($ctx) = @_; + my $mref = $ctx->{ibx}->msg_by_mid($ctx->{mid}) or return; + my $eml = PublicInbox::Eml->new($mref); + [ 200, res_hdr($ctx, $eml->header_str('Subject')), + [ msg_hdr($ctx, $eml, $ctx->{mid}) . msg_body($eml) ] ] +} - # single message should be easily renderable in browsers, - # unless obfuscation is enabled :< - [ 200, \@hdr, [ msg_str($ctx, $msg) ] ] +# /$INBOX/$MESSAGE_ID/raw +sub emit_raw { + my ($ctx) = @_; + $ctx->{base_url} = $ctx->{ibx}->base_url($ctx->{env}); + my $over = $ctx->{ibx}->over or return no_over_raw($ctx); + my ($id, $prev); + my $mip = $ctx->{next_arg} = [ $ctx->{mid}, \$id, \$prev ]; + my $smsg = $ctx->{smsg} = $over->next_by_mid(@$mip) or return; + my $res_hdr = res_hdr($ctx, $smsg->{subject}); + bless $ctx, __PACKAGE__; + $ctx->psgi_response(200, $res_hdr); } -sub msg_str { - my ($ctx, $simple) = @_; # Email::Simple object - my $header_obj = $simple->header_obj; +sub msg_hdr ($$;$) { + my ($ctx, $eml, $mid) = @_; + my $header_obj = $eml->header_obj; # drop potentially confusing headers, ssoma already should've dropped # Lines and Content-Length foreach my $d (qw(Lines Bytes Content-Length Status)) { $header_obj->header_set($d); } - my $ibx = $ctx->{-inbox}; - my $base = $ibx->base_url($ctx->{env}); - my $mid = mid_clean($header_obj->header('Message-ID')); + my $ibx = $ctx->{ibx}; + my $base = $ctx->{base_url}; + $mid = $ctx->{mid} unless defined $mid; $mid = mid_escape($mid); my @append = ( 'Archived-At', "<$base$mid/>", 'List-Archive', "<$base>", - 'List-Post', "{-primary_address}>", ); - my $crlf = $simple->crlf; - my $buf = "From mboxrd\@z Thu Jan 1 00:00:00 1970\n" . - $header_obj->as_string; + my $crlf = $header_obj->crlf; + my $buf = $header_obj->as_string; + # fixup old bug from import (pre-a0c07cba0e5d8b6a) + $buf =~ s/\A[\r\n]*From [^\r\n]*\r?\n//s; + $buf = "From mboxrd\@z Thu Jan 1 00:00:00 1970" . $crlf . $buf; + for (my $i = 0; $i < @append; $i += 2) { my $k = $append[$i]; my $v = $append[$i + 1]; - my @v = $header_obj->header($k); - foreach (@v) { - if ($v eq $_) { - $v = undef; - last; - } - } - $buf .= "$k: $v$crlf" if defined $v; + my @v = $header_obj->header_raw($k); + $buf .= "$k: $v$crlf" if !grep(/\A\Q$v\E\z/, @v); + } + my $post_addr = $ibx->{-primary_address}; + if ($post_addr && $header_obj->header_raw('List-Post')) { + $buf .= "List-Post: $crlf"; } $buf .= $crlf; +} +sub msg_body ($) { + my $bdy = $_[0]->{bdy} // return "\n"; # mboxrd quoting style - # ref: http://www.qmail.org/man/man5/mbox.html - my $body = $simple->body; - $body =~ s/^(>*From )/>$1/gm; - $buf .= $body; - $buf .= "\n"; + # https://en.wikipedia.org/wiki/Mbox#Modified_mbox + # https://www.loc.gov/preservation/digital/formats/fdd/fdd000385.shtml + # https://web.archive.org/http://www.qmail.org/man/man5/mbox.html + $$bdy =~ s/^(>*From )/>$1/gm; + $$bdy .= "\n"; } -sub thread_mbox { - my ($ctx, $srch, $sfx) = @_; - eval { require IO::Compress::Gzip }; - return sub { need_gzip(@_) } if $@; +sub thread_cb { + my ($ctx) = @_; + my $msgs = $ctx->{msgs}; + while (1) { + if (my $smsg = shift @$msgs) { + return $smsg; + } + # refill result set + $ctx->{msgs} = $msgs = $ctx->{over}->get_thread($ctx->{mid}, + $ctx->{prev}); + return unless @$msgs; + $ctx->{prev} = $msgs->[-1]; + } +} - my $cb = sub { $srch->get_thread($ctx->{mid}, @_) }; - PublicInbox::MboxGz->response($ctx, $cb); +sub thread_mbox { + my ($ctx, $over, $sfx) = @_; + my $msgs = $ctx->{msgs} = $over->get_thread($ctx->{mid}, {}); + return [404, [qw(Content-Type text/plain)], []] if !@$msgs; + $ctx->{prev} = $msgs->[-1]; + $ctx->{over} = $over; # bump refcnt + require PublicInbox::MboxGz; + PublicInbox::MboxGz::mbox_gz($ctx, \&thread_cb, $msgs->[0]->{subject}); } sub emit_range { my ($ctx, $range) = @_; - my $query; + my $q; if ($range eq 'all') { # TODO: YYYY[-MM] - $query = ''; + $q = ''; } else { return [404, [qw(Content-Type text/plain)], []]; } - mbox_all($ctx, $query); + mbox_all($ctx, { q => $q }); } -sub mbox_all { - my ($ctx, $query) = @_; - - eval { require IO::Compress::Gzip }; - return sub { need_gzip(@_) } if $@; - my $cb = sub { $ctx->{srch}->query($query, @_) }; - PublicInbox::MboxGz->response($ctx, $cb, 'results-'.$query); +sub all_ids_cb { + my ($ctx) = @_; + my $ids = $ctx->{ids}; + do { + while ((my $num = shift @$ids)) { + my $smsg = $ctx->{over}->get_art($num) or next; + return $smsg; + } + $ctx->{ids} = $ids = $ctx->{mm}->ids_after(\($ctx->{prev})); + } while (@$ids); } -sub need_gzip { - my $fh = $_[0]->([501, ['Content-Type' => 'text/html']]); - my $title = 'gzipped mbox not available'; - $fh->write(<$title
$title
-The administrator needs to install the IO::Compress::Gzip Perl module
-to support gzipped mboxes.
-Return to index
-EOF - $fh->close; +sub mbox_all_ids { + my ($ctx) = @_; + my $ibx = $ctx->{ibx}; + my $prev = 0; + my $mm = $ctx->{mm} = $ibx->mm; + my $ids = $mm->ids_after(\$prev) or return + [404, [qw(Content-Type text/plain)], ["No results found\n"]]; + $ctx->{over} = $ibx->over or + return PublicInbox::WWW::need($ctx, 'Overview'); + $ctx->{ids} = $ids; + $ctx->{prev} = $prev; + require PublicInbox::MboxGz; + PublicInbox::MboxGz::mbox_gz($ctx, \&all_ids_cb, 'all'); } -1; - -package PublicInbox::MboxGz; -use strict; -use warnings; -use PublicInbox::Hval qw/to_filename/; - -sub new { - my ($class, $ctx, $cb) = @_; - my $buf = ''; - bless { - buf => \$buf, - gz => IO::Compress::Gzip->new(\$buf, Time => 0), - cb => $cb, - ctx => $ctx, - msgs => [], - opts => { offset => 0 }, - }, $class; +sub gone ($$) { + my ($ctx, $what) = @_; + warn "W: `$ctx->{ibx}->{inboxdir}' $what went away unexpectedly\n"; + undef; } -sub response { - my ($class, $ctx, $cb, $fn) = @_; - my $body = $class->new($ctx, $cb); - # http://www.iana.org/assignments/media-types/application/gzip - $body->{hdr} = [ 'Content-Type', 'application/gzip' ]; - $body->{fn} = $fn; - my $hdr = $body->getline; # fill in Content-Disposition filename - [ 200, $hdr, $body ]; +sub results_cb { + my ($ctx) = @_; + my $over = $ctx->{ibx}->over or return gone($ctx, 'over'); + while (1) { + while (defined(my $num = shift(@{$ctx->{ids}}))) { + my $smsg = $over->get_art($num) or next; + return $smsg; + } + # refill result set + my $srch = $ctx->{ibx}->isrch or return gone($ctx, 'search'); + my $mset = $srch->mset($ctx->{query}, $ctx->{qopts}); + my $size = $mset->size or return; + $ctx->{qopts}->{offset} += $size; + $ctx->{ids} = $srch->mset_to_artnums($mset, $ctx->{qopts}); + } } -sub set_filename ($$) { - my ($fn, $msg) = @_; - return to_filename($fn) if defined($fn); +sub results_thread_cb { + my ($ctx) = @_; - PublicInbox::Mbox::subject_fn($msg); -} - -# called by Plack::Util::foreach or similar -sub getline { - my ($self) = @_; - my $ctx = $self->{ctx} or return; - my $res; - my $ibx = $ctx->{-inbox}; - my $gz = $self->{gz}; - do { - # work on existing result set - while (defined(my $smsg = shift @{$self->{msgs}})) { - my $msg = eval { $ibx->msg_by_smsg($smsg) } or next; - $msg = Email::Simple->new($msg); - $gz->write(PublicInbox::Mbox::msg_str($ctx, $msg)); - - # use subject of first message as subject - if (my $hdr = delete $self->{hdr}) { - my $fn = set_filename($self->{fn}, $msg); - push @$hdr, 'Content-Disposition', - "inline; filename=$fn.mbox.gz"; - return $hdr; - } - my $bref = $self->{buf}; - if (length($$bref) >= 8192) { - my $ret = $$bref; # copy :< - ${$self->{buf}} = ''; - return $ret; - } - - # be fair to other clients on public-inbox-httpd: - return ''; + my $over = $ctx->{ibx}->over or return gone($ctx, 'over'); + while (1) { + while (defined(my $num = shift(@{$ctx->{xids}}))) { + my $smsg = $over->get_art($num) or next; + return $smsg; } + # refills ctx->{xids} + next if $over->expand_thread($ctx); + # refill result set - $res = $self->{cb}->($self->{opts}); - $self->{msgs} = $res->{msgs}; - $res = scalar @{$self->{msgs}}; - $self->{opts}->{offset} += $res; - } while ($res); - $gz->close; - delete $self->{ctx}; - ${delete $self->{buf}}; + my $srch = $ctx->{ibx}->isrch or return gone($ctx, 'search'); + my $mset = $srch->mset($ctx->{query}, $ctx->{qopts}); + my $size = $mset->size or return; + $ctx->{qopts}->{offset} += $size; + $ctx->{ids} = $srch->mset_to_artnums($mset, $ctx->{qopts}); + } + } -sub close {} # noop +sub mbox_all { + my ($ctx, $q) = @_; + my $q_string = $q->{'q'}; + return mbox_all_ids($ctx) if $q_string !~ /\S/; + my $srch = $ctx->{ibx}->isrch or + return PublicInbox::WWW::need($ctx, 'Search'); + my $over = $ctx->{ibx}->over or + return PublicInbox::WWW::need($ctx, 'Overview'); + + my $qopts = $ctx->{qopts} = { mset => 2 }; # order by docid + $qopts->{thread} = 1 if $q->{t}; + my $mset = $srch->mset($q_string, $qopts); + $qopts->{offset} = $mset->size or + return [404, [qw(Content-Type text/plain)], + ["No results found\n"]]; + $ctx->{query} = $q_string; + $ctx->{ids} = $srch->mset_to_artnums($mset, $qopts); + require PublicInbox::MboxGz; + my $fn; + if ($q->{t} && $srch->has_threadid) { + $fn = 'results-thread-'.$q_string; + PublicInbox::MboxGz::mbox_gz($ctx, \&results_thread_cb, $fn); + } else { + $fn = 'results-'.$q_string; + PublicInbox::MboxGz::mbox_gz($ctx, \&results_cb, $fn); + } +} 1;