oxexceptionhandler.php

Go to the documentation of this file.

<?php

class oxExceptionHandler
{
    protected $_sFileName = 'EXCEPTION_LOG.txt';

    protected $_iDebug = 0;

    public function __construct( $iDebug = 0 )
    {
        $this->_iDebug = (int) $iDebug;
    }

    public function setIDebug($iDebug)
    {
        $this->_iDebug = $iDebug;
    }

    public function setLogFileName($sFile)
    {
        $this->_sFileName = $sFile;
    }

    public function getLogFileName()
    {
        return $this->_sFileName;
    }

    public function handleUncaughtException( Exception $oEx )
    {
        // split between php or shop exception
        if ( !$oEx instanceof oxException ) {
            $this->_dealWithNoOxException( $oEx );
            return;    // Return straight away ! (in case of unit testing)
        }

        $oEx->setLogFileName( $this->_sFileName );  // set common log file ...

        $this->_uncaughtException( $oEx );    // Return straight away ! (in case of unit testing)
    }

    protected function _uncaughtException( oxException $oEx )
    {
        // exception occured in function processing
        $oEx->setNotCaught();
        // general log entry for all exceptions here
        $oEx->debugOut();

        if ( defined( 'OXID_PHP_UNIT' ) ) {
            return $oEx->getString();
        } elseif ( 0 != $this->_iDebug ) {
            oxUtils::getInstance()->showMessageAndExit( $oEx->getString() );
        }

        //simple safe redirect in productive mode
        $this->_safeShopRedirectAndExit( "offline.html" );

        //should not be reached
        return ;
    }

    protected function _dealWithNoOxException( Exception $oEx )
    {
        if ( 0 != $this->_iDebug ) {
            $sLogMsg = date( 'Y-m-d H:i:s' ) . $oEx . "\n---------------------------------------------\n";
            oxUtils::getInstance()->writeToLog( $sLogMsg, $this->getLogFileName() );
            if ( defined( 'OXID_PHP_UNIT' ) ) {
                return;
            } elseif ( 0 != $this->_iDebug ) {
                oxUtils::getInstance()->showMessageAndExit( $sLogMsg );
            }
        }

        $this->_safeShopRedirectAndExit( 'offline.html' );

    }

    protected function _safeShopRedirectAndExit($sUrl)
    {
        // No redirects in unit testing .. as redirection ends also unit testing script..
        if ( defined('OXID_PHP_UNIT')) {
            return ;
        }

        //make the redirect directly to be independetn from other objects
        header("HTTP/1.1 500 Internal Server Error");
        header("Location: ".$sUrl);
        header("Connection: close");

    }

    public function __call( $sMethod, $aArgs)
    {
        if ( defined( 'OXID_PHP_UNIT' ) ) {
            if ( substr( $sMethod, 0, 4) == "UNIT") {
                $sMethod = str_replace( "UNIT", "_", $sMethod);
            }
            if ( method_exists( $this, $sMethod)) {
                return call_user_func_array( array( & $this, $sMethod), $aArgs );
            }
        }

        throw new oxSystemComponentException( "Function '$sMethod' does not exist or is not accessable! (".__CLASS__.")".PHP_EOL);
    }
}