locale.module 14.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($section = "admin/help#locale") {
Dries's avatar
 
Dries committed
5

Dries's avatar
 
Dries committed
6
  switch ($section) {
Dries's avatar
 
Dries committed
7
    case 'admin/help#locale':
Dries's avatar
 
Dries committed
8
      return t("
Dries's avatar
 
Dries committed
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
      <p>Most programs are written and documented in English, and use English to interact with users.  This is also true for a great deal of web sites.  However, most people are less comfortable with English than with their native language, and would prefer to use their mother tongue as much as possible.  Many people love see their web site showing a lot less English, and far more of their own language.</p>
      <p>Therefore Drupal provides a framework to setup a multi-lingual web site, or to overwrite the default English texts.  We explored the various alternatives to support internationalization (I18N) and decided to design the framework in such a way that the impact of internationalization on drupal's sources is minimized, modular and 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>
      <h3>How to translate texts</h3>
      <p>The actual translation starts at the <a href=\"%overview\">overview</a> page of the locale section in the administration pages. In the menu on the left under \"localization\" you will see a list of the languages you have configured. Click on the name of the language to start translating. Looking at a page full of all the strings in the site can be a bit overwhelming, so Drupal allows you to limit the strings you are working on. If you want to limit based on translated strings click \"translated strings\", if you want to limit the string based on the untranslated strings click \"untranslated strings\". Both will take you to the same page. Once there enter the string pattern to limit on, choose the language to search for, and the status, weather translated, untranslated or both, finally where you want to look, modules, specific modules, or pages.</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 example URI where this text shows up one your site.  Chances 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>
      <h3>How to add new languages</h3>
      <p>Adding a new language requires you to edit your configuration file and 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>
      \$languages = array(\"nl\" => \"Dutch / Nederlands\", \"fr\" => \"French / Francais\");
      </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>
      \$languages = array(\"en\" => \"English\", \"nl\" => \"Dutch / Nederlands\", \"fr\" => \"French / Francais\");
      </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>", array("%overview" => url("admin/locale")));
Dries's avatar
 
Dries committed
35
      break;
Dries's avatar
 
Dries committed
36
    case 'admin/system/modules#description':
Dries's avatar
 
Dries committed
37
      return t('Enables the translation of the user interface to languages other than English.');
Dries's avatar
 
Dries committed
38
    case 'admin/locale':
Dries's avatar
 
Dries committed
39
      return t('The locale module handles translations into new languages.  It also enables you to add jargon, slang or other special language as fits the web site.  For each language you want to support, a line needs to be added to your configuration file.');
Dries's avatar
 
Dries committed
40
    case 'admin/locale/search':
Dries's avatar
 
Dries committed
41
      return t("Search the localization database. ('*' can be used as a wildcard)");
Dries's avatar
 
Dries committed
42 43
  }

Dries's avatar
 
Dries committed
44 45
}

Dries's avatar
 
Dries committed
46
function locale_help_page() {
Dries's avatar
 
Dries committed
47
  print theme('page', locale_help());
Dries's avatar
 
Dries committed
48 49
}

Dries's avatar
 
Dries committed
50
function locale_perm() {
Dries's avatar
 
Dries committed
51
  return array('administer locales');
Dries's avatar
 
Dries committed
52 53
}

Dries's avatar
 
Dries committed
54 55 56
/**
 * Implementation of hook_link().
 */
Dries's avatar
 
Dries committed
57
function locale_link($type) {
Dries's avatar
 
Dries committed
58 59
  global $languages;

Dries's avatar
 
Dries committed
60 61 62 63 64 65 66 67 68 69 70 71
  if ($type == 'system') {
    $access = user_access('administer locales');
    menu('admin/locale', t('localization'), $access ? 'locale_admin' : MENU_DENIED, 5);
    menu('admin/locale/search', t('search string'), $access ? 'locale_admin' : MENU_DENIED, 8);
    menu('admin/locale/help', t('help'), $access ? 'locale_help_page' : MENU_DENIED, 9);
    menu('admin/locale/edit', t('edit string'), $access ? 'locale_admin' : MENU_DENIED, 0, MENU_HIDE, MENU_LOCKED);
    menu('admin/locale/delete', t('delete string'), $access ? 'locale_admin' : MENU_DENIED, 0, MENU_HIDE, MENU_LOCKED);

    foreach ($languages as $key => $value) {
      menu("admin/locale/$key", "$value", $access ? 'locale_admin' : MENU_DENIED);
      menu("admin/locale/$key/translated", t('translated strings'), $access ? 'locale_admin' : MENU_DENIED);
      menu("admin/locale/$key/untranslated", t('untranslated strings'), $access ? 'locale_admin' : MENU_DENIED);
Dries's avatar
 
Dries committed
72 73
    }
  }
Dries's avatar
 
Dries committed
74 75
}

Dries's avatar
 
Dries committed
76 77
function locale_user($type, &$edit, &$user) {
  global $languages;
78
  if ($type == 'form' && count($languages) > 1) {
79
    return array(t('Locale settings') => form_radios(t("Language"), 'language', $user->language, $languages, t("Selecting a different language will change the language of the site.")));
Dries's avatar
 
Dries committed
80 81 82
  }
}

Dries's avatar
 
Dries committed
83
function locale_delete($lid) {
Dries's avatar
 
Dries committed
84
  db_query("DELETE FROM {locales} WHERE lid = %d", $lid);
Dries's avatar
 
Dries committed
85
  locale_refresh_cache();
Dries's avatar
 
Dries committed
86

Dries's avatar
 
Dries committed
87
  drupal_set_message(t("deleted string"));
Dries's avatar
 
Dries committed
88 89
}

Dries's avatar
 
Dries committed
90
function locale_save($lid) {
Dries's avatar
 
Dries committed
91
  $edit =& $_POST["edit"];
Dries's avatar
 
Dries committed
92
  foreach ($edit as $key => $value) {
Dries's avatar
 
Dries committed
93
    db_query("UPDATE {locales} SET $key = '%s' WHERE lid = %d", $value, $lid);
Dries's avatar
 
Dries committed
94 95
  }
  locale_refresh_cache();
Dries's avatar
 
Dries committed
96 97
  // delete form data so it will remember where it came from
  $edit = '';
Dries's avatar
 
Dries committed
98

Dries's avatar
 
Dries committed
99
  drupal_set_message(t("saved string"));
Dries's avatar
 
Dries committed
100 101 102 103 104 105
}

function locale_refresh_cache() {
  global $languages;

  foreach (array_keys($languages) as $locale) {
Dries's avatar
 
Dries committed
106 107 108 109 110
    /*
    ** We only load short strings into the cache to improve both performance
    ** and memory usages.
    */
    $result = db_query("SELECT string, %s FROM {locales} WHERE LENGTH(string) < 75", $locale);
Dries's avatar
 
Dries committed
111
    while ($data = db_fetch_object($result)) {
112 113 114 115 116 117
      if (empty($data->$locale)) {
        $t[$data->string] = $data->string;
      }
      else {
        $t[$data->string] = $data->$locale;
      }
Dries's avatar
 
Dries committed
118 119
    }
    cache_set("locale:$locale", serialize($t));
Dries's avatar
 
Dries committed
120 121 122
  }
}

Dries's avatar
 
Dries committed
123
function locale_edit($lid) {
Dries's avatar
 
Dries committed
124
  global $languages;
Dries's avatar
 
Dries committed
125

Dries's avatar
 
Dries committed
126
  $result = db_query("SELECT * FROM {locales} WHERE lid = '$lid'");
Dries's avatar
 
Dries committed
127
  if ($translation = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
128

Dries's avatar
 
Dries committed
129
    $form .= form_item(t("Original text"), wordwrap(drupal_specialchars($translation->string, 0)));
Dries's avatar
 
Dries committed
130 131 132 133 134

    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
135
    $form .= form_submit(t('Save translations'));
Dries's avatar
 
Dries committed
136

Dries's avatar
 
Dries committed
137
    return form($form);
Dries's avatar
 
Dries committed
138 139 140 141
  }
}

function locale_languages($translation) {
Dries's avatar
 
Dries committed
142 143
  global $languages;

Dries's avatar
 
Dries committed
144 145
  foreach ($languages as $key => $value) {
    $output .= ($translation->$key) ? "<a href=\"#\" title=\"". $translation->$key ."\">$key</a> " : "<strike>$key</strike> ";
Dries's avatar
 
Dries committed
146 147 148 149 150
  }

  return $output;
}

151
function locale_seek_query() {
Dries's avatar
 
Dries committed
152
  $fields = array("string", 'language', 'status');
153 154 155 156 157 158
  if (is_array($_REQUEST["edit"])) {
    foreach ($_REQUEST["edit"] as $key => $value) {
      if (!empty($value) && in_array($key, $fields)) {
        $query->$key = $value;
      }
    }
Kjartan's avatar
Kjartan committed
159
  }
Dries's avatar
 
Dries committed
160
  else {
161 162 163 164 165
    foreach ($_REQUEST as $key => $value) {
      if (!empty($value) && in_array($key, $fields)) {
        $query->$key = strpos(",", $value) ? explode(",", $value) : $value;
      }
    }
Dries's avatar
 
Dries committed
166
  }
167 168
  return $query;
}
Dries's avatar
 
Dries committed
169

170 171 172 173
function locale_seek() {
  global $id, $languages;
  $op = $_POST["op"];
  $query = locale_seek_query();
Dries's avatar
 
Dries committed
174

175 176 177 178
  if ($query) {

    if ($query->status) {
      switch ($query->language) {
Kjartan's avatar
Kjartan committed
179 180
        case "all":
          foreach ($languages as $key=>$value) {
181
            $tmp[] = $key . (check_query($query->status) == 1 ? " !=" : " =") ." ''";
Kjartan's avatar
Kjartan committed
182
          }
183
          $sql[] = implode(" AND ", $tmp);
Kjartan's avatar
Kjartan committed
184 185 186
          break;
        case "any":
          foreach ($languages as $key=>$value) {
187
            $tmp[] = $key . (check_query($query->status) == 1 ? " !=" : " =") ." ''";
Kjartan's avatar
Kjartan committed
188
          }
Dries's avatar
 
Dries committed
189
          $sql[] = "(". implode(" OR ", $tmp) .")";
Kjartan's avatar
Kjartan committed
190 191
          break;
        default:
192
          $sql[] = check_query($query->language) . (check_query($query->status) == 1 ? " !=" : " =") ." ''";
Kjartan's avatar
Kjartan committed
193 194
      }
    }
Dries's avatar
 
Dries committed
195

196 197 198 199 200
    if ($query->string) {
      $string_query[] = "string LIKE '%". check_query($query->string) ."%'";
      if ($query->status != 2) {
        if (strlen($query->language) == 2) {
          $string_query[] = check_query($query->language) ." LIKE '%". check_query($query->string) ."%'";
Dries's avatar
 
Dries committed
201 202 203
        }
        else {
          foreach ($languages as $key=>$value) {
204
            $string_query[] = check_query($key) ." LIKE '%". check_query($query->string) ."%'";
Dries's avatar
 
Dries committed
205 206 207
          }
        }
      }
Dries's avatar
 
Dries committed
208
      $sql[] = "(". implode(" OR ", $string_query) .")";
Dries's avatar
 
Dries committed
209 210
    }

Dries's avatar
 
Dries committed
211
    $result = pager_query("SELECT * FROM {locales} ". (count($sql) ? " WHERE ". implode(" AND ", $sql) : "") ." ORDER BY string", 50);
Dries's avatar
 
Dries committed
212

213
    $header = array(t("string"), (($query->status != 2 && strlen($query->language) == 2) ? t("translated string") : t("languages")), array("data" => t("operations"), "colspan" => "2"));
Kjartan's avatar
Kjartan committed
214
    while ($locale = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
215
      $rows[] = array("$locale->string<br /><small><i>$locale->location</i></small>", array("data" => (($query->status != 2 && strlen($query->language) == 2) ? $locale->{$query->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
216
    }
217

218 219 220 221 222 223 224
    $request = array();
    if (count($query)) {
      foreach ($query as $key => $value) {
        $request[$key] = (is_array($value)) ? implode(",", $value) : $value;
      }
    }

Dries's avatar
Dries committed
225
    if ($pager = theme("pager", NULL, 50, 0, $request)) {
226
      $rows[] = array(array("data" => "$pager", "colspan" => "5"));
Dries's avatar
 
Dries committed
227 228
    }

Dries's avatar
 
Dries committed
229
    $output .= theme("table", $header, $rows);
230

Kjartan's avatar
Kjartan committed
231
  }
Kjartan's avatar
Kjartan committed
232

Dries's avatar
 
Dries committed
233 234
  return $output;
}
Dries's avatar
 
Dries committed
235

Dries's avatar
 
Dries committed
236 237 238
function locale_seek_form() {
  global $languages;
  $edit =& $_POST["edit"];
Dries's avatar
 
Dries committed
239
  $form .= form_textfield(t("Strings to search for"), "string", $edit["string"], 30, 30, t("Leave blank to show all strings."));
Dries's avatar
 
Dries committed
240
  if (count($languages) > 1) {
Dries's avatar
 
Dries committed
241
    $form .= form_radios(t("Language"), 'language', ($edit['language'] ? $edit['language'] : "all"), array_merge(array("any" => t("Any language"), "all" => t("All languages")), $languages), t("In which language must the string be translated/untranslated (see status)?"));
Dries's avatar
 
Dries committed
242 243 244
  }
  else {
    foreach ($languages as $key => $value) {
Dries's avatar
 
Dries committed
245
      $form .= form_hidden('language', $key);
Dries's avatar
 
Dries committed
246 247
    }
  }
Dries's avatar
 
Dries committed
248 249
  $form .= form_radios(t('Status'), 'status', $edit['status'], array(2 => t('Untranslated'), 1 => t('Translated'), 0 => t('All')));
  $form .= form_submit(t('Search'));
Dries's avatar
 
Dries committed
250

Dries's avatar
 
Dries committed
251
  $output .= form($form);
Kjartan's avatar
Kjartan committed
252 253 254 255

  return $output;
}

Dries's avatar
 
Dries committed
256
function locale_admin() {
Dries's avatar
 
Dries committed
257
  $op = $_POST["op"];
Dries's avatar
 
Dries committed
258
  $edit =& $_POST["edit"];
Dries's avatar
 
Dries committed
259

Dries's avatar
 
Dries committed
260 261 262
  if (empty($op)) {
    $op = arg(2);
  }
Dries's avatar
 
Dries committed
263

Dries's avatar
 
Dries committed
264 265 266 267 268 269 270 271 272 273 274
  switch ($op) {
    case 'delete':
      $output .= locale_delete(check_query(arg(3)));
      $output .= locale_seek();
      break;
    case 'edit':
      $output .= locale_edit(check_query(arg(3)));
      $output .= locale_seek();
      break;
    case 'search':
      if (locale_seek_query()) {
Dries's avatar
 
Dries committed
275
        $output = locale_seek();
Dries's avatar
 
Dries committed
276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
      }
      $output .= locale_seek_form();
      break;
    case t('Search'):
      $output = locale_seek();
      $output .= locale_seek_form();
      break;
    case t('Save translations'):
      $output .= locale_save(check_query(arg(3)));
      $output .= locale_seek_form();
      break;
    default:
      if (arg(3) == 'translated') {
        $edit['status'] = 1;
        $edit['language'] = arg(2);
      }
      else {
        $edit['status'] = 2;
        $edit['language'] = arg(2);
      }
      $output = locale_seek();
      $output .= locale_seek_form();
Dries's avatar
 
Dries committed
298
  }
Dries's avatar
 
Dries committed
299
  print theme('page', $output);
Dries's avatar
 
Dries committed
300 301 302 303
}

function locale($string) {
  global $locale;
Dries's avatar
 
Dries committed
304 305
  static $locale_t;

Dries's avatar
 
Dries committed
306
  if (!isset($locale_t)) {
Dries's avatar
 
Dries committed
307
    $cache = cache_get("locale:$locale");
Dries's avatar
 
Dries committed
308

309 310 311
    if ($cache == 0) {
      locale_refresh_cache();
      $cache = cache_get("locale:$locale");
Dries's avatar
 
Dries committed
312
    }
313
    $locale_t = unserialize($cache->data);
Dries's avatar
 
Dries committed
314
  }
Dries's avatar
 
Dries committed
315

Dries's avatar
 
Dries committed
316
  if (isset($locale_t[$string])) {
Dries's avatar
 
Dries committed
317
    $string = $locale_t[$string];
Dries's avatar
 
Dries committed
318 319
  }
  else {
Dries's avatar
 
Dries committed
320
    $result = db_query("SELECT lid, $locale FROM {locales} WHERE string = '%s'", $string);
Dries's avatar
 
Dries committed
321 322 323 324 325 326 327
    if ($trans = db_fetch_object($result)) {
      if (!empty($trans->$locale)) {
        $locale_t[$string] = $trans->$locale;
        $string = $trans->$locale;
      }
    }
    else {
Dries's avatar
 
Dries committed
328
      db_query("INSERT INTO {locales} (string, location) VALUES ('%s', '%s')", $string, request_uri());
329
      cache_clear_all("locale:$locale");
Dries's avatar
 
Dries committed
330
    }
Dries's avatar
Dries committed
331
  }
Dries's avatar
 
Dries committed
332

Dries's avatar
 
Dries committed
333 334
  return $string;
}
Dries's avatar
 
Dries committed
335

Dries's avatar
Dries committed
336
?>