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

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

use Drupal\Core\Language\Language;
9
use Drupal\Core\Session\AccountInterface;
10 11 12 13 14 15 16
use Drupal\Core\Entity\EntityFormControllerInterface;
use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Entity\EntityNG;

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

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

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

63 64 65
/**
 * Implements hook_language_type_info_alter().
 */
66
function content_translation_language_types_info_alter(array &$language_types) {
67 68
  // Make content language negotiation configurable by removing its predefined
  // configuration.
69
  unset($language_types[Language::TYPE_CONTENT]['fixed']);
70 71 72 73 74
}

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

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

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

92 93 94 95 96
    // 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;
97 98
    }

99
    $path = $info['menu_base_path'];
100

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

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

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

/**
 * Implements hook_menu().
 */
130
function content_translation_menu() {
131 132 133 134 135
  $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.
136
    if (content_translation_enabled($entity_type)) {
137 138 139
      $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'));
140
      $menu_info = array_intersect_key($info['translation']['content_translation'], $keys) + array('file' => 'content_translation.pages.inc');
141 142 143 144 145 146 147 148 149
      $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(
150
        'title' => 'Translate',
151
        'page callback' => 'content_translation_overview',
152 153
        'page arguments' => array($entity_position),
        'type' => MENU_LOCAL_TASK,
154
        'context' => MENU_CONTEXT_PAGE | MENU_CONTEXT_INLINE,
155 156 157
        'weight' => 2,
      ) + $item;

158 159 160 161 162 163
      $items["$path/translations/overview"] = array(
        'title' => 'Overview',
        'type' => MENU_DEFAULT_LOCAL_TASK,
        'weight' => 0,
      );

164 165 166 167 168
      // 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);
169
      $items["$path/translations/add/%language/%language"] = array(
170
        'title' => 'Add',
171
        'page callback' => 'content_translation_add_page',
172
        'page arguments' => $args,
173
        'access callback' => 'content_translation_add_access',
174
        'access arguments' => $args,
175 176 177 178 179 180 181 182
        'type' => MENU_LOCAL_TASK,
        'weight' => 1,
      ) + $item;

      // Edit translation callback.
      $args = array($entity_position, $language_position);
      $items["$path/translations/edit/%language"] = array(
        'title' => 'Edit',
183
        'page callback' => 'content_translation_edit_page',
184
        'page arguments' => $args,
185
        'access callback' => 'content_translation_edit_access',
186 187 188
        'access arguments' => $args,
        'type' => MENU_LOCAL_TASK,
        'weight' => 1,
189 190 191 192 193 194
      ) + $item;

      // Delete translation callback.
      $items["$path/translations/delete/%language"] = array(
        'title' => 'Delete',
        'page callback' => 'drupal_get_form',
195 196
        'page arguments' => array('content_translation_delete_confirm', $entity_position, $language_position),
        'access callback' => 'content_translation_delete_access',
197
        'access arguments' => $args,
198 199 200 201
      ) + $item;
    }
  }

202
  $items['admin/config/regional/content_translation/translatable/%'] = array(
203 204 205
    'title' => 'Confirm change in translatability.',
    'description' => 'Confirm page for changing field translatability.',
    'page callback' => 'drupal_get_form',
206 207 208
    'page arguments' => array('content_translation_translatable_form', 5),
    'access arguments' => array('administer content translation'),
    'file' => 'content_translation.admin.inc',
209 210 211 212 213 214 215 216
  );

  return $items;
}

/**
 * Implements hook_menu_alter().
 */
217
function content_translation_menu_alter(array &$items) {
218 219
  // Check that the declared menu base paths are actually valid.
  foreach (entity_get_info() as $entity_type => $info) {
220
    if (content_translation_enabled($entity_type)) {
221 222
      $path = $info['menu_base_path'];

223 224 225 226
      // 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().
227
      if (!isset($items[$path]) && !isset($items["$path/edit"])
228
          && !isset($items[_content_translation_menu_strip_loaders($path)])) {
229 230
        unset(
          $items["$path/translations"],
231
          $items["$path/translations/add/%language/%language"],
232 233
          $items["$path/translations/delete/%language"]
        );
234
        $t_args = array('@entity_type' => isset($info['label']) ? $info['label'] : $entity_type);
235
        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);
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260
      }
      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;
          }
        }
      }
    }
  }
}

261 262 263 264 265 266 267 268 269
/**
 * 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 "%".
 */
270
function _content_translation_menu_strip_loaders($path) {
271 272 273
  return preg_replace('|%[^/]+|', '%', $path);
}

274 275 276 277 278 279
/**
 * Access callback for the translation overview page.
 *
 * @param \Drupal\Core\Entity\EntityInterface $entity
 *   The entity whose translation overview should be displayed.
 */
280
function content_translation_translate_access(EntityInterface $entity) {
281
  $entity_type = $entity->entityType();
282
  return empty($entity->getUntranslated()->language()->locked) && language_multilingual() && $entity->isTranslatable() &&
283
    (user_access('create content translations') || user_access('update content translations') || user_access('delete content translations'));
284 285
}

286 287 288 289 290 291 292
/**
 * 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.
293
 * @param \Drupal\Core\Session\AccountInterface $account
294 295 296
 *   (optional) The account for which view access should be checked. Defaults to
 *   the current user.
 */
297
function content_translation_view_access(EntityInterface $entity, $langcode, AccountInterface $account = NULL) {
298 299 300 301
  $entity_type = $entity->entityType();
  return !empty($entity->translation[$langcode]['status']) || user_access('translate any entity', $account) || user_access("translate $entity_type entities", $account);
}

302 303 304 305 306 307
/**
 * Access callback for the translation addition page.
 *
 * @param \Drupal\Core\Entity\EntityInterface $entity
 *   The entity being translated.
 * @param \Drupal\Core\Language\Language $source
308 309
 *   (optional) The language of the values being translated. Defaults to the
 *   entity language.
310
 * @param \Drupal\Core\Language\Language $target
311 312
 *   (optional) The language of the translated values. Defaults to the current
 *   content language.
313
 */
314
function content_translation_add_access(EntityInterface $entity, Language $source = NULL, Language $target = NULL) {
315
  $source = !empty($source) ? $source : $entity->language();
316
  $target = !empty($target) ? $target : language(Language::TYPE_CONTENT);
317 318
  $translations = $entity->getTranslationLanguages();
  $languages = language_list();
319
  return $source->id != $target->id && isset($languages[$source->id]) && isset($languages[$target->id]) && !isset($translations[$target->id]) && content_translation_access($entity, 'create');
320 321 322 323 324 325 326 327 328 329 330
}

/**
 * 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.
 */
331
function content_translation_edit_access(EntityInterface $entity, Language $language = NULL) {
332
  $language = !empty($language) ? $language : language(Language::TYPE_CONTENT);
333 334
  $translations = $entity->getTranslationLanguages();
  $languages = language_list();
335
  return isset($languages[$language->id]) && $language->id != $entity->getUntranslated()->language()->id && isset($translations[$language->id]) && content_translation_access($entity, 'update');
336 337 338 339 340 341 342 343 344 345 346
}

/**
 * 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.
 */
347
function content_translation_delete_access(EntityInterface $entity, Language $language = NULL) {
348
  $language = !empty($language) ? $language : language(Language::TYPE_CONTENT);
349 350
  $translations = $entity->getTranslationLanguages();
  $languages = language_list();
351
  return isset($languages[$language->id]) && $language->id != $entity->getUntranslated()->language()->id && isset($translations[$language->id]) && content_translation_access($entity, 'delete');
352 353
}

354 355 356
/**
 * Implements hook_library_info().
 */
357 358 359 360
function content_translation_library_info() {
  $path = drupal_get_path('module', 'content_translation');
  $libraries['drupal.content_translation.admin'] = array(
    'title' => 'Content translation UI',
361 362
    'version' => VERSION,
    'js' => array(
363
      $path . '/content_translation.admin.js' => array(),
364 365
    ),
    'css' => array(
366
      $path . '/css/content_translation.admin.css' => array(),
367 368 369 370 371 372 373 374 375 376 377
    ),
    'dependencies' => array(
      array('system', 'jquery'),
      array('system', 'drupal'),
      array('system', 'jquery.once'),
    ),
  );

  return $libraries;
}

378
/**
379
 * Returns the key name used to store the configuration setting.
380
 *
381 382
 * Based on the entity type and bundle, the keys used to store configuration
 * will have a common root name.
383 384 385 386 387 388 389 390 391
 *
 * @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
392
 *   The key name of the configuration setting.
393 394 395 396
 *
 * @todo Generalize this logic so that it is available to any module needing
 *   per-bundle configuration.
 */
397
function content_translation_get_config_key($entity_type, $bundle, $setting) {
398 399
  $entity_type = preg_replace('/[^0-9a-zA-Z_]/', "_", $entity_type);
  $bundle = preg_replace('/[^0-9a-zA-Z_]/', "_", $bundle);
400
  return $entity_type . '.' . $bundle . '.content_translation.' . $setting;
401 402 403 404 405 406 407 408 409 410 411 412 413 414 415
}

/**
 * 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.
 */
416 417 418
function content_translation_get_config($entity_type, $bundle, $setting) {
  $key = content_translation_get_config_key($entity_type, $bundle, $setting);
  return config('content_translation.settings')->get($key);
419 420 421 422 423 424 425 426 427 428 429 430 431 432
}

/**
 * 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.
 */
433 434 435
function content_translation_set_config($entity_type, $bundle, $setting, $value) {
  $key = content_translation_get_config_key($entity_type, $bundle, $setting);
  return config('content_translation.settings')->set($key, $value)->save();
436 437 438 439 440 441 442 443 444 445 446 447 448 449 450
}

/**
 * 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.
 */
451
function content_translation_enabled($entity_type, $bundle = NULL) {
452
  $enabled = FALSE;
453
  $info = entity_get_info($entity_type);
454

455 456 457
  if (!empty($info['translatable'])) {
    $bundles = !empty($bundle) ? array($bundle) : array_keys(entity_get_bundles($entity_type));
    foreach ($bundles as $bundle) {
458
      if (content_translation_get_config($entity_type, $bundle, 'enabled')) {
459 460 461
        $enabled = TRUE;
        break;
      }
462 463 464
    }
  }

465
  return $enabled;
466 467
}

468 469 470 471 472 473
/**
 * Returns all the translatable entity types.
 *
 * @return array
 *   An array of entity types keyed by entity type.
 */
474
function content_translation_types_translatable() {
475 476 477
  $entity_types = &drupal_static(__FUNCTION__, array());

  foreach (entity_get_info() as $entity_type => $info) {
478
    if (content_translation_enabled($entity_type)) {
479 480 481 482 483 484 485
      // 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.
486
      $path = _content_translation_menu_strip_loaders($info['menu_base_path']);
487 488 489 490 491 492 493 494 495
      if (!empty($items[$path]) && !empty($items[$path . '/translations'])) {
        $entity_types[$entity_type] = $entity_type;
      }
    }
  }

  return $entity_types;
}

496
/**
497
 * Content translation controller factory.
498 499 500 501
 *
 * @param string $entity_type
 *   The type of the entity being translated.
 *
502 503
 * @return \Drupal\content_translation\ContentTranslationControllerInterface
 *   An instance of the content translation controller interface.
504
 */
505
function content_translation_controller($entity_type) {
506 507
  $entity_info = entity_get_info($entity_type);
  // @todo Throw an exception if the key is missing.
508
  return new $entity_info['controllers']['translation']($entity_type, $entity_info);
509 510 511 512 513 514 515 516 517
}

/**
 * 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;
518
 *   An instance of the content translation form interface or FALSE if not an
519 520
 *   entity form.
 */
521
function content_translation_form_controller(array $form_state) {
522 523 524 525
  return isset($form_state['controller']) && $form_state['controller'] instanceof EntityFormControllerInterface ? $form_state['controller'] : FALSE;
}

/**
526
 * Checks whether a content translation is accessible.
527 528 529
 *
 * @param \Drupal\Core\Entity\EntityInterface $entity
 *   The entity to be accessed.
530 531 532 533 534 535
 * @param $op
 *   The operation to be performed on the translation. Possible values are:
 *   - "view"
 *   - "update"
 *   - "delete"
 *   - "create"
536 537 538 539
 *
 * @return
 *   TRUE if the current user is allowed to view the translation.
 */
540 541
function content_translation_access(EntityInterface $entity, $op) {
  return content_translation_controller($entity->entityType())->getTranslationAccess($entity, $op) ;
542 543 544 545 546
}

/**
 * Implements hook_permission().
 */
547
function content_translation_permission() {
548
  $permission = array(
549
    'administer content translation' => array(
550
      'title' => t('Administer translation settings'),
551
      'description' => t('Configure translatability of entities and fields.'),
552
    ),
553
    'create content translations' => array(
554 555
      'title' => t('Create translations'),
    ),
556
    'update content translations' => array(
557 558
      'title' => t('Edit translations'),
    ),
559
    'delete content translations' => array(
560 561
      'title' => t('Delete translations'),
    ),
562 563 564 565 566
    'translate any entity' => array(
      'title' => t('Translate any entity'),
    ),
  );

567 568
  // Create a translate permission for each enabled entity type and (optionally)
  // bundle.
569
  foreach (entity_get_info() as $entity_type => $info) {
570 571 572 573 574 575
    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) {
576
            if (content_translation_enabled($entity_type, $bundle)) {
577
              $t_args['%bundle_label'] = isset($bundle_info['label']) ? $bundle_info['label'] : $bundle;
578
              $permission["translate $bundle $entity_type"] = array(
579
                'title' => t('Translate %bundle_label @entity_label', $t_args),
580 581 582 583 584 585
              );
            }
          }
          break;

        case 'entity_type':
586
          if (content_translation_enabled($entity_type)) {
587 588 589 590 591 592
            $permission["translate $entity_type"] = array(
              'title' => t('Translate @entity_label', $t_args),
            );
          }
          break;
      }
593 594 595 596 597 598 599 600 601
    }
  }

  return $permission;
}

/**
 * Implements hook_form_alter().
 */
602 603 604
function content_translation_form_alter(array &$form, array &$form_state) {
  if (($form_controller = content_translation_form_controller($form_state)) && ($entity = $form_controller->getEntity()) && !$entity->isNew() && $entity->isTranslatable()) {
    $controller = content_translation_controller($entity->entityType());
605 606 607 608 609 610 611 612 613 614
    $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)) {
615
      $entity = $entity->getNGEntity();
616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634
      if ($entity instanceof EntityNG) {
        foreach ($entity->getPropertyDefinitions() as $property_name => $definition) {
          if (isset($form[$property_name])) {
            $form[$property_name]['#multilingual'] = !empty($definition['translatable']);
          }
        }
      }
      else {
        foreach (field_info_instances($entity->entityType(), $entity->bundle()) as $instance) {
          $field_name = $instance['field_name'];
          $field = field_info_field($field_name);
          $form[$field_name]['#multilingual'] = !empty($field['translatable']);
        }
      }
    }

  }
}

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

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

    foreach ($entity->translation as $langcode => $translation) {
651
      if ($langcode == $context['langcode'] || !content_translation_view_access($entity, $langcode)) {
652
        // Unset unaccessible field translations: if the field is untranslatable
653
        // unsetting a language different from Language::LANGCODE_NOT_SPECIFIED has no
654 655 656
        // effect.
        foreach ($instances as $instance) {
          // @todo BC entities have the same value accessibile both with the
657
          //   entity language and with Language::LANGCODE_DEFAULT. We need need to unset
658 659
          //   both until we remove the BC layer.
          if ($langcode == $entity_langcode) {
660
            unset($entity->{$instance['field_name']}[Language::LANGCODE_DEFAULT]);
661 662 663 664 665 666 667 668 669 670 671
          }
          unset($entity->{$instance['field_name']}[$langcode]);
        }
      }
    }

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

672 673 674
/**
 * Implements hook_entity_load().
 */
675
function content_translation_entity_load(array $entities, $entity_type) {
676 677
  $enabled_entities = array();

678
  if (content_translation_enabled($entity_type)) {
679
    foreach ($entities as $entity) {
680
      if ($entity->isTranslatable()) {
681 682 683 684 685 686
        $enabled_entities[$entity->id()] = $entity;
      }
    }
  }

  if (!empty($enabled_entities)) {
687
    content_translation_load_translation_metadata($enabled_entities, $entity_type);
688 689 690 691 692 693 694 695 696 697 698
  }
}

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

/**
 * Implements hook_entity_insert().
 */
721
function content_translation_entity_insert(EntityInterface $entity) {
722
  // Only do something if translation support for the given entity is enabled.
723
  if (!$entity->isTranslatable()) {
724 725 726
    return;
  }

727
  $fields = array('entity_type', 'entity_id', 'langcode', 'source', 'outdated', 'uid', 'status', 'created', 'changed');
728
  $query = db_insert('content_translation')->fields($fields);
729 730

  foreach ($entity->getTranslationLanguages() as $langcode => $language) {
731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752
    $translation = isset($entity->translation[$langcode]) ? $entity->translation[$langcode] : array();

    $translation += array(
      'source' => '',
      'uid' => $GLOBALS['user']->uid,
      '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);
753 754 755 756 757 758 759 760
  }

  $query->execute();
}

/**
 * Implements hook_entity_delete().
 */
761
function content_translation_entity_delete(EntityInterface $entity) {
762
  // Only do something if translation support for the given entity is enabled.
763
  if (!$entity->isTranslatable()) {
764 765 766
    return;
  }

767
  db_delete('content_translation')
768 769 770 771 772 773 774 775
    ->condition('entity_type', $entity->entityType())
    ->condition('entity_id', $entity->id())
    ->execute();
}

/**
 * Implements hook_entity_update().
 */
776
function content_translation_entity_update(EntityInterface $entity) {
777
  // Only do something if translation support for the given entity is enabled.
778
  if (!$entity->isTranslatable()) {
779 780 781
    return;
  }

782
  // Delete and create to ensure no stale value remains behind.
783 784
  content_translation_entity_delete($entity);
  content_translation_entity_insert($entity);
785 786 787 788 789
}

/**
 * Implements hook_field_extra_fields().
 */
790
function content_translation_field_extra_fields() {
791 792 793
  $extra = array();

  foreach (entity_get_info() as $entity_type => $info) {
794
    foreach (entity_get_bundles($entity_type) as $bundle => $bundle_info) {
795
      if (content_translation_enabled($entity_type, $bundle)) {
796 797 798 799 800 801 802 803 804 805 806 807 808
        $extra[$entity_type][$bundle]['form']['translation'] = array(
          'label' => t('Translation'),
          'description' => t('Translation settings'),
          'weight' => 10,
        );
      }
    }
  }

  return $extra;
}

/**
809
 * Implements hook_form_FORM_ID_alter() for 'field_ui_field_edit_form'.
810
 */
811
function content_translation_form_field_ui_field_edit_form_alter(array &$form, array &$form_state, $form_id) {
812 813 814
  $field = $form['#field'];
  $field_name = $field['field_name'];
  $translatable = $field['translatable'];
815
  $label = t('Field translation');
816

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

  $form['field']['translatable']['#weight'] = 20;
841 842
}

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

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

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

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

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

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

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

939
    $form['#submit'][] = 'content_translation_language_configuration_element_submit';
940
  }
941 942 943 944
  return $element;
}

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

/**
968
 * Form submission handler for element added with content_translation_language_configuration_element_process().
969
 *
970
 * Stores the content translation settings.
971
 *
972
 * @see content_translation_language_configuration_element_validate()
973
 */
974 975
function content_translation_language_configuration_element_submit(array $form, array &$form_state) {
  $key = $form_state['content_translation']['key'];
976
  $context = $form_state['language'][$key];
977
  $enabled = $form_state['values'][$key]['content_translation'];
978