Added Session and Cookie Middlewares

Author: Marc Cámara

CHANGELOG.md

@@ -1,3 +1,7 @@
+### 1.0.7
+- Added Session and Cookie Middleware
+- Deleted useSessionLocale and useCookieLocale from config file
+
 ### 1.0
 - Laravel 5 supported
 - Added Middleware

README.md

@@ -13,6 +13,7 @@ Easy i18n localization for Laravel, an useful tool to combine with Laravel local
     - <a href="#laravel">Laravel</a>
 - <a href="#usage">Usage</a>
     - <a href="#middleware">Middleware</a>
+    - <a href="#sessions">Sessions</a>
 - <a href="#helpers">Helpers</a>
 - <a href="#translated-routes">Translated Routes</a>
 - <a href="#config">Config</a>
@@ -100,7 +101,7 @@ Once this route group is added to the routes file, a user can access all locales
 
 If the locale is not present in the url or it is not defined in `supportedLocales`, the system will use the application default locale or the user's browser default locale (if defined in config file).
 
-Once the locale is defined, the locale variable will be stored in a session, so it is not necessary to write the /lang/ section in the url after defining it once, using the last known locale for the user. If the user accesses to a different locale this session value would be changed, translating any other page he visits with the last chosen locale.
+Once the locale is defined, the locale variable will be stored in a session (if the middleware is enabled), so it is not necessary to write the /lang/ section in the url after defining it once, using the last known locale for the user. If the user accesses to a different locale this session value would be changed, translating any other page he visits with the last chosen locale.
 
 Template files and all locale files should follow the [Lang class](http://laravel.com/docs/5.0/localization).
 
@@ -165,6 +166,14 @@ If you want to hide the default locale but always show other locales in the url,
 
 **IMPORTANT** - When `hideDefaultLocaleInURL` is set to true, the unlocalized root is treated as the applications default locale `app.locale`.  Because of this language negotiation using the Accept-Language header will **NEVER** occur when `hideDefaultLocaleInURL` is true.
 
+### Sessions
+
+In version 1.0.7 a new middleware to control session storage has been added. I have created it because Laravel 5 changed the order for calls and you cannot access to the session from a function called from 'prefix'.
+
+To use it just add `Mcamara\LaravelLocalization\Middleware\LocaleSessionRedirect` to the Middleware list, it will automatically store and redirect users to the locale stored in the session.
+
+Just a reminder, old config values like `useSessionLocale` and `useCookieLocale` will be ignored.
+
 ## Helpers
 
 This package comes with some useful functions, like:
@@ -490,10 +499,6 @@ For example, editing the default config service provider that Laravel loads when
 
 				'laravellocalization.useAcceptLanguageHeader' => true,
 
-				'laravellocalization.useSessionLocale' => true,
-
-				'laravellocalization.useCookieLocale' => true,
-
 				'laravellocalization.hideDefaultLocaleInURL' => true
 			]);
 		}

composer.json

@@ -4,7 +4,7 @@
     "keywords": ["localization", "laravel", "php"],
     "homepage": "https://github.com/mcamara/laravel-localization",
     "license": "MIT",
-    "version": "1.0.6",
+    "version": "1.0.7",
     "authors": [
         {
             "name": "Marc Cámara",

src/Mcamara/LaravelLocalization/LaravelLocalization.php

@@ -96,13 +96,6 @@ class LaravelLocalization {
      */
     protected $routeName;
 
-    /**
-     * Name of the locale variable for the session and cookie storages
-     *
-     * @var string
-     */
-    protected $cookieSessionName = 'locale';
-
     /**
      * Creates new instance.
      * @throws UnsupportedLocaleException
@@ -111,10 +104,10 @@ public function __construct()
     {
         $this->app = app();
 
-        $this->configRepository = $this->app['config'];
-        $this->view = $this->app['view'];
-        $this->translator = $this->app['translator'];
-        $this->router = $this->app['router'];
+        $this->configRepository = $this->app[ 'config' ];
+        $this->view = $this->app[ 'view' ];
+        $this->translator = $this->app[ 'translator' ];
+        $this->router = $this->app[ 'router' ];
         $this->request = $this->app[ 'request' ];
 
         // set default locale
@@ -150,7 +143,7 @@ public function setLocale( $locale = null )
         {
             // if the first segment/locale passed is not valid
             // the system would ask which locale have to take
-            // it could be taken by session, browser or app default
+            // it could be taken by the browser
             // depending on your configuration
 
             $locale = null;
@@ -162,7 +155,7 @@ public function setLocale( $locale = null )
                 $this->currentLocale = $this->defaultLocale;
             }
             // but if hideDefaultLocaleInURL is false, we have
-            // to retrieve it from the session/cookie/browser...
+            // to retrieve it from the browser...
             else
             {
                 $this->currentLocale = $this->getCurrentLocale();
@@ -171,10 +164,6 @@ public function setLocale( $locale = null )
 
         $this->app->setLocale($this->currentLocale);
 
-        $this->storeSession($this->currentLocale);
-
-        $this->storeCookie($this->currentLocale);
-
         return $locale;
     }
 
@@ -340,7 +329,6 @@ public function getURLFromRouteNameTranslated( $locale, $transKeyName, $attribut
         {
             $route = '/' . $locale;
         }
-
         if ( is_string($locale) && $this->translator->has($transKeyName, $locale) )
         {
             $translation = $this->translator->trans($transKeyName, [ ], "", $locale);
@@ -479,19 +467,6 @@ public function getCurrentLocale()
             return $this->currentLocale;
         }
 
-        // get session language...
-        if ( $locale = $this->getSessionLocale() )
-        {
-            return $locale;
-        }
-
-        // or get cookie language...
-        if ( $locale = $this->getCookieLocale() )
-        {
-            return $locale;
-        }
-
-        // or get browser language...
         if ( $this->useAcceptLanguageHeader() )
         {
             $negotiator = new LanguageNegotiator($this->defaultLocale, $this->getSupportedLocales(), $this->request);
@@ -514,60 +489,6 @@ public function getSupportedLanguagesKeys()
     }
 
 
-    /**
-     * Returns the locale stored on the session (if available)
-     *
-     * @return string|false Locale stored in session - False if it doesn't exist
-     */
-    protected function getSessionLocale()
-    {
-        if ( $this->useSessionLocale() && app('session')->has($this->cookieSessionName) )
-        {
-            return session($this->cookieSessionName);
-        }
-
-        return false;
-    }
-
-    /**
-     * Store the locale on a session variable
-     * @param $locale string Locale to save on session variable
-     */
-    protected function storeSession( $locale )
-    {
-        if ( $this->useSessionLocale() )
-        {
-            session([ $this->cookieSessionName => $locale ]);
-        }
-    }
-
-    /**
-     * Returns the locale stored on the cookies (if available)
-     *
-     * @return string|false Locale stored in cookies - False if it doesn't exist
-     */
-    protected function getCookieLocale()
-    {
-        if ( $this->useCookieLocale() )
-        {
-            return cookie($this->cookieSessionName)->getValue();
-        }
-
-        return false;
-    }
-
-    /**
-     * Store the locale on a cookie variable
-     * @param $locale String Locale to store on Cookie variable
-     */
-    protected function storeCookie( $locale )
-    {
-        if ( $this->useCookieLocale() )
-        {
-            cookie($this->cookieSessionName, $locale);
-        }
-    }
-
     /**
      * Check if Locale exists on the supported locales array
      *
@@ -639,6 +560,7 @@ public function transRoute( $routeName )
         {
             $this->translatedRoutes[ ] = $routeName;
         }
+
         return $this->translator->trans($routeName);
     }
 
@@ -663,11 +585,12 @@ public function getRouteNameFromAPath( $path )
 
         foreach ( $this->translatedRoutes as $route )
         {
-            if ( $this->substituteAttributesInRoute( $attributes, $this->translator->trans($route)) === $path )
+            if ( $this->substituteAttributesInRoute($attributes, $this->translator->trans($route)) === $path )
             {
                 return $route;
             }
         }
+
         return false;
     }
 
@@ -751,25 +674,6 @@ public function getConfigRepository()
         return $this->configRepository;
     }
 
-    /**
-     * Returns the translation key for a given path
-     *
-     * @return boolean       Returns value of useSessionLocale in config.
-     */
-    protected function useSessionLocale()
-    {
-        return $this->configRepository->get('laravellocalization.useSessionLocale');
-    }
-
-    /**
-     * Returns the translation key for a given path
-     *
-     * @return boolean       Returns value of useCookieLocale in config.
-     */
-    protected function useCookieLocale()
-    {
-        return $this->configRepository->get('laravellocalization.useCookieLocale');
-    }
 
     /**
      * Returns the translation key for a given path
@@ -799,12 +703,14 @@ public function hideDefaultLocaleInURL()
      */
     public function createUrlFromUri( $uri )
     {
+        $uri = ltrim($uri, "/");
+
         if ( empty( $this->baseUrl ) )
         {
             return app('url')->to($uri);
         }
 
-        return $this->baseUrl . ltrim($uri, "/");
+        return $this->baseUrl . $uri;
     }
 
     /**
@@ -904,8 +810,7 @@ protected function extractAttributes( $url = false )
                 }
             }
 
-        }
-        else
+        } else
         {
             if ( !$this->router->current() )
             {
@@ -927,7 +832,6 @@ protected function extractAttributes( $url = false )
         }
 
 
-
         return $attributes;
     }
 

src/Mcamara/LaravelLocalization/Middleware/LocaleCookieRedirect.php

@@ -0,0 +1,40 @@
+<?php namespace Mcamara\LaravelLocalization\Middleware;
+
+use Illuminate\Contracts\Routing\Middleware;
+use Illuminate\Http\RedirectResponse;
+use Closure;
+
+
+class LocaleCookieRedirect implements Middleware {
+
+    /**
+     * Handle an incoming request.
+     *
+     * @param  \Illuminate\Http\Request $request
+     * @param  \Closure $next
+     * @return mixed
+     */
+    public function handle( $request, Closure $next )
+    {
+        $params = explode('/', $request->path());
+
+        if ( count($params) > 0 && $locale = app('laravellocalization')->checkLocaleInSupportedLocales($params[ 0 ]) )
+        {
+            cookie('locale', $params[ 0 ]);
+
+            return $next($request);
+        }
+
+        $locale = $request->cookie('locale', false);
+
+        if ( $locale && !( app('laravellocalization')->getDefaultLocale() === $locale && app('laravellocalization')->hideDefaultLocaleInURL() ) )
+        {
+            app('session')->reflash();
+            $redirection = app('laravellocalization')->getLocalizedURL($locale);
+
+            return new RedirectResponse($redirection, 302, [ 'Vary', 'Accept-Language' ]);
+        }
+
+        return $next($request);
+    }
+}

src/Mcamara/LaravelLocalization/Middleware/LocaleSessionRedirect.php

@@ -0,0 +1,39 @@
+<?php namespace Mcamara\LaravelLocalization\Middleware;
+
+use Illuminate\Contracts\Routing\Middleware;
+use Illuminate\Http\RedirectResponse;
+use Closure;
+
+class LocaleSessionRedirect implements Middleware {
+
+    /**
+     * Handle an incoming request.
+     *
+     * @param  \Illuminate\Http\Request $request
+     * @param  \Closure $next
+     * @return mixed
+     */
+    public function handle( $request, Closure $next )
+    {
+        $params = explode('/', $request->path());
+
+        if ( count($params) > 0 && $locale = app('laravellocalization')->checkLocaleInSupportedLocales($params[ 0 ]) )
+        {
+            session([ 'locale' => $params[ 0 ] ]);
+
+            return $next($request);
+        }
+
+        $locale = session('locale', false);
+
+        if ( $locale && !( app('laravellocalization')->getDefaultLocale() === $locale && app('laravellocalization')->hideDefaultLocaleInURL() ) )
+        {
+            app('session')->reflash();
+            $redirection = app('laravellocalization')->getLocalizedURL($locale);
+
+            return new RedirectResponse($redirection, 302, [ 'Vary', 'Accept-Language' ]);
+        }
+
+        return $next($request);
+    }
+}

src/config/config.php

@@ -301,21 +301,6 @@
 	// If false, system will take app.php locale attribute
 	'useAcceptLanguageHeader' => true,
 
-	// Should application use the locale stored in a session
-	// if the locale is not defined in the url?
-	// If false and locale not defined in the url, the system will
-	// take the default locale (defined in config/app.php) or
-	// the browser preferred language (if useAcceptLanguageHeader is true) or
-	// the cookie locale (if useCookieLocale is true)
-	'useSessionLocale' => true,
-
-	// Should application use and store the locale stored in a cookie
-	// if the locale is not defined in the url or the session?
-	// If true and locale not defined in the url or the session,
-	// system will take the default locale (defined in config/app.php)
-	// or the browser preferred locale (if useAcceptLanguageHeader is true)
-	'useCookieLocale' => true,
-
 	// If LaravelLocalizationRedirectFilter is active and hideDefaultLocaleInURL
 	// is true, the url would not have the default application language
     //