locale.install

  1. 7.x drupal-7.x/modules/locale/locale.install
  2. 6.x drupal-6.x/modules/locale/locale.install

Install, update and uninstall functions for the locale module.

File

drupal-7.x/modules/locale/locale.install
View source
  1. <?php
  2. /**
  3. * @file
  4. * Install, update and uninstall functions for the locale module.
  5. */
  6. /**
  7. * Implements hook_install().
  8. */
  9. function locale_install() {
  10. // locales_source.source and locales_target.target are not used as binary
  11. // fields; non-MySQL database servers need to ensure the field type is text
  12. // and that LIKE produces a case-sensitive comparison.
  13. db_insert('languages')
  14. ->fields(array(
  15. 'language' => 'en',
  16. 'name' => 'English',
  17. 'native' => 'English',
  18. 'direction' => 0,
  19. 'enabled' => 1,
  20. 'weight' => 0,
  21. 'javascript' => '',
  22. ))
  23. ->execute();
  24. }
  25. /**
  26. * @addtogroup updates-6.x-to-7.x
  27. * @{
  28. */
  29. /**
  30. * Add context field index and allow longer location.
  31. */
  32. function locale_update_7000() {
  33. db_drop_index('locales_source', 'source');
  34. db_add_index('locales_source', 'source_context', array(array('source', 30), 'context'));
  35. // Also drop the 'textgroup_location' index added by the i18nstrings module
  36. // of the i18n project, which prevents the below schema update from running.
  37. if (db_index_exists('locales_source', 'textgroup_location')) {
  38. db_drop_index('locales_source', 'textgroup_location');
  39. }
  40. db_change_field('locales_source', 'location', 'location', array(
  41. 'type' => 'text',
  42. 'not null' => FALSE,
  43. 'size' => 'big',
  44. 'description' => 'Drupal path in case of online discovered translations or file path in case of imported strings.',
  45. ));
  46. }
  47. /**
  48. * Upgrade language negotiation settings.
  49. */
  50. function locale_update_7001() {
  51. require_once DRUPAL_ROOT . '/includes/language.inc';
  52. require_once DRUPAL_ROOT . '/includes/locale.inc';
  53. require_once DRUPAL_ROOT . '/modules/locale/locale.module';
  54. switch (variable_get('language_negotiation', 0)) {
  55. // LANGUAGE_NEGOTIATION_NONE.
  56. case 0:
  57. $negotiation = array();
  58. break;
  59. // LANGUAGE_NEGOTIATION_PATH_DEFAULT.
  60. case 1:
  61. $negotiation = array(LOCALE_LANGUAGE_NEGOTIATION_URL);
  62. // In Drupal 6 path prefixes are shown for the default language only when
  63. // language negotiation is set to LANGUAGE_NEGOTIATION_PATH, while in
  64. // Drupal 7 path prefixes are always shown if not empty. Hence we need to
  65. // ensure that the default language has an empty prefix to avoid breaking
  66. // the site URLs with a prefix that previously was missing.
  67. $default = language_default();
  68. $default->prefix = '';
  69. variable_set('language_default', $default);
  70. db_update('languages')
  71. ->fields(array('prefix' => $default->prefix))
  72. ->condition('language', $default->language)
  73. ->execute();
  74. break;
  75. // LANGUAGE_NEGOTIATION_PATH.
  76. case 2:
  77. $negotiation = array(LOCALE_LANGUAGE_NEGOTIATION_URL, LOCALE_LANGUAGE_NEGOTIATION_USER, LOCALE_LANGUAGE_NEGOTIATION_BROWSER);
  78. break;
  79. // LANGUAGE_NEGOTIATION_DOMAIN.
  80. case 3:
  81. variable_set('locale_language_negotiation_url_part', LOCALE_LANGUAGE_NEGOTIATION_URL_DOMAIN);
  82. $negotiation = array(LOCALE_LANGUAGE_NEGOTIATION_URL);
  83. break;
  84. }
  85. // Save the new language negotiation options.
  86. language_negotiation_set(LANGUAGE_TYPE_INTERFACE, array_flip($negotiation));
  87. language_negotiation_set(LANGUAGE_TYPE_CONTENT, array(LOCALE_LANGUAGE_NEGOTIATION_INTERFACE => 0));
  88. language_negotiation_set(LANGUAGE_TYPE_URL, array(LOCALE_LANGUAGE_NEGOTIATION_URL => 0));
  89. // Save admininstration UI settings.
  90. $type = LANGUAGE_TYPE_INTERFACE;
  91. $provider_weights = array_flip(array_keys(locale_language_negotiation_info()));
  92. variable_set("locale_language_providers_weight_$type", $provider_weights);
  93. // Unset the old language negotiation system variable.
  94. variable_del('language_negotiation');
  95. return array();
  96. }
  97. /**
  98. * Updates URL language negotiation by adding the URL fallback detection method.
  99. */
  100. function locale_update_7002() {
  101. // language.inc may not have been included during bootstrap if there is not
  102. // more than one language currently enabled.
  103. require_once DRUPAL_ROOT . '/includes/language.inc';
  104. $language_types_info = language_types_info();
  105. $info = $language_types_info[LANGUAGE_TYPE_URL];
  106. if (isset($info['fixed'])) {
  107. language_negotiation_set(LANGUAGE_TYPE_URL, array_flip($info['fixed']));
  108. }
  109. }
  110. /**
  111. * @} End of "addtogroup updates-6.x-to-7.x".
  112. */
  113. /**
  114. * @addtogroup updates-7.x-extra
  115. * @{
  116. */
  117. /**
  118. * Update "language_count" variable.
  119. */
  120. function locale_update_7003() {
  121. $languages = language_list('enabled');
  122. variable_set('language_count', count($languages[1]));
  123. }
  124. /**
  125. * Remove duplicates in {locales_source}.
  126. */
  127. function locale_update_7004() {
  128. // Look up all duplicates. For each set of duplicates, we select the row
  129. // with the lowest lid as the "master" that will be preserved.
  130. $result_source = db_query("SELECT MIN(lid) AS lid, source, context FROM {locales_source} WHERE textgroup = 'default' GROUP BY source, context HAVING COUNT(*) > 1");
  131. $conflict = FALSE;
  132. foreach ($result_source as $source) {
  133. // Find all rows in {locales_target} that are translations of the same
  134. // string (incl. context).
  135. $result_target = db_query("SELECT t.lid, t.language, t.plural, t.translation FROM {locales_source} s JOIN {locales_target} t ON s.lid = t.lid WHERE s.source = :source AND s.context = :context AND s.textgroup = 'default' ORDER BY lid", array(
  136. ':source' => $source->source,
  137. ':context' => $source->context,
  138. ));
  139. $translations = array();
  140. $keep_lids = array($source->lid);
  141. foreach ($result_target as $target) {
  142. if (!isset($translations[$target->language])) {
  143. $translations[$target->language] = $target->translation;
  144. if ($target->lid != $source->lid) {
  145. // Move translation to the master lid.
  146. db_query('UPDATE {locales_target} SET lid = :new_lid WHERE lid = :old_lid', array(
  147. ':new_lid' => $source->lid,
  148. ':old_lid' => $target->lid));
  149. }
  150. }
  151. elseif ($translations[$target->language] == $target->translation) {
  152. // Delete duplicate translation.
  153. db_query('DELETE FROM {locales_target} WHERE lid = :lid AND language = :language', array(
  154. ':lid' => $target->lid,
  155. ':language' => $target->language));
  156. }
  157. else {
  158. // The same string is translated into several different strings in one
  159. // language. We do not know which is the preferred, so we keep them all.
  160. $keep_lids[] = $target->lid;
  161. $conflict = TRUE;
  162. }
  163. }
  164. // Delete rows in {locales_source} that are no longer referenced from
  165. // {locales_target}.
  166. db_delete('locales_source')
  167. ->condition('source', $source->source)
  168. ->condition('context', $source->context)
  169. ->condition('textgroup', 'default')
  170. ->condition('lid', $keep_lids, 'NOT IN')
  171. ->execute();
  172. }
  173. if ($conflict) {
  174. $url = 'http://drupal.org/node/746240';
  175. drupal_set_message('Your {locales_source} table contains duplicates that could not be removed automatically. See <a href="' . $url .'" target="_blank">' . $url . '</a> for more information.', 'warning');
  176. }
  177. }
  178. /**
  179. * Increase {locales_languages}.formula column's length.
  180. */
  181. function locale_update_7005() {
  182. db_change_field('languages', 'formula', 'formula', array(
  183. 'type' => 'varchar',
  184. 'length' => 255,
  185. 'not null' => TRUE,
  186. 'default' => '',
  187. 'description' => 'Plural formula in PHP code to evaluate to get plural indexes.',
  188. ));
  189. }
  190. /**
  191. * @} End of "addtogroup updates-7.x-extra".
  192. */
  193. /**
  194. * Implements hook_uninstall().
  195. */
  196. function locale_uninstall() {
  197. // Delete all JavaScript translation files.
  198. $locale_js_directory = 'public://' . variable_get('locale_js_directory', 'languages');
  199. if (is_dir($locale_js_directory)) {
  200. $files = db_query('SELECT language, javascript FROM {languages}');
  201. foreach ($files as $file) {
  202. if (!empty($file->javascript)) {
  203. file_unmanaged_delete($locale_js_directory . '/' . $file->language . '_' . $file->javascript . '.js');
  204. }
  205. }
  206. // Delete the JavaScript translations directory if empty.
  207. if (!file_scan_directory($locale_js_directory, '/.*/')) {
  208. drupal_rmdir($locale_js_directory);
  209. }
  210. }
  211. // Clear variables.
  212. variable_del('language_default');
  213. variable_del('language_count');
  214. variable_del('language_types');
  215. variable_del('locale_language_negotiation_url_part');
  216. variable_del('locale_language_negotiation_session_param');
  217. variable_del('language_content_type_default');
  218. variable_del('language_content_type_negotiation');
  219. variable_del('locale_cache_strings');
  220. variable_del('locale_js_directory');
  221. variable_del('javascript_parsed');
  222. variable_del('locale_field_language_fallback');
  223. variable_del('locale_cache_length');
  224. foreach (language_types() as $type) {
  225. variable_del("language_negotiation_$type");
  226. variable_del("locale_language_providers_weight_$type");
  227. }
  228. foreach (node_type_get_types() as $type => $content_type) {
  229. $setting = variable_del("language_content_type_$type");
  230. }
  231. // Switch back to English: with a $language->language value different from 'en'
  232. // successive calls of t() might result in calling locale(), which in turn might
  233. // try to query the unexisting {locales_source} and {locales_target} tables.
  234. drupal_language_initialize();
  235. }
  236. /**
  237. * Implements hook_schema().
  238. */
  239. function locale_schema() {
  240. $schema['languages'] = array(
  241. 'description' => 'List of all available languages in the system.',
  242. 'fields' => array(
  243. 'language' => array(
  244. 'type' => 'varchar',
  245. 'length' => 12,
  246. 'not null' => TRUE,
  247. 'default' => '',
  248. 'description' => "Language code, e.g. 'de' or 'en-US'.",
  249. ),
  250. 'name' => array(
  251. 'type' => 'varchar',
  252. 'length' => 64,
  253. 'not null' => TRUE,
  254. 'default' => '',
  255. 'description' => 'Language name in English.',
  256. ),
  257. 'native' => array(
  258. 'type' => 'varchar',
  259. 'length' => 64,
  260. 'not null' => TRUE,
  261. 'default' => '',
  262. 'description' => 'Native language name.',
  263. ),
  264. 'direction' => array(
  265. 'type' => 'int',
  266. 'not null' => TRUE,
  267. 'default' => 0,
  268. 'description' => 'Direction of language (Left-to-Right = 0, Right-to-Left = 1).',
  269. ),
  270. 'enabled' => array(
  271. 'type' => 'int',
  272. 'not null' => TRUE,
  273. 'default' => 0,
  274. 'description' => 'Enabled flag (1 = Enabled, 0 = Disabled).',
  275. ),
  276. 'plurals' => array(
  277. 'type' => 'int',
  278. 'not null' => TRUE,
  279. 'default' => 0,
  280. 'description' => 'Number of plural indexes in this language.',
  281. ),
  282. 'formula' => array(
  283. 'type' => 'varchar',
  284. 'length' => 255,
  285. 'not null' => TRUE,
  286. 'default' => '',
  287. 'description' => 'Plural formula in PHP code to evaluate to get plural indexes.',
  288. ),
  289. 'domain' => array(
  290. 'type' => 'varchar',
  291. 'length' => 128,
  292. 'not null' => TRUE,
  293. 'default' => '',
  294. 'description' => 'Domain to use for this language.',
  295. ),
  296. 'prefix' => array(
  297. 'type' => 'varchar',
  298. 'length' => 128,
  299. 'not null' => TRUE,
  300. 'default' => '',
  301. 'description' => 'Path prefix to use for this language.',
  302. ),
  303. 'weight' => array(
  304. 'type' => 'int',
  305. 'not null' => TRUE,
  306. 'default' => 0,
  307. 'description' => 'Weight, used in lists of languages.',
  308. ),
  309. 'javascript' => array(
  310. 'type' => 'varchar',
  311. 'length' => 64,
  312. 'not null' => TRUE,
  313. 'default' => '',
  314. 'description' => 'Location of JavaScript translation file.',
  315. ),
  316. ),
  317. 'primary key' => array('language'),
  318. 'indexes' => array(
  319. 'list' => array('weight', 'name'),
  320. ),
  321. );
  322. $schema['locales_source'] = array(
  323. 'description' => 'List of English source strings.',
  324. 'fields' => array(
  325. 'lid' => array(
  326. 'type' => 'serial',
  327. 'not null' => TRUE,
  328. 'description' => 'Unique identifier of this string.',
  329. ),
  330. 'location' => array(
  331. 'type' => 'text',
  332. 'not null' => FALSE,
  333. 'size' => 'big',
  334. 'description' => 'Drupal path in case of online discovered translations or file path in case of imported strings.',
  335. ),
  336. 'textgroup' => array(
  337. 'type' => 'varchar',
  338. 'length' => 255,
  339. 'not null' => TRUE,
  340. 'default' => 'default',
  341. 'description' => 'A module defined group of translations, see hook_locale().',
  342. ),
  343. 'source' => array(
  344. 'type' => 'text',
  345. 'mysql_type' => 'blob',
  346. 'not null' => TRUE,
  347. 'description' => 'The original string in English.',
  348. ),
  349. 'context' => array(
  350. 'type' => 'varchar',
  351. 'length' => 255,
  352. 'not null' => TRUE,
  353. 'default' => '',
  354. 'description' => 'The context this string applies to.',
  355. ),
  356. 'version' => array(
  357. 'type' => 'varchar',
  358. 'length' => 20,
  359. 'not null' => TRUE,
  360. 'default' => 'none',
  361. 'description' => 'Version of Drupal, where the string was last used (for locales optimization).',
  362. ),
  363. ),
  364. 'primary key' => array('lid'),
  365. 'indexes' => array(
  366. 'source_context' => array(array('source', 30), 'context'),
  367. ),
  368. );
  369. $schema['locales_target'] = array(
  370. 'description' => 'Stores translated versions of strings.',
  371. 'fields' => array(
  372. 'lid' => array(
  373. 'type' => 'int',
  374. 'not null' => TRUE,
  375. 'default' => 0,
  376. 'description' => 'Source string ID. References {locales_source}.lid.',
  377. ),
  378. 'translation' => array(
  379. 'type' => 'text',
  380. 'mysql_type' => 'blob',
  381. 'not null' => TRUE,
  382. 'description' => 'Translation string value in this language.',
  383. ),
  384. 'language' => array(
  385. 'type' => 'varchar',
  386. 'length' => 12,
  387. 'not null' => TRUE,
  388. 'default' => '',
  389. 'description' => 'Language code. References {languages}.language.',
  390. ),
  391. 'plid' => array(
  392. 'type' => 'int',
  393. 'not null' => TRUE, // This should be NULL for no referenced string, not zero.
  394. 'default' => 0,
  395. 'description' => 'Parent lid (lid of the previous string in the plural chain) in case of plural strings. References {locales_source}.lid.',
  396. ),
  397. 'plural' => array(
  398. 'type' => 'int',
  399. 'not null' => TRUE,
  400. 'default' => 0,
  401. 'description' => 'Plural index number in case of plural strings.',
  402. ),
  403. ),
  404. 'primary key' => array('language', 'lid', 'plural'),
  405. 'foreign keys' => array(
  406. 'locales_source' => array(
  407. 'table' => 'locales_source',
  408. 'columns' => array('lid' => 'lid'),
  409. ),
  410. ),
  411. 'indexes' => array(
  412. 'lid' => array('lid'),
  413. 'plid' => array('plid'),
  414. 'plural' => array('plural'),
  415. ),
  416. );
  417. return $schema;
  418. }