-# Copyright (C) 2015 all contributors <meta@public-inbox.org>
-# License: AGPLv3 or later (https://www.gnu.org/licenses/agpl-3.0.txt)
-# Streaming interface for formatting messages as an mboxrd
+# Copyright (C) 2015-2018 all contributors <meta@public-inbox.org>
+# License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
+
+# Streaming interface for formatting messages as an mboxrd.
+# Used by the web interface
package PublicInbox::Mbox;
use strict;
use warnings;
-use PublicInbox::MID qw/mid2path/;
-require Email::Simple;
+use PublicInbox::MID qw/mid_clean mid_escape/;
+use PublicInbox::Hval qw/to_filename/;
+use Email::Simple;
+use Email::MIME::Encode;
-sub thread_mbox {
- my ($ctx, $srch, $sfx) = @_;
- sub {
- my ($response) = @_; # Plack callback
- emit_mbox($response, $ctx, $srch, $sfx);
+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';
}
-sub emit1 {
- my $simple = Email::Simple->new(pop);
- sub {
- my ($response) = @_;
- # single message should be easily renderable in browsers
- my $fh = $response->([200, ['Content-Type'=>'text/plain']]);
- emit_msg($fh, $simple);
- $fh->close;
+# 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 emit_msg {
- my ($fh, $simple) = @_; # Email::Simple object
+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, $mid) = @_; # Email::Simple object
my $header_obj = $simple->header_obj;
# drop potentially confusing headers, ssoma already should've dropped
# Lines and Content-Length
- foreach my $d (qw(Lines Content-Length Status)) {
+ foreach my $d (qw(Lines Bytes Content-Length Status)) {
$header_obj->header_set($d);
}
-
- my $buf = $header_obj->as_string;
- unless ($buf =~ /\AFrom /) {
- $fh->write("From mboxrd\@z Thu Jan 1 00:00:00 1970\n");
+ my $ibx = $ctx->{-inbox};
+ my $base = $ibx->base_url($ctx->{env});
+ $mid = $ctx->{mid} unless defined $mid;
+ $mid = mid_escape($mid);
+ my @append = (
+ 'Archived-At', "<$base$mid/>",
+ 'List-Archive', "<$base>",
+ 'List-Post', "<mailto:$ibx->{-primary_address}>",
+ );
+ my $crlf = $simple->crlf;
+ my $buf = "From mboxrd\@z Thu Jan 1 00:00:00 1970\n" .
+ $header_obj->as_string;
+ 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;
}
- $fh->write($buf .= $simple->crlf);
-
- $buf = $simple->body;
- $simple->body_set('');
+ $buf .= $crlf;
# mboxrd quoting style
# ref: http://www.qmail.org/man/man5/mbox.html
- $buf =~ s/^(>*From )/>$1/gm;
-
- $buf .= "\n" unless $buf =~ /\n\z/s;
+ my $body = $simple->body;
+ $body =~ s/^(>*From )/>$1/gm;
+ $buf .= $body;
+ $buf .= "\n";
+}
- $fh->write($buf);
+sub thread_mbox {
+ my ($ctx, $srch, $sfx) = @_;
+ eval { require IO::Compress::Gzip };
+ return sub { need_gzip(@_) } if $@;
+ 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_mbox {
- my ($response, $ctx, $srch, $sfx) = @_;
- my $type = 'mbox';
- if ($sfx) {
- eval { require IO::Compress::Gzip };
- return need_gzip($response) if $@;
- $type = 'gzip';
- }
+sub emit_range {
+ my ($ctx, $range) = @_;
- # http://www.iana.org/assignments/media-types/application/gzip
- # http://www.iana.org/assignments/media-types/application/mbox
- my $fh = $response->([200, ['Content-Type' => "application/$type"]]);
- $fh = PublicInbox::MboxGz->new($fh) if $sfx;
+ my $query;
+ if ($range eq 'all') { # TODO: YYYY[-MM]
+ $query = '';
+ } else {
+ return [404, [qw(Content-Type text/plain)], []];
+ }
+ mbox_all($ctx, $query);
+}
- require PublicInbox::GitCatFile;
- my $mid = $ctx->{mid};
- my $git = PublicInbox::GitCatFile->new($ctx->{git_dir});
- my %opts = (offset => 0);
- my $nr;
- do {
- my $res = $srch->get_thread($mid, \%opts);
- my $msgs = $res->{msgs};
- $nr = scalar @$msgs;
- while (defined(my $smsg = shift @$msgs)) {
- my $msg = eval {
- my $p = 'HEAD:'.mid2path($smsg->mid);
- Email::Simple->new($git->cat_file($p));
- };
- emit_msg($fh, $msg) if $msg;
- }
+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');
+}
- $opts{offset} += $nr;
- } while ($nr > 0);
+sub mbox_all {
+ my ($ctx, $query) = @_;
- $fh->close;
+ 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 {
1;
-# fh may not be a proper IO, so we wrap the write and close methods
-# to prevent IO::Compress::Gzip from complaining
package PublicInbox::MboxGz;
use strict;
use warnings;
-use fields qw(gz fh buf);
+use PublicInbox::Hval qw/to_filename/;
sub new {
- my ($class, $fh) = @_;
- my $self = fields::new($class);
- my $buf;
- $self->{buf} = \$buf;
- $self->{gz} = IO::Compress::Gzip->new(\$buf);
- $self->{fh} = $fh;
- $self;
+ my ($class, $ctx, $cb) = @_;
+ my $buf = '';
+ bless {
+ buf => \$buf,
+ gz => IO::Compress::Gzip->new(\$buf, Time => 0),
+ cb => $cb,
+ ctx => $ctx,
+ }, $class;
}
-sub _flush_buf {
- my ($self) = @_;
- if (defined ${$self->{buf}}) {
- $self->{fh}->write(${$self->{buf}});
- ${$self->{buf}} = undef;
+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 ];
}
-sub write {
- $_[0]->{gz}->write($_[1]);
- _flush_buf($_[0]);
-}
-
-sub close {
+# called by Plack::Util::foreach or similar
+sub getline {
my ($self) = @_;
- $self->{gz}->close;
- _flush_buf($self);
- $self->{fh}->close;
+ my $ctx = $self->{ctx} or 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;
+ }
+
+ # 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}};
}
+sub close {} # noop
+
1;