]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - IkiWiki/Plugin/trail.pm
Show author in addition to feedname, if different.
[git.ikiwiki.info.git] / IkiWiki / Plugin / trail.pm
index 5ee152155187d718d314bb70776ff2ecb8503c6b..d5fb2b5d624c1b21cf0fa9163b5b223a090e917e 100644 (file)
@@ -1,6 +1,6 @@
 #!/usr/bin/perl
 # Copyright © 2008-2011 Joey Hess
-# Copyright © 2009-2011 Simon McVittie <http://smcv.pseudorandom.co.uk/>
+# Copyright © 2009-2012 Simon McVittie <http://smcv.pseudorandom.co.uk/>
 # Licensed under the GNU GPL, version 2, or any later version published by the
 # Free Software Foundation
 package IkiWiki::Plugin::trail;
@@ -13,67 +13,46 @@ sub import {
        hook(type => "getsetup", id => "trail", call => \&getsetup);
        hook(type => "needsbuild", id => "trail", call => \&needsbuild);
        hook(type => "preprocess", id => "trailoptions", call => \&preprocess_trailoptions, scan => 1);
-       hook(type => "preprocess", id => "trailinline", call => \&preprocess_trailinline, scan => 1);
        hook(type => "preprocess", id => "trailitem", call => \&preprocess_trailitem, scan => 1);
        hook(type => "preprocess", id => "trailitems", call => \&preprocess_trailitems, scan => 1);
        hook(type => "preprocess", id => "traillink", call => \&preprocess_traillink, scan => 1);
        hook(type => "pagetemplate", id => "trail", call => \&pagetemplate);
+       hook(type => "build_affected", id => "trail", call => \&build_affected);
 }
 
-=head1 Page state
-
-If a page C<$T> is a trail, then it can have
-
-=over
-
-=item * C<$pagestate{$T}{trail}{contents}>
-
-Reference to an array of lists each containing either:
-
-=over
-
-=item * C<[link, "link"]>
-
-A link specification, pointing to the same page that C<[[link]]> would select
-
-=item * C<[pagespec, "posts/*", "age", 0]>
-
-A match by pagespec; the third array element is the sort order and the fourth
-is whether to reverse sorting
-
-=back
-
-=item * C<$pagestate{$T}{trail}{sort}>
-
-A [[ikiwiki/pagespec/sorting]] order; if absent or undef, the trail is in
-the order given by the links that form it
-
-=item * C<$pagestate{$T}{trail}{circular}>
-
-True if this trail is circular (i.e. going "next" from the last item is
-allowed, and takes you back to the first)
-
-=item * C<$pagestate{$T}{trail}{reverse}>
-
-True if C<sort> is to be reversed.
-
-=back
-
-If a page C<$M> is a member of a trail C<$T>, then it has
-
-=over
-
-=item * C<$pagestate{$M}{trail}{item}{$T}[0]>
-
-The page before this one in C<$T> at the last rebuild, or undef.
-
-=item * C<$pagestate{$M}{trail}{item}{$T}[1]>
-
-The page after this one in C<$T> at the last refresh, or undef.
-
-=back
-
-=cut
+# Page state
+# 
+# If a page $T is a trail, then it can have
+# 
+# * $pagestate{$T}{trail}{contents} 
+#   Reference to an array of lists each containing either:
+#     - [pagenames => "page1", "page2"]
+#       Those literal pages
+#     - [link => "link"]
+#       A link specification, pointing to the same page that [[link]]
+#       would select
+#     - [pagespec => "posts/*", "age", 0]
+#       A match by pagespec; the third array element is the sort order
+#       and the fourth is whether to reverse sorting
+# 
+# * $pagestate{$T}{trail}{sort}
+#   A sorting order; if absent or undef, the trail is in the order given
+#   by the links that form it
+#
+# * $pagestate{$T}{trail}{circular}
+#   True if this trail is circular (i.e. going "next" from the last item is
+#   allowed, and takes you back to the first)
+#
+# * $pagestate{$T}{trail}{reverse}
+#   True if C<sort> is to be reversed.
+# 
+# If a page $M is a member of a trail $T, then it has
+#
+# * $pagestate{$M}{trail}{item}{$T}[0]
+#   The page before this one in C<$T> at the last rebuild, or undef.
+#
+# * $pagestate{$M}{trail}{item}{$T}[1]
+#   The page after this one in C<$T> at the last refresh, or undef.
 
 sub getsetup () {
        return
@@ -83,12 +62,20 @@ sub getsetup () {
                },
 }
 
+# Cache of pages' old titles, so we can tell whether they changed
+my %old_trail_titles;
+
 sub needsbuild (@) {
        my $needsbuild=shift;
+
        foreach my $page (keys %pagestate) {
                if (exists $pagestate{$page}{trail}) {
                        if (exists $pagesources{$page} &&
                            grep { $_ eq $pagesources{$page} } @$needsbuild) {
+                               # Remember its title, so we can know whether
+                               # it changed.
+                               $old_trail_titles{$page} = title_of($page);
+
                                # Remove state, it will be re-added
                                # if the preprocessor directive is still
                                # there during the rebuild. {item} is the
@@ -99,6 +86,7 @@ sub needsbuild (@) {
                        }
                }
        }
+
        return $needsbuild;
 }
 
@@ -123,29 +111,6 @@ sub preprocess_trailoptions (@) {
        return "";
 }
 
-sub preprocess_trailinline (@) {
-       my %params = @_;
-
-       if (! exists $params{sort}) {
-               # sort in the same order as [[plugins/inline]]'s default
-               $params{sort} = 'age';
-       }
-
-       if (defined wantarray) {
-               scalar preprocess_trailitems(%params);
-
-               if (IkiWiki->can("preprocess_inline")) {
-                       return IkiWiki::preprocess_inline(@_);
-               }
-               else {
-                       error("trailinline directive requires the inline plugin");
-               }
-       }
-       else {
-               preprocess_trailitems(%params);
-       }
-}
-
 sub preprocess_trailitem (@) {
        my $link = shift;
        shift;
@@ -194,8 +159,8 @@ sub preprocess_trailitems (@) {
        }
 
        if (exists $params{pagenames}) {
-               my @list = map { [link =>  $_] } split ' ', $params{pagenames};
-               push @{$pagestate{$params{page}}{trail}{contents}}, @list;
+               push @{$pagestate{$params{page}}{trail}{contents}},
+                       [pagenames => (split ' ', $params{pagenames})];
        }
 
        return "";
@@ -274,6 +239,12 @@ sub trails_differ {
                if (! exists $new->{$trail}) {
                        return 1;
                }
+
+               if (exists $old_trail_titles{$trail} &&
+                       title_of($trail) ne $old_trail_titles{$trail}) {
+                       return 1;
+               }
+
                my ($old_p, $old_n) = @{$old->{$trail}};
                my ($new_p, $new_n) = @{$new->{$trail}};
                $old_p = "" unless defined $old_p;
@@ -283,9 +254,20 @@ sub trails_differ {
                if ($old_p ne $new_p) {
                        return 1;
                }
+
+               if (exists $old_trail_titles{$old_p} &&
+                       title_of($old_p) ne $old_trail_titles{$old_p}) {
+                       return 1;
+               }
+
                if ($old_n ne $new_n) {
                        return 1;
                }
+
+               if (exists $old_trail_titles{$old_n} &&
+                       title_of($old_n) ne $old_trail_titles{$old_n}) {
+                       return 1;
+               }
        }
 
        foreach my $trail (keys %$new) {
@@ -299,14 +281,9 @@ sub trails_differ {
 
 my $done_prerender = 0;
 
-my %origsubs;
-
 sub prerender {
        return if $done_prerender;
 
-       $origsubs{render_backlinks} = \&IkiWiki::render_backlinks;
-       inject(name => "IkiWiki::render_backlinks", call => \&render_backlinks);
-
        %trail_to_members = ();
        %member_to_trails = ();
 
@@ -322,6 +299,19 @@ sub prerender {
                                        $c->[1], sort => $c->[2],
                                        reverse => $c->[3]);
                        }
+                       elsif ($c->[0] eq 'pagenames') {
+                               my @pagenames = @$c;
+                               shift @pagenames;
+                               foreach my $page (@pagenames) {
+                                       if (exists $pagesources{$page}) {
+                                               push @$members, $page;
+                                       }
+                                       else {
+                                               # rebuild trail if it turns up
+                                               add_depends($trail, $page, deptype("presence"));
+                                       }
+                               }
+                       }
                        elsif ($c->[0] eq 'link') {
                                my $best = bestlink($trail, $c->[1]);
                                push @$members, $best if length $best;
@@ -354,8 +344,6 @@ sub prerender {
                        $prev = $members->[$i - 1] if $i > 0;
                        my $next = $members->[$i + 1];
 
-                       add_depends($member, $trail);
-
                        $member_to_trails{$member}{$trail} = [$prev, $next];
                }
 
@@ -371,7 +359,7 @@ sub prerender {
                if (exists $pagestate{$member}{trail}{item} &&
                        ! exists $member_to_trails{$member}) {
                        $rebuild_trail_members{$member} = 1;
-                       delete $pagestate{$member}{trailitem};
+                       delete $pagestate{$member}{trail}{item};
                }
        }
 
@@ -392,18 +380,20 @@ sub prerender {
        $done_prerender = 1;
 }
 
-# This is called at about the right time that we can hijack it to render
-# extra pages.
-sub render_backlinks ($) {
-       my $blc = shift;
+sub build_affected {
+       my %affected;
 
-       foreach my $member (keys %rebuild_trail_members) {
-               next unless exists $pagesources{$member};
+       # In principle we might not have done this yet, although in practice
+       # at least the trail itself has probably changed, and its template
+       # almost certainly contains TRAILS or TRAILLOOP, triggering our
+       # prerender as a side-effect.
+       prerender();
 
-               IkiWiki::render($pagesources{$member}, sprintf(gettext("building %s, its previous or next page has changed"), $member));
+       foreach my $member (keys %rebuild_trail_members) {
+               $affected{$member} = sprintf(gettext("building %s, its previous or next page has changed"), $member);
        }
 
-       $origsubs{render_backlinks}($blc);
+       return %affected;
 }
 
 sub title_of ($) {
@@ -421,6 +411,8 @@ sub pagetemplate (@) {
        my $page = $params{page};
        my $template = $params{template};
 
+       return unless length $page;
+
        if ($template->query(name => 'trails') && ! $recursive) {
                prerender();
 
@@ -446,13 +438,11 @@ sub pagetemplate (@) {
                        my ($prevurl, $nexturl, $prevtitle, $nexttitle);
 
                        if (defined $prev) {
-                               add_depends($params{destpage}, $prev);
                                $prevurl = urlto($prev, $page);
                                $prevtitle = title_of($prev);
                        }
 
                        if (defined $next) {
-                               add_depends($params{destpage}, $next);
                                $nexturl = urlto($next, $page);
                                $nexttitle = title_of($next);
                        }