Newer
Older
Angie Byron
committed
<?php
/**
* @file
* Allows entities to be translated into different languages.
*/
use Drupal\content_translation\Plugin\Derivative\ContentTranslationLocalTasks;
use Drupal\Core\Entity\ContentEntityInterface;
Angie Byron
committed
use Drupal\Core\Entity\EntityFormControllerInterface;
use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Language\Language;
use Drupal\Core\Session\AccountInterface;
use Drupal\Core\TypedData\TranslatableInterface;
Angie Byron
committed
use Drupal\node\NodeInterface;
Angie Byron
committed
/**
* Implements hook_help().
*/
Alex Pott
committed
function content_translation_help($path, $arg) {
Angie Byron
committed
switch ($path) {
Alex Pott
committed
case 'admin/help#content_translation':
Angie Byron
committed
$output = '';
$output .= '<h3>' . t('About') . '</h3>';
$output .= '<p>' . t('The Content Translation module allows you to create and manage translations for your Drupal site content. You can specify which elements need to be translated at the content-type level for content items and comments, at the vocabulary level for taxonomy terms, and at the site level for user accounts. Other modules may provide additional elements that can be translated. For more information, see the online handbook entry for <a href="!url">Content Translation</a>.', array('!url' => 'http://drupal.org/documentation/modules/translation_entity')) . '</p>';
Angie Byron
committed
$output .= '<h3>' . t('Uses') . '</h3>';
$output .= '<dl>';
$output .= '<dt>' . t('Enabling translation') . '</dt>';
Dries Buytaert
committed
$output .= '<dd><p>' . t('Before you can translate content, there must be at least two languages added on the <a href="!url">languages administration</a> page.', array('!url' => url('admin/config/regional/language'))) . '</p>';
Angie Byron
committed
$output .= '<p>' . t('After adding languages, <a href="!url">configure translation</a>.', array('!url' => url('admin/config/regional/content-language'))) . '</p>';
Angie Byron
committed
$output .= '<dt>' . t('Translating content') . '</dt>';
Jennifer Hodgdon
committed
$output .= '<dd>' . t('After enabling translation you can create a new piece of content, or edit existing content and assign it a language. Then, you will see a <em>Translate</em> tab or link that will gives an overview of the translation status for the current content. From there, you can add translations and edit or delete existing translations. This process is similar for every translatable element on your site, such as taxonomy terms, comments or user accounts.') . '</dd>';
Angie Byron
committed
$output .= '<dt>' . t('Changing source language') . '</dt>';
$output .= '<dd>' . t('When there are two or more possible source languages, selecting a <em>Source language</em> will repopulate the form using the specified source\'s values. For example, French is much closer to Spanish than to Chinese, so changing the French translation\'s source language to Spanish can assist translators.') . '</dd>';
$output .= '<dt>' . t('Maintaining translations') . '</dt>';
$output .= '<dd>' . t('If editing content in one language requires that translated versions also be updated to reflect the change, use the <em>Flag other translations as outdated</em> check box to mark the translations as outdated and in need of revision.') . '</dd>';
$output .= '<dt>' . t('Translation permissions') . '</dt>';
Alex Pott
committed
$output .= '<dd>' . t('The Content Translation module makes a basic set of permissions available. Additional <a href="@permissions">permissions</a> are made available after translation is enabled for each translatable element.', array('@permissions' => url('admin/people/permissions', array('fragment' => 'module-content_translation')))) . '</dd>';
Angie Byron
committed
$output .= '</dl>';
return $output;
Angie Byron
committed
case 'admin/config/regional/content-language':
$output = '';
if (!\Drupal::languageManager()->isMultilingual()) {
Dries Buytaert
committed
$output .= '<br/>' . t('Before you can translate content, there must be at least two languages added on the <a href="!url">languages administration</a> page.', array('!url' => url('admin/config/regional/language')));
Angie Byron
committed
}
return $output;
Angie Byron
committed
}
}
/**
* Implements hook_module_implements_alter().
*/
Alex Pott
committed
function content_translation_module_implements_alter(&$implementations, $hook) {
switch ($hook) {
// Move some of our hook implementations to the end of the list.
case 'menu_alter':
case 'entity_type_alter':
Alex Pott
committed
$group = $implementations['content_translation'];
unset($implementations['content_translation']);
$implementations['content_translation'] = $group;
break;
}
}
Angie Byron
committed
/**
* Implements hook_language_type_info_alter().
*/
Alex Pott
committed
function content_translation_language_types_info_alter(array &$language_types) {
// Make content language negotiation configurable by removing the 'locked'
// flag.
$language_types[Language::TYPE_CONTENT]['locked'] = FALSE;
unset($language_types[Language::TYPE_CONTENT]['fixed']);
Angie Byron
committed
}
/**
* Implements hook_entity_type_alter().
Angie Byron
committed
*
* The content translation UI relies on the entity info to provide its features.
* See the documentation of hook_entity_type_build() in the Entity API documentation
Angie Byron
committed
* for more details on all the entity info keys that may be defined.
*
* To make Content Translation automatically support an entity type some keys
* may need to be defined, but none of them is required unless the entity path
* is different from the usual /ENTITY_TYPE/{ENTITY_TYPE} pattern (for instance
* "/taxonomy/term/{taxonomy_term}"), in which case at least the 'canonical' key
* in the 'links' entity info property must be defined.
*
* Every entity type needs a translation controller to be translated. This can
* be specified through the 'translation' key in the 'controllers' entity info
* property. If an entity type is translatable and no translation controller is
* defined, \Drupal\content_translation\ContentTranslationController will be
* assumed. Every translation controller class must implement
* \Drupal\content_translation\ContentTranslationControllerInterface.
*
* If the entity paths match the default pattern above and there is no need for
* an entity-specific translation controller class, Content Translation will
* provide built-in support for the entity. However enabling translation for
* each translatable bundle will be required.
*
* @see \Drupal\Core\Entity\Annotation\EntityType
Angie Byron
committed
*/
function content_translation_entity_type_alter(array &$entity_types) {
Angie Byron
committed
// Provide defaults for translation info.
/** @var $entity_types \Drupal\Core\Entity\EntityTypeInterface[] */
foreach ($entity_types as $entity_type) {
if ($entity_type->isTranslatable()) {
if (!$entity_type->hasControllerClass('translation')) {
$entity_type->setControllerClass('translation', 'Drupal\content_translation\ContentTranslationController');
Alex Pott
committed
}
$translation = $entity_type->get('translation');
Alex Pott
committed
if (!$translation || !isset($translation['content_translation'])) {
$translation['content_translation'] = array();
}
Angie Byron
committed
if ($entity_type->hasLinkTemplate('canonical')) {
// Provide default route names for the translation paths.
if (!$entity_type->hasLinkTemplate('drupal:content-translation-overview')) {
$entity_type->setLinkTemplate('drupal:content-translation-overview', "content_translation.translation_overview_" . $entity_type->id());
Alex Pott
committed
}
Angie Byron
committed
// @todo Remove this as soon as menu access checks rely on the
// controller. See https://drupal.org/node/2155787.
Alex Pott
committed
$translation['content_translation'] += array(
'access_callback' => 'content_translation_translate_access',
);
}
$entity_type->set('translation', $translation);
Angie Byron
committed
}
Angie Byron
committed
}
}
Angie Byron
committed
Angie Byron
committed
/**
* Implements hook_entity_bundle_info_alter().
*/
Alex Pott
committed
function content_translation_entity_bundle_info_alter(&$bundles) {
Angie Byron
committed
foreach ($bundles as $entity_type => &$info) {
foreach ($info as $bundle => &$bundle_info) {
Alex Pott
committed
$enabled = content_translation_get_config($entity_type, $bundle, 'enabled');
Angie Byron
committed
$bundle_info['translatable'] = !empty($enabled);
Angie Byron
committed
}
}
}
/**
* Implements hook_entity_field_info_alter().
*/
function content_translation_entity_field_info_alter(&$info, $entity_type) {
$translation_settings = config('content_translation.settings')->get($entity_type);
if ($translation_settings) {
// Currently field translatability is defined per-field but we may want to
// make it per-instance instead, so leaving the possibility open for further
// easier refactoring.
$fields = array();
foreach ($translation_settings as $bundle => $settings) {
$fields += !empty($settings['content_translation']['fields']) ? $settings['content_translation']['fields'] : array();
}
$keys = array('definitions', 'optional');
foreach ($fields as $name => $translatable) {
foreach ($keys as $key) {
if (isset($info[$key][$name])) {
Angie Byron
committed
$info[$key][$name]->setTranslatable((bool) $translatable);
break;
}
}
}
}
}
Angie Byron
committed
/**
* Implements hook_entity_operation_alter().
*/
function content_translation_entity_operation_alter(array &$operations, \Drupal\Core\Entity\EntityInterface $entity) {
// @todo Use an access permission.
if ($entity instanceof NodeInterface && $entity->isTranslatable()) {
$operations['translate'] = array(
'title' => t('Translate'),
Alex Pott
committed
) + $entity->urlInfo('drupal:content-translation-overview');
Angie Byron
committed
}
}
Angie Byron
committed
/**
* Implements hook_menu().
*
* @todo Split this into route definition and menu link definition. See
* https://drupal.org/node/1987882 and https://drupal.org/node/2047633.
Angie Byron
committed
*/
Alex Pott
committed
function content_translation_menu() {
Angie Byron
committed
$items = array();
// Create tabs for all possible entity types.
Alex Pott
committed
foreach (\Drupal::entityManager()->getDefinitions() as $entity_type_id => $entity_type) {
Angie Byron
committed
// Provide the translation UI only for enabled types.
Alex Pott
committed
if (content_translation_enabled($entity_type_id)) {
$path = _content_translation_link_to_router_path($entity_type_id, $entity_type->getLinkTemplate('canonical'));
Angie Byron
committed
$entity_position = count(explode('/', $path)) - 1;
$keys = array_flip(array('load_arguments'));
Alex Pott
committed
$translation = $entity_type->get('translation');
Alex Pott
committed
$menu_info = array_intersect_key($translation['content_translation'], $keys) + array('file' => 'content_translation.pages.inc');
Angie Byron
committed
$item = array();
// Plugin annotations cannot contain spaces, thus we need to restore them
// from underscores.
foreach ($menu_info as $key => $value) {
$item[str_replace('_', ' ', $key)] = $value;
}
// Add translation callback.
// @todo Add the access callback instead of replacing it as soon as the
// routing system supports multiple callbacks.
$language_position = $entity_position + 3;
$args = array($entity_position, $language_position, $language_position + 1);
Angie Byron
committed
$items["$path/translations/add/%language/%language"] = array(
Angie Byron
committed
'title' => 'Add',
Alex Pott
committed
'route_name' => "content_translation.translation_add_$entity_type_id",
Angie Byron
committed
'weight' => 1,
Angie Byron
committed
);
Angie Byron
committed
// Edit translation callback.
$args = array($entity_position, $language_position);
$items["$path/translations/edit/%language"] = array(
'title' => 'Edit',
Alex Pott
committed
'route_name' => "content_translation.translation_edit_$entity_type_id",
Angie Byron
committed
'weight' => 1,
Angie Byron
committed
);
Angie Byron
committed
// Delete translation callback.
$items["$path/translations/delete/%language"] = array(
'title' => 'Delete',
Alex Pott
committed
'route_name' => "content_translation.delete_$entity_type_id",
Angie Byron
committed
) + $item;
}
}
return $items;
}
/**
* Implements hook_menu_alter().
*
* @todo Split this into route definition and menu link definition. See
* https://drupal.org/node/1987882 and https://drupal.org/node/2047633.
Angie Byron
committed
*/
Alex Pott
committed
function content_translation_menu_alter(array &$items) {
Angie Byron
committed
// Check that the declared menu base paths are actually valid.
Alex Pott
committed
foreach (\Drupal::entityManager()->getDefinitions() as $entity_type_id => $entity_type) {
if (content_translation_enabled($entity_type_id)) {
$path = _content_translation_link_to_router_path($entity_type_id, $entity_type->getLinkTemplate('canonical'));
Angie Byron
committed
// If the base path is not defined we cannot provide the translation UI
// for this entity type. In some cases the actual base path might not have
// a menu loader associated, hence we need to check also for the plain "%"
// variant. See for instance comment_menu().
Dries Buytaert
committed
if (!isset($items[$path]) && !isset($items["$path/edit"])
Alex Pott
committed
&& !isset($items[_content_translation_menu_strip_loaders($path)])) {
Angie Byron
committed
unset(
$items["$path/translations"],
$items["$path/translations/add/%language/%language"],
Angie Byron
committed
$items["$path/translations/delete/%language"]
);
Alex Pott
committed
$t_args = array('@entity_type' => $entity_type->getLabel() ?: $entity_type_id);
Alex Pott
committed
watchdog('content translation', 'The entities of type @entity_type do not define a valid base path: it will not be possible to translate them.', $t_args, WATCHDOG_WARNING);
Angie Byron
committed
}
else {
$edit_path = $path . '/edit';
Angie Byron
committed
if (isset($items[$edit_path])) {
// If the edit path is a default local task we need to find the parent
// item.
$edit_path_split = explode('/', $edit_path);
do {
$entity_form_item = &$items[implode('/', $edit_path_split)];
array_pop($edit_path_split);
}
while (!empty($entity_form_item['type']) && $entity_form_item['type'] == MENU_DEFAULT_LOCAL_TASK);
Jennifer Hodgdon
committed
// Make the "Translate" tab follow the "Edit" one when possible.
Angie Byron
committed
if (isset($entity_form_item['weight'])) {
$items["$path/translations"]['weight'] = $entity_form_item['weight'] + 0.01;
}
}
}
}
}
}
/**
* Implements hook_menu_link_defaults_alter().
*/
function content_translation_menu_link_defaults_alter(array &$links) {
// Clarify where translation settings are located.
$links['language.admin.language.content_settings_page']['link_title'] = 'Content language and translation';
$links['language.admin.language.content_settings_page']['description'] = 'Configure language and translation support for content.';
/**
* Convert an entity canonical link to a router path.
*
* @param string $link
* The entity link to be converted.
*
* @return string
* The resulting router path. For instance "/node/{node}" is turned into
* "node/%node".
*
* @todo Remove this and use the actual link values when all the Content
* Translation code is adapted to the new routing system.
*/
function _content_translation_link_to_router_path($entity_type, $link) {
$path = preg_replace('|{([^}]+)}|', '%$1', trim($link, '/'));
return str_replace('%id', '%' . $entity_type, $path);
}
/**
* Strips out menu loaders from the given path.
*
* @param string $path
* The path to process.
*
* @return
* The given path where all the menu loaders are replaced with "%".
*/
Alex Pott
committed
function _content_translation_menu_strip_loaders($path) {
return preg_replace('|%[^/]+|', '%', $path);
}
Angie Byron
committed
/**
* Access callback for the translation overview page.
*
* @param \Drupal\Core\Entity\EntityInterface $entity
* The entity whose translation overview should be displayed.
*/
Alex Pott
committed
function content_translation_translate_access(EntityInterface $entity) {
return $entity instanceof ContentEntityInterface && empty($entity->getUntranslated()->language()->locked) && \Drupal::languageManager()->isMultilingual() && $entity->isTranslatable() &&
Alex Pott
committed
(user_access('create content translations') || user_access('update content translations') || user_access('delete content translations'));
Angie Byron
committed
}
/**
* Checks whether the given user can view the specified translation.
*
* @param \Drupal\Core\Entity\EntityInterface $entity
* The entity whose translation overview should be displayed.
* @param $langcode
* The language code of the translation to be displayed.
* @param \Drupal\Core\Session\AccountInterface $account
* (optional) The account for which view access should be checked. Defaults to
* the current user.
*/
Alex Pott
committed
function content_translation_view_access(EntityInterface $entity, $langcode, AccountInterface $account = NULL) {
Alex Pott
committed
$entity_type_id = $entity->getEntityTypeId();
$entity_type = $entity->getEntityType();
$permission = "translate $entity_type_id";
if ($entity_type->getPermissionGranularity() == 'bundle') {
$permission = "translate {$entity->bundle()} $entity_type_id";
}
return !empty($entity->translation[$langcode]['status']) || user_access('translate any entity', $account) || user_access($permission, $account);
}
Angie Byron
committed
/**
* Access callback for the translation addition page.
*
* @param \Drupal\Core\Entity\EntityInterface $entity
* The entity being translated.
* @param \Drupal\Core\Language\Language $source
Angie Byron
committed
* (optional) The language of the values being translated. Defaults to the
* entity language.
Angie Byron
committed
* @param \Drupal\Core\Language\Language $target
Angie Byron
committed
* (optional) The language of the translated values. Defaults to the current
* content language.
Angie Byron
committed
*/
Alex Pott
committed
function content_translation_add_access(EntityInterface $entity, Language $source = NULL, Language $target = NULL) {
Angie Byron
committed
$source = !empty($source) ? $source : $entity->language();
$target = !empty($target) ? $target : \Drupal::languageManager()->getCurrentLanguage(Language::TYPE_CONTENT);
Angie Byron
committed
$translations = $entity->getTranslationLanguages();
$languages = language_list();
return $source->id != $target->id && isset($languages[$source->id]) && isset($languages[$target->id]) && !isset($translations[$target->id]) && content_translation_access($entity, 'create');
Angie Byron
committed
}
/**
* Access callback for the translation edit page.
*
* @param \Drupal\Core\Entity\EntityInterface $entity
* The entity being translated.
* @param \Drupal\Core\Language\Language $language
* (optional) The language of the translated values. Defaults to the current
* content language.
*/
Alex Pott
committed
function content_translation_edit_access(EntityInterface $entity, Language $language = NULL) {
$language = !empty($language) ? $language : \Drupal::languageManager()->getCurrentLanguage(Language::TYPE_CONTENT);
Angie Byron
committed
$translations = $entity->getTranslationLanguages();
$languages = language_list();
return isset($languages[$language->id]) && $language->id != $entity->getUntranslated()->language()->id && isset($translations[$language->id]) && content_translation_access($entity, 'update');
Angie Byron
committed
}
/**
* Access callback for the translation delete page.
*
* @param \Drupal\Core\Entity\EntityInterface $entity
* The entity being translated.
* @param \Drupal\Core\Language\Language $language
* (optional) The language of the translated values. Defaults to the current
* content language.
*/
Alex Pott
committed
function content_translation_delete_access(EntityInterface $entity, Language $language = NULL) {
$language = !empty($language) ? $language : \Drupal::languageManager()->getCurrentLanguage(Language::TYPE_CONTENT);
Angie Byron
committed
$translations = $entity->getTranslationLanguages();
$languages = language_list();
return isset($languages[$language->id]) && $language->id != $entity->getUntranslated()->language()->id && isset($translations[$language->id]) && content_translation_access($entity, 'delete');
Angie Byron
committed
}
/**
* Returns the key name used to store the configuration setting.
Angie Byron
committed
*
* Based on the entity type and bundle, the keys used to store configuration
* will have a common root name.
Angie Byron
committed
*
* @param string $entity_type
* The type of the entity the setting refers to.
* @param string $bundle
* The bundle of the entity the setting refers to.
* @param string $setting
* The name of the setting.
*
* @return string
* The key name of the configuration setting.
Angie Byron
committed
*
* @todo Generalize this logic so that it is available to any module needing
* per-bundle configuration.
*/
Alex Pott
committed
function content_translation_get_config_key($entity_type, $bundle, $setting) {
Angie Byron
committed
$entity_type = preg_replace('/[^0-9a-zA-Z_]/', "_", $entity_type);
$bundle = preg_replace('/[^0-9a-zA-Z_]/', "_", $bundle);
Alex Pott
committed
return $entity_type . '.' . $bundle . '.content_translation.' . $setting;
Angie Byron
committed
}
/**
* Retrieves the value for the specified setting.
*
* @param string $entity_type
* The type of the entity the setting refer to.
* @param string $bundle
* The bundle of the entity the setting refer to.
* @param string $setting
* The name of the setting.
*
* @returns mixed
* The stored value for the given setting.
*/
Alex Pott
committed
function content_translation_get_config($entity_type, $bundle, $setting) {
$key = content_translation_get_config_key($entity_type, $bundle, $setting);
return \Drupal::config('content_translation.settings')->get($key);
Angie Byron
committed
}
/**
* Stores the given value for the specified setting.
*
* @param string $entity_type
* The type of the entity the setting refer to.
* @param string $bundle
* The bundle of the entity the setting refer to.
* @param string $setting
* The name of the setting.
* @param $value
* The value to be stored for the given setting.
*/
Alex Pott
committed
function content_translation_set_config($entity_type, $bundle, $setting, $value) {
$key = content_translation_get_config_key($entity_type, $bundle, $setting);
return \Drupal::config('content_translation.settings')->set($key, $value)->save();
Angie Byron
committed
}
/**
* Determines whether the given entity type is translatable.
*
* @param string $entity_type
* The type of the entity.
* @param string $bundle
* (optional) The bundle of the entity. If no bundle is provided, all the
* available bundles are checked.
*
* @returns
* TRUE if the specified bundle is translatable. If no bundle is provided
* returns TRUE if at least one of the entity bundles is translatable.
*
* @todo Move to \Drupal\content_translation\ContentTranslationManager.
Angie Byron
committed
*/
Alex Pott
committed
function content_translation_enabled($entity_type, $bundle = NULL) {
Angie Byron
committed
$enabled = FALSE;
if (\Drupal::service('content_translation.manager')->isSupported($entity_type)) {
Angie Byron
committed
$bundles = !empty($bundle) ? array($bundle) : array_keys(entity_get_bundles($entity_type));
foreach ($bundles as $bundle) {
Alex Pott
committed
if (content_translation_get_config($entity_type, $bundle, 'enabled')) {
Angie Byron
committed
$enabled = TRUE;
break;
}
Angie Byron
committed
}
}
Angie Byron
committed
return $enabled;
Angie Byron
committed
}
/**
Alex Pott
committed
* Content translation controller factory.
Angie Byron
committed
*
Alex Pott
committed
* @param string $entity_type_id
Angie Byron
committed
* The type of the entity being translated.
*
Alex Pott
committed
* @return \Drupal\content_translation\ContentTranslationControllerInterface
* An instance of the content translation controller interface.
*
* @todo Move to \Drupal\content_translation\ContentTranslationManager.
Angie Byron
committed
*/
Alex Pott
committed
function content_translation_controller($entity_type_id) {
$entity_type = \Drupal::entityManager()->getDefinition($entity_type_id);
Angie Byron
committed
// @todo Throw an exception if the key is missing.
Alex Pott
committed
$class = $entity_type->getControllerClass('translation');
return new $class($entity_type);
Angie Byron
committed
}
/**
* Returns the entity form controller for the given form.
*
* @param array $form_state
* The form state array holding the entity form controller.
*
* @return \Drupal\Core\Entity\EntityFormControllerInterface;
Alex Pott
committed
* An instance of the content translation form interface or FALSE if not an
Angie Byron
committed
* entity form.
*
* @todo Move to \Drupal\content_translation\ContentTranslationManager.
Angie Byron
committed
*/
Alex Pott
committed
function content_translation_form_controller(array $form_state) {
Angie Byron
committed
return isset($form_state['controller']) && $form_state['controller'] instanceof EntityFormControllerInterface ? $form_state['controller'] : FALSE;
}
/**
Alex Pott
committed
* Checks whether a content translation is accessible.
Angie Byron
committed
*
* @param \Drupal\Core\Entity\EntityInterface $entity
* The entity to be accessed.
Angie Byron
committed
* @param $op
* The operation to be performed on the translation. Possible values are:
* - "view"
* - "update"
* - "delete"
* - "create"
Angie Byron
committed
*
* @return
* TRUE if the current user is allowed to view the translation.
*
* @todo Move to \Drupal\content_translation\ContentTranslationManager.
Angie Byron
committed
*/
Alex Pott
committed
function content_translation_access(EntityInterface $entity, $op) {
return content_translation_controller($entity->getEntityTypeId())->getTranslationAccess($entity, $op) ;
Angie Byron
committed
}
/**
* Implements hook_permission().
*/
Alex Pott
committed
function content_translation_permission() {
Angie Byron
committed
$permission = array(
Alex Pott
committed
'administer content translation' => array(
Angie Byron
committed
'title' => t('Administer translation settings'),
Angie Byron
committed
'description' => t('Configure translatability of entities and fields.'),
Angie Byron
committed
),
Alex Pott
committed
'create content translations' => array(
Angie Byron
committed
'title' => t('Create translations'),
),
Alex Pott
committed
'update content translations' => array(
Angie Byron
committed
'title' => t('Edit translations'),
),
Alex Pott
committed
'delete content translations' => array(
Angie Byron
committed
'title' => t('Delete translations'),
),
Angie Byron
committed
'translate any entity' => array(
'title' => t('Translate any entity'),
),
);
Angie Byron
committed
// Create a translate permission for each enabled entity type and (optionally)
// bundle.
Alex Pott
committed
foreach (\Drupal::entityManager()->getDefinitions() as $entity_type_id => $entity_type) {
if ($permission_granularity = $entity_type->getPermissionGranularity()) {
$t_args = array('@entity_label' => $entity_type->getLowercaseLabel());
Angie Byron
committed
Alex Pott
committed
switch ($permission_granularity) {
Angie Byron
committed
case 'bundle':
Alex Pott
committed
foreach (entity_get_bundles($entity_type_id) as $bundle => $bundle_info) {
if (content_translation_enabled($entity_type_id, $bundle)) {
$t_args['%bundle_label'] = isset($bundle_info['label']) ? $bundle_info['label'] : $bundle;
Alex Pott
committed
$permission["translate $bundle $entity_type_id"] = array(
'title' => t('Translate %bundle_label @entity_label', $t_args),
Angie Byron
committed
);
}
}
break;
case 'entity_type':
Alex Pott
committed
if (content_translation_enabled($entity_type_id)) {
$permission["translate $entity_type_id"] = array(
Angie Byron
committed
'title' => t('Translate @entity_label', $t_args),
);
}
break;
}
Angie Byron
committed
}
}
return $permission;
}
/**
* Implements hook_form_alter().
*/
Alex Pott
committed
function content_translation_form_alter(array &$form, array &$form_state) {
$form_controller = content_translation_form_controller($form_state);
$entity = $form_controller ? $form_controller->getEntity() : NULL;
if ($entity instanceof ContentEntityInterface && $entity->isTranslatable() && count($entity->getTranslationLanguages()) > 1) {
$controller = content_translation_controller($entity->getEntityTypeId());
Angie Byron
committed
$controller->entityFormAlter($form, $form_state, $entity);
// @todo Move the following lines to the code generating the property form
// elements once we have an official #multilingual FAPI key.
$translations = $entity->getTranslationLanguages();
$form_langcode = $form_controller->getFormLangcode($form_state);
// Handle fields shared between translations when there is at least one
// translation available or a new one is being created.
if (!$entity->isNew() && (!isset($translations[$form_langcode]) || count($translations) > 1)) {
foreach ($entity->getFieldDefinitions() as $property_name => $definition) {
if (isset($form[$property_name])) {
Alex Pott
committed
$form[$property_name]['#multilingual'] = $definition->isTranslatable();
Angie Byron
committed
}
}
}
}
}
/**
* Implements hook_language_fallback_candidates_OPERATION_alter().
*
* Performs language fallback for unaccessible translations.
*/
function content_translation_language_fallback_candidates_entity_view_alter(&$candidates, $context) {
$entity = $context['data'];
foreach ($entity->getTranslationLanguages() as $langcode => $language) {
if (!content_translation_view_access($entity, $langcode)) {
unset($candidates[$langcode]);
}
}
}
Angie Byron
committed
/**
* Implements hook_entity_load().
*/
Alex Pott
committed
function content_translation_entity_load(array $entities, $entity_type) {
Angie Byron
committed
$enabled_entities = array();
Alex Pott
committed
if (content_translation_enabled($entity_type)) {
Angie Byron
committed
foreach ($entities as $entity) {
if ($entity instanceof ContentEntityInterface && $entity->isTranslatable()) {
Angie Byron
committed
$enabled_entities[$entity->id()] = $entity;
}
}
}
if (!empty($enabled_entities)) {
Alex Pott
committed
content_translation_load_translation_metadata($enabled_entities, $entity_type);
Angie Byron
committed
}
}
/**
* Loads translation data into the given entities.
*
* @param array $entities
* The entities keyed by entity ID.
* @param string $entity_type
* The type of the entities.
*/
Alex Pott
committed
function content_translation_load_translation_metadata(array $entities, $entity_type) {
$query = 'SELECT * FROM {content_translation} te WHERE te.entity_type = :entity_type AND te.entity_id IN (:entity_id)';
$result = db_query($query, array(':entity_type' => $entity_type, ':entity_id' => array_keys($entities)));
$exclude = array('entity_type', 'entity_id', 'langcode');
Angie Byron
committed
foreach ($result as $record) {
$entity = $entities[$record->entity_id];
// @todo Declare these as entity (translation?) properties.
foreach ($record as $field_name => $value) {
if (!in_array($field_name, $exclude)) {
$langcode = $record->langcode;
$entity->translation[$langcode][$field_name] = $value;
if (!$entity->hasTranslation($langcode)) {
$entity->initTranslation($langcode);
}
}
}
Angie Byron
committed
}
}
/**
* Implements hook_entity_insert().
*/
Alex Pott
committed
function content_translation_entity_insert(EntityInterface $entity) {
Angie Byron
committed
// Only do something if translation support for the given entity is enabled.
if (!($entity instanceof ContentEntityInterface) || !$entity->isTranslatable()) {
Angie Byron
committed
return;
}
$fields = array('entity_type', 'entity_id', 'langcode', 'source', 'outdated', 'uid', 'status', 'created', 'changed');
Alex Pott
committed
$query = db_insert('content_translation')->fields($fields);
Angie Byron
committed
foreach ($entity->getTranslationLanguages() as $langcode => $language) {
$translation = isset($entity->translation[$langcode]) ? $entity->translation[$langcode] : array();
$translation += array(
'source' => '',
'uid' => \Drupal::currentUser()->id(),
'outdated' => FALSE,
'status' => TRUE,
'created' => REQUEST_TIME,
'changed' => REQUEST_TIME,
);
$translation['entity_type'] = $entity->getEntityTypeId();
$translation['entity_id'] = $entity->id();
$translation['langcode'] = $langcode;
// Reorder values to match the schema.
$values = array();
foreach ($fields as $field_name) {
$value = is_bool($translation[$field_name]) ? intval($translation[$field_name]) : $translation[$field_name];
$values[$field_name] = $value;
}
$query->values($values);
Angie Byron
committed
}
$query->execute();
}
/**
* Implements hook_entity_delete().
*/
Alex Pott
committed
function content_translation_entity_delete(EntityInterface $entity) {
Angie Byron
committed
// Only do something if translation support for the given entity is enabled.
if (!($entity instanceof ContentEntityInterface) || !$entity->isTranslatable()) {
Angie Byron
committed
return;
}
Alex Pott
committed
db_delete('content_translation')
->condition('entity_type', $entity->getEntityTypeId())
Angie Byron
committed
->condition('entity_id', $entity->id())
->execute();
}
/**
* Implements hook_entity_update().
*/
Alex Pott
committed
function content_translation_entity_update(EntityInterface $entity) {
Angie Byron
committed
// Only do something if translation support for the given entity is enabled.
if (!($entity instanceof ContentEntityInterface) || !$entity->isTranslatable()) {
Angie Byron
committed
return;
}
Angie Byron
committed
// Delete and create to ensure no stale value remains behind.
Alex Pott
committed
content_translation_entity_delete($entity);
content_translation_entity_insert($entity);
Angie Byron
committed
}
/**
* Implements hook_field_extra_fields().
*/
Alex Pott
committed
function content_translation_field_extra_fields() {
Angie Byron
committed
$extra = array();
Alex Pott
committed
foreach (\Drupal::entityManager()->getDefinitions() as $entity_type => $info) {
Dries Buytaert
committed
foreach (entity_get_bundles($entity_type) as $bundle => $bundle_info) {
Alex Pott
committed
if (content_translation_enabled($entity_type, $bundle)) {
Angie Byron
committed
$extra[$entity_type][$bundle]['form']['translation'] = array(
'label' => t('Translation'),
'description' => t('Translation settings'),
'weight' => 10,
);
}
}
}
return $extra;
}
/**
Alex Pott
committed
* Implements hook_form_FORM_ID_alter() for 'field_ui_field_edit_form'.
Angie Byron
committed
*/
Alex Pott
committed
function content_translation_form_field_ui_field_edit_form_alter(array &$form, array &$form_state, $form_id) {
Angie Byron
committed
$field = $form['#field'];
$bundle = $form['#bundle'];
$bundle_is_translatable = content_translation_enabled($field->entity_type, $bundle);
$form['field']['translatable'] = array(
'#type' => 'checkbox',
'#title' => t('Users may translate this field.'),
Angie Byron
committed
'#default_value' => $field->isTranslatable(),
'#weight' => 20,
Angie Byron
committed
'#disabled' => !$bundle_is_translatable,
);
Angie Byron
committed
$form['#submit'][] = 'content_translation_form_field_ui_field_edit_form_submit';
Angie Byron
committed
// Provide helpful pointers for administrators.
if (\Drupal::currentUser()->hasPermission('administer content translation') && !$bundle_is_translatable) {
$toggle_url = url('admin/config/regional/content-language', array(
'query' => drupal_get_destination(),
));
$form['field']['translatable']['#description'] = t('To enable translation of this field, <a href="@language-settings-url">enable language support</a> for this type.', array(
'@language-settings-url' => $toggle_url,
));
}
Angie Byron
committed
}
/**
* Form submission handler for 'field_ui_field_edit_form'.
*/
function content_translation_form_field_ui_field_edit_form_submit($form, array &$form_state) {
$instance = $form_state['instance'];
$value = content_translation_get_config($instance->entity_type, $instance->bundle, 'fields');
if (!isset($value)) {
$value = array();
}
Alex Pott
committed
$value[$instance->getField()->getName()] = $form_state['values']['field']['translatable'];
Angie Byron
committed
// Store the same value for all bundles as translatability is tracked per
// field.
foreach (entity_get_bundles($instance->entity_type) as $bundle => $info) {
content_translation_set_config($instance->entity_type, $bundle, 'fields', $value);
}
Angie Byron
committed
}
Alex Pott
committed
* Implements hook_form_FORM_ID_alter() for 'field_ui_field_instance_edit_form'.
Alex Pott
committed
function content_translation_form_field_ui_field_instance_edit_form_alter(array &$form, array &$form_state, $form_id) {
Alex Pott
committed
if ($form['#field']->isTranslatable()) {
Alex Pott
committed
module_load_include('inc', 'content_translation', 'content_translation.admin');
$element = content_translation_field_sync_widget($form['#field']);
if ($element) {
$form['instance']['settings']['translation_sync'] = $element;
}
}
}
/**
* Implements hook_field_info_alter().
*/
Alex Pott
committed
function content_translation_field_info_alter(&$info) {
Angie Byron
committed
foreach ($info as &$field_type_info) {
// By default no column has to be synchronized.
$field_type_info['settings'] += array('translation_sync' => FALSE);
// Synchronization can be enabled per instance.
$field_type_info['instance_settings'] += array('translation_sync' => FALSE);
}
}
/**
* Implements hook_entity_presave().
Alex Pott
committed
function content_translation_entity_presave(EntityInterface $entity) {
if ($entity instanceof ContentEntityInterface && $entity->isTranslatable()) {
// @todo Avoid using request attributes once translation metadata become
// regular fields.
$attributes = \Drupal::request()->attributes;
\Drupal::service('content_translation.synchronizer')->synchronizeFields($entity, $entity->language()->id, $attributes->get('source_langcode'));
}
}
Angie Byron
committed
/**
* Implements hook_element_info_alter().
*/
Alex Pott
committed
function content_translation_element_info_alter(&$type) {
Angie Byron
committed
if (isset($type['language_configuration'])) {
Alex Pott
committed
$type['language_configuration']['#process'][] = 'content_translation_language_configuration_element_process';
Angie Byron
committed
}
}
Angie Byron
committed
/**
Alex Pott
committed
* Returns a widget to enable content translation per entity bundle.
Angie Byron
committed
*
* Backward compatibility layer to support entities not using the language
* configuration form element.
*
* @todo Remove once all core entities have language configuration.
*
* @param string $entity_type
* The type of the entity being configured for translation.
* @param string $bundle
* The bundle of the entity being configured for translation.
* @param array $form
* The configuration form array.
* @param array $form_state
* The configuration form state array.
*/
Alex Pott
committed
function content_translation_enable_widget($entity_type, $bundle, array &$form, array &$form_state) {
$key = $form_state['content_translation']['key'];
Angie Byron
committed
if (!isset($form_state['language'][$key])) {
$form_state['language'][$key] = array();
}
$form_state['language'][$key] += array('entity_type' => $entity_type, 'bundle' => $bundle);
Alex Pott
committed
$element = content_translation_language_configuration_element_process(array('#name' => $key), $form_state, $form);
unset($element['content_translation']['#element_validate']);
Angie Byron
committed
return $element;
}
/**
* Process callback: Expands the language_configuration form element.
*
* @param array $element
* Form API element.
*
* @return
* Processed language configuration element.
*/
Alex Pott
committed
function content_translation_language_configuration_element_process(array $element, array &$form_state, array &$form) {
if (empty($element['#content_translation_skip_alter']) && user_access('administer content translation')) {
$form_state['content_translation']['key'] = $element['#name'];
Angie Byron
committed
$context = $form_state['language'][$element['#name']];
Angie Byron
committed
Alex Pott
committed
$element['content_translation'] = array(
Angie Byron
committed
'#type' => 'checkbox',
'#title' => t('Enable translation'),
Alex Pott
committed
'#default_value' => content_translation_enabled($context['entity_type'], $context['bundle']),
'#element_validate' => array('content_translation_language_configuration_element_validate'),
Angie Byron
committed
'#prefix' => '<label>' . t('Translation') . '</label>',
);
Angie Byron
committed
Alex Pott
committed
$form['actions']['submit']['#submit'][] = 'content_translation_language_configuration_element_submit';
Angie Byron
committed
}
Angie Byron
committed
return $element;
}
/**
Alex Pott
committed
* Form validation handler for element added with content_translation_language_configuration_element_process().
Angie Byron
committed
*
* Checks whether translation can be enabled: if language is set to one of the
* special languages and language selector is not hidden, translation cannot be
* enabled.
*
Alex Pott
committed
* @see content_translation_language_configuration_element_submit()
Angie Byron
committed
*/
Alex Pott
committed
function content_translation_language_configuration_element_validate($element, array &$form_state, array $form) {
$key = $form_state['content_translation']['key'];
Angie Byron
committed
$values = $form_state['values'][$key];
if (!$values['language_show'] && $values['content_translation'] && \Drupal::languageManager()->isLanguageLocked($values['langcode'])) {
foreach (language_list(Language::STATE_LOCKED) as $language) {
Angie Byron
committed
$locked_languages[] = $language->name;
}
// @todo Set the correct form element name as soon as the element parents
// are correctly set. We should be using NestedArray::getValue() but for
// now we cannot.
Angie Byron
committed
form_set_error('', $form_state, t('"Show language selector" is not compatible with translating content that has default language: %choice. Either do not hide the language selector or pick a specific language.', array('%choice' => $locked_languages[$values['langcode']])));
Angie Byron
committed
}
}
/**
Alex Pott
committed
* Form submission handler for element added with content_translation_language_configuration_element_process().
Angie Byron
committed
*
Alex Pott
committed
* Stores the content translation settings.
Angie Byron
committed
*
Alex Pott
committed
* @see content_translation_language_configuration_element_validate()
Angie Byron
committed
*/
Alex Pott
committed
function content_translation_language_configuration_element_submit(array $form, array &$form_state) {
$key = $form_state['content_translation']['key'];
Angie Byron
committed
$context = $form_state['language'][$key];
Alex Pott
committed
$enabled = $form_state['values'][$key]['content_translation'];
Angie Byron
committed
Alex Pott
committed
if (content_translation_enabled($context['entity_type'], $context['bundle']) != $enabled) {
content_translation_set_config($context['entity_type'], $context['bundle'], 'enabled', $enabled);
Angie Byron
committed
entity_info_cache_clear();
menu_router_rebuild();
}
}
Angie Byron
committed
/**
* Implements hook_form_FORM_ID_alter() for language_content_settings_form().
*/
Alex Pott
committed
function content_translation_form_language_content_settings_form_alter(array &$form, array &$form_state) {
module_load_include('inc', 'content_translation', 'content_translation.admin');
_content_translation_form_language_content_settings_form_alter($form, $form_state);
Angie Byron
committed
}
/**
* Implements hook_preprocess_HOOK() for theme_language_content_settings_table().
*/
Alex Pott
committed
function content_translation_preprocess_language_content_settings_table(&$variables) {
module_load_include('inc', 'content_translation', 'content_translation.admin');
_content_translation_preprocess_language_content_settings_table($variables);
Angie Byron
committed
/**
Alex Pott
committed
* Stores content translation settings.
Angie Byron
committed
*
* @param array $settings
* An associative array of settings keyed by entity type and bundle. At bundle