content_translation.module 36.2 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\Form\FormStateInterface;
13
use Drupal\Core\Language\LanguageInterface;
14
use Drupal\Core\Routing\RouteMatchInterface;
15
use Drupal\field\Entity\FieldInstanceConfig;
16
use Drupal\field\FieldInstanceConfigInterface;
17
use Drupal\node\NodeInterface;
18 19 20 21

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

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

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

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

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

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

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

133 134 135
/**
 * Implements hook_entity_bundle_info_alter().
 */
136
function content_translation_entity_bundle_info_alter(&$bundles) {
137 138
  foreach ($bundles as $entity_type => &$info) {
    foreach ($info as $bundle => &$bundle_info) {
139
      $enabled = content_translation_get_config($entity_type, $bundle, 'enabled');
140
      $bundle_info['translatable'] = !empty($enabled);
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 167
 * 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);
        }
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 193
/**
 * 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();
    }
  }
}

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

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

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

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

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

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

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

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

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

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

346
  return $enabled;
347 348 349
}

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

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

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

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

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

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

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

  return $permission;
}

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

  }
}

488
/**
489
 * Implements hook_language_fallback_candidates_OPERATION_alter().
490 491 492
 *
 * Performs language fallback for unaccessible translations.
 */
493
function content_translation_language_fallback_candidates_entity_view_alter(&$candidates, $context) {
494
  /** @var \Drupal\Core\Entity\ContentEntityInterface $entity */
495
  $entity = $context['data'];
496 497 498
  $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";
499 500 501 502 503 504
  $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]);
      }
505 506 507 508
    }
  }
}

509
/**
510
 * Implements hook_entity_storage_load().
511
 */
512
function content_translation_entity_storage_load(array $entities, $entity_type) {
513 514
  $enabled_entities = array();

515
  if (content_translation_enabled($entity_type)) {
516
    foreach ($entities as $entity) {
517
      if ($entity instanceof ContentEntityInterface && $entity->isTranslatable()) {
518 519 520 521 522 523
        $enabled_entities[$entity->id()] = $entity;
      }
    }
  }

  if (!empty($enabled_entities)) {
524
    content_translation_load_translation_metadata($enabled_entities, $entity_type);
525 526 527 528 529 530 531 532 533 534 535
  }
}

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

/**
 * Implements hook_entity_insert().
 */
558
function content_translation_entity_insert(EntityInterface $entity) {
559
  // Only do something if translation support for the given entity is enabled.
560
  if (!($entity instanceof ContentEntityInterface) || !$entity->isTranslatable()) {
561 562 563
    return;
  }

564
  $fields = array('entity_type', 'entity_id', 'langcode', 'source', 'outdated', 'uid', 'status', 'created', 'changed');
565
  $query = db_insert('content_translation')->fields($fields);
566 567

  foreach ($entity->getTranslationLanguages() as $langcode => $language) {
568 569 570 571
    $translation = isset($entity->translation[$langcode]) ? $entity->translation[$langcode] : array();

    $translation += array(
      'source' => '',
572
      'uid' => \Drupal::currentUser()->id(),
573 574 575 576 577 578
      'outdated' => FALSE,
      'status' => TRUE,
      'created' => REQUEST_TIME,
      'changed' => REQUEST_TIME,
    );

579
    $translation['entity_type'] = $entity->getEntityTypeId();
580 581 582 583 584 585 586 587 588 589
    $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);
590 591 592 593 594 595 596 597
  }

  $query->execute();
}

/**
 * Implements hook_entity_delete().
 */
598
function content_translation_entity_delete(EntityInterface $entity) {
599
  // Only do something if translation support for the given entity is enabled.
600
  if (!($entity instanceof ContentEntityInterface) || !$entity->isTranslatable()) {
601 602 603
    return;
  }

604
  db_delete('content_translation')
605
    ->condition('entity_type', $entity->getEntityTypeId())
606 607 608 609 610 611 612
    ->condition('entity_id', $entity->id())
    ->execute();
}

/**
 * Implements hook_entity_update().
 */
613
function content_translation_entity_update(EntityInterface $entity) {
614
  // Only do something if translation support for the given entity is enabled.
615
  if (!($entity instanceof ContentEntityInterface) || !$entity->isTranslatable()) {
616 617 618
    return;
  }

619
  // Delete and create to ensure no stale value remains behind.
620 621
  content_translation_entity_delete($entity);
  content_translation_entity_insert($entity);
622 623 624
}

/**
625
 * Implements hook_entity_extra_field_info().
626
 */
627
function content_translation_entity_extra_field_info() {
628 629
  $extra = array();

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

  return $extra;
}

/**
646
 * Implements hook_form_FORM_ID_alter() for 'field_ui_instance_edit_form'.
647
 */
648
function content_translation_form_field_ui_field_instance_edit_form_alter(array &$form, FormStateInterface $form_state) {
649 650 651 652
  $instance = $form_state['instance'];
  $bundle_is_translatable = content_translation_enabled($instance->entity_type, $instance->bundle);

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

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

671
  if ($instance->isTranslatable()) {
672
    module_load_include('inc', 'content_translation', 'content_translation.admin');
673
    $element = content_translation_field_sync_widget($instance);
674 675
    if ($element) {
      $form['instance']['settings']['translation_sync'] = $element;
676
      $form['instance']['settings']['translation_sync']['#weight'] = -10;
677 678 679 680 681
    }
  }
}

/**
682
 * Implements hook_entity_presave().
683
 */
684
function content_translation_entity_presave(EntityInterface $entity) {
685 686
  // By default no column has to be synchronized.
  // @todo Replace with own storage in https://drupal.org/node/2224761
687
  if ($entity->getEntityTypeId() === 'field_storage_config') {
688 689 690 691 692 693 694
    $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);
  }
695
  if ($entity instanceof ContentEntityInterface && $entity->isTranslatable()) {
696 697
    // @todo Avoid using request attributes once translation metadata become
    //   regular fields.
698 699
    $attributes = \Drupal::request()->attributes;
    \Drupal::service('content_translation.synchronizer')->synchronizeFields($entity, $entity->language()->id, $attributes->get('source_langcode'));
700 701 702
  }
}

703 704 705
/**
 * Implements hook_element_info_alter().
 */
706
function content_translation_element_info_alter(&$type) {
707
  if (isset($type['language_configuration'])) {
708
    $type['language_configuration']['#process'][] = 'content_translation_language_configuration_element_process';
709 710
  }
}
711

712
/**
713
 * Returns a widget to enable content translation per entity bundle.
714 715 716 717 718 719 720 721 722 723 724 725
 *
 * 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.
726 727
 * @param \Drupal\Core\Form\FormStateInterface $form_state
 *   The current state of the form.
728
 */
729
function content_translation_enable_widget($entity_type, $bundle, array &$form, FormStateInterface $form_state) {
730
  $key = $form_state['content_translation']['key'];
731 732 733 734
  if (!isset($form_state['language'][$key])) {
    $form_state['language'][$key] = array();
  }
  $form_state['language'][$key] += array('entity_type' => $entity_type, 'bundle' => $bundle);
735 736
  $element = content_translation_language_configuration_element_process(array('#name' => $key), $form_state, $form);
  unset($element['content_translation']['#element_validate']);
737 738 739 740 741 742 743 744 745 746 747 748
  return $element;
}

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

754
    $element['content_translation'] = array(
755 756
      '#type' => 'checkbox',
      '#title' => t('Enable translation'),
757 758
      '#default_value' => content_translation_enabled($context['entity_type'], $context['bundle']),
      '#element_validate' => array('content_translation_language_configuration_element_validate'),
759 760
      '#prefix' => '<label>' . t('Translation') . '</label>',
    );
761

762
    $form['actions']['submit']['#submit'][] = 'content_translation_language_configuration_element_submit';
763
  }
764 765 766 767
  return $element;
}

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

/**
791
 * Form submission handler for element added with content_translation_language_configuration_element_process().
792
 *
793
 * Stores the content translation settings.
794
 *
795
 * @see content_translation_language_configuration_element_validate()
796
 */
797
function content_translation_language_configuration_element_submit(array $form, FormStateInterface $form_state) {
798
  $key = $form_state['content_translation']['key'];
799
  $context = $form_state['language'][$key];
800
  $enabled = $form_state['values'][$key]['content_translation'];
801

802 803
  if (content_translation_enabled($context['entity_type'], $context['bundle']) != $enabled) {
    content_translation_set_config($context['entity_type'], $context['bundle'], 'enabled', $enabled);
804
    \Drupal::entityManager()->clearCachedDefinitions();
805
    \Drupal::service('router.builder')->setRebuildNeeded();
806 807
  }
}
808 809 810 811

/**
 * Implements hook_form_FORM_ID_alter() for language_content_settings_form().
 */
812
function content_translation_form_language_content_settings_form_alter(array &$form, FormStateInterface $form_state) {
813 814
  module_load_include('inc', 'content_translation', 'content_translation.admin');
  _content_translation_form_language_content_settings_form_alter($form, $form_state);
815 816
}

817 818 819
/**
 * Implements hook_preprocess_HOOK() for theme_language_content_settings_table().
 */
820 821 822
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);
823 824
}

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

847 848 849 850 851
        // Store whether fields are translatable or not.
        if (!empty($bundle_settings['fields'])) {
          content_translation_set_config($entity_type, $bundle, 'fields', $bundle_settings['fields']);
        }

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

871
  // Ensure entity and menu router information are correctly rebuilt.
872
  \Drupal::entityManager()->clearCachedDefinitions();
873
  \Drupal::service('router.builder')->setRebuildNeeded();
874
}