From e79bb64cbb7738355b87f89d53cb64c334610d57 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Steffen=20Schro=CC=88der?= <schteffens@gmail.com>
Date: Sun, 4 May 2014 00:16:50 +0200
Subject: [PATCH] added exception class to error report improved code

---
 application/core/ErrorHandler.php | 85 ++++++++++++++++---------------
 1 file changed, 44 insertions(+), 41 deletions(-)

diff --git a/application/core/ErrorHandler.php b/application/core/ErrorHandler.php
index de328814..b378b28b 100644
--- a/application/core/ErrorHandler.php
+++ b/application/core/ErrorHandler.php
@@ -16,7 +16,7 @@ class ErrorHandler {
 	/*
 	 * Constants
 	 */
-	const MC_DEBUG_NOTICE              = "ManiaControl.DebugNotice";
+	const MC_DEBUG_NOTICE              = 'ManiaControl.DebugNotice';
 	const SETTING_RESTART_ON_EXCEPTION = 'Automatically restart on Exceptions';
 
 	/*
@@ -42,23 +42,26 @@ class ErrorHandler {
 	}
 
 	/**
-	 * ManiaControl ExceptionHandler
+	 * ManiaControl Exception Handler
 	 *
 	 * @param \Exception $ex
 	 * @param bool       $shutdown
 	 */
 	public function handleException(\Exception $ex, $shutdown = true) {
-		// Log exception
-		$message      = "[ManiaControl EXCEPTION]: {$ex->getMessage()}";
-		$traceMessage = 'Class: ' . get_class($ex) . PHP_EOL;
-		$traceMessage .= 'Trace:' . PHP_EOL . $ex->getTraceAsString();
-		logMessage($message . PHP_EOL . $traceMessage);
+		$message = "[ManiaControl EXCEPTION]: {$ex->getMessage()}";
+
+		$exceptionClass = get_class($ex);
+		$traceString    = $ex->getTraceAsString();
+
+		$logMessage = $message . PHP_EOL . 'Class: ' . $exceptionClass . PHP_EOL . 'Trace:' . PHP_EOL . $traceString;
+		logMessage($logMessage);
 
 		if ($this->reportErrors) {
 			$error                    = array();
-			$error["Type"]            = "Exception";
-			$error["Message"]         = $message;
-			$error["Backtrace"]       = $traceMessage;
+			$error['Type']            = 'Exception';
+			$error['Message']         = $message;
+			$error['Class']           = $exceptionClass;
+			$error['Backtrace']       = $traceString;
 			$error['OperatingSystem'] = php_uname();
 			$error['PHPVersion']      = phpversion();
 
@@ -79,13 +82,13 @@ class ErrorHandler {
 			$json = json_encode($error);
 			$info = base64_encode($json);
 
-			$url     = ManiaControl::URL_WEBSERVICE . "errorreport?error=" . urlencode($info);
+			$url     = ManiaControl::URL_WEBSERVICE . 'errorreport?error=' . urlencode($info);
 			$success = FileUtil::loadFile($url);
 
 			if (!json_decode($success)) {
-				logMessage("Exception-Report failed!");
+				logMessage('Exception-Report failed!');
 			} else {
-				logMessage("Exception successfully reported!");
+				logMessage('Exception successfully reported!');
 			}
 		}
 
@@ -120,7 +123,7 @@ class ErrorHandler {
 	}
 
 	/**
-	 * Error Handler
+	 * ManiaControl Error Handler
 	 *
 	 * @param int    $errorNumber
 	 * @param string $errorString
@@ -129,22 +132,21 @@ class ErrorHandler {
 	 * @return bool
 	 */
 	public function handleError($errorNumber, $errorString, $errorFile = null, $errorLine = -1) {
-		$userError = $this->isUserErrorNumber($errorNumber);
+		$errorTag = $this->getErrorTag($errorNumber);
 
-		// Log error
-		$errorTag     = $this->getErrorTag($errorNumber);
-		$message      = $errorTag . ': ' . $errorString;
-		$fileLine     = $errorFile . ': ' . $errorLine;
-		$traceMessage = $this->parseBackTrace(debug_backtrace());
-		$logMessage   = $message . PHP_EOL . $fileLine . PHP_EOL . $traceMessage;
+		$message     = $errorTag . ': ' . $errorString;
+		$fileLine    = $errorFile . ': ' . $errorLine;
+		$traceString = $this->parseBackTrace(debug_backtrace());
+
+		$logMessage = $message . PHP_EOL . 'File&Line: ' . $fileLine . PHP_EOL . 'Trace: ' . $traceString;
 		logMessage($logMessage);
 
-		if ($this->reportErrors && !$userError) {
+		if ($this->reportErrors && !$this->isUserErrorNumber($errorNumber)) {
 			$error                    = array();
-			$error["Type"]            = "Error";
-			$error["Message"]         = $message;
-			$error["FileLine"]        = $fileLine;
-			$error["Backtrace"]       = $traceMessage;
+			$error['Type']            = 'Error';
+			$error['Message']         = $message;
+			$error['FileLine']        = $fileLine;
+			$error['Backtrace']       = $traceString;
 			$error['OperatingSystem'] = php_uname();
 			$error['PHPVersion']      = phpversion();
 
@@ -165,13 +167,13 @@ class ErrorHandler {
 			$json = json_encode($error);
 			$info = base64_encode($json);
 
-			$url     = ManiaControl::URL_WEBSERVICE . "errorreport?error=" . urlencode($info);
+			$url     = ManiaControl::URL_WEBSERVICE . 'errorreport?error=' . urlencode($info);
 			$success = FileUtil::loadFile($url);
 
 			if (!json_decode($success)) {
-				logMessage("Error-Report failed!");
+				logMessage('Error-Report failed!');
 			} else {
-				logMessage("Error successfully reported!");
+				logMessage('Error successfully reported!');
 			}
 		}
 		if ($this->shouldStopExecution($errorNumber)) {
@@ -181,16 +183,6 @@ class ErrorHandler {
 		return false;
 	}
 
-	/**
-	 * Check if the given Error Number is a User Error
-	 *
-	 * @param int $errorNumber
-	 * @return bool
-	 */
-	private function isUserErrorNumber($errorNumber) {
-		return ($errorNumber === E_USER_ERROR || $errorNumber === E_USER_WARNING || $errorNumber === E_USER_NOTICE || $errorNumber === E_USER_DEPRECATED);
-	}
-
 	/**
 	 * Get the Prefix for the given Error Level
 	 *
@@ -225,10 +217,11 @@ class ErrorHandler {
 
 	/**
 	 * Parse the Debug Backtrace into a String for the Error Report
-	 * return string
+	 *
+	 * @return string
 	 */
 	private function parseBackTrace(array $backtrace) {
-		$traceString = 'Trace:';
+		$traceString = '';
 		$stepCount   = 0;
 		foreach ($backtrace as $traceStep) {
 			$traceString .= PHP_EOL . '#' . $stepCount . ': ';
@@ -254,6 +247,16 @@ class ErrorHandler {
 		return $traceString;
 	}
 
+	/**
+	 * Check if the given Error Number is a User Error
+	 *
+	 * @param int $errorNumber
+	 * @return bool
+	 */
+	private function isUserErrorNumber($errorNumber) {
+		return ($errorNumber === E_USER_ERROR || $errorNumber === E_USER_WARNING || $errorNumber === E_USER_NOTICE || $errorNumber === E_USER_DEPRECATED);
+	}
+
 	/**
 	 * Test if ManiaControl should stop its Execution
 	 *