po plugin: added istranslatable() pagespec function, and use it

[git.ikiwiki.info.git] / IkiWiki / Plugin / po.pm

diff --git a/IkiWiki/Plugin/po.pm b/IkiWiki/Plugin/po.pm
index 941f5629d0d0a14102c4cb9ee000a814815177f4..e331338576b6c46300b1d135b456a65f79902aff 100644 (file)
--- a/IkiWiki/Plugin/po.pm
+++ b/IkiWiki/Plugin/po.pm
@@ -13,8 +13,11 @@ use File::Temp;
 
 sub import {
        hook(type => "getsetup", id => "po", call => \&getsetup);
+       hook(type => "checkconfig", id => "po", call => \&checkconfig);
        hook(type => "targetpage", id => "po", call => \&targetpage);
+       hook(type => "tweakurlpath", id => "po", call => \&tweakurlpath);
        hook(type => "filter", id => "po", call => \&filter);
+       hook(type => "preprocess", id => "translatable", call => \&preprocess_translatable);
        hook(type => "htmlize", id => "po", call => \&htmlize);
 }
 
@@ -44,6 +47,28 @@ sub getsetup () { #{{{
                        safe => 1,
                        rebuild => 1,
                },
+               po_link_to => {
+                       type => "string",
+                       example => "current",
+                       description => "internal linking behavior (default/current/negotiated)",
+                       safe => 1,
+                       rebuild => 1,
+               },
+} #}}}
+
+sub checkconfig () { #{{{
+       foreach my $field (qw{po_master_language po_slave_languages}) {
+               if (! exists $config{$field} || ! defined $config{$field}) {
+                       error(sprintf(gettext("Must specify %s"), $field));
+               }
+       }
+       if (! exists $config{po_link_to} ||
+           ! defined $config{po_link_to}) {
+           $config{po_link_to}="default";
+       }
+       if ($config{po_link_to} eq "negotiated" && ! $config{usedirs}) {
+               error(gettext("po_link_to=negotiated requires usedirs to be set"));
+       }
 } #}}}
 
 sub targetpage (@) { #{{{
@@ -51,23 +76,33 @@ sub targetpage (@) { #{{{
         my $page=$params{page};
         my $ext=$params{ext};
 
-       if (IkiWiki::PageSpec::match_istranslation($page, $page)) {
+       if (pagespec_match($page,"istranslation()")) {
                my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
                if (! $config{usedirs} || $page eq 'index') {
-                       return $masterpage . "." . $ext . "." . $lang;
+                       return $masterpage . "." . $lang . "." . $ext;
                }
                else {
-                       return $masterpage . "/index." . $ext . "." . $lang;
+                       return $masterpage . "/index." . $lang . "." . $ext;
                }
        }
-       else {
+       elsif (pagespec_match($page,"istranslatable()")) {
                if (! $config{usedirs} || $page eq 'index') {
-                       return $page . "." . $ext . "." . $config{po_master_language}{code};
+                       return $page . "." . $config{po_master_language}{code} . "." . $ext;
                }
                else {
-                       return $page . "/index." . $ext . "." . $config{po_master_language}{code};
+                       return $page . "/index." . $config{po_master_language}{code} . "." . $ext;
                }
        }
+       return;
+} #}}}
+
+sub tweakurlpath ($) { #{{{
+       my %params = @_;
+       my $url=$params{url};
+       if ($config{po_link_to} eq "negotiated") {
+               $url =~ s!/index.$config{po_master_language}{code}.$config{htmlext}$!/!;
+       }
+       return $url;
 } #}}}
 
 # We use filter to convert PO to the master page's type,
@@ -79,7 +114,7 @@ sub filter (@) { #{{{
 
        # decide if this is a PO file that should be converted into a translated document,
        # and perform various sanity checks
-       if (! IkiWiki::PageSpec::match_istranslation($page, $page)) {
+       if (! pagespec_match($page, "istranslation()")) {
                return $content;
        }
 
@@ -107,6 +142,17 @@ sub filter (@) { #{{{
        return $content;
 } #}}}
 
+sub preprocess_translatable (@) { #{{{
+       my %params = @_;
+       my $match = exists $params{match} ? $params{match} : $params{page};
+
+       $pagestate{$params{page}}{po_translatable}{$match}=1;
+
+       return "" if ($params{silent} && IkiWiki::yesno($params{silent}));
+       return sprintf(gettext("pages %s set as translatable"), $params{match});
+
+} #}}}
+
 sub htmlize (@) { #{{{
        my %params=@_;
        my $page = $params{page};
@@ -119,18 +165,21 @@ sub htmlize (@) { #{{{
 } #}}}
 
 package IkiWiki::PageSpec;
+use warnings;
+use strict;
+use IkiWiki 2.00;
 
 sub match_istranslation ($;@) { #{{{
        my $page=shift;
        my $wanted=shift;
 
        my %params=@_;
-       my $file=exists $params{file} ? $params{file} : $IkiWiki::pagesources{$page};
+       my $file=exists $params{file} ? $params{file} : $pagesources{$page};
        if (! defined $file) {
                return IkiWiki::FailReason->new("no file specified");
        }
 
-       if (! IkiWiki::pagetype($page) eq 'po') {
+       if (! defined pagetype($file) || ! pagetype($file) eq 'po') {
                return IkiWiki::FailReason->new("is not a PO file");
        }
 
@@ -140,16 +189,45 @@ sub match_istranslation ($;@) { #{{{
                return IkiWiki::FailReason->new("is not named like a translation file");
        }
 
-       if (! defined $IkiWiki::pagesources{$masterpage}) {
+       if (! defined $pagesources{$masterpage}) {
                return IkiWiki::FailReason->new("the master page does not exist");
        }
 
-       if (! defined $IkiWiki::config{po_slave_languages}{$lang}) {
+       if (! defined $config{po_slave_languages}{$lang}) {
                return IkiWiki::FailReason->new("language $lang is not supported");
        }
 
        return IkiWiki::SuccessReason->new("page $page is a translation");
+} #}}}
+
+sub match_istranslatable ($;@) { #{{{
+       my $page=shift;
+       my $wanted=shift;
+
+       my %params=@_;
+       my $file=exists $params{file} ? $params{file} : $pagesources{$page};
+       if (! defined $file) {
+               return IkiWiki::FailReason->new("no file specified");
+       }
+
+       if (defined pagetype($file) && pagetype($file) eq 'po') {
+               return IkiWiki::FailReason->new("is a PO file");
+       }
+       if ($file =~ /\.pot$/) {
+               return IkiWiki::FailReason->new("is a POT file");
+       }
+
+       foreach my $registering_page (keys %pagestate) {
+               if (exists $pagestate{$registering_page}{po_translatable}) {
+                       foreach my $pagespec (sort keys %{$pagestate{$registering_page}{po_translatable}}) {
+                               if (pagespec_match($page, $pagespec, location => $registering_page)) {
+                                       return IkiWiki::SuccessReason->new("is set as translatable on $registering_page");
+                               }
+                       }
+               }
+       }
 
+       return IkiWiki::FailReason->new("is not set as translatable");
 } #}}}
 
 1