content_translation.module 39.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
use Drupal\node\NodeInterface;
16 17 18 19

/**
 * Implements hook_help().
 */
20
function content_translation_help($path, $arg) {
21
  switch ($path) {
22
    case 'admin/help#content_translation':
23 24
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
25
      $output .= '<p>' . t('The Content Translation module allows you to create and manage translations for your Drupal site content. You can specify which elements need to be translated at the content-type level for content items and comments, at the vocabulary level for taxonomy terms, and at the site level for user accounts. Other modules may provide additional elements that can be translated. For more information, see the online handbook entry for <a href="!url">Content Translation</a>.', array('!url' => 'http://drupal.org/documentation/modules/translation_entity')) . '</p>';
26 27 28
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
      $output .= '<dt>' . t('Enabling translation') . '</dt>';
29
      $output .= '<dd><p>' . t('Before you can translate content, there must be at least two languages added on the <a href="!url">languages administration</a> page.', array('!url' => url('admin/config/regional/language'))) . '</p>';
30
      $output .= '<p>' . t('After adding languages, <a href="!url">configure translation</a>.', array('!url' => url('admin/config/regional/content-language'))) . '</p>';
31
      $output .= '<dt>' . t('Translating content') . '</dt>';
32
      $output .= '<dd>' . t('After enabling translation you can create a new piece of content, or edit existing content and assign it a language. Then, you will see a <em>Translate</em> tab or link that will gives an overview of the translation status for the current content. From there, you can add translations and edit or delete existing translations. This process is similar for every translatable element on your site, such as taxonomy terms, comments or user accounts.') . '</dd>';
33 34 35 36 37
      $output .= '<dt>' . t('Changing source language') . '</dt>';
      $output .= '<dd>' . t('When there are two or more possible source languages, selecting a <em>Source language</em> will repopulate the form using the specified source\'s values. For example, French is much closer to Spanish than to Chinese, so changing the French translation\'s source language to Spanish can assist translators.') . '</dd>';
      $output .= '<dt>' . t('Maintaining translations') . '</dt>';
      $output .= '<dd>' . t('If editing content in one language requires that translated versions also be updated to reflect the change, use the <em>Flag other translations as outdated</em> check box to mark the translations as outdated and in need of revision.') . '</dd>';
      $output .= '<dt>' . t('Translation permissions') . '</dt>';
38
      $output .= '<dd>' . t('The Content Translation module makes a basic set of permissions available. Additional <a href="@permissions">permissions</a> are made available after translation is enabled for each translatable element.', array('@permissions' => url('admin/people/permissions', array('fragment' => 'module-content_translation')))) . '</dd>';
39 40
      $output .= '</dl>';
      return $output;
41 42 43 44

    case 'admin/config/regional/content-language':
      $output = '';
      if (!language_multilingual()) {
45
        $output .= '<br/>' . t('Before you can translate content, there must be at least two languages added on the <a href="!url">languages administration</a> page.', array('!url' => url('admin/config/regional/language')));
46 47
      }
      return $output;
48 49 50
  }
}

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

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

/**
 * Implements hook_entity_info_alter().
 */
79
function content_translation_entity_info_alter(array &$entity_info) {
80 81
  // Provide defaults for translation info.
  foreach ($entity_info as $entity_type => &$info) {
82 83 84 85 86 87
    if (!empty($info['translatable'])) {
      $info['controllers'] += array('translation' => 'Drupal\content_translation\ContentTranslationController');

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

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

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

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

141 142 143 144 145 146 147 148 149 150 151 152 153 154 155
/**
 * Implements hook_entity_operation_alter().
 */
function content_translation_entity_operation_alter(array &$operations, \Drupal\Core\Entity\EntityInterface $entity) {
  // @todo Use an access permission.
  if ($entity instanceof NodeInterface && $entity->isTranslatable()) {
    $uri = $entity->uri();
    $operations['translate'] = array(
      'title' => t('Translate'),
      'href' => $uri['path'] . '/translations',
      'options' => $uri['options'],
    );
  }
}

156 157
/**
 * Implements hook_menu().
158 159 160
 *
 * @todo Split this into route definition and menu link definition. See
 *   https://drupal.org/node/1987882 and https://drupal.org/node/2047633.
161
 */
162
function content_translation_menu() {
163 164 165 166 167
  $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.
168
    if (content_translation_enabled($entity_type)) {
169
      $path = _content_translation_link_to_router_path($entity_type, $info['links']['canonical']);
170
      $entity_position = count(explode('/', $path)) - 1;
171
      $keys = array_flip(array('theme_callback', 'theme_arguments', 'load_arguments'));
172
      $menu_info = array_intersect_key($info['translation']['content_translation'], $keys) + array('file' => 'content_translation.pages.inc');
173 174 175 176 177 178 179 180 181
      $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(
182
        'title' => 'Translate',
183
        'route_name' => $info['links']['drupal:content-translation-overview'],
184
        'type' => MENU_LOCAL_TASK,
185
        'context' => MENU_CONTEXT_PAGE,
186 187 188
        'weight' => 2,
      ) + $item;

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

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

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

      // Delete translation callback.
      $items["$path/translations/delete/%language"] = array(
        'title' => 'Delete',
217
        'route_name' => "content_translation.delete_$entity_type",
218 219 220 221 222 223 224 225 226
      ) + $item;
    }
  }

  return $items;
}

/**
 * Implements hook_menu_alter().
227 228 229
 *
 * @todo Split this into route definition and menu link definition. See
 *   https://drupal.org/node/1987882 and https://drupal.org/node/2047633.
230
 */
231
function content_translation_menu_alter(array &$items) {
232 233 234 235
  // 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.';

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

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

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

269
          // Make the "Translate" tab follow the "Edit" one when possible.
270 271 272 273 274 275 276 277 278
          if (isset($entity_form_item['weight'])) {
            $items["$path/translations"]['weight'] = $entity_form_item['weight'] + 0.01;
          }
        }
      }
    }
  }
}

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

288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305
/**
 * Convert an entity canonical link to a router path.
 *
 * @param string $link
 *   The entity link to be converted.
 *
 * @return string
 *   The resulting router path. For instance "/node/{node}" is turned into
 *   "node/%node".
 *
 * @todo Remove this and use the actual link values when all the Content
 *   Translation code is adapted to the new routing system.
 */
function _content_translation_link_to_router_path($entity_type, $link) {
  $path = preg_replace('|{([^}]+)}|', '%$1', trim($link, '/'));
  return str_replace('%id', '%' . $entity_type, $path);
}

306 307 308 309 310 311 312 313 314
/**
 * 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 "%".
 */
315
function _content_translation_menu_strip_loaders($path) {
316 317 318
  return preg_replace('|%[^/]+|', '%', $path);
}

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

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

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

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

/**
 * 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.
 */
396
function content_translation_delete_access(EntityInterface $entity, Language $language = NULL) {
397
  $language = !empty($language) ? $language : language(Language::TYPE_CONTENT);
398 399
  $translations = $entity->getTranslationLanguages();
  $languages = language_list();
400
  return isset($languages[$language->id]) && $language->id != $entity->getUntranslated()->language()->id && isset($translations[$language->id]) && content_translation_access($entity, 'delete');
401 402
}

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

  return $libraries;
}

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

/**
 * 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.
 */
465 466
function content_translation_get_config($entity_type, $bundle, $setting) {
  $key = content_translation_get_config_key($entity_type, $bundle, $setting);
467
  return \Drupal::config('content_translation.settings')->get($key);
468 469 470 471 472 473 474 475 476 477 478 479 480 481
}

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

/**
 * 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.
499 500
 *
 * @todo Move to \Drupal\content_translation\ContentTranslationManager.
501
 */
502
function content_translation_enabled($entity_type, $bundle = NULL) {
503 504
  $enabled = FALSE;

505
  if (\Drupal::service('content_translation.manager')->isSupported($entity_type)) {
506 507
    $bundles = !empty($bundle) ? array($bundle) : array_keys(entity_get_bundles($entity_type));
    foreach ($bundles as $bundle) {
508
      if (content_translation_get_config($entity_type, $bundle, 'enabled')) {
509 510 511
        $enabled = TRUE;
        break;
      }
512 513 514
    }
  }

515
  return $enabled;
516 517 518
}

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

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

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

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

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

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

  return $permission;
}

/**
 * Implements hook_form_alter().
 */
630
function content_translation_form_alter(array &$form, array &$form_state) {
631 632 633 634
  $form_controller = content_translation_form_controller($form_state);
  $entity = $form_controller ? $form_controller->getEntity() : NULL;

  if ($entity instanceof ContentEntityInterface && $entity->isTranslatable() && count($entity->getTranslationLanguages()) > 1) {
635
    $controller = content_translation_controller($entity->entityType());
636 637 638 639 640 641 642 643 644 645
    $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)) {
646 647
      foreach ($entity->getPropertyDefinitions() as $property_name => $definition) {
        if (isset($form[$property_name])) {
648
          $form[$property_name]['#multilingual'] = $definition->isFieldTranslatable();
649 650 651 652 653 654 655
        }
      }
    }

  }
}

656
/**
657
 * Implements hook_language_fallback_candidates_OPERATION_alter().
658 659 660
 *
 * Performs language fallback for unaccessible translations.
 */
661 662 663 664 665
function content_translation_language_fallback_candidates_entity_view_alter(&$candidates, $context) {
  $entity = $context['data'];
  foreach ($entity->getTranslationLanguages() as $langcode => $language) {
    if (!content_translation_view_access($entity, $langcode)) {
      unset($candidates[$langcode]);
666 667 668 669
    }
  }
}

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

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

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

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

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

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

  foreach ($entity->getTranslationLanguages() as $langcode => $language) {
729 730 731 732
    $translation = isset($entity->translation[$langcode]) ? $entity->translation[$langcode] : array();

    $translation += array(
      'source' => '',
733
      'uid' => $GLOBALS['user']->id(),
734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750
      '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);
751 752 753 754 755 756 757 758
  }

  $query->execute();
}

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

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

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

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

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

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

  return $extra;
}

/**
807
 * Implements hook_form_FORM_ID_alter() for 'field_ui_field_edit_form'.
808
 */
809
function content_translation_form_field_ui_field_edit_form_alter(array &$form, array &$form_state, $form_id) {
810 811 812 813 814 815
  $form['field']['translatable'] = array(
    '#type' => 'checkbox',
    '#title' => t('Users may translate this field.'),
    '#default_value' => $form['#field']->isFieldTranslatable(),
    '#weight' => 20,
  );
816 817
}

818
/**
819
 * Implements hook_form_FORM_ID_alter() for 'field_ui_field_instance_edit_form'.
820
 */
821
function content_translation_form_field_ui_field_instance_edit_form_alter(array &$form, array &$form_state, $form_id) {
822
  if ($form['#field']->isFieldTranslatable()) {
823
    module_load_include('inc', 'content_translation', 'content_translation.admin');
824
    $element = content_translation_field_sync_widget($form['#field']);
825 826 827 828 829 830 831 832 833
    if ($element) {
      $form['instance']['settings']['translation_sync'] = $element;
    }
  }
}

/**
 * Implements hook_field_info_alter().
 */
834
function content_translation_field_info_alter(&$info) {
835 836 837 838 839 840 841 842 843
  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);
  }
}

/**
844
 * Implements hook_entity_presave().
845
 */
846
function content_translation_entity_presave(EntityInterface $entity) {
847
  if ($entity instanceof ContentEntityInterface && $entity->isTranslatable()) {
848 849
    // @todo Avoid using request attributes once translation metadata become
    //   regular fields.
850 851
    $attributes = \Drupal::request()->attributes;
    \Drupal::service('content_translation.synchronizer')->synchronizeFields($entity, $entity->language()->id, $attributes->get('source_langcode'));
852 853 854
  }
}

855 856 857
/**
 * Implements hook_element_info_alter().
 */
858
function content_translation_element_info_alter(&$type) {
859
  if (isset($type['language_configuration'])) {
860
    $type['language_configuration']['#process'][] = 'content_translation_language_configuration_element_process';
861 862
  }
}
863

864
/**
865
 * Returns a widget to enable content translation per entity bundle.
866 867 868 869 870 871 872 873 874 875 876 877 878 879 880
 *
 * 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.
 */
881 882
function content_translation_enable_widget($entity_type, $bundle, array &$form, array &$form_state) {
  $key = $form_state['content_translation']['key'];
883 884 885 886
  if (!isset($form_state['language'][$key])) {
    $form_state['language'][$key] = array();
  }
  $form_state['language'][$key] += array('entity_type' => $entity_type, 'bundle' => $bundle);
887 888
  $element = content_translation_language_configuration_element_process(array('#name' => $key), $form_state, $form);
  unset($element['content_translation']['#element_validate']);
889 890 891 892 893 894 895 896 897 898 899 900
  return $element;
}

/**
 * Process callback: Expands the language_configuration form element.
 *
 * @param array $element
 *   Form API element.
 *
 * @return
 *   Processed language configuration element.
 */
901 902 903
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'];
904
    $context = $form_state['language'][$element['#name']];
905

906
    $element['content_translation'] = array(
907 908
      '#type' => 'checkbox',
      '#title' => t('Enable translation'),
909 910
      '#default_value' => content_translation_enabled($context['entity_type'], $context['bundle']),
      '#element_validate' => array('content_translation_language_configuration_element_validate'),
911 912
      '#prefix' => '<label>' . t('Translation') . '</label>',
    );
913

914
    $form['actions']['submit']['#submit'][] = 'content_translation_language_configuration_element_submit';
915
  }
916 917 918 919
  return $element;
}

/**
920
 * Form validation handler for element added with content_translation_language_configuration_element_process().
921 922 923 924 925
 *
 * 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.
 *
926
 * @see content_translation_language_configuration_element_submit()
927
 */
928 929
function content_translation_language_configuration_element_validate($element, array &$form_state, array $form) {
  $key = $form_state['content_translation']['key'];
930
  $values = $form_state['values'][$key];
931
  if (language_is_locked($values['langcode']) && !$values['language_show'] && $values['content_translation']) {
932
    foreach (language_list(Language::STATE_LOCKED) as $language) {
933 934 935 936 937
      $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.
938
    form_set_error('', $form_state, t('"Show language selector" is not compatible with translating content that has default language: %choice. Either do not hide the language selector or pick a specific language.', array('%choice' => $locked_languages[$values['langcode']])));
939 940 941 942
  }
}

/**
943
 * Form submission handler for element added with content_translation_language_configuration_element_process().
webchick's avatar