X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/f0e2ce4360a029f53ede032416acb311060aa79b..6659d78aa2e3c66c9beadf180aa18438db0f40e5:/doc/plugins/po.mdwn?ds=sidebyside
diff --git a/doc/plugins/po.mdwn b/doc/plugins/po.mdwn
index a4543ecaa..f3b70b5f7 100644
--- a/doc/plugins/po.mdwn
+++ b/doc/plugins/po.mdwn
@@ -5,6 +5,8 @@ This plugin adds support for multi-lingual wikis, translated with
gettext, using [po4a](http://po4a.alioth.debian.org/).
It depends on the Perl `Locale::Po4a::Po` library (`apt-get install po4a`).
+As detailed bellow in the security section, `po4a` is subject to
+denial-of-service attacks before version 0.35.
[[!toc levels=2]]
@@ -31,6 +33,12 @@ Example: `bla/page.fr.po` is the PO "message catalog" used to
translate `bla/page.mdwn` into French; if `usedirs` is enabled, it is
rendered as `bla/page/index.fr.html`, else as `bla/page.fr.html`
+(In)Compatibility
+=================
+
+This plugin does not support the `indexpages` mode. If you don't know
+what it is, you probably don't care.
+
Configuration
=============
@@ -47,7 +55,7 @@ Supported languages
languages, such as:
po_slave_languages => { 'fr' => 'Français',
- 'es' => 'Castellano',
+ 'es' => 'Español',
'de' => 'Deutsch',
}
@@ -64,39 +72,40 @@ worry about excluding them explicitly from this [[ikiwiki/PageSpec]].
Internal links
--------------
+### Links targets
+
The `po_link_to` option in `ikiwiki.setup` is used to decide how
internal links should be generated, depending on web server features
and site-specific preferences.
-### Default linking behavior
+#### Default linking behavior
If `po_link_to` is unset, or set to `default`, ikiwiki's default
linking behavior is preserved: `\[[destpage]]` links to the master
language's page.
-### Link to current language
+#### Link to current language
If `po_link_to` is set to `current`, `\[[destpage]]` links to the
`destpage`'s version written in the current page's language, if
available, *i.e.*:
-- `foo/destpage/index.LL.html` if `usedirs` is enabled
-- `foo/destpage.LL.html` if `usedirs` is disabled
+* `foo/destpage/index.LL.html` if `usedirs` is enabled
+* `foo/destpage.LL.html` if `usedirs` is disabled
-### Link to negotiated language
+#### Link to negotiated language
If `po_link_to` is set to `negotiated`, `\[[page]]` links to the
negotiated preferred language, *i.e.* `foo/page/`.
(In)compatibility notes:
-- if `usedirs` is disabled, it does not make sense to set `po_link_to`
+* if `usedirs` is disabled, it does not make sense to set `po_link_to`
to `negotiated`; this option combination is neither implemented
nor allowed.
-- if the web server does not support Content Negotiation, setting
+* if the web server does not support Content Negotiation, setting
`po_link_to` to `negotiated` will produce a unusable website.
-
Server support
==============
@@ -105,7 +114,8 @@ Apache
Using Apache `mod_negotiation` makes it really easy to have Apache
serve any page in the client's preferred language, if available.
-This is the default Debian Apache configuration.
+
+Add 'Options MultiViews' to the wiki directory's configuration in Apache.
When `usedirs` is enabled, one has to set `DirectoryIndex index` for
the wiki context.
@@ -114,6 +124,8 @@ Setting `DefaultLanguage LL` (replace `LL` with your default MIME
language code) for the wiki context can help to ensure
`bla/page/index.en.html` is served as `Content-Language: LL`.
+For details, see [Apache's documentation](http://httpd.apache.org/docs/2.2/content-negotiation.html).
+
lighttpd
--------
@@ -141,43 +153,21 @@ display things only on translatable or translation pages.
The `OTHERLANGUAGES` loop provides ways to display other languages'
versions of the same page, and the translations' status.
-One typically adds the following code to `templates/page.tmpl`:
-
-
-
-
---- /usr/share/perl5/Locale/Po4a/Common.pm 2008-07-21 14:54:52.000000000 -0400 -+++ Common.pm 2008-11-11 18:27:34.000000000 -0500 -@@ -30,8 +30,16 @@ - use strict; - use warnings; - --BEGIN { -- if (eval { require Text::WrapI18N }) { -+sub import { -+ my $class=shift; -+ my $wrapi18n=1; -+ if ($_[0] eq 'nowrapi18n') { -+ shift; -+ $wrapi18n=0; -+ } -+ $class->export_to_level(1, $class, @_); -+ -+ if ($wrapi18n && eval { require Text::WrapI18N }) { - - # Don't bother determining the wrap column if we cannot wrap. - my $col=$ENV{COLUMNS}; -- -##### Term::ReadKey - -`Term::ReadKey` is not a hard dependency in our case, *i.e.* po4a -works nicely without it. But the po4a Debian package recommends -`libterm-readkey-perl`, so it will probably be installed on most -systems using the po plugin. - -If `$ENV{COLUMNS}` is not set, `Locale::Po4a::Common` uses -`Term::ReadKey::GetTerminalSize()` to get the terminal size. How safe -is this? - -Part of `Term::ReadKey` is written in C. Depending on the runtime -platform, this function use ioctl, environment, or C library function -calls, and may end up running the `resize` command (without -arguments). - -IMHO, using Term::ReadKey has too far reaching implications for us to -be able to guarantee anything wrt. security. Since it is anyway of no -use in our case, I suggest we define `ENV{COLUMNS}` before loading -`Locale::Po4a::Common`, just to be on the safe side. Joey? -[[--intrigeri]] - -> Update: adding an option to disable `Text::WrapI18N`, as Nicolas -> François suggested, would as a bonus disable `Term::ReadKey` -> as well. [[--intrigeri]] - -### msgmerge - -`refreshpofiles()` runs this external program. A po4a developer -answered he does "not expect any security issues from it". - -### msgfmt - -`isvalidpo()` runs this external program. Its security should be checked. - -### Fuzzing input - -I was not able to find any public information about gettext or po4a -having been tested with a fuzzing program, such as `zzuf` or `fusil`. -Moreover, some gettext parsers seem to be quite -[easy to crash](http://fusil.hachoir.org/trac/browser/trunk/fuzzers/fusil-gettext), -so it might be useful to bang msgmerge/po4a's heads against such -a program in order to easily detect some of the most obvious DoS. -[[--intrigeri]] - -> po4a was not fuzzy-tested, but according to one of its developers, -> "it would be really appreciated". [[--intrigeri]] - -Test conditions: - -- a 21M file containing 100 concatenated copies of all the files in my - `/usr/share/common-licenses/`; I had no existing PO file or - translated versions at hand, which renders these tests - quite incomplete. -- po4a was the Debian 0.34-2 package; the same tests were also run - after replacing the `Text` module with the CVS one (the core was not - changed in CVS since 0.34-2 was released), without any significant - difference in the results. -- Perl 5.10.0-16 - -#### po4a-gettextize - -`po4a-gettextize` uses more or less the same po4a features as our -`refreshpot` function. - -Without specifying an input charset, zzuf'ed `po4a-gettextize` quickly -errors out, complaining it was not able to detect the input charset; -it leaves no incomplete file on disk. - -So I had to pretend the input was in UTF-8, as does the po plugin. +[[po/discussion]] contains a detailed security analysis of this plugin +and its dependencies. -Two ways of crashing were revealed by this command-line: +When using po4a older than 0.35, it is recommended to uninstall +`Text::WrapI18N` (Debian package `libtext-wrapi18n-perl`), in order to +avoid a potential denial of service. - zzuf -vc -s 0:100 -r 0.1:0.5 \ - po4a-gettextize -f text -o markdown -M utf-8 -L utf-8 \ - -m LICENSES >/dev/null - -They are: - - Malformed UTF-8 character (UTF-16 surrogate 0xdcc9) in substitution iterator at /usr/share/perl5/Locale/Po4a/Po.pm line 1443. - Malformed UTF-8 character (fatal) at /usr/share/perl5/Locale/Po4a/Po.pm line 1443. - -and - - Malformed UTF-8 character (UTF-16 surrogate 0xdcec) in substitution (s///) at /usr/share/perl5/Locale/Po4a/Po.pm line 1443. - Malformed UTF-8 character (fatal) at /usr/share/perl5/Locale/Po4a/Po.pm line 1443. - -Perl seems to exit cleanly, and an incomplete PO file is written on -disk. I not sure whether if this is a bug in Perl or in `Po.pm`. - -> It's fairly standard perl behavior when fed malformed utf-8. As long as it doesn't -> crash ikiwiki, it's probably acceptable. Ikiwiki can do some similar things itself when fed malformed utf-8 (doesn't crash tho) --[[Joey]] - -#### po4a-translate - -`po4a-translate` uses more or less the same po4a features as our -`filter` function. - -Without specifying an input charset, same behaviour as -`po4a-gettextize`, so let's specify UTF-8 as input charset as of now. - - zzuf -cv \ - po4a-translate -d -f text -o markdown -M utf-8 -L utf-8 \ - -k 0 -m LICENSES -p LICENSES.fr.po -l test.fr - -... prints tons of occurences of the following error, but a complete -translated document is written (obviously with some weird chars -inside): - - Use of uninitialized value in string ne at /usr/share/perl5/Locale/Po4a/TransTractor.pm line 854. - Use of uninitialized value in string ne at /usr/share/perl5/Locale/Po4a/TransTractor.pm line 840. - Use of uninitialized value in pattern match (m//) at /usr/share/perl5/Locale/Po4a/Po.pm line 1002. - -While: - - zzuf -cv -s 0:10 -r 0.001:0.3 \ - po4a-translate -d -f text -o markdown -M utf-8 -L utf-8 \ - -k 0 -m LICENSES -p LICENSES.fr.po -l test.fr - -... seems to lose the fight, at the `readpo(LICENSES.fr.po)` step, -against some kind of infinite loop, deadlock, or any similar beast. -It does not seem to eat memory, though. - -Whatever format module is used does not change anything. This is thus -probably a bug in po4a's core or in a lib it depends on. - -The sub `read`, in `TransTractor.pm`, seems to be a good debugging -starting point. - -#### msgmerge - -`msgmerge` is run in our `refreshpofiles` function. I did not manage -to crash it with `zzuf`. - -gettext/po4a rough corners --------------------------- - -- fix infinite loop when synchronizing two ikiwiki (when checkouts - live in different directories): say bla.fr.po has been updated in - repo2; pulling repo2 from repo1 seems to trigger a PO update, that - changes bla.fr.po in repo1; then pushing repo1 to repo2 triggers - a PO update, that changes bla.fr.po in repo2; etc.; quickly fixed in - `629968fc89bced6727981c0a1138072631751fee`, by disabling references - in Pot files. Using `Locale::Po4a::write_if_needed` might be - a cleaner solution. (warning: this function runs the external - `diff` program, have to check security) -- new translations created in the web interface must get proper - charset/encoding gettext metadata, else the next automatic PO update - removes any non-ascii chars; possible solution: put such metadata - into the Pot file, and let it propagate; should be fixed in - `773de05a7a1ee68d2bed173367cf5e716884945a`, time will tell. +TODO +==== Better links ------------ -### Page title in links - -Using the fix to +Once the fix to [[bugs/pagetitle_function_does_not_respect_meta_titles]] from -[[intrigeri]]'s `meta` branch, the generated links' text is based on -the page titles set with the [[meta|plugins/meta]] plugin. This has to -be merged upstream, though. - -Translation quality assurance ------------------------------ - -Modifying a PO file via the CGI is already forbidden if the new -version is not a valid PO file. As a bonus, check that it provides -a more complete translation than the existing one. +[[intrigeri]]'s `meta` branch is merged into ikiwiki upstream, the +generated links' text will be optionally based on the page titles set +with the [[meta|plugins/meta]] plugin, and will thus be translatable. +It will also allow displaying the translation status in links to slave +pages. Both were implemented, and reverted in commit +ea753782b222bf4ba2fb4683b6363afdd9055b64, which should be reverted +once [[intrigeri]]'s `meta` branch is merged. + +An integration branch, called `meta-po`, merges [[intrigeri]]'s `po` +and `meta` branches, and thus has this additional features. + +Language display order +---------------------- + +Jonas pointed out that one might want to control the order that links to +other languages are listed, for various reasons. Currently, there is no +order, as `po_slave_languages` is a hash. It would need to be converted +to an array to support this. (If twere done, twere best done quickly.) +--[[Joey]] + +Pagespecs +--------- -Note: committing to the underlying repository is a way to bypass -this check. +I was suprised that, when using the map directive, a pagespec of "*" +listed all the translated pages as well as regular pages. That can +make a big difference to an existing wiki when po is turned on, +and seems generally not wanted. +(OTOH, you do want to match translated pages by +default when locking pages.) --[[Joey]] -Creating new pages on the web ------------------------------ +Edit links on untranslated pages +-------------------------------- -* See [[contrib/po|contrib/po]]. -* Page creation initiated by clicking a broken link on a translation - page defaults to po as new page type. It must default to the master - page's type. +If a page is not translated yet, the "translated" version of it +displays wikilinks to other, existing (but not yet translated?) +pages as edit links, as if those pages do not exist. -Robustness tests ----------------- +That's really confusing, especially as clicking such a link +brings up an edit form to create a new, english page. -### Disabling the plugin +This is with po_link_to=current or negotiated. With default, it doesn't +happen.. -- enabling the plugin with `po_translatable_pages` set -- enabling the plugin without `po_translatable_pages` set: **OK** -- disabling the plugin: **OK** +Also, this may only happen if the page being linked to is coming from an +underlay, and the underlays lack translation to a given language. +--[[Joey]] -### Changing the plugin config +Double commits of po files +-------------------------- -- adding existing pages to `po_translatable_pages`: **OK** -- removing existing pages from `po_translatable_pages`: **OK** -- adding a language to `po_slave_languages`: **OK** -- removing a language from `po_slave_languages`: **OK** -- changing `po_master_language`: **OK** -- replacing `po_master_language` with a language previously part of - `po_slave_languages`: needs two rebuilds, but **OK** (this is quite - a perverse test actually) +When adding a new english page, the po files are created, committed, +and then committed again. The second commit makes this change: -### Creating pages + -"Content-Type: text/plain; charset=utf-8\n" + -"Content-Transfer-Encoding: ENCODING" + +"Content-Type: text/plain; charset=UTF-8\n" + +"Content-Transfer-Encoding: ENCODING\n" -- creating a master page via RCS: **OK** -- creating a master page via CGI: **OK** +Same thing happens when a change to an existing page triggers a po file +update. --[[Joey]] -### Deleting pages +Ugly messages with empty files +------------------------------ -- removing a master page via RCS: **OK** -- removing a translation via RCS: **OK** -- removing a master page via CGI: **OK** -- removing a translation via CGI: **OK** +If there are empty .mdwn files, the po plugin displays some ugly messages. -### Renaming pages +Translation of directives +------------------------- -- renaming a master page via RCS: **OK** (but the old translations - are lost, because not all RCS track file renaming) -- renaming a master page and its translations via RCS: **OK** -- renaming a master page via CGI: **OK** -- renaming a translation via RCS -- renaming a translation via CGI +If a translated page contains a directive, it may expand to some english +text, or text in whatever single language ikiwiki is configured to "speak". -### Misc +Maybe there could be a way to switch ikiwiki to speaking another language +when building a non-english page? Then the directives would get translated. -- general test with `usedirs` disabled: **OK** -- general test with `indexpages` enabled -- general test with `po_link_to=default` +(We also will need this in order to use translated templates, when they are +available.) Documentation ------------- @@ -602,5 +326,3 @@ Documentation Maybe write separate documentation depending on the people it targets: translators, wiki administrators, hackers. This plugin may be complex enough to deserve this. - -Gettext-ize the plugin code.