locale.module 12.3 KB
Newer Older
Dries's avatar
 
Dries committed
1
<?php
2
// $Id$
Dries's avatar
 
Dries committed
3

Dries's avatar
 
Dries committed
4
function locale_help() {
Dries's avatar
 
Dries committed
5
 ?>
Dries's avatar
 
Dries committed
6
  <p>Normally programs are written and documented in English, and use English to interact with users.  This is true for a great deal of websites.  However, most people are less comfortable with English than with their own native language, and would prefer to use their mother tongue as much as possible.  Many people love see their website showing a lot less of English, and far more of their own language.</p>
Dries's avatar
 
Dries committed
7
  <p>Therefore Drupal provides a framework to setup a multi-lingual website, or to overwrite the default texts in English.  We explored the various alternatives to support internationalization and decided to design the framework in such a way that the impact of internationalization on drupal's sources is minimized, modular and that it doesn't require a HTML or PHP wizard to maintain translations.  Maintaining translations had to be simple so it became as easy as filling out forms on the administration page.</p>
Dries's avatar
 
Dries committed
8

Dries's avatar
 
Dries committed
9
  <h3>How to translate texts</h3>
Dries's avatar
 
Dries committed
10

Dries's avatar
 
Dries committed
11 12 13 14 15 16 17
  <p>The actual translation starts at the "overview" of the locale page of the administration pages.  To allow a user to maintain the translations, he obviously needs access to the locale module.  See the account documentation for more information on roles and permissions.</p>
  <p>At the locale page, users with the proper access rights will see the various texts that need translation on the left column of the table.</p>
  <p>Below the text you can see an URI where this text shows up one your site.  Changes are most of these texts will be used and displayed on more than one page, though only one example URI is presented.</p>
  <p>The second column displays the supported languages as defined in the configuration file.  See below for more information on how to support new languages.  If the symbol for a language is seen like <strike>this</strike>, it means that this entry still needs to be translated into that language.  If not, it has been translated already.</p>
  <p>To add or change a translation click the "edit locale" link in the third column, the "operations" column.  You'll be presented the original text and fields for translation in the supported languages.  Enter the translations and confirm by clicking the "Save translations" button.  The translations need not be accurate; they are for your site so you can choose what to show to your users.</p>
  <p>To delete a translation, click the "delete locale" link at the overview page and the translation will be immediately deleted without confirmation.  Deleting translations is convenient for removing texts that belonged to an obsolete module.</p>
  <p>In some texts special strings such as "%a" and "%b" show up.  Those get replaced by some string at run-time when Drupal dynamically generate pages.  You can find out which string this is by looking at the page where the text appears.  This is where the above mentioned URI can come in handy.</p>
Dries's avatar
 
Dries committed
18

Dries's avatar
 
Dries committed
19
  <h3>How to add new languages</h3>
Dries's avatar
 
Dries committed
20

Dries's avatar
 
Dries committed
21 22
  <p>Adding a new language requires you to edit your configuration file and to edit your SQL database.  Assuming you want to support Dutch (ISO 639 code: "nl") and French (ISO 639 code: "fr"), you add the following line to your configuration file's <code>$languages</code>-variable:</p>
  <pre>
Dries's avatar
 
Dries committed
23
    $languages = array("nl" => "Dutch / Nederlands", "fr" => "French / Francais");
Dries's avatar
 
Dries committed
24 25 26
  </pre>
  <p>Note that the default language must come first and that if you want to overwrite the default text you can add an entry for English (ISO 639 code: "en"):</p>
  <pre>
Dries's avatar
 
Dries committed
27
    $languages = array("en" => "English", "nl" => "Dutch / Nederlands", "fr" => "French / Francais");
Dries's avatar
 
Dries committed
28 29 30
  </pre>
  <p>After having edited your configuration file, make sure your SQL table "locales" has the required database fields setup to host your new translations.  You can add the required rows to your "locales" table from the MySQL prompt:</p>
  <pre>
Dries's avatar
 
Dries committed
31 32 33
    mysql> ALTER TABLE locales ADD en TEXT DEFAULT '' NOT NULL;
    mysql> ALTER TABLE locales ADD nl TEXT DEFAULT '' NOT NULL;
    mysql> ALTER TABLE locales ADD fr TEXT DEFAULT '' NOT NULL;
Dries's avatar
 
Dries committed
34
  </pre>
Dries's avatar
 
Dries committed
35
 <?php
Dries's avatar
 
Dries committed
36 37
}

38
function locale_system($field){
Kjartan's avatar
Kjartan committed
39
  $system["description"] = t("Enables the translation of the user interface to languages other than English.");
40 41 42
  return $system[$field];
}

Dries's avatar
 
Dries committed
43
function locale_perm() {
Dries's avatar
 
Dries committed
44 45 46 47
  return array("administer locales");
}

function locale_link($type) {
Dries's avatar
 
Dries committed
48 49
  global $languages;

Dries's avatar
 
Dries committed
50
  if ($type == "admin" && user_access("administer locales")) {
Dries's avatar
 
Dries committed
51 52 53 54 55 56 57
    $help["general"] = "To be written: description of locale module.  Anyone?";

    menu("admin/locale", "localization", NULL, $help["general"], 5);
    menu("admin/locale/search", "search string", "locale_admin", NULL, 8);
    menu("admin/locale/help", "help", "locale_help", NULL, 9);
    menu("admin/locale/edit", "edit string", "locale_admin", NULL, 0, 1); // hidden menu
    menu("admin/locale/delete", "delete string", "locale_admin", NULL, 0, 1); // hidden menu
Dries's avatar
 
Dries committed
58

Dries's avatar
 
Dries committed
59
    foreach ($languages as $key => $value) {
Dries's avatar
 
Dries committed
60 61 62
      menu("admin/locale/$key", "$value", NULL, $help["general"]);
      menu("admin/locale/$key/translated", "translated strings", "locale_admin");
      menu("admin/locale/$key/untranslated", "untranslated strings", "locale_admin");
Dries's avatar
 
Dries committed
63 64
    }
  }
Dries's avatar
 
Dries committed
65 66
}

Dries's avatar
 
Dries committed
67
function locale_delete($lid) {
Dries's avatar
Dries committed
68
  db_query("DELETE FROM locales WHERE lid = '%d'", $lid);
Dries's avatar
 
Dries committed
69
  locale_refresh_cache();
Dries's avatar
 
Dries committed
70 71

  return t("deleted string");
Dries's avatar
 
Dries committed
72 73
}

Dries's avatar
 
Dries committed
74 75
function locale_save($lid) {
  global $edit;
Dries's avatar
 
Dries committed
76
  foreach ($edit as $key=>$value) {
Dries's avatar
Dries committed
77
    db_query("UPDATE locales SET $key = '%s' WHERE lid = '%d'", $value, $lid);
Dries's avatar
 
Dries committed
78 79
  }
  locale_refresh_cache();
Dries's avatar
 
Dries committed
80 81
  // delete form data so it will remember where it came from
  $edit = '';
Dries's avatar
 
Dries committed
82 83

  return t("saved string");
Dries's avatar
 
Dries committed
84 85 86 87 88 89
}

function locale_refresh_cache() {
  global $languages;

  foreach (array_keys($languages) as $locale) {
Dries's avatar
 
Dries committed
90
    $result = db_query("SELECT string, %s FROM locales", $locale);
Dries's avatar
 
Dries committed
91
    while ($data = db_fetch_object($result)) {
92 93 94 95 96 97
      if (empty($data->$locale)) {
        $t[$data->string] = $data->string;
      }
      else {
        $t[$data->string] = $data->$locale;
      }
Dries's avatar
 
Dries committed
98 99
    }
    cache_set("locale:$locale", serialize($t));
Dries's avatar
 
Dries committed
100 101 102
  }
}

Dries's avatar
 
Dries committed
103
function locale_edit($lid) {
Dries's avatar
 
Dries committed
104
  global $languages;
Dries's avatar
 
Dries committed
105

Dries's avatar
 
Dries committed
106
  $result = db_query("SELECT * FROM locales WHERE lid = '$lid'");
Dries's avatar
 
Dries committed
107
  if ($translation = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
108
    $form .= form_item(t("Original text"), "<pre>". wordwrap($translation->string) ."</pre>");
Dries's avatar
 
Dries committed
109
    foreach ($languages as $code=>$language) $form .= (strlen($translation->string) > 30) ? form_textarea($language, $code, $translation->$code, 50, 10) : form_textfield($language, $code, $translation->$code, 50, 128);
Dries's avatar
 
Dries committed
110
    $form .= form_submit(t("Save translations"));
Dries's avatar
 
Dries committed
111

Dries's avatar
 
Dries committed
112
    return form($form);
Dries's avatar
 
Dries committed
113 114 115 116
  }
}

function locale_languages($translation) {
Dries's avatar
 
Dries committed
117 118
  global $languages;

Dries's avatar
 
Dries committed
119 120
  foreach ($languages as $key => $value) {
    $output .= ($translation->$key) ? "<a href=\"#\" title=\"". $translation->$key ."\">$key</a> " : "<strike>$key</strike> ";
Dries's avatar
 
Dries committed
121 122 123 124 125
  }

  return $output;
}

Kjartan's avatar
Kjartan committed
126
function locale_seek() {
Dries's avatar
 
Dries committed
127
  global $id, $edit, $languages, $op, $locale_settings;
Kjartan's avatar
Kjartan committed
128

Dries's avatar
 
Dries committed
129
  if ($op != 'overview' && !$edit && session_is_registered("locale_settings")) {
Kjartan's avatar
Kjartan committed
130 131
    $edit = $locale_settings;
  }
Dries's avatar
 
Dries committed
132
  else {
Kjartan's avatar
Kjartan committed
133 134
    $locale_settings = $edit;
    session_register("locale_settings");
Dries's avatar
 
Dries committed
135 136
  }

137
  if (is_array($edit)) {
Dries's avatar
 
Dries committed
138 139 140

    if ($edit["status"]) {
      switch ($edit["language"]) {
Kjartan's avatar
Kjartan committed
141 142
        case "all":
          foreach ($languages as $key=>$value) {
Dries's avatar
 
Dries committed
143
            $tmp[] = $key . (check_query($edit["status"]) == 1 ? " !=" : " =") ." ''";
Kjartan's avatar
Kjartan committed
144 145 146 147 148
          }
          $query[] = implode(" && ", $tmp);
          break;
        case "any":
          foreach ($languages as $key=>$value) {
Dries's avatar
 
Dries committed
149
            $tmp[] = $key . (check_query($edit["status"]) == 1 ? " !=" : " =") ." ''";
Kjartan's avatar
Kjartan committed
150 151 152 153
          }
          $query[] = "(". implode(" || ", $tmp) .")";
          break;
        default:
Dries's avatar
 
Dries committed
154
          $query[] = check_query($edit["language"]) . (check_query($edit["status"]) == 1 ? " !=" : " =") ." ''";
Kjartan's avatar
Kjartan committed
155 156
      }
    }
Dries's avatar
 
Dries committed
157

Dries's avatar
 
Dries committed
158 159 160 161 162 163 164 165
    if ($edit["module"]) {
      $query[] = "location LIKE '%mod=". (check_query($edit["module"]) != "all" ? check_query($edit["module"]) : "") ."%'";
    }

    if ($edit["string"]) {
      $string_query[] = "string LIKE '%". check_query($edit["string"]) ."%'";
      if ($edit["status"] != 2) {
        if (strlen($edit["language"]) == 2) {
Kjartan's avatar
Kjartan committed
166
          $string_query[] = check_query($edit["language"]) ." LIKE '%". check_query($edit["string"]) ."%'";
Dries's avatar
 
Dries committed
167 168 169
        }
        else {
          foreach ($languages as $key=>$value) {
Kjartan's avatar
Kjartan committed
170
            $string_query[] = check_query($key) ." LIKE '%". check_query($edit["string"]) ."%'";
Dries's avatar
 
Dries committed
171 172 173
          }
        }
      }
Kjartan's avatar
Kjartan committed
174
      $query[] = "(". implode(" || ", $string_query) .")";
Dries's avatar
 
Dries committed
175 176
    }

Kjartan's avatar
Kjartan committed
177
    $result = db_query("SELECT * FROM locales". (count($query) ? " WHERE ". implode(" && ", $query) : "") ." ORDER BY string");
Dries's avatar
 
Dries committed
178

Dries's avatar
 
Dries committed
179
    $header = array(t("string"), (($edit["status"] != 2 && strlen($edit["language"]) == 2) ? t("translated string") : t("languages")), array("data" => t("operations"), "colspan" => "2"));
Kjartan's avatar
Kjartan committed
180
    while ($locale = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
181
      $rows[] = array("$locale->string<br /><small><i>$locale->location</i></small>", array("data" => (($edit["status"] != 2 && strlen($edit["language"]) == 2) ? $locale->$edit["language"] : locale_languages($locale)), "align" => "center"), array("data" => l(t("edit locale"), "admin/locale/edit/$locale->lid"), "nowrap" => "nowrap"), array("data" => l(t("delete locale"), "admin/locale/delete/$locale->lid"), "nowrap" => "nowrap"));
Kjartan's avatar
Kjartan committed
182
    }
Dries's avatar
 
Dries committed
183
    $output .= table($header, $rows);
Kjartan's avatar
Kjartan committed
184
  }
Kjartan's avatar
Kjartan committed
185

Dries's avatar
 
Dries committed
186 187
  reset($languages);

Dries's avatar
 
Dries committed
188 189 190 191 192
  $form .= form_textfield(t("String"), "string", $edit["string"], 30, 30, t("Leave blank to show all strings. This is treated as a regular expression."));
  $form .= form_select(t("Language"), "language", ($edit["language"] ? $edit["language"] : key($languages)), array_merge(array("any" => t("Any language"), "all" => t("All languages")), $languages), t("In which language must the string be translated/untranslated (see status)?"));
  $form .= form_select(t("Status"), "status", $edit["status"], array(2 => t("Untranslated"), 1 => t("Translated"), 0 => t("All")));
  $form .= form_select(t("Module"), "module", $edit["module"], array_merge(array("0" => t("All modules + pages"), "all" => t("All modules")), module_list()));
  $form .= form_submit(t("Search"));
Dries's avatar
 
Dries committed
193

Dries's avatar
 
Dries committed
194
  $output .= form($form);
Kjartan's avatar
Kjartan committed
195 196 197 198

  return $output;
}

Dries's avatar
 
Dries committed
199
function locale_admin() {
Dries's avatar
 
Dries committed
200
  global $op, $edit;
Dries's avatar
 
Dries committed
201

Dries's avatar
 
Dries committed
202
  if (user_access("administer locales")) {
Steven Wittens's avatar
Steven Wittens committed
203 204
    locale_admin_initialize();

Dries's avatar
 
Dries committed
205 206 207
    if (empty($op)) {
      $op = arg(2);
    }
Dries's avatar
 
Dries committed
208 209 210

    switch ($op) {
      case "delete":
Dries's avatar
 
Dries committed
211
        print status(locale_delete(check_query(arg(3))));
Dries's avatar
 
Dries committed
212
        print locale_seek();
Dries's avatar
 
Dries committed
213 214
        break;
      case "edit":
Dries's avatar
 
Dries committed
215
        print locale_edit(check_query(arg(3)));
Dries's avatar
 
Dries committed
216
        break;
217
      case "search":
Dries's avatar
 
Dries committed
218
      case t("Search"):
Dries's avatar
 
Dries committed
219 220
        print locale_seek();
        break;
Dries's avatar
 
Dries committed
221 222
      case t("Save translations"):
        print status(locale_save(check_query(arg(3))));
Dries's avatar
 
Dries committed
223
        print locale_seek();
Kjartan's avatar
Kjartan committed
224
        break;
Dries's avatar
 
Dries committed
225
      default:
Dries's avatar
 
Dries committed
226 227 228 229 230 231 232 233 234 235
        if (arg(3) == "translated") {
          $edit["status"] = 1;
          $edit["language"] = arg(2);
          print locale_seek();
        }
        else {
          $edit["status"] = 2;
          $edit["language"] = arg(2);
          print locale_seek();
        }
Dries's avatar
 
Dries committed
236 237 238 239
    }
  }
  else {
    print message_access();
Dries's avatar
 
Dries committed
240 241 242
  }
}

Steven Wittens's avatar
Steven Wittens committed
243
function locale_admin_initialize() {
Dries's avatar
 
Dries committed
244 245 246 247 248
  /*
  ** This function inserts common strings into the locale table (eg.
  ** names of months and days).  We use $revision and a stored variable
  ** to track if the locale table is up-to-date.
  */
Steven Wittens's avatar
Steven Wittens committed
249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267

  $revision = 1;

  if (variable_get("locale_initialize_revision", 0) < $revision) {
    variable_set("locale_initialize_revision", $revision);
    for ($i = 1; $i <= 12; $i++) {
      $stamp = mktime(0, 0, 0, $i, 1, 1971);
      t(date("F", $stamp));
      t(date("M", $stamp));
    }

    for ($i = 0; $i <= 7; $i++) {
      $stamp = $i * 86400;
      t(date("D", $stamp));
      t(date("l", $stamp));
    }
  }
}

Dries's avatar
 
Dries committed
268 269
function locale($string) {
  global $locale;
Dries's avatar
 
Dries committed
270 271
  static $locale_t;

Dries's avatar
 
Dries committed
272
  if (!isset($locale_t)) {
Dries's avatar
 
Dries committed
273
    $cache = cache_get("locale:$locale");
274 275 276
    if ($cache == 0) {
      locale_refresh_cache();
      $cache = cache_get("locale:$locale");
Dries's avatar
 
Dries committed
277
    }
278
    $locale_t = unserialize($cache->data);
Dries's avatar
 
Dries committed
279
  }
Dries's avatar
 
Dries committed
280

Dries's avatar
 
Dries committed
281
  if ($locale_t[$string] != "") {
Dries's avatar
 
Dries committed
282
    $string = $locale_t[$string];
Dries's avatar
 
Dries committed
283 284 285 286
  }
  else {
    $result = db_query("SELECT lid, $locale FROM locales WHERE string = '%s'", $string);
    if (!db_fetch_object($result)) {
287
      db_query("INSERT INTO locales (string, location) VALUES ('%s', '%s')", $string, request_uri());
288
      cache_clear_all("locale:$locale");
Dries's avatar
 
Dries committed
289
    }
Dries's avatar
Dries committed
290
  }
Dries's avatar
 
Dries committed
291

Dries's avatar
 
Dries committed
292 293
  return $string;
}
Dries's avatar
 
Dries committed
294

Dries's avatar
Dries committed
295
?>