sidebar: Add global_sidebars setting.

[www/ikiwiki.git] / IkiWiki / Plugin / sidebar.pm

diff --git a/IkiWiki/Plugin/sidebar.pm b/IkiWiki/Plugin/sidebar.pm
index a6efc6b8e377a439694d965d8e16e83e2c06a66d..1b302dcf9f80dde6a6f1a6ba6e5620a34e7af593 100644 (file)
--- a/IkiWiki/Plugin/sidebar.pm
+++ b/IkiWiki/Plugin/sidebar.pm
@@ -6,32 +6,94 @@ package IkiWiki::Plugin::sidebar;
 
 use warnings;
 use strict;
-use IkiWiki;
+use IkiWiki 3.00;
 
-sub import { #{{{
-       IkiWiki::hook(type => "pagetemplate", id => "sidebar", 
-               call => \&pagetemplate);
-} # }}}
+sub import {
+       hook(type => "getsetup", id => "sidebar", call => \&getsetup);
+       hook(type => "preprocess", id => "sidebar", call => \&preprocess);
+       hook(type => "pagetemplate", id => "sidebar", call => \&pagetemplate);
+}
 
-sub sidebar_content ($) { #{{{
+sub getsetup () {
+       return
+               plugin => {
+                       safe => 1,
+                       rebuild => 1,
+               },
+               global_sidebars => {
+                       type => "boolean",
+                       examples => 1,
+                       description => "show sidebar page on all pages?"
+                       safe => 1,
+                       rebuild => 1,
+               },
+}
+
+my %pagesidebar;
+
+sub preprocess (@) {
+       my %params=@_;
+       my $content=shift;
+       shift;
+
+       if (! defined $content) {
+               error(gettext("sidebar content not specified"));
+       }
+
+       my $page=$params{page};
+       return "" unless $page eq $params{destpage};
+       my $file = $pagesources{$page};
+       my $type = pagetype($file);
+
+       $pagesidebar{$page}=
+               IkiWiki::htmlize($page, $page, $type,
+               IkiWiki::linkify($page, $page,
+               IkiWiki::preprocess($page, $page,
+               IkiWiki::filter($page, $page, $content))));
+
+       return "";
+}
+
+my $oldfile;
+my $oldcontent;
+
+sub sidebar_content ($) {
        my $page=shift;
        
-       my $sidebar_page=IkiWiki::bestlink($page, "sidebar") || return;
-       my $sidebar_file=$IkiWiki::pagesources{$sidebar_page} || return;
-       my $sidebar_type=IkiWiki::pagetype($sidebar_file);
+       return $pagesidebar{$page} if exists $pagesidebar{$page};
+
+       return if defined $config{global_sidebars} && !$config{global_sidebars};
+
+       my $sidebar_page=bestlink($page, "sidebar") || return;
+       my $sidebar_file=$pagesources{$sidebar_page} || return;
+       my $sidebar_type=pagetype($sidebar_file);
        
        if (defined $sidebar_type) {
-               IkiWiki::add_depends($page, $sidebar_page);
-               my $content=IkiWiki::readfile(IkiWiki::srcfile($sidebar_file));
+               # FIXME: This isn't quite right; it won't take into account
+               # adding a new sidebar page. So adding such a page
+               # currently requires a wiki rebuild.
+               add_depends($page, $sidebar_page);
+
+               my $content;
+               if (defined $oldfile && $sidebar_file eq $oldfile) {
+                       $content=$oldcontent;
+               }
+               else {
+                       $content=readfile(srcfile($sidebar_file));
+                       $oldcontent=$content;
+                       $oldfile=$sidebar_file;
+               }
+
                return unless length $content;
-               return IkiWiki::htmlize($sidebar_type,
+               return IkiWiki::htmlize($sidebar_page, $page, $sidebar_type,
+                      IkiWiki::linkify($sidebar_page, $page,
                       IkiWiki::preprocess($sidebar_page, $page,
-                      IkiWiki::linkify($sidebar_page, $page, $content)));
+                      IkiWiki::filter($sidebar_page, $page, $content))));
        }
 
-} # }}}
+}
 
-sub pagetemplate (@) { #{{{
+sub pagetemplate (@) {
        my %params=@_;
 
        my $page=$params{page};
@@ -43,6 +105,6 @@ sub pagetemplate (@) { #{{{
                        $template->param(sidebar => $content);
                }
        }
-} # }}}
+}
 
 1