2 # Blog aggregation plugin.
3 package IkiWiki::Plugin::aggregate;
13 IkiWiki::hook(type => "getopt", id => "aggregate",
15 IkiWiki::hook(type => "checkconfig", id => "aggregate",
16 call => \&checkconfig);
17 IkiWiki::hook(type => "filter", id => "aggregate",
19 IkiWiki::hook(type => "preprocess", id => "aggregate",
20 call => \&preprocess);
21 IkiWiki::hook(type => "delete", id => "aggregate",
23 IkiWiki::hook(type => "savestate", id => "aggregate",
28 eval q{use Getopt::Long};
29 Getopt::Long::Configure('pass_through');
30 GetOptions("aggregate" => \$IkiWiki::config{aggregate});
33 sub checkconfig () { #{{{
35 if ($IkiWiki::config{aggregate}) {
44 my $page=$params{page};
46 # Mark all feeds originating on this page as removable;
47 # preprocess will unmark those that still exist.
50 return $params{content};
53 sub preprocess (@) { #{{{
56 foreach my $required (qw{name url}) {
57 if (! exists $params{$required}) {
58 return "[[aggregate plugin missing $required parameter]]";
63 my $name=$params{name};
64 if (exists $feeds{$name}) {
71 $feed->{sourcepage}=$params{page};
72 $feed->{url}=$params{url};
73 my $dir=exists $params{dir} ? $params{dir} : $params{page}."/".IkiWiki::titlepage($params{name});
75 ($dir)=$dir=~/$IkiWiki::config{wiki_file_regexp}/;
77 $feed->{feedurl}=defined $params{feedurl} ? $params{feedurl} : "";
78 $feed->{updateinterval}=defined $params{updateinterval} ? $params{updateinterval} * 60 : 15 * 60;
79 $feed->{expireage}=defined $params{expireage} ? $params{expireage} : 0;
80 $feed->{expirecount}=defined $params{expirecount} ? $params{expirecount} : 0;
81 delete $feed->{remove};
82 $feed->{lastupdate}=0 unless defined $feed->{lastupdate};
83 $feed->{numposts}=0 unless defined $feed->{numposts};
84 $feed->{newposts}=0 unless defined $feed->{newposts};
85 $feed->{message}="new feed" unless defined $feed->{message};
91 push @{$feed->{tags}}, $value;
95 return "<a href=\"".$feed->{url}."\">".$feed->{name}."</a>: ".
96 "<i>".$feed->{message}."</i> (".$feed->{numposts}.
97 " stored posts; ".$feed->{newposts}." new)<br />";
100 sub delete (@) { #{{{
103 # Remove feed data for removed pages.
104 foreach my $file (@files) {
105 my $page=IkiWiki::pagename($file);
110 sub loadstate () { #{{{
111 if (-e "$IkiWiki::config{wikistatedir}/aggregate") {
112 open (IN, "$IkiWiki::config{wikistatedir}/aggregate" ||
113 die "$IkiWiki::config{wikistatedir}/aggregate: $!");
115 $_=IkiWiki::possibly_foolish_untaint($_);
118 foreach my $i (split(/ /, $_)) {
119 my ($field, $val)=split(/=/, $i, 2);
120 if ($field eq "name" || $field eq "feed" ||
121 $field eq "guid" || $field eq "message") {
122 $data->{$field}=decode_entities($val, " \t\n");
124 elsif ($field eq "tag") {
125 push @{$data->{tags}}, $val;
128 $data->{$field}=$val;
132 if (exists $data->{name}) {
133 $feeds{$data->{name}}=$data;
135 elsif (exists $data->{guid}) {
136 $guids{$data->{guid}}=$data;
144 sub savestate () { #{{{
145 eval q{use HTML::Entities};
147 open (OUT, ">$IkiWiki::config{wikistatedir}/aggregate" ||
148 die "$IkiWiki::config{wikistatedir}/aggregate: $!");
149 foreach my $data (values %feeds, values %guids) {
150 if ($data->{remove}) {
152 foreach my $guid (values %guids) {
153 if ($guid->{feed} eq $data->{name}) {
159 unlink pagefile($data->{page});
165 foreach my $field (keys %$data) {
166 if ($field eq "name" || $field eq "feed" ||
167 $field eq "guid" || $field eq "message") {
168 push @line, "$field=".encode_entities($data->{$field}, " \t\n");
170 elsif ($field eq "tags") {
171 push @line, "tag=$_" foreach @{$data->{tags}};
174 push @line, "$field=".$data->{$field};
177 print OUT join(" ", @line)."\n";
182 sub aggregate () { #{{{
183 eval q{use XML::Feed};
185 eval q{use HTML::Entities};
188 foreach my $feed (values %feeds) {
189 next unless $IkiWiki::config{rebuild} ||
190 time - $feed->{lastupdate} >= $feed->{updateinterval};
191 $feed->{lastupdate}=time;
193 $IkiWiki::forcerebuild{$feed->{sourcepage}}=1;
195 IkiWiki::debug("checking feed ".$feed->{name}." ...");
197 if (! length $feed->{feedurl}) {
198 my @urls=XML::Feed->find_feeds($feed->{url});
200 $feed->{message}="could not find feed at ".$feed->{feedurl};
201 IkiWiki::debug($feed->{message});
204 $feed->{feedurl}=pop @urls;
206 my $f=eval{XML::Feed->parse(URI->new($feed->{feedurl}))};
208 $feed->{message}="feed crashed XML::Feed! $@";
209 IkiWiki::debug($feed->{message});
213 $feed->{message}=XML::Feed->errstr;
214 IkiWiki::debug($feed->{message});
218 foreach my $entry ($f->entries) {
221 title => defined $entry->title ? decode_entities($entry->title) : "untitled",
222 link => $entry->link,
223 content => $entry->content->body,
224 guid => defined $entry->id ? $entry->id : time."_".$feed->name,
225 ctime => $entry->issued ? ($entry->issued->epoch || time) : time,
229 $feed->{message}="processed ok";
235 sub add_page (@) { #{{{
238 my $feed=$params{feed};
241 if (exists $guids{$params{guid}}) {
242 # updating an existing post
243 $guid=$guids{$params{guid}};
247 $guid->{guid}=$params{guid};
248 $guids{$params{guid}}=$guid;
249 $mtime=$params{ctime};
253 # assign it an unused page
254 my $page=IkiWiki::titlepage($params{title});
255 # escape slashes and periods in title so it doesn't specify
256 # directory name or trigger ".." disallowing code.
257 $page=~s!([/.])!"__".ord($1)."__"!eg;
258 $page=$feed->{dir}."/".$page;
260 ($page)=$page=~/$IkiWiki::config{wiki_file_regexp}/;
261 if (! defined $page || ! length $page) {
262 $page=$feed->{dir}."/item";
265 while (exists $IkiWiki::pagesources{$page.$c} ||
266 -e pagefile($page.$c)) {
270 IkiWiki::debug("creating new page $page");
272 $guid->{feed}=$feed->{name};
274 # To write or not to write? Need to avoid writing unchanged pages
275 # to avoid unneccessary rebuilding. The mtime from rss cannot be
276 # trusted; let's use a digest.
277 eval q{use Digest::MD5 'md5_hex'};
279 my $digest=md5_hex(Encode::encode_utf8($params{content}));
280 return unless ! exists $guid->{md5} || $guid->{md5} ne $digest || $IkiWiki::config{rebuild};
281 $guid->{md5}=$digest;
284 my $template=IkiWiki::template("aggregatepost.tmpl", blind_cache => 1);
285 my $content=$params{content};
286 $params{content}=~s/(?<!\\)\[\[/\\\[\[/g; # escape accidental wikilinks
287 # and preprocessor stuff
288 $template->param(title => $params{title})
289 if defined $params{title} && length($params{title});
290 $template->param(content => $params{content});
291 $template->param(url => $feed->{url});
292 $template->param(name => $feed->{name});
293 $template->param(link => $params{link}) if defined $params{link};
294 if (ref $feed->{tags}) {
295 $template->param(tags => [map { tag => $_ }, @{$feed->{tags}}]);
297 IkiWiki::writefile($guid->{page}.".html", $IkiWiki::config{srcdir},
300 # Set the mtime, this lets the build process get the right creation
301 # time on record for the new page.
302 utime $mtime, $mtime, pagefile($guid->{page}) if defined $mtime;
305 sub remove_feeds () { #{{{
309 foreach my $id (keys %feeds) {
310 if ($feeds{$id}->{sourcepage} eq $page) {
311 $feeds{$id}->{remove}=1;
317 sub pagefile ($) { #{{{
320 return "$IkiWiki::config{srcdir}/$page.html";