1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
|
#!/usr/bin/perl
# Blog aggregation plugin.
package IkiWiki::Plugin::aggregate;
use warnings;
use strict;
use IkiWiki;
my %feeds;
my %guids;
sub import { #{{{
IkiWiki::hook(type => "getopt", id => "aggregate",
call => \&getopt);
IkiWiki::hook(type => "checkconfig", id => "aggregate",
call => \&checkconfig);
IkiWiki::hook(type => "filter", id => "aggregate",
call => \&filter);
IkiWiki::hook(type => "preprocess", id => "aggregate",
call => \&preprocess);
IkiWiki::hook(type => "delete", id => "aggregate",
call => \&delete);
IkiWiki::hook(type => "savestate", id => "aggregate",
call => \&savestate);
} # }}}
sub getopt () { #{{{
eval q{use Getopt::Long};
Getopt::Long::Configure('pass_through');
GetOptions("aggregate" => \$IkiWiki::config{aggregate});
} #}}}
sub checkconfig () { #{{{
loadstate();
if ($IkiWiki::config{aggregate}) {
IkiWiki::loadindex();
aggregate();
savestate();
}
} #}}}
sub filter (@) { #{{{
my %params=@_;
my $page=$params{page};
# Mark all feeds originating on this page as removable;
# preprocess will unmark those that still exist.
remove_feeds($page);
return $params{content};
} # }}}
sub preprocess (@) { #{{{
my %params=@_;
foreach my $required (qw{name url}) {
if (! exists $params{$required}) {
return "[[aggregate plugin missing $required parameter]]";
}
}
my $feed={};
my $name=$params{name};
if (exists $feeds{$name}) {
$feed=$feeds{$name};
}
else {
$feeds{$name}=$feed;
}
$feed->{name}=$name;
$feed->{sourcepage}=$params{page};
$feed->{url}=$params{url};
my $dir=exists $params{dir} ? $params{dir} : IkiWiki::titlepage($params{name});
$dir=~s/^\/+//;
($dir)=$dir=~/$IkiWiki::config{wiki_file_regexp}/;
$feed->{dir}=$dir;
$feed->{feedurl}=defined $params{feedurl} ? $params{feedurl} : "";
$feed->{updateinterval}=defined $params{updateinterval} ? $params{updateinterval} * 60 : 15 * 60;
$feed->{expireage}=defined $params{expireage} ? $params{expireage} : 0;
$feed->{expirecount}=defined $params{expirecount} ? $params{expirecount} : 0;
delete $feed->{remove};
$feed->{lastupdate}=0 unless defined $feed->{lastupdate};
$feed->{numposts}=0 unless defined $feed->{numposts};
$feed->{newposts}=0 unless defined $feed->{newposts};
$feed->{message}="new feed" unless defined $feed->{message};
$feed->{tags}=[];
while (@_) {
my $key=shift;
my $value=shift;
if ($key eq 'tag') {
push @{$feed->{tags}}, $value;
}
}
return "<a href=\"".$feed->{url}."\">".$feed->{name}."</a>: ".
"<i>".$feed->{message}."</i> (".$feed->{numposts}.
" stored posts; ".$feed->{newposts}." new)<br />";
} # }}}
sub delete (@) { #{{{
my @files=@_;
# Remove feed data for removed pages.
foreach my $file (@files) {
my $page=IkiWiki::pagename($file);
remove_feeds($page);
}
} #}}}
sub loadstate () { #{{{
eval q{use HTML::Entities};
die $@ if $@;
if (-e "$IkiWiki::config{wikistatedir}/aggregate") {
open (IN, "$IkiWiki::config{wikistatedir}/aggregate" ||
die "$IkiWiki::config{wikistatedir}/aggregate: $!");
while (<IN>) {
$_=IkiWiki::possibly_foolish_untaint($_);
chomp;
my $data={};
foreach my $i (split(/ /, $_)) {
my ($field, $val)=split(/=/, $i, 2);
if ($field eq "name" || $field eq "feed" ||
$field eq "guid" || $field eq "message") {
$data->{$field}=decode_entities($val, " \t\n");
}
elsif ($field eq "tag") {
push @{$data->{tags}}, $val;
}
else {
$data->{$field}=$val;
}
}
if (exists $data->{name}) {
$feeds{$data->{name}}=$data;
}
elsif (exists $data->{guid}) {
$guids{$data->{guid}}=$data;
}
}
close IN;
}
} #}}}
sub savestate () { #{{{
eval q{use HTML::Entities};
die $@ if $@;
open (OUT, ">$IkiWiki::config{wikistatedir}/aggregate" ||
die "$IkiWiki::config{wikistatedir}/aggregate: $!");
foreach my $data (values %feeds, values %guids) {
if ($data->{remove}) {
if ($data->{name}) {
foreach my $guid (values %guids) {
if ($guid->{feed} eq $data->{name}) {
$guid->{remove}=1;
}
}
}
else {
unlink pagefile($data->{page});
}
next;
}
my @line;
foreach my $field (keys %$data) {
if ($field eq "name" || $field eq "feed" ||
$field eq "guid" || $field eq "message") {
push @line, "$field=".encode_entities($data->{$field}, " \t\n");
}
elsif ($field eq "tags") {
push @line, "tag=$_" foreach @{$data->{tags}};
}
else {
push @line, "$field=".$data->{$field};
}
}
print OUT join(" ", @line)."\n";
}
close OUT;
} #}}}
sub aggregate () { #{{{
eval q{use XML::Feed};
die $@ if $@;
eval q{use HTML::Entities};
die $@ if $@;
foreach my $feed (values %feeds) {
next unless time - $feed->{lastupdate} >= $feed->{updateinterval};
$feed->{lastupdate}=time;
$feed->{newposts}=0;
$IkiWiki::forcerebuild{$feed->{sourcepage}}=1;
IkiWiki::debug("checking feed ".$feed->{name}." ...");
if (! length $feed->{feedurl}) {
my @urls=XML::Feed->find_feeds($feed->{url});
if (! @urls) {
$feed->{message}="could not find feed at ".$feed->{feedurl};
IkiWiki::debug($feed->{message});
next;
}
$feed->{feedurl}=pop @urls;
}
my $f=eval{XML::Feed->parse(URI->new($feed->{feedurl}))};
if ($@) {
$feed->{message}="feed crashed XML::Feed! $@";
IkiWiki::debug($feed->{message});
next;
}
if (! $f) {
$feed->{message}=XML::Feed->errstr;
IkiWiki::debug($feed->{message});
next;
}
foreach my $entry ($f->entries) {
add_page(
feed => $feed,
title => defined $entry->title ? decode_entities($entry->title) : "untitled",
link => $entry->link,
content => $entry->content->body,
guid => defined $entry->id ? $entry->id : time."_".$feed->name,
ctime => $entry->issued ? ($entry->issued->epoch || time) : time,
);
}
$feed->{message}="processed ok";
}
# TODO: expiry
} #}}}
sub add_page (@) { #{{{
my %params=@_;
my $feed=$params{feed};
my $guid={};
my $mtime;
if (exists $guids{$params{guid}}) {
# updating an existing post
$guid=$guids{$params{guid}};
}
else {
# new post
$guid->{guid}=$params{guid};
$guids{$params{guid}}=$guid;
$mtime=$params{ctime};
$feed->{numposts}++;
$feed->{newposts}++;
# assign it an unused page
my $page=$feed->{dir}."/".IkiWiki::titlepage($params{title});
$page=lc($page);
($page)=$page=~/$IkiWiki::config{wiki_file_regexp}/;
if (! defined $page || ! length $page) {
$page=$feed->{dir}."/item";
}
$page=~s/\.\.//g; # avoid ".." directory tricks
my $c="";
while (exists $IkiWiki::pagesources{$page.$c} ||
-e pagefile($page.$c)) {
$c++
}
$guid->{page}=$page;
IkiWiki::debug("creating new page $page");
}
$guid->{feed}=$feed->{name};
# To write or not to write? Need to avoid writing unchanged pages
# to avoid unneccessary rebuilding. The mtime from rss cannot be
# trusted; let's use a digest.
eval q{use Digest::MD5 'md5_hex'};
require Encode;
my $digest=md5_hex(Encode::encode_utf8($params{content}));
return unless ! exists $guid->{md5} || $guid->{md5} ne $digest;
$guid->{md5}=$digest;
# Create the page.
my $template=IkiWiki::template("aggregatepost.tmpl", blind_cache => 1);
my $content=$params{content};
$params{content}=~s/(?<!\\)\[\[/\\\[\[/g; # escape accidental wikilinks
# and preprocessor stuff
$template->param(content => $params{content});
$template->param(url => $feed->{url});
$template->param(name => $feed->{name});
$template->param(link => $params{link}) if defined $params{link};
if (ref $feed->{tags}) {
$template->param(tags => [map { tag => $_ }, @{$feed->{tags}}]);
}
IkiWiki::writefile($guid->{page}.".html", $IkiWiki::config{srcdir},
$template->output);
# Set the mtime, this lets the build process get the right creation
# time on record for the new page.
utime $mtime, $mtime, pagefile($guid->{page}) if defined $mtime;
} #}}}
sub remove_feeds () { #{{{
my $page=shift;
my %removed;
foreach my $id (keys %feeds) {
if ($feeds{$id}->{sourcepage} eq $page) {
$feeds{$id}->{remove}=1;
$removed{$id}=1;
}
}
} #}}}
sub pagefile ($) { #{{{
my $page=shift;
return "$IkiWiki::config{srcdir}/$page.html";
} #}}}
1
|