po plugin: implemented po_link_to=negotiated

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

diff --git a/IkiWiki/Plugin/po.pm b/IkiWiki/Plugin/po.pm
index dbeb0b481ac2cd0d4114d397bfedc39a002becfa..7b9945b0a52ae197f8c96da180da0e4240be3a19 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);
 }
 
@@ -24,33 +27,81 @@ sub getsetup () { #{{{
                        safe => 0,
                        rebuild => 1, # format plugin
                },
-               po_supported_languages => {
+               po_master_language => {
                        type => "string",
-                       example => { 'fr' => { 'name' => 'Français' },
+                       example => {
+                               'code' => 'en',
+                               'name' => 'English'
+                       },
+                       description => "master language (non-PO files)",
+                       safe => 1,
+                       rebuild => 1,
+               },
+               po_slave_languages => {
+                       type => "string",
+                       example => {'fr' => { 'name' => 'Français' },
                                    'es' => { 'name' => 'Castellano' },
                                    'de' => { 'name' => 'Deutsch' },
                        },
+                       description => "slave languages (PO files)",
+                       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 (@) { #{{{
        my %params = @_;
         my $page=$params{page};
         my $ext=$params{ext};
 
-       if (! IkiWiki::PageSpec::match_istranslation($page, $page)) {
-               return;
-       }
-
-       my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
-       if (! $config{usedirs} || $page eq 'index') {
-               return $masterpage.".".$ext.".".$lang;
+       if (pagespec_match($page,"istranslation()")) {
+               my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
+               if (! $config{usedirs} || $page eq 'index') {
+                       return $masterpage . "." . $lang . "." . $ext;
+               }
+               else {
+                       return $masterpage . "/index." . $lang . "." . $ext;
+               }
        }
        else {
-               return $masterpage."/index.".$ext.".".$lang;
+               if (! $config{usedirs} || $page eq 'index') {
+                       return $page . "." . $config{po_master_language}{code} . "." . $ext;
+               }
+               else {
+                       return $page . "/index." . $config{po_master_language}{code} . "." . $ext;
+               }
+       }
+} #}}}
+
+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,
@@ -62,7 +113,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;
        }
 
@@ -90,6 +141,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};
@@ -127,7 +189,7 @@ sub match_istranslation ($;@) { #{{{
                return IkiWiki::FailReason->new("the master page does not exist");
        }
 
-       if (! defined $IkiWiki::config{po_supported_languages}{$lang}) {
+       if (! defined $IkiWiki::config{po_slave_languages}{$lang}) {
                return IkiWiki::FailReason->new("language $lang is not supported");
        }