po plugin: factorize most checks into a new match_istranslation PageSpec
[ikiwiki.git] / IkiWiki / Plugin / po.pm
1 #!/usr/bin/perl
2 # .po as a wiki page type
3 package IkiWiki::Plugin::po;
4
5 use warnings;
6 use strict;
7 use IkiWiki 2.00;
8 use Encode;
9
10 sub import {
11         hook(type => "getsetup", id => "po", call => \&getsetup);
12         hook(type => "targetpage", id => "po", call => \&targetpage);
13         hook(type => "filter", id => "po", call => \&filter);
14         hook(type => "htmlize", id => "po", call => \&htmlize);
15 }
16
17 sub getsetup () { #{{{
18         return
19                 plugin => {
20                         safe => 0,
21                         rebuild => 1, # format plugin
22                 },
23                 po_supported_languages => {
24                         type => "string",
25                         example => { 'fr' => { 'name' => 'Fran├žais' },
26                                     'es' => { 'name' => 'Castellano' },
27                                     'de' => { 'name' => 'Deutsch' },
28                         },
29                         safe => 1,
30                         rebuild => 1,
31                 },
32 } #}}}
33
34 sub targetpage (@) { #{{{
35         my %params = @_;
36         my $page=$params{page};
37         my $ext=$params{ext};
38
39         if (! IkiWiki::PageSpec::match_istranslation($page, $page)) {
40                 return;
41         }
42
43         my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
44         if (! $config{usedirs} || $page eq 'index') {
45                 return $masterpage.".".$ext.".".$lang;
46         }
47         else {
48                 return $masterpage."/index.".$ext.".".$lang;
49         }
50 } #}}}
51
52 # We use filter to convert PO to HTML, since the other plugins might do harm to it.
53 sub filter (@) { #{{{
54         my %params = @_;
55         my $content = decode_utf8(encode_utf8($params{content}));
56
57         if (defined $pagesources{$params{page}} && $pagesources{$params{page}} =~ /\.po$/) {
58                 $content = "<pre>" . $content . "</pre>";
59         }
60
61         return $content;
62 } #}}}
63
64 # We need this to register the .po file extension
65 sub htmlize (@) { #{{{
66         my %params=@_;
67         return $params{content};
68 } #}}}
69
70 package IkiWiki::PageSpec;
71
72 sub match_istranslation ($;@) { #{{{
73         my $page=shift;
74         my $wanted=shift;
75
76         my %params=@_;
77         my $file=exists $params{file} ? $params{file} : $IkiWiki::pagesources{$page};
78         if (! defined $file) {
79                 return IkiWiki::FailReason->new("no file specified");
80         }
81
82         if (! IkiWiki::pagetype($page) eq 'po') {
83                 return IkiWiki::FailReason->new("is not a PO file");
84         }
85
86         my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
87         if (! defined $masterpage || ! defined $lang
88             || ! (length($masterpage) > 0) || ! (length($lang) > 0)) {
89                 return IkiWiki::FailReason->new("is not named like a translation file");
90         }
91
92         if (! defined $IkiWiki::pagesources{$masterpage}) {
93                 return IkiWiki::FailReason->new("the master page does not exist");
94         }
95
96         if (! defined $IkiWiki::config{po_supported_languages}{$lang}) {
97                 return IkiWiki::FailReason->new("language $lang is not supported");
98         }
99
100         return IkiWiki::SuccessReason->new("page $page is a translation");
101
102 } #}}}
103
104 1