oxdbmetadatahandler.php

Go to the documentation of this file.

<?php

class oxDbMetaDataHandler extends oxSuperCfg
{
    protected $_aDbTablesFields = null;

    protected $_aTables = null;

    protected $_iCurrentMaxLangId;

    protected $_aSkipTablesOnReset = array( "oxcountry" );

    public function getFields( $sTableName )
    {

        if ( empty($this->_aDbTablesFields[$sTableName]) ) {
            $aFields = oxDb::getInstance()->getTableDescription( $sTableName );

            $this->_aDbTablesFields[$sTableName] = array();

            foreach ( $aFields as $oField ) {
                $this->_aDbTablesFields[$sTableName][] = $oField->name;
            }
        }

        return $this->_aDbTablesFields[$sTableName];
    }

    public function fieldExists( $sFieldName, $sTableName )
    {
        $aTableFields = $this->getFields( $sTableName );

        if ( is_array($aTableFields) ) {
            $sFieldName = strtoupper( $sFieldName );
            if ( in_array( $sFieldName, $aTableFields ) ) {
                return true;
            }
        }

        return false;
    }


    public function getAllTables()
    {
        if ( empty($this->_aTables) ) {

            $aTables = oxDb::getDb()->getAll("show tables");

            foreach ( $aTables as $aTableInfo) {
                $sTableName = $aTableInfo[0];

                $this->_aTables[] = $aTableInfo[0];
            }
        }

        return $this->_aTables;
    }

    protected function _getDublicatedFieldSql( $sOldFieldName, $sNewFieldName, $sTableName, $sInsertAfterField = null )
    {
        if ( empty($sOldFieldName) || empty($sNewFieldName) || empty($sTableName) ) {
            return;
        }

        $aRes = oxDb::getDb()->getAll("show create table {$sTableName}");
        $sSql = $aRes[0][1];

        preg_match( "/.*,\s+(['`]?".$sOldFieldName."['`]?\s+[^,]+),.*/", $sSql, $aMatch );
        $sFieldSql = $aMatch[1];

        $sFullSql = "";

        if ( !empty($sFieldSql) ) {

            $sFieldSql = preg_replace( "/" . $sOldFieldName . "/", $sNewFieldName, $sFieldSql );
            $sFullSql = "ALTER TABLE `$sTableName` ADD " . $sFieldSql;

            if ( $sInsertAfterField ) {
                $sFullSql .= " AFTER `$sInsertAfterField`";
            }
        }

        return $sFullSql;
    }

    protected function _getDublicatedFieldIndexesSql( $sOldFieldName, $sNewFieldName, $sTableName )
    {
        if ( empty($sOldFieldName) || empty($sNewFieldName) || empty($sTableName) ) {
            return;
        }

        $aRes = oxDb::getDb()->getAll("show create table {$sTableName}");
        $sSql = $aRes[0][1];

        preg_match_all("/([\w]+\s+)?\bKEY\s+(`[^`]+`)?\s*\([^)]+\)/iU", $sSql, $aMatch);

        $aIndexes = $aMatch[0];

        $aNewIndexSql = array();
        $sFullSql = "";

        if ( !empty($aIndexes) ) {

            foreach ( $aIndexes as $sIndexSql ) {
                if ( preg_match("/\([^)]*\b" . $sOldFieldName . "\b[^)]*\)/i", $sIndexSql )  ) {

                    //removing index name - new will be added automaticly
                    $sIndexSql = preg_replace("/(.*\bKEY\s+)`[^`]+`/", "$1", $sIndexSql );

                    //replacing old field name with new one
                    $sIndexSql = preg_replace("/\b" . $sOldFieldName . "\b/", $sNewFieldName, $sIndexSql );

                    $sFullSql = "ALTER TABLE `$sTableName` ADD ". $sIndexSql;
                    $aNewIndexSql[] = $sFullSql;
                }
            }

        }

        return $aNewIndexSql;
    }

    public function getCurrentMaxLangId()
    {
        if ( isset($this->_iCurrentMaxLangId) ) {
            return $this->_iCurrentMaxLangId;
        }

        $this->_iCurrentMaxLangId = 0;

        $aFields = $this->getFields( "oxarticles" );
        $aIds = array();

        //checking max "oxarticles" table field "oxtitle" lang suffics value (_1 ,_2 ...)
        foreach ( $aFields as $sFieldName ) {
            if ( preg_match("/^OXTITLE_(\d+)$/i", $sFieldName, $aMatches) ) {
                $aIds[] = (int) $aMatches[1];
            }
        }

        if ( count($aIds) > 0 ) {
            $this->_iCurrentMaxLangId = max($aIds );
        }

        return $this->_iCurrentMaxLangId;
    }

    public function getNextLangId()
    {
        return $this->getCurrentMaxLangId() + 1;
    }

    public function getMultilangFields( $sTableName )
    {
        $aFields = $this->getFields( $sTableName );
        $aMultiLangFields = array();

        foreach ( $aFields as $sFieldName ) {
            if ( preg_match("/(.+)_1$/", $sFieldName, $aMatches) ) {
                $aMultiLangFields[] = $aMatches[1];
            }
        }

        return $aMultiLangFields;
    }

    public function getSinglelangFields( $sTableName, $iLang )
    {
        $aFields = $this->getFields( $sTableName );
        $aSingleLangFields = array();

        foreach ( $aFields as $sFieldName ) {
            if ( preg_match("/(.+)_([0-9]+)$/", $sFieldName, $aMatches) ) {
                if ($aMatches[2] == $iLang) {
                    $aSingleLangFields[$aMatches[1]] = $sFieldName;
                }
            } else {
                $aSingleLangFields[$sFieldName] = $sFieldName;
            }
        }

        return $aSingleLangFields;
    }

    public function addNewMultilangField( $sTableName )
    {
        $aSql = array();
        $aIndexesSql = array();

        $aFields = $this->getMultilangFields( $sTableName );
        $iLangNewBaseId = $this->getNextLangId();
        $iCurrentMaxLangId = $this->getCurrentMaxLangId();

        if ( is_array($aFields) && count($aFields) > 0 ) {
            foreach ( $aFields as $sFieldName ) {
                $sNewFieldName = $sFieldName . "_" . $iLangNewBaseId;
                $sLastMultilangFieldName = ( !empty($iCurrentMaxLangId) ) ? $sFieldName . "_" .  $iCurrentMaxLangId : $sFieldName;

                if ( !$this->fieldExists( $sNewFieldName, $sTableName ) ) {
                    //getting creat field sql
                    $aSql[] = $this->_getDublicatedFieldSql( $sFieldName, $sNewFieldName, $sTableName, $sLastMultilangFieldName );

                    //getting create index sql on added field
                    $aFieldIndexSql = $this->_getDublicatedFieldIndexesSql( $sLastMultilangFieldName, $sNewFieldName, $sTableName );
                    if ( !empty($aFieldIndexSql) ) {
                        $aIndexesSql = array_merge( $aIndexesSql, $aFieldIndexSql );
                    }
                }
            }
        }

        if ( !empty($aSql) ) {
            $this->_executeSql( $aSql );
        }

        if ( !empty($aIndexesSql) ) {
            $this->_executeSql( $aIndexesSql );
        }
    }

    public function resetMultilangFields( $iLangId, $sTableName )
    {
        $iLangId = (int)$iLangId;

        if ( $iLangId === 0 ) {
            return;
        }

        $aSql = array();

        $aFields = $this->getMultilangFields( $sTableName );
        if ( is_array($aFields) && count($aFields) > 0 ) {
            foreach ( $aFields as $sFieldName ) {
                $sFieldName = $sFieldName . "_" . $iLangId;

                if ( $this->fieldExists( $sFieldName, $sTableName ) ) {
                    //reseting field value to default
                    $aSql[] = "UPDATE {$sTableName} SET {$sFieldName} = DEFAULT;";
                }
            }
        }

        if ( !empty($aSql) ) {
            $this->_executeSql( $aSql );
        }
    }

    public function addNewLangToDb()
    {
        $aTable = $this->getAllTables();

        foreach ( $aTable as $sTableName ) {
            $this->addNewMultilangField( $sTableName );
        }

    }

    public function resetLanguage( $iLangId )
    {
        if ( (int)$iLangId === 0 ) {
            return;
        }

        $aTables = $this->getAllTables();

        // removing tables which does not requires reset
        foreach ( $this->_aSkipTablesOnReset as $sSkipTable ) {

            if ( ($iSkipId = array_search( $sSkipTable, $aTables )) !== false ) {
                unset( $aTables[$iSkipId] );
            }
        }

        foreach ( $aTables as $sTableName ) {
            $this->resetMultilangFields( $iLangId, $sTableName );
        }
    }

    protected function _executeSql( $aSql )
    {
        $oDb = oxDb::getDb();

        if ( is_array($aSql) && !empty($aSql) ) {
            foreach ( $aSql as $sSql) {
                $oDb->execute( $sSql );
            }
        }
    }


}