]> Sergey Matveev's repositories - public-inbox.git/blobdiff - lib/PublicInbox/Feed.pm
completely revamp URL structure to shorten permalinks
[public-inbox.git] / lib / PublicInbox / Feed.pm
index 9e567476aa75d289109440812ad242e1eb2297d1..4420fde16ac9adae8c0af3760bea85193d5937d0 100644 (file)
@@ -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_compress/;
+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
@@ -24,6 +25,11 @@ sub generate {
        sub { emit_atom($_[0], $ctx) };
 }
 
+sub generate_thread_atom {
+       my ($ctx) = @_;
+       sub { emit_atom_thread($_[0], $ctx) };
+}
+
 sub generate_html_index {
        my ($ctx) = @_;
        sub { emit_html_index($_[0], $ctx) };
@@ -31,39 +37,81 @@ sub generate_html_index {
 
 # 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) = @_;
-       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(<?xml version="1.0" encoding="us-ascii"?>\n) .
-               qq{<feed\nxmlns="http://www.w3.org/2005/Atom">} .
-               qq{<title$type>$title</title>} .
-               qq{<link\nhref="$url"/>} .
-               qq{<link\nrel="self"\nhref="$atomurl"/>} .
-               qq{<id>mailto:$addr</id>} .
-               '<updated>' . POSIX::strftime(DATEFMT, gmtime) . '</updated>');
-
+       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, $fh, $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
+       _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) = @_;
        Email::Address->purge_cache;
-       $fh->write("</feed>");
+       $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!/t\.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) = @_;
@@ -214,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);
@@ -231,21 +283,18 @@ 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/$mid/t.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/new.atom";
                }
        } else {
                $url_base = "http://example.com";
-               $rv{atomurl} = "$url_base/atom.xml";
+               $rv{atomurl} = "$url_base/new.atom";
        }
        $rv{url} ||= "$url_base/";
-       $rv{midurl} = "$url_base/m/";
-       $rv{fullurl} = "$url_base/f/";
+       $rv{midurl} = "$url_base/";
 
        \%rv;
 }
@@ -259,7 +308,7 @@ 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)
@@ -267,20 +316,24 @@ 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 $url = $feed_opts->{url};
+       my $midurl = $feed_opts->{midurl};
 
        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);
+       my $href = $mid->as_href;
+       my $content = PublicInbox::View->feed_entry($mime, "$midurl$href/f/");
        defined($content) or return 0;
        $mime = undef;
 
+       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 = PublicInbox::Hval->new_oneline($title)->as_html;
-       my $type = index($title, '&') >= 0 ? "\ntype=\"html\"" : '';
+       $title = title_tag($title);
 
        my $from = mime_header($header_obj, 'From') or return 0;
        my @from = Email::Address->parse($from) or return 0;
@@ -288,13 +341,12 @@ sub add_to_feed {
        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;
-
+       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$type>$title</title>" .
-                  "<updated>$date</updated>" .
+                  "</author>$title$date" .
                   qq{<content\ntype="xhtml">} .
                   qq{<div\nxmlns="http://www.w3.org/1999/xhtml">});
        $fh->write($content);
@@ -303,8 +355,7 @@ sub add_to_feed {
        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{</div></content><link\nhref="$midurl$href"/>}.
+       $fh->write(qq!</div></content><link\nhref="$midurl$href/"/>!.
                   "<id>$id</id></entry>");
        1;
 }
@@ -362,8 +413,8 @@ sub dump_topics {
                $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/#u\"><b>$subj</b></a>\n- ";
-               $ts = POSIX::strftime('%Y-%m-%d %H:%M', gmtime($ts));
+               $dst .= "\n<a\nhref=\"$mid/t/#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 {