4 * Copyright 2004,2005 $ThePhpWikiProgrammingTeam
6 * This file is part of PhpWiki.
8 * PhpWiki is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * PhpWiki is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with PhpWiki; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24 * _WikiTranslation: Display pagenames and other strings in various languages.
25 * Can also be used to let a favorite translation service translate a whole page.
26 * Current favorite: translate.google.com if from_lang = en or fr
29 * <<_WikiTranslation page=HomePage languages=fr >>
30 * Translation service for HomePage into french (redirect to translate.google.com)
31 * <<_WikiTranslation what=pages >>
32 * Translation matrix of all pages with proper translations (all in pgsrc)
33 * <<_WikiTranslation what=wikiwords match="W*" limit=20 >>
34 * Translation matrix of the first 20 wikiwords matching "W*"
35 * <<_WikiTranslation string=HomePage languages=fr,de,sv >>
36 * Translation matrix for all given languages
37 * <<_WikiTranslation string=HomePage >>
38 * Translation matrix for all supported languages
39 * <<_WikiTranslation string=HomePage languages=fr >>
40 * Just return the translated string for this language.
42 * @author: Reini Urban
45 /* Container for untranslated pagenames. Needed to show up in locale/po/phpwiki.pot */
47 _("AddCommentPlugin") .','.
48 _("AddingPages") .','.
49 _("AllPagesCreatedByMe") .','.
50 _("AllPagesLastEditedByMe") .','.
51 _("AllPagesOwnedByMe") .','.
52 _("AuthorHistoryPlugin") .','.
54 _("CalendarListPlugin") .','.
55 _("CalendarPlugin") .','.
56 _("CategoryCategory") .','.
57 _("CategoryHomePages") .','.
58 _("CommentPlugin") .','.
59 _("CreateTocPlugin") .','.
61 _("EditMetaData") .','.
62 _("EditMetaDataPlugin") .','.
63 _("ExternalSearchPlugin") .','.
65 _("FoafViewerPlugin") .','.
66 _("FrameIncludePlugin") .','.
67 _("FullRecentChanges") .','.
68 _("HelloWorldPlugin") .','.
69 _("HomePageAlias") .','.
70 _("IncludePagePlugin") .','.
73 _("MagicPhpWikiURLs") .','.
74 _("MoreAboutMechanics") .','.
75 _("NewMarkupTestPage") .','.
76 _("OldMarkupTestPage") .','.
77 _("OldStyleTablePlugin") .','.
78 // _("PageDump") .','.
79 _("PageGroupTest") .','.
80 _("PageGroupTest/Four") .','.
81 _("PageGroupTest/One") .','.
82 _("PageGroupTest/Three") .','.
83 _("PageGroupTest/Two") .','.
84 _("PgsrcTranslation") .','.
85 _("PhotoAlbumPlugin") .','.
86 _("PhpHighlightPlugin") .','.
87 _("PhpWeatherPlugin") .','.
89 _("PhpWikiAdministration/Chmod") .','.
90 _("PhpWikiAdministration/Chown") .','.
91 _("PhpWikiAdministration/Remove") .','.
92 _("PhpWikiAdministration/Rename") .','.
93 _("PhpWikiAdministration/Replace") .','.
94 _("PhpWikiAdministration/SetAcl") .','.
95 _("PhpWikiDocumentation") .','.
96 _("PhpWikiPoll") .','.
97 _("PloticusPlugin") .','.
98 _("PgsrcTranslation") .','.
99 _("PgsrcTranslation/de") .','.
100 _("PgsrcTranslation/fr") .','.
101 _("PgsrcTranslation/it") .','.
102 _("PgsrcTranslation/es") .','.
103 _("PgsrcTranslation/nl") .','.
104 _("PgsrcTranslation/sv") .','.
105 _("PgsrcTranslation/ja") .','.
106 _("PgsrcTranslation/zh") .','.
107 _("RawHtmlPlugin") .','.
108 _("RecentVisitors") .','.
109 _("RedirectToPlugin") .','.
110 _("ReleaseNotes") .','.
111 _("RichTablePlugin") .','.
112 // _("SpellCheck") .','.
113 _("SteveWainstead") .','.
114 _("SystemInfoPlugin") .','.
115 _("TranscludePlugin") .','.
116 _("TranslateText") .','.
117 _("UnfoldSubpagesPlugin") .','.
119 _("UpLoadPlugin") .','.
121 _("WikiBlogPlugin") .','.
122 _("WikiPlugin") .','.
125 require_once('lib/PageList.php');
127 class WikiPlugin__WikiTranslation
132 return _("_WikiTranslation");
135 function getDescription() {
136 return _("Show translations of various words or pages");
139 function getDefaultArguments() {
142 PageList::supportedArgs(),
143 array( 'languages' => '', // comma delimited string of de,en,sv,...
145 'page' => '', // use a translation service
146 'what' => 'pages', // or 'buttons', 'plugins' or 'wikiwords'
149 'from_lang' => false,
150 'include_empty' => false,
154 'nolinks' => false, // don't display any links
155 // (for development only)
156 'noT' => false // don't display the T link
157 // (for development only)
161 function init_locale($lang) {
162 if ($lang != $this->lang)
163 update_locale($lang);
165 // Hack alert! we need hash for stepping through it, even if it's
166 // in the wrong language
167 include (FindFile("locale/de/LC_MESSAGES/phpwiki.php", 0,'reinit'));
168 foreach ($locale as $en => $de) {
171 // gettext module loaded: must load the LC_MESSAGES php hash
172 } elseif (function_exists ('bindtextdomain')) {
173 include (FindFile("locale/$lang/LC_MESSAGES/phpwiki.php", 0,'reinit'));
174 //include (FindLocalizedFile("LC_MESSAGES/phpwiki.php", 0,'reinit'));
175 // we already have a $locale, but maybe it's in the wrong language
176 } elseif ($lang != $this->lang or empty($GLOBALS['locale'])) {
177 include (FindFile("locale/$lang/LC_MESSAGES/phpwiki.php", 0,'reinit'));
179 $locale = & $GLOBALS['locale'];
181 $this->_locales[$lang] = $locale;
184 // reverse translation:
185 function translate_to_en($text, $lang=false) {
186 if (!$lang) $lang = $this->lang; // current locale
187 if ($lang == 'en') return $text;
189 $this->_locales = array();
190 $this->_reverse_locales = array();
192 if (!isset($this->_locales[$lang])) {
193 $this->init_locale($lang);
195 assert(!empty($this->_locales[$lang]));
196 if (!isset($this->_reverse_locales[$lang])) {
197 // and now do a reverse lookup in the $locale hash
198 $this->_reverse_locales[$lang] = array_flip($this->_locales[$lang]);
200 if (!empty($this->_reverse_locales[$lang][$text])) {
201 return $this->_reverse_locales[$lang][$text];
208 * setlocale() switching with the gettext extension is by far too slow.
209 * So use the hash regardless if gettext is loaded or not.
211 function fast_translate($text, $to_lang, $from_lang=false) {
212 if (!$from_lang) $from_lang = $this->lang; // current locale
213 if ($from_lang == $to_lang) return $text;
214 // setup hash from en => to_lang
215 if (!isset($this->_locales[$to_lang]))
216 $this->init_locale($to_lang);
217 if ($from_lang != 'en') {
218 // get reverse gettext: translate to english
219 $text = $this->translate_to_en($text, $from_lang);
221 return !empty($this->_locales[$to_lang][$text])
222 ? $this->_locales[$to_lang][$text]
226 //FIXME! There's something wrong.
227 function translate($text, $to_lang, $from_lang=false) {
228 if (!$from_lang) $from_lang = $this->lang; // current locale
229 if ($from_lang == $to_lang) return $text;
230 // Speed up hash lookup. Not needed for gettext module
231 if (!isset($this->_locales[$from_lang]) and !function_exists('bindtextdomain')) {
232 $this->init_locale($from_lang);
234 if ($from_lang != 'en') {
235 // get reverse gettext: translate to english
236 $en = $this->translate_to_en($text, $from_lang);
237 // and then to target
238 update_locale($to_lang);
239 $result = gettext($en);
240 update_locale($from_lang);
242 // locale switching is very slow with the gettext extension.
243 // better use fast_translate
244 if ($from_lang != $to_lang) {
245 update_locale($to_lang);
247 $result = gettext($text);
248 if ($from_lang != $to_lang) {
249 update_locale($from_lang);
255 function run($dbi, $argstr, &$request, $basepage) {
256 $this->args = $this->getArgs($argstr, $request);
257 extract($this->args);
258 $this->request = &$request;
259 if (!$from_lang) $from_lang = $request->getPref('lang');
260 if (!$from_lang) $from_lang = $GLOBALS['LANG'];
261 $this->lang = $from_lang;
263 if (empty($languages)) {
264 $available_languages = listAvailableLanguages();
265 if ($from_lang == 'en') {
266 // "en" is always the first.
267 array_shift($available_languages);
269 // put from_lang to the very end.
270 if (in_array($from_lang, $available_languages))
271 $languages = $available_languages;
273 $languages = array_merge($available_languages, array($from_lang));
274 } elseif (strstr($languages,',')) {
275 $languages = explode(',', $languages);
277 $languages = array($languages);
279 if (in_array('zh', $languages) or in_array('ja', $languages)) {
281 // If the current charset != utf-8 the text will not be displayed correctly.
282 // But here we cannot change the header anymore. So we can decide to ignore them,
283 // or display them with all the errors.
284 //FIXME: do iconv the ob
285 if ($GLOBALS['charset'] != 'utf-8' and !defined('NEED_ICONV_TO')) {
286 define('NEED_ICONV_TO', 'utf-8');
287 //either the extension or external
288 //$GLOBALS['charset'] = 'utf-8';
291 $to_lang = $languages[0];
292 if (!empty($string) and count($languages)==1) {
293 return $this->translate($string, $to_lang, $from_lang);
297 if ($dbi->isWikiPage($pagename)) {
299 // google can only translate from english and french
300 if (in_array($from_lang, array('en', 'fr'))) {
301 $url = "http://translate.google.com/translate";
302 $url .= "?langpair=" . urlencode($from_lang."|".$to_lang);
303 $url .= "&u=" . urlencode(WikiURL($pagename, false, true));
305 // redirect or transclude?
307 return $request->redirect($url);
309 return HTML(fmt("TODO: Google can only translate from english and french. Find a translation service for %s to language %s",
310 WikiURL($pagename, false, true),
313 return $this->error(fmt("%s is empty",$pagename));
317 $pagelist = new PageList('', $exclude, $this->args);
318 $pagelist->_columns[0]->_heading = "$from_lang";
319 foreach ($languages as $lang) {
320 if ($lang == $from_lang) continue;
321 $field = "custom:$lang";
322 $pagelist->addColumnObject (
323 new _PageList_Column_customlang($field, $from_lang, $this));
325 if (!empty($string)) {
326 $pagelist->addPage( $string );
331 $pagelist->addPages( $dbi->getAllPages($include_empty, $sortby,
335 // not all pages, only the pgsrc pages
336 if (!is_array($exclude))
337 $exclude = $pagelist->explodePageList($exclude, false, $sortby,
339 $path = FindLocalizedFile(WIKI_PGSRC);
340 $pgsrc = new fileSet($path);
341 foreach ($pgsrc->getFiles($exclude, $sortby, $limit) as $pagename) {
342 $pagename = urldecode($pagename);
343 if (substr($pagename,-1,1) == '~') continue;
344 if (in_array($pagename, $exclude))
345 continue; // exclude page.
346 if ($match != '*' and !glob_match($match, $pagename))
348 $page_handle = $dbi->getPage($pagename);
349 $pagelist->addPage( $page_handle );
353 if (!isset($this->_locales[$from_lang])) {
354 $this->init_locale($from_lang);
356 $locale = & $this->_locales[$from_lang];
357 if (is_array($locale)) {
359 foreach ($locale as $from => $to) {
360 if ($match != '*' and !glob_match($match, $from))
362 if (isWikiWord($from)) {
364 $pagelist->addPage( $from );
365 if ($limit and $count > $limit) break;
370 // all Button texts, which need a localized .png
371 // where to get them from? templates/*.tmpl: Button()
372 // and WikiLink(?,'button')
373 // navbar links, actionpages, and admin requests
375 $buttons = $GLOBALS['AllActionPages'];
376 $fileset = new FileSet(FindFile("themes/MacOSX/buttons/en"),
378 foreach ($fileset->getFiles() as $file) {
379 $b = urldecode(substr($file, 0, -4));
380 if (!in_array($b,$buttons))
384 foreach ($buttons as $button) {
385 $pagelist->addPage( $button );
386 if ($limit and ++$count > $limit) break;
394 class _PageList_Column_customlang extends _PageList_Column {
395 function _PageList_Column_customlang($field, $from_lang, $plugin) {
396 $this->_field = $field;
397 $this->_from_lang = $from_lang;
398 $this->_plugin =& $plugin;
399 $this->_what = $plugin->args['what'];
400 $this->_noT = $plugin->args['noT'];
401 $this->_nolinks = $plugin->args['nolinks'];
402 $this->_iscustom = substr($field, 0, 7) == 'custom:';
403 if ($this->_iscustom)
404 $this->_field = substr($field, 7);
406 $this->dbi = &$GLOBALS['request']->getDbh();
407 $this->_PageList_Column_base($this->_field);
410 function _getValue($page, &$revision_handle) {
411 if (is_object($page)) $text = $page->getName();
413 $trans = $this->_plugin->fast_translate($text, $this->_field,
415 // how to markup untranslated words and not existing pages?
416 // untranslated: (TODO) link to translation editor
417 if ($trans == $text or // untranslated
418 (($this->_from_lang != 'en') and
419 ($this->_field != 'en') and
420 ($trans == $this->_plugin->fast_translate($text, 'en',
425 $link = $WikiTheme->linkUnknownWikiWord($trans);
426 if (!($this->_noT or $this->_nolinks)
427 and $this->dbi->isWikiPage($trans))
429 $url = WikiURL($trans, array('action' => 'TranslateText',
430 'lang' => $this->_field));
431 $button = $WikiTheme->makeButton('T', $url);
432 $button->addTooltip(sprintf(_("Define the translation for %s in %s"),
433 $trans, $this->_field));
434 $link = HTML::span($button);
435 $link->setAttr('class', 'wikiunknown');
436 $text = HTML::span($WikiTheme->maybeSplitWikiWord($trans));
437 $text->setAttr('style', 'text-decoration:line-through');
438 $link->pushContent($text);
440 } elseif (is_object($page))
442 else // not existing: empty
444 } elseif (is_object($page)) {
445 if (!$this->_nolinks)
446 return WikiLink($trans, 'auto');
459 // c-hanging-comment-ender-p: nil
460 // indent-tabs-mode: nil