X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=include%2Fdba.php;h=bc3802935163badf83d5c4eea5ef8c8b979b3319;hb=17f29285358cd4cf5292b72624c378e466c6ad7b;hp=3fff69c2cfea245cd4325c42799425ac1ea2d51d;hpb=41a81624a226fb3813ebaaec529fef1c2b3a8a5a;p=friendica.git

diff --git a/include/dba.php b/include/dba.php
index 3fff69c2cf..bc38029351 100644
--- a/include/dba.php
+++ b/include/dba.php
@@ -1,15 +1,12 @@
 <?php
+use \Friendica\Core\System;
+
 require_once("dbm.php");
 require_once('include/datetime.php');
 
 /**
  * @class MySQL database class
  *
- * For debugging, insert 'dbg(1);' anywhere in the program flow.
- * dbg(0); will turn it off. Logging is performed at LOGGER_DATA level.
- * When logging, all binary info is converted to text and html entities are escaped so that
- * the debugging stream is safe to view within both terminals and web pages.
- *
  * This class is for the low level database stuff that does driver specific things.
  */
 
@@ -212,175 +209,32 @@ class dba {
 		}
 	}
 
-	public function q($sql, $onlyquery = false) {
-		$a = get_app();
-
-		if (!$this->db || !$this->connected) {
-			return false;
-		}
-
-		$this->error = '';
-
-		$connstr = ($this->connected() ? "Connected" : "Disonnected");
-
-		$stamp1 = microtime(true);
-
-		$orig_sql = $sql;
-
-		if (x($a->config,'system') && x($a->config['system'], 'db_callstack')) {
-			$sql = "/*".$a->callstack()." */ ".$sql;
-		}
-
-		$columns = 0;
-
-		switch ($this->driver) {
-			case 'pdo':
-				$result = @$this->db->query($sql);
-				// Is used to separate between queries that returning data - or not
-				if (!is_bool($result)) {
-					$columns = $result->columnCount();
-				}
-				break;
-			case 'mysqli':
-				$result = @$this->db->query($sql);
-				break;
-			case 'mysql':
-				$result = @mysql_query($sql,$this->db);
-				break;
-		}
-		$stamp2 = microtime(true);
-		$duration = (float)($stamp2 - $stamp1);
-
-		$a->save_timestamp($stamp1, "database");
-
-		if (strtolower(substr($orig_sql, 0, 6)) != "select") {
-			$a->save_timestamp($stamp1, "database_write");
-		}
-		if (x($a->config,'system') && x($a->config['system'],'db_log')) {
-			if (($duration > $a->config["system"]["db_loglimit"])) {
-				$duration = round($duration, 3);
-				$backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
-				@file_put_contents($a->config["system"]["db_log"], datetime_convert()."\t".$duration."\t".
-						basename($backtrace[1]["file"])."\t".
-						$backtrace[1]["line"]."\t".$backtrace[2]["function"]."\t".
-						substr($sql, 0, 2000)."\n", FILE_APPEND);
-			}
-		}
-
-		switch ($this->driver) {
-			case 'pdo':
-				$errorInfo = $this->db->errorInfo();
-				if ($errorInfo) {
-					$this->error = $errorInfo[2];
-					$this->errorno = $errorInfo[1];
-				}
-				break;
-			case 'mysqli':
-				if ($this->db->errno) {
-					$this->error = $this->db->error;
-					$this->errorno = $this->db->errno;
-				}
-				break;
-			case 'mysql':
-				if (mysql_errno($this->db)) {
-					$this->error = mysql_error($this->db);
-					$this->errorno = mysql_errno($this->db);
-				}
-				break;
-		}
-		if (strlen($this->error)) {
-			logger('DB Error ('.$connstr.') '.$this->errorno.': '.$this->error);
-		}
-
-		if ($this->debug) {
-
-			$mesg = '';
-
-			if ($result === false) {
-				$mesg = 'false';
-			} elseif ($result === true) {
-				$mesg = 'true';
-			} else {
-				switch ($this->driver) {
-					case 'pdo':
-						$mesg = $result->rowCount().' results'.EOL;
-						break;
-					case 'mysqli':
-						$mesg = $result->num_rows.' results'.EOL;
-						break;
-					case 'mysql':
-						$mesg = mysql_num_rows($result).' results'.EOL;
-						break;
-				}
-			}
-
-			$str =  'SQL = ' . printable($sql) . EOL . 'SQL returned ' . $mesg
-				. (($this->error) ? ' error: ' . $this->error : '')
-				. EOL;
-
-			logger('dba: ' . $str );
-		}
-
-		/**
-		 * If dbfail.out exists, we will write any failed calls directly to it,
-		 * regardless of any logging that may or may nor be in effect.
-		 * These usually indicate SQL syntax errors that need to be resolved.
-		 */
+	/**
+	 * @brief execute SQL query - deprecated
+	 *
+	 * Please use the dba:: functions instead:
+	 * dba::select, dba::exists, dba::insert
+	 * dba::delete, dba::update, dba::p, dba::e
+	 *
+	 * @param string $sql SQL query
+	 * @return array Query array
+	 */
+	public function q($sql) {
+		$ret = self::p($sql);
 
-		if ($result === false) {
-			logger('dba: ' . printable($sql) . ' returned false.' . "\n" . $this->error);
-			if (file_exists('dbfail.out')) {
-				file_put_contents('dbfail.out', datetime_convert() . "\n" . printable($sql) . ' returned false' . "\n" . $this->error . "\n", FILE_APPEND);
-			}
+		if (is_bool($ret)) {
+			return $ret;
 		}
 
-		if (is_bool($result)) {
-			return $result;
-		}
-		if ($onlyquery) {
-			$this->result = $result;
-			return true;
-		}
+		$columns = self::columnCount($ret);
 
-		$r = array();
-		switch ($this->driver) {
-			case 'pdo':
-				while ($x = $result->fetch(PDO::FETCH_ASSOC)) {
-					$r[] = $x;
-				}
-				$result->closeCursor();
-				break;
-			case 'mysqli':
-				while ($x = $result->fetch_array(MYSQLI_ASSOC)) {
-					$r[] = $x;
-				}
-				$result->free_result();
-				break;
-			case 'mysql':
-				while ($x = mysql_fetch_array($result, MYSQL_ASSOC)) {
-					$r[] = $x;
-				}
-				mysql_free_result($result);
-				break;
-		}
+		$data = self::inArray($ret);
 
-		// PDO doesn't return "true" on successful operations - like mysqli does
-		// Emulate this behaviour by checking if the query returned data and had columns
-		// This should be reliable enough
-		if (($this->driver == 'pdo') && (count($r) == 0) && ($columns == 0)) {
+		if ((count($data) == 0) && ($columns == 0)) {
 			return true;
 		}
 
-		//$a->save_timestamp($stamp1, "database");
-
-		if ($this->debug) {
-			logger('dba: ' . printable(print_r($r, true)));
-		}
-		return($r);
-	}
-
-	public function dbg($dbg) {
-		$this->debug = $dbg;
+		return $data;
 	}
 
 	public function escape($str) {
@@ -476,7 +330,7 @@ class dba {
 	 * @param array $args The parameters that are to replace the ? placeholders
 	 * @return string The replaced SQL query
 	 */
-	static private function replace_parameters($sql, $args) {
+	private static function replace_parameters($sql, $args) {
 		$offset = 0;
 		foreach ($args AS $param => $value) {
 			if (is_int($args[$param]) || is_float($args[$param])) {
@@ -513,10 +367,14 @@ class dba {
 	/**
 	 * @brief Executes a prepared statement that returns data
 	 * @usage Example: $r = p("SELECT * FROM `item` WHERE `guid` = ?", $guid);
+	 *
+	 * Please only use it with complicated queries.
+	 * For all regular queries please use dba::select or dba::exists
+	 *
 	 * @param string $sql SQL statement
 	 * @return object statement object
 	 */
-	static public function p($sql) {
+	public static function p($sql) {
 		$a = get_app();
 
 		$stamp1 = microtime(true);
@@ -527,6 +385,10 @@ class dba {
 		$i = 0;
 		$args = array();
 		foreach ($params AS $param) {
+			// Avoid problems with some MySQL servers and boolean values. See issue #3645
+			if (is_bool($param)) {
+				$param = (int)$param;
+			}
 			$args[++$i] = $param;
 		}
 
@@ -534,7 +396,7 @@ class dba {
 			return false;
 		}
 
-		if (substr_count($sql, '?') != count($args)) {
+		if ((substr_count($sql, '?') != count($args)) && (count($args) > 0)) {
 			// Question: Should we continue or stop the query here?
 			logger('Parameter mismatch. Query "'.$sql.'" - Parameters '.print_r($args, true), LOGGER_DEBUG);
 		}
@@ -545,7 +407,7 @@ class dba {
 		$orig_sql = $sql;
 
 		if (x($a->config,'system') && x($a->config['system'], 'db_callstack')) {
-			$sql = "/*".$a->callstack()." */ ".$sql;
+			$sql = "/*".System::callstack()." */ ".$sql;
 		}
 
 		self::$dbo->error = '';
@@ -566,6 +428,19 @@ class dba {
 
 		switch (self::$dbo->driver) {
 			case 'pdo':
+				// If there are no arguments we use "query"
+				if (count($args) == 0) {
+					if (!$retval = self::$dbo->db->query($sql)) {
+						$errorInfo = self::$dbo->db->errorInfo();
+						self::$dbo->error = $errorInfo[2];
+						self::$dbo->errorno = $errorInfo[1];
+						$retval = false;
+						break;
+					}
+					self::$dbo->affected_rows = $retval->rowCount();
+					break;
+				}
+
 				if (!$stmt = self::$dbo->db->prepare($sql)) {
 					$errorInfo = self::$dbo->db->errorInfo();
 					self::$dbo->error = $errorInfo[2];
@@ -594,8 +469,8 @@ class dba {
 				$command = strtolower($parts[0]);
 				$can_be_prepared = in_array($command, array('select', 'update', 'insert', 'delete'));
 
-				// The fallback routine currently only works with statements that doesn't return values
-				if (!$can_be_prepared && $called_from_e) {
+				// The fallback routine is called as well when there are no arguments
+				if (!$can_be_prepared || (count($args) == 0)) {
 					$retval = self::$dbo->db->query(self::replace_parameters($sql, $args));
 					if (self::$dbo->db->errno) {
 						self::$dbo->error = self::$dbo->db->error;
@@ -675,7 +550,7 @@ class dba {
 			$errorno = self::$dbo->errorno;
 
 			logger('DB Error '.self::$dbo->errorno.': '.self::$dbo->error."\n".
-				$a->callstack(8)."\n".self::replace_parameters($sql, $params));
+				System::callstack(8)."\n".self::replace_parameters($sql, $params));
 
 			self::$dbo->error = $error;
 			self::$dbo->errorno = $errorno;
@@ -704,10 +579,12 @@ class dba {
 	/**
 	 * @brief Executes a prepared statement like UPDATE or INSERT that doesn't return data
 	 *
+	 * Please use dba::delete, dba::insert, dba::update, ... instead
+	 *
 	 * @param string $sql SQL statement
 	 * @return boolean Was the query successfull? False is returned only if an error occurred
 	 */
-	static public function e($sql) {
+	public static function e($sql) {
 		$a = get_app();
 
 		$stamp = microtime(true);
@@ -738,7 +615,7 @@ class dba {
 			$errorno = self::$dbo->errorno;
 
 			logger('DB Error '.self::$dbo->errorno.': '.self::$dbo->error."\n".
-				$a->callstack(8)."\n".self::replace_parameters($sql, $params));
+				System::callstack(8)."\n".self::replace_parameters($sql, $params));
 
 			self::$dbo->error = $error;
 			self::$dbo->errorno = $errorno;
@@ -757,7 +634,7 @@ class dba {
 	 *
 	 * @return boolean Are there rows for that condition?
 	 */
-	static public function exists($table, $condition) {
+	public static function exists($table, $condition) {
 		if (empty($table)) {
 			return false;
 		}
@@ -786,10 +663,12 @@ class dba {
 	/**
 	 * @brief Fetches the first row
 	 *
+	 * Please use dba::select or dba::exists whenever this is possible.
+	 *
 	 * @param string $sql SQL statement
 	 * @return array first row of query
 	 */
-	static public function fetch_first($sql) {
+	public static function fetch_first($sql) {
 		$params = self::getParam(func_get_args());
 
 		$stmt = self::p($sql, $params);
@@ -810,17 +689,37 @@ class dba {
 	 *
 	 * @return int Number of rows
 	 */
-	static public function affected_rows() {
+	public static function affected_rows() {
 		return self::$dbo->affected_rows;
 	}
 
+	/**
+	 * @brief Returns the number of columns of a statement
+	 *
+	 * @param object Statement object
+	 * @return int Number of columns
+	 */
+	public static function columnCount($stmt) {
+		if (!is_object($stmt)) {
+			return 0;
+		}
+		switch (self::$dbo->driver) {
+			case 'pdo':
+				return $stmt->columnCount();
+			case 'mysqli':
+				return $stmt->field_count;
+			case 'mysql':
+				return mysql_affected_rows($stmt);
+		}
+		return 0;
+	}
 	/**
 	 * @brief Returns the number of rows of a statement
 	 *
 	 * @param object Statement object
 	 * @return int Number of rows
 	 */
-	static public function num_rows($stmt) {
+	public static function num_rows($stmt) {
 		if (!is_object($stmt)) {
 			return 0;
 		}
@@ -841,7 +740,7 @@ class dba {
 	 * @param object $stmt statement object
 	 * @return array current row
 	 */
-	static public function fetch($stmt) {
+	public static function fetch($stmt) {
 		if (!is_object($stmt)) {
 			return false;
 		}
@@ -850,6 +749,10 @@ class dba {
 			case 'pdo':
 				return $stmt->fetch(PDO::FETCH_ASSOC);
 			case 'mysqli':
+				if (get_class($stmt) == 'mysqli_result') {
+					return $stmt->fetch_assoc();
+				}
+
 				// This code works, but is slow
 
 				// Bind the result to a result array
@@ -891,7 +794,7 @@ class dba {
 	 *
 	 * @return boolean was the insert successfull?
 	 */
-	static public function insert($table, $param, $on_duplicate_update = false) {
+	public static function insert($table, $param, $on_duplicate_update = false) {
 		$sql = "INSERT INTO `".self::$dbo->escape($table)."` (`".implode("`, `", array_keys($param))."`) VALUES (".
 			substr(str_repeat("?, ", count($param)), 0, -2).")";
 
@@ -910,7 +813,7 @@ class dba {
 	 *
 	 * @return integer Last inserted id
 	 */
-	function lastInsertId() {
+	public static function lastInsertId() {
 		switch (self::$dbo->driver) {
 			case 'pdo':
 				$id = self::$dbo->db->lastInsertId();
@@ -934,7 +837,7 @@ class dba {
 	 *
 	 * @return boolean was the lock successful?
 	 */
-	static public function lock($table) {
+	public static function lock($table) {
 		// See here: https://dev.mysql.com/doc/refman/5.7/en/lock-tables-and-transactions.html
 		self::e("SET autocommit=0");
 		$success = self::e("LOCK TABLES `".self::$dbo->escape($table)."` WRITE");
@@ -951,7 +854,7 @@ class dba {
 	 *
 	 * @return boolean was the unlock successful?
 	 */
-	static public function unlock() {
+	public static function unlock() {
 		// See here: https://dev.mysql.com/doc/refman/5.7/en/lock-tables-and-transactions.html
 		self::e("COMMIT");
 		$success = self::e("UNLOCK TABLES");
@@ -965,7 +868,7 @@ class dba {
 	 *
 	 * @return boolean Was the command executed successfully?
 	 */
-	static public function transaction() {
+	public static function transaction() {
 		if (!self::e('COMMIT')) {
 			return false;
 		}
@@ -981,7 +884,7 @@ class dba {
 	 *
 	 * @return boolean Was the command executed successfully?
 	 */
-	static public function commit() {
+	public static function commit() {
 		if (!self::e('COMMIT')) {
 			return false;
 		}
@@ -994,7 +897,7 @@ class dba {
 	 *
 	 * @return boolean Was the command executed successfully?
 	 */
-	static public function rollback() {
+	public static function rollback() {
 		if (!self::e('ROLLBACK')) {
 			return false;
 		}
@@ -1009,17 +912,17 @@ class dba {
 	 *
 	 * This process must only be started once, since the value is cached.
 	 */
-	static private function build_relation_data() {
+	private static function build_relation_data() {
 		$definition = db_definition();
 
 		foreach ($definition AS $table => $structure) {
-		        foreach ($structure['fields'] AS $field => $field_struct) {
-		                if (isset($field_struct['relation'])) {
-		                        foreach ($field_struct['relation'] AS $rel_table => $rel_field) {
-		                                self::$relation[$rel_table][$rel_field][$table][] = $field;
-		                        }
-		                }
-		        }
+			foreach ($structure['fields'] AS $field => $field_struct) {
+				if (isset($field_struct['relation'])) {
+					foreach ($field_struct['relation'] AS $rel_table => $rel_field) {
+						self::$relation[$rel_table][$rel_field][$table][] = $field;
+					}
+				}
+			}
 		}
 	}
 
@@ -1033,7 +936,7 @@ class dba {
 	 *
 	 * @return boolean|array was the delete successfull? When $in_process is set: deletion data
 	 */
-	static public function delete($table, $param, $in_process = false, &$callstack = array()) {
+	public static function delete($table, $param, $in_process = false, &$callstack = array()) {
 
 		$commands = array();
 
@@ -1167,7 +1070,7 @@ class dba {
 
 		return $commands;
 	}
-// $param
+
 	/**
 	 * @brief Updates rows
 	 *
@@ -1196,7 +1099,7 @@ class dba {
 	 *
 	 * @return boolean was the update successfull?
 	 */
-	static public function update($table, $fields, $condition, $old_fields = array()) {
+	public static function update($table, $fields, $condition, $old_fields = array()) {
 
 		$table = self::$dbo->escape($table);
 
@@ -1265,12 +1168,16 @@ class dba {
 	 * Example:
 	 * $table = "item";
 	 * $fields = array("id", "uri", "uid", "network");
+	 *
 	 * $condition = array("uid" => 1, "network" => 'dspr');
+	 * or:
+	 * $condition = array("`uid` = ? AND `network` IN (?, ?)", 1, 'dfrn', 'dspr');
+	 *
 	 * $params = array("order" => array("id", "received" => true), "limit" => 1);
 	 *
 	 * $data = dba::select($table, $fields, $condition, $params);
 	 */
-	static public function select($table, $fields = array(), $condition = array(), $params = array()) {
+	public static function select($table, $fields = array(), $condition = array(), $params = array()) {
 		if ($table == '') {
 			return false;
 		}
@@ -1337,7 +1244,11 @@ class dba {
 	 * @param object $stmt statement object
 	 * @return array Data array
 	 */
-	static public function inArray($stmt, $do_close = true) {
+	public static function inArray($stmt, $do_close = true) {
+		if (is_bool($stmt)) {
+			return $stmt;
+		}
+
 		$data = array();
 		while ($row = self::fetch($stmt)) {
 			$data[] = $row;
@@ -1354,7 +1265,7 @@ class dba {
 	 * @param object $stmt statement object
 	 * @return boolean was the close successfull?
 	 */
-	static public function close($stmt) {
+	public static function close($stmt) {
 		if (!is_object($stmt)) {
 			return false;
 		}
@@ -1371,24 +1282,6 @@ class dba {
 	}
 }
 
-function printable($s) {
-	$s = preg_replace("~([\x01-\x08\x0E-\x0F\x10-\x1F\x7F-\xFF])~",".", $s);
-	$s = str_replace("\x00",'.',$s);
-	if (x($_SERVER,'SERVER_NAME')) {
-		$s = escape_tags($s);
-	}
-	return $s;
-}
-
-// Procedural functions
-function dbg($state) {
-	global $db;
-
-	if ($db) {
-		$db->dbg($state);
-	}
-}
-
 function dbesc($str) {
 	global $db;
 
@@ -1399,107 +1292,46 @@ function dbesc($str) {
 	}
 }
 
-// Function: q($sql,$args);
-// Description: execute SQL query with printf style args.
-// Example: $r = q("SELECT * FROM `%s` WHERE `uid` = %d",
-//                   'user', 1);
-function q($sql) {
-	global $db;
-	$args = func_get_args();
-	unset($args[0]);
-
-	if ($db && $db->connected) {
-		$sql = $db->clean_query($sql);
-		$sql = $db->any_value_fallback($sql);
-		$stmt = @vsprintf($sql,$args); // Disabled warnings
-		//logger("dba: q: $stmt", LOGGER_ALL);
-		if ($stmt === false)
-			logger('dba: vsprintf error: ' . print_r(debug_backtrace(),true), LOGGER_DEBUG);
-
-		$db->log_index($stmt);
-
-		return $db->q($stmt);
-	}
-
-	/**
-	 *
-	 * This will happen occasionally trying to store the
-	 * session data after abnormal program termination
-	 *
-	 */
-	logger('dba: no database: ' . print_r($args,true));
-	return false;
-}
-
 /**
- * @brief Performs a query with "dirty reads"
+ * @brief execute SQL query with printf style args - deprecated
  *
- * By doing dirty reads (reading uncommitted data) no locks are performed
- * This function can be used to fetch data that doesn't need to be reliable.
+ * Please use the dba:: functions instead:
+ * dba::select, dba::exists, dba::insert
+ * dba::delete, dba::update, dba::p, dba::e
  *
  * @param $args Query parameters (1 to N parameters of different types)
  * @return array Query array
  */
-function qu($sql) {
+function q($sql) {
 	global $db;
 
 	$args = func_get_args();
 	unset($args[0]);
 
-	if ($db && $db->connected) {
-		$sql = $db->clean_query($sql);
-		$sql = $db->any_value_fallback($sql);
-		$stmt = @vsprintf($sql,$args); // Disabled warnings
-		if ($stmt === false)
-			logger('dba: vsprintf error: ' . print_r(debug_backtrace(),true), LOGGER_DEBUG);
-
-		$db->log_index($stmt);
-
-		$db->q("SET SESSION TRANSACTION ISOLATION LEVEL READ UNCOMMITTED;");
-		$retval = $db->q($stmt);
-		$db->q("SET SESSION TRANSACTION ISOLATION LEVEL REPEATABLE READ;");
-		return $retval;
+	if (!$db || !$db->connected) {
+		return false;
 	}
 
-	/**
-	 *
-	 * This will happen occasionally trying to store the
-	 * session data after abnormal program termination
-	 *
-	 */
-	logger('dba: no database: ' . print_r($args,true));
-	return false;
-}
+	$sql = $db->clean_query($sql);
+	$sql = $db->any_value_fallback($sql);
 
-/**
- *
- * Raw db query, no arguments
- *
- */
-function dbq($sql) {
-	global $db;
+	$stmt = @vsprintf($sql, $args);
 
-	if ($db && $db->connected) {
-		$ret = $db->q($sql);
-	} else {
-		$ret = false;
+	$ret = dba::p($stmt);
+
+	if (is_bool($ret)) {
+		return $ret;
 	}
-	return $ret;
-}
 
-// Caller is responsible for ensuring that any integer arguments to
-// dbesc_array are actually integers and not malformed strings containing
-// SQL injection vectors. All integer array elements should be specifically
-// cast to int to avoid trouble.
-function dbesc_array_cb(&$item, $key) {
-	if (is_string($item))
-		$item = dbesc($item);
-}
+	$columns = dba::columnCount($ret);
+
+	$data = dba::inArray($ret);
 
-function dbesc_array(&$arr) {
-	if (is_array($arr) && count($arr)) {
-		array_walk($arr,'dbesc_array_cb');
+	if ((count($data) == 0) && ($columns == 0)) {
+		return true;
 	}
+
+	return $data;
 }
 
 function dba_timer() {