clean install

web/profiles/farm/modules/core/l10n/farm_l10n.info.yml

@@ -0,0 +1,9 @@
+name: farmOS Localization
+description: Enables default configuration for localizing/translating farmOS.
+type: module
+package: farmOS
+core_version_requirement: ^10
+dependencies:
+  - drupal:config_translation
+  - drupal:language
+  - drupal:locale

web/profiles/farm/modules/core/l10n/farm_l10n.install

@@ -0,0 +1,21 @@
+<?php
+
+/**
+ * @file
+ * Install, update and uninstall functions for the farm_l10n module.
+ */
+
+/**
+ * Implements hook_install().
+ */
+function farm_l10n_install() {
+
+  // Configure the enabled language detection methods.
+  \Drupal::configFactory()->getEditable('language.types')->set('negotiation.language_interface.enabled', [
+    'language-user' => 0,
+    'language-selected' => 50,
+  ])->save();
+
+  // Configure automatic monthly language updates.
+  \Drupal::configFactory()->getEditable('locale.settings')->set('translation.update_interval_days', 30)->save();
+}

web/profiles/farm/modules/core/l10n/farm_l10n.links.task.yml

@@ -0,0 +1,4 @@
+farm_l10n.settings:
+  base_route: farm_settings.settings_page
+  route_name: farm_l10n.settings
+  title: 'Language'

web/profiles/farm/modules/core/l10n/farm_l10n.module

@@ -0,0 +1,81 @@
+<?php
+
+/**
+ * @file
+ * Hooks and customizations for the farm_l10n module.
+ */
+
+use Drupal\Core\Form\FormStateInterface;
+use Drupal\Core\Render\Element;
+use Drupal\Core\Routing\RouteMatchInterface;
+use Drupal\Core\Url;
+
+/**
+ * Implements hook_help().
+ */
+function farm_l10n_help($route_name, RouteMatchInterface $route_match) {
+  $output = '';
+
+  // Help text for the farm/settings/language form.
+  if ($route_name == 'farm_l10n.settings') {
+    $output .= '<p>' . t('Select the default language for the user interface. Individual users can override this by editing their profile.') . '</p>';
+  }
+
+  return $output;
+}
+
+/**
+ * Implements hook_entity_bundle_info_alter().
+ */
+function farm_l10n_entity_bundle_info_alter(&$bundles) {
+
+  // If the content translation module is not enabled, alter all entity type
+  // bundles to mark them as not translatable. This fixes an issue with
+  // JSON:API PATCH requests when authenticated as a user with a non-default
+  // language.
+  // @see https://www.drupal.org/project/farm/issues/3335267
+  if (\Drupal::moduleHandler()->moduleExists('content_translation')) {
+    return;
+  }
+  foreach ($bundles as $entity_type => $entity_type_bundles) {
+    foreach ($entity_type_bundles as $bundle => $bundle_info) {
+      if (!empty($bundle_info['translatable']) && $bundle_info['translatable'] === TRUE) {
+        $bundles[$entity_type][$bundle]['translatable'] = FALSE;
+      }
+    }
+  }
+}
+
+/**
+ * Implements hook_form_FORM_ID_alter().
+ */
+function farm_l10n_form_language_admin_overview_form_alter(&$form, FormStateInterface $form_state, $form_id) {
+
+  // Disable the ability to change the site's default language and direct users
+  // to /farm/settings/language instead.
+  // @see https://www.drupal.org/project/farm/issues/3257430
+  $message = t('To change the default language of farmOS, please go to <a href=":url">farmOS language settings</a>.', [':url' => Url::fromRoute('farm_l10n.settings')->toString()]);
+  \Drupal::messenger()->addWarning($message);
+  foreach (Element::children($form['languages']) as $langcode) {
+    $form['languages'][$langcode]['default']['#access'] = FALSE;
+  }
+}
+
+/**
+ * Implements hook_form_FORM_ID_alter().
+ */
+function farm_l10n_form_user_register_form_alter(&$form, FormStateInterface $form_state, $form_id) {
+
+  // Use the "Selected language" as the default for new users (unless it is
+  // still set to "site_default").
+  $selected_language = \Drupal::config('language.negotiation')->get('selected_langcode');
+  if ($selected_language == 'site_default') {
+    return;
+  }
+  if (!empty($form['language']['preferred_langcode'])) {
+    $form['language']['preferred_langcode']['#default_value'] = $selected_language;
+  }
+  if (!empty($form['language']['preferred_admin_langcode'])) {
+    $form['language']['preferred_admin_langcode']['#default_value'] = $selected_language;
+  }
+}

web/profiles/farm/modules/core/l10n/farm_l10n.permissions.yml

@@ -0,0 +1,2 @@
+administer farm language:
+  title: 'Administer farmOS language'

web/profiles/farm/modules/core/l10n/farm_l10n.routing.yml

@@ -0,0 +1,7 @@
+farm_l10n.settings:
+  path: '/farm/settings/language'
+  defaults:
+    _form: '\Drupal\farm_l10n\Form\L10nSettingsForm'
+    _title: 'Language settings'
+  requirements:
+    _permission: 'administer farm language'

web/profiles/farm/modules/core/l10n/farm_l10n.services.yml

@@ -0,0 +1,5 @@
+services:
+  farm_l10n.overrider:
+    class: Drupal\farm_l10n\Config\FarmLocalizationOverrides
+    tags:
+      - { name: config.factory.override, priority: 5 }

web/profiles/farm/modules/core/l10n/src/Config/FarmLocalizationOverrides.php

@@ -0,0 +1,46 @@
+<?php
+
+namespace Drupal\farm_l10n\Config;
+
+use Drupal\Core\Cache\CacheableMetadata;
+use Drupal\Core\Config\ConfigFactoryOverrideInterface;
+use Drupal\Core\Config\StorageInterface;
+
+/**
+ * Configuration overrides for farmOS localization module.
+ */
+class FarmLocalizationOverrides implements ConfigFactoryOverrideInterface {
+
+  /**
+   * {@inheritdoc}
+   */
+  public function loadOverrides($names) {
+    $overrides = [];
+    if (in_array('system.site', $names)) {
+      $overrides['system.site']['default_langcode'] = 'en';
+    }
+    return $overrides;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getCacheSuffix() {
+    return 'FarmLocalizationOverrider';
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getCacheableMetadata($name) {
+    return new CacheableMetadata();
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function createConfigObject($name, $collection = StorageInterface::DEFAULT_COLLECTION) {
+    return NULL;
+  }
+
+}

web/profiles/farm/modules/core/l10n/src/Form/L10nSettingsForm.php

@@ -0,0 +1,114 @@
+<?php
+
+namespace Drupal\farm_l10n\Form;
+
+use Drupal\Core\Config\ConfigFactoryInterface;
+use Drupal\Core\Entity\EntityTypeManagerInterface;
+use Drupal\Core\Form\FormStateInterface;
+use Drupal\language\Form\NegotiationSelectedForm;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+
+/**
+ * Configure the selected language negotiation method for this site.
+ *
+ * @phpstan-ignore-next-line
+ */
+class L10nSettingsForm extends NegotiationSelectedForm {
+
+  /**
+   * The entity type manager service.
+   *
+   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
+   */
+  protected $entityTypeManager;
+
+  /**
+   * Constructor for L10nSettingsForm.
+   *
+   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
+   *   The factory for configuration objects.
+   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
+   *   The entity type manager service.
+   */
+  public function __construct(ConfigFactoryInterface $config_factory, EntityTypeManagerInterface $entity_type_manager) {
+    parent::__construct($config_factory);
+    $this->entityTypeManager = $entity_type_manager;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public static function create(ContainerInterface $container) {
+    return new static(
+      $container->get('config.factory'),
+      $container->get('entity_type.manager'),
+    );
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getFormId() {
+    return 'farm_l10n_settings_form';
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function buildForm(array $form, FormStateInterface $form_state) {
+    $form = parent::buildForm($form, $form_state);
+
+    // Provide an option to update the default language of existing users.
+    $form['update_existing_users'] = [
+      '#type' => 'checkbox',
+      '#title' => $this->t('Update existing users'),
+      '#description' => $this->t('Update the language of all existing users to match the default language.'),
+      '#default_value' => FALSE,
+    ];
+
+    return $form;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function submitForm(array &$form, FormStateInterface $form_state) {
+    parent::submitForm($form, $form_state);
+
+    // Initiate a batch operation to update the default language of all users
+    // (except user 1).
+    if ($form_state->getValue('update_existing_users')) {
+      $operations = [];
+      $query = $this->entityTypeManager->getStorage('user')->getQuery()->accessCheck(FALSE);
+      $uids = $query->condition('uid', '1', '!=')->execute();
+      foreach ($uids as $uid) {
+        $operations[] = [
+          [__CLASS__, 'updateUserLanguage'],
+          [$uid, $form_state->getValue('selected_langcode')],
+        ];
+      }
+      batch_set([
+        'operations' => $operations,
+        'title' => $this->t('Updating user languages'),
+        'error_message' => $this->t('The user language update has encountered an error.'),
+      ]);
+    }
+  }
+
+  /**
+   * Update the language for a user.
+   *
+   * @param int $uid
+   *   The user ID.
+   * @param string $langcode
+   *   The new langcode to assign.
+   */
+  public static function updateUserLanguage(int $uid, string $langcode) {
+    /** @var \Drupal\user\UserInterface $user */
+    $user = \Drupal::entityTypeManager()->getStorage('user')->load($uid);
+    $user->set('preferred_langcode', $langcode);
+    $user->set('preferred_admin_langcode', $langcode);
+    $user->save();
+  }
+
+}

web/profiles/farm/modules/core/l10n/tests/src/Kernel/FarmLocalizationApiTest.php

@@ -0,0 +1,59 @@
+<?php
+
+namespace Drupal\Tests\farm_l10n\Kernel;
+
+use Drupal\Tests\farm_api\Kernel\FarmApiTest;
+use Drupal\language\Entity\ConfigurableLanguage;
+
+/**
+ * Tests farmOS API features.
+ *
+ * @group farm
+ */
+class FarmLocalizationApiTest extends FarmApiTest {
+
+  /**
+   * {@inheritdoc}
+   */
+  protected static $modules = [
+    'config_translation',
+    'farm_l10n',
+    'language',
+    'locale',
+  ];
+
+  /**
+   * {@inheritdoc}
+   */
+  public function setUp(): void {
+    parent::setUp();
+    $this->installConfig(['language']);
+    $this->installSchema('locale', ['locales_source', 'locales_target', 'locales_location']);
+
+    // Configure the enabled language detection methods.
+    // This would normally be done by farm_l10n_install(), which does not run
+    // in Kernel tests.
+    \Drupal::configFactory()->getEditable('language.types')->set('negotiation.language_interface.enabled', [
+      'language-user' => 0,
+      'language-selected' => 50,
+    ])->save();
+
+    // Create a language for testing (Spanish).
+    ConfigurableLanguage::createFromLangcode('es')->save();
+
+    // In order to reflect the changes for a multilingual site in the container
+    // we have to rebuild it.
+    \Drupal::service('kernel')->rebuildContainer();
+
+    // Make Spanish the "selected language" for the site.
+    \Drupal::configFactory()->getEditable('language.negotiation')->set('selected_langcode', 'es')->save();
+
+    // Set up a user with the farm_manager role and the non-default language.
+    $user = $this->setUpCurrentUser([
+      'preferred_langcode' => 'es',
+      'preferred_admin_langcode' => 'es',
+    ], [], FALSE);
+    $user->addRole('farm_manager');
+  }
+
+}