X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=functions%2Fgettext.php;h=f11f13f426b0e3a90da56715b6fd2c8404e9d570;hp=852f4c346831ef099a935904c2f087451e26314f;hb=eb19bc676326931545976b817f594025ed13eec0;hpb=55c10992cd9f162e50a44c5216bc135103e83fc5

diff --git a/functions/gettext.php b/functions/gettext.php
index 852f4c34..f11f13f4 100644
--- a/functions/gettext.php
+++ b/functions/gettext.php
@@ -1,180 +1,251 @@
-<?PHP
+<?php
+/**
+ * SquirrelMail internal gettext functions
+ *
+ * Copyright (c) 1999-2004 The SquirrelMail Project Team
+ * Licensed under the GNU GPL. For full terms see the file COPYING.
+ *
+ * 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
+ *
+ * @link http://www.php.net/gettext Original php gettext manual
+ * @version $Id$
+ * @package squirrelmail
+ * @subpackage i18n
+ */
 
-   /* 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
-    *
-    * Very special thanks to Konstantin Riabitsev for letting me use a
-    * server that didn't already have gettext on it!
-    */
-     
-   if (defined('gettext_php'))
-      return;
-   define('gettext_php', true);
-   
-   global $gettext_php_domain, $gettext_php_dir, $gettext_php_loaded,
-      $gettext_php_translateStrings, $gettext_php_loaded_language;
-   
-   if (! isset($gettext_php_loaded)) {
-      $gettext_php_loaded = false;
-      session_register('gettext_php_loaded');
-   }
-   if (! isset($gettext_php_domain)) {
-      $gettext_php_domain = '';
-      session_register('gettext_php_domain');
-   }
-   if (! isset($gettext_php_dir)) {
-      $gettext_php_dir = '';
-      session_register('gettext_php_dir');
-   }
-   if (! isset($gettext_php_translateStrings)) {
-      $gettext_php_translateStrings = array();
-      session_register('gettext_php_translateStrings');
-   }
-   if (! isset($gettext_php_loaded_language)) {
-      $gettext_php_loaded_language = '';
-      session_register('gettext_php_loaded_language');
-   }
+/** Almost everything requires global.php... */
+require_once(SM_PATH . 'functions/global.php');
 
-   function gettext_php_load_strings() {
-      global $squirrelmail_language, $gettext_php_translateStrings,
-         $gettext_php_domain, $gettext_php_dir, $gettext_php_loaded,
-         $gettext_php_loaded_language;
-      
-      // $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();
+global $gettext_php_domain, $gettext_php_dir, $gettext_php_loaded,
+ $gettext_php_translateStrings, $gettext_php_loaded_language,
+ $gettext_php_short_circuit;
 
-      $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.  :-)
-         $gettext_php_loaded = true;
-         return;
-      }
-	  
-      $key = '';
-      $SkipRead = false;
-      while (! feof($file)) {
-         if (! $SkipRead)
+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');
+}
+
+/**
+ * Converts .po file into array and stores it in session.
+ *
+ * Used internally by _($str) function
+ *
+ * @internal function is used internally by functions/gettext.php code
+ */
+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];
-	    }
+        } 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]);
-	    $key = '';
-	 }
-      }
-      fclose($file);
-
-      $gettext_php_loaded = true;
-      $gettext_php_loaded_language = $squirrelmail_language;
-   }
-
-   function _($str) {
-      global $gettext_php_loaded, $gettext_php_translateStrings, 
-         $squirrelmail_language, $gettext_php_loaded_language;
-	 
-      if (! $gettext_php_loaded || 
-          $gettext_php_loaded_language != $squirrelmail_language)
-         gettext_php_load_strings();
+                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;
+}
 
-      // Try finding the exact string      
-      if (isset($gettext_php_translateStrings[$str]))
-         return $gettext_php_translateStrings[$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) {
+/**
+ * Alternative php gettext function (short form)
+ *
+ * @link http://www.php.net/function.gettext
+ *
+ * @param string $str English string
+ * @return string translated string
+ */
+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;
+        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;
-   }
-   
-   function bindtextdomain($name, $dir) {
-      global $gettext_php_domain, $gettext_php_dir, $gettext_php_loaded;
+        }
+    }
+    /* 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;
+}
+
+/**
+ * Alternative php bindtextdomain function
+ *
+ * Sets path to directory containing domain translations
+ *
+ * @link http://www.php.net/function.bindtextdomain
+ * @param string $name gettext domain name
+ * @param string $dir directory that contains all translations
+ * @return string path to translation directory
+ */
+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;
+    }
+    
+    return $dir;
+}
 
-      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;
-      }
-      
-      return $dir;
-   }
-   
-   function textdomain($name = false) {
-      global $gettext_php_domain, $gettext_php_loaded;
+/**
+ * Alternative php textdomain function
+ *
+ * Sets default domain name
+ *
+ * @link http://www.php.net/function.textdomain
+ * @param string $name gettext domain name
+ * @return string gettext domain name
+ */
+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;
+    }
 
-      if ($name != false && $gettext_php_domain != $name) {
-         $gettext_php_domain = $name;
-	 $gettext_php_loaded = false;
-      }
-      return $gettext_php_domain;
-   }
-   
+    return $gettext_php_domain;
+}
+?>
\ No newline at end of file