IkiWiki/Plugin/aggregate.pm

   1 #!/usr/bin/perl
   2 # Feed aggregation plugin.
   3 package IkiWiki::Plugin::aggregate;
   4
   5 use warnings;
   6 use strict;
   7 use IkiWiki 3.00;
   8 use HTML::Parser;
   9 use HTML::Tagset;
  10 use HTML::Entities;
  11 use open qw{:utf8 :std};
  12
  13 my %feeds;
  14 my %guids;
  15
  16 sub import {
  17         hook(type => "getopt", id => "aggregate", call => \&getopt);
  18         hook(type => "getsetup", id => "aggregate", call => \&getsetup);
  19         hook(type => "checkconfig", id => "aggregate", call => \&checkconfig,
  20                 last => 1);
  21         hook(type => "needsbuild", id => "aggregate", call => \&needsbuild);
  22         hook(type => "preprocess", id => "aggregate", call => \&preprocess);
  23         hook(type => "delete", id => "aggregate", call => \&delete);
  24         hook(type => "savestate", id => "aggregate", call => \&savestate);
  25         hook(type => "htmlize", id => "_aggregated", call => \&htmlize);
  26         if (exists $config{aggregate_webtrigger} && $config{aggregate_webtrigger}) {
  27                 hook(type => "cgi", id => "aggregate", call => \&cgi);
  28         }
  29 }
  30
  31 sub getopt () {
  32         eval q{use Getopt::Long};
  33         error($@) if $@;
  34         Getopt::Long::Configure('pass_through');
  35         GetOptions(
  36                 "aggregate" => \$config{aggregate},
  37                 "aggregateinternal!" => \$config{aggregateinternal},
  38         );
  39 }
  40
  41 sub getsetup () {
  42         return
  43                 plugin => {
  44                         safe => 1,
  45                         rebuild => undef,
  46                 },
  47                 aggregateinternal => {
  48                         type => "boolean",
  49                         example => 1,
  50                         description => "enable aggregation to internal pages?",
  51                         safe => 0, # enabling needs manual transition
  52                         rebuild => 0,
  53                 },
  54                 aggregate_webtrigger => {
  55                         type => "boolean",
  56                         example => 0,
  57                         description => "allow aggregation to be triggered via the web?",
  58                         safe => 1,
  59                         rebuild => 0,
  60                 },
  61 }
  62
  63 sub checkconfig () {
  64         if (! defined $config{aggregateinternal}) {
  65                 $config{aggregateinternal}=1;
  66         }
  67
  68         # This is done here rather than in a refresh hook because it
  69         # needs to run before the wiki is locked.
  70         if ($config{aggregate} && ! ($config{post_commit} &&
  71                                      IkiWiki::commit_hook_enabled())) {
  72                 launchaggregation();
  73         }
  74 }
  75
  76 sub cgi ($) {
  77         my $cgi=shift;
  78
  79         if (defined $cgi->param('do') &&
  80             $cgi->param("do") eq "aggregate_webtrigger") {
  81                 $|=1;
  82                 print "Content-Type: text/plain\n\n";
  83                 $config{cgi}=0;
  84                 $config{verbose}=1;
  85                 $config{syslog}=0;
  86                 print gettext("Aggregation triggered via web.")."\n\n";
  87                 if (launchaggregation()) {
  88                         IkiWiki::lockwiki();
  89                         IkiWiki::loadindex();
  90                         require IkiWiki::Render;
  91                         IkiWiki::refresh();
  92                         IkiWiki::saveindex();
  93                 }
  94                 else {
  95                         print gettext("Nothing to do right now, all feeds are up-to-date!")."\n";
  96                 }
  97                 exit 0;
  98         }
  99 }
 100
 101 sub launchaggregation () {
 102         # See if any feeds need aggregation.
 103         loadstate();
 104         my @feeds=needsaggregate();
 105         return unless @feeds;
 106         if (! lockaggregate()) {
 107                 error("an aggregation process is already running");
 108         }
 109         # force a later rebuild of source pages
 110         $IkiWiki::forcerebuild{$_->{sourcepage}}=1
 111                 foreach @feeds;
 112
 113         # Fork a child process to handle the aggregation.
 114         # The parent process will then handle building the
 115         # result. This avoids messy code to clear state
 116         # accumulated while aggregating.
 117         defined(my $pid = fork) or error("Can't fork: $!");
 118         if (! $pid) {
 119                 IkiWiki::loadindex();
 120                 # Aggregation happens without the main wiki lock
 121                 # being held. This allows editing pages etc while
 122                 # aggregation is running.
 123                 aggregate(@feeds);
 124
 125                 IkiWiki::lockwiki;
 126                 # Merge changes, since aggregation state may have
 127                 # changed on disk while the aggregation was happening.
 128                 mergestate();
 129                 expire();
 130                 savestate();
 131                 IkiWiki::unlockwiki;
 132                 exit 0;
 133         }
 134         waitpid($pid,0);
 135         if ($?) {
 136                 error "aggregation failed with code $?";
 137         }
 138
 139         clearstate();
 140         unlockaggregate();
 141
 142         return 1;
 143 }
 144
 145 #  Pages with extension _aggregated have plain html markup, pass through.
 146 sub htmlize (@) {
 147         my %params=@_;
 148         return $params{content};
 149 }
 150
 151 # Used by ikiwiki-transition aggregateinternal.
 152 sub migrate_to_internal {
 153         if (! lockaggregate()) {
 154                 error("an aggregation process is currently running");
 155         }
 156
 157         IkiWiki::lockwiki();
 158         loadstate();
 159         $config{verbose}=1;
 160
 161         foreach my $data (values %guids) {
 162                 next unless $data->{page};
 163                 next if $data->{expired};
 164
 165                 $config{aggregateinternal} = 0;
 166                 my $oldname = "$config{srcdir}/".htmlfn($data->{page});
 167                 if (! -e $oldname) {
 168                         $oldname = $IkiWiki::Plugin::transient::transientdir."/".htmlfn($data->{page});
 169                 }
 170
 171                 my $oldoutput = $config{destdir}."/".IkiWiki::htmlpage($data->{page});
 172
 173                 $config{aggregateinternal} = 1;
 174                 my $newname = $IkiWiki::Plugin::transient::transientdir."/".htmlfn($data->{page});
 175
 176                 debug "moving $oldname -> $newname";
 177                 if (-e $newname) {
 178                         if (-e $oldname) {
 179                                 error("$newname already exists");
 180                         }
 181                         else {
 182                                 debug("already renamed to $newname?");
 183                         }
 184                 }
 185                 elsif (-e $oldname) {
 186                         rename($oldname, $newname) || error("$!");
 187                 }
 188                 else {
 189                         debug("$oldname not found");
 190                 }
 191                 if (-e $oldoutput) {
 192                         require IkiWiki::Render;
 193                         debug("removing output file $oldoutput");
 194                         IkiWiki::prune($oldoutput, $config{destdir});
 195                 }
 196         }
 197
 198         savestate();
 199         IkiWiki::unlockwiki;
 200
 201         unlockaggregate();
 202 }
 203
 204 sub needsbuild (@) {
 205         my $needsbuild=shift;
 206
 207         loadstate();
 208
 209         foreach my $feed (values %feeds) {
 210                 if (exists $pagesources{$feed->{sourcepage}} &&
 211                     grep { $_ eq $pagesources{$feed->{sourcepage}} } @$needsbuild) {
 212                         # Mark all feeds originating on this page as
 213                         # not yet seen; preprocess will unmark those that
 214                         # still exist.
 215                         markunseen($feed->{sourcepage});
 216                 }
 217         }
 218
 219         return $needsbuild;
 220 }
 221
 222 sub preprocess (@) {
 223         my %params=@_;
 224
 225         foreach my $required (qw{name url}) {
 226                 if (! exists $params{$required}) {
 227                         error sprintf(gettext("missing %s parameter"), $required)
 228                 }
 229         }
 230
 231         my $feed={};
 232         my $name=$params{name};
 233         if (exists $feeds{$name}) {
 234                 $feed=$feeds{$name};
 235         }
 236         else {
 237                 $feeds{$name}=$feed;
 238         }
 239         $feed->{name}=$name;
 240         $feed->{sourcepage}=$params{page};
 241         $feed->{url}=$params{url};
 242         my $dir=exists $params{dir} ? $params{dir} : $params{page}."/".titlepage($params{name});
 243         $dir=~s/^\/+//;
 244         ($dir)=$dir=~/$config{wiki_file_regexp}/;
 245         $feed->{dir}=$dir;
 246         $feed->{feedurl}=defined $params{feedurl} ? $params{feedurl} : "";
 247         $feed->{updateinterval}=defined $params{updateinterval} ? $params{updateinterval} * 60 : 15 * 60;
 248         $feed->{expireage}=defined $params{expireage} ? $params{expireage} : 0;
 249         $feed->{expirecount}=defined $params{expirecount} ? $params{expirecount} : 0;
 250         if (exists $params{template}) {
 251                 $params{template}=~s/[^-_a-zA-Z0-9]+//g;
 252         }
 253         else {
 254                 $params{template} = "aggregatepost"
 255         }
 256         $feed->{template}=$params{template} . ".tmpl";
 257         delete $feed->{unseen};
 258         $feed->{lastupdate}=0 unless defined $feed->{lastupdate};
 259         $feed->{lasttry}=$feed->{lastupdate} unless defined $feed->{lasttry};
 260         $feed->{numposts}=0 unless defined $feed->{numposts};
 261         $feed->{newposts}=0 unless defined $feed->{newposts};
 262         $feed->{message}=gettext("new feed") unless defined $feed->{message};
 263         $feed->{error}=0 unless defined $feed->{error};
 264         $feed->{tags}=[];
 265         while (@_) {
 266                 my $key=shift;
 267                 my $value=shift;
 268                 if ($key eq 'tag') {
 269                         push @{$feed->{tags}}, $value;
 270                 }
 271         }
 272
 273         return "<a href=\"".$feed->{url}."\">".$feed->{name}."</a>: ".
 274                ($feed->{error} ? "<em>" : "").$feed->{message}.
 275                ($feed->{error} ? "</em>" : "").
 276                " (".$feed->{numposts}." ".gettext("posts").
 277                ($feed->{newposts} ? "; ".$feed->{newposts}.
 278                                     " ".gettext("new") : "").
 279                ")";
 280 }
 281
 282 sub delete (@) {
 283         my @files=@_;
 284
 285         # Remove feed data for removed pages.
 286         foreach my $file (@files) {
 287                 my $page=pagename($file);
 288                 markunseen($page);
 289         }
 290 }
 291
 292 sub markunseen ($) {
 293         my $page=shift;
 294
 295         foreach my $id (keys %feeds) {
 296                 if ($feeds{$id}->{sourcepage} eq $page) {
 297                         $feeds{$id}->{unseen}=1;
 298                 }
 299         }
 300 }
 301
 302 my $state_loaded=0;
 303
 304 sub loadstate () {
 305         return if $state_loaded;
 306         $state_loaded=1;
 307         if (-e "$config{wikistatedir}/aggregate") {
 308                 open(IN, "<", "$config{wikistatedir}/aggregate") ||
 309                         die "$config{wikistatedir}/aggregate: $!";
 310                 while (<IN>) {
 311                         $_=IkiWiki::possibly_foolish_untaint($_);
 312                         chomp;
 313                         my $data={};
 314                         foreach my $i (split(/ /, $_)) {
 315                                 my ($field, $val)=split(/=/, $i, 2);
 316                                 if ($field eq "name" || $field eq "feed" ||
 317                                     $field eq "guid" || $field eq "message") {
 318                                         $data->{$field}=decode_entities($val, " \t\n");
 319                                 }
 320                                 elsif ($field eq "tag") {
 321                                         push @{$data->{tags}}, $val;
 322                                 }
 323                                 else {
 324                                         $data->{$field}=$val;
 325                                 }
 326                         }
 327
 328                         if (exists $data->{name}) {
 329                                 $feeds{$data->{name}}=$data;
 330                         }
 331                         elsif (exists $data->{guid}) {
 332                                 $guids{$data->{guid}}=$data;
 333                         }
 334                 }
 335
 336                 close IN;
 337         }
 338 }
 339
 340 sub savestate () {
 341         return unless $state_loaded;
 342         garbage_collect();
 343         my $newfile="$config{wikistatedir}/aggregate.new";
 344         my $cleanup = sub { unlink($newfile) };
 345         open (OUT, ">", $newfile) || error("open $newfile: $!", $cleanup);
 346         foreach my $data (values %feeds, values %guids) {
 347                 my @line;
 348                 foreach my $field (keys %$data) {
 349                         if ($field eq "name" || $field eq "feed" ||
 350                             $field eq "guid" || $field eq "message") {
 351                                 push @line, "$field=".encode_entities($data->{$field}, " \t\n");
 352                         }
 353                         elsif ($field eq "tags") {
 354                                 push @line, "tag=$_" foreach @{$data->{tags}};
 355                         }
 356                         else {
 357                                 push @line, "$field=".$data->{$field}
 358                                         if defined $data->{$field};
 359                         }
 360                 }
 361                 print OUT join(" ", @line)."\n" || error("write $newfile: $!", $cleanup);
 362         }
 363         close OUT || error("save $newfile: $!", $cleanup);
 364         rename($newfile, "$config{wikistatedir}/aggregate") ||
 365                 error("rename $newfile: $!", $cleanup);
 366
 367         my $timestamp=undef;
 368         foreach my $feed (keys %feeds) {
 369                 my $t=$feeds{$feed}->{lastupdate}+$feeds{$feed}->{updateinterval};
 370                 if (! defined $timestamp || $timestamp > $t) {
 371                         $timestamp=$t;
 372                 }
 373         }
 374         $newfile=~s/\.new$/time/;
 375         open (OUT, ">", $newfile) || error("open $newfile: $!", $cleanup);
 376         if (defined $timestamp) {
 377                 print OUT $timestamp."\n";
 378         }
 379         close OUT || error("save $newfile: $!", $cleanup);
 380 }
 381
 382 sub garbage_collect () {
 383         foreach my $name (keys %feeds) {
 384                 # remove any feeds that were not seen while building the pages
 385                 # that used to contain them
 386                 if ($feeds{$name}->{unseen}) {
 387                         delete $feeds{$name};
 388                 }
 389         }
 390
 391         foreach my $guid (values %guids) {
 392                 # any guid whose feed is gone should be removed
 393                 if (! exists $feeds{$guid->{feed}}) {
 394                         if (exists $guid->{page}) {
 395                                 unlink $IkiWiki::Plugin::transient::transientdir."/".htmlfn($guid->{page})
 396                                         || unlink "$config{srcdir}/".htmlfn($guid->{page});
 397                         }
 398                         delete $guids{$guid->{guid}};
 399                 }
 400                 # handle expired guids
 401                 elsif ($guid->{expired} && exists $guid->{page}) {
 402                         unlink "$config{srcdir}/".htmlfn($guid->{page});
 403                         unlink $IkiWiki::Plugin::transient::transientdir."/".htmlfn($guid->{page});
 404                         delete $guid->{page};
 405                         delete $guid->{md5};
 406                 }
 407         }
 408 }
 409
 410 sub mergestate () {
 411         # Load the current state in from disk, and merge into it
 412         # values from the state in memory that might have changed
 413         # during aggregation.
 414         my %myfeeds=%feeds;
 415         my %myguids=%guids;
 416         clearstate();
 417         loadstate();
 418
 419         # All that can change in feed state during aggregation is a few
 420         # fields.
 421         foreach my $name (keys %myfeeds) {
 422                 if (exists $feeds{$name}) {
 423                         foreach my $field (qw{message lastupdate lasttry
 424                                               numposts newposts error}) {
 425                                 $feeds{$name}->{$field}=$myfeeds{$name}->{$field};
 426                         }
 427                 }
 428         }
 429
 430         # New guids can be created during aggregation.
 431         # Guids have a few fields that may be updated during aggregation.
 432         # It's also possible that guids were removed from the on-disk state
 433         # while the aggregation was in process. That would only happen if
 434         # their feed was also removed, so any removed guids added back here
 435         # will be garbage collected later.
 436         foreach my $guid (keys %myguids) {
 437                 if (! exists $guids{$guid}) {
 438                         $guids{$guid}=$myguids{$guid};
 439                 }
 440                 else {
 441                         foreach my $field (qw{md5}) {
 442                                 $guids{$guid}->{$field}=$myguids{$guid}->{$field};
 443                         }
 444                 }
 445         }
 446 }
 447
 448 sub clearstate () {
 449         %feeds=();
 450         %guids=();
 451         $state_loaded=0;
 452 }
 453
 454 sub expire () {
 455         foreach my $feed (values %feeds) {
 456                 next unless $feed->{expireage} || $feed->{expirecount};
 457                 my $count=0;
 458                 my %seen;
 459                 foreach my $item (sort { ($IkiWiki::pagectime{$b->{page}} || 0) <=> ($IkiWiki::pagectime{$a->{page}} || 0) }
 460                                   grep { exists $_->{page} && $_->{feed} eq $feed->{name} }
 461                                   values %guids) {
 462                         if ($feed->{expireage}) {
 463                                 my $days_old = (time - ($IkiWiki::pagectime{$item->{page}} || 0)) / 60 / 60 / 24;
 464                                 if ($days_old > $feed->{expireage}) {
 465                                         debug(sprintf(gettext("expiring %s (%s days old)"),
 466                                                 $item->{page}, int($days_old)));
 467                                         $item->{expired}=1;
 468                                 }
 469                         }
 470                         elsif ($feed->{expirecount} &&
 471                                $count >= $feed->{expirecount}) {
 472                                 debug(sprintf(gettext("expiring %s"), $item->{page}));
 473                                 $item->{expired}=1;
 474                         }
 475                         else {
 476                                 if (! $seen{$item->{page}}) {
 477                                         $seen{$item->{page}}=1;
 478                                         $count++;
 479                                 }
 480                         }
 481                 }
 482         }
 483 }
 484
 485 sub needsaggregate () {
 486         return values %feeds if $config{rebuild};
 487         return grep { time - $_->{lastupdate} >= $_->{updateinterval} } values %feeds;
 488 }
 489
 490 sub aggregate (@) {
 491         eval q{use Net::INET6Glue::INET_is_INET6}; # may not be available
 492         eval q{use XML::Feed};
 493         error($@) if $@;
 494         eval q{use URI::Fetch};
 495         error($@) if $@;
 496
 497         foreach my $feed (@_) {
 498                 $feed->{lasttry}=time;
 499                 $feed->{newposts}=0;
 500                 $feed->{message}=sprintf(gettext("last checked %s"),
 501                         displaytime($feed->{lasttry}));
 502                 $feed->{error}=0;
 503
 504                 debug(sprintf(gettext("checking feed %s ..."), $feed->{name}));
 505
 506                 if (! length $feed->{feedurl}) {
 507                         my @urls=XML::Feed->find_feeds($feed->{url});
 508                         if (! @urls) {
 509                                 $feed->{message}=sprintf(gettext("could not find feed at %s"), $feed->{url});
 510                                 $feed->{error}=1;
 511                                 debug($feed->{message});
 512                                 next;
 513                         }
 514                         $feed->{feedurl}=pop @urls;
 515                 }
 516                 my $ua=useragent();
 517                 my $res=URI::Fetch->fetch($feed->{feedurl}, UserAgent=>$ua);
 518                 if (! $res) {
 519                         $feed->{message}=URI::Fetch->errstr;
 520                         $feed->{error}=1;
 521                         debug($feed->{message});
 522                         next;
 523                 }
 524
 525                 # lastupdate is only set if we were able to contact the server
 526                 $feed->{lastupdate}=$feed->{lasttry};
 527
 528                 if ($res->status == URI::Fetch::URI_GONE()) {
 529                         $feed->{message}=gettext("feed not found");
 530                         $feed->{error}=1;
 531                         debug($feed->{message});
 532                         next;
 533                 }
 534                 my $content=$res->content;
 535                 my $f=eval{XML::Feed->parse(\$content)};
 536                 if ($@) {
 537                         # One common cause of XML::Feed crashing is a feed
 538                         # that contains invalid UTF-8 sequences. Convert
 539                         # feed to ascii to try to work around.
 540                         $feed->{message}.=" ".sprintf(gettext("(invalid UTF-8 stripped from feed)"));
 541                         $f=eval {
 542                                 $content=Encode::decode_utf8($content, 0);
 543                                 XML::Feed->parse(\$content)
 544                         };
 545                 }
 546                 if ($@) {
 547                         # Another possibility is badly escaped entities.
 548                         $feed->{message}.=" ".sprintf(gettext("(feed entities escaped)"));
 549                         $content=~s/\&(?!amp)(\w+);/&amp;$1;/g;
 550                         $f=eval {
 551                                 $content=Encode::decode_utf8($content, 0);
 552                                 XML::Feed->parse(\$content)
 553                         };
 554                 }
 555                 if ($@) {
 556                         # gettext can clobber $@
 557                         my $error = $@;
 558                         $feed->{message}=gettext("feed crashed XML::Feed!")." ($error)";
 559                         $feed->{error}=1;
 560                         debug($feed->{message});
 561                         next;
 562                 }
 563                 if (! $f) {
 564                         $feed->{message}=XML::Feed->errstr;
 565                         $feed->{error}=1;
 566                         debug($feed->{message});
 567                         next;
 568                 }
 569
 570                 foreach my $entry ($f->entries) {
 571                         # XML::Feed doesn't work around XML::Atom's bizarre
 572                         # API, so we will. Real unicode strings? Yes please.
 573                         # See [[bugs/Aggregated_Atom_feeds_are_double-encoded]]
 574                         no warnings 'once';
 575                         local $XML::Atom::ForceUnicode = 1;
 576                         use warnings;
 577
 578                         my $c=$entry->content;
 579                         # atom feeds may have no content, only a summary
 580                         if (! defined $c && ref $entry->summary) {
 581                                 $c=$entry->summary;
 582                         }
 583
 584                         add_page(
 585                                 feed => $feed,
 586                                 copyright => $f->copyright,
 587                                 title => defined $entry->title ? decode_entities($entry->title) : "untitled",
 588                                 author => defined $entry->author ? decode_entities($entry->author) : "",
 589                                 link => $entry->link,
 590                                 content => (defined $c && defined $c->body) ? $c->body : "",
 591                                 guid => defined $entry->id ? $entry->id : time."_".$feed->{name},
 592                                 ctime => $entry->issued ? ($entry->issued->epoch || time) : time,
 593                                 base => (defined $c && $c->can("base")) ? $c->base : undef,
 594                         );
 595                 }
 596         }
 597 }
 598
 599 sub add_page (@) {
 600         my %params=@_;
 601
 602         my $feed=$params{feed};
 603         my $guid={};
 604         my $mtime;
 605         if (exists $guids{$params{guid}}) {
 606                 # updating an existing post
 607                 $guid=$guids{$params{guid}};
 608                 return if $guid->{expired};
 609                 write_page($feed, $guid, $mtime, \%params);
 610         }
 611         else {
 612                 # new post
 613                 $guid->{guid}=$params{guid};
 614                 $guids{$params{guid}}=$guid;
 615                 $mtime=$params{ctime};
 616                 $feed->{numposts}++;
 617                 $feed->{newposts}++;
 618
 619                 # assign it an unused page
 620                 my $page=titlepage($params{title});
 621                 # escape slashes and periods in title so it doesn't specify
 622                 # directory name or trigger ".." disallowing code.
 623                 $page=~s!([/.])!"__".ord($1)."__"!eg;
 624                 if (! defined $page || ! length $page) {
 625                         $page=$feed->{dir}."/item";
 626                 }
 627                 $page=$feed->{dir}."/".$page;
 628                 ($page)=$page=~/$config{wiki_file_regexp}/;
 629                 my $c="";
 630                 while (exists $IkiWiki::pagecase{lc $page.$c} ||
 631                        -e $IkiWiki::Plugin::transient::transientdir."/".htmlfn($page.$c) ||
 632                        -e "$config{srcdir}/".htmlfn($page.$c)) {
 633                         $c++
 634                 }
 635                 $page=$page.$c;
 636
 637                 $guid->{page}=$page;
 638                 eval { write_page($feed, $guid, $mtime, \%params) };
 639                 if ($@) {
 640                         # assume failure was due to a too long filename
 641                         $c="";
 642                         $page=$feed->{dir}."/item";
 643                         while (exists $IkiWiki::pagecase{lc $page.$c} ||
 644                               -e $IkiWiki::Plugin::transient::transientdir."/".htmlfn($page.$c) ||
 645                               -e "$config{srcdir}/".htmlfn($page.$c)) {
 646                                 $c++
 647                         }
 648                         $page=$page.$c;
 649
 650                         $guid->{page}=$page;
 651                         write_page($feed, $guid, $mtime, \%params);
 652                 }
 653
 654                 debug(sprintf(gettext("creating new page %s"), $page));
 655         }
 656 }
 657
 658 sub write_page ($$$$$) {
 659         my $feed=shift;
 660         my $guid=shift;
 661         my $mtime=shift;
 662         my %params=%{shift()};
 663
 664         $guid->{feed}=$feed->{name};
 665
 666         # To write or not to write? Need to avoid writing unchanged pages
 667         # to avoid unneccessary rebuilding. The mtime from rss cannot be
 668         # trusted; let's use a digest.
 669         eval q{use Digest::MD5 'md5_hex'};
 670         error($@) if $@;
 671         require Encode;
 672         my $digest=md5_hex(Encode::encode_utf8($params{content}));
 673         return unless ! exists $guid->{md5} || $guid->{md5} ne $digest || $config{rebuild};
 674         $guid->{md5}=$digest;
 675
 676         # Create the page.
 677         my $template;
 678         eval {
 679                 $template=template($feed->{template}, blind_cache => 1);
 680         };
 681         if ($@) {
 682                 # gettext can clobber $@
 683                 my $error = $@;
 684                 print STDERR gettext("failed to process template:")." $error";
 685                 return;
 686         }
 687         $template->param(title => $params{title})
 688                 if defined $params{title} && length($params{title});
 689         $template->param(author => $params{author})
 690                 if defined $params{author} && length($params{author}
 691                         && $params{author} ne $feed->{name});
 692         $template->param(content => wikiescape(htmlabs($params{content},
 693                 defined $params{base} ? $params{base} : $feed->{feedurl})));
 694         $template->param(name => $feed->{name});
 695         $template->param(url => $feed->{url});
 696         $template->param(copyright => $params{copyright})
 697                 if defined $params{copyright} && length $params{copyright};
 698         $template->param(permalink => IkiWiki::urlabs($params{link}, $feed->{feedurl}))
 699                 if defined $params{link};
 700         if (ref $feed->{tags}) {
 701                 $template->param(tags => [map { tag => $_ }, @{$feed->{tags}}]);
 702         }
 703         writefile(htmlfn($guid->{page}),
 704                 $IkiWiki::Plugin::transient::transientdir, $template->output);
 705
 706         if (defined $mtime && $mtime <= time) {
 707                 # Set the mtime, this lets the build process get the right
 708                 # creation time on record for the new page.
 709                 utime $mtime, $mtime,
 710                         $IkiWiki::Plugin::transient::transientdir."/".htmlfn($guid->{page});
 711                 # Store it in pagectime for expiry code to use also.
 712                 $IkiWiki::pagectime{$guid->{page}}=$mtime
 713                         unless exists $IkiWiki::pagectime{$guid->{page}};
 714         }
 715         else {
 716                 # Dummy value for expiry code.
 717                 $IkiWiki::pagectime{$guid->{page}}=time
 718                         unless exists $IkiWiki::pagectime{$guid->{page}};
 719         }
 720 }
 721
 722 sub wikiescape ($) {
 723         # escape accidental wikilinks and preprocessor stuff
 724         return encode_entities(shift, '\[\]');
 725 }
 726
 727 sub htmlabs ($$) {
 728         # Convert links in html from relative to absolute.
 729         # Note that this is a heuristic, which is not specified by the rss
 730         # spec and may not be right for all feeds. Also, see Debian
 731         # bug #381359.
 732         my $html=shift;
 733         my $urlbase=shift;
 734
 735         my $ret="";
 736         my $p = HTML::Parser->new(api_version => 3);
 737         $p->handler(default => sub { $ret.=join("", @_) }, "text");
 738         $p->handler(start => sub {
 739                 my ($tagname, $pos, $text) = @_;
 740                 if (ref $HTML::Tagset::linkElements{$tagname}) {
 741                         while (4 <= @$pos) {
 742                                 # use attribute sets from right to left
 743                                 # to avoid invalidating the offsets
 744                                 # when replacing the values
 745                                 my($k_offset, $k_len, $v_offset, $v_len) =
 746                                         splice(@$pos, -4);
 747                                 my $attrname = lc(substr($text, $k_offset, $k_len));
 748                                 next unless grep { $_ eq $attrname } @{$HTML::Tagset::linkElements{$tagname}};
 749                                 next unless $v_offset; # 0 v_offset means no value
 750                                 my $v = substr($text, $v_offset, $v_len);
 751                                 $v =~ s/^([\'\"])(.*)\1$/$2/;
 752                                 my $new_v=IkiWiki::urlabs($v, $urlbase);
 753                                 $new_v =~ s/\"/&quot;/g; # since we quote with ""
 754                                 substr($text, $v_offset, $v_len) = qq("$new_v");
 755                         }
 756                 }
 757                 $ret.=$text;
 758         }, "tagname, tokenpos, text");
 759         $p->parse($html);
 760         $p->eof;
 761
 762         return $ret;
 763 }
 764
 765 sub htmlfn ($) {
 766         return shift().".".($config{aggregateinternal} ? "_aggregated" : $config{htmlext});
 767 }
 768
 769 my $aggregatelock;
 770
 771 sub lockaggregate () {
 772         # Take an exclusive lock to prevent multiple concurrent aggregators.
 773         # Returns true if the lock was aquired.
 774         if (! -d $config{wikistatedir}) {
 775                 mkdir($config{wikistatedir});
 776         }
 777         open($aggregatelock, '>', "$config{wikistatedir}/aggregatelock") ||
 778                 error ("cannot open to $config{wikistatedir}/aggregatelock: $!");
 779         if (! flock($aggregatelock, 2 | 4)) { # LOCK_EX | LOCK_NB
 780                 close($aggregatelock) || error("failed closing aggregatelock: $!");
 781                 return 0;
 782         }
 783         return 1;
 784 }
 785
 786 sub unlockaggregate () {
 787         return close($aggregatelock) if $aggregatelock;
 788         return;
 789 }
 790
 791 1