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

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

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

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

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

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

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

/**
 * Implements hook_entity_info_alter().
 */
77
function content_translation_entity_info_alter(array &$entity_info) {
78 79
  // Provide defaults for translation info.
  foreach ($entity_info as $entity_type => &$info) {
80 81 82 83
    if (empty($info['translatable'])) {
      continue;
    }

84 85
    if (!isset($info['translation']['content_translation'])) {
      $info['translation']['content_translation'] = array();
86 87 88 89 90 91
    }

    // 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.
92
    $info['controllers'] += array('translation' => 'Drupal\content_translation\ContentTranslationController');
93

94 95 96 97 98
    // If no menu base path is provided we default to the usual
    // "entity_type/%entity_type" pattern.
    if (!isset($info['menu_base_path'])) {
      $path = "$entity_type/%$entity_type";
      $info['menu_base_path'] = $path;
99 100
    }

101
    $path = $info['menu_base_path'];
102

103 104 105 106 107
    $info += array(
      'menu_view_path' => $path,
      'menu_edit_path' => "$path/edit",
      'menu_path_wildcard' => "%$entity_type",
    );
108

109
    $entity_position = count(explode('/', $path)) - 1;
110 111
    $info['translation']['content_translation'] += array(
      'access_callback' => 'content_translation_translate_access',
112 113 114 115
      'access_arguments' => array($entity_position),
    );
  }
}
116

117 118 119
/**
 * Implements hook_entity_bundle_info_alter().
 */
120
function content_translation_entity_bundle_info_alter(&$bundles) {
121 122
  foreach ($bundles as $entity_type => &$info) {
    foreach ($info as $bundle => &$bundle_info) {
123
      $enabled = content_translation_get_config($entity_type, $bundle, 'enabled');
124
      $bundle_info['translatable'] = !empty($enabled);
125 126 127 128
    }
  }
}

129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155
/**
 * 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;
        }
      }
    }
  }
}

156 157 158
/**
 * Implements hook_menu().
 */
159
function content_translation_menu() {
160 161 162 163 164
  $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.
165
    if (content_translation_enabled($entity_type)) {
166 167 168
      $path = $info['menu_base_path'];
      $entity_position = count(explode('/', $path)) - 1;
      $keys = array_flip(array('theme_callback', 'theme_arguments', 'access_callback', 'access_arguments', 'load_arguments'));
169
      $menu_info = array_intersect_key($info['translation']['content_translation'], $keys) + array('file' => 'content_translation.pages.inc');
170 171 172 173 174 175 176 177 178
      $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(
179
        'title' => 'Translate',
180
        'route_name' => "content_translation.translation_overview_$entity_type",
181
        'type' => MENU_LOCAL_TASK,
182
        'context' => MENU_CONTEXT_PAGE | MENU_CONTEXT_INLINE,
183 184 185
        'weight' => 2,
      ) + $item;

186 187 188 189 190 191
      $items["$path/translations/overview"] = array(
        'title' => 'Overview',
        'type' => MENU_DEFAULT_LOCAL_TASK,
        'weight' => 0,
      );

192 193 194 195 196
      // 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);
197
      $items["$path/translations/add/%language/%language"] = array(
198
        'title' => 'Add',
199
        'route_name' => "content_translation.translation_add_$entity_type",
200
        'weight' => 1,
201
      );
202 203 204 205 206

      // Edit translation callback.
      $args = array($entity_position, $language_position);
      $items["$path/translations/edit/%language"] = array(
        'title' => 'Edit',
207
        'route_name' => "content_translation.translation_edit_$entity_type",
208
        'weight' => 1,
209
      );
210 211 212 213

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

219
  $items['admin/config/regional/content_translation/translatable/%/%'] = array(
220 221
    'title' => 'Confirm change in translatability.',
    'description' => 'Confirm page for changing field translatability.',
222
    'route_name' => 'content_translation.translatable',
223 224 225 226 227 228 229 230
  );

  return $items;
}

/**
 * Implements hook_menu_alter().
 */
231
function content_translation_menu_alter(array &$items) {
232 233
  // Check that the declared menu base paths are actually valid.
  foreach (entity_get_info() as $entity_type => $info) {
234
    if (content_translation_enabled($entity_type)) {
235 236
      $path = $info['menu_base_path'];

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

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

275 276 277 278 279 280 281 282 283
/**
 * 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 "%".
 */
284
function _content_translation_menu_strip_loaders($path) {
285 286 287
  return preg_replace('|%[^/]+|', '%', $path);
}

288 289 290 291 292 293
/**
 * Access callback for the translation overview page.
 *
 * @param \Drupal\Core\Entity\EntityInterface $entity
 *   The entity whose translation overview should be displayed.
 */
294
function content_translation_translate_access(EntityInterface $entity) {
295
  return $entity instanceof ContentEntityInterface && empty($entity->getUntranslated()->language()->locked) && language_multilingual() && $entity->isTranslatable() &&
296
    (user_access('create content translations') || user_access('update content translations') || user_access('delete content translations'));
297 298
}

299 300 301 302 303 304 305
/**
 * 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.
306
 * @param \Drupal\Core\Session\AccountInterface $account
307 308 309
 *   (optional) The account for which view access should be checked. Defaults to
 *   the current user.
 */
310
function content_translation_view_access(EntityInterface $entity, $langcode, AccountInterface $account = NULL) {
311 312 313 314
  $entity_type = $entity->entityType();
  return !empty($entity->translation[$langcode]['status']) || user_access('translate any entity', $account) || user_access("translate $entity_type entities", $account);
}

315 316 317 318 319 320
/**
 * Access callback for the translation addition page.
 *
 * @param \Drupal\Core\Entity\EntityInterface $entity
 *   The entity being translated.
 * @param \Drupal\Core\Language\Language $source
321 322
 *   (optional) The language of the values being translated. Defaults to the
 *   entity language.
323
 * @param \Drupal\Core\Language\Language $target
324 325
 *   (optional) The language of the translated values. Defaults to the current
 *   content language.
326
 */
327
function content_translation_add_access(EntityInterface $entity, Language $source = NULL, Language $target = NULL) {
328
  $source = !empty($source) ? $source : $entity->language();
329
  $target = !empty($target) ? $target : language(Language::TYPE_CONTENT);
330 331
  $translations = $entity->getTranslationLanguages();
  $languages = language_list();
332
  return $source->id != $target->id && isset($languages[$source->id]) && isset($languages[$target->id]) && !isset($translations[$target->id]) && content_translation_access($entity, 'create');
333 334 335 336 337 338 339 340 341 342 343
}

/**
 * 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.
 */
344
function content_translation_edit_access(EntityInterface $entity, Language $language = NULL) {
345
  $language = !empty($language) ? $language : language(Language::TYPE_CONTENT);
346 347
  $translations = $entity->getTranslationLanguages();
  $languages = language_list();
348
  return isset($languages[$language->id]) && $language->id != $entity->getUntranslated()->language()->id && isset($translations[$language->id]) && content_translation_access($entity, 'update');
349 350 351 352 353 354 355 356 357 358 359
}

/**
 * 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.
 */
360
function content_translation_delete_access(EntityInterface $entity, Language $language = NULL) {
361
  $language = !empty($language) ? $language : language(Language::TYPE_CONTENT);
362 363
  $translations = $entity->getTranslationLanguages();
  $languages = language_list();
364
  return isset($languages[$language->id]) && $language->id != $entity->getUntranslated()->language()->id && isset($translations[$language->id]) && content_translation_access($entity, 'delete');
365 366
}

367 368 369
/**
 * Implements hook_library_info().
 */
370 371 372 373
function content_translation_library_info() {
  $path = drupal_get_path('module', 'content_translation');
  $libraries['drupal.content_translation.admin'] = array(
    'title' => 'Content translation UI',
374
    'version' => \Drupal::VERSION,
375
    'js' => array(
376
      $path . '/content_translation.admin.js' => array(),
377 378
    ),
    'css' => array(
379
      $path . '/css/content_translation.admin.css' => array(),
380 381 382 383 384 385 386 387 388 389 390
    ),
    'dependencies' => array(
      array('system', 'jquery'),
      array('system', 'drupal'),
      array('system', 'jquery.once'),
    ),
  );

  return $libraries;
}

391
/**
392
 * Returns the key name used to store the configuration setting.
393
 *
394 395
 * Based on the entity type and bundle, the keys used to store configuration
 * will have a common root name.
396 397 398 399 400 401 402 403 404
 *
 * @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
405
 *   The key name of the configuration setting.
406 407 408 409
 *
 * @todo Generalize this logic so that it is available to any module needing
 *   per-bundle configuration.
 */
410
function content_translation_get_config_key($entity_type, $bundle, $setting) {
411 412
  $entity_type = preg_replace('/[^0-9a-zA-Z_]/', "_", $entity_type);
  $bundle = preg_replace('/[^0-9a-zA-Z_]/', "_", $bundle);
413
  return $entity_type . '.' . $bundle . '.content_translation.' . $setting;
414 415 416 417 418 419 420 421 422 423 424 425 426 427 428
}

/**
 * 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.
 */
429 430
function content_translation_get_config($entity_type, $bundle, $setting) {
  $key = content_translation_get_config_key($entity_type, $bundle, $setting);
431
  return \Drupal::config('content_translation.settings')->get($key);
432 433 434 435 436 437 438 439 440 441 442 443 444 445
}

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

/**
 * 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.
 */
464
function content_translation_enabled($entity_type, $bundle = NULL) {
465
  $enabled = FALSE;
466
  $info = entity_get_info($entity_type);
467

468 469 470
  if (!empty($info['translatable'])) {
    $bundles = !empty($bundle) ? array($bundle) : array_keys(entity_get_bundles($entity_type));
    foreach ($bundles as $bundle) {
471
      if (content_translation_get_config($entity_type, $bundle, 'enabled')) {
472 473 474
        $enabled = TRUE;
        break;
      }
475 476 477
    }
  }

478
  return $enabled;
479 480
}

481 482 483 484 485 486
/**
 * Returns all the translatable entity types.
 *
 * @return array
 *   An array of entity types keyed by entity type.
 */
487
function content_translation_types_translatable() {
488 489 490
  $entity_types = &drupal_static(__FUNCTION__, array());

  foreach (entity_get_info() as $entity_type => $info) {
491
    if (content_translation_enabled($entity_type)) {
492 493 494 495 496 497 498
      // Lazy load router items.
      if (!isset($items)) {
        $items = menu_get_router();
      }
      // Check whether the required paths are defined. We need to strip out the
      // menu loader and replace it with a plain "%" as router items have no
      // menu loader in them.
499
      $path = _content_translation_menu_strip_loaders($info['menu_base_path']);
500 501 502 503 504 505 506 507 508
      if (!empty($items[$path]) && !empty($items[$path . '/translations'])) {
        $entity_types[$entity_type] = $entity_type;
      }
    }
  }

  return $entity_types;
}

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

/**
 * 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;
531
 *   An instance of the content translation form interface or FALSE if not an
532 533
 *   entity form.
 */
534
function content_translation_form_controller(array $form_state) {
535 536 537 538
  return isset($form_state['controller']) && $form_state['controller'] instanceof EntityFormControllerInterface ? $form_state['controller'] : FALSE;
}

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

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

580 581
  // Create a translate permission for each enabled entity type and (optionally)
  // bundle.
582
  foreach (entity_get_info() as $entity_type => $info) {
583 584 585 586 587 588
    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) {
589
            if (content_translation_enabled($entity_type, $bundle)) {
590
              $t_args['%bundle_label'] = isset($bundle_info['label']) ? $bundle_info['label'] : $bundle;
591
              $permission["translate $bundle $entity_type"] = array(
592
                'title' => t('Translate %bundle_label @entity_label', $t_args),
593 594 595 596 597 598
              );
            }
          }
          break;

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

  return $permission;
}

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

  }
}

638 639 640 641 642
/**
 * Implements hook_field_language_alter().
 *
 * Performs language fallback for unaccessible translations.
 */
643
function content_translation_field_language_alter(&$display_language, $context) {
644 645 646
  $entity = $context['entity'];
  $entity_type = $entity->entityType();

647
  if ($entity instanceof ContentEntityInterface && isset($entity->translation[$context['langcode']]) && $entity->isTranslatable() && !content_translation_view_access($entity, $context['langcode'])) {
648 649 650
    $instances = field_info_instances($entity_type, $entity->bundle());
    // Avoid altering the real entity.
    $entity = clone($entity);
651
    $entity_langcode = $entity->getUntranslated()->language()->id;
652 653

    foreach ($entity->translation as $langcode => $translation) {
654
      if ($langcode == $context['langcode'] || !content_translation_view_access($entity, $langcode)) {
655
        $entity->removeTranslation($langcode);
656 657 658 659 660 661 662 663
      }
    }

    // Find the new fallback values.
    field_language_fallback($display_language, $entity, $context['langcode']);
  }
}

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().
939 940 941 942 943
 *
 * 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.
 *
944