use jquery underlay

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

diff --git a/IkiWiki/Plugin/po.pm b/IkiWiki/Plugin/po.pm
index dd89a96d1aa17c348148167ebfd6dc8a672c21a5..aca3d4bf86cf52afbe517ef43f83fdbc731a0eee 100644 (file)
--- a/IkiWiki/Plugin/po.pm
+++ b/IkiWiki/Plugin/po.pm
@@ -25,10 +25,13 @@ use File::Temp;
 use Memoize;
 use UNIVERSAL;
 
 use Memoize;
 use UNIVERSAL;
 

+my ($master_language_code, $master_language_name);

 my %translations;
 my @origneedsbuild;
 my %origsubs;
 my @slavelanguages; # language codes ordered as in config po_slave_languages
 my %translations;
 my @origneedsbuild;
 my %origsubs;
 my @slavelanguages; # language codes ordered as in config po_slave_languages

+my %slavelanguages; # language code to name lookup
+my $language_code_pattern = '[a-zA-Z]+(?:_[a-zA-Z]+)?';

 
 memoize("istranslatable");
 memoize("_istranslation");
 
 memoize("istranslatable");
 memoize("_istranslation");


@@ -36,10 +39,10 @@ memoize("percenttranslated");
 
 sub import {
        hook(type => "getsetup", id => "po", call => \&getsetup);
 
 sub import {
        hook(type => "getsetup", id => "po", call => \&getsetup);

-       hook(type => "checkconfig", id => "po", call => \&checkconfig);
+       hook(type => "checkconfig", id => "po", call => \&checkconfig,
+               last => 1);

        hook(type => "needsbuild", id => "po", call => \&needsbuild);
        hook(type => "scan", id => "po", call => \&scan, last => 1);
        hook(type => "needsbuild", id => "po", call => \&needsbuild);
        hook(type => "scan", id => "po", call => \&scan, last => 1);

-       hook(type => "rescan", id => "po", call => \&rescan);

        hook(type => "filter", id => "po", call => \&filter);
        hook(type => "htmlize", id => "po", call => \&htmlize);
        hook(type => "pagetemplate", id => "po", call => \&pagetemplate, last => 1);
        hook(type => "filter", id => "po", call => \&filter);
        hook(type => "htmlize", id => "po", call => \&htmlize);
        hook(type => "pagetemplate", id => "po", call => \&pagetemplate, last => 1);


@@ -64,8 +67,11 @@ sub import {
                inject(name => "IkiWiki::urlto", call => \&myurlto);
                $origsubs{'cgiurl'}=\&IkiWiki::cgiurl;
                inject(name => "IkiWiki::cgiurl", call => \&mycgiurl);
                inject(name => "IkiWiki::urlto", call => \&myurlto);
                $origsubs{'cgiurl'}=\&IkiWiki::cgiurl;
                inject(name => "IkiWiki::cgiurl", call => \&mycgiurl);

-               $origsubs{'rootpage'}=\&IkiWiki::rootpage;
-               inject(name => "IkiWiki::rootpage", call => \&myrootpage);
+               if (IkiWiki->can('rootpage')) {
+                       $origsubs{'rootpage'}=\&IkiWiki::rootpage;
+                       inject(name => "IkiWiki::rootpage", call => \&myrootpage)
+                               if defined $origsubs{'rootpage'};
+               }

                $origsubs{'isselflink'}=\&IkiWiki::isselflink;
                inject(name => "IkiWiki::isselflink", call => \&myisselflink);
        }
                $origsubs{'isselflink'}=\&IkiWiki::isselflink;
                inject(name => "IkiWiki::isselflink", call => \&myisselflink);
        }


@@ -90,16 +96,13 @@ sub import {
 sub getsetup () {
        return
                plugin => {
 sub getsetup () {
        return
                plugin => {

-                       safe => 0,
+                       safe => 1,

                        rebuild => 1, # format plugin
                        section => "format",
                },
                po_master_language => {
                        type => "string",
                        rebuild => 1, # format plugin
                        section => "format",
                },
                po_master_language => {
                        type => "string",

-                       example => {
-                               'code' => 'en',
-                               'name' => 'English'
-                       },
+                       example => "en|English",

                        description => "master language (non-PO files)",
                        safe => 1,
                        rebuild => 1,
                        description => "master language (non-PO files)",
                        safe => 1,
                        rebuild => 1,


@@ -111,7 +114,7 @@ sub getsetup () {
                                'es|Español',
                                'de|Deutsch'
                        ],
                                'es|Español',
                                'de|Deutsch'
                        ],

-                       description => "slave languages (PO files)",
+                       description => "slave languages (translated via PO files) format: ll|Langname",

                        safe => 1,
                        rebuild => 1,
                },
                        safe => 1,
                        rebuild => 1,
                },


@@ -133,39 +136,49 @@ sub getsetup () {
 }
 
 sub checkconfig () {
 }
 
 sub checkconfig () {

-       foreach my $field (qw{po_master_language}) {
-               if (! exists $config{$field} || ! defined $config{$field}) {
-                       error(sprintf(gettext("Must specify %s when using the %s plugin"),
-                                     $field, 'po'));
+       if (exists $config{po_master_language}) {
+               if (! ref $config{po_master_language}) {
+                       ($master_language_code, $master_language_name)=
+                               splitlangpair($config{po_master_language});
+               }
+               else {
+                       $master_language_code=$config{po_master_language}{code};
+                       $master_language_name=$config{po_master_language}{name};
+                       $config{po_master_language}=joinlangpair($master_language_code, $master_language_name);

                }
        }
                }
        }

+       if (! defined $master_language_code) {
+               $master_language_code='en';
+       }
+       if (! defined $master_language_name) {
+               $master_language_name='English';
+       }

 
        if (ref $config{po_slave_languages} eq 'ARRAY') {
 
        if (ref $config{po_slave_languages} eq 'ARRAY') {

-               my %slaves;

                foreach my $pair (@{$config{po_slave_languages}}) {
                foreach my $pair (@{$config{po_slave_languages}}) {

-                       my ($code, $name) = ( $pair =~ /^([a-z]{2})\|(.+)$/ );
-                       if (!defined $code || !defined $name) {
-                               error(sprintf(gettext("%s has invalid syntax: must use CODE|NAME"),
-                                             $pair));
+                       my ($code, $name)=splitlangpair($pair);
+                       if (defined $code && ! exists $slavelanguages{$code}) {
+                               push @slavelanguages, $code;
+                               $slavelanguages{$code} = $name;

                        }
                        }

-                       $slaves{$code} = $name;
-                       push @slavelanguages, $code;
-

                }
                }

-               $config{po_slave_languages} = \%slaves;

        }
        elsif (ref $config{po_slave_languages} eq 'HASH') {
        }
        elsif (ref $config{po_slave_languages} eq 'HASH') {

+               %slavelanguages=%{$config{po_slave_languages}};

                @slavelanguages = sort {
                        $config{po_slave_languages}->{$a} cmp $config{po_slave_languages}->{$b};
                @slavelanguages = sort {
                        $config{po_slave_languages}->{$a} cmp $config{po_slave_languages}->{$b};

-               } keys %{$config{po_slave_languages}};
+               } keys %slavelanguages;
+               $config{po_slave_languages}=[
+                       map { joinlangpair($_, $slavelanguages{$_}) } @slavelanguages
+               ]

        }
 
        }
 

-       delete $config{po_slave_languages}{$config{po_master_language}{code}};;
+       delete $slavelanguages{$master_language_code};

 
        map {
                islanguagecode($_)
                        or error(sprintf(gettext("%s is not a valid language code"), $_));
 
        map {
                islanguagecode($_)
                        or error(sprintf(gettext("%s is not a valid language code"), $_));

-       } ($config{po_master_language}{code}, @slavelanguages);
+       } ($master_language_code, @slavelanguages);

 
        if (! exists $config{po_translatable_pages} ||
            ! defined $config{po_translatable_pages}) {
 
        if (! exists $config{po_translatable_pages} ||
            ! defined $config{po_translatable_pages}) {


@@ -199,11 +212,11 @@ sub checkconfig () {
                                if -d "$config{underlaydirbase}/po/$ll/$underlay";
                }
        
                                if -d "$config{underlaydirbase}/po/$ll/$underlay";
                }
        

-               if ($config{po_master_language}{code} ne 'en') {
+               if ($master_language_code ne 'en') {

                        # Add underlay containing translated source files
                        # for the master language.
                        # Add underlay containing translated source files
                        # for the master language.

-                       add_underlay("locale/$config{po_master_language}{code}/$underlay")
-                               if -d "$config{underlaydirbase}/locale/$config{po_master_language}{code}/$underlay";
+                       add_underlay("locale/$master_language_code/$underlay")
+                               if -d "$config{underlaydirbase}/locale/$master_language_code/$underlay";

                }
        }
 }
                }
        }
 }


@@ -222,18 +235,25 @@ sub needsbuild () {
        foreach my $master (keys %translations) {
                map add_depends($_, $master), values %{otherlanguages_pages($master)};
        }
        foreach my $master (keys %translations) {
                map add_depends($_, $master), values %{otherlanguages_pages($master)};
        }

+
+       return $needsbuild;

 }
 
 }
 

-# Massage the recorded state of internal links so that:
-# - it matches the actually generated links, rather than the links as written
-#   in the pages' source
-# - backlinks are consistent in all cases

 sub scan (@) {
        my %params=@_;
        my $page=$params{page};
        my $content=$params{content};
 sub scan (@) {
        my %params=@_;
        my $page=$params{page};
        my $content=$params{content};

+       my $run_by_po=$params{run_by_po};

 
 

-       if (istranslation($page)) {
+       # Massage the recorded state of internal links so that:
+       # - it matches the actually generated links, rather than the links as
+       #   written in the pages' source
+       # - backlinks are consistent in all cases
+
+       # A second scan pass is made over translation pages, so as an
+       # optimization, we only do so on the second pass in this case,
+       # i.e. when this hook is called by itself.
+       if ($run_by_po && istranslation($page)) {

                # replace the occurence of $destpage in $links{$page}
                my @orig_links = @{$links{$page}};
                $links{$page} = [];
                # replace the occurence of $destpage in $links{$page}
                my @orig_links = @{$links{$page}};
                $links{$page} = [];


@@ -246,17 +266,34 @@ sub scan (@) {
                        }
                }
        }
                        }
                }
        }

-       elsif (! istranslatable($page) && ! istranslation($page)) {
+       # No second scan pass is done for a non-translation page, so
+       # links massaging must happen on first pass in this case.
+       elsif (! $run_by_po && ! istranslatable($page) && ! istranslation($page)) {

                foreach my $destpage (@{$links{$page}}) {
                        if (istranslatable($destpage)) {
                                # make sure any destpage's translations has
                                # $page in its backlinks
                                foreach my $link (values %{otherlanguages_pages($destpage)}) {
                                        add_link($page, $link);
                foreach my $destpage (@{$links{$page}}) {
                        if (istranslatable($destpage)) {
                                # make sure any destpage's translations has
                                # $page in its backlinks
                                foreach my $link (values %{otherlanguages_pages($destpage)}) {
                                        add_link($page, $link);

-                                }
+                               }

                        }
                }
        }
                        }
                }
        }

+
+       # Re-run the preprocess hooks in scan mode, then the scan hooks,
+       # over the po-to-markup converted content
+       return if $run_by_po; # avoid looping endlessly
+       return unless istranslation($page);
+       $content = po_to_markup($page, $content);
+       require IkiWiki;
+       IkiWiki::preprocess($page, $page, $content, 1);
+       IkiWiki::run_hooks(scan => sub {
+               shift->(
+                       page => $page,
+                       content => $content,
+                       run_by_po => 1,
+               );
+       });

 }
 
 # We use filter to convert PO to the master page's format,
 }
 
 # We use filter to convert PO to the master page's format,


@@ -274,26 +311,6 @@ sub filter (@) {
        return $content;
 }
 
        return $content;
 }
 

-# re-run the scan hooks and run the preprocess ones in scan
-# mode on the po-to-markup converted content
-sub rescan (@) {
-       my %params=@_;
-       my $page=$params{page};
-       my $content=$params{content};
-
-       return unless istranslation($page);
-
-       $content = po_to_markup($page, $content);
-       require IkiWiki;
-       IkiWiki::run_hooks(scan => sub {
-               shift->(
-                       page => $page,
-                       content => $content,
-               );
-       });
-       IkiWiki::preprocess($page, $page, $content, 1);
-}
-

 sub htmlize (@) {
        my %params=@_;
 
 sub htmlize (@) {
        my %params=@_;
 


@@ -355,7 +372,8 @@ sub pagetemplate (@) {
            && $masterpage eq "index") {
                $template->param('parentlinks' => []);
        }
            && $masterpage eq "index") {
                $template->param('parentlinks' => []);
        }

-       if (ishomepage($page) && $template->query(name => "title")) {
+       if (ishomepage($page) && $template->query(name => "title")
+           && !$template->param("title_overridden")) {

                $template->param(title => $config{wikiname});
        }
 }
                $template->param(title => $config{wikiname});
        }
 }


@@ -509,7 +527,7 @@ sub formbuilder_setup (@) {
        if ($form->field("do") eq "create") {
                # Warn the user: new pages must be written in master language.
                my $template=template("pocreatepage.tmpl");
        if ($form->field("do") eq "create") {
                # Warn the user: new pages must be written in master language.
                my $template=template("pocreatepage.tmpl");

-               $template->param(LANG => $config{po_master_language}{name});
+               $template->param(LANG => $master_language_name);

                $form->tmpl_param(message => $template->output);
        }
        elsif ($form->field("do") eq "edit") {
                $form->tmpl_param(message => $template->output);
        }
        elsif ($form->field("do") eq "edit") {


@@ -598,7 +616,7 @@ sub mybeautify_urlpath ($) {
 
        my $res=$origsubs{'beautify_urlpath'}->($url);
        if (defined $config{po_link_to} && $config{po_link_to} eq "negotiated") {
 
        my $res=$origsubs{'beautify_urlpath'}->($url);
        if (defined $config{po_link_to} && $config{po_link_to} eq "negotiated") {

-               $res =~ s!/\Qindex.$config{po_master_language}{code}.$config{htmlext}\E$!/!;
+               $res =~ s!/\Qindex.$master_language_code.$config{htmlext}\E$!/!;

                $res =~ s!/\Qindex.$config{htmlext}\E$!/!;
                map {
                        $res =~ s!/\Qindex.$_.$config{htmlext}\E$!/!;
                $res =~ s!/\Qindex.$config{htmlext}\E$!/!;
                map {
                        $res =~ s!/\Qindex.$_.$config{htmlext}\E$!/!;


@@ -607,23 +625,27 @@ sub mybeautify_urlpath ($) {
        return $res;
 }
 
        return $res;
 }
 

-sub mytargetpage ($$) {
+sub mytargetpage ($$;$) {

        my $page=shift;
        my $ext=shift;
        my $page=shift;
        my $ext=shift;

+       my $filename=shift;

 
        if (istranslation($page) || istranslatable($page)) {
                my ($masterpage, $lang) = (masterpage($page), lang($page));
 
        if (istranslation($page) || istranslatable($page)) {
                my ($masterpage, $lang) = (masterpage($page), lang($page));

-               if (! $config{usedirs} || $masterpage eq 'index') {
+               if (defined $filename) {
+                       return $masterpage . "/" . $filename . "." . $lang . "." . $ext;
+               }
+               elsif (! $config{usedirs} || $masterpage eq 'index') {

                        return $masterpage . "." . $lang . "." . $ext;
                }
                else {
                        return $masterpage . "/index." . $lang . "." . $ext;
                }
        }
                        return $masterpage . "." . $lang . "." . $ext;
                }
                else {
                        return $masterpage . "/index." . $lang . "." . $ext;
                }
        }

-       return $origsubs{'targetpage'}->($page, $ext);
+       return $origsubs{'targetpage'}->($page, $ext, $filename);

 }
 
 }
 

-sub myurlto ($$;$) {
+sub myurlto ($;$$) {

        my $to=shift;
        my $from=shift;
        my $absolute=shift;
        my $to=shift;
        my $from=shift;
        my $absolute=shift;


@@ -632,7 +654,12 @@ sub myurlto ($$;$) {
        if (! length $to
            && $config{po_link_to} eq "current"
            && istranslatable('index')) {
        if (! length $to
            && $config{po_link_to} eq "current"
            && istranslatable('index')) {

-               return IkiWiki::beautify_urlpath(IkiWiki::baseurl($from) . "index." . lang($from) . ".$config{htmlext}");
+               if (defined $from) {
+                       return IkiWiki::beautify_urlpath(IkiWiki::baseurl($from) . "index." . lang($from) . ".$config{htmlext}");
+               }
+               else {
+                       return $origsubs{'urlto'}->($to,$from,$absolute);
+               }

        }
        # avoid using our injected beautify_urlpath if run by cgi_editpage,
        # so that one is redirected to the just-edited page rather than to the
        }
        # avoid using our injected beautify_urlpath if run by cgi_editpage,
        # so that one is redirected to the just-edited page rather than to the


@@ -785,11 +812,11 @@ sub _istranslation ($) {
                         && pagetype($file) eq 'po';
        return 0 if $file =~ /\.pot$/;
 
                         && pagetype($file) eq 'po';
        return 0 if $file =~ /\.pot$/;
 

-       my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
+       my ($masterpage, $lang) = ($page =~ /(.*)[.]($language_code_pattern)$/);

        return 0 unless defined $masterpage && defined $lang
                         && length $masterpage && length $lang
                         && defined $pagesources{$masterpage}
        return 0 unless defined $masterpage && defined $lang
                         && length $masterpage && length $lang
                         && defined $pagesources{$masterpage}

-                        && defined $config{po_slave_languages}{$lang};
+                        && defined $slavelanguages{$lang};

 
        return (maybe_add_leading_slash($masterpage, $hasleadingslash), $lang)
                if istranslatable($masterpage);
 
        return (maybe_add_leading_slash($masterpage, $hasleadingslash), $lang)
                if istranslatable($masterpage);


@@ -821,20 +848,20 @@ sub lang ($) {
        if (1 < (my ($masterpage, $lang) = _istranslation($page))) {
                return $lang;
        }
        if (1 < (my ($masterpage, $lang) = _istranslation($page))) {
                return $lang;
        }

-       return $config{po_master_language}{code};
+       return $master_language_code;

 }
 
 sub islanguagecode ($) {
        my $code=shift;
 
 }
 
 sub islanguagecode ($) {
        my $code=shift;
 

-       return $code =~ /^[a-z]{2}$/;
+       return $code =~ /^$language_code_pattern$/;

 }
 
 sub otherlanguage_page ($$) {
        my $page=shift;
        my $code=shift;
 
 }
 
 sub otherlanguage_page ($$) {
        my $page=shift;
        my $code=shift;
 

-       return masterpage($page) if $code eq $config{po_master_language}{code};
+       return masterpage($page) if $code eq $master_language_code;

        return masterpage($page) . '.' . $code;
 }
 
        return masterpage($page) . '.' . $code;
 }
 


@@ -848,9 +875,9 @@ sub otherlanguages_codes ($) {
        return \@ret unless istranslation($page) || istranslatable($page);
        my $curlang=lang($page);
        foreach my $lang
        return \@ret unless istranslation($page) || istranslatable($page);
        my $curlang=lang($page);
        foreach my $lang

-               ($config{po_master_language}{code}, @slavelanguages) {
+               ($master_language_code, @slavelanguages) {

                next if $lang eq $curlang;
                next if $lang eq $curlang;

-               if ($lang eq $config{po_master_language}{code} ||
+               if ($lang eq $master_language_code ||

                    istranslatedto(masterpage($page), $lang)) {
                        push @ret, $lang;
                }
                    istranslatedto(masterpage($page), $lang)) {
                        push @ret, $lang;
                }


@@ -1005,10 +1032,10 @@ sub percenttranslated ($) {
 sub languagename ($) {
        my $code=shift;
 
 sub languagename ($) {
        my $code=shift;
 

-       return $config{po_master_language}{name}
-               if $code eq $config{po_master_language}{code};
-       return $config{po_slave_languages}{$code}
-               if defined $config{po_slave_languages}{$code};
+       return $master_language_name
+               if $code eq $master_language_code;
+       return $slavelanguages{$code}
+               if defined $slavelanguages{$code};

        return;
 }
 
        return;
 }
 


@@ -1019,13 +1046,13 @@ sub otherlanguagesloop ($) {
        if (istranslation($page)) {
                push @ret, {
                        url => urlto_with_orig_beautiful_urlpath(masterpage($page), $page),
        if (istranslation($page)) {
                push @ret, {
                        url => urlto_with_orig_beautiful_urlpath(masterpage($page), $page),

-                       code => $config{po_master_language}{code},
-                       language => $config{po_master_language}{name},
+                       code => $master_language_code,
+                       language => $master_language_name,

                        master => 1,
                };
        }
        foreach my $lang (@{otherlanguages_codes($page)}) {
                        master => 1,
                };
        }
        foreach my $lang (@{otherlanguages_codes($page)}) {

-               next if $lang eq $config{po_master_language}{code};
+               next if $lang eq $master_language_code;

                my $otherpage = otherlanguage_page($page, $lang);
                push @ret, {
                        url => urlto_with_orig_beautiful_urlpath($otherpage, $page),
                my $otherpage = otherlanguage_page($page, $lang);
                push @ret, {
                        url => urlto_with_orig_beautiful_urlpath($otherpage, $page),


@@ -1219,6 +1246,7 @@ sub po4a_options($) {
                # how to disable options is not consistent across po4a modules
                $options{includessi} = '';
                $options{includeexternal} = 0;
                # how to disable options is not consistent across po4a modules
                $options{includessi} = '';
                $options{includeexternal} = 0;

+               $options{ontagerror} = 'warn';

        }
        elsif ($pagetype eq 'mdwn') {
                $options{markdown} = 1;
        }
        elsif ($pagetype eq 'mdwn') {
                $options{markdown} = 1;


@@ -1230,6 +1258,27 @@ sub po4a_options($) {
        return %options;
 }
 
        return %options;
 }
 

+sub splitlangpair ($) {
+       my $pair=shift;
+
+       my ($code, $name) = ( $pair =~ /^($language_code_pattern)\|(.+)$/ );
+       if (! defined $code || ! defined $name ||
+           ! length $code || ! length $name) {
+               # not a fatal error to avoid breaking if used with web setup
+               warn sprintf(gettext("%s has invalid syntax: must use CODE|NAME"),
+                       $pair);
+       }
+
+       return $code, $name;
+}
+
+sub joinlangpair ($$) {
+       my $code=shift;
+       my $name=shift;
+
+       return "$code|$name";
+}
+

 # ,----
 # | PageSpecs
 # `----
 # ,----
 # | PageSpecs
 # `----


@@ -1264,7 +1313,7 @@ sub match_lang ($$;@) {
 
        my $regexp=IkiWiki::glob2re($wanted);
        my $lang=IkiWiki::Plugin::po::lang($page);
 
        my $regexp=IkiWiki::glob2re($wanted);
        my $lang=IkiWiki::Plugin::po::lang($page);

-       if ($lang !~ /^$regexp$/i) {
+       if ($lang !~ $regexp) {

                return IkiWiki::FailReason->new("file language is $lang, not $wanted");
        }
        else {
                return IkiWiki::FailReason->new("file language is $lang, not $wanted");
        }
        else {