]> sipb.mit.edu Git - ikiwiki.git/blob - IkiWiki/Plugin/sidebar.pm
d63cb524671210186a4380f7d829716640f7fc52
[ikiwiki.git] / IkiWiki / Plugin / sidebar.pm
1 #!/usr/bin/perl
2 # Sidebar plugin.
3 # by Tuomo Valkonen <tuomov at iki dot fi>
4
5 package IkiWiki::Plugin::sidebar;
6
7 use warnings;
8 use strict;
9 use IkiWiki 3.00;
10
11 sub import {
12         hook(type => "getsetup", id => "sidebar", call => \&getsetup);
13         hook(type => "preprocess", id => "sidebar", call => \&preprocess);
14         hook(type => "pagetemplate", id => "sidebar", call => \&pagetemplate);
15 }
16
17 sub getsetup () {
18         return
19                 plugin => {
20                         safe => 1,
21                         rebuild => 1,
22                 },
23 }
24
25 my %pagesidebar;
26
27 sub preprocess (@) {
28         my %params=@_;
29         my $content=shift;
30         shift;
31
32         if (! defined $content) {
33                 error(gettext("sidebar content not specified"));
34         }
35
36         my $page=$params{page};
37         return "" unless $page eq $params{destpage};
38         my $file = $pagesources{$page};
39         my $type = pagetype($file);
40
41         $pagesidebar{$page}=
42                 IkiWiki::htmlize($page, $page, $type,
43                 IkiWiki::linkify($page, $page,
44                 IkiWiki::preprocess($page, $page,
45                 IkiWiki::filter($page, $page, $content))));
46
47         return "";
48 }
49
50 my $oldfile;
51 my $oldcontent;
52
53 sub sidebar_content ($) {
54         my $page=shift;
55         
56         return $pagesidebar{$page} if exists $pagesidebar{$page};
57
58         my $sidebar_page=bestlink($page, "sidebar") || return;
59         my $sidebar_file=$pagesources{$sidebar_page} || return;
60         my $sidebar_type=pagetype($sidebar_file);
61         
62         if (defined $sidebar_type) {
63                 # FIXME: This isn't quite right; it won't take into account
64                 # adding a new sidebar page. So adding such a page
65                 # currently requires a wiki rebuild.
66                 add_depends($page, $sidebar_page);
67
68                 my $content;
69                 if (defined $oldfile && $sidebar_file eq $oldfile) {
70                         $content=$oldcontent;
71                 }
72                 else {
73                         $content=readfile(srcfile($sidebar_file));
74                         $oldcontent=$content;
75                         $oldfile=$sidebar_file;
76                 }
77
78                 return unless length $content;
79                 return IkiWiki::htmlize($sidebar_page, $page, $sidebar_type,
80                        IkiWiki::linkify($sidebar_page, $page,
81                        IkiWiki::preprocess($sidebar_page, $page,
82                        IkiWiki::filter($sidebar_page, $page, $content))));
83         }
84
85 }
86
87 sub pagetemplate (@) {
88         my %params=@_;
89
90         my $page=$params{page};
91         my $template=$params{template};
92         
93         if ($template->query(name => "sidebar")) {
94                 my $content=sidebar_content($page);
95                 if (defined $content && length $content) {
96                         $template->param(sidebar => $content);
97                 }
98         }
99 }
100
101 1