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