content_translation.module 41.2 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
}

/**
 * Implements hook_entity_info_alter().
78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101
 *
 * The content translation UI relies on the entity info to provide its features.
 * See the documentation of hook_entity_info() in the Entity API documentation
 * for more details on all the entity info keys that may be defined.
 *
 * To make Content Translation automatically support an entity type some keys
 * may need to be defined, but none of them is required unless the entity path
 * is different from the usual /ENTITY_TYPE/{ENTITY_TYPE} pattern (for instance
 * "/taxonomy/term/{taxonomy_term}"), in which case at least the 'canonical' key
 * in the 'links' entity info property must be defined.
 *
 * Every entity type needs a translation controller to be translated. This can
 * be specified through the 'translation' key in the 'controllers' entity info
 * property. If an entity type is translatable and no translation controller is
 * defined, \Drupal\content_translation\ContentTranslationController will be
 * assumed. Every translation controller class must implement
 * \Drupal\content_translation\ContentTranslationControllerInterface.
 *
 * If the entity paths match the default pattern above and there is no need for
 * an entity-specific translation controller class, Content Translation will
 * provide built-in support for the entity. However enabling translation for
 * each translatable bundle will be required.
 *
 * @see \Drupal\Core\Entity\Annotation\EntityType
102
 */
103
function content_translation_entity_info_alter(array &$entity_info) {
104
  // Provide defaults for translation info.
105
  /** @var $entity_info \Drupal\Core\Entity\EntityTypeInterface[] */
106
  foreach ($entity_info as $entity_type => &$info) {
107 108 109 110
    if ($info->isTranslatable()) {
      if (!$info->hasController('translation')) {
        $info->setController('translation', 'Drupal\content_translation\ContentTranslationController');
      }
111

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

117
      if ($info->hasLinkTemplate('canonical')) {
118
        // Provide default route names for the translation paths.
119 120 121
        if (!$info->hasLinkTemplate('drupal:content-translation-overview')) {
          $info->setLinkTemplate('drupal:content-translation-overview', "content_translation.translation_overview_$entity_type");
        }
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
      $info->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
/**
 * 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])) {
164
          $info[$key][$name]->setTranslatable((bool) $translatable);
165 166 167 168 169 170 171
          break;
        }
      }
    }
  }
}

172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
/**
 * 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'],
    );
  }
}

187 188
/**
 * Implements hook_menu().
189 190 191
 *
 * @todo Split this into route definition and menu link definition. See
 *   https://drupal.org/node/1987882 and https://drupal.org/node/2047633.
192
 */
193
function content_translation_menu() {
194 195 196
  $items = array();

  // Create tabs for all possible entity types.
197
  foreach (\Drupal::entityManager()->getDefinitions() as $entity_type => $info) {
198
    // Provide the translation UI only for enabled types.
199
    if (content_translation_enabled($entity_type)) {
200
      $path = _content_translation_link_to_router_path($entity_type, $info->getLinkTemplate('canonical'));
201
      $entity_position = count(explode('/', $path)) - 1;
202
      $keys = array_flip(array('load_arguments'));
203 204
      $translation = $info->get('translation');
      $menu_info = array_intersect_key($translation['content_translation'], $keys) + array('file' => 'content_translation.pages.inc');
205 206 207 208 209 210 211 212 213 214 215 216 217
      $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);
218
      $items["$path/translations/add/%language/%language"] = array(
219
        'title' => 'Add',
220
        'route_name' => "content_translation.translation_add_$entity_type",
221
        'weight' => 1,
222
      );
223 224 225 226 227

      // Edit translation callback.
      $args = array($entity_position, $language_position);
      $items["$path/translations/edit/%language"] = array(
        'title' => 'Edit',
228
        'route_name' => "content_translation.translation_edit_$entity_type",
229
        'weight' => 1,
230
      );
231 232 233 234

      // Delete translation callback.
      $items["$path/translations/delete/%language"] = array(
        'title' => 'Delete',
235
        'route_name' => "content_translation.delete_$entity_type",
236 237 238 239 240 241 242 243 244
      ) + $item;
    }
  }

  return $items;
}

/**
 * Implements hook_menu_alter().
245 246 247
 *
 * @todo Split this into route definition and menu link definition. See
 *   https://drupal.org/node/1987882 and https://drupal.org/node/2047633.
248
 */
249
function content_translation_menu_alter(array &$items) {
250 251 252 253
  // 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.';

254
  // Check that the declared menu base paths are actually valid.
255
  foreach (\Drupal::entityManager()->getDefinitions() as $entity_type => $info) {
256
    if (content_translation_enabled($entity_type)) {
257
      $path = _content_translation_link_to_router_path($entity_type, $info->getLinkTemplate('canonical'));
258

259 260 261 262
      // 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().
263
      if (!isset($items[$path]) && !isset($items["$path/edit"])
264
          && !isset($items[_content_translation_menu_strip_loaders($path)])) {
265 266
        unset(
          $items["$path/translations"],
267
          $items["$path/translations/add/%language/%language"],
268 269
          $items["$path/translations/delete/%language"]
        );
270
        $t_args = array('@entity_type' => $info->getLabel() ?: $entity_type);
271
        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);
272 273
      }
      else {
274
        $edit_path = $path . '/edit';
275 276 277 278 279 280 281 282 283 284 285

        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);

286
          // Make the "Translate" tab follow the "Edit" one when possible.
287 288 289 290 291 292 293 294 295
          if (isset($entity_form_item['weight'])) {
            $items["$path/translations"]['weight'] = $entity_form_item['weight'] + 0.01;
          }
        }
      }
    }
  }
}

296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313
/**
 * 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);
}

314 315 316 317 318 319 320 321 322
/**
 * 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 "%".
 */
323
function _content_translation_menu_strip_loaders($path) {
324 325 326
  return preg_replace('|%[^/]+|', '%', $path);
}

327 328 329 330 331 332
/**
 * Access callback for the translation overview page.
 *
 * @param \Drupal\Core\Entity\EntityInterface $entity
 *   The entity whose translation overview should be displayed.
 */
333
function content_translation_translate_access(EntityInterface $entity) {
334
  return $entity instanceof ContentEntityInterface && empty($entity->getUntranslated()->language()->locked) && language_multilingual() && $entity->isTranslatable() &&
335
    (user_access('create content translations') || user_access('update content translations') || user_access('delete content translations'));
336 337
}

338 339 340 341 342 343 344
/**
 * 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.
345
 * @param \Drupal\Core\Session\AccountInterface $account
346 347 348
 *   (optional) The account for which view access should be checked. Defaults to
 *   the current user.
 */
349
function content_translation_view_access(EntityInterface $entity, $langcode, AccountInterface $account = NULL) {
350
  $entity_type = $entity->entityType();
351 352
  $info = $entity->entityInfo();
  $permission = "translate $entity_type";
353
  if ($info->getPermissionGranularity() == 'bundle') {
354 355 356
    $permission = "translate {$entity->bundle()} $entity_type";
  }
  return !empty($entity->translation[$langcode]['status']) || user_access('translate any entity', $account) || user_access($permission, $account);
357 358
}

359 360 361 362 363 364
/**
 * Access callback for the translation addition page.
 *
 * @param \Drupal\Core\Entity\EntityInterface $entity
 *   The entity being translated.
 * @param \Drupal\Core\Language\Language $source
365 366
 *   (optional) The language of the values being translated. Defaults to the
 *   entity language.
367
 * @param \Drupal\Core\Language\Language $target
368 369
 *   (optional) The language of the translated values. Defaults to the current
 *   content language.
370
 */
371
function content_translation_add_access(EntityInterface $entity, Language $source = NULL, Language $target = NULL) {
372
  $source = !empty($source) ? $source : $entity->language();
373
  $target = !empty($target) ? $target : language(Language::TYPE_CONTENT);
374 375
  $translations = $entity->getTranslationLanguages();
  $languages = language_list();
376
  return $source->id != $target->id && isset($languages[$source->id]) && isset($languages[$target->id]) && !isset($translations[$target->id]) && content_translation_access($entity, 'create');
377 378 379 380 381 382 383 384 385 386 387
}

/**
 * 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.
 */
388
function content_translation_edit_access(EntityInterface $entity, Language $language = NULL) {
389
  $language = !empty($language) ? $language : language(Language::TYPE_CONTENT);
390 391
  $translations = $entity->getTranslationLanguages();
  $languages = language_list();
392
  return isset($languages[$language->id]) && $language->id != $entity->getUntranslated()->language()->id && isset($translations[$language->id]) && content_translation_access($entity, 'update');
393 394 395 396 397 398 399 400 401 402 403
}

/**
 * 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.
 */
404
function content_translation_delete_access(EntityInterface $entity, Language $language = NULL) {
405
  $language = !empty($language) ? $language : language(Language::TYPE_CONTENT);
406 407
  $translations = $entity->getTranslationLanguages();
  $languages = language_list();
408
  return isset($languages[$language->id]) && $language->id != $entity->getUntranslated()->language()->id && isset($translations[$language->id]) && content_translation_access($entity, 'delete');
409 410
}

411 412 413
/**
 * Implements hook_library_info().
 */
414 415 416 417
function content_translation_library_info() {
  $path = drupal_get_path('module', 'content_translation');
  $libraries['drupal.content_translation.admin'] = array(
    'title' => 'Content translation UI',
418
    'version' => \Drupal::VERSION,
419
    'js' => array(
420
      $path . '/content_translation.admin.js' => array(),
421 422
    ),
    'css' => array(
423
      $path . '/css/content_translation.admin.css' => array(),
424 425 426 427 428 429 430 431 432 433 434
    ),
    'dependencies' => array(
      array('system', 'jquery'),
      array('system', 'drupal'),
      array('system', 'jquery.once'),
    ),
  );

  return $libraries;
}

435
/**
436
 * Returns the key name used to store the configuration setting.
437
 *
438 439
 * Based on the entity type and bundle, the keys used to store configuration
 * will have a common root name.
440 441 442 443 444 445 446 447 448
 *
 * @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
449
 *   The key name of the configuration setting.
450 451 452 453
 *
 * @todo Generalize this logic so that it is available to any module needing
 *   per-bundle configuration.
 */
454
function content_translation_get_config_key($entity_type, $bundle, $setting) {
455 456
  $entity_type = preg_replace('/[^0-9a-zA-Z_]/', "_", $entity_type);
  $bundle = preg_replace('/[^0-9a-zA-Z_]/', "_", $bundle);
457
  return $entity_type . '.' . $bundle . '.content_translation.' . $setting;
458 459 460 461 462 463 464 465 466 467 468 469 470 471 472
}

/**
 * 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.
 */
473 474
function content_translation_get_config($entity_type, $bundle, $setting) {
  $key = content_translation_get_config_key($entity_type, $bundle, $setting);
475
  return \Drupal::config('content_translation.settings')->get($key);
476 477 478 479 480 481 482 483 484 485 486 487 488 489
}

/**
 * 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.
 */
490 491
function content_translation_set_config($entity_type, $bundle, $setting, $value) {
  $key = content_translation_get_config_key($entity_type, $bundle, $setting);
492
  return \Drupal::config('content_translation.settings')->set($key, $value)->save();
493 494 495 496 497 498 499 500 501 502 503 504 505 506
}

/**
 * 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.
507 508
 *
 * @todo Move to \Drupal\content_translation\ContentTranslationManager.
509
 */
510
function content_translation_enabled($entity_type, $bundle = NULL) {
511 512
  $enabled = FALSE;

513
  if (\Drupal::service('content_translation.manager')->isSupported($entity_type)) {
514 515
    $bundles = !empty($bundle) ? array($bundle) : array_keys(entity_get_bundles($entity_type));
    foreach ($bundles as $bundle) {
516
      if (content_translation_get_config($entity_type, $bundle, 'enabled')) {
517 518 519
        $enabled = TRUE;
        break;
      }
520 521 522
    }
  }

523
  return $enabled;
524 525 526
}

/**
527
 * Content translation controller factory.
528 529 530 531
 *
 * @param string $entity_type
 *   The type of the entity being translated.
 *
532 533
 * @return \Drupal\content_translation\ContentTranslationControllerInterface
 *   An instance of the content translation controller interface.
534 535
 *
 * @todo Move to \Drupal\content_translation\ContentTranslationManager.
536
 */
537
function content_translation_controller($entity_type) {
538
  $entity_info = \Drupal::entityManager()->getDefinition($entity_type);
539
  // @todo Throw an exception if the key is missing.
540 541
  $class = $entity_info->getController('translation');
  return new $class($entity_info);
542 543 544 545 546 547 548 549 550
}

/**
 * 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;
551
 *   An instance of the content translation form interface or FALSE if not an
552
 *   entity form.
553 554
 *
 * @todo Move to \Drupal\content_translation\ContentTranslationManager.
555
 */
556
function content_translation_form_controller(array $form_state) {
557 558 559 560
  return isset($form_state['controller']) && $form_state['controller'] instanceof EntityFormControllerInterface ? $form_state['controller'] : FALSE;
}

/**
561
 * Checks whether a content translation is accessible.
562 563 564
 *
 * @param \Drupal\Core\Entity\EntityInterface $entity
 *   The entity to be accessed.
565 566 567 568 569 570
 * @param $op
 *   The operation to be performed on the translation. Possible values are:
 *   - "view"
 *   - "update"
 *   - "delete"
 *   - "create"
571 572 573
 *
 * @return
 *   TRUE if the current user is allowed to view the translation.
574 575
 *
 * @todo Move to \Drupal\content_translation\ContentTranslationManager.
576
 */
577 578
function content_translation_access(EntityInterface $entity, $op) {
  return content_translation_controller($entity->entityType())->getTranslationAccess($entity, $op) ;
579 580 581 582 583
}

/**
 * Implements hook_permission().
 */
584
function content_translation_permission() {
585
  $permission = array(
586
    'administer content translation' => array(
587
      'title' => t('Administer translation settings'),
588
      'description' => t('Configure translatability of entities and fields.'),
589
    ),
590
    'create content translations' => array(
591 592
      'title' => t('Create translations'),
    ),
593
    'update content translations' => array(
594 595
      'title' => t('Edit translations'),
    ),
596
    'delete content translations' => array(
597 598
      'title' => t('Delete translations'),
    ),
599 600 601 602 603
    'translate any entity' => array(
      'title' => t('Translate any entity'),
    ),
  );

604 605
  // Create a translate permission for each enabled entity type and (optionally)
  // bundle.
606 607 608
  foreach (\Drupal::entityManager()->getDefinitions() as $entity_type => $info) {
    if ($permission_granularity = $info->getPermissionGranularity()) {
      $t_args = array('@entity_label' => $info->getLowercaseLabel());
609

610
      switch ($permission_granularity) {
611 612
        case 'bundle':
          foreach (entity_get_bundles($entity_type) as $bundle => $bundle_info) {
613
            if (content_translation_enabled($entity_type, $bundle)) {
614
              $t_args['%bundle_label'] = isset($bundle_info['label']) ? $bundle_info['label'] : $bundle;
615
              $permission["translate $bundle $entity_type"] = array(
616
                'title' => t('Translate %bundle_label @entity_label', $t_args),
617 618 619 620 621 622
              );
            }
          }
          break;

        case 'entity_type':
623
          if (content_translation_enabled($entity_type)) {
624 625 626 627 628 629
            $permission["translate $entity_type"] = array(
              'title' => t('Translate @entity_label', $t_args),
            );
          }
          break;
      }
630 631 632 633 634 635 636 637 638
    }
  }

  return $permission;
}

/**
 * Implements hook_form_alter().
 */
639
function content_translation_form_alter(array &$form, array &$form_state) {
640 641 642 643
  $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) {
644
    $controller = content_translation_controller($entity->entityType());
645 646 647 648 649 650 651 652 653 654
    $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)) {
655 656
      foreach ($entity->getPropertyDefinitions() as $property_name => $definition) {
        if (isset($form[$property_name])) {
657
          $form[$property_name]['#multilingual'] = $definition->isTranslatable();
658 659 660 661 662 663 664
        }
      }
    }

  }
}

665
/**
666
 * Implements hook_language_fallback_candidates_OPERATION_alter().
667 668 669
 *
 * Performs language fallback for unaccessible translations.
 */
670 671 672 673 674
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]);
675 676 677 678
    }
  }
}

679 680 681
/**
 * Implements hook_entity_load().
 */
682
function content_translation_entity_load(array $entities, $entity_type) {
683 684
  $enabled_entities = array();

685
  if (content_translation_enabled($entity_type)) {
686
    foreach ($entities as $entity) {
687
      if ($entity instanceof ContentEntityInterface && $entity->isTranslatable()) {
688 689 690 691 692 693
        $enabled_entities[$entity->id()] = $entity;
      }
    }
  }

  if (!empty($enabled_entities)) {
694
    content_translation_load_translation_metadata($enabled_entities, $entity_type);
695 696 697 698 699 700 701 702 703 704 705
  }
}

/**
 * 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.
 */
706 707
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)';
708
  $result = db_query($query, array(':entity_type' => $entity_type, ':entity_id' => array_keys($entities)));
709
  $exclude = array('entity_type', 'entity_id', 'langcode');
710 711 712
  foreach ($result as $record) {
    $entity = $entities[$record->entity_id];
    // @todo Declare these as entity (translation?) properties.
713 714
    foreach ($record as $field_name => $value) {
      if (!in_array($field_name, $exclude)) {
715 716 717 718 719
        $langcode = $record->langcode;
        $entity->translation[$langcode][$field_name] = $value;
        if (!$entity->hasTranslation($langcode)) {
          $entity->initTranslation($langcode);
        }
720 721
      }
    }
722 723 724 725 726 727
  }
}

/**
 * Implements hook_entity_insert().
 */
728
function content_translation_entity_insert(EntityInterface $entity) {
729
  // Only do something if translation support for the given entity is enabled.
730
  if (!($entity instanceof ContentEntityInterface) || !$entity->isTranslatable()) {
731 732 733
    return;
  }

734
  $fields = array('entity_type', 'entity_id', 'langcode', 'source', 'outdated', 'uid', 'status', 'created', 'changed');
735
  $query = db_insert('content_translation')->fields($fields);
736 737

  foreach ($entity->getTranslationLanguages() as $langcode => $language) {
738 739 740 741
    $translation = isset($entity->translation[$langcode]) ? $entity->translation[$langcode] : array();

    $translation += array(
      'source' => '',
742
      'uid' => \Drupal::currentUser()->id(),
743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759
      '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);
760 761 762 763 764 765 766 767
  }

  $query->execute();
}

/**
 * Implements hook_entity_delete().
 */
768
function content_translation_entity_delete(EntityInterface $entity) {
769
  // Only do something if translation support for the given entity is enabled.
770
  if (!($entity instanceof ContentEntityInterface) || !$entity->isTranslatable()) {
771 772 773
    return;
  }

774
  db_delete('content_translation')
775 776 777 778 779 780 781 782
    ->condition('entity_type', $entity->entityType())
    ->condition('entity_id', $entity->id())
    ->execute();
}

/**
 * Implements hook_entity_update().
 */
783
function content_translation_entity_update(EntityInterface $entity) {
784
  // Only do something if translation support for the given entity is enabled.
785
  if (!($entity instanceof ContentEntityInterface) || !$entity->isTranslatable()) {
786 787 788
    return;
  }

789
  // Delete and create to ensure no stale value remains behind.
790 791
  content_translation_entity_delete($entity);
  content_translation_entity_insert($entity);
792 793 794 795 796
}

/**
 * Implements hook_field_extra_fields().
 */
797
function content_translation_field_extra_fields() {
798 799
  $extra = array();

800
  foreach (\Drupal::entityManager()->getDefinitions() as $entity_type => $info) {
801
    foreach (entity_get_bundles($entity_type) as $bundle => $bundle_info) {
802
      if (content_translation_enabled($entity_type, $bundle)) {
803 804 805 806 807 808 809 810 811 812 813 814 815
        $extra[$entity_type][$bundle]['form']['translation'] = array(
          'label' => t('Translation'),
          'description' => t('Translation settings'),
          'weight' => 10,
        );
      }
    }
  }

  return $extra;
}

/**
816
 * Implements hook_form_FORM_ID_alter() for 'field_ui_field_edit_form'.
817
 */
818
function content_translation_form_field_ui_field_edit_form_alter(array &$form, array &$form_state, $form_id) {
819 820 821
  $form['field']['translatable'] = array(
    '#type' => 'checkbox',
    '#title' => t('Users may translate this field.'),
822
    '#default_value' => $form['#field']->isTranslatable(),
823 824
    '#weight' => 20,
  );
825 826 827 828 829 830 831 832 833 834 835 836
  $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();
  }
837
  $value[$instance->getField()->getName()] = $form_state['values']['field']['translatable'];
838 839 840 841 842
  // 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);
  }
843 844
}

845
/**
846
 * Implements hook_form_FORM_ID_alter() for 'field_ui_field_instance_edit_form'.
847
 */
848
function content_translation_form_field_ui_field_instance_edit_form_alter(array &$form, array &$form_state, $form_id) {
849
  if ($form['#field']->isTranslatable()) {
850
    module_load_include('inc', 'content_translation', 'content_translation.admin');
851
    $element = content_translation_field_sync_widget($form['#field']);
852 853 854 855 856 857 858 859 860
    if ($element) {
      $form['instance']['settings']['translation_sync'] = $element;
    }
  }
}

/**
 * Implements hook_field_info_alter().
 */
861
function content_translation_field_info_alter(&$info) {
862
  foreach ($info as &$field_type_info) {
863 864 865 866 867 868 869 870
    // 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);
  }
}

/**
871
 * Implements hook_entity_presave().
872
 */
873
function content_translation_entity_presave(EntityInterface $entity) {
874
  if ($entity instanceof ContentEntityInterface && $entity->isTranslatable()) {
875 876
    // @todo Avoid using request attributes once translation metadata become
    //   regular fields.
877 878
    $attributes = \Drupal::request()->attributes;
    \Drupal::service('content_translation.synchronizer')->synchronizeFields($entity, $entity->language()->id, $attributes->get('source_langcode'));
879 880 881
  }
}

882 883 884
/**
 * Implements hook_element_info_alter().
 */
885
function content_translation_element_info_alter(&$type) {
886
  if (isset($type['language_configuration'])) {
887
    $type['language_configuration']['#process'][] = 'content_translation_language_configuration_element_process';
888 889
  }
}
890

891
/**
892
 * Returns a widget to enable content translation per entity bundle.
893 894 895 896 897 898 899 900 901 902 903 904 905 906 907
 *
 * 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.
 */
908 909
function content_translation_enable_widget($entity_type, $bundle, array &$form, array &$form_state) {
  $key = $form_state['content_translation']['key'];
910 911 912 913
  if (!isset($form_state['language'][$key])) {
    $form_state['language'][$key] = array();
  }
  $form_state['language'][$key] += array('entity_type' => $entity_type, 'bundle' => $bundle);
914 915
  $element = content_translation_language_configuration_element_process(array('#name' => $key), $form_state, $form);
  unset($element['content_translation']['#element_validate']);
916 917 918 919 920 921 922 923 924 925 926 927
  return $element;
}

/**
 * Process callback: Expands the language_configuration form element.
 *
 * @param array $element
 *   Form API element.
 *
 * @return
 *   Processed language configuration element.
 */
928 929 930
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'];
931
    $context = $form_state['language'][$element['#name']];
932

933
    $element['content_translation'] = array(
934 935
      '#type' => 'checkbox',
      '#title' => t('Enable translation'),
936 937
      '#default_value' => content_translation_enabled($context['entity_type'], $context['bundle']),
      '#element_validate' => array('content_translation_language_configuration_element_validate'),
938 939
      '#prefix' => '<label>' . t('Translation') . '</label>',
    );
940

941
    $form['actions']['submit']['#submit'][] = 'content_translation_language_configuration_element_submit';
942
  }
943 944 945 946
  return $element;
}

/**
947
 * Form validation handler for element added with content_translation_language_configuration_element_process().
948 949 950 951 952
 *
 * 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.
 *
953
 * @see content_translation_language_configuration_element_submit()
954
 */
955 956
function content_translation_language_configuration_element_validate($element, array &$form_state, array $form) {
  $key = $form_state['content_translation']['key'];
957
  $values = $form_state['values'][$key];
958
  if (language_is_locked($values['langcode']) && !$values['language_show'] && $values['content_translation']) {
959
    foreach (language_list(Language::STATE_LOCKED) as $language) {
960 961 962 963 964
      $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.
965
    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']])));
966 967 968 969
  }
}

/**