content_translation.admin.inc 22.5 KB
Newer Older
1 2 3 4
<?php

/**
 * @file
5
 * The content translation administration forms.
6 7 8
 */

use Drupal\Core\Entity\EntityInterface;
9
use Drupal\Core\Entity\Field\FieldDefinitionInterface;
10
use Drupal\Core\Language\Language;
11
use Drupal\field\Field as FieldService;
12

13
/**
14
 * Returns a form element to configure field synchronization.
15
 *
16 17
 * @param \Drupal\Core\Entity\Field\FieldDefinitionInterface $field
 *   A field definition object.
18 19 20 21
 *
 * @return array
 *   A form element to configure field synchronization.
 */
22
function content_translation_field_sync_widget(FieldDefinitionInterface $field) {
23 24
  $element = array();

25 26
  $column_groups = $field->getFieldSetting('column_groups');
  if (!empty($column_groups) && count($column_groups) > 1) {
27 28 29
    $options = array();
    $default = array();

30
    foreach ($column_groups as $group => $info) {
31 32 33 34
      $options[$group] = $info['label'];
      $default[$group] = !empty($info['translatable']) ? $group : FALSE;
    }

35 36
    $settings = array('dependent_selectors' => array('instance[settings][translation_sync]' => array('file')));

37
    $translation_sync = $field->getFieldSetting('translation_sync');
38 39 40 41
    $element = array(
      '#type' => 'checkboxes',
      '#title' => t('Translatable elements'),
      '#options' => $options,
42
      '#default_value' => !empty($translation_sync) ? $translation_sync : $default,
43
      '#attached' => array(
44
        'library' => array(
45
          array('content_translation', 'drupal.content_translation.admin'),
46
        ),
47
        'js' => array(
48
          array('data' => array('contentTranslationDependentOptions' => $settings), 'type' => 'setting'),
49 50
        ),
      ),
51 52 53 54 55 56 57 58
    );
  }

  return $element;
}

/**
 * (proxied) Implements hook_form_FORM_ID_alter().
59
 */
60
function _content_translation_form_language_content_settings_form_alter(array &$form, array &$form_state) {
61 62
  // Inject into the content language settings the translation settings if the
  // user has the required permission.
63
  if (!user_access('administer content translation')) {
64 65 66 67 68
    return;
  }

  $default = $form['entity_types']['#default_value'];
  foreach ($default as $entity_type => $enabled) {
69
    $default[$entity_type] = $enabled || content_translation_enabled($entity_type) ? $entity_type : FALSE;
70 71 72
  }
  $form['entity_types']['#default_value'] = $default;

73 74
  $form['#attached']['library'][] = array('content_translation', 'drupal.content_translation.admin');
  $form['#attached']['js'][] = array('data' => drupal_get_path('module', 'content_translation') . '/content_translation.admin.js', 'type' => 'file');
75

76
  $dependent_options_settings = array();
77
  $entity_manager = Drupal::entityManager();
78
  foreach ($form['#labels'] as $entity_type => $label) {
79
    $entity_info = entity_get_info($entity_type);
80
    foreach (entity_get_bundles($entity_type) as $bundle => $bundle_info) {
81 82 83
      // Here we do not want the widget to be altered and hold also the "Enable
      // translation" checkbox, which would be redundant. Hence we add this key
      // to be able to skip alterations.
84
      $form['settings'][$entity_type][$bundle]['settings']['language']['#content_translation_skip_alter'] = TRUE;
85

86 87 88
      // Only show the checkbox to enable translation if the bundles in the
      // entity might have fields and if there are fields to translate.
      if (!empty($entity_info['fieldable'])) {
89 90
        $fields = $entity_manager->getFieldDefinitions($entity_type, $bundle);
        if ($fields) {
91 92
          $form['settings'][$entity_type][$bundle]['translatable'] = array(
            '#type' => 'checkbox',
93
            '#default_value' => content_translation_enabled($entity_type, $bundle),
94 95
          );

96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118
          $field_settings = content_translation_get_config($entity_type, $bundle, 'fields');
          foreach ($fields as $field_name => $definition) {
            $translatable = !empty($field_settings[$field_name]);

            // We special case Field API fields as they always natively support
            // translation.
            // @todo Remove this special casing as soon as configurable and
            //   base field definitions are "unified".
            if (!empty($definition['configurable']) && ($field = FieldService::fieldInfo()->getField($entity_type, $field_name))) {
              $instance = FieldService::fieldInfo()->getInstance($entity_type, $bundle, $field_name);
              $form['settings'][$entity_type][$bundle]['fields'][$field_name] = array(
                '#label' => $instance->getFieldLabel(),
                '#type' => 'checkbox',
                '#default_value' => $translatable,
              );
              $column_element = content_translation_field_sync_widget($instance);
              if ($column_element) {
                $form['settings'][$entity_type][$bundle]['columns'][$field_name] = $column_element;

                // @todo This should not concern only files.
                if (isset($column_element['#options']['file'])) {
                  $dependent_options_settings["settings[{$entity_type}][{$bundle}][columns][{$field_name}]"] = array('file');
                }
119 120
              }
            }
121 122 123 124 125 126 127 128 129 130 131
            // Instead we need to rely on field definitions to determine whether
            // fields support translation. Whether they are actually enabled is
            // determined through our settings. As a consequence only fields
            // that support translation can be enabled or disabled.
            elseif (isset($field_settings[$field_name]) || !empty($definition['translatable'])) {
              $form['settings'][$entity_type][$bundle]['fields'][$field_name] = array(
                '#label' => $definition['label'],
                '#type' => 'checkbox',
                '#default_value' => $translatable,
              );
            }
132
          }
133
        }
134 135 136
      }
    }
  }
137
  $settings = array('dependent_selectors' => $dependent_options_settings);
138 139 140
  $form['#attached']['js'][] = array('data' => array('contentTranslationDependentOptions' => $settings), 'type' => 'setting');
  $form['#validate'][] = 'content_translation_form_language_content_settings_validate';
  $form['#submit'][] = 'content_translation_form_language_content_settings_submit';
141 142
}

143 144 145
/**
 * (proxied) Implements hook_preprocess_HOOK();
 */
146
function _content_translation_preprocess_language_content_settings_table(&$variables) {
147 148
  // Alter the 'build' variable injecting the translation settings if the user
  // has the required permission.
149
  if (!user_access('administer content translation')) {
150 151 152 153 154 155 156 157 158 159 160
    return;
  }

  $element = $variables['element'];
  $build = &$variables['build'];

  array_unshift($build['#header'], array('data' => t('Translatable'), 'class' => array('translatable')));
  $rows = array();

  foreach (element_children($element) as $bundle) {
    $field_names = !empty($element[$bundle]['fields']) ? element_children($element[$bundle]['fields']) : array();
161 162 163
    if (!empty($element[$bundle]['translatable'])) {
      $checkbox_id = $element[$bundle]['translatable']['#id'];
    }
164 165
    $rows[$bundle] = $build['#rows'][$bundle];

166 167 168 169 170 171
    if (!empty($element[$bundle]['translatable'])) {
      $translatable = array(
        'data' => $element[$bundle]['translatable'],
        'class' => array('translatable'),
      );
      array_unshift($rows[$bundle]['data'], $translatable);
172

173 174 175 176 177 178 179 180
      $rows[$bundle]['data'][1]['data']['#prefix'] = '<label for="' . $checkbox_id . '">';
    }
    else {
      $translatable = array(
        'class' => array('untranslatable'),
      );
      array_unshift($rows[$bundle]['data'], $translatable);
    }
181 182 183 184 185 186 187 188 189 190 191 192 193 194

    foreach ($field_names as $field_name) {
      $field_element = &$element[$bundle]['fields'][$field_name];
      $rows[] = array(
        'data' => array(
          array(
            'data' => drupal_render($field_element),
            'class' => array('translatable'),
          ),
          array(
            'data' => array(
              '#prefix' => '<label for="' . $field_element['#id'] . '">',
              '#suffix' => '</label>',
              'bundle' => array(
195
                '#prefix' => '<span class="visually-hidden">',
196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228
                '#suffix' => '</span> ',
                '#markup' => check_plain($element[$bundle]['settings']['#label']),
              ),
              'field' => array(
                '#markup' => check_plain($field_element['#label']),
              ),
            ),
            'class' => array('field'),
          ),
          array(
            'data' => '',
            'class' => array('operations'),
          ),
        ),
        'class' => array('field-settings'),
      );

      if (!empty($element[$bundle]['columns'][$field_name])) {
        $column_element = &$element[$bundle]['columns'][$field_name];
        foreach (element_children($column_element) as $key) {
          $column_label = $column_element[$key]['#title'];
          unset($column_element[$key]['#title']);
          $rows[] = array(
            'data' => array(
              array(
                'data' => drupal_render($column_element[$key]),
                'class' => array('translatable'),
              ),
              array(
                'data' => array(
                  '#prefix' => '<label for="' . $column_element[$key]['#id'] . '">',
                  '#suffix' => '</label>',
                  'bundle' => array(
229
                    '#prefix' => '<span class="visually-hidden">',
230 231 232 233
                    '#suffix' => '</span> ',
                    '#markup' => check_plain($element[$bundle]['settings']['#label']),
                  ),
                  'field' => array(
234
                    '#prefix' => '<span class="visually-hidden">',
235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258
                    '#suffix' => '</span> ',
                    '#markup' => check_plain($field_element['#label']),
                  ),
                  'columns' => array(
                    '#markup' => check_plain($column_label),
                  ),
                ),
                'class' => array('column'),
              ),
              array(
                'data' => '',
                'class' => array('operations'),
              ),
            ),
            'class' => array('column-settings'),
          );
        }
      }
    }
  }

  $build['#rows'] = $rows;
}

259
/**
260
 * Form validation handler for content_translation_admin_settings_form().
261
 *
262
 * @see content_translation_admin_settings_form_submit()
263
 */
264
function content_translation_form_language_content_settings_validate(array $form, array &$form_state) {
265 266 267 268 269 270 271 272 273 274 275 276 277
  $settings = &$form_state['values']['settings'];
  foreach ($settings as $entity_type => $entity_settings) {
    foreach ($entity_settings as $bundle => $bundle_settings) {
      if (!empty($bundle_settings['translatable'])) {
        $name = "settings][$entity_type][$bundle][translatable";

        $translatable_fields = isset($settings[$entity_type][$bundle]['fields']) ? array_filter($settings[$entity_type][$bundle]['fields']) : FALSE;
        if (empty($translatable_fields)) {
          $t_args = array('%bundle' => $form['settings'][$entity_type][$bundle]['settings']['#label']);
          form_set_error($name, t('At least one field needs to be translatable to enable %bundle for translation.', $t_args));
        }

        $values = $bundle_settings['settings']['language'];
278
        if (language_is_locked($values['langcode']) && empty($values['language_show'])) {
279
          foreach (language_list(Language::STATE_LOCKED) as $language) {
280 281 282 283 284 285 286 287 288 289
            $locked_languages[] = $language->name;
          }
          form_set_error($name, t('Translation is not supported if language is always one of: @locked_languages', array('@locked_languages' => implode(', ', $locked_languages))));
        }
      }
    }
  }
}

/**
290
 * Form submission handler for content_translation_admin_settings_form().
291
 *
292
 * @see content_translation_admin_settings_form_validate()
293
 */
294
function content_translation_form_language_content_settings_submit(array $form, array &$form_state) {
295 296 297 298 299 300 301 302
  $entity_types = $form_state['values']['entity_types'];
  $settings = &$form_state['values']['settings'];

  // If an entity type is not translatable all its bundles and fields must be
  // marked as non-translatable. Similarly, if a bundle is made non-translatable
  // all of its fields will be not translatable.
  foreach ($settings as $entity_type => &$entity_settings) {
    foreach ($entity_settings as $bundle => &$bundle_settings) {
303 304 305
      if (!empty($bundle_settings['translatable'])) {
        $bundle_settings['translatable'] = $bundle_settings['translatable'] && $entity_types[$entity_type];
      }
306 307 308
      if (!empty($bundle_settings['fields'])) {
        foreach ($bundle_settings['fields'] as $field_name => $translatable) {
          $bundle_settings['fields'][$field_name] = $translatable && $bundle_settings['translatable'];
309 310 311 312 313
          // If we have column settings and no column is translatable, no point
          // in making the field translatable.
          if (isset($bundle_settings['columns'][$field_name]) && !array_filter($bundle_settings['columns'][$field_name])) {
            $bundle_settings['fields'][$field_name] = FALSE;
          }
314 315 316 317 318
        }
      }
    }
  }

319
  _content_translation_update_field_translatability($settings);
320 321 322 323
  drupal_set_message(t('Settings successfully updated.'));
}

/**
324
 * Stores content translation settings.
325 326 327 328 329 330 331 332 333 334 335 336 337
 *
 * @param array $settings
 *   An associative array of settings keyed by entity type and bundle. At bundle
 *   level the following keys are available:
 *   - translatable: The bundle translatability status, which is a bool.
 *   - settings: An array of language configuration settings as defined by
 *     language_save_default_configuration().
 *   - fields: An associative array with field names as keys and a boolean as
 *     value, indicating field translatability.
 *
 * @todo Remove this migration entirely once the Field API is converted to the
 *   Entity Field API.
 */
338
function _content_translation_update_field_translatability($settings) {
339 340 341 342 343 344 345 346 347 348
  $fields = array();
  foreach ($settings as $entity_type => $entity_settings) {
    foreach ($entity_settings as $bundle => $bundle_settings) {
      // Collapse field settings since here we have per instance settings, but
      // translatability has per-field scope. We assume that all the field
      // instances have the same value.
      if (!empty($bundle_settings['fields'])) {
        foreach ($bundle_settings['fields'] as $field_name => $translatable) {
          // If a field is enabled for translation for at least one instance we
          // need to mark it as translatable.
349 350 351
          if (FieldService::fieldInfo()->getField($entity_type, $field_name)) {
            $fields[$entity_type][$field_name] = $translatable || !empty($fields[$entity_type][$field_name]);
          }
352 353 354 355 356 357
        }
      }
    }
  }

  $operations = array();
358 359 360
  foreach ($fields as $entity_type => $entity_type_fields) {
    foreach ($entity_type_fields as $field_name => $translatable) {
      $field = field_info_field($entity_type, $field_name);
361
      if ($field->isFieldTranslatable() != $translatable) {
362 363 364 365 366 367 368 369 370 371 372 373 374
        // If a field is untranslatable, it can have no data except under
        // Language::LANGCODE_NOT_SPECIFIED. Thus we need a field to be translatable before
        // we convert data to the entity language. Conversely we need to switch
        // data back to Language::LANGCODE_NOT_SPECIFIED before making a field
        // untranslatable lest we lose information.
        $field_operations = array(
          array('content_translation_translatable_switch', array($translatable, $entity_type, $field_name)),
        );
        if ($field->hasData()) {
          $field_operations[] = array('content_translation_translatable_batch', array($translatable, $field_name));
          $field_operations = $translatable ? $field_operations : array_reverse($field_operations);
        }
        $operations = array_merge($operations, $field_operations);
375 376 377 378 379
      }
    }
  }

  // As last operation store the submitted settings.
380
  $operations[] = array('content_translation_save_settings', array($settings));
381 382 383 384

  $batch = array(
    'title' => t('Updating translatability for the selected fields'),
    'operations' => $operations,
385 386
    'finished' => 'content_translation_translatable_batch_done',
    'file' => drupal_get_path('module', 'content_translation') . '/content_translation.admin.inc',
387 388 389 390
  );
  batch_set($batch);
}

391 392 393 394 395 396 397 398
/**
 * Toggles translatability of the given field.
 *
 * This is called from a batch operation, but should only run once per field.
 *
 * @param bool $translatable
 *   Indicator of whether the field should be made translatable (TRUE) or
 *   untranslatble (FALSE).
399 400
 * @param string $entity_type
 *   Field entity type.
401 402 403
 * @param string $field_name
 *   Field machine name.
 */
404 405
function content_translation_translatable_switch($translatable, $entity_type, $field_name) {
  $field = field_info_field($entity_type, $field_name);
406 407
  if ($field->isFieldTranslatable() !== $translatable) {
    $field->translatable = $translatable;
408
    $field->save();
409 410 411 412
  }
}

/**
413
 * Batch callback: Converts field data to or from Language::LANGCODE_NOT_SPECIFIED.
414 415 416 417 418 419 420
 *
 * @param bool $translatable
 *   Indicator of whether the field should be made translatable (TRUE) or
 *   untranslatble (FALSE).
 * @param string $field_name
 *   Field machine name.
 */
421
function content_translation_translatable_batch($translatable, $field_name, &$context) {
422
  // Determine the entity types to act on.
423
  $entity_types = array();
424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439
  foreach (field_info_instances() as $entity_type => $info) {
    foreach ($info as $bundle => $instances) {
      foreach ($instances as $instance_field_name => $instance) {
        if ($instance_field_name == $field_name) {
          $entity_types[] = $entity_type;
          break 2;
        }
      }
    }
  }

  if (empty($context['sandbox'])) {
    $context['sandbox']['progress'] = 0;
    $context['sandbox']['max'] = 0;

    foreach ($entity_types as $entity_type) {
440
      $field = field_info_field($entity_type, $field_name);
441 442
      $columns = $field->getColumns();
      $column = isset($columns['value']) ? 'value' : key($columns);
443 444
      $query_field = "$field_name.$column";

445
      // How many entities will need processing?
446
      $query = \Drupal::entityQuery($entity_type);
447
      $count = $query
448
        ->exists($query_field)
449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470
        ->count()
        ->execute();

      $context['sandbox']['max'] += $count;
      $context['sandbox']['progress_entity_type'][$entity_type] = 0;
      $context['sandbox']['max_entity_type'][$entity_type] = $count;
    }

    if ($context['sandbox']['max'] === 0) {
      // Nothing to do.
      $context['finished'] = 1;
      return;
    }
  }

  foreach ($entity_types as $entity_type) {
    if ($context['sandbox']['max_entity_type'][$entity_type] === 0) {
      continue;
    }

    $info = entity_get_info($entity_type);
    $offset = $context['sandbox']['progress_entity_type'][$entity_type];
471
    $query = \Drupal::entityQuery($entity_type);
472
    $field = field_info_field($entity_type, $field_name);
473 474
    $columns = $field->getColumns();
    $column = isset($columns['value']) ? 'value' : key($columns);
475
    $query_field = "$field_name.$column";
476
    $result = $query
477
      ->exists($query_field)
478 479 480 481 482 483 484 485
      ->sort($info['entity_keys']['id'])
      ->range($offset, 10)
      ->execute();

    foreach (entity_load_multiple($entity_type, $result) as $id => $entity) {
      $context['sandbox']['max_entity_type'][$entity_type] -= count($result);
      $context['sandbox']['progress_entity_type'][$entity_type]++;
      $context['sandbox']['progress']++;
486
      $langcode = $entity->language()->id;
487 488

      // Skip process for language neutral entities.
489
      if ($langcode == Language::LANGCODE_NOT_SPECIFIED) {
490 491 492 493 494
        continue;
      }

      // We need a two-step approach while updating field translations: given
      // that field-specific update functions might rely on the stored values to
495 496 497 498
      // perform their processing first we need to store the new translations
      // and only after we can remove the old ones. Otherwise we might have data
      // loss, since the removal of the old translations might occur before the
      // new ones are stored.
499
      if ($translatable && isset($entity->{$field_name}[Language::LANGCODE_NOT_SPECIFIED])) {
500
        // If the field is being switched to translatable and has data for
501
        // Language::LANGCODE_NOT_SPECIFIED then we need to move the data to the right
502
        // language.
503
        $entity->{$field_name}[$langcode] = $entity->{$field_name}[Language::LANGCODE_NOT_SPECIFIED];
504
        // Store the original value.
505
        _content_translation_update_field($entity_type, $entity, $field_name);
506
        $entity->{$field_name}[Language::LANGCODE_NOT_SPECIFIED] = array();
507
        // Remove the language neutral value.
508
        _content_translation_update_field($entity_type, $entity, $field_name);
509 510 511
      }
      elseif (!$translatable && isset($entity->{$field_name}[$langcode])) {
        // The field has been marked untranslatable and has data in the entity
512
        // language: we need to move it to Language::LANGCODE_NOT_SPECIFIED and drop the
513
        // other translations.
514
        $entity->{$field_name}[Language::LANGCODE_NOT_SPECIFIED] = $entity->{$field_name}[$langcode];
515
        // Store the original value.
516
        _content_translation_update_field($entity_type, $entity, $field_name);
517 518
        // Remove translations.
        foreach ($entity->{$field_name} as $langcode => $items) {
519
          if ($langcode != Language::LANGCODE_NOT_SPECIFIED) {
520 521 522
            $entity->{$field_name}[$langcode] = array();
          }
        }
523
        _content_translation_update_field($entity_type, $entity, $field_name);
524 525 526 527 528 529 530 531 532 533 534 535 536 537
      }
      else {
        // No need to save unchanged entities.
        continue;
      }
    }
  }

  $context['finished'] = $context['sandbox']['progress'] / $context['sandbox']['max'];
}

/**
 * Stores the given field translations.
 */
538
function _content_translation_update_field($entity_type, EntityInterface $entity, $field_name) {
539
  $empty = 0;
540
  $translations = $entity->getTranslationLanguages();
541 542

  // Ensure that we are trying to store only valid data.
543 544 545 546
  foreach (array_keys($translations) as $langcode) {
    $items = $entity->getTranslation($langcode)->get($field_name);
    $items->filterEmptyValues();
    $empty += $items->isEmpty();
547 548 549 550 551
  }

  // Save the field value only if there is at least one item available,
  // otherwise any stored empty field value would be deleted. If this happens
  // the range queries would be messed up.
552 553
  if ($empty < count($translations)) {
    $entity->save();
554 555 556 557 558 559
  }
}

/**
 * Batch finished callback: Checks the exit status of the batch operation.
 */
560
function content_translation_translatable_batch_done($success, $results, $operations) {
561 562 563 564 565 566 567 568 569
  if ($success) {
    drupal_set_message(t("Successfully changed field translation setting."));
  }
  else {
    // @todo: Do something about this case.
    drupal_set_message(t("Something went wrong while processing data. Some nodes may appear to have lost fields."), 'error');
  }
}