Disable guessing for a given query pattern

EmmanuelVella · EmmanuelVella · commit 47f787f6d7b2 · 2014-07-15T14:28:49.000+02:00
diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
@@ -42,6 +42,9 @@ public function getConfigTreeBuilder()
                     ->requiresAtLeastOneElement()
                     ->prototype('scalar')->end()
                 ->end()
+                ->scalarNode('guessing_excluded_pattern')
+                    ->defaultNull()
+                ->end()
                 ->arrayNode('guessing_order')
                     ->isRequired()
                     ->requiresAtLeastOneElement()
diff --git a/EventListener/LocaleListener.php b/EventListener/LocaleListener.php
@@ -60,6 +60,11 @@ class LocaleListener implements EventSubscriberInterface
      */
     private $disableVaryHeader = false;
 
+    /**
+     * @var string
+     */
+    private $excludedPattern;
+
     /**
      * Construct the guessermanager
      *
@@ -89,6 +94,10 @@ public function onKernelRequest(GetResponseEvent $event)
     {
         $request = $event->getRequest();
 
+        if ($this->excludedPattern && preg_match(sprintf('#%s#', $this->excludedPattern), $request->getPathInfo())) {
+            return;
+        }
+
         $request->setDefaultLocale($this->defaultLocale);
 
         $manager = $this->guesserManager;
@@ -143,6 +152,13 @@ public function setDisableVaryHeader ($disableVaryHeader) {
         $this->disableVaryHeader = $disableVaryHeader;
     }
 
+    /**
+     * @param string $excludedPattern
+     */
+    public function setExcludedPattern($excludedPattern) {
+        $this->excludedPattern = $excludedPattern;
+    }
+
     /**
      * Log detection events
      *
diff --git a/Resources/config/services.xml b/Resources/config/services.xml
@@ -56,6 +56,9 @@
             <call method="setDisableVaryHeader">
                 <argument>%lunetics_locale.disable_vary_header%</argument>
             </call>
+            <call method="setExcludedPattern">
+                <argument>%lunetics_locale.guessing_excluded_pattern%</argument>
+            </call>
             <tag name="kernel.event_subscriber"/>
         </service>
 
diff --git a/Resources/doc/index.markdown b/Resources/doc/index.markdown
@@ -115,7 +115,14 @@ lunetics_locale:
     - browser
 ```
 
-### Locale Cookies / Session 
+Note that you can disable the guessing for a given query pattern :
+
+``` yaml
+lunetics_locale:
+  guessing_excluded_pattern: ^/api
+```
+
+### Locale Cookies / Session
 
 The session and cookie guesser is usually used when you do not use locales in the uri's and you guess it from the user browser preferences. When doing this,
 
diff --git a/Tests/EventListener/LocaleListenerTest.php b/Tests/EventListener/LocaleListenerTest.php
@@ -234,6 +234,36 @@ public function testOnLocaleDetectedDisabledVaryHeader () {
         $listener->onLocaleDetectedSetVaryHeader($filterResponseEvent);
     }
 
+    public function excludedPatternDataProvider()
+    {
+        return array(
+            array(null,    true),
+            array('.*',    false),
+            array('/api$', true),
+            array('^/api', false),
+        );
+    }
+
+    /**
+     * @dataProvider excludedPatternDataProvider
+     */
+    public function testRunLocaleGuessingIsNotFiredIfPatternMatches ($pattern, $called)
+    {
+        $request = new Request(array(), array(), array(), array(), array(), array('REQUEST_URI' => '/api/users'));
+
+        $guesserManager = $this->getMockGuesserManager();
+        $guesserManager
+            ->expects($this->exactly((int) $called))
+            ->method('runLocaleGuessing');
+
+        $listener = $this->getListener('en', $guesserManager);
+        $listener->setExcludedPattern($pattern);
+
+        $event = $this->getEvent($request);
+
+        $listener->onKernelRequest($event);
+    }
+
     public function testLogEvent()
     {
         $message = 'Setting [ 1 ] as locale for the (Sub-)Request';
