use PublicInbox::Hval qw/to_filename/;
use PublicInbox::Smsg;
use PublicInbox::Eml;
-
-sub subject_fn ($) {
- my ($hdr) = @_;
- my $fn = $hdr->header_str('Subject');
- return 'no-subject' if (!defined($fn) || $fn eq '');
-
- $fn =~ s/^re:\s+//i;
- $fn eq '' ? 'no-subject' : to_filename($fn);
-}
-
-sub mb_stream {
- my ($more) = @_;
- bless $more, 'PublicInbox::Mbox';
-}
+use PublicInbox::GitAsyncCat;
+use PublicInbox::GzipFilter qw(gzf_maybe);
# 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 ($more) = @_; # self
- my ($ctx, $id, $prev, $next, $mref, $hdr) = @$more;
- if ($hdr) { # first message hits this, only
- pop @$more; # $hdr
- pop @$more; # $mref
- return msg_hdr($ctx, $hdr) . msg_body($$mref);
- }
- my $cur = $next or return;
+ my ($ctx) = @_; # ctx
+ my $smsg = $ctx->{smsg} or return;
my $ibx = $ctx->{-inbox};
- $next = $ibx->over->next_by_mid($ctx->{mid}, \$id, \$prev);
- $mref = $ibx->msg_by_smsg($cur) or return;
- $hdr = PublicInbox::Eml->new($mref)->header_obj;
- @$more = ($ctx, $id, $prev, $next); # $next may be undef, here
- msg_hdr($ctx, $hdr) . msg_body($$mref);
+ my $eml = $ibx->smsg_eml($smsg) or return;
+ $ctx->{smsg} = $ibx->over->next_by_mid($ctx->{mid}, @{$ctx->{id_prev}});
+ msg_hdr($ctx, $eml, $smsg->{mid}) . msg_body($eml);
}
-sub close {} # noop
+sub close { !!delete($_[0]->{http_out}) }
-# /$INBOX/$MESSAGE_ID/raw
-sub emit_raw {
+sub mbox_async_step ($) { # public-inbox-httpd-only
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;
- $mref = $ibx->msg_by_smsg($smsg) or return;
- $next = $over->next_by_mid($mid, \$id, \$prev);
+ if (my $smsg = $ctx->{smsg}) {
+ git_async_cat($ctx->{-inbox}->git, $smsg->{blob},
+ \&mbox_blob_cb, $ctx);
+ } elsif (my $out = delete $ctx->{http_out}) {
+ $out->close;
+ }
+}
+
+# called by PublicInbox::DS::write
+sub mbox_async_next {
+ my ($http) = @_; # PublicInbox::HTTP
+ my $ctx = $http->{forward} or return; # client aborted
+ eval {
+ $ctx->{smsg} = $ctx->{-inbox}->over->next_by_mid(
+ $ctx->{mid}, @{$ctx->{id_prev}});
+ mbox_async_step($ctx);
+ };
+}
+
+# this is public-inbox-httpd-specific
+sub mbox_blob_cb { # git->cat_async callback
+ my ($bref, $oid, $type, $size, $ctx) = @_;
+ my $http = $ctx->{env}->{'psgix.io'} or return; # client abort
+ my $smsg = delete $ctx->{smsg} or die 'BUG: no smsg';
+ if (!defined($oid)) {
+ # it's possible to have TOCTOU if an admin runs
+ # public-inbox-(edit|purge), just move onto the next message
+ return $http->next_step(\&mbox_async_next);
} else {
- $mref = $ibx->msg_by_mid($mid) or return;
+ $smsg->{blob} eq $oid or die "BUG: $smsg->{blob} != $oid";
}
- my $hdr = PublicInbox::Eml->new($mref)->header_obj;
- $more = [ $ctx, $id, $prev, $next, $mref, $hdr ]; # for ->getline
- my $fn = subject_fn($hdr);
+ my $eml = PublicInbox::Eml->new($bref);
+ $ctx->{http_out}->write(msg_hdr($ctx, $eml, $smsg->{mid}));
+ $ctx->{http_out}->write(msg_body($eml));
+ $http->next_step(\&mbox_async_next);
+}
+
+sub res_hdr ($$) {
+ my ($ctx, $subject) = @_;
+ my $fn = $subject // 'no-subject';
+ $fn =~ s/^re:\s+//i;
+ $fn = $fn eq '' ? 'no-subject' : to_filename($fn);
my @hdr = ('Content-Type');
- if ($ibx->{obfuscate}) {
+ if ($ctx->{-inbox}->{obfuscate}) {
# obfuscation is stupid, but maybe scrapers are, too...
push @hdr, 'application/mbox';
$fn .= '.mbox';
$fn .= '.txt';
}
push @hdr, 'Content-Disposition', "inline; filename=$fn";
- [ 200, \@hdr, mb_stream($more) ];
+ \@hdr;
+}
+
+# for rare cases where v1 inboxes aren't indexed w/ ->over at all
+sub no_over_raw ($) {
+ my ($ctx) = @_;
+ my $mref = $ctx->{-inbox}->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) ] ]
+}
+
+sub stream_raw { # MboxGz response callback
+ my ($ctx) = @_;
+ delete($ctx->{smsg}) //
+ $ctx->{-inbox}->over->next_by_mid($ctx->{mid},
+ @{$ctx->{id_prev}});
+}
+
+# /$INBOX/$MESSAGE_ID/raw
+sub emit_raw {
+ my ($ctx) = @_;
+ my $env = $ctx->{env};
+ $ctx->{base_url} = $ctx->{-inbox}->base_url($env);
+ my $over = $ctx->{-inbox}->over or return no_over_raw($ctx);
+ my ($id, $prev);
+ my $smsg = $over->next_by_mid($ctx->{mid}, \$id, \$prev) or return;
+ $ctx->{smsg} = $smsg;
+ my $res_hdr = res_hdr($ctx, $smsg->{subject});
+ $ctx->{id_prev} = [ \$id, \$prev ];
+
+ if (my $gzf = gzf_maybe($res_hdr, $env)) {
+ $ctx->{gz} = delete $gzf->{gz};
+ require PublicInbox::MboxGz;
+ PublicInbox::MboxGz::response($ctx, \&stream_raw, $res_hdr);
+ } elsif ($env->{'pi-httpd.async'}) {
+ sub {
+ my ($wcb) = @_; # -httpd provided write callback
+ $ctx->{http_out} = $wcb->([200, $res_hdr]);
+ $ctx->{env}->{'psgix.io'}->{forward} = $ctx;
+ bless $ctx, __PACKAGE__;
+ mbox_async_step($ctx); # start stepping
+ };
+ } else { # generic PSGI code path
+ bless $ctx, __PACKAGE__; # respond to ->getline
+ [ 200, $res_hdr, $ctx ];
+ }
}
sub msg_hdr ($$;$) {
- my ($ctx, $header_obj, $mid) = @_;
+ my ($ctx, $eml, $mid) = @_;
+ my $header_obj = $eml->header_obj;
# drop potentially confusing headers, ssoma already should've dropped
# Lines and Content-Length
}
sub msg_body ($) {
+ my $bdy = $_[0]->{bdy} // return "\n";
# mboxrd quoting style
# 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";
+ $$bdy =~ s/^(>*From )/>$1/gm;
+ $$bdy .= "\n";
}
sub thread_cb {
sub thread_mbox {
my ($ctx, $over, $sfx) = @_;
- require PublicInbox::MboxGz;
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
- PublicInbox::MboxGz->response($ctx, \&thread_cb, $msgs->[0]->{subject});
+ require PublicInbox::MboxGz;
+ PublicInbox::MboxGz::mbox_gz($ctx, \&thread_cb, $msgs->[0]->{subject});
}
sub emit_range {
return PublicInbox::WWW::need($ctx, 'Overview');
$ctx->{ids} = $ids;
$ctx->{prev} = $prev;
- return PublicInbox::MboxGz->response($ctx, \&all_ids_cb, 'all');
+ require PublicInbox::MboxGz;
+ PublicInbox::MboxGz::mbox_gz($ctx, \&all_ids_cb, 'all');
}
sub results_cb {
sub mbox_all {
my ($ctx, $query) = @_;
- require PublicInbox::MboxGz;
return mbox_all_ids($ctx) if $query eq '';
my $qopts = $ctx->{qopts} = { mset => 2 };
my $srch = $ctx->{srch} = $ctx->{-inbox}->search or
["No results found\n"]];
$ctx->{iter} = 0;
$ctx->{query} = $query;
- PublicInbox::MboxGz->response($ctx, \&results_cb, 'results-'.$query);
+ require PublicInbox::MboxGz;
+ PublicInbox::MboxGz::mbox_gz($ctx, \&results_cb, 'results-'.$query);
}
1;
if (!defined($oid)) {
# it's possible to have TOCTOU if an admin runs
# public-inbox-(edit|purge), just move onto the next message
- return $http->next_step(\&async_next);
+ return $http->next_step(\&mboxgz_async_next);
} else {
$smsg->{blob} eq $oid or die "BUG: $smsg->{blob} != $oid";
}
- $self->zmore(msg_hdr($self,
- PublicInbox::Eml->new($bref)->header_obj,
- $smsg->{mid}));
+ my $eml = PublicInbox::Eml->new($bref);
+ $self->zmore(msg_hdr($self, $eml, $smsg->{mid}));
# PublicInbox::HTTP::{Chunked,Identity}::write
- $self->{http_out}->write($self->translate(msg_body($$bref)));
+ $self->{http_out}->write($self->translate(msg_body($eml)));
- $http->next_step(\&async_next);
+ $http->next_step(\&mboxgz_async_next);
}
# this is public-inbox-httpd-specific
-sub async_step ($) {
+sub mboxgz_async_step ($) {
my ($self) = @_;
if (my $smsg = $self->{smsg} = $self->{cb}->($self)) {
git_async_cat($self->{-inbox}->git, $smsg->{blob},
}
# called by PublicInbox::DS::write
-sub async_next {
+sub mboxgz_async_next {
my ($http) = @_; # PublicInbox::HTTP
- async_step($http->{forward});
+ mboxgz_async_step($http->{forward});
}
# called by PublicInbox::HTTP::close, or any other PSGI server
sub close { !!delete($_[0]->{http_out}) }
sub response {
- my ($class, $self, $cb, $fn) = @_;
- $self->{base_url} = $self->{-inbox}->base_url($self->{env});
+ my ($self, $cb, $res_hdr) = @_;
$self->{cb} = $cb;
- $self->{gz} = PublicInbox::GzipFilter::gzip_or_die();
- bless $self, $class;
- # http://www.iana.org/assignments/media-types/application/gzip
- $fn = defined($fn) && $fn ne '' ? to_filename($fn) : 'no-subject';
- my $h = [ qw(Content-Type application/gzip),
- 'Content-Disposition', "inline; filename=$fn.mbox.gz" ];
+ bless $self, __PACKAGE__;
if ($self->{env}->{'pi-httpd.async'}) {
sub {
my ($wcb) = @_; # -httpd provided write callback
- $self->{http_out} = $wcb->([200, $h]);
+ $self->{http_out} = $wcb->([200, $res_hdr]);
$self->{env}->{'psgix.io'}->{forward} = $self;
- async_step($self); # start stepping
+ mboxgz_async_step($self); # start stepping
};
} else { # generic PSGI
- [ 200, $h, $self ];
+ [ 200, $res_hdr, $self ];
}
}
+sub mbox_gz {
+ my ($self, $cb, $fn) = @_;
+ $self->{base_url} = $self->{-inbox}->base_url($self->{env});
+ $self->{gz} = PublicInbox::GzipFilter::gzip_or_die();
+ $fn = to_filename($fn // 'no-subject');
+ $fn = 'no-subject' if $fn eq '';
+ # http://www.iana.org/assignments/media-types/application/gzip
+ response($self, $cb, [ qw(Content-Type application/gzip),
+ 'Content-Disposition', "inline; filename=$fn.mbox.gz" ]);
+}
+
# called by Plack::Util::foreach or similar (generic PSGI)
sub getline {
my ($self) = @_;
my $cb = $self->{cb} or return;
while (my $smsg = $cb->($self)) {
- my $mref = $self->{-inbox}->msg_by_smsg($smsg) or next;
- my $h = PublicInbox::Eml->new($mref)->header_obj;
- $self->zmore(msg_hdr($self, $h, $smsg->{mid}));
- return $self->translate(msg_body($$mref));
+ my $eml = $self->{-inbox}->smsg_eml($smsg) or next;
+ $self->zmore(msg_hdr($self, $eml, $smsg->{mid}));
+ return $self->translate(msg_body($eml));
}
# signal that we're done and can return undef next call:
delete $self->{cb};
my $third = $mids->[-1];
$im->done;
-test_psgi(sub { $www->call(@_) }, sub {
+my $client = sub {
my ($cb) = @_;
$res = $cb->(GET("/v2test/$third/raw"));
$raw = $res->content;
SKIP: {
eval { require IO::Uncompress::Gunzip };
- skip 'IO::Uncompress::Gunzip missing', 4 if $@;
+ skip 'IO::Uncompress::Gunzip missing', 6 if $@;
+ my ($in, $out, $status);
+ my $req = GET('/v2test/a-mid@b/raw');
+ $req->header('Accept-Encoding' => 'gzip');
+ $res = $cb->($req);
+ is($res->header('Content-Encoding'), 'gzip', 'gzip encoding');
+ $in = $res->content;
+ IO::Uncompress::Gunzip::gunzip(\$in => \$out);
+ is($out, $raw, 'gzip response matches');
$res = $cb->(GET('/v2test/a-mid@b/t.mbox.gz'));
- my $out;
- my $in = $res->content;
- my $status = IO::Uncompress::Gunzip::gunzip(\$in => \$out);
+ $in = $res->content;
+ $status = IO::Uncompress::Gunzip::gunzip(\$in => \$out);
unlike($out, qr/^From oldbug/sm, 'buggy "From_" line omitted');
like($out, qr/^hello world$/m, 'got first in t.mbox.gz');
like($out, qr/^hello world!$/m, 'got second in t.mbox.gz');
like($raw, qr!>\Q$mid\E</a>!s, "Message-ID $mid shown");
}
like($raw, qr/\b3\+ messages\b/, 'thread overview shown');
+};
+test_psgi(sub { $www->call(@_) }, $client);
+SKIP: {
+ require_mods(qw(Plack::Test::ExternalServer), 37);
+ my $cfgpath = "$inboxdir/$$.config";
+ open my $fh, '>', $cfgpath or BAIL_OUT $!;
+ print $fh <<EOF or BAIL_OUT $!;
+[publicinbox "v2test"]
+ inboxdir = $inboxdir
+ address = test\@example.com
+EOF
+ close $fh or BAIL_OUT $!;
+ my $env = { PI_CONFIG => $cfgpath };
+ my $sock = tcp_server() or die;
+ my ($out, $err) = map { "$inboxdir/std$_.log" } qw(out err);
+ my $cmd = [ qw(-httpd -W0), "--stdout=$out", "--stderr=$err" ];
+ my $td = start_script($cmd, $env, { 3 => $sock });
+ my ($h, $p) = ($sock->sockhost, $sock->sockport);
+ local $ENV{PLACK_TEST_EXTERNALSERVER_URI} = "http://$h:$p";
+ Plack::Test::ExternalServer::test_psgi(client => $client);
+ $td->join('TERM');
+ open $fh, '<', $err or BAIL_OUT $!;
+ is(do { local $/; <$fh> }, '', 'no errors');
+};
+
+test_psgi(sub { $www->call(@_) }, sub {
+ my ($cb) = @_;
my $exp = [ qw(<a-mid@b> <reuse@mid>) ];
$mime->header_set('Message-Id', @$exp);
$mime->header_set('Subject', '4th dupe');
$res = $cb->(GET('/v2test/reuse@mid/T/'));
$raw = $res->content;
like($raw, qr/\b4\+ messages\b/, 'thread overview shown with /T/');
- @over = ($raw =~ m/^\d{4}-\d+-\d+\s+\d+:\d+ (.+)$/gm);
+ my @over = ($raw =~ m/^\d{4}-\d+-\d+\s+\d+:\d+ (.+)$/gm);
is_deeply(\@over, [ '<a', '` <a', '` <a', '` <a' ],
'duplicate messages share the same root');