X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=include%2Fdba.php;h=920027cbcfaeef721a02f2ec3214efed0fcf459b;hb=51716957b24d97c20f078d1f880a6ca112cae792;hp=1421a703dc730ad1a7eb803e30c632ff0d17937c;hpb=39405c8056b4a1d55c97fb2963d8776695dbeb30;p=friendica.git

diff --git a/include/dba.php b/include/dba.php
index 1421a703dc..920027cbcf 100644
--- a/include/dba.php
+++ b/include/dba.php
@@ -1,280 +1,360 @@
 <?php
+require_once("dbm.php");
+
+# if PDO is avaible for mysql, use the new database abstraction
+# TODO: PDO is disabled for release 3.3. We need to investigate why
+# the update from 3.2 fails with pdo
+/*
+if (class_exists('\PDO') && in_array('mysql', PDO::getAvailableDrivers())) {
+  require_once("library/dddbl2/dddbl.php");
+  require_once("include/dba_pdo.php");
+}
+*/
+
 
 require_once('include/datetime.php');
 
 /**
- *
- * MySQL database class
+ * @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.
+ * 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.
  *
  */
 
-if(! class_exists('dba')) {
+if (! class_exists('dba')) {
+class dba {
 
-	class dba {
+	private $debug = 0;
+	private $db;
+	private $result;
+	public  $mysqli = true;
+	public  $connected = false;
+	public  $error = false;
 
-		private $debug = 0;
-		private $db;
-		private $exceptions; 
-		
-		public  $mysqli = true;
-		public  $connected = false;
-		public  $error = false;
+	function __construct($server, $user, $pass, $db, $install = false) {
+		$a = get_app();
 
-		function __construct($server,$user,$pass,$db,$install = false) {
+		$stamp1 = microtime(true);
 
-			$server = trim($server);
-			$user = trim($user);
-			$pass = trim($pass);
-			$db = trim($db);
+		$server = trim($server);
+		$user = trim($user);
+		$pass = trim($pass);
+		$db = trim($db);
 
-			//we need both, server and username, so fail if one is missing
-			if (!(strlen($server) && strlen($user))){
-				$this->connected = false;
-				$this->db = null;
-				throw new InvalidArgumentException(t("Server name of user name are missing. "));
-			}
+		if (!(strlen($server) && strlen($user))) {
+			$this->connected = false;
+			$this->db = null;
+			return;
+		}
 
-			//when we are installing
-			if($install) {
-				if(strlen($server) && ($server !== 'localhost') && ($server !== '127.0.0.1')) {
-					if(! dns_get_record($server, DNS_A + DNS_CNAME + DNS_PTR)) {
-						$this->connected = false;
-						$this->db = null;
-						throw new InvalidArgumentException( t('Cannot locate DNS info for database server \'%s\''), $server);
-					}
+		if ($install) {
+			if (strlen($server) && ($server !== 'localhost') && ($server !== '127.0.0.1')) {
+				if (! dns_get_record($server, DNS_A + DNS_CNAME + DNS_PTR)) {
+					$this->error = sprintf( t('Cannot locate DNS info for database server \'%s\''), $server);
+					$this->connected = false;
+					$this->db = null;
+					return;
 				}
 			}
+		}
 
-			if(class_exists('mysqli')) {
-				$this->db = new mysqli($server,$user,$pass,$db);
-				if(NULL === $this->db->connect_error) {
-					$this->connected = true;
-				} else {
-					throw new RuntimeException($this->db->connect_error);
-				}
-			} else {
-				$this->mysqli = false;
-				$this->db = mysql_connect($server,$user,$pass);
-				if($this->db && mysql_select_db($db,$this->db)) {
-					$this->connected = true;
-				} else {
-					throw new RuntimeException(mysql_error());
-				}
+		if (class_exists('mysqli')) {
+			$this->db = @new mysqli($server,$user,$pass,$db);
+			if (! mysqli_connect_errno()) {
+				$this->connected = true;
 			}
+			if (isset($a->config["system"]["db_charset"])) {
+				$this->db->set_charset($a->config["system"]["db_charset"]);
+			}
+		} else {
+			$this->mysqli = false;
+			$this->db = mysql_connect($server,$user,$pass);
+			if ($this->db && mysql_select_db($db,$this->db)) {
+				$this->connected = true;
+			}
+			if (isset($a->config["system"]["db_charset"]))
+				mysql_set_charset($a->config["system"]["db_charset"], $this->db);
 		}
+		if (!$this->connected) {
+			$this->db = null;
+			if (!$install) {
+				system_unavailable();
+			}
+		}
+
+		$a->save_timestamp($stamp1, "network");
+	}
 
-		public function excep($excep) {
-			$this->exceptions=$excep; 
+	public function getdb() {
+		return $this->db;
+	}
+
+	/**
+	 * @brief Returns the MySQL server version string
+	 * 
+	 * This function discriminate between the deprecated mysql API and the current
+	 * object-oriented mysqli API. Example of returned string: 5.5.46-0+deb8u1
+	 *
+	 * @return string
+	 */
+	public function server_info() {
+		if ($this->mysqli) {
+			$return = $this->db->server_info;
+		} else {
+			$return = mysql_get_server_info($this->db);
 		}
-		
-		public function getdb() {
-			return $this->db;
+		return $return;
+	}
+
+	/**
+	 * @brief Returns the selected database name
+	 *
+	 * @return string
+	 */
+	public function database_name() {
+		$r = $this->q("SELECT DATABASE() AS `db`");
+
+		return $r[0]['db'];
+	}
+
+	/**
+	 * @brief Returns the number of rows
+	 *
+	 * @return integer
+	 */
+	public function num_rows() {
+		if (!$this->result) {
+			return 0;
 		}
 
-		public function q($sql) {
+		if ($this->mysqli) {
+			$return = $this->result->num_rows;
+		} else {
+			$return = mysql_num_rows($this->result);
+		}
+		return $return;
+	}
 
-			if((! $this->db) || (! $this->connected)) {
-				$this->throwOrLog(new RuntimeException(t("There is no db connection. ")));
-				return;
-			}
+	public function q($sql, $onlyquery = false) {
+		$a = get_app();
 
-			if($this->mysqli) {
-				$result = $this->db->query($sql);
-			} else {
-				$result = mysql_query($sql,$this->db);
-			}
+		if (!$this->db || !$this->connected) {
+			return false;
+		}
 
-			//on debug mode or fail, the query is written to the log.
-			//this won't work if logger can not read it's logging level
-			//from the db.
-			if($this->debug || FALSE === $result) {
+		$this->error = '';
 
-				$mesg = '';
+		// Check the connection (This can reconnect the connection - if configured)
+		if ($this->mysqli) {
+			$connected = $this->db->ping();
+		} else {
+			$connected = mysql_ping($this->db);
+		}
+		$connstr = ($connected ? "Connected" : "Disonnected");
 
-				if($result === false) {
-					$mesg = 'false '.$this->error();
-				} elseif($result === true) {
-					$mesg = 'true';
-				} else {
-					if($this->mysqli) {
-						$mesg = $result->num_rows . t(' results') . EOL;
-					} else {
-						$mesg = mysql_num_rows($result) . t(' results') . EOL;
-					}
-				}
+		$stamp1 = microtime(true);
+
+		$orig_sql = $sql;
 
-				$str =  'SQL = ' . printable($sql) . EOL . t('SQL returned ') . $mesg . EOL;
+		if (x($a->config,'system') && x($a->config['system'], 'db_callstack')) {
+			$sql = "/*".$a->callstack()." */ ".$sql;
+		}
 
+		if ($this->mysqli) {
+			$result = @$this->db->query($sql);
+		} else {
+			$result = @mysql_query($sql,$this->db);
+		}
+		$stamp2 = microtime(true);
+		$duration = (float)($stamp2-$stamp1);
 
-			 // 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.
-				if(file_exists('dbfail.out')) {
-					file_put_contents('dbfail.out', datetime_convert() . "\n" . $str . "\n", FILE_APPEND);
-				}
-				logger('dba: ' . $str );
-				if(FALSE===$result) {
-					$this->throwOrLog(new RuntimeException('dba: ' . $str));
-					return; 
-				}
+		$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);
 			}
-				
+		}
 
-			if($result === true) {
-				return $result;
+		if ($this->mysqli) {
+			if ($this->db->errno) {
+				$this->error = $this->db->error;
+				$this->errorno = $this->db->errno;
 			}
+		} elseif (mysql_errno($this->db)) {
+			$this->error = mysql_error($this->db);
+			$this->errorno = mysql_errno($this->db);
+		}
 
-			$r = array();
-			if($this->mysqli) {
-				if($result->num_rows) {
-					while($x = $result->fetch_array(MYSQLI_ASSOC)) {
-						$r[] = $x;
-					}
-					$result->free_result();
-				}
+		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 {
-				if(mysql_num_rows($result)) {
-					while($x = mysql_fetch_array($result, MYSQL_ASSOC)) {
-						$r[] = $x;
-					}
-					mysql_free_result($result);
+				if ($this->mysqli) {
+					$mesg = $result->num_rows . ' results' . EOL;
+				} else {
+					$mesg = mysql_num_rows($result) . ' results' . EOL;
 				}
 			}
 
+			$str =  'SQL = ' . printable($sql) . EOL . 'SQL returned ' . $mesg
+				. (($this->error) ? ' error: ' . $this->error : '')
+				. EOL;
 
-			if($this->debug) {
-				logger('dba: ' . printable(print_r($r, true)));
-			}
-			return($r);
+			logger('dba: ' . $str );
 		}
 
-		private function error() {
-			if($this->mysqli) {
-				return $this->db->error;
-			} else {
-				return mysql_error($this->db);
+		/**
+		 * 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.
+		 */
+
+		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);
 			}
 		}
-		
-		private function throwOrLog(Exception $ex) {
-			if($this->exceptions) {
-				throw $ex; 
-			} else {
-				logger('dba: '.$ex->getMessage()); 
-			}
+
+		if (($result === true) || ($result === false)) {
+			return $result;
 		}
-		
-		/**
-		 * starts a transaction. Transactions need to be finished with 
-		 * commit() or rollback(). Please mind that the db table engine may
-		 * not support this. 
-		 */
-		public function beginTransaction() {
-			if($this->mysqli) {
-				return $this->db->autocommit(false);
-			} else {
-				//no transaction support in mysql module...
-				mysql_query('SET AUTOCOMMIT = 0;', $db); 
-			}
+		if ($onlyquery) {
+			$this->result = $result;
+			return true;
 		}
-		
-		/**
-		 * rollback a transaction. So, rollback anything that was done since the last call 
-		 * to beginTransaction(). 
-		 */
-		public function rollback() {
-			if($this->mysqli) {
-				return $this->db->rollback();
-			} else {
-				//no transaction support in mysql module...
-				mysql_query('ROLLBACK;', $db);
+
+		$r = array();
+		if ($this->mysqli) {
+			if ($result->num_rows) {
+				while($x = $result->fetch_array(MYSQLI_ASSOC))
+					$r[] = $x;
+				$result->free_result();
+			}
+		} else {
+			if (mysql_num_rows($result)) {
+				while($x = mysql_fetch_array($result, MYSQL_ASSOC))
+					$r[] = $x;
+				mysql_free_result($result);
 			}
-			$this->stopTransaction(); 
 		}
 
-		/**
-		 * commit a transaction. So, write any query to the database. 
-		 */
-		public function commit() {
-			if($this->mysqli) {
-				return $this->db->commit();
-			} else {
-				//no transaction support in mysql module...
-				mysql_query('COMMIT;', $db);
-			}
-			$this->stopTransaction();
+		//$a->save_timestamp($stamp1, "database");
+
+		if ($this->debug) {
+			logger('dba: ' . printable(print_r($r, true)));
 		}
-		
-		private function stopTransaction() {
-			if($this->mysqli) {
-				return $this->db->autocommit(true);
-			} else {
-				//no transaction support in mysql module...
-				mysql_query('SET AUTOCOMMIT = 1;', $db);
-			}
+		return($r);
+	}
+
+	public function qfetch() {
+		$x = false;
+
+		if ($this->result) {
+			if ($this->mysqli) {
+				if ($this->result->num_rows)
+					$x = $this->result->fetch_array(MYSQLI_ASSOC);
+			} else {
+				if (mysql_num_rows($this->result))
+					$x = mysql_fetch_array($this->result, MYSQL_ASSOC);
+			}
 		}
-		
-		public function dbg($dbg) {
-			$this->debug = $dbg;
+		return($x);
+	}
+
+	public function qclose() {
+		if ($this->result) {
+			if ($this->mysqli) {
+				$this->result->free_result();
+			} else {
+				mysql_free_result($this->result);
+			}
 		}
+	}
 
-		public function escape($str) {
-			if($this->db && $this->connected) {
-				if($this->mysqli) {
-					return $this->db->real_escape_string($str);
-				} else {
-					return mysql_real_escape_string($str,$this->db);
-				}
+	public function dbg($dbg) {
+		$this->debug = $dbg;
+	}
+
+	public function escape($str) {
+		if ($this->db && $this->connected) {
+			if ($this->mysqli) {
+				return @$this->db->real_escape_string($str);
+			} else {
+				return @mysql_real_escape_string($str,$this->db);
 			}
 		}
+	}
+
+	function connected() {
+		if ($this->mysqli) {
+			$connected = $this->db->ping();
+		} else {
+			$connected = mysql_ping($this->db);
+		}
+		return $connected;
+	}
 
-		function __destruct() {
-			if ($this->db) {
-				if($this->mysqli) {
-					$this->db->close();
-				}
+	function __destruct() {
+		if ($this->db) {
+			if ($this->mysqli) {
+				$this->db->close();
 			} else {
 				mysql_close($this->db);
 			}
 		}
 	}
-}
-
-if(! function_exists('printable')) {
-	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;
+}}
+
+if (! function_exists('printable')) {
+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
-if(! function_exists('dbg')) {
-	function dbg($state) {
-		global $db;
-		if($db)
-			$db->dbg($state);
+if (! function_exists('dbg')) {
+function dbg($state) {
+	global $db;
+	if ($db) {
+		$db->dbg($state);
 	}
-}
-
-if(! function_exists('dbesc')) {
-	function dbesc($str) {
-		global $db;
-		if($db && $db->connected)
-			return($db->escape($str));
-		else
-			return(str_replace("'","\\'",$str));
+}}
+
+if (! function_exists('dbesc')) {
+function dbesc($str) {
+	global $db;
+	if ($db && $db->connected) {
+		return($db->escape($str));
+	} else {
+		return(str_replace("'","\\'",$str));
 	}
-}
+}}
 
 
 
@@ -283,30 +363,66 @@ if(! function_exists('dbesc')) {
 // Example: $r = q("SELECT * FROM `%s` WHERE `uid` = %d",
 //                   'user', 1);
 
-if(! function_exists('q')) {
-	function q($sql) {
+if (! function_exists('q')) {
+function q($sql) {
 
-		global $db;
-		$args = func_get_args();
-		unset($args[0]);
+	global $db;
+	$args = func_get_args();
+	unset($args[0]);
 
-		if($db && $db->connected) {
-			$stmt = vsprintf($sql,$args);
-			if($stmt === false)
-				logger('dba: vsprintf error: ' . print_r(debug_backtrace(),true));
-			return $db->q($stmt);
-		}
+	if ($db && $db->connected) {
+		$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);
+		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;
+	/**
+	 *
+	 * 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"
+ *
+ * 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.
+ *
+ * @param $args Query parameters (1 to N parameters of different types)
+ * @return array Query array
+ */
+function qu($sql) {
+
+	global $db;
+	$args = func_get_args();
+	unset($args[0]);
+
+	if ($db && $db->connected) {
+		$stmt = @vsprintf($sql,$args); // Disabled warnings
+		if ($stmt === false)
+			logger('dba: vsprintf error: ' . print_r(debug_backtrace(),true), LOGGER_DEBUG);
+		$db->q("SET SESSION TRANSACTION ISOLATION LEVEL READ UNCOMMITTED;");
+		$retval = $db->q($stmt);
+		$db->q("SET SESSION TRANSACTION ISOLATION LEVEL REPEATABLE READ;");
+		return $retval;
 	}
+
+	/**
+	 *
+	 * This will happen occasionally trying to store the
+	 * session data after abnormal program termination
+	 *
+	 */
+	logger('dba: no database: ' . print_r($args,true));
+	return false;
+
 }
 
 /**
@@ -315,17 +431,17 @@ if(! function_exists('q')) {
  *
  */
 
-if(! function_exists('dbq')) {
-	function dbq($sql) {
+if (! function_exists('dbq')) {
+function dbq($sql) {
 
-		global $db;
-		if($db && $db->connected)
-			$ret = $db->q($sql);
-		else
-			$ret = false;
-		return $ret;
+	global $db;
+	if ($db && $db->connected) {
+		$ret = $db->q($sql);
+	} else {
+		$ret = false;
 	}
-}
+	return $ret;
+}}
 
 
 // Caller is responsible for ensuring that any integer arguments to
@@ -334,20 +450,21 @@ if(! function_exists('dbq')) {
 // cast to int to avoid trouble.
 
 
-if(! function_exists('dbesc_array_cb')) {
-	function dbesc_array_cb(&$item, $key) {
-		if(is_string($item))
-			$item = dbesc($item);
-	}
-}
+if (! function_exists('dbesc_array_cb')) {
+function dbesc_array_cb(&$item, $key) {
+	if (is_string($item))
+		$item = dbesc($item);
+}}
 
 
-if(! function_exists('dbesc_array')) {
-	function dbesc_array(&$arr) {
-		if(is_array($arr) && count($arr)) {
-			array_walk($arr,'dbesc_array_cb');
-		}
+if (! function_exists('dbesc_array')) {
+function dbesc_array(&$arr) {
+	if (is_array($arr) && count($arr)) {
+		array_walk($arr,'dbesc_array_cb');
 	}
-}
+}}
 
 
+function dba_timer() {
+	return microtime(true);
+}