classes/xdb.php

   1 <?php
   2 /***************************************************************************
   3  *  Copyright (C) 2003-2009 Polytechnique.org                              *
   4  *  http://opensource.polytechnique.org/                                   *
   5  *                                                                         *
   6  *  This program is free software; you can redistribute it and/or modify   *
   7  *  it under the terms of the GNU General Public License as published by   *
   8  *  the Free Software Foundation; either version 2 of the License, or      *
   9  *  (at your option) any later version.                                    *
  10  *                                                                         *
  11  *  This program is distributed in the hope that it will be useful,        *
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of         *
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          *
  14  *  GNU General Public License for more details.                           *
  15  *                                                                         *
  16  *  You should have received a copy of the GNU General Public License      *
  17  *  along with this program; if not, write to the Free Software            *
  18  *  Foundation, Inc.,                                                      *
  19  *  59 Temple Place, Suite 330, Boston, MA  02111-1307  USA                *
  20  **************************************************************************/
  21
  22 class XDB
  23 {
  24     private static $mysqli = null;
  25
  26     public static function connect()
  27     {
  28         global $globals;
  29         self::$mysqli = new mysqli($globals->dbhost, $globals->dbuser, $globals->dbpwd, $globals->dbdb);
  30         if ($globals->debug & DEBUG_BT) {
  31             $bt = new PlBacktrace('MySQL');
  32             if (mysqli_connect_errno()) {
  33                 $bt->newEvent("MySQLI connection", 0, mysqli_connect_error());
  34                 return false;
  35             }
  36         }
  37         self::$mysqli->autocommit(true);
  38         self::$mysqli->set_charset($globals->dbcharset);
  39         return true;
  40     }
  41
  42     public static function _prepare($args)
  43     {
  44         global $globals;
  45         $query    = array_map(Array('XDB', 'escape'), $args);
  46         $query[0] = preg_replace('/#([a-z0-9]*)#/', $globals->dbprefix . '$1', $args[0]);
  47         $query[0] = str_replace('%',   '%%', $query[0]);
  48         $query[0] = str_replace('{?}', '%s', $query[0]);
  49         return call_user_func_array('sprintf', $query);
  50     }
  51
  52     public static function _reformatQuery($query)
  53     {
  54         $query  = preg_split("/\n\\s*/", trim($query));
  55         $length = 0;
  56         foreach ($query as $key=>$line) {
  57             $local = -2;
  58             if (preg_match('/^([A-Z]+(?:\s+(?:JOIN|BY|FROM|INTO))?)\s+(.*)/u', $line, $matches)
  59             && $matches[1] != 'AND' && $matches[1] != 'OR')
  60             {
  61                 $local  = strlen($matches[1]);
  62                 $line   = $matches[1] . '  ' . $matches[2];
  63                 $length = max($length, $local);
  64             }
  65             $query[$key] = array($line, $local);
  66         }
  67         $res = '';
  68         foreach ($query as $array) {
  69             list($line, $local) = $array;
  70             $local   = max(0, $length - $local);
  71             $res    .= str_repeat(' ', $local) . $line . "\n";
  72             $length += 2 * (substr_count($line, '(') - substr_count($line, ')'));
  73         }
  74         return $res;
  75     }
  76
  77     public static function _query($query)
  78     {
  79         global $globals;
  80
  81         if (!self::$mysqli && !self::connect()) {
  82             header($_SERVER['SERVER_PROTOCOL'] . ' 500 Internal Server Error');
  83             Platal::page()->kill('Impossible de se connecter à la base de données.');
  84             exit;
  85         }
  86
  87         if ($globals->debug & DEBUG_BT) {
  88             $explain = array();
  89             if (strpos($query, 'FOUND_ROWS()') === false) {
  90                 $res = self::$mysqli->query("EXPLAIN $query");
  91                 if ($res) {
  92                     while ($row = $res->fetch_assoc()) {
  93                         $explain[] = $row;
  94                     }
  95                     $res->free();
  96                 }
  97             }
  98             PlBacktrace::$bt['MySQL']->start(XDB::_reformatQuery($query));
  99         }
 100
 101         $res = XDB::$mysqli->query($query);
 102
 103         if ($globals->debug & DEBUG_BT) {
 104             PlBacktrace::$bt['MySQL']->stop(@$res->num_rows ? $res->num_rows : self::$mysqli->affected_rows,
 105                                             self::$mysqli->error,
 106                                             $explain);
 107         }
 108
 109         if ($res === false) {
 110             header($_SERVER['SERVER_PROTOCOL'] . ' 500 Internal Server Error');
 111             if (strpos($query, 'INSERT') === false && strpos($query, 'UPDATE') === false
 112                 && strpos($query, 'REPLACE') === false && strpos($query, 'DELETE') === false) {
 113                 $text = 'Erreur lors de l\'interrogation de la base de données';
 114             } else {
 115                 $text = 'Erreur lors de l\'écriture dans la base de données';
 116             }
 117             if ($globals->debug) {
 118                 $text .= '<pre>' . pl_entities(XDB::_reformatQuery($query)) . '</pre>';
 119             } else {
 120                 $file = fopen($globals->spoolroot . '/spool/tmp/query_errors', 'a');
 121                 fwrite($file, '<pre>' . pl_entities(XDB::_reformatQuery($query)) . '</pre>'
 122                             . '<pre>' . XDB::$mysqli->error . '</pre>' . "\n");
 123                 fclose($file);
 124             }
 125             Platal::page()->kill($text);
 126             exit;
 127         }
 128         return $res;
 129     }
 130
 131     private static function queryv($query)
 132     {
 133         return new XOrgDBResult(self::_prepare($query));
 134     }
 135
 136     public static function query()
 137     {
 138         return self::queryv(func_get_args());
 139     }
 140
 141     public static function format()
 142     {
 143         return self::_prepare(func_get_args());
 144     }
 145
 146     // Produce the SQL statement for setting/unsetting a flag
 147     public static function changeFlag($fieldname, $flagname, $state)
 148     {
 149         if ($state) {
 150             return XDB::format($fieldname . ' = CONCAT({?}, \',\', ' . $fieldname . ')', $flagname);
 151         } else {
 152             return XDB::format($fieldname . ' = REPLACE(' . $fieldname . ', {?}, \'\')', $flagname);
 153         }
 154     }
 155
 156     // Produce the SQL statement representing an array
 157     public static function formatArray(array $array)
 158     {
 159         return '(' . implode(', ', array_map(array('XDB', 'escape'), $array)) . ')';
 160     }
 161
 162     const WILDCARD_EXACT    = 0x00;
 163     const WILDCARD_PREFIX   = 0x01;
 164     const WILDCARD_SUFFIX   = 0x02;
 165     const WILDCARD_CONTAINS = 0x03; // WILDCARD_PREFIX | WILDCARD_SUFFIX
 166
 167     // Returns the SQL statement for a wildcard search.
 168     public static function formatWildcards($mode, $text)
 169     {
 170         if ($mode == self::WILDCARD_EXACT) {
 171             return XDB::format(' = {?}', $text);
 172         } else {
 173             $text = str_replace(array('%', '_'), array('\%', '\_'), $text);
 174             if ($mode & self::WILDCARD_PREFIX) {
 175                 $text = $text . '%';
 176             }
 177             if ($mode & self::WILDCARD_SUFFIX) {
 178                 $text = '%' . $text;
 179             }
 180             return XDB::format(" LIKE {?}", $text);
 181         }
 182     }
 183
 184     public static function execute()
 185     {
 186         global $globals;
 187         $args = func_get_args();
 188         if ($globals->mode != 'rw' && !strpos($args[0], 'logger')) {
 189             return;
 190         }
 191         return self::_query(XDB::_prepare($args));
 192     }
 193
 194     public static function iterator()
 195     {
 196         return new XOrgDBIterator(self::_prepare(func_get_args()));
 197     }
 198
 199     public static function iterRow()
 200     {
 201         return new XOrgDBIterator(self::_prepare(func_get_args()), MYSQL_NUM);
 202     }
 203
 204     private static function findQuery($params, $default = array())
 205     {
 206         for ($i = 0 ; $i < count($default) ; ++$i) {
 207             $is_query = false;
 208             foreach (array('insert', 'select', 'replace', 'delete', 'update') as $kwd) {
 209                 if (stripos($params[0], $kwd) !== false) {
 210                     $is_query = true;
 211                     break;
 212                 }
 213             }
 214             if ($is_query) {
 215                 break;
 216             } else {
 217                 $default[$i] = array_shift($params);
 218             }
 219         }
 220         return array($default, $params);
 221     }
 222
 223     /** Fetch all rows returned by the given query.
 224      * This functions can take 2 optional arguments (cf XOrgDBResult::fetchAllRow()).
 225      * Optional arguments are given *before* the query.
 226      */
 227     public static function fetchAllRow()
 228     {
 229         list($args, $query) = self::findQuery(func_get_args(), array(false, false));
 230         return self::queryv($query)->fetchAllRow($args[0], $args[1]);
 231     }
 232
 233     /** Fetch all rows returned by the given query.
 234      * This functions can take 2 optional arguments (cf XOrgDBResult::fetchAllAssoc()).
 235      * Optional arguments are given *before* the query.
 236      */
 237     public static function fetchAllAssoc()
 238     {
 239         list($args, $query) = self::findQuery(func_get_args(), array(false, false));
 240         return self::queryv($query)->fetchAllAssoc($args[0], $args[1]);
 241     }
 242
 243     public static function fetchOneCell()
 244     {
 245         list($args, $query) = self::findQuery(func_get_args());
 246         return self::queryv($query)->fetchOneCell();
 247     }
 248
 249     public static function fetchOneRow()
 250     {
 251         list($args, $query) = self::findQuery(func_get_args());
 252         return self::queryv($query)->fetchOneRow();
 253     }
 254
 255     public static function fetchOneAssoc()
 256     {
 257         list($args, $query) = self::findQuery(func_get_args());
 258         return self::queryv($query)->fetchOneAssoc();
 259     }
 260
 261     /** Fetch a column from the result of the given query.
 262      * This functions can take 1 optional arguments (cf XOrgDBResult::fetchColumn()).
 263      * Optional arguments are given *before* the query.
 264      */
 265     public static function fetchColumn()
 266     {
 267         list($args, $query) = self::findQuery(func_get_args(), array(0));
 268         return self::queryv($query)->fetchColumn();
 269     }
 270
 271     public static function insertId()
 272     {
 273         return self::$mysqli->insert_id;
 274     }
 275
 276     public static function errno()
 277     {
 278         return self::$mysqli->errno;
 279     }
 280
 281     public static function error()
 282     {
 283         return self::$mysqli->error;
 284     }
 285
 286     public static function affectedRows()
 287     {
 288         return self::$mysqli->affected_rows;
 289     }
 290
 291     public static function escape($var)
 292     {
 293         switch (gettype($var)) {
 294           case 'boolean':
 295             return $var ? 1 : 0;
 296
 297           case 'integer':
 298           case 'double':
 299           case 'float':
 300             return $var;
 301
 302           case 'string':
 303             return "'".addslashes($var)."'";
 304
 305           case 'NULL':
 306             return 'NULL';
 307
 308           case 'object':
 309             if ($var instanceof PlFlagSet) {
 310                 return "'" . addslashes($var->flags()) . "'";
 311             }
 312           case 'array':
 313             return "'".addslashes(serialize($var))."'";
 314
 315           default:
 316             die(var_export($var, true).' is not a valid for a database entry');
 317         }
 318     }
 319 }
 320
 321 class XOrgDBResult
 322 {
 323
 324     private $_res;
 325
 326     public function __construct($query)
 327     {
 328         $this->_res = XDB::_query($query);
 329     }
 330
 331     public function free()
 332     {
 333         if ($this->_res) {
 334             $this->_res->free();
 335         }
 336         unset($this);
 337     }
 338
 339     protected function _fetchRow()
 340     {
 341         return $this->_res ? $this->_res->fetch_row() : null;
 342     }
 343
 344     protected function _fetchAssoc()
 345     {
 346         return $this->_res ? $this->_res->fetch_assoc() : null;
 347     }
 348
 349     public function fetchAllRow($id = false, $keep_array = false)
 350     {
 351         $result = Array();
 352         if (!$this->_res) {
 353             return $result;
 354         }
 355         while (($data = $this->_res->fetch_row())) {
 356             if ($id !== false) {
 357                 $key = $data[$id];
 358                 unset($data[$id]);
 359                 if (!$keep_array && count($data) == 1) {
 360                     reset($data);
 361                     $result[$key] = current($data);
 362                 } else {
 363                     $result[$key] = $data;
 364                 }
 365             } else {
 366                 $result[] = $data;
 367             }
 368         }
 369         $this->free();
 370         return $result;
 371     }
 372
 373     public function fetchAllAssoc($id = false, $keep_array = false)
 374     {
 375         $result = Array();
 376         if (!$this->_res) {
 377             return $result;
 378         }
 379         while (($data = $this->_res->fetch_assoc())) {
 380             if ($id !== false) {
 381                 $key = $data[$id];
 382                 unset($data[$id]);
 383                 if (!$keep_array && count($data) == 1) {
 384                     reset($data);
 385                     $result[$key] = current($data);
 386                 } else {
 387                     $result[$key] = $data;
 388                 }
 389             } else {
 390                 $result[] = $data;
 391             }
 392         }
 393         $this->free();
 394         return $result;
 395     }
 396
 397     public function fetchOneAssoc()
 398     {
 399         $tmp = $this->_fetchAssoc();
 400         $this->free();
 401         return $tmp;
 402     }
 403
 404     public function fetchOneRow()
 405     {
 406         $tmp = $this->_fetchRow();
 407         $this->free();
 408         return $tmp;
 409     }
 410
 411     public function fetchOneCell()
 412     {
 413         $tmp = $this->_fetchRow();
 414         $this->free();
 415         return $tmp[0];
 416     }
 417
 418     public function fetchColumn($key = 0)
 419     {
 420         $res = Array();
 421         if (is_numeric($key)) {
 422             while($tmp = $this->_fetchRow()) {
 423                 $res[] = $tmp[$key];
 424             }
 425         } else {
 426             while($tmp = $this->_fetchAssoc()) {
 427                 $res[] = $tmp[$key];
 428             }
 429         }
 430         $this->free();
 431         return $res;
 432     }
 433
 434     public function fetchOneField()
 435     {
 436         return $this->_res ? $this->_res->fetch_field() : null;
 437     }
 438
 439     public function fetchFields()
 440     {
 441         $res = array();
 442         while ($res[] = $this->fetchOneField());
 443         return $res;
 444     }
 445
 446     public function numRows()
 447     {
 448         return $this->_res ? $this->_res->num_rows : 0;
 449     }
 450
 451     public function fieldCount()
 452     {
 453         return $this->_res ? $this->_res->field_count : 0;
 454     }
 455 }
 456
 457 require_once dirname(__FILE__) . '/pliterator.php';
 458
 459 class XOrgDBIterator extends XOrgDBResult implements PlIterator
 460 {
 461     private $_result;
 462     private $_pos;
 463     private $_total;
 464     private $_fpos;
 465     private $_fields;
 466     private $_mode = MYSQL_ASSOC;
 467
 468     public function __construct($query, $mode = MYSQL_ASSOC)
 469     {
 470         parent::__construct($query);
 471         $this->_pos    = 0;
 472         $this->_total  = $this->numRows();
 473         $this->_fpost  = 0;
 474         $this->_fields = $this->fieldCount();
 475         $this->_mode   = $mode;
 476     }
 477
 478     public function next()
 479     {
 480         $this->_pos ++;
 481         if ($this->_pos > $this->_total) {
 482             $this->free();
 483             unset($this);
 484             return null;
 485         }
 486         return $this->_mode != MYSQL_ASSOC ? $this->_fetchRow() : $this->_fetchAssoc();
 487     }
 488
 489     public function first()
 490     {
 491         return $this->_pos == 1;
 492     }
 493
 494     public function last()
 495     {
 496         return $this->_pos == $this->_total;
 497     }
 498
 499     public function total()
 500     {
 501         return $this->_total;
 502     }
 503
 504     public function nextField()
 505     {
 506         $this->_fpos++;
 507         if ($this->_fpos > $this->_fields) {
 508             return null;
 509         }
 510         return $this->fetchOneField();
 511     }
 512
 513     public function firstField()
 514     {
 515         return $this->_fpos == 1;
 516     }
 517
 518     public function lastField()
 519     {
 520         return $this->_fpos == $this->_fields;
 521     }
 522
 523     public function totalFields()
 524     {
 525         return $this->_fields;
 526     }
 527 }
 528
 529 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8:
 530 ?>