(no commit message)

[git.ikiwiki.info.git] / IkiWiki / Plugin / aggregate.pm

diff --git a/IkiWiki/Plugin/aggregate.pm b/IkiWiki/Plugin/aggregate.pm
index d6592fef30f96fdfe20c5d812ef38fc77c373fd5..9b70e5df053731866c5ad7a494432e6e0b72b4bc 100644 (file)
--- a/IkiWiki/Plugin/aggregate.pm
+++ b/IkiWiki/Plugin/aggregate.pm
@@ -1,65 +1,225 @@
 #!/usr/bin/perl
 #!/usr/bin/perl

-# Blog aggregation plugin.
+# Feed aggregation plugin.

 package IkiWiki::Plugin::aggregate;
 
 use warnings;
 use strict;
 package IkiWiki::Plugin::aggregate;
 
 use warnings;
 use strict;

-use IkiWiki;
-use HTML::Entities;
+use IkiWiki 3.00;

 use HTML::Parser;
 use HTML::Tagset;
 use HTML::Parser;
 use HTML::Tagset;

+use HTML::Entities;

 use URI;
 use URI;

+use open qw{:utf8 :std};

 
 my %feeds;
 my %guids;
 
 
 my %feeds;
 my %guids;
 

-sub import { #{{{
-       IkiWiki::hook(type => "getopt", id => "aggregate", 
-               call => \&getopt);
-       IkiWiki::hook(type => "checkconfig", id => "aggregate",
-               call => \&checkconfig);
-       IkiWiki::hook(type => "filter", id => "aggregate", 
-               call => \&filter);
-       IkiWiki::hook(type => "preprocess", id => "aggregate",
-               call => \&preprocess);
-        IkiWiki::hook(type => "delete", id => "aggregate",
-                call => \&delete);
-       IkiWiki::hook(type => "savestate", id => "aggregate",
-               call => \&savestate);
-} # }}}
-
-sub getopt () { #{{{
+sub import {
+       hook(type => "getopt", id => "aggregate", call => \&getopt);
+       hook(type => "getsetup", id => "aggregate", call => \&getsetup);
+       hook(type => "checkconfig", id => "aggregate", call => \&checkconfig);
+       hook(type => "needsbuild", id => "aggregate", call => \&needsbuild);
+       hook(type => "preprocess", id => "aggregate", call => \&preprocess);
+        hook(type => "delete", id => "aggregate", call => \&delete);
+       hook(type => "savestate", id => "aggregate", call => \&savestate);
+       hook(type => "htmlize", id => "_aggregated", call => \&htmlize);
+       if (exists $config{aggregate_webtrigger} && $config{aggregate_webtrigger}) {
+               hook(type => "cgi", id => "aggregate", call => \&cgi);
+       }
+}
+
+sub getopt () {

         eval q{use Getopt::Long};
         eval q{use Getopt::Long};

+       error($@) if $@;

         Getopt::Long::Configure('pass_through');
         Getopt::Long::Configure('pass_through');

-        GetOptions("aggregate" => \$IkiWiki::config{aggregate});
-} #}}}
+        GetOptions(
+               "aggregate" => \$config{aggregate},
+               "aggregateinternal!" => \$config{aggregateinternal},
+       );
+}
+
+sub getsetup () {
+       return
+               plugin => {
+                       safe => 1,
+                       rebuild => undef,
+               },
+               aggregateinternal => {
+                       type => "boolean",
+                       example => 1,
+                       description => "enable aggregation to internal pages?",
+                       safe => 0, # enabling needs manual transition
+                       rebuild => 0,
+               },
+               aggregate_webtrigger => {
+                       type => "boolean",
+                       example => 0,
+                       description => "allow aggregation to be triggered via the web?",
+                       safe => 1,
+                       rebuild => 0,
+               },
+}
+
+sub checkconfig () {
+       if (! defined $config{aggregateinternal}) {
+               $config{aggregateinternal}=1;
+       }

 
 

-sub checkconfig () { #{{{
+       if ($config{aggregate} && ! ($config{post_commit} && 
+                                    IkiWiki::commit_hook_enabled())) {
+               launchaggregation();
+       }
+}
+
+sub cgi ($) {
+       my $cgi=shift;
+
+       if (defined $cgi->param('do') &&
+           $cgi->param("do") eq "aggregate_webtrigger") {
+               $|=1;
+               print "Content-Type: text/plain\n\n";
+               $config{cgi}=0;
+               $config{verbose}=1;
+               $config{syslog}=0;
+               print gettext("Aggregation triggered via web.")."\n\n";
+               if (launchaggregation()) {
+                       IkiWiki::lockwiki();
+                       IkiWiki::loadindex();
+                       require IkiWiki::Render;
+                       IkiWiki::refresh();
+                       IkiWiki::saveindex();
+               }
+               else {
+                       print gettext("Nothing to do right now, all feeds are up-to-date!")."\n";
+               }
+               exit 0;
+       }
+}
+
+sub launchaggregation () {
+       # See if any feeds need aggregation.

        loadstate();
        loadstate();

-       if ($IkiWiki::config{aggregate}) {
+       my @feeds=needsaggregate();
+       return unless @feeds;
+       if (! lockaggregate()) {
+               debug("an aggregation process is already running");
+               return;
+       }
+       # force a later rebuild of source pages
+       $IkiWiki::forcerebuild{$_->{sourcepage}}=1
+               foreach @feeds;
+
+       # Fork a child process to handle the aggregation.
+       # The parent process will then handle building the
+       # result. This avoids messy code to clear state
+       # accumulated while aggregating.
+       defined(my $pid = fork) or error("Can't fork: $!");
+       if (! $pid) {

                IkiWiki::loadindex();
                IkiWiki::loadindex();

-               aggregate();
+               # Aggregation happens without the main wiki lock
+               # being held. This allows editing pages etc while
+               # aggregation is running.
+               aggregate(@feeds);
+
+               IkiWiki::lockwiki;
+               # Merge changes, since aggregation state may have
+               # changed on disk while the aggregation was happening.
+               mergestate();
+               expire();

                savestate();
                savestate();

+               IkiWiki::unlockwiki;
+               exit 0;
+       }
+       waitpid($pid,0);
+       if ($?) {
+               error "aggregation failed with code $?";

        }
        }

-} #}}}

 
 

-sub filter (@) { #{{{
-       my %params=@_;
-       my $page=$params{page};
+       clearstate();
+       unlockaggregate();

 
 

-       # Mark all feeds originating on this page as removable;
-       # preprocess will unmark those that still exist.
-       remove_feeds($page);
+       return 1;
+}

 
 

+#  Pages with extension _aggregated have plain html markup, pass through.
+sub htmlize (@) {
+       my %params=@_;

        return $params{content};
        return $params{content};

-} # }}}
+}
+
+# Used by ikiwiki-transition aggregateinternal.
+sub migrate_to_internal {
+       if (! lockaggregate()) {
+               error("an aggregation process is currently running");
+       }
+
+       IkiWiki::lockwiki();
+       loadstate();
+       $config{verbose}=1;
+
+       foreach my $data (values %guids) {
+               next unless $data->{page};
+               next if $data->{expired};
+               
+               $config{aggregateinternal} = 0;
+               my $oldname = "$config{srcdir}/".htmlfn($data->{page});
+               my $oldoutput = $config{destdir}."/".IkiWiki::htmlpage($data->{page});
+               
+               $config{aggregateinternal} = 1;
+               my $newname = "$config{srcdir}/".htmlfn($data->{page});
+               
+               debug "moving $oldname -> $newname";
+               if (-e $newname) {
+                       if (-e $oldname) {
+                               error("$newname already exists");
+                       }
+                       else {
+                               debug("already renamed to $newname?");
+                       }
+               }
+               elsif (-e $oldname) {
+                       rename($oldname, $newname) || error("$!");
+               }
+               else {
+                       debug("$oldname not found");
+               }
+               if (-e $oldoutput) {
+                       require IkiWiki::Render;
+                       debug("removing output file $oldoutput");
+                       IkiWiki::prune($oldoutput);
+               }
+       }
+       
+       savestate();
+       IkiWiki::unlockwiki;
+       
+       unlockaggregate();
+}
+
+sub needsbuild (@) {
+       my $needsbuild=shift;
+       
+       loadstate();
+
+       foreach my $feed (values %feeds) {
+               if (exists $pagesources{$feed->{sourcepage}} && 
+                   grep { $_ eq $pagesources{$feed->{sourcepage}} } @$needsbuild) {
+                       # Mark all feeds originating on this page as 
+                       # not yet seen; preprocess will unmark those that
+                       # still exist.
+                       markunseen($feed->{sourcepage});
+               }
+       }
+
+       return $needsbuild;
+}

 
 

-sub preprocess (@) { #{{{
+sub preprocess (@) {

        my %params=@_;
 
        foreach my $required (qw{name url}) {
                if (! exists $params{$required}) {
        my %params=@_;
 
        foreach my $required (qw{name url}) {
                if (! exists $params{$required}) {

-                       return "[[aggregate plugin missing $required parameter]]";
+                       error sprintf(gettext("missing %s parameter"), $required)

                }
        }
 
                }
        }
 


@@ -74,19 +234,28 @@ sub preprocess (@) { #{{{
        $feed->{name}=$name;
        $feed->{sourcepage}=$params{page};
        $feed->{url}=$params{url};
        $feed->{name}=$name;
        $feed->{sourcepage}=$params{page};
        $feed->{url}=$params{url};

-       my $dir=exists $params{dir} ? $params{dir} : $params{page}."/".IkiWiki::titlepage($params{name});
+       my $dir=exists $params{dir} ? $params{dir} : $params{page}."/".titlepage($params{name});

        $dir=~s/^\/+//;
        $dir=~s/^\/+//;

-       ($dir)=$dir=~/$IkiWiki::config{wiki_file_regexp}/;
+       ($dir)=$dir=~/$config{wiki_file_regexp}/;

        $feed->{dir}=$dir;
        $feed->{feedurl}=defined $params{feedurl} ? $params{feedurl} : "";
        $feed->{updateinterval}=defined $params{updateinterval} ? $params{updateinterval} * 60 : 15 * 60;
        $feed->{expireage}=defined $params{expireage} ? $params{expireage} : 0;
        $feed->{expirecount}=defined $params{expirecount} ? $params{expirecount} : 0;
        $feed->{dir}=$dir;
        $feed->{feedurl}=defined $params{feedurl} ? $params{feedurl} : "";
        $feed->{updateinterval}=defined $params{updateinterval} ? $params{updateinterval} * 60 : 15 * 60;
        $feed->{expireage}=defined $params{expireage} ? $params{expireage} : 0;
        $feed->{expirecount}=defined $params{expirecount} ? $params{expirecount} : 0;

-       delete $feed->{remove};
+        if (exists $params{template}) {
+                $params{template}=~s/[^-_a-zA-Z0-9]+//g;
+        }
+        else {
+                $params{template} = "aggregatepost"
+        }
+       $feed->{template}=$params{template} . ".tmpl";
+       delete $feed->{unseen};

        $feed->{lastupdate}=0 unless defined $feed->{lastupdate};
        $feed->{lastupdate}=0 unless defined $feed->{lastupdate};

+       $feed->{lasttry}=$feed->{lastupdate} unless defined $feed->{lasttry};

        $feed->{numposts}=0 unless defined $feed->{numposts};
        $feed->{newposts}=0 unless defined $feed->{newposts};
        $feed->{numposts}=0 unless defined $feed->{numposts};
        $feed->{newposts}=0 unless defined $feed->{newposts};

-       $feed->{message}="new feed" unless defined $feed->{message};
+       $feed->{message}=gettext("new feed") unless defined $feed->{message};
+       $feed->{error}=0 unless defined $feed->{error};

        $feed->{tags}=[];
        while (@_) {
                my $key=shift;
        $feed->{tags}=[];
        while (@_) {
                my $key=shift;


@@ -97,24 +266,42 @@ sub preprocess (@) { #{{{
        }
 
        return "<a href=\"".$feed->{url}."\">".$feed->{name}."</a>: ".
        }
 
        return "<a href=\"".$feed->{url}."\">".$feed->{name}."</a>: ".

-              "<i>".$feed->{message}."</i> (".$feed->{numposts}.
-              " stored posts; ".$feed->{newposts}." new)<br />";
-} # }}}
-
-sub delete (@) { #{{{
+              ($feed->{error} ? "<em>" : "").$feed->{message}.
+              ($feed->{error} ? "</em>" : "").
+              " (".$feed->{numposts}." ".gettext("posts").
+              ($feed->{newposts} ? "; ".$feed->{newposts}.
+                                   " ".gettext("new") : "").
+              ")";
+}
+
+sub delete (@) {

        my @files=@_;
 
        # Remove feed data for removed pages.
        foreach my $file (@files) {
        my @files=@_;
 
        # Remove feed data for removed pages.
        foreach my $file (@files) {

-               my $page=IkiWiki::pagename($file);
-               remove_feeds($page);
+               my $page=pagename($file);
+               markunseen($page);

        }
        }

-} #}}}
+}
+
+sub markunseen ($) {
+       my $page=shift;
+
+       foreach my $id (keys %feeds) {
+               if ($feeds{$id}->{sourcepage} eq $page) {
+                       $feeds{$id}->{unseen}=1;
+               }
+       }
+}
+
+my $state_loaded=0;

 
 

-sub loadstate () { #{{{
-       if (-e "$IkiWiki::config{wikistatedir}/aggregate") {
-               open (IN, "$IkiWiki::config{wikistatedir}/aggregate" ||
-                       die "$IkiWiki::config{wikistatedir}/aggregate: $!");
+sub loadstate () {
+       return if $state_loaded;
+       $state_loaded=1;
+       if (-e "$config{wikistatedir}/aggregate") {
+               open(IN, "<", "$config{wikistatedir}/aggregate") ||
+                       die "$config{wikistatedir}/aggregate: $!";

                while (<IN>) {
                        $_=IkiWiki::possibly_foolish_untaint($_);
                        chomp;
                while (<IN>) {
                        $_=IkiWiki::possibly_foolish_untaint($_);
                        chomp;


@@ -143,28 +330,15 @@ sub loadstate () { #{{{
 
                close IN;
        }
 
                close IN;
        }

-} #}}}
-
-sub savestate () { #{{{
-       eval q{use HTML::Entities};
-       die $@ if $@;
-       open (OUT, ">$IkiWiki::config{wikistatedir}/aggregate" ||
-               die "$IkiWiki::config{wikistatedir}/aggregate: $!");
+}
+
+sub savestate () {
+       return unless $state_loaded;
+       garbage_collect();
+       my $newfile="$config{wikistatedir}/aggregate.new";
+       my $cleanup = sub { unlink($newfile) };
+       open (OUT, ">", $newfile) || error("open $newfile: $!", $cleanup);

        foreach my $data (values %feeds, values %guids) {
        foreach my $data (values %feeds, values %guids) {

-               if ($data->{remove}) {
-                       if ($data->{name}) {
-                               foreach my $guid (values %guids) {
-                                       if ($guid->{feed} eq $data->{name}) {
-                                               $guid->{remove}=1;
-                                       }
-                               }
-                       }
-                       else {
-                               unlink pagefile($data->{page});
-                       }
-                       next;
-               }
-

                my @line;
                foreach my $field (keys %$data) {
                        if ($field eq "name" || $field eq "feed" ||
                my @line;
                foreach my $field (keys %$data) {
                        if ($field eq "name" || $field eq "feed" ||


@@ -175,68 +349,239 @@ sub savestate () { #{{{
                                push @line, "tag=$_" foreach @{$data->{tags}};
                        }
                        else {
                                push @line, "tag=$_" foreach @{$data->{tags}};
                        }
                        else {

-                               push @line, "$field=".$data->{$field};
+                               push @line, "$field=".$data->{$field}
+                                       if defined $data->{$field};

                        }
                }
                        }
                }

-               print OUT join(" ", @line)."\n";
+               print OUT join(" ", @line)."\n" || error("write $newfile: $!", $cleanup);
+       }
+       close OUT || error("save $newfile: $!", $cleanup);
+       rename($newfile, "$config{wikistatedir}/aggregate") ||
+               error("rename $newfile: $!", $cleanup);
+
+       my $timestamp=undef;
+       foreach my $feed (keys %feeds) {
+               my $t=$feeds{$feed}->{lastupdate}+$feeds{$feed}->{updateinterval};
+               if (! defined $timestamp || $timestamp > $t) {
+                       $timestamp=$t;
+               }
+       }
+       $newfile=~s/\.new$/time/;
+       open (OUT, ">", $newfile) || error("open $newfile: $!", $cleanup);
+       if (defined $timestamp) {
+               print OUT $timestamp."\n";
+       }
+       close OUT || error("save $newfile: $!", $cleanup);
+}
+
+sub garbage_collect () {
+       foreach my $name (keys %feeds) {
+               # remove any feeds that were not seen while building the pages
+               # that used to contain them
+               if ($feeds{$name}->{unseen}) {
+                       delete $feeds{$name};
+               }

        }
        }

-       close OUT;
-} #}}}

 
 

-sub aggregate () { #{{{
-       eval q{use XML::Feed};
-       die $@ if $@;
-       eval q{use HTML::Entities};
-       die $@ if $@;
+       foreach my $guid (values %guids) {
+               # any guid whose feed is gone should be removed
+               if (! exists $feeds{$guid->{feed}}) {
+                       unlink "$config{srcdir}/".htmlfn($guid->{page})
+                               if exists $guid->{page};
+                       delete $guids{$guid->{guid}};
+               }
+               # handle expired guids
+               elsif ($guid->{expired} && exists $guid->{page}) {
+                       unlink "$config{srcdir}/".htmlfn($guid->{page});
+                       delete $guid->{page};
+                       delete $guid->{md5};
+               }
+       }
+}
+
+sub mergestate () {
+       # Load the current state in from disk, and merge into it
+       # values from the state in memory that might have changed
+       # during aggregation.
+       my %myfeeds=%feeds;
+       my %myguids=%guids;
+       clearstate();
+       loadstate();
+
+       # All that can change in feed state during aggregation is a few
+       # fields.
+       foreach my $name (keys %myfeeds) {
+               if (exists $feeds{$name}) {
+                       foreach my $field (qw{message lastupdate lasttry
+                                             numposts newposts error}) {
+                               $feeds{$name}->{$field}=$myfeeds{$name}->{$field};
+                       }
+               }
+       }

 
 

+       # New guids can be created during aggregation.
+       # Guids have a few fields that may be updated during aggregation.
+       # It's also possible that guids were removed from the on-disk state
+       # while the aggregation was in process. That would only happen if
+       # their feed was also removed, so any removed guids added back here
+       # will be garbage collected later.
+       foreach my $guid (keys %myguids) {
+               if (! exists $guids{$guid}) {
+                       $guids{$guid}=$myguids{$guid};
+               }
+               else {
+                       foreach my $field (qw{md5}) {
+                               $guids{$guid}->{$field}=$myguids{$guid}->{$field};
+                       }
+               }
+       }
+}
+
+sub clearstate () {
+       %feeds=();
+       %guids=();
+       $state_loaded=0;
+}
+
+sub expire () {

        foreach my $feed (values %feeds) {
        foreach my $feed (values %feeds) {

-               next unless $IkiWiki::config{rebuild} || 
-                       time - $feed->{lastupdate} >= $feed->{updateinterval};
-               $feed->{lastupdate}=time;
+               next unless $feed->{expireage} || $feed->{expirecount};
+               my $count=0;
+               my %seen;
+               foreach my $item (sort { ($IkiWiki::pagectime{$b->{page}} || 0) <=> ($IkiWiki::pagectime{$a->{page}} || 0) }
+                                 grep { exists $_->{page} && $_->{feed} eq $feed->{name} }
+                                 values %guids) {
+                       if ($feed->{expireage}) {
+                               my $days_old = (time - ($IkiWiki::pagectime{$item->{page}} || 0)) / 60 / 60 / 24;
+                               if ($days_old > $feed->{expireage}) {
+                                       debug(sprintf(gettext("expiring %s (%s days old)"),
+                                               $item->{page}, int($days_old)));
+                                       $item->{expired}=1;
+                               }
+                       }
+                       elsif ($feed->{expirecount} &&
+                              $count >= $feed->{expirecount}) {
+                               debug(sprintf(gettext("expiring %s"), $item->{page}));
+                               $item->{expired}=1;
+                       }
+                       else {
+                               if (! $seen{$item->{page}}) {
+                                       $seen{$item->{page}}=1;
+                                       $count++;
+                               }
+                       }
+               }
+       }
+}
+
+sub needsaggregate () {
+       return values %feeds if $config{rebuild};
+       return grep { time - $_->{lastupdate} >= $_->{updateinterval} } values %feeds;
+}
+
+sub aggregate (@) {
+       eval q{use XML::Feed};
+       error($@) if $@;
+       eval q{use URI::Fetch};
+       error($@) if $@;
+
+       foreach my $feed (@_) {
+               $feed->{lasttry}=time;

                $feed->{newposts}=0;
                $feed->{newposts}=0;

-               $IkiWiki::forcerebuild{$feed->{sourcepage}}=1;
+               $feed->{message}=sprintf(gettext("last checked %s"),
+                       displaytime($feed->{lasttry}));
+               $feed->{error}=0;

 
 

-               IkiWiki::debug("checking feed ".$feed->{name}." ...");
+               debug(sprintf(gettext("checking feed %s ..."), $feed->{name}));

 
                if (! length $feed->{feedurl}) {
                        my @urls=XML::Feed->find_feeds($feed->{url});
                        if (! @urls) {
 
                if (! length $feed->{feedurl}) {
                        my @urls=XML::Feed->find_feeds($feed->{url});
                        if (! @urls) {

-                               $feed->{message}="could not find feed at ".$feed->{feedurl};
-                               IkiWiki::debug($feed->{message});
+                               $feed->{message}=sprintf(gettext("could not find feed at %s"), $feed->{url});
+                               $feed->{error}=1;
+                               debug($feed->{message});

                                next;
                        }
                        $feed->{feedurl}=pop @urls;
                }
                                next;
                        }
                        $feed->{feedurl}=pop @urls;
                }

-               my $f=eval{XML::Feed->parse(URI->new($feed->{feedurl}))};
+               my $res=URI::Fetch->fetch($feed->{feedurl});
+               if (! $res) {
+                       $feed->{message}=URI::Fetch->errstr;
+                       $feed->{error}=1;
+                       debug($feed->{message});
+                       next;
+               }
+
+               # lastupdate is only set if we were able to contact the server
+               $feed->{lastupdate}=$feed->{lasttry};
+
+               if ($res->status == URI::Fetch::URI_GONE()) {
+                       $feed->{message}=gettext("feed not found");
+                       $feed->{error}=1;
+                       debug($feed->{message});
+                       next;
+               }
+               my $content=$res->content;
+               my $f=eval{XML::Feed->parse(\$content)};
+               if ($@) {
+                       # One common cause of XML::Feed crashing is a feed
+                       # that contains invalid UTF-8 sequences. Convert
+                       # feed to ascii to try to work around.
+                       $feed->{message}.=" ".sprintf(gettext("(invalid UTF-8 stripped from feed)"));
+                       $f=eval {
+                               $content=Encode::decode_utf8($content, 0);
+                               XML::Feed->parse(\$content)
+                       };
+               }
+               if ($@) {
+                       # Another possibility is badly escaped entities.
+                       $feed->{message}.=" ".sprintf(gettext("(feed entities escaped)"));
+                       $content=~s/\&(?!amp)(\w+);/&amp;$1;/g;
+                       $f=eval {
+                               $content=Encode::decode_utf8($content, 0);
+                               XML::Feed->parse(\$content)
+                       };
+               }

                if ($@) {
                if ($@) {

-                       $feed->{message}="feed crashed XML::Feed! $@";
-                       IkiWiki::debug($feed->{message});
+                       $feed->{message}=gettext("feed crashed XML::Feed!")." ($@)";
+                       $feed->{error}=1;
+                       debug($feed->{message});

                        next;
                }
                if (! $f) {
                        $feed->{message}=XML::Feed->errstr;
                        next;
                }
                if (! $f) {
                        $feed->{message}=XML::Feed->errstr;

-                       IkiWiki::debug($feed->{message});
+                       $feed->{error}=1;
+                       debug($feed->{message});

                        next;
                }
 
                foreach my $entry ($f->entries) {
                        next;
                }
 
                foreach my $entry ($f->entries) {

+                       # XML::Feed doesn't work around XML::Atom's bizarre
+                       # API, so we will. Real unicode strings? Yes please.
+                       # See [[bugs/Aggregated_Atom_feeds_are_double-encoded]]
+                       local $XML::Atom::ForceUnicode = 1;
+
+                       my $c=$entry->content;
+                       # atom feeds may have no content, only a summary
+                       if (! defined $c && ref $entry->summary) {
+                               $c=$entry->summary;
+                       }
+

                        add_page(
                                feed => $feed,
                        add_page(
                                feed => $feed,

+                               copyright => $f->copyright,

                                title => defined $entry->title ? decode_entities($entry->title) : "untitled",
                                link => $entry->link,
                                title => defined $entry->title ? decode_entities($entry->title) : "untitled",
                                link => $entry->link,

-                               content => $entry->content->body,
-                               guid => defined $entry->id ? $entry->id : time."_".$feed->name,
+                               content => (defined $c && defined $c->body) ? $c->body : "",
+                               guid => defined $entry->id ? $entry->id : time."_".$feed->{name},

                                ctime => $entry->issued ? ($entry->issued->epoch || time) : time,
                                ctime => $entry->issued ? ($entry->issued->epoch || time) : time,

+                               base => (defined $c && $c->can("base")) ? $c->base : undef,

                        );
                }
                        );
                }

-
-               $feed->{message}="processed ok";

        }
        }

+}

 
 

-       # TODO: expiry
-} #}}}
-
-sub add_page (@) { #{{{
+sub add_page (@) {

        my %params=@_;
        
        my $feed=$params{feed};
        my %params=@_;
        
        my $feed=$params{feed};


@@ -245,6 +590,7 @@ sub add_page (@) { #{{{
        if (exists $guids{$params{guid}}) {
                # updating an existing post
                $guid=$guids{$params{guid}};
        if (exists $guids{$params{guid}}) {
                # updating an existing post
                $guid=$guids{$params{guid}};

+               return if $guid->{expired};

        }
        else {
                # new post
        }
        else {
                # new post


@@ -255,23 +601,35 @@ sub add_page (@) { #{{{
                $feed->{newposts}++;
 
                # assign it an unused page
                $feed->{newposts}++;
 
                # assign it an unused page

-               my $page=IkiWiki::titlepage($params{title});
+               my $page=titlepage($params{title});

                # escape slashes and periods in title so it doesn't specify
                # directory name or trigger ".." disallowing code.
                $page=~s!([/.])!"__".ord($1)."__"!eg;
                $page=$feed->{dir}."/".$page;
                # escape slashes and periods in title so it doesn't specify
                # directory name or trigger ".." disallowing code.
                $page=~s!([/.])!"__".ord($1)."__"!eg;
                $page=$feed->{dir}."/".$page;

-               $page=lc($page);
-               ($page)=$page=~/$IkiWiki::config{wiki_file_regexp}/;
+               ($page)=$page=~/$config{wiki_file_regexp}/;

                if (! defined $page || ! length $page) {
                        $page=$feed->{dir}."/item";
                }
                my $c="";
                if (! defined $page || ! length $page) {
                        $page=$feed->{dir}."/item";
                }
                my $c="";

-               while (exists $IkiWiki::pagesources{$page.$c} ||
-                      -e pagefile($page.$c)) {
+               while (exists $IkiWiki::pagecase{lc $page.$c} ||
+                      -e "$config{srcdir}/".htmlfn($page.$c)) {

                        $c++
                }
                        $c++
                }

+
+               # Make sure that the file name isn't too long. 
+               # NB: This doesn't check for path length limits.
+               my $max=POSIX::pathconf($config{srcdir}, &POSIX::_PC_NAME_MAX);
+               if (defined $max && length(htmlfn($page)) >= $max) {
+                       $c="";
+                       $page=$feed->{dir}."/item";
+                       while (exists $IkiWiki::pagecase{lc $page.$c} ||
+                              -e "$config{srcdir}/".htmlfn($page.$c)) {
+                               $c++
+                       }
+               }
+

                $guid->{page}=$page;
                $guid->{page}=$page;

-               IkiWiki::debug("creating new page $page");
+               debug(sprintf(gettext("creating new page %s"), $page));

        }
        $guid->{feed}=$feed->{name};
        
        }
        $guid->{feed}=$feed->{name};
        


@@ -279,50 +637,69 @@ sub add_page (@) { #{{{
        # to avoid unneccessary rebuilding. The mtime from rss cannot be
        # trusted; let's use a digest.
        eval q{use Digest::MD5 'md5_hex'};
        # to avoid unneccessary rebuilding. The mtime from rss cannot be
        # trusted; let's use a digest.
        eval q{use Digest::MD5 'md5_hex'};

+       error($@) if $@;

        require Encode;
        my $digest=md5_hex(Encode::encode_utf8($params{content}));
        require Encode;
        my $digest=md5_hex(Encode::encode_utf8($params{content}));

-       return unless ! exists $guid->{md5} || $guid->{md5} ne $digest || $IkiWiki::config{rebuild};
+       return unless ! exists $guid->{md5} || $guid->{md5} ne $digest || $config{rebuild};

        $guid->{md5}=$digest;
 
        # Create the page.
        $guid->{md5}=$digest;
 
        # Create the page.

-       my $template=IkiWiki::template("aggregatepost.tmpl", blind_cache => 1);
+       my $template;
+       eval {
+               $template=template($feed->{template}, blind_cache => 1);
+       };
+       if ($@) {
+               print STDERR gettext("failed to process template:")." $@";
+               return;
+       }

        $template->param(title => $params{title})
                if defined $params{title} && length($params{title});
        $template->param(title => $params{title})
                if defined $params{title} && length($params{title});

-       $template->param(content => htmlescape(htmlabs($params{content}, $feed->{feedurl})));
-       $template->param(url => $feed->{url});
+       $template->param(content => wikiescape(htmlabs($params{content},
+               defined $params{base} ? $params{base} : $feed->{feedurl})));

        $template->param(name => $feed->{name});
        $template->param(name => $feed->{name});

-       $template->param(link => urlabs($params{link}, $feed->{feedurl}))
+       $template->param(url => $feed->{url});
+       $template->param(copyright => $params{copyright})
+               if defined $params{copyright} && length $params{copyright};
+       $template->param(permalink => urlabs($params{link}, $feed->{feedurl}))

                if defined $params{link};
        if (ref $feed->{tags}) {
                $template->param(tags => [map { tag => $_ }, @{$feed->{tags}}]);
        }
                if defined $params{link};
        if (ref $feed->{tags}) {
                $template->param(tags => [map { tag => $_ }, @{$feed->{tags}}]);
        }

-       IkiWiki::writefile($guid->{page}.".html", $IkiWiki::config{srcdir},
+       writefile(htmlfn($guid->{page}), $config{srcdir},

                $template->output);
 
                $template->output);
 

-       # Set the mtime, this lets the build process get the right creation
-       # time on record for the new page.
-       utime $mtime, $mtime, pagefile($guid->{page}) if defined $mtime;
-} #}}}
+       if (defined $mtime && $mtime <= time) {
+               # Set the mtime, this lets the build process get the right
+               # creation time on record for the new page.
+               utime $mtime, $mtime, "$config{srcdir}/".htmlfn($guid->{page});
+               # Store it in pagectime for expiry code to use also.
+               $IkiWiki::pagectime{$guid->{page}}=$mtime
+                       unless exists $IkiWiki::pagectime{$guid->{page}};
+       }
+       else {
+               # Dummy value for expiry code.
+               $IkiWiki::pagectime{$guid->{page}}=time
+                       unless exists $IkiWiki::pagectime{$guid->{page}};
+       }
+}

 
 

-sub htmlescape ($) { #{{{
+sub wikiescape ($) {

        # escape accidental wikilinks and preprocessor stuff
        # escape accidental wikilinks and preprocessor stuff

-       my $html=shift;
-       $html=~s/(?<!\\)\[\[/\\\[\[/g;
-       return $html;
-} #}}}
+       return encode_entities(shift, '\[\]');
+}

 
 

-sub urlabs ($$) { #{{{
+sub urlabs ($$) {

        my $url=shift;
        my $urlbase=shift;
 
        URI->new_abs($url, $urlbase)->as_string;
        my $url=shift;
        my $urlbase=shift;
 
        URI->new_abs($url, $urlbase)->as_string;

-} #}}}
+}

 
 

-sub htmlabs ($$) { #{{{
+sub htmlabs ($$) {

        # Convert links in html from relative to absolute.
        # Note that this is a heuristic, which is not specified by the rss
        # spec and may not be right for all feeds. Also, see Debian
        # Convert links in html from relative to absolute.
        # Note that this is a heuristic, which is not specified by the rss
        # spec and may not be right for all feeds. Also, see Debian

-       # bug #XXXX TODO: get bug.
+       # bug #381359.

        my $html=shift;
        my $urlbase=shift;
 
        my $html=shift;
        my $urlbase=shift;
 


@@ -354,24 +731,32 @@ sub htmlabs ($$) { #{{{
        $p->eof;
 
        return $ret;
        $p->eof;
 
        return $ret;

-} #}}}
+}

 
 

-sub remove_feeds () { #{{{
-       my $page=shift;
+sub htmlfn ($) {
+       return shift().".".($config{aggregateinternal} ? "_aggregated" : $config{htmlext});
+}

 
 

-       my %removed;
-       foreach my $id (keys %feeds) {
-               if ($feeds{$id}->{sourcepage} eq $page) {
-                       $feeds{$id}->{remove}=1;
-                       $removed{$id}=1;
-               }
-       }
-} #}}}
+my $aggregatelock;

 
 

-sub pagefile ($) { #{{{
-       my $page=shift;
+sub lockaggregate () {
+       # Take an exclusive lock to prevent multiple concurrent aggregators.
+       # Returns true if the lock was aquired.
+       if (! -d $config{wikistatedir}) {
+               mkdir($config{wikistatedir});
+       }
+       open($aggregatelock, '>', "$config{wikistatedir}/aggregatelock") ||
+               error ("cannot open to $config{wikistatedir}/aggregatelock: $!");
+       if (! flock($aggregatelock, 2 | 4)) { # LOCK_EX | LOCK_NB
+               close($aggregatelock) || error("failed closing aggregatelock: $!");
+               return 0;
+       }
+       return 1;
+}

 
 

-       return "$IkiWiki::config{srcdir}/$page.html";
-} #}}}
+sub unlockaggregate () {
+       return close($aggregatelock) if $aggregatelock;
+       return;
+}

 
 1
 
 1