web commit by http://id.loopysoft.com/matt/: Ignore my stupid choices for paths

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

diff --git a/IkiWiki/Plugin/aggregate.pm b/IkiWiki/Plugin/aggregate.pm
index c8d21864a4f452ea3d58227bb42f1ec67ce96867..0da527f25e7bff733b0f64473e6fc7f67d323982 100644 (file)
--- a/IkiWiki/Plugin/aggregate.pm
+++ b/IkiWiki/Plugin/aggregate.pm
@@ -4,11 +4,12 @@ package IkiWiki::Plugin::aggregate;
 
 use warnings;
 use strict;
 
 use warnings;
 use strict;

-use IkiWiki;
+use IkiWiki 2.00;

 use HTML::Entities;
 use HTML::Parser;
 use HTML::Tagset;
 use URI;
 use HTML::Entities;
 use HTML::Parser;
 use HTML::Tagset;
 use URI;

+use open qw{:utf8 :std};

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


@@ -16,7 +17,7 @@ my %guids;
 sub import { #{{{
        hook(type => "getopt", id => "aggregate", call => \&getopt);
        hook(type => "checkconfig", id => "aggregate", call => \&checkconfig);
 sub import { #{{{
        hook(type => "getopt", id => "aggregate", call => \&getopt);
        hook(type => "checkconfig", id => "aggregate", call => \&checkconfig);

-       hook(type => "filter", id => "aggregate", call => \&filter);
+       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 => "preprocess", id => "aggregate", call => \&preprocess);
         hook(type => "delete", id => "aggregate", call => \&delete);
        hook(type => "savestate", id => "aggregate", call => \&savestate);


@@ -24,31 +25,42 @@ sub import { #{{{
 
 sub getopt () { #{{{
         eval q{use Getopt::Long};
 
 sub getopt () { #{{{
         eval q{use Getopt::Long};

+       error($@) if $@;

         Getopt::Long::Configure('pass_through');
         GetOptions("aggregate" => \$config{aggregate});
 } #}}}
 
 sub checkconfig () { #{{{
         Getopt::Long::Configure('pass_through');
         GetOptions("aggregate" => \$config{aggregate});
 } #}}}
 
 sub checkconfig () { #{{{

-       IkiWiki::lockwiki();
-       loadstate();
-       if ($config{aggregate}) {
+       if ($config{aggregate} && ! ($config{post_commit} && 
+                                    IkiWiki::commit_hook_enabled())) {
+               if (! IkiWiki::lockwiki(0)) {
+                       debug("wiki is locked by another process, not aggregating");
+                       exit 1;
+               }
+       
+               loadstate();

                IkiWiki::loadindex();
                aggregate();
                expire();
                savestate();
                IkiWiki::loadindex();
                aggregate();
                expire();
                savestate();

+               clearstate();
+
+               IkiWiki::unlockwiki();

        }
        }

-       IkiWiki::unlockwiki();

 } #}}}
 
 } #}}}
 

-sub filter (@) { #{{{
-       my %params=@_;
-       my $page=$params{page};
-
-       # Mark all feeds originating on this page as removable;
-       # preprocess will unmark those that still exist.
-       remove_feeds($page);
+sub needsbuild (@) { #{{{
+       my $needsbuild=shift;
+       
+       loadstate(); # if not already loaded

 
 

-       return $params{content};
+       foreach my $feed (values %feeds) {
+               if (grep { $_ eq $pagesources{$feed->{sourcepage}} } @$needsbuild) {
+                       # Mark all feeds originating on this page as removable;
+                       # preprocess will unmark those that still exist.
+                       remove_feeds($feed->{sourcepage});
+               }
+       }

 } # }}}
 
 sub preprocess (@) { #{{{
 } # }}}
 
 sub preprocess (@) { #{{{


@@ -56,7 +68,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 plugin missing $required parameter]]";
+                       return "[[aggregate ".sprintf(gettext("missing %s parameter"), $required)."]]";

                }
        }
 
                }
        }
 


@@ -84,7 +96,7 @@ sub preprocess (@) { #{{{
        $feed->{lastupdate}=0 unless defined $feed->{lastupdate};
        $feed->{numposts}=0 unless defined $feed->{numposts};
        $feed->{newposts}=0 unless defined $feed->{newposts};
        $feed->{lastupdate}=0 unless defined $feed->{lastupdate};
        $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 (@_) {
        $feed->{error}=0 unless defined $feed->{error};
        $feed->{tags}=[];
        while (@_) {


@@ -98,8 +110,9 @@ sub preprocess (@) { #{{{
        return "<a href=\"".$feed->{url}."\">".$feed->{name}."</a>: ".
               ($feed->{error} ? "<em>" : "").$feed->{message}.
               ($feed->{error} ? "</em>" : "").
        return "<a href=\"".$feed->{url}."\">".$feed->{name}."</a>: ".
               ($feed->{error} ? "<em>" : "").$feed->{message}.
               ($feed->{error} ? "</em>" : "").

-              " (".$feed->{numposts}." posts".
-              ($feed->{newposts} ? "; ".$feed->{newposts}." new" : "").
+              " (".$feed->{numposts}." ".gettext("posts").
+              ($feed->{newposts} ? "; ".$feed->{newposts}.
+                                   " ".gettext("new") : "").

               ")";
 } # }}}
 
               ")";
 } # }}}
 


@@ -113,10 +126,13 @@ sub delete (@) { #{{{
        }
 } #}}}
 
        }
 } #}}}
 

+my $state_loaded=0;

 sub loadstate () { #{{{
 sub loadstate () { #{{{

+       return if $state_loaded;
+       $state_loaded=1;

        if (-e "$config{wikistatedir}/aggregate") {
        if (-e "$config{wikistatedir}/aggregate") {

-               open (IN, "$config{wikistatedir}/aggregate" ||
-                       die "$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;


@@ -148,10 +164,12 @@ sub loadstate () { #{{{
 } #}}}
 
 sub savestate () { #{{{
 } #}}}
 
 sub savestate () { #{{{

+       return unless $state_loaded;

        eval q{use HTML::Entities};
        eval q{use HTML::Entities};

-       die $@ if $@;
-       open (OUT, ">$config{wikistatedir}/aggregate" ||
-               die "$config{wikistatedir}/aggregate: $!");
+       error($@) if $@;
+       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) {
                if ($data->{remove}) {
                        if ($data->{name}) {
        foreach my $data (values %feeds, values %guids) {
                if ($data->{remove}) {
                        if ($data->{name}) {


@@ -162,7 +180,8 @@ sub savestate () { #{{{
                                }
                        }
                        else {
                                }
                        }
                        else {

-                               unlink pagefile($data->{page});
+                               unlink pagefile($data->{page})
+                                       if exists $data->{page};

                        }
                        next;
                }
                        }
                        next;
                }


@@ -185,32 +204,45 @@ sub savestate () { #{{{
                                push @line, "$field=".$data->{$field};
                        }
                }
                                push @line, "$field=".$data->{$field};
                        }
                }

-               print OUT join(" ", @line)."\n";
+               print OUT join(" ", @line)."\n" || error("write $newfile: $!", $cleanup);

        }
        }

-       close OUT;
+       close OUT || error("save $newfile: $!", $cleanup);
+       rename($newfile, "$config{wikistatedir}/aggregate") ||
+               error("rename $newfile: $!", $cleanup);
+} #}}}
+
+sub clearstate () { #{{{
+       %feeds=();
+       %guids=();
+       $state_loaded=0;

 } #}}}
 
 sub expire () { #{{{
        foreach my $feed (values %feeds) {
                next unless $feed->{expireage} || $feed->{expirecount};
                my $count=0;
 } #}}}
 
 sub expire () { #{{{
        foreach my $feed (values %feeds) {
                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}} }
                                  values %guids) {
                        if ($feed->{expireage}) {
                                my $days_old = (time - $IkiWiki::pagectime{$item->{page}}) / 60 / 60 / 24;
                                if ($days_old > $feed->{expireage}) {
                foreach my $item (sort { $IkiWiki::pagectime{$b->{page}} <=> $IkiWiki::pagectime{$a->{page}} }
                                  grep { exists $_->{page} && $_->{feed} eq $feed->{name} && $IkiWiki::pagectime{$_->{page}} }
                                  values %guids) {
                        if ($feed->{expireage}) {
                                my $days_old = (time - $IkiWiki::pagectime{$item->{page}}) / 60 / 60 / 24;
                                if ($days_old > $feed->{expireage}) {

-                                       debug("expiring ".$item->{page}." ($days_old days old)");
+                                       debug(sprintf(gettext("expiring %s (%s days old)"),
+                                               $item->{page}, int($days_old)));

                                        $item->{expired}=1;
                                }
                        }
                        elsif ($feed->{expirecount} &&
                               $count >= $feed->{expirecount}) {
                                        $item->{expired}=1;
                                }
                        }
                        elsif ($feed->{expirecount} &&
                               $count >= $feed->{expirecount}) {

-                               debug("expiring ".$item->{page});
+                               debug(sprintf(gettext("expiring %s"), $item->{page}));

                                $item->{expired}=1;
                        }
                        else {
                                $item->{expired}=1;
                        }
                        else {

-                               $count++;
+                               if (! $seen{$item->{page}}) {
+                                       $seen{$item->{page}}=1;
+                                       $count++;
+                               }

                        }
                }
        }
                        }
                }
        }


@@ -218,32 +250,66 @@ sub expire () { #{{{
 
 sub aggregate () { #{{{
        eval q{use XML::Feed};
 
 sub aggregate () { #{{{
        eval q{use XML::Feed};

-       die $@ if $@;
+       error($@) if $@;
+       eval q{use URI::Fetch};
+       error($@) if $@;

        eval q{use HTML::Entities};
        eval q{use HTML::Entities};

-       die $@ if $@;
+       error($@) if $@;

 
        foreach my $feed (values %feeds) {
                next unless $config{rebuild} || 
                        time - $feed->{lastupdate} >= $feed->{updateinterval};
                $feed->{lastupdate}=time;
                $feed->{newposts}=0;
 
        foreach my $feed (values %feeds) {
                next unless $config{rebuild} || 
                        time - $feed->{lastupdate} >= $feed->{updateinterval};
                $feed->{lastupdate}=time;
                $feed->{newposts}=0;

+               $feed->{message}=sprintf(gettext("processed ok at %s"),
+                       displaytime($feed->{lastupdate}));
+               $feed->{error}=0;

                $IkiWiki::forcerebuild{$feed->{sourcepage}}=1;
 
                $IkiWiki::forcerebuild{$feed->{sourcepage}}=1;
 

-               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};
+                               $feed->{message}=sprintf(gettext("could not find feed at %s"), $feed->{url});

                                $feed->{error}=1;
                                debug($feed->{message});
                                next;
                        }
                        $feed->{feedurl}=pop @urls;
                }
                                $feed->{error}=1;
                                debug($feed->{message});
                                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;
+               }
+               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 ($@) {
                if ($@) {

-                       $feed->{message}="feed crashed XML::Feed! $@";
+                       # 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)"));
+                       $content=Encode::decode_utf8($content);
+                       $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);
+                       $f=eval{XML::Feed->parse(\$content)};
+               }
+               if ($@) {
+                       $feed->{message}=gettext("feed crashed XML::Feed!")." ($@)";

                        $feed->{error}=1;
                        debug($feed->{message});
                        next;
                        $feed->{error}=1;
                        debug($feed->{message});
                        next;


@@ -258,17 +324,14 @@ sub aggregate () { #{{{
                foreach my $entry ($f->entries) {
                        add_page(
                                feed => $feed,
                foreach my $entry ($f->entries) {
                        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,
+                               content => defined $entry->content->body ? $entry->content->body : "",

                                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,
                        );
                }

-
-               $feed->{message}="processed ok at ".
-                       displaytime($feed->{lastupdate});
-               $feed->{error}=0;

        }
 } #}}}
 
        }
 } #}}}
 


@@ -306,8 +369,21 @@ sub add_page (@) { #{{{
                       -e pagefile($page.$c)) {
                        $c++
                }
                       -e pagefile($page.$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 pagefile($page.$c)) {
+                               $c++
+                       }
+               }
+

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

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

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


@@ -315,6 +391,7 @@ 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}));
        return unless ! exists $guid->{md5} || $guid->{md5} ne $digest || $config{rebuild};
        require Encode;
        my $digest=md5_hex(Encode::encode_utf8($params{content}));
        return unless ! exists $guid->{md5} || $guid->{md5} ne $digest || $config{rebuild};


@@ -327,17 +404,20 @@ sub add_page (@) { #{{{
        $template->param(content => htmlescape(htmlabs($params{content}, $feed->{feedurl})));
        $template->param(name => $feed->{name});
        $template->param(url => $feed->{url});
        $template->param(content => htmlescape(htmlabs($params{content}, $feed->{feedurl})));
        $template->param(name => $feed->{name});
        $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}}]);
        }
        $template->param(permalink => urlabs($params{link}, $feed->{feedurl}))
                if defined $params{link};
        if (ref $feed->{tags}) {
                $template->param(tags => [map { tag => $_ }, @{$feed->{tags}}]);
        }

-       writefile(htmlpage($guid->{page}), $config{srcdir},
+       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.
                $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;
+       utime $mtime, $mtime, pagefile($guid->{page})
+               if defined $mtime && $mtime <= time;

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


@@ -407,7 +487,11 @@ sub remove_feeds () { #{{{
 sub pagefile ($) { #{{{
        my $page=shift;
 
 sub pagefile ($) { #{{{
        my $page=shift;
 

-       return "$config{srcdir}/".htmlpage($page);
+       return "$config{srcdir}/".htmlfn($page);
+} #}}}
+
+sub htmlfn ($) { #{{{
+       return shift().".".$config{htmlext};

 } #}}}
 
 1
 } #}}}
 
 1