Happy New Year
[squirrelmail.git] / functions / gettext.php
index fa74b24f80610bb26185b7673072570c00b74b11..8057640b2d296f223d8e6456af5c26333744194d 100644 (file)
 <?php
 
 /**
- * gettext.php
+ * SquirrelMail internal gettext functions
  *
- * Copyright (c) 1999-2003 The SquirrelMail Project Team
- * Licensed under the GNU GPL. For full terms see the file COPYING.
+ * Since 1.5.1 uses php-gettext classes.
+ * Original implementation was done by Tyler Akins (fidian)
  *
- * Alternate to the system's built-in gettext.
- * relies on .po files (can't read .mo easily).
- * Uses the session for caching (speed increase)
- * Possible use in other PHP scripts?  The only SM-specific thing is
- *   $sm_language, I think
- *
- * $Id$
+ * @link http://www.php.net/gettext Original php gettext manual
+ * @link http://savannah.nongnu.org/projects/php-gettext php-gettext classes
+ * @copyright 1999-2018 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @version $Id$
+ * @since 1.1.2
  * @package squirrelmail
+ * @subpackage i18n
  */
 
-/** Almost everything requires global.php... */
-require_once(SM_PATH . 'functions/global.php');
-
-global $gettext_php_domain, $gettext_php_dir, $gettext_php_loaded,
- $gettext_php_translateStrings, $gettext_php_loaded_language,
- $gettext_php_short_circuit;
-
-if (! isset($gettext_php_loaded)) {
-    $gettext_php_loaded = false;
-    sqsession_register($gettext_php_loaded, 'gettext_php_loaded');
-}
-if (! isset($gettext_php_domain)) {
-    $gettext_php_domain = '';
-    sqsession_register($gettext_php_domain, 'gettext_php_domain');
-}
-if (! isset($gettext_php_dir)) {
-    $gettext_php_dir = '';
-    sqsession_register($gettext_php_dir, 'gettext_php_dir');
-}
-if (! isset($gettext_php_translateStrings)) {
-    $gettext_php_translateStrings = array();
-    sqsession_register($gettext_php_translateStrings, 'gettext_php_translateStrings');
-}
-if (! isset($gettext_php_loaded_language)) {
-    $gettext_php_loaded_language = '';
-    sqsession_register($gettext_php_loaded_language, 'gettext_php_loaded_language');
-}
-if (! isset($gettext_php_short_circuit)) {
-    $gettext_php_short_circuit = false;
-    sqsession_register($gettext_php_short_circuit, 'gettext_php_short_circuit');
-}
 
-function gettext_php_load_strings() {
-    global $squirrelmail_language, $gettext_php_translateStrings,
-        $gettext_php_domain, $gettext_php_dir, $gettext_php_loaded,
-        $gettext_php_loaded_language, $gettext_php_short_circuit;
-    
-    /*
-     * $squirrelmail_language gives 'en' for English, 'de' for German,
-     * etc.  I didn't wanna use getenv or similar, but you easily could
-     * change my code to do that. 
-     */
-    
-    $gettext_php_translateStrings = array();
-    
-    $gettext_php_short_circuit = false;  /* initialization */
-    
-    $filename = $gettext_php_dir;
-    if (substr($filename, -1) != '/')
-        $filename .= '/';
-    $filename .= $squirrelmail_language . '/LC_MESSAGES/' . 
-        $gettext_php_domain . '.po';
-    
-    $file = @fopen($filename, 'r');
-    if ($file == false) {
-        /* Uh-ho -- we can't load the file.  Just fake it.  :-)
-           This is also for English, which doesn't use translations */
-        $gettext_php_loaded = true;
-        $gettext_php_loaded_language = $squirrelmail_language;
-        /* Avoid fuzzy matching when we didn't load strings */
-        $gettext_php_short_circuit = true;  
-        return;
-    }
-    
-    $key = '';
-    $SkipRead = false;
-    while (! feof($file)) {
-        if (! $SkipRead) {
-            $line = trim(fgets($file, 4096));
-        } else {
-            $SkipRead = false;
-        }
-        
-        if (ereg('^msgid "(.*)"$', $line, $match)) {
-            if ($match[1] == '') {
-                /*
-                 * Potential multi-line
-                 * msgid ""
-                 * "string string "
-                 * "string string"
-                 */
-                $key = '';
-                $line = trim(fgets($file, 4096));
-                while (ereg('^[ ]*"(.*)"[ ]*$', $line, $match)) {
-                    $key .= $match[1];
-                    $line = trim(fgets($file, 4096));
-                }
-                $SkipRead = true;
-            } else {
-                /* msgid "string string" */
-                $key = $match[1];
-            }
-        } elseif (ereg('^msgstr "(.*)"$', $line, $match)) {
-            if ($match[1] == '') {
-                /*
-                 * Potential multi-line
-                 * msgstr ""
-                 * "string string "
-                 * "string string"
-                 */
-                $gettext_php_translateStrings[$key] = '';
-                $line = trim(fgets($file, 4096));
-                while (ereg('^[ ]*"(.*)"[ ]*$', $line, $match)) {
-                    $gettext_php_translateStrings[$key] .= $match[1];
-                    $line = trim(fgets($file, 4096));
-                }
-                $SkipRead = true;
-            } else {
-                /* msgstr "string string" */
-                $gettext_php_translateStrings[$key] = $match[1];
-            }
-            $gettext_php_translateStrings[$key] =
-                stripslashes($gettext_php_translateStrings[$key]);
-            /* If there is no translation, just use the untranslated string */
-            if ($gettext_php_translateStrings[$key] == '') {
-                $gettext_php_translateStrings[$key] = $key;
-            }
-            $key = '';
-        }
-    }
-    fclose($file);
-    
-    $gettext_php_loaded = true;
-    $gettext_php_loaded_language = $squirrelmail_language;
-}
+/** Load classes and other functions */
+include_once(SM_PATH . 'class/l10n.class.php');
+include_once(SM_PATH . 'functions/ngettext.php');
 
+/**
+ * Alternative php gettext function (short form)
+ *
+ * @link http://www.php.net/function.gettext
+ *
+ * @param string $str English string
+ * @return string translated string
+ * @since 1.1.2
+ */
 function _($str) {
-    global $gettext_php_loaded, $gettext_php_translateStrings, 
-        $squirrelmail_language, $gettext_php_loaded_language,
-        $gettext_php_short_circuit;
-    
-    if (! $gettext_php_loaded || 
-        $gettext_php_loaded_language != $squirrelmail_language) {
-        gettext_php_load_strings();
-    }
-    
-    /* Try finding the exact string */
-    if (isset($gettext_php_translateStrings[$str])) {
-        return $gettext_php_translateStrings[$str];
-    }
-    
-    /* See if we should short-circuit */
-    if ($gettext_php_short_circuit) {
-        $gettext_php_translateStrings[$str] = $str;
+    global $l10n, $gettext_domain;
+    if (! isset($l10n[$gettext_domain]) ||
+        ! is_object($l10n[$gettext_domain]) ||
+        $l10n[$gettext_domain]->error==1)
         return $str;
-    }
-    
-    /* Look for a string that is very close to the one we want
-       Very computationally expensive */
-    $oldPercent = 0;
-    $oldStr = '';
-    $newPercent = 0;
-    foreach ($gettext_php_translateStrings as $k => $v) {
-        similar_text($str, $k, $newPercent);
-        if ($newPercent > $oldPercent) {
-            $oldStr = $v;
-            $oldPercent = $newPercent;
-        }
-    }
-    /* Require 80% match or better
-       Adjust to suit your needs */
-    if ($oldPercent > 80) {
-        /* Remember this so we don't need to search again */
-        $gettext_php_translateStrings[$str] = $oldStr;
-        return $oldStr;
-    }
-    
-    /* Remember this so we don't need to search again */
-    $gettext_php_translateStrings[$str] = $str;
-    return $str;
+    return $l10n[$gettext_domain]->translate($str);
 }
 
-function bindtextdomain($name, $dir) {
-    global $gettext_php_domain, $gettext_php_dir, $gettext_php_loaded;
-    
-    if ($gettext_php_domain != $name) {
-        $gettext_php_domain = $name;
-        $gettext_php_loaded = false;
-    }
-    if ($gettext_php_dir != $dir) {
-        $gettext_php_dir = $dir;
-        $gettext_php_loaded = false;
-    }
-    
+/**
+ * Alternative php bindtextdomain function
+ *
+ * Sets path to directory containing domain translations
+ *
+ * @link http://www.php.net/function.bindtextdomain
+ * @param string $domain gettext domain name
+ * @param string $dir directory that contains all translations
+ * @return string path to translation directory
+ * @since 1.1.2
+ */
+function bindtextdomain($domain, $dir) {
+    global $l10n, $sm_notAlias;
+    if (substr($dir, -1) != '/') $dir .= '/';
+    $mofile=$dir . $sm_notAlias . '/LC_MESSAGES/' . $domain . '.mo';
+
+    $input = new FileReader($mofile);
+    $l10n[$domain] = new gettext_reader($input);
+
     return $dir;
 }
 
+/**
+ * Alternative php textdomain function
+ *
+ * Sets default domain name. Before 1.5.1 command required
+ * bindtextdomain() call for each gettext domain change.
+ *
+ * @link http://www.php.net/function.textdomain
+ * @param string $name gettext domain name
+ * @return string gettext domain name
+ * @since 1.1.2
+ */
 function textdomain($name = false) {
-    global $gettext_php_domain, $gettext_php_loaded;
-    
-    if ($name != false && $gettext_php_domain != $name) {
-        $gettext_php_domain = $name;
-        $gettext_php_loaded = false;
-    }
-    return $gettext_php_domain;
+    global $gettext_domain;
+    if ($name) $gettext_domain=$name;
+    return $gettext_domain;
 }
 
-?>
+/**
+ * Safety check.
+ * Setup where three standard gettext functions don't exist and dgettext() exists.
+ */
+if (! function_exists('dgettext')) {
+    /**
+     * Alternative php dgettext function
+     *
+     * @link http://www.php.net/function.dgettext
+     * @param string $domain Gettext domain
+     * @param string $str English string
+     * @return string translated string
+     * @since 1.5.1
+     */
+    function dgettext($domain, $str) {
+        global $l10n;
+        if (! isset($l10n[$domain]) ||
+            ! is_object($l10n[$domain]) ||
+            $l10n[$domain]->error==1)
+            return $str;
+        return $l10n[$domain]->translate($str);
+    }
+}