classes/xdb.php

   1 <?php
   2 /***************************************************************************
   3  *  Copyright (C) 2003-2010 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 run($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 && strpos($query, 'AUTOCOMMIT') === 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             throw new XDBException(XDB::reformatQuery($query), XDB::$mysqli->error);
 111         }
 112         return $res;
 113     }
 114
 115     private static function queryv($query)
 116     {
 117         return new XDBResult(self::prepare($query));
 118     }
 119
 120     public static function query()
 121     {
 122         return self::queryv(func_get_args());
 123     }
 124
 125     public static function rawQuery($query)
 126     {
 127         return new XDBResult($query);
 128     }
 129
 130     public static function format()
 131     {
 132         return self::prepare(func_get_args());
 133     }
 134
 135     // Produce the SQL statement for setting/unsetting a flag
 136     public static function changeFlag($fieldname, $flagname, $state)
 137     {
 138         if ($state) {
 139             return XDB::format($fieldname . ' = CONCAT({?}, \',\', ' . $fieldname . ')', $flagname);
 140         } else {
 141             return XDB::format($fieldname . ' = REPLACE(' . $fieldname . ', {?}, \'\')', $flagname);
 142         }
 143     }
 144
 145     // Produce the SQL statement representing an array
 146     public static function formatArray(array $array)
 147     {
 148         return self::escape($array);
 149     }
 150
 151     const WILDCARD_EXACT    = 0x00;
 152     const WILDCARD_PREFIX   = 0x01;
 153     const WILDCARD_SUFFIX   = 0x02;
 154     const WILDCARD_CONTAINS = 0x03; // WILDCARD_PREFIX | WILDCARD_SUFFIX
 155
 156     // Produce a valid XDB argument that get formatted as a wildcard
 157     // according to the given mode.
 158     //
 159     // Example:
 160     // XDB::query("SELECT * FROM table WHERE field {?}", XDB::wildcard($text, WILDCARD_EXACT));
 161     public static function wildcard($mode, $value)
 162     {
 163       return new XDBWildcard($value, $mode);
 164     }
 165
 166     // Returns the SQL statement for a wildcard search.
 167     public static function formatWildcards($mode, $text)
 168     {
 169         return XDB::wildcard($mode, $text)->format();
 170     }
 171
 172     // Returns a FIELD(blah, 3, 1, 2) for use in an order with custom orders
 173     public static function formatCustomOrder($field, $values)
 174     {
 175         return 'FIELD( ' . $field . ', ' . implode(', ', array_map(array('XDB', 'escape'), $values)) . ')';
 176     }
 177
 178     public static function execute()
 179     {
 180         global $globals;
 181         $args = func_get_args();
 182         if ($globals->mode != 'rw' && !strpos($args[0], 'logger')) {
 183             return;
 184         }
 185         return self::run(XDB::prepare($args));
 186     }
 187
 188     public static function rawExecute($query)
 189     {
 190         global $globals;
 191         if ($globals->mode != 'rw') {
 192             return;
 193         }
 194         return self::run($query);
 195     }
 196
 197     public static function startTransaction()
 198     {
 199         self::rawExecute('SET AUTOCOMMIT = 0');
 200         self::rawExecute('START TRANSACTION');
 201     }
 202
 203     public static function commit()
 204     {
 205         self::rawExecute('COMMIT');
 206         self::rawExecute('SET AUTOCOMMIT = 1');
 207     }
 208
 209     public static function rollback()
 210     {
 211         self::rawExecute('ROLLBACK');
 212         self::rawExecute('SET AUTOCOMMIT = 1');
 213     }
 214
 215     public static function iterator()
 216     {
 217         return new XDBIterator(self::prepare(func_get_args()));
 218     }
 219
 220     public static function rawIterator($query)
 221     {
 222         return new XDBIterator($query);
 223     }
 224
 225     public static function iterRow()
 226     {
 227         return new XDBIterator(self::prepare(func_get_args()), MYSQL_NUM);
 228     }
 229
 230     public static function rawIterRow($query)
 231     {
 232         return new XDBIterator($query, MYSQL_NUM);
 233     }
 234
 235     private static function findQuery($params, $default = array())
 236     {
 237         for ($i = 0 ; $i < count($default) ; ++$i) {
 238             $is_query = false;
 239             foreach (array('insert', 'select', 'replace', 'delete', 'update') as $kwd) {
 240                 if (stripos($params[0], $kwd) !== false) {
 241                     $is_query = true;
 242                     break;
 243                 }
 244             }
 245             if ($is_query) {
 246                 break;
 247             } else {
 248                 $default[$i] = array_shift($params);
 249             }
 250         }
 251         return array($default, $params);
 252     }
 253
 254     /** Fetch all rows returned by the given query.
 255      * This functions can take 2 optional arguments (cf XDBResult::fetchAllRow()).
 256      * Optional arguments are given *before* the query.
 257      */
 258     public static function fetchAllRow()
 259     {
 260         list($args, $query) = self::findQuery(func_get_args(), array(false, false));
 261         return self::queryv($query)->fetchAllRow($args[0], $args[1]);
 262     }
 263
 264     public static function rawFetchAllRow($query, $id = false, $keep_array = false)
 265     {
 266         return self::rawQuery($query)->fetchAllRow($id, $keep_array);
 267     }
 268
 269     /** Fetch all rows returned by the given query.
 270      * This functions can take 2 optional arguments (cf XDBResult::fetchAllAssoc()).
 271      * Optional arguments are given *before* the query.
 272      */
 273     public static function fetchAllAssoc()
 274     {
 275         list($args, $query) = self::findQuery(func_get_args(), array(false, false));
 276         return self::queryv($query)->fetchAllAssoc($args[0], $args[1]);
 277     }
 278
 279     public static function rawFetchAllAssoc($query, $id = false, $keep_array = false)
 280     {
 281         return self::rawQuery($query)->fetchAllAssoc($id, $keep_array);
 282     }
 283
 284     public static function fetchOneCell()
 285     {
 286         list($args, $query) = self::findQuery(func_get_args());
 287         return self::queryv($query)->fetchOneCell();
 288     }
 289
 290     public static function rawFetchOneCell($query)
 291     {
 292         return self::rawQuery($query)->fetchOneCell();
 293     }
 294
 295     public static function fetchOneRow()
 296     {
 297         list($args, $query) = self::findQuery(func_get_args());
 298         return self::queryv($query)->fetchOneRow();
 299     }
 300
 301     public static function rawFetchOneRow($query)
 302     {
 303         return self::rawQuery($query)->fetchOneRow();
 304     }
 305
 306     public static function fetchOneAssoc()
 307     {
 308         list($args, $query) = self::findQuery(func_get_args());
 309         return self::queryv($query)->fetchOneAssoc();
 310     }
 311
 312     public static function rawFetchOneAssoc($query)
 313     {
 314         return self::rawQuery($query)->fetchOneAssoc();
 315     }
 316
 317     /** Fetch a column from the result of the given query.
 318      * This functions can take 1 optional arguments (cf XDBResult::fetchColumn()).
 319      * Optional arguments are given *before* the query.
 320      */
 321     public static function fetchColumn()
 322     {
 323         list($args, $query) = self::findQuery(func_get_args(), array(0));
 324         return self::queryv($query)->fetchColumn($args[0]);
 325     }
 326
 327     public static function rawFetchColumn($query, $key = 0)
 328     {
 329         return self::rawQuery($query)->fetchColumn($key);
 330     }
 331
 332     public static function insertId()
 333     {
 334         return self::$mysqli->insert_id;
 335     }
 336
 337     public static function errno()
 338     {
 339         return self::$mysqli->errno;
 340     }
 341
 342     public static function error()
 343     {
 344         return self::$mysqli->error;
 345     }
 346
 347     public static function affectedRows()
 348     {
 349         return self::$mysqli->affected_rows;
 350     }
 351
 352     public static function escape($var)
 353     {
 354         switch (gettype($var)) {
 355           case 'boolean':
 356             return $var ? 1 : 0;
 357
 358           case 'integer':
 359           case 'double':
 360           case 'float':
 361             return $var;
 362
 363           case 'string':
 364             return "'".addslashes($var)."'";
 365
 366           case 'NULL':
 367             return 'NULL';
 368
 369           case 'object':
 370             if ($var instanceof XDBFormat) {
 371                 return $var->format();
 372             } else {
 373                 return "'".addslashes(serialize($var))."'";
 374             }
 375
 376           case 'array':
 377             return '(' . implode(', ', array_map(array('XDB', 'escape'), $var)) . ')';
 378
 379           default:
 380             die(var_export($var, true).' is not a valid for a database entry');
 381         }
 382     }
 383 }
 384
 385 class XDBException extends PlException
 386 {
 387     public function __construct($query, $error)
 388     {
 389         if (strpos($query, 'INSERT') === false && strpos($query, 'UPDATE') === false
 390             && strpos($query, 'REPLACE') === false && strpos($query, 'DELETE') === false) {
 391             $text = 'Erreur lors de l\'interrogation de la base de données';
 392         } else {
 393             $text = 'Erreur lors de l\'écriture dans la base de données';
 394         }
 395         parent::__construct($text, $query . "\n" . $error);
 396     }
 397 }
 398
 399 interface XDBFormat
 400 {
 401     public function format();
 402 }
 403
 404 class XDBWildcard implements XDBFormat
 405 {
 406     private $value;
 407     private $mode;
 408
 409     public function __construct($value, $mode)
 410     {
 411         $this->value = $value;
 412         $this->mode  = $mode;
 413     }
 414
 415     public function format()
 416     {
 417         if ($this->mode == XDB::WILDCARD_EXACT) {
 418             return XDB::format(' = {?}', $this->value);
 419         } else {
 420             $text = str_replace(array('%', '_'), array('\%', '\_'), $this->value);
 421             if ($this->mode & XDB::WILDCARD_PREFIX) {
 422                 $text = $text . '%';
 423             }
 424             if ($this->mode & XDB::WILDCARD_SUFFIX) {
 425                 $text = '%' . $text;
 426             }
 427             return XDB::format(" LIKE {?}", $text);
 428         }
 429     }
 430 }
 431
 432
 433 class XDBResult
 434 {
 435     private $res;
 436
 437     public function __construct($query)
 438     {
 439         $this->res = XDB::run($query);
 440     }
 441
 442     public function free()
 443     {
 444         if ($this->res) {
 445             $this->res->free();
 446         }
 447         unset($this);
 448     }
 449
 450     protected function fetchRow()
 451     {
 452         return $this->res ? $this->res->fetch_row() : null;
 453     }
 454
 455     protected function fetchAssoc()
 456     {
 457         return $this->res ? $this->res->fetch_assoc() : null;
 458     }
 459
 460     public function fetchAllRow($id = false, $keep_array = false)
 461     {
 462         $result = Array();
 463         if (!$this->res) {
 464             return $result;
 465         }
 466         while (($data = $this->res->fetch_row())) {
 467             if ($id !== false) {
 468                 $key = $data[$id];
 469                 unset($data[$id]);
 470                 if (!$keep_array && count($data) == 1) {
 471                     reset($data);
 472                     $result[$key] = current($data);
 473                 } else {
 474                     $result[$key] = $data;
 475                 }
 476             } else {
 477                 $result[] = $data;
 478             }
 479         }
 480         $this->free();
 481         return $result;
 482     }
 483
 484     public function fetchAllAssoc($id = false, $keep_array = false)
 485     {
 486         $result = Array();
 487         if (!$this->res) {
 488             return $result;
 489         }
 490         while (($data = $this->res->fetch_assoc())) {
 491             if ($id !== false) {
 492                 $key = $data[$id];
 493                 unset($data[$id]);
 494                 if (!$keep_array && count($data) == 1) {
 495                     reset($data);
 496                     $result[$key] = current($data);
 497                 } else {
 498                     $result[$key] = $data;
 499                 }
 500             } else {
 501                 $result[] = $data;
 502             }
 503         }
 504         $this->free();
 505         return $result;
 506     }
 507
 508     public function fetchOneAssoc()
 509     {
 510         $tmp = $this->fetchAssoc();
 511         $this->free();
 512         return $tmp;
 513     }
 514
 515     public function fetchOneRow()
 516     {
 517         $tmp = $this->fetchRow();
 518         $this->free();
 519         return $tmp;
 520     }
 521
 522     public function fetchOneCell()
 523     {
 524         $tmp = $this->fetchRow();
 525         $this->free();
 526         return $tmp[0];
 527     }
 528
 529     public function fetchColumn($key = 0)
 530     {
 531         $res = Array();
 532         if (is_numeric($key)) {
 533             while($tmp = $this->fetchRow()) {
 534                 $res[] = $tmp[$key];
 535             }
 536         } else {
 537             while($tmp = $this->fetchAssoc()) {
 538                 $res[] = $tmp[$key];
 539             }
 540         }
 541         $this->free();
 542         return $res;
 543     }
 544
 545     public function fetchOneField()
 546     {
 547         return $this->res ? $this->res->fetch_field() : null;
 548     }
 549
 550     public function fetchFields()
 551     {
 552         $res = array();
 553         while ($res[] = $this->fetchOneField());
 554         return $res;
 555     }
 556
 557     public function numRows()
 558     {
 559         return $this->res ? $this->res->num_rows : 0;
 560     }
 561
 562     public function fieldCount()
 563     {
 564         return $this->res ? $this->res->field_count : 0;
 565     }
 566 }
 567
 568
 569 class XDBIterator extends XDBResult implements PlIterator
 570 {
 571     private $result;
 572     private $pos;
 573     private $total;
 574     private $fpos;
 575     private $fields;
 576     private $mode = MYSQL_ASSOC;
 577
 578     public function __construct($query, $mode = MYSQL_ASSOC)
 579     {
 580         parent::__construct($query);
 581         $this->pos    = 0;
 582         $this->total  = $this->numRows();
 583         $this->fpost  = 0;
 584         $this->fields = $this->fieldCount();
 585         $this->mode   = $mode;
 586     }
 587
 588     public function next()
 589     {
 590         $this->pos ++;
 591         if ($this->pos > $this->total) {
 592             $this->free();
 593             unset($this);
 594             return null;
 595         }
 596         return $this->mode != MYSQL_ASSOC ? $this->fetchRow() : $this->fetchAssoc();
 597     }
 598
 599     public function first()
 600     {
 601         return $this->pos == 1;
 602     }
 603
 604     public function last()
 605     {
 606         return $this->pos == $this->total;
 607     }
 608
 609     public function total()
 610     {
 611         return $this->total;
 612     }
 613
 614     public function nextField()
 615     {
 616         $this->fpos++;
 617         if ($this->fpos > $this->fields) {
 618             return null;
 619         }
 620         return $this->fetchOneField();
 621     }
 622
 623     public function firstField()
 624     {
 625         return $this->fpos == 1;
 626     }
 627
 628     public function lastField()
 629     {
 630         return $this->fpos == $this->fields;
 631     }
 632
 633     public function totalFields()
 634     {
 635         return $this->fields;
 636     }
 637 }
 638
 639 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8:
 640 ?>