ContentTranslationHandler.php 18.7 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\Entity\EntityInterface;
11
use Drupal\Core\Entity\EntityTypeInterface;
12
use Drupal\Core\Language\LanguageInterface;
13
use Drupal\Core\Render\Element;
14 15

/**
16
 * Base class for content translation handlers.
17
 */
18
class ContentTranslationHandler implements ContentTranslationHandlerInterface {
19 20 21 22 23 24

  /**
   * The type of the entity being translated.
   *
   * @var string
   */
25
  protected $entityTypeId;
26 27

  /**
28
   * Information about the entity type.
29
   *
30
   * @var \Drupal\Core\Entity\EntityTypeInterface
31
   */
32
  protected $entityType;
33 34

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

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

  /**
57
   * {@inheritdoc}
58
   */
59 60 61
  public function getTranslationAccess(EntityInterface $entity, $op) {
    // @todo Move this logic into a translation access controller checking also
    //   the translation language and the given account.
62
    $entity_type = $entity->getEntityType();
63 64 65
    $translate_permission = TRUE;
    // If no permission granularity is defined this entity type does not need an
    // explicit translate permission.
66
    if (!user_access('translate any entity') && $permission_granularity = $entity_type->getPermissionGranularity()) {
67
      $translate_permission = user_access($permission_granularity == 'bundle' ? "translate {$entity->bundle()} {$entity->getEntityTypeId()}" : "translate {$entity->getEntityTypeId()}");
68
    }
69
    return $translate_permission && user_access("$op content translations");
70 71 72
  }

  /**
73
   * {@inheritdoc}
74 75
   */
  public function getSourceLangcode(array $form_state) {
76
    return isset($form_state['content_translation']['source']) ? $form_state['content_translation']['source']->id : FALSE;
77 78 79
  }

  /**
80
   * {@inheritdoc}
81 82
   */
  public function entityFormAlter(array &$form, array &$form_state, EntityInterface $entity) {
83
    $form_controller = content_translation_form_controller($form_state);
84
    $form_langcode = $form_controller->getFormLangcode($form_state);
85
    $entity_langcode = $entity->getUntranslated()->language()->id;
86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102
    $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]);
    }
    $is_translation = !$form_controller->isDefaultFormLangcode($form_state);
    $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.
103
      if ($form_langcode != $entity_langcode) {
104 105 106
        $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);
      }
107
      $form['#title'] = $title;
108 109 110 111 112 113
    }

    // 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(
114
        '#type' => 'details',
115 116 117 118 119
        '#title' => t('Source language: @language', array('@language' => $languages[$source_langcode]->name)),
        '#tree' => TRUE,
        '#weight' => -100,
        '#multilingual' => TRUE,
        'source' => array(
120 121
          '#title' => t('Select source language'),
          '#title_display' => 'invisible',
122 123 124 125 126 127 128 129 130 131
          '#type' => 'select',
          '#default_value' => $source_langcode,
          '#options' => array(),
        ),
        'submit' => array(
          '#type' => 'submit',
          '#value' => t('Change'),
          '#submit' => array(array($this, 'entityFormSourceChange')),
        ),
      );
132
      foreach (language_list(LanguageInterface::STATE_CONFIGURABLE) as $language) {
133 134
        if (isset($translations[$language->id])) {
          $form['source_langcode']['source']['#options'][$language->id] = $language->name;
135 136 137 138 139 140 141 142 143 144
        }
      }
    }

    // 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();
145
      foreach (language_list(LanguageInterface::STATE_CONFIGURABLE) as $language) {
146 147
        if (empty($translations[$language->id]) || $language->id == $entity_langcode) {
          $form['langcode']['#options'][$language->id] = $language->name;
148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170
        }
      }
    }

    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')),
171
          '#access' => $this->getTranslationAccess($entity, 'delete'),
172 173 174 175 176 177 178 179 180 181
        );
      }

      // 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) {
182
      $form['content_translation'] = array(
183
        '#type' => 'details',
184 185 186
        '#title' => t('Translation'),
        '#tree' => TRUE,
        '#weight' => 10,
187
        '#access' => $this->getTranslationAccess($entity, $source_langcode ? 'create' : 'update'),
188 189 190
        '#multilingual' => TRUE,
      );

191 192 193 194 195 196 197 198 199
      // 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;
200
        foreach ($entity->translation as $translation) {
201 202 203 204 205 206 207 208
          $published += $translation['status'];
        }
        $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.');

209
      $form['content_translation']['status'] = array(
210 211 212 213 214 215 216 217
        '#type' => 'checkbox',
        '#title' => t('This translation is published'),
        '#default_value' => $status,
        '#description' => $description,
        '#disabled' => !$enabled,
      );

      $translate = !$new_translation && $entity->translation[$form_langcode]['outdated'];
218
      if (!$translate) {
219
        $form['content_translation']['retranslate'] = array(
220 221 222 223 224 225 226
          '#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 {
227
        $form['content_translation']['outdated'] = array(
228 229 230 231 232 233 234
          '#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.'),
        );
      }

235 236 237
      // Default to the anonymous user.
      $name = '';
      if ($new_translation) {
238
        $name = \Drupal::currentUser()->getUsername();
239 240 241 242
      }
      elseif ($entity->translation[$form_langcode]['uid']) {
        $name = user_load($entity->translation[$form_langcode]['uid'])->getUsername();
      }
243
      $form['content_translation']['name'] = array(
244 245 246
        '#type' => 'textfield',
        '#title' => t('Authored by'),
        '#maxlength' => 60,
247
        '#autocomplete_route_name' => 'user.autocomplete',
248
        '#default_value' => $name,
249
        '#description' => t('Leave blank for %anonymous.', array('%anonymous' => \Drupal::config('user.settings')->get('anonymous'))),
250 251 252
      );

      $date = $new_translation ? REQUEST_TIME : $entity->translation[$form_langcode]['created'];
253
      $form['content_translation']['created'] = array(
254 255 256 257 258 259 260
        '#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'),
      );

261
      if ($language_widget) {
262
        $form['langcode']['#multilingual'] = TRUE;
263 264 265 266 267 268 269 270
      }

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

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

271 272 273 274 275
    // Handle entity validation.
    if (isset($form['actions']['submit'])) {
      $form['actions']['submit']['#validate'][] = array($this, 'entityFormValidate');
    }

276 277 278 279 280 281 282
    // Handle entity deletion.
    if (isset($form['actions']['delete'])) {
      $form['actions']['delete']['#submit'][] = array($this, 'entityFormDelete');
    }
  }

  /**
283
   * Process callback: determines which elements get clue in the form.
284
   *
285
   * @see \Drupal\content_translation\ContentTranslationHandler::entityFormAlter()
286
   */
287
  public function entityFormSharedElements($element, $form_state, $form) {
288 289 290 291 292
    static $ignored_types;

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

296
    foreach (Element::children($element) as $key) {
297
      if (!isset($element[$key]['#type'])) {
298
        $this->entityFormSharedElements($element[$key], $form_state, $form);
299 300 301 302 303 304 305 306
      }
      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'])) {
307 308 309
          // If we are displaying a multilingual entity form we need to provide
          // translatability clues, otherwise the shared form elements should be
          // hidden.
310
          if (empty($form_state['content_translation']['translation_form'])) {
311 312 313 314 315
            $this->addTranslatabilityClue($element[$key]);
          }
          else {
            $element[$key]['#access'] = FALSE;
          }
316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337
        }
      }
    }

    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>';
338
      $fapi_title_elements = array_flip(array('checkbox', 'checkboxes', 'date', 'details', 'fieldset', 'file', 'item', 'password', 'password_confirm', 'radio', 'radios', 'select', 'text_format', 'textarea', 'textfield', 'weight'));
339 340 341 342 343 344 345 346 347 348
    }

    // 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.
349
    elseif ($children = Element::children($element)) {
350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368
      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.
   *
369
   * @see \Drupal\content_translation\ContentTranslationHandler::entityFormAlter()
370 371
   */
  public function entityFormEntityBuild($entity_type, EntityInterface $entity, array $form, array &$form_state) {
372
    $form_controller = content_translation_form_controller($form_state);
373 374
    $form_langcode = $form_controller->getFormLangcode($form_state);

375 376
    if (!isset($entity->translation[$form_langcode])) {
      $entity->translation[$form_langcode] = array();
377
    }
378
    $values = isset($form_state['values']['content_translation']) ? $form_state['values']['content_translation'] : array();
379
    $translation = &$entity->translation[$form_langcode];
380

381 382
    // @todo Use the entity setter when all entities support multilingual
    // properties.
383
    $translation['uid'] = !empty($values['name']) && ($account = user_load_by_name($values['name'])) ? $account->id() : 0;
384 385 386
    $translation['status'] = !empty($values['status']);
    $translation['created'] = !empty($values['created']) ? strtotime($values['created']) : REQUEST_TIME;
    $translation['changed'] = REQUEST_TIME;
387

388 389 390 391 392 393
    $source_langcode = $this->getSourceLangcode($form_state);
    if ($source_langcode) {
      $translation['source'] = $source_langcode;
    }

    $translation['outdated'] = !empty($values['outdated']);
394 395 396
    if (!empty($values['retranslate'])) {
      $this->retranslate($entity, $form_langcode);
    }
397 398

    // Set contextual information that can be reused during the storage phase.
399 400
    // @todo Remove this once translation metadata are converted to regular
    //   fields.
401
    $attributes = \Drupal::request()->attributes;
402
    $attributes->set('source_langcode', $source_langcode);
403 404
  }

405
  /**
406
   * Form validation handler for ContentTranslationHandler::entityFormAlter().
407
   *
408
   * Validates the submitted content translation metadata.
409 410
   */
  function entityFormValidate($form, &$form_state) {
411 412
    if (!empty($form_state['values']['content_translation'])) {
      $translation = $form_state['values']['content_translation'];
413 414
      // Validate the "authored by" field.
      if (!empty($translation['name']) && !($account = user_load_by_name($translation['name']))) {
415
        form_set_error('content_translation][name', $form_state, t('The translation authoring username %name does not exist.', array('%name' => $translation['name'])));
416 417 418
      }
      // Validate the "authored on" field.
      if (!empty($translation['created']) && strtotime($translation['created']) === FALSE) {
419
        form_set_error('content_translation][created', $form_state, t('You have to specify a valid translation authoring date.'));
420 421 422 423
      }
    }
  }

424
  /**
425
   * Form submission handler for ContentTranslationHandler::entityFormAlter().
426 427 428 429
   *
   * Takes care of the source language change.
   */
  public function entityFormSourceChange($form, &$form_state) {
430
    $form_controller = content_translation_form_controller($form_state);
431
    $entity = $form_controller->getEntity();
432
    $source = $form_state['values']['source_langcode']['source'];
433

434 435
    $path = $entity->getSystemPath('drupal:content-translation-overview');
    $form_state['redirect'] = $path . '/add/' . $source . '/' . $form_controller->getFormLangcode($form_state);
436 437 438 439 440
    $languages = language_list();
    drupal_set_message(t('Source language set to: %language', array('%language' => $languages[$source]->name)));
  }

  /**
441
   * Form submission handler for ContentTranslationHandler::entityFormAlter().
442 443 444 445
   *
   * Takes care of entity deletion.
   */
  function entityFormDelete($form, &$form_state) {
446
    $form_controller = content_translation_form_controller($form_state);
447
    $entity = $form_controller->getEntity();
448 449 450 451 452 453
    if (count($entity->getTranslationLanguages()) > 1) {
      drupal_set_message(t('This will delete all the translations of %label.', array('%label' => $entity->label())), 'warning');
    }
  }

  /**
454
   * Form submission handler for ContentTranslationHandler::entityFormAlter().
455
   *
456
   * Takes care of content translation deletion.
457 458
   */
  function entityFormDeleteTranslation($form, &$form_state) {
459
    $form_controller = content_translation_form_controller($form_state);
460
    $entity = $form_controller->getEntity();
461
    $path = $entity->getSystemPath('drupal:content-translation-overview');
462
    $form_langcode = $form_controller->getFormLangcode($form_state);
463
    $form_state['redirect'] = $path . '/delete/' . $form_langcode;
464 465 466 467 468 469 470 471 472 473 474 475 476
  }

  /**
   * 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();
  }

}