Newer
Older
Jennifer Hodgdon
committed
* Enables the translation of the user interface to languages other than English.
* When enabled, multiple languages can be added. The site interface can be
Jennifer Hodgdon
committed
* 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.
Angie Byron
committed
use Drupal\Component\Serialization\Json;
Alex Pott
committed
use Drupal\Component\Utility\String;
use Drupal\Component\Utility\UrlHelper;
Angie Byron
committed
use Drupal\Component\Utility\Xss;
use Drupal\Core\Url;
use Drupal\Core\Cache\Cache;
Dries Buytaert
committed
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Language\Language;
Angie Byron
committed
use Drupal\Core\Routing\RouteMatchInterface;
use Drupal\Core\StringTranslation\TranslationWrapper;
use Drupal\Core\Language\LanguageInterface;
use Drupal\language\ConfigurableLanguageInterface;
Angie Byron
committed
use Drupal\Component\Utility\Crypt;
Dries Buytaert
committed
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
/**
* 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().
Angie Byron
committed
function locale_help($route_name, RouteMatchInterface $route_match) {
switch ($route_name) {
case 'help.page.locale':
Angie Byron
committed
$output = '';
$output .= '<h3>' . t('About') . '</h3>';
Jennifer Hodgdon
committed
$output .= '<p>' . t('The Interface Translation module allows you to translate interface text (<em>strings</em>) into different languages, and to switch between them for the display of interface text. It uses the functionality provided by the <a href="!language">Language module</a>. For more information, see the <a href="!doc-url">online documentation for the Interface Translation module</a>.', array('!doc-url' => 'https://drupal.org/documentation/modules/locale/', '!language' => \Drupal::url('help.page', array('name' => 'language')))) . '</p>';
Angie Byron
committed
$output .= '<h3>' . t('Uses') . '</h3>';
$output .= '<dl>';
Jennifer Hodgdon
committed
$output .= '<dt>' . t('Importing translation files') . '</dt>';
Alex Pott
committed
$output .= '<dd>' . t('Translation files with translated interface text are imported automatically when languages are added on the <a href="!languages">Languages</a> page, or when modules or themes are enabled. On the <a href="!locale-settings">Settings</a> page, the <em>Translation source</em> can be restricted to local files only, or to include the <a href="!server">Drupal translation server</a>. Although modules and themes may not be fully translated in all languages, new translations become available frequently. You can specify whether and how often to check for translation file updates and whether to overwrite existing translations on the <a href="!locale-settings">Settings</a> page. You can also manually import a translation file on the <a title="User interface translation import" href="!import">Import</a> page.', array('!import' => \Drupal::url('locale.translate_import'), '!locale-settings' => \Drupal::url('locale.settings'), '!languages' => \Drupal::url('entity.configurable_language.collection'), '!server' => 'https://localize.drupal.org')) . '</dd>';
Jennifer Hodgdon
committed
$output .= '<dt>' . t('Checking the translation status') . '</dt>';
Alex Pott
committed
$output .= '<dd>' . t('You can check how much of the interface on your site is translated into which language on the <a href="!languages">Languages</a> page. On the <a href="!translation-updates">Available translation updates</a> page, you can check whether interface translation updates are available on the <a href="!server">Drupal translation server</a>.', array('!languages' => \Drupal::url('entity.configurable_language.collection'), '!translation-updates' => \Drupal::url('locale.translate_status'), '!server' => 'https://localize.drupal.org')) . '<dd>';
Jennifer Hodgdon
committed
$output .= '<dt>' . t('Translating individual strings') . '</dt>';
Jennifer Hodgdon
committed
$output .= '<dd>' . t('You can translate individual strings directly on the <a href="!translate">User interface translation</a> page, or download the currently-used translation file for a specific language on the <a title="User interface translation export" href="!export">Export</a> page. Once you have edited the translation file, you can then import it again on the <a title="User interface translation import" href="!import">Import</a> page.', array('!translate' => \Drupal::url('locale.translate_page'), '!export' => \Drupal::url('locale.translate_export'), '!import' => \Drupal::url('locale.translate_import'))) . '</dd>';
Angie Byron
committed
$output .= '</dl>';
Dries Buytaert
committed
return $output;
Dries Buytaert
committed
Alex Pott
committed
case 'entity.configurable_language.collection':
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 customized in the <a href="!translate">user interface translation</a> page.', array('!update' => \Drupal::url('locale.translate_status'), '!translate' => \Drupal::url('locale.translate_page'))) . '</p>';
case 'locale.translate_page':
Jennifer Hodgdon
committed
$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 involve many strings, it may be more convenient to <a title="User interface translation export" 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' => \Drupal::url('locale.translate_export'))) . '</p>';
return $output;
Dries Buytaert
committed
case 'locale.translate_import':
Alex Pott
committed
$output = '<p>' . t('Translation files are automatically downloaded and imported when <a title="Languages" href="!language">languages</a> are added, or when modules or themes are enabled.', array('!language' => \Drupal::url('entity.configurable_language.collection'))) . '</p>';
Jennifer Hodgdon
committed
$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 title="User interface translation export" 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' => 'https://localize.drupal.org', '!export' => \Drupal::url('locale.translate_export'))) . '</p>';
$output .= '<p>' . t('Note that importing large .po files may take several minutes.') . '</p>';
return $output;
Dries Buytaert
committed
case 'locale.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_theme().
*/
function locale_theme() {
return array(
'locale_translation_last_check' => array(
'variables' => array('last' => NULL),
'file' => 'locale.pages.inc',
),
'locale_translation_update_info' => array(
'variables' => array('updates' => array(), 'not_found' => array()),
'file' => 'locale.pages.inc',
),
* Implements hook_ENTITY_TYPE_insert() for 'configurable_language'.
function locale_configurable_language_insert(ConfigurableLanguageInterface $language) {
// @todo move these two cache clears out. See http://drupal.org/node/1293252
// Changing the language settings impacts the interface: clear render cache.
\Drupal::cache('render')->deleteAll();
// Force JavaScript translation file re-creation for the new language.
_locale_invalidate_js($language->id());
}
/**
* Implements hook_ENTITY_TYPE_update() for 'configurable_language'.
function locale_configurable_language_update(ConfigurableLanguageInterface $language) {
// @todo move these two cache clears out. See http://drupal.org/node/1293252
// Changing the language settings impacts the interface: clear render cache.
\Drupal::cache('render')->deleteAll();
// Force JavaScript translation file re-creation for the modified language.
_locale_invalidate_js($language->id());
}
/**
* Implements hook_ENTITY_TYPE_delete() for 'configurable_language'.
function locale_configurable_language_delete(ConfigurableLanguageInterface $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());
\Drupal::cache('render')->deleteAll();
// Clear locale translation caches.
locale_translation_status_delete_languages(array($language->id()));
\Drupal::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 = \Drupal::languageManager()->getLanguages();
Angie Byron
committed
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 = \Drupal::languageManager()->getCurrentLanguage();
// 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->getId();
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])) {
Alex Pott
committed
// Plural formulas are stored as an array for 0-199. 100 is the highest
// modulo used but storing 0-99 is not enough because below 100 we often
// find exceptions (1, 2, etc).
$index = $count > 199 ? 100 + ($count % 100) : $count;
$plural_indexes[$langcode][$count] = isset($plural_formulas[$langcode]['formula'][$index]) ? $plural_formulas[$langcode]['formula'][$index] : $plural_formulas[$langcode]['formula']['default'];
}
// 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_module_preuninstall().
*/
function locale_module_preuninstall($module) {
$components['module'] = array($module);
locale_system_remove($components);
}
Dries Buytaert
committed
/**
catch
committed
* Implements hook_themes_installed().
Dries Buytaert
committed
*/
catch
committed
function locale_themes_installed($themes) {
$components['theme'] = $themes;
locale_system_update($components);
Dries Buytaert
committed
}
/**
catch
committed
* Implements hook_themes_uninstalled().
*/
catch
committed
function locale_themes_uninstalled($themes) {
$components['theme'] = $themes;
locale_system_remove($components);
}
Alex Pott
committed
/**
* Implements hook_cron().
*
* @see \Drupal\locale\Plugin\QueueWorker\LocaleTranslation
Alex Pott
committed
*/
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.
if ($frequency = \Drupal::config('locale.settings')->get('translation.update_interval_days') && locale_translatable_language_list()) {
Alex Pott
committed
module_load_include('translation.inc', 'locale');
locale_cron_fill_queue();
}
}
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.
Angie Byron
committed
\Drupal::service('locale.project')->deleteMultiple($list);
// Clear the translation status.
locale_translation_status_delete_projects($list);
}
}
}
/**
* Implements hook_cache_flush().
*/
function locale_cache_flush() {
\Drupal::state()->delete('system.javascript_parsed');
}
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 = \Drupal::languageManager()->getCurrentLanguage();
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->getId()])) {
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->getId()]);
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('locale.translation.javascript') ?: array();
$translation_file = NULL;
if (!empty($files) && !empty($locale_javascripts[$language_interface->getId()])) {
Angie Byron
committed
// Add the translation JavaScript file to the page.
$translation_file = $dir . '/' . $language_interface->getId() . '_' . $locale_javascripts[$language_interface->getId()] . '.js';
Gábor Hojtsy
committed
}
return $translation_file;
Gábor Hojtsy
committed
}
/**
* Implements hook_library_info_alter().
*
* Provides the language support for the jQuery UI Date Picker.
*/
function locale_library_info_alter(array &$libraries, $module) {
if ($module === 'core' && isset($libraries['jquery.ui.datepicker'])) {
$libraries['jquery.ui.datepicker']['dependencies'][] = 'locale/drupal.locale.datepicker';
$libraries['jquery.ui.datepicker']['drupalSettings']['jquery']['ui']['datepicker'] = [
'isRTL' => NULL,
'firstDay' => NULL,
];
}
}
Angie Byron
committed
/**
* Implements hook_js_settings_alter().
*
* Generates the values for the altered core/jquery.ui.datepicker library.
*/
function locale_js_settings_alter(&$settings) {
if (isset($settings['jquery']['ui']['datepicker'])) {
$language_interface = \Drupal::languageManager()->getCurrentLanguage();
$settings['jquery']['ui']['datepicker']['isRTL'] = $language_interface->getDirection() == LanguageInterface::DIRECTION_RTL;
$settings['jquery']['ui']['datepicker']['firstDay'] = \Drupal::config('system.date')->get('first_day');
}
}
Dries Buytaert
committed
/**
* Implements hook_form_FORM_ID_alter() for language_admin_overview_form().
Dries Buytaert
committed
*/
Dries Buytaert
committed
function locale_form_language_admin_overview_form_alter(&$form, FormStateInterface $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,
);
Alex Pott
committed
if (!$language->isLocked() && ($langcode != 'en' || locale_translate_english())) {
Dries Buytaert
committed
$form['languages'][$langcode]['locale_statistics'] = array(
'#markup' => \Drupal::l(
Angie Byron
committed
t('@translated/@total (@ratio%)', array(
'@translated' => $stats[$langcode]['translated'],
'@total' => $total_strings,
'@ratio' => $stats[$langcode]['ratio'],
)),
new Url('locale.translate_page', array(), array('query' => array('langcode' => $langcode)))
Angie Byron
committed
),
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().
Dries Buytaert
committed
function locale_form_language_admin_add_form_alter(&$form, FormStateInterface $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.
Alex Pott
committed
function locale_form_language_admin_add_form_alter_submit($form, FormStateInterface $form_state) {
if (\Drupal::config('locale.settings')->get('translation.import_enabled')) {
Alex Pott
committed
if ($form_state->isValueEmpty('predefined_langcode') || $form_state->getValue('predefined_langcode') == 'custom') {
$langcode = $form_state->getValue('langcode');
Alex Pott
committed
}
else {
Alex Pott
committed
$langcode = $form_state->getValue('predefined_langcode');
Alex Pott
committed
}
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
*/
Dries Buytaert
committed
function locale_form_language_admin_edit_form_alter(&$form, FormStateInterface $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' => \Drupal::configFactory()->getEditable('locale.settings')->get('translate_english'),
catch
committed
);
$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
*/
Alex Pott
committed
function locale_form_language_admin_edit_form_alter_submit($form, FormStateInterface $form_state) {
\Drupal::configFactory()->getEditable('locale.settings')->set('translate_english', intval($form_state->getValue('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.
*/
Alex Pott
committed
function locale_form_system_file_system_settings_alter(&$form, FormStateInterface $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.
*/
Alex Pott
committed
function locale_system_file_system_settings_submit(&$form, FormStateInterface $form_state) {
Alex Pott
committed
if ($form['translation_path']['#default_value'] != $form_state->getValue('translation_path')) {
Angie Byron
committed
locale_translation_clear_status();
}
\Drupal::config('locale.settings')
Alex Pott
committed
->set('translation.path', $form_state->getValue('translation_path'))
->save();
/**
Angie Byron
committed
* Implements hook_preprocess_HOOK() for node templates.
*/
function locale_preprocess_node(&$variables) {
/* @var $node \Drupal\node\NodeInterface */
$node = $variables['node'];
if ($node->language()->getId() != LanguageInterface::LANGCODE_NOT_SPECIFIED) {
$interface_language = \Drupal::languageManager()->getCurrentLanguage();
$node_language = $node->language();
if ($node_language->getId() != $interface_language->getId()) {
// 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->getId();
if ($node_language->getDirection() != $interface_language->getDirection()) {
// If text direction is different form the page's text direction, add
// direction information as well.
$variables['attributes']['dir'] = $node_language->getDirection();
}
}
}
}
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 int
* FALSE on failure. Otherwise SAVED_NEW or SAVED_UPDATED.
*/
function locale_translation_update_file_history($file) {
catch
committed
$status = db_merge('locale_file')
->key(array(
'project' => $file->project,
'langcode' => $file->langcode,
))
->fields(array(
'version' => $file->version,
'timestamp' => $file->timestamp,
'last_checked' => $file->last_checked,
))
->execute();
Alex Pott
committed
// 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');
catch
committed
return $status;
}
/**
* 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 $langcodes
* 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) {
case LOCALE_TRANSLATION_REMOTE:
case LOCALE_TRANSLATION_LOCAL:
// Add the source data to the status array.
$status[$project][$langcode]->files[$type] = $data;
// Check if this translation is the most recent one. Set timestamp and
// data type of the most recent translation source.
if (isset($data->timestamp) && $data->timestamp) {
if ($data->timestamp > $status[$project][$langcode]->timestamp) {
$status[$project][$langcode]->timestamp = $data->timestamp;
$status[$project][$langcode]->last_checked = REQUEST_TIME;
$status[$project][$langcode]->type = $type;
}
}
break;
Alex Pott
committed
case LOCALE_TRANSLATION_CURRENT:
$data->last_checked = REQUEST_TIME;
$status[$project][$langcode]->timestamp = $data->timestamp;
$status[$project][$langcode]->last_checked = $data->last_checked;
$status[$project][$langcode]->type = $type;
locale_translation_update_file_history($data);
break;
}
\Drupal::state()->set('locale.translation_status', $status);
\Drupal::state()->set('locale.translation_last_checked', REQUEST_TIME);
Alex Pott
committed
}
}
/**
* Delete language entries from the status cache.
*
* @param array $langcodes
* Language code(s) to be deleted from the cache.
*/
function locale_translation_status_delete_languages($langcodes) {
Alex Pott
committed
if ($status = locale_translation_get_status()) {
foreach ($status as $project => $languages) {
foreach ($languages as $langcode => $source) {
if (in_array($langcode, $langcodes)) {
unset($status[$project][$langcode]);
}
}
}
\Drupal::state()->set('locale.translation_status', $status);
}
}
/**
* Delete project entries from the status cache.
*
* @param array $projects
* Project name(s) to be deleted from the cache.
*/
function locale_translation_status_delete_projects($projects) {
Alex Pott
committed
$status = locale_translation_get_status();
foreach ($status as $project => $languages) {
if (in_array($project, $projects)) {
unset($status[$project]);
}
}
\Drupal::state()->set('locale.translation_status', $status);
}
Angie Byron
committed
/**
* Clear the translation status cache.
*/
function locale_translation_clear_status() {
\Drupal::state()->delete('locale.translation_status');
\Drupal::state()->delete('locale.translation_last_checked');
}
/**
* Checks whether remote translation sources are used.
*
* @return bool
* Returns TRUE if remote translations sources should be taken into account
* when checking or importing translation files, FALSE otherwise.
*/
function locale_translation_use_remote_source() {
return \Drupal::config('locale.settings')->get('translation.use_source') == LOCALE_TRANSLATION_USE_SOURCE_REMOTE_AND_LOCAL;
Angie Byron
committed
}
Dries Buytaert
committed
/**
* Check that a string is safe to be added or imported as a translation.
*
* This test can be used to detect possibly bad translation strings. It should
* not have any false positives. But it is only a test, not a transformation,
* as it destroys valid HTML. We cannot reliably filter translation strings
* on import because some strings are irreversibly corrupted. For example,
Angie Byron
committed
* a & in the translation would get encoded to &amp; by
* \Drupal\Component\Utility\Xss::filter() before being put in the database,
* and thus would be displayed incorrectly.
Dries Buytaert
committed
*
Angie Byron
committed
* The allowed tag list is like \Drupal\Component\Utility\Xss::filterAdmin(),
* but omitting div and img as not needed for translation and likely to cause
* layout issues (div) or a possible attack vector (img).
Dries Buytaert
committed
*/
function locale_string_is_safe($string) {
Alex Pott
committed
return String::decodeEntities($string) == String::decodeEntities(Xss::filter($string, array('a', 'abbr', 'acronym', 'address', 'b', 'bdo', 'big', 'blockquote', 'br', 'caption', 'cite', 'code', 'col', 'colgroup', 'dd', 'del', 'dfn', 'dl', 'dt', 'em', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'hr', 'i', 'ins', 'kbd', 'li', 'ol', 'p', 'pre', 'q', 'samp', 'small', 'span', 'strong', 'sub', 'sup', 'table', 'tbody', 'td', 'tfoot', 'th', 'thead', 'tr', 'tt', 'ul', 'var')));
Dries Buytaert
committed
}
catch
committed
/**
* Refresh related information after string translations have been updated.
*
* The information that will be refreshed includes:
* - JavaScript translations.
* - Locale cache.
*
* @param array $langcodes
* Language codes for updated translations.
* @param array $lids
* (optional) List of string identifiers that have been updated / created.
* If not provided, all caches for the affected languages are cleared.
catch
committed
*/
function _locale_refresh_translations($langcodes, $lids = array()) {
if (!empty($langcodes)) {
// Update javascript translations if any of the strings has a javascript
// location, or if no string ids were provided, update all languages.
if (empty($lids) || ($strings = \Drupal::service('locale.storage')->getStrings(array('lid' => $lids, 'type' => 'javascript')))) {
catch
committed
array_map('_locale_invalidate_js', $langcodes);
}
}
// Clear locale cache.
catch
committed
Cache::invalidateTags(array('locale'));
catch
committed
}
/**
* Refreshes configuration after string translations have been updated.
*
* The information that will be refreshed includes:
* - JavaScript translations.
* - Locale cache.
*
* @param array $langcodes
* Language codes for updated translations.