ImageOnTranslatedEntityTest.php

<?php

namespace Drupal\Tests\image\Functional;

use Drupal\file\Entity\File;
use Drupal\Tests\TestFileCreationTrait;

/**
 * Uploads images to translated nodes.
 *
 * @group image
 */
class ImageOnTranslatedEntityTest extends ImageFieldTestBase {
    use TestFileCreationTrait {
        getTestFiles as drupalGetTestFiles;
        compareFiles as drupalCompareFiles;
    }
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'language',
        'content_translation',
        'field_ui',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * The name of the image field used in the test.
     *
     * @var string
     */
    protected $fieldName;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        // This test expects unused managed files to be marked as a temporary file.
        $this->config('file.settings')
            ->set('make_unused_managed_files_temporary', TRUE)
            ->save();
        // Create the "Basic page" node type.
        // @todo Remove the disabling of new revision creation in
        //   https://www.drupal.org/node/1239558.
        $this->drupalCreateContentType([
            'type' => 'basicpage',
            'name' => 'Basic page',
            'new_revision' => FALSE,
        ]);
        // Create an image field on the "Basic page" node type.
        $this->fieldName = strtolower($this->randomMachineName());
        $this->createImageField($this->fieldName, 'basicpage', [], [
            'title_field' => 1,
        ]);
        // Create and log in user.
        $permissions = [
            'access administration pages',
            'administer content translation',
            'administer content types',
            'administer languages',
            'administer node fields',
            'create content translations',
            'create basicpage content',
            'edit any basicpage content',
            'translate any entity',
            'delete any basicpage content',
        ];
        $admin_user = $this->drupalCreateUser($permissions);
        $this->drupalLogin($admin_user);
        // Add a second and third language.
        $edit = [];
        $edit['predefined_langcode'] = 'fr';
        $this->drupalGet('admin/config/regional/language/add');
        $this->submitForm($edit, 'Add language');
        $edit = [];
        $edit['predefined_langcode'] = 'nl';
        $this->drupalGet('admin/config/regional/language/add');
        $this->submitForm($edit, 'Add language');
    }
    
    /**
     * Tests synced file fields on translated nodes.
     */
    public function testSyncedImages() {
        // Enable translation for "Basic page" nodes.
        $edit = [
            'entity_types[node]' => 1,
            'settings[node][basicpage][translatable]' => 1,
            "settings[node][basicpage][fields][{$this->fieldName}]" => 1,
            "settings[node][basicpage][columns][{$this->fieldName}][file]" => 1,
            // Explicitly disable alt and title since the javascript disables the
            // checkboxes on the form.
"settings[node][basicpage][columns][{$this->fieldName}][alt]" => FALSE,
            "settings[node][basicpage][columns][{$this->fieldName}][title]" => FALSE,
        ];
        $this->drupalGet('admin/config/regional/content-language');
        $this->submitForm($edit, 'Save configuration');
        // Verify that the image field on the "Basic basic" node type is
        // translatable.
        $definitions = \Drupal::service('entity_field.manager')->getFieldDefinitions('node', 'basicpage');
        $this->assertTrue($definitions[$this->fieldName]
            ->isTranslatable(), 'Node image field is translatable.');
        // Create a default language node.
        $default_language_node = $this->drupalCreateNode([
            'type' => 'basicpage',
            'title' => 'Lost in translation',
        ]);
        // Edit the node to upload a file.
        $edit = [];
        $name = 'files[' . $this->fieldName . '_0]';
        $edit[$name] = \Drupal::service('file_system')->realpath($this->drupalGetTestFiles('image')[0]->uri);
        $this->drupalGet('node/' . $default_language_node->id() . '/edit');
        $this->submitForm($edit, 'Save');
        $edit = [
            $this->fieldName . '[0][alt]' => 'Lost in translation image',
            $this->fieldName . '[0][title]' => 'Lost in translation image title',
        ];
        $this->submitForm($edit, 'Save');
        $first_fid = $this->getLastFileId();
        // Translate the node into French: remove the existing file.
        $this->drupalGet('node/' . $default_language_node->id() . '/translations/add/en/fr');
        $this->submitForm([], 'Remove');
        // Upload a different file.
        $edit = [];
        $edit['title[0][value]'] = 'Scarlett Johansson';
        $name = 'files[' . $this->fieldName . '_0]';
        $edit[$name] = \Drupal::service('file_system')->realpath($this->drupalGetTestFiles('image')[1]->uri);
        $this->submitForm($edit, 'Save (this translation)');
        $edit = [
            $this->fieldName . '[0][alt]' => 'Scarlett Johansson image',
            $this->fieldName . '[0][title]' => 'Scarlett Johansson image title',
        ];
        $this->submitForm($edit, 'Save (this translation)');
        // This inspects the HTML after the post of the translation, the image
        // should be displayed on the original node.
        $this->assertSession()
            ->responseContains('alt="Lost in translation image"');
        $this->assertSession()
            ->responseContains('title="Lost in translation image title"');
        $second_fid = $this->getLastFileId();
        // View the translated node.
        $this->drupalGet('fr/node/' . $default_language_node->id());
        $this->assertSession()
            ->responseContains('alt="Scarlett Johansson image"');
        \Drupal::entityTypeManager()->getStorage('file')
            ->resetCache();
        
        /** @var \Drupal\file\FileInterface $file */
        // Ensure the file status of the first file permanent.
        $file = File::load($first_fid);
        $this->assertTrue($file->isPermanent());
        // Ensure the file status of the second file is permanent.
        $file = File::load($second_fid);
        $this->assertTrue($file->isPermanent());
        // Translate the node into dutch: remove the existing file.
        $this->drupalGet('node/' . $default_language_node->id() . '/translations/add/en/nl');
        $this->submitForm([], 'Remove');
        // Upload a different file.
        $edit = [];
        $edit['title[0][value]'] = 'Akiko Takeshita';
        $name = 'files[' . $this->fieldName . '_0]';
        $edit[$name] = \Drupal::service('file_system')->realpath($this->drupalGetTestFiles('image')[2]->uri);
        $this->submitForm($edit, 'Save (this translation)');
        $edit = [
            $this->fieldName . '[0][alt]' => 'Akiko Takeshita image',
            $this->fieldName . '[0][title]' => 'Akiko Takeshita image title',
        ];
        $this->submitForm($edit, 'Save (this translation)');
        $third_fid = $this->getLastFileId();
        \Drupal::entityTypeManager()->getStorage('file')
            ->resetCache();
        // Ensure the first file is untouched.
        $file = File::load($first_fid);
        $this->assertTrue($file->isPermanent(), 'First file still exists and is permanent.');
        // This inspects the HTML after the post of the translation, the image
        // should be displayed on the original node.
        $this->assertSession()
            ->responseContains('alt="Lost in translation image"');
        $this->assertSession()
            ->responseContains('title="Lost in translation image title"');
        // View the translated node.
        $this->drupalGet('nl/node/' . $default_language_node->id());
        $this->assertSession()
            ->responseContains('alt="Akiko Takeshita image"');
        $this->assertSession()
            ->responseContains('title="Akiko Takeshita image title"');
        // Ensure the file status of the second file is permanent.
        $file = File::load($second_fid);
        $this->assertTrue($file->isPermanent());
        // Ensure the file status of the third file is permanent.
        $file = File::load($third_fid);
        $this->assertTrue($file->isPermanent());
        // Edit the second translation: remove the existing file.
        $this->drupalGet('fr/node/' . $default_language_node->id() . '/edit');
        $this->submitForm([], 'Remove');
        // Upload a different file.
        $edit = [];
        $edit['title[0][value]'] = 'Giovanni Ribisi';
        $name = 'files[' . $this->fieldName . '_0]';
        $edit[$name] = \Drupal::service('file_system')->realpath($this->drupalGetTestFiles('image')[3]->uri);
        $this->submitForm($edit, 'Save (this translation)');
        $name = $this->fieldName . '[0][alt]';
        $edit = [
            $name => 'Giovanni Ribisi image',
        ];
        $this->submitForm($edit, 'Save (this translation)');
        $replaced_second_fid = $this->getLastFileId();
        \Drupal::entityTypeManager()->getStorage('file')
            ->resetCache();
        // Ensure the first and third files are untouched.
        $file = File::load($first_fid);
        $this->assertTrue($file->isPermanent(), 'First file still exists and is permanent.');
        $file = File::load($third_fid);
        $this->assertTrue($file->isPermanent());
        // Ensure the file status of the replaced second file is permanent.
        $file = File::load($replaced_second_fid);
        $this->assertTrue($file->isPermanent());
        // Delete the third translation.
        $this->drupalGet('nl/node/' . $default_language_node->id() . '/delete');
        $this->submitForm([], 'Delete Dutch translation');
        \Drupal::entityTypeManager()->getStorage('file')
            ->resetCache();
        // Ensure the first and replaced second files are untouched.
        $file = File::load($first_fid);
        $this->assertTrue($file->isPermanent(), 'First file still exists and is permanent.');
        $file = File::load($replaced_second_fid);
        $this->assertTrue($file->isPermanent());
        // Ensure the file status of the third file is now temporary.
        $file = File::load($third_fid);
        $this->assertTrue($file->isTemporary());
        // Delete the all translations.
        $this->drupalGet('node/' . $default_language_node->id() . '/delete');
        $this->submitForm([], 'Delete all translations');
        \Drupal::entityTypeManager()->getStorage('file')
            ->resetCache();
        // Ensure the file status of the all files are now temporary.
        $file = File::load($first_fid);
        $this->assertTrue($file->isTemporary(), 'First file still exists and is temporary.');
        $file = File::load($replaced_second_fid);
        $this->assertTrue($file->isTemporary());
    }

}