Newer
Older
Angie Byron
committed
<?php
/**
* @file
* The entity translation administration forms.
*/
use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Language\Language;
Alex Pott
committed
use Drupal\field\Plugin\Core\Entity\Field;
use Drupal\field\Plugin\Core\Entity\FieldInstance;
Angie Byron
committed
Angie Byron
committed
/**
* Returns a form element to configure field synchronization.
Angie Byron
committed
*
Alex Pott
committed
* @param \Drupal\field\Plugin\Core\Entity\Field $field
* A field definition array.
Alex Pott
committed
* @param \Drupal\field\Plugin\Core\Entity\FieldInstance $instance
* A field instance definition object.
*
* @return array
* A form element to configure field synchronization.
*/
Alex Pott
committed
function translation_entity_field_sync_widget(Field $field, FieldInstance $instance) {
$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;
}
$settings = array('dependent_selectors' => array('instance[settings][translation_sync]' => array('file')));
$element = array(
'#type' => 'checkboxes',
'#title' => t('Translatable elements'),
'#options' => $options,
'#default_value' => !empty($instance['settings']['translation_sync']) ? $instance['settings']['translation_sync'] : $default,
'#attached' => array(
Dries Buytaert
committed
'library' => array(
array('translation_entity', 'drupal.translation_entity.admin'),
),
'js' => array(
array('data' => array('translationEntityDependentOptions' => $settings), 'type' => 'setting'),
),
),
);
}
return $element;
}
/**
* (proxied) Implements hook_form_FORM_ID_alter().
Angie Byron
committed
*/
function _translation_entity_form_language_content_settings_form_alter(array &$form, array &$form_state) {
// Inject into the content language settings the translation settings if the
// user has the required permission.
if (!user_access('administer entity translation')) {
return;
}
$default = $form['entity_types']['#default_value'];
foreach ($default as $entity_type => $enabled) {
$default[$entity_type] = $enabled || translation_entity_enabled($entity_type) ? $entity_type : FALSE;
}
$form['entity_types']['#default_value'] = $default;
Angie Byron
committed
$form['#attached']['library'][] = array('translation_entity', 'drupal.translation_entity.admin');
$form['#attached']['js'][] = array('data' => drupal_get_path('module', 'translation_entity') . '/translation_entity.admin.js', 'type' => 'file');
Angie Byron
committed
$dependent_options_settings = array();
Angie Byron
committed
foreach ($form['#labels'] as $entity_type => $label) {
Alex Pott
committed
$entity_info = entity_get_info($entity_type);
Dries Buytaert
committed
foreach (entity_get_bundles($entity_type) as $bundle => $bundle_info) {
Angie Byron
committed
// 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.
$form['settings'][$entity_type][$bundle]['settings']['language']['#translation_entity_skip_alter'] = TRUE;
Alex Pott
committed
// 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',
'#default_value' => translation_entity_enabled($entity_type, $bundle),
);
// @todo Exploit field definitions once all core entities and field
// types are migrated to the Entity Field API.
foreach ($fields as $field_name => $instance) {
$field = field_info_field($field_name);
$form['settings'][$entity_type][$bundle]['fields'][$field_name] = array(
'#label' => $instance['label'],
'#type' => 'checkbox',
'#default_value' => $field['translatable'],
);
$column_element = translation_entity_field_sync_widget($field, $instance);
if ($column_element) {
$form['settings'][$entity_type][$bundle]['columns'][$field_name] = $column_element;
Alex Pott
committed
if (isset($column_element['#options']['file'])) {
$dependent_options_settings["settings[{$entity_type}][{$bundle}][columns][{$field_name}]"] = array('file');
}
}
}
Angie Byron
committed
}
}
}
$settings = array('dependent_selectors' => $dependent_options_settings);
$form['#attached']['js'][] = array('data' => array('translationEntityDependentOptions' => $settings), 'type' => 'setting');
Angie Byron
committed
$form['#validate'][] = 'translation_entity_form_language_content_settings_validate';
$form['#submit'][] = 'translation_entity_form_language_content_settings_submit';
}
/**
* (proxied) Implements hook_preprocess_HOOK();
*/
function _translation_entity_preprocess_language_content_settings_table(&$variables) {
// Alter the 'build' variable injecting the translation settings if the user
// has the required permission.
if (!user_access('administer entity translation')) {
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();
Alex Pott
committed
if (!empty($element[$bundle]['translatable'])) {
$checkbox_id = $element[$bundle]['translatable']['#id'];
}
$rows[$bundle] = $build['#rows'][$bundle];
Alex Pott
committed
if (!empty($element[$bundle]['translatable'])) {
$translatable = array(
'data' => $element[$bundle]['translatable'],
'class' => array('translatable'),
);
array_unshift($rows[$bundle]['data'], $translatable);
Alex Pott
committed
$rows[$bundle]['data'][1]['data']['#prefix'] = '<label for="' . $checkbox_id . '">';
}
else {
$translatable = array(
'class' => array('untranslatable'),
);
array_unshift($rows[$bundle]['data'], $translatable);
}
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
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(
'#prefix' => '<span class="element-invisible">',
'#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(
'#prefix' => '<span class="element-invisible">',
'#suffix' => '</span> ',
'#markup' => check_plain($element[$bundle]['settings']['#label']),
),
'field' => array(
'#prefix' => '<span class="element-invisible">',
'#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;
}
Angie Byron
committed
/**
* Form validation handler for translation_entity_admin_settings_form().
*
* @see translation_entity_admin_settings_form_submit()
*/
function translation_entity_form_language_content_settings_validate(array $form, array &$form_state) {
$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'];
Dries Buytaert
committed
if (language_is_locked($values['langcode']) && empty($values['language_show'])) {
foreach (language_list(Language::STATE_LOCKED) as $language) {
Angie Byron
committed
$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))));
}
}
}
}
}
/**
* Form submission handler for translation_entity_admin_settings_form().
*
* @see translation_entity_admin_settings_form_validate()
*/
function translation_entity_form_language_content_settings_submit(array $form, array &$form_state) {
$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) {
Alex Pott
committed
if (!empty($bundle_settings['translatable'])) {
$bundle_settings['translatable'] = $bundle_settings['translatable'] && $entity_types[$entity_type];
}
Angie Byron
committed
if (!empty($bundle_settings['fields'])) {
foreach ($bundle_settings['fields'] as $field_name => $translatable) {
$bundle_settings['fields'][$field_name] = $translatable && $bundle_settings['translatable'];
// 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;
}
Angie Byron
committed
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
}
}
}
}
_translation_entity_update_field_translatability($settings);
drupal_set_message(t('Settings successfully updated.'));
}
/**
* Stores entity translation settings.
*
* @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.
*/
function _translation_entity_update_field_translatability($settings) {
$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.
$fields[$field_name] = $translatable || !empty($fields[$field_name]);
}
}
// @todo Store non-configurable field settings to be able to alter their
// definition afterwards.
}
}
$operations = array();
foreach ($fields as $field_name => $translatable) {
$field = field_info_field($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
Angie Byron
committed
// we convert data to the entity language. Conversely we need to switch
// data back to Language::LANGCODE_NOT_SPECIFIED before making a field
Angie Byron
committed
// untranslatable lest we lose information.
$field_operations = array(
array('translation_entity_translatable_switch', array($translatable, $field_name)),
);
if ($field->hasData()) {
Angie Byron
committed
$field_operations[] = array('translation_entity_translatable_batch', array($translatable, $field_name));
$field_operations = $translatable ? $field_operations : array_reverse($field_operations);
}
$operations = array_merge($operations, $field_operations);
}
}
// As last operation store the submitted settings.
$operations[] = array('translation_entity_save_settings', array($settings));
$batch = array(
'title' => t('Updating translatability for the selected fields'),
'operations' => $operations,
'finished' => 'translation_entity_translatable_batch_done',
'file' => drupal_get_path('module', 'translation_entity') . '/translation_entity.admin.inc',
);
batch_set($batch);
}
Angie Byron
committed
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
/**
* Form constructor for the confirmation of translatability switching.
*/
function translation_entity_translatable_form(array $form, array &$form_state, $field_name) {
$field = field_info_field($field_name);
$t_args = array('%name' => $field_name);
$warning = t('By submitting this form these changes will apply to the %name field everywhere it is used.', $t_args);
if ($field['translatable']) {
$title = t('Are you sure you want to disable translation for the %name field?', $t_args);
$warning .= "<br>" . t("<strong>All the existing translations of this field will be deleted.</strong><br>This action cannot be undone.");
}
else {
$title = t('Are you sure you want to enable translation for the %name field?', $t_args);
}
// We need to keep some information for later processing.
$form_state['field'] = $field;
// Store the 'translatable' status on the client side to prevent outdated form
// submits from toggling translatability.
$form['translatable'] = array(
'#type' => 'hidden',
'#default_value' => $field['translatable'],
);
return confirm_form($form, $title, '', $warning);
}
/**
* Form submission handler for translation_entity_translatable_form().
*
* This submit handler maintains consistency between the translatability of an
* entity and the language under which the field data is stored. When a field is
* marked as translatable, all the data in
* $entity->{field_name}[Language::LANGCODE_NOT_SPECIFIED] is moved to
Angie Byron
committed
* $entity->{field_name}[$entity_language]. When a field is marked as
* untranslatable the opposite process occurs. Note that marking a field as
* untranslatable will cause all of its translations to be permanently removed,
* with the exception of the one corresponding to the entity language.
*/
function translation_entity_translatable_form_submit(array $form, array $form_state) {
// This is the current state that we want to reverse.
$translatable = $form_state['values']['translatable'];
$field_name = $form_state['field']['field_name'];
$field = field_info_field($field_name);
if ($field['translatable'] !== $translatable) {
// Field translatability has changed since form creation, abort.
$t_args = array('%field_name');
$msg = $translatable ?
t('The field %field_name is already translatable. No change was performed.', $t_args):
t('The field %field_name is already untranslatable. No change was performed.', $t_args);
drupal_set_message($msg, 'warning');
return;
}
// 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
Angie Byron
committed
// 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
Angie Byron
committed
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
// information.
$operations = array(
array('translation_entity_translatable_batch', array(!$translatable, $field_name)),
array('translation_entity_translatable_switch', array(!$translatable, $field_name)),
);
$operations = $translatable ? $operations : array_reverse($operations);
$t_args = array('%field' => $field_name);
$title = !$translatable ? t('Enabling translation for the %field field', $t_args) : t('Disabling translation for the %field field', $t_args);
$batch = array(
'title' => $title,
'operations' => $operations,
'finished' => 'translation_entity_translatable_batch_done',
'file' => drupal_get_path('module', 'translation_entity') . '/translation_entity.admin.inc',
);
batch_set($batch);
}
/**
* 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).
* @param string $field_name
* Field machine name.
*/
function translation_entity_translatable_switch($translatable, $field_name) {
$field = field_info_field($field_name);
Angie Byron
committed
if ($field['translatable'] !== $translatable) {
$field['translatable'] = $translatable;
field_update_field($field);
Angie Byron
committed
}
}
/**
* Batch callback: Converts field data to or from Language::LANGCODE_NOT_SPECIFIED.
Angie Byron
committed
*
* @param bool $translatable
* Indicator of whether the field should be made translatable (TRUE) or
* untranslatble (FALSE).
* @param string $field_name
* Field machine name.
*/
function translation_entity_translatable_batch($translatable, $field_name, &$context) {
Angie Byron
committed
$field = field_info_field($field_name);
$column = isset($field['columns']['value']) ? 'value' : key($field['columns']);
$query_field = "$field_name.$column";
Angie Byron
committed
// Determine the entity types to act on.
Angie Byron
committed
$entity_types = array();
Angie Byron
committed
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) {
// How many entities will need processing?
Alex Pott
committed
$query = Drupal::entityQuery($entity_type);
Angie Byron
committed
$count = $query
Angie Byron
committed
->exists($query_field)
Angie Byron
committed
->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];
Alex Pott
committed
$query = Drupal::entityQuery($entity_type);
Angie Byron
committed
$result = $query
Angie Byron
committed
->exists($query_field)
Angie Byron
committed
->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']++;
$langcode = $entity->language()->langcode;
// Skip process for language neutral entities.
if ($langcode == Language::LANGCODE_NOT_SPECIFIED) {
Angie Byron
committed
continue;
}
// We need a two-step approach while updating field translations: given
// that field-specific update functions might rely on the stored values to
// perform their processing, see for instance file_field_update(), 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.
if ($translatable && isset($entity->{$field_name}[Language::LANGCODE_NOT_SPECIFIED])) {
Angie Byron
committed
// If the field is being switched to translatable and has data for
// Language::LANGCODE_NOT_SPECIFIED then we need to move the data to the right
Angie Byron
committed
// language.
$entity->{$field_name}[$langcode] = $entity->{$field_name}[Language::LANGCODE_NOT_SPECIFIED];
Angie Byron
committed
// Store the original value.
_translation_entity_update_field($entity_type, $entity, $field_name);
$entity->{$field_name}[Language::LANGCODE_NOT_SPECIFIED] = array();
Angie Byron
committed
// Remove the language neutral value.
_translation_entity_update_field($entity_type, $entity, $field_name);
}
elseif (!$translatable && isset($entity->{$field_name}[$langcode])) {
// The field has been marked untranslatable and has data in the entity
// language: we need to move it to Language::LANGCODE_NOT_SPECIFIED and drop the
Angie Byron
committed
// other translations.
$entity->{$field_name}[Language::LANGCODE_NOT_SPECIFIED] = $entity->{$field_name}[$langcode];
Angie Byron
committed
// Store the original value.
_translation_entity_update_field($entity_type, $entity, $field_name);
// Remove translations.
foreach ($entity->{$field_name} as $langcode => $items) {
if ($langcode != Language::LANGCODE_NOT_SPECIFIED) {
Angie Byron
committed
$entity->{$field_name}[$langcode] = array();
}
}
_translation_entity_update_field($entity_type, $entity, $field_name);
}
else {
// No need to save unchanged entities.
continue;
}
}
}
$context['finished'] = $context['sandbox']['progress'] / $context['sandbox']['max'];
}
/**
* Stores the given field translations.
*/
function _translation_entity_update_field($entity_type, EntityInterface $entity, $field_name) {
$empty = 0;
$field = field_info_field($field_name);
// Ensure that we are trying to store only valid data.
foreach ($entity->{$field_name} as $langcode => $items) {
$entity->{$field_name}[$langcode] = _field_filter_items($field['type'], $entity->{$field_name}[$langcode]);
Angie Byron
committed
$empty += empty($entity->{$field_name}[$langcode]);
}
// 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.
if ($empty < count($entity->{$field_name})) {
field_attach_presave($entity);
field_attach_update($entity);
Angie Byron
committed
}
}
/**
* Batch finished callback: Checks the exit status of the batch operation.
*/
function translation_entity_translatable_batch_done($success, $results, $operations) {
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');
}
}