locale.install 12.5 KB
Newer Older
1
<?php
2
// $Id$
3

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

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

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

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

/**
 * {locales_meta} table became {languages}.
 */
26
function locale_update_6000() {
27
  $ret = array();
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']);
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122

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

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

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

204
205
206
207
/**
 * @} End of "defgroup updates-5.x-to-6.x"
 */

208
209
210
211
/**
 * Implementation of hook_uninstall().
 */
function locale_uninstall() {
212
213
214
215
216
217
218
219
  // 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));
    }
  }

220
221
  // Remove tables.
  drupal_uninstall_schema('locale');
222
}
223
224
225
226
227
228

/**
 * Implementation of hook_schema().
 */
function locale_schema() {
  $schema['languages'] = array(
229
    'description' => t('List of all available languages in the system.'),
230
    'fields' => array(
231
232
233
234
235
      'language' => array(
        'type' => 'varchar',
        'length' => 12,
        'not null' => TRUE,
        'default' => '',
236
        'description' => t("Language code, e.g. 'de' or 'en-US'."),
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
      ),
      'name' => array(
        'type' => 'varchar',
        'length' => 64,
        'not null' => TRUE,
        'default' => '',
        'description' => t('Language name in English.'),
      ),
      'native' => array(
        'type' => 'varchar',
        'length' => 64,
        'not null' => TRUE,
        'default' => '',
        'description' => t('Native language name.'),
      ),
      'direction' => array(
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
        'description' => t('Direction of language (Left-to-Right = 0, Right-to-Left = 1).'),
      ),
      'enabled' => array(
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
        'description' => t('Enabled flag (1 = Enabled, 0 = Disabled).'),
      ),
      'plurals' => array(
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
268
        'description' => t('Number of plural indexes in this language.'),
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
      ),
      'formula' => array(
        'type' => 'varchar',
        'length' => 128,
        'not null' => TRUE,
        'default' => '',
        'description' => t('Plural formula in PHP code to evaluate to get plural indexes.'),
      ),
      'domain' => array(
        'type' => 'varchar',
        'length' => 128,
        'not null' => TRUE,
        'default' => '',
        'description' => t('Domain to use for this language.'),
      ),
      'prefix' => array(
        'type' => 'varchar',
        'length' => 128,
        'not null' => TRUE,
        'default' => '',
        'description' => t('Path prefix to use for this language.'),
      ),
      'weight' => array(
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
        'description' => t('Weight, used in lists of languages.'),
      ),
      'javascript' => array(
        'type' => 'varchar',
        'length' => 32,
        'not null' => TRUE,
        'default' => '',
        'description' => t('Location of JavaScript translation file.'),
      ),
304
305
    ),
    'primary key' => array('language'),
306
307
308
    'indexes' => array(
      'list' => array('weight', 'name'),
    ),
309
310
311
  );

  $schema['locales_source'] = array(
312
    'description' => t('List of English source strings.'),
313
    'fields' => array(
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
      'lid' => array(
        'type' => 'serial',
        'not null' => TRUE,
        'description' => t('Unique identifier of this string.'),
      ),
      'location' => array(
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
        'default' => '',
        'description' => t('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',
        'description' => t('A module defined group of translations, see hook_locale().'),
      ),
      'source' => array(
        'type' => 'text',
        'mysql_type' => 'blob',
        'not null' => TRUE,
        'description' => t('The original string in English.'),
      ),
      'version' => array(
        'type' => 'varchar',
        'length' => 20,
        'not null' => TRUE,
        'default' => 'none',
        'description' => t('Version of Drupal, where the string was last used (for locales optimization).'),
      ),
346
347
    ),
    'primary key' => array('lid'),
348
349
350
    'indexes' => array(
      'source' => array(array('source', 30)),
    ),
351
352
353
  );

  $schema['locales_target'] = array(
354
    'description' => t('Stores translated versions of strings.'),
355
    'fields' => array(
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
      'lid' => array(
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
        'description' => t('Source string ID. References {locales_source}.lid.'),
      ),
      'translation' => array(
        'type' => 'text',
        'mysql_type' => 'blob',
        'not null' => TRUE,
        'description' => t('Translation string value in this language.'),
      ),
      'language' => array(
        'type' => 'varchar',
        'length' => 12,
        'not null' => TRUE,
        'default' => '',
        'description' => t('Language code. References {languages}.language.'),
      ),
      'plid' => array(
        'type' => 'int',
377
        'not null' => TRUE, // This should be NULL for no referenced string, not zero.
378
379
380
381
382
383
384
385
386
        'default' => 0,
        'description' => t('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,
        'description' => t('Plural index number in case of plural strings.'),
      ),
387
    ),
388
    'primary key' => array('language', 'lid', 'plural'),
389
    'indexes' => array(
390
391
392
      'lid'      => array('lid'),
      'plid'     => array('plid'),
      'plural'   => array('plural'),
393
394
395
396
397
398
    ),
  );

  return $schema;
}