X-Git-Url: http://www.git.stargrave.org/?p=public-inbox.git;a=blobdiff_plain;f=lib%2FPublicInbox%2FMbox.pm;h=4427ae5d86588056c6d7e9108314e8cfd6dff75f;hp=fd623f6d48bd4e63ae3fc8d762e5a75fed39f993;hb=fad9acd35e56a289ade90a62d056b2a6663d448c;hpb=9d1e5fadd7d18f4c96ab0509d673040e34225a04 diff --git a/lib/PublicInbox/Mbox.pm b/lib/PublicInbox/Mbox.pm index fd623f6d..4427ae5d 100644 --- a/lib/PublicInbox/Mbox.pm +++ b/lib/PublicInbox/Mbox.pm @@ -1,5 +1,5 @@ -# Copyright (C) 2015 all contributors -# License: AGPLv3 or later (https://www.gnu.org/licenses/agpl-3.0.txt) +# Copyright (C) 2015-2018 all contributors +# License: AGPL-3.0+ # Streaming interface for formatting messages as an mboxrd. # Used by the web interface @@ -7,17 +7,83 @@ package PublicInbox::Mbox; use strict; use warnings; use PublicInbox::MID qw/mid_clean mid_escape/; -require Email::Simple; +use PublicInbox::Hval qw/to_filename/; +use Email::Simple; +use Email::MIME::Encode; -sub emit1 { - my ($ctx, $msg) = @_; - $msg = Email::Simple->new($msg); - # single message should be easily renderable in browsers - [200, ['Content-Type', 'text/plain'], [ msg_str($ctx, $msg)] ] +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 $@; + } + $fn =~ s/^re:\s+//i; + $fn = to_filename($fn); + $fn eq '' ? 'no-subject' : $fn; +} + +sub mb_stream { + my ($more) = @_; + bless $more, 'PublicInbox::Mbox'; +} + +# called by PSGI server as body response +sub getline { + my ($more) = @_; # self + my ($ctx, $id, $prev, $next, $cur) = @$more; + if ($cur) { # first + pop @$more; + return msg_str($ctx, $cur); + } + $cur = $next or return; + my $ibx = $ctx->{-inbox}; + $next = $ibx->search->next_by_mid($ctx->{mid}, \$id, \$prev); + @$more = ($ctx, $id, $prev, $next); # $next may be undef, here + my $mref = $ibx->msg_by_smsg($cur) or return; + msg_str($ctx, Email::Simple->new($mref)); +} + +sub close {} # noop + +sub emit_raw { + my ($ctx) = @_; + my $mid = $ctx->{mid}; + my $ibx = $ctx->{-inbox}; + my $first; + my $more; + if (my $srch = $ibx->search) { + my ($id, $prev); + my $smsg = $srch->next_by_mid($mid, \$id, \$prev) or return; + my $mref = $ibx->msg_by_smsg($smsg) or return; + $first = Email::Simple->new($mref); + my $next = $srch->next_by_mid($mid, \$id, \$prev); + # $more is for ->getline + $more = [ $ctx, $id, $prev, $next, $first ] if $next; + } else { + my $mref = $ibx->msg_by_mid($mid) or return; + $first = Email::Simple->new($mref); + } + return unless defined $first; + my $fn = subject_fn($first); + my @hdr = ('Content-Type'); + if ($ibx->{obfuscate}) { + # obfuscation is stupid, but maybe scrapers are, too... + push @hdr, 'application/mbox'; + $fn .= '.mbox'; + } else { + push @hdr, 'text/plain'; + $fn .= '.txt'; + } + push @hdr, 'Content-Disposition', "inline; filename=$fn"; + [ 200, \@hdr, $more ? mb_stream($more) : [ msg_str($ctx, $first) ] ]; } sub msg_str { - my ($ctx, $simple) = @_; # Email::Simple object + my ($ctx, $simple, $mid) = @_; # Email::Simple object my $header_obj = $simple->header_obj; # drop potentially confusing headers, ssoma already should've dropped @@ -27,7 +93,7 @@ sub msg_str { } my $ibx = $ctx->{-inbox}; my $base = $ibx->base_url($ctx->{env}); - my $mid = mid_clean($header_obj->header('Message-ID')); + $mid = $ctx->{mid} unless defined $mid; $mid = mid_escape($mid); my @append = ( 'Archived-At', "<$base$mid/>", @@ -63,29 +129,89 @@ sub thread_mbox { my ($ctx, $srch, $sfx) = @_; eval { require IO::Compress::Gzip }; return sub { need_gzip(@_) } if $@; - - my $cb = sub { $srch->get_thread($ctx->{mid}, @_) }; - # http://www.iana.org/assignments/media-types/application/gzip - [200, ['Content-Type' => 'application/gzip'], - PublicInbox::MboxGz->new($ctx, $cb) ]; + my $mid = $ctx->{mid}; + my $msgs = $srch->get_thread($mid, 0); + return [404, [qw(Content-Type text/plain)], []] if !@$msgs; + my $prev = $msgs->[-1]->{num}; + my $i = 0; + my $cb = sub { + while (1) { + if (my $smsg = $msgs->[$i++]) { + return $smsg; + } + # refill result set + $msgs = $srch->get_thread($mid, $prev); + return unless @$msgs; + $prev = $msgs->[-1]->{num}; + $i = 0; + } + }; + PublicInbox::MboxGz->response($ctx, $cb, $msgs->[0]->subject); } sub emit_range { my ($ctx, $range) = @_; - eval { require IO::Compress::Gzip }; - return sub { need_gzip(@_) } if $@; my $query; if ($range eq 'all') { # TODO: YYYY[-MM] $query = ''; } else { return [404, [qw(Content-Type text/plain)], []]; } - my $cb = sub { $ctx->{srch}->query($query, @_) }; + mbox_all($ctx, $query); +} - # http://www.iana.org/assignments/media-types/application/gzip - [200, [qw(Content-Type application/gzip)], - PublicInbox::MboxGz->new($ctx, $cb) ]; +sub mbox_all_ids { + my ($ctx) = @_; + my $prev = 0; + my $ids = $ctx->{-inbox}->mm->ids_after(\$prev) or return + [404, [qw(Content-Type text/plain)], ["No results found\n"]]; + my $i = 0; + my $over = $ctx->{srch}->{over_ro}; + my $cb = sub { + do { + while ((my $num = $ids->[$i++])) { + my $smsg = $over->get_art($num) or next; + return $smsg; + } + $ids = $ctx->{-inbox}->mm->ids_after(\$prev); + $i = 0; + } while (@$ids); + undef; + }; + return PublicInbox::MboxGz->response($ctx, $cb, 'all'); +} + +sub mbox_all { + my ($ctx, $query) = @_; + + eval { require IO::Compress::Gzip }; + return sub { need_gzip(@_) } if $@; + return mbox_all_ids($ctx) if $query eq ''; + my $opts = { mset => 2 }; + my $srch = $ctx->{srch}; + my $mset = $srch->query($query, $opts); + $opts->{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); } sub need_gzip { @@ -105,6 +231,7 @@ EOF package PublicInbox::MboxGz; use strict; use warnings; +use PublicInbox::Hval qw/to_filename/; sub new { my ($class, $ctx, $cb) = @_; @@ -114,39 +241,42 @@ sub new { gz => IO::Compress::Gzip->new(\$buf, Time => 0), cb => $cb, ctx => $ctx, - msgs => [], - opts => { asc => 1, offset => 0 }, }, $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 $res; - my $ibx = $ctx->{-inbox}; - my $gz = $self->{gz}; - do { - 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)); - 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 ''; + while (my $smsg = $self->{cb}->()) { + my $msg = $ctx->{-inbox}->msg_by_smsg($smsg) or next; + $msg = Email::Simple->new($msg); + $self->{gz}->write(PublicInbox::Mbox::msg_str($ctx, $msg, + $smsg->{mid})); + my $bref = $self->{buf}; + if (length($$bref) >= 8192) { + my $ret = $$bref; # copy :< + ${$self->{buf}} = ''; + return $ret; } - $res = $self->{cb}->($self->{opts}); - $self->{msgs} = $res->{msgs}; - $res = scalar @{$self->{msgs}}; - $self->{opts}->{offset} += $res; - } while ($res); - $gz->close; + + # 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}}; }