$title

X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=lib%2FPublicInbox%2FFeed.pm;h=8dd6d036175a433ebf168e56a264bfb0813be877;hb=1761fba7befab2681276ac8f123593610ad27e58;hp=81ac66b9439c66fd3a059ffdaf718c7d15b090bf;hpb=0e356ebfa0bbbbb2a7582657435cf681d92387f2;p=public-inbox.git diff --git a/lib/PublicInbox/Feed.pm b/lib/PublicInbox/Feed.pm index 81ac66b9..8dd6d036 100644 --- a/lib/PublicInbox/Feed.pm +++ b/lib/PublicInbox/Feed.pm @@ -1,184 +1,195 @@ -# 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) package PublicInbox::Feed; use strict; use warnings; use Email::Address; -use URI::Escape qw/uri_escape/; -use Encode qw/find_encoding/; -use Encode::MIME::Header; -use CGI qw(escapeHTML); -use Date::Parse qw(strptime str2time); -eval { require Git }; # this is GPLv2+, so we are OK to use it +use Email::MIME; +use Date::Parse qw(strptime); +use PublicInbox::Hval; +use PublicInbox::GitCatFile; +use PublicInbox::View; +use PublicInbox::MID qw/mid_clean mid_compressed/; 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 }; -my $enc_utf8 = find_encoding('utf8'); -my $enc_ascii = find_encoding('us-ascii'); -my $enc_mime = find_encoding('MIME-Header'); -# FIXME: workaround https://rt.cpan.org/Public/Bug/Display.html?id=22817 +use Encode qw/find_encoding/; +my $enc_utf8 = find_encoding('UTF-8'); # main function sub generate { - my ($class, $args) = @_; - require XML::Atom::SimpleFeed; - require PublicInbox::View; - require Email::MIME; - 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 $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", - }, - id => $feed_opts->{address} || '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_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 = xs_html($feed_opts->{description} || ""); - my @messages; - my $git = try_git_pm($args->{git_dir}); - my ($first, $last) = each_recent_blob($args, sub { - my $simple = do_cat_mail($git, 'Email::Simple', $_[0]) - or return 0; - if ($top && ($simple->header("In-Reply-To") || - $simple->header("References"))) { - return 0; - } - $simple->body_set(""); # save some memory + my ($ctx) = @_; + sub { emit_html_index($_[0], $ctx) }; +} - my $t = eval { str2time($simple->header('Date')) }; - defined($t) or $t = 0; - $simple->header_set('X-PI-Date', $t); - push @messages, $simple; - 1; - }); +# private subs - 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')
-		} @_;
+sub emit_atom {
+	my ($cb, $ctx) = @_;
+	require POSIX;
+	my $fh = $cb->([ 200, ['Content-Type' => 'application/xml']]);
+	my $max = $ctx->{max} || MAX_PER_PAGE;
+	my $feed_opts = get_feedopts($ctx);
+	my $addr = $feed_opts->{address};
+	$addr = $addr->[0] if ref($addr);
+	$addr ||= 'public-inbox@example.com';
+	my $title = $feed_opts->{description} || "unnamed feed";
+	$title = PublicInbox::Hval->new_oneline($title)->as_html;
+	my $type = index($title, '&') >= 0 ? "\ntype=\"html\"" : '';
+	my $url = $feed_opts->{url} || "http://example.com/";
+	my $atomurl = $feed_opts->{atomurl};
+	$fh->write(qq(\n) .
+		qq{} .
+		qq{$title} .
+		qq{} .
+		qq{} .
+		qq{mailto:$addr} .
+		'' . POSIX::strftime(DATEFMT, gmtime) . '');
+
+	my $git = PublicInbox::GitCatFile->new($ctx->{git_dir});
+	each_recent_blob($ctx, sub {
+		my ($add, undef) = @_;
+		add_to_feed($feed_opts, $fh, $add, $git);
 	});
-	dump_html_line($_, 0, \@out) for $th->rootset;
-
-	my $footer = nav_footer($args->{cgi}, $first, $last);
-	$footer = "
$footer" if $footer;
-	$out[0] . "

$footer"; + $git = undef; # destroy pipes + Email::Address->purge_cache; + $fh->write(""); + $fh->close; } -# private subs + +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 ||= [ undef, {}, $commit, 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. + + 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

"; + } + $fh->write(dump_topics($topics)) if $topics; + $fh->write("$footer"); + $fh->close; +} sub nav_footer { - my ($cgi, $first, $last) = @_; + my ($cgi, $last, $feed_opts, $state) = @_; $cgi or return ''; my $old_r = $cgi->param('r'); - my $prev = ' '; + my $head = ' '; my $next = ' '; - my %opts = (-path => 1, -query => 1, -relative => 1); + # $state = [ undef, {}, $first_commit, $last_anchor ]; + my $first = $state->[2]; + my $anchor = $state->[3]; 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"; + my $permalink = "permalink"; + "page: $next $head $atom $permalink"; } sub each_recent_blob { - my ($args, $cb) = @_; - my $max = $args->{max} || MAX_PER_PAGE; - my $refhex = qr/[a-f0-9]{4,40}(?:~\d+)?/; - my $cgi = $args->{cgi}; + 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 = $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 --no-abbrev/; - push @cmd, '--reverse' if $reverse; + 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 $first; my $pid = open(my $log, '-|', @cmd) or die('open `'.join(' ', @cmd) . " pipe failed: $!\n"); - my %deleted; + my %deleted; # only an optimization at this point my $last; my $nr = 0; - my @commits = (); - while (my $line = <$log>) { - if ($line =~ /^:000000 100644 0{40} ([a-f0-9]{40})/) { + my ($cur_commit, $first_commit, $last_commit); + my ($ts, $subj, $u); + 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 =~ /^:100644 000000 ([a-f0-9]{40}) 0{40}/) { + } elsif ($line =~ /$delmsg/o) { $deleted{$1} = 1; - } elsif ($line =~ /^commit ([a-f0-9]{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) { while (my $line = <$log>) { - if ($line =~ /^commit ([a-f0-9]{40})/) { - push @commits, $1; + if ($line =~ /^(${hex}{7,40})/o) { + $last_commit = $1; last; } } @@ -186,37 +197,47 @@ sub each_recent_blob { 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 ($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; + } if ($pi_config && defined $listname && length $listname) { - foreach my $key (qw(description address)) { + 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; + 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/index.atom.xml"; + $rv{atomurl} = "$base$url_base/atom.xml"; } else { - $url_base =~ s!/?(?:index|all)\.atom\.xml\z!!; - $rv{atomurl} = $base . $cgi_url; + $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/index.atom.xml"; + $rv{atomurl} = "$url_base/atom.xml"; } $rv{url} ||= "$url_base/"; $rv{midurl} = "$url_base/m/"; @@ -225,13 +246,9 @@ sub get_feedopts { \%rv; } -sub utf8_header { - my ($simple, $name) = @_; - my $val = $simple->header($name); - return "" unless defined $val; - $val =~ tr/\t\n / /s; - $val =~ tr/\r//d; - $enc_utf8->encode($enc_mime->decode($val)); +sub mime_header { + my ($mime, $name) = @_; + PublicInbox::Hval->new_oneline($mime->header($name))->raw; } sub feed_date { @@ -243,97 +260,112 @@ sub feed_date { # returns 0 (skipped) or 1 (added) sub add_to_feed { - my ($feed_opts, $feed, $add, $top, $git) = @_; - - my $mime = do_cat_mail($git, 'Email::MIME', $add) or return 0; - if ($top && $mime->header("In-Reply-To")) { - return 0; - } + my ($feed_opts, $fh, $add, $git) = @_; - my $midurl = $feed_opts->{midurl} || 'http://example.com/m/'; + my $mime = do_cat_mail($git, $add) or return 0; my $fullurl = $feed_opts->{fullurl} || 'http://example.com/f/'; - my $content = PublicInbox::View->as_feed_entry($mime, $fullurl); + 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 . '.html'; + my $content = PublicInbox::View->feed_entry($mime, $fullurl . $href); defined($content) or return 0; + $mime = undef; - my $mid = utf8_header($mime, "Message-ID") or return 0; - $mid =~ s/\A\z//; - - my $subject = utf8_header($mime, "Subject") || ""; - length($subject) or return 0; - - my $from = utf8_header($mime, "From") or return 0; + 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); - my $name = $from[0]->name; - defined $name or $name = ""; + my $name = PublicInbox::Hval->new_oneline($from[0]->name)->as_html; my $email = $from[0]->address; - defined $email or $email = ""; - - my $url = $midurl . uri_escape($mid); - my $date = utf8_header($mime, "Date"); - $date or return 0; - $date = feed_date($date) or return 0; - $feed->add_entry( - author => { name => $name, email => $email }, - title => $subject, - updated => $date, - content => { type => "html", content => $content }, - link => $url, - id => $add, - ); + $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; + + $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 dump_html_line { - my ($self, $level, $args) = @_; # args => [ $html, $midurl ] - $args->[0] .= (' ' x $level); - if ($self->message) { - my $simple = $self->message; - my $subj = utf8_header($simple, "Subject"); - my $mid = utf8_header($simple, "Message-ID"); - $mid =~ s/\A\z//; - my $url = $args->[1] . uri_escape($mid); - my $from = utf8_header($simple, "From"); - my @from = Email::Address->parse($from); - $from = $from[0]->name; - (defined($from) && length($from)) or $from = $from[0]->address; - $from = xs_html($from); - $subj = xs_html($subj); - $args->[0] .= "$subj $from\n"; - } else { - $args->[0] .= "[ Message not available ]\n"; - } - dump_html_line($self->child, $level+1, $args) if $self->child; - dump_html_line($self->next, $level, $args) if $self->next; +sub do_cat_mail { + my ($git, $path) = @_; + my $mime = eval { + my $str = $git->cat_file("HEAD:$path"); + Email::MIME->new($str); + }; + $@ ? undef : $mime; } -sub xs_html { - $enc_ascii->encode(escapeHTML($enc_utf8->decode($_[0])), - Encode::HTMLCREF); -} +# 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'); + } -sub try_git_pm { - my ($dir) = @_; - eval { Git->repository(Directory => $dir) }; -}; + $subj = $srch->subject_normalized($subj); + if (++$subjs->{$subj} == 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_compressed(mid_clean($mid)); + $u = $enc_utf8->decode($u); + push @$order, [ $mid, $ts, $u, $subj ]; + return 1; + } + 0; # old topic, continue going +} -sub do_cat_mail { - my ($git, $class, $sha1) = @_; - my $str; - if ($git) { - open my $fh, '>', \$str or - die "failed to setup string handle: $!\n"; - binmode $fh; - my $bytes = $git->cat_blob($sha1, $fh); - return if $bytes <= 0; - close $fh or die "failed to close string handle: $!\n"; - } else { - $str = `git cat-file blob $sha1`; - return if $? != 0 || length($str) == 0; +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) = @$info; + my $n = delete $subjs->{$subj}; + $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 = POSIX::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" + } } - $class->new($str); + $dst .= '' } 1;