hcuLogError.i

<?php
/**
 *
 *  Log Error and Exception Handling Class
 *
 *  Required
 *    hcuCommon.i
 *    logging.i
 *
 */


require_once(dirname(__FILE__) . '/../../shared/library/logging.i');
require_once(dirname(__FILE__) . '/../../shared/library/hcuCommon.i');

define('HCU_PRODUCT_BANKING', 0);
define('HCU_PRODUCT_ADMIN',   1);
define('HCU_PRODUCT_MONITOR', 2);

abstract class CatchHandler {

  /**
   * PROPERTIES
   */

  /**
   *  The logger object used for writing to error log
   */
  protected $errLogger = null;
  protected $errReportLvl = E_ALL & ~E_NOTICE & ~E_STRICT & ~E_DEPRECATED;

  /**
   * private @var boolean $saveLog     -- By default does the log get saved when this class handles a raised error
   * private @var boolean $showErrPage -- Redirect to an error page?
   *
   * private @var string $errPageUrl
   */
  private $saveLog = false;
  private $showErrPage = false;

  private $errPageUrl = '';

  /**
   * private @var boolean $noticeOnly  -- {true, false(default)}Should the message be printed to the console as a NOTICE
   */
  private $noticeOnly = false;
  /**
   *
   * private @var integer $hcuProduct  -- This is the homecu product that has called raised the error
   *                                     {HCU_PRODUCT_MONITOR, HCU_PRODUCT_BANKING, HCU_PRODUCT_ADMIN}
   *
   */
  private $hcuProduct = null;


  /**
   *
   * private @var integer $hcuDevMode  -- This will tell us if we are in Dev Mode or Production
   *                                      1 -- dev mode is enabled, log files may have more information
   *                                      0 -- production mode
   */
  private $hcuDevMode = 0;

  /**
   *  Values from the PHP _SERVER structure
   *  protected @var string $errRemoteAddr _SERVER REMOTE_ADDR
   *  protected @var string $errRequestUri _SERVER REQUEST_URI
   *  protected @var string $errServerName _SERVER SERVER_NAME
   *  protected @var string $errPhpSelf    _SERVER PHP_SELF
   *  protected @var string $errScriptName _SERVER SCRIPT_NAME
   *  protected @var string $errQueryString _SERVER QUERY_STRING
   *
   */
  protected $errRemoteAddr;
  protected $errRequestUri;
  protected $errServerName;
  protected $errPhpSelf;
  protected $errScriptName;
  protected $errQueryString;

  /**
   *
   * PARENT CONSTRUCTOR
   *
   */
  function __construct($pSetProduct, $pSetLogger=null) {

    $this->hcuProduct = $pSetProduct;

    /**
     * Set the logger object if it is defined
     */
    $this->setLogger($pSetLogger);
    $this->setErrorReporting($this->errReportLvl);

  }

  /**
   *
   * PRIVATE METHODS
   *
   */

  /**
   *  Save the log message for the error being raised
   *
   */
  private function SaveLogMsg() {

    $lLogMsg = $this->getErrMsg();
    //** If this->errLogger is set then use this for logging the error,
      // * If not, then save to the default error_log
    if (!is_null($this->errLogger)) {
      if ($this->noticeOnly) {
        // * Default error log destination
        $this->errLogger->notice($lLogMsg);
      } else {
        // * Default error log destination
        $this->errLogger->error($lLogMsg);
      }

    } else {
      // ** logger not set, save with built in error_log function
      error_log($lLogMsg);
    }
  }

  /**
   *
   * PROTECTED METHODS
   *
   */
  protected function handleError() {

    /**
     *  Record the _SERVER variables
     */

    $this->errRemoteAddr = (array_key_exists("REMOTE_ADDR", $_SERVER) ? $_SERVER['REMOTE_ADDR'] : '0.0.0.0');
    $this->errRequestUri = (array_key_exists("REQUEST_URI", $_SERVER) ? $_SERVER['REQUEST_URI'] : '127.0.0.1');
    $this->errServerName = (array_key_exists("SERVER_NAME", $_SERVER) ? $_SERVER['SERVER_NAME'] : '');
    $this->errPhpSelf = (array_key_exists("PHP_SELF", $_SERVER) ? $_SERVER['PHP_SELF'] : '');
    $this->errScriptFileName = (array_key_exists("SCRIPT_FILENAME", $_SERVER) ? $_SERVER['SCRIPT_FILENAME'] : __FILE__);
    $this->errQueryString = (array_key_exists("QUERY_STRING", $_SERVER) ? $_SERVER['QUERY_STRING'] : '');

    if ($this->saveLog) {
      $this->SaveLogMsg();
    }
  }

  protected function setSaveLog($pSaveLog) {
    $this->saveLog = $pSaveLog;
  }
  protected function getErrMsg() {
  }

  protected function setNotice($pNoticeOnly) {
    $this->noticeOnly = $pNoticeOnly;
  }


  /**
   *
   * PUBLIC METHODS
   *
   */
  /**
   *
   *  this will set the logger object for the current error exception handler
   *  @param object $pLogger This is an instance of the ColorStandardLogger object
   *
   */
  public function setLogger($pLogger) {

    if (is_a($pLogger, 'StandardLogger')) {
      $this->errLogger = $pLogger;
    }
  }

  public function setDevMode($pDevMode) {
    $this->hcuDevMode = $pDevMode;


    if ($pDevMode) {
      // ** DEV MODE -- ADD E_NOTICE
      $this->setErrorReporting($this->getErrorReporting() | E_NOTICE);
    }
  }
  public function getDevMode() {
    return $this->hcuDevMode;
  }

  /**
   *
   *  Set the level of php debugging
   *  @param int The integer value representing the error reporting level
   *
   *  @return int the previous value of error reporting
   *
   */
  public function setErrorReporting($pNewReportLvl) {
    $this->errReportLvl = $pNewReportLvl;
    return error_reporting($pNewReportLvl);
  }

  /**
   *
   *  Get the current level of php debugging
   *
   *  @return int the previous value of error reporting
   *
   */
  public function getErrorReporting() {
    return $this->errReportLvl;
  }
}

class CatchExceptionHandler extends CatchHandler {

  /**
   * @var object $errException  This is the error exception class that is thrown to catchHandler
   */
  private $errException = null;

  private function getSaveLog() {
    return true;
  }

  function __construct($pSetProduct, $pSetLogger=null, $pDevMode=false) {
    parent::__construct($pSetProduct, $pSetLogger);

    $this->setDevMode($pDevMode);
  }

  public function catchException($pException) {

    $this->logException($pException);

    /**
     *
     *  Exception was triggered
     *  Include an error handling script that will be presented to the user
     *
     */

    include_once(dirname(__FILE__) . '/../../shared/includes/hcuBadRequest.i');
    exit;

  }
  /**
   *  This will log the exception information to the specified error log
   *
   *  @param object $pException This is the exception object that was thrown
   *
   */
  public function logException($pException) {

    $this->errException = $pException;

    $this->setSaveLog($this->getSaveLog());

    parent::handleError();

  }


  /**
   *
   * Build the error message from the exception information
   *   Specific to the exception object
   *
   * @param int $pType - (0-Format error for Log File, 1-Format error for e-mail)
   *
   * @return string     Returns formatted error string
   */
  protected function getErrMsg() {
    $lRetStr = '';
    $lCurDate = date("Ymd:His");

    $lRetStr = <<< LOGMSG
[{$lCurDate}] {$this->errException->getCode()} [{$this->errRemoteAddr}] [{$this->errServerName}{$this->errPhpSelf}?{$this->errQueryString}] [{$this->errException->getFile()}] [Line {$this->errException->getLine()}] [{$this->errException->getCode()}] {$this->errException->getMessage()}
LOGMSG;

    if ($this->getDevMode()) {
      /**
       *  For dev mode  add extra informaition to the log file
       *
       */
      $lRetStr .= $this->errException->getTraceAsString();
    }
    return $lRetStr;
  }
}

class CatchErrorHandler extends CatchHandler {

  /**
   *  @var string $errNo The Error Number sent to the error handler
   */
  private $errNo;
  /**
   *  @var string $errStr The Error String sent to the error handler
   */
  private $errStr;
  /**
   *  @var string $errFile The File Information where the error was raised
   */
  private $errFile;
  /**
   *  @var string $errLine The line number in the file that raised the error
   */
  private $errLine;
  /**
   *  @var string $errType A printable representation of the errNo
   */
  private $errType;

  /**
   *  @var array $errConstants  A list to translate the error numbers into readable string
   */
  private $errConstants = Array (
      "1" => "[E_ERROR]",
      "2" => "[E_WARNING]",
      "4" => "[E_PARSE]",
      "8" => "[E_NOTICE]",
      "16" => "[E_CORE_ERROR]",
      "32" => "[E_CORE_WARNING]",
      "64" => "[E_COMPILE_ERROR]",
      "128" => "[E_COMPILE_WARNING]",
      "256" => "[E_USER_ERROR]",
      "512" => "[E_USER_WARNING]",
      "1024" => "[E_USER_NOTICE]",
      "2048" => "[E_STRICT]",
      "4096" => "[E_RECOVERABLE_ERROR]",
      "8192" => "[E_DEPRECATED]",
      "16384" => "[E_USER_DEPRECATED]",
      "32767" => "[E_ALL]"
  );

  /**
   *  Default list of files to ignore errors
   */
  private $ignoreFileErrors = Array(
    "db.postgres.i"
  );


  /**
   *  Default list of error strings to ignore
   */
  private $ignoreErrorString = Array(
    "file-get-contents", "SSL: fatal protocol"
  );

  /**
   *
   * determine if we will save the log file
   * This will examine the {ignored files/error string} arrays and determine
   *  if the log should be saved
   *
   * @return boolean - {true/false} true if the log should be saved
   *
   */
  private function getSaveLog() {
    $retVal = false;
    parent::setNotice(false);

    // * Verify we want to report the error based on the Error
    if (($this->getErrorReporting() & $this->errNo) > 0) {
      switch ($this->errNo) {
        case E_NOTICE:
          // ** for E_NOTICE -- set the flag to show the errors as a notice
          parent::setNotice(true);

        case E_USER_ERROR:
        case E_USER_WARNING:
        case E_USER_NOTICE:

        case E_ERROR:

        case E_PARSE:

        case E_DEPRECATED:
        case E_USER_DEPRECATED:
          $retVal = true;
          break;
        case E_WARNING:

          // ** check to see if the file raising the error is in the exception list
          // Determine if it the file exists in the ignoreFileList array

          $retVal = (in_array(basename($this->errFile), $this->ignoreFileErrors) === false);

          // * ONLY consider the next check if retVal is true, if false, then skip
          if ($retVal) {
            $retVal = (in_array($this->errStr, $this->ignoreErrorString) === false);
          }
      }
    }
    return $retVal;
  }

  function __construct($pSetProduct, $pSetLogger=null, $pDevMode=false) {
    parent::__construct($pSetProduct, $pSetLogger);

    $this->setDevMode($pDevMode);
  }


  public function catchError($pErrNo, $pErrStr, $pErrFile, $pErrLine) {
    // ** Do what I need to do here to setup common details about the error that I want to capture
    // ** Include the back trace as well.
    $this->errNo = $pErrNo;
    $this->errStr = $pErrStr;
    $this->errFile = $pErrFile;
    $this->errLine = $pErrLine;
    $this->errType = (array_key_exists($pErrNo, $this->errConstants) ? $this->errConstants[$pErrNo] : "UNKNOWN");

    $this->setSaveLog($this->getSaveLog());

    parent::handleError();

  }

  /**
   *
   * Build the error message from the exception information
   *   Specific to the fields that were passed into the Error Handler
   *
   * @return string     Returns formatted error string
   */
  public function getErrMsg() {
    $lRetStr = "";
    $lCurDate = date("Ymd:His");
    $lCurDate = date("d/M/Y:H:i:s");

    // ** Format for Log File
    $lRetStr = <<< LOGMSG
[{$lCurDate}] $this->errType [{$this->errRemoteAddr}] [{$this->errServerName}{$this->errPhpSelf}?{$this->errQueryString}] [$this->errFile] [Line $this->errLine] [$this->errNo] $this->errStr
LOGMSG;

    // ** At this time I don't see a need to add trace to an error log

    return $lRetStr;
  }

  /**
   * Add a file to the ignore list.  This may be added to ignore a particular script on the fly
   *
   * @param string $pFileName - The name of the file to be added to the array
   */
  public function addFileIgnore($pFileName) {
    $this->ignoreFileErrors[] = $pFileName;
  }

  /**
   * Add a file to the ignore list.  This may be added to ignore a particular script on the fly
   *
   * @param string $pFileName - The name of the file to be added to the array
   */
  public function addErrStrIgnore($pFileName) {
    $this->ignoreErrorString[] = $pFileName;
  }
}