Newer
Older
Dries Buytaert
committed
<?php
Dries Buytaert
committed
/**
* Implementation of hook_install().
*/
Dries Buytaert
committed
function locale_install() {
Neil Drumm
committed
// locales_source.source and locales_target.target are not used as binary
// fields; non-MySQL database servers need to ensure the field type is text
// and that LIKE produces a case-sensitive comparison.
Dries Buytaert
committed
// Create tables.
drupal_install_schema('locale');
Gábor Hojtsy
committed
db_query("INSERT INTO {languages} (language, name, native, direction, enabled, weight, javascript) VALUES ('en', 'English', 'English', '0', '1', '0', '')");
Dries Buytaert
committed
}
/**
* @defgroup updates-5.x-to-6.x Locale updates from 5.x to 6.x
* @{
*/
/**
* {locales_meta} table became {languages}.
*/
Dries Buytaert
committed
function locale_update_6000() {
Dries Buytaert
committed
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
$schema['languages'] = array(
'fields' => array(
'language' => array(
'type' => 'varchar',
'length' => 12,
'not null' => TRUE,
'default' => '',
),
'name' => array(
'type' => 'varchar',
'length' => 64,
'not null' => TRUE,
'default' => '',
),
'native' => array(
'type' => 'varchar',
'length' => 64,
'not null' => TRUE,
'default' => '',
),
'direction' => array(
'type' => 'int',
'not null' => TRUE,
'default' => 0,
),
'enabled' => array(
'type' => 'int',
'not null' => TRUE,
'default' => 0,
),
'plurals' => array(
'type' => 'int',
'not null' => TRUE,
'default' => 0,
),
'formula' => array(
'type' => 'varchar',
'length' => 128,
'not null' => TRUE,
'default' => '',
),
'domain' => array(
'type' => 'varchar',
'length' => 128,
'not null' => TRUE,
'default' => '',
),
'prefix' => array(
'type' => 'varchar',
'length' => 128,
'not null' => TRUE,
'default' => '',
),
'weight' => array(
'type' => 'int',
'not null' => TRUE,
'default' => 0,
),
'javascript' => array( //Adds a column to store the filename of the JavaScript translation file.
'type' => 'varchar',
'length' => 32,
'not null' => TRUE,
'default' => '',
),
),
'primary key' => array('language'),
'indexes' => array(
'list' => array('weight', 'name'),
),
);
db_create_table($ret, 'languages', $schema['languages']);
// Save the languages
$ret[] = update_sql("INSERT INTO {languages} (language, name, native, direction, enabled, plurals, formula, domain, prefix, weight) SELECT locale, name, name, 0, enabled, plurals, formula, '', locale, 0 FROM {locales_meta}");
// Save the language count in the variable table
$count = db_result(db_query('SELECT COUNT(*) FROM {languages} WHERE enabled = 1'));
variable_set('language_count', $count);
// Save the default language in the variable table
$default = db_fetch_object(db_query('SELECT * FROM {locales_meta} WHERE isdefault = 1'));
variable_set('language_default', (object) array('language' => $default->locale, 'name' => $default->name, 'native' => '', 'direction' => 0, 'enabled' => 1, 'plurals' => $default->plurals, 'formula' => $default->formula, 'domain' => '', 'prefix' => $default->locale, 'weight' => 0));
$ret[] = update_sql("DROP TABLE {locales_meta}");
return $ret;
}
/**
* Change locale column to language. The language column is added by
* update_fix_d6_requirements() in update.php to avoid a large number
* of error messages from update.php. All we need to do here is copy
* locale to language and then drop locale.
*/
Dries Buytaert
committed
function locale_update_6001() {
$ret = array();
$ret[] = update_sql('UPDATE {locales_target} SET language = locale');
db_drop_field($ret, 'locales_target', 'locale');
return $ret;
}
/**
* Remove empty translations, we don't need these anymore.
*/
Dries Buytaert
committed
function locale_update_6002() {
$ret = array();
$ret[] = update_sql("DELETE FROM {locales_target} WHERE translation = ''");
return $ret;
}
/**
* Prune strings with no translations (will be automatically re-registered if still in use)
*/
Dries Buytaert
committed
function locale_update_6003() {
$ret = array();
$ret[] = update_sql("DELETE FROM {locales_source} WHERE lid NOT IN (SELECT lid FROM {locales_target})");
return $ret;
}
/**
* Fix remaining inconsistent indexes.
*/
Dries Buytaert
committed
function locale_update_6004() {
$ret = array();
db_add_index($ret, 'locales_target', 'language', array('language'));
switch ($GLOBALS['db_type']) {
case 'pgsql':
db_drop_index($ret, 'locales_source', 'source');
db_add_index($ret, 'locales_source', 'source', array(array('source', 30)));
break;
}
return $ret;
}
Gábor Hojtsy
committed
/**
* Change language setting variable of content types.
Gábor Hojtsy
committed
*
Gábor Hojtsy
committed
* Use language_content_type_<content_type> instead of language_<content_type>
* so content types such as 'default', 'count' or 'negotiation' will not
Gábor Hojtsy
committed
* interfere with language variables.
Gábor Hojtsy
committed
*/
function locale_update_6005() {
foreach (node_get_types() as $type => $content_type) {
// Default to NULL, so we can skip dealing with non-existent settings.
$setting = variable_get('language_'. $type, NULL);
if ($type == 'default' && is_numeric($setting)) {
// language_default was overwritten with the content type setting,
// so reset the default language and save the content type setting.
variable_set('language_content_type_default', $setting);
variable_del('language_default');
drupal_set_message('The default language setting has been reset to its default value. Check the '. l('language configuration page', 'admin/settings/language') .' to configure it correctly.');
}
elseif ($type == 'negotiation') {
Gábor Hojtsy
committed
// language_content_type_negotiation is an integer either if it is
// the negotiation setting or the content type setting.
// The language_negotiation setting is not reset, but
Gábor Hojtsy
committed
// the user is alerted that this setting possibly was overwritten
variable_set('language_content_type_negotiation', $setting);
drupal_set_message('The language negotiation setting was possibly overwritten by a content type of the same name. Check the '. l('language configuration page', 'admin/settings/language/configure') .' and the '. l('<em>'. $content_type->name ."</em> content type's multilingual support settings", 'admin/content/types/negotiation', array('html' => TRUE)) .' to configure them correctly.');
}
elseif (!is_null($setting)) {
// Change the language setting variable for any other content type.
// Do not worry about language_count, it will be updated below.
variable_set('language_content_type_'. $type, $setting);
variable_del('language_'. $type);
}
}
// Update language count variable that might be overwritten.
$count = db_result(db_query('SELECT COUNT(*) FROM {languages} WHERE enabled = 1'));
variable_set('language_count', $count);
return array();
}
/**
* Neutralize unsafe language names in the database.
*/
function locale_update_6006() {
$ret = array();
$matches = db_result(db_query("SELECT 1 FROM {languages} WHERE native LIKE '%<%' OR native LIKE '%>%' OR name LIKE '%<%' OR name LIKE '%>%'"));
if ($matches) {
$ret[] = update_sql("UPDATE {languages} SET name = REPLACE(name, '<', ''), native = REPLACE(native, '<', '')");
$ret[] = update_sql("UPDATE {languages} SET name = REPLACE(name, '>', ''), native = REPLACE(native, '>', '')");
drupal_set_message('The language name in English and the native language name values of all the existing custom languages of your site have been sanitized for security purposes. Visit the <a href="'. url('admin/settings/language') .'">Languages</a> page to check these and fix them if necessary.', 'warning');
}
// Check if some langcode values contain potentially dangerous characters and
// warn the user if so. These are not fixed since they are referenced in other
// tables (e.g. {node}).
if (db_result(db_query("SELECT 1 FROM {languages} WHERE language LIKE '%<%' OR language LIKE '%>%' OR language LIKE '%\"%' OR language LIKE '%\\\\\%'"))) {
drupal_set_message('Some of your custom language code values contain invalid characters. You should examine the <a href="'. url('admin/settings/language') .'">Languages</a> page. These must be fixed manually.', 'error');
}
return $ret;
}
/**
* @} End of "defgroup updates-5.x-to-6.x"
*/
/**
* Implementation of hook_uninstall().
*/
function locale_uninstall() {
Gábor Hojtsy
committed
// Delete all JavaScript translation files
$files = db_query('SELECT javascript FROM {languages}');
while ($file = db_fetch_object($files)) {
if (!empty($file)) {
file_delete(file_create_path($file->javascript));
}
}
Gábor Hojtsy
committed
// Clear variables.
variable_del('language_default');
variable_del('language_count');
variable_del('language_content_type_default');
variable_del('language_content_type_negotiation');
variable_del('locale_cache_strings');
variable_del('locale_js_directory');
variable_del('javascript_parsed');
variable_del('language_negotiation');
foreach (node_get_types() as $type => $content_type) {
variable_del("language_content_type_$type");
}
// Switch back to English: with a $language->language value different from
// 'en' successive calls of t() might result in calling locale(), which in
// turn might try to query the unexisting {locales_source} and
// {locales_target} tables.
drupal_init_language();
Dries Buytaert
committed
// Remove tables.
drupal_uninstall_schema('locale');
Dries Buytaert
committed
/**
* Implementation of hook_schema().
*/
function locale_schema() {
$schema['languages'] = array(
Gábor Hojtsy
committed
'description' => 'List of all available languages in the system.',
Dries Buytaert
committed
'fields' => array(
'language' => array(
'type' => 'varchar',
'length' => 12,
'not null' => TRUE,
'default' => '',
Gábor Hojtsy
committed
'description' => "Language code, e.g. 'de' or 'en-US'.",
),
'name' => array(
'type' => 'varchar',
'length' => 64,
'not null' => TRUE,
'default' => '',
Gábor Hojtsy
committed
'description' => 'Language name in English.',
),
'native' => array(
'type' => 'varchar',
'length' => 64,
'not null' => TRUE,
'default' => '',
Gábor Hojtsy
committed
'description' => 'Native language name.',
),
'direction' => array(
'type' => 'int',
'not null' => TRUE,
'default' => 0,
Gábor Hojtsy
committed
'description' => 'Direction of language (Left-to-Right = 0, Right-to-Left = 1).',
),
'enabled' => array(
'type' => 'int',
'not null' => TRUE,
'default' => 0,
Gábor Hojtsy
committed
'description' => 'Enabled flag (1 = Enabled, 0 = Disabled).',
),
'plurals' => array(
'type' => 'int',
'not null' => TRUE,
'default' => 0,
Gábor Hojtsy
committed
'description' => 'Number of plural indexes in this language.',
),
'formula' => array(
'type' => 'varchar',
'length' => 128,
'not null' => TRUE,
'default' => '',
Gábor Hojtsy
committed
'description' => 'Plural formula in PHP code to evaluate to get plural indexes.',
),
'domain' => array(
'type' => 'varchar',
'length' => 128,
'not null' => TRUE,
'default' => '',
Gábor Hojtsy
committed
'description' => 'Domain to use for this language.',
),
'prefix' => array(
'type' => 'varchar',
'length' => 128,
'not null' => TRUE,
'default' => '',
Gábor Hojtsy
committed
'description' => 'Path prefix to use for this language.',
),
'weight' => array(
'type' => 'int',
'not null' => TRUE,
'default' => 0,
Gábor Hojtsy
committed
'description' => 'Weight, used in lists of languages.',
),
'javascript' => array(
'type' => 'varchar',
'length' => 32,
'not null' => TRUE,
'default' => '',
Gábor Hojtsy
committed
'description' => 'Location of JavaScript translation file.',
Dries Buytaert
committed
),
'primary key' => array('language'),
Dries Buytaert
committed
'indexes' => array(
'list' => array('weight', 'name'),
),
Dries Buytaert
committed
);
$schema['locales_source'] = array(
Gábor Hojtsy
committed
'description' => 'List of English source strings.',
Dries Buytaert
committed
'fields' => array(
'lid' => array(
'type' => 'serial',
'not null' => TRUE,
Gábor Hojtsy
committed
'description' => 'Unique identifier of this string.',
),
'location' => array(
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
'default' => '',
Gábor Hojtsy
committed
'description' => 'Drupal path in case of online discovered translations or file path in case of imported strings.',
),
'textgroup' => array(
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
'default' => 'default',
Gábor Hojtsy
committed
'description' => 'A module defined group of translations, see hook_locale().',
),
'source' => array(
'type' => 'text',
'mysql_type' => 'blob',
'not null' => TRUE,
Gábor Hojtsy
committed
'description' => 'The original string in English.',
),
'version' => array(
'type' => 'varchar',
'length' => 20,
'not null' => TRUE,
'default' => 'none',
Gábor Hojtsy
committed
'description' => 'Version of Drupal, where the string was last used (for locales optimization).',
Dries Buytaert
committed
),
'primary key' => array('lid'),
Dries Buytaert
committed
'indexes' => array(
'source' => array(array('source', 30)),
),
Dries Buytaert
committed
);
$schema['locales_target'] = array(
Gábor Hojtsy
committed
'description' => 'Stores translated versions of strings.',
Dries Buytaert
committed
'fields' => array(
'lid' => array(
'type' => 'int',
'not null' => TRUE,
'default' => 0,
Gábor Hojtsy
committed
'description' => 'Source string ID. References {locales_source}.lid.',
),
'translation' => array(
'type' => 'text',
'mysql_type' => 'blob',
'not null' => TRUE,
Gábor Hojtsy
committed
'description' => 'Translation string value in this language.',
),
'language' => array(
'type' => 'varchar',
'length' => 12,
'not null' => TRUE,
'default' => '',
Gábor Hojtsy
committed
'description' => 'Language code. References {languages}.language.',
),
'plid' => array(
'type' => 'int',
Dries Buytaert
committed
'not null' => TRUE, // This should be NULL for no referenced string, not zero.
'default' => 0,
Gábor Hojtsy
committed
'description' => 'Parent lid (lid of the previous string in the plural chain) in case of plural strings. References {locales_source}.lid.',
),
'plural' => array(
'type' => 'int',
'not null' => TRUE,
'default' => 0,
Gábor Hojtsy
committed
'description' => 'Plural index number in case of plural strings.',
Dries Buytaert
committed
),
Dries Buytaert
committed
'primary key' => array('language', 'lid', 'plural'),
Dries Buytaert
committed
'indexes' => array(
Dries Buytaert
committed
'lid' => array('lid'),
'plid' => array('plid'),
'plural' => array('plural'),
Dries Buytaert
committed
),
);
return $schema;
}