ContentTranslationHandler.php 19.2 KB
Newer Older
1 2 3 4
<?php

/**
 * @file
5
 * Contains \Drupal\content_translation\ContentTranslationHandler.
6 7
 */

8
namespace Drupal\content_translation;
9

10
use Drupal\Core\Access\AccessResult;
11
use Drupal\Core\Entity\EntityInterface;
12
use Drupal\Core\Entity\EntityTypeInterface;
13
use Drupal\Core\Form\FormStateInterface;
14
use Drupal\Core\Language\LanguageInterface;
15
use Drupal\Core\Render\Element;
16 17

/**
18
 * Base class for content translation handlers.
19 20
 *
 * @ingroup entity_api
21
 */
22
class ContentTranslationHandler implements ContentTranslationHandlerInterface {
23 24 25 26 27 28

  /**
   * The type of the entity being translated.
   *
   * @var string
   */
29
  protected $entityTypeId;
30 31

  /**
32
   * Information about the entity type.
33
   *
34
   * @var \Drupal\Core\Entity\EntityTypeInterface
35
   */
36
  protected $entityType;
37 38

  /**
39
   * Initializes an instance of the content translation controller.
40
   *
41
   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
42 43
   *   The info array of the given entity type.
   */
44
  public function __construct(EntityTypeInterface $entity_type) {
45 46
    $this->entityTypeId = $entity_type->id();
    $this->entityType = $entity_type;
47 48 49
  }

  /**
50
   * {@inheritdoc}
51 52
   */
  public function retranslate(EntityInterface $entity, $langcode = NULL) {
53
    $updated_langcode = !empty($langcode) ? $langcode : $entity->language()->id;
54 55
    $translations = $entity->getTranslationLanguages();
    foreach ($translations as $langcode => $language) {
56
      $entity->translation[$langcode]['outdated'] = $langcode != $updated_langcode;
57 58 59 60
    }
  }

  /**
61
   * {@inheritdoc}
62
   */
63
  public function getTranslationAccess(EntityInterface $entity, $op) {
64
    // @todo Move this logic into a translation access control handler checking also
65
    //   the translation language and the given account.
66
    $entity_type = $entity->getEntityType();
67 68 69
    $translate_permission = TRUE;
    // If no permission granularity is defined this entity type does not need an
    // explicit translate permission.
70 71 72
    $current_user = \Drupal::currentUser();
    if (!$current_user->hasPermission('translate any entity') && $permission_granularity = $entity_type->getPermissionGranularity()) {
      $translate_permission = $current_user->hasPermission($permission_granularity == 'bundle' ? "translate {$entity->bundle()} {$entity->getEntityTypeId()}" : "translate {$entity->getEntityTypeId()}");
73
    }
74
    return AccessResult::allowedIf($translate_permission && $current_user->hasPermission("$op content translations"))->cachePerRole();
75 76 77
  }

  /**
78
   * {@inheritdoc}
79
   */
80
  public function getSourceLangcode(FormStateInterface $form_state) {
81 82 83 84
    if ($source = $form_state->get(['content_translation', 'source'])) {
      return $source->id;
    }
    return FALSE;
85 86 87
  }

  /**
88
   * {@inheritdoc}
89
   */
90
  public function entityFormAlter(array &$form, FormStateInterface $form_state, EntityInterface $entity) {
91 92
    $form_object = $form_state->getFormObject();
    $form_langcode = $form_object->getFormLangcode($form_state);
93
    $entity_langcode = $entity->getUntranslated()->language()->id;
94 95 96 97 98 99 100 101
    $source_langcode = $this->getSourceLangcode($form_state);

    $new_translation = !empty($source_langcode);
    $translations = $entity->getTranslationLanguages();
    if ($new_translation) {
      // Make sure a new translation does not appear as existing yet.
      unset($translations[$form_langcode]);
    }
102
    $is_translation = !$form_object->isDefaultFormLangcode($form_state);
103 104 105 106 107 108 109 110
    $has_translations = count($translations) > 1;

    // Adjust page title to specify the current language being edited, if we
    // have at least one translation.
    $languages = language_list();
    if (isset($languages[$form_langcode]) && ($has_translations || $new_translation)) {
      $title = $this->entityFormTitle($entity);
      // When editing the original values display just the entity label.
111
      if ($form_langcode != $entity_langcode) {
112 113 114
        $t_args = array('%language' => $languages[$form_langcode]->name, '%title' => $entity->label());
        $title = empty($source_langcode) ? $title . ' [' . t('%language translation', $t_args) . ']' : t('Create %language translation of %title', $t_args);
      }
115
      $form['#title'] = $title;
116 117 118 119 120 121
    }

    // Display source language selector only if we are creating a new
    // translation and there are at least two translations available.
    if ($has_translations && $new_translation) {
      $form['source_langcode'] = array(
122
        '#type' => 'details',
123 124 125 126 127
        '#title' => t('Source language: @language', array('@language' => $languages[$source_langcode]->name)),
        '#tree' => TRUE,
        '#weight' => -100,
        '#multilingual' => TRUE,
        'source' => array(
128 129
          '#title' => t('Select source language'),
          '#title_display' => 'invisible',
130 131 132 133 134 135 136 137 138 139
          '#type' => 'select',
          '#default_value' => $source_langcode,
          '#options' => array(),
        ),
        'submit' => array(
          '#type' => 'submit',
          '#value' => t('Change'),
          '#submit' => array(array($this, 'entityFormSourceChange')),
        ),
      );
140
      foreach (language_list(LanguageInterface::STATE_CONFIGURABLE) as $language) {
141 142
        if (isset($translations[$language->id])) {
          $form['source_langcode']['source']['#options'][$language->id] = $language->name;
143 144 145 146 147 148 149 150 151 152
        }
      }
    }

    // Disable languages for existing translations, so it is not possible to
    // switch this node to some language which is already in the translation
    // set.
    $language_widget = isset($form['langcode']) && $form['langcode']['#type'] == 'language_select';
    if ($language_widget && $has_translations) {
      $form['langcode']['#options'] = array();
153
      foreach (language_list(LanguageInterface::STATE_CONFIGURABLE) as $language) {
154 155
        if (empty($translations[$language->id]) || $language->id == $entity_langcode) {
          $form['langcode']['#options'][$language->id] = $language->name;
156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
        }
      }
    }

    if ($is_translation) {
      if ($language_widget) {
        $form['langcode']['#access'] = FALSE;
      }

      // Replace the delete button with the delete translation one.
      if (!$new_translation) {
        $weight = 100;
        foreach (array('delete', 'submit') as $key) {
          if (isset($form['actions'][$key]['weight'])) {
            $weight = $form['actions'][$key]['weight'];
            break;
          }
        }
        $form['actions']['delete_translation'] = array(
          '#type' => 'submit',
          '#value' => t('Delete translation'),
          '#weight' => $weight,
          '#submit' => array(array($this, 'entityFormDeleteTranslation')),
179
          '#access' => $this->getTranslationAccess($entity, 'delete')->isAllowed(),
180 181 182 183 184 185 186 187 188 189
        );
      }

      // Always remove the delete button on translation forms.
      unset($form['actions']['delete']);
    }

    // We need to display the translation tab only when there is at least one
    // translation available or a new one is about to be created.
    if ($new_translation || $has_translations) {
190
      $form['content_translation'] = array(
191
        '#type' => 'details',
192 193 194
        '#title' => t('Translation'),
        '#tree' => TRUE,
        '#weight' => 10,
195
        '#access' => $this->getTranslationAccess($entity, $source_langcode ? 'create' : 'update')->isAllowed(),
196 197 198
        '#multilingual' => TRUE,
      );

199 200 201 202 203 204 205 206 207
      // A new translation is enabled by default.
      $status = $new_translation || $entity->translation[$form_langcode]['status'];
      // If there is only one published translation we cannot unpublish it,
      // since there would be nothing left to display.
      $enabled = TRUE;
      if ($status) {
        // A new translation is not available in the translation metadata, hence
        // it should count as one more.
        $published = $new_translation;
208 209 210 211 212 213
        // When creating a brand new translation, $entity->translation is not
        // set.
        if (!$new_translation) {
          foreach ($entity->translation as $translation) {
            $published += $translation['status'];
          }
214 215 216 217 218 219 220
        }
        $enabled = $published > 1;
      }
      $description = $enabled ?
        t('An unpublished translation will not be visible without translation permissions.') :
        t('Only this translation is published. You must publish at least one more translation to unpublish this one.');

221
      $form['content_translation']['status'] = array(
222 223 224 225 226 227 228 229
        '#type' => 'checkbox',
        '#title' => t('This translation is published'),
        '#default_value' => $status,
        '#description' => $description,
        '#disabled' => !$enabled,
      );

      $translate = !$new_translation && $entity->translation[$form_langcode]['outdated'];
230
      if (!$translate) {
231
        $form['content_translation']['retranslate'] = array(
232 233 234 235 236 237 238
          '#type' => 'checkbox',
          '#title' => t('Flag other translations as outdated'),
          '#default_value' => FALSE,
          '#description' => t('If you made a significant change, which means the other translations should be updated, you can flag all translations of this content as outdated. This will not change any other property of them, like whether they are published or not.'),
        );
      }
      else {
239
        $form['content_translation']['outdated'] = array(
240 241 242 243 244 245 246
          '#type' => 'checkbox',
          '#title' => t('This translation needs to be updated'),
          '#default_value' => $translate,
          '#description' => t('When this option is checked, this translation needs to be updated. Uncheck when the translation is up to date again.'),
        );
      }

247 248 249
      // Default to the anonymous user.
      $name = '';
      if ($new_translation) {
250
        $name = \Drupal::currentUser()->getUsername();
251 252 253 254
      }
      elseif ($entity->translation[$form_langcode]['uid']) {
        $name = user_load($entity->translation[$form_langcode]['uid'])->getUsername();
      }
255
      $form['content_translation']['name'] = array(
256 257 258
        '#type' => 'textfield',
        '#title' => t('Authored by'),
        '#maxlength' => 60,
259
        '#autocomplete_route_name' => 'user.autocomplete',
260
        '#default_value' => $name,
261
        '#description' => t('Leave blank for %anonymous.', array('%anonymous' => \Drupal::config('user.settings')->get('anonymous'))),
262 263 264
      );

      $date = $new_translation ? REQUEST_TIME : $entity->translation[$form_langcode]['created'];
265
      $form['content_translation']['created'] = array(
266 267 268 269 270 271 272
        '#type' => 'textfield',
        '#title' => t('Authored on'),
        '#maxlength' => 25,
        '#description' => t('Format: %time. The date format is YYYY-MM-DD and %timezone is the time zone offset from UTC. Leave blank to use the time of form submission.', array('%time' => format_date($date, 'custom', 'Y-m-d H:i:s O'), '%timezone' => format_date($date, 'custom', 'O'))),
        '#default_value' => $new_translation ? '' : format_date($date, 'custom', 'Y-m-d H:i:s O'),
      );

273
      if ($language_widget) {
274
        $form['langcode']['#multilingual'] = TRUE;
275 276 277 278 279 280 281 282
      }

      $form['#process'][] = array($this, 'entityFormSharedElements');
    }

    // Process the submitted values before they are stored.
    $form['#entity_builders'][] = array($this, 'entityFormEntityBuild');

283 284 285 286 287
    // Handle entity validation.
    if (isset($form['actions']['submit'])) {
      $form['actions']['submit']['#validate'][] = array($this, 'entityFormValidate');
    }

288 289 290 291 292 293 294
    // Handle entity deletion.
    if (isset($form['actions']['delete'])) {
      $form['actions']['delete']['#submit'][] = array($this, 'entityFormDelete');
    }
  }

  /**
295
   * Process callback: determines which elements get clue in the form.
296
   *
297
   * @see \Drupal\content_translation\ContentTranslationHandler::entityFormAlter()
298
   */
299
  public function entityFormSharedElements($element, FormStateInterface $form_state, $form) {
300 301 302 303 304
    static $ignored_types;

    // @todo Find a more reliable way to determine if a form element concerns a
    //   multilingual value.
    if (!isset($ignored_types)) {
305
      $ignored_types = array_flip(array('actions', 'value', 'hidden', 'vertical_tabs', 'token', 'details'));
306 307
    }

308
    foreach (Element::children($element) as $key) {
309
      if (!isset($element[$key]['#type'])) {
310
        $this->entityFormSharedElements($element[$key], $form_state, $form);
311 312 313 314 315 316 317 318
      }
      else {
        // Ignore non-widget form elements.
        if (isset($ignored_types[$element[$key]['#type']])) {
          continue;
        }
        // Elements are considered to be non multilingual by default.
        if (empty($element[$key]['#multilingual'])) {
319 320 321
          // If we are displaying a multilingual entity form we need to provide
          // translatability clues, otherwise the shared form elements should be
          // hidden.
322
          if (!$form_state->get(['content_translation', 'translation_form'])) {
323 324 325 326 327
            $this->addTranslatabilityClue($element[$key]);
          }
          else {
            $element[$key]['#access'] = FALSE;
          }
328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349
        }
      }
    }

    return $element;
  }

  /**
   * Adds a clue about the form element translatability.
   *
   * If the given element does not have a #title attribute, the function is
   * recursively applied to child elements.
   *
   * @param array $element
   *   A form element array.
   */
  protected function addTranslatabilityClue(&$element) {
    static $suffix, $fapi_title_elements;

    // Elements which can have a #title attribute according to FAPI Reference.
    if (!isset($suffix)) {
      $suffix = ' <span class="translation-entity-all-languages">(' . t('all languages') . ')</span>';
350
      $fapi_title_elements = array_flip(array('checkbox', 'checkboxes', 'date', 'details', 'fieldset', 'file', 'item', 'password', 'password_confirm', 'radio', 'radios', 'select', 'text_format', 'textarea', 'textfield', 'weight'));
351 352 353 354 355 356 357 358 359 360
    }

    // Update #title attribute for all elements that are allowed to have a
    // #title attribute according to the Form API Reference. The reason for this
    // check is because some elements have a #title attribute even though it is
    // not rendered, e.g. field containers.
    if (isset($element['#type']) && isset($fapi_title_elements[$element['#type']]) && isset($element['#title'])) {
      $element['#title'] .= $suffix;
    }
    // If the current element does not have a (valid) title, try child elements.
361
    elseif ($children = Element::children($element)) {
362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380
      foreach ($children as $delta) {
        $this->addTranslatabilityClue($element[$delta], $suffix);
      }
    }
    // If there are no children, fall back to the current #title attribute if it
    // exists.
    elseif (isset($element['#title'])) {
      $element['#title'] .= $suffix;
    }
  }

  /**
   * Entity builder method.
   *
   * @param string $entity_type
   *   The type of the entity.
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   The entity whose form is being built.
   *
381
   * @see \Drupal\content_translation\ContentTranslationHandler::entityFormAlter()
382
   */
383
  public function entityFormEntityBuild($entity_type, EntityInterface $entity, array $form, FormStateInterface $form_state) {
384 385
    $form_object = $form_state->getFormObject();
    $form_langcode = $form_object->getFormLangcode($form_state);
386

387 388
    if (!isset($entity->translation[$form_langcode])) {
      $entity->translation[$form_langcode] = array();
389
    }
390
    $values = $form_state->getValue('content_translation', array());
391
    $translation = &$entity->translation[$form_langcode];
392

393 394
    // @todo Use the entity setter when all entities support multilingual
    // properties.
395
    $translation['uid'] = !empty($values['name']) && ($account = user_load_by_name($values['name'])) ? $account->id() : 0;
396 397 398
    $translation['status'] = !empty($values['status']);
    $translation['created'] = !empty($values['created']) ? strtotime($values['created']) : REQUEST_TIME;
    $translation['changed'] = REQUEST_TIME;
399

400 401 402 403 404 405
    $source_langcode = $this->getSourceLangcode($form_state);
    if ($source_langcode) {
      $translation['source'] = $source_langcode;
    }

    $translation['outdated'] = !empty($values['outdated']);
406 407 408
    if (!empty($values['retranslate'])) {
      $this->retranslate($entity, $form_langcode);
    }
409 410

    // Set contextual information that can be reused during the storage phase.
411 412
    // @todo Remove this once translation metadata are converted to regular
    //   fields.
413
    $attributes = \Drupal::request()->attributes;
414
    $attributes->set('source_langcode', $source_langcode);
415 416
  }

417
  /**
418
   * Form validation handler for ContentTranslationHandler::entityFormAlter().
419
   *
420
   * Validates the submitted content translation metadata.
421
   */
422
  function entityFormValidate($form, FormStateInterface $form_state) {
423 424
    if (!$form_state->isValueEmpty('content_translation')) {
      $translation = $form_state->getValue('content_translation');
425 426
      // Validate the "authored by" field.
      if (!empty($translation['name']) && !($account = user_load_by_name($translation['name']))) {
427
        $form_state->setErrorByName('content_translation][name', t('The translation authoring username %name does not exist.', array('%name' => $translation['name'])));
428 429 430
      }
      // Validate the "authored on" field.
      if (!empty($translation['created']) && strtotime($translation['created']) === FALSE) {
431
        $form_state->setErrorByName('content_translation][created', t('You have to specify a valid translation authoring date.'));
432 433 434 435
      }
    }
  }

436
  /**
437
   * Form submission handler for ContentTranslationHandler::entityFormAlter().
438 439 440
   *
   * Takes care of the source language change.
   */
441
  public function entityFormSourceChange($form, FormStateInterface $form_state) {
442 443
    $form_object = $form_state->getFormObject();
    $entity = $form_object->getEntity();
444
    $source = $form_state->getValue(array('source_langcode', 'source'));
445

446 447 448 449
    $entity_type_id = $entity->getEntityTypeId();
    $form_state->setRedirect('content_translation.translation_add_' . $entity_type_id, array(
      $entity_type_id => $entity->id(),
      'source' => $source,
450
      'target' => $form_object->getFormLangcode($form_state),
451
    ));
452 453 454 455 456
    $languages = language_list();
    drupal_set_message(t('Source language set to: %language', array('%language' => $languages[$source]->name)));
  }

  /**
457
   * Form submission handler for ContentTranslationHandler::entityFormAlter().
458 459 460
   *
   * Takes care of entity deletion.
   */
461
  function entityFormDelete($form, FormStateInterface $form_state) {
462 463
    $form_object = $form_state->getFormObject()->getEntity();
    $entity = $form_object->getEntity();
464 465 466 467 468 469
    if (count($entity->getTranslationLanguages()) > 1) {
      drupal_set_message(t('This will delete all the translations of %label.', array('%label' => $entity->label())), 'warning');
    }
  }

  /**
470
   * Form submission handler for ContentTranslationHandler::entityFormAlter().
471
   *
472
   * Takes care of content translation deletion.
473
   */
474
  function entityFormDeleteTranslation($form, FormStateInterface $form_state) {
475 476
    $form_object = $form_state->getFormObject();
    $entity = $form_object->getEntity();
477
    $entity_type_id = $entity->getEntityTypeId();
478
    $form_state->setRedirect('content_translation.translation_delete_' . $entity_type_id, array(
479
      $entity_type_id => $entity->id(),
480
      'language' => $form_object->getFormLangcode($form_state),
481
    ));
482 483 484 485 486 487 488 489 490 491 492 493 494
  }

  /**
   * Returns the title to be used for the entity form page.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   The entity whose form is being altered.
   */
  protected function entityFormTitle(EntityInterface $entity) {
    return $entity->label();
  }

}