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;
8 use Date::Parse qw(strptime);
10 use PublicInbox::GitCatFile;
11 use PublicInbox::View;
13 DATEFMT => '%Y-%m-%dT%H:%M:%SZ', # atom standard
14 MAX_PER_PAGE => 25, # this needs to be tunable
15 PRE_WRAP => "<pre\nstyle=\"white-space:pre-wrap\">",
20 my ($class, $ctx) = @_;
21 require XML::Atom::SimpleFeed;
23 my $max = $ctx->{max} || MAX_PER_PAGE;
25 my $feed_opts = get_feedopts($ctx);
26 my $addr = $feed_opts->{address};
27 $addr = $addr->[0] if ref($addr);
28 my $feed = XML::Atom::SimpleFeed->new(
29 title => $feed_opts->{description} || "unnamed feed",
30 link => $feed_opts->{url} || "http://example.com/",
33 href => $feed_opts->{atomurl} ||
34 "http://example.com/atom.xml",
36 id => 'mailto:' . ($addr || 'public-inbox@example.com'),
37 updated => POSIX::strftime(DATEFMT, gmtime),
41 my $git = PublicInbox::GitCatFile->new($ctx->{git_dir});
42 each_recent_blob($ctx, sub {
43 my ($add, undef) = @_;
44 add_to_feed($feed_opts, $feed, $add, $git);
46 $git = undef; # destroy pipes
47 Email::Address->purge_cache;
51 sub generate_html_index {
52 my ($class, $ctx) = @_;
54 my $max = $ctx->{max} || MAX_PER_PAGE;
55 my $feed_opts = get_feedopts($ctx);
57 my $title = $feed_opts->{description} || '';
58 $title = PublicInbox::Hval->new_oneline($title)->as_html;
60 my $html = "<html><head><title>$title</title>" .
61 '<link rel="alternate" title="Atom feed"' . "\nhref=\"" .
62 $feed_opts->{atomurl} . "\"\ntype=\"application/atom+xml\"/>" .
63 '</head><body>' . PRE_WRAP;
66 my $git = PublicInbox::GitCatFile->new($ctx->{git_dir});
67 my (undef, $last) = each_recent_blob($ctx, sub {
68 my ($path, $commit) = @_;
69 unless (defined $state) {
70 $state = [ $ctx->{srch}, {}, $commit, 0 ];
72 my $mime = do_cat_mail($git, $_[0]) or return 0;
73 $html .= PublicInbox::View->index_entry($mime, 0, $state);
76 Email::Address->purge_cache;
77 $git = undef; # destroy pipes.
79 my $footer = nav_footer($ctx->{cgi}, $last, $feed_opts, $state);
81 my $list_footer = $ctx->{footer};
82 $footer .= "\n" . $list_footer if $list_footer;
83 $footer = "<hr />" . PRE_WRAP . "$footer</pre>";
85 $html . "</pre>$footer</body></html>";
91 my ($cgi, $last, $feed_opts, $state) = @_;
93 my $old_r = $cgi->param('r');
96 my $first = $state->[2];
97 my $anchor = $state->[3];
100 $next = qq!<a\nhref="?r=$last">next</a>!;
103 $head = $cgi->path_info;
104 $head = qq!<a\nhref="$head">head</a>!;
106 my $atom = "<a\nhref=\"$feed_opts->{atomurl}\">atom</a>";
107 my $permalink = "<a\nhref=\"?r=$first\">permalink</a>";
108 "<a\nname=\"s$anchor\">page:</a> $next $head $atom $permalink";
111 sub each_recent_blob {
113 my $max = $ctx->{max} || MAX_PER_PAGE;
114 my $hex = '[a-f0-9]';
115 my $addmsg = qr!^:000000 100644 \S+ \S+ A\t(${hex}{2}/${hex}{38})$!;
116 my $delmsg = qr!^:100644 000000 \S+ \S+ D\t(${hex}{2}/${hex}{38})$!;
117 my $refhex = qr/${hex}{4,40}(?:~\d+)?/;
118 my $cgi = $ctx->{cgi};
120 # revision ranges may be specified
122 my $r = $cgi->param('r') if $cgi;
123 if ($r && ($r =~ /\A(?:$refhex\.\.)?$refhex\z/o)) {
127 # get recent messages
128 # we could use git log -z, but, we already know ssoma will not
129 # leave us with filenames with spaces in them..
130 my @cmd = ('git', "--git-dir=$ctx->{git_dir}",
131 qw/log --no-notes --no-color --raw -r
132 --abbrev=16 --abbrev-commit/);
135 my $pid = open(my $log, '-|', @cmd) or
136 die('open `'.join(' ', @cmd) . " pipe failed: $!\n");
137 my %deleted; # only an optimization at this point
140 my ($cur_commit, $first_commit, $last_commit);
141 while (my $line = <$log>) {
142 if ($line =~ /$addmsg/o) {
144 next if $deleted{$add}; # optimization-only
145 $nr += $cb->($add, $cur_commit);
150 } elsif ($line =~ /$delmsg/o) {
152 } elsif ($line =~ /^commit (${hex}{7,40})/o) {
154 $first_commit = $1 unless defined $first_commit;
159 while (my $line = <$log>) {
160 if ($line =~ /^commit (${hex}{7,40})/o) {
167 close $log; # we may EPIPE here
169 ($first_commit, $last_commit);
172 # private functions below
175 my $pi_config = $ctx->{pi_config};
176 my $listname = $ctx->{listname};
177 my $cgi = $ctx->{cgi};
179 if (open my $fh, '<', "$ctx->{git_dir}/description") {
180 chomp($rv{description} = <$fh>);
184 if ($pi_config && defined $listname && length $listname) {
185 foreach my $key (qw(address)) {
186 $rv{$key} = $pi_config->get($listname, $key) || "";
191 my $path_info = $cgi->path_info;
193 if (ref($cgi) eq 'CGI') {
194 $base = $cgi->url(-base);
196 $base = $cgi->base->as_string;
199 $url_base = $path_info;
200 if ($url_base =~ s!/(?:|index\.html)?\z!!) {
201 $rv{atomurl} = "$base$url_base/atom.xml";
203 $url_base =~ s!/atom\.xml\z!!;
204 $rv{atomurl} = $base . $path_info;
205 $url_base = $base . $url_base; # XXX is this needed?
208 $url_base = "http://example.com";
209 $rv{atomurl} = "$url_base/atom.xml";
211 $rv{url} ||= "$url_base/";
212 $rv{midurl} = "$url_base/m/";
213 $rv{fullurl} = "$url_base/f/";
219 my ($mime, $name) = @_;
220 PublicInbox::Hval->new_oneline($mime->header($name))->raw;
225 my @t = eval { strptime($date) };
227 scalar(@t) ? POSIX::strftime(DATEFMT, @t) : 0;
230 # returns 0 (skipped) or 1 (added)
232 my ($feed_opts, $feed, $add, $git) = @_;
234 my $mime = do_cat_mail($git, $add) or return 0;
235 my $midurl = $feed_opts->{midurl} || 'http://example.com/m/';
236 my $fullurl = $feed_opts->{fullurl} || 'http://example.com/f/';
238 my $header_obj = $mime->header_obj;
239 my $mid = $header_obj->header_raw('Message-ID');
240 defined $mid or return 0;
241 $mid = PublicInbox::Hval->new_msgid($mid);
242 my $href = $mid->as_href . '.html';
243 my $content = PublicInbox::View->feed_entry($mime, $fullurl . $href);
244 defined($content) or return 0;
247 my $subject = mime_header($header_obj, 'Subject') or return 0;
249 my $from = mime_header($header_obj, 'From') or return 0;
250 my @from = Email::Address->parse($from);
251 my $name = $from[0]->name;
252 defined $name or $name = "";
253 my $email = $from[0]->address;
254 defined $email or $email = "";
256 my $date = $header_obj->header('Date');
257 $date = PublicInbox::Hval->new_oneline($date);
258 $date = feed_date($date->raw) or return 0;
261 my (@uuid5) = ($add =~ m!\A($h{8})($h{4})($h{4})($h{4})($h{12})!o);
264 author => { name => $name, email => $email },
267 content => { type => 'xhtml', content => $content },
268 link => $midurl . $href,
269 id => 'urn:uuid:' . join('-', @uuid5),
275 my ($git, $path) = @_;
277 my $str = $git->cat_file("HEAD:$path");
278 Email::MIME->new($str);