X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=lib%2FPublicInbox%2FFeed.pm;h=d7df07ee9c4577a1d15fe5410f68e6bdd68ee3e2;hb=be4d92e74dd0b1c8de85bc08c3c522af2d8d8656;hp=81895dbf1d67289644007844cdf3853b47b15f3a;hpb=23a4e44bedabe5b8b651346cabc2a870c5377a30;p=public-inbox.git diff --git a/lib/PublicInbox/Feed.pm b/lib/PublicInbox/Feed.pm index 81895dbf..d7df07ee 100644 --- a/lib/PublicInbox/Feed.pm +++ b/lib/PublicInbox/Feed.pm @@ -1,210 +1,111 @@ -# Copyright (C) 2013-2015 all contributors -# License: AGPLv3 or later (https://www.gnu.org/licenses/agpl-3.0.txt) +# Copyright (C) 2013-2018 all contributors +# License: AGPL-3.0+ # # 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; +use PublicInbox::SearchMsg; # this loads w/o Search::Xapian # main function sub generate { my ($ctx) = @_; - sub { emit_atom($_[0], $ctx) }; + my $msgs = recent_msgs($ctx); + return _no_thread() unless @$msgs; + + my $ibx = $ctx->{-inbox}; + PublicInbox::WwwAtomStream->response($ctx, 200, sub { + while (my $smsg = shift @$msgs) { + $ibx->smsg_mime($smsg) and return $smsg; + } + }); } sub generate_thread_atom { my ($ctx) = @_; - sub { emit_atom_thread($_[0], $ctx) }; + my $mid = $ctx->{mid}; + my $msgs = $ctx->{srch}->get_thread($mid); + return _no_thread() unless @$msgs; + + 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; + PublicInbox::WwwAtomStream->response($ctx, 200, sub { + while (my $smsg = shift @$msgs) { + $ibx->smsg_mime($smsg) and return $smsg; + } + }); } 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); + # 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} && $ctx->{srch}) { + return PublicInbox::View::index_topics($ctx); + } - qq(\n) . - qq{} . - qq{$title} . - qq() . - qq({atomurl}"/>) . - qq(mailto:$feed_opts->{id_addr}); + 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_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 $git = $ctx->{git} ||= PublicInbox::Git->new($ctx->{git_dir}); - each_recent_blob($ctx, sub { - my ($path, undef, $ts) = @_; - if (defined $x) { - $fh->write($x . feed_updated(undef, $ts)); - $x = undef; +sub new_html { + my ($ctx) = @_; + my $msgs = recent_msgs($ctx); + if (!@$msgs) { + return [404, ['Content-Type', 'text/plain'], + ["No messages, yet\n"] ]; + } + $ctx->{-html_tip} = '
';
+	$ctx->{-upfx} = '';
+	$ctx->{-hr} = 1;
+	my $ibx = $ctx->{-inbox};
+	PublicInbox::WwwStream->response($ctx, 200, sub {
+		while (my $smsg = shift @$msgs) {
+			my $m = $ibx->smsg_mime($smsg) or next;
+			my $more = scalar @$msgs;
+			return PublicInbox::View::index_entry($m, $ctx, $more);
 		}
-		add_to_feed($feed_opts, $fh, $path, $git);
+		PublicInbox::View::pagination_footer($ctx, './new.html');
 	});
-	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) = @_;
-	$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;
-
-	my $git = $ctx->{git} ||= PublicInbox::Git->new($ctx->{git_dir});
-	foreach my $msg (@{$res->{msgs}}) {
-		add_to_feed($feed_opts, $fh, mid2path($msg->mid), $git);
-	}
-	end_feed($fh);
-}
-
-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 $title = ascii_html($feed_opts->{description} || '');
-	my ($footer, $param, $last);
-	my $state = { ctx => $ctx, seen => {}, anchor_idx => 0, fh => $fh };
-	my $srch = $ctx->{srch};
-
-	my $top = "$title (Atom feed)";
-
-	if ($srch) {
-		$top = qq{
$top} .
-			  qq{ } .
-			  qq{} .
-			  q{
}
-	} else {
-		$top = '
' . $top . "\n";
-	}
-
-	$fh->write("$title" .
-		   "" .
-		   PublicInbox::Hval::STYLE .
-		   "$top");
-
-	# 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);
-		$param = 'o';
-	} else {
-		$last = emit_index_nosrch($ctx, $state);
-		$param = 'r';
-	}
-	$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; } -sub emit_index_nosrch { - my ($ctx, $state) = @_; - my $git = $ctx->{git} ||= PublicInbox::Git->new($ctx->{git_dir}); - my (undef, $last) = each_recent_blob($ctx, sub { - my ($path, $commit, $ts, $u, $subj) = @_; - $state->{first} ||= $commit; +# private subs - my $mime = do_cat_mail($git, $path) or return 0; - PublicInbox::View::index_entry($mime, 0, $state); - 1; - }); - $last; +sub _no_thread () { + [404, ['Content-Type', 'text/plain'], ["No feed found for thread\n"]]; } -sub nav_footer { - my ($cgi, $last, $feed_opts, $state, $param) = @_; - $cgi or return ''; - my $old_r = $cgi->param($param); - my $head = ' '; - my $next = ' '; - my $first = $state->{first}; - my $anchor = $state->{anchor_idx}; - - if ($last) { - $next = qq!next!; +sub recent_msgs { + my ($ctx) = @_; + my $ibx = $ctx->{-inbox}; + my $max = $ibx->{feedmax}; + my $qp = $ctx->{qp}; + my $v = $ibx->{version} || 1; + if ($v > 2) { + die "BUG: unsupported inbox version: $v\n"; } - if ($old_r) { - $head = $cgi->path_info; - $head = qq!head!; + if (my $srch = $ibx->search) { + return PublicInbox::View::paginate_recent($ctx, $max); } - my $atom = "{atomurl}\">Atom feed"; - "page: $next $head $atom"; -} -sub each_recent_blob { - my ($ctx, $cb) = @_; - my $max = $ctx->{max} || MAX_PER_PAGE; 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 $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}; # 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; } @@ -212,152 +113,41 @@ 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 $git = $ctx->{git} ||= PublicInbox::Git->new($ctx->{git_dir}); - my $log = $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 $log = $ibx->git->popen(qw/log + --no-notes --no-color --raw -r + --no-abbrev --abbrev-commit/, + "--format=%h", $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); + my $last_commit; local $/ = "\n"; + my @oids; 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); - if ($nr >= $max) { + push @oids, $add; + if (scalar(@oids) >= $max) { $last = 1; last; } } elsif ($line =~ /$delmsg/o) { $deleted{$1} = 1; - } elsif ($line =~ /^${hex}{7,40}/o) { - ($cur_commit, $ts, $u, $subj) = split("\0", $line); - unless (defined $first_commit) { - $first_commit = $cur_commit; - } } } if ($last) { local $/ = "\n"; while (my $line = <$log>) { - if ($line =~ /^(${hex}{7,40})/o) { + if ($line =~ /^(${hex}{7,40})/) { $last_commit = $1; last; } } } - # for pagination - ($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 ? $obj->description : 'FIXME' ); - - if ($obj) { - $rv{address} = $obj->{address}; - $rv{id_addr} = $obj->{-primary_address}; - } elsif ($pi_config && defined $inbox && $inbox ne '') { - # TODO: remove - my $addr = $pi_config->get($inbox, '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 ($obj) { - $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"; - } - } else { - $url_base = 'http://example.com/'; - $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 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_raw('Message-ID'); - defined $mid or return 0; - $mid = PublicInbox::Hval->new_msgid($mid); - my $href = $midurl.$mid->as_href; - - my $content = qq() . - PublicInbox::View::multipart_text_as_html($mime, $href) . - '
'; - my $date = $header_obj->header('Date'); - my $updated = feed_updated($date); - - my $title = $header_obj->header('Subject'); - defined $title or return 0; - $title = title_tag($title); - - my $from = $header_obj->header('From') or return 0; - my ($email) = PublicInbox::Address::emails($from); - my $name = PublicInbox::Address::from_name($from); - $name = ascii_html($name); - $email = ascii_html($email); - - if (delete $feed_opts->{emit_header}) { - $fh->write(atom_header($feed_opts, $title) . $updated); - } - $fh->write("$name$email" . - "$title$updated" . - 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; + $ctx->{next_page} = "r=$last_commit" if $last_commit; + [ map { bless {blob => $_ }, 'PublicInbox::SearchMsg' } @oids ]; } 1;