language.inc 13.2 KB
Newer Older
1
2
3
4
5
6
7
8
<?php

/**
 * @file
 * Multiple language handling functionality.
 */

/**
9
10
 * No language negotiation. The default language is used.
 */
11
const LANGUAGE_NEGOTIATION_DEFAULT = 'language-default';
12
13

/**
14
15
16
17
18
19
20
21
22
 * Chooses a language for the given type based on language negotiation settings.
 *
 * @param $type
 *   The language type key.
 *
 * @return
 *   The negotiated language object.
 */
function language_types_initialize($type) {
23
24
  // Execute the language negotiation methods in the order they were set up and
  // return the first valid language found.
25
26
  $negotiation = variable_get("language_negotiation_$type", array());

27
28
  foreach ($negotiation as $method_id => $method) {
    $language = language_negotiation_method_invoke($method_id, $method);
29
    if ($language) {
30
31
      // Remember the method ID used to detect the language.
      $language->method_id = $method_id;
32
33
34
35
36
37
      return $language;
    }
  }

  // If no other language was found use the default one.
  $language = language_default();
38
  $language->method_id = LANGUAGE_NEGOTIATION_DEFAULT;
39
40
41
42
43
  return $language;
}

/**
 * Returns information about all defined language types.
44
45
 *
 * @return
46
47
48
49
 *   An associative array of language type information arrays keyed by type
 *   names. Based on information from hook_language_types_info().
 *
 * @see hook_language_types_info().
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 */
function language_types_info() {
  $language_types = &drupal_static(__FUNCTION__);

  if (!isset($language_types)) {
    $language_types = module_invoke_all('language_types_info');
    // Let other modules alter the list of language types.
    drupal_alter('language_types_info', $language_types);
  }

  return $language_types;
}

/**
64
 * Returns only the configurable language types.
65
66
 *
 * A language type maybe configurable or fixed. A fixed language type is a type
67
 * whose negotiation values are unchangeable and defined while defining the
68
69
 * language type itself.
 *
70
 * @param $stored
71
72
73
74
75
 *   (optional) By default, retrieves values from the 'language_types' variable
 *   to avoid unnecessary hook invocations. If set to FALSE, retrieves values
 *   from the actual language type definitions. This allows reaction to
 *   alterations performed on the definitions by modules installed after the
 *   'language_types' variable is set.
76
 *
77
78
79
 * @return
 *   An array of language type names.
 */
80
function language_types_get_configurable($stored = TRUE) {
81
82
  $configurable = &drupal_static(__FUNCTION__);

83
  if ($stored && !isset($configurable)) {
84
    $types = variable_get('language_types', language_types_get_default());
85
86
87
    $configurable = array_keys(array_filter($types));
  }

88
89
90
91
92
93
94
95
96
97
  if (!$stored) {
    $result = array();
    foreach (language_types_info() as $type => $info) {
      if (!isset($info['fixed'])) {
        $result[] = $type;
      }
    }
    return $result;
  }

98
99
100
101
  return $configurable;
}

/**
102
 * Disables the given language types.
103
104
105
106
107
 *
 * @param $types
 *   An array of language types.
 */
function language_types_disable($types) {
108
  $enabled_types = variable_get('language_types', language_types_get_default());
109
110
111
112
113
114
115
116

  foreach ($types as $type) {
    unset($enabled_types[$type]);
  }

  variable_set('language_types', $enabled_types);
}

117
118
119
120
121
122
123
124
125
126
127
128
129
/**
 * Updates the language type configuration.
 */
function language_types_set() {
  // Ensure that we are getting the defined language negotiation information. An
  // invocation of module_enable() or module_disable() could outdate the cached
  // information.
  drupal_static_reset('language_types_info');
  drupal_static_reset('language_negotiation_info');

  // Determine which language types are configurable and which not by checking
  // whether the 'fixed' key is defined. Non-configurable (fixed) language types
  // have their language negotiation settings stored there.
130
  $language_types = array();
131
  $negotiation_info = language_negotiation_info();
132
133
134
  foreach (language_types_info() as $type => $info) {
    if (isset($info['fixed'])) {
      $language_types[$type] = FALSE;
135
136
137
138
      $method_weights = array();
      foreach ($info['fixed'] as $weight => $method_id) {
        if (isset($negotiation_info[$method_id])) {
          $method_weights[$method_id] = $weight;
139
140
        }
      }
141
      language_negotiation_set($type, $method_weights);
142
143
144
145
146
147
    }
    else {
      $language_types[$type] = TRUE;
    }
  }

148
  // Save enabled language types.
149
150
  variable_set('language_types', $language_types);

151
152
153
  // Ensure that subsequent calls of language_types_get_configurable() return
  // the updated language type information.
  drupal_static_reset('language_types_get_configurable');
154
155
}

156
/**
157
 * Returns the ID of the language type's first language negotiation method.
158
159
 *
 * @param $type
160
 *   The language type.
161
 */
162
function language_negotiation_method_get_first($type) {
163
  $negotiation = variable_get("language_negotiation_$type", array());
164
  return empty($negotiation) ? LANGUAGE_NEGOTIATION_DEFAULT : key($negotiation);
165
166
167
}

/**
168
 * Checks if a language negotiation method is enabled for a language type.
169
 *
170
171
172
173
174
 * @param $method_id
 *   The language negotiation method ID.
 * @param $type
 *   (optional) The language type. If none is passed, all the configurable
 *   language types will be inspected.
175
176
 *
 * @return
177
178
 *   TRUE if the method is enabled for at least one of the given language
 *   types, or FALSE otherwise.
179
 */
180
181
182
183
184
185
function language_negotiation_method_enabled($method_id, $type = NULL) {
  $language_types = !empty($type) ? array($type) : language_types_get_configurable();

  foreach ($language_types as $type) {
    $negotiation = variable_get("language_negotiation_$type", array());
    if (isset($negotiation[$method_id])) {
186
187
188
189
190
191
192
193
      return TRUE;
    }
  }

  return FALSE;
}

/**
194
 * Returns the language switch links for the given language type.
195
196
 *
 * @param $type
197
 *   The language type.
198
199
200
201
202
203
204
205
206
207
 * @param $path
 *   The internal path the switch links will be relative to.
 *
 * @return
 *   A keyed array of links ready to be themed.
 */
function language_negotiation_get_switch_links($type, $path) {
  $links = FALSE;
  $negotiation = variable_get("language_negotiation_$type", array());

208
209
210
211
  foreach ($negotiation as $method_id => $method) {
    if (isset($method['callbacks']['language_switch'])) {
      if (isset($method['file'])) {
        require_once DRUPAL_ROOT . '/' . $method['file'];
212
      }
213

214
      $callback = $method['callbacks']['language_switch'];
215
216
217
218
219
      $result = $callback($type, $path);

      if (!empty($result)) {
        // Allow modules to provide translations for specific links.
        drupal_alter('language_switch_links', $result, $type, $path);
220
        $links = (object) array('links' => $result, 'method_id' => $method_id);
221
        break;
222
      }
223
224
225
226
227
228
    }
  }

  return $links;
}

229
/**
230
 * Removes any language negotiation methods that are no longer defined.
231
232
233
234
235
236
237
238
 */
function language_negotiation_purge() {
  // Ensure that we are getting the defined language negotiation information. An
  // invocation of module_enable() or module_disable() could outdate the cached
  // information.
  drupal_static_reset('language_negotiation_info');
  drupal_static_reset('language_types_info');

239
  $negotiation_info = language_negotiation_info();
240
241
  foreach (language_types_info() as $type => $type_info) {
    $weight = 0;
242
243
244
245
    $method_weights = array();
    foreach (variable_get("language_negotiation_$type", array()) as $method_id => $method) {
      if (isset($negotiation_info[$method_id])) {
        $method_weights[$method_id] = $weight++;
246
247
      }
    }
248
    language_negotiation_set($type, $method_weights);
249
250
  }
}
251
252

/**
253
 * Saves a list of language negotiation methods for a language type.
254
255
 *
 * @param $type
256
257
258
 *   The language type.
 * @param $method_weights
 *   An array of language negotiation method weights keyed by method id.
259
 */
260
function language_negotiation_set($type, $method_weights) {
261
  // Save only the necessary fields.
262
  $method_fields = array('callbacks', 'file', 'cache');
263
264

  $negotiation = array();
265
  $negotiation_info = language_negotiation_info();
266
  $default_types = language_types_get_configurable(FALSE);
267

268
269
270
271
272
273
274
275
276
277
278
  // Order the language negotiation method list by weight.
  asort($method_weights);

  foreach ($method_weights as $method_id => $weight) {
    if (isset($negotiation_info[$method_id])) {
      $method = $negotiation_info[$method_id];
      // If the language negotiation method does not express any preference
      // about types, make it available for any configurable type.
      $types = array_flip(isset($method['types']) ? $method['types'] : $default_types);
      // Check if the language negotiation method is defined and has the right
      // type.
279
      if (isset($types[$type])) {
280
281
282
283
        $method_data = array();
        foreach ($method_fields as $field) {
          if (isset($method[$field])) {
            $method_data[$field] = $method[$field];
284
285
          }
        }
286
        $negotiation[$method_id] = $method_data;
287
288
      }
    }
289
  }
290

291
292
293
294
  variable_set("language_negotiation_$type", $negotiation);
}

/**
295
 * Returns all defined language negotiation methods.
296
297
 *
 * @return
298
 *   An array of language negotiation methods.
299
300
 */
function language_negotiation_info() {
301
  $negotiation_info = &drupal_static(__FUNCTION__);
302

303
304
305
  if (!isset($negotiation_info)) {
    // Collect all the module-defined language negotiation methods.
    $negotiation_info = module_invoke_all('language_negotiation_info');
306

307
308
    // Add the default language negotiation method.
    $negotiation_info[LANGUAGE_NEGOTIATION_DEFAULT] = array(
309
310
      'callbacks' => array('language' => 'language_from_default'),
      'weight' => 10,
311
      'name' => t('Default language'),
312
      'description' => t('Use the default site language (@language_name).', array('@language_name' => language_default()->name)),
313
      'config' => 'admin/config/regional/language',
314
315
    );

316
317
     // Let other modules alter the list of language negotiation methods.
     drupal_alter('language_negotiation_info', $negotiation_info);
318
  }
319

320
  return $negotiation_info;
321
322
323
}

/**
324
 * Invokes a language negotiation method and caches the results.
325
 *
326
327
328
329
330
 * @param $method_id
 *   The language negotiation method ID.
 * @param $method
 *   (optional) The language negotiation method to be invoked. If not passed it
 *   will be explicitly loaded through language_negotiation_info().
331
332
 *
 * @return
333
 *   The language negotiation method's return value.
334
 */
335
function language_negotiation_method_invoke($method_id, $method = NULL) {
336
  $results = &drupal_static(__FUNCTION__);
337

338
  if (!isset($results[$method_id])) {
339
340
    global $user;

341
342
    // Get the enabled languages only.
    $languages = language_list(TRUE);
343

344
345
346
    if (!isset($method)) {
      $negotiation_info = language_negotiation_info();
      $method = $negotiation_info[$method_id];
347
348
    }

349
350
    if (isset($method['file'])) {
      require_once DRUPAL_ROOT . '/' . $method['file'];
351
    }
352

353
354
355
356
    // If the language negotiation method has no cache preference or this is
    // satisfied we can execute the callback.
    $cache = !isset($method['cache']) || $user->uid || $method['cache'] == variable_get('cache', 0);
    $callback = isset($method['callbacks']['negotiation']) ? $method['callbacks']['negotiation'] : FALSE;
357
    $langcode = $cache && function_exists($callback) ? $callback($languages) : FALSE;
358
    $results[$method_id] = isset($languages[$langcode]) ? $languages[$langcode] : FALSE;
359
  }
360

361
  // Since objects are resources we need to return a clone to prevent the
362
363
364
365
  // language negotiation method cache to be unintentionally altered. The same
  // language negotiation methods might be used with different language types
  // based on configuration.
  return !empty($results[$method_id]) ? clone($results[$method_id]) : $results[$method_id];
366
}
367
368

/**
369
 * Returns the default language code.
370
371
372
 *
 * @return
 *   The default language code.
373
 */
374
function language_from_default() {
375
  return language_default()->langcode;
376
}
377

378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
/**
 * Split the given path into prefix and actual path.
 *
 * Parse the given path and return the language object identified by the
 * prefix and the actual path.
 *
 * @param $path
 *   The path to split.
 * @param $languages
 *   An array of valid languages.
 *
 * @return
 *   An array composed of:
 *    - A language object corresponding to the identified prefix on success,
 *      FALSE otherwise.
 *    - The path without the prefix on success, the given path otherwise.
 */
function language_url_split_prefix($path, $languages) {
396
  $args = empty($path) ? array() : explode('/', $path);
397
398
399
  $prefix = array_shift($args);

  // Search prefix within enabled languages.
400
  $prefixes = language_negotiation_url_prefixes();
401
  foreach ($languages as $language) {
402
    if (isset($prefixes[$language->langcode]) && $prefixes[$language->langcode] == $prefix) {
403
404
405
406
407
408
409
      // Rebuild $path with the language removed.
      return array($language, implode('/', $args));
    }
  }

  return array(FALSE, $path);
}
410
411
412
413
414
415
416
417
418
419
420
421
422
423

/**
 * Return the possible fallback languages ordered by language weight.
 *
 * @param
 *   The language type.
 *
 * @return
 *   An array of language codes.
 */
function language_fallback_get_candidates($type = LANGUAGE_TYPE_CONTENT) {
  $fallback_candidates = &drupal_static(__FUNCTION__);

  if (!isset($fallback_candidates)) {
424
    // Get languages ordered by weight, add LANGUAGE_NOT_SPECIFIED at the end.
425
    $fallback_candidates = array_keys(language_list());
426
    $fallback_candidates[] = LANGUAGE_NOT_SPECIFIED;
427
428

    // Let other modules hook in and add/change candidates.
429
    drupal_alter('language_fallback_candidates', $fallback_candidates);
430
431
432
433
  }

  return $fallback_candidates;
}