content_translation.admin.inc 21.4 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\Language\Language;
10 11
use Drupal\field\Entity\Field;
use Drupal\field\Entity\FieldInstance;
12

13
/**
14
 * Returns a form element to configure field synchronization.
15
 *
16
 * @param \Drupal\field\Entity\Field $field
17
 *   A field definition array.
18
 * @param \Drupal\field\Entity\FieldInstance $instance
19 20 21 22 23
 *   A field instance definition object.
 *
 * @return array
 *   A form element to configure field synchronization.
 */
24
function content_translation_field_sync_widget(Field $field, FieldInstance $instance) {
25 26 27 28 29 30 31 32 33 34 35
  $element = array();

  if (!empty($field['settings']['column_groups']) && count($field['settings']['column_groups']) > 1) {
    $options = array();
    $default = array();

    foreach ($field['settings']['column_groups'] as $group => $info) {
      $options[$group] = $info['label'];
      $default[$group] = !empty($info['translatable']) ? $group : FALSE;
    }

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

38 39 40 41 42
    $element = array(
      '#type' => 'checkboxes',
      '#title' => t('Translatable elements'),
      '#options' => $options,
      '#default_value' => !empty($instance['settings']['translation_sync']) ? $instance['settings']['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
  foreach ($form['#labels'] as $entity_type => $label) {
78
    $entity_info = entity_get_info($entity_type);
79
    foreach (entity_get_bundles($entity_type) as $bundle => $bundle_info) {
80 81 82
      // 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.
83
      $form['settings'][$entity_type][$bundle]['settings']['language']['#content_translation_skip_alter'] = TRUE;
84

85 86 87 88 89 90 91
      // 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'])) {
        $fields = field_info_instances($entity_type, $bundle);
        if ($fields) {
          $form['settings'][$entity_type][$bundle]['translatable'] = array(
            '#type' => 'checkbox',
92
            '#title' => $bundle,
93
            '#default_value' => content_translation_enabled($entity_type, $bundle),
94 95 96 97 98
          );

          // @todo Exploit field definitions once all core entities and field
          // types are migrated to the Entity Field API.
          foreach ($fields as $field_name => $instance) {
99
            $field = $instance->getField();
100 101 102
            $form['settings'][$entity_type][$bundle]['fields'][$field_name] = array(
              '#label' => $instance['label'],
              '#type' => 'checkbox',
103
              '#title' => $instance['label'],
104 105
              '#default_value' => $field['translatable'],
            );
106
            $column_element = content_translation_field_sync_widget($field, $instance);
107 108
            if ($column_element) {
              $form['settings'][$entity_type][$bundle]['columns'][$field_name] = $column_element;
109

110 111 112 113
              if (isset($column_element['#options']['file'])) {
                $dependent_options_settings["settings[{$entity_type}][{$bundle}][columns][{$field_name}]"] = array('file');
              }
            }
114
          }
115
        }
116 117 118
      }
    }
  }
119
  $settings = array('dependent_selectors' => $dependent_options_settings);
120 121 122
  $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';
123 124
}

125 126 127
/**
 * (proxied) Implements hook_preprocess_HOOK();
 */
128
function _content_translation_preprocess_language_content_settings_table(&$variables) {
129 130
  // Alter the 'build' variable injecting the translation settings if the user
  // has the required permission.
131
  if (!user_access('administer content translation')) {
132 133 134 135 136 137 138 139 140 141 142
    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();
143 144 145
    if (!empty($element[$bundle]['translatable'])) {
      $checkbox_id = $element[$bundle]['translatable']['#id'];
    }
146 147
    $rows[$bundle] = $build['#rows'][$bundle];

148 149 150 151 152 153
    if (!empty($element[$bundle]['translatable'])) {
      $translatable = array(
        'data' => $element[$bundle]['translatable'],
        'class' => array('translatable'),
      );
      array_unshift($rows[$bundle]['data'], $translatable);
154

155 156 157 158 159 160 161 162
      $rows[$bundle]['data'][1]['data']['#prefix'] = '<label for="' . $checkbox_id . '">';
    }
    else {
      $translatable = array(
        'class' => array('untranslatable'),
      );
      array_unshift($rows[$bundle]['data'], $translatable);
    }
163 164 165 166 167 168 169 170 171 172 173 174 175 176

    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(
177
                '#prefix' => '<span class="visually-hidden">',
178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210
                '#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(
211
                    '#prefix' => '<span class="visually-hidden">',
212 213 214 215
                    '#suffix' => '</span> ',
                    '#markup' => check_plain($element[$bundle]['settings']['#label']),
                  ),
                  'field' => array(
216
                    '#prefix' => '<span class="visually-hidden">',
217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240
                    '#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;
}

241
/**
242
 * Form validation handler for content_translation_admin_settings_form().
243
 *
244
 * @see content_translation_admin_settings_form_submit()
245
 */
246
function content_translation_form_language_content_settings_validate(array $form, array &$form_state) {
247 248 249 250 251 252 253 254 255 256 257 258 259
  $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'];
260
        if (language_is_locked($values['langcode']) && empty($values['language_show'])) {
261
          foreach (language_list(Language::STATE_LOCKED) as $language) {
262 263 264 265 266 267 268 269 270 271
            $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))));
        }
      }
    }
  }
}

/**
272
 * Form submission handler for content_translation_admin_settings_form().
273
 *
274
 * @see content_translation_admin_settings_form_validate()
275
 */
276
function content_translation_form_language_content_settings_submit(array $form, array &$form_state) {
277 278 279 280 281 282 283 284
  $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) {
285 286 287
      if (!empty($bundle_settings['translatable'])) {
        $bundle_settings['translatable'] = $bundle_settings['translatable'] && $entity_types[$entity_type];
      }
288 289 290
      if (!empty($bundle_settings['fields'])) {
        foreach ($bundle_settings['fields'] as $field_name => $translatable) {
          $bundle_settings['fields'][$field_name] = $translatable && $bundle_settings['translatable'];
291 292 293 294 295
          // 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;
          }
296 297 298 299 300
        }
      }
    }
  }

301
  _content_translation_update_field_translatability($settings);
302 303 304 305
  drupal_set_message(t('Settings successfully updated.'));
}

/**
306
 * Stores content translation settings.
307 308 309 310 311 312 313 314 315 316 317 318 319
 *
 * @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.
 */
320
function _content_translation_update_field_translatability($settings) {
321 322 323 324 325 326 327 328 329 330
  $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.
331
          $fields[$entity_type][$field_name] = $translatable || !empty($fields[$entity_type][$field_name]);
332 333 334 335 336 337 338 339
        }
      }
      // @todo Store non-configurable field settings to be able to alter their
      //   definition afterwards.
    }
  }

  $operations = array();
340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356
  foreach ($fields as $entity_type => $entity_type_fields) {
    foreach ($entity_type_fields as $field_name => $translatable) {
      $field = field_info_field($entity_type, $field_name);
      if ($field['translatable'] != $translatable) {
        // 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);
357 358 359 360 361
      }
    }
  }

  // As last operation store the submitted settings.
362
  $operations[] = array('content_translation_save_settings', array($settings));
363 364 365 366

  $batch = array(
    'title' => t('Updating translatability for the selected fields'),
    'operations' => $operations,
367 368
    'finished' => 'content_translation_translatable_batch_done',
    'file' => drupal_get_path('module', 'content_translation') . '/content_translation.admin.inc',
369 370 371 372
  );
  batch_set($batch);
}

373 374 375 376 377 378 379 380
/**
 * 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).
381 382
 * @param string $entity_type
 *   Field entity type.
383 384 385
 * @param string $field_name
 *   Field machine name.
 */
386 387
function content_translation_translatable_switch($translatable, $entity_type, $field_name) {
  $field = field_info_field($entity_type, $field_name);
388 389
  if ($field['translatable'] !== $translatable) {
    $field['translatable'] = $translatable;
390
    $field->save();
391 392 393 394
  }
}

/**
395
 * Batch callback: Converts field data to or from Language::LANGCODE_NOT_SPECIFIED.
396 397 398 399 400 401 402
 *
 * @param bool $translatable
 *   Indicator of whether the field should be made translatable (TRUE) or
 *   untranslatble (FALSE).
 * @param string $field_name
 *   Field machine name.
 */
403
function content_translation_translatable_batch($translatable, $field_name, &$context) {
404
  // Determine the entity types to act on.
405
  $entity_types = array();
406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421
  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) {
422 423 424 425
      $field = field_info_field($entity_type, $field_name);
      $column = isset($field['columns']['value']) ? 'value' : key($field['columns']);
      $query_field = "$field_name.$column";

426
      // How many entities will need processing?
427
      $query = \Drupal::entityQuery($entity_type);
428
      $count = $query
429
        ->exists($query_field)
430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451
        ->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];
452
    $query = \Drupal::entityQuery($entity_type);
453 454 455
    $field = field_info_field($entity_type, $field_name);
    $column = isset($field['columns']['value']) ? 'value' : key($field['columns']);
    $query_field = "$field_name.$column";
456
    $result = $query
457
      ->exists($query_field)
458 459 460 461 462 463 464 465
      ->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']++;
466
      $langcode = $entity->language()->id;
467 468

      // Skip process for language neutral entities.
469
      if ($langcode == Language::LANGCODE_NOT_SPECIFIED) {
470 471 472 473 474
        continue;
      }

      // We need a two-step approach while updating field translations: given
      // that field-specific update functions might rely on the stored values to
475 476 477 478
      // 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.
479
      if ($translatable && isset($entity->{$field_name}[Language::LANGCODE_NOT_SPECIFIED])) {
480
        // If the field is being switched to translatable and has data for
481
        // Language::LANGCODE_NOT_SPECIFIED then we need to move the data to the right
482
        // language.
483
        $entity->{$field_name}[$langcode] = $entity->{$field_name}[Language::LANGCODE_NOT_SPECIFIED];
484
        // Store the original value.
485
        _content_translation_update_field($entity_type, $entity, $field_name);
486
        $entity->{$field_name}[Language::LANGCODE_NOT_SPECIFIED] = array();
487
        // Remove the language neutral value.
488
        _content_translation_update_field($entity_type, $entity, $field_name);
489 490 491
      }
      elseif (!$translatable && isset($entity->{$field_name}[$langcode])) {
        // The field has been marked untranslatable and has data in the entity
492
        // language: we need to move it to Language::LANGCODE_NOT_SPECIFIED and drop the
493
        // other translations.
494
        $entity->{$field_name}[Language::LANGCODE_NOT_SPECIFIED] = $entity->{$field_name}[$langcode];
495
        // Store the original value.
496
        _content_translation_update_field($entity_type, $entity, $field_name);
497 498
        // Remove translations.
        foreach ($entity->{$field_name} as $langcode => $items) {
499
          if ($langcode != Language::LANGCODE_NOT_SPECIFIED) {
500 501 502
            $entity->{$field_name}[$langcode] = array();
          }
        }
503
        _content_translation_update_field($entity_type, $entity, $field_name);
504 505 506 507 508 509 510 511 512 513 514 515 516 517
      }
      else {
        // No need to save unchanged entities.
        continue;
      }
    }
  }

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

/**
 * Stores the given field translations.
 */
518
function _content_translation_update_field($entity_type, EntityInterface $entity, $field_name) {
519
  $empty = 0;
520
  $translations = $entity->getTranslationLanguages();
521 522

  // Ensure that we are trying to store only valid data.
523 524 525 526
  foreach (array_keys($translations) as $langcode) {
    $items = $entity->getTranslation($langcode)->get($field_name);
    $items->filterEmptyValues();
    $empty += $items->isEmpty();
527 528 529 530 531
  }

  // 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.
532 533
  if ($empty < count($translations)) {
    $entity->save();
534 535 536 537 538 539
  }
}

/**
 * Batch finished callback: Checks the exit status of the batch operation.
 */
540
function content_translation_translatable_batch_done($success, $results, $operations) {
541 542 543 544 545 546 547 548 549
  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');
  }
}