]> Sergey Matveev's repositories - public-inbox.git/blobdiff - lib/PublicInbox/Feed.pm
add various TODO items
[public-inbox.git] / lib / PublicInbox / Feed.pm
index 3bee3a517dafd0ef86da3668b81c527593a14e25..6996f374e555a4f55d565fda80fe3b119369e3b0 100644 (file)
@@ -7,14 +7,12 @@ 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 PublicInbox::GitCatFile;
 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) = @_;
@@ -22,9 +20,7 @@ sub generate {
        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);
@@ -36,39 +32,34 @@ sub generate {
                        href => $feed_opts->{atomurl} ||
                                "http://example.com/atom.xml",
                },
-               id => $addr || 'public-inbox@example.com',
+               id => 'mailto:' . ($addr || 'public-inbox@example.com'),
                updated => POSIX::strftime(DATEFMT, gmtime),
        );
 
-       my $git = try_git_pm($args->{git_dir});
+       my $git = PublicInbox::GitCatFile->new($args->{git_dir});
        each_recent_blob($args, sub {
                my ($add) = @_;
-               add_to_feed($feed_opts, $feed, $add, $top, $git);
+               add_to_feed($feed_opts, $feed, $add, $git);
        });
+       $git = undef; # destroy pipes
+       Email::Address->purge_cache;
        $feed->as_string;
 }
 
 sub generate_html_index {
        my ($class, $args) = @_;
-       require Mail::Thread;
+       require PublicInbox::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;
-               }
+       my $git = PublicInbox::GitCatFile->new($args->{git_dir});
+       my $last = each_recent_blob($args, sub {
+               my $mime = do_cat_mail($git, $_[0]) or return 0;
                $mime->body_set(''); # save some memory
 
                my $t = eval { str2time($mime->header('Date')) };
@@ -77,15 +68,14 @@ sub generate_html_index {
                push @messages, $mime;
                1;
        });
+       $git = undef; # destroy pipes.
 
-       my $th = Mail::Thread->new(@messages);
+       my $th = PublicInbox::Thread->new(@messages);
        $th->thread;
-       my @out = (
-               "<html><head><title>$title</title>" .
-               '<link rel=alternate title=Atom.feed href="' .
+       my $html = "<html><head><title>$title</title>" .
+               '<link rel="alternate" title="Atom feed" href="' .
                $feed_opts->{atomurl} . '" type="application/atom+xml"/>' .
-               '</head><body><pre>');
-       push @out, $feed_opts->{midurl};
+               '</head><body><pre>';
 
        # sort by date, most recent at top
        $th->order(sub {
@@ -94,71 +84,65 @@ sub generate_html_index {
                        $a->topmost->message->header('X-PI-Date')
                } @_;
        });
-       dump_html_line($_, 0, \@out) for $th->rootset;
+       dump_html_line($_, 0, \$html) for $th->rootset;
 
-       my $footer = nav_footer($args->{cgi}, $first, $last);
+       Email::Address->purge_cache;
+
+       my $footer = nav_footer($args->{cgi}, $last);
        $footer = "<hr /><pre>$footer</pre>" if $footer;
-       $out[0] . "</pre>$footer</html>";
+       $html . "</pre>$footer</html>";
 }
 
 # private subs
 
 sub nav_footer {
-       my ($cgi, $first, $last) = @_;
+       my ($cgi, $last) = @_;
        $cgi or return '';
        my $old_r = $cgi->param('r');
-       my $prev = '    ';
+       my $head = '    ';
        my $next = '    ';
-       my %opts = (-path => 1, -query => 1, -relative => 1);
 
        if ($last) {
-               $cgi->param('r', $last);
-               $next = $cgi->url(%opts);
-               $next = qq!<a href="$next">next</a>!;
+               $next = qq!<a href="?r=$last">next</a>!;
        }
-       if ($first && $old_r) {
-               $cgi->param('r', "$first..");
-               $prev = $cgi->url(%opts);
-               $prev = qq!<a href="$prev">prev</a>!;
+       if ($old_r) {
+               $head = $cgi->path_info;
+               $head = qq!<a href="$head">head</a>!;
        }
-       "$prev $next";
+       "$next $head";
 }
 
 sub each_recent_blob {
        my ($args, $cb) = @_;
        my $max = $args->{max} || MAX_PER_PAGE;
-       my $refhex = qr/[a-f0-9]{4,40}(?:~\d+)?/;
+       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};
 
        # 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=$args->{git_dir}",
+                       qw/log --no-notes --no-color --raw -r/);
        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})/) {
+               if ($line =~ /$addmsg/o) {
                        my $add = $1;
                        next if $deleted{$add};
                        $nr += $cb->($add);
@@ -166,29 +150,27 @@ sub each_recent_blob {
                                $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})/) {
+               } elsif ($line =~ /^commit (${hex}{40})/) {
                        push @commits, $1;
                }
        }
 
        if ($last) {
                while (my $line = <$log>) {
-                       if ($line =~ /^commit ([a-f0-9]{40})/) {
+                       if ($line =~ /^commit (${hex}{40})/) {
                                push @commits, $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]);
+       $commits[-1];
 }
 
 # private functions below
@@ -210,14 +192,20 @@ sub get_feedopts {
        }
        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/atom.xml";
                } else {
                        $url_base =~ s!/atom\.xml\z!!;
-                       $rv{atomurl} = $base . $cgi_url;
+                       $rv{atomurl} = $base . $path_info;
                        $url_base = $base . $url_base; # XXX is this needed?
                }
        } else {
@@ -245,22 +233,17 @@ sub feed_date {
 
 # returns 0 (skipped) or 1 (added)
 sub add_to_feed {
-       my ($feed_opts, $feed, $add, $top, $git) = @_;
+       my ($feed_opts, $feed, $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 $mid = $mime->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");
+       my $href = $mid->as_href . '.html';
+       my $content = PublicInbox::View->feed_entry($mime, $fullurl . $href);
        defined($content) or return 0;
 
        my $subject = mime_header($mime, 'Subject') or return 0;
@@ -275,26 +258,30 @@ sub add_to_feed {
        my $date = $mime->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 => "html", content => $content },
+               content => { type => 'xhtml', content => $content },
                link => $midurl . $href,
-               id => $add,
+               id => 'urn:uuid:' . join('-', @uuid5),
        );
        1;
 }
 
 sub dump_html_line {
-       my ($self, $level, $args) = @_; # args => [ $html, $midurl ]
+       my ($self, $level, $html) = @_;
        if ($self->message) {
-               $args->[0] .= (' ' x $level);
+               $$html .= (' ' 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 $href = 'm/' . $mid->as_href . '.html';
                my $from = mime_header($mime, 'From');
 
                my @from = Email::Address->parse($from);
@@ -303,31 +290,15 @@ sub dump_html_line {
 
                $from = PublicInbox::Hval->new_oneline($from)->as_html;
                $subj = PublicInbox::Hval->new_oneline($subj)->as_html;
-               $args->[0] .= "<a href=\"$url.html\">$subj</a> $from\n";
+               $$html .= "<a href=\"$href\">$subj</a> $from\n";
        }
-       dump_html_line($self->child, $level+1, $args) if $self->child;
-       dump_html_line($self->next, $level, $args) if $self->next;
+       dump_html_line($self->child, $level+1, $html) if $self->child;
+       dump_html_line($self->next, $level, $html) if $self->next;
 }
 
-sub try_git_pm {
-       my ($dir) = @_;
-       eval { Git->repository(Directory => $dir) };
-};
-
 sub do_cat_mail {
-       my ($git, $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;
-       }
+       my ($git, $path) = @_;
+       my $str = $git->cat_file("HEAD:$path");
        Email::MIME->new($str);
 }