locale.install 14.8 KB
Newer Older
1 2
<?php

3 4 5
/**
 * Implementation of hook_install().
 */
6
function locale_install() {
7 8 9
  // 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.
10

11 12
  // Create tables.
  drupal_install_schema('locale');
13

14
  db_query("INSERT INTO {languages} (language, name, native, direction, enabled, weight, javascript) VALUES ('en', 'English', 'English', '0', '1', '0', '')");
15
}
16

17 18 19 20 21 22 23 24
/**
 * @defgroup updates-5.x-to-6.x Locale updates from 5.x to 6.x
 * @{
 */

/**
 * {locales_meta} table became {languages}.
 */
25
function locale_update_6000() {
26
  $ret = array();
27 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

  $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']);
100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121

  // 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.
 */
122
function locale_update_6001() {
123 124 125 126 127 128 129 130 131
  $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.
 */
132
function locale_update_6002() {
133 134 135 136 137 138 139 140
  $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)
 */
141
function locale_update_6003() {
142 143 144 145 146 147 148 149
  $ret = array();
  $ret[] = update_sql("DELETE FROM {locales_source} WHERE lid NOT IN (SELECT lid FROM {locales_target})");
  return $ret;
}

/**
 * Fix remaining inconsistent indexes.
 */
150
function locale_update_6004() {
151 152 153 154 155 156 157 158 159 160 161 162 163
  $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;
}

164 165
/**
 * Change language setting variable of content types.
166
 *
167 168
 * Use language_content_type_<content_type> instead of language_<content_type>
 * so content types such as 'default', 'count' or 'negotiation' will not
169
 * interfere with language variables.
170 171 172 173 174 175 176 177 178 179 180 181 182
 */
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') {
183 184 185
      // 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
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202
      // 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();
}

Gábor Hojtsy's avatar
Gábor Hojtsy committed
203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222
/**
 * 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;
}

223 224 225 226
/**
 * @} End of "defgroup updates-5.x-to-6.x"
 */

227 228 229 230 231 232 233 234 235
/**
 * @defgroup updates-6.x-extra Locale updates for 6.x
 * @{
 */

/**
 * Fix Drupal.formatPlural().
 */
function locale_update_6007() {
236
  drupal_load('module', 'locale');
237 238 239 240 241 242 243 244 245
  locale_inc_callback('_locale_invalidate_js');
  return array();
}

/**
 * @} End of "defgroup updates-6.x-extra"
 * The next series of updates should start at 7000.
 */

246 247 248 249
/**
 * Implementation of hook_uninstall().
 */
function locale_uninstall() {
250 251 252 253 254 255 256 257
  // 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));
    }
  }

258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277
  // 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();

278 279
  // Remove tables.
  drupal_uninstall_schema('locale');
280
}
281 282 283 284 285 286

/**
 * Implementation of hook_schema().
 */
function locale_schema() {
  $schema['languages'] = array(
287
    'description' => 'List of all available languages in the system.',
288
    'fields' => array(
289 290 291 292 293
      'language' => array(
        'type' => 'varchar',
        'length' => 12,
        'not null' => TRUE,
        'default' => '',
294
        'description' => "Language code, e.g. 'de' or 'en-US'.",
295 296 297 298 299 300
      ),
      'name' => array(
        'type' => 'varchar',
        'length' => 64,
        'not null' => TRUE,
        'default' => '',
301
        'description' => 'Language name in English.',
302 303 304 305 306 307
      ),
      'native' => array(
        'type' => 'varchar',
        'length' => 64,
        'not null' => TRUE,
        'default' => '',
308
        'description' => 'Native language name.',
309 310 311 312 313
      ),
      'direction' => array(
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
314
        'description' => 'Direction of language (Left-to-Right = 0, Right-to-Left = 1).',
315 316 317 318 319
      ),
      'enabled' => array(
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
320
        'description' => 'Enabled flag (1 = Enabled, 0 = Disabled).',
321 322 323 324 325
      ),
      'plurals' => array(
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
326
        'description' => 'Number of plural indexes in this language.',
327 328 329 330 331 332
      ),
      'formula' => array(
        'type' => 'varchar',
        'length' => 128,
        'not null' => TRUE,
        'default' => '',
333
        'description' => 'Plural formula in PHP code to evaluate to get plural indexes.',
334 335 336 337 338 339
      ),
      'domain' => array(
        'type' => 'varchar',
        'length' => 128,
        'not null' => TRUE,
        'default' => '',
340
        'description' => 'Domain to use for this language.',
341 342 343 344 345 346
      ),
      'prefix' => array(
        'type' => 'varchar',
        'length' => 128,
        'not null' => TRUE,
        'default' => '',
347
        'description' => 'Path prefix to use for this language.',
348 349 350 351 352
      ),
      'weight' => array(
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
353
        'description' => 'Weight, used in lists of languages.',
354 355 356 357 358 359
      ),
      'javascript' => array(
        'type' => 'varchar',
        'length' => 32,
        'not null' => TRUE,
        'default' => '',
360
        'description' => 'Location of JavaScript translation file.',
361
      ),
362 363
    ),
    'primary key' => array('language'),
364 365 366
    'indexes' => array(
      'list' => array('weight', 'name'),
    ),
367 368 369
  );

  $schema['locales_source'] = array(
370
    'description' => 'List of English source strings.',
371
    'fields' => array(
372 373 374
      'lid' => array(
        'type' => 'serial',
        'not null' => TRUE,
375
        'description' => 'Unique identifier of this string.',
376 377 378 379 380 381
      ),
      'location' => array(
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
        'default' => '',
382
        'description' => 'Drupal path in case of online discovered translations or file path in case of imported strings.',
383 384 385 386 387 388
      ),
      'textgroup' => array(
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
        'default' => 'default',
389
        'description' => 'A module defined group of translations, see hook_locale().',
390 391 392 393 394
      ),
      'source' => array(
        'type' => 'text',
        'mysql_type' => 'blob',
        'not null' => TRUE,
395
        'description' => 'The original string in English.',
396 397 398 399 400 401
      ),
      'version' => array(
        'type' => 'varchar',
        'length' => 20,
        'not null' => TRUE,
        'default' => 'none',
402
        'description' => 'Version of Drupal, where the string was last used (for locales optimization).',
403
      ),
404 405
    ),
    'primary key' => array('lid'),
406 407 408
    'indexes' => array(
      'source' => array(array('source', 30)),
    ),
409 410 411
  );

  $schema['locales_target'] = array(
412
    'description' => 'Stores translated versions of strings.',
413
    'fields' => array(
414 415 416 417
      'lid' => array(
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
418
        'description' => 'Source string ID. References {locales_source}.lid.',
419 420 421 422 423
      ),
      'translation' => array(
        'type' => 'text',
        'mysql_type' => 'blob',
        'not null' => TRUE,
424
        'description' => 'Translation string value in this language.',
425 426 427 428 429 430
      ),
      'language' => array(
        'type' => 'varchar',
        'length' => 12,
        'not null' => TRUE,
        'default' => '',
431
        'description' => 'Language code. References {languages}.language.',
432 433 434
      ),
      'plid' => array(
        'type' => 'int',
435
        'not null' => TRUE, // This should be NULL for no referenced string, not zero.
436
        'default' => 0,
437
        'description' => 'Parent lid (lid of the previous string in the plural chain) in case of plural strings. References {locales_source}.lid.',
438 439 440 441 442
      ),
      'plural' => array(
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
443
        'description' => 'Plural index number in case of plural strings.',
444
      ),
445
    ),
446
    'primary key' => array('language', 'lid', 'plural'),
447
    'indexes' => array(
448 449 450
      'lid'      => array('lid'),
      'plid'     => array('plid'),
      'plural'   => array('plural'),
451 452 453 454 455
    ),
  );

  return $schema;
}