View source
<?php
namespace Drupal\Tests\content_translation\Functional;
use Drupal\Component\Render\FormattableMarkup;
use Drupal\Core\Cache\Cache;
use Drupal\Core\Entity\EntityChangedInterface;
use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Language\Language;
use Drupal\Core\Language\LanguageInterface;
use Drupal\Core\Url;
use Drupal\language\Entity\ConfigurableLanguage;
use Drupal\Tests\system\Functional\Cache\AssertPageCacheContextsAndTagsTrait;
abstract class ContentTranslationUITestBase extends ContentTranslationTestBase {
use AssertPageCacheContextsAndTagsTrait;
protected $entityId;
protected $testLanguageSelector = TRUE;
protected $testHTMLEscapeForAllLanguages = FALSE;
protected $defaultCacheContexts = [
'languages:language_interface',
'theme',
'url.query_args:_wrapper_format',
'user.permissions',
];
public function testTranslationUI() {
$this
->doTestBasicTranslation();
$this
->doTestTranslationOverview();
$this
->doTestOutdatedStatus();
$this
->doTestPublishedStatus();
$this
->doTestAuthoringInfo();
$this
->doTestTranslationEdit();
$this
->doTestTranslationChanged();
$this
->doTestChangedTimeAfterSaveWithoutChanges();
$this
->doTestTranslationDeletion();
}
protected function doTestBasicTranslation() {
$default_langcode = $this->langcodes[0];
$values[$default_langcode] = $this
->getNewEntityValues($default_langcode);
$this
->drupalLogin($this->editor);
$this->entityId = $this
->createEntity($values[$default_langcode], $default_langcode);
$this
->drupalLogin($this->translator);
$storage = $this->container
->get('entity_type.manager')
->getStorage($this->entityTypeId);
$storage
->resetCache([
$this->entityId,
]);
$entity = $storage
->load($this->entityId);
$this
->assertNotEmpty($entity, 'Entity found in the database.');
$this
->drupalGet($entity
->toUrl());
$this
->assertSession()
->statusCodeEquals(200);
$this
->assertCacheContexts($this->defaultCacheContexts);
$this
->drupalGet($entity
->toUrl('drupal:content-translation-overview'));
$this
->assertSession()
->pageTextNotContains('Source language');
$translation = $this
->getTranslation($entity, $default_langcode);
foreach ($values[$default_langcode] as $property => $value) {
$stored_value = $this
->getValue($translation, $property, $default_langcode);
$value = is_array($value) ? $value[0]['value'] : $value;
$message = new FormattableMarkup('@property correctly stored in the default language.', [
'@property' => $property,
]);
$this
->assertEquals($value, $stored_value, $message);
}
$langcode = 'it';
$language = ConfigurableLanguage::load($langcode);
$values[$langcode] = $this
->getNewEntityValues($langcode);
$entity_type_id = $entity
->getEntityTypeId();
$add_url = Url::fromRoute("entity.{$entity_type_id}.content_translation_add", [
$entity
->getEntityTypeId() => $entity
->id(),
'source' => $default_langcode,
'target' => $langcode,
], [
'language' => $language,
]);
$this
->drupalGet($add_url);
$this
->submitForm($this
->getEditValues($values, $langcode), $this
->getFormSubmitActionForNewTranslation($entity, $langcode));
if ($this->testHTMLEscapeForAllLanguages) {
$this
->assertSession()
->responseNotContains('<span class="translation-entity-all-languages">(all languages)</span>');
$this
->assertSession()
->responseContains('<span class="translation-entity-all-languages">(all languages)</span>');
}
$storage = $this->container
->get('entity_type.manager')
->getStorage($this->entityTypeId);
$storage
->resetCache([
$this->entityId,
]);
$entity = $storage
->load($this->entityId);
$this
->drupalGet($entity
->toUrl());
$this
->assertCacheContexts(Cache::mergeContexts([
'languages:language_content',
], $this->defaultCacheContexts));
$metadata_source_translation = $this->manager
->getTranslationMetadata($entity
->getTranslation($default_langcode));
$metadata_target_translation = $this->manager
->getTranslationMetadata($entity
->getTranslation($langcode));
$author_field_name = $entity
->hasField('content_translation_uid') ? 'content_translation_uid' : 'uid';
if ($entity
->getFieldDefinition($author_field_name)
->isTranslatable()) {
$this
->assertEquals($this->translator
->id(), $metadata_target_translation
->getAuthor()
->id(), new FormattableMarkup('Author of the target translation @langcode correctly stored for translatable owner field.', [
'@langcode' => $langcode,
]));
$this
->assertNotEquals($metadata_target_translation
->getAuthor()
->id(), $metadata_source_translation
->getAuthor()
->id(), new FormattableMarkup('Author of the target translation @target different from the author of the source translation @source for translatable owner field.', [
'@target' => $langcode,
'@source' => $default_langcode,
]));
}
else {
$this
->assertEquals($this->editor
->id(), $metadata_target_translation
->getAuthor()
->id(), 'Author of the entity remained untouched after translation for non translatable owner field.');
}
$created_field_name = $entity
->hasField('content_translation_created') ? 'content_translation_created' : 'created';
if ($entity
->getFieldDefinition($created_field_name)
->isTranslatable()) {
$this
->assertGreaterThan($metadata_source_translation
->getCreatedTime(), $metadata_target_translation
->getCreatedTime());
}
else {
$this
->assertEquals($metadata_source_translation
->getCreatedTime(), $metadata_target_translation
->getCreatedTime(), 'Creation timestamp of the entity remained untouched after translation for non translatable created field.');
}
if ($this->testLanguageSelector) {
$this
->assertSession()
->fieldNotExists('edit-langcode-0-value');
}
$storage
->resetCache([
$this->entityId,
]);
$entity = $storage
->load($this->entityId);
$this
->drupalGet($entity
->toUrl('drupal:content-translation-overview'));
$this
->assertSession()
->pageTextNotContains('Source language');
$langcode = 'fr';
$language = ConfigurableLanguage::load($langcode);
$source_langcode = 'it';
$edit = [
'source_langcode[source]' => $source_langcode,
];
$entity_type_id = $entity
->getEntityTypeId();
$add_url = Url::fromRoute("entity.{$entity_type_id}.content_translation_add", [
$entity
->getEntityTypeId() => $entity
->id(),
'source' => $default_langcode,
'target' => $langcode,
], [
'language' => $language,
]);
$this
->drupalGet($add_url);
$this
->submitForm($edit, 'Change');
$this
->assertSession()
->fieldValueEquals("{$this->fieldName}[0][value]", $values[$source_langcode][$this->fieldName][0]['value']);
$values[$langcode] = $this
->getNewEntityValues($langcode);
$edit = $this
->getEditValues($values, $langcode) + [
'content_translation[retranslate]' => TRUE,
];
$entity_type_id = $entity
->getEntityTypeId();
$add_url = Url::fromRoute("entity.{$entity_type_id}.content_translation_add", [
$entity
->getEntityTypeId() => $entity
->id(),
'source' => $source_langcode,
'target' => $langcode,
], [
'language' => $language,
]);
$this
->drupalGet($add_url);
$this
->submitForm($edit, $this
->getFormSubmitActionForNewTranslation($entity, $langcode));
$storage
->resetCache([
$this->entityId,
]);
$entity = $storage
->load($this->entityId);
$this
->drupalGet($entity
->toUrl('drupal:content-translation-overview'));
$this
->assertSession()
->pageTextContains('Source language');
foreach ($values as $langcode => $property_values) {
$translation = $this
->getTranslation($entity, $langcode);
foreach ($property_values as $property => $value) {
$stored_value = $this
->getValue($translation, $property, $langcode);
$value = is_array($value) ? $value[0]['value'] : $value;
$message = new FormattableMarkup('%property correctly stored with language %language.', [
'%property' => $property,
'%language' => $langcode,
]);
$this
->assertEquals($value, $stored_value, $message);
}
}
}
protected function doTestTranslationOverview() {
$storage = $this->container
->get('entity_type.manager')
->getStorage($this->entityTypeId);
$storage
->resetCache([
$this->entityId,
]);
$entity = $storage
->load($this->entityId);
$translate_url = $entity
->toUrl('drupal:content-translation-overview');
$this
->drupalGet($translate_url);
$translate_url
->setAbsolute(FALSE);
foreach ($this->langcodes as $langcode) {
if ($entity
->hasTranslation($langcode)) {
$language = new Language([
'id' => $langcode,
]);
$view_url = $entity
->toUrl('canonical', [
'language' => $language,
])
->toString();
$this
->assertSession()
->elementTextEquals('xpath', "//table//a[@href='{$view_url}']", $entity
->getTranslation($langcode)
->label() ?? '');
$edit_path = $entity
->toUrl('edit-form', [
'language' => $language,
])
->toString();
$this
->assertSession()
->elementTextEquals('xpath', "//table//ul[@class='dropbutton']/li/a[@href='{$edit_path}']", 'Edit');
}
}
}
protected function doTestOutdatedStatus() {
$storage = $this->container
->get('entity_type.manager')
->getStorage($this->entityTypeId);
$storage
->resetCache([
$this->entityId,
]);
$entity = $storage
->load($this->entityId);
$langcode = 'fr';
$languages = \Drupal::languageManager()
->getLanguages();
$edit = [
'content_translation[retranslate]' => TRUE,
];
$edit_path = $entity
->toUrl('edit-form', [
'language' => $languages[$langcode],
]);
$this
->drupalGet($edit_path);
$this
->submitForm($edit, $this
->getFormSubmitAction($entity, $langcode));
$storage
->resetCache([
$this->entityId,
]);
$entity = $storage
->load($this->entityId);
foreach ($this->langcodes as $added_langcode) {
$url = $entity
->toUrl('edit-form', [
'language' => ConfigurableLanguage::load($added_langcode),
]);
$this
->drupalGet($url);
if ($added_langcode == $langcode) {
$this
->assertSession()
->fieldValueEquals('content_translation[retranslate]', FALSE);
$this
->assertEmpty($this
->xpath('//details[@id="edit-content-translation" and @open="open"]'), 'The translation tab should be collapsed by default.');
}
else {
$this
->assertSession()
->fieldValueEquals('content_translation[outdated]', TRUE);
$this
->assertNotEmpty($this
->xpath('//details[@id="edit-content-translation" and @open="open"]'), 'The translation tab is correctly expanded when the translation is outdated.');
$edit = [
'content_translation[outdated]' => FALSE,
];
$this
->drupalGet($url);
$this
->submitForm($edit, $this
->getFormSubmitAction($entity, $added_langcode));
$this
->drupalGet($url);
$this
->assertSession()
->fieldValueEquals('content_translation[retranslate]', FALSE);
$storage = $this->container
->get('entity_type.manager')
->getStorage($this->entityTypeId);
$storage
->resetCache([
$this->entityId,
]);
$entity = $storage
->load($this->entityId);
$this
->assertFalse($this->manager
->getTranslationMetadata($entity
->getTranslation($added_langcode))
->isOutdated(), 'The "outdated" status has been correctly stored.');
}
}
}
protected function doTestPublishedStatus() {
$storage = $this->container
->get('entity_type.manager')
->getStorage($this->entityTypeId);
$storage
->resetCache([
$this->entityId,
]);
$entity = $storage
->load($this->entityId);
foreach ($this->langcodes as $index => $langcode) {
if ($index > 0) {
$url = $entity
->toUrl('edit-form', [
'language' => ConfigurableLanguage::load($langcode),
]);
$edit = [
'content_translation[status]' => FALSE,
];
$this
->drupalGet($url);
$this
->submitForm($edit, $this
->getFormSubmitAction($entity, $langcode));
$storage = $this->container
->get('entity_type.manager')
->getStorage($this->entityTypeId);
$storage
->resetCache([
$this->entityId,
]);
$entity = $storage
->load($this->entityId);
$this
->assertFalse($this->manager
->getTranslationMetadata($entity
->getTranslation($langcode))
->isPublished(), 'The translation has been correctly unpublished.');
}
}
$this
->drupalGet($entity
->toUrl('edit-form'));
$this
->assertSession()
->fieldDisabled('content_translation[status]');
$this
->assertSession()
->fieldValueEquals('content_translation[status]', TRUE);
}
protected function doTestAuthoringInfo() {
$storage = $this->container
->get('entity_type.manager')
->getStorage($this->entityTypeId);
$storage
->resetCache([
$this->entityId,
]);
$entity = $storage
->load($this->entityId);
$values = [];
foreach ($this->langcodes as $index => $langcode) {
$user = $this
->drupalCreateUser();
$values[$langcode] = [
'uid' => $user
->id(),
'created' => REQUEST_TIME - mt_rand(0, 1000),
];
$edit = [
'content_translation[uid]' => $user
->getAccountName(),
'content_translation[created]' => $this->container
->get('date.formatter')
->format($values[$langcode]['created'], 'custom', 'Y-m-d H:i:s O'),
];
$url = $entity
->toUrl('edit-form', [
'language' => ConfigurableLanguage::load($langcode),
]);
$this
->drupalGet($url);
$this
->submitForm($edit, $this
->getFormSubmitAction($entity, $langcode));
}
$storage = $this->container
->get('entity_type.manager')
->getStorage($this->entityTypeId);
$storage
->resetCache([
$this->entityId,
]);
$entity = $storage
->load($this->entityId);
foreach ($this->langcodes as $langcode) {
$metadata = $this->manager
->getTranslationMetadata($entity
->getTranslation($langcode));
$this
->assertEquals($values[$langcode]['uid'], $metadata
->getAuthor()
->id(), 'Translation author correctly stored.');
$this
->assertEquals($values[$langcode]['created'], $metadata
->getCreatedTime(), 'Translation date correctly stored.');
}
$langcode = 'en';
$edit = [
'content_translation[uid]' => $this
->randomMachineName(12),
'content_translation[created]' => '19/11/1978',
];
$this
->drupalGet($entity
->toUrl('edit-form'));
$this
->submitForm($edit, $this
->getFormSubmitAction($entity, $langcode));
$this
->assertSession()
->elementExists('xpath', '//div[contains(@class, "error")]//ul');
$metadata = $this->manager
->getTranslationMetadata($entity
->getTranslation($langcode));
$this
->assertEquals($values[$langcode]['uid'], $metadata
->getAuthor()
->id(), 'Translation author correctly kept.');
$this
->assertEquals($values[$langcode]['created'], $metadata
->getCreatedTime(), 'Translation date correctly kept.');
}
protected function doTestTranslationDeletion() {
$this
->drupalLogin($this->translator);
$langcode = 'fr';
$storage = $this->container
->get('entity_type.manager')
->getStorage($this->entityTypeId);
$storage
->resetCache([
$this->entityId,
]);
$entity = $storage
->load($this->entityId);
$language = ConfigurableLanguage::load($langcode);
$url = $entity
->toUrl('edit-form', [
'language' => $language,
]);
$this
->drupalGet($url);
$this
->submitForm([], 'Delete translation');
$this
->submitForm([], 'Delete ' . $language
->getName() . ' translation');
$storage
->resetCache([
$this->entityId,
]);
$entity = $storage
->load($this->entityId, TRUE);
$this
->assertIsObject($entity);
$translations = $entity
->getTranslationLanguages();
$this
->assertCount(2, $translations);
$this
->assertArrayNotHasKey($langcode, $translations);
$args = [
$this->entityTypeId => $entity
->id(),
'language' => 'en',
];
$this
->drupalGet(Url::fromRoute("entity.{$this->entityTypeId}.content_translation_delete", $args));
$this
->assertSession()
->statusCodeEquals(403);
}
protected function getNewEntityValues($langcode) {
return [
$this->fieldName => [
[
'value' => $this
->randomMachineName(16),
],
],
];
}
protected function getEditValues($values, $langcode, $new = FALSE) {
$edit = $values[$langcode];
$langcode = $new ? LanguageInterface::LANGCODE_NOT_SPECIFIED : $langcode;
foreach ($values[$langcode] as $property => $value) {
if (is_array($value)) {
$edit["{$property}[0][value]"] = $value[0]['value'];
unset($edit[$property]);
}
}
return $edit;
}
protected function getFormSubmitActionForNewTranslation(EntityInterface $entity, $langcode) {
$entity
->addTranslation($langcode, $entity
->toArray());
return $this
->getFormSubmitAction($entity, $langcode);
}
protected function getFormSubmitAction(EntityInterface $entity, $langcode) {
return 'Save' . $this
->getFormSubmitSuffix($entity, $langcode);
}
protected function getFormSubmitSuffix(EntityInterface $entity, $langcode) {
return '';
}
protected function getTranslation(EntityInterface $entity, $langcode) {
return $entity
->getTranslation($langcode);
}
protected function getValue(EntityInterface $translation, $property, $langcode) {
$key = $property == 'user_id' ? 'target_id' : 'value';
return $translation
->get($property)->{$key};
}
protected function getChangedFieldName($entity) {
return $entity
->hasField('content_translation_changed') ? 'content_translation_changed' : 'changed';
}
protected function doTestTranslationEdit() {
$storage = $this->container
->get('entity_type.manager')
->getStorage($this->entityTypeId);
$storage
->resetCache([
$this->entityId,
]);
$entity = $storage
->load($this->entityId);
$languages = $this->container
->get('language_manager')
->getLanguages();
foreach ($this->langcodes as $langcode) {
if ($langcode != 'en') {
$options = [
'language' => $languages[$langcode],
];
$url = $entity
->toUrl('edit-form', $options);
$this
->drupalGet($url);
$this
->assertSession()
->responseContains($entity
->getTranslation($langcode)
->label());
}
}
}
protected function doTestTranslationChanged() {
$storage = $this->container
->get('entity_type.manager')
->getStorage($this->entityTypeId);
$storage
->resetCache([
$this->entityId,
]);
$entity = $storage
->load($this->entityId);
$changed_field_name = $this
->getChangedFieldName($entity);
$definition = $entity
->getFieldDefinition($changed_field_name);
$config = $definition
->getConfig($entity
->bundle());
foreach ([
FALSE,
TRUE,
] as $translatable_changed_field) {
if ($definition
->isTranslatable()) {
$config
->setTranslatable($translatable_changed_field);
$config
->save();
}
elseif ($translatable_changed_field) {
break;
}
foreach ($entity
->getTranslationLanguages() as $language) {
sleep(1);
$langcode = $language
->getId();
$edit = [
$this->fieldName . '[0][value]' => $this
->randomString(),
];
$edit_path = $entity
->toUrl('edit-form', [
'language' => $language,
]);
$this
->drupalGet($edit_path);
$this
->submitForm($edit, $this
->getFormSubmitAction($entity, $langcode));
$storage = $this->container
->get('entity_type.manager')
->getStorage($this->entityTypeId);
$storage
->resetCache([
$this->entityId,
]);
$entity = $storage
->load($this->entityId);
$this
->assertEquals($entity
->getChangedTimeAcrossTranslations(), $entity
->getTranslation($langcode)
->getChangedTime(), new FormattableMarkup('Changed time for language %language is the latest change over all languages.', [
'%language' => $language
->getName(),
]));
}
$timestamps = [];
foreach ($entity
->getTranslationLanguages() as $language) {
$next_timestamp = $entity
->getTranslation($language
->getId())
->getChangedTime();
if (!in_array($next_timestamp, $timestamps)) {
$timestamps[] = $next_timestamp;
}
}
if ($translatable_changed_field) {
$this
->assertSameSize($entity
->getTranslationLanguages(), $timestamps, 'All timestamps from all languages are different.');
}
else {
$this
->assertCount(1, $timestamps, 'All timestamps from all languages are identical.');
}
}
}
public function doTestChangedTimeAfterSaveWithoutChanges() {
$storage = $this->container
->get('entity_type.manager')
->getStorage($this->entityTypeId);
$storage
->resetCache([
$this->entityId,
]);
$entity = $storage
->load($this->entityId);
if ($entity instanceof EntityChangedInterface) {
$changed_timestamp = $entity
->getChangedTime();
$entity
->save();
$storage = $this->container
->get('entity_type.manager')
->getStorage($this->entityTypeId);
$storage
->resetCache([
$this->entityId,
]);
$entity = $storage
->load($this->entityId);
$this
->assertEquals($changed_timestamp, $entity
->getChangedTime(), 'The entity\'s changed time wasn\'t updated after API save without changes.');
sleep(1);
$language = $entity
->language();
$edit_path = $entity
->toUrl('edit-form', [
'language' => $language,
]);
$this
->drupalGet($edit_path);
$this
->submitForm([], $this
->getFormSubmitAction($entity, $language
->getId()));
$storage
->resetCache([
$this->entityId,
]);
$entity = $storage
->load($this->entityId);
$this
->assertNotEquals($changed_timestamp, $entity
->getChangedTime(), 'The entity\'s changed time was updated after form save without changes.');
}
}
}