]> Sergey Matveev's repositories - public-inbox.git/blobdiff - lib/PublicInbox/Feed.pm
fix quoted URL generation in feeds
[public-inbox.git] / lib / PublicInbox / Feed.pm
index 75290c9e1a33d758f8063bd2769fbfce28fd6846..93ee80bbef27b51b88099889c416dc36798dff6a 100644 (file)
@@ -3,21 +3,17 @@
 package PublicInbox::Feed;
 use strict;
 use warnings;
-use XML::Atom::SimpleFeed;
-use Email::MIME;
 use Email::Address;
 use URI::Escape qw/uri_escape/;
 use Encode qw/find_encoding/;
 use Encode::MIME::Header;
 use CGI qw(escapeHTML);
-use POSIX qw(strftime);
 use Date::Parse qw(strptime str2time);
+eval { require Git }; # this is GPLv2+, so we are OK to use it
 use constant {
        DATEFMT => '%Y-%m-%dT%H:%M:%SZ',
        MAX_PER_PAGE => 25,
 };
-use PublicInbox::View;
-use Mail::Thread;
 my $enc_utf8 = find_encoding('utf8');
 my $enc_ascii = find_encoding('us-ascii');
 my $enc_mime = find_encoding('MIME-Header');
@@ -27,43 +23,51 @@ my $enc_mime = find_encoding('MIME-Header');
 # 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 $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",
+                               "http://example.com/atom.xml",
                },
-               id => $feed_opts->{address} || 'public-inbox@example.com',
-               updated => strftime(DATEFMT, gmtime),
+               id => $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);
+               add_to_feed($feed_opts, $feed, $add, $top, $git);
        });
        $feed->as_string;
 }
 
 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 $str = `git cat-file blob $_[0]`;
-               return 0 if $? != 0;
-               my $simple = Email::Simple->new($str);
+               my $simple = do_cat_mail($git, 'Email::Simple', $_[0])
+                       or return 0;
                if ($top && ($simple->header("In-Reply-To") ||
                             $simple->header("References"))) {
                        return 0;
@@ -179,6 +183,10 @@ sub each_recent_blob {
                                last;
                        }
                }
+       } elsif ($reverse) {
+               unshift @commits, undef
+       } else {
+               push @commits, undef;
        }
 
        close $log; # we may EPIPE here
@@ -193,9 +201,13 @@ sub get_feedopts {
        my $listname = $args->{listname};
        my $cgi = $args->{cgi};
        my %rv;
+       if (open my $fh, '<', "$args->{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) || "";
                }
        }
@@ -205,15 +217,15 @@ sub get_feedopts {
                my $base = $cgi->url(-base);
                $url_base = $cgi_url;
                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!!;
+                       $url_base =~ s!/atom\.xml\z!!;
                        $rv{atomurl} = $base . $cgi_url;
                        $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/";
@@ -235,19 +247,14 @@ sub feed_date {
        my ($date) = @_;
        my @t = eval { strptime($date) };
 
-       scalar(@t) ? strftime(DATEFMT, @t) : 0;
+       scalar(@t) ? POSIX::strftime(DATEFMT, @t) : 0;
 }
 
 # returns 0 (skipped) or 1 (added)
 sub add_to_feed {
-       my ($feed_opts, $feed, $add, $top) = @_;
-
-       # we can use git cat-file --batch if performance becomes a
-       # problem, but I doubt it...
-       my $str = `git cat-file blob $add`;
-       return 0 if $? != 0;
-       my $mime = Email::MIME->new($str);
+       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;
        }
@@ -255,11 +262,13 @@ sub add_to_feed {
        my $midurl = $feed_opts->{midurl} || 'http://example.com/m/';
        my $fullurl = $feed_opts->{fullurl} || 'http://example.com/f/';
 
-       my $content = PublicInbox::View->as_feed_entry($mime, $fullurl);
-       defined($content) or return 0;
-
        my $mid = utf8_header($mime, "Message-ID") or return 0;
-       $mid =~ s/\A<//; $mid =~ s/>\z//;
+       # FIXME: refactor
+       my (undef, $href) = PublicInbox::View::trim_message_id($mid);
+
+       my $content = PublicInbox::View->as_feed_entry($mime,
+                                                       "$fullurl$href.html");
+       defined($content) or return 0;
 
        my $subject = utf8_header($mime, "Subject") || "";
        length($subject) or return 0;
@@ -272,7 +281,6 @@ sub add_to_feed {
        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;
@@ -281,7 +289,7 @@ sub add_to_feed {
                title => $subject,
                updated => $date,
                content => { type => "html", content => $content },
-               link => $url,
+               link => $midurl . $href,
                id => $add,
        );
        1;
@@ -289,14 +297,14 @@ sub add_to_feed {
 
 sub dump_html_line {
        my ($self, $level, $args) = @_; # args => [ $html, $midurl ]
-       $args->[0] .= (' ' x $level);
        if ($self->message) {
+               $args->[0] .= (' ' x $level);
                my $simple = $self->message;
                my $subj = utf8_header($simple, "Subject");
                my $mid = utf8_header($simple, "Message-ID");
                $mid =~ s/\A<//;
                $mid =~ s/>\z//;
-               my $url = $args->[1] . uri_escape($mid);
+               my $url = $args->[1] . xs_html(uri_escape($mid));
                my $from = utf8_header($simple, "From");
                my @from = Email::Address->parse($from);
                $from = $from[0]->name;
@@ -304,8 +312,6 @@ sub dump_html_line {
                $from = xs_html($from);
                $subj = xs_html($subj);
                $args->[0] .= "<a href=\"$url.html\">$subj</a> $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;
@@ -316,4 +322,26 @@ sub xs_html {
                        Encode::HTMLCREF);
 }
 
+sub try_git_pm {
+       my ($dir) = @_;
+       eval { Git->repository(Directory => $dir) };
+};
+
+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);
+               close $fh or die "failed to close string handle: $!\n";
+               return if $bytes <= 0;
+       } else {
+               $str = `git cat-file blob $sha1`;
+               return if $? != 0 || length($str) == 0;
+       }
+       $class->new($str);
+}
+
 1;