po plugin: switch to page.LL.html naming convention

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

diff --git a/IkiWiki/Plugin/aggregate.pm b/IkiWiki/Plugin/aggregate.pm
index a9c7447fa8faf6a082e714b84cd203f2c4e3355d..c18784e8b8c64d143c06b469906beb2f329c087b 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);
        }


@@ -30,7 +32,32 @@ sub getopt () { #{{{
         eval q{use Getopt::Long};
        error($@) if $@;
         Getopt::Long::Configure('pass_through');
         eval q{use Getopt::Long};
        error($@) if $@;
         Getopt::Long::Configure('pass_through');

-        GetOptions("aggregate" => \$config{aggregate});
+        GetOptions(
+               "aggregate" => \$config{aggregate},
+               "aggregateinternal!" => \$config{aggregateinternal},
+       );
+} #}}}
+
+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 () { #{{{
 } #}}}
 
 sub checkconfig () { #{{{


@@ -110,6 +137,61 @@ sub launchaggregation () { #{{{
        return 1;
 } #}}}
 
        return 1;
 } #}}}
 

+#  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()) {
+               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;
        
 sub needsbuild (@) { #{{{
        my $needsbuild=shift;
        


@@ -131,7 +213,7 @@ sub preprocess (@) { #{{{
 
        foreach my $required (qw{name url}) {
                if (! exists $params{$required}) {
 
        foreach my $required (qw{name url}) {
                if (! exists $params{$required}) {

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

                }
        }
 
                }
        }
 


@@ -146,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;


@@ -154,6 +236,13 @@ sub preprocess (@) { #{{{
        $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->{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;

+        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->{numposts}=0 unless defined $feed->{numposts};
        delete $feed->{unseen};
        $feed->{lastupdate}=0 unless defined $feed->{lastupdate};
        $feed->{numposts}=0 unless defined $feed->{numposts};


@@ -275,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};
                }


@@ -331,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)));


@@ -407,14 +496,14 @@ sub aggregate (@) { #{{{
                        # 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)"));
                        # 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)"));

-                       $content=Encode::decode_utf8($content);
+                       $content=Encode::decode_utf8($content, 0);

                        $f=eval{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{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;

-                       $content=Encode::decode_utf8($content);
+                       $content=Encode::decode_utf8($content, 0);

                        $f=eval{XML::Feed->parse(\$content)};
                }
                if ($@) {
                        $f=eval{XML::Feed->parse(\$content)};
                }
                if ($@) {


@@ -431,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,
                        );


@@ -464,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;


@@ -475,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++
                }
 


@@ -486,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++
                        }
                }


@@ -507,7 +602,7 @@ sub add_page (@) { #{{{
        $guid->{md5}=$digest;
 
        # Create the page.
        $guid->{md5}=$digest;
 
        # Create the page.

-       my $template=template("aggregatepost.tmpl", blind_cache => 1);
+       my $template=template($feed->{template}, blind_cache => 1);

        $template->param(title => $params{title})
                if defined $params{title} && length($params{title});
        $template->param(content => htmlescape(htmlabs($params{content}, $feed->{feedurl})));
        $template->param(title => $params{title})
                if defined $params{title} && length($params{title});
        $template->param(content => htmlescape(htmlabs($params{content}, $feed->{feedurl})));


@@ -523,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 ($) { #{{{


@@ -581,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{htmlext};
+       return shift().".".($config{aggregateinternal} ? "_aggregated" : $config{htmlext});

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