]> git.mxchange.org Git - friendica.git/blobdiff - src/Database/DBA.php
Moved documentation
[friendica.git] / src / Database / DBA.php
index 70b43e122502ece25fa2631bcefc85664eefe0eb..ab856ef9d05da6fd2c1205fcf07e2029d8fdce02 100644 (file)
@@ -9,10 +9,14 @@ namespace Friendica\Database;
 use Friendica\Core\System;
 use Friendica\Util\DateTimeFormat;
 use mysqli;
+use mysqli_result;
+use mysqli_stmt;
 use PDO;
 use PDOException;
 use PDOStatement;
 
+require_once 'include/dba.php';
+
 /**
  * @class MySQL database class
  *
@@ -87,6 +91,7 @@ class DBA
                                self::$connection->setAttribute(PDO::ATTR_EMULATE_PREPARES, false);
                                self::$connected = true;
                        } catch (PDOException $e) {
+                               /// @TODO At least log exception, don't ignore it!
                        }
                }
 
@@ -212,7 +217,7 @@ class DBA
                }
 
                $r = self::p("EXPLAIN ".$query);
-               if (!DBM::is_result($r)) {
+               if (!self::isResult($r)) {
                        return;
                }
 
@@ -247,11 +252,16 @@ class DBA
        }
 
        public static function escape($str) {
-               switch (self::$driver) {
-                       case 'pdo':
-                               return substr(@self::$connection->quote($str, PDO::PARAM_STR), 1, -1);
-                       case 'mysqli':
-                               return @self::$connection->real_escape_string($str);
+               if (self::$connected) {
+                       switch (self::$driver) {
+                               case 'pdo':
+                                       return substr(@self::$connection->quote($str, PDO::PARAM_STR), 1, -1);
+
+                               case 'mysqli':
+                                       return @self::$connection->real_escape_string($str);
+                       }
+               } else {
+                       return str_replace("'", "\\'", $str);
                }
        }
 
@@ -265,7 +275,7 @@ class DBA
                switch (self::$driver) {
                        case 'pdo':
                                $r = self::p("SELECT 1");
-                               if (DBM::is_result($r)) {
+                               if (self::isResult($r)) {
                                        $row = self::toArray($r);
                                        $connected = ($row[0]['1'] == '1');
                                }
@@ -364,7 +374,7 @@ class DBA
         * @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
+        * For all regular queries please use DBA::select or DBA::exists
         *
         * @param string $sql SQL statement
         * @return bool|object statement object or result object
@@ -582,7 +592,7 @@ 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
+        * 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
@@ -677,7 +687,7 @@ class DBA
        /**
         * Fetches the first row
         *
-        * Please use dba::selectFirst or dba::exists whenever this is possible.
+        * Please use DBA::selectFirst or DBA::exists whenever this is possible.
         *
         * @brief Fetches the first row
         * @param string $sql SQL statement
@@ -924,13 +934,11 @@ class DBA
 
                switch (self::$driver) {
                        case 'pdo':
-                               if (self::$connection->inTransaction()) {
-                                       break;
-                               }
-                               if (!self::$connection->beginTransaction()) {
+                               if (!self::$connection->inTransaction() && !self::$connection->beginTransaction()) {
                                        return false;
                                }
                                break;
+
                        case 'mysqli':
                                if (!self::$connection->begin_transaction()) {
                                        return false;
@@ -949,10 +957,13 @@ class DBA
                                if (!self::$connection->inTransaction()) {
                                        return true;
                                }
+
                                return self::$connection->commit();
+
                        case 'mysqli':
                                return self::$connection->commit();
                }
+
                return true;
        }
 
@@ -985,6 +996,7 @@ class DBA
                                }
                                $ret = self::$connection->rollBack();
                                break;
+
                        case 'mysqli':
                                $ret = self::$connection->rollback();
                                break;
@@ -1050,7 +1062,12 @@ class DBA
 
                $commands[$key] = ['table' => $table, 'conditions' => $conditions];
 
-               $cascade = defaults($options, 'cascade', true);
+               // Don't use "defaults" here, since it would set "false" to "true"
+               if (isset($options['cascade'])) {
+                       $cascade = $options['cascade'];
+               } else {
+                       $cascade = true;
+               }
 
                // To speed up the whole process we cache the table relations
                if ($cascade && count(self::$relation) == 0) {
@@ -1290,7 +1307,7 @@ class DBA
         *
         * $params = array("order" => array("id", "received" => true), "limit" => 10);
         *
-        * $data = dba::select($table, $fields, $condition, $params);
+        * $data = DBA::select($table, $fields, $condition, $params);
         */
        public static function select($table, array $fields = [], array $condition = [], array $params = [])
        {
@@ -1332,7 +1349,7 @@ class DBA
         * or:
         * $condition = ["`uid` = ? AND `network` IN (?, ?)", 1, 'dfrn', 'dspr'];
         *
-        * $count = dba::count($table, $condition);
+        * $count = DBA::count($table, $condition);
         */
        public static function count($table, array $condition = [])
        {
@@ -1386,7 +1403,7 @@ class DBA
                                                /* Workaround for MySQL Bug #64791.
                                                 * Never mix data types inside any IN() condition.
                                                 * In case of mixed types, cast all as string.
-                                                * Logic needs to be consistent with dba::p() data types.
+                                                * Logic needs to be consistent with DBA::p() data types.
                                                 */
                                                $is_int = false;
                                                $is_alpha = false;
@@ -1446,7 +1463,7 @@ class DBA
 
                $limit_string = '';
                if (isset($params['limit']) && is_int($params['limit'])) {
-                       $limit_string = " LIMIT " . $params['limit'];
+                       $limit_string = " LIMIT " . intval($params['limit']);
                }
 
                if (isset($params['limit']) && is_array($params['limit'])) {
@@ -1517,7 +1534,7 @@ class DBA
                        case 'mysqli':
                                // MySQLi offers both a mysqli_stmt and a mysqli_result class.
                                // We should be careful not to assume the object type of $stmt
-                               // because dba::p() has been able to return both types.
+                               // because DBA::p() has been able to return both types.
                                if ($stmt instanceof mysqli_stmt) {
                                        $stmt->free_result();
                                        $ret = $stmt->close();
@@ -1534,4 +1551,101 @@ class DBA
 
                return $ret;
        }
+
+       /**
+        * @brief Return a list of database processes
+        *
+        * @return array
+        *      'list' => List of processes, separated in their different states
+        *      'amount' => Number of concurrent database processes
+        */
+       public static function processlist()
+       {
+               $ret = self::p("SHOW PROCESSLIST");
+               $data = self::toArray($ret);
+
+               $s = [];
+
+               $processes = 0;
+               $states = [];
+               foreach ($data as $process) {
+                       $state = trim($process["State"]);
+
+                       // Filter out all non blocking processes
+                       if (!in_array($state, ["", "init", "statistics", "updating"])) {
+                               ++$states[$state];
+                               ++$processes;
+                       }
+               }
+
+               $statelist = "";
+               foreach ($states as $state => $usage) {
+                       if ($statelist != "") {
+                               $statelist .= ", ";
+                       }
+                       $statelist .= $state.": ".$usage;
+               }
+               return(["list" => $statelist, "amount" => $processes]);
+       }
+
+       /**
+        * Checks if $array is a filled array with at least one entry.
+        *
+        * @param mixed $array A filled array with at least one entry
+        *
+        * @return boolean Whether $array is a filled array or an object with rows
+        */
+       public static function isResult($array)
+       {
+               // It could be a return value from an update statement
+               if (is_bool($array)) {
+                       return $array;
+               }
+
+               if (is_object($array)) {
+                       return self::numRows($array) > 0;
+               }
+
+               return (is_array($array) && (count($array) > 0));
+       }
+
+       /**
+        * @brief Callback function for "esc_array"
+        *
+        * @param mixed   $value         Array value
+        * @param string  $key           Array key
+        * @param boolean $add_quotation add quotation marks for string values
+        * @return void
+        */
+       private static function escapeArrayCallback(&$value, $key, $add_quotation)
+       {
+               if (!$add_quotation) {
+                       if (is_bool($value)) {
+                               $value = ($value ? '1' : '0');
+                       } else {
+                               $value = self::escape($value);
+                       }
+                       return;
+               }
+
+               if (is_bool($value)) {
+                       $value = ($value ? 'true' : 'false');
+               } elseif (is_float($value) || is_integer($value)) {
+                       $value = (string) $value;
+               } else {
+                       $value = "'" . self::escape($value) . "'";
+               }
+       }
+
+       /**
+        * @brief Escapes a whole array
+        *
+        * @param mixed   $arr           Array with values to be escaped
+        * @param boolean $add_quotation add quotation marks for string values
+        * @return void
+        */
+       public static function escapeArray(&$arr, $add_quotation = false)
+       {
+               array_walk($arr, 'self::escapeArrayCallback', $add_quotation);
+       }
 }