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->{lasttry}=$feed->{lastupdate} unless defined $feed->{lasttry};
 249         $feed->{numposts}=0 unless defined $feed->{numposts};
 250         $feed->{newposts}=0 unless defined $feed->{newposts};
 251         $feed->{message}=gettext("new feed") unless defined $feed->{message};
 252         $feed->{error}=0 unless defined $feed->{error};
 253         $feed->{tags}=[];
 254         while (@_) {
 255                 my $key=shift;
 256                 my $value=shift;
 257                 if ($key eq 'tag') {
 258                         push @{$feed->{tags}}, $value;
 259                 }
 260         }
 261
 262         return "<a href=\"".$feed->{url}."\">".$feed->{name}."</a>: ".
 263                ($feed->{error} ? "<em>" : "").$feed->{message}.
 264                ($feed->{error} ? "</em>" : "").
 265                " (".$feed->{numposts}." ".gettext("posts").
 266                ($feed->{newposts} ? "; ".$feed->{newposts}.
 267                                     " ".gettext("new") : "").
 268                ")";
 269 }
 270
 271 sub delete (@) {
 272         my @files=@_;
 273
 274         # Remove feed data for removed pages.
 275         foreach my $file (@files) {
 276                 my $page=pagename($file);
 277                 markunseen($page);
 278         }
 279 }
 280
 281 sub markunseen ($) {
 282         my $page=shift;
 283
 284         foreach my $id (keys %feeds) {
 285                 if ($feeds{$id}->{sourcepage} eq $page) {
 286                         $feeds{$id}->{unseen}=1;
 287                 }
 288         }
 289 }
 290
 291 my $state_loaded=0;
 292
 293 sub loadstate () {
 294         return if $state_loaded;
 295         $state_loaded=1;
 296         if (-e "$config{wikistatedir}/aggregate") {
 297                 open(IN, "$config{wikistatedir}/aggregate") ||
 298                         die "$config{wikistatedir}/aggregate: $!";
 299                 while (<IN>) {
 300                         $_=IkiWiki::possibly_foolish_untaint($_);
 301                         chomp;
 302                         my $data={};
 303                         foreach my $i (split(/ /, $_)) {
 304                                 my ($field, $val)=split(/=/, $i, 2);
 305                                 if ($field eq "name" || $field eq "feed" ||
 306                                     $field eq "guid" || $field eq "message") {
 307                                         $data->{$field}=decode_entities($val, " \t\n");
 308                                 }
 309                                 elsif ($field eq "tag") {
 310                                         push @{$data->{tags}}, $val;
 311                                 }
 312                                 else {
 313                                         $data->{$field}=$val;
 314                                 }
 315                         }
 316
 317                         if (exists $data->{name}) {
 318                                 $feeds{$data->{name}}=$data;
 319                         }
 320                         elsif (exists $data->{guid}) {
 321                                 $guids{$data->{guid}}=$data;
 322                         }
 323                 }
 324
 325                 close IN;
 326         }
 327 }
 328
 329 sub savestate () {
 330         return unless $state_loaded;
 331         garbage_collect();
 332         my $newfile="$config{wikistatedir}/aggregate.new";
 333         my $cleanup = sub { unlink($newfile) };
 334         open (OUT, ">$newfile") || error("open $newfile: $!", $cleanup);
 335         foreach my $data (values %feeds, values %guids) {
 336                 my @line;
 337                 foreach my $field (keys %$data) {
 338                         if ($field eq "name" || $field eq "feed" ||
 339                             $field eq "guid" || $field eq "message") {
 340                                 push @line, "$field=".encode_entities($data->{$field}, " \t\n");
 341                         }
 342                         elsif ($field eq "tags") {
 343                                 push @line, "tag=$_" foreach @{$data->{tags}};
 344                         }
 345                         else {
 346                                 push @line, "$field=".$data->{$field}
 347                                         if defined $data->{$field};
 348                         }
 349                 }
 350                 print OUT join(" ", @line)."\n" || error("write $newfile: $!", $cleanup);
 351         }
 352         close OUT || error("save $newfile: $!", $cleanup);
 353         rename($newfile, "$config{wikistatedir}/aggregate") ||
 354                 error("rename $newfile: $!", $cleanup);
 355 }
 356
 357 sub garbage_collect () {
 358         foreach my $name (keys %feeds) {
 359                 # remove any feeds that were not seen while building the pages
 360                 # that used to contain them
 361                 if ($feeds{$name}->{unseen}) {
 362                         delete $feeds{$name};
 363                 }
 364         }
 365
 366         foreach my $guid (values %guids) {
 367                 # any guid whose feed is gone should be removed
 368                 if (! exists $feeds{$guid->{feed}}) {
 369                         unlink "$config{srcdir}/".htmlfn($guid->{page})
 370                                 if exists $guid->{page};
 371                         delete $guids{$guid->{guid}};
 372                 }
 373                 # handle expired guids
 374                 elsif ($guid->{expired} && exists $guid->{page}) {
 375                         unlink "$config{srcdir}/".htmlfn($guid->{page});
 376                         delete $guid->{page};
 377                         delete $guid->{md5};
 378                 }
 379         }
 380 }
 381
 382 sub mergestate () {
 383         # Load the current state in from disk, and merge into it
 384         # values from the state in memory that might have changed
 385         # during aggregation.
 386         my %myfeeds=%feeds;
 387         my %myguids=%guids;
 388         clearstate();
 389         loadstate();
 390
 391         # All that can change in feed state during aggregation is a few
 392         # fields.
 393         foreach my $name (keys %myfeeds) {
 394                 if (exists $feeds{$name}) {
 395                         foreach my $field (qw{message lastupdate lasttry
 396                                               numposts newposts error}) {
 397                                 $feeds{$name}->{$field}=$myfeeds{$name}->{$field};
 398                         }
 399                 }
 400         }
 401
 402         # New guids can be created during aggregation.
 403         # It's also possible that guids were removed from the on-disk state
 404         # while the aggregation was in process. That would only happen if
 405         # their feed was also removed, so any removed guids added back here
 406         # will be garbage collected later.
 407         foreach my $guid (keys %myguids) {
 408                 if (! exists $guids{$guid}) {
 409                         $guids{$guid}=$myguids{$guid};
 410                 }
 411         }
 412 }
 413
 414 sub clearstate () {
 415         %feeds=();
 416         %guids=();
 417         $state_loaded=0;
 418 }
 419
 420 sub expire () {
 421         foreach my $feed (values %feeds) {
 422                 next unless $feed->{expireage} || $feed->{expirecount};
 423                 my $count=0;
 424                 my %seen;
 425                 foreach my $item (sort { ($IkiWiki::pagectime{$b->{page}} || 0) <=> ($IkiWiki::pagectime{$a->{page}} || 0) }
 426                                   grep { exists $_->{page} && $_->{feed} eq $feed->{name} }
 427                                   values %guids) {
 428                         if ($feed->{expireage}) {
 429                                 my $days_old = (time - ($IkiWiki::pagectime{$item->{page}} || 0)) / 60 / 60 / 24;
 430                                 if ($days_old > $feed->{expireage}) {
 431                                         debug(sprintf(gettext("expiring %s (%s days old)"),
 432                                                 $item->{page}, int($days_old)));
 433                                         $item->{expired}=1;
 434                                 }
 435                         }
 436                         elsif ($feed->{expirecount} &&
 437                                $count >= $feed->{expirecount}) {
 438                                 debug(sprintf(gettext("expiring %s"), $item->{page}));
 439                                 $item->{expired}=1;
 440                         }
 441                         else {
 442                                 if (! $seen{$item->{page}}) {
 443                                         $seen{$item->{page}}=1;
 444                                         $count++;
 445                                 }
 446                         }
 447                 }
 448         }
 449 }
 450
 451 sub needsaggregate () {
 452         return values %feeds if $config{rebuild};
 453         return grep { time - $_->{lastupdate} >= $_->{updateinterval} } values %feeds;
 454 }
 455
 456 sub aggregate (@) {
 457         eval q{use XML::Feed};
 458         error($@) if $@;
 459         eval q{use URI::Fetch};
 460         error($@) if $@;
 461
 462         foreach my $feed (@_) {
 463                 $feed->{lasttry}=time;
 464                 $feed->{newposts}=0;
 465                 $feed->{message}=sprintf(gettext("last checked %s"),
 466                         displaytime($feed->{lasttry}));
 467                 $feed->{error}=0;
 468
 469                 debug(sprintf(gettext("checking feed %s ..."), $feed->{name}));
 470
 471                 if (! length $feed->{feedurl}) {
 472                         my @urls=XML::Feed->find_feeds($feed->{url});
 473                         if (! @urls) {
 474                                 $feed->{message}=sprintf(gettext("could not find feed at %s"), $feed->{url});
 475                                 $feed->{error}=1;
 476                                 debug($feed->{message});
 477                                 next;
 478                         }
 479                         $feed->{feedurl}=pop @urls;
 480                 }
 481                 my $res=URI::Fetch->fetch($feed->{feedurl});
 482                 if (! $res) {
 483                         $feed->{message}=URI::Fetch->errstr;
 484                         $feed->{error}=1;
 485                         debug($feed->{message});
 486                         next;
 487                 }
 488
 489                 # lastupdate is only set if we were able to contact the server
 490                 $feed->{lastupdate}=$feed->{lasttry};
 491
 492                 if ($res->status == URI::Fetch::URI_GONE()) {
 493                         $feed->{message}=gettext("feed not found");
 494                         $feed->{error}=1;
 495                         debug($feed->{message});
 496                         next;
 497                 }
 498                 my $content=$res->content;
 499                 my $f=eval{XML::Feed->parse(\$content)};
 500                 if ($@) {
 501                         # One common cause of XML::Feed crashing is a feed
 502                         # that contains invalid UTF-8 sequences. Convert
 503                         # feed to ascii to try to work around.
 504                         $feed->{message}.=" ".sprintf(gettext("(invalid UTF-8 stripped from feed)"));
 505                         $f=eval {
 506                                 $content=Encode::decode_utf8($content, 0);
 507                                 XML::Feed->parse(\$content)
 508                         };
 509                 }
 510                 if ($@) {
 511                         # Another possibility is badly escaped entities.
 512                         $feed->{message}.=" ".sprintf(gettext("(feed entities escaped)"));
 513                         $content=~s/\&(?!amp)(\w+);/&amp;$1;/g;
 514                         $f=eval {
 515                                 $content=Encode::decode_utf8($content, 0);
 516                                 XML::Feed->parse(\$content)
 517                         };
 518                 }
 519                 if ($@) {
 520                         $feed->{message}=gettext("feed crashed XML::Feed!")." ($@)";
 521                         $feed->{error}=1;
 522                         debug($feed->{message});
 523                         next;
 524                 }
 525                 if (! $f) {
 526                         $feed->{message}=XML::Feed->errstr;
 527                         $feed->{error}=1;
 528                         debug($feed->{message});
 529                         next;
 530                 }
 531
 532                 foreach my $entry ($f->entries) {
 533                         my $c=$entry->content;
 534                         # atom feeds may have no content, only a summary
 535                         if (! defined $c && ref $entry->summary) {
 536                                 $c=$entry->summary;
 537                         }
 538
 539                         add_page(
 540                                 feed => $feed,
 541                                 copyright => $f->copyright,
 542                                 title => defined $entry->title ? decode_entities($entry->title) : "untitled",
 543                                 link => $entry->link,
 544                                 content => (defined $c && defined $c->body) ? $c->body : "",
 545                                 guid => defined $entry->id ? $entry->id : time."_".$feed->{name},
 546                                 ctime => $entry->issued ? ($entry->issued->epoch || time) : time,
 547                                 base => (defined $c && $c->can("base")) ? $c->base : undef,
 548                         );
 549                 }
 550         }
 551 }
 552
 553 sub add_page (@) {
 554         my %params=@_;
 555
 556         my $feed=$params{feed};
 557         my $guid={};
 558         my $mtime;
 559         if (exists $guids{$params{guid}}) {
 560                 # updating an existing post
 561                 $guid=$guids{$params{guid}};
 562                 return if $guid->{expired};
 563         }
 564         else {
 565                 # new post
 566                 $guid->{guid}=$params{guid};
 567                 $guids{$params{guid}}=$guid;
 568                 $mtime=$params{ctime};
 569                 $feed->{numposts}++;
 570                 $feed->{newposts}++;
 571
 572                 # assign it an unused page
 573                 my $page=titlepage($params{title});
 574                 # escape slashes and periods in title so it doesn't specify
 575                 # directory name or trigger ".." disallowing code.
 576                 $page=~s!([/.])!"__".ord($1)."__"!eg;
 577                 $page=$feed->{dir}."/".$page;
 578                 ($page)=$page=~/$config{wiki_file_regexp}/;
 579                 if (! defined $page || ! length $page) {
 580                         $page=$feed->{dir}."/item";
 581                 }
 582                 my $c="";
 583                 while (exists $IkiWiki::pagecase{lc $page.$c} ||
 584                        -e "$config{srcdir}/".htmlfn($page.$c)) {
 585                         $c++
 586                 }
 587
 588                 # Make sure that the file name isn't too long.
 589                 # NB: This doesn't check for path length limits.
 590                 my $max=POSIX::pathconf($config{srcdir}, &POSIX::_PC_NAME_MAX);
 591                 if (defined $max && length(htmlfn($page)) >= $max) {
 592                         $c="";
 593                         $page=$feed->{dir}."/item";
 594                         while (exists $IkiWiki::pagecase{lc $page.$c} ||
 595                                -e "$config{srcdir}/".htmlfn($page.$c)) {
 596                                 $c++
 597                         }
 598                 }
 599
 600                 $guid->{page}=$page;
 601                 debug(sprintf(gettext("creating new page %s"), $page));
 602         }
 603         $guid->{feed}=$feed->{name};
 604
 605         # To write or not to write? Need to avoid writing unchanged pages
 606         # to avoid unneccessary rebuilding. The mtime from rss cannot be
 607         # trusted; let's use a digest.
 608         eval q{use Digest::MD5 'md5_hex'};
 609         error($@) if $@;
 610         require Encode;
 611         my $digest=md5_hex(Encode::encode_utf8($params{content}));
 612         return unless ! exists $guid->{md5} || $guid->{md5} ne $digest || $config{rebuild};
 613         $guid->{md5}=$digest;
 614
 615         # Create the page.
 616         my $template=template($feed->{template}, blind_cache => 1);
 617         $template->param(title => $params{title})
 618                 if defined $params{title} && length($params{title});
 619         $template->param(content => wikiescape(htmlabs($params{content},
 620                 defined $params{base} ? $params{base} : $feed->{feedurl})));
 621         $template->param(name => $feed->{name});
 622         $template->param(url => $feed->{url});
 623         $template->param(copyright => $params{copyright})
 624                 if defined $params{copyright} && length $params{copyright};
 625         $template->param(permalink => urlabs($params{link}, $feed->{feedurl}))
 626                 if defined $params{link};
 627         if (ref $feed->{tags}) {
 628                 $template->param(tags => [map { tag => $_ }, @{$feed->{tags}}]);
 629         }
 630         writefile(htmlfn($guid->{page}), $config{srcdir},
 631                 $template->output);
 632
 633         if (defined $mtime && $mtime <= time) {
 634                 # Set the mtime, this lets the build process get the right
 635                 # creation time on record for the new page.
 636                 utime $mtime, $mtime, "$config{srcdir}/".htmlfn($guid->{page});
 637                 # Store it in pagectime for expiry code to use also.
 638                 $IkiWiki::pagectime{$guid->{page}}=$mtime;
 639         }
 640         else {
 641                 # Dummy value for expiry code.
 642                 $IkiWiki::pagectime{$guid->{page}}=time;
 643         }
 644 }
 645
 646 sub wikiescape ($) {
 647         # escape accidental wikilinks and preprocessor stuff
 648         return encode_entities(shift, '\[\]');
 649 }
 650
 651 sub urlabs ($$) {
 652         my $url=shift;
 653         my $urlbase=shift;
 654
 655         URI->new_abs($url, $urlbase)->as_string;
 656 }
 657
 658 sub htmlabs ($$) {
 659         # Convert links in html from relative to absolute.
 660         # Note that this is a heuristic, which is not specified by the rss
 661         # spec and may not be right for all feeds. Also, see Debian
 662         # bug #381359.
 663         my $html=shift;
 664         my $urlbase=shift;
 665
 666         my $ret="";
 667         my $p = HTML::Parser->new(api_version => 3);
 668         $p->handler(default => sub { $ret.=join("", @_) }, "text");
 669         $p->handler(start => sub {
 670                 my ($tagname, $pos, $text) = @_;
 671                 if (ref $HTML::Tagset::linkElements{$tagname}) {
 672                         while (4 <= @$pos) {
 673                                 # use attribute sets from right to left
 674                                 # to avoid invalidating the offsets
 675                                 # when replacing the values
 676                                 my($k_offset, $k_len, $v_offset, $v_len) =
 677                                         splice(@$pos, -4);
 678                                 my $attrname = lc(substr($text, $k_offset, $k_len));
 679                                 next unless grep { $_ eq $attrname } @{$HTML::Tagset::linkElements{$tagname}};
 680                                 next unless $v_offset; # 0 v_offset means no value
 681                                 my $v = substr($text, $v_offset, $v_len);
 682                                 $v =~ s/^([\'\"])(.*)\1$/$2/;
 683                                 my $new_v=urlabs($v, $urlbase);
 684                                 $new_v =~ s/\"/&quot;/g; # since we quote with ""
 685                                 substr($text, $v_offset, $v_len) = qq("$new_v");
 686                         }
 687                 }
 688                 $ret.=$text;
 689         }, "tagname, tokenpos, text");
 690         $p->parse($html);
 691         $p->eof;
 692
 693         return $ret;
 694 }
 695
 696 sub htmlfn ($) {
 697         return shift().".".($config{aggregateinternal} ? "_aggregated" : $config{htmlext});
 698 }
 699
 700 my $aggregatelock;
 701
 702 sub lockaggregate () {
 703         # Take an exclusive lock to prevent multiple concurrent aggregators.
 704         # Returns true if the lock was aquired.
 705         if (! -d $config{wikistatedir}) {
 706                 mkdir($config{wikistatedir});
 707         }
 708         open($aggregatelock, '>', "$config{wikistatedir}/aggregatelock") ||
 709                 error ("cannot open to $config{wikistatedir}/aggregatelock: $!");
 710         if (! flock($aggregatelock, 2 | 4)) { # LOCK_EX | LOCK_NB
 711                 close($aggregatelock) || error("failed closing aggregatelock: $!");
 712                 return 0;
 713         }
 714         return 1;
 715 }
 716
 717 sub unlockaggregate () {
 718         return close($aggregatelock) if $aggregatelock;
 719         return;
 720 }
 721
 722 1