db_mysql.inc.php 37.4 KB
Newer Older
tbrehm's avatar
tbrehm committed
1
<?php
2 3 4 5 6 7 8 9
/*
 * db_mysql.inc.php:  ISPConfig mysql db interface
 *
 * Note!  When making changes to this file, put a copy in both locations:
 *   interface/lib/classes/db_mysql.inc.php
 *      server/lib/classes/db_mysql.inc.php
 */

tbrehm's avatar
tbrehm committed
10
/*
11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37
   Copyright (c) 2005, Till Brehm, projektfarm Gmbh
   All rights reserved.

   Redistribution and use in source and binary forms, with or without modification,
   are permitted provided that the following conditions are met:

 * Redistributions of source code must retain the above copyright notice,
 this list of conditions and the following disclaimer.
 * Redistributions in binary form must reproduce the above copyright notice,
 this list of conditions and the following disclaimer in the documentation
 and/or other materials provided with the distribution.
 * Neither the name of ISPConfig nor the names of its contributors
 may be used to endorse or promote products derived from this software without
 specific prior written permission.

 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

38
class db
39
{
40 41 42 43 44 45 46
	/**#@+
     * @access private
     */
	private $_iQueryId;
	private $_iConnId;

	private $dbHost = '';  // hostname of the MySQL server
47
	private $dbPort = '';  // port of the MySQL server
48 49 50 51 52
	private $dbName = '';  // logical database name on that server
	private $dbUser = '';  // database authorized user
	private $dbPass = '';  // user's password
	private $dbCharset = 'utf8';// Database charset
	private $dbClientFlags = 0; // MySQL Client falgs
53 54
	/**#@-*/

55
	public $show_error_messages = false; // false in server, interface sets true when generating templates
56 57

	/* old things - unused now ////
58 59 60 61 62
	private $linkId = 0;  // last result of mysqli_connect()
	private $queryId = 0;  // last result of mysqli_query()
	private $record = array(); // last record fetched
	private $autoCommit = 1;    // Autocommit Transactions
	private $currentRow;  // current row number
Marius Cramer's avatar
Marius Cramer committed
63
	*/
64
	public $errorNumber = 0; // last error number
65
	public $errorMessage = ''; // last error message
Marius Cramer's avatar
Marius Cramer committed
66
	/*
67 68
	private $errorLocation = '';// last error location
	private $isConnected = false; // needed to know if we have a valid mysqli object from the constructor
69 70
	////
	*/
71 72

	// constructor
73
	public function __construct($host = NULL , $user = NULL, $pass = NULL, $database = NULL, $port = NULL, $flags = NULL) {
74 75
		global $app, $conf;

76 77 78 79 80 81
		$this->dbHost = $host ? $host  : $conf['db_host'];
		$this->dbPort = $port ? $port : $conf['db_port'];
		$this->dbName = $database ? $database : $conf['db_database'];
		$this->dbUser = $user ? $user : $conf['db_user'];
		$this->dbPass = $pass ? $pass : $conf['db_password'];
		$this->dbCharset = $conf['db_charset'];
82
		$this->dbClientFlags = ($flags !== NULL) ? $flags : $conf['db_client_flags'];
83
		$this->_iConnId = mysqli_init();
84

85
		mysqli_real_connect($this->_iConnId, $this->dbHost, $this->dbUser, $this->dbPass, '', (int)$this->dbPort, NULL, $this->dbClientFlags);
86
		for($try=0;(!is_object($this->_iConnId) || mysqli_connect_errno()) && $try < 5;++$try) {
87
			sleep($try);
88 89 90
			if(!is_object($this->_iConnId)) {
				$this->_iConnId = mysqli_init();
			}
91 92 93
			if(!mysqli_real_connect($this->_iConnId, $this->dbHost, $this->dbUser, $this->dbPass, '', (int)$this->dbPort, NULL, $this->dbClientFlags)) {
				$this->_sqlerror('Database connection failed');
			}
94
		}
95

96
		if(!is_object($this->_iConnId) || mysqli_connect_errno()) {
97
			$this->_iConnId = null;
98 99
			$this->_sqlerror('Zugriff auf Datenbankserver fehlgeschlagen! / Database server not accessible!', '', true); // sets errorMessage
			throw new Exception($this->errorMessage);
100
		}
101
		if(!((bool)mysqli_query( $this->_iConnId, 'USE `' . $this->dbName . '`'))) {
102
			$this->close();
103 104
			$this->_sqlerror('Datenbank nicht gefunden / Database not found', '', true); // sets errorMessage
			throw new Exception($this->errorMessage);
105
		}
106

107
		$this->_setCharset();
108 109 110
	}

	public function __destruct() {
111 112 113 114 115 116
		if($this->_iConnId) mysqli_close($this->_iConnId);
	}

	public function close() {
		if($this->_iConnId) mysqli_close($this->_iConnId);
		$this->_iConnId = null;
117 118
	}

119 120 121 122 123 124 125 126 127 128 129 130
	/*
	 * Test mysql connection.
	 *
	 * @return boolean returns true if db connection is good.
	 */
	public function testConnection() {
		if(mysqli_connect_errno()) {
			return false;
		}
		return (boolean)(is_object($this->_iConnId) && mysqli_ping($this->_iConnId));
	}

131 132 133 134 135
	/* This allows our private variables to be "read" out side of the class */
	public function __get($var) {
		return isset($this->$var) ? $this->$var : NULL;
	}

136 137 138 139
	public function _build_query_string($sQuery = '') {
		$iArgs = func_num_args();
		if($iArgs > 1) {
			$aArgs = func_get_args();
140

141 142 143 144 145 146 147 148 149 150 151 152 153 154
			if($iArgs == 3 && $aArgs[1] === true && is_array($aArgs[2])) {
				$aArgs = $aArgs[2];
				$iArgs = count($aArgs);
			} else {
				array_shift($aArgs); // delete the query string that is the first arg!
			}

			$iPos = 0;
			$iPos2 = 0;
			foreach($aArgs as $sKey => $sValue) {
				$iPos2 = strpos($sQuery, '??', $iPos2);
				$iPos = strpos($sQuery, '?', $iPos);

				if($iPos === false && $iPos2 === false) break;
155

156 157 158
				if($iPos2 !== false && ($iPos === false || $iPos2 <= $iPos)) {
					$sTxt = $this->escape($sValue);

159
					$sTxt = str_replace('`', '', $sTxt);
160 161 162 163
					if(strpos($sTxt, '.') !== false) {
						$sTxt = preg_replace('/^(.+)\.(.+)$/', '`$1`.`$2`', $sTxt);
						$sTxt = str_replace('.`*`', '.*', $sTxt);
					} else $sTxt = '`' . $sTxt . '`';
164 165 166 167

					$sQuery = substr_replace($sQuery, $sTxt, $iPos2, 2);
					$iPos2 += strlen($sTxt);
					$iPos = $iPos2;
168
				} else {
169 170
					if(is_int($sValue) || is_float($sValue)) {
						$sTxt = $sValue;
171
					} elseif(is_null($sValue) || (is_string($sValue) && (strcmp($sValue, '#NULL#') == 0))) {
172 173
						$sTxt = 'NULL';
					} elseif(is_array($sValue)) {
174 175 176 177 178 179 180 181
						if(isset($sValue['SQL'])) {
							$sTxt = $sValue['SQL'];
						} else {
							$sTxt = '';
							foreach($sValue as $sVal) $sTxt .= ',\'' . $this->escape($sVal) . '\'';
							$sTxt = '(' . substr($sTxt, 1) . ')';
							if($sTxt == '()') $sTxt = '(0)';
						}
182 183 184 185 186 187 188 189
					} else {
						$sTxt = '\'' . $this->escape($sValue) . '\'';
					}

					$sQuery = substr_replace($sQuery, $sTxt, $iPos, 1);
					$iPos += strlen($sTxt);
					$iPos2 = $iPos;
				}
190 191
			}
		}
192 193

		return $sQuery;
194 195
	}

196 197 198 199
	/**#@-*/


	/**#@+
200 201
	 * @access private
	 */
202
	private function _setCharset() {
203 204
		$this->query('SET NAMES '.$this->dbCharset);
		$this->query("SET character_set_results = '".$this->dbCharset."', character_set_client = '".$this->dbCharset."', character_set_connection = '".$this->dbCharset."', character_set_database = '".$this->dbCharset."', character_set_server = '".$this->dbCharset."'");
205
	}
206

Jesse Norell's avatar
Jesse Norell committed
207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258
	private function securityScan($string) {
		global $app, $conf;

		// get security config
		if(isset($app)) {
			$app->uses('getconf');
			$ids_config = $app->getconf->get_security_config('ids');

			if($ids_config['sql_scan_enabled'] == 'yes') {

				// Remove whitespace
				$string = trim($string);
				if(substr($string,-1) == ';') $string = substr($string,0,-1);

				// Save original string
				$string_orig = $string;

				//echo $string;
				$chars = array(';', '#', '/*', '*/', '--', '\\\'', '\\"');

				$string = str_replace('\\\\', '', $string);
				$string = preg_replace('/(^|[^\\\])([\'"])\\2/is', '$1', $string);
				$string = preg_replace('/(^|[^\\\])([\'"])(.*?[^\\\])\\2/is', '$1', $string);
				$ok = true;

				if(substr_count($string, "`") % 2 != 0 || substr_count($string, "'") % 2 != 0 || substr_count($string, '"') % 2 != 0) {
					$app->log("SQL injection warning (" . $string_orig . ")",2);
					$ok = false;
				} else {
					foreach($chars as $char) {
						if(strpos($string, $char) !== false) {
							$ok = false;
							$app->log("SQL injection warning (" . $string_orig . ")",2);
							break;
						}
					}
				}
				if($ok == true) {
					return true;
				} else {
					if($ids_config['sql_scan_action'] == 'warn') {
						// we return false in warning level.
						return false;
					} else {
						// if sql action = 'block' or anything else then stop here.
						$app->error('Possible SQL injection. All actions have been logged.');
					}
				}
			}
		}
	}

259 260 261 262 263 264 265 266
	private function _query($sQuery = '') {
		global $app;

		if ($sQuery == '') {
			$this->_sqlerror('Keine Anfrage angegeben / No query given');
			return false;
		}

267 268 269
		$try = 0;
		do {
			$try++;
270
			$ok = (is_object($this->_iConnId)) ? mysqli_ping($this->_iConnId) : false;
271
			if(!$ok) {
272 273 274 275 276
				if(!is_object($this->_iConnId)) {
					$this->_iConnId = mysqli_init();
				}
				if(!mysqli_real_connect($this->_isConnId, $this->dbHost, $this->dbUser, $this->dbPass, $this->dbName, (int)$this->dbPort, NULL, $this->dbClientFlags)) {
					if(mysqli_connect_errno() == '111') {
277 278 279 280 281 282 283 284 285 286
						// server is not available
						if($try > 9) {
							if(isset($app) && isset($app->forceErrorExit)) {
								$app->forceErrorExit('Database connection failure!');
							}
							// if we reach this, the app object is missing or has no exit method, so we continue as normal
						}
						sleep(30); // additional seconds, please!
					}

287
					if($try > 9) {
288
						$this->_sqlerror('db::_query -> reconnect', '', true);
289 290 291 292 293
						return false;
					} else {
						sleep(($try > 7 ? 5 : 1));
					}
				} else {
294
					$this->_setCharset();
295 296 297 298
					$ok = true;
				}
			}
		} while($ok == false);
299 300 301

		$aArgs = func_get_args();
		$sQuery = call_user_func_array(array(&$this, '_build_query_string'), $aArgs);
Jesse Norell's avatar
Jesse Norell committed
302
		$this->securityScan($sQuery);
303 304
		$this->_iQueryId = mysqli_query($this->_iConnId, $sQuery);
		if (!$this->_iQueryId) {
305
			$this->_sqlerror('Falsche Anfrage / Wrong Query', 'SQL-Query = ' . $sQuery);
306 307
			return false;
		}
308 309

		return is_bool($this->_iQueryId) ? $this->_iQueryId : new db_result($this->_iQueryId, $this->_iConnId);
310
	}
311

312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355
	/**#@-*/





	/**
	 * Executes a query
	 *
	 * Executes a given query string, has a variable amount of parameters:
	 * - 1 parameter
	 *   executes the given query
	 * - 2 parameters
	 *   executes the given query, replaces the first ? in the query with the second parameter
	 * - 3 parameters
	 *   if the 2nd parameter is a boolean true, the 3rd parameter has to be an array containing all the replacements for every occuring ? in the query, otherwise the second parameter replaces the first ?, the third parameter replaces the second ? in the query
	 * - 4 or more parameters
	 *   all ? in the query are replaced from left to right by the parameters 2 to x
	 *
	 * @access public
	 * @param string  $sQuery query string
	 * @param mixed   ... one or more parameters
	 * @return db_result the result object of the query
	 */


	public function query($sQuery = '') {
		$aArgs = func_get_args();
		return call_user_func_array(array(&$this, '_query'), $aArgs);
	}

	/**
	 * Execute a query and get first result array
	 *
	 * Executes a query and returns the first result row as an array
	 * This is like calling $result = $db->query(),  $result->get(), $result->free()
	 * Use of this function @see query
	 *
	 * @access public
	 * @param string  $sQuery query to execute
	 * @param ...     further params (see query())
	 * @return array result row or NULL if none found
	 */
	public function queryOneRecord($sQuery = '') {
356
		if(!preg_match('/limit \d+\s*(,\s*\d+)?$/i', $sQuery)) $sQuery .= ' LIMIT 0,1';
357 358 359 360 361 362 363 364 365 366 367 368

		$aArgs = func_get_args();
		$oResult = call_user_func_array(array(&$this, 'query'), $aArgs);
		if(!$oResult) return null;

		$aReturn = $oResult->get();
		$oResult->free();

		return $aReturn;
	}

	public function queryOne($sQuery = '') {
369
		return call_user_func_array(array(&$this, 'queryOneRecord'), func_get_args());
370 371 372
	}

	public function query_one($sQuery = '') {
373
		return call_user_func_array(array(&$this, 'queryOneRecord'), func_get_args());
374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394
	}

	/**
	 * Execute a query and return all rows
	 *
	 * Executes a query and returns all result rows in an array
	 * <strong>Use this with extreme care!!!</strong> Uses lots of memory on big result sets.
	 *
	 * @access public
	 * @param string  $sQuery query to execute
	 * @param ...     further params (see query())
	 * @return array all the rows in the result set
	 */
	public function queryAllRecords($sQuery = '') {
		$aArgs = func_get_args();
		$oResult = call_user_func_array(array(&$this, 'query'), $aArgs);
		if(!$oResult) return array();

		$aResults = array();
		while($aRow = $oResult->get()) {
			$aResults[] = $aRow;
395
		}
396 397 398
		$oResult->free();

		return $aResults;
399
	}
400

401
	public function queryAll($sQuery = '') {
402
		return call_user_func_array(array(&$this, 'queryAllRecords'), func_get_args());
403 404 405
	}

	public function query_all($sQuery = '') {
406
		return call_user_func_array(array(&$this, 'queryAllRecords'), func_get_args());
407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427
	}

	/**
	 * Execute a query and return all rows as simple array
	 *
	 * Executes a query and returns all result rows in an array with elements
	 * <strong>Only first column is returned</strong> Uses lots of memory on big result sets.
	 *
	 * @access public
	 * @param string  $sQuery query to execute
	 * @param ...     further params (see query())
	 * @return array all the rows in the result set
	 */
	public function queryAllArray($sQuery = '') {
		$aArgs = func_get_args();
		$oResult = call_user_func_array(array(&$this, 'query'), $aArgs);
		if(!$oResult) return array();

		$aResults = array();
		while($aRow = $oResult->get()) {
			$aResults[] = reset($aRow);
428
		}
429 430 431
		$oResult->free();

		return $aResults;
432
	}
433

434
	public function query_all_array($sQuery = '') {
435
		return call_user_func_array(array(&$this, 'queryAllArray'), func_get_args());
436 437 438 439 440 441 442 443 444 445 446 447 448
	}



	/**
	 * Get id of last inserted row
	 *
	 * Gives you the id of the last inserted row in a table with an auto-increment primary key
	 *
	 * @access public
	 * @return int id of last inserted row or 0 if none
	 */
	public function insert_id() {
449 450 451 452 453 454 455 456
		$oResult = $this->query('SELECT LAST_INSERT_ID() as `newid`');
		if(!$oResult) {
			$this->_sqlerror('Unable to select last_insert_id()');
			return false;
		}
		$aReturn = $oResult->get();
		$oResult->free();
		return isset($aReturn['newid']) ? $aReturn['newid'] : 0;
457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477
	}



	/**
	 * get affected row count
	 *
	 * Gets the amount of rows affected by the previous query
	 *
	 * @access public
	 * @return int affected rows
	 */
	public function affected() {
		if(!is_object($this->_iConnId)) return 0;
		$iRows = mysqli_affected_rows($this->_iConnId);
		if(!$iRows) $iRows = 0;
		return $iRows;
	}



478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506
	/**
	 * check if a utf8 string is valid
	 *
	 * @access public
	 * @param string  $string the string to check
	 * @return bool true if it is valid utf8, false otherwise
	 */
	private function check_utf8($str) {
		$len = strlen($str);
		for($i = 0; $i < $len; $i++){
			$c = ord($str[$i]);
			if ($c > 128) {
				if (($c > 247)) return false;
				elseif ($c > 239) $bytes = 4;
				elseif ($c > 223) $bytes = 3;
				elseif ($c > 191) $bytes = 2;
				else return false;
				if (($i + $bytes) > $len) return false;
				while ($bytes > 1) {
					$i++;
					$b = ord($str[$i]);
					if ($b < 128 || $b > 191) return false;
					$bytes--;
				}
			}
		}
		return true;
	} // end of check_utf8

507 508 509 510 511 512 513 514 515 516 517
	/**
	 * Escape a string for usage in a query
	 *
	 * @access public
	 * @param string  $sString query string to escape
	 * @return string escaped string
	 */
	public function escape($sString) {
		global $app;
		if(!is_string($sString) && !is_numeric($sString)) {
			$app->log('NON-String given in escape function! (' . gettype($sString) . ')', LOGLEVEL_INFO);
518
			//$sAddMsg = getDebugBacktrace();
519 520
			$app->log($sAddMsg, LOGLEVEL_DEBUG);
			$sString = '';
521
		}
522

523
		$cur_encoding = mb_detect_encoding($sString);
524 525
		if($cur_encoding != "UTF-8") {
			if($cur_encoding != 'ASCII') {
Marius Cramer's avatar
Marius Cramer committed
526
				if(is_object($app) && method_exists($app, 'log')) $app->log('String ' . substr($sString, 0, 25) . '... is ' . $cur_encoding . '.', LOGLEVEL_INFO);
527 528 529
				if($cur_encoding) $sString = mb_convert_encoding($sString, 'UTF-8', $cur_encoding);
				else $sString = mb_convert_encoding($sString, 'UTF-8');
			}
530
		} elseif(!$this->check_utf8($sString)) {
531
			$sString = utf8_encode($sString);
532
		}
533 534 535

		if($this->_iConnId) return mysqli_real_escape_string($this->_iConnId, $sString);
		else return addslashes($sString);
536 537
	}

538 539 540 541 542
	/**
	 *
	 *
	 * @access private
	 */
543
	private function _sqlerror($sErrormsg = 'Unbekannter Fehler', $sAddMsg = '', $bNoLog = false) {
544 545
		global $app, $conf;

546 547 548 549 550 551 552
		$mysql_errno = mysqli_connect_errno();
		$mysql_error = mysqli_connect_error();
		if ($mysql_errno === 0 && is_object($this->_iConnId)) {
			$mysql_errno = mysqli_errno($this->_iConnId);
			$mysql_error = mysqli_error($this->_iConnId);
		}
		$this->errorNumber = $mysql_error;
Marius Cramer's avatar
Marius Cramer committed
553
		$this->errorMessage = $mysql_error;
554

555
		//$sAddMsg .= getDebugBacktrace();
556

557
		if($this->show_error_messages && $conf['demo_mode'] === false) {
558
			echo $sErrormsg . $sAddMsg;
559
		} elseif(is_object($app) && method_exists($app, 'log') && $bNoLog == false) {
560
			$app->log($sErrormsg . $sAddMsg . ' -> ' . $mysql_errno . ' (' . $mysql_error . ')', LOGLEVEL_WARN, false);
561 562 563
		} elseif(php_sapi_name() == 'cli') {
			echo $sErrormsg . $sAddMsg;
		}
564 565 566
	}

	public function affectedRows() {
567
		return $this->affected();
568 569 570 571
	}

	// returns mySQL insert id
	public function insertID() {
572
		return $this->insert_id();
573 574 575
	}


576
	//* Function to quote strings
577
	public function quote($formfield) {
578
		return $this->escape($formfield);
579 580
	}

581
	//* Function to unquotae strings
582 583 584 585 586 587 588 589 590 591 592 593 594 595
	public function unquote($formfield) {
		return stripslashes($formfield);
	}

	public function toLower($record) {
		if(is_array($record)) {
			foreach($record as $key => $val) {
				$key = strtolower($key);
				$out[$key] = $val;
			}
		}
		return $out;
	}

Jesse Norell's avatar
Jesse Norell committed
596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615
	public function insertFromArray($tablename, $data) {
		if(!is_array($data)) return false;

		$k_query = '';
		$v_query = '';

		$params = array($tablename);
		$v_params = array();

		foreach($data as $key => $value) {
			$k_query .= ($k_query != '' ? ', ' : '') . '??';
			$v_query .= ($v_query != '' ? ', ' : '') . '?';
			$params[] = $key;
			$v_params[] = $value;
		}

		$query = 'INSERT INTO ?? (' . $k_query . ') VALUES (' . $v_query . ')';
		return $this->query($query, true, array_merge($params, $v_params));
	}

616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656
	public function diffrec($record_old, $record_new) {
		$diffrec_full = array();
		$diff_num = 0;

		if(is_array($record_old) && count($record_old) > 0) {
			foreach($record_old as $key => $val) {
				// if(!isset($record_new[$key]) || $record_new[$key] != $val) {
				if(@$record_new[$key] != $val) {
					// Record has changed
					$diffrec_full['old'][$key] = $val;
					$diffrec_full['new'][$key] = @$record_new[$key];
					$diff_num++;
				} else {
					$diffrec_full['old'][$key] = $val;
					$diffrec_full['new'][$key] = $val;
				}
			}
		} elseif(is_array($record_new)) {
			foreach($record_new as $key => $val) {
				if(isset($record_new[$key]) && @$record_old[$key] != $val) {
					// Record has changed
					$diffrec_full['new'][$key] = $val;
					$diffrec_full['old'][$key] = @$record_old[$key];
					$diff_num++;
				} else {
					$diffrec_full['new'][$key] = $val;
					$diffrec_full['old'][$key] = $val;
				}
			}
		}

		return array('diff_num' => $diff_num, 'diff_rec' => $diffrec_full);

	}

	/**
	 * Function to get the database-size
	 * @param string $database_name
	 * @return int - database-size in bytes
	 */
	public function getDatabaseSize($database_name) {
Jesse Norell's avatar
Jesse Norell committed
657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672
		global $app, $conf;
		static $db=null;

		if ( ! $db ) {
			$clientdb_host     = ($conf['db_host']) ? $conf['db_host'] : NULL;
			$clientdb_user     = ($conf['db_user']) ? $conf['db_user'] : NULL;
			$clientdb_password = ($conf['db_password']) ? $conf['db_password'] : NULL;
			$clientdb_port     = ((int)$conf['db_port']) ? (int)$conf['db_port'] : NULL;
			$clientdb_flags    = ($conf['db_flags'] !== NULL) ? $conf['db_flags'] : NULL;

			require_once 'lib/mysql_clientdb.conf';

			$db = new db($clientdb_host, $clientdb_user, $clientdb_password, NULL, $clientdb_port, $clientdb_flags);
		}

		$result = $db->_query("SELECT SUM(data_length+index_length) FROM information_schema.TABLES WHERE table_schema='".$db->escape($database_name)."'");
673
		if(!$result) {
Jesse Norell's avatar
Jesse Norell committed
674
			$db->_sqlerror('Unable to determine the size of database ' . $database_name);
675 676
			return;
		}
677 678
		$database_size = $result->getAsRow();
		$result->free();
Jesse Norell's avatar
Jesse Norell committed
679
		return $database_size[0] ? $database_size[0] : 0;
680 681 682 683
	}

	//** Function to fill the datalog with a full differential record.
	public function datalogSave($db_table, $action, $primary_field, $primary_id, $record_old, $record_new, $force_update = false) {
Jesse Norell's avatar
Jesse Norell committed
684
		global $app;
685 686 687 688 689 690 691

		// Insert backticks only for incomplete table names.
		if(stristr($db_table, '.')) {
			$escape = '';
		} else {
			$escape = '`';
		}
692

693 694
		if($force_update == true) {
			//* We force a update even if no record has changed
695
			$diffrec_full = array('new' => $record_new, 'old' => $record_old);
696 697 698 699 700 701 702 703
			$diff_num = count($record_new);
		} else {
			//* get the difference record between old and new record
			$tmp = $this->diffrec($record_old, $record_new);
			$diffrec_full = $tmp['diff_rec'];
			$diff_num = $tmp['diff_num'];
			unset($tmp);
		}
704

705 706 707
		// Insert the server_id, if the record has a server_id
		$server_id = (isset($record_old['server_id']) && $record_old['server_id'] > 0)?$record_old['server_id']:0;
		if(isset($record_new['server_id'])) $server_id = $record_new['server_id'];
708 709


710
		if($diff_num > 0) {
711
			$diffstr = serialize($diffrec_full);
712
			if(isset($_SESSION)) {
713
				$username = $_SESSION['s']['user']['username'];
714 715 716 717 718 719 720 721
			} else {
				$username = 'admin';
			}
			$dbidx = $primary_field.':'.$primary_id;

			if($action == 'INSERT') $action = 'i';
			if($action == 'UPDATE') $action = 'u';
			if($action == 'DELETE') $action = 'd';
722 723
			$sql = "INSERT INTO sys_datalog (dbtable,dbidx,server_id,action,tstamp,user,data) VALUES (?, ?, ?, ?, ?, ?, ?)";
			$app->db->query($sql, $db_table, $dbidx, $server_id, $action, time(), $username, $diffstr);
724 725
		}

726
		return true;
727
	}
728

729 730 731
	//** Inserts a record and saves the changes into the datalog
	public function datalogInsert($tablename, $insert_data, $index_field) {
		global $app;
732

733 734 735 736
		// Check fields
		if(!preg_match('/^[a-zA-Z0-9\-\_\.]{1,64}$/',$tablename)) $app->error('Invalid table name '.$tablename);
		if(!preg_match('/^[a-zA-Z0-9\-\_]{1,64}$/',$index_field)) $app->error('Invalid index field '.$index_field.' in table '.$tablename);

737
		if(is_array($insert_data)) {
738 739
			$key_str = '';
			$val_str = '';
740 741
			$params = array($tablename);
			$v_params = array();
742
			foreach($insert_data as $key => $val) {
743
				$key_str .= '??,';
744 745 746 747
				$params[] = $key;
				
				$val_str .= '?,';
				$v_params[] = $val;
748
			}
749 750
			$key_str = substr($key_str, 0, -1);
			$val_str = substr($val_str, 0, -1);
751
			$insert_data_str = '('.$key_str.') VALUES ('.$val_str.')';
752
			$this->query("INSERT INTO ?? $insert_data_str", true, array_merge($params, $v_params));
753
		} else {
754
			/* TODO: deprecate this method! */
755
			$insert_data_str = $insert_data;
756
			$this->query("INSERT INTO ?? $insert_data_str", $tablename);
757
			$app->log("deprecated use of passing values to datalogInsert() - table " . $tablename, 1);
758
		}
759
		
760 761
		$old_rec = array();
		$index_value = $this->insertID();
762
		$new_rec = $this->queryOneRecord("SELECT * FROM ?? WHERE ?? = ?", $tablename, $index_field, $index_value);
763
		$this->datalogSave($tablename, 'INSERT', $index_field, $index_value, $old_rec, $new_rec);
764

765 766
		return $index_value;
	}
767

768 769
	//** Updates a record and saves the changes into the datalog
	public function datalogUpdate($tablename, $update_data, $index_field, $index_value, $force_update = false) {
770
		global $app;
771

772 773 774 775
		// Check fields
		if(!preg_match('/^[a-zA-Z0-9\-\_\.]{1,64}$/',$tablename)) $app->error('Invalid table name '.$tablename);
		if(!preg_match('/^[a-zA-Z0-9\-\_]{1,64}$/',$index_field)) $app->error('Invalid index field '.$index_field.' in table '.$tablename);

776
		$old_rec = $this->queryOneRecord("SELECT * FROM ?? WHERE ?? = ?", $tablename, $index_field, $index_value);
777 778

		if(is_array($update_data)) {
779
			$params = array($tablename);
780 781
			$update_data_str = '';
			foreach($update_data as $key => $val) {
782 783 784
				$update_data_str .= '?? = ?,';
				$params[] = $key;
				$params[] = $val;
785
			}
786 787
			$params[] = $index_field;
			$params[] = $index_value;
788
			$update_data_str = substr($update_data_str, 0, -1);
789
			$this->query("UPDATE ?? SET $update_data_str WHERE ?? = ?", true, $params);
790
		} else {
791
			/* TODO: deprecate this method! */
792
			$update_data_str = $update_data;
793
			$this->query("UPDATE ?? SET $update_data_str WHERE ?? = ?", $tablename, $index_field, $index_value);
794
			$app->log("deprecated use of passing values to datalogUpdate() - table " . $tablename, 1);
795
		}
796

797
		$new_rec = $this->queryOneRecord("SELECT * FROM ?? WHERE ?? = ?", $tablename, $index_field, $index_value);
798
		$this->datalogSave($tablename, 'UPDATE', $index_field, $index_value, $old_rec, $new_rec, $force_update);
799

800 801
		return true;
	}
802

803 804 805 806
	//** Deletes a record and saves the changes into the datalog
	public function datalogDelete($tablename, $index_field, $index_value) {
		global $app;

807 808 809 810
		// Check fields
		if(!preg_match('/^[a-zA-Z0-9\-\_\.]{1,64}$/',$tablename)) $app->error('Invalid table name '.$tablename);
		if(!preg_match('/^[a-zA-Z0-9\-\_]{1,64}$/',$index_field)) $app->error('Invalid index field '.$index_field.' in table '.$tablename);

811 812
		$old_rec = $this->queryOneRecord("SELECT * FROM ?? WHERE ?? = ?", $tablename, $index_field, $index_value);
		$this->query("DELETE FROM ?? WHERE ?? = ?", $tablename, $index_field, $index_value);
813 814 815 816 817
		$new_rec = array();
		$this->datalogSave($tablename, 'DELETE', $index_field, $index_value, $old_rec, $new_rec);

		return true;
	}
818

819
	//** Deletes a record and saves the changes into the datalog
820 821
	public function datalogError($errormsg) {
		global $app;
822

823
		if(isset($app->modules->current_datalog_id) && $app->modules->current_datalog_id > 0) $this->query("UPDATE sys_datalog set error = ? WHERE datalog_id = ?", $errormsg, $app->modules->current_datalog_id);
824

825 826
		return true;
	}
827

828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847
	//* get the current datalog status for the specified login (or currently logged in user)
	public function datalogStatus($login = '') {
		global $app;

		$return = array('count' => 0, 'entries' => array());

		if($login == '' && isset($_SESSION['s']['user'])) {
			$login = $_SESSION['s']['user']['username'];
		}

		$result = $this->queryAllRecords("SELECT COUNT( * ) AS cnt, sys_datalog.action, sys_datalog.dbtable FROM sys_datalog, server WHERE server.server_id = sys_datalog.server_id AND sys_datalog.user = ? AND sys_datalog.datalog_id > server.updated GROUP BY sys_datalog.dbtable, sys_datalog.action", $login);
		foreach($result as $row) {
			if(!$row['dbtable'] || in_array($row['dbtable'], array('aps_instances', 'aps_instances_settings', 'mail_access', 'mail_content_filter'))) continue; // ignore some entries, maybe more to come
			$return['entries'][] = array('table' => $row['dbtable'], 'action' => $row['action'], 'count' => $row['cnt'], 'text' => $app->lng('datalog_status_' . $row['action'] . '_' . $row['dbtable'])); $return['count'] += $row['cnt'];
		}
		unset($result);

		return $return;
	}

848

849 850 851 852 853 854 855 856 857
	public function freeResult($query)
	{
		if(is_object($query) && (get_class($query) == "mysqli_result")) {
			$query->free();
			return true;
		} else {
			return false;
		}
	}
858

859
	/*
860 861 862 863 864 865 866 867 868 869 870 871 872
       $columns = array(action =>   add | alter | drop
       name =>     Spaltenname
       name_new => neuer Spaltenname, nur bei 'alter' belegt
       type =>     42go-Meta-Type: int16, int32, int64, double, char, varchar, text, blob
       typeValue => Wert z.B. bei Varchar
       defaultValue =>  Default Wert
       notNull =>   true | false
       autoInc =>   true | false
       option =>   unique | primary | index)


     */

873 874
	public function createTable($table_name, $columns) {
		$index = '';
875
		$sql = "CREATE TABLE ?? (";
876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894
		foreach($columns as $col){
			$sql .= $col['name'].' '.$this->mapType($col['type'], $col['typeValue']).' ';

			if($col['defaultValue'] != '') $sql .= "DEFAULT '".$col['defaultValue']."' ";
			if($col['notNull'] == true) {
				$sql .= 'NOT NULL ';
			} else {
				$sql .= 'NULL ';
			}
			if($col['autoInc'] == true) $sql .= 'auto_increment ';
			$sql.= ',';
			// key Definitionen
			if($col['option'] == 'primary') $index .= 'PRIMARY KEY ('.$col['name'].'),';
			if($col['option'] == 'index') $index .= 'INDEX ('.$col['name'].'),';
			if($col['option'] == 'unique') $index .= 'UNIQUE ('.$col['name'].'),';
		}
		$sql .= $index;
		$sql = substr($sql, 0, -1);
		$sql .= ')';
895 896
		/* TODO: secure parameters */
		$this->query($sql, $table_name);
897
		return true;
898
	}
899

900
	/*
901 902 903 904 905 906 907 908 909 910 911 912
       $columns = array(action =>   add | alter | drop
       name =>     Spaltenname
       name_new => neuer Spaltenname, nur bei 'alter' belegt
       type =>     42go-Meta-Type: int16, int32, int64, double, char, varchar, text, blob
       typeValue => Wert z.B. bei Varchar
       defaultValue =>  Default Wert
       notNull =>   true | false
       autoInc =>   true | false
       option =>   unique | primary | index)


     */
913 914
	public function alterTable($table_name, $columns) {
		$index = '';
915
		$sql = "ALTER TABLE ?? ";
916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940
		foreach($columns as $col){
			if($col['action'] == 'add') {
				$sql .= 'ADD '.$col['name'].' '.$this->mapType($col['type'], $col['typeValue']).' ';
			} elseif ($col['action'] == 'alter') {
				$sql .= 'CHANGE '.$col['name'].' '.$col['name_new'].' '.$this->mapType($col['type'], $col['typeValue']).' ';
			} elseif ($col['action'] == 'drop') {
				$sql .= 'DROP '.$col['name'].' ';
			}
			if($col['action'] != 'drop') {
				if($col['defaultValue'] != '') $sql .= "DEFAULT '".$col['defaultValue']."' ";
				if($col['notNull'] == true) {
					$sql .= 'NOT NULL ';
				} else {
					$sql .= 'NULL ';
				}
				if($col['autoInc'] == true) $sql .= 'auto_increment ';
				$sql.= ',';
				// Index definitions
				if($col['option'] == 'primary') $index .= 'PRIMARY KEY ('.$col['name'].'),';
				if($col['option'] == 'index') $index .= 'INDEX ('.$col['name'].'),';
				if($col['option'] == 'unique') $index .= 'UNIQUE ('.$col['name'].'),';
			}
		}
		$sql .= $index;
		$sql = substr($sql, 0, -1);
941
		/* TODO: secure parameters */
942
		//die($sql);
943
		$this->query($sql, $table_name);
944 945
		return true;
	}
946

947 948
	public function dropTable($table_name) {
		$this->check($table_name);
949 950
		$sql = "DROP TABLE ??";
		return $this->query($sql, $table_name);
951
	}
952

953 954
	// gibt Array mit Tabellennamen zur�ck
	public function getTables($database_name = '') {
955
		if(!is_object($this->_iConnId)) return false;
956
		if($database_name == '') $database_name = $this->dbName;
957
		$tb_names = $this->queryAllArray("SHOW TABLES FROM ??", $database_name);
958 959
		return $tb_names;
	}
960

961 962
	// gibt Feldinformationen zur Tabelle zur�ck
	/*
963
       $columns = array(action =>   add | alter | drop
964 965 966 967 968 969 970 971 972 973 974 975
       name =>     Spaltenname
       name_new => neuer Spaltenname, nur bei 'alter' belegt
       type =>     42go-Meta-Type: int16, int32, int64, double, char, varchar, text, blob
       typeValue => Wert z.B. bei Varchar
       defaultValue =>  Default Wert
       notNull =>   true | false
       autoInc =>   true | false
       option =>   unique | primary | index)


     */

976 977
	function tableInfo($table_name) {

978
		global $go_api, $go_info, $app;
979 980
		// Tabellenfelder einlesen

981
		if($rows = $app->db->queryAllRecords('SHOW FIELDS FROM ??', $table_name)){
982
			foreach($rows as $row) {
983 984 985 986 987 988
				$name = $row['Field'];
				$default = $row['Default'];
				$key = $row['Key'];
				$extra = $row['Extra'];
				$isnull = $row['Null'];
				$type = $row['Type'];
989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031


				$column = array();

				$column['name'] = $name;
				//$column['type'] = $type;
				$column['defaultValue'] = $default;
				if(stristr($key, 'PRI')) $column['option'] = 'primary';
				if(stristr($isnull, 'YES')) {
					$column['notNull'] = false;
				} else {
					$column['notNull'] = true;
				}
				if($extra == 'auto_increment') $column['autoInc'] = true;


				// Type in Metatype umsetzen

				if(stristr($type, 'int(')) $metaType = 'int32';
				if(stristr($type, 'bigint')) $metaType = 'int64';
				if(stristr($type, 'char')) {
					$metaType = 'char';
					$tmp_typeValue = explode('(', $type);
					$column['typeValue'] = substr($tmp_typeValue[1], 0, -1);
				}
				if(stristr($type, 'varchar')) {
					$metaType = 'varchar';
					$tmp_typeValue = explode('(', $type);
					$column['typeValue'] = substr($tmp_typeValue[1], 0, -1);
				}
				if(stristr($type, 'text')) $metaType = 'text';
				if(stristr($type, 'double')) $metaType = 'double';
				if(stristr($type, 'blob')) $metaType = 'blob';


				$column['type'] = $metaType;

				$columns[] = $column;
			}
			return $columns;
		} else {
			return false;
		}
1032 1033


1034
		//$this->createTable('tester',$columns);
1035

1036
		/*
1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056
	 $result = mysql_list_fields($go_info["server"]["db_name"],$table_name);
	 $fields = mysql_num_fields ($result);
	 $i = 0;
	 $table = mysql_field_table ($result, $i);
	 while ($i < $fields) {
	 $name  = mysql_field_name  ($result, $i);
	 $type  = mysql_field_type  ($result, $i);
	 $len   = mysql_field_len   ($result, $i);
	 $flags = mysql_field_flags ($result, $i);
	 print_r($flags);

	 $columns = array(name => $name,
	 type =>     "",
	 defaultValue =>  "",
	 isnull =>   1,
	 option =>   "");
	 $returnvar[] = $columns;

	 $i++;
	 }
1057
       */
tbrehm's avatar
tbrehm committed
1058

1059 1060


1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082
	}

	public function mapType($metaType, $typeValue) {
		global $go_api;
		$metaType = strtolower($metaType);
		switch ($metaType) {
		case 'int16':
			return 'smallint';
			break;
		case 'int32':
			return 'int';
			break;
		case 'int64':
			return 'bigint';
			break;
		case 'double':
			return 'double';
			break;
		case 'char':
			return 'char';
			break;
		case 'varchar':
1083
			if($typeValue < 1) die('Database failure: Length required for these data types.');
1084 1085 1086 1087 1088 1089 1090 1091
			return 'varchar('.$typeValue.')';
			break;
		case 'text':
			return 'text';
			break;
		case 'blob':
			return 'blob';
			break;
1092 1093 1094
		case 'date':
			return 'date';
			break;
1095 1096 1097 1098
		}
	}

}
1099

1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122
/**
 * database query result class
 *
 * @package pxFramework
 *
 */
class db_result {

	/**
	 *
	 *
	 * @access private
	 */
	private $_iResId = null;
	private $_iConnection = null;



	/**
	 *
	 *
	 * @access private
	 */
1123
	public function __construct($iResId, $iConnection) {
1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248
		$this->_iResId = $iResId;
		$this->_iConnection = $iConnection;
	}



	/**
	 * get count of result rows
	 *
	 * Returns the amount of rows in the result set
	 *
	 * @access public
	 * @return int amount of rows
	 */
	public function rows() {
		if(!is_object($this->_iResId)) return 0;
		$iRows = mysqli_num_rows($this->_iResId);
		if(!$iRows) $iRows = 0;
		return $iRows;
	}



	/**
	 * Get number of affected rows
	 *
	 * Returns the amount of rows affected by the previous query
	 *
	 * @access public
	 * @return int amount of affected rows
	 */
	public function affected() {
		if(!is_object($this->_iConnection)) return 0;
		$iRows = mysqli_affected_rows($this->_iConnection);
		if(!$iRows) $iRows = 0;
		return $iRows;
	}



	/**
	 * Frees the result set
	 *
	 * @access public
	 */
	public function free() {
		if(!is_object($this->_iResId)) return;

		mysqli_free_result($this->_iResId);
		return;
	}



	/**
	 * Get a result row (associative)
	 *
	 * Returns the next row in the result set. To be used in a while loop like while($currow = $result->get()) { do something ... }
	 *
	 * @access public
	 * @return array result row
	 */
	public function get() {
		$aItem = null;

		if(is_object($this->_iResId)) {
			$aItem = mysqli_fetch_assoc($this->_iResId);
			if(!$aItem) $aItem = null;
		}
		return $aItem;
	}



	/**
	 * Get a result row (array with numeric index)
	 *
	 * @access public
	 * @return array result row
	 */
	public function getAsRow() {
		$aItem = null;

		if(is_object($this->_iResId)) {
			$aItem = mysqli_fetch_row($this->_iResId);
			if(!$aItem) $aItem = null;
		}
		return $aItem;
	}

}

/**
 * database query result class
 *
 * emulates a db result set out of an array so you can use array results and db results the same way
 *
 * @package pxFramework
 * @see db_result
 *
 *
 */
class fakedb_result {

	/**
	 *
	 *
	 * @access private
	 */
	private $aResultData = array();

	/**
	 *
	 *
	 * @access private
	 */
	private $aLimitedData = array();



	/**
	 *
	 *
	 * @access private
	 */
1249
	public function __construct($aData) {
1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333
		$this->aResultData = $aData;
		$this->aLimitedData = $aData;
		reset($this->aLimitedData);
	}



	/**
	 * get count of result rows
	 *
	 * Returns the amount of rows in the result set
	 *
	 * @access public
	 * @return int amount of rows
	 */
	// Gibt die Anzahl Zeilen zurück
	public function rows() {
		return count($this->aLimitedData);
	}



	/**
	 * Frees the result set
	 *
	 * @access public
	 */
	// Gibt ein Ergebnisset frei
	public function free() {
		$this->aResultData = array();
		$this->aLimitedData = array();
		return;
	}



	/**
	 * Get a result row (associative)
	 *
	 * Returns the next row in the result set. To be used