summaryrefslogtreecommitdiff
path: root/.library/IkiWiki/Plugin/license.pm
blob: 47fb34d81e319881066e8a19001453dcb4cfc958 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
# A plugin for ikiwiki to implement adding a footer with licensing information
# based on a default value taken out of a file.

# Copyright © 2007 Thomas Schwinge <tschwinge@gnu.org>
#
# This program is free software; you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by the
# Free Software Foundation; either version 2, or (at your option) any later
# version.
# 
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
# or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
# for more details.
# 
# You should have received a copy of the GNU General Public License along
# with this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

# A footer with licensing information will be added to every rendered page if
# (a) such a footer isn't present already (see the `meta' plugin's ``license''
# facility) and (b) a file `license.html' is found (using the same rules as for
# the sidebar plugin).
#
# The state which page's license text was gathered from which source is not
# tracked, so you'll need a full wiki-rebuild if (b)'s files are changed.
#
# You can use wiki links in `license.html'.

package IkiWiki::Plugin::license;

use warnings;
use strict;
use IkiWiki 2.00;

sub import
{
    hook (type => "pagetemplate", id => "license", call => \&pagetemplate,
	  # Run last, as to have the `meta' plugin do its work first.
	  last => 1);
}

sub pagetemplate (@)
{
    my %params = @_;
    my $page = $params {page};
    my $destpage = $params {destpage};

    my $template = $params {template};

    if ($template->query (name => "license") &&
	! defined $template->param('license'))
    {
	my $content;
	my $license_page = bestlink ($page, "license") || return;
	my $license_file = $pagesources {$license_page} || return;
	#my $pagetype = pagetype ($license_file);
	# Check if ``$pagetype eq 'html'''?
	$content = readfile (srcfile ($license_file));

	if (defined $content && length $content)
	{
	    $template->param (license =>
	      IkiWiki::linkify ($page, $destpage, $content));
	}
    }
}

1