X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=lib%2FPublicInbox%2FFeed.pm;h=e5d57550f414140fd7c1fc4f182bb8657b3e0169;hb=3fc59df0d633a17e0c5e43d633d12e8772c06ec3;hp=dbb80cad0073ca8e4fc5621ed123d59f622928fa;hpb=1e7fe3de7021427f8326a5f7710347035f7a63c5;p=public-inbox.git diff --git a/lib/PublicInbox/Feed.pm b/lib/PublicInbox/Feed.pm index dbb80cad..e5d57550 100644 --- a/lib/PublicInbox/Feed.pm +++ b/lib/PublicInbox/Feed.pm @@ -1,217 +1,126 @@ -# Copyright (C) 2013-2015, all contributors +# Copyright (C) 2013-2015 all contributors # License: AGPLv3 or later (https://www.gnu.org/licenses/agpl-3.0.txt) +# +# Used for generating Atom feeds for web-accessible mailing list archives. package PublicInbox::Feed; use strict; use warnings; -use Email::Address; -use Email::MIME; -use Date::Parse qw(strptime); -use PublicInbox::Hval; -use PublicInbox::GitCatFile; +use PublicInbox::MIME; use PublicInbox::View; -use PublicInbox::MID qw/mid_clean mid2path/; -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 Encode qw/find_encoding/; -my $enc_utf8 = find_encoding('UTF-8'); +use PublicInbox::WwwAtomStream; # main function sub generate { my ($ctx) = @_; - sub { emit_atom($_[0], $ctx) }; + my @paths; + each_recent_blob($ctx, sub { push @paths, $_[0] }); + return _no_thread() unless @paths; + + my $ibx = $ctx->{-inbox}; + PublicInbox::WwwAtomStream->response($ctx, 200, sub { + while (my $path = shift @paths) { + my $mime = do_cat_mail($ibx, $path) or next; + return $mime; + } + }); } 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) = @_; - # try to avoid the type attribute in title: - $title = PublicInbox::Hval->new_oneline($title)->as_html; - 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}); -} - -sub emit_atom { - my ($cb, $ctx) = @_; - my $fh = $cb->([ 200, ['Content-Type' => 'application/atom+xml']]); - my $max = $ctx->{max} || MAX_PER_PAGE; - my $feed_opts = get_feedopts($ctx); - my $x = atom_header($feed_opts); - my $git = PublicInbox::GitCatFile->new($ctx->{git_dir}); - each_recent_blob($ctx, sub { - my ($path, undef, $ts) = @_; - if (defined $x) { - $fh->write($x . '' . - strftime(DATEFMT, gmtime($ts)) . - ''); - $x = undef; + my $mid = $ctx->{mid}; + my $res = $ctx->{srch}->get_thread($mid); + return _no_thread() unless $res->{total}; + + my $ibx = $ctx->{-inbox}; + 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); } - add_to_feed($feed_opts, $fh, $path, $git); }); - $git = undef; # destroy pipes - _end_feed($fh); -} - -sub _no_thread { - my ($cb) = @_; - my $fh = $cb->([404, ['Content-Type' => 'text/plain']]); - $fh->write("No feed found for thread\n"); - $fh->close; } -sub _end_feed { - my ($fh) = @_; - Email::Address->purge_cache; - $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 $fh = $cb->([200, ['Content-Type' => 'application/atom+xml']]); - my $feed_opts = get_feedopts($ctx); - - 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; - - my $git = PublicInbox::GitCatFile->new($ctx->{git_dir}); - foreach my $msg (@{$res->{msgs}}) { - add_to_feed($feed_opts, $fh, mid2path($msg->mid), $git); - } - $git = undef; # destroy pipes - _end_feed($fh); -} - -sub emit_html_index { - my ($cb, $ctx) = @_; - my $fh = $cb->([200,['Content-Type'=>'text/html; charset=UTF-8']]); - - my $max = $ctx->{max} || MAX_PER_PAGE; - my $feed_opts = get_feedopts($ctx); - - my $title = $feed_opts->{description} || ''; - $title = PublicInbox::Hval->new_oneline($title)->as_html; - my $atom_url = $feed_opts->{atomurl}; - my ($footer, $param, $last); - my $state = { ctx => $ctx, seen => {}, anchor_idx => 0 }; - my $srch = $ctx->{srch}; - - my $top = "$title (Atom feed)"; - - if ($srch) { - $top = qq{$top} . - qq{ } . - qq{} . - qq{} . - PublicInbox::View::PRE_WRAP; - } else { - $top = PublicInbox::View::PRE_WRAP . $top . "\n"; - } - - $fh->write("$title" . - "" . - "$top"); - +sub generate_html_index { + my ($ctx) = @_; # if the 'r' query parameter is given, it is a legacy permalink # which we must continue supporting: - my $cgi = $ctx->{cgi}; - if ($cgi && !$cgi->param('r') && $srch) { - $state->{srch} = $srch; - $last = PublicInbox::View::emit_index_topics($state, $fh); - $param = 'o'; - } else { - $last = emit_index_nosrch($ctx, $state, $fh); - $param = 'r'; + my $qp = $ctx->{qp}; + if ($qp && !$qp->{r} && $ctx->{srch}) { + return PublicInbox::View::index_topics($ctx); } - $footer = nav_footer($cgi, $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, $fh) = @_; - my $git = PublicInbox::GitCatFile->new($ctx->{git_dir}); +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($git, $path) or return 0; - PublicInbox::View::index_entry($fh, $mime, 0, $state); - 1; + $ctx->{first} ||= $commit; + push @paths, $path; + }); + 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);
 	});
-	Email::Address->purge_cache;
-	$last;
 }
 
-sub nav_footer {
-	my ($cgi, $last, $feed_opts, $state, $param) = @_;
-	$cgi or return '';
-	my $old_r = $cgi->param($param);
-	my $head = '    ';
+# private subs
+
+sub _no_thread () {
+	[404, ['Content-Type', 'text/plain'], ["No feed found for thread\n"]];
+}
+
+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 = $cgi->path_info;
-		$head = qq!head!;
+		$latest = qq! latest!;
 	}
-	my $atom = "{atomurl}\">atom";
-	"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})$!; my $refhex = qr/(?:HEAD|${hex}{4,40})(?:~\d+)?/; - my $cgi = $ctx->{cgi}; + my $qp = $ctx->{qp}; # revision ranges may be specified my $range = 'HEAD'; - my $r = $cgi->param('r') if $cgi; + my $r = $qp->{r} if $qp; if ($r && ($r =~ /\A(?:$refhex\.\.)?$refhex\z/o)) { $range = $r; } @@ -219,24 +128,22 @@ sub each_recent_blob { # get recent messages # we could use git log -z, but, we already know ssoma will not # leave us with filenames with spaces in them.. - my @cmd = ('git', "--git-dir=$ctx->{git_dir}", - qw/log --no-notes --no-color --raw -r - --abbrev=16 --abbrev-commit/, - "--format=%h%x00%ct%x00%an%x00%s%x00"); - push @cmd, $range; - - my $pid = open(my $log, '-|', @cmd) or - die('open `'.join(' ', @cmd) . " pipe failed: $!\n"); + my $log = $ctx->{-inbox}->git->popen(qw/log + --no-notes --no-color --raw -r + --abbrev=16 --abbrev-commit/, + "--format=%h%x00%ct%x00%an%x00%s%x00", + $range); my %deleted; # only an optimization at this point my $last; my $nr = 0; my ($cur_commit, $first_commit, $last_commit); my ($ts, $subj, $u); + local $/ = "\n"; while (defined(my $line = <$log>)) { 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; @@ -252,6 +159,7 @@ sub each_recent_blob { } if ($last) { + local $/ = "\n"; while (my $line = <$log>) { if ($line =~ /^(${hex}{7,40})/o) { $last_commit = $1; @@ -260,126 +168,14 @@ sub each_recent_blob { } } - close $log; # we may EPIPE here # for pagination ($first_commit, $last_commit); } -# private functions below -sub get_feedopts { - my ($ctx) = @_; - my $pi_config = $ctx->{pi_config}; - my $listname = $ctx->{listname}; - my $cgi = $ctx->{cgi}; - my %rv; - if (open my $fh, '<', "$ctx->{git_dir}/description") { - chomp($rv{description} = <$fh>); - close $fh; - } else { - $rv{description} = '($GIT_DIR/description missing)'; - } - - if ($pi_config && defined $listname && $listname ne '') { - my $addr = $pi_config->get($listname, 'address') || ""; - $rv{address} = $addr; - $addr = $addr->[0] if ref($addr); - $rv{id_addr} = $addr; - } - $rv{id_addr} ||= 'public-inbox@example.com'; - - my $url_base; - if ($cgi) { - my $base; - if (ref($cgi) eq 'CGI') { - $base = $cgi->url(-base); - } else { - $base = $cgi->base->as_string; - $base =~ s!/\z!!; - } - $url_base = "$base/$listname"; - if (my $mid = $ctx->{mid}) { # per-thread feed: - $rv{atomurl} = "$url_base/$mid/t.atom"; - } else { - $rv{atomurl} = "$url_base/new.atom"; - } - } else { - $url_base = "http://example.com"; - $rv{atomurl} = "$url_base/new.atom"; - } - $rv{url} ||= "$url_base/"; - $rv{midurl} = "$url_base/"; - - \%rv; -} - -sub mime_header { - my ($mime, $name) = @_; - PublicInbox::Hval->new_oneline($mime->header($name))->raw; -} - -sub feed_date { - my ($date) = @_; - my @t = eval { strptime($date) }; - - scalar(@t) ? strftime(DATEFMT, @t) : 0; -} - -# returns 0 (skipped) or 1 (added) -sub add_to_feed { - my ($feed_opts, $fh, $add, $git) = @_; - - my $mime = do_cat_mail($git, $add) or return 0; - my $url = $feed_opts->{url}; - my $midurl = $feed_opts->{midurl}; - - my $header_obj = $mime->header_obj; - my $mid = $header_obj->header('Message-ID'); - defined $mid or return 0; - $mid = PublicInbox::Hval->new_msgid($mid); - my $href = $mid->as_href; - my $content = PublicInbox::View->feed_entry($mime, "$midurl$href/f/"); - defined($content) or return 0; - $mime = undef; - - my $date = $header_obj->header('Date'); - $date = PublicInbox::Hval->new_oneline($date); - $date = feed_date($date->raw) or return 0; - $date = "$date"; - - my $title = mime_header($header_obj, 'Subject') or return 0; - $title = title_tag($title); - - my $from = mime_header($header_obj, 'From') or return 0; - my @from = Email::Address->parse($from) or return 0; - my $name = PublicInbox::Hval->new_oneline($from[0]->name)->as_html; - my $email = $from[0]->address; - $email = PublicInbox::Hval->new_oneline($email)->as_html; - - if (delete $feed_opts->{emit_header}) { - $fh->write(atom_header($feed_opts, $title) . $date); - } - $fh->write("$name$email" . - "$title$date" . - qq{} . - qq{}); - $fh->write($content); - - $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); - $fh->write(qq!!. - "$id"); - 1; -} - sub do_cat_mail { - my ($git, $path) = @_; - my $mime = eval { - my $str = $git->cat_file("HEAD:$path"); - Email::MIME->new($str); - }; - $@ ? undef : $mime; + my ($ibx, $path) = @_; + my $mime = eval { $ibx->msg_by_path($path) } or return; + PublicInbox::MIME->new($mime); } 1;