# 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
+# Streaming (via getline) interface for formatting messages as an mboxrd.
+# Used by the PSGI web interface.
+#
+# public-inbox-httpd favors "getline" response bodies to take a
+# "pull"-based approach to feeding slow clients (as opposed to a
+# more common "push" model)
package PublicInbox::Mbox;
use strict;
use warnings;
# called by PSGI server as body response
sub getline {
my ($more) = @_; # self
- my ($ctx, $id, $prev, $next, $cur) = @$more;
- if ($cur) { # first
+ my ($ctx, $id, $prev, $next, $cur, $mref) = @$more;
+ if ($mref) { # first
pop @$more;
- return msg_str($ctx, $cur);
+ pop @$more;
+ return msg_str($ctx, $cur, $mref);
}
$cur = $next or return;
my $ibx = $ctx->{-inbox};
- $next = $ibx->search->next_by_mid($ctx->{mid}, \$id, \$prev);
+ $next = $ibx->over->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));
+ $mref = $ibx->msg_by_smsg($cur) or return;
+ msg_str($ctx, Email::Simple->new($mref), $mref);
}
sub close {} # noop
my ($ctx) = @_;
my $mid = $ctx->{mid};
my $ibx = $ctx->{-inbox};
- my $first;
- my $more;
- if (my $srch = $ibx->search) {
+ my ($first, $mref, $more);
+ if (my $over = $ibx->over) {
my ($id, $prev);
- my $smsg = $srch->next_by_mid($mid, \$id, \$prev) or return;
- my $mref = $ibx->msg_by_smsg($smsg) or return;
+ my $smsg = $over->next_by_mid($mid, \$id, \$prev) or return;
+ $mref = $ibx->msg_by_smsg($smsg) or return;
$first = Email::Simple->new($mref);
- my $next = $srch->next_by_mid($mid, \$id, \$prev);
+ my $next = $over->next_by_mid($mid, \$id, \$prev);
# $more is for ->getline
- $more = [ $ctx, $id, $prev, $next, $first ] if $next;
+ $more = [ $ctx, $id, $prev, $next, $first, $mref ] if $next;
} else {
- my $mref = $ibx->msg_by_mid($mid) or return;
+ $mref = $ibx->msg_by_mid($mid) or return;
$first = Email::Simple->new($mref);
}
return unless defined $first;
$fn .= '.txt';
}
push @hdr, 'Content-Disposition', "inline; filename=$fn";
- [ 200, \@hdr, $more ? mb_stream($more) : [ msg_str($ctx, $first) ] ];
+ [ 200, \@hdr,
+ $more ? mb_stream($more) : [ msg_str($ctx, $first, $mref) ] ];
}
sub msg_str {
- my ($ctx, $simple, $mid) = @_; # Email::Simple object
+ my ($ctx, $simple, $mref, $mid) = @_; # simple - Email::Simple object
my $header_obj = $simple->header_obj;
# drop potentially confusing headers, ssoma already should've dropped
'List-Archive', "<$base>",
'List-Post', "<mailto:$ibx->{-primary_address}>",
);
- my $crlf = $simple->crlf;
+ my $crlf = $header_obj->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) {
# mboxrd quoting style
# ref: http://www.qmail.org/man/man5/mbox.html
- my $body = $simple->body;
- $body =~ s/^(>*From )/>$1/gm;
- $buf .= $body;
+ $$mref =~ s/^(>*From )/>$1/gm;
+ $buf .= $$mref;
$buf .= "\n";
}
sub thread_mbox {
- my ($ctx, $srch, $sfx) = @_;
+ my ($ctx, $over, $sfx) = @_;
eval { require IO::Compress::Gzip };
return sub { need_gzip(@_) } if $@;
my $mid = $ctx->{mid};
- my $msgs = $srch->get_thread($mid, 0);
+ my $msgs = $over->get_thread($mid, {});
return [404, [qw(Content-Type text/plain)], []] if !@$msgs;
- my $prev = $msgs->[-1]->{num};
+ my $prev = $msgs->[-1];
my $i = 0;
my $cb = sub {
while (1) {
return $smsg;
}
# refill result set
- $msgs = $srch->get_thread($mid, $prev);
+ $msgs = $over->get_thread($mid, $prev);
return unless @$msgs;
- $prev = $msgs->[-1]->{num};
+ $prev = $msgs->[-1];
$i = 0;
}
};
sub mbox_all_ids {
my ($ctx) = @_;
my $prev = 0;
- my $ids = $ctx->{-inbox}->mm->ids_after(\$prev) or return
+ my $ibx = $ctx->{-inbox};
+ my $ids = $ibx->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 $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 = $ctx->{-inbox}->mm->ids_after(\$prev);
+ $ids = $ibx->mm->ids_after(\$prev);
$i = 0;
} while (@$ids);
undef;
return sub { need_gzip(@_) } if $@;
return mbox_all_ids($ctx) if $query eq '';
my $opts = { mset => 2 };
- my $srch = $ctx->{srch};
+ my $srch = $ctx->{-inbox}->search or
+ return PublicInbox::WWW::need($ctx, 'Search');;
my $mset = $srch->query($query, $opts);
$opts->{offset} = $mset->size or
return [404, [qw(Content-Type text/plain)],
my ($self) = @_;
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,
+ my $mref = $ctx->{-inbox}->msg_by_smsg($smsg) or next;
+ my $s = Email::Simple->new($mref);
+ $self->{gz}->write(PublicInbox::Mbox::msg_str($ctx, $s, $mref,
$smsg->{mid}));
my $bref = $self->{buf};
if (length($$bref) >= 8192) {