-# Copyright (C) 2016-2020 all contributors <meta@public-inbox.org>
+# Copyright (C) 2016-2021 all contributors <meta@public-inbox.org>
# License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
#
-# Atom body stream for which yields getline+close methods
-# 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)
+# Atom body stream for HTTP responses
+# See PublicInbox::GzipFilter for details.
package PublicInbox::WwwAtomStream;
use strict;
-use warnings;
+use parent 'PublicInbox::GzipFilter';
use POSIX qw(strftime);
use Digest::SHA qw(sha1_hex);
use PublicInbox::Address;
use PublicInbox::Hval qw(ascii_html mid_href);
use PublicInbox::MsgTime qw(msg_timestamp);
-use PublicInbox::GzipFilter qw(gzf_maybe);
-
-# called by PSGI server after getline:
-sub close {}
sub new {
my ($class, $ctx, $cb) = @_;
- $ctx->{feed_base_url} = $ctx->{-inbox}->base_url($ctx->{env});
- bless { cb => $cb || \&close, ctx => $ctx, emit_header => 1 }, $class;
+ $ctx->{feed_base_url} = $ctx->{ibx}->base_url($ctx->{env});
+ $ctx->{cb} = $cb || \&PublicInbox::GzipFilter::close;
+ $ctx->{emit_header} = 1;
+ bless $ctx, $class;
+}
+
+sub async_next ($) {
+ my ($http) = @_; # PublicInbox::HTTP
+ my $ctx = $http->{forward} or return;
+ eval {
+ if (my $smsg = $ctx->{smsg} = $ctx->{cb}->($ctx)) {
+ $ctx->smsg_blob($smsg);
+ } else {
+ $ctx->write('</feed>');
+ $ctx->close;
+ }
+ };
+ warn "E: $@" if $@;
+}
+
+sub async_eml { # for async_blob_cb
+ my ($ctx, $eml) = @_;
+ my $smsg = delete $ctx->{smsg};
+ $ctx->write(feed_entry($ctx, $smsg, $eml));
}
sub response {
my ($class, $ctx, $code, $cb) = @_;
- my $h = [ 'Content-Type' => 'application/atom+xml' ];
- my $self = $class->new($ctx, $cb);
- $self->{gzf} = gzf_maybe($h, $ctx->{env});
- [ $code, $h, $self ]
+ my $res_hdr = [ 'Content-Type' => 'application/atom+xml' ];
+ $class->new($ctx, $cb);
+ $ctx->psgi_response($code, $res_hdr);
}
# called once for each message by PSGI server
sub getline {
my ($self) = @_;
- my $buf = do {
- if (my $middle = $self->{cb}) {
- my $smsg = $middle->($self->{ctx});
- feed_entry($self, $smsg) if $smsg;
- }
- } // (delete($self->{cb}) ? '</feed>' : undef);
-
- # gzf may be GzipFilter, `undef' or `0'
- my $gzf = $self->{gzf} or return $buf;
-
- return $gzf->translate($buf) if defined $buf;
- $self->{gzf} = 0; # next call to ->getline returns $buf (== undef)
- $gzf->translate(undef);
+ my $cb = $self->{cb} or return;
+ while (my $smsg = $cb->($self)) {
+ my $eml = $self->{ibx}->smsg_eml($smsg) or next;
+ return $self->translate(feed_entry($self, $smsg, $eml));
+ }
+ delete $self->{cb};
+ $self->zflush('</feed>');
}
# private
sub atom_header {
my ($ctx, $title) = @_;
- my $ibx = $ctx->{-inbox};
+ my $ibx = $ctx->{ibx};
my $base_url = $ctx->{feed_base_url};
my $search_q = $ctx->{search_query};
my $self_url = $base_url;
} else {
$title = title_tag($ibx->description);
$self_url .= 'new.atom';
- $page_id = "mailto:$ibx->{-primary_address}";
+ if (defined(my $addr = $ibx->{-primary_address})) {
+ $page_id = "mailto:$addr";
+ } else {
+ $page_id = to_uuid($self_url);
+ }
}
- my $mtime = (stat($ibx->{inboxdir}))[9] || time;
-
qq(<?xml version="1.0" encoding="us-ascii"?>\n) .
qq(<feed\nxmlns="http://www.w3.org/2005/Atom"\n) .
qq(xmlns:thr="http://purl.org/syndication/thread/1.0">) .
qq(\nhref="$base_url"/>) .
qq(<link\nrel="self"\nhref="$self_url"/>) .
qq(<id>$page_id</id>) .
- feed_updated($mtime);
+ feed_updated($ibx->modified);
}
# returns undef or string
sub feed_entry {
- my ($self, $smsg) = @_;
- my $ctx = $self->{ctx};
- my $eml = $ctx->{-inbox}->smsg_eml($smsg) or return '';
- my $hdr = $eml->header_obj;
+ my ($ctx, $smsg, $eml) = @_;
my $mid = $smsg->{mid};
- my $irt = PublicInbox::View::in_reply_to($hdr);
+ my $irt = PublicInbox::View::in_reply_to($eml);
my $uuid = to_uuid($mid);
my $base = $ctx->{feed_base_url};
if (defined $irt) {
$irt = '';
}
my $href = $base . mid_href($mid) . '/';
- my $updated = feed_updated(msg_timestamp($hdr));
+ my $updated = feed_updated(msg_timestamp($eml));
- my $title = $hdr->header('Subject');
+ my $title = $eml->header('Subject');
$title = '(no subject)' unless defined $title && $title ne '';
$title = title_tag($title);
- my $from = $hdr->header('From') or return;
+ my $from = $eml->header('From') // $eml->header('Sender') //
+ $ctx->{ibx}->{-primary_address};
my ($email) = PublicInbox::Address::emails($from);
- my $name = join(', ',PublicInbox::Address::names($from));
- $name = ascii_html($name);
- $email = ascii_html($email);
+ my $name = ascii_html(join(', ', PublicInbox::Address::names($from)));
+ $email = ascii_html($email // $ctx->{ibx}->{-primary_address});
- my $s = '';
- if (delete $self->{emit_header}) {
- $s .= atom_header($ctx, $title);
- }
+ my $s = delete($ctx->{emit_header}) ? atom_header($ctx, $title) : '';
$s .= "<entry><author><name>$name</name><email>$email</email>" .
"</author>$title$updated" .
qq(<link\nhref="$href"/>).
}
sub feed_updated {
- '<updated>' . strftime('%Y-%m-%dT%H:%M:%SZ', gmtime(@_)) . '</updated>';
+ my ($t) = @_;
+ '<updated>' . strftime('%Y-%m-%dT%H:%M:%SZ', gmtime($t)) . '</updated>';
}
1;