NodeLanguageTest.php

<?php

declare (strict_types=1);
namespace Drupal\Tests\node\Functional\Views;

use Drupal\Core\Language\LanguageInterface;
use Drupal\field\Entity\FieldStorageConfig;
use Drupal\language\Entity\ConfigurableLanguage;
use Drupal\views\Plugin\views\PluginBase;
use Drupal\views\Tests\ViewTestData;
use Drupal\views\Views;
// cspell:ignore nodo nœud tercera

/**
 * Tests node language fields, filters, and sorting.
 *
 * @group node
 */
class NodeLanguageTest extends NodeTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'language',
        'node_test_views',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * Views used by this test.
     *
     * @var array
     */
    public static $testViews = [
        'test_language',
    ];
    
    /**
     * List of node titles by language.
     *
     * @var array
     */
    public $nodeTitles = [];
    
    /**
     * {@inheritdoc}
     */
    protected function setUp($import_test_views = TRUE, $modules = []) : void {
        parent::setUp(FALSE, $modules);
        // Create Page content type.
        if ($this->profile != 'standard') {
            $this->drupalCreateContentType([
                'type' => 'page',
                'name' => 'Basic page',
            ]);
            ViewTestData::createTestViews(static::class, [
                'node_test_views',
            ]);
        }
        // Add two new languages.
        ConfigurableLanguage::createFromLangcode('fr')->save();
        ConfigurableLanguage::createFromLangcode('es')->save();
        // Make the body field translatable. The title is already translatable by
        // definition.
        $field_storage = FieldStorageConfig::loadByName('node', 'body');
        $field_storage->setTranslatable(TRUE);
        $field_storage->save();
        // Set up node titles. They should not include the words "French",
        // "English", or "Spanish", as there is a language field in the view
        // that prints out those words.
        $this->nodeTitles = [
            LanguageInterface::LANGCODE_NOT_SPECIFIED => [
                'First node und',
            ],
            'es' => [
                'Primero nodo es',
                'Segundo nodo es',
                'Tercera nodo es',
            ],
            'en' => [
                'First node en',
                'Second node en',
            ],
            'fr' => [
                'Premier nœud fr',
            ],
        ];
        // Create nodes with translations.
        foreach ($this->nodeTitles['es'] as $index => $title) {
            $node = $this->drupalCreateNode([
                'title' => $title,
                'langcode' => 'es',
                'type' => 'page',
                'promote' => 1,
            ]);
            foreach ([
                'en',
                'fr',
            ] as $langcode) {
                if (isset($this->nodeTitles[$langcode][$index])) {
                    $translation = $node->addTranslation($langcode, [
                        'title' => $this->nodeTitles[$langcode][$index],
                    ]);
                    $translation->body->value = $this->randomMachineName(32);
                }
            }
            $node->save();
        }
        // Create non-translatable nodes.
        foreach ($this->nodeTitles[LanguageInterface::LANGCODE_NOT_SPECIFIED] as $index => $title) {
            $node = $this->drupalCreateNode([
                'title' => $title,
                'langcode' => LanguageInterface::LANGCODE_NOT_SPECIFIED,
                'type' => 'page',
                'promote' => 1,
            ]);
            $node->body->value = $this->randomMachineName(32);
            $node->save();
        }
        $user = $this->drupalCreateUser([
            'access content overview',
            'access content',
        ]);
        $this->drupalLogin($user);
    }
    
    /**
     * Tests translation language filter, field, and sort.
     */
    public function testLanguages() : void {
        // Test the page with no arguments. It is filtered to Spanish and French.
        // The page shows node titles and languages.
        $this->drupalGet('test-language');
        $message = 'French/Spanish page';
        // Test that the correct nodes are shown.
        foreach ($this->nodeTitles as $langcode => $list) {
            foreach ($list as $title) {
                if ($langcode == 'en') {
                    $this->assertSession()
                        ->pageTextNotContains($title);
                }
                else {
                    $this->assertSession()
                        ->pageTextContains($title);
                }
            }
        }
        // Test that the language field value is shown.
        $this->assertSession()
            ->pageTextNotContains('English');
        $this->assertSession()
            ->pageTextContains('French');
        $this->assertSession()
            ->pageTextContains('Spanish');
        // Test page sorting, which is by language code, ascending. So the
        // Spanish nodes should appear before the French nodes.
        $page = $this->getTextContent();
        $pos_es_max = 0;
        $pos_fr_min = 10000;
        foreach ($this->nodeTitles['es'] as $title) {
            $pos_es_max = max($pos_es_max, strpos($page, $title));
        }
        foreach ($this->nodeTitles['fr'] as $title) {
            $pos_fr_min = min($pos_fr_min, strpos($page, $title));
        }
        $this->assertLessThan($pos_fr_min, $pos_es_max, "The Spanish translation should appear before the French one on {$message}.");
        // Test the argument -- filter to just Spanish.
        $this->drupalGet('test-language/es');
        // This time, test just the language field.
        $message = 'Spanish argument page';
        $this->assertSession()
            ->pageTextNotContains('English');
        $this->assertSession()
            ->pageTextNotContains('French');
        $this->assertSession()
            ->pageTextContains('Spanish');
        // Test the front page view filter. Only node titles in the current language
        // should be displayed on the front page by default.
        foreach ($this->nodeTitles as $langcode => $titles) {
            // The frontpage view does not display content without a language.
            if ($langcode == LanguageInterface::LANGCODE_NOT_SPECIFIED) {
                continue;
            }
            $this->drupalGet(($langcode == 'en' ? '' : "{$langcode}/") . 'node');
            foreach ($titles as $title) {
                $this->assertSession()
                    ->pageTextContains($title);
            }
            foreach ($this->nodeTitles as $control_langcode => $control_titles) {
                if ($langcode != $control_langcode) {
                    foreach ($control_titles as $title) {
                        $this->assertSession()
                            ->pageTextNotContains($title);
                    }
                }
            }
        }
        // Test the node admin view filter. By default all translations should show.
        $this->drupalGet('admin/content');
        foreach ($this->nodeTitles as $titles) {
            foreach ($titles as $title) {
                $this->assertSession()
                    ->pageTextContains($title);
            }
        }
        // When filtered, only the specific languages should show.
        foreach ($this->nodeTitles as $langcode => $titles) {
            $this->drupalGet('admin/content', [
                'query' => [
                    'langcode' => $langcode,
                ],
            ]);
            foreach ($titles as $title) {
                $this->assertSession()
                    ->pageTextContains($title);
            }
            foreach ($this->nodeTitles as $control_langcode => $control_titles) {
                if ($langcode != $control_langcode) {
                    foreach ($control_titles as $title) {
                        $this->assertSession()
                            ->pageTextNotContains($title);
                    }
                }
            }
        }
        // Override the config for the front page view, so that the language
        // filter is set to the site default language instead. This should just
        // show the English nodes, no matter what the content language is.
        $config = $this->config('views.view.frontpage');
        $config->set('display.default.display_options.filters.langcode.value', [
            PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT => PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT,
        ]);
        $config->save();
        foreach ($this->nodeTitles as $langcode => $titles) {
            if ($langcode == LanguageInterface::LANGCODE_NOT_SPECIFIED) {
                continue;
            }
            $this->drupalGet(($langcode == 'en' ? '' : "{$langcode}/") . 'node');
            foreach ($this->nodeTitles as $control_langcode => $control_titles) {
                foreach ($control_titles as $title) {
                    if ($control_langcode == 'en') {
                        $this->assertSession()
                            ->pageTextContains($title);
                    }
                    else {
                        $this->assertSession()
                            ->pageTextNotContains($title);
                    }
                }
            }
        }
        // Override the config so that the language filter is set to the UI
        // language, and make that have a fixed value of 'es'.
        //
        // IMPORTANT: Make sure this part of the test is last -- it is changing
        // language configuration!
        $config->set('display.default.display_options.filters.langcode.value', [
            '***LANGUAGE_language_interface***' => '***LANGUAGE_language_interface***',
        ]);
        $config->save();
        $language_config = $this->config('language.types');
        $language_config->set('negotiation.language_interface.enabled', [
            'language-selected' => 1,
        ]);
        $language_config->save();
        $language_config = $this->config('language.negotiation');
        $language_config->set('selected_langcode', 'es');
        $language_config->save();
        // With a fixed language selected, there is no language-based URL.
        $this->drupalGet('node');
        foreach ($this->nodeTitles as $control_langcode => $control_titles) {
            foreach ($control_titles as $title) {
                if ($control_langcode == 'es') {
                    $this->assertSession()
                        ->pageTextContains($title);
                }
                else {
                    $this->assertSession()
                        ->pageTextNotContains($title);
                }
            }
        }
    }
    
    /**
     * Tests native name display in language field.
     */
    public function testNativeLanguageField() : void {
        $this->assertLanguageNames();
        // Modify test view to display native language names and set translations.
        $config = $this->config('views.view.test_language');
        $config->set('display.default.display_options.fields.langcode.settings.native_language', TRUE);
        $config->save();
        \Drupal::languageManager()->getLanguageConfigOverride('fr', 'language.entity.fr')
            ->set('label', 'Français')
            ->save();
        \Drupal::languageManager()->getLanguageConfigOverride('es', 'language.entity.es')
            ->set('label', 'Español')
            ->save();
        $this->assertLanguageNames(TRUE);
        // Modify test view to use the views built-in language field and test that.
        \Drupal::state()->set('node_test_views.use_basic_handler', TRUE);
        Views::viewsData()->clear();
        $config = $this->config('views.view.test_language');
        $config->set('display.default.display_options.fields.langcode.native_language', FALSE);
        $config->clear('display.default.display_options.fields.langcode.settings');
        $config->clear('display.default.display_options.fields.langcode.type');
        $config->set('display.default.display_options.fields.langcode.plugin_id', 'language');
        $config->save();
        $this->assertLanguageNames();
        $config->set('display.default.display_options.fields.langcode.native_language', TRUE)
            ->save();
        $this->assertLanguageNames(TRUE);
    }
    
    /**
     * Asserts the presence of language names in their English or native forms.
     *
     * @param bool $native
     *   (optional) Whether to assert the language name in its native form.
     *
     * @internal
     */
    protected function assertLanguageNames(bool $native = FALSE) : void {
        $this->drupalGet('test-language');
        if ($native) {
            $this->assertSession()
                ->pageTextContains('Français');
            $this->assertSession()
                ->pageTextContains('Español');
            $this->assertSession()
                ->pageTextNotContains('French');
            $this->assertSession()
                ->pageTextNotContains('Spanish');
        }
        else {
            $this->assertSession()
                ->pageTextNotContains('Français');
            $this->assertSession()
                ->pageTextNotContains('Español');
            $this->assertSession()
                ->pageTextContains('French');
            $this->assertSession()
                ->pageTextContains('Spanish');
        }
    }

}