content_translation.module 39.7 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 14
use Drupal\Core\Language\Language;
use Drupal\Core\Session\AccountInterface;
use Drupal\Core\TypedData\TranslatableInterface;
15
use Drupal\node\NodeInterface;
16 17 18 19

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

    case 'admin/config/regional/content-language':
      $output = '';
      if (!language_multilingual()) {
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' => url('admin/config/regional/language')));
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 57 58
  switch ($hook) {
    // Move some of our hook implementations to the end of the list.
    case 'menu_alter':
    case 'entity_info_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 72
  // Make content language negotiation configurable by removing the 'locked'
  // flag.
  $language_types[Language::TYPE_CONTENT]['locked'] = FALSE;
73
  unset($language_types[Language::TYPE_CONTENT]['fixed']);
74 75 76 77 78
}

/**
 * Implements hook_entity_info_alter().
 */
79
function content_translation_entity_info_alter(array &$entity_info) {
80
  // Provide defaults for translation info.
81
  /** @var $entity_info \Drupal\Core\Entity\EntityTypeInterface[] */
82
  foreach ($entity_info as $entity_type => &$info) {
83 84 85 86
    if ($info->isTranslatable()) {
      if (!$info->hasController('translation')) {
        $info->setController('translation', 'Drupal\content_translation\ContentTranslationController');
      }
87

88 89 90
      $translation = $info->get('translation');
      if (!$translation || !isset($translation['content_translation'])) {
        $translation['content_translation'] = array();
91
      }
92

93
      if ($info->hasLinkTemplate('canonical')) {
94
        // Provide default route names for the translation paths.
95 96 97 98
        if (!$info->hasLinkTemplate('drupal:content-translation-overview')) {
          $info->setLinkTemplate('drupal:content-translation-overview', "content_translation.translation_overview_$entity_type");
        }
        $translation['content_translation'] += array(
99
          'access_callback' => 'content_translation_translate_access',
100 101
        );
      }
102
      $info->set('translation', $translation);
103
    }
104 105
  }
}
106

107 108 109
/**
 * Implements hook_entity_bundle_info_alter().
 */
110
function content_translation_entity_bundle_info_alter(&$bundles) {
111 112
  foreach ($bundles as $entity_type => &$info) {
    foreach ($info as $bundle => &$bundle_info) {
113
      $enabled = content_translation_get_config($entity_type, $bundle, 'enabled');
114
      $bundle_info['translatable'] = !empty($enabled);
115 116 117 118
    }
  }
}

119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137
/**
 * Implements hook_entity_field_info_alter().
 */
function content_translation_entity_field_info_alter(&$info, $entity_type) {
  $translation_settings = config('content_translation.settings')->get($entity_type);

  if ($translation_settings) {
    // Currently field translatability is defined per-field but we may want to
    // make it per-instance instead, so leaving the possibility open for further
    // easier refactoring.
    $fields = array();
    foreach ($translation_settings as $bundle => $settings) {
      $fields += !empty($settings['content_translation']['fields']) ? $settings['content_translation']['fields'] : array();
    }

    $keys = array('definitions', 'optional');
    foreach ($fields as $name => $translatable) {
      foreach ($keys as $key) {
        if (isset($info[$key][$name])) {
138
          $info[$key][$name]->setTranslatable((bool) $translatable);
139 140 141 142 143 144 145
          break;
        }
      }
    }
  }
}

146 147 148 149 150 151 152 153 154 155 156 157 158 159 160
/**
 * 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()) {
    $uri = $entity->uri();
    $operations['translate'] = array(
      'title' => t('Translate'),
      'href' => $uri['path'] . '/translations',
      'options' => $uri['options'],
    );
  }
}

161 162
/**
 * Implements hook_menu().
163 164 165
 *
 * @todo Split this into route definition and menu link definition. See
 *   https://drupal.org/node/1987882 and https://drupal.org/node/2047633.
166
 */
167
function content_translation_menu() {
168 169 170
  $items = array();

  // Create tabs for all possible entity types.
171
  foreach (\Drupal::entityManager()->getDefinitions() as $entity_type => $info) {
172
    // Provide the translation UI only for enabled types.
173
    if (content_translation_enabled($entity_type)) {
174
      $path = _content_translation_link_to_router_path($entity_type, $info->getLinkTemplate('canonical'));
175
      $entity_position = count(explode('/', $path)) - 1;
176
      $keys = array_flip(array('load_arguments'));
177 178
      $translation = $info->get('translation');
      $menu_info = array_intersect_key($translation['content_translation'], $keys) + array('file' => 'content_translation.pages.inc');
179 180 181 182 183 184 185 186 187 188 189 190 191
      $item = array();

      // Plugin annotations cannot contain spaces, thus we need to restore them
      // from underscores.
      foreach ($menu_info as $key => $value) {
        $item[str_replace('_', ' ', $key)] = $value;
      }

      // Add translation callback.
      // @todo Add the access callback instead of replacing it as soon as the
      // routing system supports multiple callbacks.
      $language_position = $entity_position + 3;
      $args = array($entity_position, $language_position, $language_position + 1);
192
      $items["$path/translations/add/%language/%language"] = array(
193
        'title' => 'Add',
194
        'route_name' => "content_translation.translation_add_$entity_type",
195
        'weight' => 1,
196
      );
197 198 199 200 201

      // Edit translation callback.
      $args = array($entity_position, $language_position);
      $items["$path/translations/edit/%language"] = array(
        'title' => 'Edit',
202
        'route_name' => "content_translation.translation_edit_$entity_type",
203
        'weight' => 1,
204
      );
205 206 207 208

      // Delete translation callback.
      $items["$path/translations/delete/%language"] = array(
        'title' => 'Delete',
209
        'route_name' => "content_translation.delete_$entity_type",
210 211 212 213 214 215 216 217 218
      ) + $item;
    }
  }

  return $items;
}

/**
 * Implements hook_menu_alter().
219 220 221
 *
 * @todo Split this into route definition and menu link definition. See
 *   https://drupal.org/node/1987882 and https://drupal.org/node/2047633.
222
 */
223
function content_translation_menu_alter(array &$items) {
224 225 226 227
  // Clarify where translation settings are located.
  $items['admin/config/regional/content-language']['title'] = 'Content language and translation';
  $items['admin/config/regional/content-language']['description'] = 'Configure language and translation support for content.';

228
  // Check that the declared menu base paths are actually valid.
229
  foreach (\Drupal::entityManager()->getDefinitions() as $entity_type => $info) {
230
    if (content_translation_enabled($entity_type)) {
231
      $path = _content_translation_link_to_router_path($entity_type, $info->getLinkTemplate('canonical'));
232

233 234 235 236
      // If the base path is not defined we cannot provide the translation UI
      // for this entity type. In some cases the actual base path might not have
      // a menu loader associated, hence we need to check also for the plain "%"
      // variant. See for instance comment_menu().
237
      if (!isset($items[$path]) && !isset($items["$path/edit"])
238
          && !isset($items[_content_translation_menu_strip_loaders($path)])) {
239 240
        unset(
          $items["$path/translations"],
241
          $items["$path/translations/add/%language/%language"],
242 243
          $items["$path/translations/delete/%language"]
        );
244
        $t_args = array('@entity_type' => $info->getLabel() ?: $entity_type);
245
        watchdog('content translation', 'The entities of type @entity_type do not define a valid base path: it will not be possible to translate them.', $t_args, WATCHDOG_WARNING);
246 247
      }
      else {
248
        $edit_path = $path . '/edit';
249 250 251 252 253 254 255 256 257 258 259

        if (isset($items[$edit_path])) {
          // If the edit path is a default local task we need to find the parent
          // item.
          $edit_path_split = explode('/', $edit_path);
          do {
            $entity_form_item = &$items[implode('/', $edit_path_split)];
            array_pop($edit_path_split);
          }
          while (!empty($entity_form_item['type']) && $entity_form_item['type'] == MENU_DEFAULT_LOCAL_TASK);

260
          // Make the "Translate" tab follow the "Edit" one when possible.
261 262 263 264 265 266 267 268 269
          if (isset($entity_form_item['weight'])) {
            $items["$path/translations"]['weight'] = $entity_form_item['weight'] + 0.01;
          }
        }
      }
    }
  }
}

270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287
/**
 * 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);
}

288 289 290 291 292 293 294 295 296
/**
 * 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 "%".
 */
297
function _content_translation_menu_strip_loaders($path) {
298 299 300
  return preg_replace('|%[^/]+|', '%', $path);
}

301 302 303 304 305 306
/**
 * Access callback for the translation overview page.
 *
 * @param \Drupal\Core\Entity\EntityInterface $entity
 *   The entity whose translation overview should be displayed.
 */
307
function content_translation_translate_access(EntityInterface $entity) {
308
  return $entity instanceof ContentEntityInterface && empty($entity->getUntranslated()->language()->locked) && language_multilingual() && $entity->isTranslatable() &&
309
    (user_access('create content translations') || user_access('update content translations') || user_access('delete content translations'));
310 311
}

312 313 314 315 316 317 318
/**
 * Checks whether the given user can view the specified translation.
 *
 * @param \Drupal\Core\Entity\EntityInterface $entity
 *   The entity whose translation overview should be displayed.
 * @param $langcode
 *   The language code of the translation to be displayed.
319
 * @param \Drupal\Core\Session\AccountInterface $account
320 321 322
 *   (optional) The account for which view access should be checked. Defaults to
 *   the current user.
 */
323
function content_translation_view_access(EntityInterface $entity, $langcode, AccountInterface $account = NULL) {
324
  $entity_type = $entity->entityType();
325 326
  $info = $entity->entityInfo();
  $permission = "translate $entity_type";
327
  if ($info->getPermissionGranularity() == 'bundle') {
328 329 330
    $permission = "translate {$entity->bundle()} $entity_type";
  }
  return !empty($entity->translation[$langcode]['status']) || user_access('translate any entity', $account) || user_access($permission, $account);
331 332
}

333 334 335 336 337 338
/**
 * Access callback for the translation addition page.
 *
 * @param \Drupal\Core\Entity\EntityInterface $entity
 *   The entity being translated.
 * @param \Drupal\Core\Language\Language $source
339 340
 *   (optional) The language of the values being translated. Defaults to the
 *   entity language.
341
 * @param \Drupal\Core\Language\Language $target
342 343
 *   (optional) The language of the translated values. Defaults to the current
 *   content language.
344
 */
345
function content_translation_add_access(EntityInterface $entity, Language $source = NULL, Language $target = NULL) {
346
  $source = !empty($source) ? $source : $entity->language();
347
  $target = !empty($target) ? $target : language(Language::TYPE_CONTENT);
348 349
  $translations = $entity->getTranslationLanguages();
  $languages = language_list();
350
  return $source->id != $target->id && isset($languages[$source->id]) && isset($languages[$target->id]) && !isset($translations[$target->id]) && content_translation_access($entity, 'create');
351 352 353 354 355 356 357 358 359 360 361
}

/**
 * Access callback for the translation edit page.
 *
 * @param \Drupal\Core\Entity\EntityInterface $entity
 *   The entity being translated.
 * @param \Drupal\Core\Language\Language $language
 *   (optional) The language of the translated values. Defaults to the current
 *   content language.
 */
362
function content_translation_edit_access(EntityInterface $entity, Language $language = NULL) {
363
  $language = !empty($language) ? $language : language(Language::TYPE_CONTENT);
364 365
  $translations = $entity->getTranslationLanguages();
  $languages = language_list();
366
  return isset($languages[$language->id]) && $language->id != $entity->getUntranslated()->language()->id && isset($translations[$language->id]) && content_translation_access($entity, 'update');
367 368 369 370 371 372 373 374 375 376 377
}

/**
 * Access callback for the translation delete page.
 *
 * @param \Drupal\Core\Entity\EntityInterface $entity
 *   The entity being translated.
 * @param \Drupal\Core\Language\Language $language
 *   (optional) The language of the translated values. Defaults to the current
 *   content language.
 */
378
function content_translation_delete_access(EntityInterface $entity, Language $language = NULL) {
379
  $language = !empty($language) ? $language : language(Language::TYPE_CONTENT);
380 381
  $translations = $entity->getTranslationLanguages();
  $languages = language_list();
382
  return isset($languages[$language->id]) && $language->id != $entity->getUntranslated()->language()->id && isset($translations[$language->id]) && content_translation_access($entity, 'delete');
383 384
}

385 386 387
/**
 * Implements hook_library_info().
 */
388 389 390 391
function content_translation_library_info() {
  $path = drupal_get_path('module', 'content_translation');
  $libraries['drupal.content_translation.admin'] = array(
    'title' => 'Content translation UI',
392
    'version' => \Drupal::VERSION,
393
    'js' => array(
394
      $path . '/content_translation.admin.js' => array(),
395 396
    ),
    'css' => array(
397
      $path . '/css/content_translation.admin.css' => array(),
398 399 400 401 402 403 404 405 406 407 408
    ),
    'dependencies' => array(
      array('system', 'jquery'),
      array('system', 'drupal'),
      array('system', 'jquery.once'),
    ),
  );

  return $libraries;
}

409
/**
410
 * Returns the key name used to store the configuration setting.
411
 *
412 413
 * Based on the entity type and bundle, the keys used to store configuration
 * will have a common root name.
414 415 416 417 418 419 420 421 422
 *
 * @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
423
 *   The key name of the configuration setting.
424 425 426 427
 *
 * @todo Generalize this logic so that it is available to any module needing
 *   per-bundle configuration.
 */
428
function content_translation_get_config_key($entity_type, $bundle, $setting) {
429 430
  $entity_type = preg_replace('/[^0-9a-zA-Z_]/', "_", $entity_type);
  $bundle = preg_replace('/[^0-9a-zA-Z_]/', "_", $bundle);
431
  return $entity_type . '.' . $bundle . '.content_translation.' . $setting;
432 433 434 435 436 437 438 439 440 441 442 443 444 445 446
}

/**
 * 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.
 */
447 448
function content_translation_get_config($entity_type, $bundle, $setting) {
  $key = content_translation_get_config_key($entity_type, $bundle, $setting);
449
  return \Drupal::config('content_translation.settings')->get($key);
450 451 452 453 454 455 456 457 458 459 460 461 462 463
}

/**
 * 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.
 */
464 465
function content_translation_set_config($entity_type, $bundle, $setting, $value) {
  $key = content_translation_get_config_key($entity_type, $bundle, $setting);
466
  return \Drupal::config('content_translation.settings')->set($key, $value)->save();
467 468 469 470 471 472 473 474 475 476 477 478 479 480
}

/**
 * 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.
481 482
 *
 * @todo Move to \Drupal\content_translation\ContentTranslationManager.
483
 */
484
function content_translation_enabled($entity_type, $bundle = NULL) {
485 486
  $enabled = FALSE;

487
  if (\Drupal::service('content_translation.manager')->isSupported($entity_type)) {
488 489
    $bundles = !empty($bundle) ? array($bundle) : array_keys(entity_get_bundles($entity_type));
    foreach ($bundles as $bundle) {
490
      if (content_translation_get_config($entity_type, $bundle, 'enabled')) {
491 492 493
        $enabled = TRUE;
        break;
      }
494 495 496
    }
  }

497
  return $enabled;
498 499 500
}

/**
501
 * Content translation controller factory.
502 503 504 505
 *
 * @param string $entity_type
 *   The type of the entity being translated.
 *
506 507
 * @return \Drupal\content_translation\ContentTranslationControllerInterface
 *   An instance of the content translation controller interface.
508 509
 *
 * @todo Move to \Drupal\content_translation\ContentTranslationManager.
510
 */
511
function content_translation_controller($entity_type) {
512
  $entity_info = \Drupal::entityManager()->getDefinition($entity_type);
513
  // @todo Throw an exception if the key is missing.
514 515
  $class = $entity_info->getController('translation');
  return new $class($entity_info);
516 517 518 519 520 521 522 523 524
}

/**
 * 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;
525
 *   An instance of the content translation form interface or FALSE if not an
526
 *   entity form.
527 528
 *
 * @todo Move to \Drupal\content_translation\ContentTranslationManager.
529
 */
530
function content_translation_form_controller(array $form_state) {
531 532 533 534
  return isset($form_state['controller']) && $form_state['controller'] instanceof EntityFormControllerInterface ? $form_state['controller'] : FALSE;
}

/**
535
 * Checks whether a content translation is accessible.
536 537 538
 *
 * @param \Drupal\Core\Entity\EntityInterface $entity
 *   The entity to be accessed.
539 540 541 542 543 544
 * @param $op
 *   The operation to be performed on the translation. Possible values are:
 *   - "view"
 *   - "update"
 *   - "delete"
 *   - "create"
545 546 547
 *
 * @return
 *   TRUE if the current user is allowed to view the translation.
548 549
 *
 * @todo Move to \Drupal\content_translation\ContentTranslationManager.
550
 */
551 552
function content_translation_access(EntityInterface $entity, $op) {
  return content_translation_controller($entity->entityType())->getTranslationAccess($entity, $op) ;
553 554 555 556 557
}

/**
 * Implements hook_permission().
 */
558
function content_translation_permission() {
559
  $permission = array(
560
    'administer content translation' => array(
561
      'title' => t('Administer translation settings'),
562
      'description' => t('Configure translatability of entities and fields.'),
563
    ),
564
    'create content translations' => array(
565 566
      'title' => t('Create translations'),
    ),
567
    'update content translations' => array(
568 569
      'title' => t('Edit translations'),
    ),
570
    'delete content translations' => array(
571 572
      'title' => t('Delete translations'),
    ),
573 574 575 576 577
    'translate any entity' => array(
      'title' => t('Translate any entity'),
    ),
  );

578 579
  // Create a translate permission for each enabled entity type and (optionally)
  // bundle.
580 581 582
  foreach (\Drupal::entityManager()->getDefinitions() as $entity_type => $info) {
    if ($permission_granularity = $info->getPermissionGranularity()) {
      $t_args = array('@entity_label' => $info->getLowercaseLabel());
583

584
      switch ($permission_granularity) {
585 586
        case 'bundle':
          foreach (entity_get_bundles($entity_type) as $bundle => $bundle_info) {
587
            if (content_translation_enabled($entity_type, $bundle)) {
588
              $t_args['%bundle_label'] = isset($bundle_info['label']) ? $bundle_info['label'] : $bundle;
589
              $permission["translate $bundle $entity_type"] = array(
590
                'title' => t('Translate %bundle_label @entity_label', $t_args),
591 592 593 594 595 596
              );
            }
          }
          break;

        case 'entity_type':
597
          if (content_translation_enabled($entity_type)) {
598 599 600 601 602 603
            $permission["translate $entity_type"] = array(
              'title' => t('Translate @entity_label', $t_args),
            );
          }
          break;
      }
604 605 606 607 608 609 610 611 612
    }
  }

  return $permission;
}

/**
 * Implements hook_form_alter().
 */
613
function content_translation_form_alter(array &$form, array &$form_state) {
614 615 616 617
  $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) {
618
    $controller = content_translation_controller($entity->entityType());
619 620 621 622 623 624 625 626 627 628
    $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)) {
629 630
      foreach ($entity->getPropertyDefinitions() as $property_name => $definition) {
        if (isset($form[$property_name])) {
631
          $form[$property_name]['#multilingual'] = $definition->isTranslatable();
632 633 634 635 636 637 638
        }
      }
    }

  }
}

639
/**
640
 * Implements hook_language_fallback_candidates_OPERATION_alter().
641 642 643
 *
 * Performs language fallback for unaccessible translations.
 */
644 645 646 647 648
function content_translation_language_fallback_candidates_entity_view_alter(&$candidates, $context) {
  $entity = $context['data'];
  foreach ($entity->getTranslationLanguages() as $langcode => $language) {
    if (!content_translation_view_access($entity, $langcode)) {
      unset($candidates[$langcode]);
649 650 651 652
    }
  }
}

653 654 655
/**
 * Implements hook_entity_load().
 */
656
function content_translation_entity_load(array $entities, $entity_type) {
657 658
  $enabled_entities = array();

659
  if (content_translation_enabled($entity_type)) {
660
    foreach ($entities as $entity) {
661
      if ($entity instanceof ContentEntityInterface && $entity->isTranslatable()) {
662 663 664 665 666 667
        $enabled_entities[$entity->id()] = $entity;
      }
    }
  }

  if (!empty($enabled_entities)) {
668
    content_translation_load_translation_metadata($enabled_entities, $entity_type);
669 670 671 672 673 674 675 676 677 678 679
  }
}

/**
 * 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.
 */
680 681
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)';
682
  $result = db_query($query, array(':entity_type' => $entity_type, ':entity_id' => array_keys($entities)));
683
  $exclude = array('entity_type', 'entity_id', 'langcode');
684 685 686
  foreach ($result as $record) {
    $entity = $entities[$record->entity_id];
    // @todo Declare these as entity (translation?) properties.
687 688
    foreach ($record as $field_name => $value) {
      if (!in_array($field_name, $exclude)) {
689 690 691 692 693
        $langcode = $record->langcode;
        $entity->translation[$langcode][$field_name] = $value;
        if (!$entity->hasTranslation($langcode)) {
          $entity->initTranslation($langcode);
        }
694 695
      }
    }
696 697 698 699 700 701
  }
}

/**
 * Implements hook_entity_insert().
 */
702
function content_translation_entity_insert(EntityInterface $entity) {
703
  // Only do something if translation support for the given entity is enabled.
704
  if (!($entity instanceof ContentEntityInterface) || !$entity->isTranslatable()) {
705 706 707
    return;
  }

708
  $fields = array('entity_type', 'entity_id', 'langcode', 'source', 'outdated', 'uid', 'status', 'created', 'changed');
709
  $query = db_insert('content_translation')->fields($fields);
710 711

  foreach ($entity->getTranslationLanguages() as $langcode => $language) {
712 713 714 715
    $translation = isset($entity->translation[$langcode]) ? $entity->translation[$langcode] : array();

    $translation += array(
      'source' => '',
716
      'uid' => $GLOBALS['user']->id(),
717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733
      'outdated' => FALSE,
      'status' => TRUE,
      'created' => REQUEST_TIME,
      'changed' => REQUEST_TIME,
    );

    $translation['entity_type'] = $entity->entityType();
    $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);
734 735 736 737 738 739 740 741
  }

  $query->execute();
}

/**
 * Implements hook_entity_delete().
 */
742
function content_translation_entity_delete(EntityInterface $entity) {
743
  // Only do something if translation support for the given entity is enabled.
744
  if (!($entity instanceof ContentEntityInterface) || !$entity->isTranslatable()) {
745 746 747
    return;
  }

748
  db_delete('content_translation')
749 750 751 752 753 754 755 756
    ->condition('entity_type', $entity->entityType())
    ->condition('entity_id', $entity->id())
    ->execute();
}

/**
 * Implements hook_entity_update().
 */
757
function content_translation_entity_update(EntityInterface $entity) {
758
  // Only do something if translation support for the given entity is enabled.
759
  if (!($entity instanceof ContentEntityInterface) || !$entity->isTranslatable()) {
760 761 762
    return;
  }

763
  // Delete and create to ensure no stale value remains behind.
764 765
  content_translation_entity_delete($entity);
  content_translation_entity_insert($entity);
766 767 768 769 770
}

/**
 * Implements hook_field_extra_fields().
 */
771
function content_translation_field_extra_fields() {
772 773
  $extra = array();

774
  foreach (\Drupal::entityManager()->getDefinitions() as $entity_type => $info) {
775
    foreach (entity_get_bundles($entity_type) as $bundle => $bundle_info) {
776
      if (content_translation_enabled($entity_type, $bundle)) {
777 778 779 780 781 782 783 784 785 786 787 788 789
        $extra[$entity_type][$bundle]['form']['translation'] = array(
          'label' => t('Translation'),
          'description' => t('Translation settings'),
          'weight' => 10,
        );
      }
    }
  }

  return $extra;
}

/**
790
 * Implements hook_form_FORM_ID_alter() for 'field_ui_field_edit_form'.
791
 */
792
function content_translation_form_field_ui_field_edit_form_alter(array &$form, array &$form_state, $form_id) {
793 794 795
  $form['field']['translatable'] = array(
    '#type' => 'checkbox',
    '#title' => t('Users may translate this field.'),
796
    '#default_value' => $form['#field']->isTranslatable(),
797 798
    '#weight' => 20,
  );
799 800 801 802 803 804 805 806 807 808 809 810
  $form['#submit'][] = 'content_translation_form_field_ui_field_edit_form_submit';
}

/**
 * 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();
  }
811
  $value[$instance->getField()->getName()] = $form_state['values']['field']['translatable'];
812 813 814 815 816
  // 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);
  }
817 818
}

819
/**
820
 * Implements hook_form_FORM_ID_alter() for 'field_ui_field_instance_edit_form'.
821
 */
822
function content_translation_form_field_ui_field_instance_edit_form_alter(array &$form, array &$form_state, $form_id) {
823
  if ($form['#field']->isTranslatable()) {
824
    module_load_include('inc', 'content_translation', 'content_translation.admin');
825
    $element = content_translation_field_sync_widget($form['#field']);
826 827 828 829 830 831 832 833 834
    if ($element) {
      $form['instance']['settings']['translation_sync'] = $element;
    }
  }
}

/**
 * Implements hook_field_info_alter().
 */
835
function content_translation_field_info_alter(&$info) {
836
  foreach ($info as &$field_type_info) {
837 838 839 840 841 842 843 844
    // By default no column has to be synchronized.
    $field_type_info['settings'] += array('translation_sync' => FALSE);
    // Synchronization can be enabled per instance.
    $field_type_info['instance_settings'] += array('translation_sync' => FALSE);
  }
}

/**
845
 * Implements hook_entity_presave().
846
 */
847
function content_translation_entity_presave(EntityInterface $entity) {
848
  if ($entity instanceof ContentEntityInterface && $entity->isTranslatable()) {
849 850
    // @todo Avoid using request attributes once translation metadata become
    //   regular fields.
851 852
    $attributes = \Drupal::request()->attributes;
    \Drupal::service('content_translation.synchronizer')->synchronizeFields($entity, $entity->language()->id, $attributes->get('source_langcode'));
853 854 855
  }
}

856 857 858
/**
 * Implements hook_element_info_alter().
 */
859
function content_translation_element_info_alter(&$type) {
860
  if (isset($type['language_configuration'])) {
861
    $type['language_configuration']['#process'][] = 'content_translation_language_configuration_element_process';
862 863
  }
}
864

865
/**
866
 * Returns a widget to enable content translation per entity bundle.
867 868 869 870 871 872 873 874 875 876 877 878 879 880 881
 *
 * 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.
 */
882 883
function content_translation_enable_widget($entity_type, $bundle, array &$form, array &$form_state) {
  $key = $form_state['content_translation']['key'];
884 885 886 887
  if (!isset($form_state['language'][$key])) {
    $form_state['language'][$key] = array();
  }
  $form_state['language'][$key] += array('entity_type' => $entity_type, 'bundle' => $bundle);
888 889
  $element = content_translation_language_configuration_element_process(array('#name' => $key), $form_state, $form);
  unset($element['content_translation']['#element_validate']);
890 891 892 893 894 895 896 897 898 899 900 901
  return $element;
}

/**
 * Process callback: Expands the language_configuration form element.
 *
 * @param array $element
 *   Form API element.
 *
 * @return
 *   Processed language configuration element.
 */
902 903 904
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'];
905
    $context = $form_state['language'][$element['#name']];
906

907
    $element['content_translation'] = array(
908 909
      '#type' => 'checkbox',
      '#title' => t('Enable translation'),
910 911
      '#default_value' => content_translation_enabled($context['entity_type'], $context['bundle']),
      '#element_validate' => array('content_translation_language_configuration_element_validate'),
912 913
      '#prefix' => '<label>' . t('Translation') . '</label>',
    );
914

915
    $form['actions']['submit']['#submit'][] = 'content_translation_language_configuration_element_submit';
916
  }
917 918 919 920
  return $element;
}

/**
921
 * Form validation handler for element added with content_translation_language_configuration_element_process().
922 923 924 925 926
 *
 * 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.
 *
927
 * @see content_translation_language_configuration_element_submit()
928
 */
929 930
function content_translation_language_configuration_element_validate($element, array &$form_state, array $form) {
  $key = $form_state['content_translation']['key'];
931
  $values = $form_state['values'][$key];
932
  if (language_is_locked($values['langcode']) && !$values['language_show'] && $values['content_translation']) {
933
    foreach (language_list(Language::STATE_LOCKED) as $language) {
934 935 936 937 938
      $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.
939
    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']])));
940 941 942 943
  }
}

/**
944
 * Form submission handler for element added with content_translation_language_configuration_element_process().
945
 *
946
 * Stores the content translation settings.
947
 *
948
 * @see content_translation_language_configuration_element_validate()
949
 */
950 951
function content_translation_language_configuration_element_submit(array $form, array &$form_state) {
  $key = $form_state['content_translation']['key'];
952
  $context = $form_state['language'][$key];