From 1831e1b690f02d7f551d38ef88a0ba200f786497 Mon Sep 17 00:00:00 2001 From: Dries Buytaert <dries@buytaert.net> Date: Wed, 11 Aug 2004 11:26:20 +0000 Subject: [PATCH] - New locale module thanks to Gerhard, Goba, Marco, Kristjan and others. The new locale module provides every functionality on the web interface, so you don't need to edit the configuration files or add columns, when you add a new language. This module is an integration of the old locale and localegettext modules, plus a bunch of logic to parse Gettext Portable Object files (opposed to Machine Object files, as supported by localegettext). Note: I made some minor changes to the context-sensitive help texts and to some of the status messages. --- database/database.mysql | 50 +- database/database.pgsql | 51 +- database/updates.inc | 85 ++- includes/common.inc | 38 +- includes/conf.php | 9 - includes/locale.inc | 1268 ++++++++++++++++++++++++++++++++++ modules/locale.module | 627 +++++++++-------- modules/locale/locale.module | 627 +++++++++-------- modules/node.module | 5 +- modules/node/node.module | 5 +- update.php | 20 +- 11 files changed, 2197 insertions(+), 588 deletions(-) create mode 100644 includes/locale.inc diff --git a/database/database.mysql b/database/database.mysql index 2e91654f2ca5..75f1b51c5a95 100644 --- a/database/database.mysql +++ b/database/database.mysql @@ -255,24 +255,46 @@ CREATE TABLE history ( ) TYPE=MyISAM; -- --- Table structure for table 'locales' +-- Table structure for table 'locales_meta' -- -CREATE TABLE locales ( - lid int(10) NOT NULL auto_increment, +CREATE TABLE locales_meta ( + locale varchar(12) NOT NULL default '', + name varchar(64) NOT NULL default '', + enabled int(2) NOT NULL default '0', + isdefault int(2) NOT NULL default '0', + plurals int(1) NOT NULL default '0', + formula varchar(128) NOT NULL default '', + PRIMARY KEY (locale) +) TYPE=MyISAM; + +-- +-- Table structure for table 'locales_source' +-- + +CREATE TABLE locales_source ( + lid int(11) NOT NULL auto_increment, location varchar(128) NOT NULL default '', - string blob NOT NULL, - da blob NOT NULL, - fi blob NOT NULL, - fr blob NOT NULL, - en blob NOT NULL, - es blob NOT NULL, - nl blob NOT NULL, - no blob NOT NULL, - sw blob NOT NULL, + source blob NOT NULL, PRIMARY KEY (lid) ) TYPE=MyISAM; +-- +-- Table structure for table 'locales_target' +-- + +CREATE TABLE locales_target ( + lid int(11) NOT NULL default '0', + translation blob NOT NULL, + locale varchar(12) NOT NULL default '', + plid int(11) NOT NULL default '0', + plural int(1) NOT NULL default '0', + KEY lid (lid), + KEY lang (locale), + KEY plid (plid), + KEY plural (plural) +) TYPE=MyISAM; + -- -- Table structure for table 'menu' -- @@ -620,7 +642,7 @@ CREATE TABLE users ( changed int(11) NOT NULL default '0', status tinyint(4) NOT NULL default '0', timezone varchar(8) default NULL, - language char(2) NOT NULL default '', + language varchar(12) NOT NULL default '', picture varchar(255) NOT NULL DEFAULT '', init varchar(64) default '', data longtext, @@ -723,3 +745,5 @@ INSERT INTO filters VALUES (1,'filter',3,1); INSERT INTO filters VALUES (2,'filter',1,0); INSERT INTO filters VALUES (3,'filter',3,0); INSERT INTO variable (name,value) VALUES ('filter_html_1','i:1;'); + +INSERT INTO locales_meta (locale, name, enabled, isdefault) VALUES ('en', 'English', '1', '1'); diff --git a/database/database.pgsql b/database/database.pgsql index 669889f7f804..8092f0d87be1 100644 --- a/database/database.pgsql +++ b/database/database.pgsql @@ -242,24 +242,48 @@ CREATE TABLE history ( ); -- --- Table structure for locales +-- Table structure for locales_meta -- -CREATE TABLE locales ( - lid SERIAL, +CREATE TABLE locales_meta ( + locale varchar(12) NOT NULL default '', + name varchar(64) NOT NULL default '', + enabled int4 NOT NULL default '0', + isdefault int4 NOT NULL default '0', + plurals int4 NOT NULL default '0', + formula varchar(128) NOT NULL default '', + PRIMARY KEY (locale) +); + +-- +-- Table structure for locales_source +-- + +CREATE sequence locales_source_lid_seq; + +CREATE TABLE locales_source ( +lid integer DEFAULT nextval('locales_source_lid_seq'::text) NOT NULL, location varchar(128) NOT NULL default '', - string text NOT NULL default '', - da text NOT NULL default '', - fi text NOT NULL default '', - fr text NOT NULL default '', - en text NOT NULL default '', - es text NOT NULL default '', - nl text NOT NULL default '', - no text NOT NULL default '', - sw text NOT NULL default '', + source text NOT NULL, PRIMARY KEY (lid) ); +-- +-- Table structure for locales_target +-- + +CREATE TABLE locales_target ( + lid int4 NOT NULL default '0', + translation text NOT NULL, + locale varchar(12) NOT NULL default '', + plid int4 NOT NULL default '0', + plural int4 NOT NULL default '0', + UNIQUE (lid), + UNIQUE (locale), + UNIQUE (plid), + UNIQUE (plural) +); + -- -- Table structure for table 'menu' -- @@ -601,7 +625,7 @@ CREATE TABLE users ( changed integer NOT NULL default '0', status smallint NOT NULL default '0', timezone varchar(8) default NULL, - language char(2) NOT NULL default '', + language varchar(12) NOT NULL default '', picture varchar(255) NOT NULL DEFAULT '', init varchar(64) default '', data text default '', @@ -703,6 +727,7 @@ INSERT INTO filters VALUES (2,'filter',1,0); INSERT INTO filters VALUES (3,'filter',3,0); INSERT INTO variable (name,value) VALUES ('filter_html_1','i:1;'); +INSERT INTO locales_meta(locale, name, enabled, isdefault) VALUES('en', 'English', '1', '1'); --- --- Functions diff --git a/database/updates.inc b/database/updates.inc index be5a59b810c9..a2d5400dfb42 100644 --- a/database/updates.inc +++ b/database/updates.inc @@ -70,7 +70,9 @@ "2004-08-04" => "update_96", "2004-08-06" => "update_97", "2004-08-07" => "update_98", - "2004-08-09" => "update_99" + "2004-08-09" => "update_99", + "2004-08-10" => "update_100", + "2004-08-11" => "update_101" ); function update_32() { @@ -1461,6 +1463,87 @@ function update_99() { return $ret; } +function update_100() { + + $ret = array(); + if ($GLOBALS["db_type"] == "mysql") { + $ret[] = update_sql("CREATE TABLE {locales_source} ( + lid int(11) NOT NULL auto_increment, + location varchar(128) NOT NULL default '', + source blob NOT NULL, + PRIMARY KEY (lid) + )"); + $ret[] = update_sql("CREATE TABLE {locales_target} ( + lid int(11) NOT NULL default '0', + translation blob NOT NULL, + locale varchar(12) NOT NULL default '', + plid int(11) NOT NULL default '0', + plural int(1) NOT NULL default '0', + KEY lid (lid), + KEY lang (locale), + KEY plid (plid), + KEY plural (plural) + )"); + $ret[] = update_sql("INSERT INTO {locales_meta} (locale, name, enabled, isdefault) VALUES ('en', 'English', '1', '1')"); + $ret[] = update_sql("ALTER TABLE {users} CHANGE language language varchar(12) NOT NULL default ''"); + } + else { // TODO: pgsql support (see database.pgsql for suggestions) + } + + return $ret; +} + +function update_101() { + include_once 'includes/locale.inc'; + // get the language columns + $result = db_query('SELECT * FROM {locales} LIMIT 1'); + $fields = array(); + if (db_num_rows($result)) { + $columns = array_keys(db_fetch_array($result)); + foreach ($columns as $field) { + $fields[$field] = 1; + } + + // but not the fixed fields + unset($fields['lid'], $fields['location'], $fields['string']); + + // insert locales + $list = _locale_get_iso639_list(); + foreach ($fields as $key => $value) { + if (db_result(db_query("SELECT COUNT(lid) FROM {locales} WHERE $key != ''"))) { + if (isset($list[$key])) { + $name = $list[$key][0]; + if ($key == 'en') { + $key = 'en-local'; + } + db_query("INSERT INTO {locales_meta} (locale, name) VALUES ('%s', '%s')", $key, $name); + } + else { + db_query("INSERT INTO {locales_meta} (locale, name) VALUES ('%s', '%s')", $key, $key); + } + } + } + + // get all strings + $result = db_query('SELECT * FROM {locales}'); + while($entry = db_fetch_object($result)) { + // insert string if at least one translation exists + $test = 'return $entry->'. implode(' == "" && $entry->', array_keys($fields)) .' == "";'; + if (!eval($test)) { + db_query("INSERT INTO {locales_source} (location, source) VALUES ('%s', '%s')", $entry->location, $entry->string); + $lid = db_fetch_object(db_query("SELECT lid FROM {locales_source} WHERE location = '%s' AND source = '%s'", $entry->location, $entry->string)); + foreach ($fields as $key => $value) { + // insert translation if non-empty + db_query("INSERT INTO {locales_target} (lid, translation, locale) VALUES (%d, '%s', '%s')", $lid->lid, $entry->$key, $key); + } + } + } + } + + $ret = array(); + $ret[] = update_sql("DROP TABLE {locales}"); + return $ret; +} function update_sql($sql) { $edit = $_POST["edit"]; diff --git a/includes/common.inc b/includes/common.inc index 209769c8fd42..d5eb1d1f379a 100644 --- a/includes/common.inc +++ b/includes/common.inc @@ -505,8 +505,15 @@ function message_na() { /** * Initialize the localization system. */ -function locale_init() { - global $languages, $user; +function locale_initialize() { + global $user; + if (function_exists('locale')) { + $languages = locale_supported_languages(); + $languages = $languages['name']; + } + else { + $languages = array(); + } if ($user->uid && $languages[$user->language]) { return $user->language; } @@ -540,9 +547,10 @@ function locale_init() { * The translated string. */ function t($string, $args = 0) { - global $languages; - - $string = ($languages && module_exist('locale') ? locale($string) : $string); + global $locale; + if (function_exists('locale') && $locale != 'en') { + $string = locale($string); + } if (!$args) { return $string; @@ -841,7 +849,23 @@ function format_rss_item($title, $link, $description, $args = array()) { * A translated string. */ function format_plural($count, $singular, $plural) { - return t($count == 1 ? $singular : $plural, array('%count' => $count)); + if ($count == 1) return t($singular); + + // get the plural index through the gettext formula + $index = (function_exists('locale')) ? locale_get_plural($count) : -1; + if ($index < 0) { // backward compatibility + return t($plural, array("%count" => $count)); + } + else { + switch ($index) { + case "0": + return t($singular); + case "1": + return t($plural, array("%count" => $count)); + default: + return t(strtr($plural, array("%count" => '%count['. $index .']')), array('%count['. $index .']' => $count)); + } + } } /** @@ -1814,7 +1838,7 @@ function drupal_eval($code) { } // initialize localization system: -$locale = locale_init(); +$locale = locale_initialize(); // initialize theme: $theme = init_theme(); diff --git a/includes/conf.php b/includes/conf.php index cf72381f8270..0c78ed344f9a 100644 --- a/includes/conf.php +++ b/includes/conf.php @@ -45,15 +45,6 @@ # If required, update PHP's include path to include your PEAR directory: // ini_set("include_path", ".:/path/to/pear"); -# -# Languages / translation / internationalization: -# -# The first language listed in this associative array will -# automatically become the default language. You can add a language -# but make sure your SQL table, called locales is updated -# appropriately. -$languages = array("en" => "english"); - # # Custom navigation links: # diff --git a/includes/locale.inc b/includes/locale.inc new file mode 100644 index 000000000000..5d6ceb18c38a --- /dev/null +++ b/includes/locale.inc @@ -0,0 +1,1268 @@ +<?php +// $Id$ +/** + * @file + * + * Admin related functions for locale.module + * + */ + +// --------------------------------------------------------------------------------- +// Language addition functionality (administration only) + +/** + * Helper function to add a language + */ +function _locale_add_language($code, $name, $onlylanguage = TRUE) { + db_query("INSERT INTO {locales_meta} (locale, name) VALUES ('%s','%s')", $code, $name); + $result = db_query("SELECT lid FROM {locales_source}"); + while ($string = db_fetch_object($result)) { + db_query("INSERT INTO {locales_target} (lid, locale) VALUES (%d,'%s')", $string->lid, $code); + } + + // If only the language was added, and not a PO file import triggered + // the language addition, we need to inform the user on how to start + // a translation + if ($onlylanguage) { + $message = t("'%locale' language added. You can now import a translation. See the <a href=\"%locale-help\">help screen</a> for more information.", array('%locale' => t($name), '%locale-help' => url("admin/help/locale"))); + } + else { + $message = t("'%locale' language added.", array('%locale' => t($name))); + } + + drupal_set_message($message); + watchdog('locale', t("'%locale' language added.", array('%locale' => $code))); +} + +/** + * User interface for the language management screen + */ +function _locale_admin_manage_screen() { + $edit = &$_POST['edit']; + $languages = locale_supported_languages(TRUE, TRUE); + + $header = array(array('data' => t('code')), array('data' => t('English name')), array('data' => t('enabled')), array('data' => t('default')), array('data' => t('translated')), array('data' => t('operations'))); + + foreach ($languages['name'] as $key => $lang) { + + $status = db_fetch_object(db_query("SELECT isdefault, enabled FROM {locales_meta} WHERE locale = '%s'", $key)); + + if ($key == 'en') { + $rows[] = array('en', $lang, form_checkbox('', 'enabled][en', 1, $status->enabled), form_radio('', 'sitedefault', $key, $status->isdefault), message_na(), ''); + } + else { + $original = db_fetch_object(db_query("SELECT COUNT(*) AS strings FROM {locales_source}")); + $translation = db_fetch_object(db_query("SELECT COUNT(*) AS translation FROM {locales_target} WHERE locale = '%s' AND translation != ''", $key)); + + $ratio = ($original->strings > 0 && $translation->translation > 0) ? round(($translation->translation/$original->strings)*100., 2) : 0; + + $rows[] = array($key, ($key != 'en' ? form_textfield('', 'name]['. $key, $lang, 15, 64) : $lang), form_checkbox('', 'enabled]['. $key, 1, $status->enabled), form_radio('', 'sitedefault', $key, $status->isdefault), "$translation->translation/$original->strings ($ratio%)", ($key != 'en' ? l(t('delete locale'), 'admin/locale/language/delete/'. urlencode($key)) : '')); + } + } + + return form(theme('table', $header, $rows) . form_submit(t('Save configuration')), 'POST', url('admin/locale')); +} + +/** + * User interface for the language addition screen + */ +function _locale_admin_manage_add_screen() { + + $isocodes = _locale_prepare_iso_list(); + + $output = '<h2>'. t('From language list') .'</h2>'; + $form = form_select(t('Language name'), 'langcode', key($isocodes), $isocodes, t('Select your language here, or add it below, if you are unable to find it.')); + $form .= form_submit(t('Add language')); + $output .= form($form); + + $edit = &$_POST['edit']; + $output .= '<h2>'. t('Custom language') .'</h2>'; + $form = form_textfield(t('Language code'), 'langcode', $edit['langcode'], 70, 12, t("Commonly this is an <a href=\"%iso-codes\">ISO 639 language code</a> with an optional country code for regional variants. Examples include 'en', 'en-US' and 'zh-cn'.", array("%iso-codes" => "http://www.w3.org/WAI/ER/IG/ert/iso639.htm"))); + $form .= form_textfield(t('Language name in English'), 'langname', $edit['langname'], 70, 64, t('Name of the language. Will be availabale for translation in all languages.')); + $form .= form_submit(t('Add language')); + $output .= form($form); + + return $output; +} + + +/** + * User interface for the translation import screen + */ +function _locale_admin_import_screen() { + $languages = locale_supported_languages(FALSE, TRUE); + $languages = array_map("t", $languages['name']); + unset($languages['en']); + + if (!count($languages)) { + drupal_set_message(t('You need to have at least one language set up to import translations.'), 'error'); + } + else { + $languages = array( + t('Already added languages') => $languages, + t('Languages not yet added') => _locale_prepare_iso_list() + ); + + $form = form_file(t('Language file'), 'file', 50, t('A gettext Portable Object (.po) file.')); + $form .= form_select(t('Import into'), 'langcode', '', $languages, t('Choose the language you want to add strings into. If you choose a language which is not yet set up, then it will be added.')); + $form .= form_radios(t('Mode'), 'mode', 'overwrite', array("overwrite" => t('Strings in the uploaded file replace existing ones, new ones are added'), "keep" => t('Existing strings are kept, only new strings are added'))); + $form .= form_submit(t('Import')); + $output = form($form, 'POST', url('admin/locale/language/import'), array('enctype' => 'multipart/form-data')); + } + return $output; +} + +/** + * Parses Gettext Portable Object file information and inserts into database + * + * @param $file Name of local file to be imported + * @param $edit Language code + * @param $mode should existing translations be replaced? + */ +function _locale_import_po($file, $lang, $mode) { + // Check if we have the language already in the database + if (!db_fetch_object(db_query("SELECT locale FROM {locales_meta} WHERE locale = '%s'", $lang))) { + drupal_set_message(t("Unsupported language selected for import."), 'error'); + return FALSE; + } + + // Check if we can get the strings from the file + if (!($strings = _locale_import_read_po($file))) { + drupal_set_message(t("Translation file broken: Couldn't be read."), 'error'); + return FALSE; + } + + // Strip out header from the string pairs + $header = $strings[""]["msgstr"]; + unset($strings[""]); + + // Get information from the header into the database + if ($header) { + $hdr = _locale_import_parse_header($header); + + // Get the plural formula + if ($hdr["Plural-Forms"] && $p = _locale_import_parse_plural_forms($hdr["Plural-Forms"])) { + list($nplurals, $plural) = $p; + db_query("UPDATE {locales_meta} SET plurals = '%d', formula = '%s' WHERE locale = '%s'", $nplurals, $plural, $lang); + } + else { + db_query("UPDATE {locales_meta} SET plurals = '%d', formula = '%s' WHERE locale = '%s'", 0, '', $lang); + } + } + else { + drupal_set_message(t("Translation file broken: No header."), 'error'); + return FALSE; + } + + $fullstr = 0; + foreach ($strings as $value) { + $comments = _locale_import_shorten_comments($value['#']); + + // Handle a translation for some plural string + if (strpos($value['msgid'], "\0")) { + $english = explode("\0", $value['msgid'], 2); + $entries = array_keys($value['msgstr']); + for ($i = 3; $i <= count($entries); $i++) { + $english[] = $english[1]; + } + $translation = array_map("_locale_import_append_plural", $value['msgstr'], $entries); + $english = array_map("_locale_import_append_plural", $english, $entries); + foreach ($translation as $key => $trans) { + if ($trans != '') { + $fullstr++; + } + $loc = db_fetch_object(db_query("SELECT s.lid, t.translation FROM {locales_source} s LEFT JOIN {locales_target} t ON s.lid = t.lid WHERE s.source = '%s' AND t.locale = '%s'", $english[$key], $lang)); + if ($loc->lid) { + $lid = $loc->lid; + db_query("UPDATE {locales_source} SET location = '%s' WHERE lid = %d", $comments, $lid); + } + else { + db_query("INSERT INTO {locales_source} (location, source) VALUES ('%s', '%s')", $comments, $english[$key]); + $lid = db_fetch_object(db_query("SELECT lid FROM {locales_source} WHERE location = '%s' AND source = '%s'", $comments, $english[$key])); + $lid = $lid->lid; + } + if ($key == 0) { + $parent = $lid; + } + if ($loc->translation && $mode == 'overwrite') { + db_query("UPDATE {locales_target} SET translation = '%s', plid = %d, plural = %d WHERE locale = '%s' AND lid = %d", $trans, $parent, $key, $lang, $lid); + } + elseif (!$loc->translation) { + db_query("INSERT INTO {locales_target} (lid, locale, translation, plid, plural) VALUES (%d, '%s', '%s', %d, %d)", $lid, $lang, $trans, $parent, $key); + } + } + } + + // A simple translation + else { + $english = $value['msgid']; + $translation = $value['msgstr']; + if ($translation != '') { + $fullstr++; + } + $loc = db_fetch_object(db_query("SELECT s.lid, t.translation FROM {locales_source} s LEFT JOIN {locales_target} t ON s.lid = t.lid WHERE s.source = '%s' AND t.locale = '%s'", $english, $lang)); + if ($loc->lid) { + $lid = $loc->lid; + db_query("UPDATE {locales_source} SET location = '%s' WHERE source = '%s'", $comments, $english); + } + else { + db_query("INSERT INTO {locales_source} (location, source) VALUES ('%s', '%s')", $comments, $english); + $loc = db_fetch_object(db_query("SELECT lid FROM {locales_source} WHERE location = '%s' AND source = '%s'", $comments, $english)); + $lid = $loc->lid; + } + if ($loc->translation && $mode == 'overwrite') { + db_query("UPDATE {locales_target} SET translation = '%s' WHERE locale = '%s' AND lid = %d", $translation, $lang, $lid); + } + elseif (!$loc->translation) { + db_query("INSERT INTO {locales_target} (lid, locale, translation) VALUES (%d, '%s', '%s')", $lid, $lang, $translation); + } + } + } + + // Successfull import + cache_clear_all("locale:$lang"); + drupal_set_message(t("Translation successfully imported. %num translated strings added to language.", array('%num' => $fullstr))); + watchdog('locale', strtr("Translation imported into '%locale', %num translated strings added to language.", array('%locale' => $lang, '%num' => $fullstr))); + return TRUE; +} + +/** + * Parses Gettext Portable Object file into an array + * + * @param $path Name of local file to parse + * @author Jacobo Tarrio + */ +function _locale_import_read_po($path) { + + $fd = fopen($path, "rb"); + if (!$fd) { + drupal_set_message(t("Translation import failed: File '%path' cannot be read.", array("%path" => $path)), 'error'); + return FALSE; + } + $info = fstat($fd); + $len = $info["size"]; + $po = fread($fd, $len); + fclose($fd); + + $context = "COMMENT"; // Parser context: COMMENT, MSGID, MSGID_PLURAL, MSGSTR and MSGSTR_ARR + $current = array(); // Current entry being read + $strings = array(); // List of entries read + $plural = 0; // Current plural form + + $po = strtr($po, array("\\\n" => "")); + $lines = split("\n", $po); + $lineno = 0; + + foreach ($lines as $line) { + $lineno++; + $line = trim($line); + + if (!strncmp("#", $line, 1)) { // A comment + if ($context == "COMMENT") { // Already in comment context: add + $current["#"][] = substr($line, 1); + } + elseif (($context == "MSGSTR") || ($context == "MSGSTR_ARR")) { // End current entry, start a new one + $strings[$current["msgid"]] = $current; + $current = array(); + $current["#"][] = substr($line, 1); + $context = "COMMENT"; + } + else { // Parse error + drupal_set_message(t("Translation file broken: Expected \"msgstr\" in line %lineno", array("%lineno" => $lineno)), 'error'); + return FALSE; + } + } + elseif (!strncmp("msgid_plural", $line, 12)) { + if ($context != "MSGID") { // Must be plural form for current entry + drupal_set_message(t("Translation file broken: Unexpected \"msgid_plural\" in line %lineno", array("%lineno" => $lineno)), 'error'); + return FALSE; + } + $line = trim(substr($line, 12)); + $quoted = _locale_import_parse_quoted($line); + if ($quoted === false) { + drupal_set_message(t("Translation file broken: Syntax error in line %lineno", array("%lineno" => $lineno)), 'error'); + return FALSE; + } + $current["msgid"] = $current["msgid"] ."\0". $quoted; + $context = "MSGID_PLURAL"; + } + elseif (!strncmp("msgid", $line, 5)) { + if ($context == "MSGSTR") { // End current entry, start a new one + $strings[$current["msgid"]] = $current; + $current = array(); + } + elseif ($context == "MSGID") { // Already in this context? Parse error + drupal_set_message(t("Translation file broken: Unexpected \"msgid\" in line %lineno", array("%lineno" => $lineno)), 'error'); + return FALSE; + } + $line = trim(substr($line, 5)); + $quoted = _locale_import_parse_quoted($line); + if ($quoted === false) { + drupal_set_message(t("Translation file broken: Syntax error in line %lineno", array("%lineno" => $lineno)), 'error'); + return FALSE; + } + $current["msgid"] = $quoted; + $context = "MSGID"; + } + elseif (!strncmp("msgstr[", $line, 7)) { + if (($context != "MSGID") && ($context != "MSGID_PLURAL") && ($context != "MSGSTR_ARR")) { // Must come after msgid, msgid_plural, or msgstr[] + drupal_set_message(t("Translation file broken: Unexpected \"msgstr[]\" in line %lineno", array("%lineno" => $lineno)), 'error'); + return FALSE; + } + if (strpos($line, "]") === false) { + drupal_set_message(t("Translation file broken: Syntax error in line %lineno", array("%lineno" => $lineno)), 'error'); + return FALSE; + } + $frombracket = strstr($line, "["); + $plural = substr($frombracket, 1, strpos($frombracket, "]") - 1); + $line = trim(strstr($line, " ")); + $quoted = _locale_import_parse_quoted($line); + if ($quoted === false) { + drupal_set_message(t("Translation file broken: Syntax error in line %lineno", array("%lineno" => $lineno)), 'error'); + return FALSE; + } + $current["msgstr"][$plural] = $quoted; + $context = "MSGSTR_ARR"; + } + elseif (!strncmp("msgstr", $line, 6)) { + if ($context != "MSGID") { // Should come just after a msgid block + drupal_set_message(t("Translation file broken: Unexpected \"msgstr\" in line %lineno", array("%lineno" => $lineno)), 'error'); + return FALSE; + } + $line = trim(substr($line, 6)); + $quoted = _locale_import_parse_quoted($line); + if ($quoted === false) { + drupal_set_message(t("Translation file broken: Syntax error in line %lineno", array("%lineno" => $lineno)), 'error'); + return FALSE; + } + $current["msgstr"] = $quoted; + $context = "MSGSTR"; + } + elseif ($line != "") { + $quoted = _locale_import_parse_quoted($line); + if ($quoted === false) { + drupal_set_message(t("Translation file broken: Syntax error in line %lineno", array("%lineno" => $lineno)), 'error'); + return FALSE; + } + if (($context == "MSGID") || ($context == "MSGID_PLURAL")) { + $current["msgid"] .= $quoted; + } + elseif ($context == "MSGSTR") { + $current["msgstr"] .= $quoted; + } + elseif ($context == "MSGSTR_ARR") { + $current["msgstr"][$plural] .= $quoted; + } + else { + drupal_set_message(t("Translation file broken: Unexpected string in line %lineno", array("%lineno" => $lineno)), 'error'); + return FALSE; + } + } + } + + // End of PO file, flush last entry + if (($context == "MSGSTR") || ($context == "MSGSTR_ARR")) { + $strings[$current["msgid"]] = $current; + } + elseif ($context != "COMMENT") { + drupal_set_message(t("Translation file broken: Unexpected end file at line %lineno", array("%lineno" => $lineno)), 'error'); + return FALSE; + } + + return $strings; +} + +/** + * Parses a Gettext Portable Object file header + * + * @param $header A string containing the complete header + * @return An associative array of key-value pairs + * @author Jacobo Tarrio + */ +function _locale_import_parse_header($header) { + $hdr = array(); + + $lines = explode("\n", $header); + foreach ($lines as $line) { + $line = trim($line); + if ($line) { + list($tag, $contents) = explode(":", $line, 2); + $hdr[trim($tag)] = trim($contents); + } + } + + return $hdr; +} + +/** + * Parses a Plural-Forms entry from a Gettext Portable Object file header + * + * @param $pluralforms A string containing the Plural-Forms entry + * @return An array containing the number of plurals and a + * formula in PHP for computing the plural form + * @author Jacobo Tarrio + */ +function _locale_import_parse_plural_forms($pluralforms) { + // First, delete all whitespace + $pluralforms = strtr($pluralforms, array(" " => "", "\t" => "")); + + // Select the parts that define nplurals and plural + $nplurals = strstr($pluralforms, "nplurals="); + if (strpos($nplurals, ";")) { + $nplurals = substr($nplurals, 9, strpos($nplurals, ";") - 9); + } + else { + return FALSE; + } + $plural = strstr($pluralforms, "plural="); + if (strpos($plural, ";")) { + $plural = substr($plural, 7, strpos($plural, ";") - 7); + } + else { + return FALSE; + } + + // Get PHP version of the plural formula + $plural = _locale_import_parse_arithmetic($plural); + + if ($plural) { + return array($nplurals, $plural); + } + else { + drupal_set_message(t("Translation file broken: Plural formula couldn't get parsed."), 'error'); + return FALSE; + } +} + +/** + * Parses and sanitizes an arithmetic formula into a PHP expression + * + * While parsing, we ensure, that the operators have the right + * precedence and associativity. + * + * @param $string A string containing the arithmetic formula + * @return The PHP version of the formula + * @author Jacobo Tarrio + */ +function _locale_import_parse_arithmetic($string) { + // Operator precedence table + $prec = array("(" => -1, ")" => -1, "?" => 1, ":" => 1, "||" => 3, "&&" => 4, "==" => 5, "!=" => 5, "<" => 6, ">" => 6, "<=" => 6, ">=" => 6, "+" => 7, "-" => 7, "*" => 8, "/" => 8, "%" => 8); + // Right associativity + $rasc = array("?" => 1, ":" => 1); + + $tokens = _locale_import_tokenize_formula($string); + + // Parse by converting into infix notation then back into postfix + $opstk = array(); + $elstk = array(); + + foreach ($tokens as $token) { + $ctok = $token; + + // Numbers and the $n variable are simply pushed into $elarr + if (is_numeric($token)) { + $elstk[] = $ctok; + } + elseif ($ctok == "n") { + $elstk[] = '$n'; + } + elseif ($ctok == "(") { + $opstk[] = $ctok; + } + elseif ($ctok == ")") { + $topop = array_pop($opstk); + while (($topop != NULL) && ($topop != "(")) { + $elstk[] = $topop; + $topop = array_pop($opstk); + } + } + elseif ($prec[$ctok]) { + // If it's an operator, then pop from $oparr into $elarr until the + // precedence in $oparr is less than current, then push into $oparr + $topop = array_pop($opstk); + while (($topop != NULL) && ($prec[$topop] >= $prec[$ctok]) && !(($prec[$topop] == $prec[$ctok]) && $rasc[$topop] && $rasc[$ctok])) { + $elstk[] = $topop; + $topop = array_pop($opstk); + } + if ($topop) { + $opstk[] = $topop; // Return element to top + } + $opstk[] = $ctok; // Parentheses are not needed + } + else { + return false; + } + } + + // Flush operator stack + $topop = array_pop($opstk); + while ($topop != NULL) { + $elstk[] = $topop; + $topop = array_pop($opstk); + } + + // Now extract formula from stack + $prevsize = count($elstk) + 1; + while (count($elstk) < $prevsize) { + $prevsize = count($elstk); + for ($i = 2; $i < count($elstk); $i++) { + $op = $elstk[$i]; + if ($prec[$op]) { + $f = ""; + if ($op == ":") { + $f = $elstk[$i - 2] ."):". $elstk[$i - 1] .")"; + } + elseif ($op == "?") { + $f = "(". $elstk[$i - 2] ."?(". $elstk[$i - 1]; + } + else { + $f = "(". $elstk[$i - 2] . $op . $elstk[$i - 1] .")"; + } + array_splice($elstk, $i - 2, 3, $f); + break; + } + } + } + + // If only one element is left, the number of operators is appropriate + if (count($elstk) == 1) { + return $elstk[0]; + } + else { + return FALSE; + } +} + +/** + * Backward compatible implementation of token_get_all() for formula parsing + * + * @param $string A string containing the arithmetic formula + * @return The PHP version of the formula + * @author Gerhard Killesreiter + */ +function _locale_import_tokenize_formula($formula) { + $formula = str_replace(" ", "", $formula); + $tokens = array(); + for ($i = 0; $i < strlen($formula); $i++) { + if (is_numeric($formula{$i})) { + $num = $formula{$i}; + $j = $i + 1; + while($j < strlen($formula) && is_numeric($formula{$j})) { + $num .= $formula{$j}; + $j++; + } + $i = $j - 1; + $tokens[] = $num; + } + elseif ($pos = strpos(" =<>!&|", $formula{$i})) { // We won't have a space + $next = $formula{($i+1)}; + switch ($pos) { + case 1: + case 2: + case 3: + case 4: + if ($next == '=') { + $tokens[] = $formula{$i} .'='; + $i++; + } + else { + $tokens[] = $formula{$i}; + } + break; + case 5: + if ($next == '&') { + $tokens[] = '&&'; + $i++; + } + else { + $tokens[] = $formula{$i}; + } + break; + case 6: + if ($next == '|') { + $tokens[] = '||'; + $i++; + } + else { + $tokens[] = $formula{$i}; + } + break; + } + } + else { + $tokens[] = $formula{$i}; + } + } + return $tokens; +} + +/** + * Modify a string to contain proper count indices + * + * This is a callback function used via array_map() + * + * @param $entry An array element + * @param $key Index of the array element + */ +function _locale_import_append_plural($entry, $key) { + // No modifications for 0, 1 + if ($key == 0 || $key == 1) { + return $entry; + } + + // First remove any possibly false indices, then add new ones + $entry = preg_replace('/(%count)\[[0-9]\]/', '\\1', $entry); + return preg_replace('/(%count)/', "\\1[$key]", $entry); +} + +/** + * Generate a short, one string version of the passed comment array + * + * @param $comment An array of strings containing a comment + * @return Short one string version of the comment + */ +function _locale_import_shorten_comments($comment) { + $comm = ''; + while(strlen($comm) < 128 && count($comment)) { + $comm .= substr(array_shift($comment), 1) .', '; + } + return substr($comm, 0, -2); +} + +/** + * Parses a string in quotes + * + * @param $string A string specified with enclosing quotes + * @return The string parsed from inside the quotes + */ +function _locale_import_parse_quoted($string) { + if (substr($string, 0, 1) != substr($string, -1, 1)) { + return FALSE; // Start and end quotes must be the same + } + $quote = substr($string, 0, 1); + $string = substr($string, 1, -1); + if ($quote == '"') { // Double quotes: strip slashes + return stripcslashes($string); + } + elseif ($quote == "'") { // Simple quote: return as-is + return $string; + } + else { + return FALSE; // Unrecognized quote + } +} + +/** + * User interface for the translation export screen + */ +function _locale_admin_export_screen() { + $languages = locale_supported_languages(FALSE, TRUE); + $languages = array_map("t", $languages['name']); + unset($languages['en']); + $output = ''; + + // Offer language specific export if any language is set up + if (count($languages)) { + $output .= '<h2>'. t('Export translation') .'</h2>'; + $form = form_select(t('Language name'), 'langcode', '', $languages, t('Select the language you would like to export in gettext Portable Object (.po) format.')); + $form .= form_submit(t('Export')); + $output .= form($form); + } + + // Complete template export of the strings + $output .= '<h2>'. t('Export template') .'</h2>'; + $form = t('<p>Generate a gettext Portable Object Template (.pot) file with all the interface strings from the Drupal locale database.</p>'); + $form .= form_submit(t('Export')); + $output .= form($form); + + return $output; +} + +/** + * Exports a Portable Object (Template) file for a language + * + * @param $language Selects a language to generate the output for + */ +function _locale_export_po($language) { + global $user; + + // Get language specific strings, or all strings + if ($language) { + $meta = db_fetch_object(db_query("SELECT * FROM {locales_meta} WHERE locale = '%s'", $language)); + $result = db_query("SELECT s.lid, s.source, s.location, t.translation, t.plid, t.plural FROM {locales_source} s INNER JOIN {locales_target} t ON s.lid = t.lid WHERE t.locale = '%s' ORDER BY t.plid, t.plural", $language); + } + else { + $result = db_query("SELECT s.lid, s.source, s.location, t.plid, t.plural FROM {locales_source} s INNER JOIN {locales_target} t ON s.lid = t.lid GROUP BY s.lid ORDER BY t.plid, t.plural"); + } + + // Build array out of the database results + $parent = array(); + while ($child = db_fetch_object($result)) { + $parent[$child->lid]['comment'] = $child->location; + $parent[$child->lid]['msgid'] = $child->source; + if ($child->plid) { + $parent[$child->lid][$child->plid]['plural'] = $child->lid; + $parent[$child->lid][$child->plid]['translation'] = $child->translation; + $parent[$child->lid][$child->plid]['msgid'] = $child->source; + } + else { + $parent[$child->lid]['translation'] = $child->translation; + } + } + + // Generating Portable Object file for a language + if ($language) { + $filename = $language .'.po'; + $header .= "# $meta->name translation of ". variable_get('site_name', 'Drupal') ."\n"; + $header .= '# Copyright (c) '. date('Y') .' '. $user->name .' <'. $user->mail .">\n"; + $header .= "#\n"; + $header .= "msgid \"\"\n"; + $header .= "msgstr \"\"\n"; + $header .= "\"Project-Id-Version: PROJECT VERSION\\n\"\n"; + $header .= "\"POT-Creation-Date: ". date("Y-m-d H:iO") ."\\n\"\n"; + $header .= "\"PO-Revision-Date: ". date("Y-m-d H:iO") ."\\n\"\n"; + $header .= "\"Last-Translator: ". $user->name .' <'. $user->mail .">\\n\"\n"; + $header .= "\"Language-Team: ". $meta->name .' <'. $user->mail .">\\n\"\n"; + $header .= "\"MIME-Version: 1.0\\n\"\n"; + $header .= "\"Content-Type: text/plain; charset=utf-8\\n\"\n"; + $header .= "\"Content-Transfer-Encoding: 8bit\\n\"\n"; + if ($meta->formula && $meta->plurals) { + $header .= "\"Plural-Forms: nplurals=". $meta->plurals ."; plural=". strtr($meta->formula, '$', '') .";\\n\"\n"; + } + $header .= "\n"; + watchdog('locale', strtr("PO file for locale '%loc' downloaded.", array('%loc' => $meta->name))); + } + + // Generating Portable Object Template + else { + $filename = variable_get('site_name', 'drupal') .'.pot'; + $header .= "# LANGUAGE translation of PROJECT\n"; + $header .= "# Copyright (c) YEAR NAME <EMAIL@ADDRESS>\n"; + $header .= "#\n"; + $header .= "msgid \"\"\n"; + $header .= "msgstr \"\"\n"; + $header .= "\"Project-Id-Version: PROJECT VERSION\\n\"\n"; + $header .= "\"POT-Creation-Date: ". date("Y-m-d H:iO") ."\\n\"\n"; + $header .= "\"PO-Revision-Date: YYYY-mm-DD HH:MM+ZZZZ\\n\"\n"; + $header .= "\"Last-Translator: NAME <EMAIL@ADDRESS>\\n\"\n"; + $header .= "\"Language-Team: LANGUAGE <EMAIL@ADDRESS>\\n\"\n"; + $header .= "\"MIME-Version: 1.0\\n\"\n"; + $header .= "\"Content-Type: text/plain; charset=utf-8\\n\"\n"; + $header .= "\"Content-Transfer-Encoding: 8bit\\n\"\n"; + $header .= "\"Plural-Forms: nplurals=INTEGER; plural=EXPRESSION;\\n\"\n"; + $header .= "\n"; + watchdog('locale', 'POT file downloaded.'); + } + + // Start download process + header("Content-Disposition: attachment; filename=$filename"); + header("Content-Type: text/plain; charset=utf-8"); + + print $header; + + foreach ($parent as $lid => $message) { + if (!isset($done[$lid])) { + if ($message['comment']) { + print '#: '. $message['comment'] ."\n"; + } + print 'msgid '. _locale_export_print($message['msgid']); + if (isset($message[1]['plural'])) { + print 'msgid_plural '. _locale_export_print($message[1]['msgid']); + if ($language) { + for ($i = 0; $i < $meta->plurals; $i++) { + print 'msgstr['. $i .'] '. _locale_export_print(_locale_export_remove_plural($message[${i}]['translation'])); + $done[$message[${i}]['plural']] = 1; + } + } + else { + print 'msgstr[0] ""'. "\n"; + print 'msgstr[1] ""'. "\n"; + $done[$message[0]['plural']] = 1; + $done[$message[1]['plural']] = 1; + } + } + else { + if ($language) { + print 'msgstr '. _locale_export_print($message['translation']); + } + else { + print 'msgstr ""'. "\n"; + } + } + print "\n"; + } + } + die(); +} + +/** + * Print out a string on multiple lines + */ +function _locale_export_print($str) { + $stri = addcslashes($str, "\0..\37\\\""); + $parts = array(); + + // Cut text into several lines + while ($stri != "") { + $i = strpos($stri, "\\n"); + if ($i === FALSE) { + $curstr = $stri; + $stri = ""; + } + else { + $curstr = substr($stri, 0, $i + 2); + $stri = substr($stri, $i + 2); + } + $curparts = explode("\n", _locale_export_wrap($curstr, 70)); + $parts = array_merge($parts, $curparts); + } + + if (count($parts) > 1) { + return "\"\"\n\"". implode("\"\n\"", $parts) ."\"\n"; + } + else { + return "\"$parts[0]\"\n"; + } +} + +/** + * Custom word wrapping for Portable Object (Template) files. + * + * @author Jacobo Tarrio + */ +function _locale_export_wrap($str, $len) { + $words = split(" ", $str); + $ret = array(); + + $cur = ""; + $nstr = 1; + while (count($words)) { + $word = array_shift($words); + if ($nstr) { + $cur = $word; + $nstr = 0; + } + elseif (strlen("$cur $word") > $len) { + $ret[] = $cur . " "; + $cur = $word; + } + else { + $cur = "$cur $word"; + } + } + $ret[] = $cur; + + return implode("\n", $ret); +} + +/** + * Removes plural index information from a string + */ +function _locale_export_remove_plural($entry) { + return preg_replace('/(%count)\[[0-9]\]/', '\\1', $entry); +} + +function _locale_string_delete($lid) { + db_query("DELETE FROM {locales_source} WHERE lid = %d", $lid); + db_query("DELETE FROM {locales_target} WHERE lid = %d", $lid); + locale_refresh_cache(); + drupal_set_message(t("deleted string")); +} + +/** + * Action handler for string editing + * + * Saves all translations of one string submitted from a form + */ +function _locale_string_save($lid) { + + $edit =& $_POST["edit"]; + foreach ($edit as $key => $value) { + $trans = db_fetch_object(db_query("SELECT translation FROM {locales_target} WHERE lid = %d AND locale = '%s'", $lid, $key)); + if ($trans->translation) { + db_query("UPDATE {locales_target} SET translation = '%s' WHERE lid = %d AND locale = '%s'", $value, $lid, $key); + } + else { + db_query("INSERT INTO {locales_target} (lid, translation, locale) VALUES (%d, '%s', '%s')", $lid, $value, $key); + } + } + locale_refresh_cache(); + // delete form data so it will remember where it came from + $edit = ''; + + drupal_set_message(t("saved string")); +} + +/** + * User interface for string editing + */ +function _locale_string_edit($lid) { + $languages = locale_supported_languages(FALSE, TRUE); + unset($languages['name']['en']); + + $result = db_query("SELECT DISTINCT s.source, t.translation, t.locale FROM {locales_source} s INNER JOIN {locales_target} t ON s.lid = t.lid WHERE s.lid = %d", $lid); + $form = ''; + while ($translation = db_fetch_object($result)) { + $orig = $translation->source; + $form .= (strlen($orig) > 40) ? form_textarea($languages['name'][$translation->locale], $translation->locale, $translation->translation, 70, 15) : form_textfield($languages['name'][$translation->locale], $translation->locale, $translation->translation, 50, 128); + unset($languages['name'][$translation->locale]); + } + foreach ($languages['name'] as $key => $lang) { + $form .= (strlen($orig) > 40) ? form_textarea($lang, $key, '', 70, 15) : form_textfield($lang, $key, '', 50, 128); + } + $form = form_item(t('Original text'), wordwrap(drupal_specialchars($orig, 0))) . $form; + + $form .= form_submit(t('Save translations')); + + return form($form); +} + +/** + * List languages in search result table + */ +function _locale_string_language_list($translation) { + $languages = locale_supported_languages(FALSE, TRUE); + unset($languages['name']['en']); + $output = ''; + foreach ($languages['name'] as $key => $value) { + if (isset($translation[$key])) { + $output .= ($translation[$key] != '') ? $key .' ' : "<strike>$key</strike> "; + } + } + + return $output; +} + +/** + * Build object out of search criteria specified in request variables + */ +function _locale_string_seek_query() { + static $query = NULL; + + if (is_null($query) && isset($_REQUEST['edit'])) { + $fields = array('string', 'language', 'searchin'); + $query = new StdClass; + if (is_array($_REQUEST['edit'])) { + foreach ($_REQUEST['edit'] as $key => $value) { + if (!empty($value) && in_array($key, $fields)) { + $query->$key = $value; + } + } + } + else { + foreach ($_REQUEST as $key => $value) { + if (!empty($value) && in_array($key, $fields)) { + $query->$key = strpos(',', $value) ? explode(',', $value) : $value; + } + } + } + } + return $query; +} + +/** + * Perform a string search and display results in a table + */ +function _locale_string_seek() { + // We have at least one criterium to match + if ($query = _locale_string_seek_query()) { + $join = "SELECT s.source, s.location, s.lid, t.translation, t.locale FROM {locales_source} s INNER JOIN {locales_target} t ON s.lid = t.lid "; + + // Compute LIKE section + switch ($query->searchin) { + case 'translated': + $where = "WHERE (t.translation LIKE '%". check_query($query->string) ."%' AND t.translation != '')"; + $orderby = "ORDER BY t.translation"; + break; + case 'untranslated': + $where = "WHERE (s.source LIKE '%". check_query($query->string) ."%' AND t.translation = '')"; + $orderby = "ORDER BY s.source"; + break; + case 'all' : + default: + $where = "WHERE (s.source LIKE '%". check_query($query->string) ."%' OR t.translation LIKE '%". check_query($query->string) ."%')"; + $orderby = ''; + break; + } + + switch ($query->language) { + // Force search in source strings + case "en": + $sql = $join ." WHERE s.source LIKE '%". check_query($query->string) ."%' ORDER BY s.source"; + break; + // Search in all languages + case "all": + $sql = "$join $where $orderby"; + break; + // Some different language + default: + $sql = "$join $where AND t.locale = '". check_query($query->language) ."' $orderby"; + } + + $result = pager_query($sql, 50); + + $header = array(t('string'), t('locales'), array('data' => t('operations'), 'colspan' => '2')); + $arr = array(); + while ($locale = db_fetch_object($result)) { + $arr[$locale->lid]['locales'][$locale->locale] = $locale->translation; + $arr[$locale->lid]['location'] = $locale->location; + $arr[$locale->lid]['source'] = $locale->source; + } + foreach ($arr as $lid => $value) { + $source = htmlspecialchars($value['source']); + $rows[] = array(array('data' => (strlen($source) > 150 ? substr($source, 0, 150) .'...' : $source) .'<br /><small>'. $value['location'] .'</small>'), array('data' => _locale_string_language_list($value['locales']), 'align' => 'center'), array('data' => l(t('edit'), "admin/locale/string/edit/$lid"), 'nowrap' => 'nowrap'), array('data' => l(t('delete'), "admin/locale/string/delete/$lid"), 'nowrap' => 'nowrap')); + } + + $request = array(); + if (count($query)) { + foreach ($query as $key => $value) { + $request[$key] = (is_array($value)) ? implode(',', $value) : $value; + } + } + + if ($pager = theme('pager', NULL, 50, 0, $request)) { + $rows[] = array(array('data' => "$pager", 'colspan' => '5')); + } + + $output .= theme('table', $header, $rows); + + } + + return $output; +} + +/** + * User interface for the string search screen + */ +function _locale_string_seek_form() { + + // Get *all* languages set up + $languages = locale_supported_languages(FALSE, TRUE); + asort($languages['name']); unset($languages['name']['en']); + + // Present edit form preserving previous user settings + $query = _locale_string_seek_query(); + $form .= form_textfield(t('Strings to search for'), 'string', $query->string, 30, 30, t('Leave blank to show all strings. The search is case sensitive.')); + $form .= form_radios(t('Language'), 'language', ($query->language ? $query->language : 'all'), array_merge(array('all' => t('All languages'), 'en' => t('English (provided by Drupal)')), $languages['name'])); + $form .= form_radios(t('Search in'), 'searchin', ($query->searchin ? $query->searchin : 'all'), array('all' => t('All strings in that language'), 'translated' => t('Only translated strings'), 'untranslated' => t('Only untranslated strings'))); + + $form .= form_submit(t('Search')); + $output = form(form_group(t('Search strings'), $form), 'POST', url('admin/locale/string/search')); + + return $output; +} + +// --------------------------------------------------------------------------------- +// List of some of the most common languages (administration only) + +/** + * Prepares the language code list for a select form item with only the unsupported ones + */ +function _locale_prepare_iso_list() { + $languages = locale_supported_languages(FALSE, TRUE); + $isocodes = _locale_get_iso639_list(); + foreach ($isocodes as $key => $value) { + if (isset($languages['name'][$key])) { + unset($isocodes[$key]); + continue; + } + if (count($value) == 2) { + $tname = t($value[0]); + $isocodes[$key] = ($tname == $value[1]) ? $tname : "$tname ($value[1])"; + } + else { + $isocodes[$key] = t($value[0]); + } + } + asort($isocodes); + return $isocodes; +} + +/** + * Some of the common languages with their English and native names + * + * Based on ISO 639 and http://people.w3.org/rishida/names/languages.html + */ +function _locale_get_iso639_list() { + return array( + "aa" => array("Afar"), + "ab" => array("Abkhazian", "аҧÑуа бызшәа"), + "ae" => array("Avestan"), + "af" => array("Afrikaans"), + "ak" => array("Akan"), + "am" => array("Amharic", "አማáˆáŠ›"), + "ar" => array("Arabic", "العربية"), + "as" => array("Assamese"), + "av" => array("Avar"), + "ay" => array("Aymara"), + "az" => array("Azerbaijani", "azÉ™rbaycan"), + "ba" => array("Bashkir"), + "be" => array("Belarusian", "БеларуÑкаÑ"), + "bg" => array("Bulgarian", "БългарÑки"), + "bh" => array("Bihari"), + "bi" => array("Bislama"), + "bm" => array("Bambara", "Bamanankan"), + "bn" => array("Bengali"), + "bo" => array("Tibetan"), + "br" => array("Breton"), + "bs" => array("Bosnian", "Bosanski"), + "ca" => array("Catalan", "Català "), + "ce" => array("Chechen"), + "ch" => array("Chamorro"), + "co" => array("Corsican"), + "cr" => array("Cree"), + "cs" => array("Czech", "ÄŒeÅ¡tina"), + "cu" => array("Old Slavonic"), + "cv" => array("Welsh", "Cymraeg"), + "cy" => array("Welch"), + "da" => array("Danish"), + "de" => array("German", "Deutsch"), + "dv" => array("Maldivian"), + "dz" => array("Bhutani"), + "ee" => array("Ewe", "ÆÊ‹É›"), + "el" => array("Greek", "Ελληνικά"), + "en" => array("English"), + "eo" => array("Esperanto"), + "es" => array("Spanish", "Español"), + "et" => array("Estonian", "Eesti"), + "eu" => array("Basque", "Euskera"), + "fa" => array("Persian", "Ùارسی"), + "ff" => array("Fulah", "Fulfulde"), + "fi" => array("Finnish", "Suomi"), + "fj" => array("Fiji"), + "fo" => array("Faeroese"), + "fr" => array("French", "Français"), + "fy" => array("Frisian", "Frysk"), + "ga" => array("Irish", "Gaeilge"), + "gd" => array("Scots Gaelic"), + "gl" => array("Galician", "Galego"), + "gn" => array("Guarani"), + "gu" => array("Gujarati"), + "gv" => array("Manx"), + "ha" => array("Hausa"), + "he" => array("Hebrew", "עברית"), + "hi" => array("Hindi", "हिनà¥à¤¦à¥€"), + "ho" => array("Hiri Motu"), + "hr" => array("Croatian", "Hrvatski"), + "hu" => array("Hungarian", "Magyar"), + "hy" => array("Armenian", "Õ€Õ¡ÕµÕ¥Ö€Õ¥Õ¶"), + "hz" => array("Herero"), + "ia" => array("Interlingua"), + "id" => array("Indonesian", "Bahasa Indonesia"), + "ie" => array("Interlingue"), + "ig" => array("Igbo"), + "ik" => array("Inupiak"), + "is" => array("Icelandic", "Ãslenska"), + "it" => array("Italian", "Italiano"), + "iu" => array("Inuktitut"), + "ja" => array("Japanese", "日本語"), + "jv" => array("Javanese"), + "ka" => array("Georgian"), + "kg" => array("Kongo"), + "ki" => array("Kikuyu"), + "kj" => array("Kwanyama"), + "kk" => array("Kazakh", "Қазақ"), + "kl" => array("Greenlandic"), + "km" => array("Cambodian"), + "kn" => array("Kannada", "ಕನà³à²¨à²¡"), + "ko" => array("Korean", "í•œêµì–´"), + "kr" => array("Kanuri"), + "ks" => array("Kashmiri"), + "ku" => array("Kurdish", "Kurdî"), + "kv" => array("Komi"), + "kw" => array("Cornish"), + "ky" => array("Kirghiz", "Кыргыз"), + "la" => array("Latin", "Latina"), + "lb" => array("Luxembourgish"), + "lg" => array("Luganda"), + "ln" => array("Lingala"), + "lo" => array("Laothian"), + "lt" => array("Lithuanian", "LietuviÅ¡kai"), + "lv" => array("Latvian", "LatvieÅ¡u"), + "mg" => array("Malagasy"), + "mh" => array("Marshallese"), + "mi" => array("Maori"), + "mk" => array("Macedonian", "МакедонÑки"), + "ml" => array("Malayalam", "മലയാളം"), + "mn" => array("Mongolian"), + "mo" => array("Moldavian"), + "mr" => array("Marathi"), + "ms" => array("Malay", "Bahasa Melayu"), + "mt" => array("Maltese", "Malti"), + "my" => array("Burmese"), + "na" => array("Nauru"), + "nd" => array("North Ndebele"), + "ne" => array("Nepali"), + "ng" => array("Ndonga"), + "nl" => array("Dutch", "Nederlands"), + "no" => array("Norwegian", "Norsk"), + "nr" => array("South Ndebele"), + "nv" => array("Navajo"), + "ny" => array("Chichewa"), + "oc" => array("Occitan"), + "om" => array("Oromo"), + "or" => array("Oriya"), + "os" => array("Ossetian"), + "pa" => array("Punjabi"), + "pi" => array("Pali"), + "pl" => array("Polish", "Polski"), + "ps" => array("Pashto", "پښتو"), + "pt" => array("Portuguese", "Português"), + "qu" => array("Quechua"), + "rm" => array("Rhaeto-Romance"), + "rn" => array("Kirundi"), + "ro" => array("Romanian", "Română"), + "ru" => array("Russian", "РуÑÑкий"), + "rw" => array("Kinyarwanda"), + "sa" => array("Sanskrit"), + "sc" => array("Sardinian"), + "sd" => array("Sindhi"), + "se" => array("Northern Sami"), + "sg" => array("Sango"), + "sh" => array("Serbo-Croatian"), + "si" => array("Singhalese"), + "sk" => array("Slovak", "SlovenÄina"), + "sl" => array("Slovenian", "SlovenÅ¡Äina"), + "sm" => array("Samoan"), + "sn" => array("Shona"), + "so" => array("Somali"), + "sq" => array("Albanian", "Shqip"), + "sr" => array("Serbian", "СрпÑки"), + "ss" => array("Siswati"), + "st" => array("Sesotho"), + "su" => array("Sudanese"), + "sv" => array("Swedish", "Svenska"), + "sw" => array("Swahili", "Kiswahili"), + "ta" => array("Tamil", "தமிழà¯"), + "te" => array("Telugu", "తెలà±à°—à±"), + "tg" => array("Tajik"), + "th" => array("Thai", "ภาษาไทย"), + "ti" => array("Tigrinya"), + "tk" => array("Turkmen"), + "tl" => array("Tagalog"), + "tn" => array("Setswana"), + "to" => array("Tonga"), + "tr" => array("Turkish", "Türkçe"), + "ts" => array("Tsonga"), + "tt" => array("Tatar", "Tatarça"), + "tw" => array("Twi"), + "ty" => array("Tahitian"), + "ug" => array("Uighur"), + "uk" => array("Ukrainian", "УкраїнÑька"), + "ur" => array("Urdu", "اردو"), + "uz" => array("Uzbek", "o'zbek"), + "ve" => array("Venda"), + "vi" => array("Vietnamese", "Tiếng Việt"), + "vo" => array("Volapük"), + "wo" => array("Wolof"), + "xh" => array("Xhosa", "isiXhosa"), + "yi" => array("Yiddish"), + "yo" => array("Yoruba", "Yorùbá"), + "za" => array("Zhuang"), + "zh_hans" => array("Chinese, Simplified", "简体ä¸æ–‡"), + "zh_hant" => array("Chinese, Traditional", "ç¹é«”ä¸æ–‡"), + "zu" => array("Zulu", "isiZulu"), + ); +} + +?> diff --git a/modules/locale.module b/modules/locale.module index ad9fb326d793..7b13b5f8d33a 100644 --- a/modules/locale.module +++ b/modules/locale.module @@ -1,365 +1,452 @@ <?php // $Id$ +/** + * @file + * + * Enables administrators to manage the site interface languages. + * + * When enabled, the site interface can be displayed in different + * languages. The setup of languages and translations is completely + * we based. Gettext portable object files are supported. + */ + +// --------------------------------------------------------------------------------- +// Hook implementations (needed on all page loads) + /** * Implementation of hook_help(). */ -function locale_help($section) { +function locale_help($section = "admin/help#locale") { switch ($section) { + case 'admin/modules#description': + return t('Enables the translation of the user interface to languages other than English.'); + case 'admin/locale': + case 'admin/locale/language/overview': + return t("<p>Drupal allows you to translate the interface to a language other than English. This page provides an overview of the installed languages. You can add more languages on the <a href=\"%add-language\">add language page</a>, or directly by <a href=\"%import\">importing a translation</a>. If there are multiple languages enabled, registered users will be able to set their preference. The site default will be used for users without their own settings, including anonymous visitors.</p><p>There are different approaches to translate the Drupal interface: either by <a href=\"%import\">importing</a> an existing translation, by <a href=\"%search\">translating everything</a> yourself, or by using a combination of these.</p>", array("%search" => url("admin/locale/string/search"), "%import" => url("admin/locale/language/import"), "%add-language" => url("admin/locale/language/add"))); + case 'admin/locale/language/add': + return t("<p>You need to add all languages you would like to provide the site interface in. If you can't find the desired language in the quick add dropdown, then need to provide the proper language code yourself. The language code might be used to negotiate with browsers and present flags, so it is important to pick one that is standardised for the desired language. You can also add languages by <a href=\"%import\">importing translations</a> directly into a language not yet set up.</p>", array("%import" => url("admin/locale/language/import"))); + case 'admin/locale/language/import': + return t("<p>This page allows you to import a translation provided in the gettext Portable Object (.po) format. The easiest way to get your site translated is to grab an existing Drupal translation and to import it. You can obtain translations from the <a href=\"%url\">Drupal localization page</a>.</p>", array('%url' => 'http://drupal.org/localization')); + case 'admin/locale/language/export': + return t("<p>This page allows you to export Drupal strings. The first option is to export a translation so it can be shared. The second option is to generate a translation template, which contains all Drupal strings, but without their translations. You can use this template to start a new translation using a specialized desktop application.</p>"); + case 'admin/locale/string/search': + return t("<p>It is often more convinient to get the strings of your setup on the <a href=\"%export\">export page</a>, and start with a desktop Gettext translation editor though. Here you can search in the translated and untranslated strings, and the default English texts provided by Drupal.</p>", array("%export" => url("admin/locale/language/export"))); + case 'admin/help#locale': return t(" - <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>Most programs are written and documented in English, and primarily 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 to see their web site showing a lot less English, and far more of their own language. Therefore Drupal provides a framework to setup a multi-lingual web site, or to overwrite the default English texts.</p> + <h3>How to interface translation works</h3> + <p>Whenever Drupal encounters an interface string which needs to be displayed, it tries to translate it into the currently selected language. If a translation is not available, then the string is remembered, so you can look up untranslated strings easily.</p> + <p>Drupal provides two options to translate these strings. First is the integrated web interface, where you can search for untranslated strings, and specify their translations via simple web forms. An easier, and much less time consuming method is to import translations already done for your language. This is achieved by the use of GNU gettext Portable Object files. These are editable with quite convinient desktop editors specifically architected for supporting your work with GNU Gettext files. The import feature allows you to add strings from such files into the site database. The export functionality enables you to share your translations with others, generating Portable Object files from your site strings."); + break; + + // TODO: integrate a rewritten version of this help into the big help screen above + /* + "<p>To translate strings start at the <a href=\"%search\">search</a> page of the locale section in the administration pages. There you will see a list of the languages you have configured. Choose the appropriate settings and search for the strings you want to translate.</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 on 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>Below the text you can see an example URI where this text shows up one your site or a file and the line number in the source code. 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> - 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; - </pre>", array('%overview' => url('admin/locale'))); - break; - case 'admin/modules#description': - return t('Enables the translation of the user interface to languages other than English.'); - case 'admin/locale': - 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.'); - case 'admin/locale/search': - return t('Search the localization database. ("*" can be used as a wildcard)'); - } - -} - -/** - * Menu callback; prints locale-specific help text from admin/help. - */ -function locale_help_page() { - print theme('page', locale_help('admin/help#locale')); -} - -/** - * Implementation of hook_perm(). - */ -function locale_perm() { - return array('administer locales'); + <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 and code line numbers can come in handy.</p> + <h3>Uploading PO files</h3> + <p>PO files are files containing translations as used by <a href=\"%gettext\">GNU gettext</a>.</p> + <p>The Drupal project distributes user contributed PO files in a number of languages. These files can be obtained from the <a href=\"%translations\">Drupal translations</a> home page.</p> + <p>If you want to provide a PO file for a not yet supported language or update an existing PO files, read about it in the <a href=\"%handbook\">Drupal handbook</a> home page.</p> + <p>Once you got the appropriate PO file, all you have to do is to add the locale and upload it from the <a href=\"%addlocale\">manage locale</a> screen.</p> + <p>Note that uploading and parsing the uploaded file can take quite some time, depending on the connection to the server and the server's power.</p> + ", array("%search" => url("admin/locale/string/search"), "%addlocale" => url("admin/locale/languages/add"), "%translations" => 'http://www.Drupal.org/translations/', "%handbook" => 'http://www.Drupal.org/handbook/po-files', "%gettext" => 'http://www.gnu.org/software/gettext/gettext.html'));*/ + } } /** * Implementation of hook_menu(). */ function locale_menu() { - global $languages; $items = array(); $access = user_access('administer locales'); + // Main admin menu item $items[] = array('path' => 'admin/locale', 'title' => t('localization'), - 'callback' => 'locale_admin', 'access' => $access); - $items[] = array('path' => 'admin/locale/edit', 'title' => t('edit string'), - 'callback' => 'locale_admin', 'access' => $access, + 'callback' => 'locale_admin_manage', 'access' => $access); + + // Top level tabs + $items[] = array('path' => 'admin/locale/language', 'title' => t('manage languages'), + 'access' => $access, 'weight' => -10, 'type' => MENU_DEFAULT_LOCAL_TASK); + $items[] = array('path' => 'admin/locale/string/search', 'title' => t('manage strings'), + 'callback' => 'locale_admin_string', 'access' => $access, 'weight' => 10, + 'type' => MENU_LOCAL_TASK); + + // Manage languages subtabs + $items[] = array('path' => 'admin/locale/language/overview', 'title' => t('list'), + 'callback' => 'locale_admin_manage', 'access' => $access, "weight" => 0, + 'type' => MENU_DEFAULT_LOCAL_TASK); + $items[] = array('path' => 'admin/locale/language/add', 'title' => t('add language'), + 'callback' => 'locale_admin_manage_add', 'access' => $access, "weight" => 5, + 'type' => MENU_LOCAL_TASK); + $items[] = array('path' => 'admin/locale/language/import', 'title' => t('import'), + 'callback' => 'locale_admin_import', 'access' => $access, 'weight' => 10, + 'type' => MENU_LOCAL_TASK); + $items[] = array('path' => 'admin/locale/language/export', 'title' => t('export'), + 'callback' => 'locale_admin_export', 'access' => $access, 'weight' => 20, + 'type' => MENU_LOCAL_TASK); + + // Language related callbacks + $items[] = array('path' => 'admin/locale/language/delete', 'title' => t('confirm'), + 'callback' => 'locale_admin_manage_delete_screen', 'access' => $access, 'type' => MENU_CALLBACK); - $items[] = array('path' => 'admin/locale/delete', 'title' => t('delete string'), - 'callback' => 'locale_admin', 'access' => $access, - 'type' => MENU_CALLBACK); - - foreach ($languages as $key => $value) { - $items[] = array('path' => "admin/locale/$key", 'title' => $value, - 'callback' => 'locale_admin', 'access' => $access); - $items[] = array('path' => "admin/locale/$key/translated", 'title' => t('translated strings'), - 'callback' => 'locale_admin', 'access' => $access); - $items[] = array('path' => "admin/locale/$key/untranslated", 'title' => t('untranslated strings'), - 'callback' => 'locale_admin', 'access' => $access); - } - + + // String related callbacks + $items[] = array('path' => 'admin/locale/string/edit', 'title' => t('edit'), + 'callback' => 'locale_admin_string', 'access' => $access, 'type' => MENU_CALLBACK); + $items[] = array('path' => 'admin/locale/string/delete', 'title' => t('delete'), + 'callback' => 'locale_admin_string', 'access' => $access, 'type' => MENU_CALLBACK); return $items; } /** - * Implementation of hook_user(). Allows each user to select an interface language. + * Implementation of hook_perm(). */ -function locale_user($type, &$edit, &$user, $category = NULL) { - global $languages; - if ($type == 'form' && count($languages) > 1 && $category == 'account') { - return array(array( - 'title' => t('Locale settings'), - 'data' => form_radios(t('Language'), 'language', $user->language, $languages, t('Selecting a different language will change the language of the site.')), - 'weight' => 2)); +function locale_perm() { + return array('administer locales'); +} + +/** + * Implementation of hook_user(). + */ +function locale_user($type, $edit, &$user, $category = NULL) { + $languages = locale_supported_languages(); + if ($type == 'form' && $category == 'account' && count($languages['name']) > 1) { + if ($user->language == '') { + $user->language = key($languages['name']); + } + return array(array('title' => t('Interface language settings'), 'data' => form_radios(t("Language"), 'language', $user->language, $languages['name'], t("Selecting a different locale will change the interface language of the site.")))); } } -function locale_delete($lid) { - db_query('DELETE FROM {locales} WHERE lid = %d', $lid); - locale_refresh_cache(); +// --------------------------------------------------------------------------------- +// Locale core functionality (needed on all page loads) + +/** + * Provides interface translation services + * + * This function is called from t() to translate a string if needed. + */ +function locale($string) { + global $locale; + static $locale_t; - drupal_set_message(t('deleted string')); -} + // Store database cached translations in a static var + if (!isset($locale_t)) { + $cache = cache_get("locale:$locale"); -function locale_save($lid) { - $edit =& $_POST['edit']; - foreach ($edit as $key => $value) { - db_query("UPDATE {locales} SET $key = '%s' WHERE lid = %d", $value, $lid); + if ($cache == 0) { + locale_refresh_cache(); + $cache = cache_get("locale:$locale"); + } + $locale_t = unserialize($cache->data); } - locale_refresh_cache(); - // delete form data so it will remember where it came from - $edit = ''; - - drupal_set_message(t('saved string')); -} -function locale_refresh_cache() { - global $languages; - - foreach (array_keys($languages) as $locale) { - /* - ** 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); - while ($data = db_fetch_object($result)) { - if (empty($data->$locale)) { - $t[$data->string] = $data->string; + // We have the translation cached (if it is TRUE, then there is no + // translation, so there is no point in checking the database) + if (isset($locale_t[$string])) { + $string = ($locale_t[$string] === TRUE ? $string : $locale_t[$string]); + } + + // We don't have this translation cached, so get it from the DB + else { + $result = db_query("SELECT s.lid, t.translation FROM {locales_source} s INNER JOIN {locales_target} t ON s.lid = t.lid WHERE s.source = '%s' AND t.locale = '%s'", $string, $locale); + // Translation found + if ($trans = db_fetch_object($result)) { + if (!empty($trans->translation)) { + $locale_t[$string] = $trans->translation; + $string = $trans->translation; } + } + + // Either we have no such source string, or no translation + else { + $result = db_query("SELECT lid, source FROM {locales_source} WHERE source = '%s'", $string); + // We have no such translation + if ($obj = db_fetch_object($result)) { + if ($locale) { + db_query("INSERT INTO {locales_target} (lid, locale) VALUES (%d, '%s')", $obj->lid, $locale); + } + } + // We have no such source string else { - $t[$data->string] = $data->$locale; + db_query("INSERT INTO {locales_source} (location, source) VALUES ('%s', '%s')", request_uri(), $string); + if ($locale) { + $lid = db_fetch_object(db_query("SELECT lid FROM {locales_source} WHERE location = '%s' AND source = '%s'", request_uri(), $string)); + db_query("INSERT INTO {locales_target} (lid, locale) VALUES (%d, '%s')", $lid->lid, $locale); + } } + // Clear locale cache in DB + cache_clear_all("locale:$locale"); } - cache_set("locale:$locale", serialize($t)); } -} -function locale_edit($lid) { - global $languages; - - $result = db_query("SELECT * FROM {locales} WHERE lid = '$lid'"); - if ($translation = db_fetch_object($result)) { + return $string; +} - $form .= form_item(t('Original text'), wordwrap(drupal_specialchars($translation->string, 0))); +/** + * Refreshes database stored cache of translations + * + * We only store short strings to improve performance and consume less memory. + */ +function locale_refresh_cache() { + $languages = locale_supported_languages(); - 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); + foreach (array_keys($languages['name']) as $locale) { + $result = db_query("SELECT s.source, t.translation, t.locale FROM {locales_source} s INNER JOIN {locales_target} t ON s.lid = t.lid WHERE t.locale = '%s' AND LENGTH(s.source) < 75", $locale); + while ($data = db_fetch_object($result)) { + $t[$data->source] = (empty($data->translation) ? TRUE : $data->translation); } - - $form .= form_submit(t('Save translations')); - - return form($form); + cache_set("locale:$locale", serialize($t)); } } -function locale_languages($translation) { - global $languages; +/** + * Returns list of languages supported on this site + * + * @param $reset Refresh cached language list + * @param $getall Return all languages (even disabled ones) + */ +function locale_supported_languages($reset = FALSE, $getall = FALSE) { + static $enabled = NULL; + static $all = NULL; - foreach ($languages as $key => $value) { - $output .= ($translation->$key) ? '<a href="#" title="'. $translation->$key ."\">$key</a> " : "<strike>$key</strike> "; + if ($reset) { + unset($enabled); unset($all); } - return $output; -} - -function locale_seek_query() { - $fields = array('string', 'language', 'status'); - if (is_array($_REQUEST['edit'])) { - foreach ($_REQUEST['edit'] as $key => $value) { - if (!empty($value) && in_array($key, $fields)) { - $query->$key = $value; + if (is_null($enabled)) { + $enabled = $all = array(); + $all['name'] = $all['formula'] = $enabled['name'] = $enabled['formula'] = array(); + $result = db_query('SELECT locale, name, formula, enabled FROM {locales_meta} ORDER BY isdefault DESC, enabled DESC, name ASC'); + while ($row = db_fetch_object($result)) { + $all['name'][$row->locale] = $row->name; + $all['formula'][$row->locale] = $row->formula; + if ($row->enabled) { + $enabled['name'][$row->locale] = $row->name; + $enabled['formula'][$row->locale] = $row->formula; } } } - else { - foreach ($_REQUEST as $key => $value) { - if (!empty($value) && in_array($key, $fields)) { - $query->$key = strpos(',', $value) ? explode(',', $value) : $value; - } + return $getall ? $all : $enabled; +} + +/** + * Returns plural form index for a specific number + * + * The index is computed from the formula of this language + */ +function locale_get_plural($count) { + global $locale; + static $locale_formula, $plurals = array(); + + if (!isset($plurals[$count])) { + if (!isset($locale_formula)) { + $languages = locale_supported_languages(); + $locale_formula = $languages['formula'][$locale]; + } + if ($locale_formula) { + $n = $count; + $plurals[$count] = @eval("return intval($locale_formula);"); + return $plurals[$count]; + } + else { + $plurals[$count] = -1; + return -1; } } - return $query; + return $plurals[$count]; } -function locale_seek() { - global $id, $languages; - $op = $_POST['op']; - $query = locale_seek_query(); - - if ($query) { - - if ($query->status) { - switch ($query->language) { - case 'all': - foreach ($languages as $key=>$value) { - $tmp[] = $key . (check_query($query->status) == 1 ? ' !=' : ' =') ." ''"; - } - $sql[] = implode(' AND ', $tmp); - break; - case 'any': - foreach ($languages as $key=>$value) { - $tmp[] = $key . (check_query($query->status) == 1 ? ' !=' : ' =') ." ''"; - } - $sql[] = '('. implode(' OR ', $tmp) .')'; - break; - default: - $sql[] = check_query($query->language) . (check_query($query->status) == 1 ? ' !=' : ' =') ." ''"; - } - } +// --------------------------------------------------------------------------------- +// Language management functionality (admininstration only) - 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) ."%'"; +/** + * Page handler for the language management screen + */ +function locale_admin_manage() { + include_once 'includes/locale.inc'; + $edit = &$_POST['edit']; + + switch ($_POST['op']) { + // Save changes to existing languages + case t('Save configuration'): + $languages = locale_supported_languages(FALSE, TRUE); + foreach($languages['name'] as $key => $value) { + if ($edit['sitedefault'] == $key) { + $edit['enabled'][$key] = 1; // autoenable the default language + } + if ($key == 'en') { + // Disallow name change for English locale + db_query("UPDATE {locales_meta} SET isdefault = %d, enabled = %d WHERE locale = 'en'", ($edit['sitedefault'] == $key), $edit['enabled'][$key]); } else { - foreach ($languages as $key=>$value) { - $string_query[] = check_query($key) ." LIKE '%". check_query($query->string) ."%'"; - } + db_query("UPDATE {locales_meta} SET name = '%s', isdefault = %d, enabled = %d WHERE locale = '%s'", $edit['name'][$key], ($edit['sitedefault'] == $key), $edit['enabled'][$key], $key); } } - $sql[] = '('. implode(' OR ', $string_query) .')'; - } + break; + + // Remove existing language + case t('Delete'): + $languages = locale_supported_languages(FALSE, TRUE); + if (isset($languages['name'][$edit['langcode']])) { + db_query("DELETE FROM {locales_meta} WHERE locale = '%s'", $edit['langcode']); + db_query("DELETE FROM {locales_target} WHERE locale = '%s'", $edit['langcode']); + drupal_set_message(t("'%locale' language removed.", array('%locale' => t($languages['name'][$edit['langcode']])))); + watchdog('locale', t("'%locale' language removed.", array('%locale' => $edit['langcode']))); + } + break; + } + print theme('page', _locale_admin_manage_screen()); +} - $result = pager_query('SELECT * FROM {locales} '. (count($sql) ? ' WHERE '. implode(' AND ', $sql) : '') .' ORDER BY string', 50); +/** + * User interface for the language deletion confirmation screen + */ +function locale_admin_manage_delete_screen() { + include_once 'includes/locale.inc'; + $langcode = arg(4); + + // Do not allow deletion of English locale + if ($langcode == 'en') { + drupal_goto('admin/locale/language/overview'); + return; + } + + // For other locales, warn user that data loss is ahead + $form = form_hidden('langcode', $langcode); + $form .= form_submit(t('Delete')); + $form .= form_submit(t('Cancel')); + $languages = locale_supported_languages(FALSE, TRUE); + print theme('page', form(form_item(t("Delete language '%name'", array('%name' => t($languages['name'][$langcode]))), $form, t('Are you sure you want to delete the language and all data associated with it?')), 'POST', url('admin/locale/language/overview'))); +} - $header = array(t('string'), (($query->status != 2 && strlen($query->language) == 2) ? t('translated string') : t('languages')), array('data' => t('operations'), 'colspan' => '2')); - while ($locale = db_fetch_object($result)) { - $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')); - } +/** + * Page handler for the language addition screen + */ +function locale_admin_manage_add() { + include_once 'includes/locale.inc'; + $edit = &$_POST['edit']; + $isocodes = _locale_get_iso639_list(); + + switch ($_POST['op']) { + // Try to add new language + case t('Add language'): + // Check for duplicates + if (db_num_rows(db_query("SELECT locale FROM {locales_meta} WHERE locale = '%s'", $edit['langcode'])) == 0) { + + // Set language name from the available list if needed + if ($edit['langcode'] && !$edit['langname'] && isset($isocodes[$edit['langcode']])) { + _locale_add_language($edit['langcode'], $isocodes[$edit['langcode']][0]); + drupal_goto('admin/locale'); + } + + // Add language, if we have the details + elseif ($edit['langcode'] && $edit['langname']) { + _locale_add_language($edit['langcode'], $edit['langname']); + drupal_goto('admin/locale'); + } - $request = array(); - if (count($query)) { - foreach ($query as $key => $value) { - $request[$key] = (is_array($value)) ? implode(',', $value) : $value; + // Seems like we have not received some data + drupal_set_message(t('You need to specify both the language code and the English name of the new language.'), 'error'); } - } + else { + drupal_set_message(t("The language '%language' (%code) is already set up.", array('%language' => $edit['langname'], '%code' => $edit['langcode'])), 'error'); + } + break; + } + print theme('page', _locale_admin_manage_add_screen()); +} - if ($pager = theme('pager', NULL, 50, 0, $request)) { - $rows[] = array(array('data' => "$pager", 'colspan' => '5')); - } +// --------------------------------------------------------------------------------- +// Gettext Portable Object import functionality (admininstration only) - $output .= theme('table', $header, $rows); +/** + * Page handler for the translation import screen + */ +function locale_admin_import() { + include_once 'includes/locale.inc'; + $edit = &$_POST['edit']; + switch ($_POST['op']) { + case t('Import'): + + // Add language, if not yet supported + $languages = locale_supported_languages(TRUE, TRUE); + if (!isset($languages['name'][$edit['langcode']])) { + $isocodes = _locale_get_iso639_list(); + _locale_add_language($edit['langcode'], $isocodes[$edit['langcode']][0], FALSE); + } + + // Now import strings into the language + $file = file_check_upload('file'); + if ($ret = _locale_import_po($file->path, $edit['langcode'], $edit['mode']) == FALSE) { + watchdog('error', 'Translation import failed.'); + watchdog('locale', 'Translation import failed.'); + } + drupal_goto('admin/locale'); + break; } - - return $output; + print theme('page', _locale_admin_import_screen()); } -function locale_seek_form() { - global $languages; - $edit =& $_POST['edit']; - $form .= form_textfield(t('Strings to search for'), 'string', $edit['string'], 30, 30, t('Leave blank to show all strings.')); - if (count($languages) > 1) { - $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)?')); - } - else { - foreach ($languages as $key => $value) { - $form .= form_hidden('language', $key); - } - } - $form .= form_radios(t('Status'), 'status', $edit['status'], array(2 => t('Untranslated'), 1 => t('Translated'), 0 => t('All'))); - $form .= form_submit(t('Search')); - $output .= form($form); +// --------------------------------------------------------------------------------- +// Gettext Portable Object export functionality (administration only) - return $output; +/** + * Page handler for the translation export screen + */ +function locale_admin_export() { + include_once 'includes/locale.inc'; + switch ($_POST['op']) { + case t('Export'): + _locale_export_po($_POST['edit']['langcode']); + break; + } + print theme('page', _locale_admin_export_screen()); } -function locale_admin() { - $op = $_POST['op']; - $edit =& $_POST['edit']; - if (empty($op)) { - $op = arg(2); - } +// --------------------------------------------------------------------------------- +// String search and editing functionality (admininstration only) + +/** + * Page handler for the string search and administration screen + */ +function locale_admin_string() { + include_once 'includes/locale.inc'; + $op = ($_POST['op'] ? $_POST['op'] : arg(3)); + $edit =& $_POST['edit']; switch ($op) { case 'delete': - $output .= locale_delete(check_query(arg(3))); - $output .= locale_seek(); + $output .= _locale_string_delete(check_query(arg(4))); + $output .= _locale_string_seek(); break; case 'edit': - $output .= locale_edit(check_query(arg(3))); - $output .= locale_seek(); - break; - case 'search': - if (locale_seek_query()) { - $output = locale_seek(); - } - $output .= locale_seek_form(); + $output .= _locale_string_edit(check_query(arg(4))); + $output .= _locale_string_seek(); break; case t('Search'): - $output = locale_seek(); - $output .= locale_seek_form(); + case 'search': + $output = _locale_string_seek(); + $output .= _locale_string_seek_form(); break; case t('Save translations'): - $output .= locale_save(check_query(arg(3))); - $output .= locale_seek_form(); + $output .= _locale_string_save(check_query(arg(4))); + drupal_goto('admin/locale/string/search'); 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(); } print theme('page', $output); } -/** - * Does the work of localizing a string of text. - * - * This function is called by the universally-used t() function each time - * an internationalized string is encountered. The string is then localized - * by this function if the locale module is enabled. - */ -function locale($string) { - global $locale; - static $locale_t; - - if (!isset($locale_t)) { - $cache = cache_get("locale:$locale"); - - if ($cache == 0) { - locale_refresh_cache(); - $cache = cache_get("locale:$locale"); - } - $locale_t = unserialize($cache->data); - } - - if (isset($locale_t[$string])) { - $string = $locale_t[$string]; - } - else { - $result = db_query("SELECT lid, $locale FROM {locales} WHERE string = '%s'", $string); - if ($trans = db_fetch_object($result)) { - if (!empty($trans->$locale)) { - $locale_t[$string] = $trans->$locale; - $string = $trans->$locale; - } - } - else { - db_query("INSERT INTO {locales} (string, location) VALUES ('%s', '%s')", $string, request_uri()); - cache_clear_all("locale:$locale"); - } - } - - return $string; -} - ?> diff --git a/modules/locale/locale.module b/modules/locale/locale.module index ad9fb326d793..7b13b5f8d33a 100644 --- a/modules/locale/locale.module +++ b/modules/locale/locale.module @@ -1,365 +1,452 @@ <?php // $Id$ +/** + * @file + * + * Enables administrators to manage the site interface languages. + * + * When enabled, the site interface can be displayed in different + * languages. The setup of languages and translations is completely + * we based. Gettext portable object files are supported. + */ + +// --------------------------------------------------------------------------------- +// Hook implementations (needed on all page loads) + /** * Implementation of hook_help(). */ -function locale_help($section) { +function locale_help($section = "admin/help#locale") { switch ($section) { + case 'admin/modules#description': + return t('Enables the translation of the user interface to languages other than English.'); + case 'admin/locale': + case 'admin/locale/language/overview': + return t("<p>Drupal allows you to translate the interface to a language other than English. This page provides an overview of the installed languages. You can add more languages on the <a href=\"%add-language\">add language page</a>, or directly by <a href=\"%import\">importing a translation</a>. If there are multiple languages enabled, registered users will be able to set their preference. The site default will be used for users without their own settings, including anonymous visitors.</p><p>There are different approaches to translate the Drupal interface: either by <a href=\"%import\">importing</a> an existing translation, by <a href=\"%search\">translating everything</a> yourself, or by using a combination of these.</p>", array("%search" => url("admin/locale/string/search"), "%import" => url("admin/locale/language/import"), "%add-language" => url("admin/locale/language/add"))); + case 'admin/locale/language/add': + return t("<p>You need to add all languages you would like to provide the site interface in. If you can't find the desired language in the quick add dropdown, then need to provide the proper language code yourself. The language code might be used to negotiate with browsers and present flags, so it is important to pick one that is standardised for the desired language. You can also add languages by <a href=\"%import\">importing translations</a> directly into a language not yet set up.</p>", array("%import" => url("admin/locale/language/import"))); + case 'admin/locale/language/import': + return t("<p>This page allows you to import a translation provided in the gettext Portable Object (.po) format. The easiest way to get your site translated is to grab an existing Drupal translation and to import it. You can obtain translations from the <a href=\"%url\">Drupal localization page</a>.</p>", array('%url' => 'http://drupal.org/localization')); + case 'admin/locale/language/export': + return t("<p>This page allows you to export Drupal strings. The first option is to export a translation so it can be shared. The second option is to generate a translation template, which contains all Drupal strings, but without their translations. You can use this template to start a new translation using a specialized desktop application.</p>"); + case 'admin/locale/string/search': + return t("<p>It is often more convinient to get the strings of your setup on the <a href=\"%export\">export page</a>, and start with a desktop Gettext translation editor though. Here you can search in the translated and untranslated strings, and the default English texts provided by Drupal.</p>", array("%export" => url("admin/locale/language/export"))); + case 'admin/help#locale': return t(" - <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>Most programs are written and documented in English, and primarily 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 to see their web site showing a lot less English, and far more of their own language. Therefore Drupal provides a framework to setup a multi-lingual web site, or to overwrite the default English texts.</p> + <h3>How to interface translation works</h3> + <p>Whenever Drupal encounters an interface string which needs to be displayed, it tries to translate it into the currently selected language. If a translation is not available, then the string is remembered, so you can look up untranslated strings easily.</p> + <p>Drupal provides two options to translate these strings. First is the integrated web interface, where you can search for untranslated strings, and specify their translations via simple web forms. An easier, and much less time consuming method is to import translations already done for your language. This is achieved by the use of GNU gettext Portable Object files. These are editable with quite convinient desktop editors specifically architected for supporting your work with GNU Gettext files. The import feature allows you to add strings from such files into the site database. The export functionality enables you to share your translations with others, generating Portable Object files from your site strings."); + break; + + // TODO: integrate a rewritten version of this help into the big help screen above + /* + "<p>To translate strings start at the <a href=\"%search\">search</a> page of the locale section in the administration pages. There you will see a list of the languages you have configured. Choose the appropriate settings and search for the strings you want to translate.</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 on 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>Below the text you can see an example URI where this text shows up one your site or a file and the line number in the source code. 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> - 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; - </pre>", array('%overview' => url('admin/locale'))); - break; - case 'admin/modules#description': - return t('Enables the translation of the user interface to languages other than English.'); - case 'admin/locale': - 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.'); - case 'admin/locale/search': - return t('Search the localization database. ("*" can be used as a wildcard)'); - } - -} - -/** - * Menu callback; prints locale-specific help text from admin/help. - */ -function locale_help_page() { - print theme('page', locale_help('admin/help#locale')); -} - -/** - * Implementation of hook_perm(). - */ -function locale_perm() { - return array('administer locales'); + <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 and code line numbers can come in handy.</p> + <h3>Uploading PO files</h3> + <p>PO files are files containing translations as used by <a href=\"%gettext\">GNU gettext</a>.</p> + <p>The Drupal project distributes user contributed PO files in a number of languages. These files can be obtained from the <a href=\"%translations\">Drupal translations</a> home page.</p> + <p>If you want to provide a PO file for a not yet supported language or update an existing PO files, read about it in the <a href=\"%handbook\">Drupal handbook</a> home page.</p> + <p>Once you got the appropriate PO file, all you have to do is to add the locale and upload it from the <a href=\"%addlocale\">manage locale</a> screen.</p> + <p>Note that uploading and parsing the uploaded file can take quite some time, depending on the connection to the server and the server's power.</p> + ", array("%search" => url("admin/locale/string/search"), "%addlocale" => url("admin/locale/languages/add"), "%translations" => 'http://www.Drupal.org/translations/', "%handbook" => 'http://www.Drupal.org/handbook/po-files', "%gettext" => 'http://www.gnu.org/software/gettext/gettext.html'));*/ + } } /** * Implementation of hook_menu(). */ function locale_menu() { - global $languages; $items = array(); $access = user_access('administer locales'); + // Main admin menu item $items[] = array('path' => 'admin/locale', 'title' => t('localization'), - 'callback' => 'locale_admin', 'access' => $access); - $items[] = array('path' => 'admin/locale/edit', 'title' => t('edit string'), - 'callback' => 'locale_admin', 'access' => $access, + 'callback' => 'locale_admin_manage', 'access' => $access); + + // Top level tabs + $items[] = array('path' => 'admin/locale/language', 'title' => t('manage languages'), + 'access' => $access, 'weight' => -10, 'type' => MENU_DEFAULT_LOCAL_TASK); + $items[] = array('path' => 'admin/locale/string/search', 'title' => t('manage strings'), + 'callback' => 'locale_admin_string', 'access' => $access, 'weight' => 10, + 'type' => MENU_LOCAL_TASK); + + // Manage languages subtabs + $items[] = array('path' => 'admin/locale/language/overview', 'title' => t('list'), + 'callback' => 'locale_admin_manage', 'access' => $access, "weight" => 0, + 'type' => MENU_DEFAULT_LOCAL_TASK); + $items[] = array('path' => 'admin/locale/language/add', 'title' => t('add language'), + 'callback' => 'locale_admin_manage_add', 'access' => $access, "weight" => 5, + 'type' => MENU_LOCAL_TASK); + $items[] = array('path' => 'admin/locale/language/import', 'title' => t('import'), + 'callback' => 'locale_admin_import', 'access' => $access, 'weight' => 10, + 'type' => MENU_LOCAL_TASK); + $items[] = array('path' => 'admin/locale/language/export', 'title' => t('export'), + 'callback' => 'locale_admin_export', 'access' => $access, 'weight' => 20, + 'type' => MENU_LOCAL_TASK); + + // Language related callbacks + $items[] = array('path' => 'admin/locale/language/delete', 'title' => t('confirm'), + 'callback' => 'locale_admin_manage_delete_screen', 'access' => $access, 'type' => MENU_CALLBACK); - $items[] = array('path' => 'admin/locale/delete', 'title' => t('delete string'), - 'callback' => 'locale_admin', 'access' => $access, - 'type' => MENU_CALLBACK); - - foreach ($languages as $key => $value) { - $items[] = array('path' => "admin/locale/$key", 'title' => $value, - 'callback' => 'locale_admin', 'access' => $access); - $items[] = array('path' => "admin/locale/$key/translated", 'title' => t('translated strings'), - 'callback' => 'locale_admin', 'access' => $access); - $items[] = array('path' => "admin/locale/$key/untranslated", 'title' => t('untranslated strings'), - 'callback' => 'locale_admin', 'access' => $access); - } - + + // String related callbacks + $items[] = array('path' => 'admin/locale/string/edit', 'title' => t('edit'), + 'callback' => 'locale_admin_string', 'access' => $access, 'type' => MENU_CALLBACK); + $items[] = array('path' => 'admin/locale/string/delete', 'title' => t('delete'), + 'callback' => 'locale_admin_string', 'access' => $access, 'type' => MENU_CALLBACK); return $items; } /** - * Implementation of hook_user(). Allows each user to select an interface language. + * Implementation of hook_perm(). */ -function locale_user($type, &$edit, &$user, $category = NULL) { - global $languages; - if ($type == 'form' && count($languages) > 1 && $category == 'account') { - return array(array( - 'title' => t('Locale settings'), - 'data' => form_radios(t('Language'), 'language', $user->language, $languages, t('Selecting a different language will change the language of the site.')), - 'weight' => 2)); +function locale_perm() { + return array('administer locales'); +} + +/** + * Implementation of hook_user(). + */ +function locale_user($type, $edit, &$user, $category = NULL) { + $languages = locale_supported_languages(); + if ($type == 'form' && $category == 'account' && count($languages['name']) > 1) { + if ($user->language == '') { + $user->language = key($languages['name']); + } + return array(array('title' => t('Interface language settings'), 'data' => form_radios(t("Language"), 'language', $user->language, $languages['name'], t("Selecting a different locale will change the interface language of the site.")))); } } -function locale_delete($lid) { - db_query('DELETE FROM {locales} WHERE lid = %d', $lid); - locale_refresh_cache(); +// --------------------------------------------------------------------------------- +// Locale core functionality (needed on all page loads) + +/** + * Provides interface translation services + * + * This function is called from t() to translate a string if needed. + */ +function locale($string) { + global $locale; + static $locale_t; - drupal_set_message(t('deleted string')); -} + // Store database cached translations in a static var + if (!isset($locale_t)) { + $cache = cache_get("locale:$locale"); -function locale_save($lid) { - $edit =& $_POST['edit']; - foreach ($edit as $key => $value) { - db_query("UPDATE {locales} SET $key = '%s' WHERE lid = %d", $value, $lid); + if ($cache == 0) { + locale_refresh_cache(); + $cache = cache_get("locale:$locale"); + } + $locale_t = unserialize($cache->data); } - locale_refresh_cache(); - // delete form data so it will remember where it came from - $edit = ''; - - drupal_set_message(t('saved string')); -} -function locale_refresh_cache() { - global $languages; - - foreach (array_keys($languages) as $locale) { - /* - ** 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); - while ($data = db_fetch_object($result)) { - if (empty($data->$locale)) { - $t[$data->string] = $data->string; + // We have the translation cached (if it is TRUE, then there is no + // translation, so there is no point in checking the database) + if (isset($locale_t[$string])) { + $string = ($locale_t[$string] === TRUE ? $string : $locale_t[$string]); + } + + // We don't have this translation cached, so get it from the DB + else { + $result = db_query("SELECT s.lid, t.translation FROM {locales_source} s INNER JOIN {locales_target} t ON s.lid = t.lid WHERE s.source = '%s' AND t.locale = '%s'", $string, $locale); + // Translation found + if ($trans = db_fetch_object($result)) { + if (!empty($trans->translation)) { + $locale_t[$string] = $trans->translation; + $string = $trans->translation; } + } + + // Either we have no such source string, or no translation + else { + $result = db_query("SELECT lid, source FROM {locales_source} WHERE source = '%s'", $string); + // We have no such translation + if ($obj = db_fetch_object($result)) { + if ($locale) { + db_query("INSERT INTO {locales_target} (lid, locale) VALUES (%d, '%s')", $obj->lid, $locale); + } + } + // We have no such source string else { - $t[$data->string] = $data->$locale; + db_query("INSERT INTO {locales_source} (location, source) VALUES ('%s', '%s')", request_uri(), $string); + if ($locale) { + $lid = db_fetch_object(db_query("SELECT lid FROM {locales_source} WHERE location = '%s' AND source = '%s'", request_uri(), $string)); + db_query("INSERT INTO {locales_target} (lid, locale) VALUES (%d, '%s')", $lid->lid, $locale); + } } + // Clear locale cache in DB + cache_clear_all("locale:$locale"); } - cache_set("locale:$locale", serialize($t)); } -} -function locale_edit($lid) { - global $languages; - - $result = db_query("SELECT * FROM {locales} WHERE lid = '$lid'"); - if ($translation = db_fetch_object($result)) { + return $string; +} - $form .= form_item(t('Original text'), wordwrap(drupal_specialchars($translation->string, 0))); +/** + * Refreshes database stored cache of translations + * + * We only store short strings to improve performance and consume less memory. + */ +function locale_refresh_cache() { + $languages = locale_supported_languages(); - 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); + foreach (array_keys($languages['name']) as $locale) { + $result = db_query("SELECT s.source, t.translation, t.locale FROM {locales_source} s INNER JOIN {locales_target} t ON s.lid = t.lid WHERE t.locale = '%s' AND LENGTH(s.source) < 75", $locale); + while ($data = db_fetch_object($result)) { + $t[$data->source] = (empty($data->translation) ? TRUE : $data->translation); } - - $form .= form_submit(t('Save translations')); - - return form($form); + cache_set("locale:$locale", serialize($t)); } } -function locale_languages($translation) { - global $languages; +/** + * Returns list of languages supported on this site + * + * @param $reset Refresh cached language list + * @param $getall Return all languages (even disabled ones) + */ +function locale_supported_languages($reset = FALSE, $getall = FALSE) { + static $enabled = NULL; + static $all = NULL; - foreach ($languages as $key => $value) { - $output .= ($translation->$key) ? '<a href="#" title="'. $translation->$key ."\">$key</a> " : "<strike>$key</strike> "; + if ($reset) { + unset($enabled); unset($all); } - return $output; -} - -function locale_seek_query() { - $fields = array('string', 'language', 'status'); - if (is_array($_REQUEST['edit'])) { - foreach ($_REQUEST['edit'] as $key => $value) { - if (!empty($value) && in_array($key, $fields)) { - $query->$key = $value; + if (is_null($enabled)) { + $enabled = $all = array(); + $all['name'] = $all['formula'] = $enabled['name'] = $enabled['formula'] = array(); + $result = db_query('SELECT locale, name, formula, enabled FROM {locales_meta} ORDER BY isdefault DESC, enabled DESC, name ASC'); + while ($row = db_fetch_object($result)) { + $all['name'][$row->locale] = $row->name; + $all['formula'][$row->locale] = $row->formula; + if ($row->enabled) { + $enabled['name'][$row->locale] = $row->name; + $enabled['formula'][$row->locale] = $row->formula; } } } - else { - foreach ($_REQUEST as $key => $value) { - if (!empty($value) && in_array($key, $fields)) { - $query->$key = strpos(',', $value) ? explode(',', $value) : $value; - } + return $getall ? $all : $enabled; +} + +/** + * Returns plural form index for a specific number + * + * The index is computed from the formula of this language + */ +function locale_get_plural($count) { + global $locale; + static $locale_formula, $plurals = array(); + + if (!isset($plurals[$count])) { + if (!isset($locale_formula)) { + $languages = locale_supported_languages(); + $locale_formula = $languages['formula'][$locale]; + } + if ($locale_formula) { + $n = $count; + $plurals[$count] = @eval("return intval($locale_formula);"); + return $plurals[$count]; + } + else { + $plurals[$count] = -1; + return -1; } } - return $query; + return $plurals[$count]; } -function locale_seek() { - global $id, $languages; - $op = $_POST['op']; - $query = locale_seek_query(); - - if ($query) { - - if ($query->status) { - switch ($query->language) { - case 'all': - foreach ($languages as $key=>$value) { - $tmp[] = $key . (check_query($query->status) == 1 ? ' !=' : ' =') ." ''"; - } - $sql[] = implode(' AND ', $tmp); - break; - case 'any': - foreach ($languages as $key=>$value) { - $tmp[] = $key . (check_query($query->status) == 1 ? ' !=' : ' =') ." ''"; - } - $sql[] = '('. implode(' OR ', $tmp) .')'; - break; - default: - $sql[] = check_query($query->language) . (check_query($query->status) == 1 ? ' !=' : ' =') ." ''"; - } - } +// --------------------------------------------------------------------------------- +// Language management functionality (admininstration only) - 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) ."%'"; +/** + * Page handler for the language management screen + */ +function locale_admin_manage() { + include_once 'includes/locale.inc'; + $edit = &$_POST['edit']; + + switch ($_POST['op']) { + // Save changes to existing languages + case t('Save configuration'): + $languages = locale_supported_languages(FALSE, TRUE); + foreach($languages['name'] as $key => $value) { + if ($edit['sitedefault'] == $key) { + $edit['enabled'][$key] = 1; // autoenable the default language + } + if ($key == 'en') { + // Disallow name change for English locale + db_query("UPDATE {locales_meta} SET isdefault = %d, enabled = %d WHERE locale = 'en'", ($edit['sitedefault'] == $key), $edit['enabled'][$key]); } else { - foreach ($languages as $key=>$value) { - $string_query[] = check_query($key) ." LIKE '%". check_query($query->string) ."%'"; - } + db_query("UPDATE {locales_meta} SET name = '%s', isdefault = %d, enabled = %d WHERE locale = '%s'", $edit['name'][$key], ($edit['sitedefault'] == $key), $edit['enabled'][$key], $key); } } - $sql[] = '('. implode(' OR ', $string_query) .')'; - } + break; + + // Remove existing language + case t('Delete'): + $languages = locale_supported_languages(FALSE, TRUE); + if (isset($languages['name'][$edit['langcode']])) { + db_query("DELETE FROM {locales_meta} WHERE locale = '%s'", $edit['langcode']); + db_query("DELETE FROM {locales_target} WHERE locale = '%s'", $edit['langcode']); + drupal_set_message(t("'%locale' language removed.", array('%locale' => t($languages['name'][$edit['langcode']])))); + watchdog('locale', t("'%locale' language removed.", array('%locale' => $edit['langcode']))); + } + break; + } + print theme('page', _locale_admin_manage_screen()); +} - $result = pager_query('SELECT * FROM {locales} '. (count($sql) ? ' WHERE '. implode(' AND ', $sql) : '') .' ORDER BY string', 50); +/** + * User interface for the language deletion confirmation screen + */ +function locale_admin_manage_delete_screen() { + include_once 'includes/locale.inc'; + $langcode = arg(4); + + // Do not allow deletion of English locale + if ($langcode == 'en') { + drupal_goto('admin/locale/language/overview'); + return; + } + + // For other locales, warn user that data loss is ahead + $form = form_hidden('langcode', $langcode); + $form .= form_submit(t('Delete')); + $form .= form_submit(t('Cancel')); + $languages = locale_supported_languages(FALSE, TRUE); + print theme('page', form(form_item(t("Delete language '%name'", array('%name' => t($languages['name'][$langcode]))), $form, t('Are you sure you want to delete the language and all data associated with it?')), 'POST', url('admin/locale/language/overview'))); +} - $header = array(t('string'), (($query->status != 2 && strlen($query->language) == 2) ? t('translated string') : t('languages')), array('data' => t('operations'), 'colspan' => '2')); - while ($locale = db_fetch_object($result)) { - $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')); - } +/** + * Page handler for the language addition screen + */ +function locale_admin_manage_add() { + include_once 'includes/locale.inc'; + $edit = &$_POST['edit']; + $isocodes = _locale_get_iso639_list(); + + switch ($_POST['op']) { + // Try to add new language + case t('Add language'): + // Check for duplicates + if (db_num_rows(db_query("SELECT locale FROM {locales_meta} WHERE locale = '%s'", $edit['langcode'])) == 0) { + + // Set language name from the available list if needed + if ($edit['langcode'] && !$edit['langname'] && isset($isocodes[$edit['langcode']])) { + _locale_add_language($edit['langcode'], $isocodes[$edit['langcode']][0]); + drupal_goto('admin/locale'); + } + + // Add language, if we have the details + elseif ($edit['langcode'] && $edit['langname']) { + _locale_add_language($edit['langcode'], $edit['langname']); + drupal_goto('admin/locale'); + } - $request = array(); - if (count($query)) { - foreach ($query as $key => $value) { - $request[$key] = (is_array($value)) ? implode(',', $value) : $value; + // Seems like we have not received some data + drupal_set_message(t('You need to specify both the language code and the English name of the new language.'), 'error'); } - } + else { + drupal_set_message(t("The language '%language' (%code) is already set up.", array('%language' => $edit['langname'], '%code' => $edit['langcode'])), 'error'); + } + break; + } + print theme('page', _locale_admin_manage_add_screen()); +} - if ($pager = theme('pager', NULL, 50, 0, $request)) { - $rows[] = array(array('data' => "$pager", 'colspan' => '5')); - } +// --------------------------------------------------------------------------------- +// Gettext Portable Object import functionality (admininstration only) - $output .= theme('table', $header, $rows); +/** + * Page handler for the translation import screen + */ +function locale_admin_import() { + include_once 'includes/locale.inc'; + $edit = &$_POST['edit']; + switch ($_POST['op']) { + case t('Import'): + + // Add language, if not yet supported + $languages = locale_supported_languages(TRUE, TRUE); + if (!isset($languages['name'][$edit['langcode']])) { + $isocodes = _locale_get_iso639_list(); + _locale_add_language($edit['langcode'], $isocodes[$edit['langcode']][0], FALSE); + } + + // Now import strings into the language + $file = file_check_upload('file'); + if ($ret = _locale_import_po($file->path, $edit['langcode'], $edit['mode']) == FALSE) { + watchdog('error', 'Translation import failed.'); + watchdog('locale', 'Translation import failed.'); + } + drupal_goto('admin/locale'); + break; } - - return $output; + print theme('page', _locale_admin_import_screen()); } -function locale_seek_form() { - global $languages; - $edit =& $_POST['edit']; - $form .= form_textfield(t('Strings to search for'), 'string', $edit['string'], 30, 30, t('Leave blank to show all strings.')); - if (count($languages) > 1) { - $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)?')); - } - else { - foreach ($languages as $key => $value) { - $form .= form_hidden('language', $key); - } - } - $form .= form_radios(t('Status'), 'status', $edit['status'], array(2 => t('Untranslated'), 1 => t('Translated'), 0 => t('All'))); - $form .= form_submit(t('Search')); - $output .= form($form); +// --------------------------------------------------------------------------------- +// Gettext Portable Object export functionality (administration only) - return $output; +/** + * Page handler for the translation export screen + */ +function locale_admin_export() { + include_once 'includes/locale.inc'; + switch ($_POST['op']) { + case t('Export'): + _locale_export_po($_POST['edit']['langcode']); + break; + } + print theme('page', _locale_admin_export_screen()); } -function locale_admin() { - $op = $_POST['op']; - $edit =& $_POST['edit']; - if (empty($op)) { - $op = arg(2); - } +// --------------------------------------------------------------------------------- +// String search and editing functionality (admininstration only) + +/** + * Page handler for the string search and administration screen + */ +function locale_admin_string() { + include_once 'includes/locale.inc'; + $op = ($_POST['op'] ? $_POST['op'] : arg(3)); + $edit =& $_POST['edit']; switch ($op) { case 'delete': - $output .= locale_delete(check_query(arg(3))); - $output .= locale_seek(); + $output .= _locale_string_delete(check_query(arg(4))); + $output .= _locale_string_seek(); break; case 'edit': - $output .= locale_edit(check_query(arg(3))); - $output .= locale_seek(); - break; - case 'search': - if (locale_seek_query()) { - $output = locale_seek(); - } - $output .= locale_seek_form(); + $output .= _locale_string_edit(check_query(arg(4))); + $output .= _locale_string_seek(); break; case t('Search'): - $output = locale_seek(); - $output .= locale_seek_form(); + case 'search': + $output = _locale_string_seek(); + $output .= _locale_string_seek_form(); break; case t('Save translations'): - $output .= locale_save(check_query(arg(3))); - $output .= locale_seek_form(); + $output .= _locale_string_save(check_query(arg(4))); + drupal_goto('admin/locale/string/search'); 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(); } print theme('page', $output); } -/** - * Does the work of localizing a string of text. - * - * This function is called by the universally-used t() function each time - * an internationalized string is encountered. The string is then localized - * by this function if the locale module is enabled. - */ -function locale($string) { - global $locale; - static $locale_t; - - if (!isset($locale_t)) { - $cache = cache_get("locale:$locale"); - - if ($cache == 0) { - locale_refresh_cache(); - $cache = cache_get("locale:$locale"); - } - $locale_t = unserialize($cache->data); - } - - if (isset($locale_t[$string])) { - $string = $locale_t[$string]; - } - else { - $result = db_query("SELECT lid, $locale FROM {locales} WHERE string = '%s'", $string); - if ($trans = db_fetch_object($result)) { - if (!empty($trans->$locale)) { - $locale_t[$string] = $trans->$locale; - $string = $trans->$locale; - } - } - else { - db_query("INSERT INTO {locales} (string, location) VALUES ('%s', '%s')", $string, request_uri()); - cache_clear_all("locale:$locale"); - } - } - - return $string; -} - ?> diff --git a/modules/node.module b/modules/node.module index e01353ec6c2f..d619b0063f48 100644 --- a/modules/node.module +++ b/modules/node.module @@ -994,7 +994,8 @@ function node_block($op = 'list', $delta = 0) { * The link should be an absolute URL. */ function node_feed($nodes = 0, $channel = array()) { - global $base_url, $languages; + global $base_url; + $languages = (function_exists('locale')) ? locale_supported_languages() : array(); if (!$nodes) { $nodes = db_query_range('SELECT nid FROM {node} WHERE promote = 1 AND status = 1 ORDER BY created DESC', 0, 15); @@ -1012,7 +1013,7 @@ function node_feed($nodes = 0, $channel = array()) { 'title' => variable_get('site_name', 'drupal') .' - '. variable_get('site_slogan', ''), 'link' => $base_url, 'description' => variable_get('site_mission', ''), - 'language' => (($key = reset(array_keys($languages))) ? $key : 'en') + 'language' => (($key = reset(array_keys($languages['name']))) ? $key : 'en') ); $channel = array_merge($channel_defaults, $channel); diff --git a/modules/node/node.module b/modules/node/node.module index e01353ec6c2f..d619b0063f48 100644 --- a/modules/node/node.module +++ b/modules/node/node.module @@ -994,7 +994,8 @@ function node_block($op = 'list', $delta = 0) { * The link should be an absolute URL. */ function node_feed($nodes = 0, $channel = array()) { - global $base_url, $languages; + global $base_url; + $languages = (function_exists('locale')) ? locale_supported_languages() : array(); if (!$nodes) { $nodes = db_query_range('SELECT nid FROM {node} WHERE promote = 1 AND status = 1 ORDER BY created DESC', 0, 15); @@ -1012,7 +1013,7 @@ function node_feed($nodes = 0, $channel = array()) { 'title' => variable_get('site_name', 'drupal') .' - '. variable_get('site_slogan', ''), 'link' => $base_url, 'description' => variable_get('site_mission', ''), - 'language' => (($key = reset(array_keys($languages))) ? $key : 'en') + 'language' => (($key = reset(array_keys($languages['name']))) ? $key : 'en') ); $channel = array_merge($channel_defaults, $channel); diff --git a/update.php b/update.php index 39cbe5c7ac60..f021cea84537 100644 --- a/update.php +++ b/update.php @@ -109,7 +109,7 @@ function update_info() { print "</ol>"; print "Notes:"; print "<ol>"; - print " <li>If you <strong>upgrade from Drupal 4.4.x</strong>, you will need to create the <code>users_roles</code> table manually before upgrading. To create the <code>users_roles</code> table, issue the following SQL commands: + print " <li>If you <strong>upgrade from Drupal 4.4.x</strong>, you will need to create the <code>users_roles</code> and <code>locales_meta</code> tables manually before upgrading. To create these tables, issue the following SQL commands: <p>MySQL specific example: <pre> @@ -118,6 +118,15 @@ function update_info() { rid int(10) unsigned NOT NULL default '0', PRIMARY KEY (uid, rid) ); + CREATE TABLE locales_meta ( + locale varchar(12) NOT NULL default '', + name varchar(64) NOT NULL default '', + enabled int(2) NOT NULL default '0', + isdefault int(2) NOT NULL default '0', + plurals int(1) NOT NULL default '0', + formula varchar(128) NOT NULL default '', + PRIMARY KEY (locale) + ); </pre> </p> @@ -128,6 +137,15 @@ function update_info() { rid integer NOT NULL default '0', PRIMARY KEY (uid, rid) ); + CREATE TABLE locales_meta ( + locale varchar(12) NOT NULL default '', + name varchar(64) NOT NULL default '', + enabled int4 NOT NULL default '0', + isdefault int4 NOT NULL default '0', + plurals int4 NOT NULL default '0', + formula varchar(128) NOT NULL default '', + PRIMARY KEY (locale) + ); </pre> </p> </li>"; -- GitLab