Source for file gettext.php

Documentation is available at gettext.php

  1. <?php
  2.  
  3. /**
  4.  * SquirrelMail internal gettext functions
  5.  *
  6.  * Alternate to the system's built-in gettext. Relies on .po files (can't read
  7.  * .mo easily). Uses the session for caching (speed increase). Possible use in
  8.  * other PHP scripts? The only SM-specific thing is $sm_language, I think.
  9.  *
  10.  * @link http://www.php.net/gettext Original php gettext manual
  11.  * @copyright 1999-2020 The SquirrelMail Project Team
  12.  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  13.  * @version $Id: gettext.php 14840 2020-01-07 07:42:38Z pdontthink $
  14.  * @since 1.1.2
  15.  * @package squirrelmail
  16.  * @subpackage i18n
  17.  */
  18.  
  19. /** Almost everything requires global.php... */
  20. require_once(SM_PATH . 'functions/global.php');
  21.  
  22. global $gettext_php_domain, $gettext_php_dir, $gettext_php_loaded,
  23.  $gettext_php_translateStrings, $gettext_php_loaded_language,
  24.  $gettext_php_short_circuit;
  25.  
  26. if (! isset($gettext_php_loaded)) {
  27.     $gettext_php_loaded = false;
  28.     sqsession_register($gettext_php_loaded, 'gettext_php_loaded');
  29. }
  30. if (! isset($gettext_php_domain)) {
  31.     $gettext_php_domain = '';
  32.     sqsession_register($gettext_php_domain, 'gettext_php_domain');
  33. }
  34. if (! isset($gettext_php_dir)) {
  35.     $gettext_php_dir = '';
  36.     sqsession_register($gettext_php_dir, 'gettext_php_dir');
  37. }
  38. if (! isset($gettext_php_translateStrings)) {
  39.     $gettext_php_translateStrings = array();
  40.     sqsession_register($gettext_php_translateStrings, 'gettext_php_translateStrings');
  41. }
  42. if (! isset($gettext_php_loaded_language)) {
  43.     $gettext_php_loaded_language = '';
  44.     sqsession_register($gettext_php_loaded_language, 'gettext_php_loaded_language');
  45. }
  46. if (! isset($gettext_php_short_circuit)) {
  47.     $gettext_php_short_circuit = false;
  48.     sqsession_register($gettext_php_short_circuit, 'gettext_php_short_circuit');
  49. }
  50.  
  51. /**
  52.  * Converts .po file into array and stores it in session.
  53.  *
  54.  * Used internally by _($str) function
  55.  *
  56.  * @internal function is used internally by functions/gettext.php code
  57.  */
  58. function gettext_php_load_strings() {
  59.     global $squirrelmail_language, $gettext_php_translateStrings,
  60.         $gettext_php_domain, $gettext_php_dir, $gettext_php_loaded,
  61.         $gettext_php_loaded_language, $gettext_php_short_circuit;
  62.     
  63.     /*
  64.      * $squirrelmail_language gives 'en' for English, 'de' for German,
  65.      * etc.  I didn't wanna use getenv or similar, but you easily could
  66.      * change my code to do that. 
  67.      */
  68.     
  69.     $gettext_php_translateStrings = array();
  70.     
  71.     $gettext_php_short_circuit = false;  /* initialization */
  72.     
  73.     $filename = $gettext_php_dir;
  74.     if (substr($filename, -1) != '/')
  75.         $filename .= '/';
  76.     $filename .= $squirrelmail_language . '/LC_MESSAGES/' . 
  77.         $gettext_php_domain . '.po';
  78.     
  79.     $file = @fopen($filename, 'r');
  80.     if ($file == false) {
  81.         /* Uh-ho -- we can't load the file.  Just fake it.  :-)
  82.            This is also for English, which doesn't use translations */
  83.         $gettext_php_loaded = true;
  84.         $gettext_php_loaded_language = $squirrelmail_language;
  85.         /* Avoid fuzzy matching when we didn't load strings */
  86.         $gettext_php_short_circuit = true;  
  87.         return;
  88.     }
  89.     
  90.     $key = '';
  91.     $SkipRead = false;
  92.     while (! feof($file)) {
  93.         if (! $SkipRead) {
  94.             $line = trim(fgets($file, 4096));
  95.         } else {
  96.             $SkipRead = false;
  97.         }
  98.         
  99.         if (preg_match('/^msgid "(.*)"$/', $line, $match)) {
  100.             if ($match[1] == '') {
  101.                 /*
  102.                  * Potential multi-line
  103.                  * msgid ""
  104.                  * "string string "
  105.                  * "string string"
  106.                  */
  107.                 $key = '';
  108.                 $line = trim(fgets($file, 4096));
  109.                 while (preg_match('/^[ ]*"(.*)"[ ]*$/', $line, $match)) {
  110.                     $key .= $match[1];
  111.                     $line = trim(fgets($file, 4096));
  112.                 }
  113.                 $SkipRead = true;
  114.             } else {
  115.                 /* msgid "string string" */
  116.                 $key = $match[1];
  117.             }
  118.         } elseif (preg_match('/^msgstr "(.*)"$/', $line, $match)) {
  119.             if ($match[1] == '') {
  120.                 /*
  121.                  * Potential multi-line
  122.                  * msgstr ""
  123.                  * "string string "
  124.                  * "string string"
  125.                  */
  126.                 $gettext_php_translateStrings[$key] = '';
  127.                 $line = trim(fgets($file, 4096));
  128.                 while (preg_match('/^[ ]*"(.*)"[ ]*$/', $line, $match)) {
  129.                     $gettext_php_translateStrings[$key] .= $match[1];
  130.                     $line = trim(fgets($file, 4096));
  131.                 }
  132.                 $SkipRead = true;
  133.             } else {
  134.                 /* msgstr "string string" */
  135.                 $gettext_php_translateStrings[$key] = $match[1];
  136.             }
  137.             $gettext_php_translateStrings[$key] =
  138.                 stripslashes($gettext_php_translateStrings[$key]);
  139.             /* If there is no translation, just use the untranslated string */
  140.             if ($gettext_php_translateStrings[$key] == '') {
  141.                 $gettext_php_translateStrings[$key] = $key;
  142.             }
  143.             $key = '';
  144.         }
  145.     }
  146.     fclose($file);
  147.     
  148.     $gettext_php_loaded = true;
  149.     $gettext_php_loaded_language = $squirrelmail_language;
  150. }
  151.  
  152. /**
  153.  * Alternative php gettext function (short form)
  154.  *
  155.  * @link http://www.php.net/function.gettext
  156.  *
  157.  * @param string $str English string
  158.  * @return string translated string
  159.  */
  160. function _($str) {
  161.     global $gettext_php_loaded, $gettext_php_translateStrings, 
  162.         $squirrelmail_language, $gettext_php_loaded_language,
  163.         $gettext_php_short_circuit;
  164.     
  165.     if (! $gettext_php_loaded || 
  166.         $gettext_php_loaded_language != $squirrelmail_language) {
  167.         gettext_php_load_strings();
  168.     }
  169.     
  170.     /* Try finding the exact string */
  171.     if (isset($gettext_php_translateStrings[$str])) {
  172.         return $gettext_php_translateStrings[$str];
  173.     }
  174.     
  175.     /* See if we should short-circuit */
  176.     if ($gettext_php_short_circuit) {
  177.         $gettext_php_translateStrings[$str] = $str;
  178.         return $str;
  179.     }
  180.  
  181.     /* don't do fuzzy matching for strings with sprintf() formating */
  182.     if (! preg_match('/\%[\%bcdeufFosxX]/',$str)) {
  183.         /* Look for a string that is very close to the one we want
  184.          * Very computationally expensive */
  185.         $oldPercent = 0;
  186.         $oldStr = '';
  187.         $newPercent = 0;
  188.         foreach ($gettext_php_translateStrings as $k => $v) {
  189.             similar_text($str, $k, $newPercent);
  190.             if ($newPercent > $oldPercent) {
  191.                 $oldStr = $v;
  192.                 $oldPercent = $newPercent;
  193.             }
  194.         }
  195.         /* Require 80% match or better
  196.          * Adjust to suit your needs */
  197.         if ($oldPercent > 80) {
  198.             /* Remember this so we don't need to search again */
  199.             $gettext_php_translateStrings[$str] = $oldStr;
  200.             return $oldStr;
  201.         }
  202.     }
  203.     /* Remember this so we don't need to search again */
  204.     $gettext_php_translateStrings[$str] = $str;
  205.     return $str;
  206. }
  207.  
  208. /**
  209.  * Alternative php bindtextdomain function
  210.  *
  211.  * Sets path to directory containing domain translations
  212.  *
  213.  * @link http://www.php.net/function.bindtextdomain
  214.  * @param string $name gettext domain name
  215.  * @param string $dir directory that contains all translations
  216.  * @return string path to translation directory
  217.  */
  218. function bindtextdomain($name, $dir) {
  219.     global $gettext_php_domain, $gettext_php_dir, $gettext_php_loaded;
  220.     
  221.     if ($gettext_php_domain != $name) {
  222.         $gettext_php_domain = $name;
  223.         $gettext_php_loaded = false;
  224.     }
  225.     if ($gettext_php_dir != $dir) {
  226.         $gettext_php_dir = $dir;
  227.         $gettext_php_loaded = false;
  228.     }
  229.     
  230.     return $dir;
  231. }
  232.  
  233. /**
  234.  * Alternative php textdomain function
  235.  *
  236.  * Sets default domain name
  237.  *
  238.  * @link http://www.php.net/function.textdomain
  239.  * @param string $name gettext domain name
  240.  * @return string gettext domain name
  241.  */
  242. function textdomain($name = false) {
  243.     global $gettext_php_domain, $gettext_php_loaded;
  244.     
  245.     if ($name != false && $gettext_php_domain != $name) {
  246.         $gettext_php_domain = $name;
  247.         $gettext_php_loaded = false;
  248.     }
  249.  
  250.     return $gettext_php_domain;
  251. }

Documentation generated on Mon, 13 Jan 2020 04:24:40 +0100 by phpDocumentor 1.4.3