oxajax.php

Go to the documentation of this file.

<?php

// shop path for includes
if ( !function_exists( 'getShopBasePath' )) {
    function getShopBasePath()
    {
        return dirname(__FILE__).'/../';
    }
}

//to load the session correctly
if ( !function_exists( 'isAdmin' )) {
    function isAdmin()
    {
        return true;
    }
}

include_once getShopBasePath() . 'core/oxsupercfg.php';

class ajaxListComponent extends oxSuperCfg
{
    protected $_aPosDir = array( 'asc', 'desc' );

    protected $_aColumns = array();

    protected $_iSqlLimit = 2500;

    public function __construct( $aColumns )
    {
        $this->_aColumns = $aColumns;
    }

    protected function _getActionIds( $sId )
    {
        $aColumns = $this->_getColNames();
        foreach ( $aColumns as $iPos => $aCol ) {
            if ( isset($aCol[4]) && $aCol[4] == 1 && $sId == $aCol[1].'.'.$aCol[0] ) {
                return oxConfig::getParameter( '_'.$iPos );
            }
        }
    }

    public function setName( $sName )
    {
        $this->sContainer = $sName;
    }

    protected function _getQuery()
    {
        return '';
    }

    protected function _getDataQuery( $sQ )
    {
        return 'select ' . $this->_getQueryCols() . $sQ;
    }

    protected function _getCountQuery( $sQ )
    {
        return 'select count( * ) ' . $sQ;
    }

    public function processRequest( $sFunction = null )
    {
        if ( $sFunction ) {
            $this->$sFunction();
        } else {
            $sQAdd = $this->_getQuery();

            // formatting SQL queries
            $sQ      = $this->_getDataQuery( $sQAdd );
            $sCountQ = $this->_getCountQuery( $sQAdd );

            $this->_outputResponse( $this->_getData( $sCountQ, $sQ ) );
        }
    }

    protected function _getSortCol()
    {
        $aVisibleNames = $this->_getVisibleColNames();
        $iCol = oxConfig::getParameter( 'sort' );
        $iCol = $iCol?( ( int ) str_replace( '_', '', $iCol )):0;
        $iCol = ( !isset( $aVisibleNames[$iCol] ) )?0:$iCol;

        return $iCol;
    }


    protected function _getColNames( $sId = null )
    {
        if ( $sId === null ) {
            $sId = oxConfig::getParameter( 'cmpid' );
        }

        if ( $sId && isset( $this->_aColumns[$sId] ) ) {
            return $this->_aColumns[$sId];
        }

        return $this->_aColumns;
    }

    protected function _getIdentColNames()
    {
        $aColNames = $this->_getColNames();
        $aCols = array();
        foreach ( $aColNames as $iKey =>  $aCol ) {
            if ( $aCol[4] ) // ident ?
                $aCols[$iKey] = $aCol;
        }
        return $aCols;
    }

    protected function _getVisibleColNames()
    {
        $aColNames = $this->_getColNames();
        $aUserCols = oxConfig::getParameter( 'aCols' );
        $aVisibleCols = array();

        // user defined some cols to load ?
        if ( is_array( $aUserCols ) ) {
            foreach ( $aUserCols as $iKey => $sCol ) {
                $iCol = ( int ) str_replace( '_', '', $sCol );
                if ( isset( $aColNames[$iCol] ) && !$aColNames[$iCol][4] ) {
                    $aVisibleCols[$iCol] = $aColNames[$iCol];
                }
            }
        }

        // no user defined valid cols ? setting defauls ..
        if ( !count( $aVisibleCols ) ) {
            foreach ( $aColNames as $sName => $aCol ) {
                if ( $aCol[1] && !$aColNames[$sName][4]  ) // visible ?
                    $aVisibleCols[$sName] = $aCol;
            }
        }

        return $aVisibleCols;
    }

    protected function _getQueryCols()
    {
        $sLangTag = oxLang::getInstance()->getLanguageTag();
        $sQ = '';
        $blSep = false;
        $aVisiblecols = $this->_getVisibleColNames();
        foreach ( $aVisiblecols as $iCnt => $aCol ) {
            if ( $blSep )
                $sQ .= ', ';

            // multijanguage
            $sCol = $aCol[3]?$aCol[0].$sLangTag:$aCol[0];
            $sQ  .= getViewName( $aCol[1] ) . '.' . $sCol . ' as _' . $iCnt;
            $blSep = true;
        }

        $aIdentCols = $this->_getIdentColNames();
        foreach ( $aIdentCols as $iCnt => $aCol ) {
            if ( $blSep )
                $sQ .= ', ';

            // multijanguage
            $sCol = $aCol[3]?$aCol[0].$sLangTag:$aCol[0];
            $sQ  .= getViewName( $aCol[1] ) . '.' . $sCol . ' as _' . $iCnt;
        }

        return " $sQ ";
    }

    protected function _getSorting()
    {
        return ' order by _' . $this->_getSortCol() . ' '.$this->_getSortDir().' ';
    }

    protected function _getLimit( $iStart )
    {
        $iLimit = (int) oxConfig::getParameter("results");
        $iLimit = $iLimit?$iLimit:$this->_iSqlLimit;

        return " limit $iStart, $iLimit ";
    }

    protected function _getFilter()
    {
        $myConfig = $this->getConfig();
        $sQ = '';
        $aFilter = oxConfig::getParameter( 'aFilter' );
        if ( is_array( $aFilter ) && count( $aFilter ) ) {
            $aCols = $this->_getVisibleColNames();
            $blSep = false;
            $oDb = oxDb::getDb();
            $sLangTag = oxLang::getInstance()->getLanguageTag();
            $oStr = getStr();

            foreach ( $aFilter as $sCol => $sValue ) {

                // skipping empty filters
                if ( !$sValue ) {
                    continue;
                }

                $iCol = (int) str_replace( '_', '', $sCol );
                if ( isset( $aCols[ $iCol ] ) ) {
                    if ( $sQ )
                        $sQ .= ' and ';

                    if (!$myConfig->isUtf()) {
                        $sValue = iconv('UTF-8', oxLang::getInstance()->translateString("charset"), $sValue );
                    }

                    // escaping special characters
                    $sValue = str_replace( array( '%', '_' ), array( '\%', '\_' ), $sValue );

                    // possibility to search in the middle ..
                    $sValue = $oStr->preg_replace( '/^\*/', '%', $sValue );

                    $sCol = $aCols[ $iCol ][3]?$aCols[ $iCol ][0].$sLangTag:$aCols[ $iCol ][0];
                    $sQ .= getViewName( $aCols[ $iCol ][1] ) . '.' . $sCol;
                    $sQ .= ' like ' . $oDb->Quote( $sValue . '%' ). ' ';
                }

            }
        }
        return $sQ;
    }

    protected function _addFilter( $sQ )
    {
        if ( $sQ && $sFilter = $this->_getFilter() ) {
            $sQ .= ( ( stristr( $sQ, 'where' ) === false )?'where':' and ' ) . $sFilter;
        }
        return $sQ;
    }

    protected function _getAll( $sQ )
    {
        $aReturn = array();
        $rs = oxDb::getDb()->Execute( $sQ );
        if ($rs != false && $rs->recordCount() > 0) {
            while (!$rs->EOF) {
                $aReturn[] = $rs->fields[0];
                $rs->moveNext();
            }
        }
        return $aReturn;
    }

    protected function _getSortDir()
    {
        $sDir = oxConfig::getParameter( 'dir' );
        if ( !in_array( $sDir, $this->_aPosDir ) ) {
            $sDir = $this->_aPosDir[0];
        }

        return $sDir;
    }

    protected function _getStartIndex()
    {
        return (int) oxConfig::getParameter( 'startIndex' );
    }

    protected function _getTotalCount( $sQ )
    {
        // TODO: implement caching here

        // we can cache total count ...

        // $sCountCacheKey = md5( $sQ );

        return (int) oxDb::getDb()->getOne( $sQ );
    }

    protected function _getDataFields( $sQ )
    {
        return oxDb::getDb(true)->getArray( $sQ );
    }

    protected function _outputResponse( $aData )
    {
        if ( !$this->getConfig()->isUtf() ) {
            // TODO: improve this
            if ( is_array( $aData['records'] ) && $iRecSize = count( $aData['records'] ) ) {
                $aKeys = array_keys( current( $aData['records'] ) );
                $iKeySize = count( $aKeys );
                for ( $i = 0; $i < $iRecSize; $i++ ) {
                    for ( $c = 0; $c < $iKeySize; $c++ ) {
                        $aData['records'][$i][$aKeys[$c]] = iconv(oxLang::getInstance()->translateString("charset"), "UTF-8", $aData['records'][$i][$aKeys[$c]] );
                    }
                }
            }
        }

        echo json_encode( $aData );
    }

    protected function _getData( $sCountQ, $sQ )
    {
        $sQ = $this->_addFilter( $sQ );
        $sCountQ = $this->_addFilter( $sCountQ );

        $aResponse['startIndex'] = $iStart = $this->_getStartIndex();
        $aResponse['sort'] = '_' . $this->_getSortCol();
        $aResponse['dir']  = $this->_getSortDir();

        $iDebug = $this->getConfig()->getConfigParam( 'iDebug' );
        if ( $iDebug ) {
            $aResponse['countsql'] = $sCountQ;
        }

        $aResponse['records'] = array();

        // skip further execution if no records were found ...
        if ( ( $iTotal = $this->_getTotalCount( $sCountQ ) ) ) {
            $sQ .= $this->_getSorting();
            $sQ .= $this->_getLimit( $iStart );

            if ( $iDebug ) {
                $aResponse['datasql'] = $sQ;
            }

            $aResponse['records'] = $this->_getDataFields( $sQ );
        }

        $aResponse['totalRecords'] = $iTotal;

        return $aResponse;
    }

    public function resetContentCache()
    {
        $blDeleteCacheOnLogout = $this->getConfig()->getConfigParam( 'blClearCacheOnLogout' );


            if ( !$blDeleteCacheOnLogout ) {
                oxUtils::getInstance()->oxResetFileCache();
            }
    }

    public function resetCounter( $sCounterType, $sValue = null )
    {
        $blDeleteCacheOnLogout = $this->getConfig()->getConfigParam( 'blClearCacheOnLogout' );
        $myUtilsCount = oxUtilsCount::getInstance();

        if ( !$blDeleteCacheOnLogout ) {
            switch ( $sCounterType ) {
                case 'priceCatArticle':
                    $myUtilsCount->resetPriceCatArticleCount( $sValue );
                    break;
                case 'catArticle':
                    $myUtilsCount->resetCatArticleCount( $sValue );
                    break;
                case 'vendorArticle':
                    $myUtilsCount->resetVendorArticleCount( $sValue );
                    break;
                case 'manufacturerArticle':
                    $myUtilsCount->resetManufacturerArticleCount( $sValue );
                    break;
            }
        }
    }

}

// processing ..
$blAjaxCall = (isset($_SERVER['HTTP_X_REQUESTED_WITH']) && $_SERVER['HTTP_X_REQUESTED_WITH'] == 'XMLHttpRequest');
if ( $blAjaxCall ) {


    // Setting error reporting mode
    error_reporting( E_ALL ^ E_NOTICE);

    //setting basic configuration parameters
    ini_set('session.name', 'sid' );
    ini_set('session.use_cookies', 0 );
    ini_set('session.use_trans_sid', 0);
    ini_set('url_rewriter.tags', '');
    ini_set('magic_quotes_runtime', 0);

    // Generic utility method file.
    $sBasePath = getShopBasePath();
    include_once $sBasePath . 'modules/functions.php';
    include_once $sBasePath . 'core/oxfunctions.php';
    include_once $sBasePath . 'core/adodblite/adodb.inc.php';
    include_once $sBasePath . 'core/oxconfig.php';
    include_once $sBasePath . 'core/oxsupercfg.php';


    include_once $sBasePath . "core/oxutils.php";

    $myConfig = oxConfig::getInstance();

    // Includes Utility module.
    $sUtilModule = $myConfig->getConfigParam( 'sUtilModule' );
    if ( $sUtilModule && file_exists( getShopBasePath()."modules/".$sUtilModule ) )
        include_once getShopBasePath()."modules/".$sUtilModule;

    $myConfig->setConfigParam( 'blAdmin', true );
    $myConfig->setConfigParam( 'blTemplateCaching', false );

    // authorization
    if ( !count(oxUtilsServer::getInstance()->getOxCookie()) || !oxUtils::getInstance()->checkAccessRights()) {
        header( "location:index.php");
        exit();
    }

    if ( $sContainer = oxConfig::getParameter( 'container' ) ) {

        $sContainer = strtolower( basename( $sContainer ) );
        $aColumns = array();
        include_once 'inc/'.$sContainer.'.inc.php';

        $oAjaxComponent = new ajaxcomponent( $aColumns );
        $oAjaxComponent->setName( $sContainer );
        $oAjaxComponent->processRequest( oxConfig::getParameter( 'fnc' ) );

    } else {

    }

    $myConfig->pageClose();

    // closing session handlers
    // session_write_close();
    return;
}

---