Exception.php

<?php
/**
 *
 * @version   1.0
 * @author    Paul Dragoonis <dragoonis@php.net>
 * @license   http://opensource.org/licenses/mit-license.php MIT
 * @copyright Digiflex Development
 * @package   Core
 * @link      www.ppiframework.com
 */

class PPI_Exception extends Exception {

    /**
     * The backtrace
     *
     * @var string
     */
	public $_traceString = '';

    /**
     * The error line
     *
     * @var int|string
     */
	public $_line = '';

    /**
     * The error code
     *
     * @var int|string
     */
	public $_code = '';

    /**
     * The error message
     *
     * @var string
     */
	public $_message = '';

    /**
     * The error filename
     *
     * @var string
     */
	public $_file = '';

    /**
     * The backtrace as an array
     *
     * @var array
     */
	public $_traceArray = array();

    /**
     * Any SQL queries that have been ran
     *
     * @var array
     */
	public $_queries = array();

    /**
     * Singleton instance
     *
     * @var null
     */
    private static $_instance = null;

    /**
     * Initialize the default registry instance.

     * @return void
     */
    protected static function init() {
        self::setInstance(new PPI_Exception());
    }

    /**
     * Set the default registry instance to a specified instance.
     *
     * @return void
     */
    public static function setInstance(PPI_Exception $instance) {
        self::$_instance = $instance;
    }
    /**
     * Retrieves the default exception instance.
     */
    public static function getInstance() {
        if (self::$_instance === null) {
            self::init();
        }
        return self::$_instance;
    }

    /**
     * Initialise the PPI_Exception object and start setting up debug info such as backtraces.
     *
     * @param string $message
     * @param null|array $sqlQueries
     */
	function __construct($message = '', $sqlQueries = null) {
		parent::__construct($message);
		$this->_traceString = $this->getTraceAsString();
		$this->_traceArray	= $this->getTrace();
		$this->_line 		= $this->getLine();
		$this->_code 		= $this->getCode();
		$this->_message 	= $this->getMessage();
		$this->_file 		= $this->getFile();
		$this->_queries 	= PPI_Helper::getRegistry()->get('PPI_Model_Queries', array());
	}

	/**
     * This function shows a 403 error
     *
     * @access	public
     * @return	void
     */
	function show_403($p_sMessage = "") {
		$heading = "403 Forbidden";
		$message = (!empty ($p_sMessage) ) ? $p_sMessage : "You are not allowed to access the requested location";
		PPI_Helper::getRegistry()->set('PPI_View::httpResponseCode', 403);
		require SYSTEMPATH.'errors/403.php';
	}


	/**
    * This function shows a 404 error
    *
    * @access	public
    * @todo     change this to a new function name
    * @todo     make this do 404 on the HTTP status line
    * @param    string argument name
    * @return	void
    */
	static function show_404($p_sLocation = "", $p_bUseImage = false) {
		$oConfig = PPI_Helper::getConfig();
		$heading = "Page cannot be found";
		$message = !empty($p_sLocation) ? $p_sLocation : "The page you requested was not found.";
		PPI_Helper::getRegistry()->set('PPI_View::httpResponseCode', 404);
		header('Status: 404 Not Found');
		$oView   = new PPI_View();
		$oView->load('framework/404', array(
			'heading'       => 'Page cannot be found', 'message' => $message,
			'errorPageType' => '404'
		));
        exit;
	}


	/**
     * Show this exception
     *
	 * @param string $p_aError Error information from the custom error log
	 * @return void
	 */
	function show_exceptioned_error($p_aError = "") {

		$p_aError['sql'] = PPI_Helper::getRegistry()->get('PPI_Model::Query_Backtrace', array());
		if(!empty($p_aError)) {

			try {
				$logInfo = $p_aError;
				unset($logInfo['code']);
				$logInfo['sql'] = serialize($logInfo['sql']);
				$oModel = new PPI_Model_Shared('ppi_exception', 'id');
				$oModel->insert($logInfo);
			} catch(PPI_Exception $e) {} catch(Exception $e) {}

			try {
				$oEmail    = new PPI_Email_PHPMailer();
				$oConfig   = PPI_Helper::getConfig();
				$url       = $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'];
				$userAgent = $_SERVER['HTTP_USER_AGENT'];
				$ip        = $_SERVER['REMOTE_ADDR'];
				$referer   = isset($_SERVER['HTTP_REFERER']) ? $_SERVER['HTTP_REFERER'] : 'Not Available';
				if(isset($oConfig->system->error->email)) {

				$emailBody = <<<EOT
Hey Support Team,
An error has occured. The following information will help you debug:

Message:    {$p_aError['message']}
Line:       {$p_aError['line']}
File:       {$p_aError['file']}
URL:        {$url}
User Agent: {$userAgent}
IP:         {$ip}
Referer:    {$referer}
Backtrace:  {$p_aError['backtrace']}

EOT;
					$aErrorConfig = $oConfig->system->error->email->toArray();
					$aEmails = array_map('trim', explode(',', $aErrorConfig['to']));
					foreach($aEmails as $email) {
						$name = '';
						if(strpos($email, ':') !== false) {
							list($name, $email) = explode(':', $email, 2);
						}
						$oEmail->AddAddress($email, $name);
					}

					$fromEmail = $aErrorConfig['from'];
					$fromName = '';
					if(strpos($fromEmail, ':') !== false) {
						list($fromName, $fromEmail) = explode(':', $fromEmail, 2);
					}
					$oEmail->SetFrom($fromEmail, $fromName);
					$oEmail->Subject = $aErrorConfig['subject'];
					$oEmail->Body = $emailBody;
					$oEmail->Send();
				}

			} catch(PPI_Exception $e) {} catch(Exception $e) {}
		}

		$oApp = PPI_Helper::getRegistry()->get('PPI_App', false);
		if($oApp === false) {
			$sSiteMode = 'development';
			$heading = "Exception";
			require SYSTEMPATH.'View/fatal_code_error.php';
			echo $header.$html.$footer;
			exit;
		}

		$sSiteMode = $oApp->getSiteMode();
		if($sSiteMode == 'development') {
			$heading = "Exception";
			$baseUrl = PPI_Helper::getConfig()->system->base_url;
			require SYSTEMPATH.'View/code_error.php';
			echo $header.$html.$footer;
		} else {

			$oView = new PPI_View();
			$oView->load('framework/error', array(
				'message' => $p_aError['message'],
				'errorPageType' => '404'
			));
		}
		exit;
	}


	/**
	 * Show an error message
	 *
	 * @param string $p_sMsg
     * @return void
	 */
	function show_error($p_sMsg) {
        $oConfig = PPI_Helper::getConfig();
		$heading = "PHP Error";
		$baseUrl = $oConfig->system->base_url;
		require SYSTEMPATH.'View/code_error.php';
		echo $header.$html.$footer;
	}

	/**
	 * Same as show error but return the content as a param
	 *
	 * @param array $p_aError
	 * @return string The HTML contents
	 */
	function getErrorForEmail($p_aError = "") {
		$oConfig = PPI_Helper::getConfig();
		$heading = "PHP Error";
		$baseUrl = $oConfig->system->base_url;
		require SYSTEMPATH.'View/code_error.php';
		return $html;
	}
}