Newer
Older
Jennifer Hodgdon
committed
* Enables the translation of the user interface to languages other than English.
Jennifer Hodgdon
committed
* When enabled, multiple languages can be set up. The site interface can be
* displayed in different languages, and nodes can have languages assigned. The
* setup of languages and translations is completely web based. Gettext portable
* object files are supported.
use Drupal\Core\Language\Language;
Angie Byron
committed
use Drupal\Component\Utility\Crypt;
Dries Buytaert
committed
16
17
18
19
20
21
22
23
24
25
26
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
/**
* Regular expression pattern used to localize JavaScript strings.
*/
const LOCALE_JS_STRING = '(?:(?:\'(?:\\\\\'|[^\'])*\'|"(?:\\\\"|[^"])*")(?:\s*\+\s*)?)+';
/**
* Regular expression pattern used to match simple JS object literal.
*
* This pattern matches a basic JS object, but will fail on an object with
* nested objects. Used in JS file parsing for string arg processing.
*/
const LOCALE_JS_OBJECT = '\{.*?\}';
/**
* Regular expression to match an object containing a key 'context'.
*
* Pattern to match a JS object containing a 'context key' with a string value,
* which is captured. Will fail if there are nested objects.
*/
define('LOCALE_JS_OBJECT_CONTEXT', '
\{ # match object literal start
.*? # match anything, non-greedy
(?: # match a form of "context"
\'context\'
|
"context"
|
context
)
\s*:\s* # match key-value separator ":"
(' . LOCALE_JS_STRING . ') # match context string
.*? # match anything, non-greedy
\} # match end of object literal
');
/**
* Flag for locally not customized interface translation.
*
* Such translations are imported from .po files downloaded from
* localize.drupal.org for example.
*/
const LOCALE_NOT_CUSTOMIZED = 0;
/**
* Flag for locally customized interface translation.
*
* Such translations are edited from their imported originals on the user
* interface or are imported as customized.
*/
const LOCALE_CUSTOMIZED = 1;
Angie Byron
committed
/**
* Translation update mode: Use local files only.
*
* When checking for available translation updates, only local files will be
* used. Any remote translation file will be ignored. Also custom modules and
* themes which have set a "server pattern" to use a remote translation server
* will be ignored.
*/
const LOCALE_TRANSLATION_USE_SOURCE_LOCAL = 'local';
/**
* Translation update mode: Use both remote and local files.
*
* When checking for available translation updates, both local and remote files
* will be checked.
*/
const LOCALE_TRANSLATION_USE_SOURCE_REMOTE_AND_LOCAL = 'remote_and_local';
/**
* Default location of gettext file on the translation server.
*
* @see locale_translation_default_translation_server().
*/
const LOCALE_TRANSLATION_DEFAULT_SERVER_PATTERN = 'http://ftp.drupal.org/files/translations/%core/%project/%project-%version.%language.po';
/**
* The number of seconds that the translations status entry should be considered.
*/
const LOCALE_TRANSLATION_STATUS_TTL = 600;
/**
* UI option for override of existing translations. Override any translation.
*/
const LOCALE_TRANSLATION_OVERWRITE_ALL = 'all';
/**
* UI option for override of existing translations. Only override non-customized
* translations.
Angie Byron
committed
*/
const LOCALE_TRANSLATION_OVERWRITE_NON_CUSTOMIZED = 'non_customized';
/**
* UI option for override of existing translations. Don't override existing
* translations.
*/
const LOCALE_TRANSLATION_OVERWRITE_NONE = 'none';
/**
* Translation source is a remote file.
*/
const LOCALE_TRANSLATION_REMOTE = 'remote';
/**
* Translation source is a local file.
*/
const LOCALE_TRANSLATION_LOCAL = 'local';
/**
* Translation source is the current translation.
*/
const LOCALE_TRANSLATION_CURRENT = 'current';
Dries Buytaert
committed
* Implements hook_help().
Gábor Hojtsy
committed
function locale_help($path, $arg) {
switch ($path) {
Dries Buytaert
committed
case 'admin/help#locale':
Angie Byron
committed
$output = '';
$output .= '<h3>' . t('About') . '</h3>';
$output .= '<p>' . t('The Locale module allows your Drupal site to be presented in languages other than the default English, and to be multilingual. The Locale module works by maintaining a database of translations, and examining text as it is about to be displayed. When a translation of the text is available in the language to be displayed, the translation is displayed rather than the original text. When a translation is unavailable, the original text is displayed, and then stored for review by a translator. For more information, see the online handbook entry for <a href="@locale">Locale module</a>.', array('@locale' => 'http://drupal.org/documentation/modules/locale/')) . '</p>';
Angie Byron
committed
$output .= '<h3>' . t('Uses') . '</h3>';
$output .= '<dl>';
$output .= '<dt>' . t('Translating interface text') . '</dt>';
$output .= '<dd>' . t('Translations of text in the Drupal interface may be provided by:');
$output .= '<ul>';
$output .= '<li>' . t('<a href="@update">Automatic import</a> of translations when you add a language or enable a module or theme. These translations are obtained from the <a href="@url">Drupal translation server</a>. Although Drupal modules and themes may not be fully translated in all languages, new translations become available frequently. Interface translation updates can be downloaded and installed automatically at <a href="@config">regular intervals</a>.', array('@url' => 'http://localize.drupal.org', '@update' => url('admin/reports/translations'), '@config' => url('admin/config/regional/translate/settings'))) . '</li>';
Angie Byron
committed
$output .= '<li>' . t("Translating within your site, using the Locale module's integrated <a href='@translate'>translation interface</a>.", array('@translate' => url('admin/config/regional/translate'))) . '</li>';
$output .= '<li>' . t("If an existing translations do not meet your needs, the interface translations files in Gettext Portable Object (<em>.po</em>) format may be modified, or new <em>.po</em> files may be created, using a desktop Gettext editor. The Locale module's <a href='@import'>manual import</a> feature allows the translated strings from a new or modified <em>.po</em> file to be added to your site. The Locale module's <a href='@export'>export</a> feature generates files from your site's translated strings, that can either be shared with others or edited offline by a Gettext translation editor.", array('@import' => url('admin/config/regional/translate/import'), '@export' => url('admin/config/regional/translate/export'))) . '</li>';
Angie Byron
committed
$output .= '</ul></dd>';
$output .= '</dl>';
Dries Buytaert
committed
return $output;
Dries Buytaert
committed
Dries Buytaert
committed
case 'admin/config/regional/language':
return '<p>' . t('Interface translations are automatically imported when a language is added, or when new modules or themes are enabled. The report, <a href="@update">Available translation updates</a>, shows the status. Interface text can be <a href="@translate">customized</a>.', array('@update' => url('admin/reports/translations'), '@translate' => url('admin/config/regional/translate'))) . '</p>';
Dries Buytaert
committed
Dries Buytaert
committed
case 'admin/config/regional/translate':
$output = '<p>' . t('This page allows a translator to search for specific translated and untranslated strings, and is used when creating or editing translations. (Note: Because translation tasks involves many strings, it may be more convenient to <a href="@export">export</a> strings for offline editing in a desktop Gettext translation editor). Searches may be limited to strings in a specific language.', array('@export' => url('admin/config/regional/translate/export'))) . '</p>';
return $output;
Dries Buytaert
committed
Dries Buytaert
committed
case 'admin/config/regional/translate/import':
$output = '<p>' . t('Translation files are automatically downloaded and imported when <a href="@language">languages</a> are added, or when modules or themes are enabled.', array('@language' => url('admin/config/regional/language'))). '</p>';
$output .= '<p>' . t('This page allows translators to manually import translated strings contained in a Gettext Portable Object (.po) file. Manual import may be used for customized translations or for the translation of custom modules and themes. To customize translations you can download a translation file from the <a href="@url">Drupal translation server</a> or <a href="@export">export</a> translations from the site, customize the translations using a Gettext translation editor, and import the result using this page.', array('@url' => 'http://localize.drupal.org', '@export' => url('admin/config/regional/translate/export'))) . '</p>';
$output .= '<p>' . t('Note that importing large .po files may take several minutes.') . '</p>';
return $output;
Dries Buytaert
committed
Dries Buytaert
committed
case 'admin/config/regional/translate/export':
return '<p>' . t('This page exports the translated strings used by your site. An export file may be in Gettext Portable Object (<em>.po</em>) form, which includes both the original string and the translation (used to share translations with others), or in Gettext Portable Object Template (<em>.pot</em>) form, which includes the original strings only (used to create new translations with a Gettext translation editor).') . '</p>';
Dries Buytaert
committed
* Implements hook_menu().
Dries Buytaert
committed
function locale_menu() {
// Translation functionality.
Dries Buytaert
committed
$items['admin/config/regional/translate'] = array(
Dries Buytaert
committed
'title' => 'User interface translation',
'description' => 'Translate the built-in user interface.',
'route_name' => 'locale.translate_page',
Angie Byron
committed
'weight' => -5,
Angie Byron
committed
$items['admin/reports/translations'] = array(
'title' => 'Available translation updates',
Alex Pott
committed
'route_name' => 'locale.translate_status',
Angie Byron
committed
'description' => 'Get a status report about available interface translations for your installed modules and themes.',
);
Dries Buytaert
committed
* Implements hook_permission().
function locale_permission() {
return array(
Angie Byron
committed
'translate interface' => array(
'title' => t('Translate interface texts'),
'restrict access' => TRUE,
Angie Byron
committed
),
);
Dries Buytaert
committed
* Implements hook_theme().
*/
function locale_theme() {
return array(
Angie Byron
committed
'locale_translate_edit_form_strings' => array(
'render element' => 'form',
'file' => 'locale.pages.inc',
),
'locale_translation_last_check' => array(
'variables' => array('last' => NULL),
'file' => 'locale.pages.inc',
Alex Pott
committed
'template' => 'locale-translation-last-check',
),
'locale_translation_update_info' => array(
'variables' => array('updates' => array(), 'not_found' => array()),
'file' => 'locale.pages.inc',
Alex Pott
committed
'template' => 'locale-translation-update-info',
),
/**
* Implements hook_stream_wrappers().
*/
function locale_stream_wrappers() {
$wrappers = array(
'translations' => array(
'name' => t('Translation files'),
'class' => 'Drupal\locale\TranslationsStream',
'description' => t('Translation files'),
'type' => STREAM_WRAPPERS_LOCAL_HIDDEN,
),
);
return $wrappers;
}
* Implements hook_language_insert().
function locale_language_insert($language) {
// @todo move these two cache clears out. See http://drupal.org/node/1293252
// Changing the language settings impacts the interface.
cache('page')->deleteAll();
// Force JavaScript translation file re-creation for the new language.
_locale_invalidate_js($language->id);
}
/**
* Implements hook_language_update().
function locale_language_update($language) {
// @todo move these two cache clears out. See http://drupal.org/node/1293252
// Changing the language settings impacts the interface.
cache('page')->deleteAll();
// Force JavaScript translation file re-creation for the modified language.
_locale_invalidate_js($language->id);
}
/**
* Implements hook_language_delete().
function locale_language_delete($language) {
// Remove translations.
\Drupal::service('locale.storage')->deleteTranslations(array('language' => $language->id));
Angie Byron
committed
// Remove interface translation files.
module_load_include('inc', 'locale', 'locale.bulk');
locale_translate_delete_translation_files(array(), array($language->id));
// Remove translated configuration objects.
\Drupal\locale\Locale::config()->deleteLanguageTranslations($language->id);
// Changing the language settings impacts the interface:
_locale_invalidate_js($language->id);
cache('page')->deleteAll();
// Clear locale translation caches.
locale_translation_status_delete_languages(array($language->id));
cache()->delete('locale:' . $language->id);
Angie Byron
committed
/**
* Returns list of translatable languages.
*
* @return array
* Array of installed languages keyed by language name. English is omitted
* unless it is marked as translatable.
*/
function locale_translatable_language_list() {
$languages = language_list();
if (!locale_translate_english()) {
unset($languages['en']);
}
return $languages;
}
* Returns plural form index for a specific number.
* The index is computed from the formula of this language.
*
Gábor Hojtsy
committed
* @param $count
* Number to return plural for.
* @param $langcode
* Optional language code to translate to a language other than
* what is used to display the page.
* @return
* The numeric index of the plural variant to use for this $langcode and
* $count combination or -1 if the language was not found or does not have a
* plural formula.
Gábor Hojtsy
committed
function locale_get_plural($count, $langcode = NULL) {
$language_interface = language(Language::TYPE_INTERFACE);
// Used to locally cache the plural formulas for all languages.
$plural_formulas = &drupal_static(__FUNCTION__, array());
// Used to store precomputed plural indexes corresponding to numbers
// individually for each language.
$plural_indexes = &drupal_static(__FUNCTION__ . ':plurals', array());
$langcode = $langcode ? $langcode : $language_interface->id;
if (!isset($plural_indexes[$langcode][$count])) {
// Retrieve and statically cache the plural formulas for all languages.
if (empty($plural_formulas)) {
$plural_formulas = \Drupal::state()->get('locale.translation.plurals') ?: array();
// If there is a plural formula for the language, evaluate it for the given
// $count and statically cache the result for the combination of language
// and count, since the result will always be identical.
if (!empty($plural_formulas[$langcode])) {
// $n is used inside the expression in the eval().
$n = $count;
$plural_indexes[$langcode][$count] = @eval('return intval(' . $plural_formulas[$langcode]['formula'] . ');');
}
// In case there is no plural formula for English (no imported translation
// for English), use a default formula.
elseif ($langcode == 'en') {
$plural_indexes[$langcode][$count] = (int) ($count != 1);
// Otherwise, return -1 (unknown).
$plural_indexes[$langcode][$count] = -1;
return $plural_indexes[$langcode][$count];
Gábor Hojtsy
committed
/**
Dries Buytaert
committed
* Implements hook_modules_installed().
*/
function locale_modules_installed($modules) {
$components['module'] = $modules;
locale_system_update($components);
Dries Buytaert
committed
}
/**
* Implements hook_modules_uninstalled().
*/
function locale_modules_uninstalled($modules) {
$components['module'] = $modules;
locale_system_remove($components);
}
Dries Buytaert
committed
/**
* Implements hook_themes_enabled().
*
* @todo This is technically wrong. We must not import upon enabling, but upon
* initial installation. The theme system is missing an installation hook.
*/
function locale_themes_enabled($themes) {
$components['theme'] = $themes;
locale_system_update($components);
Dries Buytaert
committed
}
/**
* Implements hook_themes_disabled().
*/
function locale_themes_disabled($themes) {
$components['theme'] = $themes;
locale_system_remove($components);
}
Alex Pott
committed
/**
* Implements hook_cron().
*
* @see drupal_cron_run()
* @see locale_queue_info()
*/
function locale_cron() {
// Update translations only when an update frequency was set by the admin
// and a translatable language was set.
// Update tasks are added to the queue here but processed by Drupal's cron
// using the cron worker defined in locale_queue_info().
if ($frequency = \Drupal::config('locale.settings')->get('translation.update_interval_days') && locale_translatable_language_list()) {
Alex Pott
committed
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
module_load_include('translation.inc', 'locale');
locale_cron_fill_queue();
}
}
/**
* Implements hook_queue_info().
*/
function locale_queue_info() {
$queues['locale_translation'] = array(
'title' => t('Update translations'),
'worker callback' => 'locale_translation_worker',
'cron' => array(
'time' => 30,
),
);
return $queues;
}
/**
* Callback: Executes interface translation queue tasks.
*
* The translation update functions executed here are batch operations which
* are also used in translation update batches. The batch functions may need to
* be executed multiple times to complete their task, typically this is the
* translation import function. When a batch function is not finished, a new
* queue task is created and added to the end of the queue. The batch context
* data is needed to continue the batch task is stored in the queue with the
* queue data.
*
* @param array $data
* Queue data array containing:
* - Function name.
* - Array of function arguments. Optionally contains the batch context data.
*
* @see locale_queue_info()
*/
function locale_translation_worker($data) {
module_load_include('batch.inc', 'locale');
list($function, $args) = $data;
// We execute batch operation functions here to check, download and import the
// translation files. Batch functions use a context variable as last argument
// which is passed by reference. When a batch operation is called for the
// first time a default batch context is created. When called iterative
// (usually the batch import function) the batch context is passed through via
// the queue and is part of the $data.
$last = count($args) - 1;
if (!is_array($args[$last]) || !isset($args[$last]['finished'])) {
$batch_context = array(
'sandbox' => array(),
'results' => array(),
'finished' => 1,
'message' => '',
);
}
else {
$batch_context = $args[$last];
unset ($args[$last]);
}
$args = array_merge($args, array(&$batch_context));
// Call the batch operation function.
call_user_func_array($function, $args);
// If the batch operation is not finished we create a new queue task to
// continue the task. This is typically the translation import task.
if ($batch_context['finished'] < 1) {
unset($batch_context['strings']);
$queue = \Drupal::queue('locale_translation', TRUE);
Alex Pott
committed
$queue->createItem(array($function, $args));
}
}
Dries Buytaert
committed
/**
* Imports translations when new modules or themes are installed.
Gábor Hojtsy
committed
*
* This function will start a batch to import translations for the added
* components.
Gábor Hojtsy
committed
*
* @param array $components
* An array of arrays of component (theme and/or module) names to import
* translations for, indexed by type.
Gábor Hojtsy
committed
*/
function locale_system_update(array $components) {
$components += array('module' => array(), 'theme' => array());
$list = array_merge($components['module'], $components['theme']);
Angie Byron
committed
// Skip running the translation imports if in the installer,
// because it would break out of the installer flow. We have
// built-in support for translation imports in the installer.
if (!drupal_installation_attempted() && locale_translatable_language_list() && \Drupal::config('locale.settings')->get('translation.import_enabled')) {
module_load_include('compare.inc', 'locale');
// Update the list of translatable projects and start the import batch.
// Only when new projects are added the update batch will be triggered. Not
// each enabled module will introduce a new project. E.g. sub modules.
$projects = array_keys(locale_translation_build_projects());
if ($list = array_intersect($list, $projects)) {
module_load_include('fetch.inc', 'locale');
// Get translation status of the projects, download and update translations.
$options = _locale_translation_default_update_options();
$batch = locale_translation_batch_update_build($list, array(), $options);
batch_set($batch);
}
\Drupal::moduleHandler()->loadInclude('locale', 'bulk.inc');
if ($batch = locale_config_batch_update_components(array(), array(), $components)) {
Angie Byron
committed
batch_set($batch);
}
Gábor Hojtsy
committed
}
}
/**
* Delete translation history of modules and themes.
*
* Only the translation history is removed, not the source strings or
* translations. This is not possible because strings are shared between
* modules and we have no record of which string is used by which module.
*
* @param array $components
* An array of arrays of component (theme and/or module) names to import
* translations for, indexed by type.
*/
function locale_system_remove($components) {
$components += array('module' => array(), 'theme' => array());
$list = array_merge($components['module'], $components['theme']);
if ($language_list = locale_translatable_language_list()) {
module_load_include('compare.inc', 'locale');
\Drupal::moduleHandler()->loadInclude('locale', 'bulk.inc');
// Delete configuration translations.
\Drupal\locale\Locale::config()->deleteComponentTranslations($components, array_keys($language_list));
// Only when projects are removed, the translation files and records will be
// deleted. Not each disabled module will remove a project. E.g. sub modules.
$projects = array_keys(locale_translation_get_projects());
if ($list = array_intersect($list, $projects)) {
locale_translation_file_history_delete($list);
// Remove translation files.
locale_translate_delete_translation_files($list, array());
// Remove translatable projects.
// Followup issue http://drupal.org/node/1842362 to replace the
// {locale_project} table. Then change this to a function call.
db_delete('locale_project')
->condition('name', $list)
->execute();
// Clear the translation status.
locale_translation_status_delete_projects($list);
}
}
}
Gábor Hojtsy
committed
/**
Dries Buytaert
committed
* Implements hook_js_alter().
Gábor Hojtsy
committed
*/
Angie Byron
committed
function locale_js_alter(&$javascript) {
$files = array();
foreach ($javascript as $item) {
if (isset($item['type']) && $item['type'] == 'file') {
$files[] = $item['data'];
}
}
if ($translation_file = locale_js_translate($files)) {
$javascript[$translation_file] = drupal_js_defaults($translation_file);
}
}
Dries Buytaert
committed
/**
* Returns a list of translation files given a list of JavaScript files.
*
* This function checks all JavaScript files passed and invokes parsing if they
* have not yet been parsed for Drupal.t() and Drupal.formatPlural() calls.
* Also refreshes the JavaScript translation files if necessary, and returns
* the filepath to the translation file (if any).
*
* @param array $files
* An array of local file paths.
Jennifer Hodgdon
committed
* @return string|null
* The filepath to the translation file or NULL if no translation is
* applicable.
*/
function locale_js_translate(array $files = array()) {
$language_interface = language(Language::TYPE_INTERFACE);
Gábor Hojtsy
committed
$dir = 'public://' . \Drupal::config('locale.settings')->get('javascript.directory');
$parsed = \Drupal::state()->get('system.javascript_parsed') ?: array();
$new_files = FALSE;
foreach ($files as $filepath) {
if (!in_array($filepath, $parsed)) {
// Don't parse our own translations files.
if (substr($filepath, 0, strlen($dir)) != $dir) {
_locale_parse_js_file($filepath);
$parsed[] = $filepath;
$new_files = TRUE;
Gábor Hojtsy
committed
}
}
}
// If there are any new source files we parsed, invalidate existing
// JavaScript translation files for all languages, adding the refresh
// flags into the existing array.
if ($new_files) {
$parsed += _locale_invalidate_js();
Gábor Hojtsy
committed
}
// If necessary, rebuild the translation file for the current language.
if (!empty($parsed['refresh:' . $language_interface->id])) {
Gábor Hojtsy
committed
// Don't clear the refresh flag on failure, so that another try will
// be performed later.
if (_locale_rebuild_js()) {
unset($parsed['refresh:' . $language_interface->id]);
Gábor Hojtsy
committed
}
// Store any changes after refresh was attempted.
\Drupal::state()->set('system.javascript_parsed', $parsed);
Gábor Hojtsy
committed
}
// If no refresh was attempted, but we have new source files, we need
// to store them too. This occurs if current page is in English.
Angie Byron
committed
elseif ($new_files) {
\Drupal::state()->set('system.javascript_parsed', $parsed);
Gábor Hojtsy
committed
}
// Add the translation JavaScript file to the page.
$locale_javascripts = \Drupal::state()->get('translation.javascript') ?: array();
$translation_file = NULL;
if (!empty($files) && !empty($locale_javascripts[$language_interface->id])) {
Angie Byron
committed
// Add the translation JavaScript file to the page.
$translation_file = $dir . '/' . $language_interface->id . '_' . $locale_javascripts[$language_interface->id] . '.js';
Gábor Hojtsy
committed
}
return $translation_file;
Gábor Hojtsy
committed
}
/**
* Implements hook_library_info().
*/
function locale_library_info() {
$libraries['drupal.locale.admin'] = array(
'title' => 'Locale',
'version' => \Drupal::VERSION,
'js' => array(
drupal_get_path('module', 'locale') . '/locale.admin.js' => array(),
),
'dependencies' => array(
array('system', 'jquery'),
array('system', 'drupal'),
array('system', 'jquery.once'),
),
);
$libraries['drupal.locale.datepicker'] = array(
'title' => 'Locale Datepicker UI',
'version' => \Drupal::VERSION,
'js' => array(
drupal_get_path('module', 'locale') . '/locale.datepicker.js' => array(),
),
'dependencies' => array(
array('system', 'jquery'),
array('system', 'drupal'),
array('system', 'drupalSettings'),
),
);
return $libraries;
}
/**
* Implement hook_library_info_alter().
*
* Provides the language support for the jQuery UI Date Picker.
*/
function locale_library_info_alter(&$libraries, $module) {
Angie Byron
committed
if ($module == 'system' && isset($libraries['jquery.ui.datepicker'])) {
$language_interface = language(Language::TYPE_INTERFACE);
// locale.datepicker.js should be added in the JS_LIBRARY group, so that
// this attach behavior will execute early. JS_LIBRARY is the default for
// hook_library_info_alter(), thus does not have to be specified explicitly.
$libraries['jquery.ui.datepicker']['dependencies'][] = array('locale', 'drupal.locale.datepicker');
Angie Byron
committed
$libraries['jquery.ui.datepicker']['js'][] = array(
'data' => array(
'jquery' => array(
'ui' => array(
'datepicker' => array(
'isRTL' => $language_interface->direction == Language::DIRECTION_RTL,
'firstDay' => \Drupal::config('system.date')->get('first_day'),
),
),
),
),
'type' => 'setting',
);
}
}
Dries Buytaert
committed
/**
* Implements hook_form_FORM_ID_alter() for language_admin_overview_form().
Dries Buytaert
committed
*/
function locale_form_language_admin_overview_form_alter(&$form, &$form_state) {
Dries Buytaert
committed
$languages = $form['languages']['#languages'];
$total_strings = \Drupal::service('locale.storage')->countStrings();
Dries Buytaert
committed
$stats = array_fill_keys(array_keys($languages), array());
// If we have source strings, count translations and calculate progress.
if (!empty($total_strings)) {
$translations = \Drupal::service('locale.storage')->countTranslations();
foreach ($translations as $langcode => $translated) {
$stats[$langcode]['translated'] = $translated;
if ($translated > 0) {
$stats[$langcode]['ratio'] = round($translated / $total_strings * 100, 2);
Dries Buytaert
committed
}
}
}
array_splice($form['languages']['#header'], -1, 0, t('Interface translation'));
foreach ($languages as $langcode => $language) {
$stats[$langcode] += array(
'translated' => 0,
'ratio' => 0,
);
Angie Byron
committed
if (!$language->locked && ($langcode != 'en' || locale_translate_english())) {
Dries Buytaert
committed
$form['languages'][$langcode]['locale_statistics'] = array(
Angie Byron
committed
'#markup' => l(
t('@translated/@total (@ratio%)', array(
'@translated' => $stats[$langcode]['translated'],
'@total' => $total_strings,
'@ratio' => $stats[$langcode]['ratio'],
)),
Angie Byron
committed
'admin/config/regional/translate',
Angie Byron
committed
array('query' => array('langcode' => $langcode))
),
Dries Buytaert
committed
);
}
else {
$form['languages'][$langcode]['locale_statistics'] = array(
catch
committed
'#markup' => t('not applicable'),
Dries Buytaert
committed
);
}
Dries Buytaert
committed
// #type = link doesn't work with #weight on table.
// reset and set it back after locale_statistics to get it at the right end.
$operations = $form['languages'][$langcode]['operations'];
unset($form['languages'][$langcode]['operations']);
$form['languages'][$langcode]['operations'] = $operations;
Dries Buytaert
committed
}
}
catch
committed
/**
* Implements hook_form_FORM_ID_alter() for language_admin_add_form(().
*/
function locale_form_language_admin_add_form_alter(&$form, &$form_state) {
$form['predefined_submit']['#submit'][] = 'locale_form_language_admin_add_form_alter_submit';
$form['custom_language']['submit']['#submit'][] = 'locale_form_language_admin_add_form_alter_submit';
}
/**
Jennifer Hodgdon
committed
* Form submission handler for language_admin_add_form().
*
* Set a batch for a newly-added language.
*/
function locale_form_language_admin_add_form_alter_submit($form, $form_state) {
if (\Drupal::config('locale.settings')->get('translation.import_enabled')) {
Alex Pott
committed
if (empty($form_state['values']['predefined_langcode']) || $form_state['values']['predefined_langcode'] == 'custom') {
$langcode = $form_state['values']['langcode'];
}
else {
$langcode = $form_state['values']['predefined_langcode'];
}
Alex Pott
committed
// Download and import translations for the newly added language.
module_load_include('fetch.inc', 'locale');
$options = _locale_translation_default_update_options();
$batch = locale_translation_batch_update_build(array(), array($langcode), $options);
batch_set($batch);
Alex Pott
committed
// Create or update all configuration translations for this language.
\Drupal::moduleHandler()->loadInclude('locale', 'bulk.inc');
Alex Pott
committed
if ($batch = locale_config_batch_update_components($options, array($langcode))) {
batch_set($batch);
}
}
}
/**
* Implements hook_form_FORM_ID_alter() for language_admin_edit_form().
catch
committed
*/
function locale_form_language_admin_edit_form_alter(&$form, &$form_state) {
catch
committed
if ($form['langcode']['#type'] == 'value' && $form['langcode']['#value'] == 'en') {
$form['locale_translate_english'] = array(
'#title' => t('Enable interface translation to English'),
'#type' => 'checkbox',
'#default_value' => locale_translate_english(),
);
$form['actions']['submit']['#submit'][] = 'locale_form_language_admin_edit_form_alter_submit';
catch
committed
}
}
/**
Jennifer Hodgdon
committed
* Form submission handler for language_admin_edit_form().
catch
committed
*/
function locale_form_language_admin_edit_form_alter_submit($form, $form_state) {
\Drupal::config('locale.settings')->set('translate_english', intval($form_state['values']['locale_translate_english']))->save();
catch
committed
}
/**
Jennifer Hodgdon
committed
* Checks whether locale translates to English.
*
* @return bool
* Returns TRUE if content should be translated to English, FALSE otherwise.
catch
committed
*/
function locale_translate_english() {
return \Drupal::config('locale.settings')->get('translate_english');
catch
committed
}
/**
* Implements hook_form_FORM_ID_alter() for system_file_system_settings().
*
* Add interface translation directory setting to directories configuration.
*/
function locale_form_system_file_system_settings_alter(&$form, $form_state) {
$form['translation_path'] = array(
'#type' => 'textfield',
'#title' => t('Interface translations directory'),
'#default_value' => \Drupal::config('locale.settings')->get('translation.path'),
'#maxlength' => 255,
'#description' => t('A local file system path where interface translation files will be stored.'),
Alex Pott
committed
'#required' => TRUE,
'#after_build' => array('system_check_directory'),
'#weight' => 10,
);
if ($form['file_default_scheme']) {
$form['file_default_scheme']['#weight'] = 20;
}
Angie Byron
committed
$form['#submit'][] = 'locale_system_file_system_settings_submit';
}
/**
* Submit handler for the file system settings form.
*
* Clears the translation status when the Interface translations directory
* changes. Without a translations directory local po files in the directory
* should be ignored. The old translation status is no longer valid.
*/
function locale_system_file_system_settings_submit(&$form, $form_state) {
if ($form['translation_path']['#default_value'] != $form_state['values']['translation_path']) {
Angie Byron
committed
locale_translation_clear_status();
}
\Drupal::config('locale.settings')
->set('translation.path', $form_state['values']['translation_path'])
->save();
/**
Angie Byron
committed
* Implements hook_preprocess_HOOK() for node templates.
*/
function locale_preprocess_node(&$variables) {
if ($variables['node']->language()->id != Language::LANGCODE_NOT_SPECIFIED) {
$language_interface = language(Language::TYPE_INTERFACE);
$node_language = $variables['node']->language();
if ($node_language->id != $language_interface->id) {
// If the node language was different from the page language, we should
// add markup to identify the language. Otherwise the page language is
// inherited.
$variables['attributes']['lang'] = $node_language->id;
if ($node_language->direction != $language_interface->direction) {
// If text direction is different form the page's text direction, add
// direction information as well.
$dir = array('ltr', 'rtl');
Dries Buytaert
committed
$variables['attributes']['dir'] = $dir[$node_language->direction];
}
}
}
}
Dries Buytaert
committed
/**
* Gets current translation status from the {locale_file} table.
*
* @return array
* Array of translation file objects.
*/
function locale_translation_get_file_history() {
$history = &drupal_static(__FUNCTION__, array());
if (empty($history)) {
// Get file history from the database.
$result = db_query('SELECT project, langcode, filename, version, uri, timestamp, last_checked FROM {locale_file}');
foreach ($result as $file) {
Alex Pott
committed
$file->type = $file->timestamp ? LOCALE_TRANSLATION_CURRENT : '';
$history[$file->project][$file->langcode] = $file;
}
}
return $history;
}
/**
* Updates the {locale_file} table.
*
* @param object $file
* Object representing the file just imported.
*
* @return integer
* FALSE on failure. Otherwise SAVED_NEW or SAVED_UPDATED.
*
* @see drupal_write_record()
*/
function locale_translation_update_file_history($file) {
// Update or write new record.
if (db_query("SELECT project FROM {locale_file} WHERE project = :project AND langcode = :langcode", array(':project' => $file->project, ':langcode' => $file->langcode))->fetchField()) {
$update = array('project', 'langcode');
}
else {
$update = array();
}
Alex Pott
committed
$result = drupal_write_record('locale_file', $file, $update);
// The file history has changed, flush the static cache now.
// @todo Can we make this more fine grained?
drupal_static_reset('locale_translation_get_file_history');
return $result;
}
/**
* Deletes the history of downloaded translations.
*
* @param array $projects
* Project name(s) to be deleted from the file history. If both project(s) and
* language code(s) are specified the conditions will be ANDed.
* @param array $langcode
* Language code(s) to be deleted from the file history.
*/
function locale_translation_file_history_delete($projects = array(), $langcodes = array()) {
$query = db_delete('locale_file');
if (!empty($projects)) {
$query->condition('project', $projects);
}
if (!empty($langcodes)) {
$query->condition('langcode', $langcodes);
}
$query->execute();
}
Alex Pott
committed
/**
* Gets the current translation status.
*
* @todo What is 'translation status'?
*/
function locale_translation_get_status($projects = NULL, $langcodes = NULL) {
$result = array();
$status = \Drupal::state()->get('locale.translation_status');
Alex Pott
committed
module_load_include('translation.inc', 'locale');
$projects = $projects ? $projects : array_keys(locale_translation_get_projects());
$langcodes = $langcodes ? $langcodes : array_keys(locale_translatable_language_list());
// Get the translation status of each project-language combination. If no
// status was stored, a new translation source is created.
foreach ($projects as $project) {
foreach ($langcodes as $langcode) {
if (isset($status[$project][$langcode])) {
$result[$project][$langcode] = $status[$project][$langcode];
}
else {
$sources = locale_translation_build_sources(array($project), array($langcode));
if (isset($sources[$project][$langcode])) {
$result[$project][$langcode] = $sources[$project][$langcode];
}
}
}
}
return $result;
}
/**
* Saves the status of translation sources in static cache.
*
Alex Pott
committed
* @param string $project
* Machine readable project name.
* @param string $langcode
* Language code.
* @param string $type
* Type of data to be stored.
* @param array $data
Alex Pott
committed
* File object also containing timestamp when the translation is last updated.
*/
Alex Pott
committed
function locale_translation_status_save($project, $langcode, $type, $data) {
// Followup issue: http://drupal.org/node/1842362
// Split status storage per module/language and expire individually. This will
// improve performance for large sites.
Alex Pott
committed
// Load the translation status or build it if not already available.
module_load_include('translation.inc', 'locale');
$status = locale_translation_get_status();
if (empty($status)) {
$projects = locale_translation_get_projects(array($project));
if (isset($projects[$project])) {
$status[$project][$langcode] = locale_translation_source_build($projects[$project], $langcode);
}
}
Alex Pott
committed
// Merge the new status data with the existing status.
if (isset($status[$project][$langcode])) {
switch ($type) {