content_translation.module 40.8 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 88 89 90 91
    if (!empty($info['translatable'])) {
      // Every fieldable entity type must have a translation controller class,
      // no matter if it is enabled for translation or not. As a matter of fact
      // we might need it to correctly switch field translatability when a field
      // is shared accross different entities.
      $info['controllers'] += array('translation' => 'Drupal\content_translation\ContentTranslationController');

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

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

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

118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144
/**
 * 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;
        }
      }
    }
  }
}

145 146 147 148 149 150 151 152 153 154 155 156 157 158 159
/**
 * 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'],
    );
  }
}

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

193 194 195 196 197 198
      $items["$path/translations/overview"] = array(
        'title' => 'Overview',
        'type' => MENU_DEFAULT_LOCAL_TASK,
        'weight' => 0,
      );

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

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

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

226
  $items['admin/config/regional/content_translation/translatable/%/%'] = array(
227 228
    'title' => 'Confirm change in translatability.',
    'description' => 'Confirm page for changing field translatability.',
229
    'route_name' => 'content_translation.translatable',
230 231 232 233 234 235 236
  );

  return $items;
}

/**
 * Implements hook_menu_alter().
237 238 239
 *
 * @todo Split this into route definition and menu link definition. See
 *   https://drupal.org/node/1987882 and https://drupal.org/node/2047633.
240
 */
241
function content_translation_menu_alter(array &$items) {
242 243 244 245
  // 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.';

246 247
  // Check that the declared menu base paths are actually valid.
  foreach (entity_get_info() as $entity_type => $info) {
248
    if (content_translation_enabled($entity_type)) {
249
      $path = _content_translation_link_to_router_path($entity_type, $info['links']['canonical']);
250

251 252 253 254
      // 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().
255
      if (!isset($items[$path]) && !isset($items["$path/edit"])
256
          && !isset($items[_content_translation_menu_strip_loaders($path)])) {
257 258
        unset(
          $items["$path/translations"],
259
          $items["$path/translations/add/%language/%language"],
260 261
          $items["$path/translations/delete/%language"]
        );
262
        $t_args = array('@entity_type' => isset($info['label']) ? $info['label'] : $entity_type);
263
        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);
264 265 266
      }
      else {
        $entity_position = count(explode('/', $path)) - 1;
267
        $edit_path = $path . '/edit';
268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288

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

289 290 291 292 293 294 295 296 297
/**
 * 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);
}

298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315
/**
 * 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);
}

316 317 318 319 320 321 322 323 324
/**
 * 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 "%".
 */
325
function _content_translation_menu_strip_loaders($path) {
326 327 328
  return preg_replace('|%[^/]+|', '%', $path);
}

329 330 331 332 333 334
/**
 * Access callback for the translation overview page.
 *
 * @param \Drupal\Core\Entity\EntityInterface $entity
 *   The entity whose translation overview should be displayed.
 */
335
function content_translation_translate_access(EntityInterface $entity) {
336
  return $entity instanceof ContentEntityInterface && empty($entity->getUntranslated()->language()->locked) && language_multilingual() && $entity->isTranslatable() &&
337
    (user_access('create content translations') || user_access('update content translations') || user_access('delete content translations'));
338 339
}

340 341 342 343 344 345 346
/**
 * 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.
347
 * @param \Drupal\Core\Session\AccountInterface $account
348 349 350
 *   (optional) The account for which view access should be checked. Defaults to
 *   the current user.
 */
351
function content_translation_view_access(EntityInterface $entity, $langcode, AccountInterface $account = NULL) {
352
  $entity_type = $entity->entityType();
353 354 355 356 357 358
  $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);
359 360
}

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

/**
 * 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.
 */
390
function content_translation_edit_access(EntityInterface $entity, Language $language = NULL) {
391
  $language = !empty($language) ? $language : language(Language::TYPE_CONTENT);
392 393
  $translations = $entity->getTranslationLanguages();
  $languages = language_list();
394
  return isset($languages[$language->id]) && $language->id != $entity->getUntranslated()->language()->id && isset($translations[$language->id]) && content_translation_access($entity, 'update');
395 396 397 398 399 400 401 402 403 404 405
}

/**
 * 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.
 */
406
function content_translation_delete_access(EntityInterface $entity, Language $language = NULL) {
407
  $language = !empty($language) ? $language : language(Language::TYPE_CONTENT);
408 409
  $translations = $entity->getTranslationLanguages();
  $languages = language_list();
410
  return isset($languages[$language->id]) && $language->id != $entity->getUntranslated()->language()->id && isset($translations[$language->id]) && content_translation_access($entity, 'delete');
411 412
}

413 414 415
/**
 * Implements hook_library_info().
 */
416 417 418 419
function content_translation_library_info() {
  $path = drupal_get_path('module', 'content_translation');
  $libraries['drupal.content_translation.admin'] = array(
    'title' => 'Content translation UI',
420
    'version' => \Drupal::VERSION,
421
    'js' => array(
422
      $path . '/content_translation.admin.js' => array(),
423 424
    ),
    'css' => array(
425
      $path . '/css/content_translation.admin.css' => array(),
426 427 428 429 430 431 432 433 434 435 436
    ),
    'dependencies' => array(
      array('system', 'jquery'),
      array('system', 'drupal'),
      array('system', 'jquery.once'),
    ),
  );

  return $libraries;
}

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

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

/**
 * 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.
 */
492 493
function content_translation_set_config($entity_type, $bundle, $setting, $value) {
  $key = content_translation_get_config_key($entity_type, $bundle, $setting);
494
  return \Drupal::config('content_translation.settings')->set($key, $value)->save();
495 496 497 498 499 500 501 502 503 504 505 506 507 508
}

/**
 * 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.
509 510
 *
 * @todo Move to \Drupal\content_translation\ContentTranslationManager.
511
 */
512
function content_translation_enabled($entity_type, $bundle = NULL) {
513 514
  $enabled = FALSE;

515
  if (\Drupal::service('content_translation.manager')->isSupported($entity_type)) {
516 517
    $bundles = !empty($bundle) ? array($bundle) : array_keys(entity_get_bundles($entity_type));
    foreach ($bundles as $bundle) {
518
      if (content_translation_get_config($entity_type, $bundle, 'enabled')) {
519 520 521
        $enabled = TRUE;
        break;
      }
522 523 524
    }
  }

525
  return $enabled;
526 527 528
}

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

/**
 * 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;
552
 *   An instance of the content translation form interface or FALSE if not an
553
 *   entity form.
554 555
 *
 * @todo Move to \Drupal\content_translation\ContentTranslationManager.
556
 */
557
function content_translation_form_controller(array $form_state) {
558 559 560 561
  return isset($form_state['controller']) && $form_state['controller'] instanceof EntityFormControllerInterface ? $form_state['controller'] : FALSE;
}

/**
562
 * Checks whether a content translation is accessible.
563 564 565
 *
 * @param \Drupal\Core\Entity\EntityInterface $entity
 *   The entity to be accessed.
566 567 568 569 570 571
 * @param $op
 *   The operation to be performed on the translation. Possible values are:
 *   - "view"
 *   - "update"
 *   - "delete"
 *   - "create"
572 573 574
 *
 * @return
 *   TRUE if the current user is allowed to view the translation.
575 576
 *
 * @todo Move to \Drupal\content_translation\ContentTranslationManager.
577
 */
578 579
function content_translation_access(EntityInterface $entity, $op) {
  return content_translation_controller($entity->entityType())->getTranslationAccess($entity, $op) ;
580 581 582 583 584
}

/**
 * Implements hook_permission().
 */
585
function content_translation_permission() {
586
  $permission = array(
587
    'administer content translation' => array(
588
      'title' => t('Administer translation settings'),
589
      'description' => t('Configure translatability of entities and fields.'),
590
    ),
591
    'create content translations' => array(
592 593
      'title' => t('Create translations'),
    ),
594
    'update content translations' => array(
595 596
      'title' => t('Edit translations'),
    ),
597
    'delete content translations' => array(
598 599
      'title' => t('Delete translations'),
    ),
600 601 602 603 604
    'translate any entity' => array(
      'title' => t('Translate any entity'),
    ),
  );

605 606
  // Create a translate permission for each enabled entity type and (optionally)
  // bundle.
607
  foreach (entity_get_info() as $entity_type => $info) {
608 609 610 611 612 613
    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) {
614
            if (content_translation_enabled($entity_type, $bundle)) {
615
              $t_args['%bundle_label'] = isset($bundle_info['label']) ? $bundle_info['label'] : $bundle;
616
              $permission["translate $bundle $entity_type"] = array(
617
                'title' => t('Translate %bundle_label @entity_label', $t_args),
618 619 620 621 622 623
              );
            }
          }
          break;

        case 'entity_type':
624
          if (content_translation_enabled($entity_type)) {
625 626 627 628 629 630
            $permission["translate $entity_type"] = array(
              'title' => t('Translate @entity_label', $t_args),
            );
          }
          break;
      }
631 632 633 634 635 636 637 638 639
    }
  }

  return $permission;
}

/**
 * Implements hook_form_alter().
 */
640
function content_translation_form_alter(array &$form, array &$form_state) {
641 642 643 644
  $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) {
645
    $controller = content_translation_controller($entity->entityType());
646 647 648 649 650 651 652 653 654 655
    $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)) {
656 657 658
      foreach ($entity->getPropertyDefinitions() as $property_name => $definition) {
        if (isset($form[$property_name])) {
          $form[$property_name]['#multilingual'] = !empty($definition['translatable']);
659 660 661 662 663 664 665
        }
      }
    }

  }
}

666
/**
667
 * Implements hook_language_fallback_candidates_OPERATION_alter().
668 669 670
 *
 * Performs language fallback for unaccessible translations.
 */
671 672 673 674 675
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]);
676 677 678 679
    }
  }
}

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

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

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

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

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

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

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

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

  $query->execute();
}

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

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

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

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

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

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

  return $extra;
}

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

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

  $form['field']['translatable']['#weight'] = 20;
850 851
}

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

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

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

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

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

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

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

alexpott's avatar