Release plat/al core v1.1.13
[platal.git] / classes / xdb.php
index 098a4ec..6239b4b 100644 (file)
@@ -1,6 +1,6 @@
 <?php
 /***************************************************************************
- *  Copyright (C) 2003-2008 Polytechnique.org                              *
+ *  Copyright (C) 2003-2011 Polytechnique.org                              *
  *  http://opensource.polytechnique.org/                                   *
  *                                                                         *
  *  This program is free software; you can redistribute it and/or modify   *
@@ -26,7 +26,7 @@ class XDB
     public static function connect()
     {
         global $globals;
-        XDB::$mysqli = new mysqli($globals->dbhost, $globals->dbuser, $globals->dbpwd, $globals->dbdb);
+        self::$mysqli = new mysqli($globals->dbhost, $globals->dbuser, $globals->dbpwd, $globals->dbdb);
         if ($globals->debug & DEBUG_BT) {
             $bt = new PlBacktrace('MySQL');
             if (mysqli_connect_errno()) {
@@ -34,19 +34,22 @@ class XDB
                 return false;
             }
         }
-        XDB::$mysqli->autocommit(true);
-        XDB::$mysqli->set_charset($globals->dbcharset);
+        self::$mysqli->autocommit(true);
+        self::$mysqli->set_charset($globals->dbcharset);
         return true;
     }
 
-    public static function _prepare($args)
+    public static function prepare($args)
     {
+        global $globals;
         $query    = array_map(Array('XDB', 'escape'), $args);
-        $query[0] = str_replace('{?}', '%s', str_replace('%',   '%%', $args[0]));
+        $query[0] = preg_replace('/#([a-z0-9]+)#/', $globals->dbprefix . '$1', $args[0]);
+        $query[0] = str_replace('%',   '%%', $query[0]);
+        $query[0] = str_replace('{?}', '%s', $query[0]);
         return call_user_func_array('sprintf', $query);
     }
 
-    public static function _reformatQuery($query)
+    public static function reformatQuery($query)
     {
         $query  = preg_split("/\n\\s*/", trim($query));
         $length = 0;
@@ -71,11 +74,11 @@ class XDB
         return $res;
     }
 
-    public static function _query($query)
+    public static function run($query)
     {
         global $globals;
 
-        if (!XDB::$mysqli && !XDB::connect()) {
+        if (!self::$mysqli && !self::connect()) {
             header($_SERVER['SERVER_PROTOCOL'] . ' 500 Internal Server Error');
             Platal::page()->kill('Impossible de se connecter à la base de données.');
             exit;
@@ -83,8 +86,8 @@ class XDB
 
         if ($globals->debug & DEBUG_BT) {
             $explain = array();
-            if (strpos($query, 'FOUND_ROWS()') === false) {
-                $res = XDB::$mysqli->query("EXPLAIN $query");
+            if (strpos($query, 'FOUND_ROWS()') === false && strpos($query, 'AUTOCOMMIT') === false) {
+                $res = self::$mysqli->query("EXPLAIN $query");
                 if ($res) {
                     while ($row = $res->fetch_assoc()) {
                         $explain[] = $row;
@@ -92,33 +95,84 @@ class XDB
                     $res->free();
                 }
             }
-            PlBacktrace::$bt['MySQL']->start(XDB::_reformatQuery($query));
+            PlBacktrace::$bt['MySQL']->start(XDB::reformatQuery($query));
         }
 
         $res = XDB::$mysqli->query($query);
 
         if ($globals->debug & DEBUG_BT) {
-            PlBacktrace::$bt['MySQL']->stop(@$res->num_rows ? $res->num_rows : XDB::$mysqli->affected_rows,
-                                            XDB::$mysqli->error,
+            PlBacktrace::$bt['MySQL']->stop(@$res->num_rows ? $res->num_rows : self::$mysqli->affected_rows,
+                                            self::$mysqli->error,
                                             $explain);
         }
 
         if ($res === false) {
-            header($_SERVER['SERVER_PROTOCOL'] . ' 500 Internal Server Error');
-            if (strpos($query, 'INSERT') === false && strpos($query, 'UPDATE') === false
-                && strpos($query, 'REPLACE') === false && strpos($query, 'DELETE') === false) {
-                Platal::page()->kill('Erreur lors de l\'interrogation de la base de données');
-            } else {
-                Platal::page()->kill('Erreur lors de l\'écriture dans la base de données');
-            }
-            exit;
+            throw new XDBException(XDB::reformatQuery($query), XDB::$mysqli->error);
         }
         return $res;
     }
 
+    private static function queryv($query)
+    {
+        return new XDBResult(self::prepare($query));
+    }
+
     public static function query()
     {
-        return new XOrgDBResult(XDB::_prepare(func_get_args()));
+        return self::queryv(func_get_args());
+    }
+
+    public static function rawQuery($query)
+    {
+        return new XDBResult($query);
+    }
+
+    public static function format()
+    {
+        return self::prepare(func_get_args());
+    }
+
+    // Produce the SQL statement for setting/unsetting a flag
+    public static function changeFlag($fieldname, $flagname, $state)
+    {
+        if ($state) {
+            return XDB::format($fieldname . ' = CONCAT({?}, \',\', ' . $fieldname . ')', $flagname);
+        } else {
+            return XDB::format($fieldname . ' = REPLACE(' . $fieldname . ', {?}, \'\')', $flagname);
+        }
+    }
+
+    // Produce the SQL statement representing an array
+    public static function formatArray(array $array)
+    {
+        return self::escape($array);
+    }
+
+    const WILDCARD_EXACT    = 0x00;
+    const WILDCARD_PREFIX   = 0x01;
+    const WILDCARD_SUFFIX   = 0x02;
+    const WILDCARD_CONTAINS = 0x03; // WILDCARD_PREFIX | WILDCARD_SUFFIX
+
+    // Produce a valid XDB argument that get formatted as a wildcard
+    // according to the given mode.
+    //
+    // Example:
+    // XDB::query("SELECT * FROM table WHERE field {?}", XDB::wildcard($text, WILDCARD_EXACT));
+    public static function wildcard($mode, $value)
+    {
+      return new XDBWildcard($value, $mode);
+    }
+
+    // Returns the SQL statement for a wildcard search.
+    public static function formatWildcards($mode, $text)
+    {
+        return XDB::wildcard($mode, $text)->format();
+    }
+
+    // Returns a FIELD(blah, 3, 1, 2) for use in an order with custom orders
+    public static function formatCustomOrder($field, $values)
+    {
+        return 'FIELD( ' . $field . ', ' . implode(', ', array_map(array('XDB', 'escape'), $values)) . ')';
     }
 
     public static function execute()
@@ -128,37 +182,207 @@ class XDB
         if ($globals->mode != 'rw' && !strpos($args[0], 'logger')) {
             return;
         }
-        return XDB::_query(XDB::_prepare($args));
+        return self::run(XDB::prepare($args));
+    }
+
+    public static function rawExecute($query)
+    {
+        global $globals;
+        if ($globals->mode != 'rw') {
+            return;
+        }
+        return self::run($query);
+    }
+
+    private static $inTransaction = false;
+    public static function startTransaction()
+    {
+        if (self::$inTransaction) {
+            throw new XDBException('START TRANSACTION', 'Already in a transaction');
+        }
+        self::$inTransaction = true;
+        self::rawExecute('SET AUTOCOMMIT = 0');
+        self::rawExecute('START TRANSACTION');
+    }
+
+    public static function commit()
+    {
+        self::rawExecute('COMMIT');
+        self::rawExecute('SET AUTOCOMMIT = 1');
+        self::$inTransaction = false;
+    }
+
+    public static function rollback()
+    {
+        self::rawExecute('ROLLBACK');
+        self::rawExecute('SET AUTOCOMMIT = 1');
+        self::$inTransaction = false;
+    }
+
+    public static function runTransactionV($callback, array $args)
+    {
+        self::startTransaction();
+        try {
+            if (call_user_func_array($callback, $args)) {
+                self::commit();
+                return true;
+            } else {
+                self::rollback();
+                return false;
+            }
+        } catch (Exception $e) {
+            self::rollback();
+            throw $e;
+        }
+    }
+
+    /** This function takes a callback followed by the arguments to be passed to the callback
+     * as arguments. It starts a transaction and execute the callback. If the callback fails
+     * (return false or raise an exception), the transaction is rollbacked, if the callback
+     * succeeds (return true), the transaction is committed.
+     */
+    public static function runTransaction()
+    {
+        $args = func_get_args();
+        $cb = array_shift($args);
+        return self::runTransactionV($cb, $args);
     }
 
     public static function iterator()
     {
-        return new XOrgDBIterator(XDB::_prepare(func_get_args()));
+        return new XDBIterator(self::prepare(func_get_args()));
+    }
+
+    public static function rawIterator($query)
+    {
+        return new XDBIterator($query);
     }
 
     public static function iterRow()
     {
-        return new XOrgDBIterator(XDB::_prepare(func_get_args()), MYSQL_NUM);
+        return new XDBIterator(self::prepare(func_get_args()), MYSQL_NUM);
+    }
+
+    public static function rawIterRow($query)
+    {
+        return new XDBIterator($query, MYSQL_NUM);
+    }
+
+    private static function findQuery($params, $default = array())
+    {
+        for ($i = 0 ; $i < count($default) ; ++$i) {
+            $is_query = false;
+            foreach (array('insert', 'select', 'replace', 'delete', 'update') as $kwd) {
+                if (stripos($params[0], $kwd) !== false) {
+                    $is_query = true;
+                    break;
+                }
+            }
+            if ($is_query) {
+                break;
+            } else {
+                $default[$i] = array_shift($params);
+            }
+        }
+        return array($default, $params);
+    }
+
+    /** Fetch all rows returned by the given query.
+     * This functions can take 2 optional arguments (cf XDBResult::fetchAllRow()).
+     * Optional arguments are given *before* the query.
+     */
+    public static function fetchAllRow()
+    {
+        list($args, $query) = self::findQuery(func_get_args(), array(false, false));
+        return self::queryv($query)->fetchAllRow($args[0], $args[1]);
+    }
+
+    public static function rawFetchAllRow($query, $id = false, $keep_array = false)
+    {
+        return self::rawQuery($query)->fetchAllRow($id, $keep_array);
+    }
+
+    /** Fetch all rows returned by the given query.
+     * This functions can take 2 optional arguments (cf XDBResult::fetchAllAssoc()).
+     * Optional arguments are given *before* the query.
+     */
+    public static function fetchAllAssoc()
+    {
+        list($args, $query) = self::findQuery(func_get_args(), array(false, false));
+        return self::queryv($query)->fetchAllAssoc($args[0], $args[1]);
+    }
+
+    public static function rawFetchAllAssoc($query, $id = false, $keep_array = false)
+    {
+        return self::rawQuery($query)->fetchAllAssoc($id, $keep_array);
+    }
+
+    public static function fetchOneCell()
+    {
+        list($args, $query) = self::findQuery(func_get_args());
+        return self::queryv($query)->fetchOneCell();
+    }
+
+    public static function rawFetchOneCell($query)
+    {
+        return self::rawQuery($query)->fetchOneCell();
+    }
+
+    public static function fetchOneRow()
+    {
+        list($args, $query) = self::findQuery(func_get_args());
+        return self::queryv($query)->fetchOneRow();
+    }
+
+    public static function rawFetchOneRow($query)
+    {
+        return self::rawQuery($query)->fetchOneRow();
+    }
+
+    public static function fetchOneAssoc()
+    {
+        list($args, $query) = self::findQuery(func_get_args());
+        return self::queryv($query)->fetchOneAssoc();
+    }
+
+    public static function rawFetchOneAssoc($query)
+    {
+        return self::rawQuery($query)->fetchOneAssoc();
+    }
+
+    /** Fetch a column from the result of the given query.
+     * This functions can take 1 optional arguments (cf XDBResult::fetchColumn()).
+     * Optional arguments are given *before* the query.
+     */
+    public static function fetchColumn()
+    {
+        list($args, $query) = self::findQuery(func_get_args(), array(0));
+        return self::queryv($query)->fetchColumn($args[0]);
+    }
+
+    public static function rawFetchColumn($query, $key = 0)
+    {
+        return self::rawQuery($query)->fetchColumn($key);
     }
 
     public static function insertId()
     {
-        return XDB::$mysqli->insert_id;
+        return self::$mysqli->insert_id;
     }
 
     public static function errno()
     {
-        return XDB::$mysqli->errno;
+        return self::$mysqli->errno;
     }
 
     public static function error()
     {
-        return XDB::$mysqli->error;
+        return self::$mysqli->error;
     }
 
     public static function affectedRows()
     {
-        return XDB::$mysqli->affected_rows;
+        return self::$mysqli->affected_rows;
     }
 
     public static function escape($var)
@@ -179,11 +403,14 @@ class XDB
             return 'NULL';
 
           case 'object':
-            if ($var instanceof PlFlagSet) {
-                return "'" . addslashes($var->flags()) . "'";
+            if ($var instanceof XDBFormat) {
+                return $var->format();
+            } else {
+                return "'".addslashes(serialize($var))."'";
             }
+
           case 'array':
-            return "'".addslashes(serialize($var))."'";
+            return '(' . implode(', ', array_map(array('XDB', 'escape'), $var)) . ')';
 
           default:
             die(var_export($var, true).' is not a valid for a database entry');
@@ -191,75 +418,146 @@ class XDB
     }
 }
 
-class XOrgDBResult
+class XDBException extends PlException
+{
+    public function __construct($query, $error)
+    {
+        if (strpos($query, 'INSERT') === false && strpos($query, 'UPDATE') === false
+            && strpos($query, 'REPLACE') === false && strpos($query, 'DELETE') === false) {
+            $text = 'Erreur lors de l\'interrogation de la base de données';
+        } else {
+            $text = 'Erreur lors de l\'écriture dans la base de données';
+        }
+        parent::__construct($text, $query . "\n" . $error);
+    }
+}
+
+interface XDBFormat
 {
+    public function format();
+}
 
-    private $_res;
+class XDBWildcard implements XDBFormat
+{
+    private $value;
+    private $mode;
+
+    public function __construct($value, $mode)
+    {
+        $this->value = $value;
+        $this->mode  = $mode;
+    }
+
+    public function format()
+    {
+        if ($this->mode == XDB::WILDCARD_EXACT) {
+            return XDB::format(' = {?}', $this->value);
+        } else {
+            $text = str_replace(array('%', '_'), array('\%', '\_'), $this->value);
+            if ($this->mode & XDB::WILDCARD_PREFIX) {
+                $text = $text . '%';
+            }
+            if ($this->mode & XDB::WILDCARD_SUFFIX) {
+                $text = '%' . $text;
+            }
+            return XDB::format(" LIKE {?}", $text);
+        }
+    }
+}
+
+
+class XDBResult
+{
+    private $res;
 
     public function __construct($query)
     {
-        $this->_res = XDB::_query($query);
+        $this->res = XDB::run($query);
     }
 
     public function free()
     {
-        if ($this->_res) {
-            $this->_res->free();
+        if ($this->res) {
+            $this->res->free();
         }
         unset($this);
     }
 
-    protected function _fetchRow()
+    protected function fetchRow()
     {
-        return $this->_res ? $this->_res->fetch_row() : null;
+        return $this->res ? $this->res->fetch_row() : null;
     }
 
-    protected function _fetchAssoc()
+    protected function fetchAssoc()
     {
-        return $this->_res ? $this->_res->fetch_assoc() : null;
+        return $this->res ? $this->res->fetch_assoc() : null;
     }
 
-    public function fetchAllRow()
+    public function fetchAllRow($id = false, $keep_array = false)
     {
         $result = Array();
-        if (!$this->_res) {
+        if (!$this->res) {
             return $result;
         }
-        while ($result[] = $this->_res->fetch_row());
-        array_pop($result);
+        while (($data = $this->res->fetch_row())) {
+            if ($id !== false) {
+                $key = $data[$id];
+                unset($data[$id]);
+                if (!$keep_array && count($data) == 1) {
+                    reset($data);
+                    $result[$key] = current($data);
+                } else {
+                    $result[$key] = $data;
+                }
+            } else {
+                $result[] = $data;
+            }
+        }
         $this->free();
         return $result;
     }
 
-    public function fetchAllAssoc()
+    public function fetchAllAssoc($id = false, $keep_array = false)
     {
         $result = Array();
-        if (!$this->_res) {
+        if (!$this->res) {
             return $result;
         }
-        while ($result[] = $this->_res->fetch_assoc());
-        array_pop($result);
+        while (($data = $this->res->fetch_assoc())) {
+            if ($id !== false) {
+                $key = $data[$id];
+                unset($data[$id]);
+                if (!$keep_array && count($data) == 1) {
+                    reset($data);
+                    $result[$key] = current($data);
+                } else {
+                    $result[$key] = $data;
+                }
+            } else {
+                $result[] = $data;
+            }
+        }
         $this->free();
         return $result;
     }
 
     public function fetchOneAssoc()
     {
-        $tmp = $this->_fetchAssoc();
+        $tmp = $this->fetchAssoc();
         $this->free();
         return $tmp;
     }
 
     public function fetchOneRow()
     {
-        $tmp = $this->_fetchRow();
+        $tmp = $this->fetchRow();
         $this->free();
         return $tmp;
     }
 
     public function fetchOneCell()
     {
-        $tmp = $this->_fetchRow();
+        $tmp = $this->fetchRow();
         $this->free();
         return $tmp[0];
     }
@@ -268,11 +566,11 @@ class XOrgDBResult
     {
         $res = Array();
         if (is_numeric($key)) {
-            while($tmp = $this->_fetchRow()) {
+            while($tmp = $this->fetchRow()) {
                 $res[] = $tmp[$key];
             }
         } else {
-            while($tmp = $this->_fetchAssoc()) {
+            while($tmp = $this->fetchAssoc()) {
                 $res[] = $tmp[$key];
             }
         }
@@ -282,7 +580,7 @@ class XOrgDBResult
 
     public function fetchOneField()
     {
-        return $this->_res ? $this->_res->fetch_field() : null;
+        return $this->res ? $this->res->fetch_field() : null;
     }
 
     public function fetchFields()
@@ -294,66 +592,65 @@ class XOrgDBResult
 
     public function numRows()
     {
-        return $this->_res ? $this->_res->num_rows : 0;
+        return $this->res ? $this->res->num_rows : 0;
     }
 
     public function fieldCount()
     {
-        return $this->_res ? $this->_res->field_count : 0;
+        return $this->res ? $this->res->field_count : 0;
     }
 }
 
-require_once dirname(__FILE__) . '/pliterator.php';
 
-class XOrgDBIterator extends XOrgDBResult implements PlIterator
+class XDBIterator extends XDBResult implements PlIterator
 {
-    private $_result;
-    private $_pos;
-    private $_total;
-    private $_fpos;
-    private $_fields;
-    private $_mode = MYSQL_ASSOC;
+    private $result;
+    private $pos;
+    private $total;
+    private $fpos;
+    private $fields;
+    private $mode = MYSQL_ASSOC;
 
     public function __construct($query, $mode = MYSQL_ASSOC)
     {
         parent::__construct($query);
-        $this->_pos    = 0;
-        $this->_total  = $this->numRows();
-        $this->_fpost  = 0;
-        $this->_fields = $this->fieldCount();
-        $this->_mode   = $mode;
+        $this->pos    = 0;
+        $this->total  = $this->numRows();
+        $this->fpost  = 0;
+        $this->fields = $this->fieldCount();
+        $this->mode   = $mode;
     }
 
     public function next()
     {
-        $this->_pos ++;
-        if ($this->_pos > $this->_total) {
+        $this->pos ++;
+        if ($this->pos > $this->total) {
             $this->free();
             unset($this);
             return null;
         }
-        return $this->_mode != MYSQL_ASSOC ? $this->_fetchRow() : $this->_fetchAssoc();
+        return $this->mode != MYSQL_ASSOC ? $this->fetchRow() : $this->fetchAssoc();
     }
 
     public function first()
     {
-        return $this->_pos == 1;
+        return $this->pos == 1;
     }
 
     public function last()
     {
-        return $this->_pos == $this->_total;
+        return $this->pos == $this->total;
     }
 
     public function total()
     {
-        return $this->_total;
+        return $this->total;
     }
 
     public function nextField()
     {
-        $this->_fpos++;
-        if ($this->_fpos > $this->_fields) {
+        $this->fpos++;
+        if ($this->fpos > $this->fields) {
             return null;
         }
         return $this->fetchOneField();
@@ -361,19 +658,19 @@ class XOrgDBIterator extends XOrgDBResult implements PlIterator
 
     public function firstField()
     {
-        return $this->_fpos == 1;
+        return $this->fpos == 1;
     }
 
     public function lastField()
     {
-        return $this->_fpos == $this->_fields;
+        return $this->fpos == $this->fields;
     }
 
     public function totalFields()
     {
-        return $this->_fields;
+        return $this->fields;
     }
 }
 
-// vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8:
+// vim:set et sw=4 sts=4 sws=4 foldmethod=marker fenc=utf-8:
 ?>