#
# Used for generating Atom feeds for web-accessible mailing list archives.
package PublicInbox::Feed;
use strict;
use warnings;
-use Email::MIME;
-use Date::Parse qw(strptime);
-use PublicInbox::Hval qw/ascii_html/;
-use PublicInbox::Git;
+use PublicInbox::MIME;
use PublicInbox::View;
-use PublicInbox::MID qw/mid_clean mid2path/;
-use PublicInbox::Address;
-use POSIX qw/strftime/;
-use constant {
- DATEFMT => '%Y-%m-%dT%H:%M:%SZ', # Atom standard
- MAX_PER_PAGE => 25, # this needs to be tunable
-};
+use PublicInbox::WwwAtomStream;
# main function
sub generate {
my ($ctx) = @_;
- sub { emit_atom($_[0], $ctx) };
-}
-
-sub generate_thread_atom {
- my ($ctx) = @_;
- sub { emit_atom_thread($_[0], $ctx) };
-}
-
-sub generate_html_index {
- my ($ctx) = @_;
- sub { emit_html_index($_[0], $ctx) };
-}
-
-# private subs
-
-sub title_tag {
- my ($title) = @_;
- $title =~ tr/\t\n / /s; # squeeze spaces
- # try to avoid the type attribute in title:
- $title = ascii_html($title);
- my $type = index($title, '&') >= 0 ? "\ntype=\"html\"" : '';
- "$title";
-}
-
-sub atom_header {
- my ($feed_opts, $title) = @_;
-
- $title = title_tag($feed_opts->{description}) unless (defined $title);
-
- qq(\n) .
- qq{} .
- qq{$title} .
- qq({url}"/>) .
- qq({atomurl}"/>) .
- qq(mailto:$feed_opts->{id_addr});
-}
+ my @paths;
+ each_recent_blob($ctx, sub { push @paths, $_[0] });
+ return _no_thread() unless @paths;
-sub emit_atom {
- my ($cb, $ctx) = @_;
- my $feed_opts = get_feedopts($ctx);
- my $fh = $cb->([ 200, ['Content-Type' => 'application/atom+xml']]);
- my $max = $ctx->{max} || MAX_PER_PAGE;
- my $x = atom_header($feed_opts);
my $ibx = $ctx->{-inbox};
- each_recent_blob($ctx, sub {
- my ($path, undef, $ts) = @_;
- if (defined $x) {
- $fh->write($x . feed_updated(undef, $ts));
- $x = undef;
+ PublicInbox::WwwAtomStream->response($ctx, 200, sub {
+ while (my $path = shift @paths) {
+ my $mime = do_cat_mail($ibx, $path) or next;
+ return $mime;
}
- my $s = feed_entry($feed_opts, $path, $ibx) or return 0;
- $fh->write($s);
- 1;
});
- end_feed($fh);
}
-sub _no_thread {
- my ($cb) = @_;
- $cb->([404, ['Content-Type', 'text/plain'],
- ["No feed found for thread\n"]]);
-}
-
-sub end_feed {
- my ($fh) = @_;
- $fh->write('');
- $fh->close;
-}
-
-sub emit_atom_thread {
- my ($cb, $ctx) = @_;
- my $res = $ctx->{srch}->get_thread($ctx->{mid});
- return _no_thread($cb) unless $res->{total};
- my $feed_opts = get_feedopts($ctx);
- my $fh = $cb->([200, ['Content-Type' => 'application/atom+xml']]);
-
- my $html_url = $feed_opts->{atomurl} = $ctx->{self_url};
- $html_url =~ s!/t\.atom\z!/!;
- $feed_opts->{url} = $html_url;
- $feed_opts->{emit_header} = 1;
+sub generate_thread_atom {
+ my ($ctx) = @_;
+ my $mid = $ctx->{mid};
+ my $res = $ctx->{srch}->get_thread($mid);
+ return _no_thread() unless $res->{total};
my $ibx = $ctx->{-inbox};
- foreach my $msg (@{$res->{msgs}}) {
- my $s = feed_entry($feed_opts, mid2path($msg->mid), $ibx);
- $fh->write($s) if defined $s;
- }
- end_feed($fh);
-}
-
-sub _html_index_top {
- my ($feed_opts, $srch) = @_;
-
- my $title = ascii_html($feed_opts->{description} || '');
- my $top = "$title (Atom feed)";
- if ($srch) {
- $top = qq{}
- } else {
- $top = '' . $top . "\n";
- }
-
- "$title" .
- "" .
- PublicInbox::Hval::STYLE .
- "$top";
+ my $html_url = $ibx->base_url($ctx->{env});
+ $html_url .= PublicInbox::Hval->new_msgid($mid)->{href};
+ $ctx->{-html_url} = $html_url;
+ my $msgs = $res->{msgs};
+ PublicInbox::WwwAtomStream->response($ctx, 200, sub {
+ while (my $msg = shift @$msgs) {
+ $msg = $ibx->msg_by_smsg($msg) and
+ return PublicInbox::MIME->new($msg);
+ }
+ });
}
-sub emit_html_index {
- my ($res, $ctx) = @_;
- my $feed_opts = get_feedopts($ctx);
- my $fh = $res->([200,['Content-Type'=>'text/html; charset=UTF-8']]);
-
- my $max = $ctx->{max} || MAX_PER_PAGE;
-
- my ($footer, $param, $last);
- my $state = { ctx => $ctx, seen => {}, anchor_idx => 0, fh => $fh };
- my $srch = $ctx->{srch};
- $fh->write(_html_index_top($feed_opts, $srch));
-
+sub generate_html_index {
+ my ($ctx) = @_;
# if the 'r' query parameter is given, it is a legacy permalink
# which we must continue supporting:
my $qp = $ctx->{qp};
- if ($qp && !$qp->{r} && $srch) {
- $state->{srch} = $srch;
- $last = PublicInbox::View::emit_index_topics($state);
- $param = 'o';
- } else {
- $last = emit_index_nosrch($ctx, $state);
- $param = 'r';
+ if ($qp && !$qp->{r} && $ctx->{srch}) {
+ return PublicInbox::View::index_topics($ctx);
}
- $footer = nav_footer($ctx, $last, $feed_opts, $state, $param);
- if ($footer) {
- my $list_footer = $ctx->{footer};
- $footer .= "\n\n" . $list_footer if $list_footer;
- $footer = "
$footer
";
- }
- $fh->write("$footer");
- $fh->close;
+
+ my $env = $ctx->{env};
+ my $url = $ctx->{-inbox}->base_url($env) . 'new.html';
+ my $qs = $env->{QUERY_STRING};
+ $url .= "?$qs" if $qs ne '';
+ [302, [ 'Location', $url, 'Content-Type', 'text/plain'],
+ [ "Redirecting to $url\n" ] ];
}
-sub emit_index_nosrch {
- my ($ctx, $state) = @_;
- my $ibx = $ctx->{-inbox};
+sub new_html {
+ my ($ctx) = @_;
+ my @paths;
my (undef, $last) = each_recent_blob($ctx, sub {
my ($path, $commit, $ts, $u, $subj) = @_;
- $state->{first} ||= $commit;
-
- my $mime = do_cat_mail($ibx, $path) or return 0;
- PublicInbox::View::index_entry($mime, 0, $state);
- 1;
+ $ctx->{first} ||= $commit;
+ push @paths, $path;
});
- $last;
+ if (!@paths) {
+ return [404, ['Content-Type', 'text/plain'],
+ ["No messages, yet\n"] ];
+ }
+ $ctx->{-html_tip} = '';
+ $ctx->{-upfx} = '';
+ $ctx->{-hr} = 1;
+ PublicInbox::WwwStream->response($ctx, 200, sub {
+ while (my $path = shift @paths) {
+ my $m = do_cat_mail($ctx->{-inbox}, $path) or next;
+ my $more = scalar @paths;
+ my $s = PublicInbox::View::index_entry($m, $ctx, $more);
+ return $s;
+ }
+ new_html_footer($ctx, $last);
+ });
+}
+
+# private subs
+
+sub _no_thread () {
+ [404, ['Content-Type', 'text/plain'], ["No feed found for thread\n"]];
}
-sub nav_footer {
- my ($ctx, $last, $feed_opts, $state, $param) = @_;
- my $qp = $ctx->{qp} or return '';
- my $old_r = $qp->{$param};
- my $head = ' ';
+sub new_html_footer {
+ my ($ctx, $last) = @_;
+ my $qp = delete $ctx->{qp} or return;
+ my $old_r = $qp->{r};
+ my $latest = '';
my $next = ' ';
- my $first = $state->{first};
- my $anchor = $state->{anchor_idx};
if ($last) {
- $next = qq!next!;
+ $next = qq!next!;
}
if ($old_r) {
- $head = $ctx->{env}->{PATH_INFO};
- $head = qq!head!;
+ $latest = qq! latest!;
}
- my $atom = "{atomurl}\">Atom feed";
- "page: $next $head $atom";
+ "
page: $next$latest
";
}
sub each_recent_blob {
my ($ctx, $cb) = @_;
- my $max = $ctx->{max} || MAX_PER_PAGE;
+ my $max = $ctx->{-inbox}->{feedmax};
my $hex = '[a-f0-9]';
my $addmsg = qr!^:000000 100644 \S+ \S+ A\t(${hex}{2}/${hex}{38})$!;
my $delmsg = qr!^:100644 000000 \S+ \S+ D\t(${hex}{2}/${hex}{38})$!;
@@ -233,7 +143,7 @@ sub each_recent_blob {
if ($line =~ /$addmsg/o) {
my $add = $1;
next if $deleted{$add}; # optimization-only
- $nr += $cb->($add, $cur_commit, $ts, $u, $subj);
+ $cb->($add, $cur_commit, $ts, $u, $subj) and $nr++;
if ($nr >= $max) {
$last = 1;
last;
@@ -262,89 +172,10 @@ sub each_recent_blob {
($first_commit, $last_commit);
}
-# private functions below
-sub get_feedopts {
- my ($ctx) = @_;
- my $pi_config = $ctx->{pi_config};
- my $inbox = $ctx->{inbox};
- my $obj = $ctx->{-inbox};
- my $cgi = $ctx->{cgi};
- my %rv = ( description => $obj->description );
-
- $rv{address} = $obj->{address};
- $rv{id_addr} = $obj->{-primary_address};
- my $url_base;
- $url_base = $obj->base_url($cgi); # CGI may be undef
- if (my $mid = $ctx->{mid}) { # per-thread feed:
- $rv{atomurl} = "$url_base$mid/t.atom";
- } else {
- $rv{atomurl} = $url_base."new.atom";
- }
- $rv{url} ||= $url_base;
- $rv{midurl} = $url_base;
-
- \%rv;
-}
-
-sub feed_updated {
- my ($date, $ts) = @_;
- my @t = eval { strptime($date) } if defined $date;
- @t = gmtime($ts || time) unless scalar @t;
-
- '' . strftime(DATEFMT, @t) . '';
-}
-
-# returns undef or string
-sub feed_entry {
- my ($feed_opts, $add, $ibx) = @_;
-
- my $mime = do_cat_mail($ibx, $add) or return;
- my $url = $feed_opts->{url};
- my $midurl = $feed_opts->{midurl};
-
- my $header_obj = $mime->header_obj;
- my $mid = $header_obj->header_raw('Message-ID');
- defined $mid or return;
- $mid = PublicInbox::Hval->new_msgid($mid);
- my $href = $midurl.$mid->as_href;
-
- my $date = $header_obj->header('Date');
- my $updated = feed_updated($date);
-
- my $title = $header_obj->header('Subject');
- defined $title or return;
- $title = title_tag($title);
-
- my $from = $header_obj->header('From') or return;
- my ($email) = PublicInbox::Address::emails($from);
- my $name = join(', ',PublicInbox::Address::names($from));
- $name = ascii_html($name);
- $email = ascii_html($email);
-
- my $s = '';
- if (delete $feed_opts->{emit_header}) {
- $s .= atom_header($feed_opts, $title) . $updated;
- }
- $s .= "$name$email" .
- "$title$updated" .
- qq{} .
- qq{} .
- qq(
) .
- PublicInbox::View::multipart_text_as_html($mime, $href) .
- '
';
-
- $add =~ tr!/!!d;
- my $h = '[a-f0-9]';
- my (@uuid5) = ($add =~ m!\A($h{8})($h{4})($h{4})($h{4})($h{12})!o);
- my $id = 'urn:uuid:' . join('-', @uuid5);
- $s .= qq!
!.
- "$id";
-}
-
sub do_cat_mail {
my ($ibx, $path) = @_;
my $mime = eval { $ibx->msg_by_path($path) } or return;
- Email::MIME->new($mime);
+ PublicInbox::MIME->new($mime);
}
1;