classes/xdb.php

   1 <?php
   2 /***************************************************************************
   3  *  Copyright (C) 2003-2008 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         XDB::$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         XDB::$mysqli->autocommit(true);
  38         XDB::$mysqli->set_charset($globals->dbcharset);
  39         return true;
  40     }
  41
  42     public static function _prepare($args)
  43     {
  44         $query    = array_map(Array('XDB', 'escape'), $args);
  45         $query[0] = str_replace('{?}', '%s', str_replace('%',   '%%', $args[0]));
  46         return call_user_func_array('sprintf', $query);
  47     }
  48
  49     public static function _reformatQuery($query)
  50     {
  51         $query  = preg_split("/\n\\s*/", trim($query));
  52         $length = 0;
  53         foreach ($query as $key=>$line) {
  54             $local = -2;
  55             if (preg_match('/^([A-Z]+(?:\s+(?:JOIN|BY|FROM|INTO))?)\s+(.*)/u', $line, $matches)
  56             && $matches[1] != 'AND' && $matches[1] != 'OR')
  57             {
  58                 $local  = strlen($matches[1]);
  59                 $line   = $matches[1] . '  ' . $matches[2];
  60                 $length = max($length, $local);
  61             }
  62             $query[$key] = array($line, $local);
  63         }
  64         $res = '';
  65         foreach ($query as $array) {
  66             list($line, $local) = $array;
  67             $local   = max(0, $length - $local);
  68             $res    .= str_repeat(' ', $local) . $line . "\n";
  69             $length += 2 * (substr_count($line, '(') - substr_count($line, ')'));
  70         }
  71         return $res;
  72     }
  73
  74     public static function _query($query)
  75     {
  76         global $globals;
  77
  78         if (!XDB::$mysqli && !XDB::connect()) {
  79             return false;
  80         }
  81
  82         if ($globals->debug & DEBUG_BT) {
  83             $explain = array();
  84             if (strpos($query, 'FOUND_ROWS()') === false) {
  85                 $res = XDB::$mysqli->query("EXPLAIN $query");
  86                 if ($res) {
  87                     while ($row = $res->fetch_assoc()) {
  88                         $explain[] = $row;
  89                     }
  90                     $res->free();
  91                 }
  92             }
  93             PlBacktrace::$bt['MySQL']->start(XDB::_reformatQuery($query));
  94         }
  95
  96         $res = XDB::$mysqli->query($query);
  97
  98         if ($globals->debug & DEBUG_BT) {
  99             PlBacktrace::$bt['MySQL']->stop(@$res->num_rows ? $res->num_rows : XDB::$mysqli->affected_rows,
 100                                             XDB::$mysqli->error,
 101                                             $explain);
 102         }
 103         return $res;
 104     }
 105
 106     public static function query()
 107     {
 108         return new XOrgDBResult(XDB::_prepare(func_get_args()));
 109     }
 110
 111     public static function execute()
 112     {
 113         global $globals;
 114         $args = func_get_args();
 115         if ($globals->mode != 'rw' && !strpos($args[0], 'logger')) {
 116             return;
 117         }
 118         return XDB::_query(XDB::_prepare($args));
 119     }
 120
 121     public static function iterator()
 122     {
 123         return new XOrgDBIterator(XDB::_prepare(func_get_args()));
 124     }
 125
 126     public static function iterRow()
 127     {
 128         return new XOrgDBIterator(XDB::_prepare(func_get_args()), MYSQL_NUM);
 129     }
 130
 131     public static function insertId()
 132     {
 133         return XDB::$mysqli->insert_id;
 134     }
 135
 136     public static function errno()
 137     {
 138         return XDB::$mysqli->errno;
 139     }
 140
 141     public static function error()
 142     {
 143         return XDB::$mysqli->error;
 144     }
 145
 146     public static function affectedRows()
 147     {
 148         return XDB::$mysqli->affected_rows;
 149     }
 150
 151     public static function escape($var)
 152     {
 153         switch (gettype($var)) {
 154           case 'boolean':
 155             return $var ? 1 : 0;
 156
 157           case 'integer':
 158           case 'double':
 159           case 'float':
 160             return $var;
 161
 162           case 'string':
 163             return "'".addslashes($var)."'";
 164
 165           case 'NULL':
 166             return 'NULL';
 167
 168           case 'object':
 169           case 'array':
 170             return "'".addslashes(serialize($var))."'";
 171
 172           default:
 173             die(var_export($var, true).' is not a valid for a database entry');
 174         }
 175     }
 176 }
 177
 178 class XOrgDBResult
 179 {
 180
 181     private $_res;
 182
 183     public function __construct($query)
 184     {
 185         $this->_res = XDB::_query($query);
 186     }
 187
 188     public function free()
 189     {
 190         if ($this->_res) {
 191             $this->_res->free();
 192         }
 193         unset($this);
 194     }
 195
 196     protected function _fetchRow()
 197     {
 198         return $this->_res ? $this->_res->fetch_row() : null;
 199     }
 200
 201     protected function _fetchAssoc()
 202     {
 203         return $this->_res ? $this->_res->fetch_assoc() : null;
 204     }
 205
 206     public function fetchAllRow()
 207     {
 208         $result = Array();
 209         if (!$this->_res) {
 210             return $result;
 211         }
 212         while ($result[] = $this->_res->fetch_row());
 213         array_pop($result);
 214         $this->free();
 215         return $result;
 216     }
 217
 218     public function fetchAllAssoc()
 219     {
 220         $result = Array();
 221         if (!$this->_res) {
 222             return $result;
 223         }
 224         while ($result[] = $this->_res->fetch_assoc());
 225         array_pop($result);
 226         $this->free();
 227         return $result;
 228     }
 229
 230     public function fetchOneAssoc()
 231     {
 232         $tmp = $this->_fetchAssoc();
 233         $this->free();
 234         return $tmp;
 235     }
 236
 237     public function fetchOneRow()
 238     {
 239         $tmp = $this->_fetchRow();
 240         $this->free();
 241         return $tmp;
 242     }
 243
 244     public function fetchOneCell()
 245     {
 246         $tmp = $this->_fetchRow();
 247         $this->free();
 248         return $tmp[0];
 249     }
 250
 251     public function fetchColumn($key = 0)
 252     {
 253         $res = Array();
 254         if (is_numeric($key)) {
 255             while($tmp = $this->_fetchRow()) {
 256                 $res[] = $tmp[$key];
 257             }
 258         } else {
 259             while($tmp = $this->_fetchAssoc()) {
 260                 $res[] = $tmp[$key];
 261             }
 262         }
 263         $this->free();
 264         return $res;
 265     }
 266
 267     public function fetchOneField()
 268     {
 269         return $this->_res ? $this->_res->fetch_field() : null;
 270     }
 271
 272     public function fetchFields()
 273     {
 274         $res = array();
 275         while ($res[] = $this->fetchOneField());
 276         return $res;
 277     }
 278
 279     public function numRows()
 280     {
 281         return $this->_res ? $this->_res->num_rows : 0;
 282     }
 283
 284     public function fieldCount()
 285     {
 286         return $this->_res ? $this->_res->field_count : 0;
 287     }
 288 }
 289
 290 require_once dirname(__FILE__) . '/pliterator.php';
 291
 292 class XOrgDBIterator extends XOrgDBResult implements PlIterator
 293 {
 294     private $_result;
 295     private $_pos;
 296     private $_total;
 297     private $_fpos;
 298     private $_fields;
 299     private $_mode = MYSQL_ASSOC;
 300
 301     public function __construct($query, $mode = MYSQL_ASSOC)
 302     {
 303         parent::__construct($query);
 304         $this->_pos    = 0;
 305         $this->_total  = $this->numRows();
 306         $this->_fpost  = 0;
 307         $this->_fields = $this->fieldCount();
 308         $this->_mode   = $mode;
 309     }
 310
 311     public function next()
 312     {
 313         $this->_pos ++;
 314         if ($this->_pos > $this->_total) {
 315             $this->free();
 316             unset($this);
 317             return null;
 318         }
 319         return $this->_mode != MYSQL_ASSOC ? $this->_fetchRow() : $this->_fetchAssoc();
 320     }
 321
 322     public function first()
 323     {
 324         return $this->_pos == 1;
 325     }
 326
 327     public function last()
 328     {
 329         return $this->_pos == $this->_total;
 330     }
 331
 332     public function total()
 333     {
 334         return $this->_total;
 335     }
 336
 337     public function nextField()
 338     {
 339         $this->_fpos++;
 340         if ($this->_fpos > $this->_fields) {
 341             return null;
 342         }
 343         return $this->fetchOneField();
 344     }
 345
 346     public function firstField()
 347     {
 348         return $this->_fpos == 1;
 349     }
 350
 351     public function lastField()
 352     {
 353         return $this->_fpos == $this->_fields;
 354     }
 355
 356     public function totalFields()
 357     {
 358         return $this->_fields;
 359     }
 360 }
 361
 362 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8:
 363 ?>