OPENEUROPA-480: Provide a language selection page

README.md

@@ -130,7 +130,6 @@ Then:
 $ docker-compose exec -u web web composer install
 $ docker-compose exec -u node node npm install
 $ docker-compose exec -u node node npm run build
-$ docker-compose exec -u web web ./vendor/bin/run drupal:site-setup
 $ docker-compose exec -u web web ./vendor/bin/run drupal:site-install
 ```
 

behat.yml.dist

@@ -7,6 +7,7 @@ default:
         - Drupal\DrupalExtension\Context\MinkContext
         - Drupal\DrupalExtension\Context\DrupalContext
         - Drupal\Tests\oe_multilingual\Behat\DrupalContext
+        - Drupal\Tests\oe_multilingual\Behat\MinkContext
   extensions:
     Behat\MinkExtension:
       goutte: ~

composer.json

@@ -6,10 +6,12 @@
     "minimum-stability": "dev",
     "prefer-stable": true,
     "require": {
+        "php": "^7.1",
         "drupal/administration_language_negotiation": "1.4",
         "drupal/core": "~8.6",
-        "drupal/pathauto": "1.2",
-        "php": "^7.1"
+        "drupal/devel": "^1.2",
+        "drupal/language_selection_page": "2.2",
+        "drupal/pathauto": "1.2"
     },
     "require-dev": {
         "cweagans/composer-patches": "~1.0",
@@ -18,10 +20,11 @@
         "drupal/console": "^1.6",
         "drupal/config_devel": "~1.2",
         "drush/drush": "^9",
+        "drupal/devel": "^1.2",
         "drupal/drupal-extension": "^4.0.0@alpha",
         "openeuropa/code-review": "^0.2",
         "openeuropa/task-runner": "^0.5",
-        "openeuropa/oe_theme": "dev-master",
+        "openeuropa/oe_theme": "dev-OPENEUROPA-480",
         "webflo/drupal-core-require-dev": "8.6.x"
     },
     "scripts": {

modules/oe_multilingual_selection_page/oe_multilingual_selection_page.info.yml

@@ -0,0 +1,19 @@
+name: 'OpenEuropa Multilingual Selection Page'
+type: module
+description: 'Module for OpenEuropa Multilingual Language Selection Page.'
+core: 8.x
+package: 'OpenEuropa'
+
+dependencies:
+  - drupal:language_selection_page
+  - oe_multilingual:oe_multilingual
+
+config_devel:
+  install:
+    - core.entity_form_display.node.oe_demo_translatable_page.default
+    - core.entity_view_display.node.oe_demo_translatable_page.default
+    - field.storage.node.field_oe_demo_translatable_body
+    - field.field.node.oe_demo_translatable_page.field_oe_demo_translatable_body
+    - language.content_settings.node.oe_demo_translatable_page
+    - node.type.oe_demo_translatable_page
+    - pathauto.pattern.oe_demo_translatable_page

modules/oe_multilingual_selection_page/oe_multilingual_selection_page.install

@@ -0,0 +1,44 @@
+<?php
+
+/**
+ * @file
+ * Install, update and uninstall functions for the module.
+ */
+
+declare(strict_types = 1);
+
+use Drupal\administration_language_negotiation\Plugin\LanguageNegotiation\LanguageNegotiationAdministrationLanguage;
+use Drupal\language\Plugin\LanguageNegotiation\LanguageNegotiationUrl;
+use Drupal\language\Plugin\LanguageNegotiation\LanguageNegotiationSelected;
+use Drupal\language_selection_page\Plugin\LanguageNegotiation\LanguageNegotiationLanguageSelectionPage;
+
+/**
+ * Implements hook_install().
+ */
+function oe_multilingual_selection_page_install() {
+  // Configure selection page language negotiation method.
+  \Drupal::configFactory()
+    ->getEditable('language_selection_page.negotiation')
+    ->set('path', '/select-language')
+    ->set('type', 'standalone')
+    ->set('ignore_neutral', FALSE)
+    ->set('blacklisted_paths', [
+      '/admin',
+      '/user',
+      '/admin/*',
+      '/admin*',
+      '/node/add/*',
+      '/node/*/edit',
+    ])->save();
+
+  /** @var \Drupal\oe_multilingual\LanguageNegotiationSetter $setter */
+  $setter = \Drupal::service('oe_multilingual.language_negotiation_setter');
+
+  // For interface negotiation make sure administrative pages are in English.
+  $setter->setInterfaceSettings([
+    LanguageNegotiationAdministrationLanguage::METHOD_ID => -20,
+    LanguageNegotiationUrl::METHOD_ID => -19,
+    LanguageNegotiationLanguageSelectionPage::METHOD_ID => -18,
+    LanguageNegotiationSelected::METHOD_ID => 20,
+  ]);
+}

modules/oe_multilingual_selection_page/oe_multilingual_selection_page.module

@@ -0,0 +1,29 @@
+<?php
+
+/**
+ * @file
+ * Contains hooks to manipulate language links for selection page.
+ */
+
+/**
+ * Implements hook_page_preprocess().
+ */
+function oe_multilingual_selection_page_preprocess_language_selection_page_content(array &$variables) {
+
+  $current_language = \Drupal::languageManager()
+    ->getCurrentLanguage()
+    ->getId();
+
+  foreach ($variables['language_links']['#items'] as $key => $value) {
+    $language_code = $key;
+    $url = $value['#url']->toString();
+
+    $variables['languages'][] = [
+      "href" => $url,
+      "hreflang" => $language_code,
+      "label" => $value["#title"],
+      "lang" => $language_code,
+      "isActive" => $language_code === $current_language,
+    ];
+  }
+}

oe_multilingual.info.yml

@@ -39,4 +39,4 @@ config_devel:
 
   optional:
     # Language switcher block
-    - block.block.oe_multilingual_language_switcher
+    - block.block.oe_multilingual_language_switcher

oe_multilingual.install

@@ -36,29 +36,31 @@ function oe_multilingual_install() {
       '/node/*/translations',
     ])->save();
 
+  // Make sure that English language prefix is set to "en".
+  \Drupal::configFactory()
+    ->getEditable('language.negotiation')
+    ->set('url.prefixes.en', 'en')
+    ->save();
+
+  /** @var \Drupal\oe_multilingual\LanguageNegotiationSetter $setter */
+  $setter = \Drupal::service('oe_multilingual.language_negotiation_setter');
+
+  // Set default language negotiation methods.
+  $setter->enableNegotiationMethods([
+    LanguageInterface::TYPE_INTERFACE,
+    LanguageInterface::TYPE_CONTENT,
+  ]);
+
   // For interface negotiation make sure administrative pages are in English.
-  $interface_settings = [
+  $setter->setInterfaceSettings([
     LanguageNegotiationAdministrationLanguage::METHOD_ID => -20,
     LanguageNegotiationUrl::METHOD_ID => -19,
     LanguageNegotiationSelected::METHOD_ID => 20,
-  ];
+  ]);
 
   // For content negotiation make sure that content respects URL language.
-  $content_settings = [
+  $setter->setContentSettings([
     LanguageNegotiationUrl::METHOD_ID => -19,
     LanguageNegotiationSelected::METHOD_ID => 20,
-  ];
-
-  // Set default language negotiation methods with related weights.
-  \Drupal::configFactory()
-    ->getEditable('language.types')
-    ->set('configurable', [
-      LanguageInterface::TYPE_INTERFACE,
-      LanguageInterface::TYPE_CONTENT,
-    ])
-    ->set('negotiation.' . LanguageInterface::TYPE_INTERFACE . '.enabled', $interface_settings)
-    ->set('negotiation.' . LanguageInterface::TYPE_INTERFACE . '.method_weights', $interface_settings)
-    ->set('negotiation.' . LanguageInterface::TYPE_CONTENT . '.enabled', $content_settings)
-    ->set('negotiation.' . LanguageInterface::TYPE_CONTENT . '.method_weights', $content_settings)
-    ->save();
+  ]);
 }

oe_multilingual.services.yml

@@ -0,0 +1,4 @@
+services:
+  oe_multilingual.language_negotiation_setter:
+    class: Drupal\oe_multilingual\LanguageNegotiationSetter
+    arguments: ['@config.factory']

runner.yml.dist

@@ -10,6 +10,7 @@ drupal:
   post_install:
     - "./vendor/bin/drush en oe_theme_helper -y"
     - "./vendor/bin/drush en config_devel -y"
+    - "./vendor/bin/drush en devel -y"
     - "./vendor/bin/drush en oe_multilingual -y"
     - "./vendor/bin/drush en oe_multilingual_demo -y"
     - "./vendor/bin/drush theme:enable oe_theme -y"

src/LanguageNegotiationSetter.php

@@ -0,0 +1,73 @@
+<?php
+
+namespace Drupal\oe_multilingual;
+
+use Drupal\Core\Config\ConfigFactoryInterface;
+use Drupal\Core\Language\LanguageInterface;
+
+/**
+ * Helper service for language negotiation method configuration.
+ */
+class LanguageNegotiationSetter {
+
+  /**
+   * Configuration name.
+   */
+  const CONFIG_NAME = 'language.types';
+
+  /**
+   * Drupal\Core\Config\ConfigFactoryInterface definition.
+   *
+   * @var \Drupal\Core\Config\ConfigFactoryInterface
+   */
+  protected $configFactory;
+
+  /**
+   * Constructs a new LanguageNegotiationSetter object.
+   */
+  public function __construct(ConfigFactoryInterface $config_factory) {
+    $this->configFactory = $config_factory;
+  }
+
+  /**
+   * Enable given language negotiation methods.
+   *
+   * @param array $methods
+   *   Array of language negotiation method names.
+   */
+  public function enableNegotiationMethods(array $methods) {
+    $this->configFactory
+      ->getEditable(self::CONFIG_NAME)
+      ->set('configurable', $methods)
+      ->save();
+  }
+
+  /**
+   * Set interface language negotiation settings.
+   *
+   * @param array $settings
+   *   Array of language negotiation method names with their weights.
+   */
+  public function setInterfaceSettings(array $settings): void {
+    $this->configFactory
+      ->getEditable(self::CONFIG_NAME)
+      ->set('negotiation.' . LanguageInterface::TYPE_INTERFACE . '.enabled', $settings)
+      ->set('negotiation.' . LanguageInterface::TYPE_INTERFACE . '.method_weights', $settings)
+      ->save();
+  }
+
+  /**
+   * Set content language negotiation settings.
+   *
+   * @param array $settings
+   *   Array of language negotiation method names with their weights.
+   */
+  public function setContentSettings(array $settings): void {
+    $this->configFactory
+      ->getEditable(self::CONFIG_NAME)
+      ->set('negotiation.' . LanguageInterface::TYPE_CONTENT . '.enabled', $settings)
+      ->set('negotiation.' . LanguageInterface::TYPE_CONTENT . '.method_weights', $settings)
+      ->save();
+  }
+
+}

tests/Behat/DrupalContext.php

@@ -4,6 +4,8 @@
 
 namespace Drupal\Tests\oe_multilingual\Behat;
 
+use Behat\Behat\Hook\Scope\AfterScenarioScope;
+use Behat\Behat\Hook\Scope\BeforeScenarioScope;
 use Behat\Gherkin\Node\TableNode;
 use Drupal\Core\Entity\ContentEntityInterface;
 use Drupal\DrupalExtension\Context\RawDrupalContext;
@@ -15,6 +17,33 @@
  */
 class DrupalContext extends RawDrupalContext {
 
+  /**
+   * Enable OpenEuropa Multilingual Selection Page module.
+   *
+   * @param \Behat\Behat\Hook\Scope\BeforeScenarioScope $scope
+   *   The Hook scope.
+   *
+   * @BeforeScenario @selection-page
+   */
+  public function setupSelectionPage(BeforeScenarioScope $scope): void {
+    \Drupal::service('module_installer')->install(['oe_multilingual_selection_page']);
+  }
+
+  /**
+   * Disable OpenEuropa Multilingual Selection Page module.
+   *
+   * @param \Behat\Behat\Hook\Scope\AfterScenarioScope $scope
+   *   The Hook scope.
+   *
+   * @AfterScenario @selection-page
+   */
+  public function revertSelectionPage(AfterScenarioScope $scope): void {
+    \Drupal::service('module_installer')->uninstall([
+      'oe_multilingual_selection_page',
+      'language_selection_page',
+    ]);
+  }
+
   /**
    * Create content given its type and fields.
    *

tests/Behat/MinkContext.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Drupal\Tests\oe_multilingual\Behat;
+
+use Behat\MinkExtension\Context\RawMinkContext;
+
+/**
+ * Class MinkContext.
+ */
+class MinkContext extends RawMinkContext {
+
+  /**
+   * Assert that visitor is redirected to language selection page.
+   *
+   * @Then I should be redirected to the language selection page
+   */
+  public function assertLanguageSelectionPageRedirect() {
+    $this->assertSession()->addressMatches("/.*\/select-language/");
+  }
+
+}

tests/features/language-selection.feature

@@ -0,0 +1,33 @@
+@api @selection-page
+Feature: Language selection
+  In order to be able choose the initial language of the site
+  As a visitor
+  I want to be presented with a language selection page
+
+  Background:
+    Given the following "Demo translatable page" content item:
+      | Title | Test page   |
+      | Body  | Hello world |
+    And the following "French" translation for the "Demo translatable page" with title "Test page":
+      | Title | Page de test     |
+      | Body  | Bonjour le monde |
+    And the following "Spanish" translation for the "Demo translatable page" with title "Test page":
+      | Title | Página de prueba |
+      | Body  | Hola Mundo       |
+
+  Scenario: When I visit the homepage I'm presented with a language selection page
+
+    Given I am on the homepage
+    Then I should be redirected to the language selection page
+
+    When I click "French"
+    Then the url should match "/fr"
+
+  Scenario: Users visiting a page should be presented with the language selection page,
+            if no language is detected in the URL.
+
+    Given I visit the "Test page" content
+    Then I should be redirected to the language selection page
+
+    When I click "French"
+    Then the url should match "/fr/page-de-test"