content_translation.module 34.4 KB
Newer Older
1 2 3 4 5 6 7
<?php

/**
 * @file
 * Allows entities to be translated into different languages.
 */

8
use Drupal\Core\Entity\ContentEntityInterface;
9
use Drupal\Core\Entity\EntityFormInterface;
10
use Drupal\Core\Entity\EntityInterface;
11
use Drupal\Core\Form\FormStateInterface;
12
use Drupal\Core\Language\LanguageInterface;
13
use Drupal\Core\Routing\RouteMatchInterface;
14
use Drupal\field\Entity\FieldInstanceConfig;
15
use Drupal\node\NodeInterface;
16 17 18 19

/**
 * Implements hook_help().
 */
20
function content_translation_help($route_name, RouteMatchInterface $route_match) {
21 22
  switch ($route_name) {
    case 'help.page.content_translation':
23 24
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
25
      $output .= '<p>' . t('The Content Translation module allows you to translate content, comments, custom blocks, taxonomy terms, users and other <a href="!entity_help">content entities</a>. Together with the modules <a href="!language">Language</a>, <a href="!config-trans">Configuration Translation</a>, and <a href="!locale">Interface Translation</a>, it allows you to build multilingual websites. For more information, see <a href="!translation-entity">the online documentation for the Content Translation module</a>.', array('!locale' => (\Drupal::moduleHandler()->moduleExists('locale')) ? \Drupal::url('help.page', array('name' => 'locale')) : '#', '!config-trans' => (\Drupal::moduleHandler()->moduleExists('config_translation')) ? \Drupal::url('help.page', array('name' => 'config_translation')) : '#', '!language' => \Drupal::url('help.page', array('name' => 'language')), '!translation-entity' => 'https://drupal.org/documentation/modules/translation', '!entity_help' => \Drupal::url('help.page', array('name' => 'entity')))) . '</p>';
26 27 28
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
      $output .= '<dt>' . t('Enabling translation') . '</dt>';
29 30 31
      $output .= '<dd>' . t('In order to translate content, the website must have at least two <a href="!url">languages</a>. When that is the case, you can enable translation for the desired content entities on the <a href="!translation-entity">Content language</a> page. When enabling translation you can choose the default language for content and decide whether to show the language selection field on the content editing forms.', array('!url' => \Drupal::url('language.admin_overview'), '!translation-entity' => \Drupal::url('language.content_settings_page'), '!language-help' => \Drupal::url('help.page', array('name' => 'language')))) . '</dd>';
      $output .= '<dt>' . t('Enabling field translation') . '</dt>';
      $output .= '<dd>' . t('You can define which fields of a content entity can be translated. For example, you might want to translate the title and body field while leaving the image field untranslated. If you exclude a field from being translated, it will still show up in the content editing form, but any changes made to that field will be applied to <em>all</em> translations of that content.') . '</dd>';
32
      $output .= '<dt>' . t('Translating content') . '</dt>';
33 34 35 36 37
      $output .= '<dd>' . t('If translation is enabled you can translate a content entity via the Translate tab (or Translate link). The Translations page of a content entity gives an overview of the translation status for the current content and lets you add, edit, and delete its translations. This process is similar for every translatable content entity on your site.') . '</dd>';
      $output .= '<dt>' . t('Changing the source language for a translation') . '</dt>';
      $output .= '<dd>' . t('When you add a new translation, the original text you are translating is displayed in the edit form as the <em>source</em>. If at least one translation of the original content already exists when you add a new translation, you can choose either the original content (default) or one of the other translations as the source, using the select list in the Source language section. After saving the translation, the chosen source language is then listed on the Translate tab of the content.') . '</dd>';
      $output .= '<dt>' . t('Setting status of translations') . '</dt>';
      $output .= '<dd>' . t('If you edit a translation in one language you may want to set the status of the other translations as <em>out-of-date</em>. You can set this status by selecting the <em>Flag other translations as outdated</em> checkbox in the Translation section of the content editing form. The status will be visible on the Translations page.') . '</dd>';
38 39
      $output .= '</dl>';
      return $output;
40

41
    case 'language.content_settings_page':
42
      $output = '';
43
      if (!\Drupal::languageManager()->isMultilingual()) {
44
        $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' => \Drupal::url('language.admin_overview')));
45 46
      }
      return $output;
47 48 49
  }
}

50 51 52
/**
 * Implements hook_module_implements_alter().
 */
53
function content_translation_module_implements_alter(&$implementations, $hook) {
54 55
  switch ($hook) {
    // Move some of our hook implementations to the end of the list.
56
    case 'entity_type_alter':
57 58 59
      $group = $implementations['content_translation'];
      unset($implementations['content_translation']);
      $implementations['content_translation'] = $group;
60 61 62 63
      break;
  }
}

64 65 66
/**
 * Implements hook_language_type_info_alter().
 */
67
function content_translation_language_types_info_alter(array &$language_types) {
68 69
  // Make content language negotiation configurable by removing the 'locked'
  // flag.
70 71
  $language_types[LanguageInterface::TYPE_CONTENT]['locked'] = FALSE;
  unset($language_types[LanguageInterface::TYPE_CONTENT]['fixed']);
72 73 74
}

/**
75
 * Implements hook_entity_type_alter().
76 77
 *
 * The content translation UI relies on the entity info to provide its features.
78
 * See the documentation of hook_entity_type_build() in the Entity API documentation
79 80 81 82 83 84 85 86 87 88 89
 * 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
90
 * defined, \Drupal\content_translation\ContentTranslationHandler will be
91
 * assumed. Every translation controller class must implement
92
 * \Drupal\content_translation\ContentTranslationHandlerInterface.
93 94 95 96 97 98 99
 *
 * 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
100
 */
101
function content_translation_entity_type_alter(array &$entity_types) {
102
  // Provide defaults for translation info.
103 104 105 106
  /** @var $entity_types \Drupal\Core\Entity\EntityTypeInterface[] */
  foreach ($entity_types as $entity_type) {
    if ($entity_type->isTranslatable()) {
      if (!$entity_type->hasControllerClass('translation')) {
107
        $entity_type->setControllerClass('translation', 'Drupal\content_translation\ContentTranslationHandler');
108
      }
109

110
      $translation = $entity_type->get('translation');
111 112
      if (!$translation || !isset($translation['content_translation'])) {
        $translation['content_translation'] = array();
113
      }
114

115
      if ($entity_type->hasLinkTemplate('canonical')) {
116
        // Provide default route names for the translation paths.
117 118
        if (!$entity_type->hasLinkTemplate('drupal:content-translation-overview')) {
          $entity_type->setLinkTemplate('drupal:content-translation-overview', "content_translation.translation_overview_" . $entity_type->id());
119
        }
120 121
        // @todo Remove this as soon as menu access checks rely on the
        //   controller. See https://drupal.org/node/2155787.
122
        $translation['content_translation'] += array(
123
          'access_callback' => 'content_translation_translate_access',
124 125
        );
      }
126
      $entity_type->set('translation', $translation);
127
    }
128 129
  }
}
130

131 132 133
/**
 * Implements hook_entity_bundle_info_alter().
 */
134
function content_translation_entity_bundle_info_alter(&$bundles) {
135 136
  foreach ($bundles as $entity_type => &$info) {
    foreach ($info as $bundle => &$bundle_info) {
137
      $enabled = content_translation_get_config($entity_type, $bundle, 'enabled');
138
      $bundle_info['translatable'] = !empty($enabled);
139 140 141 142
    }
  }
}

143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163
/**
 * Implements hook_field_info_alter().
 *
 * Content translation extends the @FieldType annotation with following key:
 * - column_groups: contains information about the field type properties
 *   which columns should be synchronized across different translations and
 *   which are translatable. This is useful for instance to translate the
 *   "alt" and "title" textual elements of an image field, while keeping the
 *   same image on every translation.
 *
 *   @see Drupal\image\Plugin\Field\FieldType\imageItem.
 */
function content_translation_field_info_alter(&$info) {
  foreach ($info as $key => $settings) {
    // Supply the column_groups key if it's not there.
    if (empty($settings['column_groups'])) {
      $info[$key]['column_groups'] = array();
    }
  }
}

164 165 166 167 168 169 170 171
/**
 * 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'),
172
    ) + $entity->urlInfo('drupal:content-translation-overview')->toArray();
173 174 175
  }
}

176
/**
177
 * Implements hook_menu_links_discovered_alter().
178
 */
179
function content_translation_menu_links_discovered_alter(array &$links) {
180
  // Clarify where translation settings are located.
181
  $links['language.content_settings_page']['title'] = 'Content language and translation';
182
  $links['language.content_settings_page']['description'] = 'Configure language and translation support for content.';
183 184
}

185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202
/**
 * 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);
}

203 204 205 206 207 208 209 210 211
/**
 * 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 "%".
 */
212
function _content_translation_menu_strip_loaders($path) {
213 214 215
  return preg_replace('|%[^/]+|', '%', $path);
}

216 217 218 219 220 221
/**
 * Access callback for the translation overview page.
 *
 * @param \Drupal\Core\Entity\EntityInterface $entity
 *   The entity whose translation overview should be displayed.
 */
222
function content_translation_translate_access(EntityInterface $entity) {
223
  $account = \Drupal::currentUser();
224
  return $entity instanceof ContentEntityInterface && empty($entity->getUntranslated()->language()->locked) && \Drupal::languageManager()->isMultilingual() && $entity->isTranslatable() &&
225
    ($account->hasPermission('create content translations') || $account->hasPermission('update content translations') || $account->hasPermission('delete content translations'));
226 227 228
}

/**
229
 * Returns the key name used to store the configuration setting.
230
 *
231 232
 * Based on the entity type and bundle, the keys used to store configuration
 * will have a common root name.
233 234 235 236 237 238 239 240 241
 *
 * @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
242
 *   The key name of the configuration setting.
243 244 245 246
 *
 * @todo Generalize this logic so that it is available to any module needing
 *   per-bundle configuration.
 */
247
function content_translation_get_config_key($entity_type, $bundle, $setting) {
248 249
  $entity_type = preg_replace('/[^0-9a-zA-Z_]/', "_", $entity_type);
  $bundle = preg_replace('/[^0-9a-zA-Z_]/', "_", $bundle);
250
  return $entity_type . '.' . $bundle . '.content_translation.' . $setting;
251 252 253 254 255 256 257 258 259 260 261 262 263 264 265
}

/**
 * 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.
 */
266 267
function content_translation_get_config($entity_type, $bundle, $setting) {
  $key = content_translation_get_config_key($entity_type, $bundle, $setting);
268
  return \Drupal::config('content_translation.settings')->get($key);
269 270 271 272 273 274 275 276 277 278 279 280 281 282
}

/**
 * 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.
 */
283 284
function content_translation_set_config($entity_type, $bundle, $setting, $value) {
  $key = content_translation_get_config_key($entity_type, $bundle, $setting);
285
  return \Drupal::config('content_translation.settings')->set($key, $value)->save();
286 287 288 289 290 291 292 293 294 295 296 297 298 299
}

/**
 * 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.
300 301
 *
 * @todo Move to \Drupal\content_translation\ContentTranslationManager.
302
 */
303
function content_translation_enabled($entity_type, $bundle = NULL) {
304 305
  $enabled = FALSE;

306
  if (\Drupal::service('content_translation.manager')->isSupported($entity_type)) {
307 308
    $bundles = !empty($bundle) ? array($bundle) : array_keys(entity_get_bundles($entity_type));
    foreach ($bundles as $bundle) {
309
      if (content_translation_get_config($entity_type, $bundle, 'enabled')) {
310 311 312
        $enabled = TRUE;
        break;
      }
313 314 315
    }
  }

316
  return $enabled;
317 318 319
}

/**
320
 * Content translation controller factory.
321
 *
322
 * @param string $entity_type_id
323 324
 *   The type of the entity being translated.
 *
325
 * @return \Drupal\content_translation\ContentTranslationHandlerInterface
326
 *   An instance of the content translation controller interface.
327 328
 *
 * @todo Move to \Drupal\content_translation\ContentTranslationManager.
329
 */
330 331
function content_translation_controller($entity_type_id) {
  $entity_type = \Drupal::entityManager()->getDefinition($entity_type_id);
332
  // @todo Throw an exception if the key is missing.
333 334
  $class = $entity_type->getControllerClass('translation');
  return new $class($entity_type);
335 336 337
}

/**
338
 * Returns the entity form for the given form.
339
 *
340 341
 * @param \Drupal\Core\Form\FormStateInterface $form_state
 *   The current form state holding the entity form.
342
 *
343
 * @return \Drupal\Core\Entity\EntityFormInterface;
344
 *   An instance of the content translation form interface or FALSE if not an
345
 *   entity form.
346 347
 *
 * @todo Move to \Drupal\content_translation\ContentTranslationManager.
348
 */
349
function content_translation_form_controller(FormStateInterface $form_state) {
350
  return isset($form_state['controller']) && $form_state['controller'] instanceof EntityFormInterface ? $form_state['controller'] : FALSE;
351 352 353
}

/**
354
 * Checks whether a content translation is accessible.
355 356 357
 *
 * @param \Drupal\Core\Entity\EntityInterface $entity
 *   The entity to be accessed.
358 359 360 361 362 363
 * @param $op
 *   The operation to be performed on the translation. Possible values are:
 *   - "view"
 *   - "update"
 *   - "delete"
 *   - "create"
364 365 366
 *
 * @return
 *   TRUE if the current user is allowed to view the translation.
367 368
 *
 * @todo Move to \Drupal\content_translation\ContentTranslationManager.
369
 */
370
function content_translation_access(EntityInterface $entity, $op) {
371
  return content_translation_controller($entity->getEntityTypeId())->getTranslationAccess($entity, $op) ;
372 373 374 375 376
}

/**
 * Implements hook_permission().
 */
377
function content_translation_permission() {
378
  $permission = array(
379
    'administer content translation' => array(
380
      'title' => t('Administer translation settings'),
381
      'description' => t('Configure translatability of entities and fields.'),
382
    ),
383
    'create content translations' => array(
384 385
      'title' => t('Create translations'),
    ),
386
    'update content translations' => array(
387 388
      'title' => t('Edit translations'),
    ),
389
    'delete content translations' => array(
390 391
      'title' => t('Delete translations'),
    ),
392 393 394 395 396
    'translate any entity' => array(
      'title' => t('Translate any entity'),
    ),
  );

397 398
  // Create a translate permission for each enabled entity type and (optionally)
  // bundle.
399 400 401
  foreach (\Drupal::entityManager()->getDefinitions() as $entity_type_id => $entity_type) {
    if ($permission_granularity = $entity_type->getPermissionGranularity()) {
      $t_args = array('@entity_label' => $entity_type->getLowercaseLabel());
402

403
      switch ($permission_granularity) {
404
        case 'bundle':
405 406
          foreach (entity_get_bundles($entity_type_id) as $bundle => $bundle_info) {
            if (content_translation_enabled($entity_type_id, $bundle)) {
407
              $t_args['%bundle_label'] = isset($bundle_info['label']) ? $bundle_info['label'] : $bundle;
408
              $permission["translate $bundle $entity_type_id"] = array(
409
                'title' => t('Translate %bundle_label @entity_label', $t_args),
410 411 412 413 414 415
              );
            }
          }
          break;

        case 'entity_type':
416 417
          if (content_translation_enabled($entity_type_id)) {
            $permission["translate $entity_type_id"] = array(
418 419 420 421 422
              'title' => t('Translate @entity_label', $t_args),
            );
          }
          break;
      }
423 424 425 426 427 428 429 430 431
    }
  }

  return $permission;
}

/**
 * Implements hook_form_alter().
 */
432
function content_translation_form_alter(array &$form, FormStateInterface $form_state) {
433 434 435 436
  $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) {
437
    $controller = content_translation_controller($entity->getEntityTypeId());
438 439 440 441 442 443 444 445 446 447
    $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)) {
448
      foreach ($entity->getFieldDefinitions() as $property_name => $definition) {
449
        if (isset($form[$property_name])) {
450
          $form[$property_name]['#multilingual'] = $definition->isTranslatable();
451 452 453 454 455 456 457
        }
      }
    }

  }
}

458
/**
459
 * Implements hook_language_fallback_candidates_OPERATION_alter().
460 461 462
 *
 * Performs language fallback for unaccessible translations.
 */
463
function content_translation_language_fallback_candidates_entity_view_alter(&$candidates, $context) {
464
  /** @var \Drupal\Core\Entity\ContentEntityInterface $entity */
465
  $entity = $context['data'];
466 467 468
  $entity_type_id = $entity->getEntityTypeId();
  $entity_type = $entity->getEntityType();
  $permission = $entity_type->getPermissionGranularity() == 'bundle' ? $permission = "translate {$entity->bundle()} $entity_type_id" : "translate $entity_type_id";
469 470 471 472 473 474
  $current_user = \Drupal::currentuser();
  if (!$current_user->hasPermission('translate any entity') && !$current_user->hasPermission($permission)) {
    foreach ($entity->getTranslationLanguages() as $langcode => $language) {
      if (empty($entity->translation[$langcode]['status'])) {
        unset($candidates[$langcode]);
      }
475 476 477 478
    }
  }
}

479
/**
480
 * Implements hook_entity_storage_load().
481
 */
482
function content_translation_entity_storage_load(array $entities, $entity_type) {
483 484
  $enabled_entities = array();

485
  if (content_translation_enabled($entity_type)) {
486
    foreach ($entities as $entity) {
487
      if ($entity instanceof ContentEntityInterface && $entity->isTranslatable()) {
488 489 490 491 492 493
        $enabled_entities[$entity->id()] = $entity;
      }
    }
  }

  if (!empty($enabled_entities)) {
494
    content_translation_load_translation_metadata($enabled_entities, $entity_type);
495 496 497 498 499 500 501 502 503 504 505
  }
}

/**
 * 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.
 */
506 507
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)';
508
  $result = db_query($query, array(':entity_type' => $entity_type, ':entity_id' => array_keys($entities)));
509
  $exclude = array('entity_type', 'entity_id', 'langcode');
510 511 512
  foreach ($result as $record) {
    $entity = $entities[$record->entity_id];
    // @todo Declare these as entity (translation?) properties.
513 514
    foreach ($record as $field_name => $value) {
      if (!in_array($field_name, $exclude)) {
515 516 517 518 519
        $langcode = $record->langcode;
        $entity->translation[$langcode][$field_name] = $value;
        if (!$entity->hasTranslation($langcode)) {
          $entity->initTranslation($langcode);
        }
520 521
      }
    }
522 523 524 525 526 527
  }
}

/**
 * Implements hook_entity_insert().
 */
528
function content_translation_entity_insert(EntityInterface $entity) {
529
  // Only do something if translation support for the given entity is enabled.
530
  if (!($entity instanceof ContentEntityInterface) || !$entity->isTranslatable()) {
531 532 533
    return;
  }

534
  $fields = array('entity_type', 'entity_id', 'langcode', 'source', 'outdated', 'uid', 'status', 'created', 'changed');
535
  $query = db_insert('content_translation')->fields($fields);
536 537

  foreach ($entity->getTranslationLanguages() as $langcode => $language) {
538 539 540 541
    $translation = isset($entity->translation[$langcode]) ? $entity->translation[$langcode] : array();

    $translation += array(
      'source' => '',
542
      'uid' => \Drupal::currentUser()->id(),
543 544 545 546 547 548
      'outdated' => FALSE,
      'status' => TRUE,
      'created' => REQUEST_TIME,
      'changed' => REQUEST_TIME,
    );

549
    $translation['entity_type'] = $entity->getEntityTypeId();
550 551 552 553 554 555 556 557 558 559
    $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);
560 561 562 563 564 565 566 567
  }

  $query->execute();
}

/**
 * Implements hook_entity_delete().
 */
568
function content_translation_entity_delete(EntityInterface $entity) {
569
  // Only do something if translation support for the given entity is enabled.
570
  if (!($entity instanceof ContentEntityInterface) || !$entity->isTranslatable()) {
571 572 573
    return;
  }

574
  db_delete('content_translation')
575
    ->condition('entity_type', $entity->getEntityTypeId())
576 577 578 579 580 581 582
    ->condition('entity_id', $entity->id())
    ->execute();
}

/**
 * Implements hook_entity_update().
 */
583
function content_translation_entity_update(EntityInterface $entity) {
584
  // Only do something if translation support for the given entity is enabled.
585
  if (!($entity instanceof ContentEntityInterface) || !$entity->isTranslatable()) {
586 587 588
    return;
  }

589
  // Delete and create to ensure no stale value remains behind.
590 591
  content_translation_entity_delete($entity);
  content_translation_entity_insert($entity);
592 593 594
}

/**
595
 * Implements hook_entity_extra_field_info().
596
 */
597
function content_translation_entity_extra_field_info() {
598 599
  $extra = array();

600
  foreach (\Drupal::entityManager()->getDefinitions() as $entity_type => $info) {
601
    foreach (entity_get_bundles($entity_type) as $bundle => $bundle_info) {
602
      if (content_translation_enabled($entity_type, $bundle)) {
603 604 605 606 607 608 609 610 611 612 613 614 615
        $extra[$entity_type][$bundle]['form']['translation'] = array(
          'label' => t('Translation'),
          'description' => t('Translation settings'),
          'weight' => 10,
        );
      }
    }
  }

  return $extra;
}

/**
616
 * Implements hook_form_FORM_ID_alter() for 'field_ui_instance_edit_form'.
617
 */
618
function content_translation_form_field_ui_field_instance_edit_form_alter(array &$form, FormStateInterface $form_state) {
619 620 621 622
  $instance = $form_state['instance'];
  $bundle_is_translatable = content_translation_enabled($instance->entity_type, $instance->bundle);

  $form['instance']['translatable'] = array(
623 624
    '#type' => 'checkbox',
    '#title' => t('Users may translate this field.'),
625 626
    '#default_value' => $instance->isTranslatable(),
    '#weight' => -1,
627
    '#disabled' => !$bundle_is_translatable,
628
    '#access' => $instance->getFieldStorageDefinition()->isTranslatable(),
629
  );
630 631 632 633 634 635

  // 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(),
    ));
636
    $form['instance']['translatable']['#description'] = t('To configure translation for this field, <a href="@language-settings-url">enable language support</a> for this type.', array(
637 638 639
      '@language-settings-url' => $toggle_url,
    ));
  }
640

641
  if ($instance->isTranslatable()) {
642
    module_load_include('inc', 'content_translation', 'content_translation.admin');
643
    $element = content_translation_field_sync_widget($instance);
644 645
    if ($element) {
      $form['instance']['settings']['translation_sync'] = $element;
646
      $form['instance']['settings']['translation_sync']['#weight'] = -10;
647 648 649 650 651
    }
  }
}

/**
652
 * Implements hook_entity_presave().
653
 */
654
function content_translation_entity_presave(EntityInterface $entity) {
655 656
  // By default no column has to be synchronized.
  // @todo Replace with own storage in https://drupal.org/node/2224761
657
  if ($entity->getEntityTypeId() === 'field_storage_config') {
658 659 660 661 662 663 664
    $entity->settings += array('translation_sync' => FALSE);
  }
  // Synchronization can be enabled per instance.
  // @todo Replace with own storage in https://drupal.org/node/2224761
  if ($entity->getEntityTypeId() === 'field_instance_config') {
    $entity->settings += array('translation_sync' => FALSE);
  }
665
  if ($entity instanceof ContentEntityInterface && $entity->isTranslatable()) {
666 667
    // @todo Avoid using request attributes once translation metadata become
    //   regular fields.
668 669
    $attributes = \Drupal::request()->attributes;
    \Drupal::service('content_translation.synchronizer')->synchronizeFields($entity, $entity->language()->id, $attributes->get('source_langcode'));
670 671 672
  }
}

673 674 675
/**
 * Implements hook_element_info_alter().
 */
676
function content_translation_element_info_alter(&$type) {
677
  if (isset($type['language_configuration'])) {
678
    $type['language_configuration']['#process'][] = 'content_translation_language_configuration_element_process';
679 680
  }
}
681

682
/**
683
 * Returns a widget to enable content translation per entity bundle.
684 685 686 687 688 689 690 691 692 693 694 695
 *
 * 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.
696 697
 * @param \Drupal\Core\Form\FormStateInterface $form_state
 *   The current state of the form.
698
 */
699
function content_translation_enable_widget($entity_type, $bundle, array &$form, FormStateInterface $form_state) {
700
  $key = $form_state['content_translation']['key'];
701 702 703 704
  if (!isset($form_state['language'][$key])) {
    $form_state['language'][$key] = array();
  }
  $form_state['language'][$key] += array('entity_type' => $entity_type, 'bundle' => $bundle);
705 706
  $element = content_translation_language_configuration_element_process(array('#name' => $key), $form_state, $form);
  unset($element['content_translation']['#element_validate']);
707 708 709 710 711 712 713 714 715 716 717 718
  return $element;
}

/**
 * Process callback: Expands the language_configuration form element.
 *
 * @param array $element
 *   Form API element.
 *
 * @return
 *   Processed language configuration element.
 */
719
function content_translation_language_configuration_element_process(array $element, FormStateInterface $form_state, array &$form) {
720
  if (empty($element['#content_translation_skip_alter']) && \Drupal::currentUser()->hasPermission('administer content translation')) {
721
    $form_state['content_translation']['key'] = $element['#name'];
722
    $context = $form_state['language'][$element['#name']];
723

724
    $element['content_translation'] = array(
725 726
      '#type' => 'checkbox',
      '#title' => t('Enable translation'),
727 728
      '#default_value' => content_translation_enabled($context['entity_type'], $context['bundle']),
      '#element_validate' => array('content_translation_language_configuration_element_validate'),
729 730
      '#prefix' => '<label>' . t('Translation') . '</label>',
    );
731

732
    $form['actions']['submit']['#submit'][] = 'content_translation_language_configuration_element_submit';
733
  }
734 735 736 737
  return $element;
}

/**
738
 * Form validation handler for element added with content_translation_language_configuration_element_process().
739 740 741 742 743
 *
 * 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.
 *
744
 * @see content_translation_language_configuration_element_submit()
745
 */
746
function content_translation_language_configuration_element_validate($element, FormStateInterface $form_state, array $form) {
747
  $key = $form_state['content_translation']['key'];
748
  $values = $form_state->getValue($key);
749
  if (!$values['language_show'] && $values['content_translation'] && \Drupal::languageManager()->isLanguageLocked($values['langcode'])) {
750
    foreach (\Drupal::languageManager()->getLanguages(LanguageInterface::STATE_LOCKED) as $language) {
751 752 753 754 755
      $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.
756
    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']])));
757 758 759 760
  }
}

/**
761
 * Form submission handler for element added with content_translation_language_configuration_element_process().
762
 *
763
 * Stores the content translation settings.
764
 *
765
 * @see content_translation_language_configuration_element_validate()
766
 */
767
function content_translation_language_configuration_element_submit(array $form, FormStateInterface $form_state) {
768
  $key = $form_state['content_translation']['key'];
769
  $context = $form_state['language'][$key];
770
  $enabled = $form_state->getValue(array($key, 'content_translation'));
771

772 773
  if (content_translation_enabled($context['entity_type'], $context['bundle']) != $enabled) {
    content_translation_set_config($context['entity_type'], $context['bundle'], 'enabled', $enabled);
774
    \Drupal::entityManager()->clearCachedDefinitions();
775
    \Drupal::service('router.builder')->setRebuildNeeded();
776 777
  }
}
778 779 780 781

/**
 * Implements hook_form_FORM_ID_alter() for language_content_settings_form().
 */
782
function content_translation_form_language_content_settings_form_alter(array &$form, FormStateInterface $form_state) {
783 784
  module_load_include('inc', 'content_translation', 'content_translation.admin');
  _content_translation_form_language_content_settings_form_alter($form, $form_state);
785 786
}

787 788 789
/**
 * Implements hook_preprocess_HOOK() for theme_language_content_settings_table().
 */
790 791 792
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);
793 794
}

795
/**
796
 * Stores content translation settings.
797 798 799 800 801
 *
 * @param array $settings
 *   An associative array of settings keyed by entity type and bundle. At bundle
 *   level the following keys are available:
 *   - translatable: The bundle translatability status, which is a bool.
802 803
 *   - columns: An associative array of translation synchronization settings
 *     keyed by field names.
804
 */
805
function content_translation_save_settings($settings) {
806 807
  foreach ($settings as $entity_type => $entity_settings) {
    foreach ($entity_settings as $bundle => $bundle_settings) {
808 809 810
      // The 'translatable' value is set only if it is possible to enable.
      if (isset($bundle_settings['translatable'])) {
        // Store whether a bundle has translation enabled or not.
811
        content_translation_set_config($entity_type, $bundle, 'enabled', $bundle_settings['translatable']);
812

813
        // Save translation_sync settings.
814 815
        if (!empty($bundle_settings['columns'])) {
          foreach ($bundle_settings['columns'] as $field_name => $column_settings) {
816
            $instance = FieldInstanceConfig::loadByName($entity_type, $bundle, $field_name);
817
            if ($instance->isTranslatable()) {
818
              $instance->settings['translation_sync'] = $column_settings;
819 820 821 822
            }
            // If the field does not have translatable enabled we need to reset
            // the sync settings to their defaults.
            else {
823
              unset($instance->settings['translation_sync']);
824
            }
825
            $instance->save();
826 827 828
          }
        }
      }
829 830
    }
  }
831

832
  // Ensure entity and menu router information are correctly rebuilt.
833
  \Drupal::entityManager()->clearCachedDefinitions();
834
  \Drupal::service('router.builder')->setRebuildNeeded();
835
}