1 # Copyright (C) 2013, Eric Wong <normalperson@yhbt.net> and all contributors
2 # License: AGPLv3 or later (https://www.gnu.org/licenses/agpl-3.0.txt)
3 package PublicInbox::Feed;
7 use URI::Escape qw/uri_escape/;
8 use Encode qw/find_encoding/;
9 use Encode::MIME::Header;
10 use CGI qw(escapeHTML);
11 use Date::Parse qw(strptime str2time);
12 eval { require Git }; # this is GPLv2+, so we are OK to use it
14 DATEFMT => '%Y-%m-%dT%H:%M:%SZ',
17 my $enc_utf8 = find_encoding('utf8');
18 my $enc_ascii = find_encoding('us-ascii');
19 my $enc_mime = find_encoding('MIME-Header');
21 # FIXME: workaround https://rt.cpan.org/Public/Bug/Display.html?id=22817
25 my ($class, $args) = @_;
26 require XML::Atom::SimpleFeed;
27 require PublicInbox::View;
30 my $max = $args->{max} || MAX_PER_PAGE;
31 my $top = $args->{top}; # bool
33 local $ENV{GIT_DIR} = $args->{git_dir};
34 my $feed_opts = get_feedopts($args);
35 my $addr = $feed_opts->{address};
36 $addr = $addr->[0] if ref($addr);
37 my $feed = XML::Atom::SimpleFeed->new(
38 title => $feed_opts->{description} || "unnamed feed",
39 link => $feed_opts->{url} || "http://example.com/",
42 href => $feed_opts->{atomurl} ||
43 "http://example.com/atom.xml",
45 id => $addr || 'public-inbox@example.com',
46 updated => POSIX::strftime(DATEFMT, gmtime),
49 my $git = try_git_pm($args->{git_dir});
50 each_recent_blob($args, sub {
52 add_to_feed($feed_opts, $feed, $add, $top, $git);
57 sub generate_html_index {
58 my ($class, $args) = @_;
61 my $max = $args->{max} || MAX_PER_PAGE;
62 my $top = $args->{top}; # bool
63 local $ENV{GIT_DIR} = $args->{git_dir};
64 my $feed_opts = get_feedopts($args);
65 my $title = xs_html($feed_opts->{description} || "");
67 my $git = try_git_pm($args->{git_dir});
68 my ($first, $last) = each_recent_blob($args, sub {
69 my $simple = do_cat_mail($git, 'Email::Simple', $_[0])
71 if ($top && ($simple->header("In-Reply-To") ||
72 $simple->header("References"))) {
75 $simple->body_set(""); # save some memory
77 my $t = eval { str2time($simple->header('Date')) };
78 defined($t) or $t = 0;
79 $simple->header_set('X-PI-Date', $t);
80 push @messages, $simple;
84 my $th = Mail::Thread->new(@messages);
87 "<html><head><title>$title</title>" .
88 '<link rel=alternate title=Atom.feed href="' .
89 $feed_opts->{atomurl} . '" type="application/atom+xml"/>' .
90 '</head><body><pre>');
91 push @out, $feed_opts->{midurl};
93 # sort by date, most recent at top
96 $b->topmost->message->header('X-PI-Date') <=>
97 $a->topmost->message->header('X-PI-Date')
100 dump_html_line($_, 0, \@out) for $th->rootset;
102 my $footer = nav_footer($args->{cgi}, $first, $last);
103 $footer = "<hr /><pre>$footer</pre>" if $footer;
104 $out[0] . "</pre>$footer</html>";
110 my ($cgi, $first, $last) = @_;
112 my $old_r = $cgi->param('r');
115 my %opts = (-path => 1, -query => 1, -relative => 1);
118 $cgi->param('r', $last);
119 $next = $cgi->url(%opts);
120 $next = qq!<a href="$next">next</a>!;
122 if ($first && $old_r) {
123 $cgi->param('r', "$first..");
124 $prev = $cgi->url(%opts);
125 $prev = qq!<a href="$prev">prev</a>!;
130 sub each_recent_blob {
131 my ($args, $cb) = @_;
132 my $max = $args->{max} || MAX_PER_PAGE;
133 my $refhex = qr/[a-f0-9]{4,40}(?:~\d+)?/;
134 my $cgi = $args->{cgi};
136 # revision ranges may be specified
139 my $r = $cgi->param('r') if $cgi;
141 if ($r =~ /\A(?:$refhex\.\.)?$refhex\z/o) {
143 } elsif ($r =~ /\A(?:$refhex\.\.)\z/o) {
149 # get recent messages
150 # we could use git log -z, but, we already know ssoma will not
151 # leave us with filenames with spaces in them..
152 my @cmd = qw/git log --no-notes --no-color --raw -r --no-abbrev/;
153 push @cmd, '--reverse' if $reverse;
157 my $pid = open(my $log, '-|', @cmd) or
158 die('open `'.join(' ', @cmd) . " pipe failed: $!\n");
163 while (my $line = <$log>) {
164 if ($line =~ /^:000000 100644 0{40} ([a-f0-9]{40})/) {
166 next if $deleted{$add};
172 } elsif ($line =~ /^:100644 000000 ([a-f0-9]{40}) 0{40}/) {
174 } elsif ($line =~ /^commit ([a-f0-9]{40})/) {
180 while (my $line = <$log>) {
181 if ($line =~ /^commit ([a-f0-9]{40})/) {
187 unshift @commits, undef
189 push @commits, undef;
192 close $log; # we may EPIPE here
194 $reverse ? ($commits[-1],$commits[0]) : ($commits[0],$commits[-1]);
197 # private functions below
200 my $pi_config = $args->{pi_config};
201 my $listname = $args->{listname};
202 my $cgi = $args->{cgi};
204 if (open my $fh, '<', "$args->{git_dir}/description") {
205 chomp($rv{description} = <$fh>);
209 if ($pi_config && defined $listname && length $listname) {
210 foreach my $key (qw(address)) {
211 $rv{$key} = $pi_config->get($listname, $key) || "";
216 my $cgi_url = $cgi->url(-path=>1, -relative=>1);
217 my $base = $cgi->url(-base);
218 $url_base = $cgi_url;
219 if ($url_base =~ s!/(?:|index\.html)?\z!!) {
220 $rv{atomurl} = "$base$url_base/atom.xml";
222 $url_base =~ s!/atom\.xml\z!!;
223 $rv{atomurl} = $base . $cgi_url;
224 $url_base = $base . $url_base; # XXX is this needed?
227 $url_base = "http://example.com";
228 $rv{atomurl} = "$url_base/atom.xml";
230 $rv{url} ||= "$url_base/";
231 $rv{midurl} = "$url_base/m/";
232 $rv{fullurl} = "$url_base/f/";
238 my ($simple, $name) = @_;
239 my $val = $simple->header($name);
240 return "" unless defined $val;
241 $val =~ tr/\t\n / /s;
243 $enc_utf8->encode($enc_mime->decode($val));
248 my @t = eval { strptime($date) };
250 scalar(@t) ? POSIX::strftime(DATEFMT, @t) : 0;
253 # returns 0 (skipped) or 1 (added)
255 my ($feed_opts, $feed, $add, $top, $git) = @_;
257 my $mime = do_cat_mail($git, 'Email::MIME', $add) or return 0;
258 if ($top && $mime->header("In-Reply-To")) {
262 my $midurl = $feed_opts->{midurl} || 'http://example.com/m/';
263 my $fullurl = $feed_opts->{fullurl} || 'http://example.com/f/';
265 my $content = PublicInbox::View->as_feed_entry($mime, $fullurl);
266 defined($content) or return 0;
268 my $mid = utf8_header($mime, "Message-ID") or return 0;
269 $mid =~ s/\A<//; $mid =~ s/>\z//;
271 my $subject = utf8_header($mime, "Subject") || "";
272 length($subject) or return 0;
274 my $from = utf8_header($mime, "From") or return 0;
276 my @from = Email::Address->parse($from);
277 my $name = $from[0]->name;
278 defined $name or $name = "";
279 my $email = $from[0]->address;
280 defined $email or $email = "";
282 my $url = $midurl . uri_escape($mid);
283 my $date = utf8_header($mime, "Date");
285 $date = feed_date($date) or return 0;
287 author => { name => $name, email => $email },
290 content => { type => "html", content => $content },
298 my ($self, $level, $args) = @_; # args => [ $html, $midurl ]
299 if ($self->message) {
300 $args->[0] .= (' ' x $level);
301 my $simple = $self->message;
302 my $subj = utf8_header($simple, "Subject");
303 my $mid = utf8_header($simple, "Message-ID");
306 my $url = $args->[1] . uri_escape($mid);
307 my $from = utf8_header($simple, "From");
308 my @from = Email::Address->parse($from);
309 $from = $from[0]->name;
310 (defined($from) && length($from)) or $from = $from[0]->address;
311 $from = xs_html($from);
312 $subj = xs_html($subj);
313 $args->[0] .= "<a href=\"$url.html\">$subj</a> $from\n";
315 dump_html_line($self->child, $level+1, $args) if $self->child;
316 dump_html_line($self->next, $level, $args) if $self->next;
320 $enc_ascii->encode(escapeHTML($enc_utf8->decode($_[0])),
326 eval { Git->repository(Directory => $dir) };
330 my ($git, $class, $sha1) = @_;
333 open my $fh, '>', \$str or
334 die "failed to setup string handle: $!\n";
336 my $bytes = $git->cat_blob($sha1, $fh);
337 close $fh or die "failed to close string handle: $!\n";
338 return if $bytes <= 0;
340 $str = `git cat-file blob $sha1`;
341 return if $? != 0 || length($str) == 0;