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

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

8
use Drupal\content_translation\Plugin\Derivative\ContentTranslationLocalTasks;
9
use Drupal\Core\Entity\ContentEntityInterface;
10 11
use Drupal\Core\Entity\EntityFormControllerInterface;
use Drupal\Core\Entity\EntityInterface;
12 13 14
use Drupal\Core\Language\Language;
use Drupal\Core\Session\AccountInterface;
use Drupal\Core\TypedData\TranslatableInterface;
15 16 17 18

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

    case 'admin/config/regional/content-language':
      $output = '';
      if (!language_multilingual()) {
44
        $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')));
45 46
      }
      return $output;
47 48 49
  }
}

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

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

/**
 * Implements hook_entity_info_alter().
 */
78
function content_translation_entity_info_alter(array &$entity_info) {
79 80
  // Provide defaults for translation info.
  foreach ($entity_info as $entity_type => &$info) {
81 82 83 84 85 86 87 88 89 90
    if (!empty($info['translatable'])) {
      // Every fieldable entity type must have a translation controller class,
      // no matter if it is enabled for translation or not. As a matter of fact
      // we might need it to correctly switch field translatability when a field
      // is shared accross different entities.
      $info['controllers'] += array('translation' => 'Drupal\content_translation\ContentTranslationController');

      if (!isset($info['translation']['content_translation'])) {
        $info['translation']['content_translation'] = array();
      }
91

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

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

117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143
/**
 * 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])) {
          $info[$key][$name]['translatable'] = (bool) $translatable;
          break;
        }
      }
    }
  }
}

144 145
/**
 * Implements hook_menu().
146 147 148
 *
 * @todo Split this into route definition and menu link definition. See
 *   https://drupal.org/node/1987882 and https://drupal.org/node/2047633.
149
 */
150
function content_translation_menu() {
151 152 153 154 155
  $items = array();

  // Create tabs for all possible entity types.
  foreach (entity_get_info() as $entity_type => $info) {
    // Provide the translation UI only for enabled types.
156
    if (content_translation_enabled($entity_type)) {
157
      $path = _content_translation_link_to_router_path($entity_type, $info['links']['canonical']);
158
      $entity_position = count(explode('/', $path)) - 1;
159
      $keys = array_flip(array('load_arguments'));
160
      $menu_info = array_intersect_key($info['translation']['content_translation'], $keys) + array('file' => 'content_translation.pages.inc');
161 162 163 164 165 166 167 168 169
      $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;
      }

      $items["$path/translations"] = array(
170
        'title' => 'Translate',
171
        'route_name' => $info['links']['drupal:content-translation-overview'],
172
        'type' => MENU_LOCAL_TASK,
173
        'context' => MENU_CONTEXT_PAGE,
174 175 176
        'weight' => 2,
      ) + $item;

177 178 179 180 181 182
      $items["$path/translations/overview"] = array(
        'title' => 'Overview',
        'type' => MENU_DEFAULT_LOCAL_TASK,
        'weight' => 0,
      );

183 184 185 186 187
      // 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);
188
      $items["$path/translations/add/%language/%language"] = array(
189
        'title' => 'Add',
190
        'route_name' => "content_translation.translation_add_$entity_type",
191
        'weight' => 1,
192
      );
193 194 195 196 197

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

      // Delete translation callback.
      $items["$path/translations/delete/%language"] = array(
        'title' => 'Delete',
205
        'route_name' => "content_translation.delete_$entity_type",
206 207 208 209
      ) + $item;
    }
  }

210
  $items['admin/config/regional/content_translation/translatable/%/%'] = array(
211 212
    'title' => 'Confirm change in translatability.',
    'description' => 'Confirm page for changing field translatability.',
213
    'route_name' => 'content_translation.translatable',
214 215 216 217 218 219 220
  );

  return $items;
}

/**
 * Implements hook_menu_alter().
221 222 223
 *
 * @todo Split this into route definition and menu link definition. See
 *   https://drupal.org/node/1987882 and https://drupal.org/node/2047633.
224
 */
225
function content_translation_menu_alter(array &$items) {
226 227 228 229
  // 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.';

230 231
  // Check that the declared menu base paths are actually valid.
  foreach (entity_get_info() as $entity_type => $info) {
232
    if (content_translation_enabled($entity_type)) {
233
      $path = _content_translation_link_to_router_path($entity_type, $info['links']['canonical']);
234

235 236 237 238
      // 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().
239
      if (!isset($items[$path]) && !isset($items["$path/edit"])
240
          && !isset($items[_content_translation_menu_strip_loaders($path)])) {
241 242
        unset(
          $items["$path/translations"],
243
          $items["$path/translations/add/%language/%language"],
244 245
          $items["$path/translations/delete/%language"]
        );
246
        $t_args = array('@entity_type' => isset($info['label']) ? $info['label'] : $entity_type);
247
        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);
248 249 250
      }
      else {
        $entity_position = count(explode('/', $path)) - 1;
251
        $edit_path = $path . '/edit';
252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272

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

          // Make the "Translate" tab follow the "Edit" one when possibile.
          if (isset($entity_form_item['weight'])) {
            $items["$path/translations"]['weight'] = $entity_form_item['weight'] + 0.01;
          }
        }
      }
    }
  }
}

273 274 275 276 277 278 279 280 281
/**
 * Implements hook_local_tasks_alter().
 */
function content_translation_local_tasks_alter(&$local_tasks) {
  // Alters in tab_root_id onto the content translation local task.
  $derivative = ContentTranslationLocalTasks::create(\Drupal::getContainer(), 'content_translation.local_tasks');
  $derivative->alterLocalTasks($local_tasks);
}

282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299
/**
 * 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);
}

300 301 302 303 304 305 306 307 308
/**
 * 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 "%".
 */
309
function _content_translation_menu_strip_loaders($path) {
310 311 312
  return preg_replace('|%[^/]+|', '%', $path);
}

313 314 315 316 317 318
/**
 * Access callback for the translation overview page.
 *
 * @param \Drupal\Core\Entity\EntityInterface $entity
 *   The entity whose translation overview should be displayed.
 */
319
function content_translation_translate_access(EntityInterface $entity) {
320
  return $entity instanceof ContentEntityInterface && empty($entity->getUntranslated()->language()->locked) && language_multilingual() && $entity->isTranslatable() &&
321
    (user_access('create content translations') || user_access('update content translations') || user_access('delete content translations'));
322 323
}

324 325 326 327 328 329 330
/**
 * 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.
331
 * @param \Drupal\Core\Session\AccountInterface $account
332 333 334
 *   (optional) The account for which view access should be checked. Defaults to
 *   the current user.
 */
335
function content_translation_view_access(EntityInterface $entity, $langcode, AccountInterface $account = NULL) {
336
  $entity_type = $entity->entityType();
337 338 339 340 341 342
  $info = $entity->entityInfo();
  $permission = "translate $entity_type";
  if (!empty($info['permission_granularity']) && $info['permission_granularity'] == 'bundle') {
    $permission = "translate {$entity->bundle()} $entity_type";
  }
  return !empty($entity->translation[$langcode]['status']) || user_access('translate any entity', $account) || user_access($permission, $account);
343 344
}

345 346 347 348 349 350
/**
 * Access callback for the translation addition page.
 *
 * @param \Drupal\Core\Entity\EntityInterface $entity
 *   The entity being translated.
 * @param \Drupal\Core\Language\Language $source
351 352
 *   (optional) The language of the values being translated. Defaults to the
 *   entity language.
353
 * @param \Drupal\Core\Language\Language $target
354 355
 *   (optional) The language of the translated values. Defaults to the current
 *   content language.
356
 */
357
function content_translation_add_access(EntityInterface $entity, Language $source = NULL, Language $target = NULL) {
358
  $source = !empty($source) ? $source : $entity->language();
359
  $target = !empty($target) ? $target : language(Language::TYPE_CONTENT);
360 361
  $translations = $entity->getTranslationLanguages();
  $languages = language_list();
362
  return $source->id != $target->id && isset($languages[$source->id]) && isset($languages[$target->id]) && !isset($translations[$target->id]) && content_translation_access($entity, 'create');
363 364 365 366 367 368 369 370 371 372 373
}

/**
 * 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.
 */
374
function content_translation_edit_access(EntityInterface $entity, Language $language = NULL) {
375
  $language = !empty($language) ? $language : language(Language::TYPE_CONTENT);
376 377
  $translations = $entity->getTranslationLanguages();
  $languages = language_list();
378
  return isset($languages[$language->id]) && $language->id != $entity->getUntranslated()->language()->id && isset($translations[$language->id]) && content_translation_access($entity, 'update');
379 380 381 382 383 384 385 386 387 388 389
}

/**
 * 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.
 */
390
function content_translation_delete_access(EntityInterface $entity, Language $language = NULL) {
391
  $language = !empty($language) ? $language : language(Language::TYPE_CONTENT);
392 393
  $translations = $entity->getTranslationLanguages();
  $languages = language_list();
394
  return isset($languages[$language->id]) && $language->id != $entity->getUntranslated()->language()->id && isset($translations[$language->id]) && content_translation_access($entity, 'delete');
395 396
}

397 398 399
/**
 * Implements hook_library_info().
 */
400 401 402 403
function content_translation_library_info() {
  $path = drupal_get_path('module', 'content_translation');
  $libraries['drupal.content_translation.admin'] = array(
    'title' => 'Content translation UI',
404
    'version' => \Drupal::VERSION,
405
    'js' => array(
406
      $path . '/content_translation.admin.js' => array(),
407 408
    ),
    'css' => array(
409
      $path . '/css/content_translation.admin.css' => array(),
410 411 412 413 414 415 416 417 418 419 420
    ),
    'dependencies' => array(
      array('system', 'jquery'),
      array('system', 'drupal'),
      array('system', 'jquery.once'),
    ),
  );

  return $libraries;
}

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

/**
 * 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.
 */
459 460
function content_translation_get_config($entity_type, $bundle, $setting) {
  $key = content_translation_get_config_key($entity_type, $bundle, $setting);
461
  return \Drupal::config('content_translation.settings')->get($key);
462 463 464 465 466 467 468 469 470 471 472 473 474 475
}

/**
 * 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.
 */
476 477
function content_translation_set_config($entity_type, $bundle, $setting, $value) {
  $key = content_translation_get_config_key($entity_type, $bundle, $setting);
478
  return \Drupal::config('content_translation.settings')->set($key, $value)->save();
479 480 481 482 483 484 485 486 487 488 489 490 491 492
}

/**
 * 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.
493 494
 *
 * @todo Move to \Drupal\content_translation\ContentTranslationManager.
495
 */
496
function content_translation_enabled($entity_type, $bundle = NULL) {
497 498
  $enabled = FALSE;

499
  if (\Drupal::service('content_translation.manager')->isSupported($entity_type)) {
500 501
    $bundles = !empty($bundle) ? array($bundle) : array_keys(entity_get_bundles($entity_type));
    foreach ($bundles as $bundle) {
502
      if (content_translation_get_config($entity_type, $bundle, 'enabled')) {
503 504 505
        $enabled = TRUE;
        break;
      }
506 507 508
    }
  }

509
  return $enabled;
510 511 512
}

/**
513
 * Content translation controller factory.
514 515 516 517
 *
 * @param string $entity_type
 *   The type of the entity being translated.
 *
518 519
 * @return \Drupal\content_translation\ContentTranslationControllerInterface
 *   An instance of the content translation controller interface.
520 521
 *
 * @todo Move to \Drupal\content_translation\ContentTranslationManager.
522
 */
523
function content_translation_controller($entity_type) {
524 525
  $entity_info = entity_get_info($entity_type);
  // @todo Throw an exception if the key is missing.
526
  return new $entity_info['controllers']['translation']($entity_type, $entity_info);
527 528 529 530 531 532 533 534 535
}

/**
 * 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;
536
 *   An instance of the content translation form interface or FALSE if not an
537
 *   entity form.
538 539
 *
 * @todo Move to \Drupal\content_translation\ContentTranslationManager.
540
 */
541
function content_translation_form_controller(array $form_state) {
542 543 544 545
  return isset($form_state['controller']) && $form_state['controller'] instanceof EntityFormControllerInterface ? $form_state['controller'] : FALSE;
}

/**
546
 * Checks whether a content translation is accessible.
547 548 549
 *
 * @param \Drupal\Core\Entity\EntityInterface $entity
 *   The entity to be accessed.
550 551 552 553 554 555
 * @param $op
 *   The operation to be performed on the translation. Possible values are:
 *   - "view"
 *   - "update"
 *   - "delete"
 *   - "create"
556 557 558
 *
 * @return
 *   TRUE if the current user is allowed to view the translation.
559 560
 *
 * @todo Move to \Drupal\content_translation\ContentTranslationManager.
561
 */
562 563
function content_translation_access(EntityInterface $entity, $op) {
  return content_translation_controller($entity->entityType())->getTranslationAccess($entity, $op) ;
564 565 566 567 568
}

/**
 * Implements hook_permission().
 */
569
function content_translation_permission() {
570
  $permission = array(
571
    'administer content translation' => array(
572
      'title' => t('Administer translation settings'),
573
      'description' => t('Configure translatability of entities and fields.'),
574
    ),
575
    'create content translations' => array(
576 577
      'title' => t('Create translations'),
    ),
578
    'update content translations' => array(
579 580
      'title' => t('Edit translations'),
    ),
581
    'delete content translations' => array(
582 583
      'title' => t('Delete translations'),
    ),
584 585 586 587 588
    'translate any entity' => array(
      'title' => t('Translate any entity'),
    ),
  );

589 590
  // Create a translate permission for each enabled entity type and (optionally)
  // bundle.
591
  foreach (entity_get_info() as $entity_type => $info) {
592 593 594 595 596 597
    if (!empty($info['permission_granularity'])) {
      $t_args = array('@entity_label' => drupal_strtolower(t($info['label'])));

      switch ($info['permission_granularity']) {
        case 'bundle':
          foreach (entity_get_bundles($entity_type) as $bundle => $bundle_info) {
598
            if (content_translation_enabled($entity_type, $bundle)) {
599
              $t_args['%bundle_label'] = isset($bundle_info['label']) ? $bundle_info['label'] : $bundle;
600
              $permission["translate $bundle $entity_type"] = array(
601
                'title' => t('Translate %bundle_label @entity_label', $t_args),
602 603 604 605 606 607
              );
            }
          }
          break;

        case 'entity_type':
608
          if (content_translation_enabled($entity_type)) {
609 610 611 612 613 614
            $permission["translate $entity_type"] = array(
              'title' => t('Translate @entity_label', $t_args),
            );
          }
          break;
      }
615 616 617 618 619 620 621 622 623
    }
  }

  return $permission;
}

/**
 * Implements hook_form_alter().
 */
624
function content_translation_form_alter(array &$form, array &$form_state) {
625 626 627 628
  $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) {
629
    $controller = content_translation_controller($entity->entityType());
630 631 632 633 634 635 636 637 638 639
    $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)) {
640 641 642
      foreach ($entity->getPropertyDefinitions() as $property_name => $definition) {
        if (isset($form[$property_name])) {
          $form[$property_name]['#multilingual'] = !empty($definition['translatable']);
643 644 645 646 647 648 649
        }
      }
    }

  }
}

650
/**
651
 * Implements hook_language_fallback_candidates_OPERATION_alter().
652 653 654
 *
 * Performs language fallback for unaccessible translations.
 */
655 656 657 658 659
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]);
660 661 662 663
    }
  }
}

664 665 666
/**
 * Implements hook_entity_load().
 */
667
function content_translation_entity_load(array $entities, $entity_type) {
668 669
  $enabled_entities = array();

670
  if (content_translation_enabled($entity_type)) {
671
    foreach ($entities as $entity) {
672
      if ($entity instanceof ContentEntityInterface && $entity->isTranslatable()) {
673 674 675 676 677 678
        $enabled_entities[$entity->id()] = $entity;
      }
    }
  }

  if (!empty($enabled_entities)) {
679
    content_translation_load_translation_metadata($enabled_entities, $entity_type);
680 681 682 683 684 685 686 687 688 689 690
  }
}

/**
 * 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.
 */
691 692
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)';
693
  $result = db_query($query, array(':entity_type' => $entity_type, ':entity_id' => array_keys($entities)));
694
  $exclude = array('entity_type', 'entity_id', 'langcode');
695 696 697
  foreach ($result as $record) {
    $entity = $entities[$record->entity_id];
    // @todo Declare these as entity (translation?) properties.
698 699
    foreach ($record as $field_name => $value) {
      if (!in_array($field_name, $exclude)) {
700 701 702 703 704
        $langcode = $record->langcode;
        $entity->translation[$langcode][$field_name] = $value;
        if (!$entity->hasTranslation($langcode)) {
          $entity->initTranslation($langcode);
        }
705 706
      }
    }
707 708 709 710 711 712
  }
}

/**
 * Implements hook_entity_insert().
 */
713
function content_translation_entity_insert(EntityInterface $entity) {
714
  // Only do something if translation support for the given entity is enabled.
715
  if (!($entity instanceof ContentEntityInterface) || !$entity->isTranslatable()) {
716 717 718
    return;
  }

719
  $fields = array('entity_type', 'entity_id', 'langcode', 'source', 'outdated', 'uid', 'status', 'created', 'changed');
720
  $query = db_insert('content_translation')->fields($fields);
721 722

  foreach ($entity->getTranslationLanguages() as $langcode => $language) {
723 724 725 726
    $translation = isset($entity->translation[$langcode]) ? $entity->translation[$langcode] : array();

    $translation += array(
      'source' => '',
727
      'uid' => $GLOBALS['user']->id(),
728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744
      '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);
745 746 747 748 749 750 751 752
  }

  $query->execute();
}

/**
 * Implements hook_entity_delete().
 */
753
function content_translation_entity_delete(EntityInterface $entity) {
754
  // Only do something if translation support for the given entity is enabled.
755
  if (!($entity instanceof ContentEntityInterface) || !$entity->isTranslatable()) {
756 757 758
    return;
  }

759
  db_delete('content_translation')
760 761 762 763 764 765 766 767
    ->condition('entity_type', $entity->entityType())
    ->condition('entity_id', $entity->id())
    ->execute();
}

/**
 * Implements hook_entity_update().
 */
768
function content_translation_entity_update(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
  // Delete and create to ensure no stale value remains behind.
775 776
  content_translation_entity_delete($entity);
  content_translation_entity_insert($entity);
777 778 779 780 781
}

/**
 * Implements hook_field_extra_fields().
 */
782
function content_translation_field_extra_fields() {
783 784 785
  $extra = array();

  foreach (entity_get_info() as $entity_type => $info) {
786
    foreach (entity_get_bundles($entity_type) as $bundle => $bundle_info) {
787
      if (content_translation_enabled($entity_type, $bundle)) {
788 789 790 791 792 793 794 795 796 797 798 799 800
        $extra[$entity_type][$bundle]['form']['translation'] = array(
          'label' => t('Translation'),
          'description' => t('Translation settings'),
          'weight' => 10,
        );
      }
    }
  }

  return $extra;
}

/**
801
 * Implements hook_form_FORM_ID_alter() for 'field_ui_field_edit_form'.
802
 */
803
function content_translation_form_field_ui_field_edit_form_alter(array &$form, array &$form_state, $form_id) {
804
  $field = $form['#field'];
805 806 807
  $field_name = $field->getFieldName();
  $translatable = $field->isFieldTranslatable();
  $entity_type = $field->entity_type;
808
  $label = t('Field translation');
809

810
  if ($field->hasData()) {
811
    $form['field']['translatable'] = array(
812 813 814
      '#type' => 'item',
      '#title' => $label,
      '#attributes' => array('class' => 'translatable'),
815 816
      'link' => array(
        '#type' => 'link',
817 818
        '#prefix' => t('This field has data in existing content.') . ' ',
        '#title' => !$translatable ? t('Enable translation') : t('Disable translation'),
819
        '#href' => "admin/config/regional/content_translation/translatable/$entity_type/$field_name",
820
        '#options' => array('query' => drupal_get_destination()),
821
        '#access' => user_access('administer content translation'),
822 823 824 825 826 827
      ),
    );
  }
  else {
    $form['field']['translatable'] = array(
      '#type' => 'checkbox',
828
      '#title' => t('Users may translate this field.'),
829 830 831
      '#default_value' => $translatable,
    );
  }
832 833

  $form['field']['translatable']['#weight'] = 20;
834 835
}

836
/**
837
 * Implements hook_form_FORM_ID_alter() for 'field_ui_field_instance_edit_form'.
838
 */
839
function content_translation_form_field_ui_field_instance_edit_form_alter(array &$form, array &$form_state, $form_id) {
840
  if ($form['#field']->isFieldTranslatable()) {
841
    module_load_include('inc', 'content_translation', 'content_translation.admin');
842
    $element = content_translation_field_sync_widget($form['#field']);
843 844 845 846 847 848 849 850 851
    if ($element) {
      $form['instance']['settings']['translation_sync'] = $element;
    }
  }
}

/**
 * Implements hook_field_info_alter().
 */
852
function content_translation_field_info_alter(&$info) {
853 854 855 856 857 858 859 860 861
  foreach ($info as $field_type => &$field_type_info) {
    // 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);
  }
}

/**
862
 * Implements hook_entity_presave().
863
 */
864
function content_translation_entity_presave(EntityInterface $entity) {
865
  if ($entity instanceof ContentEntityInterface && $entity->isTranslatable()) {
866 867
    // @todo Avoid using request attributes once translation metadata become
    //   regular fields.
868 869
    $attributes = \Drupal::request()->attributes;
    \Drupal::service('content_translation.synchronizer')->synchronizeFields($entity, $entity->language()->id, $attributes->get('source_langcode'));
870 871 872
  }
}

873 874 875
/**
 * Implements hook_element_info_alter().
 */
876
function content_translation_element_info_alter(&$type) {
877
  if (isset($type['language_configuration'])) {
878
    $type['language_configuration']['#process'][] = 'content_translation_language_configuration_element_process';
879 880
  }
}
881

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

/**
 * Process callback: Expands the language_configuration form element.
 *
 * @param array $element
 *   Form API element.
 *
 * @return
 *   Processed language configuration element.
 */
919 920 921
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'];
922
    $context = $form_state['language'][$element['#name']];
923

924
    $element['content_translation'] = array(
925 926
      '#type' => 'checkbox',
      '#title' => t('Enable translation'),
927 928
      '#default_value' => content_translation_enabled($context['entity_type'], $context['bundle']),
      '#element_validate' => array('content_translation_language_configuration_element_validate'),
929 930
      '#prefix' => '<label>' . t('Translation') . '</label>',
    );
931

932
    $form['actions']['submit']['#submit'][] = 'content_translation_language_configuration_element_submit';
933
  }
934 935 936 937
  return $element;
}

/**
938
 * Form validation handler for element added with content_translation_language_configuration_element_process().