1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 

<?php

/**
 * MvcCore
 *
 * This source file is subject to the BSD 3 License
 * For the full copyright and license information, please view
 * the LICENSE.md file that are distributed with this source code.
 *
 * @copyright   Copyright (c) 2016 Tom Flidr (https://github.com/mvccore)
 * @license     https://mvccore.github.io/docs/mvccore/5.0.0/LICENCE.md
 */

namespace MvcCore\Ext\Routers\Localization;

trait Preparing {

    /**
     * Prepare localizations processing:
     * - Check if any default localization configured.
     * - Complete allowed localizations into array keyed by it's values to check 
     *   by `isset()`.
     * - Complete default localization string for comparison later.
     * - Put default localization into allowed localizations for sure.
     * - Complete localization equivalents with language codes only by router 
     *   configuration.
     * - Try to complete switching param from request object global `$_GET` 
     *   collection.
     * - Try to complete session language and locale.
     * - Store request path before next request localization detection request 
     *   path manipulation.
     * - Try to complete request language and locale from request query string 
     *   or path.
     * @throws \InvalidArgumentException No default localization configured
     * @return void
     */
    protected function prepareLocalization () {

        // check all necessary properties configured
        if (!$this->defaultLocalization) {
            throw new \InvalidArgumentException("[".get_class()."] No default localization configured.");
        }
        
        // store path info locally for routing process
        $this->originalRequestPath = $this->request->GetPath();

        // prepare possibly modified allowed localizations
        $this->allowedLocalizations = array_combine($this->allowedLocalizations, $this->allowedLocalizations);
        // add default localization into allowed lang(s) for sure
        $this->defaultLocalizationStr = implode(static::LANG_AND_LOCALE_SEPARATOR, $this->defaultLocalization);
        $this->allowedLocalizations[$this->defaultLocalizationStr] = $this->defaultLocalizationStr;

        // if there is only one localized language, do not process anything else
        if (count($this->allowedLocalizations) < 2) {
            $this->localization = $this->defaultLocalization;
            $this->requestLocalization = $this->defaultLocalization;
            return;
        }

        // add automatically into equivalents also all lang(s) parsed from localizations if necessary
        if ($this->detectLocalizationOnlyByLang) {
            foreach ($this->allowedLocalizations as $allowedLocalization => $allowedLocalizationValue) {
                $separatorPos = strpos($allowedLocalization, static::LANG_AND_LOCALE_SEPARATOR);
                if ($separatorPos !== FALSE) {
                    $lang = substr($allowedLocalization, 0, $separatorPos);
                    if (!isset($this->localizationEquivalents[$lang]))
                        $this->localizationEquivalents[$lang] = $allowedLocalization;
                }
            }
        }
        
        // check it with any strict session configuration to have more flexible navigations
        //if ($this->stricModeBySession) {
            $sessStrictModeSwitchUrlParam = static::URL_PARAM_SWITCH_LOCALIZATION;
            if (isset($this->requestGlobalGet[$sessStrictModeSwitchUrlParam])) {
                $globalGetValue = strtolower($this->requestGlobalGet[$sessStrictModeSwitchUrlParam]);
                $separatorPos = strpos($globalGetValue, static::LANG_AND_LOCALE_SEPARATOR);
                if ($separatorPos !== FALSE)
                    $globalGetValue = substr($globalGetValue, 0, $separatorPos + 1)
                        . strtoupper(substr($globalGetValue, $separatorPos + 1));
                if (isset($this->allowedLocalizations[$globalGetValue]))
                    $this->switchUriParamLocalization = $globalGetValue;
            }
        //}
        
        // look into session object if there are or not
        // any record about lang from previous request
        if (isset($this->session->{static::URL_PARAM_LOCALIZATION})) 
            $this->sessionLocalization = $this->session->{static::URL_PARAM_LOCALIZATION};

        // get current localization from requested url string
        $this->prepareRequestLocalizationFromUrl();
    }

    /**
     * Try to set up lang (or lang and locale) from request query string and if 
     * there i no localization query param, try to set up localization from
     * request path if any routes defined. If there is any lang detected (or 
     * lang and locale detected), set up these values into request object.
     * @return void
     */
    protected function prepareRequestLocalizationFromUrl () {
        $this->prepareRequestLocalizationFromUrlQueryString();
        if ($this->requestLocalization === NULL && $this->anyRoutesConfigured) 
            $this->prepareRequestLocalizationFromUrlPath();
        if ($this->requestLocalization === NULL) {
            $requestPath = $this->request->GetPath(TRUE);
            if (trim($requestPath, '/') === '' && $requestPath !== $this->request->GetScriptName()) {
                $this->requestLocalization = $this->defaultLocalization;
                $this->request->SetLang($this->requestLocalization[0]);
                if ($this->requestLocalization[1]) 
                    $this->request->SetLocale($this->requestLocalization[1]);
            }
        }
    }

    /**
     * Try to set up lang (or lang and locale) from request query string.
     * @return void
     */
    protected function prepareRequestLocalizationFromUrlQueryString () {
        $localizationUrlParam = static::URL_PARAM_LOCALIZATION;
        $langAndLocaleSeparator = static::LANG_AND_LOCALE_SEPARATOR;
        // try to set up request localization by query string first - query string is always stronger value
        $requestLocalization = $this->request->GetParam(
            $localizationUrlParam, 
            $langAndLocaleSeparator . 'a-zA-Z0-9'
        );
        $this->prepareSetUpRequestLocalizationIfValid($requestLocalization, FALSE);
    }

    
    
    /**
     * Try to set up lang (or lang and locale) from request path.
     * If there is any request path detected, remove localization from request 
     * path and store detected localization in local context.
     * @return void
     */
    protected function prepareRequestLocalizationFromUrlPath () {
        // if there is no localization in query string - try to detect localization from path
        $requestPath = $this->request->GetPath(TRUE);
        /**
            * $requestPath = '/'                    => $secondSlashPos = FALSE  => $firstPathElm = ''
            * $requestPath = '/en'                  => $secondSlashPos = FALSE  => $firstPathElm = 'en'
            * $requestPath = '/en/'                 => $secondSlashPos = 3      => $firstPathElm = 'en'
            * $requestPath = '/en/move...'          => $secondSlashPos = 3      => $firstPathElm = 'en'
            * $requestPath = '/any-thing'           => $secondSlashPos = FALSE  => $firstPathElm = 'any-thing'
            * $requestPath = '/any-thing/'          => $secondSlashPos = 10     => $firstPathElm = 'any-thing'
            * $requestPath = '/any-thing/more...'   => $secondSlashPos = 10     => $firstPathElm = 'any-thing'
            */
        $secondSlashPos = mb_strlen($requestPath) > 1 
            ? mb_strpos($requestPath, '/', 1) 
            : FALSE;
        if ($secondSlashPos === FALSE) {
            $firstPathElm = $requestPath !== '/' ? mb_substr($requestPath, 1) : '';
        } else {
            $firstPathElm = mb_substr($requestPath, 1, $secondSlashPos - 1);
        }
        $localizationPart = preg_replace(
            "#[^" . static::LANG_AND_LOCALE_SEPARATOR . "a-z0-9]#", 
            '', strtolower($firstPathElm)
        );
        $this->prepareSetUpRequestLocalizationIfValid($localizationPart, TRUE);
    }

    /**
     * Try to format given localization and check if localization is allowed. 
     * If localization is allowed, set up request localization and re-set up
     * request path by second function argument. Or if localization is in 
     * localization equivalent array, also correct request path if necessary
     * and set up target localization for later redirection.
     * @param string|NULL $rawRequestLocalization 
     * @param bool $correctRequestPath 
     * @return bool
     */
    protected function prepareSetUpRequestLocalizationIfValid ($rawRequestLocalization, $correctRequestPath = FALSE) {
        $result = FALSE;
        $langAndLocaleSeparator = static::LANG_AND_LOCALE_SEPARATOR;
        $requestLocalizationFormated = '';
        $rawRequestLocalizationLength = $rawRequestLocalization ? strlen($rawRequestLocalization) : 0;
        $requestLocalizationValidStr = $rawRequestLocalizationLength > 0;
        if ($requestLocalizationValidStr) {
            $requestLocalizationFormated = strtolower($rawRequestLocalization);
            $separatorPos = strpos($rawRequestLocalization, static::LANG_AND_LOCALE_SEPARATOR);
            if ($separatorPos !== FALSE) 
                $requestLocalizationFormated = substr($requestLocalizationFormated, 0, $separatorPos + 1)
                    . strtoupper(substr($requestLocalizationFormated, $separatorPos + 1));
        }
        if (isset($this->allowedLocalizations[$requestLocalizationFormated])) {
            $this->requestLocalization = explode($langAndLocaleSeparator, $requestLocalizationFormated);
            $this->requestLocalizationEquivalent = NULL;
            $this->request->SetLang($this->requestLocalization[0]);
            $result = TRUE;
            if (count($this->requestLocalization) > 1) 
                $this->request->SetLocale($this->requestLocalization[1]);
            if ($correctRequestPath) {
                $requestPath = $this->request->GetPath(TRUE);
                $newPath = mb_substr($requestPath, $rawRequestLocalizationLength + 1);
                if ($newPath === '') $newPath = '/';
                $this->request->SetPath($newPath);
            }
        } else if (isset($this->localizationEquivalents[$requestLocalizationFormated])) {
            $targetLocalizationStr = $this->localizationEquivalents[$requestLocalizationFormated];
            if (isset($this->allowedLocalizations[$targetLocalizationStr])) {
                $targetLocalization = explode($langAndLocaleSeparator, $targetLocalizationStr);
                if ($this->stricModeBySession && $this->sessionLocalization) {
                    $this->requestLocalizationEquivalent = $this->sessionLocalization;
                    $result = TRUE;
                } else {
                    $this->requestLocalizationEquivalent = $targetLocalization;
                    $result = TRUE;
                }
                if ($correctRequestPath) {
                    $requestPath = $this->request->GetPath(TRUE);
                    $newPath = mb_substr($requestPath, $rawRequestLocalizationLength + 1);
                    if ($newPath === '') $newPath = '/';
                    $this->request->SetPath($newPath);
                }
            }
        }
        return $result;
    }
}