Merge lp:~vierbergenlars/remotecp-panel/offline-db-access into lp:~vierbergenlars/remotecp-panel/trunk

[Lars Vierbergen]

Add remote database offline access to admin area (offline-db-access blueprint)

[lp:~vierbergenlars/remotecp-panel/offline-db-access]

207. By Lars Vierbergen on 2011-10-19

Started implementation of blueprint offline-db-access.
Add exceptions

[Lars Vierbergen (vierbergenlars)]

review: Approve

=== modified file 'inc/controllers.php'
--- inc/controllers.php	2011-09-02 16:38:47 +0000
+++ inc/controllers.php	2011-10-19 19:44:25 +0000
@@ -1,7 +1,9 @@
 <?php //@./inc/controllers.php ?><?php
+require_once 'inc/exceptions/exceptions.php';
 require_once 'inc/errorhandler.php';
 require_once 'inc/utils/magic_quotes.php';
-ob_start('ob_gzhandler');
+//ob_start('ob_gzhandler');
+ob_start();
 header('Cache-Control: private');
 require_once 'inc/sitemgmt/constants.php';
 require_once 'inc/JavaScript_errorhandler.php';

=== added directory 'inc/exceptions'
=== added file 'inc/exceptions/database.php'
--- inc/exceptions/database.php	1970-01-01 00:00:00 +0000
+++ inc/exceptions/database.php	2011-10-19 19:44:25 +0000
@@ -0,0 +1,143 @@
+<?php
+/**
+ * Handles exceptions related to the database
+ * @author Lars Vierbergen
+ * @package exceptions
+ */
+class DatabaseException extends RuntimeException {
+	/**
+	 * Unknown error
+	 * @var int
+	 */
+	const unknown=0;
+	/**
+	 * Connection error
+	 * @var int
+	 */
+	const connect=1;
+	/**
+	 * Query error
+	 * @var int
+	 */
+	const query=2;
+	/**
+	 * Error on a row operation
+	 * @var int
+	 */
+	const row=4;
+	/**
+	 * Error on a SELECT statement
+	 * @var int
+	 */
+	const select=8;
+	/**
+	 * Error on an UPDATE statement
+	 * @var int
+	 */
+	const update=16;
+	/**
+	 * Error on an INSERT statement
+	 * @var int
+	 */
+	const insert=32;
+	/**
+	 * Error on a DELETE statement
+	 * @var int
+	 */
+	const delete=64;
+	/**
+	 * Error on a table operation
+	 * @var int
+	 */
+	const table=128;
+	/**
+	 * Error on a SHOW statement
+	 * @var int
+	 */
+	const show=156;
+	/**
+	 * Error on an ALTER statement
+	 * @var int
+	 */
+	const alter=512;
+	/**
+	 * Error on a CREATE statement
+	 * @var int
+	 */
+	const create=1024;
+	/**
+	 * Error on a DROP statement
+	 * @var int
+	 */
+	const drop=2048;
+	/**
+	 * The table on which the error occurs
+	 * @var string
+	 */
+	protected $table='';
+	/**
+	 * Throw a database-related error
+	 * @param string $table The table on which the error occured
+	 * @param int $code Explanation of the error by using class constants
+	 * @param Exception $previous The previous exception
+	 */
+	function __construct($table='' ,$code=0, Exception $previous=NULL) {
+		$this->table=$table;
+		$this->code=$code;
+		parent::__construct('Database failed on '.$this->table,$code,$previous);
+	}
+	/**
+	 * Get the table on which the exception occured
+	 * @return string Table name
+	 */
+	final function getTable() {
+		return $this->table;
+	}
+	/**
+	 * Get the type of the failure, the error codes are converted to a single string
+	 * @return string String representation of the exact exception that occured
+	 */
+	final function getFailureType() {
+		$errors='';
+		if($this->code==self::unknown) {
+			return 'UNKNOWN';
+		}
+		if($this->code&self::connect) {
+			$errors.='connect>';
+		}
+		if($this->code&self::query) {
+			$errors.='query>';
+		}
+		if($this->code&self::row) {
+			$errors.='row:';
+		}
+		if($this->code&self::select) {
+			$errors.='select,';
+		}
+		if($this->code&self::update) {
+			$errors.='update,';
+		}
+		if($this->code&self::insert) {
+			$errors.='insert,';
+		}
+		if($this->code&self::delete) {
+			$errors.='delete,';
+		}
+		if($this->code&self::table) {
+			$errors.='table:';
+		}
+		if($this->code&self::show) {
+			$errors.='show,';
+		}
+		if($this->code&self::alter) {
+			$errors.='alter,';
+		}
+		if($this->code&self::create) {
+			$errors.='create,';
+		}
+		if($this->code&self::drop) {
+			$errors.='drop,';
+		}
+		return substr($errors,0,-1);
+	}
+}
\ No newline at end of file

=== added file 'inc/exceptions/exceptions.php'
--- inc/exceptions/exceptions.php	1970-01-01 00:00:00 +0000
+++ inc/exceptions/exceptions.php	2011-10-19 19:44:25 +0000
@@ -0,0 +1,6 @@
+<?php
+/**
+ * A list of exceptions used by RemoteCP
+ * @package exceptions
+ */
+require 'database.php';

=== added file 'inc/exceptions/handler.php'
--- inc/exceptions/handler.php	1970-01-01 00:00:00 +0000
+++ inc/exceptions/handler.php	2011-10-19 19:44:25 +0000
@@ -0,0 +1,11 @@
+<?php
+function default_exception_handler($e,$type) {
+	header('HTTP/1.1 500 Internal Server Error');
+	$es=$type.': <i>'.get_class($e).'</i>: <b>'.$e->getMessage().'</b> in <b>'.$e->getFile().'</b> on </b>'.$e->getLine().'</b>';
+	if(defined('__DEBUG__')&&__DEBUG__) {
+		$es.='<hr>Trace:<br><pre>';
+		$es.=$e->getTraceAsString();
+		$es.='</pre>';
+	}
+	echo '<h1>Internal Server Error</h1>'.$es;
+}
\ No newline at end of file

=== modified file 'inc/rdb/auth.php'
--- inc/rdb/auth.php	2011-09-02 16:38:47 +0000
+++ inc/rdb/auth.php	2011-10-19 19:44:25 +0000
@@ -39,9 +39,6 @@
 		else {
 			$remote_connection=@new MySQLi($rdbauth['host'],$rdbauth['user'],$rdbauth['password'],$rdbauth['database']);
 		}
-		if(!@$remote_connection->ping()) {
-			trigger_error('Could not connect to the remote database',E_USER_ERROR);
-		}
 		return $remote_connection;
 	}
 }

=== modified file 'inc/rdb/db_info.php'
--- inc/rdb/db_info.php	2011-09-26 17:38:10 +0000
+++ inc/rdb/db_info.php	2011-10-19 19:44:25 +0000
@@ -3,6 +3,7 @@
 	static private $info=array();
 	static function init() {
 		global $remote_connection;
+		if(!@$remote_connection->ping()) throw new DatabaseException('Remote database is down',DatabaseException::connect);
 		$q=$remote_connection->query('SELECT * FROM `_system_`');
 		while($r=$q->fetch_array()) {
 			self::$info[$r[0]]=$r[1];

=== modified file 'inc/rdb/rdb.php'
--- inc/rdb/rdb.php	2011-09-26 16:13:19 +0000
+++ inc/rdb/rdb.php	2011-10-19 19:44:25 +0000
@@ -5,10 +5,11 @@
 */
 require_once('inc/rdb/auth.php');
 if(!rdb_auth::$exists) {
-	trigger_error('Remote database does not exist',E_USER_ERROR);
+	throw new DatabaseException('Remote database does not exist',DatabaseException::connect);
 }
 else {
 	$remote_connection=rdb_auth::connect();
+	if(!@$remote_connection->ping()) throw new DatabaseException('Remote database is not accessible',DatabaseException::connect);
 }
 require_once 'inc/rdb/db_info.php';
 ?>
\ No newline at end of file

=== modified file 'remote_panel.php'
--- remote_panel.php	2011-10-18 18:14:57 +0000
+++ remote_panel.php	2011-10-19 19:44:25 +0000
@@ -6,9 +6,20 @@
  * This file is called from the webbrowser when using RemoteCP to connect to a remote database.
  */ 
 require('inc/controllers.php');
+try {
 require_once('inc/rdb/rdb.php');
 require_once('inc/groups/groups.php');
 require_once('inc/accountlevels.php');
+}
+catch(DatabaseException $e) {
+	if($e->getCode()==DatabaseException::connect) {
+		define('REMOTEDB_DOWN',true);
+	}	
+	else {
+		default_exception_handler($e, 'DatabaseException');
+		exit;
+	}
+}
 $t->addFile(__FILE__);
 //Basic HTML start
 ?>

=== modified file 'system_remote/database.php'
--- system_remote/database.php	2011-09-26 16:13:19 +0000
+++ system_remote/database.php	2011-10-19 19:44:25 +0000
@@ -54,7 +54,7 @@
 	</fieldset>
 	<fieldset>
 		<legend><?php echo $t->_('Information')?></legend>
-		<?php echo $t->_('Filesystem'); ?>: <?php echo rdb_info::getInfo('fs'); ?>
+		<?php echo $t->_('Filesystem'); ?>: <?php if(defined('REMOTEDB_DOWN')&&REMOTEDB_DOWN) echo $t->_('Remote database is down'); else echo rdb_info::getInfo('fs'); ?>
 	</fieldset>
 	<fieldset>
 		<legend><?php echo $t->_('Delete database'); ?></legend>

=== modified file 'system_remote/desktop.php'
--- system_remote/desktop.php	2011-06-28 16:13:01 +0000
+++ system_remote/desktop.php	2011-10-19 19:44:25 +0000
@@ -4,7 +4,7 @@
 <AJAX_SCRIPTEVAL>NULL</AJAX_SCRIPTEVAL>
 < HEADERS -->
 <?php if(rdb_auth::$level==9) {
-	?>| <a onclick="openLoc('<?php echo $t->_('Administration'); ?>','?control=admin','admin');"><?php echo $t->_('Administration'); ?></a> |<?php } ?>| <a onclick="openLoc('<?php echo $t->_('Groups'); ?>','?control=groups','groups');"><?php echo $t->_('Groups'); ?></a> |
+	?>| <a onclick="openLoc('<?php echo $t->_('Administration'); ?>','?control=admin','admin');"><?php echo $t->_('Administration'); ?></a> |<?php } if(defined('REMOTEDB_DOWN')&&REMOTEDB_DOWN) {die('<hr>'.$t->_('Remote database is not available'));} ?>| <a onclick="openLoc('<?php echo $t->_('Groups'); ?>','?control=groups','groups');"><?php echo $t->_('Groups'); ?></a> |
 <hr><?php
 	$q=$remote_connection->query('SELECT * FROM `sites` WHERE `user`="'.session::$guid.'"');
 	while($sites=$q->fetch_assoc()) { ?>| <a onclick="openLoc('<?php echo getSiteInfo($sites['ref'],'SITE_TITLE'); ?>','?control=addons&site=<?php echo $sites['ref']; ?>','<?php echo $sites['ref']; ?>_ctrls_main');"><?php echo getSiteInfo($sites['ref'],'SITE_TITLE'); ?></a> |<?php }