X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=lib%2FPublicInbox%2FFeed.pm;h=cbdf5db99f8b8486e8a14caff84259c63e560fd9;hb=68f9da93b11412122fff6e6154a42ecabcdbada0;hp=3540e9a49e73704f1ced02d9fcedeb96c064ac17;hpb=864dc1c4c61d240651a9f48983e0bf00147a3953;p=public-inbox.git diff --git a/lib/PublicInbox/Feed.pm b/lib/PublicInbox/Feed.pm index 3540e9a4..cbdf5db9 100644 --- a/lib/PublicInbox/Feed.pm +++ b/lib/PublicInbox/Feed.pm @@ -1,161 +1,98 @@ -# Copyright (C) 2013-2015, all contributors -# License: AGPLv3 or later (https://www.gnu.org/licenses/agpl-3.0.txt) +# Copyright (C) 2013-2020 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::Address; -use Email::MIME; -use Date::Parse qw(strptime); -use PublicInbox::Hval; -use PublicInbox::GitCatFile; use PublicInbox::View; -use PublicInbox::MID qw/mid_clean mid_compress/; -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::Smsg; # this loads w/o Search::Xapian -use Encode qw/find_encoding/; -my $enc_utf8 = find_encoding('UTF-8'); +sub generate_i { + my ($ctx) = @_; + shift @{$ctx->{msgs}}; +} # main function sub generate { my ($ctx) = @_; - sub { emit_atom($_[0], $ctx) }; + my $msgs = $ctx->{msgs} = recent_msgs($ctx); + return _no_thread() unless @$msgs; + PublicInbox::WwwAtomStream->response($ctx, 200, \&generate_i); } -sub generate_html_index { +sub generate_thread_atom { my ($ctx) = @_; - sub { emit_html_index($_[0], $ctx) }; + my $msgs = $ctx->{msgs} = $ctx->{-inbox}->over->get_thread($ctx->{mid}); + return _no_thread() unless @$msgs; + PublicInbox::WwwAtomStream->response($ctx, 200, \&generate_i); } -# private subs - -sub atom_header { - my ($feed_opts) = @_; - my $title = $feed_opts->{description}; - $title = PublicInbox::Hval->new_oneline($title)->as_html; - my $type = index($title, '&') >= 0 ? "\ntype=\"html\"" : ''; - - qq(\n) . - qq{} . - qq{$title} . - qq({url}"/>) . - qq({atomurl}"/>) . - qq(mailto:$feed_opts->{id_addr}); -} +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}; + my $ibx = $ctx->{-inbox}; + if ($qp && !$qp->{r} && $ibx->over) { + return PublicInbox::View::index_topics($ctx); + } -sub emit_atom { - my ($cb, $ctx) = @_; - my $fh = $cb->([ 200, ['Content-Type' => 'application/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; - } - add_to_feed($feed_opts, $fh, $path, $git); - }); - $git = undef; # destroy pipes - Email::Address->purge_cache; - $fh->write(""); - $fh->close; + my $env = $ctx->{env}; + my $url = $ibx->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 new_html_i { + my ($ctx, $eml) = @_; + $ctx->zmore($ctx->html_top) if exists $ctx->{-html_tip}; -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}; - - $fh->write("$title" . - "" . - '' . PublicInbox::View::PRE_WRAP . - "$title (Atom feed)\n"); - - my $state; - my $git = PublicInbox::GitCatFile->new($ctx->{git_dir}); - my $topics; - my $srch = $ctx->{srch}; - $srch and $topics = [ [], {} ]; - my (undef, $last) = each_recent_blob($ctx, sub { - my ($path, $commit, $ts, $u, $subj) = @_; - $state ||= { - ctx => $ctx, - seen => {}, - first_commit => $commit, - anchor_idx => 0, - }; - - if ($srch) { - add_topic($git, $srch, $topics, $path, $ts, $u, $subj); - } else { - my $mime = do_cat_mail($git, $path) or return 0; - PublicInbox::View::index_entry($fh, $mime, 0, $state); - 1; - } - }); - Email::Address->purge_cache; - $git = undef; # destroy pipes. + $eml and return PublicInbox::View::eml_entry($ctx, $eml); + my $smsg = shift @{$ctx->{msgs}} or + $ctx->zmore(PublicInbox::View::pagination_footer( + $ctx, './new.html')); + $smsg; +} - my $footer = nav_footer($ctx->{cgi}, $last, $feed_opts, $state); - if ($footer) { - my $list_footer = $ctx->{footer}; - $footer .= "\n" . $list_footer if $list_footer; - $footer = "
$footer
"; +sub new_html { + my ($ctx) = @_; + my $msgs = $ctx->{msgs} = recent_msgs($ctx); + if (!@$msgs) { + return [404, ['Content-Type', 'text/plain'], + ["No messages, yet\n"] ]; } - $fh->write(dump_topics($topics)) if $topics; - $fh->write("$footer"); - $fh->close; + $ctx->{-html_tip} = '
';
+	$ctx->{-upfx} = '';
+	$ctx->{-hr} = 1;
+	PublicInbox::WwwStream::aresponse($ctx, 200, \&new_html_i);
 }
 
-sub nav_footer {
-	my ($cgi, $last, $feed_opts, $state) = @_;
-	$cgi or return '';
-	my $old_r = $cgi->param('r');
-	my $head = '    ';
-	my $next = '    ';
-	my $first = $state->{first_commit};
-	my $anchor = $state->{anchor_idx};
+# private subs
 
-	if ($last) {
-		$next = qq!next!;
-	}
-	if ($old_r) {
-		$head = $cgi->path_info;
-		$head = qq!head!;
-	}
-	my $atom = "{atomurl}\">atom";
-	my $permalink = "permalink";
-	"page: $next $head $atom $permalink";
+sub _no_thread () {
+	[404, ['Content-Type', 'text/plain'], ["No feed found for thread\n"]];
 }
 
-sub each_recent_blob {
-	my ($ctx, $cb) = @_;
-	my $max = $ctx->{max} || MAX_PER_PAGE;
+sub recent_msgs {
+	my ($ctx) = @_;
+	my $ibx = $ctx->{-inbox};
+	my $max = $ibx->{feedmax};
+	return PublicInbox::View::paginate_recent($ctx, $max) if $ibx->over;
+
+	# only for rare v1 inboxes which aren't indexed at all
+	my $qp = $ctx->{qp};
 	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 $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})(?:~[0-9]+)?/;
 
 	# 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;
 	}
@@ -163,227 +100,44 @@ 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 = $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;
 			}
 		}
 	}
 
-	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 $path_info = $cgi->path_info;
-		my $base;
-		if (ref($cgi) eq 'CGI') {
-			$base = $cgi->url(-base);
-		} else {
-			$base = $cgi->base->as_string;
-			$base =~ s!/\z!!;
-		}
-		$url_base = $path_info;
-		if ($url_base =~ s!/(?:|index\.html)?\z!!) {
-			$rv{atomurl} = "$base$url_base/atom.xml";
-		} else {
-			$url_base =~ s!/atom\.xml\z!!;
-			$rv{atomurl} = $base . $path_info;
-			$url_base = $base . $url_base; # XXX is this needed?
-		}
-	} else {
-		$url_base = "http://example.com";
-		$rv{atomurl} = "$url_base/atom.xml";
-	}
-	$rv{url} ||= "$url_base/";
-	$rv{midurl} = "$url_base/m/";
-	$rv{fullurl} = "$url_base/f/";
-
-	\%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 $fullurl = $feed_opts->{fullurl} || 'http://example.com/f/';
-
-	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, $fullurl . $href);
-	defined($content) or return 0;
-	$mime = undef;
-
-	my $title = mime_header($header_obj, 'Subject') or return 0;
-	$title = PublicInbox::Hval->new_oneline($title)->as_html;
-	my $type = index($title, '&') >= 0 ? "\ntype=\"html\"" : '';
-
-	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;
-
-	my $date = $header_obj->header('Date');
-	$date = PublicInbox::Hval->new_oneline($date);
-	$date = feed_date($date->raw) or return 0;
+	$last_commit and
+		$ctx->{next_page} = qq[] .
+					'next (older)';
 
-	$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);
-	my $midurl = $feed_opts->{midurl} || 'http://example.com/m/';
-	$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;
-}
-
-# accumulate recent topics if search is supported
-sub add_topic {
-	my ($git, $srch, $topics, $path, $ts, $u, $subj) = @_;
-	my ($order, $subjs) = @$topics;
-	my $header_obj;
-
-	# legacy ssoma did not set commit titles based on Subject
-	$subj = $enc_utf8->decode($subj);
-	if ($subj eq 'mda') {
-		my $mime = do_cat_mail($git, $path) or return 0;
-		$header_obj = $mime->header_obj;
-		$subj = mime_header($header_obj, 'Subject');
-	}
-
-	my $topic = $subj = $srch->subject_normalized($subj);
-
-	# kill "[PATCH v2]" etc. for summarization
-	$topic =~ s/\A\s*\[[^\]]+\]\s*//g;
-
-	if (++$subjs->{$topic} == 1) {
-		unless ($header_obj) {
-			my $mime = do_cat_mail($git, $path) or return 0;
-			$header_obj = $mime->header_obj;
-		}
-		my $mid = $header_obj->header('Message-ID');
-		$mid = mid_compress(mid_clean($mid));
-		$u = $enc_utf8->decode($u);
-		push @$order, [ $mid, $ts, $u, $subj, $topic ];
-		return 1;
-	}
-	0; # old topic, continue going
-}
-
-sub dump_topics {
-	my ($topics) = @_;
-	my ($order, $subjs) = @$topics;
-	my $dst = '';
-	$dst .= "\n[No recent topics]" unless (scalar @$order);
-	while (defined(my $info = shift @$order)) {
-		my ($mid, $ts, $u, $subj, $topic) = @$info;
-		my $n = delete $subjs->{$topic};
-		$mid = PublicInbox::Hval->new($mid)->as_href;
-		$subj = PublicInbox::Hval->new($subj)->as_html;
-		$u = PublicInbox::Hval->new($u)->as_html;
-		$dst .= "\n$subj\n- ";
-		$ts = strftime('%Y-%m-%d %H:%M', gmtime($ts));
-		if ($n == 1) {
-			$dst .= "created by $u @ $ts UTC\n"
-		} else {
-			# $n isn't the total number of posts on the topic,
-			# just the number of posts in the current "git log"
-			# window, so leave it unlabeled
-			$dst .= "updated by $u @ $ts UTC ($n)\n"
-		}
-	}
-	$dst .= '
' + [ map { bless {blob => $_ }, 'PublicInbox::Smsg' } @oids ]; } 1;