content_translation.module 35.8 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\Entity\EntityTypeInterface;
12
use Drupal\Core\Language\LanguageInterface;
13
use Drupal\field\Entity\FieldInstanceConfig;
14
use Drupal\field\FieldInstanceConfigInterface;
15
use Drupal\node\NodeInterface;
16
use Symfony\Component\HttpFoundation\Request;
17 18 19 20

/**
 * Implements hook_help().
 */
21 22 23
function content_translation_help($route_name, Request $request) {
  switch ($route_name) {
    case 'help.page.content_translation':
24 25
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
26
      $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>';
27 28 29
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
      $output .= '<dt>' . t('Enabling translation') . '</dt>';
30 31 32
      $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>';
33
      $output .= '<dt>' . t('Translating content') . '</dt>';
34 35 36 37 38
      $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>';
39 40
      $output .= '</dl>';
      return $output;
41

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

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

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

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

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

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

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

144
/**
145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166
 * Implements hook_entity_bundle_field_info_alter().
 *
 * @todo Remove this when any field supports per-bundle configurable overrides.
 *   See https://drupal.org/node/2224761.
 */
function content_translation_entity_bundle_field_info_alter(&$fields, EntityTypeInterface $entity_type, $bundle) {
  $settings = content_translation_get_config($entity_type->id(), $bundle, 'fields');
  if (!empty($settings)) {
    $base_field_definitions = \Drupal::entityManager()->getBaseFieldDefinitions($entity_type->id());
    foreach ($settings as $name => $translatable) {
      // Skip storable field definitions as those are supposed to have already
      // been changed.
      if (!isset($fields[$name]) || !$fields[$name] instanceof FieldInstanceConfigInterface) {
        // If we do not have a bundle definition for the current field and we
        // have to override its translatability, we need to instantiate a new
        // bundle field definition from the base one.
        if (!isset($fields[$name]) && isset($base_field_definitions[$name]) && $base_field_definitions[$name]->isTranslatable() != $translatable) {
          $fields[$name] = clone $base_field_definitions[$name];
        }
        if (isset($fields[$name])) {
          $fields[$name]->setTranslatable((bool) $translatable);
        }
167 168 169 170 171
      }
    }
  }
}

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

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

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

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

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

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

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

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

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

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

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

344
  return $enabled;
345 346 347
}

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

/**
366
 * Returns the entity form for the given form.
367 368
 *
 * @param array $form_state
369
 *   The form state array holding the entity form.
370
 *
371
 * @return \Drupal\Core\Entity\EntityFormInterface;
372
 *   An instance of the content translation form interface or FALSE if not an
373
 *   entity form.
374 375
 *
 * @todo Move to \Drupal\content_translation\ContentTranslationManager.
376
 */
377
function content_translation_form_controller(array $form_state) {
378
  return isset($form_state['controller']) && $form_state['controller'] instanceof EntityFormInterface ? $form_state['controller'] : FALSE;
379 380 381
}

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

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

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

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

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

  return $permission;
}

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

  }
}

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

504 505 506
/**
 * Implements hook_entity_load().
 */
507
function content_translation_entity_load(array $entities, $entity_type) {
508 509
  $enabled_entities = array();

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

  if (!empty($enabled_entities)) {
519
    content_translation_load_translation_metadata($enabled_entities, $entity_type);
520 521 522 523 524 525 526 527 528 529 530
  }
}

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

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

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

  foreach ($entity->getTranslationLanguages() as $langcode => $language) {
563 564 565 566
    $translation = isset($entity->translation[$langcode]) ? $entity->translation[$langcode] : array();

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

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

  $query->execute();
}

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

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

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

614
  // Delete and create to ensure no stale value remains behind.
615 616
  content_translation_entity_delete($entity);
  content_translation_entity_insert($entity);
617 618 619
}

/**
620
 * Implements hook_entity_extra_field_info().
621
 */
622
function content_translation_entity_extra_field_info() {
623 624
  $extra = array();

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

  return $extra;
}

/**
641
 * Implements hook_form_FORM_ID_alter() for 'field_ui_instance_edit_form'.
642
 */
643 644 645 646 647
function content_translation_form_field_ui_field_instance_edit_form_alter(array &$form, array &$form_state) {
  $instance = $form_state['instance'];
  $bundle_is_translatable = content_translation_enabled($instance->entity_type, $instance->bundle);

  $form['instance']['translatable'] = array(
648 649
    '#type' => 'checkbox',
    '#title' => t('Users may translate this field.'),
650 651
    '#default_value' => $instance->isTranslatable(),
    '#weight' => -1,
652
    '#disabled' => !$bundle_is_translatable,
653
    '#access' => $instance->getFieldStorageDefinition()->isTranslatable(),
654
  );
655 656 657 658 659 660

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

666
  if ($instance->isTranslatable()) {
667
    module_load_include('inc', 'content_translation', 'content_translation.admin');
668
    $element = content_translation_field_sync_widget($instance);
669 670
    if ($element) {
      $form['instance']['settings']['translation_sync'] = $element;
671
      $form['instance']['settings']['translation_sync']['#weight'] = -10;
672 673 674 675 676
    }
  }
}

/**
677
 * Implements hook_entity_presave().
678
 */
679
function content_translation_entity_presave(EntityInterface $entity) {
680 681 682 683 684 685 686 687 688 689
  // 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);
  }
690
  if ($entity instanceof ContentEntityInterface && $entity->isTranslatable()) {
691 692
    // @todo Avoid using request attributes once translation metadata become
    //   regular fields.
693 694
    $attributes = \Drupal::request()->attributes;
    \Drupal::service('content_translation.synchronizer')->synchronizeFields($entity, $entity->language()->id, $attributes->get('source_langcode'));
695 696 697
  }
}

698 699 700
/**
 * Implements hook_element_info_alter().
 */
701
function content_translation_element_info_alter(&$type) {
702
  if (isset($type['language_configuration'])) {
703
    $type['language_configuration']['#process'][] = 'content_translation_language_configuration_element_process';
704 705
  }
}
706

707
/**
708
 * Returns a widget to enable content translation per entity bundle.
709 710 711 712 713 714 715 716 717 718 719 720 721 722 723
 *
 * 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.
 */
724 725
function content_translation_enable_widget($entity_type, $bundle, array &$form, array &$form_state) {
  $key = $form_state['content_translation']['key'];
726 727 728 729
  if (!isset($form_state['language'][$key])) {
    $form_state['language'][$key] = array();
  }
  $form_state['language'][$key] += array('entity_type' => $entity_type, 'bundle' => $bundle);
730 731
  $element = content_translation_language_configuration_element_process(array('#name' => $key), $form_state, $form);
  unset($element['content_translation']['#element_validate']);
732 733 734 735 736 737 738 739 740 741 742 743
  return $element;
}

/**
 * Process callback: Expands the language_configuration form element.
 *
 * @param array $element
 *   Form API element.
 *
 * @return
 *   Processed language configuration element.
 */
744 745 746
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'];
747
    $context = $form_state['language'][$element['#name']];
748

749
    $element['content_translation'] = array(
750 751
      '#type' => 'checkbox',
      '#title' => t('Enable translation'),
752 753
      '#default_value' => content_translation_enabled($context['entity_type'], $context['bundle']),
      '#element_validate' => array('content_translation_language_configuration_element_validate'),
754 755
      '#prefix' => '<label>' . t('Translation') . '</label>',
    );
756

757
    $form['actions']['submit']['#submit'][] = 'content_translation_language_configuration_element_submit';
758
  }
759 760 761 762
  return $element;
}

/**
763
 * Form validation handler for element added with content_translation_language_configuration_element_process().
764 765 766 767 768
 *
 * 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.
 *
769
 * @see content_translation_language_configuration_element_submit()
770
 */
771 772
function content_translation_language_configuration_element_validate($element, array &$form_state, array $form) {
  $key = $form_state['content_translation']['key'];
773
  $values = $form_state['values'][$key];
774
  if (!$values['language_show'] && $values['content_translation'] && \Drupal::languageManager()->isLanguageLocked($values['langcode'])) {
775
    foreach (\Drupal::languageManager()->getLanguages(LanguageInterface::STATE_LOCKED) as $language) {
776 777 778 779 780
      $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.
781
    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']])));
782 783 784 785
  }
}

/**
786
 * Form submission handler for element added with content_translation_language_configuration_element_process().
787
 *
788
 * Stores the content translation settings.
789
 *
790
 * @see content_translation_language_configuration_element_validate()
791
 */
792 793
function content_translation_language_configuration_element_submit(array $form, array &$form_state) {
  $key = $form_state['content_translation']['key'];
794
  $context = $form_state['language'][$key];
795
  $enabled = $form_state['values'][$key]['content_translation'];
796

797 798
  if (content_translation_enabled($context['entity_type'], $context['bundle']) != $enabled) {
    content_translation_set_config($context['entity_type'], $context['bundle'], 'enabled', $enabled);
799
    \Drupal::entityManager()->clearCachedDefinitions();
800
    \Drupal::service('router.builder')->setRebuildNeeded();
801 802
  }
}
803 804 805 806

/**
 * Implements hook_form_FORM_ID_alter() for language_content_settings_form().
 */
807 808 809
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);
810 811
}

812 813 814
/**
 * Implements hook_preprocess_HOOK() for theme_language_content_settings_table().
 */
815 816 817
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);
818 819
}

820
/**
821
 * Stores content translation settings.
822 823 824 825 826 827 828 829 830
 *
 * @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.
831 832
 *   - columns: An associative array of translation synchronization settings
 *     keyed by field names.
833
 */
834
function content_translation_save_settings($settings) {
835 836
  foreach ($settings as $entity_type => $entity_settings) {
    foreach ($entity_settings as $bundle => $bundle_settings) {
837 838 839
      // 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.
840
        content_translation_set_config($entity_type, $bundle, 'enabled', $bundle_settings['translatable']);
841

842 843 844 845 846
        // Store whether fields are translatable or not.
        if (!empty($bundle_settings['fields'])) {
          content_translation_set_config($entity_type, $bundle, 'fields', $bundle_settings['fields']);
        }

847 848 849
        // Store whether fields have translation enabled or not.
        if (!empty($bundle_settings['columns'])) {
          foreach ($bundle_settings['columns'] as $field_name => $column_settings) {
850
            $instance = FieldInstanceConfig::loadByName($entity_type, $bundle, $field_name);
851
            if ($instance->isTranslatable()) {
852
              $instance->settings['translation_sync'] = $column_settings;
853 854 855 856
            }
            // If the field does not have translatable enabled we need to reset
            // the sync settings to their defaults.
            else {
857
              unset($instance->settings['translation_sync']);
858
            }
859
            $instance->save();
860 861 862
          }
        }
      }
863 864
    }
  }
865

866
  // Ensure entity and menu router information are correctly rebuilt.
867
  \Drupal::entityManager()->clearCachedDefinitions();
868
  \Drupal::service('router.builder')->setRebuildNeeded();
869
}