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
 ```
 
@@ -170,7 +169,7 @@ This is due to the following [Drupal Console issue][11].
 ## Demo module
 
 The OpenEuropa Multilingual module ships with a demo module which provides all the necessary configuration and code needed
-to showcase the modules's most important features.
+to showcase the modules' most important features.
 
 The demo module includes a translatable content type with automatic URL path generation.
 

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,11 @@
     "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/language_selection_page": "^2.2",
+        "drupal/pathauto": "^1.2"
     },
     "require-dev": {
         "cweagans/composer-patches": "~1.0",
@@ -18,10 +19,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": "^0.2",
         "webflo/drupal-core-require-dev": "8.6.x"
     },
     "scripts": {

modules/oe_multilingual_selection_page/README.md

@@ -0,0 +1,7 @@
+# OpenEuropa Multilingual Selection Page
+
+The OpenEuropa Multilingual Selection Page module will present users with a language selection page, as soon as their
+visit the site.
+
+**Disclaimer**: when installed this module will update existing configuration by enabling the language selection page
+negotiation method, make sure you review these changes before deploying your configuration.

modules/oe_multilingual_selection_page/oe_multilingual_selection_page.info.yml

@@ -0,0 +1,9 @@
+name: 'OpenEuropa Multilingual Selection Page'
+type: module
+description: 'Generates a Language Selection Page used on first access to a multilingual site.'
+core: 8.x
+package: 'OpenEuropa'
+
+dependencies:
+  - drupal:language_selection_page
+  - oe_multilingual:oe_multilingual

modules/oe_multilingual_selection_page/oe_multilingual_selection_page.install

@@ -0,0 +1,42 @@
+<?php
+
+/**
+ * @file
+ * Install, update and uninstall functions for the module.
+ */
+
+declare(strict_types = 1);
+
+use Drupal\language_selection_page\Plugin\LanguageNegotiation\LanguageNegotiationLanguageSelectionPage;
+
+/**
+ * Implements hook_install().
+ */
+function oe_multilingual_selection_page_install(): void {
+  // 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\LanguageNegotiationSetterInterface $setter */
+  $setter = \Drupal::service('oe_multilingual.language_negotiation_setter');
+
+  // Add language selection page negotiation method.
+  // Since this is an optional module setting configuration in its
+  // hook_install() might cause unexpected behaviors.
+  // We are discussing implications in the following ticket:
+  // https://webgate.ec.europa.eu/CITnet/jira/browse/OPENEUROPA-600
+  $setter->addInterfaceSettings([
+    LanguageNegotiationLanguageSelectionPage::METHOD_ID => -18,
+  ]);
+}

modules/oe_multilingual_selection_page/oe_multilingual_selection_page.module

@@ -0,0 +1,27 @@
+<?php
+
+/**
+ * @file
+ * Contains hooks to manipulate language links for selection page.
+ */
+
+declare(strict_types = 1);
+
+/**
+ * Implements hook_page_preprocess().
+ */
+function oe_multilingual_selection_page_preprocess_language_selection_page_content(array &$variables): void {
+
+  // Generate an array suitable for use in the ecl-language-list component.
+  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,
+    ];
+  }
+}

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\LanguageNegotiationSetterInterface $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

@@ -1,4 +1,7 @@
 services:
+  oe_multilingual.language_negotiation_setter:
+    class: Drupal\oe_multilingual\LanguageNegotiationSetter
+    arguments: ['@config.factory']
   oe_multilingual.helper:
     class: Drupal\oe_multilingual\MultilingualHelper
     arguments: ['@entity.repository', '@current_route_match', '@language_manager']

runner.yml.dist

@@ -9,6 +9,7 @@ drupal:
     password: ""
   post_install:
     - "./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 pmu big_pipe -y"

src/LanguageNegotiationSetter.php

@@ -0,0 +1,94 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Drupal\oe_multilingual;
+
+use Drupal\Core\Config\ConfigFactoryInterface;
+use Drupal\Core\Language\LanguageInterface;
+
+/**
+ * Helper service for language negotiation method configuration.
+ */
+class LanguageNegotiationSetter implements LanguageNegotiationSetterInterface {
+
+  /**
+     * 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;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function enableNegotiationMethods(array $methods): void {
+    $this->configFactory
+      ->getEditable(self::CONFIG_NAME)
+      ->set('configurable', $methods)
+      ->save();
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  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();
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function addInterfaceSettings(array $settings): void {
+    $current = $this->configFactory
+      ->get(self::CONFIG_NAME)
+      ->get('negotiation.' . LanguageInterface::TYPE_INTERFACE . '.enabled');
+
+    $settings = array_merge($current, $settings);
+    asort($settings);
+
+    $this->setInterfaceSettings($settings);
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  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();
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function addContentSettings(array $settings): void {
+    $current = $this->configFactory
+      ->get(self::CONFIG_NAME)
+      ->get('negotiation.' . LanguageInterface::TYPE_CONTENT . '.enabled');
+
+    $settings = array_merge($current, $settings);
+    asort($settings);
+
+    $this->setContentSettings($settings);
+  }
+
+}

src/LanguageNegotiationSetterInterface.php

@@ -0,0 +1,82 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Drupal\oe_multilingual;
+
+/**
+ * Helper service for language negotiation method configuration.
+ */
+interface LanguageNegotiationSetterInterface {
+
+  /**
+   * Enable given language negotiation methods.
+   *
+   * @param array $methods
+   *   Array of language negotiation method names.
+   */
+  public function enableNegotiationMethods(array $methods): void;
+
+  /**
+   * Set interface language negotiation settings.
+   *
+   * Usage:
+   *
+   * \Drupal::service('oe_multilingual.language_negotiation_setter')
+   *    ->setInterfaceSettings([
+   *      LanguageNegotiationUrl::METHOD_ID => -19,
+   *      LanguageNegotiationSelected::METHOD_ID => 20,
+   *    ]);
+   *
+   * @param array $settings
+   *   Array of language negotiation method names with their weights.
+   */
+  public function setInterfaceSettings(array $settings): void;
+
+  /**
+   * Add given settings to current interface language negotiation.
+   *
+   * Usage:
+   *
+   * \Drupal::service('oe_multilingual.language_negotiation_setter')
+   *    ->addInterfaceSettings([
+   *      LanguageNegotiationUrl::METHOD_ID => -19,
+   *    ]);
+   *
+   * @param array $settings
+   *   Array of language negotiation method names with their weights.
+   */
+  public function addInterfaceSettings(array $settings): void;
+
+  /**
+   * Set content language negotiation settings.
+   *
+   * Usage:
+   *
+   * \Drupal::service('oe_multilingual.language_negotiation_setter')
+   *    ->setContentSettings([
+   *      LanguageNegotiationUrl::METHOD_ID => -19,
+   *      LanguageNegotiationSelected::METHOD_ID => 20,
+   *    ]);
+   *
+   * @param array $settings
+   *   Array of language negotiation method names with their weights.
+   */
+  public function setContentSettings(array $settings): void;
+
+  /**
+   * Add given settings to current content language negotiation.
+   *
+   * Usage:
+   *
+   * \Drupal::service('oe_multilingual.language_negotiation_setter')
+   *    ->addContentSettings([
+   *      LanguageNegotiationUrl::METHOD_ID => -19,
+   *    ]);
+   *
+   * @param array $settings
+   *   Array of language negotiation method names with their weights.
+   */
+  public function addContentSettings(array $settings): void;
+
+}