Stop Symfony from overwriting the localefrom the query string when set_locale_from_accept_language is true

[nicofrand]

Hi!

Context

A bit of context to begin with: I am using Bolt with 3 languages, each page being translated in each of this language.
Some of the visitors do not speak the default language and won't take the time use the language switcher.

I want the pages do be displayed in the language the user chose in its browser configuration.
That's what symfony provides through https://symfony.com/doc/current/reference/configuration/framework.html#set-locale-from-accept-language.

However I'd still like to be able to change the locale, through the language switcher, which simply appends ?_locale=XX to the query string.

Issue

When framework.set_locale_from_accept_language: true is set (with `framework.enabled_locales: ['en', 'fr', 'it']) the preferred language overwrites (Symfony's subscriber is called after Bolt's subscriber) the language set in the query string: symfony only checks the attributes, not the query string.

Solution

When the _locale parameter from the query string is set, also set it in the attributes, which Symfony will check.

⚠️ Warning

I do not know what that might imply (besides fixing my issue). This pull request is kind of here for discussions if that is not the way things should be done (I might not know Symfony well enough).

See https://github.com/symfony/symfony/blob/5.4/src/Symfony/Component/HttpKernel/EventListener/LocaleListener.php#L71

[nicofrand]

In case that MR is not accepted for some reason (in its current form or another), the issue it fixes can also be fixed by creating a subscriber in the App namespace:

<?php

declare(strict_types=1);

namespace App\Event\Subscriber;

use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Symfony\Component\HttpKernel\Event\RequestEvent;
use Symfony\Component\HttpKernel\KernelEvents;

class FixLocaleSubscriber implements EventSubscriberInterface
{
    public function onKernelRequest(RequestEvent $event): void
    {
        $request = $event->getRequest();

        /**
         * Symfony's listener has a lower priority and will be called after Bolt's listener.
         * It will not check that the locale was set already and in case useAcceptLanguageHeader is
         * set, it will overwrite the locale just set by Bolt (since it does not care about the
         * query, only the attributes).
         *
         * This listener registers the locale as an attribute (if not already the case) to ensure
         * the _locale query parameter has a greater weight than the HTTP_ACCEPT_LANGUAGE header.
         * It does not set the locale: either Bolt did it or Symfony will.
         */
        if (!$request->attributes->has('_locale') && $request->query->has('_locale')) {
            $locale = $request->query->get('_locale');
            $request->attributes->set('_locale', $locale);
        }
    }

    public static function getSubscribedEvents(): array
    {
        return [
            // must be registered before (i.e. with a higher priority than) the default Bolt's Locale listener
            KernelEvents::REQUEST => [['onKernelRequest', 25]],
        ];
    }
}

[github-actions]

In an effort to keep our pull request list manageable, we are marking this PR as stale because it has been 60 days without activity. If this PR is still relevant, please let us know by posting a quick comment or update so that it can be assigned and hopefully merged.

[nicofrand]

Why wouldn't it be relevant anymore?

[bobvandevijver]

It is not recommended to have the locale in a query string, which is also why Symfony doesn't use it by default. So, in its current form it will not be merged, but you can still use your own subscriber for your specific use case.