$title

X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=lib%2FPublicInbox%2FFeed.pm;h=81895dbf1d67289644007844cdf3853b47b15f3a;hb=23a4e44bedabe5b8b651346cabc2a870c5377a30;hp=2dc3940ff7e4fc3bd591f5501eb40f53792fb112;hpb=f5a852a0fbaad70512abdbf4332dca343b85bc89;p=public-inbox.git diff --git a/lib/PublicInbox/Feed.pm b/lib/PublicInbox/Feed.pm index 2dc3940f..81895dbf 100644 --- a/lib/PublicInbox/Feed.pm +++ b/lib/PublicInbox/Feed.pm @@ -1,351 +1,363 @@ -# Copyright (C) 2013, Eric Wong and 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 str2time); -use PublicInbox::Hval; -eval { require Git }; # this is GPLv2+, so we are OK to use it +use Date::Parse qw(strptime); +use PublicInbox::Hval qw/ascii_html/; +use PublicInbox::Git; +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', - MAX_PER_PAGE => 25, + DATEFMT => '%Y-%m-%dT%H:%M:%SZ', # Atom standard + MAX_PER_PAGE => 25, # this needs to be tunable }; -# FIXME: workaround https://rt.cpan.org/Public/Bug/Display.html?id=22817 - # main function sub generate { - my ($class, $args) = @_; - require XML::Atom::SimpleFeed; - require PublicInbox::View; - require POSIX; - my $max = $args->{max} || MAX_PER_PAGE; - my $top = $args->{top}; # bool - - local $ENV{GIT_DIR} = $args->{git_dir}; - my $feed_opts = get_feedopts($args); - my $addr = $feed_opts->{address}; - $addr = $addr->[0] if ref($addr); - my $feed = XML::Atom::SimpleFeed->new( - title => $feed_opts->{description} || "unnamed feed", - link => $feed_opts->{url} || "http://example.com/", - link => { - rel => 'self', - href => $feed_opts->{atomurl} || - "http://example.com/atom.xml", - }, - id => 'mailto:' . ($addr || 'public-inbox@example.com'), - updated => POSIX::strftime(DATEFMT, gmtime), - ); - - my $git = try_git_pm($args->{git_dir}); - each_recent_blob($args, sub { - my ($add) = @_; - add_to_feed($feed_opts, $feed, $add, $top, $git); - }); - $feed->as_string; + my ($ctx) = @_; + sub { emit_atom($_[0], $ctx) }; +} + +sub generate_thread_atom { + my ($ctx) = @_; + sub { emit_atom_thread($_[0], $ctx) }; } sub generate_html_index { - my ($class, $args) = @_; - require Mail::Thread; - - my $max = $args->{max} || MAX_PER_PAGE; - my $top = $args->{top}; # bool - local $ENV{GIT_DIR} = $args->{git_dir}; - my $feed_opts = get_feedopts($args); - - my $title = $feed_opts->{description} || ''; - $title = PublicInbox::Hval->new_oneline($title)->as_html; - - my @messages; - my $git = try_git_pm($args->{git_dir}); - my ($first, $last) = each_recent_blob($args, sub { - my $mime = do_cat_mail($git, $_[0]) - or return 0; - if ($top && ($mime->header('In-Reply-To') || - $mime->header('References'))) { - return 0; - } - $mime->body_set(''); # save some memory + my ($ctx) = @_; + sub { emit_html_index($_[0], $ctx) }; +} - my $t = eval { str2time($mime->header('Date')) }; - defined($t) or $t = 0; - $mime->header_set('X-PI-Date', $t); - push @messages, $mime; - 1; - }); +# 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) = @_; - my $th = Mail::Thread->new(@messages); - $th->thread; - my @out = ( - "$title" . - '' . - '

');
-	push @out, $feed_opts->{midurl};
-
-	# sort by date, most recent at top
-	$th->order(sub {
-		sort {
-			$b->topmost->message->header('X-PI-Date') <=>
-			$a->topmost->message->header('X-PI-Date')
-		} @_;
+	$title = title_tag($feed_opts->{description}) unless (defined $title);
+
+	qq(\n) .
+	qq{} .
+	qq{$title} .
+	qq() .
+	qq({atomurl}"/>) .
+	qq(mailto:$feed_opts->{id_addr});
+}
+
+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;
+		}
+		add_to_feed($feed_opts, $fh, $path, $git);
 	});
-	dump_html_line($_, 0, \@out) for $th->rootset;
+	end_feed($fh);
+}
 
-	my $footer = nav_footer($args->{cgi}, $first, $last);
-	$footer = "
$footer" if $footer;
-	$out[0] . "

$footer"; +sub _no_thread { + my ($cb) = @_; + my $fh = $cb->([404, ['Content-Type' => 'text/plain']]); + $fh->write("No feed found for thread\n"); + $fh->close; } -# private subs +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;
+
+		my $mime = do_cat_mail($git, $path) or return 0;
+		PublicInbox::View::index_entry($mime, 0, $state);
+		1;
+	});
+	$last;
+}
 
 sub nav_footer {
-	my ($cgi, $first, $last) = @_;
+	my ($cgi, $last, $feed_opts, $state, $param) = @_;
 	$cgi or return '';
-	my $old_r = $cgi->param('r');
-	my $prev = '    ';
+	my $old_r = $cgi->param($param);
+	my $head = '    ';
 	my $next = '    ';
-	my %opts = (-path => 1, -query => 1, -relative => 1);
+	my $first = $state->{first};
+	my $anchor = $state->{anchor_idx};
 
 	if ($last) {
-		$cgi->param('r', $last);
-		$next = $cgi->url(%opts);
-		$next = qq!next!;
+		$next = qq!next!;
 	}
-	if ($first && $old_r) {
-		$cgi->param('r', "$first..");
-		$prev = $cgi->url(%opts);
-		$prev = qq!prev!;
+	if ($old_r) {
+		$head = $cgi->path_info;
+		$head = qq!head!;
 	}
-	"$prev $next";
+	my $atom = "{atomurl}\">Atom feed";
+	"page: $next $head $atom";
 }
 
 sub each_recent_blob {
-	my ($args, $cb) = @_;
-	my $max = $args->{max} || MAX_PER_PAGE;
+	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 $refhex = qr/${hex}{4,40}(?:~\d+)?/;
-	my $cgi = $args->{cgi};
+	my $refhex = qr/(?:HEAD|${hex}{4,40})(?:~\d+)?/;
+	my $cgi = $ctx->{cgi};
 
 	# revision ranges may be specified
-	my $reverse;
 	my $range = 'HEAD';
 	my $r = $cgi->param('r') if $cgi;
-	if ($r) {
-		if ($r =~ /\A(?:$refhex\.\.)?$refhex\z/o) {
-			$range = $r;
-		} elsif ($r =~ /\A(?:$refhex\.\.)\z/o) {
-			$reverse = 1;
-			$range = $r;
-		}
+	if ($r && ($r =~ /\A(?:$refhex\.\.)?$refhex\z/o)) {
+		$range = $r;
 	}
 
 	# 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 = qw/git log --no-notes --no-color --raw -r/;
-	push @cmd, '--reverse' if $reverse;
-	push @cmd, $range;
-	my $first;
-
-	my $pid = open(my $log, '-|', @cmd) or
-		die('open `'.join(' ', @cmd) . " pipe failed: $!\n");
+	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 %deleted; # only an optimization at this point
 	my $last;
 	my $nr = 0;
-	my @commits = ();
-	while (my $line = <$log>) {
+	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};
-			$nr += $cb->($add);
+			next if $deleted{$add}; # optimization-only
+			$nr += $cb->($add, $cur_commit, $ts, $u, $subj);
 			if ($nr >= $max) {
 				$last = 1;
 				last;
 			}
 		} elsif ($line =~ /$delmsg/o) {
 			$deleted{$1} = 1;
-		} elsif ($line =~ /^commit (${hex}{40})/) {
-			push @commits, $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 =~ /^commit (${hex}{40})/) {
-				push @commits, $1;
+			if ($line =~ /^(${hex}{7,40})/o) {
+				$last_commit = $1;
 				last;
 			}
 		}
-	} elsif ($reverse) {
-		unshift @commits, undef
-	} else {
-		push @commits, undef;
 	}
 
-	close $log; # we may EPIPE here
 	# for pagination
-	$reverse ? ($commits[-1],$commits[0]) : ($commits[0],$commits[-1]);
+	($first_commit, $last_commit);
 }
 
 # private functions below
 sub get_feedopts {
-	my ($args) = @_;
-	my $pi_config = $args->{pi_config};
-	my $listname = $args->{listname};
-	my $cgi = $args->{cgi};
-	my %rv;
-	if (open my $fh, '<', "$args->{git_dir}/description") {
-		chomp($rv{description} = <$fh>);
-		close $fh;
+	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';
 
-	if ($pi_config && defined $listname && length $listname) {
-		foreach my $key (qw(address)) {
-			$rv{$key} = $pi_config->get($listname, $key) || "";
-		}
-	}
 	my $url_base;
-	if ($cgi) {
-		my $cgi_url = $cgi->url(-path=>1, -relative=>1);
-		my $base = $cgi->url(-base);
-		$url_base = $cgi_url;
-		if ($url_base =~ s!/(?:|index\.html)?\z!!) {
-			$rv{atomurl} = "$base$url_base/atom.xml";
+	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 {
-			$url_base =~ s!/atom\.xml\z!!;
-			$rv{atomurl} = $base . $cgi_url;
-			$url_base = $base . $url_base; # XXX is this needed?
+			$rv{atomurl} = $url_base."new.atom";
 		}
 	} else {
-		$url_base = "http://example.com";
-		$rv{atomurl} = "$url_base/atom.xml";
+		$url_base = 'http://example.com/';
+		$rv{atomurl} = $url_base.'new.atom';
 	}
-	$rv{url} ||= "$url_base/";
-	$rv{midurl} = "$url_base/m/";
-	$rv{fullurl} = "$url_base/f/";
+	$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) };
+sub feed_updated {
+	my ($date, $ts) = @_;
+	my @t = eval { strptime($date) } if defined $date;
+	@t = gmtime($ts || time) unless scalar @t;
 
-	scalar(@t) ? POSIX::strftime(DATEFMT, @t) : 0;
+	'' . strftime(DATEFMT, @t) . '';
 }
 
 # returns 0 (skipped) or 1 (added)
 sub add_to_feed {
-	my ($feed_opts, $feed, $add, $top, $git) = @_;
+	my ($feed_opts, $fh, $add, $git) = @_;
 
 	my $mime = do_cat_mail($git, $add) or return 0;
-	if ($top && $mime->header('In-Reply-To')) {
-		return 0;
-	}
-
-	my $midurl = $feed_opts->{midurl} || 'http://example.com/m/';
-	my $fullurl = $feed_opts->{fullurl} || 'http://example.com/f/';
+	my $url = $feed_opts->{url};
+	my $midurl = $feed_opts->{midurl};
 
-	my $mid = $mime->header_obj->header_raw('Message-ID');
+	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 = $mid->as_href;
-	my $content = PublicInbox::View->as_feed_entry($mime,
-							"$fullurl$href.html");
-	defined($content) or return 0;
-
-	my $subject = mime_header($mime, 'Subject') or return 0;
-
-	my $from = mime_header($mime, 'From') or return 0;
-	my @from = Email::Address->parse($from);
-	my $name = $from[0]->name;
-	defined $name or $name = "";
-	my $email = $from[0]->address;
-	defined $email or $email = "";
-
-	my $date = $mime->header('Date');
-	$date = PublicInbox::Hval->new_oneline($date);
-	$date = feed_date($date->raw) or return 0;
+	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);
-
-	$feed->add_entry(
-		author => { name => $name, email => $email },
-		title => $subject,
-		updated => $date,
-		content => { type => "html", content => $content },
-		link => $midurl . $href,
-		id => 'urn:uuid:' . join('-', @uuid5),
-	);
+	my $id = 'urn:uuid:' . join('-', @uuid5);
+	$fh->write(qq!!.
+		   "$id");
 	1;
 }
 
-sub dump_html_line {
-	my ($self, $level, $args) = @_; # args => [ $html, $midurl ]
-	if ($self->message) {
-		$args->[0] .= (' ' x $level);
-		my $mime = $self->message;
-		my $subj = $mime->header('Subject');
-		my $mid = $mime->header_obj->header_raw('Message-ID');
-		$mid = PublicInbox::Hval->new_msgid($mid);
-		my $url = $args->[1] . $mid->as_href;
-		my $from = mime_header($mime, 'From');
-
-		my @from = Email::Address->parse($from);
-		$from = $from[0]->name;
-		(defined($from) && length($from)) or $from = $from[0]->address;
-
-		$from = PublicInbox::Hval->new_oneline($from)->as_html;
-		$subj = PublicInbox::Hval->new_oneline($subj)->as_html;
-		$args->[0] .= "$subj $from\n";
-	}
-	dump_html_line($self->child, $level+1, $args) if $self->child;
-	dump_html_line($self->next, $level, $args) if $self->next;
-}
-
-sub try_git_pm {
-	my ($dir) = @_;
-	eval { Git->repository(Directory => $dir) };
-};
-
 sub do_cat_mail {
 	my ($git, $path) = @_;
-	my $str;
-	if ($git) {
-		open my $fh, '>', \$str or
-				die "failed to setup string handle: $!\n";
-		binmode $fh;
-		my $err = '';
-		my $bytes;
-		{
-			local $SIG{__WARN__} = sub { $err .= $_[0] };
-			$bytes = $git->cat_blob("HEAD:$path", $fh);
-		}
-		close $fh or die "failed to close string handle: $!\n";
-
-		if ($bytes < 0 && $err &&
-				$err !~ /doesn't exist in the repository/) {
-			warn $err;
-		}
-		return if $bytes <= 0;
-	} else {
-		$str = `git cat-file blob HEAD:$path`;
-		return if $? != 0 || length($str) == 0;
-	}
-	Email::MIME->new($str);
+	my $mime = eval {
+		my $str = $git->cat_file("HEAD:$path");
+		Email::MIME->new($str);
+	};
+	$@ ? undef : $mime;
 }
 
 1;