N°1195 exception handling in cron.php

* cron.php : use exit(n°) instead of exit n°, and extract codes to constants
* CMDBSource : new MySQLHasGoneAwayException
* exits cron.php on MySQLHasGoneAwayException
* fix backgroundprocess PHPDoc
* new ProcessException and ProcessFatalException
* new cron.php catch blocks

SVN:trunk[5148]

core/backgroundprocess.inc.php

@@ -24,9 +24,16 @@
  * @copyright   Copyright (C) 2010-2012 Combodo SARL
  * @license     http://opensource.org/licenses/AGPL-3.0
  */
-
 interface iProcess
 {
+	/**
+	 * @param int $iUnixTimeLimit
+	 *
+	 * @return string status message
+	 * @throws \ProcessException
+	 * @throws \ProcessFatalException
+	 * @throws MySQLHasGoneAwayException
+	 */
 	public function Process($iUnixTimeLimit);
 }
 
@@ -37,13 +44,11 @@ interface iProcess
  * @copyright   Copyright (C) 2010-2012 Combodo SARL
  * @license     http://opensource.org/licenses/AGPL-3.0
  */
-
 interface iBackgroundProcess extends iProcess
 {
-	/*
-		Gives the repetition rate in seconds
-		@returns integer
-	*/
+	/**
+	 * @return int repetition rate in seconds
+	 */
 	public function GetPeriodicity();
 }
 
@@ -54,14 +59,30 @@ interface iBackgroundProcess extends iProcess
  * @copyright   Copyright (C) 2013 Combodo SARL
  * @license     http://opensource.org/licenses/AGPL-3.0
  */
-
 interface iScheduledProcess extends iProcess
 {
-	/*
-		Gives the exact time at which the process must be run next time
-		@returns DateTime
-	*/
+	/**
+	 * @return DateTime exact time at which the process must be run next time
+	 */
 	public function GetNextOccurrence();
 }
 
-?>
+/**
+ * Class ProcessException
+ * Exception for iProcess implementations.<br>
+ * An error happened during the processing but we can go on with the next implementations.
+ */
+class ProcessException extends CoreException
+{
+
+}
+
+/**
+ * Class ProcessFatalException
+ * Exception for iProcess implementations.<br>
+ * A big error occurred, we have to stop the iProcess processing.
+ */
+class ProcessFatalException extends CoreException
+{
+
+}

core/cmdbsource.class.inc.php

@@ -47,6 +47,34 @@ class MySQLException extends CoreException
 	}
 }
 
+/**
+ * Class MySQLHasGoneAwayException
+ *
+ * @since iTop 2.5
+ * @see itop bug 1195
+ * @see https://dev.mysql.com/doc/refman/5.7/en/gone-away.html
+ */
+class MySQLHasGoneAwayException extends MySQLException
+{
+	/**
+	 * can not be a constant before PHP 5.6 (http://php.net/manual/fr/language.oop5.constants.php)
+	 *
+	 * @return int[]
+	 */
+	public static function getErrorCodes()
+	{
+		return array(
+			2006,
+			2013
+		);
+	}
+
+	public function __construct($sIssue, $aContext)
+	{
+		parent::__construct($sIssue, $aContext, null);
+	}
+}
+
 
 /**
  * CMDBSource
@@ -60,6 +88,7 @@ class CMDBSource
 	protected static $m_sDBUser;
 	protected static $m_sDBPwd;
 	protected static $m_sDBName;
+	/** @var mysqli */
 	protected static $m_oMysqli;
 
 	public static function Init($sServer, $sUser, $sPwd, $sSource = '')
@@ -275,6 +304,13 @@ class CMDBSource
 		return $value;
 	}
 
+	/**
+	 * @param string $sSQLQuery
+	 *
+	 * @return \mysqli_result
+	 * @throws \MySQLException
+	 * @throws \MySQLHasGoneAwayException
+	 */
 	public static function Query($sSQLQuery)
 	{
 		$oKPI = new ExecutionKPI();
@@ -289,7 +325,16 @@ class CMDBSource
 		$oKPI->ComputeStats('Query exec (mySQL)', $sSQLQuery);
 		if ($oResult === false)
 		{
-			throw new MySQLException('Failed to issue SQL query', array('query' => $sSQLQuery));
+			$aContext = array('query' => $sSQLQuery);
+
+			$iMySqlErrorNo = self::$m_oMysqli->errno;
+			$aMySqlHasGoneAwayErrorCodes = MySQLHasGoneAwayException::getErrorCodes();
+			if (in_array($iMySqlErrorNo, $aMySqlHasGoneAwayErrorCodes))
+			{
+				throw new MySQLHasGoneAwayException(self::GetError(), $aContext);
+			}
+
+			throw new MySQLException('Failed to issue SQL query', $aContext);
 		}
 	
 		return $oResult;

core/coreexception.class.inc.php

@@ -69,6 +69,13 @@ class CoreException extends Exception
 		parent::__construct($sMessage, 0);
 	}
 
+	/**
+	 * @return string code and message for log purposes
+	 */
+	public function getInfoLog()
+	{
+		return 'error_code='.$this->getCode().', message="'.$this->getMessage().'"';
+	}
 	public function getHtmlDesc($sHighlightHtmlBegin = '<b>', $sHighlightHtmlEnd = '</b>')
 	{
 		return $this->getMessage();