content_translation.module 40.5 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
    if (empty($info['translatable'])) {
      continue;
    }

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

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

95 96 97 98 99
    // 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;
100 101
    }

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

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

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

118 119 120
/**
 * Implements hook_entity_bundle_info_alter().
 */
121
function content_translation_entity_bundle_info_alter(&$bundles) {
122 123
  foreach ($bundles as $entity_type => &$info) {
    foreach ($info as $bundle => &$bundle_info) {
124
      $enabled = content_translation_get_config($entity_type, $bundle, 'enabled');
125
      $bundle_info['translatable'] = !empty($enabled);
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 156
/**
 * 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;
        }
      }
    }
  }
}

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

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

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

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

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

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

  return $items;
}

/**
 * Implements hook_menu_alter().
 */
232
function content_translation_menu_alter(array &$items) {
233 234 235 236
  // 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.';

237 238
  // Check that the declared menu base paths are actually valid.
  foreach (entity_get_info() as $entity_type => $info) {
239
    if (content_translation_enabled($entity_type)) {
240 241
      $path = $info['menu_base_path'];

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

280 281 282 283 284 285 286 287 288
/**
 * 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);
}

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

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

313 314 315 316 317 318 319
/**
 * 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.
320
 * @param \Drupal\Core\Session\AccountInterface $account
321 322 323
 *   (optional) The account for which view access should be checked. Defaults to
 *   the current user.
 */
324
function content_translation_view_access(EntityInterface $entity, $langcode, AccountInterface $account = NULL) {
325
  $entity_type = $entity->entityType();
326
  return !empty($entity->translation[$langcode]['status']) || user_access('translate any entity', $account) || user_access("translate $entity_type entities", $account);
327 328
}

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

/**
 * 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.
 */
358
function content_translation_edit_access(EntityInterface $entity, Language $language = NULL) {
359
  $language = !empty($language) ? $language : language(Language::TYPE_CONTENT);
360 361
  $translations = $entity->getTranslationLanguages();
  $languages = language_list();
362
  return isset($languages[$language->id]) && $language->id != $entity->getUntranslated()->language()->id && isset($translations[$language->id]) && content_translation_access($entity, 'update');
363 364 365 366 367 368 369 370 371 372 373
}

/**
 * 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.
 */
374
function content_translation_delete_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, 'delete');
379 380
}

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

  return $libraries;
}

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

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

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

/**
 * 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.
 */
478
function content_translation_enabled($entity_type, $bundle = NULL) {
479
  $enabled = FALSE;
480
  $info = entity_get_info($entity_type);
481

482 483 484
  if (!empty($info['translatable'])) {
    $bundles = !empty($bundle) ? array($bundle) : array_keys(entity_get_bundles($entity_type));
    foreach ($bundles as $bundle) {
485
      if (content_translation_get_config($entity_type, $bundle, 'enabled')) {
486 487 488
        $enabled = TRUE;
        break;
      }
489 490 491
    }
  }

492
  return $enabled;
493 494
}

495 496 497 498 499 500
/**
 * Returns all the translatable entity types.
 *
 * @return array
 *   An array of entity types keyed by entity type.
 */
501
function content_translation_types_translatable() {
502 503 504
  $entity_types = &drupal_static(__FUNCTION__, array());

  foreach (entity_get_info() as $entity_type => $info) {
505
    if (content_translation_enabled($entity_type)) {
506 507 508 509 510 511 512
      // 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.
513
      $path = _content_translation_menu_strip_loaders($info['menu_base_path']);
514 515 516 517 518 519 520 521 522
      if (!empty($items[$path]) && !empty($items[$path . '/translations'])) {
        $entity_types[$entity_type] = $entity_type;
      }
    }
  }

  return $entity_types;
}

523
/**
524
 * Content translation controller factory.
525 526 527 528
 *
 * @param string $entity_type
 *   The type of the entity being translated.
 *
529 530
 * @return \Drupal\content_translation\ContentTranslationControllerInterface
 *   An instance of the content translation controller interface.
531
 */
532
function content_translation_controller($entity_type) {
533 534
  $entity_info = entity_get_info($entity_type);
  // @todo Throw an exception if the key is missing.
535
  return new $entity_info['controllers']['translation']($entity_type, $entity_info);
536 537 538 539 540 541 542 543 544
}

/**
 * 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;
545
 *   An instance of the content translation form interface or FALSE if not an
546 547
 *   entity form.
 */
548
function content_translation_form_controller(array $form_state) {
549 550 551 552
  return isset($form_state['controller']) && $form_state['controller'] instanceof EntityFormControllerInterface ? $form_state['controller'] : FALSE;
}

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

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

594 595
  // Create a translate permission for each enabled entity type and (optionally)
  // bundle.
596
  foreach (entity_get_info() as $entity_type => $info) {
597 598 599 600 601 602
    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) {
603
            if (content_translation_enabled($entity_type, $bundle)) {
604
              $t_args['%bundle_label'] = isset($bundle_info['label']) ? $bundle_info['label'] : $bundle;
605
              $permission["translate $bundle $entity_type"] = array(
606
                'title' => t('Translate %bundle_label @entity_label', $t_args),
607 608 609 610 611 612
              );
            }
          }
          break;

        case 'entity_type':
613
          if (content_translation_enabled($entity_type)) {
614 615 616 617 618 619
            $permission["translate $entity_type"] = array(
              'title' => t('Translate @entity_label', $t_args),
            );
          }
          break;
      }
620 621 622 623 624 625 626 627 628
    }
  }

  return $permission;
}

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

  }
}

652
/**
653
 * Implements hook_field_language_alter().
654 655 656
 *
 * Performs language fallback for unaccessible translations.
 */
657 658 659 660 661 662 663 664 665 666 667 668 669 670
function content_translation_field_language_alter(&$display_language, $context) {
  $entity = $context['entity'];
  $entity_type = $entity->entityType();

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

    foreach ($entity->translation as $langcode => $translation) {
      if ($langcode == $context['langcode'] || !content_translation_view_access($entity, $langcode)) {
        $entity->removeTranslation($langcode);
      }
671
    }
672 673 674

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

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

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

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

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

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

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

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

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

  $query->execute();
}

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

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

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

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

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

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

  return $extra;
}

/**
815
 * Implements hook_form_FORM_ID_alter() for 'field_ui_field_edit_form'.
816
 */
817
function content_translation_form_field_ui_field_edit_form_alter(array &$form, array &$form_state, $form_id) {
818
  $field = $form['#field'];
819 820 821
  $field_name = $field->getFieldName();
  $translatable = $field->isFieldTranslatable();
  $entity_type = $field->entity_type;
822
  $label = t('Field translation');
823

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

  $form['field']['translatable']['#weight'] = 20;
848 849
}

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

/**
 * Implements hook_field_info_alter().
 */
866
function content_translation_field_info_alter(&$info) {
867 868 869 870 871 872 873 874 875
  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);
  }
}

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

887 888 889
/**
 * Implements hook_element_info_alter().
 */
890
function content_translation_element_info_alter(&$type) {
891
  if (isset($type['language_configuration'])) {
892
    $type['language_configuration']['#process'][] = 'content_translation_language_configuration_element_process';
893 894
  }
}
895

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

/**
 * Process callback: Expands the language_configuration form element.
 *
 * @param array $element
 *   Form API element.
 *
 * @return
 *   Processed language configuration element.
 */
933 934 935
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'];
936
    $context = $form_state['language'][$element['#name']];
937

938
    $element['content_translation'] = array(
939 940
      '#type' => 'checkbox',
      '#title' => t('Enable translation'),
941 942
      '#default_value' => content_translation_enabled($context['entity_type'], $context['bundle']),
      '#element_validate' => array('content_translation_language_configuration_element_validate'),
943 944
      '#prefix' => '<label>' . t('Translation') . '</label>',
    );
945

946
    $form['actions']['submit']['#submit'][] = 'content_translation_language_configuration_element_submit';
947
  }
948 949 950 951
  return $element;
}

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

/**
975
 * Form submission handler for element added with content_translation_language_configuration_element_process().
976
 *
977
 * Stores the content translation settings.
978