]> sipb.mit.edu Git - ikiwiki.git/blob - IkiWiki/Plugin/edittemplate.pm
98308de135ba42c6efc5d574b261d51cc5f18e29
[ikiwiki.git] / IkiWiki / Plugin / edittemplate.pm
1 #!/usr/bin/perl
2 package IkiWiki::Plugin::edittemplate;
3
4 use warnings;
5 use strict;
6 use IkiWiki 2.00;
7 use HTML::Template;
8 use Encode;
9
10 sub import { #{{{
11         hook(type => "getsetup", id => "edittemplate",
12                 call => \&getsetup);
13         hook(type => "needsbuild", id => "edittemplate",
14                 call => \&needsbuild);
15         hook(type => "preprocess", id => "edittemplate",
16                 call => \&preprocess);
17         hook(type => "formbuilder", id => "edittemplate",
18                 call => \&formbuilder);
19 } #}}}
20
21 sub getsetup () { #{{{
22         return
23                 plugin => {
24                         safe => 1,
25                         rebuild => undef,
26                 },
27 } #}}}
28
29 sub needsbuild (@) { #{{{
30         my $needsbuild=shift;
31
32         foreach my $page (keys %pagestate) {
33                 if (exists $pagestate{$page}{edittemplate}) {
34                         if (exists $pagesources{$page} && 
35                             grep { $_ eq $pagesources{$page} } @$needsbuild) {
36                                 # remove state, it will be re-added
37                                 # if the preprocessor directive is still
38                                 # there during the rebuild
39                                 delete $pagestate{$page}{edittemplate};
40                         }
41                 }
42         }
43 } #}}}
44
45 sub preprocess (@) { #{{{
46         my %params=@_;
47
48         return "" if $params{page} ne $params{destpage};
49
50         if (! exists $params{template} || ! length($params{template})) {
51                 error gettext("template not specified")
52         }
53         if (! exists $params{match} || ! length($params{match})) {
54                 error gettext("match not specified")
55         }
56
57         $pagestate{$params{page}}{edittemplate}{$params{match}}=$params{template};
58
59         return sprintf(gettext("edittemplate %s registered for %s"),
60                 $params{template}, $params{match});
61 } # }}}
62
63 sub formbuilder (@) { #{{{
64         my %params=@_;
65         my $form=$params{form};
66
67         return if $form->field("do") ne "create" ||
68                 length $form->field("editcontent");
69         
70         my $page=$form->field("page");
71         
72         # The tricky bit here is that $page is probably just the base
73         # page name, without any subdir, but the pagespec for a template
74         # probably does include the subdir (ie, "bugs/*"). We don't know
75         # what subdir the user will pick to put the page in. So, try them
76         # all, starting with the one that was made default.
77         my @page_locs=$page;
78         foreach my $field ($form->field) {
79                 if ($field eq 'page') {
80                         @page_locs=$field->def_value;
81                         push @page_locs, $field->options;
82                 }
83         }
84
85         foreach my $p (@page_locs) {
86                 foreach my $registering_page (keys %pagestate) {
87                         if (exists $pagestate{$registering_page}{edittemplate}) {
88                                 foreach my $pagespec (sort keys %{$pagestate{$registering_page}{edittemplate}}) {
89                                         if (pagespec_match($p, $pagespec, location => $registering_page)) {
90                                                 $form->field(name => "editcontent",
91                                                          value => filltemplate($pagestate{$registering_page}{edittemplate}{$pagespec}, $page));
92                                                 return;
93                                         }
94                                 }
95                         }
96                 }
97         }
98 } #}}}
99
100 sub filltemplate ($$) { #{{{
101         my $template_page=shift;
102         my $page=shift;
103
104         my $template_file=$pagesources{$template_page};
105         if (! defined $template_file) {
106                 return;
107         }
108
109         my $template;
110         eval {
111                 $template=HTML::Template->new(
112                         filter => sub {
113                                 my $text_ref = shift;
114                                 $$text_ref=&Encode::decode_utf8($$text_ref);
115                                 chomp $$text_ref;
116                         },
117                         filename => srcfile($template_file),
118                         die_on_bad_params => 0,
119                         no_includes => 1,
120                 );
121         };
122         if ($@) {
123                 # Indicate that the earlier preprocessor directive set 
124                 # up a template that doesn't work.
125                 return "[[!pagetemplate ".gettext("failed to process")." $@]]";
126         }
127
128         $template->param(name => $page);
129
130         return $template->output;
131 } #}}}
132
133 1