functions/gettext.php

   1 <?PHP
   2
   3 /**
   4  * gettext.php
   5  *
   6  * Copyright (c) 1999-2002 The SquirrelMail Project Team
   7  * Licensed under the GNU GPL. For full terms see the file COPYING.
   8  *
   9  * Alternate to the system's built-in gettext.
  10  * relies on .po files (can't read .mo easily).
  11  * Uses the session for caching (speed increase)
  12  * Possible use in other PHP scripts?  The only SM-specific thing is
  13  *   $sm_language, I think
  14  *
  15  * $Id$
  16  */
  17
  18 /*****************************************************************/
  19 /*** THIS FILE NEEDS TO HAVE ITS FORMATTING FIXED!!!           ***/
  20 /*** PLEASE DO SO AND REMOVE THIS COMMENT SECTION.             ***/
  21 /***    + Base level indent should begin at left margin, as    ***/
  22 /***      the global definition below.                         ***/
  23 /***    + All identation should consist of four space blocks   ***/
  24 /***    + Tab characters are evil.                             ***/
  25 /***    + all comments should use "slash-star ... star-slash"  ***/
  26 /***      style -- no pound characters, no slash-slash style   ***/
  27 /***    + FLOW CONTROL STATEMENTS (if, while, etc) SHOULD      ***/
  28 /***      ALWAYS USE { AND } CHARACTERS!!!                     ***/
  29 /***    + Please use ' instead of ", when possible. Note "     ***/
  30 /***      should always be used in _( ) function calls.        ***/
  31 /*** Thank you for your help making the SM code more readable. ***/
  32 /*****************************************************************/
  33
  34 global $gettext_php_domain, $gettext_php_dir, $gettext_php_loaded,
  35        $gettext_php_translateStrings, $gettext_php_loaded_language,
  36        $gettext_php_short_circuit;
  37
  38    if (! isset($gettext_php_loaded)) {
  39       $gettext_php_loaded = false;
  40       session_register('gettext_php_loaded');
  41    }
  42    if (! isset($gettext_php_domain)) {
  43       $gettext_php_domain = '';
  44       session_register('gettext_php_domain');
  45    }
  46    if (! isset($gettext_php_dir)) {
  47       $gettext_php_dir = '';
  48       session_register('gettext_php_dir');
  49    }
  50    if (! isset($gettext_php_translateStrings)) {
  51       $gettext_php_translateStrings = array();
  52       session_register('gettext_php_translateStrings');
  53    }
  54    if (! isset($gettext_php_loaded_language)) {
  55       $gettext_php_loaded_language = '';
  56       session_register('gettext_php_loaded_language');
  57    }
  58    if (! isset($gettext_php_short_circuit)) {
  59       $gettext_php_short_circuit = false;
  60       session_register('gettext_php_short_circuit');
  61    }
  62
  63    function gettext_php_load_strings() {
  64       global $squirrelmail_language, $gettext_php_translateStrings,
  65          $gettext_php_domain, $gettext_php_dir, $gettext_php_loaded,
  66          $gettext_php_loaded_language, $gettext_php_short_circuit;
  67
  68       // $squirrelmail_language gives 'en' for English, 'de' for German,
  69       // etc.  I didn't wanna use getenv or similar, but you easily could
  70       // change my code to do that.
  71
  72       $gettext_php_translateStrings = array();
  73
  74       $gettext_php_short_circuit = false;  // initialization
  75
  76       $filename = $gettext_php_dir;
  77       if (substr($filename, -1) != '/')
  78          $filename .= '/';
  79       $filename .= $squirrelmail_language . '/LC_MESSAGES/' .
  80          $gettext_php_domain . '.po';
  81
  82       $file = @fopen($filename, 'r');
  83       if ($file == false) {
  84          // Uh-ho -- we can't load the file.  Just fake it.  :-)
  85          // This is also for English, which doesn't use translations
  86          $gettext_php_loaded = true;
  87          $gettext_php_loaded_language = $squirrelmail_language;
  88          $gettext_php_short_circuit = true;  // Avoid fuzzy matching when we
  89                                              // didn't load strings
  90          return;
  91       }
  92
  93       $key = '';
  94       $SkipRead = false;
  95       while (! feof($file)) {
  96          if (! $SkipRead)
  97             $line = trim(fgets($file, 4096));
  98          else
  99             $SkipRead = false;
 100
 101          if (ereg('^msgid "(.*)"$', $line, $match)) {
 102             if ($match[1] == '') {
 103                // Potential multi-line
 104                // msgid ""
 105                // "string string "
 106                // "string string"
 107                $key = '';
 108                $line = trim(fgets($file, 4096));
 109                while (ereg('^[ ]*"(.*)"[ ]*$', $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 (ereg('^msgstr "(.*)"$', $line, $match)) {
 119             if ($match[1] == '') {
 120                // Potential multi-line
 121                // msgstr ""
 122                // "string string "
 123                // "string string"
 124                $gettext_php_translateStrings[$key] = '';
 125                $line = trim(fgets($file, 4096));
 126                while (ereg('^[ ]*"(.*)"[ ]*$', $line, $match)) {
 127                   $gettext_php_translateStrings[$key] .= $match[1];
 128                   $line = trim(fgets($file, 4096));
 129                }
 130                $SkipRead = true;
 131             } else {
 132                // msgstr "string string"
 133                $gettext_php_translateStrings[$key] = $match[1];
 134             }
 135             $gettext_php_translateStrings[$key] =
 136                stripslashes($gettext_php_translateStrings[$key]);
 137             // If there is no translation, just use the untranslated string
 138             if ($gettext_php_translateStrings[$key] == '')
 139                $gettext_php_translateStrings[$key] = $key;
 140             $key = '';
 141          }
 142       }
 143       fclose($file);
 144
 145       $gettext_php_loaded = true;
 146       $gettext_php_loaded_language = $squirrelmail_language;
 147    }
 148
 149    function _($str) {
 150       global $gettext_php_loaded, $gettext_php_translateStrings,
 151          $squirrelmail_language, $gettext_php_loaded_language,
 152          $gettext_php_short_circuit;
 153
 154       if (! $gettext_php_loaded ||
 155           $gettext_php_loaded_language != $squirrelmail_language)
 156          gettext_php_load_strings();
 157
 158       // Try finding the exact string
 159       if (isset($gettext_php_translateStrings[$str]))
 160          return $gettext_php_translateStrings[$str];
 161
 162       // See if we should short-circuit
 163       if ($gettext_php_short_circuit) {
 164          $gettext_php_translateStrings[$str] = $str;
 165          return $str;
 166       }
 167
 168       // Look for a string that is very close to the one we want
 169       // Very computationally expensive
 170       $oldPercent = 0;
 171       $oldStr = '';
 172       $newPercent = 0;
 173       foreach ($gettext_php_translateStrings as $k => $v) {
 174          similar_text($str, $k, $newPercent);
 175          if ($newPercent > $oldPercent) {
 176             $oldStr = $v;
 177             $oldPercent = $newPercent;
 178          }
 179       }
 180       // Require 80% match or better
 181       // Adjust to suit your needs
 182       if ($oldPercent > 80) {
 183          // Remember this so we don't need to search again
 184          $gettext_php_translateStrings[$str] = $oldStr;
 185          return $oldStr;
 186       }
 187
 188       // Remember this so we don't need to search again
 189       $gettext_php_translateStrings[$str] = $str;
 190       return $str;
 191    }
 192
 193    function bindtextdomain($name, $dir) {
 194       global $gettext_php_domain, $gettext_php_dir, $gettext_php_loaded;
 195
 196       if ($gettext_php_domain != $name) {
 197          $gettext_php_domain = $name;
 198          $gettext_php_loaded = false;
 199       }
 200       if ($gettext_php_dir != $dir) {
 201          $gettext_php_dir = $dir;
 202          $gettext_php_loaded = false;
 203       }
 204
 205       return $dir;
 206    }
 207
 208    function textdomain($name = false) {
 209       global $gettext_php_domain, $gettext_php_loaded;
 210
 211       if ($name != false && $gettext_php_domain != $name) {
 212          $gettext_php_domain = $name;
 213          $gettext_php_loaded = false;
 214       }
 215       return $gettext_php_domain;
 216    }
 217