content_translation.module 39.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
use Drupal\Core\Entity\EntityTypeInterface;
use Drupal\Core\Field\FieldDefinition;
14 15 16
use Drupal\Core\Language\Language;
use Drupal\Core\Session\AccountInterface;
use Drupal\Core\TypedData\TranslatableInterface;
17
use Drupal\node\NodeInterface;
18 19 20 21

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

    case 'admin/config/regional/content-language':
      $output = '';
46
      if (!\Drupal::languageManager()->isMultilingual()) {
47
        $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')));
48 49
      }
      return $output;
50 51 52
  }
}

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

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

/**
79
 * Implements hook_entity_type_alter().
80 81
 *
 * The content translation UI relies on the entity info to provide its features.
82
 * See the documentation of hook_entity_type_build() in the Entity API documentation
83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103
 * for more details on all the entity info keys that may be defined.
 *
 * To make Content Translation automatically support an entity type some keys
 * may need to be defined, but none of them is required unless the entity path
 * is different from the usual /ENTITY_TYPE/{ENTITY_TYPE} pattern (for instance
 * "/taxonomy/term/{taxonomy_term}"), in which case at least the 'canonical' key
 * in the 'links' entity info property must be defined.
 *
 * Every entity type needs a translation controller to be translated. This can
 * be specified through the 'translation' key in the 'controllers' entity info
 * property. If an entity type is translatable and no translation controller is
 * defined, \Drupal\content_translation\ContentTranslationController will be
 * assumed. Every translation controller class must implement
 * \Drupal\content_translation\ContentTranslationControllerInterface.
 *
 * If the entity paths match the default pattern above and there is no need for
 * an entity-specific translation controller class, Content Translation will
 * provide built-in support for the entity. However enabling translation for
 * each translatable bundle will be required.
 *
 * @see \Drupal\Core\Entity\Annotation\EntityType
104
 */
105
function content_translation_entity_type_alter(array &$entity_types) {
106
  // Provide defaults for translation info.
107 108 109 110 111
  /** @var $entity_types \Drupal\Core\Entity\EntityTypeInterface[] */
  foreach ($entity_types as $entity_type) {
    if ($entity_type->isTranslatable()) {
      if (!$entity_type->hasControllerClass('translation')) {
        $entity_type->setControllerClass('translation', 'Drupal\content_translation\ContentTranslationController');
112
      }
113

114
      $translation = $entity_type->get('translation');
115 116
      if (!$translation || !isset($translation['content_translation'])) {
        $translation['content_translation'] = array();
117
      }
118

119
      if ($entity_type->hasLinkTemplate('canonical')) {
120
        // Provide default route names for the translation paths.
121 122
        if (!$entity_type->hasLinkTemplate('drupal:content-translation-overview')) {
          $entity_type->setLinkTemplate('drupal:content-translation-overview', "content_translation.translation_overview_" . $entity_type->id());
123
        }
124 125
        // @todo Remove this as soon as menu access checks rely on the
        //   controller. See https://drupal.org/node/2155787.
126
        $translation['content_translation'] += array(
127
          'access_callback' => 'content_translation_translate_access',
128 129
        );
      }
130
      $entity_type->set('translation', $translation);
131
    }
132 133
  }
}
134

135 136 137
/**
 * Implements hook_entity_bundle_info_alter().
 */
138
function content_translation_entity_bundle_info_alter(&$bundles) {
139 140
  foreach ($bundles as $entity_type => &$info) {
    foreach ($info as $bundle => &$bundle_info) {
141
      $enabled = content_translation_get_config($entity_type, $bundle, 'enabled');
142
      $bundle_info['translatable'] = !empty($enabled);
143 144 145 146
    }
  }
}

147
/**
148
 * Implements hook_entity_base_field_info_alter().
149
 */
150 151
function content_translation_entity_base_field_info_alter(&$fields, EntityTypeInterface $entity_type) {
  $translation_settings = \Drupal::config('content_translation.settings')->get($entity_type->id());
152 153 154

  if ($translation_settings) {
    // Currently field translatability is defined per-field but we may want to
155 156 157
    // make it per-instance instead. In that case, we will need to implement
    // hook_bundle_field_info_alter() instead.
    $field_settings = array();
158
    foreach ($translation_settings as $bundle => $settings) {
159
      $field_settings += !empty($settings['content_translation']['fields']) ? $settings['content_translation']['fields'] : array();
160 161
    }

162 163 164
    foreach ($field_settings as $name => $translatable) {
      if (isset($fields[$name]) && $fields[$name] instanceof FieldDefinition) {
        $fields[$name]->setTranslatable((bool) $translatable);
165 166 167 168 169
      }
    }
  }
}

170 171 172 173 174 175 176 177
/**
 * 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()) {
    $operations['translate'] = array(
      'title' => t('Translate'),
178
    ) + $entity->urlInfo('drupal:content-translation-overview');
179 180 181
  }
}

182 183
/**
 * Implements hook_menu_alter().
184 185 186
 *
 * @todo Split this into route definition and menu link definition. See
 *   https://drupal.org/node/1987882 and https://drupal.org/node/2047633.
187
 */
188
function content_translation_menu_alter(array &$items) {
189
  // Check that the declared menu base paths are actually valid.
190 191 192
  foreach (\Drupal::entityManager()->getDefinitions() as $entity_type_id => $entity_type) {
    if (content_translation_enabled($entity_type_id)) {
      $path = _content_translation_link_to_router_path($entity_type_id, $entity_type->getLinkTemplate('canonical'));
193

194 195 196 197
      // 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().
198
      if (!isset($items[$path]) && !isset($items["$path/edit"])
199
          && !isset($items[_content_translation_menu_strip_loaders($path)])) {
200 201
        unset(
          $items["$path/translations"],
202
          $items["$path/translations/add/%language/%language"],
203 204
          $items["$path/translations/delete/%language"]
        );
205
        $t_args = array('@entity_type' => $entity_type->getLabel() ?: $entity_type_id);
206
        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);
207 208
      }
      else {
209
        $edit_path = $path . '/edit';
210 211 212 213 214 215 216 217 218 219 220

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

221
          // Make the "Translate" tab follow the "Edit" one when possible.
222 223 224 225 226 227 228 229 230
          if (isset($entity_form_item['weight'])) {
            $items["$path/translations"]['weight'] = $entity_form_item['weight'] + 0.01;
          }
        }
      }
    }
  }
}

231 232 233 234 235
/**
 * Implements hook_menu_link_defaults_alter().
 */
function content_translation_menu_link_defaults_alter(array &$links) {
  // Clarify where translation settings are located.
236 237
  $links['language.admin.language.content_settings_page']['link_title'] = 'Content language and translation';
  $links['language.admin.language.content_settings_page']['description'] = 'Configure language and translation support for content.';
238 239
}

240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257
/**
 * 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);
}

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

271 272 273 274 275 276
/**
 * Access callback for the translation overview page.
 *
 * @param \Drupal\Core\Entity\EntityInterface $entity
 *   The entity whose translation overview should be displayed.
 */
277
function content_translation_translate_access(EntityInterface $entity) {
278
  return $entity instanceof ContentEntityInterface && empty($entity->getUntranslated()->language()->locked) && \Drupal::languageManager()->isMultilingual() && $entity->isTranslatable() &&
279
    (user_access('create content translations') || user_access('update content translations') || user_access('delete content translations'));
280 281
}

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

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

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

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

/**
356
 * Returns the key name used to store the configuration setting.
357
 *
358 359
 * Based on the entity type and bundle, the keys used to store configuration
 * will have a common root name.
360 361 362 363 364 365 366 367 368
 *
 * @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
369
 *   The key name of the configuration setting.
370 371 372 373
 *
 * @todo Generalize this logic so that it is available to any module needing
 *   per-bundle configuration.
 */
374
function content_translation_get_config_key($entity_type, $bundle, $setting) {
375 376
  $entity_type = preg_replace('/[^0-9a-zA-Z_]/', "_", $entity_type);
  $bundle = preg_replace('/[^0-9a-zA-Z_]/', "_", $bundle);
377
  return $entity_type . '.' . $bundle . '.content_translation.' . $setting;
378 379 380 381 382 383 384 385 386 387 388 389 390 391 392
}

/**
 * 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.
 */
393 394
function content_translation_get_config($entity_type, $bundle, $setting) {
  $key = content_translation_get_config_key($entity_type, $bundle, $setting);
395
  return \Drupal::config('content_translation.settings')->get($key);
396 397 398 399 400 401 402 403 404 405 406 407 408 409
}

/**
 * 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.
 */
410 411
function content_translation_set_config($entity_type, $bundle, $setting, $value) {
  $key = content_translation_get_config_key($entity_type, $bundle, $setting);
412
  return \Drupal::config('content_translation.settings')->set($key, $value)->save();
413 414 415 416 417 418 419 420 421 422 423 424 425 426
}

/**
 * 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.
427 428
 *
 * @todo Move to \Drupal\content_translation\ContentTranslationManager.
429
 */
430
function content_translation_enabled($entity_type, $bundle = NULL) {
431 432
  $enabled = FALSE;

433
  if (\Drupal::service('content_translation.manager')->isSupported($entity_type)) {
434 435
    $bundles = !empty($bundle) ? array($bundle) : array_keys(entity_get_bundles($entity_type));
    foreach ($bundles as $bundle) {
436
      if (content_translation_get_config($entity_type, $bundle, 'enabled')) {
437 438 439
        $enabled = TRUE;
        break;
      }
440 441 442
    }
  }

443
  return $enabled;
444 445 446
}

/**
447
 * Content translation controller factory.
448
 *
449
 * @param string $entity_type_id
450 451
 *   The type of the entity being translated.
 *
452 453
 * @return \Drupal\content_translation\ContentTranslationControllerInterface
 *   An instance of the content translation controller interface.
454 455
 *
 * @todo Move to \Drupal\content_translation\ContentTranslationManager.
456
 */
457 458
function content_translation_controller($entity_type_id) {
  $entity_type = \Drupal::entityManager()->getDefinition($entity_type_id);
459
  // @todo Throw an exception if the key is missing.
460 461
  $class = $entity_type->getControllerClass('translation');
  return new $class($entity_type);
462 463 464 465 466 467 468 469 470
}

/**
 * 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;
471
 *   An instance of the content translation form interface or FALSE if not an
472
 *   entity form.
473 474
 *
 * @todo Move to \Drupal\content_translation\ContentTranslationManager.
475
 */
476
function content_translation_form_controller(array $form_state) {
477 478 479 480
  return isset($form_state['controller']) && $form_state['controller'] instanceof EntityFormControllerInterface ? $form_state['controller'] : FALSE;
}

/**
481
 * Checks whether a content translation is accessible.
482 483 484
 *
 * @param \Drupal\Core\Entity\EntityInterface $entity
 *   The entity to be accessed.
485 486 487 488 489 490
 * @param $op
 *   The operation to be performed on the translation. Possible values are:
 *   - "view"
 *   - "update"
 *   - "delete"
 *   - "create"
491 492 493
 *
 * @return
 *   TRUE if the current user is allowed to view the translation.
494 495
 *
 * @todo Move to \Drupal\content_translation\ContentTranslationManager.
496
 */
497
function content_translation_access(EntityInterface $entity, $op) {
498
  return content_translation_controller($entity->getEntityTypeId())->getTranslationAccess($entity, $op) ;
499 500 501 502 503
}

/**
 * Implements hook_permission().
 */
504
function content_translation_permission() {
505
  $permission = array(
506
    'administer content translation' => array(
507
      'title' => t('Administer translation settings'),
508
      'description' => t('Configure translatability of entities and fields.'),
509
    ),
510
    'create content translations' => array(
511 512
      'title' => t('Create translations'),
    ),
513
    'update content translations' => array(
514 515
      'title' => t('Edit translations'),
    ),
516
    'delete content translations' => array(
517 518
      'title' => t('Delete translations'),
    ),
519 520 521 522 523
    'translate any entity' => array(
      'title' => t('Translate any entity'),
    ),
  );

524 525
  // Create a translate permission for each enabled entity type and (optionally)
  // bundle.
526 527 528
  foreach (\Drupal::entityManager()->getDefinitions() as $entity_type_id => $entity_type) {
    if ($permission_granularity = $entity_type->getPermissionGranularity()) {
      $t_args = array('@entity_label' => $entity_type->getLowercaseLabel());
529

530
      switch ($permission_granularity) {
531
        case 'bundle':
532 533
          foreach (entity_get_bundles($entity_type_id) as $bundle => $bundle_info) {
            if (content_translation_enabled($entity_type_id, $bundle)) {
534
              $t_args['%bundle_label'] = isset($bundle_info['label']) ? $bundle_info['label'] : $bundle;
535
              $permission["translate $bundle $entity_type_id"] = array(
536
                'title' => t('Translate %bundle_label @entity_label', $t_args),
537 538 539 540 541 542
              );
            }
          }
          break;

        case 'entity_type':
543 544
          if (content_translation_enabled($entity_type_id)) {
            $permission["translate $entity_type_id"] = array(
545 546 547 548 549
              'title' => t('Translate @entity_label', $t_args),
            );
          }
          break;
      }
550 551 552 553 554 555 556 557 558
    }
  }

  return $permission;
}

/**
 * Implements hook_form_alter().
 */
559
function content_translation_form_alter(array &$form, array &$form_state) {
560 561 562 563
  $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) {
564
    $controller = content_translation_controller($entity->getEntityTypeId());
565 566 567 568 569 570 571 572 573 574
    $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)) {
575
      foreach ($entity->getFieldDefinitions() as $property_name => $definition) {
576
        if (isset($form[$property_name])) {
577
          $form[$property_name]['#multilingual'] = $definition->isTranslatable();
578 579 580 581 582 583 584
        }
      }
    }

  }
}

585
/**
586
 * Implements hook_language_fallback_candidates_OPERATION_alter().
587 588 589
 *
 * Performs language fallback for unaccessible translations.
 */
590 591 592 593 594
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]);
595 596 597 598
    }
  }
}

599 600 601
/**
 * Implements hook_entity_load().
 */
602
function content_translation_entity_load(array $entities, $entity_type) {
603 604
  $enabled_entities = array();

605
  if (content_translation_enabled($entity_type)) {
606
    foreach ($entities as $entity) {
607
      if ($entity instanceof ContentEntityInterface && $entity->isTranslatable()) {
608 609 610 611 612 613
        $enabled_entities[$entity->id()] = $entity;
      }
    }
  }

  if (!empty($enabled_entities)) {
614
    content_translation_load_translation_metadata($enabled_entities, $entity_type);
615 616 617 618 619 620 621 622 623 624 625
  }
}

/**
 * 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.
 */
626 627
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)';
628
  $result = db_query($query, array(':entity_type' => $entity_type, ':entity_id' => array_keys($entities)));
629
  $exclude = array('entity_type', 'entity_id', 'langcode');
630 631 632
  foreach ($result as $record) {
    $entity = $entities[$record->entity_id];
    // @todo Declare these as entity (translation?) properties.
633 634
    foreach ($record as $field_name => $value) {
      if (!in_array($field_name, $exclude)) {
635 636 637 638 639
        $langcode = $record->langcode;
        $entity->translation[$langcode][$field_name] = $value;
        if (!$entity->hasTranslation($langcode)) {
          $entity->initTranslation($langcode);
        }
640 641
      }
    }
642 643 644 645 646 647
  }
}

/**
 * Implements hook_entity_insert().
 */
648
function content_translation_entity_insert(EntityInterface $entity) {
649
  // Only do something if translation support for the given entity is enabled.
650
  if (!($entity instanceof ContentEntityInterface) || !$entity->isTranslatable()) {
651 652 653
    return;
  }

654
  $fields = array('entity_type', 'entity_id', 'langcode', 'source', 'outdated', 'uid', 'status', 'created', 'changed');
655
  $query = db_insert('content_translation')->fields($fields);
656 657

  foreach ($entity->getTranslationLanguages() as $langcode => $language) {
658 659 660 661
    $translation = isset($entity->translation[$langcode]) ? $entity->translation[$langcode] : array();

    $translation += array(
      'source' => '',
662
      'uid' => \Drupal::currentUser()->id(),
663 664 665 666 667 668
      'outdated' => FALSE,
      'status' => TRUE,
      'created' => REQUEST_TIME,
      'changed' => REQUEST_TIME,
    );

669
    $translation['entity_type'] = $entity->getEntityTypeId();
670 671 672 673 674 675 676 677 678 679
    $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);
680 681 682 683 684 685 686 687
  }

  $query->execute();
}

/**
 * Implements hook_entity_delete().
 */
688
function content_translation_entity_delete(EntityInterface $entity) {
689
  // Only do something if translation support for the given entity is enabled.
690
  if (!($entity instanceof ContentEntityInterface) || !$entity->isTranslatable()) {
691 692 693
    return;
  }

694
  db_delete('content_translation')
695
    ->condition('entity_type', $entity->getEntityTypeId())
696 697 698 699 700 701 702
    ->condition('entity_id', $entity->id())
    ->execute();
}

/**
 * Implements hook_entity_update().
 */
703
function content_translation_entity_update(EntityInterface $entity) {
704
  // Only do something if translation support for the given entity is enabled.
705
  if (!($entity instanceof ContentEntityInterface) || !$entity->isTranslatable()) {
706 707 708
    return;
  }

709
  // Delete and create to ensure no stale value remains behind.
710 711
  content_translation_entity_delete($entity);
  content_translation_entity_insert($entity);
712 713 714 715 716
}

/**
 * Implements hook_field_extra_fields().
 */
717
function content_translation_field_extra_fields() {
718 719
  $extra = array();

720
  foreach (\Drupal::entityManager()->getDefinitions() as $entity_type => $info) {
721
    foreach (entity_get_bundles($entity_type) as $bundle => $bundle_info) {
722
      if (content_translation_enabled($entity_type, $bundle)) {
723 724 725 726 727 728 729 730 731 732 733 734 735
        $extra[$entity_type][$bundle]['form']['translation'] = array(
          'label' => t('Translation'),
          'description' => t('Translation settings'),
          'weight' => 10,
        );
      }
    }
  }

  return $extra;
}

/**
736
 * Implements hook_form_FORM_ID_alter() for 'field_ui_field_edit_form'.
737
 */
738
function content_translation_form_field_ui_field_edit_form_alter(array &$form, array &$form_state, $form_id) {
739 740 741
  $field = $form['#field'];
  $bundle = $form['#bundle'];
  $bundle_is_translatable = content_translation_enabled($field->entity_type, $bundle);
742 743 744
  $form['field']['translatable'] = array(
    '#type' => 'checkbox',
    '#title' => t('Users may translate this field.'),
745
    '#default_value' => $field->isTranslatable(),
746
    '#weight' => 20,
747
    '#disabled' => !$bundle_is_translatable,
748
  );
749
  $form['#submit'][] = 'content_translation_form_field_ui_field_edit_form_submit';
750 751 752 753 754 755 756 757 758 759

  // Provide helpful pointers for administrators.
  if (\Drupal::currentUser()->hasPermission('administer content translation') &&  !$bundle_is_translatable) {
    $toggle_url = url('admin/config/regional/content-language', array(
      'query' => drupal_get_destination(),
    ));
    $form['field']['translatable']['#description'] = t('To enable translation of this field, <a href="@language-settings-url">enable language support</a> for this type.', array(
      '@language-settings-url' => $toggle_url,
    ));
  }
760 761 762 763 764 765 766 767 768 769 770
}

/**
 * Form submission handler for 'field_ui_field_edit_form'.
 */
function content_translation_form_field_ui_field_edit_form_submit($form, array &$form_state) {
  $instance = $form_state['instance'];
  $value = content_translation_get_config($instance->entity_type, $instance->bundle, 'fields');
  if (!isset($value)) {
    $value = array();
  }
771
  $value[$instance->getField()->getName()] = $form_state['values']['field']['translatable'];
772 773 774 775 776
  // Store the same value for all bundles as translatability is tracked per
  // field.
  foreach (entity_get_bundles($instance->entity_type) as $bundle => $info) {
    content_translation_set_config($instance->entity_type, $bundle, 'fields', $value);
  }
777 778
}

779
/**
780
 * Implements hook_form_FORM_ID_alter() for 'field_ui_field_instance_edit_form'.
781
 */
782
function content_translation_form_field_ui_field_instance_edit_form_alter(array &$form, array &$form_state, $form_id) {
783
  if ($form['#field']->isTranslatable()) {
784
    module_load_include('inc', 'content_translation', 'content_translation.admin');
785
    $element = content_translation_field_sync_widget($form['#field']);
786 787 788 789 790 791 792 793 794
    if ($element) {
      $form['instance']['settings']['translation_sync'] = $element;
    }
  }
}

/**
 * Implements hook_field_info_alter().
 */
795
function content_translation_field_info_alter(&$info) {
796
  foreach ($info as &$field_type_info) {
797 798 799 800 801 802 803 804
    // 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);
  }
}

/**
805
 * Implements hook_entity_presave().
806
 */
807
function content_translation_entity_presave(EntityInterface $entity) {
808
  if ($entity instanceof ContentEntityInterface && $entity->isTranslatable()) {
809 810
    // @todo Avoid using request attributes once translation metadata become
    //   regular fields.
811 812
    $attributes = \Drupal::request()->attributes;
    \Drupal::service('content_translation.synchronizer')->synchronizeFields($entity, $entity->language()->id, $attributes->get('source_langcode'));
813 814 815
  }
}

816 817 818
/**
 * Implements hook_element_info_alter().
 */
819
function content_translation_element_info_alter(&$type) {
820
  if (isset($type['language_configuration'])) {
821
    $type['language_configuration']['#process'][] = 'content_translation_language_configuration_element_process';
822 823
  }
}
824

825
/**
826
 * Returns a widget to enable content translation per entity bundle.
827 828 829 830 831 832 833 834 835 836 837 838 839 840 841
 *
 * 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.
 */
842 843
function content_translation_enable_widget($entity_type, $bundle, array &$form, array &$form_state) {
  $key = $form_state['content_translation']['key'];
844 845 846 847
  if (!isset($form_state['language'][$key])) {
    $form_state['language'][$key] = array();
  }
  $form_state['language'][$key] += array('entity_type' => $entity_type, 'bundle' => $bundle);
848 849
  $element = content_translation_language_configuration_element_process(array('#name' => $key), $form_state, $form);
  unset($element['content_translation']['#element_validate']);
850 851 852 853 854 855 856 857 858 859 860 861
  return $element;
}

/**
 * Process callback: Expands the language_configuration form element.
 *
 * @param array $element
 *   Form API element.
 *
 * @return
 *   Processed language configuration element.
 */
862 863 864
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'];
865
    $context = $form_state['language'][$element['#name']];
866

867
    $element['content_translation'] = array(
868 869
      '#type' => 'checkbox',
      '#title' => t('Enable translation'),
870 871
      '#default_value' => content_translation_enabled($context['entity_type'], $context['bundle']),
      '#element_validate' => array('content_translation_language_configuration_element_validate'),
872 873
      '#prefix' => '<label>' . t('Translation') . '</label>',
    );
874

875
    $form['actions']['submit']['#submit'][] = 'content_translation_language_configuration_element_submit';
876
  }
877 878 879 880
  return $element;
}

/**
881
 * Form validation handler for element added with content_translation_language_configuration_element_process().
882 883 884 885 886
 *
 * 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.
 *
887
 * @see content_translation_language_configuration_element_submit()
888
 */
889 890
function content_translation_language_configuration_element_validate($element, array &$form_state, array $form) {
  $key = $form_state['content_translation']['key'];
891
  $values = $form_state['values'][$key];
892
  if (!$values['language_show'] && $values['content_translation'] && \Drupal::languageManager()->isLanguageLocked($values['langcode'])) {
893
    foreach (language_list(Language::STATE_LOCKED) as $language) {
894 895 896 897 898
      $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.
899
    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']])));
900 901 902 903
  }
}

/**
904
 * Form submission handler for element added with content_translation_language_configuration_element_process().
905
 *
906
 * Stores the content translation settings.
907
 *
908
 * @see content_translation_language_configuration_element_validate()
909
 */
910 911
function content_translation_language_configuration_element_submit(array $form, array &$form_state) {
  $key = $form_state['content_translation']['key'];
912
  $context = $form_state['language'][$key];
913
  $enabled = $form_state['values'][$key]['content_translation'];
914

915 916
  if (content_translation_enabled($context['entity_type'], $context['bundle']) != $enabled) {
    content_translation_set_config($context['entity_type'], $context['bundle'], 'enabled', $enabled);
917
    entity_info_cache_clear();
918
    \Drupal::service('router.builder')->setRebuildNeeded();
919 920
  }
}
921 922 923 924

/**
 * Implements hook_form_FORM_ID_alter() for language_content_settings_form().
 */
925 926 927
function content_translation_form_language_content_settings_form_alter(array &$form, array &$form_state) {
  module_load_include('inc', 'content_translation', 'content_translation.admin');
  _content_translation_form_language_content_settings_form_alter($form, $form_state);
928 929
}

webchick's avatar