]> Sergey Matveev's repositories - public-inbox.git/blobdiff - lib/PublicInbox/Feed.pm
implement per-thread Atom feeds
[public-inbox.git] / lib / PublicInbox / Feed.pm
index 5d122ac6ffa67bd058f323bec5d4d925b6a88e5b..1fef98491e35fc7d9426dca7cbab918eedd5e4b2 100644 (file)
@@ -1,4 +1,4 @@
-# Copyright (C) 2013, Eric Wong <normalperson@yhbt.net> and all contributors
+# Copyright (C) 2013-2015, all contributors <meta@public-inbox.org>
 # License: AGPLv3 or later (https://www.gnu.org/licenses/agpl-3.0.txt)
 package PublicInbox::Feed;
 use strict;
@@ -9,7 +9,8 @@ use Date::Parse qw(strptime);
 use PublicInbox::Hval;
 use PublicInbox::GitCatFile;
 use PublicInbox::View;
-use PublicInbox::MID qw/mid_clean mid_compressed/;
+use PublicInbox::MID qw/mid_clean mid_compress 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
@@ -20,43 +21,97 @@ my $enc_utf8 = find_encoding('UTF-8');
 
 # main function
 sub generate {
-       my ($class, $ctx) = @_;
-       require XML::Atom::SimpleFeed;
-       require POSIX;
-       my $max = $ctx->{max} || MAX_PER_PAGE;
+       my ($ctx) = @_;
+       sub { emit_atom($_[0], $ctx) };
+}
 
-       my $feed_opts = get_feedopts($ctx);
-       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),
-       );
-       $feed->no_generator;
+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$type>$title</title>";
+}
+
+sub atom_header {
+       my ($feed_opts, $title) = @_;
+
+       $title = title_tag($feed_opts->{description}) unless (defined $title);
+
+       qq(<?xml version="1.0" encoding="us-ascii"?>\n) .
+       qq{<feed\nxmlns="http://www.w3.org/2005/Atom">} .
+       qq{$title} .
+       qq(<link\nhref="$feed_opts->{url}"/>) .
+       qq(<link\nrel="self"\nhref="$feed_opts->{atomurl}"/>) .
+       qq(<id>mailto:$feed_opts->{id_addr}</id>);
+}
+
+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 ($add, undef) = @_;
-               add_to_feed($feed_opts, $feed, $add, $git);
+               my ($path, undef, $ts) = @_;
+               if (defined $x) {
+                       $fh->write($x . '<updated>' .
+                                  strftime(DATEFMT, gmtime($ts)) .
+                                  '</updated>');
+                       $x = undef;
+               }
+               add_to_feed($feed_opts, $fh, $path, $git);
        });
        $git = undef; # destroy pipes
-       Email::Address->purge_cache;
-       $feed->as_string;
+       _end_feed($fh);
 }
 
-sub generate_html_index {
-       my ($ctx) = @_;
-       sub { emit_html_index($_[0], $ctx) };
+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) = @_;
+       Email::Address->purge_cache;
+       $fh->write('</feed>');
+       $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/xml']]);
+       my $feed_opts = get_feedopts($ctx);
+
+       my $html_url = $feed_opts->{atomurl} = $ctx->{self_url};
+       $html_url =~ s!/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) = @_;
@@ -82,7 +137,12 @@ sub emit_html_index {
        $srch and $topics = [ [], {} ];
        my (undef, $last) = each_recent_blob($ctx, sub {
                my ($path, $commit, $ts, $u, $subj) = @_;
-               $state ||= [ undef, {}, $commit, 0 ];
+               $state ||= {
+                       ctx => $ctx,
+                       seen => {},
+                       first_commit => $commit,
+                       anchor_idx => 0,
+               };
 
                if ($srch) {
                        add_topic($git, $srch, $topics, $path, $ts, $u, $subj);
@@ -112,9 +172,8 @@ sub nav_footer {
        my $old_r = $cgi->param('r');
        my $head = '    ';
        my $next = '    ';
-       # $state = [ undef, {}, $first_commit, $last_anchor ];
-       my $first = $state->[2];
-       my $anchor = $state->[3];
+       my $first = $state->{first_commit};
+       my $anchor = $state->{anchor_idx};
 
        if ($last) {
                $next = qq!<a\nhref="?r=$last">next</a>!;
@@ -134,7 +193,7 @@ sub each_recent_blob {
        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 $refhex = qr/(?:HEAD|${hex}{4,40})(?:~\d+)?/;
        my $cgi = $ctx->{cgi};
 
        # revision ranges may be specified
@@ -203,16 +262,20 @@ sub get_feedopts {
        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 && length $listname) {
-               foreach my $key (qw(address)) {
-                       $rv{$key} = $pi_config->get($listname, $key) || "";
-               }
+       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);
@@ -220,13 +283,11 @@ sub get_feedopts {
                        $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";
+               $url_base = "$base/$listname";
+               if (my $mid = $ctx->{mid}) { # per-thread feed:
+                       $rv{atomurl} = "$url_base/t/$mid/atom";
                } else {
-                       $url_base =~ s!/atom\.xml\z!!;
-                       $rv{atomurl} = $base . $path_info;
-                       $url_base = $base . $url_base; # XXX is this needed?
+                       $rv{atomurl} = "$url_base/atom.xml";
                }
        } else {
                $url_base = "http://example.com";
@@ -248,50 +309,55 @@ sub feed_date {
        my ($date) = @_;
        my @t = eval { strptime($date) };
 
-       scalar(@t) ? POSIX::strftime(DATEFMT, @t) : 0;
+       scalar(@t) ? strftime(DATEFMT, @t) : 0;
 }
 
 # returns 0 (skipped) or 1 (added)
 sub add_to_feed {
-       my ($feed_opts, $feed, $add, $git) = @_;
+       my ($feed_opts, $fh, $add, $git) = @_;
 
        my $mime = do_cat_mail($git, $add) or return 0;
-       my $midurl = $feed_opts->{midurl} || 'http://example.com/m/';
        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 . '.html';
+       my $href = $mid->as_href . '/';
        my $content = PublicInbox::View->feed_entry($mime, $fullurl . $href);
        defined($content) or return 0;
        $mime = undef;
 
-       my $subject = mime_header($header_obj, 'Subject') or return 0;
+       my $date = $header_obj->header('Date');
+       $date = PublicInbox::Hval->new_oneline($date);
+       $date = feed_date($date->raw) or return 0;
+
+       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);
-       my $name = $from[0]->name;
-       defined $name or $name = "";
+       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;
-       defined $email or $email = "";
+       $email = PublicInbox::Hval->new_oneline($email)->as_html;
+
+       if (delete $feed_opts->{emit_header}) {
+               $fh->write(atom_header($feed_opts, $title) .
+                          "<updated>$date</updated>");
+       }
+       $fh->write("<entry><author><name>$name</name><email>$email</email>" .
+                  "</author>$title$date" .
+                  qq{<content\ntype="xhtml">} .
+                  qq{<div\nxmlns="http://www.w3.org/1999/xhtml">});
+       $fh->write($content);
 
-       my $date = $header_obj->header('Date');
-       $date = PublicInbox::Hval->new_oneline($date);
-       $date = feed_date($date->raw) or return 0;
        $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 => 'xhtml', content => $content },
-               link => $midurl . $href,
-               id => 'urn:uuid:' . join('-', @uuid5),
-       );
+       my $id = 'urn:uuid:' . join('-', @uuid5);
+       my $midurl = $feed_opts->{midurl};
+       $fh->write(qq{</div></content><link\nhref="$midurl$href"/>}.
+                  "<id>$id</id></entry>");
        1;
 }
 
@@ -318,16 +384,20 @@ sub add_topic {
                $subj = mime_header($header_obj, 'Subject');
        }
 
-       $subj = $srch->subject_normalized($subj);
-       if (++$subjs->{$subj} == 1) {
+       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_compressed(mid_clean($mid));
+               $mid = mid_compress(mid_clean($mid));
                $u = $enc_utf8->decode($u);
-               push @$order, [ $mid, $ts, $u, $subj ];
+               push @$order, [ $mid, $ts, $u, $subj, $topic ];
                return 1;
        }
        0; # old topic, continue going
@@ -339,13 +409,13 @@ sub dump_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};
+               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<a\nhref=\"t/$mid.html#u\"><b>$subj</b></a>\n- ";
-               $ts = POSIX::strftime('%Y-%m-%d %H:%M', gmtime($ts));
+               $dst .= "\n<a\nhref=\"t/$mid/#u\"><b>$subj</b></a>\n- ";
+               $ts = strftime('%Y-%m-%d %H:%M', gmtime($ts));
                if ($n == 1) {
                        $dst .= "created by $u @ $ts UTC\n"
                } else {