genimport_main.php

Go to the documentation of this file.

<?php

class GenImport_Main extends oxAdminDetails
{

    public $sClassDo = "genImport_do";

    public $sClassMain = "genImport_main";

    protected $_sCsvFilePath = null;

    protected $_sStringTerminator = null;

    protected $_sStringEncloser = null;

    protected $_sDefaultStringTerminator = ";";

    protected $_sDefaultStringEncloser = '"';

    protected $_sThisTemplate = "genimport_main.tpl";

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

        $oErpImport = new oxErpGenImport();
        $this->_sCsvFilePath = null;

        $sNavStep = $oConfig->getRequestParameter('sNavStep');

        if (!$sNavStep) {
            $sNavStep = 1;
        } else {
            $sNavStep++;
        }


        $sNavStep = $this->_checkErrors($sNavStep);

        if ($sNavStep == 1) {
            $this->_aViewData['sGiCsvFieldTerminator'] = oxStr::getStr()->htmlentities($this->_getCsvFieldsTerminator());
            $this->_aViewData['sGiCsvFieldEncloser'] = oxStr::getStr()->htmlentities($this->_getCsvFieldsEncolser());
        }

        if ($sNavStep == 2) {
            $configValidator = oxNew('oxNoJsValidator');
            //saving csv field terminator and encloser to config
            $sTerminator = $oConfig->getRequestParameter('sGiCsvFieldTerminator');
            if ($sTerminator && !$configValidator->isValid($sTerminator)) {
                $this->setErrorToView($sTerminator);
            } else {
                $this->_sStringTerminator = $sTerminator;
                $oConfig->saveShopConfVar('str', 'sGiCsvFieldTerminator', $sTerminator);
            }

            $sEncloser = $oConfig->getRequestParameter('sGiCsvFieldEncloser');
            if ($sEncloser && !$configValidator->isValid($sEncloser)) {
                $this->setErrorToView($sEncloser);
            } else {
                $this->_sStringEncloser = $sEncloser;
                $oConfig->saveShopConfVar('str', 'sGiCsvFieldEncloser', $sEncloser);
            }

            $sType = $oConfig->getRequestParameter('sType');
            $oType = $oErpImport->getImportObject($sType);
            $this->_aViewData['sType'] = $sType;
            $this->_aViewData['sImportTable'] = $oType->getBaseTableName();
            $this->_aViewData['aCsvFieldsList'] = $this->_getCsvFieldsNames();
            $this->_aViewData['aDbFieldsList'] = $oType->getFieldList();
        }

        if ($sNavStep == 3) {
            $aCsvFields = $oConfig->getRequestParameter('aCsvFields');
            $sType = $oConfig->getRequestParameter('sType');

            $oErpImport = new oxErpGenImport();
            $oErpImport->setImportTypePrefix($sType);
            $oErpImport->setCsvFileFieldsOrder($aCsvFields);
            $oErpImport->setCsvContainsHeader(oxRegistry::getSession()->getVariable('blCsvContainsHeader'));

            $oErpImport->doImport($this->_getUploadedCsvFilePath());
            $this->_aViewData['iTotalRows'] = $oErpImport->getTotalImportedRowsNumber();

            //checking if errors occured during import
            $this->_checkImportErrors($oErpImport);

            //deleting uploaded csv file from temp dir
            $this->_deleteCsvFile();

            //check if repeating import - then forsing first step
            if ($oConfig->getRequestParameter('iRepeatImport')) {
                $this->_aViewData['iRepeatImport'] = 1;
                $sNavStep = 1;
            }
        }

        if ($sNavStep == 1) {
            $this->_aViewData['aImportTables'] = $oErpImport->getImportObjectsList();
            asort($this->_aViewData['aImportTables']);
            $this->_resetUploadedCsvData();
        }

        $this->_aViewData['sNavStep'] = $sNavStep;

        return parent::render();
    }

    protected function _deleteCsvFile()
    {
        $sPath = $this->_getUploadedCsvFilePath();
        if (is_file($sPath)) {
            @unlink($sPath);
        }
    }

    protected function _getCsvFieldsNames()
    {
        $blCsvContainsHeader = $this->getConfig()->getRequestParameter('blContainsHeader');
        oxRegistry::getSession()->setVariable('blCsvContainsHeader', $blCsvContainsHeader);
        $sCsvPath = $this->_getUploadedCsvFilePath();

        $aFirstRow = $this->_getCsvFirstRow();

        if (!$blCsvContainsHeader) {
            $iIndex = 1;
            foreach ($aFirstRow as $sValue) {
                $aCsvFields[$iIndex] = 'Column ' . $iIndex++;
            }
        } else {
            foreach ($aFirstRow as $sKey => $sValue) {
                $aFirstRow[$sKey] = oxStr::getStr()->htmlentities($sValue);
            }

            $aCsvFields = $aFirstRow;
        }

        return $aCsvFields;
    }

    protected function _getCsvFirstRow()
    {
        $sPath = $this->_getUploadedCsvFilePath();
        $iMaxLineLength = 8192;

        //getting first row
        if (($rFile = @fopen($sPath, "r")) !== false) {
            $aRow = fgetcsv($rFile, $iMaxLineLength, $this->_getCsvFieldsTerminator(), $this->_getCsvFieldsEncolser());
            fclose($rFile);
        }

        return $aRow;
    }

    protected function _resetUploadedCsvData()
    {
        $this->_sCsvFilePath = null;
        oxRegistry::getSession()->setVariable('sCsvFilePath', null);
        oxRegistry::getSession()->setVariable('blCsvContainsHeader', null);
    }

    protected function _checkErrors($iNavStep)
    {
        if ($iNavStep == 2) {
            if (!$this->_getUploadedCsvFilePath()) {
                $oEx = oxNew("oxExceptionToDisplay");
                $oEx->setMessage('GENIMPORT_ERRORUPLOADINGFILE');
                oxRegistry::get("oxUtilsView")->addErrorToDisplay($oEx, false, true, 'genimport');
                $iNavStep = 1;
            }
        }

        if ($iNavStep == 3) {
            $blIsEmpty = true;
            $aCsvFields = $this->getConfig()->getRequestParameter('aCsvFields');
            foreach ($aCsvFields as $sValue) {
                if ($sValue) {
                    $blIsEmpty = false;
                    break;
                }
            }

            if ($blIsEmpty) {
                $oEx = oxNew("oxExceptionToDisplay");
                $oEx->setMessage('GENIMPORT_ERRORASSIGNINGFIELDS');
                oxRegistry::get("oxUtilsView")->addErrorToDisplay($oEx, false, true, 'genimport');
                $iNavStep = 2;
            }
        }

        return $iNavStep;
    }

    protected function _getUploadedCsvFilePath()
    {
        //try to get uploaded csv file path
        if ($this->_sCsvFilePath !== null) {
            return $this->_sCsvFilePath;
        } elseif ($this->_sCsvFilePath = oxRegistry::getSession()->getVariable('sCsvFilePath')) {
            return $this->_sCsvFilePath;
        }

        $oConfig = $this->getConfig();
        $aFile = $oConfig->getUploadedFile('csvfile');
        if (isset($aFile['name']) && $aFile['name']) {
            $this->_sCsvFilePath = $oConfig->getConfigParam('sCompileDir') . basename($aFile['tmp_name']);
            move_uploaded_file($aFile['tmp_name'], $this->_sCsvFilePath);
            oxRegistry::getSession()->setVariable('sCsvFilePath', $this->_sCsvFilePath);

            return $this->_sCsvFilePath;
        }
    }

    protected function _checkImportErrors($oErpImport)
    {
        foreach ($oErpImport->getStatistics() as $aValue) {
            if (!$aValue ['r']) {
                $oEx = oxNew("oxExceptionToDisplay");
                $oEx->setMessage($aValue ['m']);
                oxRegistry::get("oxUtilsView")->addErrorToDisplay($oEx, false, true, 'genimport');
            }
        }

    }

    protected function _getCsvFieldsTerminator()
    {
        if ($this->_sStringTerminator === null) {
            $this->_sStringTerminator = $this->_sDefaultStringTerminator;
            if ($sChar = $this->getConfig()->getConfigParam('sGiCsvFieldTerminator')) {
                $this->_sStringTerminator = $sChar;
            }
        }

        return $this->_sStringTerminator;
    }

    protected function _getCsvFieldsEncolser()
    {
        if ($this->_sStringEncloser === null) {
            $this->_sStringEncloser = $this->_sDefaultStringEncloser;
            if ($sChar = $this->getConfig()->getConfigParam('sGiCsvFieldEncloser')) {
                $this->_sStringEncloser = $sChar;
            }
        }

        return $this->_sStringEncloser;
    }

    private function setErrorToView($sInvalidData)
    {
        $error = oxNew('oxDisplayError');
        $error->setFormatParameters(htmlspecialchars($sInvalidData));
        $error->setMessage("SHOP_CONFIG_ERROR_INVALID_VALUE");
        oxRegistry::get("oxUtilsView")->addErrorToDisplay($error);
    }
}