timegridio/timegrid

<?php

namespace App\Http\Middleware;

use Closure;
use Jenssegers\Agent\Agent;

class Language
{
    /**
     * Agent information gather class.
     *
     * @var Jenssegers\Agent\Facades\Agent
     */
    private $agent;

    /**
     * Create the class.
     *
     * @param Agent $agent
     */
    public function __construct(Agent $agent)
    {
        $this->agent = $agent;
    }

    public function handle($request, Closure $next)
    {
        // logger()->debug(__METHOD__);

        $sessionAppLocale = session()->get('applocale', null);

        if ($sessionAppLocale == null) {
            $sessionAppLocale = $this->getAgentLangOrFallback(config('app.fallback_locale'));
        }

        // logger()->debug("sessionAppLocale:$sessionAppLocale");

        if (isAcceptedLocale($sessionAppLocale)) {
            setGlobalLocale($sessionAppLocale);
            // logger()->debug('setGlobalLocale set');
        }

        return $next($request);
    }

    /////////////
    // Helpers //
    /////////////

    /**
     * Get accepted Lang from Agent Or Fallback to default locale.
     *
     * @return string
     */
    protected function getAgentLangOrFallback($fallbackLocale)
    {
        $agentLanguages = $this->agent->languages();
        $configLanguages = config('languages');

        // logger()->debug('Agent Languages: '.serialize($agentLanguages));
        // logger()->debug('Config Languages: '.serialize($configLanguages));

        if ($agentPreferredLocale = $this->searchAgent($agentLanguages, $configLanguages)) {
            // logger()->debug("Agent Preferred Locale: $agentPreferredLocale");

            return $agentPreferredLocale;
        }

        // logger()->debug("Using Fallback: $fallbackLocale");

        return $fallbackLocale;
    }

    /**
     * Search all AgentLangs aming app available Langs.
     *
     * @param array $agentPreferredLocale
     * @param array $appAcceptedLocales
     *
     * @return string
     */
    protected function searchAgent($agentPreferredLocale, $appAcceptedLocales)
    {
        $availableLangs = $this->normalizeArrayKeys($appAcceptedLocales);
        $agentPreferredLocale = $this->normalizeArrayValues($agentPreferredLocale);

        foreach ($agentPreferredLocale as $agentLang) {
            if ($matchedLocale = $this->compareAgentLang($availableLangs, $agentLang)) {
                return $matchedLocale;
            }
        }
    }

    /**
     * Search for an AgentLang among app available Langs.
     *
     * EXAMPLE MATCH
     * "en_us" "en_us" : true
     * "en"    "en_us" : true
     * "es"    "es_es" : true
     * "en_us" "es_es" : false
     * "es_ar" "es_es" : false
     *
     * @param array  $availableLangs
     * @param string $agentLang
     *
     * @return string|false
     */
    protected function compareAgentLang(array $availableLangs, $agentLang)
    {
        foreach ($availableLangs as $availableKey => $availableLang) {
            if (stripos($availableLang, $agentLang) !== false) {
                return $availableKey;
            }
        }

        return false;
    }

    /**
     * Copy keys as lowercase values.
     *
     * EXAMPLE CONVERSION
     * array:2 [                   >> array:2 [
     *   "en_US" => "English" >>   "en_US" => "en_us"
     *   "es_ES" => "Español" >>   "es_ES" => "es_es"
     * ]                           >> ]
     *
     * @param array $array
     *
     * @return array
     */
    protected function normalizeArrayKeys(array $array)
    {
        array_walk($array, function (&$value, $key) {
            $value = strtolower($key);
        });

        return $array;
    }

    /**
     * Change values to lowercase and undescored instead of dashed.
     *
     * EXAMPLE CONVERSION
     * array:3 [      >> array:3 [
     *   0 => "es"    >>   0 => "es"
     *   1 => "en-us" >>   1 => "en_us"
     *   2 => "en"    >>   2 => "en"
     * ]              >> ]
     *
     * @param array $array
     *
     * @return array
     */
    protected function normalizeArrayValues(array $array)
    {
        array_walk($array, function (&$value) {
            $value = str_replace('-', '_', strtolower($value));
        });

        return $array;
    }
}