X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=lib%2FPublicInbox%2FMbox.pm;h=5693d30b1c5ab80ce08fe56f694ffd84b94d7522;hb=95bdac7f09c69036efed537a4d03d5bdd2ae4eb6;hp=8837400a435788d1fa1ef17b6dc85674bc59672d;hpb=9bd675d33ad1e49bd2ebe12a1d216216e61380de;p=public-inbox.git diff --git a/lib/PublicInbox/Mbox.pm b/lib/PublicInbox/Mbox.pm index 8837400a..5693d30b 100644 --- a/lib/PublicInbox/Mbox.pm +++ b/lib/PublicInbox/Mbox.pm @@ -1,4 +1,4 @@ -# Copyright (C) 2015-2019 all contributors +# Copyright (C) 2015-2020 all contributors # License: AGPL-3.0+ # Streaming (via getline) interface for formatting messages as an mboxrd. @@ -10,24 +10,24 @@ package PublicInbox::Mbox; use strict; use warnings; -use PublicInbox::MID qw/mid_clean mid_escape/; +use PublicInbox::MID qw/mid_escape/; use PublicInbox::Hval qw/to_filename/; +use PublicInbox::SearchMsg; use Email::Simple; use Email::MIME::Encode; sub subject_fn ($) { my ($hdr) = @_; my $fn = $hdr->header('Subject'); - return 'no-subject' unless defined($fn); + return 'no-subject' if (!defined($fn) || $fn eq ''); # no need for full Email::MIME, here if ($fn =~ /=\?/) { eval { $fn = Encode::decode('MIME-Header', $fn) }; - $fn = 'no-subject' if $@; + return 'no-subject' if $@; } $fn =~ s/^re:\s+//i; - $fn = to_filename($fn); - $fn eq '' ? 'no-subject' : $fn; + $fn eq '' ? 'no-subject' : to_filename($fn); } sub mb_stream { @@ -60,10 +60,12 @@ sub getline { sub close {} # noop +# /$INBOX/$MESSAGE_ID/raw sub emit_raw { my ($ctx) = @_; my $mid = $ctx->{mid}; my $ibx = $ctx->{-inbox}; + $ctx->{base_url} = $ibx->base_url($ctx->{env}); my ($mref, $more, $id, $prev, $next); if (my $over = $ibx->over) { my $smsg = $over->next_by_mid($mid, \$id, \$prev) or return; @@ -97,7 +99,7 @@ sub msg_hdr ($$;$) { $header_obj->header_set($d); } my $ibx = $ctx->{-inbox}; - my $base = $ibx->base_url($ctx->{env}); + my $base = $ctx->{base_url}; $mid = $ctx->{mid} unless defined $mid; $mid = mid_escape($mid); my @append = ( @@ -125,33 +127,37 @@ sub msg_hdr ($$;$) { sub msg_body ($) { # mboxrd quoting style - # ref: http://www.qmail.org/man/man5/mbox.html + # 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 $_[0] =~ s/^(>*From )/>$1/gm; $_[0] .= "\n"; } +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]; + } +} + sub thread_mbox { my ($ctx, $over, $sfx) = @_; - eval { require IO::Compress::Gzip }; - return sub { need_gzip(@_) } if $@; - my $mid = $ctx->{mid}; - my $msgs = $over->get_thread($mid, {}); + eval { require PublicInbox::MboxGz }; + return need_gzip() if $@; + my $msgs = $ctx->{msgs} = $over->get_thread($ctx->{mid}, {}); return [404, [qw(Content-Type text/plain)], []] if !@$msgs; - my $prev = $msgs->[-1]; - my $i = 0; - my $cb = sub { - while (1) { - if (my $smsg = $msgs->[$i++]) { - return $smsg; - } - # refill result set - $msgs = $over->get_thread($mid, $prev); - return unless @$msgs; - $prev = $msgs->[-1]; - $i = 0; - } - }; - PublicInbox::MboxGz->response($ctx, $cb, $msgs->[0]->subject); + $ctx->{prev} = $msgs->[-1]; + $ctx->{over} = $over; # bump refcnt + PublicInbox::MboxGz->response($ctx, \&thread_cb, $msgs->[0]->subject); } sub emit_range { @@ -166,131 +172,80 @@ sub emit_range { mbox_all($ctx, $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 mbox_all_ids { my ($ctx) = @_; - my $prev = 0; my $ibx = $ctx->{-inbox}; - my $ids = $ibx->mm->ids_after(\$prev) or return + 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"]]; - my $i = 0; - my $over = $ibx->over or + $ctx->{over} = $ibx->over or return PublicInbox::WWW::need($ctx, 'Overview'); - my $cb = sub { - do { - while ((my $num = $ids->[$i++])) { - my $smsg = $over->get_art($num) or next; - return $smsg; - } - $ids = $ibx->mm->ids_after(\$prev); - $i = 0; - } while (@$ids); - undef; - }; - return PublicInbox::MboxGz->response($ctx, $cb, 'all'); + $ctx->{ids} = $ids; + $ctx->{prev} = $prev; + return PublicInbox::MboxGz->response($ctx, \&all_ids_cb, 'all'); +} + +sub results_cb { + my ($ctx) = @_; + my $mset = $ctx->{mset}; + my $srch = $ctx->{srch}; + while (1) { + while (my $mi = (($mset->items)[$ctx->{iter}++])) { + my $smsg = PublicInbox::SearchMsg::from_mitem($mi, + $srch) or next; + return $smsg; + } + # refill result set + $mset = $ctx->{mset} = $srch->query($ctx->{query}, + $ctx->{qopts}); + my $size = $mset->size or return; + $ctx->{qopts}->{offset} += $size; + $ctx->{iter} = 0; + } } sub mbox_all { my ($ctx, $query) = @_; - eval { require IO::Compress::Gzip }; - return sub { need_gzip(@_) } if $@; + eval { require PublicInbox::MboxGz }; + return need_gzip() if $@; return mbox_all_ids($ctx) if $query eq ''; - my $opts = { mset => 2 }; - my $srch = $ctx->{-inbox}->search or + my $qopts = $ctx->{qopts} = { mset => 2 }; + my $srch = $ctx->{srch} = $ctx->{-inbox}->search or return PublicInbox::WWW::need($ctx, 'Search');; - my $mset = $srch->query($query, $opts); - $opts->{offset} = $mset->size or + my $mset = $ctx->{mset} = $srch->query($query, $qopts); + $qopts->{offset} = $mset->size or return [404, [qw(Content-Type text/plain)], ["No results found\n"]]; - my $i = 0; - my $cb = sub { # called by MboxGz->getline - while (1) { - while (my $mi = (($mset->items)[$i++])) { - my $doc = $mi->get_document; - my $smsg = $srch->retry_reopen(sub { - PublicInbox::SearchMsg->load_doc($doc); - }) or next; - return $smsg; - } - # refill result set - $mset = $srch->query($query, $opts); - my $size = $mset->size or return; - $opts->{offset} += $size; - $i = 0; - } - }; - PublicInbox::MboxGz->response($ctx, $cb, 'results-'.$query); + $ctx->{iter} = 0; + $ctx->{query} = $query; + PublicInbox::MboxGz->response($ctx, \&results_cb, 'results-'.$query); } 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
+The administrator needs to install the Compress::Raw::Zlib Perl module
 to support gzipped mboxes.
 Return to index
EOF - $fh->close; -} - -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, - }, $class; -} -sub response { - my ($class, $ctx, $cb, $fn) = @_; - my $body = $class->new($ctx, $cb); - # http://www.iana.org/assignments/media-types/application/gzip - my @h = qw(Content-Type application/gzip); - if ($fn) { - $fn = to_filename($fn); - push @h, 'Content-Disposition', "inline; filename=$fn.mbox.gz"; - } - [ 200, \@h, $body ]; -} - -# called by Plack::Util::foreach or similar -sub getline { - my ($self) = @_; - my $ctx = $self->{ctx} or return; - my $gz = $self->{gz}; - while (my $smsg = $self->{cb}->()) { - my $mref = $ctx->{-inbox}->msg_by_smsg($smsg) or next; - my $h = Email::Simple->new($mref)->header_obj; - $gz->write(PublicInbox::Mbox::msg_hdr($ctx, $h, $smsg->{mid})); - $gz->write(PublicInbox::Mbox::msg_body($$mref)); - - 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 ''; - } - delete($self->{gz})->close; - # signal that we're done and can return undef next call: - delete $self->{ctx}; - ${delete $self->{buf}}; + [501,[qw(Content-Type text/html Content-Length), bytes::length($body)], + [ $body ] ]; } -sub close {} # noop - 1;