dynexportbase.php

Go to the documentation of this file.

<?php

DEFINE("ERR_SUCCESS", -2);
DEFINE("ERR_GENERAL", -1);
DEFINE("ERR_FILEIO", 1);

class DynExportBase extends oxAdminDetails
{
    public $sClassDo            = "";

    public $sClassMain          = "";

    public $sExportPath          = "export/";

    public $sExportFileType      = "txt";

    public $sExportFileName      = "dynexport";

    public $fpFile               = null;

    public $iExportPerTick       = 30;

    protected $_iExportPerTick   = null;

    protected $_sFilePath        = null;

    protected $_aExportResultset = array();

    protected $_sThisTemplate = "dynexportbase.tpl";

    protected $_aCatLvlCache = null;

    public function __construct()
    {
        parent::__construct();

        // set generic frame template
        $this->_sFilePath = $this->getConfig()->getConfigParam( 'sShopDir' ) . "/". $this->sExportPath . $this->sExportFileName . "." . $this->sExportFileType;
    }

    public function render()
    {
        parent::render();

        // assign all member variables to template
        $aClassVars = get_object_vars( $this );
        while ( list( $name, $value ) = each( $aClassVars ) ) {
            $this->_aViewData[$name] = $value;
        }

        $this->_aViewData['sOutputFile']     = $this->_sFilePath;
        $this->_aViewData['sDownloadFile']   = $this->getConfig()->getConfigParam( 'sShopURL' ) . $this->sExportPath . $this->sExportFileName . "." . $this->sExportFileType;

        return $this->_sThisTemplate;
    }

    public function createMainExportView()
    {
        // parent categorie tree
        $this->_aViewData["cattree"] = oxNew( "oxCategoryList" );
        $this->_aViewData["cattree"]->buildList( $this->getConfig()->getConfigParam( 'bl_perfLoadCatTree' ) );

        $oLangObj = oxNew( 'oxLang' );
        $aLangs = $oLangObj->getLanguageArray();
        foreach ( $aLangs as $id => $language) {
            $language->selected = ($id == $this->_iEditLang);
            $this->_aViewData["aLangs"][$id] = clone $language;
        }
    }

    public function start()
    {
        // delete file, if its already there
        $this->fpFile = @fopen( $this->_sFilePath, "w" );
        if ( !isset( $this->fpFile ) || !$this->fpFile ) {
            // we do have an error !
            $this->stop( ERR_FILEIO );
        } else {
            $this->_aViewData['refresh'] = 0;
            $this->_aViewData['iStart']  = 0;
            fclose( $this->fpFile );

            // prepare it
            $iEnd = $this->prepareExport();
            oxSession::setVar( "iEnd", $iEnd );
            $this->_aViewData['iEnd'] = $iEnd;
        }
    }

    public function stop( $iError = 0 )
    {
        if ( $iError ) {
            $this->_aViewData['iError'] = $iError;
        }

        // delete temporary heap table
        oxDb::getDb()->execute( "drop TABLE if exists ". $this->_getHeapTableName() );
    }

    public function nextTick( $iCnt)
    {
        return false;
    }

    public function write( $sLine )
    {
        $sLine = $this->removeSID( $sLine );
        $sLine = str_replace( array("\r\n","\n"), "", $sLine);
        fwrite( $this->fpFile, $sLine."\r\n");
    }

    public function run()
    {
        $blContinue = true;
        $iExportedItems = 0;

        $this->fpFile = @fopen( $this->_sFilePath, "a");
        if ( !isset( $this->fpFile) || !$this->fpFile) {
            // we do have an error !
            $this->stop( ERR_FILEIO);
        } else {
            // file is open
            $iStart = oxConfig::getParameter("iStart");
            // load from session
            $this->_aExportResultset = oxConfig::getParameter( "aExportResultset");
            $iExportPerTick = $this->getExportPerTick();
            for ( $i = $iStart; $i < $iStart + $iExportPerTick; $i++) {
                if ( ( $iExportedItems = $this->nextTick( $i ) ) === false ) {
                    // end reached
                    $this->stop( ERR_SUCCESS);
                    $blContinue = false;
                    break;
                }
            }
            if ( $blContinue) {
                // make ticker continue
                $this->_aViewData['refresh'] = 0;
                $this->_aViewData['iStart']  = $i;
                $this->_aViewData['iExpItems'] = $iExportedItems;
            }
            fclose( $this->fpFile);
        }
    }

    public function getExportPerTick()
    {
        if ( $this->_iExportPerTick === null ) {
            $this->_iExportPerTick = (int) oxRegistry::getConfig()->getConfigParam("iExportNrofLines");
            if ( !$this->_iExportPerTick ) {
                $this->_iExportPerTick = $this->iExportPerTick;
            }
        }
        return $this->_iExportPerTick;
    }

    public function setExportPerTick( $iCount )
    {
        $this->_iExportPerTick = $iCount;
    }

    public function removeSid( $sInput )
    {
        $sSid = $this->getSession()->getId();

        // remove sid from link
        $sOutput = str_replace( "sid={$sSid}/", "", $sInput);
        $sOutput = str_replace( "sid/{$sSid}/", "", $sOutput);
        $sOutput = str_replace( "sid={$sSid}&amp;", "", $sOutput);
        $sOutput = str_replace( "sid={$sSid}&", "", $sOutput);
        $sOutput = str_replace( "sid={$sSid}", "", $sOutput);

        return $sOutput;
    }

    public function shrink( $sInput, $iMaxSize, $blRemoveNewline = true )
    {
        if ( $blRemoveNewline ) {
            $sInput = str_replace( "\r\n", " ", $sInput );
            $sInput = str_replace( "\n", " ", $sInput );
        }

        $sInput = str_replace( "\t", "    ", $sInput );

        // remove html entities, remove html tags
        $sInput = $this->_unHTMLEntities( strip_tags( $sInput ) );

        $oStr = getStr();
        if ( $oStr->strlen( $sInput ) > $iMaxSize - 3 ) {
            $sInput = $oStr->substr( $sInput, 0, $iMaxSize - 5 ) . "...";
        }

        return $sInput;
    }

    public function getCategoryString( $oArticle, $sSeparator = "/" )
    {
        $sCatStr = '';

        $sLang = oxRegistry::getLang()->getBaseLanguage();
        $oDB = oxDb::getDb();

        $sCatView = getViewName( 'oxcategories', $sLang );
        $sO2CView = getViewName( 'oxobject2category', $sLang );

        //selecting category
        $sQ  = "select $sCatView.oxleft, $sCatView.oxright, $sCatView.oxrootid from $sO2CView as oxobject2category left join $sCatView on $sCatView.oxid = oxobject2category.oxcatnid ";
        $sQ .= "where oxobject2category.oxobjectid=".$oDB->quote( $oArticle->getId() )." and $sCatView.oxactive = 1 order by oxobject2category.oxtime ";

        $oRs = $oDB->execute( $sQ );
        if ( $oRs != false && $oRs->recordCount() > 0 ) {
            $sLeft   = $oRs->fields[0];
            $sRight  = $oRs->fields[1];
            $sRootId = $oRs->fields[2];

            //selecting all parent category titles
            $sQ = "select oxtitle from $sCatView where oxright >= {$sRight} and oxleft <= {$sLeft} and oxrootid = '{$sRootId}' order by oxleft ";

            $oRs = $oDB->execute( $sQ );
            if ( $oRs != false && $oRs->recordCount() > 0 ) {
                while ( !$oRs->EOF ) {
                    if ( $sCatStr ) {
                        $sCatStr .= $sSeparator;
                    }
                    $sCatStr .= $oRs->fields[0];
                    $oRs->moveNext();
                }
            }
        }

        return $sCatStr;
    }

    public function getDefaultCategoryString( $oArticle )
    {
        $sLang = oxRegistry::getLang()->getBaseLanguage();
        $oDB = oxDb::getDb();

        $sCatView = getViewName( 'oxcategories', $sLang );
        $sO2CView = getViewName( 'oxobject2category', $sLang );

        //selecting category
        $sQ =  "select $sCatView.oxtitle from $sO2CView as oxobject2category left join $sCatView on $sCatView.oxid = oxobject2category.oxcatnid ";
        $sQ .= "where oxobject2category.oxobjectid=".$oDB->quote( $oArticle->getId() )." and $sCatView.oxactive = 1 order by oxobject2category.oxtime ";

        return $oDB->getOne( $sQ);
    }

    public function prepareCSV( $sInput )
    {
        $sInput = oxRegistry::get("oxUtilsString")->prepareCSVField( $sInput );
        return str_replace( array( "&nbsp;", "&euro;", "|" ), array( " ", "", "" ), $sInput );
    }

    public function prepareXML( $sInput )
    {
        $sOutput = str_replace( "&", "&amp;", $sInput );
        $sOutput = str_replace( "\"", "&quot;", $sOutput );
        $sOutput = str_replace( ">", "&gt;", $sOutput );
        $sOutput = str_replace( "<", "&lt;", $sOutput );
        $sOutput = str_replace( "'", "&apos;", $sOutput );

        return $sOutput;
    }

    public function getDeepestCategoryPath( $oArticle )
    {
        return $this->_findDeepestCatPath( $oArticle );
    }

    public function prepareExport()
    {
        $oDB = oxDb::getDb();
        $sHeapTable = $this->_getHeapTableName();

        // #1070 Saulius 2005.11.28
        // check mySQL version
        $oRs = $oDB->execute( "SHOW VARIABLES LIKE 'version'" );
        $sTableCharset = $this->_generateTableCharSet( $oRs->fields[1] );

        // create heap table
        if ( !( $this->_createHeapTable( $sHeapTable, $sTableCharset ) ) ) {
            // error
            oxRegistry::getUtils()->showMessageAndExit( "Could not create HEAP Table {$sHeapTable}\n<br>" );
        }

        $sCatAdd = $this->_getCatAdd( oxConfig::getParameter( "acat" ) );
        if ( !$this->_insertArticles( $sHeapTable, $sCatAdd ) ) {
            oxRegistry::getUtils()->showMessageAndExit( "Could not insert Articles in Table {$sHeapTable}\n<br>" );
        }

        $this->_removeParentArticles( $sHeapTable );
        $this->_setSessionParams();

        // get total cnt
        return $oDB->getOne( "select count(*) from {$sHeapTable}" );
    }

    public function getOneArticle( $iCnt, & $blContinue )
    {
        $myConfig  = $this->getConfig();

        //[Alfonsas 2006-05-31] setting specific parameter
        //to be checked in oxarticle.php init() method
        $myConfig->setConfigParam( 'blExport', true );
        $blContinue = false;

        if ( ( $oArticle = $this->_initArticle( $this->_getHeapTableName(), $iCnt, $blContinue ) ) ) {
            $blContinue = true;
            $oArticle = $this->_setCampaignDetailLink( $oArticle );
        }

        //[Alfonsas 2006-05-31] unsetting specific parameter
        //to be checked in oxarticle.php init() method
        $myConfig->setConfigParam( 'blExport', false );

        return $oArticle;
    }

    public function assureContent( $sInput, $sReplace = null)
    {
        $oStr = getStr();
        if ( !$oStr->strlen( $sInput ) ) {
            if ( !isset( $sReplace ) || !$oStr->strlen( $sReplace ) ) {
                $sReplace = "-";
            }
            $sInput = $sReplace;
        }
        return $sInput;
    }

    protected function _unHtmlEntities( $sInput )
    {
        $aTransTbl = array_flip( get_html_translation_table( HTML_ENTITIES ) );
        return strtr( $sInput, $aTransTbl );
    }

    protected function _getHeapTableName()
    {
        // table name must not start with any digit
        return "tmp_".str_replace( "0", "", md5( $this->getSession()->getId() ) );
    }

    protected function _generateTableCharSet( $sMysqlVersion )
    {
        $sTableCharset = "";

        //if MySQL >= 4.1.0 set charsets and collations
        if ( version_compare( $sMysqlVersion, '4.1.0', '>=' ) > 0 ) {
            $oDB = oxDb::getDb( oxDB::FETCH_MODE_ASSOC );
            $oRs = $oDB->execute( "SHOW FULL COLUMNS FROM `oxarticles` WHERE field like 'OXID'" );
            if ( isset( $oRs->fields['Collation'] ) && ( $sMysqlCollation = $oRs->fields['Collation'] ) ) {
                $oRs = $oDB->execute( "SHOW COLLATION LIKE '{$sMysqlCollation}'" );
                if ( isset( $oRs->fields['Charset'] ) && ( $sMysqlCharacterSet = $oRs->fields['Charset'] ) ) {
                    $sTableCharset = "DEFAULT CHARACTER SET {$sMysqlCharacterSet} COLLATE {$sMysqlCollation}";
                }
            }

        }
        return $sTableCharset;
    }

    protected function _createHeapTable( $sHeapTable, $sTableCharset )
    {
        $blDone = false;

        $oDB = oxDb::getDb();
        $sQ = "CREATE TABLE IF NOT EXISTS {$sHeapTable} ( `oxid` CHAR(32) NOT NULL default '' ) ENGINE=InnoDB {$sTableCharset}";
        if ( ( $oDB->execute( $sQ ) ) !== false ) {
            $blDone = true;
            $oDB->execute( "TRUNCATE TABLE {$sHeapTable}" );
        }

        return $blDone;
    }

    protected function _getCatAdd( $aChosenCat )
    {
        $sCatAdd = null;
        if ( is_array( $aChosenCat ) && count( $aChosenCat ) ) {
            $oDB = oxDb::getDb();
            $sCatAdd = " and ( ";
            $blSep = false;
            foreach ( $aChosenCat as $sCat ) {
                if ( $blSep ) {
                    $sCatAdd .= " or ";
                }
                $sCatAdd .= "oxobject2category.oxcatnid = ".$oDB->quote( $sCat );
                $blSep = true;
            }
            $sCatAdd .= ")";
        }
        return $sCatAdd;
    }

    protected function _insertArticles( $sHeapTable, $sCatAdd )
    {
        $oDB = oxDb::getDb();

        $iExpLang = oxConfig::getParameter( "iExportLanguage" );
        if (!isset($iExpLang)) {
            $iExpLang = oxSession::getVar( "iExportLanguage" );
        }

        $oArticle = oxNew( 'oxarticle' );
        $oArticle->setLanguage( $iExpLang );

        $sO2CView = getViewName( 'oxobject2category', $iExpLang );
        $sArticleTable = getViewName( "oxarticles", $iExpLang );

        $sSelect  = "insert into {$sHeapTable} select {$sArticleTable}.oxid from {$sArticleTable}, {$sO2CView} as oxobject2category where ";
        $sSelect .= $oArticle->getSqlActiveSnippet();

        if ( ! oxConfig::getParameter( "blExportVars" ) ) {
            $sSelect .= " and {$sArticleTable}.oxid = oxobject2category.oxobjectid and {$sArticleTable}.oxparentid = '' ";
        } else {
            $sSelect .= " and ( {$sArticleTable}.oxid = oxobject2category.oxobjectid or {$sArticleTable}.oxparentid = oxobject2category.oxobjectid ) ";
        }

        $sSearchString = oxConfig::getParameter( "search" );
        if ( isset( $sSearchString ) ) {
            $sSelect .= "and ( {$sArticleTable}.OXTITLE like ".$oDB->quote( "%{$sSearchString}%" );
            $sSelect .= " or {$sArticleTable}.OXSHORTDESC like ".$oDB->quote( "%$sSearchString%" );
            $sSelect .= " or {$sArticleTable}.oxsearchkeys like ".$oDB->quote( "%$sSearchString%" ) ." ) ";
        }

        if ( $sCatAdd ) {
            $sSelect .= $sCatAdd;
        }

            if ( !$sCatAdd ) {
                $sShopID = $this->getConfig()->getShopId();
                $sSelect .= " and {$sArticleTable}.oxshopid = '$sShopID' ";
            }

        // add minimum stock value
        if ( $this->getConfig()->getConfigParam( 'blUseStock' ) && ( $dMinStock = oxConfig::getParameter( "sExportMinStock" ) ) ) {
            $dMinStock = str_replace( array( ";", " ", "/", "'"), "", $dMinStock );
            $sSelect .= " and {$sArticleTable}.oxstock >= ".$oDB->quote( $dMinStock );
        }

        $sSelect .= " group by {$sArticleTable}.oxid";

        return $oDB->execute( $sSelect ) ? true : false;
    }

    protected function _removeParentArticles( $sHeapTable )
    {
        if ( !( oxConfig::getParameter( "blExportMainVars" ) ) ) {

            $oDB = oxDb::getDb();
            $sArticleTable = getViewName('oxarticles');

            // we need to remove again parent articles so that we only have the variants itself
            $sQ = "select $sHeapTable.oxid from $sHeapTable, $sArticleTable where
                          $sHeapTable.oxid = $sArticleTable.oxparentid group by $sHeapTable.oxid";

            $oRs = $oDB->execute( $sQ );
            $sDel = "delete from $sHeapTable where oxid in ( ";
            $blSep = false;
            if ($oRs != false && $oRs->recordCount() > 0) {
                while ( !$oRs->EOF ) {
                    if ( $blSep ) {
                        $sDel .= ",";
                    }
                    $sDel .= $oDB->quote( $oRs->fields[0] );
                    $blSep = true;
                    $oRs->moveNext();
                }
            }
            $sDel .= " )";
            $oDB->execute( $sDel );
        }
    }

    protected function _setSessionParams()
    {
        // reset it from session
        oxSession::deleteVar( "sExportDelCost" );
        $dDelCost = oxConfig::getParameter( "sExportDelCost");
        if ( isset( $dDelCost ) ) {
            $dDelCost = str_replace( array( ";", " ", "/", "'"), "", $dDelCost );
            $dDelCost = str_replace( ",", ".", $dDelCost );
            oxSession::setVar( "sExportDelCost", $dDelCost );
        }

        oxSession::deleteVar( "sExportMinPrice" );
        $dMinPrice = oxConfig::getParameter( "sExportMinPrice" );
        if ( isset( $dMinPrice ) ) {
            $dMinPrice = str_replace( array( ";", " ", "/", "'"), "", $dMinPrice);
            $dMinPrice = str_replace( ",", ".", $dMinPrice);
            oxSession::setVar( "sExportMinPrice", $dMinPrice);
        }

        // #827
        oxSession::deleteVar( "sExportCampaign" );
        $sCampaign = oxConfig::getParameter( "sExportCampaign" );
        if ( isset( $sCampaign ) ) {
            $sCampaign = str_replace( array( ";", " ", "/", "'"), "", $sCampaign );
            oxSession::setVar( "sExportCampaign", $sCampaign );
        }

        // reset it from session
        oxSession::deleteVar("blAppendCatToCampaign" );
        // now retrieve it from get or post.
        $blAppendCatToCampaign = oxConfig::getParameter( "blAppendCatToCampaign" );
        if ( $blAppendCatToCampaign ) {
            oxSession::setVar( "blAppendCatToCampaign", $blAppendCatToCampaign );
        }

        // reset it from session
        oxSession::deleteVar("iExportLanguage" );
        oxSession::setVar( "iExportLanguage", oxConfig::getParameter( "iExportLanguage" ) );

        //setting the custom header
        oxSession::setVar("sExportCustomHeader", oxConfig::getParameter( "sExportCustomHeader" ));
    }

    protected function _loadRootCats()
    {
        if ( $this->_aCatLvlCache === null ) {
            $this->_aCatLvlCache = array();

            $sCatView = getViewName('oxcategories');
            $oDb = oxDb::getDb();

            // Load all root cat's == all trees
            $sSQL = "select oxid from $sCatView where oxparentid = 'oxrootid'";
            $oRs = $oDb->execute( $sSQL);
            if ( $oRs != false && $oRs->recordCount() > 0 ) {
                while ( !$oRs->EOF ) {
                    // now load each tree
                    $sSQL = "SELECT s.oxid, s.oxtitle,
                             s.oxparentid, count( * ) AS LEVEL FROM $sCatView v,
                             $sCatView s WHERE s.oxrootid = '".$oRs->fields[0]."' and
                             v.oxrootid='".$oRs->fields[0]."' and s.oxleft BETWEEN
                             v.oxleft AND v.oxright AND s.oxhidden = '0' GROUP BY s.oxleft order by level";

                    $oRs2 = $oDb->Execute( $sSQL );
                    if ( $oRs2 != false && $oRs2->recordCount() > 0 ) {
                        while ( !$oRs2->EOF ) {
                            // store it
                            $oCat = new stdClass();
                            $oCat->_sOXID     = $oRs2->fields[0];
                            $oCat->oxtitle    = $oRs2->fields[1];
                            $oCat->oxparentid = $oRs2->fields[2];
                            $oCat->ilevel     = $oRs2->fields[3];
                            $this->_aCatLvlCache[$oCat->_sOXID] = $oCat;

                            $oRs2->moveNext();
                        }
                    }
                    $oRs->moveNext();
                }
            }
        }

        return $this->_aCatLvlCache;
    }

    protected function _findDeepestCatPath( $oArticle )
    {
        $sRet = "";

        // find deepest
        $aIds = $oArticle->getCategoryIds();
        if ( is_array( $aIds ) && count( $aIds ) ) {
            if ( $aCatLvlCache = $this->_loadRootCats() ) {
                $sIdMax  = null;
                $dMaxLvl = 0;
                foreach ( $aIds as $sCatId ) {
                    if ( $dMaxLvl < $aCatLvlCache[$sCatId]->ilevel ) {
                        $dMaxLvl = $aCatLvlCache[$sCatId]->ilevel;
                        $sIdMax  = $sCatId;
                        $sRet    = $aCatLvlCache[$sCatId]->oxtitle;
                    }
                }

                // endless
                for ( ;; ) {
                    if ( !isset( $aCatLvlCache[$sIdMax]->oxparentid ) || $aCatLvlCache[$sIdMax]->oxparentid == "oxrootid" ) {
                        break;
                    }
                    $sIdMax = $aCatLvlCache[$sIdMax]->oxparentid;
                    $sRet = $aCatLvlCache[$sIdMax]->oxtitle."/".$sRet;
                }
            }
        }
        return $sRet;
    }

    protected function _initArticle( $sHeapTable, $iCnt, & $blContinue )
    {


        $oRs = oxDb::getDb()->selectLimit( "select oxid from $sHeapTable", 1, $iCnt );
        if ( $oRs != false && $oRs->recordCount() > 0 ) {
            $oArticle = oxNew( 'oxarticle' );
            $oArticle->setLoadParentData( true );

            $oArticle->setLanguage( oxSession::getVar( "iExportLanguage" ) );

            if ( $oArticle->load( $oRs->fields[0] ) ) {
                // if article exists, do not stop export
                $blContinue = true;
                // check price
                $dMinPrice = oxConfig::getParameter( "sExportMinPrice" );
                if ( !isset( $dMinPrice ) || ( isset( $dMinPrice ) && ( $oArticle->getPrice()->getBruttoPrice() >= $dMinPrice ) ) ) {

                    //Saulius: variant title added
                    $sTitle = $oArticle->oxarticles__oxvarselect->value ? " " .$oArticle->oxarticles__oxvarselect->value : "";
                    $oArticle->oxarticles__oxtitle->setValue( $oArticle->oxarticles__oxtitle->value . $sTitle );


                    return $oArticle;
                }
            }
        }
    }

    protected function _setCampaignDetailLink( $oArticle )
    {
        // #827
        if ( $sCampaign = oxConfig::getParameter( "sExportCampaign" ) ) {
            // modify detaillink
            //#1166R - pangora - campaign
            $oArticle->appendLink( "campaign={$sCampaign}" );

            if ( oxConfig::getParameter( "blAppendCatToCampaign") &&
                 ( $sCat = $this->getCategoryString( $oArticle ) ) ) {
                $oArticle->appendLink( "/$sCat" );
            }
        }
        return $oArticle;
    }

    public function getViewId()
    {
        return 'dyn_interface';
    }
}