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

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

8
use Drupal\content_translation\Plugin\Derivative\ContentTranslationLocalTasks;
9
use Drupal\Core\Entity\ContentEntityInterface;
10 11
use Drupal\Core\Entity\EntityFormControllerInterface;
use Drupal\Core\Entity\EntityInterface;
12 13
use Drupal\Core\Entity\EntityTypeInterface;
use Drupal\Core\Field\FieldDefinition;
14 15 16
use Drupal\Core\Language\Language;
use Drupal\Core\Session\AccountInterface;
use Drupal\Core\TypedData\TranslatableInterface;
17
use Drupal\node\NodeInterface;
18 19 20 21

/**
 * Implements hook_help().
 */
22
function content_translation_help($path, $arg) {
23
  switch ($path) {
24
    case 'admin/help#content_translation':
25 26
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
27
      $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>';
28 29 30
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
      $output .= '<dt>' . t('Enabling translation') . '</dt>';
31
      $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>';
32
      $output .= '<p>' . t('After adding languages, <a href="!url">configure translation</a>.', array('!url' => url('admin/config/regional/content-language'))) . '</p>';
33
      $output .= '<dt>' . t('Translating content') . '</dt>';
34
      $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>';
35 36 37 38 39
      $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>';
40
      $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>';
41 42
      $output .= '</dl>';
      return $output;
43 44 45

    case 'admin/config/regional/content-language':
      $output = '';
46
      if (!\Drupal::languageManager()->isMultilingual()) {
47
        $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')));
48 49
      }
      return $output;
50 51 52
  }
}

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

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

/**
78
 * Implements hook_entity_type_alter().
79 80
 *
 * The content translation UI relies on the entity info to provide its features.
81
 * See the documentation of hook_entity_type_build() in the Entity API documentation
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102
 * 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
103
 */
104
function content_translation_entity_type_alter(array &$entity_types) {
105
  // Provide defaults for translation info.
106 107 108 109 110
  /** @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');
111
      }
112

113
      $translation = $entity_type->get('translation');
114 115
      if (!$translation || !isset($translation['content_translation'])) {
        $translation['content_translation'] = array();
116
      }
117

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

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

146
/**
147
 * Implements hook_entity_base_field_info_alter().
148
 */
149 150
function content_translation_entity_base_field_info_alter(&$fields, EntityTypeInterface $entity_type) {
  $translation_settings = \Drupal::config('content_translation.settings')->get($entity_type->id());
151 152 153

  if ($translation_settings) {
    // Currently field translatability is defined per-field but we may want to
154 155 156
    // make it per-instance instead. In that case, we will need to implement
    // hook_bundle_field_info_alter() instead.
    $field_settings = array();
157
    foreach ($translation_settings as $bundle => $settings) {
158
      $field_settings += !empty($settings['content_translation']['fields']) ? $settings['content_translation']['fields'] : array();
159 160
    }

161 162 163
    foreach ($field_settings as $name => $translatable) {
      if (isset($fields[$name]) && $fields[$name] instanceof FieldDefinition) {
        $fields[$name]->setTranslatable((bool) $translatable);
164 165 166 167 168
      }
    }
  }
}

169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189
/**
 * 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();
    }
  }
}

190 191 192 193 194 195 196 197
/**
 * 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'),
198
    ) + $entity->urlInfo('drupal:content-translation-overview')->toArray();
199 200 201
  }
}

202 203 204 205 206
/**
 * Implements hook_menu_link_defaults_alter().
 */
function content_translation_menu_link_defaults_alter(array &$links) {
  // Clarify where translation settings are located.
207
  $links['language.content_settings_page']['title'] = 'Content language and translation';
208
  $links['language.content_settings_page']['description'] = 'Configure language and translation support for content.';
209 210
}

211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228
/**
 * 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);
}

229 230 231 232 233 234 235 236 237
/**
 * 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 "%".
 */
238
function _content_translation_menu_strip_loaders($path) {
239 240 241
  return preg_replace('|%[^/]+|', '%', $path);
}

242 243 244 245 246 247
/**
 * Access callback for the translation overview page.
 *
 * @param \Drupal\Core\Entity\EntityInterface $entity
 *   The entity whose translation overview should be displayed.
 */
248
function content_translation_translate_access(EntityInterface $entity) {
249
  return $entity instanceof ContentEntityInterface && empty($entity->getUntranslated()->language()->locked) && \Drupal::languageManager()->isMultilingual() && $entity->isTranslatable() &&
250
    (user_access('create content translations') || user_access('update content translations') || user_access('delete content translations'));
251 252 253
}

/**
254
 * Returns the key name used to store the configuration setting.
255
 *
256 257
 * Based on the entity type and bundle, the keys used to store configuration
 * will have a common root name.
258 259 260 261 262 263 264 265 266
 *
 * @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
267
 *   The key name of the configuration setting.
268 269 270 271
 *
 * @todo Generalize this logic so that it is available to any module needing
 *   per-bundle configuration.
 */
272
function content_translation_get_config_key($entity_type, $bundle, $setting) {
273 274
  $entity_type = preg_replace('/[^0-9a-zA-Z_]/', "_", $entity_type);
  $bundle = preg_replace('/[^0-9a-zA-Z_]/', "_", $bundle);
275
  return $entity_type . '.' . $bundle . '.content_translation.' . $setting;
276 277 278 279 280 281 282 283 284 285 286 287 288 289 290
}

/**
 * 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.
 */
291 292
function content_translation_get_config($entity_type, $bundle, $setting) {
  $key = content_translation_get_config_key($entity_type, $bundle, $setting);
293
  return \Drupal::config('content_translation.settings')->get($key);
294 295 296 297 298 299 300 301 302 303 304 305 306 307
}

/**
 * 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.
 */
308 309
function content_translation_set_config($entity_type, $bundle, $setting, $value) {
  $key = content_translation_get_config_key($entity_type, $bundle, $setting);
310
  return \Drupal::config('content_translation.settings')->set($key, $value)->save();
311 312 313 314 315 316 317 318 319 320 321 322 323 324
}

/**
 * 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.
325 326
 *
 * @todo Move to \Drupal\content_translation\ContentTranslationManager.
327
 */
328
function content_translation_enabled($entity_type, $bundle = NULL) {
329 330
  $enabled = FALSE;

331
  if (\Drupal::service('content_translation.manager')->isSupported($entity_type)) {
332 333
    $bundles = !empty($bundle) ? array($bundle) : array_keys(entity_get_bundles($entity_type));
    foreach ($bundles as $bundle) {
334
      if (content_translation_get_config($entity_type, $bundle, 'enabled')) {
335 336 337
        $enabled = TRUE;
        break;
      }
338 339 340
    }
  }

341
  return $enabled;
342 343 344
}

/**
345
 * Content translation controller factory.
346
 *
347
 * @param string $entity_type_id
348 349
 *   The type of the entity being translated.
 *
350 351
 * @return \Drupal\content_translation\ContentTranslationControllerInterface
 *   An instance of the content translation controller interface.
352 353
 *
 * @todo Move to \Drupal\content_translation\ContentTranslationManager.
354
 */
355 356
function content_translation_controller($entity_type_id) {
  $entity_type = \Drupal::entityManager()->getDefinition($entity_type_id);
357
  // @todo Throw an exception if the key is missing.
358 359
  $class = $entity_type->getControllerClass('translation');
  return new $class($entity_type);
360 361 362 363 364 365 366 367 368
}

/**
 * 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;
369
 *   An instance of the content translation form interface or FALSE if not an
370
 *   entity form.
371 372
 *
 * @todo Move to \Drupal\content_translation\ContentTranslationManager.
373
 */
374
function content_translation_form_controller(array $form_state) {
375 376 377 378
  return isset($form_state['controller']) && $form_state['controller'] instanceof EntityFormControllerInterface ? $form_state['controller'] : FALSE;
}

/**
379
 * Checks whether a content translation is accessible.
380 381 382
 *
 * @param \Drupal\Core\Entity\EntityInterface $entity
 *   The entity to be accessed.
383 384 385 386 387 388
 * @param $op
 *   The operation to be performed on the translation. Possible values are:
 *   - "view"
 *   - "update"
 *   - "delete"
 *   - "create"
389 390 391
 *
 * @return
 *   TRUE if the current user is allowed to view the translation.
392 393
 *
 * @todo Move to \Drupal\content_translation\ContentTranslationManager.
394
 */
395
function content_translation_access(EntityInterface $entity, $op) {
396
  return content_translation_controller($entity->getEntityTypeId())->getTranslationAccess($entity, $op) ;
397 398 399 400 401
}

/**
 * Implements hook_permission().
 */
402
function content_translation_permission() {
403
  $permission = array(
404
    'administer content translation' => array(
405
      'title' => t('Administer translation settings'),
406
      'description' => t('Configure translatability of entities and fields.'),
407
    ),
408
    'create content translations' => array(
409 410
      'title' => t('Create translations'),
    ),
411
    'update content translations' => array(
412 413
      'title' => t('Edit translations'),
    ),
414
    'delete content translations' => array(
415 416
      'title' => t('Delete translations'),
    ),
417 418 419 420 421
    'translate any entity' => array(
      'title' => t('Translate any entity'),
    ),
  );

422 423
  // Create a translate permission for each enabled entity type and (optionally)
  // bundle.
424 425 426
  foreach (\Drupal::entityManager()->getDefinitions() as $entity_type_id => $entity_type) {
    if ($permission_granularity = $entity_type->getPermissionGranularity()) {
      $t_args = array('@entity_label' => $entity_type->getLowercaseLabel());
427

428
      switch ($permission_granularity) {
429
        case 'bundle':
430 431
          foreach (entity_get_bundles($entity_type_id) as $bundle => $bundle_info) {
            if (content_translation_enabled($entity_type_id, $bundle)) {
432
              $t_args['%bundle_label'] = isset($bundle_info['label']) ? $bundle_info['label'] : $bundle;
433
              $permission["translate $bundle $entity_type_id"] = array(
434
                'title' => t('Translate %bundle_label @entity_label', $t_args),
435 436 437 438 439 440
              );
            }
          }
          break;

        case 'entity_type':
441 442
          if (content_translation_enabled($entity_type_id)) {
            $permission["translate $entity_type_id"] = array(
443 444 445 446 447
              'title' => t('Translate @entity_label', $t_args),
            );
          }
          break;
      }
448 449 450 451 452 453 454 455 456
    }
  }

  return $permission;
}

/**
 * Implements hook_form_alter().
 */
457
function content_translation_form_alter(array &$form, array &$form_state) {
458 459 460 461
  $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) {
462
    $controller = content_translation_controller($entity->getEntityTypeId());
463 464 465 466 467 468 469 470 471 472
    $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)) {
473
      foreach ($entity->getFieldDefinitions() as $property_name => $definition) {
474
        if (isset($form[$property_name])) {
475
          $form[$property_name]['#multilingual'] = $definition->isTranslatable();
476 477 478 479 480 481 482
        }
      }
    }

  }
}

483
/**
484
 * Implements hook_language_fallback_candidates_OPERATION_alter().
485 486 487
 *
 * Performs language fallback for unaccessible translations.
 */
488
function content_translation_language_fallback_candidates_entity_view_alter(&$candidates, $context) {
489
  /** @var \Drupal\Core\Entity\ContentEntityInterface $entity */
490
  $entity = $context['data'];
491 492 493
  $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";
494
  foreach ($entity->getTranslationLanguages() as $langcode => $language) {
495
    if (empty($entity->translation[$langcode]['status']) && !user_access('translate any entity') && !user_access($permission)) {
496
      unset($candidates[$langcode]);
497 498 499 500
    }
  }
}

501 502 503
/**
 * Implements hook_entity_load().
 */
504
function content_translation_entity_load(array $entities, $entity_type) {
505 506
  $enabled_entities = array();

507
  if (content_translation_enabled($entity_type)) {
508
    foreach ($entities as $entity) {
509
      if ($entity instanceof ContentEntityInterface && $entity->isTranslatable()) {
510 511 512 513 514 515
        $enabled_entities[$entity->id()] = $entity;
      }
    }
  }

  if (!empty($enabled_entities)) {
516
    content_translation_load_translation_metadata($enabled_entities, $entity_type);
517 518 519 520 521 522 523 524 525 526 527
  }
}

/**
 * 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.
 */
528 529
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)';
530
  $result = db_query($query, array(':entity_type' => $entity_type, ':entity_id' => array_keys($entities)));
531
  $exclude = array('entity_type', 'entity_id', 'langcode');
532 533 534
  foreach ($result as $record) {
    $entity = $entities[$record->entity_id];
    // @todo Declare these as entity (translation?) properties.
535 536
    foreach ($record as $field_name => $value) {
      if (!in_array($field_name, $exclude)) {
537 538 539 540 541
        $langcode = $record->langcode;
        $entity->translation[$langcode][$field_name] = $value;
        if (!$entity->hasTranslation($langcode)) {
          $entity->initTranslation($langcode);
        }
542 543
      }
    }
544 545 546 547 548 549
  }
}

/**
 * Implements hook_entity_insert().
 */
550
function content_translation_entity_insert(EntityInterface $entity) {
551
  // Only do something if translation support for the given entity is enabled.
552
  if (!($entity instanceof ContentEntityInterface) || !$entity->isTranslatable()) {
553 554 555
    return;
  }

556
  $fields = array('entity_type', 'entity_id', 'langcode', 'source', 'outdated', 'uid', 'status', 'created', 'changed');
557
  $query = db_insert('content_translation')->fields($fields);
558 559

  foreach ($entity->getTranslationLanguages() as $langcode => $language) {
560 561 562 563
    $translation = isset($entity->translation[$langcode]) ? $entity->translation[$langcode] : array();

    $translation += array(
      'source' => '',
564
      'uid' => \Drupal::currentUser()->id(),
565 566 567 568 569 570
      'outdated' => FALSE,
      'status' => TRUE,
      'created' => REQUEST_TIME,
      'changed' => REQUEST_TIME,
    );

571
    $translation['entity_type'] = $entity->getEntityTypeId();
572 573 574 575 576 577 578 579 580 581
    $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);
582 583 584 585 586 587 588 589
  }

  $query->execute();
}

/**
 * Implements hook_entity_delete().
 */
590
function content_translation_entity_delete(EntityInterface $entity) {
591
  // Only do something if translation support for the given entity is enabled.
592
  if (!($entity instanceof ContentEntityInterface) || !$entity->isTranslatable()) {
593 594 595
    return;
  }

596
  db_delete('content_translation')
597
    ->condition('entity_type', $entity->getEntityTypeId())
598 599 600 601 602 603 604
    ->condition('entity_id', $entity->id())
    ->execute();
}

/**
 * Implements hook_entity_update().
 */
605
function content_translation_entity_update(EntityInterface $entity) {
606
  // Only do something if translation support for the given entity is enabled.
607
  if (!($entity instanceof ContentEntityInterface) || !$entity->isTranslatable()) {
608 609 610
    return;
  }

611
  // Delete and create to ensure no stale value remains behind.
612 613
  content_translation_entity_delete($entity);
  content_translation_entity_insert($entity);
614 615 616
}

/**
617
 * Implements hook_entity_extra_field_info().
618
 */
619
function content_translation_entity_extra_field_info() {
620 621
  $extra = array();

622
  foreach (\Drupal::entityManager()->getDefinitions() as $entity_type => $info) {
623
    foreach (entity_get_bundles($entity_type) as $bundle => $bundle_info) {
624
      if (content_translation_enabled($entity_type, $bundle)) {
625 626 627 628 629 630 631 632 633 634 635 636 637
        $extra[$entity_type][$bundle]['form']['translation'] = array(
          'label' => t('Translation'),
          'description' => t('Translation settings'),
          'weight' => 10,
        );
      }
    }
  }

  return $extra;
}

/**
638
 * Implements hook_form_FORM_ID_alter() for 'field_ui_field_edit_form'.
639
 */
640
function content_translation_form_field_ui_field_edit_form_alter(array &$form, array &$form_state, $form_id) {
641 642 643
  $field = $form['#field'];
  $bundle = $form['#bundle'];
  $bundle_is_translatable = content_translation_enabled($field->entity_type, $bundle);
644 645 646
  $form['field']['translatable'] = array(
    '#type' => 'checkbox',
    '#title' => t('Users may translate this field.'),
647
    '#default_value' => $field->isTranslatable(),
648
    '#weight' => 20,
649
    '#disabled' => !$bundle_is_translatable,
650
  );
651
  $form['#submit'][] = 'content_translation_form_field_ui_field_edit_form_submit';
652 653 654 655 656 657 658 659 660 661

  // 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,
    ));
  }
662 663 664 665 666 667 668 669 670 671 672
}

/**
 * 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();
  }
673
  $value[$instance->getField()->getName()] = $form_state['values']['field']['translatable'];
674 675 676 677 678
  // 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);
  }
679 680
}

681
/**
682
 * Implements hook_form_FORM_ID_alter() for 'field_ui_field_instance_edit_form'.
683
 */
684
function content_translation_form_field_ui_field_instance_edit_form_alter(array &$form, array &$form_state, $form_id) {
685
  if ($form['#field']->isTranslatable()) {
686
    module_load_include('inc', 'content_translation', 'content_translation.admin');
687
    $element = content_translation_field_sync_widget($form['#field']);
688 689 690 691 692 693 694
    if ($element) {
      $form['instance']['settings']['translation_sync'] = $element;
    }
  }
}

/**
695
 * Implements hook_entity_presave().
696
 */
697
function content_translation_entity_presave(EntityInterface $entity) {
698 699 700 701 702 703 704 705 706 707
  // By default no column has to be synchronized.
  // @todo Replace with own storage in https://drupal.org/node/2224761
  if ($entity->getEntityTypeId() === 'field_config') {
    $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);
  }
708
  if ($entity instanceof ContentEntityInterface && $entity->isTranslatable()) {
709 710
    // @todo Avoid using request attributes once translation metadata become
    //   regular fields.
711 712
    $attributes = \Drupal::request()->attributes;
    \Drupal::service('content_translation.synchronizer')->synchronizeFields($entity, $entity->language()->id, $attributes->get('source_langcode'));
713 714 715
  }
}

716 717 718
/**
 * Implements hook_element_info_alter().
 */
719
function content_translation_element_info_alter(&$type) {
720
  if (isset($type['language_configuration'])) {
721
    $type['language_configuration']['#process'][] = 'content_translation_language_configuration_element_process';
722 723
  }
}
724

725
/**
726
 * Returns a widget to enable content translation per entity bundle.
727 728 729 730 731 732 733 734 735 736 737 738 739 740 741
 *
 * 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.
 */
742 743
function content_translation_enable_widget($entity_type, $bundle, array &$form, array &$form_state) {
  $key = $form_state['content_translation']['key'];
744 745 746 747
  if (!isset($form_state['language'][$key])) {
    $form_state['language'][$key] = array();
  }
  $form_state['language'][$key] += array('entity_type' => $entity_type, 'bundle' => $bundle);
748 749
  $element = content_translation_language_configuration_element_process(array('#name' => $key), $form_state, $form);
  unset($element['content_translation']['#element_validate']);
750 751 752 753 754 755 756 757 758 759 760 761
  return $element;
}

/**
 * Process callback: Expands the language_configuration form element.
 *
 * @param array $element
 *   Form API element.
 *
 * @return
 *   Processed language configuration element.
 */
762 763 764
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'];
765
    $context = $form_state['language'][$element['#name']];
766

767
    $element['content_translation'] = array(
768 769
      '#type' => 'checkbox',
      '#title' => t('Enable translation'),
770 771
      '#default_value' => content_translation_enabled($context['entity_type'], $context['bundle']),
      '#element_validate' => array('content_translation_language_configuration_element_validate'),
772 773
      '#prefix' => '<label>' . t('Translation') . '</label>',
    );
774

775
    $form['actions']['submit']['#submit'][] = 'content_translation_language_configuration_element_submit';
776
  }
777 778 779 780
  return $element;
}

/**
781
 * Form validation handler for element added with content_translation_language_configuration_element_process().
782 783 784 785 786
 *
 * 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.
 *
787
 * @see content_translation_language_configuration_element_submit()
788
 */
789 790
function content_translation_language_configuration_element_validate($element, array &$form_state, array $form) {
  $key = $form_state['content_translation']['key'];
791
  $values = $form_state['values'][$key];
792
  if (!$values['language_show'] && $values['content_translation'] && \Drupal::languageManager()->isLanguageLocked($values['langcode'])) {
793
    foreach (\Drupal::languageManager()->getLanguages(Language::STATE_LOCKED) as $language) {
794 795 796 797 798
      $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.
799
    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']])));
800 801 802 803
  }
}

/**
804
 * Form submission handler for element added with content_translation_language_configuration_element_process().
805
 *
806
 * Stores the content translation settings.
807
 *
808
 * @see content_translation_language_configuration_element_validate()
809
 */
810 811
function content_translation_language_configuration_element_submit(array $form, array &$form_state) {
  $key = $form_state['content_translation']['key'];
812
  $context = $form_state['language'][$key];
813
  $enabled = $form_state['values'][$key]['content_translation'];
814

815 816
  if (content_translation_enabled($context['entity_type'], $context['bundle']) != $enabled) {
    content_translation_set_config($context['entity_type'], $context['bundle'], 'enabled', $enabled);
817
    entity_info_cache_clear();
818
    \Drupal::service('router.builder')->setRebuildNeeded();
819 820
  }
}
821 822 823 824

/**
 * Implements hook_form_FORM_ID_alter() for language_content_settings_form().
 */
825 826 827
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);
828 829
}

830 831 832
/**
 * Implements hook_preprocess_HOOK() for theme_language_content_settings_table().
 */
833 834 835
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);
836 837
}

838
/**
839
 * Stores content translation settings.
840 841 842 843 844 845 846 847 848
 *
 * @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.
 *   - settings: An array of language configuration settings as defined by
 *     language_save_default_configuration().
 *   - fields: An associative array with field names as keys and a boolean as
 *     value, indicating field translatability.
849 850
 *   - columns: An associative array of translation synchronization settings
 *     keyed by field names.
851
 */
852
function content_translation_save_settings($settings) {
853 854
  foreach ($settings as $entity_type => $entity_settings) {
    foreach ($entity_settings as $bundle => $bundle_settings) {
855 856 857
      // 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.
858
        content_translation_set_config($entity_type, $bundle, 'enabled', $bundle_settings['translatable']);
859

860 861 862 863 864
        // Store whether fields are translatable or not.
        if (!empty($bundle_settings['fields'])) {
          content_translation_set_config($entity_type, $bundle, 'fields', $bundle_settings['fields']);
        }

865 866 867 868
        // Store whether fields have translation enabled or not.
        if (!empty($bundle_settings['columns'])) {
          foreach ($bundle_settings['columns'] as $field_name => $column_settings) {
            $instance = field_info_instance($entity_type, $field_name, $bundle);
869
            if ($instance->isTranslatable()) {
870
              $instance->settings['translation_sync'] = $column_settings;
871 872 873 874
            }
            // If the field does not have translatable enabled we need to reset
            // the sync settings to their defaults.
            else {
875
              unset($instance->settings['translation_sync']);
876
            }
877
            $instance->save();
878 879 880
          }
        }
      }
881 882
    }
  }
883

884 885
  // Ensure entity and menu router information are correctly rebuilt.
  entity_info_cache_clear();
886
  \Drupal::service('router.builder')->setRebuildNeeded();
887
}