Merge commit 'upstream/master'

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

diff --git a/IkiWiki/Plugin/aggregate.pm b/IkiWiki/Plugin/aggregate.pm
index 9da619375df515ec4e8d236d10ce7b7b5b2c2130..2e4c86f242ae0673899c6faa330896544218b705 100644 (file)
--- a/IkiWiki/Plugin/aggregate.pm
+++ b/IkiWiki/Plugin/aggregate.pm
@@ -16,11 +16,13 @@ my %guids;
 
 sub import { #{{{
        hook(type => "getopt", id => "aggregate", call => \&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 => "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);
        }
        if (exists $config{aggregate_webtrigger} && $config{aggregate_webtrigger}) {
                hook(type => "cgi", id => "aggregate", call => \&cgi);
        }


@@ -36,6 +38,28 @@ sub getopt () { #{{{
        );
 } #}}}
 
        );
 } #}}}
 

+sub getsetup () { #{{{
+       return
+               plugin => {
+                       safe => 1,
+                       rebuild => undef,
+               },
+               aggregateinternal => {
+                       type => "boolean",
+                       example => 0,
+                       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 ($config{aggregate} && ! ($config{post_commit} && 
                                     IkiWiki::commit_hook_enabled())) {
 sub checkconfig () { #{{{
        if ($config{aggregate} && ! ($config{post_commit} && 
                                     IkiWiki::commit_hook_enabled())) {


@@ -113,46 +137,58 @@ sub launchaggregation () { #{{{
        return 1;
 } #}}}
 
        return 1;
 } #}}}
 

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

 
 

+# Used by ikiwiki-transition aggregateinternal.
+sub migrate_to_internal { #{{{

        if (! lockaggregate()) {
        if (! lockaggregate()) {

-               error("an aggregation process is already running");
-               return;
+               error("an aggregation process is currently running");

        }
 
        IkiWiki::lockwiki();
        loadstate();
        }
 
        IkiWiki::lockwiki();
        loadstate();

+       $config{verbose}=1;

 
        foreach my $data (values %guids) {
                next unless $data->{page};
 
        foreach my $data (values %guids) {
                next unless $data->{page};

-
+               next if $data->{expired};
+               

                $config{aggregateinternal} = 0;
                $config{aggregateinternal} = 0;

-               my $oldname = pagefile($data->{page});
-
+               my $oldname = "$config{srcdir}/".htmlfn($data->{page});
+               my $oldoutput = $config{destdir}."/".IkiWiki::htmlpage($data->{page});
+               

                $config{aggregateinternal} = 1;
                $config{aggregateinternal} = 1;

-               my $newname = pagefile($data->{page});
-
-               print "I: $oldname -> $newname\n";
+               my $newname = "$config{srcdir}/".htmlfn($data->{page});
+               
+               debug "moving $oldname -> $newname";

                if (-e $newname) {
                        if (-e $oldname) {
                                error("$newname already exists");
                        }
                        else {
                if (-e $newname) {
                        if (-e $oldname) {
                                error("$newname already exists");
                        }
                        else {

-                               print STDERR 
-                                       "W: already renamed to $newname?\n";
+                               debug("already renamed to $newname?");

                        }
                }
                elsif (-e $oldname) {
                        rename($oldname, $newname) || error("$!");
                }
                else {
                        }
                }
                elsif (-e $oldname) {
                        rename($oldname, $newname) || error("$!");
                }
                else {

-                       print "W: $oldname not found\n";
+                       debug("$oldname not found");
+               }
+               if (-e $oldoutput) {
+                       require IkiWiki::Render;
+                       debug("removing output file $oldoutput");
+                       IkiWiki::prune($oldoutput);

                }
        }
                }
        }

-
+       

        savestate();
        IkiWiki::unlockwiki;
        savestate();
        IkiWiki::unlockwiki;

-
+       

        unlockaggregate();
 } #}}}
 
        unlockaggregate();
 } #}}}
 


@@ -192,7 +228,7 @@ 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)=$dir=~/$config{wiki_file_regexp}/;
        $feed->{dir}=$dir;
        $dir=~s/^\/+//;
        ($dir)=$dir=~/$config{wiki_file_regexp}/;
        $feed->{dir}=$dir;


@@ -328,13 +364,13 @@ sub garbage_collect () { #{{{
        foreach my $guid (values %guids) {
                # any guid whose feed is gone should be removed
                if (! exists $feeds{$guid->{feed}}) {
        foreach my $guid (values %guids) {
                # any guid whose feed is gone should be removed
                if (! exists $feeds{$guid->{feed}}) {

-                       unlink pagefile($guid->{page})
+                       unlink "$config{srcdir}/".htmlfn($guid->{page})

                                if exists $guid->{page};
                        delete $guids{$guid->{guid}};
                }
                # handle expired guids
                elsif ($guid->{expired} && exists $guid->{page}) {
                                if exists $guid->{page};
                        delete $guids{$guid->{guid}};
                }
                # handle expired guids
                elsif ($guid->{expired} && exists $guid->{page}) {

-                       unlink pagefile($guid->{page});
+                       unlink "$config{srcdir}/".htmlfn($guid->{page});

                        delete $guid->{page};
                        delete $guid->{md5};
                }
                        delete $guid->{page};
                        delete $guid->{md5};
                }


@@ -384,11 +420,11 @@ sub expire () { #{{{
                next unless $feed->{expireage} || $feed->{expirecount};
                my $count=0;
                my %seen;
                next unless $feed->{expireage} || $feed->{expirecount};
                my $count=0;
                my %seen;

-               foreach my $item (sort { $IkiWiki::pagectime{$b->{page}} <=> $IkiWiki::pagectime{$a->{page}} }
-                                 grep { exists $_->{page} && $_->{feed} eq $feed->{name} && $IkiWiki::pagectime{$_->{page}} }
+               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}) {
                                  values %guids) {
                        if ($feed->{expireage}) {

-                               my $days_old = (time - $IkiWiki::pagectime{$item->{page}}) / 60 / 60 / 24;
+                               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)));
                                if ($days_old > $feed->{expireage}) {
                                        debug(sprintf(gettext("expiring %s (%s days old)"),
                                                $item->{page}, int($days_old)));


@@ -424,7 +460,7 @@ sub aggregate (@) { #{{{
        foreach my $feed (@_) {
                $feed->{lastupdate}=time;
                $feed->{newposts}=0;
        foreach my $feed (@_) {
                $feed->{lastupdate}=time;
                $feed->{newposts}=0;

-               $feed->{message}=sprintf(gettext("processed ok at %s"),
+               $feed->{message}=sprintf(gettext("last checked %s"),

                        displaytime($feed->{lastupdate}));
                $feed->{error}=0;
 
                        displaytime($feed->{lastupdate}));
                $feed->{error}=0;
 


@@ -484,12 +520,18 @@ sub aggregate (@) { #{{{
                }
 
                foreach my $entry ($f->entries) {
                }
 
                foreach my $entry ($f->entries) {

+                       my $content=$content=$entry->content->body;
+                       # atom feeds may have no content, only a summary
+                       if (! defined $content && ref $entry->summary) {
+                               $content=$entry->summary->body;
+                       }
+

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

-                               content => defined $entry->content->body ? $entry->content->body : "",
+                               content => defined $content ? $content : "",

                                guid => defined $entry->id ? $entry->id : time."_".$feed->{name},
                                ctime => $entry->issued ? ($entry->issued->epoch || time) : time,
                        );
                                guid => defined $entry->id ? $entry->id : time."_".$feed->{name},
                                ctime => $entry->issued ? ($entry->issued->epoch || time) : time,
                        );


@@ -517,7 +559,7 @@ 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;
                # escape slashes and periods in title so it doesn't specify
                # directory name or trigger ".." disallowing code.
                $page=~s!([/.])!"__".ord($1)."__"!eg;


@@ -528,7 +570,7 @@ sub add_page (@) { #{{{
                }
                my $c="";
                while (exists $IkiWiki::pagecase{lc $page.$c} ||
                }
                my $c="";
                while (exists $IkiWiki::pagecase{lc $page.$c} ||

-                      -e pagefile($page.$c)) {
+                      -e "$config{srcdir}/".htmlfn($page.$c)) {

                        $c++
                }
 
                        $c++
                }
 


@@ -539,7 +581,7 @@ sub add_page (@) { #{{{
                        $c="";
                        $page=$feed->{dir}."/item";
                        while (exists $IkiWiki::pagecase{lc $page.$c} ||
                        $c="";
                        $page=$feed->{dir}."/item";
                        while (exists $IkiWiki::pagecase{lc $page.$c} ||

-                              -e pagefile($page.$c)) {
+                              -e "$config{srcdir}/".htmlfn($page.$c)) {

                                $c++
                        }
                }
                                $c++
                        }
                }


@@ -576,10 +618,17 @@ sub add_page (@) { #{{{
        writefile(htmlfn($guid->{page}), $config{srcdir},
                $template->output);
 
        writefile(htmlfn($guid->{page}), $config{srcdir},
                $template->output);
 

-       # Set the mtime, this lets the build process get the right creation
-       # time on record for the new page.
-       utime $mtime, $mtime, pagefile($guid->{page})
-               if defined $mtime && $mtime <= time;
+       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;
+       }
+       else {
+               # Dummy value for expiry code.
+               $IkiWiki::pagectime{$guid->{page}}=time;
+       }

 } #}}}
 
 sub htmlescape ($) { #{{{
 } #}}}
 
 sub htmlescape ($) { #{{{


@@ -634,14 +683,8 @@ sub htmlabs ($$) { #{{{
        return $ret;
 } #}}}
 
        return $ret;
 } #}}}
 

-sub pagefile ($) { #{{{
-       my $page=shift;
-
-       return "$config{srcdir}/".htmlfn($page);
-} #}}}
-

 sub htmlfn ($) { #{{{
 sub htmlfn ($) { #{{{

-       return shift().".".($config{aggregateinternal} ? "_" : "").$config{htmlext};
+       return shift().".".($config{aggregateinternal} ? "_aggregated" : $config{htmlext});

 } #}}}
 
 my $aggregatelock;
 } #}}}
 
 my $aggregatelock;