]> projects.mako.cc - scuttle/blob - includes/php-gettext/gettext.inc
updated readme with information on a series of bugs I know exist
[scuttle] / includes / php-gettext / gettext.inc
1 <?php
2 /*
3    Copyright (c) 2005 Steven Armstrong <sa at c-area dot ch>
4    Copyright (c) 2009 Danilo Segan <danilo@kvota.net>
5
6    Drop in replacement for native gettext.
7
8    This file is part of PHP-gettext.
9
10    PHP-gettext is free software; you can redistribute it and/or modify
11    it under the terms of the GNU General Public License as published by
12    the Free Software Foundation; either version 2 of the License, or
13    (at your option) any later version.
14
15    PHP-gettext is distributed in the hope that it will be useful,
16    but WITHOUT ANY WARRANTY; without even the implied warranty of
17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18    GNU General Public License for more details.
19
20    You should have received a copy of the GNU General Public License
21    along with PHP-gettext; if not, write to the Free Software
22    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
23
24 */
25 /*
26 LC_CTYPE        0
27 LC_NUMERIC      1
28 LC_TIME         2
29 LC_COLLATE      3
30 LC_MONETARY     4
31 LC_MESSAGES     5
32 LC_ALL          6
33 */
34
35
36 // LC_MESSAGES is not available if php-gettext is not loaded
37 // while the other constants are already available from session extension.
38 if (!defined('LC_MESSAGES')) {
39   define('LC_MESSAGES', 5);
40 }
41
42 require('streams.php');
43 require('gettext.php');
44
45
46 // Variables
47
48 global $text_domains, $default_domain, $LC_CATEGORIES, $EMULATEGETTEXT, $CURRENTLOCALE;
49 $text_domains = array();
50 $default_domain = 'messages';
51 $LC_CATEGORIES = array('LC_CTYPE', 'LC_NUMERIC', 'LC_TIME', 'LC_COLLATE', 'LC_MONETARY', 'LC_MESSAGES', 'LC_ALL');
52 $EMULATEGETTEXT = 0;
53 $CURRENTLOCALE = '';
54
55 /* Class to hold a single domain included in $text_domains. */
56 class domain {
57   var $l10n;
58   var $path;
59   var $codeset;
60 }
61
62 // Utility functions
63
64 /**
65  * Return a list of locales to try for any POSIX-style locale specification.
66  */
67 function get_list_of_locales($locale) {
68   /* Figure out all possible locale names and start with the most
69    * specific ones.  I.e. for sr_CS.UTF-8@latin, look through all of
70    * sr_CS.UTF-8@latin, sr_CS@latin, sr@latin, sr_CS.UTF-8, sr_CS, sr.
71    */
72   $locale_names = array();
73   $lang = NULL;
74   $country = NULL;
75   $charset = NULL;
76   $modifier = NULL;
77   if ($locale) {
78     if (preg_match("/^(?P<lang>[a-z]{2,3})"              // language code
79                    ."(?:_(?P<country>[A-Z]{2}))?"           // country code
80                    ."(?:\.(?P<charset>[-A-Za-z0-9_]+))?"    // charset
81                    ."(?:@(?P<modifier>[-A-Za-z0-9_]+))?$/",  // @ modifier
82                    $locale, $matches)) {
83
84       if (isset($matches["lang"])) $lang = $matches["lang"];
85       if (isset($matches["country"])) $country = $matches["country"];
86       if (isset($matches["charset"])) $charset = $matches["charset"];
87       if (isset($matches["modifier"])) $modifier = $matches["modifier"];
88
89       if ($modifier) {
90         if ($country) {
91           if ($charset)
92             array_push($locale_names, "${lang}_$country.$charset@$modifier");
93           array_push($locale_names, "${lang}_$country@$modifier");
94         } elseif ($charset)
95             array_push($locale_names, "${lang}.$charset@$modifier");
96         array_push($locale_names, "$lang@$modifier");
97       }
98       if ($country) {
99         if ($charset)
100           array_push($locale_names, "${lang}_$country.$charset");
101         array_push($locale_names, "${lang}_$country");
102       } elseif ($charset)
103           array_push($locale_names, "${lang}.$charset");
104       array_push($locale_names, $lang);
105     }
106
107     // If the locale name doesn't match POSIX style, just include it as-is.
108     if (!in_array($locale, $locale_names))
109       array_push($locale_names, $locale);
110   }
111   return $locale_names;
112 }
113
114 /**
115  * Utility function to get a StreamReader for the given text domain.
116  */
117 function _get_reader($domain=null, $category=5, $enable_cache=true) {
118     global $text_domains, $default_domain, $LC_CATEGORIES;
119     if (!isset($domain)) $domain = $default_domain;
120     if (!isset($text_domains[$domain]->l10n)) {
121         // get the current locale
122         $locale = _setlocale(LC_MESSAGES, 0);
123         $bound_path = isset($text_domains[$domain]->path) ?
124           $text_domains[$domain]->path : './';
125         $subpath = $LC_CATEGORIES[$category] ."/$domain.mo";
126
127         $locale_names = get_list_of_locales($locale);
128         $input = null;
129         foreach ($locale_names as $locale) {
130           $full_path = $bound_path . $locale . "/" . $subpath;
131           if (file_exists($full_path)) {
132             $input = new FileReader($full_path);
133             break;
134           }
135         }
136
137         if (!array_key_exists($domain, $text_domains)) {
138           // Initialize an empty domain object.
139           $text_domains[$domain] = new domain();
140         }
141         $text_domains[$domain]->l10n = new gettext_reader($input,
142                                                           $enable_cache);
143     }
144     return $text_domains[$domain]->l10n;
145 }
146
147 /**
148  * Returns whether we are using our emulated gettext API or PHP built-in one.
149  */
150 function locale_emulation() {
151     global $EMULATEGETTEXT;
152     return $EMULATEGETTEXT;
153 }
154
155 /**
156  * Checks if the current locale is supported on this system.
157  */
158 function _check_locale_and_function($function=false) {
159     global $EMULATEGETTEXT;
160     if ($function and !function_exists($function))
161         return false;
162     return !$EMULATEGETTEXT;
163 }
164
165 /**
166  * Get the codeset for the given domain.
167  */
168 function _get_codeset($domain=null) {
169     global $text_domains, $default_domain, $LC_CATEGORIES;
170     if (!isset($domain)) $domain = $default_domain;
171     return (isset($text_domains[$domain]->codeset))? $text_domains[$domain]->codeset : ini_get('mbstring.internal_encoding');
172 }
173
174 /**
175  * Convert the given string to the encoding set by bind_textdomain_codeset.
176  */
177 function _encode($text) {
178     $source_encoding = mb_detect_encoding($text);
179     $target_encoding = _get_codeset();
180     if ($source_encoding != $target_encoding) {
181         return mb_convert_encoding($text, $target_encoding, $source_encoding);
182     }
183     else {
184         return $text;
185     }
186 }
187
188
189 // Custom implementation of the standard gettext related functions
190
191 /**
192  * Returns passed in $locale, or environment variable $LANG if $locale == ''.
193  */
194 function _get_default_locale($locale) {
195   if ($locale == '') // emulate variable support
196     return getenv('LANG');
197   else
198     return $locale;
199 }
200
201 /**
202  * Sets a requested locale, if needed emulates it.
203  */
204 function _setlocale($category, $locale) {
205     global $CURRENTLOCALE, $EMULATEGETTEXT;
206     if ($locale === 0) { // use === to differentiate between string "0"
207         if ($CURRENTLOCALE != '')
208             return $CURRENTLOCALE;
209         else
210             // obey LANG variable, maybe extend to support all of LC_* vars
211             // even if we tried to read locale without setting it first
212             return _setlocale($category, $CURRENTLOCALE);
213     } else {
214         if (function_exists('setlocale')) {
215           $ret = setlocale($category, $locale);
216           if (($locale == '' and !$ret) or // failed setting it by env
217               ($locale != '' and $ret != $locale)) { // failed setting it
218             // Failed setting it according to environment.
219             $CURRENTLOCALE = _get_default_locale($locale);
220             $EMULATEGETTEXT = 1;
221           } else {
222             $CURRENTLOCALE = $ret;
223             $EMULATEGETTEXT = 0;
224           }
225         } else {
226           // No function setlocale(), emulate it all.
227           $CURRENTLOCALE = _get_default_locale($locale);
228           $EMULATEGETTEXT = 1;
229         }
230         // Allow locale to be changed on the go for one translation domain.
231         global $text_domains, $default_domain;
232         unset($text_domains[$default_domain]->l10n);
233         return $CURRENTLOCALE;
234     }
235 }
236
237 /**
238  * Sets the path for a domain.
239  */
240 function _bindtextdomain($domain, $path) {
241     global $text_domains;
242     // ensure $path ends with a slash ('/' should work for both, but lets still play nice)
243     if (substr(php_uname(), 0, 7) == "Windows") {
244       if ($path[strlen($path)-1] != '\\' and $path[strlen($path)-1] != '/')
245         $path .= '\\';
246     } else {
247       if ($path[strlen($path)-1] != '/')
248         $path .= '/';
249     }
250     if (!array_key_exists($domain, $text_domains)) {
251       // Initialize an empty domain object.
252       $text_domains[$domain] = new domain();
253     }
254     $text_domains[$domain]->path = $path;
255 }
256
257 /**
258  * Specify the character encoding in which the messages from the DOMAIN message catalog will be returned.
259  */
260 function _bind_textdomain_codeset($domain, $codeset) {
261     global $text_domains;
262     $text_domains[$domain]->codeset = $codeset;
263 }
264
265 /**
266  * Sets the default domain.
267  */
268 function _textdomain($domain) {
269     global $default_domain;
270     $default_domain = $domain;
271 }
272
273 /**
274  * Lookup a message in the current domain.
275  */
276 function _gettext($msgid) {
277     $l10n = _get_reader();
278     return _encode($l10n->translate($msgid));
279 }
280
281 /**
282  * Alias for gettext.
283  */
284 function __($msgid) {
285     return _gettext($msgid);
286 }
287
288 /**
289  * Plural version of gettext.
290  */
291 function _ngettext($single, $plural, $number) {
292     $l10n = _get_reader();
293     return _encode($l10n->ngettext($single, $plural, $number));
294 }
295
296 /**
297  * Override the current domain.
298  */
299 function _dgettext($domain, $msgid) {
300     $l10n = _get_reader($domain);
301     return _encode($l10n->translate($msgid));
302 }
303
304 /**
305  * Plural version of dgettext.
306  */
307 function _dngettext($domain, $single, $plural, $number) {
308     $l10n = _get_reader($domain);
309     return _encode($l10n->ngettext($single, $plural, $number));
310 }
311
312 /**
313  * Overrides the domain and category for a single lookup.
314  */
315 function _dcgettext($domain, $msgid, $category) {
316     $l10n = _get_reader($domain, $category);
317     return _encode($l10n->translate($msgid));
318 }
319 /**
320  * Plural version of dcgettext.
321  */
322 function _dcngettext($domain, $single, $plural, $number, $category) {
323     $l10n = _get_reader($domain, $category);
324     return _encode($l10n->ngettext($single, $plural, $number));
325 }
326
327 /**
328  * Context version of gettext.
329  */
330 function _pgettext($context, $msgid) {
331     $l10n = _get_reader();
332     return _encode($l10n->pgettext($context, $msgid));
333 }
334
335 /**
336  * Override the current domain in a context gettext call.
337  */
338 function _dpgettext($domain, $context, $msgid) {
339     $l10n = _get_reader($domain);
340     return _encode($l10n->pgettext($context, $msgid));
341 }
342
343 /**
344  * Overrides the domain and category for a single context-based lookup.
345  */
346 function _dcpgettext($domain, $context, $msgid, $category) {
347     $l10n = _get_reader($domain, $category);
348     return _encode($l10n->pgettext($context, $msgid));
349 }
350
351 /**
352  * Context version of ngettext.
353  */
354 function _npgettext($context, $singular, $plural) {
355     $l10n = _get_reader();
356     return _encode($l10n->npgettext($context, $singular, $plural));
357 }
358
359 /**
360  * Override the current domain in a context ngettext call.
361  */
362 function _dnpgettext($domain, $context, $singular, $plural) {
363     $l10n = _get_reader($domain);
364     return _encode($l10n->npgettext($context, $singular, $plural));
365 }
366
367 /**
368  * Overrides the domain and category for a plural context-based lookup.
369  */
370 function _dcnpgettext($domain, $context, $singular, $plural, $category) {
371     $l10n = _get_reader($domain, $category);
372     return _encode($l10n->npgettext($context, $singular, $plural));
373 }
374
375
376
377 // Wrappers to use if the standard gettext functions are available,
378 // but the current locale is not supported by the system.
379 // Use the standard impl if the current locale is supported, use the
380 // custom impl otherwise.
381
382 function T_setlocale($category, $locale) {
383     return _setlocale($category, $locale);
384 }
385
386 function T_bindtextdomain($domain, $path) {
387     if (_check_locale_and_function()) return bindtextdomain($domain, $path);
388     else return _bindtextdomain($domain, $path);
389 }
390 function T_bind_textdomain_codeset($domain, $codeset) {
391     // bind_textdomain_codeset is available only in PHP 4.2.0+
392     if (_check_locale_and_function('bind_textdomain_codeset'))
393         return bind_textdomain_codeset($domain, $codeset);
394     else return _bind_textdomain_codeset($domain, $codeset);
395 }
396 function T_textdomain($domain) {
397     if (_check_locale_and_function()) return textdomain($domain);
398     else return _textdomain($domain);
399 }
400 function T_gettext($msgid) {
401     if (_check_locale_and_function()) return gettext($msgid);
402     else return _gettext($msgid);
403 }
404 function T_($msgid) {
405     if (_check_locale_and_function()) return _($msgid);
406     return __($msgid);
407 }
408 function T_ngettext($single, $plural, $number) {
409     if (_check_locale_and_function())
410         return ngettext($single, $plural, $number);
411     else return _ngettext($single, $plural, $number);
412 }
413 function T_dgettext($domain, $msgid) {
414     if (_check_locale_and_function()) return dgettext($domain, $msgid);
415     else return _dgettext($domain, $msgid);
416 }
417 function T_dngettext($domain, $single, $plural, $number) {
418     if (_check_locale_and_function())
419         return dngettext($domain, $single, $plural, $number);
420     else return _dngettext($domain, $single, $plural, $number);
421 }
422 function T_dcgettext($domain, $msgid, $category) {
423     if (_check_locale_and_function())
424         return dcgettext($domain, $msgid, $category);
425     else return _dcgettext($domain, $msgid, $category);
426 }
427 function T_dcngettext($domain, $single, $plural, $number, $category) {
428     if (_check_locale_and_function())
429       return dcngettext($domain, $single, $plural, $number, $category);
430     else return _dcngettext($domain, $single, $plural, $number, $category);
431 }
432
433 function T_pgettext($context, $msgid) {
434   if (_check_locale_and_function('pgettext'))
435       return pgettext($context, $msgid);
436   else
437       return _pgettext($context, $msgid);
438 }
439
440 function T_dpgettext($domain, $context, $msgid) {
441   if (_check_locale_and_function('dpgettext'))
442       return dpgettext($domain, $context, $msgid);
443   else
444       return _dpgettext($domain, $context, $msgid);
445 }
446
447 function T_dcpgettext($domain, $context, $msgid, $category) {
448   if (_check_locale_and_function('dcpgettext'))
449       return dcpgettext($domain, $context, $msgid, $category);
450   else
451       return _dcpgettext($domain, $context, $msgid, $category);
452 }
453
454 function T_npgettext($context, $singular, $plural) {
455     if (_check_locale_and_function('npgettext'))
456         return npgettext($context, $single, $plural, $number);
457     else
458         return _npgettext($context, $single, $plural, $number);
459 }
460
461 function T_dnpgettext($domain, $context, $singular, $plural) {
462   if (_check_locale_and_function('dnpgettext'))
463       return dnpgettext($domain, $context, $single, $plural, $number);
464   else
465       return _dnpgettext($domain, $context, $single, $plural, $number);
466 }
467
468 function T_dcnpgettext($domain, $context, $singular, $plural, $category) {
469     if (_check_locale_and_function('dcnpgettext'))
470         return dcnpgettext($domain, $context, $single,
471                            $plural, $number, $category);
472     else
473         return _dcnpgettext($domain, $context, $single,
474                             $plural, $number, $category);
475 }
476
477
478
479 // Wrappers used as a drop in replacement for the standard gettext functions
480
481 if (!function_exists('gettext')) {
482     function bindtextdomain($domain, $path) {
483         return _bindtextdomain($domain, $path);
484     }
485     function bind_textdomain_codeset($domain, $codeset) {
486         return _bind_textdomain_codeset($domain, $codeset);
487     }
488     function textdomain($domain) {
489         return _textdomain($domain);
490     }
491     function gettext($msgid) {
492         return _gettext($msgid);
493     }
494     function _($msgid) {
495         return __($msgid);
496     }
497     function ngettext($single, $plural, $number) {
498         return _ngettext($single, $plural, $number);
499     }
500     function dgettext($domain, $msgid) {
501         return _dgettext($domain, $msgid);
502     }
503     function dngettext($domain, $single, $plural, $number) {
504         return _dngettext($domain, $single, $plural, $number);
505     }
506     function dcgettext($domain, $msgid, $category) {
507         return _dcgettext($domain, $msgid, $category);
508     }
509     function dcngettext($domain, $single, $plural, $number, $category) {
510         return _dcngettext($domain, $single, $plural, $number, $category);
511     }
512     function pgettext($context, $msgid) {
513         return _pgettext($context, $msgid);
514     }
515     function npgettext($context, $single, $plural, $number) {
516         return _npgettext($context, $single, $plural, $number);
517     }
518     function dpgettext($domain, $context, $msgid) {
519         return _dpgettext($domain, $context, $msgid);
520     }
521     function dnpgettext($domain, $context, $single, $plural, $number) {
522         return _dnpgettext($domain, $context, $single, $plural, $number);
523     }
524     function dcpgettext($domain, $context, $msgid, $category) {
525         return _dcpgettext($domain, $context, $msgid, $category);
526     }
527     function dcnpgettext($domain, $context, $single, $plural,
528                          $number, $category) {
529       return _dcnpgettext($domain, $context, $single, $plural,
530                           $number, $category);
531     }
532 }
533
534 ?>

Benjamin Mako Hill || Want to submit a patch?