language_main.php

Go to the documentation of this file.

<?php

class Language_Main extends oxAdminDetails
{

    protected $_aLangData = null;

    protected $_aLangParams = null;

    protected $_aLanguagesUrls = null;

    protected $_aLanguagesSslUrls = null;

    private $oConfigValidator;

    public function render()
    {
        $myConfig = $this->getConfig();


        parent::render();

        $sOxId = $this->_aViewData["oxid"] = $this->getEditObjectId();
        //loading languages info from config
        $this->_aLangData = $this->_getLanguages();

        if ( $sOxId != -1 ) {
            //checking if translations files exists
            $this->_checkLangTranslations( $sOxId );
        }

        if ( $sOxId != "-1" && isset( $sOxId)) {
            $this->_aViewData["edit"] =  $this->_getLanguageInfo( $sOxId );
        }

        return "language_main.tpl";
    }

    public function save()
    {
        $myConfig  = $this->getConfig();


        parent::save();

        $sOxId = $this->getEditObjectId();
        $aParams = oxConfig::getParameter( "editval" );

        if ( !isset( $aParams['active'])) {
            $aParams['active'] = 0;
        }

        if ( !isset( $aParams['default'])) {
            $aParams['default'] = false;
        }

        if ( empty( $aParams['sort'])) {
            $aParams['sort'] = '99999';
        }

        //loading languages info from config
        $this->_aLangData = $this->_getLanguages();
        //checking input errors
        if ( !$this->_validateInput() ) {
            return;
        }

        $blViewError = false;

        // if changed language abbervation, updating it for all arrays related with languages
        if ( $sOxId != -1 && $sOxId != $aParams['abbr'] ) {
            // #0004850 preventing changing abbr for main language with base id = 0
            if ( (int) $this->_aLangData['params'][$sOxId]['baseId'] == 0 ) {
                $oEx = oxNew( "oxExceptionToDisplay" );
                $oEx->setMessage( 'LANGUAGE_ABBRCHANGEMAINLANG_WARNING' );
                oxUtilsView::getInstance()->addErrorToDisplay( $oEx );
                $aParams['abbr'] = $sOxId;
            } else {
                $this->_updateAbbervation( $sOxId, $aParams['abbr'] );
                $sOxId = $aParams['abbr'];
                $this->setEditObjectId( $sOxId );

                $blViewError = true;
            }
        }

        // if adding new language, setting lang id to abbervation
        if ( $blNewLanguage = ($sOxId == -1) ) {
            $sOxId = $aParams['abbr'];
            $this->_aLangData['params'][$sOxId]['baseId'] = $this->_getAvailableLangBaseId();
            $this->setEditObjectId( $sOxId );
        }

        //updating language description
        $this->_aLangData['lang'][$sOxId]  = $aParams['desc'];

        //updating language parameters
        $this->_aLangData['params'][$sOxId]['active']  = $aParams['active'];
        $this->_aLangData['params'][$sOxId]['default'] = $aParams['default'];
        $this->_aLangData['params'][$sOxId]['sort']   = $aParams['sort'];

        //if setting lang as default
        if ( $aParams['default'] == '1' ) {
            $this->_setDefaultLang( $sOxId );
        }

        //updating language urls
        $iBaseId = $this->_aLangData['params'][$sOxId]['baseId'];
        $this->_aLangData['urls'][$iBaseId] = $aParams['baseurl'];
        $this->_aLangData['sslUrls'][$iBaseId] = $aParams['basesslurl'];

        //sort parameters, urls and languages arrays by language base id
        $this->_sortLangArraysByBaseId();

        $this->_aViewData["updatelist"] = "1";

        if ($this->isValidLanguageData($this->_aLangData)) {
            //saving languages info
            $this->getConfig()->saveShopConfVar('aarr', 'aLanguageParams', $this->_aLangData['params']);
            $this->getConfig()->saveShopConfVar('aarr', 'aLanguages', $this->_aLangData['lang']);
            $this->getConfig()->saveShopConfVar('arr', 'aLanguageURLs', $this->_aLangData['urls']);
            $this->getConfig()->saveShopConfVar('arr', 'aLanguageSSLURLs', $this->_aLangData['sslUrls']);
            //checking if added language already has created multilang fields
            //with new base ID - if not, creating new fields
            if ($blNewLanguage) {
                if (!$this->_checkMultilangFieldsExistsInDb($sOxId)) {
                    $this->_addNewMultilangFieldsToDb();
                } else {
                    $blViewError = true;
                }
            }
            // show message for user to generate views
            if ($blViewError) {
                $oEx = oxNew('oxExceptionToDisplay');
                $oEx->setMessage('LANGUAGE_ERRORGENERATEVIEWS');
                oxRegistry::get("oxUtilsView")->addErrorToDisplay($oEx);
            }
        }
    }

    protected function _getLanguageInfo( $sOxId )
    {
        $sDefaultLang = $this->getConfig()->getConfigParam( 'sDefaultLang' );

        $aLangData               = $this->_aLangData['params'][$sOxId];
        $aLangData['abbr']       = $sOxId;
        $aLangData['desc']       = $this->_aLangData['lang'][$sOxId];
        $aLangData['baseurl']    = $this->_aLangData['urls'][$aLangData['baseId']];
        $aLangData['basesslurl'] = $this->_aLangData['sslUrls'][$aLangData['baseId']];
        $aLangData['default']    = ($this->_aLangData['params'][$sOxId]["baseId"] == $sDefaultLang) ? true : false;

        return $aLangData;
    }

    protected function _setLanguages( $aLangData )
    {
        $this->_aLangData = $aLangData;
    }

    protected function _getLanguages()
    {
        $aLangData['params']  = $this->getConfig()->getConfigParam( 'aLanguageParams' );
        $aLangData['lang']    = $this->getConfig()->getConfigParam( 'aLanguages' );
        $aLangData['urls']    = $this->getConfig()->getConfigParam( 'aLanguageURLs' );
        $aLangData['sslUrls'] = $this->getConfig()->getConfigParam( 'aLanguageSSLURLs' );

        // empty languages parameters array - creating new one with default values
        if ( !is_array( $aLangData['params']) ) {
            $aLangData['params'] = $this->_assignDefaultLangParams( $aLangData['lang'] );
        }

        return $aLangData;
    }

    protected function _updateAbbervation( $sOldId, $sNewId )
    {
        foreach ( array_keys($this->_aLangData) as $sTypeKey ) {

            if ( is_array($this->_aLangData[$sTypeKey]) && count($this->_aLangData[$sTypeKey]) > 0 ) {

                if ( $sTypeKey == 'urls' || $sTypeKey == 'sslUrls' ) {
                    continue;
                }

                $aKeys   = array_keys( $this->_aLangData[$sTypeKey] );
                $aValues = array_values( $this->_aLangData[$sTypeKey] );
                //find and replace key
                $iReplaceId = array_search( $sOldId, $aKeys );
                $aKeys[$iReplaceId] = $sNewId;

                $this->_aLangData[$sTypeKey] = array_combine( $aKeys, $aValues );
            }
        }
    }

    protected function _sortLangArraysByBaseId()
    {
        $aUrls      = array();
        $aSslUrls   = array();
        $aLanguages = array();

        uasort( $this->_aLangData['params'], array($this, '_sortLangParamsByBaseIdCallback') );

        foreach ( $this->_aLangData['params'] as  $sAbbr => $aParams ) {
            $iId = (int)$aParams['baseId'];
            $aUrls[$iId]        = $this->_aLangData['urls'][$iId];
            $aSslUrls[$iId]     = $this->_aLangData['sslUrls'][$iId];
            $aLanguages[$sAbbr] = $this->_aLangData['lang'][$sAbbr];
        }

        $this->_aLangData['lang']    = $aLanguages;
        $this->_aLangData['urls']    = $aUrls;
        $this->_aLangData['sslUrls'] = $aSslUrls;
    }

    protected function _assignDefaultLangParams( $aLanguages )
    {
        $aParams = array();
        $iBaseId = 0;

        foreach ( array_keys($aLanguages) as $sOxId ) {
            $aParams[$sOxId]['baseId']  = $iBaseId;
            $aParams[$sOxId]['active']  = 1;
            $aParams[$sOxId]['sort']   = $iBaseId + 1;

            $iBaseId++;
        }

        return $aParams;
    }

    protected function _setDefaultLang( $sOxId )
    {
        $sDefaultId = $this->_aLangData['params'][$sOxId]['baseId'];
        $this->getConfig()->saveShopConfVar( 'str', 'sDefaultLang', $sDefaultId );
    }

    protected function _getAvailableLangBaseId()
    {
        $aBaseId = array();
        foreach ( $this->_aLangData['params'] as $aLang ) {
            $aBaseId[] = $aLang['baseId'];
        }

        $iNewId = 0;
        sort( $aBaseId );
        $iTotal = count($aBaseId);

        //getting first available id
        while ( $iNewId <= $iTotal ) {
            if ( $iNewId !== $aBaseId[$iNewId] ) {
                break;
            }
            $iNewId++;
        }

        return $iNewId;
    }

    protected function _checkLangTranslations( $sOxId )
    {
        $myConfig = $this->getConfig();

        $sDir = dirname( $myConfig->getTranslationsDir( 'lang.php', $sOxId ) );

        if ( empty($sDir) ) {
            $oEx = oxNew( "oxExceptionToDisplay" );
            $oEx->setMessage( 'LANGUAGE_NOTRANSLATIONS_WARNING' );
            oxRegistry::get("oxUtilsView")->addErrorToDisplay( $oEx );
        }
    }

    protected function _checkMultilangFieldsExistsInDb( $sOxId )
    {
        $iBaseId = $this->_aLangData['params'][$sOxId]['baseId'];
        $sTable  = getLangTableName('oxarticles', $iBaseId );
        $sColumn = 'oxtitle' . oxRegistry::getLang()->getLanguageTag( $iBaseId );

        $oDbMetadata = oxNew('oxDbMetaDataHandler');
        return $oDbMetadata->tableExists( $sTable ) && $oDbMetadata->fieldExists( $sColumn, $sTable );
    }

    protected function _addNewMultilangFieldsToDb()
    {
        //creating new multilanguage fields with new id over whole DB
        oxDb::getDb()->startTransaction();

        $oDbMeta = oxNew( "oxDbMetaDataHandler" );

        try {
             $oDbMeta->addNewLangToDb();
        } catch( Exception $oEx ) {
             // if exception, rollBack everything
             oxDb::getDb()->rollbackTransaction();

             //show warning
             echo $oEx->getMessage();
             $oEx = oxNew( "oxExceptionToDisplay" );
             $oEx->setMessage( 'LANGUAGE_ERROR_ADDING_MULTILANG_FIELDS' );
             oxRegistry::get("oxUtilsView")->addErrorToDisplay( $oEx );

             return;
        }

        oxDb::getDb()->commitTransaction();
    }

    protected function _checkLangExists( $sAbbr )
    {
        $myConfig = $this->getConfig();
        $aAbbrs = array_keys($this->_aLangData['lang']);

        if ( in_array( $sAbbr, $aAbbrs ) ) {
            return true;
        }

        return false;
    }

    protected function _sortLangParamsByBaseIdCallback( $oLang1, $oLang2 )
    {
        return ($oLang1['baseId'] < $oLang2['baseId']) ? -1 : 1;
    }

    protected function _validateInput()
    {
        $blResult = true;

        $sOxId = $this->getEditObjectId();
        $aParams = oxConfig::getParameter( "editval" );

        // if creating new language, checking if language already exists with
        // entered language abbreviation
        if ( $sOxId == -1 ) {
            if ( $this->_checkLangExists( $aParams['abbr'] ) ) {
                $oEx = oxNew( 'oxExceptionToDisplay' );
                $oEx->setMessage( 'LANGUAGE_ALREADYEXISTS_ERROR' );
                oxRegistry::get("oxUtilsView")->addErrorToDisplay( $oEx );
                $blResult = false;
            }
        }

        // As the abbreviation is used in database view creation, check for allowed characters
        if (!$this->checkAbbreviationAllowedCharacters($aParams['abbr'])) {
            $oEx = oxNew('oxExceptionToDisplay');
            $oEx->setMessage('LANGUAGE_ABBREVIATION_INVALID_ERROR');
            oxRegistry::get("oxUtilsView")->addErrorToDisplay($oEx);
            $blResult = false;
        }

        // checking if language name is not empty
        if ( empty($aParams['desc']) ) {
            $oEx = oxNew( 'oxExceptionToDisplay' );
            $oEx->setMessage( 'LANGUAGE_EMPTYLANGUAGENAME_ERROR' );
            oxRegistry::get("oxUtilsView")->addErrorToDisplay( $oEx );
            $blResult = false;
        }

        return $blResult;
    }

    protected function checkAbbreviationAllowedCharacters($sAbbreviation)
    {
        $blReturn = false;
        if (preg_match('/^[a-zA-Z0-9_]*$/', $sAbbreviation)) {
            $blReturn = true;
        }
        return $blReturn;
    }

    protected function isValidLanguageData($aLanguageData)
    {
        $blValid = true;
        $configValidator = $this->getNoJsValidator();
        foreach ($aLanguageData as $mLanguageDataParameters) {
            if (is_array($mLanguageDataParameters)) {
                // Recursion till we gonna have a string.
                $blDeepResult = $this->isValidLanguageData($mLanguageDataParameters);
                $blValid = $blDeepResult === false ? $blDeepResult : $blValid;
            } elseif (!$configValidator->isValid($mLanguageDataParameters)) {
                $blValid = false;
                $error = oxNew('oxDisplayError');
                $error->setFormatParameters(htmlspecialchars($mLanguageDataParameters));
                $error->setMessage("SHOP_CONFIG_ERROR_INVALID_VALUE");
                oxRegistry::get("oxUtilsView")->addErrorToDisplay($error);
            }
        }

        return $blValid;
    }

    protected function getNoJsValidator()
    {
        if (is_null($this->oConfigValidator)) {
            $this->oConfigValidator = oxNew('oxNoJsValidator');
        }

        return $this->oConfigValidator;
    }
}