source: branches/dev/data/module/MDB2.php @ 15960

Revision 15960, 137.6 KB checked in by kakinaka, 15 years ago (diff)
Line 
1<?php
2// vim: set et ts=4 sw=4 fdm=marker:
3// +----------------------------------------------------------------------+
4// | PHP versions 4 and 5                                                 |
5// +----------------------------------------------------------------------+
6// | Copyright (c) 1998-2007 Manuel Lemos, Tomas V.V.Cox,                 |
7// | Stig. S. Bakken, Lukas Smith                                         |
8// | All rights reserved.                                                 |
9// +----------------------------------------------------------------------+
10// | MDB2 is a merge of PEAR DB and Metabases that provides a unified DB  |
11// | API as well as database abstraction for PHP applications.            |
12// | This LICENSE is in the BSD license style.                            |
13// |                                                                      |
14// | Redistribution and use in source and binary forms, with or without   |
15// | modification, are permitted provided that the following conditions   |
16// | are met:                                                             |
17// |                                                                      |
18// | Redistributions of source code must retain the above copyright       |
19// | notice, this list of conditions and the following disclaimer.        |
20// |                                                                      |
21// | Redistributions in binary form must reproduce the above copyright    |
22// | notice, this list of conditions and the following disclaimer in the  |
23// | documentation and/or other materials provided with the distribution. |
24// |                                                                      |
25// | Neither the name of Manuel Lemos, Tomas V.V.Cox, Stig. S. Bakken,    |
26// | Lukas Smith nor the names of his contributors may be used to endorse |
27// | or promote products derived from this software without specific prior|
28// | written permission.                                                  |
29// |                                                                      |
30// | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS  |
31// | "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT    |
32// | LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS    |
33// | FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE      |
34// | REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,          |
35// | INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, |
36// | BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS|
37// |  OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED  |
38// | AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT          |
39// | LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY|
40// | WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE          |
41// | POSSIBILITY OF SUCH DAMAGE.                                          |
42// +----------------------------------------------------------------------+
43// | Author: Lukas Smith <smith@pooteeweet.org>                           |
44// +----------------------------------------------------------------------+
45//
46// $Id: MDB2.php,v 1.292 2007/04/25 09:31:01 quipo Exp $
47//
48
49/**
50 * @package     MDB2
51 * @category    Database
52 * @author      Lukas Smith <smith@pooteeweet.org>
53 */
54
55if(!defined('MDB2_PHP_DIR')) {
56    $MDB2_PHP_DIR = realpath(dirname( __FILE__));
57    define("MDB2_PHP_DIR", $MDB2_PHP_DIR); 
58}
59
60require_once MDB2_PHP_DIR . '/PEAR.php';
61
62// {{{ Error constants
63
64/**
65 * The method mapErrorCode in each MDB2_dbtype implementation maps
66 * native error codes to one of these.
67 *
68 * If you add an error code here, make sure you also add a textual
69 * version of it in MDB2::errorMessage().
70 */
71
72define('MDB2_OK',                      true);
73define('MDB2_ERROR',                     -1);
74define('MDB2_ERROR_SYNTAX',              -2);
75define('MDB2_ERROR_CONSTRAINT',          -3);
76define('MDB2_ERROR_NOT_FOUND',           -4);
77define('MDB2_ERROR_ALREADY_EXISTS',      -5);
78define('MDB2_ERROR_UNSUPPORTED',         -6);
79define('MDB2_ERROR_MISMATCH',            -7);
80define('MDB2_ERROR_INVALID',             -8);
81define('MDB2_ERROR_NOT_CAPABLE',         -9);
82define('MDB2_ERROR_TRUNCATED',          -10);
83define('MDB2_ERROR_INVALID_NUMBER',     -11);
84define('MDB2_ERROR_INVALID_DATE',       -12);
85define('MDB2_ERROR_DIVZERO',            -13);
86define('MDB2_ERROR_NODBSELECTED',       -14);
87define('MDB2_ERROR_CANNOT_CREATE',      -15);
88define('MDB2_ERROR_CANNOT_DELETE',      -16);
89define('MDB2_ERROR_CANNOT_DROP',        -17);
90define('MDB2_ERROR_NOSUCHTABLE',        -18);
91define('MDB2_ERROR_NOSUCHFIELD',        -19);
92define('MDB2_ERROR_NEED_MORE_DATA',     -20);
93define('MDB2_ERROR_NOT_LOCKED',         -21);
94define('MDB2_ERROR_VALUE_COUNT_ON_ROW', -22);
95define('MDB2_ERROR_INVALID_DSN',        -23);
96define('MDB2_ERROR_CONNECT_FAILED',     -24);
97define('MDB2_ERROR_EXTENSION_NOT_FOUND',-25);
98define('MDB2_ERROR_NOSUCHDB',           -26);
99define('MDB2_ERROR_ACCESS_VIOLATION',   -27);
100define('MDB2_ERROR_CANNOT_REPLACE',     -28);
101define('MDB2_ERROR_CONSTRAINT_NOT_NULL',-29);
102define('MDB2_ERROR_DEADLOCK',           -30);
103define('MDB2_ERROR_CANNOT_ALTER',       -31);
104define('MDB2_ERROR_MANAGER',            -32);
105define('MDB2_ERROR_MANAGER_PARSE',      -33);
106define('MDB2_ERROR_LOADMODULE',         -34);
107define('MDB2_ERROR_INSUFFICIENT_DATA',  -35);
108// }}}
109// {{{ Verbose constants
110/**
111 * These are just helper constants to more verbosely express parameters to prepare()
112 */
113
114define('MDB2_PREPARE_MANIP', false);
115define('MDB2_PREPARE_RESULT', null);
116
117// }}}
118// {{{ Fetchmode constants
119
120/**
121 * This is a special constant that tells MDB2 the user hasn't specified
122 * any particular get mode, so the default should be used.
123 */
124define('MDB2_FETCHMODE_DEFAULT', 0);
125
126/**
127 * Column data indexed by numbers, ordered from 0 and up
128 */
129define('MDB2_FETCHMODE_ORDERED', 1);
130
131/**
132 * Column data indexed by column names
133 */
134define('MDB2_FETCHMODE_ASSOC', 2);
135
136/**
137 * Column data as object properties
138 */
139define('MDB2_FETCHMODE_OBJECT', 3);
140
141/**
142 * For multi-dimensional results: normally the first level of arrays
143 * is the row number, and the second level indexed by column number or name.
144 * MDB2_FETCHMODE_FLIPPED switches this order, so the first level of arrays
145 * is the column name, and the second level the row number.
146 */
147define('MDB2_FETCHMODE_FLIPPED', 4);
148
149// }}}
150// {{{ Portability mode constants
151
152/**
153 * Portability: turn off all portability features.
154 * @see MDB2_Driver_Common::setOption()
155 */
156define('MDB2_PORTABILITY_NONE', 0);
157
158/**
159 * Portability: convert names of tables and fields to case defined in the
160 * "field_case" option when using the query*(), fetch*() and tableInfo() methods.
161 * @see MDB2_Driver_Common::setOption()
162 */
163define('MDB2_PORTABILITY_FIX_CASE', 1);
164
165/**
166 * Portability: right trim the data output by query*() and fetch*().
167 * @see MDB2_Driver_Common::setOption()
168 */
169define('MDB2_PORTABILITY_RTRIM', 2);
170
171/**
172 * Portability: force reporting the number of rows deleted.
173 * @see MDB2_Driver_Common::setOption()
174 */
175define('MDB2_PORTABILITY_DELETE_COUNT', 4);
176
177/**
178 * Portability: not needed in MDB2 (just left here for compatibility to DB)
179 * @see MDB2_Driver_Common::setOption()
180 */
181define('MDB2_PORTABILITY_NUMROWS', 8);
182
183/**
184 * Portability: makes certain error messages in certain drivers compatible
185 * with those from other DBMS's.
186 *
187 * + mysql, mysqli:  change unique/primary key constraints
188 *   MDB2_ERROR_ALREADY_EXISTS -> MDB2_ERROR_CONSTRAINT
189 *
190 * + odbc(access):  MS's ODBC driver reports 'no such field' as code
191 *   07001, which means 'too few parameters.'  When this option is on
192 *   that code gets mapped to MDB2_ERROR_NOSUCHFIELD.
193 *
194 * @see MDB2_Driver_Common::setOption()
195 */
196define('MDB2_PORTABILITY_ERRORS', 16);
197
198/**
199 * Portability: convert empty values to null strings in data output by
200 * query*() and fetch*().
201 * @see MDB2_Driver_Common::setOption()
202 */
203define('MDB2_PORTABILITY_EMPTY_TO_NULL', 32);
204
205/**
206 * Portability: removes database/table qualifiers from associative indexes
207 * @see MDB2_Driver_Common::setOption()
208 */
209define('MDB2_PORTABILITY_FIX_ASSOC_FIELD_NAMES', 64);
210
211/**
212 * Portability: turn on all portability features.
213 * @see MDB2_Driver_Common::setOption()
214 */
215define('MDB2_PORTABILITY_ALL', 127);
216
217// }}}
218// {{{ Globals for class instance tracking
219
220/**
221 * These are global variables that are used to track the various class instances
222 */
223
224$GLOBALS['_MDB2_databases'] = array();
225$GLOBALS['_MDB2_dsninfo_default'] = array(
226    'phptype'  => false,
227    'dbsyntax' => false,
228    'username' => false,
229    'password' => false,
230    'protocol' => false,
231    'hostspec' => false,
232    'port'     => false,
233    'socket'   => false,
234    'database' => false,
235    'mode'     => false,
236);
237
238// }}}
239// {{{ class MDB2
240
241/**
242 * The main 'MDB2' class is simply a container class with some static
243 * methods for creating DB objects as well as some utility functions
244 * common to all parts of DB.
245 *
246 * The object model of MDB2 is as follows (indentation means inheritance):
247 *
248 * MDB2          The main MDB2 class.  This is simply a utility class
249 *              with some 'static' methods for creating MDB2 objects as
250 *              well as common utility functions for other MDB2 classes.
251 *
252 * MDB2_Driver_Common   The base for each MDB2 implementation.  Provides default
253 * |            implementations (in OO lingo virtual methods) for
254 * |            the actual DB implementations as well as a bunch of
255 * |            query utility functions.
256 * |
257 * +-MDB2_Driver_mysql  The MDB2 implementation for MySQL. Inherits MDB2_Driver_Common.
258 *              When calling MDB2::factory or MDB2::connect for MySQL
259 *              connections, the object returned is an instance of this
260 *              class.
261 * +-MDB2_Driver_pgsql  The MDB2 implementation for PostGreSQL. Inherits MDB2_Driver_Common.
262 *              When calling MDB2::factory or MDB2::connect for PostGreSQL
263 *              connections, the object returned is an instance of this
264 *              class.
265 *
266 * @package     MDB2
267 * @category    Database
268 * @author      Lukas Smith <smith@pooteeweet.org>
269 */
270class MDB2
271{
272    // {{{ function setOptions(&$db, $options)
273
274    /**
275     * set option array   in an exiting database object
276     *
277     * @param   MDB2_Driver_Common  MDB2 object
278     * @param   array   An associative array of option names and their values.
279     *
280     * @return mixed   MDB2_OK or a PEAR Error object
281     *
282     * @access  public
283     */
284    function setOptions(&$db, $options)
285    {
286        if (is_array($options)) {
287            foreach ($options as $option => $value) {
288                $test = $db->setOption($option, $value);
289                if (PEAR::isError($test)) {
290                    return $test;
291                }
292            }
293        }
294        return MDB2_OK;
295    }
296
297    // }}}
298    // {{{ function classExists($classname)
299
300    /**
301     * Checks if a class exists without triggering __autoload
302     *
303     * @param   string  classname
304     *
305     * @return  bool    true success and false on error
306     * @static
307     * @access  public
308     */
309    function classExists($classname)
310    {
311        if (version_compare(phpversion(), "5.0", ">=")) {
312            return class_exists($classname, false);
313        }
314        return class_exists($classname);
315    }
316
317    // }}}
318    // {{{ function loadClass($class_name, $debug)
319
320    /**
321     * Loads a PEAR class.
322     *
323     * @param   string  classname to load
324     * @param   bool    if errors should be suppressed
325     *
326     * @return  mixed   true success or PEAR_Error on failure
327     *
328     * @access  public
329     */
330    function loadClass($class_name, $debug)
331    {
332        if (!MDB2::classExists($class_name)) {
333            $file_name = str_replace('_', DIRECTORY_SEPARATOR, $class_name).'.php';
334            if ($debug) {
335                $include = include_once($file_name);
336            } else {
337                $include = @include_once($file_name);
338            }
339            if (!$include) {
340                if (!MDB2::fileExists($file_name)) {
341                    $msg = "unable to find package '$class_name' file '$file_name'";
342                } else {
343                    $msg = "unable to load class '$class_name' from file '$file_name'";
344                }
345                $err =& MDB2::raiseError(MDB2_ERROR_NOT_FOUND, null, null, $msg);
346                return $err;
347            }
348        }
349        return MDB2_OK;
350    }
351
352    // }}}
353    // {{{ function &factory($dsn, $options = false)
354
355    /**
356     * Create a new MDB2 object for the specified database type
357     *
358     * IMPORTANT: In order for MDB2 to work properly it is necessary that
359     * you make sure that you work with a reference of the original
360     * object instead of a copy (this is a PHP4 quirk).
361     *
362     * For example:
363     *     $db =& MDB2::factory($dsn);
364     *          ^^
365     * And not:
366     *     $db = MDB2::factory($dsn);
367     *
368     * @param   mixed   'data source name', see the MDB2::parseDSN
369     *                      method for a description of the dsn format.
370     *                      Can also be specified as an array of the
371     *                      format returned by MDB2::parseDSN.
372     * @param   array   An associative array of option names and
373     *                            their values.
374     *
375     * @return  mixed   a newly created MDB2 object, or false on error
376     *
377     * @access  public
378     */
379    function &factory($dsn, $options = false)
380    {
381        $dsninfo = MDB2::parseDSN($dsn);
382        if (empty($dsninfo['phptype'])) {
383            $err =& MDB2::raiseError(MDB2_ERROR_NOT_FOUND,
384                null, null, 'no RDBMS driver specified');
385            return $err;
386        }
387        $class_name = 'MDB2_Driver_'.$dsninfo['phptype'];
388
389        $debug = (!empty($options['debug']));
390        $err = MDB2::loadClass($class_name, $debug);
391        if (PEAR::isError($err)) {
392            return $err;
393        }
394
395        $db =& new $class_name();
396        $db->setDSN($dsninfo);
397        $err = MDB2::setOptions($db, $options);
398        if (PEAR::isError($err)) {
399            return $err;
400        }
401
402        return $db;
403    }
404
405    // }}}
406    // {{{ function &connect($dsn, $options = false)
407
408    /**
409     * Create a new MDB2 connection object and connect to the specified
410     * database
411     *
412     * IMPORTANT: In order for MDB2 to work properly it is necessary that
413     * you make sure that you work with a reference of the original
414     * object instead of a copy (this is a PHP4 quirk).
415     *
416     * For example:
417     *     $db =& MDB2::connect($dsn);
418     *          ^^
419     * And not:
420     *     $db = MDB2::connect($dsn);
421     *          ^^
422     *
423     * @param   mixed   'data source name', see the MDB2::parseDSN
424     *                            method for a description of the dsn format.
425     *                            Can also be specified as an array of the
426     *                            format returned by MDB2::parseDSN.
427     * @param   array   An associative array of option names and
428     *                            their values.
429     *
430     * @return  mixed   a newly created MDB2 connection object, or a MDB2
431     *                  error object on error
432     *
433     * @access  public
434     * @see     MDB2::parseDSN
435     */
436    function &connect($dsn, $options = false)
437    {
438        $db =& MDB2::factory($dsn, $options);
439        if (PEAR::isError($db)) {
440            return $db;
441        }
442
443        $err = $db->connect();
444        if (PEAR::isError($err)) {
445            $dsn = $db->getDSN('string', 'xxx');
446            $db->disconnect();
447            $err->addUserInfo($dsn);
448            return $err;
449        }
450
451        return $db;
452    }
453
454    // }}}
455    // {{{ function &singleton($dsn = null, $options = false)
456
457    /**
458     * Returns a MDB2 connection with the requested DSN.
459     * A new MDB2 connection object is only created if no object with the
460     * requested DSN exists yet.
461     *
462     * IMPORTANT: In order for MDB2 to work properly it is necessary that
463     * you make sure that you work with a reference of the original
464     * object instead of a copy (this is a PHP4 quirk).
465     *
466     * For example:
467     *     $db =& MDB2::singleton($dsn);
468     *          ^^
469     * And not:
470     *     $db = MDB2::singleton($dsn);
471     *          ^^
472     *
473     * @param   mixed   'data source name', see the MDB2::parseDSN
474     *                            method for a description of the dsn format.
475     *                            Can also be specified as an array of the
476     *                            format returned by MDB2::parseDSN.
477     * @param   array   An associative array of option names and
478     *                            their values.
479     *
480     * @return  mixed   a newly created MDB2 connection object, or a MDB2
481     *                  error object on error
482     *
483     * @access  public
484     * @see     MDB2::parseDSN
485     */
486    function &singleton($dsn = null, $options = false)
487    {
488        if ($dsn) {
489            $dsninfo = MDB2::parseDSN($dsn);
490            $dsninfo = array_merge($GLOBALS['_MDB2_dsninfo_default'], $dsninfo);
491            $keys = array_keys($GLOBALS['_MDB2_databases']);
492            for ($i=0, $j=count($keys); $i<$j; ++$i) {
493                if (isset($GLOBALS['_MDB2_databases'][$keys[$i]])) {
494                    $tmp_dsn = $GLOBALS['_MDB2_databases'][$keys[$i]]->getDSN('array');
495                    if (count(array_diff_assoc($tmp_dsn, $dsninfo)) == 0) {
496                        MDB2::setOptions($GLOBALS['_MDB2_databases'][$keys[$i]], $options);
497                        return $GLOBALS['_MDB2_databases'][$keys[$i]];
498                    }
499                }
500            }
501        } elseif (is_array($GLOBALS['_MDB2_databases']) && reset($GLOBALS['_MDB2_databases'])) {
502            $db =& $GLOBALS['_MDB2_databases'][key($GLOBALS['_MDB2_databases'])];
503            return $db;
504        }
505        $db =& MDB2::factory($dsn, $options);
506        return $db;
507    }
508
509    // }}}
510    // {{{ function loadFile($file)
511
512    /**
513     * load a file (like 'Date')
514     *
515     * @param   string  name of the file in the MDB2 directory (without '.php')
516     *
517     * @return  string  name of the file that was included
518     *
519     * @access  public
520     */
521    function loadFile($file)
522    {
523        $file_name = 'MDB2'.DIRECTORY_SEPARATOR.$file.'.php';
524        if (!MDB2::fileExists($file_name)) {
525            return MDB2::raiseError(MDB2_ERROR_NOT_FOUND, null, null,
526                'unable to find: '.$file_name);
527        }
528        if (!include_once($file_name)) {
529            return MDB2::raiseError(MDB2_ERROR_NOT_FOUND, null, null,
530                'unable to load driver class: '.$file_name);
531        }
532        return $file_name;
533    }
534
535    // }}}
536    // {{{ function apiVersion()
537
538    /**
539     * Return the MDB2 API version
540     *
541     * @return  string  the MDB2 API version number
542     *
543     * @access  public
544     */
545    function apiVersion()
546    {
547        return '2.4.1';
548    }
549
550    // }}}
551    // {{{ function &raiseError($code = null, $mode = null, $options = null, $userinfo = null)
552
553    /**
554     * This method is used to communicate an error and invoke error
555     * callbacks etc.  Basically a wrapper for PEAR::raiseError
556     * without the message string.
557     *
558     * @param   mixed  int error code
559     *
560     * @param   int    error mode, see PEAR_Error docs
561     *
562     * @param   mixed  If error mode is PEAR_ERROR_TRIGGER, this is the
563     *                 error level (E_USER_NOTICE etc).  If error mode is
564     *                 PEAR_ERROR_CALLBACK, this is the callback function,
565     *                 either as a function name, or as an array of an
566     *                 object and method name.  For other error modes this
567     *                 parameter is ignored.
568     *
569     * @param   string Extra debug information.  Defaults to the last
570     *                 query and native error code.
571     *
572     * @return PEAR_Error instance of a PEAR Error object
573     *
574     * @access  private
575     * @see     PEAR_Error
576     */
577    function &raiseError($code = null, $mode = null, $options = null, $userinfo = null)
578    {
579        $err =& PEAR::raiseError(null, $code, $mode, $options, $userinfo, 'MDB2_Error', true);
580        return $err;
581    }
582
583    // }}}
584    // {{{ function isError($data, $code = null)
585
586    /**
587     * Tell whether a value is a MDB2 error.
588     *
589     * @param   mixed   the value to test
590     * @param   int     if is an error object, return true
591     *                        only if $code is a string and
592     *                        $db->getMessage() == $code or
593     *                        $code is an integer and $db->getCode() == $code
594     *
595     * @return  bool    true if parameter is an error
596     *
597     * @access  public
598     */
599    function isError($data, $code = null)
600    {
601        if (is_a($data, 'MDB2_Error')) {
602            if (is_null($code)) {
603                return true;
604            } elseif (is_string($code)) {
605                return $data->getMessage() === $code;
606            } else {
607                $code = (array)$code;
608                return in_array($data->getCode(), $code);
609            }
610        }
611        return false;
612    }
613
614    // }}}
615    // {{{ function isConnection($value)
616
617    /**
618     * Tell whether a value is a MDB2 connection
619     *
620     * @param   mixed   value to test
621     *
622     * @return  bool    whether $value is a MDB2 connection
623     *
624     * @access  public
625     */
626    function isConnection($value)
627    {
628        return is_a($value, 'MDB2_Driver_Common');
629    }
630
631    // }}}
632    // {{{ function isResult($value)
633
634    /**
635     * Tell whether a value is a MDB2 result
636     *
637     * @param   mixed   value to test
638     *
639     * @return  bool    whether $value is a MDB2 result
640     *
641     * @access  public
642     */
643    function isResult($value)
644    {
645        return is_a($value, 'MDB2_Result');
646    }
647
648    // }}}
649    // {{{ function isResultCommon($value)
650
651    /**
652     * Tell whether a value is a MDB2 result implementing the common interface
653     *
654     * @param   mixed   value to test
655     *
656     * @return  bool    whether $value is a MDB2 result implementing the common interface
657     *
658     * @access  public
659     */
660    function isResultCommon($value)
661    {
662        return is_a($value, 'MDB2_Result_Common');
663    }
664
665    // }}}
666    // {{{ function isStatement($value)
667
668    /**
669     * Tell whether a value is a MDB2 statement interface
670     *
671     * @param   mixed   value to test
672     *
673     * @return  bool    whether $value is a MDB2 statement interface
674     *
675     * @access  public
676     */
677    function isStatement($value)
678    {
679        return is_a($value, 'MDB2_Statement');
680    }
681
682    // }}}
683    // {{{ function errorMessage($value = null)
684
685    /**
686     * Return a textual error message for a MDB2 error code
687     *
688     * @param   int|array   integer error code,
689                                null to get the current error code-message map,
690                                or an array with a new error code-message map
691     *
692     * @return  string  error message, or false if the error code was
693     *                  not recognized
694     *
695     * @access  public
696     */
697    function errorMessage($value = null)
698    {
699        static $errorMessages;
700
701        if (is_array($value)) {
702            $errorMessages = $value;
703            return MDB2_OK;
704        }
705
706        if (!isset($errorMessages)) {
707            $errorMessages = array(
708                MDB2_OK                       => 'no error',
709                MDB2_ERROR                    => 'unknown error',
710                MDB2_ERROR_ALREADY_EXISTS     => 'already exists',
711                MDB2_ERROR_CANNOT_CREATE      => 'can not create',
712                MDB2_ERROR_CANNOT_ALTER       => 'can not alter',
713                MDB2_ERROR_CANNOT_REPLACE     => 'can not replace',
714                MDB2_ERROR_CANNOT_DELETE      => 'can not delete',
715                MDB2_ERROR_CANNOT_DROP        => 'can not drop',
716                MDB2_ERROR_CONSTRAINT         => 'constraint violation',
717                MDB2_ERROR_CONSTRAINT_NOT_NULL=> 'null value violates not-null constraint',
718                MDB2_ERROR_DIVZERO            => 'division by zero',
719                MDB2_ERROR_INVALID            => 'invalid',
720                MDB2_ERROR_INVALID_DATE       => 'invalid date or time',
721                MDB2_ERROR_INVALID_NUMBER     => 'invalid number',
722                MDB2_ERROR_MISMATCH           => 'mismatch',
723                MDB2_ERROR_NODBSELECTED       => 'no database selected',
724                MDB2_ERROR_NOSUCHFIELD        => 'no such field',
725                MDB2_ERROR_NOSUCHTABLE        => 'no such table',
726                MDB2_ERROR_NOT_CAPABLE        => 'MDB2 backend not capable',
727                MDB2_ERROR_NOT_FOUND          => 'not found',
728                MDB2_ERROR_NOT_LOCKED         => 'not locked',
729                MDB2_ERROR_SYNTAX             => 'syntax error',
730                MDB2_ERROR_UNSUPPORTED        => 'not supported',
731                MDB2_ERROR_VALUE_COUNT_ON_ROW => 'value count on row',
732                MDB2_ERROR_INVALID_DSN        => 'invalid DSN',
733                MDB2_ERROR_CONNECT_FAILED     => 'connect failed',
734                MDB2_ERROR_NEED_MORE_DATA     => 'insufficient data supplied',
735                MDB2_ERROR_EXTENSION_NOT_FOUND=> 'extension not found',
736                MDB2_ERROR_NOSUCHDB           => 'no such database',
737                MDB2_ERROR_ACCESS_VIOLATION   => 'insufficient permissions',
738                MDB2_ERROR_LOADMODULE         => 'error while including on demand module',
739                MDB2_ERROR_TRUNCATED          => 'truncated',
740                MDB2_ERROR_DEADLOCK           => 'deadlock detected',
741            );
742        }
743
744        if (is_null($value)) {
745            return $errorMessages;
746        }
747
748        if (PEAR::isError($value)) {
749            $value = $value->getCode();
750        }
751
752        return isset($errorMessages[$value]) ?
753           $errorMessages[$value] : $errorMessages[MDB2_ERROR];
754    }
755
756    // }}}
757    // {{{ function parseDSN($dsn)
758
759    /**
760     * Parse a data source name.
761     *
762     * Additional keys can be added by appending a URI query string to the
763     * end of the DSN.
764     *
765     * The format of the supplied DSN is in its fullest form:
766     * <code>
767     *  phptype(dbsyntax)://username:password@protocol+hostspec/database?option=8&another=true
768     * </code>
769     *
770     * Most variations are allowed:
771     * <code>
772     *  phptype://username:password@protocol+hostspec:110//usr/db_file.db?mode=0644
773     *  phptype://username:password@hostspec/database_name
774     *  phptype://username:password@hostspec
775     *  phptype://username@hostspec
776     *  phptype://hostspec/database
777     *  phptype://hostspec
778     *  phptype(dbsyntax)
779     *  phptype
780     * </code>
781     *
782     * @param   string  Data Source Name to be parsed
783     *
784     * @return  array   an associative array with the following keys:
785     *  + phptype:  Database backend used in PHP (mysql, odbc etc.)
786     *  + dbsyntax: Database used with regards to SQL syntax etc.
787     *  + protocol: Communication protocol to use (tcp, unix etc.)
788     *  + hostspec: Host specification (hostname[:port])
789     *  + database: Database to use on the DBMS server
790     *  + username: User name for login
791     *  + password: Password for login
792     *
793     * @access  public
794     * @author  Tomas V.V.Cox <cox@idecnet.com>
795     */
796    function parseDSN($dsn)
797    {
798        $parsed = $GLOBALS['_MDB2_dsninfo_default'];
799
800        if (is_array($dsn)) {
801            $dsn = array_merge($parsed, $dsn);
802            if (!$dsn['dbsyntax']) {
803                $dsn['dbsyntax'] = $dsn['phptype'];
804            }
805            return $dsn;
806        }
807
808        // Find phptype and dbsyntax
809        if (($pos = strpos($dsn, '://')) !== false) {
810            $str = substr($dsn, 0, $pos);
811            $dsn = substr($dsn, $pos + 3);
812        } else {
813            $str = $dsn;
814            $dsn = null;
815        }
816
817        // Get phptype and dbsyntax
818        // $str => phptype(dbsyntax)
819        if (preg_match('|^(.+?)\((.*?)\)$|', $str, $arr)) {
820            $parsed['phptype']  = $arr[1];
821            $parsed['dbsyntax'] = !$arr[2] ? $arr[1] : $arr[2];
822        } else {
823            $parsed['phptype']  = $str;
824            $parsed['dbsyntax'] = $str;
825        }
826
827        if (!count($dsn)) {
828            return $parsed;
829        }
830
831        // Get (if found): username and password
832        // $dsn => username:password@protocol+hostspec/database
833        if (($at = strrpos($dsn,'@')) !== false) {
834            $str = substr($dsn, 0, $at);
835            $dsn = substr($dsn, $at + 1);
836            if (($pos = strpos($str, ':')) !== false) {
837                $parsed['username'] = rawurldecode(substr($str, 0, $pos));
838                $parsed['password'] = rawurldecode(substr($str, $pos + 1));
839            } else {
840                $parsed['username'] = rawurldecode($str);
841            }
842        }
843
844        // Find protocol and hostspec
845
846        // $dsn => proto(proto_opts)/database
847        if (preg_match('|^([^(]+)\((.*?)\)/?(.*?)$|', $dsn, $match)) {
848            $proto       = $match[1];
849            $proto_opts  = $match[2] ? $match[2] : false;
850            $dsn         = $match[3];
851
852        // $dsn => protocol+hostspec/database (old format)
853        } else {
854            if (strpos($dsn, '+') !== false) {
855                list($proto, $dsn) = explode('+', $dsn, 2);
856            }
857            if (   strpos($dsn, '//') === 0
858                && strpos($dsn, '/', 2) !== false
859                && $parsed['phptype'] == 'oci8'
860            ) {
861                //oracle's "Easy Connect" syntax:
862                //"username/password@[//]host[:port][/service_name]"
863                //e.g. "scott/tiger@//mymachine:1521/oracle"
864                $proto_opts = $dsn;
865                $dsn = null;
866            } elseif (strpos($dsn, '/') !== false) {
867                list($proto_opts, $dsn) = explode('/', $dsn, 2);
868            } else {
869                $proto_opts = $dsn;
870                $dsn = null;
871            }
872        }
873
874        // process the different protocol options
875        $parsed['protocol'] = (!empty($proto)) ? $proto : 'tcp';
876        $proto_opts = rawurldecode($proto_opts);
877        if (strpos($proto_opts, ':') !== false) {
878            list($proto_opts, $parsed['port']) = explode(':', $proto_opts);
879        }
880        if ($parsed['protocol'] == 'tcp') {
881            $parsed['hostspec'] = $proto_opts;
882        } elseif ($parsed['protocol'] == 'unix') {
883            $parsed['socket'] = $proto_opts;
884        }
885
886        // Get dabase if any
887        // $dsn => database
888        if ($dsn) {
889            // /database
890            if (($pos = strpos($dsn, '?')) === false) {
891                $parsed['database'] = $dsn;
892            // /database?param1=value1&param2=value2
893            } else {
894                $parsed['database'] = substr($dsn, 0, $pos);
895                $dsn = substr($dsn, $pos + 1);
896                if (strpos($dsn, '&') !== false) {
897                    $opts = explode('&', $dsn);
898                } else { // database?param1=value1
899                    $opts = array($dsn);
900                }
901                foreach ($opts as $opt) {
902                    list($key, $value) = explode('=', $opt);
903                    if (!isset($parsed[$key])) {
904                        // don't allow params overwrite
905                        $parsed[$key] = rawurldecode($value);
906                    }
907                }
908            }
909        }
910
911        return $parsed;
912    }
913
914    // }}}
915    // {{{ function fileExists($file)
916
917    /**
918     * Checks if a file exists in the include path
919     *
920     * @param   string  filename
921     *
922     * @return  bool    true success and false on error
923     *
924     * @access  public
925     */
926    function fileExists($file)
927    {
928        // safe_mode does notwork with is_readable()
929/*       
930        if (!@ini_get('safe_mode')) {
931             $dirs = explode(PATH_SEPARATOR, ini_get('include_path'));
932             
933             foreach ($dirs as $dir) {
934                 if (is_readable($dir . DIRECTORY_SEPARATOR . $file)) {
935                     return true;
936                 }
937            }
938        } else {
939            $fp = @fopen($file, 'r', true);
940            if (is_resource($fp)) {
941                @fclose($fp);
942                return true;
943            }
944        }
945        return false;
946        */
947        $fp = @fopen($file, 'r', true);
948        if (is_resource($fp)) {
949            @fclose($fp);
950            return true;
951        }
952        return false;
953    }
954    // }}}
955}
956
957// }}}
958// {{{ class MDB2_Error extends PEAR_Error
959
960/**
961 * MDB2_Error implements a class for reporting portable database error
962 * messages.
963 *
964 * @package     MDB2
965 * @category    Database
966 * @author Stig Bakken <ssb@fast.no>
967 */
968class MDB2_Error extends PEAR_Error
969{
970    // {{{ constructor: function MDB2_Error($code = MDB2_ERROR, $mode = PEAR_ERROR_RETURN, $level = E_USER_NOTICE, $debuginfo = null)
971
972    /**
973     * MDB2_Error constructor.
974     *
975     * @param   mixed   MDB2 error code, or string with error message.
976     * @param   int     what 'error mode' to operate in
977     * @param   int     what error level to use for $mode & PEAR_ERROR_TRIGGER
978     * @param   smixed   additional debug info, such as the last query
979     */
980    function MDB2_Error($code = MDB2_ERROR, $mode = PEAR_ERROR_RETURN,
981              $level = E_USER_NOTICE, $debuginfo = null)
982    {
983        if (is_null($code)) {
984            $code = MDB2_ERROR;
985        }
986        $this->PEAR_Error('MDB2 Error: '.MDB2::errorMessage($code), $code,
987            $mode, $level, $debuginfo);
988    }
989
990    // }}}
991}
992
993// }}}
994// {{{ class MDB2_Driver_Common extends PEAR
995
996/**
997 * MDB2_Driver_Common: Base class that is extended by each MDB2 driver
998 *
999 * @package     MDB2
1000 * @category    Database
1001 * @author      Lukas Smith <smith@pooteeweet.org>
1002 */
1003class MDB2_Driver_Common extends PEAR
1004{
1005    // {{{ Variables (Properties)
1006
1007    /**
1008     * index of the MDB2 object within the $GLOBALS['_MDB2_databases'] array
1009     * @var     int
1010     * @access  public
1011     */
1012    var $db_index = 0;
1013
1014    /**
1015     * DSN used for the next query
1016     * @var     array
1017     * @access  protected
1018     */
1019    var $dsn = array();
1020
1021    /**
1022     * DSN that was used to create the current connection
1023     * @var     array
1024     * @access  protected
1025     */
1026    var $connected_dsn = array();
1027
1028    /**
1029     * connection resource
1030     * @var     mixed
1031     * @access  protected
1032     */
1033    var $connection = 0;
1034
1035    /**
1036     * if the current opened connection is a persistent connection
1037     * @var     bool
1038     * @access  protected
1039     */
1040    var $opened_persistent;
1041
1042    /**
1043     * the name of the database for the next query
1044     * @var     string
1045     * @access  protected
1046     */
1047    var $database_name = '';
1048
1049    /**
1050     * the name of the database currently selected
1051     * @var     string
1052     * @access  protected
1053     */
1054    var $connected_database_name = '';
1055
1056    /**
1057     * server version information
1058     * @var     string
1059     * @access  protected
1060     */
1061    var $connected_server_info = '';
1062
1063    /**
1064     * list of all supported features of the given driver
1065     * @var     array
1066     * @access  public
1067     */
1068    var $supported = array(
1069        'sequences' => false,
1070        'indexes' => false,
1071        'affected_rows' => false,
1072        'summary_functions' => false,
1073        'order_by_text' => false,
1074        'transactions' => false,
1075        'savepoints' => false,
1076        'current_id' => false,
1077        'limit_queries' => false,
1078        'LOBs' => false,
1079        'replace' => false,
1080        'sub_selects' => false,
1081        'auto_increment' => false,
1082        'primary_key' => false,
1083        'result_introspection' => false,
1084        'prepared_statements' => false,
1085        'identifier_quoting' => false,
1086        'pattern_escaping' => false,
1087        'new_link' => false,
1088    );
1089
1090    /**
1091     * Array of supported options that can be passed to the MDB2 instance.
1092     *
1093     * The options can be set during object creation, using
1094     * MDB2::connect(), MDB2::factory() or MDB2::singleton(). The options can
1095     * also be set after the object is created, using MDB2::setOptions() or
1096     * MDB2_Driver_Common::setOption().
1097     * The list of available option includes:
1098     * <ul>
1099     *  <li>$options['ssl'] -> boolean: determines if ssl should be used for connections</li>
1100     *  <li>$options['field_case'] -> CASE_LOWER|CASE_UPPER: determines what case to force on field/table names</li>
1101     *  <li>$options['disable_query'] -> boolean: determines if queries should be executed</li>
1102     *  <li>$options['result_class'] -> string: class used for result sets</li>
1103     *  <li>$options['buffered_result_class'] -> string: class used for buffered result sets</li>
1104     *  <li>$options['result_wrap_class'] -> string: class used to wrap result sets into</li>
1105     *  <li>$options['result_buffering'] -> boolean should results be buffered or not?</li>
1106     *  <li>$options['fetch_class'] -> string: class to use when fetch mode object is used</li>
1107     *  <li>$options['persistent'] -> boolean: persistent connection?</li>
1108     *  <li>$options['debug'] -> integer: numeric debug level</li>
1109     *  <li>$options['debug_handler'] -> string: function/method that captures debug messages</li>
1110     *  <li>$options['debug_expanded_output'] -> bool: BC option to determine if more context information should be send to the debug handler</li>
1111     *  <li>$options['default_text_field_length'] -> integer: default text field length to use</li>
1112     *  <li>$options['lob_buffer_length'] -> integer: LOB buffer length</li>
1113     *  <li>$options['log_line_break'] -> string: line-break format</li>
1114     *  <li>$options['idxname_format'] -> string: pattern for index name</li>
1115     *  <li>$options['seqname_format'] -> string: pattern for sequence name</li>
1116     *  <li>$options['savepoint_format'] -> string: pattern for auto generated savepoint names</li>
1117     *  <li>$options['statement_format'] -> string: pattern for prepared statement names</li>
1118     *  <li>$options['seqcol_name'] -> string: sequence column name</li>
1119     *  <li>$options['quote_identifier'] -> boolean: if identifier quoting should be done when check_option is used</li>
1120     *  <li>$options['use_transactions'] -> boolean: if transaction use should be enabled</li>
1121     *  <li>$options['decimal_places'] -> integer: number of decimal places to handle</li>
1122     *  <li>$options['portability'] -> integer: portability constant</li>
1123     *  <li>$options['modules'] -> array: short to long module name mapping for __call()</li>
1124     *  <li>$options['emulate_prepared'] -> boolean: force prepared statements to be emulated</li>
1125     *  <li>$options['datatype_map'] -> array: map user defined datatypes to other primitive datatypes</li>
1126     *  <li>$options['datatype_map_callback'] -> array: callback function/method that should be called</li>
1127     * </ul>
1128     *
1129     * @var     array
1130     * @access  public
1131     * @see     MDB2::connect()
1132     * @see     MDB2::factory()
1133     * @see     MDB2::singleton()
1134     * @see     MDB2_Driver_Common::setOption()
1135     */
1136    var $options = array(
1137        'ssl' => false,
1138        'field_case' => CASE_LOWER,
1139        'disable_query' => false,
1140        'result_class' => 'MDB2_Result_%s',
1141        'buffered_result_class' => 'MDB2_BufferedResult_%s',
1142        'result_wrap_class' => false,
1143        'result_buffering' => true,
1144        'fetch_class' => 'stdClass',
1145        'persistent' => false,
1146        'debug' => 0,
1147        'debug_handler' => 'MDB2_defaultDebugOutput',
1148        'debug_expanded_output' => false,
1149        'default_text_field_length' => 4096,
1150        'lob_buffer_length' => 8192,
1151        'log_line_break' => "\n",
1152        'idxname_format' => '%s_idx',
1153        'seqname_format' => '%s_seq',
1154        'savepoint_format' => 'MDB2_SAVEPOINT_%s',
1155        'statement_format' => 'MDB2_STATEMENT_%1$s_%2$s',
1156        'seqcol_name' => 'sequence',
1157        'quote_identifier' => false,
1158        'use_transactions' => true,
1159        'decimal_places' => 2,
1160        'portability' => MDB2_PORTABILITY_ALL,
1161        'modules' => array(
1162            'ex' => 'Extended',
1163            'dt' => 'Datatype',
1164            'mg' => 'Manager',
1165            'rv' => 'Reverse',
1166            'na' => 'Native',
1167            'fc' => 'Function',
1168        ),
1169        'emulate_prepared' => false,
1170        'datatype_map' => array(),
1171        'datatype_map_callback' => array(),
1172        'nativetype_map_callback' => array(),
1173    );
1174
1175    /**
1176     * string array
1177     * @var     string
1178     * @access  protected
1179     */
1180    var $string_quoting = array('start' => "'", 'end' => "'", 'escape' => false, 'escape_pattern' => false);
1181
1182    /**
1183     * identifier quoting
1184     * @var     array
1185     * @access  protected
1186     */
1187    var $identifier_quoting = array('start' => '"', 'end' => '"', 'escape' => '"');
1188
1189    /**
1190     * sql comments
1191     * @var     array
1192     * @access  protected
1193     */
1194    var $sql_comments = array(
1195        array('start' => '--', 'end' => "\n", 'escape' => false),
1196        array('start' => '/*', 'end' => '*/', 'escape' => false),
1197    );
1198
1199    /**
1200     * comparision wildcards
1201     * @var     array
1202     * @access  protected
1203     */
1204    var $wildcards = array('%', '_');
1205
1206    /**
1207     * column alias keyword
1208     * @var     string
1209     * @access  protected
1210     */
1211    var $as_keyword = ' AS ';
1212
1213    /**
1214     * warnings
1215     * @var     array
1216     * @access  protected
1217     */
1218    var $warnings = array();
1219
1220    /**
1221     * string with the debugging information
1222     * @var     string
1223     * @access  public
1224     */
1225    var $debug_output = '';
1226
1227    /**
1228     * determine if there is an open transaction
1229     * @var     bool
1230     * @access  protected
1231     */
1232    var $in_transaction = false;
1233
1234    /**
1235     * the smart transaction nesting depth
1236     * @var     int
1237     * @access  protected
1238     */
1239    var $nested_transaction_counter = null;
1240
1241    /**
1242     * the first error that occured inside a nested transaction
1243     * @var     MDB2_Error|bool
1244     * @access  protected
1245     */
1246    var $has_transaction_error = false;
1247
1248    /**
1249     * result offset used in the next query
1250     * @var     int
1251     * @access  protected
1252     */
1253    var $offset = 0;
1254
1255    /**
1256     * result limit used in the next query
1257     * @var     int
1258     * @access  protected
1259     */
1260    var $limit = 0;
1261
1262    /**
1263     * Database backend used in PHP (mysql, odbc etc.)
1264     * @var     string
1265     * @access  public
1266     */
1267    var $phptype;
1268
1269    /**
1270     * Database used with regards to SQL syntax etc.
1271     * @var     string
1272     * @access  public
1273     */
1274    var $dbsyntax;
1275
1276    /**
1277     * the last query sent to the driver
1278     * @var     string
1279     * @access  public
1280     */
1281    var $last_query;
1282
1283    /**
1284     * the default fetchmode used
1285     * @var     int
1286     * @access  protected
1287     */
1288    var $fetchmode = MDB2_FETCHMODE_ORDERED;
1289
1290    /**
1291     * array of module instances
1292     * @var     array
1293     * @access  protected
1294     */
1295    var $modules = array();
1296
1297    /**
1298     * determines of the PHP4 destructor emulation has been enabled yet
1299     * @var     array
1300     * @access  protected
1301     */
1302    var $destructor_registered = true;
1303
1304    // }}}
1305    // {{{ constructor: function __construct()
1306
1307    /**
1308     * Constructor
1309     */
1310    function __construct()
1311    {
1312        end($GLOBALS['_MDB2_databases']);
1313        $db_index = key($GLOBALS['_MDB2_databases']) + 1;
1314        $GLOBALS['_MDB2_databases'][$db_index] = &$this;
1315        $this->db_index = $db_index;
1316    }
1317
1318    // }}}
1319    // {{{ function MDB2_Driver_Common()
1320
1321    /**
1322     * PHP 4 Constructor
1323     */
1324    function MDB2_Driver_Common()
1325    {
1326        $this->destructor_registered = false;
1327        $this->__construct();
1328    }
1329
1330    // }}}
1331    // {{{ destructor: function __destruct()
1332
1333    /**
1334     *  Destructor
1335     */
1336    function __destruct()
1337    {
1338        $this->disconnect(false);
1339    }
1340
1341    // }}}
1342    // {{{ function free()
1343
1344    /**
1345     * Free the internal references so that the instance can be destroyed
1346     *
1347     * @return  bool    true on success, false if result is invalid
1348     *
1349     * @access  public
1350     */
1351    function free()
1352    {
1353        unset($GLOBALS['_MDB2_databases'][$this->db_index]);
1354        unset($this->db_index);
1355        return MDB2_OK;
1356    }
1357
1358    // }}}
1359    // {{{ function __toString()
1360
1361    /**
1362     * String conversation
1363     *
1364     * @return  string representation of the object
1365     *
1366     * @access  public
1367     */
1368    function __toString()
1369    {
1370        $info = get_class($this);
1371        $info.= ': (phptype = '.$this->phptype.', dbsyntax = '.$this->dbsyntax.')';
1372        if ($this->connection) {
1373            $info.= ' [connected]';
1374        }
1375        return $info;
1376    }
1377
1378    // }}}
1379    // {{{ function errorInfo($error = null)
1380
1381    /**
1382     * This method is used to collect information about an error
1383     *
1384     * @param   mixed   error code or resource
1385     *
1386     * @return  array   with MDB2 errorcode, native error code, native message
1387     *
1388     * @access  public
1389     */
1390    function errorInfo($error = null)
1391    {
1392        return array($error, null, null);
1393    }
1394
1395    // }}}
1396    // {{{ function &raiseError($code = null, $mode = null, $options = null, $userinfo = null)
1397
1398    /**
1399     * This method is used to communicate an error and invoke error
1400     * callbacks etc.  Basically a wrapper for PEAR::raiseError
1401     * without the message string.
1402     *
1403     * @param   mixed   integer error code, or a PEAR error object (all other
1404     *                  parameters are ignored if this parameter is an object
1405     * @param   int     error mode, see PEAR_Error docs
1406     * @param   mixed   If error mode is PEAR_ERROR_TRIGGER, this is the
1407         *              error level (E_USER_NOTICE etc).  If error mode is
1408     *                  PEAR_ERROR_CALLBACK, this is the callback function,
1409     *                  either as a function name, or as an array of an
1410     *                  object and method name.  For other error modes this
1411     *                  parameter is ignored.
1412     * @param   string  Extra debug information.  Defaults to the last
1413     *                  query and native error code.
1414     * @param   string  name of the method that triggered the error
1415     *
1416     * @return PEAR_Error   instance of a PEAR Error object
1417     *
1418     * @access  public
1419     * @see     PEAR_Error
1420     */
1421    function &raiseError($code = null, $mode = null, $options = null, $userinfo = null, $method = null)
1422    {
1423        $userinfo = "[Error message: $userinfo]\n";
1424        // The error is yet a MDB2 error object
1425        if (PEAR::isError($code)) {
1426            // because we use the static PEAR::raiseError, our global
1427            // handler should be used if it is set
1428            if (is_null($mode) && !empty($this->_default_error_mode)) {
1429                $mode    = $this->_default_error_mode;
1430                $options = $this->_default_error_options;
1431            }
1432            if (is_null($userinfo)) {
1433                $userinfo = $code->getUserinfo();
1434            }
1435            $code = $code->getCode();
1436        } elseif ($code == MDB2_ERROR_NOT_FOUND) {
1437            // extension not loaded: don't call $this->errorInfo() or the script
1438            // will die
1439        } elseif (isset($this->connection)) {
1440            if (!empty($this->last_query)) {
1441                $userinfo.= "[Last executed query: {$this->last_query}]\n";
1442            }
1443            $native_errno = $native_msg = null;
1444            list($code, $native_errno, $native_msg) = $this->errorInfo($code);
1445            if (!is_null($native_errno) && $native_errno !== '') {
1446                $userinfo.= "[Native code: $native_errno]\n";
1447            }
1448            if (!is_null($native_msg) && $native_msg !== '') {
1449                $userinfo.= "[Native message: ". strip_tags($native_msg) ."]\n";
1450            }
1451            if (!is_null($method)) {
1452                $userinfo = $method.': '.$userinfo;
1453            }
1454        }
1455
1456        $err =& PEAR::raiseError(null, $code, $mode, $options, $userinfo, 'MDB2_Error', true);
1457        if ($err->getMode() !== PEAR_ERROR_RETURN
1458            && isset($this->nested_transaction_counter) && !$this->has_transaction_error) {
1459            $this->has_transaction_error =& $err;
1460        }
1461        return $err;
1462    }
1463
1464    // }}}
1465    // {{{ function resetWarnings()
1466
1467    /**
1468     * reset the warning array
1469     *
1470     * @return void
1471     *
1472     * @access  public
1473     */
1474    function resetWarnings()
1475    {
1476        $this->warnings = array();
1477    }
1478
1479    // }}}
1480    // {{{ function getWarnings()
1481
1482    /**
1483     * Get all warnings in reverse order.
1484     * This means that the last warning is the first element in the array
1485     *
1486     * @return  array   with warnings
1487     *
1488     * @access  public
1489     * @see     resetWarnings()
1490     */
1491    function getWarnings()
1492    {
1493        return array_reverse($this->warnings);
1494    }
1495
1496    // }}}
1497    // {{{ function setFetchMode($fetchmode, $object_class = 'stdClass')
1498
1499    /**
1500     * Sets which fetch mode should be used by default on queries
1501     * on this connection
1502     *
1503     * @param   int     MDB2_FETCHMODE_ORDERED, MDB2_FETCHMODE_ASSOC
1504     *                               or MDB2_FETCHMODE_OBJECT
1505     * @param   string  the class name of the object to be returned
1506     *                               by the fetch methods when the
1507     *                               MDB2_FETCHMODE_OBJECT mode is selected.
1508     *                               If no class is specified by default a cast
1509     *                               to object from the assoc array row will be
1510     *                               done.  There is also the possibility to use
1511     *                               and extend the 'MDB2_row' class.
1512     *
1513     * @return  mixed   MDB2_OK or MDB2 Error Object
1514     *
1515     * @access  public
1516     * @see     MDB2_FETCHMODE_ORDERED, MDB2_FETCHMODE_ASSOC, MDB2_FETCHMODE_OBJECT
1517     */
1518    function setFetchMode($fetchmode, $object_class = 'stdClass')
1519    {
1520        switch ($fetchmode) {
1521        case MDB2_FETCHMODE_OBJECT:
1522            $this->options['fetch_class'] = $object_class;
1523        case MDB2_FETCHMODE_ORDERED:
1524        case MDB2_FETCHMODE_ASSOC:
1525            $this->fetchmode = $fetchmode;
1526            break;
1527        default:
1528            return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
1529                'invalid fetchmode mode', __FUNCTION__);
1530        }
1531
1532        return MDB2_OK;
1533    }
1534
1535    // }}}
1536    // {{{ function setOption($option, $value)
1537
1538    /**
1539     * set the option for the db class
1540     *
1541     * @param   string  option name
1542     * @param   mixed   value for the option
1543     *
1544     * @return  mixed   MDB2_OK or MDB2 Error Object
1545     *
1546     * @access  public
1547     */
1548    function setOption($option, $value)
1549    {
1550        if (array_key_exists($option, $this->options)) {
1551            $this->options[$option] = $value;
1552            return MDB2_OK;
1553        }
1554        return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
1555            "unknown option $option", __FUNCTION__);
1556    }
1557
1558    // }}}
1559    // {{{ function getOption($option)
1560
1561    /**
1562     * Returns the value of an option
1563     *
1564     * @param   string  option name
1565     *
1566     * @return  mixed   the option value or error object
1567     *
1568     * @access  public
1569     */
1570    function getOption($option)
1571    {
1572        if (array_key_exists($option, $this->options)) {
1573            return $this->options[$option];
1574        }
1575        return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
1576            "unknown option $option", __FUNCTION__);
1577    }
1578
1579    // }}}
1580    // {{{ function debug($message, $scope = '', $is_manip = null)
1581
1582    /**
1583     * set a debug message
1584     *
1585     * @param   string  message that should be appended to the debug variable
1586     * @param   string  usually the method name that triggered the debug call:
1587     *                  for example 'query', 'prepare', 'execute', 'parameters',
1588     *                  'beginTransaction', 'commit', 'rollback'
1589     * @param   array   contains context information about the debug() call
1590     *                  common keys are: is_manip, time, result etc.
1591     *
1592     * @return void
1593     *
1594     * @access  public
1595     */
1596    function debug($message, $scope = '', $context = array())
1597    {
1598        if ($this->options['debug'] && $this->options['debug_handler']) {
1599            if (!$this->options['debug_expanded_output']) {
1600                if (!empty($context['when']) && $context['when'] !== 'pre') {
1601                    return null;
1602                }
1603                $context = empty($context['is_manip']) ? false : $context['is_manip'];
1604            }
1605            return call_user_func_array($this->options['debug_handler'], array(&$this, $scope, $message, $context));
1606        }
1607        return null;
1608    }
1609
1610    // }}}
1611    // {{{ function getDebugOutput()
1612
1613    /**
1614     * output debug info
1615     *
1616     * @return  string  content of the debug_output class variable
1617     *
1618     * @access  public
1619     */
1620    function getDebugOutput()
1621    {
1622        return $this->debug_output;
1623    }
1624
1625    // }}}
1626    // {{{ function escape($text)
1627
1628    /**
1629     * Quotes a string so it can be safely used in a query. It will quote
1630     * the text so it can safely be used within a query.
1631     *
1632     * @param   string  the input string to quote
1633     * @param   bool    escape wildcards
1634     *
1635     * @return  string  quoted string
1636     *
1637     * @access  public
1638     */
1639    function escape($text, $escape_wildcards = false)
1640    {
1641        if ($escape_wildcards) {
1642            $text = $this->escapePattern($text);
1643        }
1644
1645        $text = str_replace($this->string_quoting['end'], $this->string_quoting['escape'] . $this->string_quoting['end'], $text);
1646        return $text;
1647    }
1648
1649    // }}}
1650    // {{{ function escapePattern($text)
1651
1652    /**
1653     * Quotes pattern (% and _) characters in a string)
1654     *
1655     * EXPERIMENTAL
1656     *
1657     * WARNING: this function is experimental and may change signature at
1658     * any time until labelled as non-experimental
1659     *
1660     * @param   string  the input string to quote
1661     *
1662     * @return  string  quoted string
1663     *
1664     * @access  public
1665     */
1666    function escapePattern($text)
1667    {
1668        if ($this->string_quoting['escape_pattern']) {
1669            $text = str_replace($this->string_quoting['escape_pattern'], $this->string_quoting['escape_pattern'] . $this->string_quoting['escape_pattern'], $text);
1670            foreach ($this->wildcards as $wildcard) {
1671                $text = str_replace($wildcard, $this->string_quoting['escape_pattern'] . $wildcard, $text);
1672            }
1673        }
1674        return $text;
1675    }
1676
1677    // }}}
1678    // {{{ function quoteIdentifier($str, $check_option = false)
1679
1680    /**
1681     * Quote a string so it can be safely used as a table or column name
1682     *
1683     * Delimiting style depends on which database driver is being used.
1684     *
1685     * NOTE: just because you CAN use delimited identifiers doesn't mean
1686     * you SHOULD use them.  In general, they end up causing way more
1687     * problems than they solve.
1688     *
1689     * Portability is broken by using the following characters inside
1690     * delimited identifiers:
1691     *   + backtick (<kbd>`</kbd>) -- due to MySQL
1692     *   + double quote (<kbd>"</kbd>) -- due to Oracle
1693     *   + brackets (<kbd>[</kbd> or <kbd>]</kbd>) -- due to Access
1694     *
1695     * Delimited identifiers are known to generally work correctly under
1696     * the following drivers:
1697     *   + mssql
1698     *   + mysql
1699     *   + mysqli
1700     *   + oci8
1701     *   + pgsql
1702     *   + sqlite
1703     *
1704     * InterBase doesn't seem to be able to use delimited identifiers
1705     * via PHP 4.  They work fine under PHP 5.
1706     *
1707     * @param   string  identifier name to be quoted
1708     * @param   bool    check the 'quote_identifier' option
1709     *
1710     * @return  string  quoted identifier string
1711     *
1712     * @access  public
1713     */
1714    function quoteIdentifier($str, $check_option = false)
1715    {
1716        if ($check_option && !$this->options['quote_identifier']) {
1717            return $str;
1718        }
1719        $str = str_replace($this->identifier_quoting['end'], $this->identifier_quoting['escape'] . $this->identifier_quoting['end'], $str);
1720        return $this->identifier_quoting['start'] . $str . $this->identifier_quoting['end'];
1721    }
1722
1723    // }}}
1724    // {{{ function getAsKeyword()
1725
1726    /**
1727     * Gets the string to alias column
1728     *
1729     * @return string to use when aliasing a column
1730     */
1731    function getAsKeyword()
1732    {
1733        return $this->as_keyword;
1734    }
1735
1736    // }}}
1737    // {{{ function getConnection()
1738
1739    /**
1740     * Returns a native connection
1741     *
1742     * @return  mixed   a valid MDB2 connection object,
1743     *                  or a MDB2 error object on error
1744     *
1745     * @access  public
1746     */
1747    function getConnection()
1748    {
1749        $result = $this->connect();
1750        if (PEAR::isError($result)) {
1751            return $result;
1752        }
1753        return $this->connection;
1754    }
1755
1756     // }}}
1757    // {{{ function _fixResultArrayValues(&$row, $mode)
1758
1759    /**
1760     * Do all necessary conversions on result arrays to fix DBMS quirks
1761     *
1762     * @param   array   the array to be fixed (passed by reference)
1763     * @param   array   bit-wise addition of the required portability modes
1764     *
1765     * @return  void
1766     *
1767     * @access  protected
1768     */
1769    function _fixResultArrayValues(&$row, $mode)
1770    {
1771        switch ($mode) {
1772        case MDB2_PORTABILITY_EMPTY_TO_NULL:
1773            foreach ($row as $key => $value) {
1774                if ($value === '') {
1775                    $row[$key] = null;
1776                }
1777            }
1778            break;
1779        case MDB2_PORTABILITY_RTRIM:
1780            foreach ($row as $key => $value) {
1781                if (is_string($value)) {
1782                    $row[$key] = rtrim($value);
1783                }
1784            }
1785            break;
1786        case MDB2_PORTABILITY_FIX_ASSOC_FIELD_NAMES:
1787            $tmp_row = array();
1788            foreach ($row as $key => $value) {
1789                $tmp_row[preg_replace('/^(?:.*\.)?([^.]+)$/', '\\1', $key)] = $value;
1790            }
1791            $row = $tmp_row;
1792            break;
1793        case (MDB2_PORTABILITY_RTRIM + MDB2_PORTABILITY_EMPTY_TO_NULL):
1794            foreach ($row as $key => $value) {
1795                if ($value === '') {
1796                    $row[$key] = null;
1797                } elseif (is_string($value)) {
1798                    $row[$key] = rtrim($value);
1799                }
1800            }
1801            break;
1802        case (MDB2_PORTABILITY_RTRIM + MDB2_PORTABILITY_FIX_ASSOC_FIELD_NAMES):
1803            $tmp_row = array();
1804            foreach ($row as $key => $value) {
1805                if (is_string($value)) {
1806                    $value = rtrim($value);
1807                }
1808                $tmp_row[preg_replace('/^(?:.*\.)?([^.]+)$/', '\\1', $key)] = $value;
1809            }
1810            $row = $tmp_row;
1811            break;
1812        case (MDB2_PORTABILITY_EMPTY_TO_NULL + MDB2_PORTABILITY_FIX_ASSOC_FIELD_NAMES):
1813            $tmp_row = array();
1814            foreach ($row as $key => $value) {
1815                if ($value === '') {
1816                    $value = null;
1817                }
1818                $tmp_row[preg_replace('/^(?:.*\.)?([^.]+)$/', '\\1', $key)] = $value;
1819            }
1820            $row = $tmp_row;
1821            break;
1822        case (MDB2_PORTABILITY_RTRIM + MDB2_PORTABILITY_EMPTY_TO_NULL + MDB2_PORTABILITY_FIX_ASSOC_FIELD_NAMES):
1823            $tmp_row = array();
1824            foreach ($row as $key => $value) {
1825                if ($value === '') {
1826                    $value = null;
1827                } elseif (is_string($value)) {
1828                    $value = rtrim($value);
1829                }
1830                $tmp_row[preg_replace('/^(?:.*\.)?([^.]+)$/', '\\1', $key)] = $value;
1831            }
1832            $row = $tmp_row;
1833            break;
1834        }
1835    }
1836
1837    // }}}
1838    // {{{ function &loadModule($module, $property = null, $phptype_specific = null)
1839
1840    /**
1841     * loads a module
1842     *
1843     * @param   string  name of the module that should be loaded
1844     *                  (only used for error messages)
1845     * @param   string  name of the property into which the class will be loaded
1846     * @param   bool    if the class to load for the module is specific to the
1847     *                  phptype
1848     *
1849     * @return  object  on success a reference to the given module is returned
1850     *                  and on failure a PEAR error
1851     *
1852     * @access  public
1853     */
1854    function &loadModule($module, $property = null, $phptype_specific = null)
1855    {
1856        if (!$property) {
1857            $property = strtolower($module);
1858        }
1859
1860        if (!isset($this->{$property})) {
1861            $version = $phptype_specific;
1862            if ($phptype_specific !== false) {
1863                $version = true;
1864                $class_name = 'MDB2_Driver_'.$module.'_'.$this->phptype;
1865                $file_name = str_replace('_', DIRECTORY_SEPARATOR, $class_name).'.php';
1866            }
1867           
1868            sfprintr($phptype_specific);
1869            sfprintr($class_name);
1870            sfprintr($file_name);
1871            sfprintr(!MDB2::classExists($class_name));
1872            sfprintr(!MDB2::fileExists($file_name));
1873           
1874            if ($phptype_specific === false
1875                || (!MDB2::classExists($class_name) && !MDB2::fileExists($file_name))
1876            ) {
1877                $version = false;
1878                $class_name = 'MDB2_'.$module;
1879                $file_name = str_replace('_', DIRECTORY_SEPARATOR, $class_name).'.php';
1880            }
1881           
1882            $err = MDB2::loadClass($class_name, $this->getOption('debug'));
1883            if (PEAR::isError($err)) {
1884                return $err;
1885            }
1886
1887            // load modul in a specific version
1888            if ($version) {
1889                if (method_exists($class_name, 'getClassName')) {
1890                    $class_name_new = call_user_func(array($class_name, 'getClassName'), $this->db_index);
1891                    if ($class_name != $class_name_new) {
1892                        $class_name = $class_name_new;
1893                        $err = MDB2::loadClass($class_name, $this->getOption('debug'));
1894                        if (PEAR::isError($err)) {
1895                            return $err;
1896                        }
1897                    }
1898                }
1899            }
1900
1901            if (!MDB2::classExists($class_name)) {
1902                $err =& $this->raiseError(MDB2_ERROR_LOADMODULE, null, null,
1903                    "unable to load module '$module' into property '$property'", __FUNCTION__);
1904                return $err;
1905            }
1906            $this->{$property} =& new $class_name($this->db_index);
1907            $this->modules[$module] =& $this->{$property};
1908            if ($version) {
1909                // this will be used in the connect method to determine if the module
1910                // needs to be loaded with a different version if the server
1911                // version changed in between connects
1912                $this->loaded_version_modules[] = $property;
1913            }
1914        }
1915
1916        return $this->{$property};
1917    }
1918
1919    // }}}
1920    // {{{ function __call($method, $params)
1921
1922    /**
1923     * Calls a module method using the __call magic method
1924     *
1925     * @param   string  Method name.
1926     * @param   array   Arguments.
1927     *
1928     * @return  mixed   Returned value.
1929     */
1930    function __call($method, $params)
1931    {
1932        $module = null;
1933        if (preg_match('/^([a-z]+)([A-Z])(.*)$/', $method, $match)
1934            && isset($this->options['modules'][$match[1]])
1935        ) {
1936            $module = $this->options['modules'][$match[1]];
1937            $method = strtolower($match[2]).$match[3];
1938            if (!isset($this->modules[$module]) || !is_object($this->modules[$module])) {
1939                $result =& $this->loadModule($module);
1940                if (PEAR::isError($result)) {
1941                    return $result;
1942                }
1943            }
1944        } else {
1945            foreach ($this->modules as $key => $foo) {
1946                if (is_object($this->modules[$key])
1947                    && method_exists($this->modules[$key], $method)
1948                ) {
1949                    $module = $key;
1950                    break;
1951                }
1952            }
1953        }
1954        if (!is_null($module)) {
1955            return call_user_func_array(array(&$this->modules[$module], $method), $params);
1956        }
1957        trigger_error(sprintf('Call to undefined function: %s::%s().', get_class($this), $method), E_USER_ERROR);
1958    }
1959
1960    // }}}
1961    // {{{ function beginTransaction($savepoint = null)
1962
1963    /**
1964     * Start a transaction or set a savepoint.
1965     *
1966     * @param   string  name of a savepoint to set
1967     * @return  mixed   MDB2_OK on success, a MDB2 error on failure
1968     *
1969     * @access  public
1970     */
1971    function beginTransaction($savepoint = null)
1972    {
1973        $this->debug('Starting transaction', __FUNCTION__, array('is_manip' => true, 'savepoint' => $savepoint));
1974        return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
1975            'transactions are not supported', __FUNCTION__);
1976    }
1977
1978    // }}}
1979    // {{{ function commit($savepoint = null)
1980
1981    /**
1982     * Commit the database changes done during a transaction that is in
1983     * progress or release a savepoint. This function may only be called when
1984     * auto-committing is disabled, otherwise it will fail. Therefore, a new
1985     * transaction is implicitly started after committing the pending changes.
1986     *
1987     * @param   string  name of a savepoint to release
1988     * @return  mixed   MDB2_OK on success, a MDB2 error on failure
1989     *
1990     * @access  public
1991     */
1992    function commit($savepoint = null)
1993    {
1994        $this->debug('Committing transaction/savepoint', __FUNCTION__, array('is_manip' => true, 'savepoint' => $savepoint));
1995        return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
1996            'commiting transactions is not supported', __FUNCTION__);
1997    }
1998
1999    // }}}
2000    // {{{ function rollback($savepoint = null)
2001
2002    /**
2003     * Cancel any database changes done during a transaction or since a specific
2004     * savepoint that is in progress. This function may only be called when
2005     * auto-committing is disabled, otherwise it will fail. Therefore, a new
2006     * transaction is implicitly started after canceling the pending changes.
2007     *
2008     * @param   string  name of a savepoint to rollback to
2009     * @return  mixed   MDB2_OK on success, a MDB2 error on failure
2010     *
2011     * @access  public
2012     */
2013    function rollback($savepoint = null)
2014    {
2015        $this->debug('Rolling back transaction/savepoint', __FUNCTION__, array('is_manip' => true, 'savepoint' => $savepoint));
2016        return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
2017            'rolling back transactions is not supported', __FUNCTION__);
2018    }
2019
2020    // }}}
2021    // {{{ function inTransaction($ignore_nested = false)
2022
2023    /**
2024     * If a transaction is currently open.
2025     *
2026     * @param   bool    if the nested transaction count should be ignored
2027     * @return  int|bool    - an integer with the nesting depth is returned if a
2028     *                      nested transaction is open
2029     *                      - true is returned for a normal open transaction
2030     *                      - false is returned if no transaction is open
2031     *
2032     * @access  public
2033     */
2034    function inTransaction($ignore_nested = false)
2035    {
2036        if (!$ignore_nested && isset($this->nested_transaction_counter)) {
2037            return $this->nested_transaction_counter;
2038        }
2039        return $this->in_transaction;
2040    }
2041
2042    // }}}
2043    // {{{ function setTransactionIsolation($isolation)
2044
2045    /**
2046     * Set the transacton isolation level.
2047     *
2048     * @param   string  standard isolation level
2049     *                  READ UNCOMMITTED (allows dirty reads)
2050     *                  READ COMMITTED (prevents dirty reads)
2051     *                  REPEATABLE READ (prevents nonrepeatable reads)
2052     *                  SERIALIZABLE (prevents phantom reads)
2053     * @param   array some transaction options:
2054     *                  'wait' => 'WAIT' | 'NO WAIT'
2055     *                  'rw'   => 'READ WRITE' | 'READ ONLY'
2056     * @return  mixed   MDB2_OK on success, a MDB2 error on failure
2057     *
2058     * @access  public
2059     * @since   2.1.1
2060     */
2061    function setTransactionIsolation($isolation, $options = array())
2062    {
2063        $this->debug('Setting transaction isolation level', __FUNCTION__, array('is_manip' => true));
2064        return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
2065            'isolation level setting is not supported', __FUNCTION__);
2066    }
2067
2068    // }}}
2069    // {{{ function beginNestedTransaction($savepoint = false)
2070
2071    /**
2072     * Start a nested transaction.
2073     *
2074     * EXPERIMENTAL
2075     *
2076     * WARNING: this function is experimental and may change signature at
2077     * any time until labelled as non-experimental
2078     *
2079     * @return  mixed   MDB2_OK on success/savepoint name, a MDB2 error on failure
2080     *
2081     * @access  public
2082     * @since   2.1.1
2083     */
2084    function beginNestedTransaction()
2085    {
2086        if ($this->in_transaction) {
2087            ++$this->nested_transaction_counter;
2088            $savepoint = sprintf($this->options['savepoint_format'], $this->nested_transaction_counter);
2089            if ($this->supports('savepoints') && $savepoint) {
2090                return $this->beginTransaction($savepoint);
2091            }
2092            return MDB2_OK;
2093        }
2094        $this->has_transaction_error = false;
2095        $result = $this->beginTransaction();
2096        $this->nested_transaction_counter = 1;
2097        return $result;
2098    }
2099
2100    // }}}
2101    // {{{ function completeNestedTransaction($force_rollback = false, $release = false)
2102
2103    /**
2104     * Finish a nested transaction by rolling back if an error occured or
2105     * committing otherwise.
2106     *
2107     * EXPERIMENTAL
2108     *
2109     * WARNING: this function is experimental and may change signature at
2110     * any time until labelled as non-experimental
2111     *
2112     * @param   bool    if the transaction should be rolled back regardless
2113     *                  even if no error was set within the nested transaction
2114     * @return  mixed   MDB_OK on commit/counter decrementing, false on rollback
2115     *                  and a MDB2 error on failure
2116     *
2117     * @access  public
2118     * @since   2.1.1
2119     */
2120    function completeNestedTransaction($force_rollback = false)
2121    {
2122        if ($this->nested_transaction_counter > 1) {
2123            $savepoint = sprintf($this->options['savepoint_format'], $this->nested_transaction_counter);
2124            if ($this->supports('savepoints') && $savepoint) {
2125                if ($force_rollback || $this->has_transaction_error) {
2126                    $result = $this->rollback($savepoint);
2127                    if (!PEAR::isError($result)) {
2128                        $result = false;
2129                        $this->has_transaction_error = false;
2130                    }
2131                } else {
2132                    $result = $this->commit($savepoint);
2133                }
2134            } else {
2135                $result = MDB2_OK;
2136            }
2137            --$this->nested_transaction_counter;
2138            return $result;
2139        }
2140
2141        $this->nested_transaction_counter = null;
2142        $result = MDB2_OK;
2143
2144        // transaction has not yet been rolled back
2145        if ($this->in_transaction) {
2146            if ($force_rollback || $this->has_transaction_error) {
2147                $result = $this->rollback();
2148                if (!PEAR::isError($result)) {
2149                    $result = false;
2150                }
2151            } else {
2152                $result = $this->commit();
2153            }
2154        }
2155        $this->has_transaction_error = false;
2156        return $result;
2157    }
2158
2159    // }}}
2160    // {{{ function failNestedTransaction($error = null, $immediately = false)
2161
2162    /**
2163     * Force setting nested transaction to failed.
2164     *
2165     * EXPERIMENTAL
2166     *
2167     * WARNING: this function is experimental and may change signature at
2168     * any time until labelled as non-experimental
2169     *
2170     * @param   mixed   value to return in getNestededTransactionError()
2171     * @param   bool    if the transaction should be rolled back immediately
2172     * @return  bool    MDB2_OK
2173     *
2174     * @access  public
2175     * @since   2.1.1
2176     */
2177    function failNestedTransaction($error = null, $immediately = false)
2178    {
2179        if (is_null($error)) {
2180            $error = $this->has_transaction_error ? $this->has_transaction_error : true;
2181        } elseif (!$error) {
2182            $error = true;
2183        }
2184        $this->has_transaction_error = $error;
2185        if (!$immediately) {
2186            return MDB2_OK;
2187        }
2188        return $this->rollback();
2189    }
2190
2191    // }}}
2192    // {{{ function getNestedTransactionError()
2193
2194    /**
2195     * The first error that occured since the transaction start.
2196     *
2197     * EXPERIMENTAL
2198     *
2199     * WARNING: this function is experimental and may change signature at
2200     * any time until labelled as non-experimental
2201     *
2202     * @return  MDB2_Error|bool     MDB2 error object if an error occured or false.
2203     *
2204     * @access  public
2205     * @since   2.1.1
2206     */
2207    function getNestedTransactionError()
2208    {
2209        return $this->has_transaction_error;
2210    }
2211
2212    // }}}
2213    // {{{ connect()
2214
2215    /**
2216     * Connect to the database
2217     *
2218     * @return true on success, MDB2 Error Object on failure
2219     */
2220    function connect()
2221    {
2222        return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
2223            'method not implemented', __FUNCTION__);
2224    }
2225
2226    // }}}
2227    // {{{ setCharset($charset, $connection = null)
2228
2229    /**
2230     * Set the charset on the current connection
2231     *
2232     * @param string    charset
2233     * @param resource  connection handle
2234     *
2235     * @return true on success, MDB2 Error Object on failure
2236     */
2237    function setCharset($charset, $connection = null)
2238    {
2239        return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
2240            'method not implemented', __FUNCTION__);
2241    }
2242
2243    // }}}
2244    // {{{ function disconnect($force = true)
2245
2246    /**
2247     * Log out and disconnect from the database.
2248     *
2249     * @param   bool    if the disconnect should be forced even if the
2250     *                  connection is opened persistently
2251     *
2252     * @return  mixed   true on success, false if not connected and error
2253     *                  object on error
2254     *
2255     * @access  public
2256     */
2257    function disconnect($force = true)
2258    {
2259        $this->connection = 0;
2260        $this->connected_dsn = array();
2261        $this->connected_database_name = '';
2262        $this->opened_persistent = null;
2263        $this->connected_server_info = '';
2264        $this->in_transaction = null;
2265        $this->nested_transaction_counter = null;
2266        return MDB2_OK;
2267    }
2268
2269    // }}}
2270    // {{{ function setDatabase($name)
2271
2272    /**
2273     * Select a different database
2274     *
2275     * @param   string  name of the database that should be selected
2276     *
2277     * @return  string  name of the database previously connected to
2278     *
2279     * @access  public
2280     */
2281    function setDatabase($name)
2282    {
2283        $previous_database_name = (isset($this->database_name)) ? $this->database_name : '';
2284        $this->database_name = $name;
2285        $this->disconnect(false);
2286        return $previous_database_name;
2287    }
2288
2289    // }}}
2290    // {{{ function getDatabase()
2291
2292    /**
2293     * Get the current database
2294     *
2295     * @return  string  name of the database
2296     *
2297     * @access  public
2298     */
2299    function getDatabase()
2300    {
2301        return $this->database_name;
2302    }
2303
2304    // }}}
2305    // {{{ function setDSN($dsn)
2306
2307    /**
2308     * set the DSN
2309     *
2310     * @param   mixed   DSN string or array
2311     *
2312     * @return  MDB2_OK
2313     *
2314     * @access  public
2315     */
2316    function setDSN($dsn)
2317    {
2318        $dsn_default = $GLOBALS['_MDB2_dsninfo_default'];
2319        $dsn = MDB2::parseDSN($dsn);
2320        if (array_key_exists('database', $dsn)) {
2321            $this->database_name = $dsn['database'];
2322            unset($dsn['database']);
2323        }
2324        $this->dsn = array_merge($dsn_default, $dsn);
2325        return $this->disconnect(false);
2326    }
2327
2328    // }}}
2329    // {{{ function getDSN($type = 'string', $hidepw = false)
2330
2331    /**
2332     * return the DSN as a string
2333     *
2334     * @param   string  format to return ("array", "string")
2335     * @param   string  string to hide the password with
2336     *
2337     * @return  mixed   DSN in the chosen type
2338     *
2339     * @access  public
2340     */
2341    function getDSN($type = 'string', $hidepw = false)
2342    {
2343        $dsn = array_merge($GLOBALS['_MDB2_dsninfo_default'], $this->dsn);
2344        $dsn['phptype'] = $this->phptype;
2345        $dsn['database'] = $this->database_name;
2346        if ($hidepw) {
2347            $dsn['password'] = $hidepw;
2348        }
2349        switch ($type) {
2350        // expand to include all possible options
2351        case 'string':
2352           $dsn = $dsn['phptype'].
2353               ($dsn['dbsyntax'] ? ('('.$dsn['dbsyntax'].')') : '').
2354               '://'.$dsn['username'].':'.
2355                $dsn['password'].'@'.$dsn['hostspec'].
2356                ($dsn['port'] ? (':'.$dsn['port']) : '').
2357                '/'.$dsn['database'];
2358            break;
2359        case 'array':
2360        default:
2361            break;
2362        }
2363        return $dsn;
2364    }
2365
2366    // }}}
2367    // {{{ function &standaloneQuery($query, $types = null, $is_manip = false)
2368
2369   /**
2370     * execute a query as database administrator
2371     *
2372     * @param   string  the SQL query
2373     * @param   mixed   array that contains the types of the columns in
2374     *                        the result set
2375     * @param   bool    if the query is a manipulation query
2376     *
2377     * @return  mixed   MDB2_OK on success, a MDB2 error on failure
2378     *
2379     * @access  public
2380     */
2381    function &standaloneQuery($query, $types = null, $is_manip = false)
2382    {
2383        $offset = $this->offset;
2384        $limit = $this->limit;
2385        $this->offset = $this->limit = 0;
2386        $query = $this->_modifyQuery($query, $is_manip, $limit, $offset);
2387
2388        $connection = $this->getConnection();
2389        if (PEAR::isError($connection)) {
2390            return $connection;
2391        }
2392
2393        $result =& $this->_doQuery($query, $is_manip, $connection, false);
2394        if (PEAR::isError($result)) {
2395            return $result;
2396        }
2397
2398        if ($is_manip) {
2399            $affected_rows =  $this->_affectedRows($connection, $result);
2400            return $affected_rows;
2401        }
2402        $result =& $this->_wrapResult($result, $types, true, false, $limit, $offset);
2403        return $result;
2404    }
2405
2406    // }}}
2407    // {{{ function _modifyQuery($query, $is_manip, $limit, $offset)
2408
2409    /**
2410     * Changes a query string for various DBMS specific reasons
2411     *
2412     * @param   string  query to modify
2413     * @param   bool    if it is a DML query
2414     * @param   int  limit the number of rows
2415     * @param   int  start reading from given offset
2416     *
2417     * @return  string  modified query
2418     *
2419     * @access  protected
2420     */
2421    function _modifyQuery($query, $is_manip, $limit, $offset)
2422    {
2423        return $query;
2424    }
2425
2426    // }}}
2427    // {{{ function &_doQuery($query, $is_manip = false, $connection = null, $database_name = null)
2428
2429    /**
2430     * Execute a query
2431     * @param   string  query
2432     * @param   bool    if the query is a manipulation query
2433     * @param   resource connection handle
2434     * @param   string  database name
2435     *
2436     * @return  result or error object
2437     *
2438     * @access  protected
2439     */
2440    function &_doQuery($query, $is_manip = false, $connection = null, $database_name = null)
2441    {
2442        $this->last_query = $query;
2443        $result = $this->debug($query, 'query', array('is_manip' => $is_manip, 'when' => 'pre'));
2444        if ($result) {
2445            if (PEAR::isError($result)) {
2446                return $result;
2447            }
2448            $query = $result;
2449        }
2450        $err =& $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
2451            'method not implemented', __FUNCTION__);
2452        return $err;
2453    }
2454
2455    // }}}
2456    // {{{ function _affectedRows($connection, $result = null)
2457
2458    /**
2459     * Returns the number of rows affected
2460     *
2461     * @param   resource result handle
2462     * @param   resource connection handle
2463     *
2464     * @return  mixed   MDB2 Error Object or the number of rows affected
2465     *
2466     * @access  private
2467     */
2468    function _affectedRows($connection, $result = null)
2469    {
2470        return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
2471            'method not implemented', __FUNCTION__);
2472    }
2473
2474    // }}}
2475    // {{{ function &exec($query)
2476
2477    /**
2478     * Execute a manipulation query to the database and return the number of affected rows
2479     *
2480     * @param   string  the SQL query
2481     *
2482     * @return  mixed   number of affected rows on success, a MDB2 error on failure
2483     *
2484     * @access  public
2485     */
2486    function &exec($query)
2487    {
2488        $offset = $this->offset;
2489        $limit = $this->limit;
2490        $this->offset = $this->limit = 0;
2491        $query = $this->_modifyQuery($query, true, $limit, $offset);
2492
2493        $connection = $this->getConnection();
2494        if (PEAR::isError($connection)) {
2495            return $connection;
2496        }
2497
2498        $result =& $this->_doQuery($query, true, $connection, $this->database_name);
2499        if (PEAR::isError($result)) {
2500            return $result;
2501        }
2502
2503        $affectedRows = $this->_affectedRows($connection, $result);
2504        return $affectedRows;
2505    }
2506
2507    // }}}
2508    // {{{ function &query($query, $types = null, $result_class = true, $result_wrap_class = false)
2509
2510    /**
2511     * Send a query to the database and return any results
2512     *
2513     * @param   string  the SQL query
2514     * @param   mixed   array that contains the types of the columns in
2515     *                        the result set
2516     * @param   mixed   string which specifies which result class to use
2517     * @param   mixed   string which specifies which class to wrap results in
2518     *
2519     * @return mixed   an MDB2_Result handle on success, a MDB2 error on failure
2520     *
2521     * @access  public
2522     */
2523    function &query($query, $types = null, $result_class = true, $result_wrap_class = false)
2524    {
2525        $offset = $this->offset;
2526        $limit = $this->limit;
2527        $this->offset = $this->limit = 0;
2528        $query = $this->_modifyQuery($query, false, $limit, $offset);
2529
2530        $connection = $this->getConnection();
2531        if (PEAR::isError($connection)) {
2532            return $connection;
2533        }
2534
2535        $result =& $this->_doQuery($query, false, $connection, $this->database_name);
2536        if (PEAR::isError($result)) {
2537            return $result;
2538        }
2539
2540        $result =& $this->_wrapResult($result, $types, $result_class, $result_wrap_class, $limit, $offset);
2541        return $result;
2542    }
2543
2544    // }}}
2545    // {{{ function &_wrapResult($result, $types = array(), $result_class = true, $result_wrap_class = false, $limit = null, $offset = null)
2546
2547    /**
2548     * wrap a result set into the correct class
2549     *
2550     * @param   resource result handle
2551     * @param   mixed   array that contains the types of the columns in
2552     *                        the result set
2553     * @param   mixed   string which specifies which result class to use
2554     * @param   mixed   string which specifies which class to wrap results in
2555     * @param   string  number of rows to select
2556     * @param   string  first row to select
2557     *
2558     * @return mixed   an MDB2_Result, a MDB2 error on failure
2559     *
2560     * @access  protected
2561     */
2562    function &_wrapResult($result, $types = array(), $result_class = true,
2563        $result_wrap_class = false, $limit = null, $offset = null)
2564    {
2565        if ($types === true) {
2566            if ($this->supports('result_introspection')) {
2567                $this->loadModule('Reverse', null, true);
2568                $tableInfo = $this->reverse->tableInfo($result);
2569                if (PEAR::isError($tableInfo)) {
2570                    return $tableInfo;
2571                }
2572                $types = array();
2573                foreach ($tableInfo as $field) {
2574                    $types[] = $field['mdb2type'];
2575                }
2576            } else {
2577                $types = null;
2578            }
2579        }
2580
2581        if ($result_class === true) {
2582            $result_class = $this->options['result_buffering']
2583                ? $this->options['buffered_result_class'] : $this->options['result_class'];
2584        }
2585
2586        if ($result_class) {
2587            $class_name = sprintf($result_class, $this->phptype);
2588            if (!MDB2::classExists($class_name)) {
2589                $err =& $this->raiseError(MDB2_ERROR_NOT_FOUND, null, null,
2590                    'result class does not exist '.$class_name, __FUNCTION__);
2591                return $err;
2592            }
2593            $result =& new $class_name($this, $result, $limit, $offset);
2594            if (!MDB2::isResultCommon($result)) {
2595                $err =& $this->raiseError(MDB2_ERROR_NOT_FOUND, null, null,
2596                    'result class is not extended from MDB2_Result_Common', __FUNCTION__);
2597                return $err;
2598            }
2599            if (!empty($types)) {
2600                $err = $result->setResultTypes($types);
2601                if (PEAR::isError($err)) {
2602                    $result->free();
2603                    return $err;
2604                }
2605            }
2606        }
2607        if ($result_wrap_class === true) {
2608            $result_wrap_class = $this->options['result_wrap_class'];
2609        }
2610        if ($result_wrap_class) {
2611            if (!MDB2::classExists($result_wrap_class)) {
2612                $err =& $this->raiseError(MDB2_ERROR_NOT_FOUND, null, null,
2613                    'result wrap class does not exist '.$result_wrap_class, __FUNCTION__);
2614                return $err;
2615            }
2616            $result =& new $result_wrap_class($result, $this->fetchmode);
2617        }
2618        return $result;
2619    }
2620
2621    // }}}
2622    // {{{ function getServerVersion($native = false)
2623
2624    /**
2625     * return version information about the server
2626     *
2627     * @param   bool    determines if the raw version string should be returned
2628     *
2629     * @return  mixed   array with version information or row string
2630     *
2631     * @access  public
2632     */
2633    function getServerVersion($native = false)
2634    {
2635        return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
2636            'method not implemented', __FUNCTION__);
2637    }
2638
2639    // }}}
2640    // {{{ function setLimit($limit, $offset = null)
2641
2642    /**
2643     * set the range of the next query
2644     *
2645     * @param   string  number of rows to select
2646     * @param   string  first row to select
2647     *
2648     * @return  mixed   MDB2_OK on success, a MDB2 error on failure
2649     *
2650     * @access  public
2651     */
2652    function setLimit($limit, $offset = null)
2653    {
2654        if (!$this->supports('limit_queries')) {
2655            return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
2656                'limit is not supported by this driver', __FUNCTION__);
2657        }
2658        $limit = (int)$limit;
2659        if ($limit < 0) {
2660            return $this->raiseError(MDB2_ERROR_SYNTAX, null, null,
2661                'it was not specified a valid selected range row limit', __FUNCTION__);
2662        }
2663        $this->limit = $limit;
2664        if (!is_null($offset)) {
2665            $offset = (int)$offset;
2666            if ($offset < 0) {
2667                return $this->raiseError(MDB2_ERROR_SYNTAX, null, null,
2668                    'it was not specified a valid first selected range row', __FUNCTION__);
2669            }
2670            $this->offset = $offset;
2671        }
2672        return MDB2_OK;
2673    }
2674
2675    // }}}
2676    // {{{ function subSelect($query, $type = false)
2677
2678    /**
2679     * simple subselect emulation: leaves the query untouched for all RDBMS
2680     * that support subselects
2681     *
2682     * @param   string  the SQL query for the subselect that may only
2683     *                      return a column
2684     * @param   string  determines type of the field
2685     *
2686     * @return  string  the query
2687     *
2688     * @access  public
2689     */
2690    function subSelect($query, $type = false)
2691    {
2692        if ($this->supports('sub_selects') === true) {
2693            return $query;
2694        }
2695
2696        if (!$this->supports('sub_selects')) {
2697            return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
2698                'method not implemented', __FUNCTION__);
2699        }
2700
2701        $col = $this->queryCol($query, $type);
2702        if (PEAR::isError($col)) {
2703            return $col;
2704        }
2705        if (!is_array($col) || count($col) == 0) {
2706            return 'NULL';
2707        }
2708        if ($type) {
2709            $this->loadModule('Datatype', null, true);
2710            return $this->datatype->implodeArray($col, $type);
2711        }
2712        return implode(', ', $col);
2713    }
2714
2715    // }}}
2716    // {{{ function replace($table, $fields)
2717
2718    /**
2719     * Execute a SQL REPLACE query. A REPLACE query is identical to a INSERT
2720     * query, except that if there is already a row in the table with the same
2721     * key field values, the REPLACE query just updates its values instead of
2722     * inserting a new row.
2723     *
2724     * The REPLACE type of query does not make part of the SQL standards. Since
2725     * practically only MySQL and SQLite implement it natively, this type of
2726     * query isemulated through this method for other DBMS using standard types
2727     * of queries inside a transaction to assure the atomicity of the operation.
2728     *
2729     * @param   string  name of the table on which the REPLACE query will
2730     *       be executed.
2731     * @param   array   associative array   that describes the fields and the
2732     *       values that will be inserted or updated in the specified table. The
2733     *       indexes of the array are the names of all the fields of the table.
2734     *       The values of the array are also associative arrays that describe
2735     *       the values and other properties of the table fields.
2736     *
2737     *       Here follows a list of field properties that need to be specified:
2738     *
2739     *       value
2740     *           Value to be assigned to the specified field. This value may be
2741     *           of specified in database independent type format as this
2742     *           function can perform the necessary datatype conversions.
2743     *
2744     *           Default: this property is required unless the Null property is
2745     *           set to 1.
2746     *
2747     *       type
2748     *           Name of the type of the field. Currently, all types MDB2
2749     *           are supported except for clob and blob.
2750     *
2751     *           Default: no type conversion
2752     *
2753     *       null
2754     *           bool    property that indicates that the value for this field
2755     *           should be set to null.
2756     *
2757     *           The default value for fields missing in INSERT queries may be
2758     *           specified the definition of a table. Often, the default value
2759     *           is already null, but since the REPLACE may be emulated using
2760     *           an UPDATE query, make sure that all fields of the table are
2761     *           listed in this function argument array.
2762     *
2763     *           Default: 0
2764     *
2765     *       key
2766     *           bool    property that indicates that this field should be
2767     *           handled as a primary key or at least as part of the compound
2768     *           unique index of the table that will determine the row that will
2769     *           updated if it exists or inserted a new row otherwise.
2770     *
2771     *           This function will fail if no key field is specified or if the
2772     *           value of a key field is set to null because fields that are
2773     *           part of unique index they may not be null.
2774     *
2775     *           Default: 0
2776     *
2777     * @return  mixed   MDB2_OK on success, a MDB2 error on failure
2778     *
2779     * @access  public
2780     */
2781    function replace($table, $fields)
2782    {
2783        if (!$this->supports('replace')) {
2784            return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
2785                'replace query is not supported', __FUNCTION__);
2786        }
2787        $count = count($fields);
2788        $condition = $values = array();
2789        for ($colnum = 0, reset($fields); $colnum < $count; next($fields), $colnum++) {
2790            $name = key($fields);
2791            if (isset($fields[$name]['null']) && $fields[$name]['null']) {
2792                $value = 'NULL';
2793            } else {
2794                $type = isset($fields[$name]['type']) ? $fields[$name]['type'] : null;
2795                $value = $this->quote($fields[$name]['value'], $type);
2796            }
2797            $values[$name] = $value;
2798            if (isset($fields[$name]['key']) && $fields[$name]['key']) {
2799                if ($value === 'NULL') {
2800                    return $this->raiseError(MDB2_ERROR_CANNOT_REPLACE, null, null,
2801                        'key value '.$name.' may not be NULL', __FUNCTION__);
2802                }
2803                $condition[] = $name . '=' . $value;
2804            }
2805        }
2806        if (empty($condition)) {
2807            return $this->raiseError(MDB2_ERROR_CANNOT_REPLACE, null, null,
2808                'not specified which fields are keys', __FUNCTION__);
2809        }
2810
2811        $result = null;
2812        $in_transaction = $this->in_transaction;
2813        if (!$in_transaction && PEAR::isError($result = $this->beginTransaction())) {
2814            return $result;
2815        }
2816
2817        $connection = $this->getConnection();
2818        if (PEAR::isError($connection)) {
2819            return $connection;
2820        }
2821
2822        $condition = ' WHERE '.implode(' AND ', $condition);
2823        $query = "DELETE FROM $table$condition";
2824        $result =& $this->_doQuery($query, true, $connection);
2825        if (!PEAR::isError($result)) {
2826            $affected_rows = $this->_affectedRows($connection, $result);
2827            $insert = implode(', ', array_keys($values));
2828            $values = implode(', ', $values);
2829            $query = "INSERT INTO $table ($insert) VALUES ($values)";
2830            $result =& $this->_doQuery($query, true, $connection);
2831            if (!PEAR::isError($result)) {
2832                $affected_rows += $this->_affectedRows($connection, $result);;
2833            }
2834        }
2835
2836        if (!$in_transaction) {
2837            if (PEAR::isError($result)) {
2838                $this->rollback();
2839            } else {
2840                $result = $this->commit();
2841            }
2842        }
2843
2844        if (PEAR::isError($result)) {
2845            return $result;
2846        }
2847
2848        return $affected_rows;
2849    }
2850
2851    // }}}
2852    // {{{ function &prepare($query, $types = null, $result_types = null, $lobs = array())
2853
2854    /**
2855     * Prepares a query for multiple execution with execute().
2856     * With some database backends, this is emulated.
2857     * prepare() requires a generic query as string like
2858     * 'INSERT INTO numbers VALUES(?,?)' or
2859     * 'INSERT INTO numbers VALUES(:foo,:bar)'.
2860     * The ? and :[a-zA-Z] and  are placeholders which can be set using
2861     * bindParam() and the query can be send off using the execute() method.
2862     *
2863     * @param   string  the query to prepare
2864     * @param   mixed   array that contains the types of the placeholders
2865     * @param   mixed   array that contains the types of the columns in
2866     *                        the result set or MDB2_PREPARE_RESULT, if set to
2867     *                        MDB2_PREPARE_MANIP the query is handled as a manipulation query
2868     * @param   mixed   key (field) value (parameter) pair for all lob placeholders
2869     *
2870     * @return  mixed   resource handle for the prepared query on success,
2871     *                  a MDB2 error on failure
2872     *
2873     * @access  public
2874     * @see     bindParam, execute
2875     */
2876    function &prepare($query, $types = null, $result_types = null, $lobs = array())
2877    {
2878        $is_manip = ($result_types === MDB2_PREPARE_MANIP);
2879        $offset = $this->offset;
2880        $limit = $this->limit;
2881        $this->offset = $this->limit = 0;
2882        $result = $this->debug($query, __FUNCTION__, array('is_manip' => $is_manip, 'when' => 'pre'));
2883        if ($result) {
2884            if (PEAR::isError($result)) {
2885                return $result;
2886            }
2887            $query = $result;
2888        }
2889        $placeholder_type_guess = $placeholder_type = null;
2890        $question = '?';
2891        $colon = ':';
2892        $positions = array();
2893        $position = 0;
2894        $ignores = $this->sql_comments;
2895        $ignores[] = $this->string_quoting;
2896        $ignores[] = $this->identifier_quoting;
2897        while ($position < strlen($query)) {
2898            $q_position = strpos($query, $question, $position);
2899            $c_position = strpos($query, $colon, $position);
2900            if ($q_position && $c_position) {
2901                $p_position = min($q_position, $c_position);
2902            } elseif ($q_position) {
2903                $p_position = $q_position;
2904            } elseif ($c_position) {
2905                $p_position = $c_position;
2906            } else {
2907                break;
2908            }
2909            if (is_null($placeholder_type)) {
2910                $placeholder_type_guess = $query[$p_position];
2911            }
2912
2913            $new_pos = $this->_skipDelimitedStrings($query, $position, $p_position);
2914            if (PEAR::isError($new_pos)) {
2915                return $new_pos;
2916            }
2917            if ($new_pos != $position) {
2918                $position = $new_pos;
2919                continue; //evaluate again starting from the new position
2920            }
2921
2922            if ($query[$position] == $placeholder_type_guess) {
2923                if (is_null($placeholder_type)) {
2924                    $placeholder_type = $query[$p_position];
2925                    $question = $colon = $placeholder_type;
2926                    if (!empty($types) && is_array($types)) {
2927                        if ($placeholder_type == ':') {
2928                            if (is_int(key($types))) {
2929                                $types_tmp = $types;
2930                                $types = array();
2931                                $count = -1;
2932                            }
2933                        } else {
2934                            $types = array_values($types);
2935                        }
2936                    }
2937                }
2938                if ($placeholder_type == ':') {
2939                    $parameter = preg_replace('/^.{'.($position+1).'}([a-z0-9_]+).*$/si', '\\1', $query);
2940                    if ($parameter === '') {
2941                        $err =& $this->raiseError(MDB2_ERROR_SYNTAX, null, null,
2942                            'named parameter with an empty name', __FUNCTION__);
2943                        return $err;
2944                    }
2945                    $positions[$p_position] = $parameter;
2946                    $query = substr_replace($query, '?', $position, strlen($parameter)+1);
2947                    // use parameter name in type array
2948                    if (isset($count) && isset($types_tmp[++$count])) {
2949                        $types[$parameter] = $types_tmp[$count];
2950                    }
2951                } else {
2952                    $positions[$p_position] = count($positions);
2953                }
2954                $position = $p_position + 1;
2955            } else {
2956                $position = $p_position;
2957            }
2958        }
2959        $class_name = 'MDB2_Statement_'.$this->phptype;
2960        $statement = null;
2961        $obj =& new $class_name($this, $statement, $positions, $query, $types, $result_types, $is_manip, $limit, $offset);
2962        $this->debug($query, __FUNCTION__, array('is_manip' => $is_manip, 'when' => 'post', 'result' => $obj));
2963        return $obj;
2964    }
2965
2966    // }}}
2967    // {{{ function _skipDelimitedStrings($query, $position, $p_position)
2968   
2969    /**
2970     * Utility method, used by prepare() to avoid replacing placeholders within delimited strings.
2971     * Check if the placeholder is contained within a delimited string.
2972     * If so, skip it and advance the position, otherwise return the current position,
2973     * which is valid
2974     *
2975     * @param string $query
2976     * @param integer $position current string cursor position
2977     * @param integer $p_position placeholder position
2978     *
2979     * @return mixed integer $new_position on success
2980     *               MDB2_Error on failure
2981     *
2982     * @access  protected
2983     */
2984    function _skipDelimitedStrings($query, $position, $p_position)
2985    {
2986        $ignores = $this->sql_comments;
2987        $ignores[] = $this->string_quoting;
2988        $ignores[] = $this->identifier_quoting;
2989       
2990        foreach ($ignores as $ignore) {
2991            if (!empty($ignore['start'])) {
2992                if (is_int($start_quote = strpos($query, $ignore['start'], $position)) && $start_quote < $p_position) {
2993                    $end_quote = $start_quote;
2994                    do {
2995                        if (!is_int($end_quote = strpos($query, $ignore['end'], $end_quote + 1))) {
2996                            if ($ignore['end'] === "\n") {
2997                                $end_quote = strlen($query) - 1;
2998                            } else {
2999                                $err =& $this->raiseError(MDB2_ERROR_SYNTAX, null, null,
3000                                    'query with an unterminated text string specified', __FUNCTION__);
3001                                return $err;
3002                            }
3003                        }
3004                    } while ($ignore['escape'] && $query[($end_quote - 1)] == $ignore['escape']);
3005                    $position = $end_quote + 1;
3006                    return $position;
3007                }
3008            }
3009        }
3010        return $position;
3011    }
3012   
3013    // }}}
3014    // {{{ function quote($value, $type = null, $quote = true)
3015
3016    /**
3017     * Convert a text value into a DBMS specific format that is suitable to
3018     * compose query statements.
3019     *
3020     * @param   string  text string value that is intended to be converted.
3021     * @param   string  type to which the value should be converted to
3022     * @param   bool    quote
3023     * @param   bool    escape wildcards
3024     *
3025     * @return  string  text string that represents the given argument value in
3026     *       a DBMS specific format.
3027     *
3028     * @access  public
3029     */
3030    function quote($value, $type = null, $quote = true, $escape_wildcards = false)
3031    {
3032        $result = $this->loadModule('Datatype', null, true);
3033        if (PEAR::isError($result)) {
3034            return $result;
3035        }
3036
3037        return $this->datatype->quote($value, $type, $quote, $escape_wildcards);
3038    }
3039
3040    // }}}
3041    // {{{ function getDeclaration($type, $name, $field)
3042
3043    /**
3044     * Obtain DBMS specific SQL code portion needed to declare
3045     * of the given type
3046     *
3047     * @param   string  type to which the value should be converted to
3048     * @param   string  name the field to be declared.
3049     * @param   string  definition of the field
3050     *
3051     * @return  string  DBMS specific SQL code portion that should be used to
3052     *                 declare the specified field.
3053     *
3054     * @access  public
3055     */
3056    function getDeclaration($type, $name, $field)
3057    {
3058        $result = $this->loadModule('Datatype', null, true);
3059        if (PEAR::isError($result)) {
3060            return $result;
3061        }
3062        return $this->datatype->getDeclaration($type, $name, $field);
3063    }
3064
3065    // }}}
3066    // {{{ function compareDefinition($current, $previous)
3067
3068    /**
3069     * Obtain an array of changes that may need to applied
3070     *
3071     * @param   array   new definition
3072     * @param   array   old definition
3073     *
3074     * @return  array   containing all changes that will need to be applied
3075     *
3076     * @access  public
3077     */
3078    function compareDefinition($current, $previous)
3079    {
3080        $result = $this->loadModule('Datatype', null, true);
3081        if (PEAR::isError($result)) {
3082            return $result;
3083        }
3084        return $this->datatype->compareDefinition($current, $previous);
3085    }
3086
3087    // }}}
3088    // {{{ function supports($feature)
3089
3090    /**
3091     * Tell whether a DB implementation or its backend extension
3092     * supports a given feature.
3093     *
3094     * @param   string  name of the feature (see the MDB2 class doc)
3095     *
3096     * @return  bool|string if this DB implementation supports a given feature
3097     *                      false means no, true means native,
3098     *                      'emulated' means emulated
3099     *
3100     * @access  public
3101     */
3102    function supports($feature)
3103    {
3104        if (array_key_exists($feature, $this->supported)) {
3105            return $this->supported[$feature];
3106        }
3107        return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
3108            "unknown support feature $feature", __FUNCTION__);
3109    }
3110
3111    // }}}
3112    // {{{ function getSequenceName($sqn)
3113
3114    /**
3115     * adds sequence name formatting to a sequence name
3116     *
3117     * @param   string  name of the sequence
3118     *
3119     * @return  string  formatted sequence name
3120     *
3121     * @access  public
3122     */
3123    function getSequenceName($sqn)
3124    {
3125        return sprintf($this->options['seqname_format'],
3126            preg_replace('/[^a-z0-9_\$.]/i', '_', $sqn));
3127    }
3128
3129    // }}}
3130    // {{{ function getIndexName($idx)
3131
3132    /**
3133     * adds index name formatting to a index name
3134     *
3135     * @param   string  name of the index
3136     *
3137     * @return  string  formatted index name
3138     *
3139     * @access  public
3140     */
3141    function getIndexName($idx)
3142    {
3143        return sprintf($this->options['idxname_format'],
3144            preg_replace('/[^a-z0-9_\$]/i', '_', $idx));
3145    }
3146
3147    // }}}
3148    // {{{ function nextID($seq_name, $ondemand = true)
3149
3150    /**
3151     * Returns the next free id of a sequence
3152     *
3153     * @param   string  name of the sequence
3154     * @param   bool    when true missing sequences are automatic created
3155     *
3156     * @return  mixed   MDB2 Error Object or id
3157     *
3158     * @access  public
3159     */
3160    function nextID($seq_name, $ondemand = true)
3161    {
3162        return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
3163            'method not implemented', __FUNCTION__);
3164    }
3165
3166    // }}}
3167    // {{{ function lastInsertID($table = null, $field = null)
3168
3169    /**
3170     * Returns the autoincrement ID if supported or $id or fetches the current
3171     * ID in a sequence called: $table.(empty($field) ? '' : '_'.$field)
3172     *
3173     * @param   string  name of the table into which a new row was inserted
3174     * @param   string  name of the field into which a new row was inserted
3175     *
3176     * @return  mixed   MDB2 Error Object or id
3177     *
3178     * @access  public
3179     */
3180    function lastInsertID($table = null, $field = null)
3181    {
3182        return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
3183            'method not implemented', __FUNCTION__);
3184    }
3185
3186    // }}}
3187    // {{{ function currID($seq_name)
3188
3189    /**
3190     * Returns the current id of a sequence
3191     *
3192     * @param   string  name of the sequence
3193     *
3194     * @return  mixed   MDB2 Error Object or id
3195     *
3196     * @access  public
3197     */
3198    function currID($seq_name)
3199    {
3200        $this->warnings[] = 'database does not support getting current
3201            sequence value, the sequence value was incremented';
3202        return $this->nextID($seq_name);
3203    }
3204
3205    // }}}
3206    // {{{ function queryOne($query, $type = null, $colnum = 0)
3207
3208    /**
3209     * Execute the specified query, fetch the value from the first column of
3210     * the first row of the result set and then frees
3211     * the result set.
3212     *
3213     * @param   string  the SELECT query statement to be executed.
3214     * @param   string  optional argument that specifies the expected
3215     *       datatype of the result set field, so that an eventual conversion
3216     *       may be performed. The default datatype is text, meaning that no
3217     *       conversion is performed
3218     * @param   int     the column number to fetch
3219     *
3220     * @return  mixed   MDB2_OK or field value on success, a MDB2 error on failure
3221     *
3222     * @access  public
3223     */
3224    function queryOne($query, $type = null, $colnum = 0)
3225    {
3226        $result = $this->query($query, $type);
3227        if (!MDB2::isResultCommon($result)) {
3228            return $result;
3229        }
3230
3231        $one = $result->fetchOne($colnum);
3232        $result->free();
3233        return $one;
3234    }
3235
3236    // }}}
3237    // {{{ function queryRow($query, $types = null, $fetchmode = MDB2_FETCHMODE_DEFAULT)
3238
3239    /**
3240     * Execute the specified query, fetch the values from the first
3241     * row of the result set into an array and then frees
3242     * the result set.
3243     *
3244     * @param   string  the SELECT query statement to be executed.
3245     * @param   array   optional array argument that specifies a list of
3246     *       expected datatypes of the result set columns, so that the eventual
3247     *       conversions may be performed. The default list of datatypes is
3248     *       empty, meaning that no conversion is performed.
3249     * @param   int     how the array data should be indexed
3250     *
3251     * @return  mixed   MDB2_OK or data array on success, a MDB2 error on failure
3252     *
3253     * @access  public
3254     */
3255    function queryRow($query, $types = null, $fetchmode = MDB2_FETCHMODE_DEFAULT)
3256    {
3257        $result = $this->query($query, $types);
3258        if (!MDB2::isResultCommon($result)) {
3259            return $result;
3260        }
3261
3262        $row = $result->fetchRow($fetchmode);
3263        $result->free();
3264        return $row;
3265    }
3266
3267    // }}}
3268    // {{{ function queryCol($query, $type = null, $colnum = 0)
3269
3270    /**
3271     * Execute the specified query, fetch the value from the first column of
3272     * each row of the result set into an array and then frees the result set.
3273     *
3274     * @param   string  the SELECT query statement to be executed.
3275     * @param   string  optional argument that specifies the expected
3276     *       datatype of the result set field, so that an eventual conversion
3277     *       may be performed. The default datatype is text, meaning that no
3278     *       conversion is performed
3279     * @param   int     the row number to fetch
3280     *
3281     * @return  mixed   MDB2_OK or data array on success, a MDB2 error on failure
3282     *
3283     * @access  public
3284     */
3285    function queryCol($query, $type = null, $colnum = 0)
3286    {
3287        $result = $this->query($query, $type);
3288        if (!MDB2::isResultCommon($result)) {
3289            return $result;
3290        }
3291
3292        $col = $result->fetchCol($colnum);
3293        $result->free();
3294        return $col;
3295    }
3296
3297    // }}}
3298    // {{{ function queryAll($query, $types = null, $fetchmode = MDB2_FETCHMODE_DEFAULT, $rekey = false, $force_array = false, $group = false)
3299
3300    /**
3301     * Execute the specified query, fetch all the rows of the result set into
3302     * a two dimensional array and then frees the result set.
3303     *
3304     * @param   string  the SELECT query statement to be executed.
3305     * @param   array   optional array argument that specifies a list of
3306     *       expected datatypes of the result set columns, so that the eventual
3307     *       conversions may be performed. The default list of datatypes is
3308     *       empty, meaning that no conversion is performed.
3309     * @param   int     how the array data should be indexed
3310     * @param   bool    if set to true, the $all will have the first
3311     *       column as its first dimension
3312     * @param   bool    used only when the query returns exactly
3313     *       two columns. If true, the values of the returned array will be
3314     *       one-element arrays instead of scalars.
3315     * @param   bool    if true, the values of the returned array is
3316     *       wrapped in another array.  If the same key value (in the first
3317     *       column) repeats itself, the values will be appended to this array
3318     *       instead of overwriting the existing values.
3319     *
3320     * @return  mixed   MDB2_OK or data array on success, a MDB2 error on failure
3321     *
3322     * @access  public
3323     */
3324    function queryAll($query, $types = null, $fetchmode = MDB2_FETCHMODE_DEFAULT,
3325        $rekey = false, $force_array = false, $group = false)
3326    {
3327        $result = $this->query($query, $types);
3328        if (!MDB2::isResultCommon($result)) {
3329            return $result;
3330        }
3331
3332        $all = $result->fetchAll($fetchmode, $rekey, $force_array, $group);
3333        $result->free();
3334        return $all;
3335    }
3336
3337    // }}}
3338}
3339
3340// }}}
3341// {{{ class MDB2_Result
3342
3343/**
3344 * The dummy class that all user space result classes should extend from
3345 *
3346 * @package     MDB2
3347 * @category    Database
3348 * @author      Lukas Smith <smith@pooteeweet.org>
3349 */
3350class MDB2_Result
3351{
3352}
3353
3354// }}}
3355// {{{ class MDB2_Result_Common extends MDB2_Result
3356
3357/**
3358 * The common result class for MDB2 result objects
3359 *
3360 * @package     MDB2
3361 * @category    Database
3362 * @author      Lukas Smith <smith@pooteeweet.org>
3363 */
3364class MDB2_Result_Common extends MDB2_Result
3365{
3366    // {{{ Variables (Properties)
3367
3368    var $db;
3369    var $result;
3370    var $rownum = -1;
3371    var $types = array();
3372    var $values = array();
3373    var $offset;
3374    var $offset_count = 0;
3375    var $limit;
3376    var $column_names;
3377
3378    // }}}
3379    // {{{ constructor: function __construct(&$db, &$result, $limit = 0, $offset = 0)
3380
3381    /**
3382     * Constructor
3383     */
3384    function __construct(&$db, &$result, $limit = 0, $offset = 0)
3385    {
3386        $this->db =& $db;
3387        $this->result =& $result;
3388        $this->offset = $offset;
3389        $this->limit = max(0, $limit - 1);
3390    }
3391
3392    // }}}
3393    // {{{ function MDB2_Result_Common(&$db, &$result, $limit = 0, $offset = 0)
3394
3395    /**
3396     * PHP 4 Constructor
3397     */
3398    function MDB2_Result_Common(&$db, &$result, $limit = 0, $offset = 0)
3399    {
3400        $this->__construct($db, $result, $limit, $offset);
3401    }
3402
3403    // }}}
3404    // {{{ function setResultTypes($types)
3405
3406    /**
3407     * Define the list of types to be associated with the columns of a given
3408     * result set.
3409     *
3410     * This function may be called before invoking fetchRow(), fetchOne(),
3411     * fetchCol() and fetchAll() so that the necessary data type
3412     * conversions are performed on the data to be retrieved by them. If this
3413     * function is not called, the type of all result set columns is assumed
3414     * to be text, thus leading to not perform any conversions.
3415     *
3416     * @param   array   variable that lists the
3417     *       data types to be expected in the result set columns. If this array
3418     *       contains less types than the number of columns that are returned
3419     *       in the result set, the remaining columns are assumed to be of the
3420     *       type text. Currently, the types clob and blob are not fully
3421     *       supported.
3422     *
3423     * @return  mixed   MDB2_OK on success, a MDB2 error on failure
3424     *
3425     * @access  public
3426     */
3427    function setResultTypes($types)
3428    {
3429        $load = $this->db->loadModule('Datatype', null, true);
3430        if (PEAR::isError($load)) {
3431            return $load;
3432        }
3433        $types = $this->db->datatype->checkResultTypes($types);
3434        if (PEAR::isError($types)) {
3435            return $types;
3436        }
3437        $this->types = $types;
3438        return MDB2_OK;
3439    }
3440
3441    // }}}
3442    // {{{ function seek($rownum = 0)
3443
3444    /**
3445     * Seek to a specific row in a result set
3446     *
3447     * @param   int     number of the row where the data can be found
3448     *
3449     * @return  mixed   MDB2_OK on success, a MDB2 error on failure
3450     *
3451     * @access  public
3452     */
3453    function seek($rownum = 0)
3454    {
3455        $target_rownum = $rownum - 1;
3456        if ($this->rownum > $target_rownum) {
3457            return $this->db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
3458                'seeking to previous rows not implemented', __FUNCTION__);
3459        }
3460        while ($this->rownum < $target_rownum) {
3461            $this->fetchRow();
3462        }
3463        return MDB2_OK;
3464    }
3465
3466    // }}}
3467    // {{{ function &fetchRow($fetchmode = MDB2_FETCHMODE_DEFAULT, $rownum = null)
3468
3469    /**
3470     * Fetch and return a row of data
3471     *
3472     * @param   int     how the array data should be indexed
3473     * @param   int     number of the row where the data can be found
3474     *
3475     * @return  int     data array on success, a MDB2 error on failure
3476     *
3477     * @access  public
3478     */
3479    function &fetchRow($fetchmode = MDB2_FETCHMODE_DEFAULT, $rownum = null)
3480    {
3481        $err =& $this->db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
3482            'method not implemented', __FUNCTION__);
3483        return $err;
3484    }
3485
3486    // }}}
3487    // {{{ function fetchOne($colnum = 0)
3488
3489    /**
3490     * fetch single column from the next row from a result set
3491     *
3492     * @param   int     the column number to fetch
3493     * @param   int     number of the row where the data can be found
3494     *
3495     * @return  string  data on success, a MDB2 error on failure
3496     *
3497     * @access  public
3498     */
3499    function fetchOne($colnum = 0, $rownum = null)
3500    {
3501        $fetchmode = is_numeric($colnum) ? MDB2_FETCHMODE_ORDERED : MDB2_FETCHMODE_ASSOC;
3502        $row = $this->fetchRow($fetchmode, $rownum);
3503        if (!is_array($row) || PEAR::isError($row)) {
3504            return $row;
3505        }
3506        if (!array_key_exists($colnum, $row)) {
3507            return $this->db->raiseError(MDB2_ERROR_TRUNCATED, null, null,
3508                'column is not defined in the result set: '.$colnum, __FUNCTION__);
3509        }
3510        return $row[$colnum];
3511    }
3512
3513    // }}}
3514    // {{{ function fetchCol($colnum = 0)
3515
3516    /**
3517     * Fetch and return a column from the current row pointer position
3518     *
3519     * @param   int     the column number to fetch
3520     *
3521     * @return  mixed   data array on success, a MDB2 error on failure
3522     *
3523     * @access  public
3524     */
3525    function fetchCol($colnum = 0)
3526    {
3527        $column = array();
3528        $fetchmode = is_numeric($colnum) ? MDB2_FETCHMODE_ORDERED : MDB2_FETCHMODE_ASSOC;
3529        $row = $this->fetchRow($fetchmode);
3530        if (is_array($row)) {
3531            if (!array_key_exists($colnum, $row)) {
3532                return $this->db->raiseError(MDB2_ERROR_TRUNCATED, null, null,
3533                    'column is not defined in the result set: '.$colnum, __FUNCTION__);
3534            }
3535            do {
3536                $column[] = $row[$colnum];
3537            } while (is_array($row = $this->fetchRow($fetchmode)));
3538        }
3539        if (PEAR::isError($row)) {
3540            return $row;
3541        }
3542        return $column;
3543    }
3544
3545    // }}}
3546    // {{{ function fetchAll($fetchmode = MDB2_FETCHMODE_DEFAULT, $rekey = false, $force_array = false, $group = false)
3547
3548    /**
3549     * Fetch and return all rows from the current row pointer position
3550     *
3551     * @param   int     $fetchmode  the fetch mode to use:
3552     *                            + MDB2_FETCHMODE_ORDERED
3553     *                            + MDB2_FETCHMODE_ASSOC
3554     *                            + MDB2_FETCHMODE_ORDERED | MDB2_FETCHMODE_FLIPPED
3555     *                            + MDB2_FETCHMODE_ASSOC | MDB2_FETCHMODE_FLIPPED
3556     * @param   bool    if set to true, the $all will have the first
3557     *       column as its first dimension
3558     * @param   bool    used only when the query returns exactly
3559     *       two columns. If true, the values of the returned array will be
3560     *       one-element arrays instead of scalars.
3561     * @param   bool    if true, the values of the returned array is
3562     *       wrapped in another array.  If the same key value (in the first
3563     *       column) repeats itself, the values will be appended to this array
3564     *       instead of overwriting the existing values.
3565     *
3566     * @return  mixed   data array on success, a MDB2 error on failure
3567     *
3568     * @access  public
3569     * @see     getAssoc()
3570     */
3571    function fetchAll($fetchmode = MDB2_FETCHMODE_DEFAULT, $rekey = false,
3572        $force_array = false, $group = false)
3573    {
3574        $all = array();
3575        $row = $this->fetchRow($fetchmode);
3576        if (PEAR::isError($row)) {
3577            return $row;
3578        } elseif (!$row) {
3579            return $all;
3580        }
3581
3582        $shift_array = $rekey ? false : null;
3583        if (!is_null($shift_array)) {
3584            if (is_object($row)) {
3585                $colnum = count(get_object_vars($row));
3586            } else {
3587                $colnum = count($row);
3588            }
3589            if ($colnum < 2) {
3590                return $this->db->raiseError(MDB2_ERROR_TRUNCATED, null, null,
3591                    'rekey feature requires atleast 2 column', __FUNCTION__);
3592            }
3593            $shift_array = (!$force_array && $colnum == 2);
3594        }
3595
3596        if ($rekey) {
3597            do {
3598                if (is_object($row)) {
3599                    $arr = get_object_vars($row);
3600                    $key = reset($arr);
3601                    unset($row->{$key});
3602                } else {
3603                    if ($fetchmode & MDB2_FETCHMODE_ASSOC) {
3604                        $key = reset($row);
3605                        unset($row[key($row)]);
3606                    } else {
3607                        $key = array_shift($row);
3608                    }
3609                    if ($shift_array) {
3610                        $row = array_shift($row);
3611                    }
3612                }
3613                if ($group) {
3614                    $all[$key][] = $row;
3615                } else {
3616                    $all[$key] = $row;
3617                }
3618            } while (($row = $this->fetchRow($fetchmode)));
3619        } elseif ($fetchmode & MDB2_FETCHMODE_FLIPPED) {
3620            do {
3621                foreach ($row as $key => $val) {
3622                    $all[$key][] = $val;
3623                }
3624            } while (($row = $this->fetchRow($fetchmode)));
3625        } else {
3626            do {
3627                $all[] = $row;
3628            } while (($row = $this->fetchRow($fetchmode)));
3629        }
3630
3631        return $all;
3632    }
3633
3634    // }}}
3635    // {{{ function rowCount()
3636    /**
3637     * Returns the actual row number that was last fetched (count from 0)
3638     * @return  int
3639     *
3640     * @access  public
3641     */
3642    function rowCount()
3643    {
3644        return $this->rownum + 1;
3645    }
3646
3647    // }}}
3648    // {{{ function numRows()
3649
3650    /**
3651     * Returns the number of rows in a result object
3652     *
3653     * @return  mixed   MDB2 Error Object or the number of rows
3654     *
3655     * @access  public
3656     */
3657    function numRows()
3658    {
3659        return $this->db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
3660            'method not implemented', __FUNCTION__);
3661    }
3662
3663    // }}}
3664    // {{{ function nextResult()
3665
3666    /**
3667     * Move the internal result pointer to the next available result
3668     *
3669     * @return  true on success, false if there is no more result set or an error object on failure
3670     *
3671     * @access  public
3672     */
3673    function nextResult()
3674    {
3675        return $this->db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
3676            'method not implemented', __FUNCTION__);
3677    }
3678
3679    // }}}
3680    // {{{ function getColumnNames()
3681
3682    /**
3683     * Retrieve the names of columns returned by the DBMS in a query result or
3684     * from the cache.
3685     *
3686     * @param   bool    If set to true the values are the column names,
3687     *                  otherwise the names of the columns are the keys.
3688     * @return  mixed   Array variable that holds the names of columns or an
3689     *                  MDB2 error on failure.
3690     *                  Some DBMS may not return any columns when the result set
3691     *                  does not contain any rows.
3692     *
3693     * @access  public
3694     */
3695    function getColumnNames($flip = false)
3696    {
3697        if (!isset($this->column_names)) {
3698            $result = $this->_getColumnNames();
3699            if (PEAR::isError($result)) {
3700                return $result;
3701            }
3702            $this->column_names = $result;
3703        }
3704        if ($flip) {
3705            return array_flip($this->column_names);
3706        }
3707        return $this->column_names;
3708    }
3709
3710    // }}}
3711    // {{{ function _getColumnNames()
3712
3713    /**
3714     * Retrieve the names of columns returned by the DBMS in a query result.
3715     *
3716     * @return  mixed   Array variable that holds the names of columns as keys
3717     *                  or an MDB2 error on failure.
3718     *                  Some DBMS may not return any columns when the result set
3719     *                  does not contain any rows.
3720     *
3721     * @access  private
3722     */
3723    function _getColumnNames()
3724    {
3725        return $this->db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
3726            'method not implemented', __FUNCTION__);
3727    }
3728
3729    // }}}
3730    // {{{ function numCols()
3731
3732    /**
3733     * Count the number of columns returned by the DBMS in a query result.
3734     *
3735     * @return  mixed   integer value with the number of columns, a MDB2 error
3736     *       on failure
3737     *
3738     * @access  public
3739     */
3740    function numCols()
3741    {
3742        return $this->db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
3743            'method not implemented', __FUNCTION__);
3744    }
3745
3746    // }}}
3747    // {{{ function getResource()
3748
3749    /**
3750     * return the resource associated with the result object
3751     *
3752     * @return  resource
3753     *
3754     * @access  public
3755     */
3756    function getResource()
3757    {
3758        return $this->result;
3759    }
3760
3761    // }}}
3762    // {{{ function bindColumn($column, &$value, $type = null)
3763
3764    /**
3765     * Set bind variable to a column.
3766     *
3767     * @param   int     column number or name
3768     * @param   mixed   variable reference
3769     * @param   string  specifies the type of the field
3770     *
3771     * @return  mixed   MDB2_OK on success, a MDB2 error on failure
3772     *
3773     * @access  public
3774     */
3775    function bindColumn($column, &$value, $type = null)
3776    {
3777        if (!is_numeric($column)) {
3778            $column_names = $this->getColumnNames();
3779            if ($this->db->options['portability'] & MDB2_PORTABILITY_FIX_CASE) {
3780                if ($this->db->options['field_case'] == CASE_LOWER) {
3781                    $column = strtolower($column);
3782                } else {
3783                    $column = strtoupper($column);
3784                }
3785            }
3786            $column = $column_names[$column];
3787        }
3788        $this->values[$column] =& $value;
3789        if (!is_null($type)) {
3790            $this->types[$column] = $type;
3791        }
3792        return MDB2_OK;
3793    }
3794
3795    // }}}
3796    // {{{ function _assignBindColumns($row)
3797
3798    /**
3799     * Bind a variable to a value in the result row.
3800     *
3801     * @param   array   row data
3802     *
3803     * @return  mixed   MDB2_OK on success, a MDB2 error on failure
3804     *
3805     * @access  private
3806     */
3807    function _assignBindColumns($row)
3808    {
3809        $row = array_values($row);
3810        foreach ($row as $column => $value) {
3811            if (array_key_exists($column, $this->values)) {
3812                $this->values[$column] = $value;
3813            }
3814        }
3815        return MDB2_OK;
3816    }
3817
3818    // }}}
3819    // {{{ function free()
3820
3821    /**
3822     * Free the internal resources associated with result.
3823     *
3824     * @return  bool    true on success, false if result is invalid
3825     *
3826     * @access  public
3827     */
3828    function free()
3829    {
3830        $this->result = false;
3831        return MDB2_OK;
3832    }
3833
3834    // }}}
3835}
3836
3837// }}}
3838// {{{ class MDB2_Row
3839
3840/**
3841 * The simple class that accepts row data as an array
3842 *
3843 * @package     MDB2
3844 * @category    Database
3845 * @author      Lukas Smith <smith@pooteeweet.org>
3846 */
3847class MDB2_Row
3848{
3849    // {{{ constructor: function __construct(&$row)
3850
3851    /**
3852     * constructor
3853     *
3854     * @param   resource    row data as array
3855     */
3856    function __construct(&$row)
3857    {
3858        foreach ($row as $key => $value) {
3859            $this->$key = &$row[$key];
3860        }
3861    }
3862
3863    // }}}
3864    // {{{ function MDB2_Row(&$row)
3865
3866    /**
3867     * PHP 4 Constructor
3868     *
3869     * @param   resource    row data as array
3870     */
3871    function MDB2_Row(&$row)
3872    {
3873        $this->__construct($row);
3874    }
3875
3876    // }}}
3877}
3878
3879// }}}
3880// {{{ class MDB2_Statement_Common
3881
3882/**
3883 * The common statement class for MDB2 statement objects
3884 *
3885 * @package     MDB2
3886 * @category    Database
3887 * @author      Lukas Smith <smith@pooteeweet.org>
3888 */
3889class MDB2_Statement_Common
3890{
3891    // {{{ Variables (Properties)
3892
3893    var $db;
3894    var $statement;
3895    var $query;
3896    var $result_types;
3897    var $types;
3898    var $values = array();
3899    var $limit;
3900    var $offset;
3901    var $is_manip;
3902
3903    // }}}
3904    // {{{ constructor: function __construct(&$db, &$statement, $positions, $query, $types, $result_types, $is_manip = false, $limit = null, $offset = null)
3905
3906    /**
3907     * Constructor
3908     */
3909    function __construct(&$db, &$statement, $positions, $query, $types, $result_types, $is_manip = false, $limit = null, $offset = null)
3910    {
3911        $this->db =& $db;
3912        $this->statement =& $statement;
3913        $this->positions = $positions;
3914        $this->query = $query;
3915        $this->types = (array)$types;
3916        $this->result_types = (array)$result_types;
3917        $this->limit = $limit;
3918        $this->is_manip = $is_manip;
3919        $this->offset = $offset;
3920    }
3921
3922    // }}}
3923    // {{{ function MDB2_Statement_Common(&$db, &$statement, $positions, $query, $types, $result_types, $is_manip = false, $limit = null, $offset = null)
3924
3925    /**
3926     * PHP 4 Constructor
3927     */
3928    function MDB2_Statement_Common(&$db, &$statement, $positions, $query, $types, $result_types, $is_manip = false, $limit = null, $offset = null)
3929    {
3930        $this->__construct($db, $statement, $positions, $query, $types, $result_types, $is_manip, $limit, $offset);
3931    }
3932
3933    // }}}
3934    // {{{ function bindValue($parameter, &$value, $type = null)
3935
3936    /**
3937     * Set the value of a parameter of a prepared query.
3938     *
3939     * @param   int     the order number of the parameter in the query
3940     *       statement. The order number of the first parameter is 1.
3941     * @param   mixed   value that is meant to be assigned to specified
3942     *       parameter. The type of the value depends on the $type argument.
3943     * @param   string  specifies the type of the field
3944     *
3945     * @return  mixed   MDB2_OK on success, a MDB2 error on failure
3946     *
3947     * @access  public
3948     */
3949    function bindValue($parameter, $value, $type = null)
3950    {
3951        if (!is_numeric($parameter)) {
3952            $parameter = preg_replace('/^:(.*)$/', '\\1', $parameter);
3953        }
3954        if (!in_array($parameter, $this->positions)) {
3955            return $this->db->raiseError(MDB2_ERROR_NOT_FOUND, null, null,
3956                'Unable to bind to missing placeholder: '.$parameter, __FUNCTION__);
3957        }
3958        $this->values[$parameter] = $value;
3959        if (!is_null($type)) {
3960            $this->types[$parameter] = $type;
3961        }
3962        return MDB2_OK;
3963    }
3964
3965    // }}}
3966    // {{{ function bindValueArray($values, $types = null)
3967
3968    /**
3969     * Set the values of multiple a parameter of a prepared query in bulk.
3970     *
3971     * @param   array   specifies all necessary information
3972     *       for bindValue() the array elements must use keys corresponding to
3973     *       the number of the position of the parameter.
3974     * @param   array   specifies the types of the fields
3975     *
3976     * @return  mixed   MDB2_OK on success, a MDB2 error on failure
3977     *
3978     * @access  public
3979     * @see     bindParam()
3980     */
3981    function bindValueArray($values, $types = null)
3982    {
3983        $types = is_array($types) ? array_values($types) : array_fill(0, count($values), null);
3984        $parameters = array_keys($values);
3985        foreach ($parameters as $key => $parameter) {
3986            $err = $this->bindValue($parameter, $values[$parameter], $types[$key]);
3987            if (PEAR::isError($err)) {
3988                return $err;
3989            }
3990        }
3991        return MDB2_OK;
3992    }
3993
3994    // }}}
3995    // {{{ function bindParam($parameter, &$value, $type = null)
3996
3997    /**
3998     * Bind a variable to a parameter of a prepared query.
3999     *
4000     * @param   int     the order number of the parameter in the query
4001     *       statement. The order number of the first parameter is 1.
4002     * @param   mixed   variable that is meant to be bound to specified
4003     *       parameter. The type of the value depends on the $type argument.
4004     * @param   string  specifies the type of the field
4005     *
4006     * @return  mixed   MDB2_OK on success, a MDB2 error on failure
4007     *
4008     * @access  public
4009     */
4010    function bindParam($parameter, &$value, $type = null)
4011    {
4012        if (!is_numeric($parameter)) {
4013            $parameter = preg_replace('/^:(.*)$/', '\\1', $parameter);
4014        }
4015        if (!in_array($parameter, $this->positions)) {
4016            return $this->db->raiseError(MDB2_ERROR_NOT_FOUND, null, null,
4017                'Unable to bind to missing placeholder: '.$parameter, __FUNCTION__);
4018        }
4019        $this->values[$parameter] =& $value;
4020        if (!is_null($type)) {
4021            $this->types[$parameter] = $type;
4022        }
4023        return MDB2_OK;
4024    }
4025
4026    // }}}
4027    // {{{ function bindParamArray(&$values, $types = null)
4028
4029    /**
4030     * Bind the variables of multiple a parameter of a prepared query in bulk.
4031     *
4032     * @param   array   specifies all necessary information
4033     *       for bindParam() the array elements must use keys corresponding to
4034     *       the number of the position of the parameter.
4035     * @param   array   specifies the types of the fields
4036     *
4037     * @return  mixed   MDB2_OK on success, a MDB2 error on failure
4038     *
4039     * @access  public
4040     * @see     bindParam()
4041     */
4042    function bindParamArray(&$values, $types = null)
4043    {
4044        $types = is_array($types) ? array_values($types) : array_fill(0, count($values), null);
4045        $parameters = array_keys($values);
4046        foreach ($parameters as $key => $parameter) {
4047            $err = $this->bindParam($parameter, $values[$parameter], $types[$key]);
4048            if (PEAR::isError($err)) {
4049                return $err;
4050            }
4051        }
4052        return MDB2_OK;
4053    }
4054
4055    // }}}
4056    // {{{ function &execute($values = null, $result_class = true, $result_wrap_class = false)
4057
4058    /**
4059     * Execute a prepared query statement.
4060     *
4061     * @param   array   specifies all necessary information
4062     *       for bindParam() the array elements must use keys corresponding to
4063     *       the number of the position of the parameter.
4064     * @param   mixed   specifies which result class to use
4065     * @param   mixed   specifies which class to wrap results in
4066     *
4067     * @return  mixed   a result handle or MDB2_OK on success, a MDB2 error on failure
4068     *
4069     * @access  public
4070     */
4071    function &execute($values = null, $result_class = true, $result_wrap_class = false)
4072    {
4073        if (is_null($this->positions)) {
4074            return $this->db->raiseError(MDB2_ERROR, null, null,
4075                'Prepared statement has already been freed', __FUNCTION__);
4076        }
4077
4078        $values = (array)$values;
4079        if (!empty($values)) {
4080            $err = $this->bindValueArray($values);
4081            if (PEAR::isError($err)) {
4082                return $this->db->raiseError(MDB2_ERROR, null, null,
4083                                            'Binding Values failed with message: ' . $err->getMessage(), __FUNCTION__);
4084            }
4085        }
4086        $result =& $this->_execute($result_class, $result_wrap_class);
4087        return $result;
4088    }
4089
4090    // }}}
4091    // {{{ function &_execute($result_class = true, $result_wrap_class = false)
4092
4093    /**
4094     * Execute a prepared query statement helper method.
4095     *
4096     * @param   mixed   specifies which result class to use
4097     * @param   mixed   specifies which class to wrap results in
4098     *
4099     * @return  mixed   MDB2_Result or integer on success, a MDB2 error on failure
4100     *
4101     * @access  private
4102     */
4103    function &_execute($result_class = true, $result_wrap_class = false)
4104    {
4105        $this->last_query = $this->query;
4106        $query = '';
4107        $last_position = 0;
4108        foreach ($this->positions as $current_position => $parameter) {
4109            if (!array_key_exists($parameter, $this->values)) {
4110                return $this->db->raiseError(MDB2_ERROR_NOT_FOUND, null, null,
4111                    'Unable to bind to missing placeholder: '.$parameter, __FUNCTION__);
4112            }
4113            $value = $this->values[$parameter];
4114            $query.= substr($this->query, $last_position, $current_position - $last_position);
4115            if (!isset($value)) {
4116                $value_quoted = 'NULL';
4117            } else {
4118                $type = !empty($this->types[$parameter]) ? $this->types[$parameter] : null;
4119                $value_quoted = $this->db->quote($value, $type);
4120                if (PEAR::isError($value_quoted)) {
4121                    return $value_quoted;
4122                }
4123            }
4124            $query.= $value_quoted;
4125            $last_position = $current_position + 1;
4126        }
4127        $query.= substr($this->query, $last_position);
4128
4129        $this->db->offset = $this->offset;
4130        $this->db->limit = $this->limit;
4131        if ($this->is_manip) {
4132            $result = $this->db->exec($query);
4133        } else {
4134            $result =& $this->db->query($query, $this->result_types, $result_class, $result_wrap_class);
4135        }
4136        return $result;
4137    }
4138
4139    // }}}
4140    // {{{ function free()
4141
4142    /**
4143     * Release resources allocated for the specified prepared query.
4144     *
4145     * @return  mixed   MDB2_OK on success, a MDB2 error on failure
4146     *
4147     * @access  public
4148     */
4149    function free()
4150    {
4151        if (is_null($this->positions)) {
4152            return $this->db->raiseError(MDB2_ERROR, null, null,
4153                'Prepared statement has already been freed', __FUNCTION__);
4154        }
4155
4156        $this->statement = null;
4157        $this->positions = null;
4158        $this->query = null;
4159        $this->types = null;
4160        $this->result_types = null;
4161        $this->limit = null;
4162        $this->is_manip = null;
4163        $this->offset = null;
4164        $this->values = null;
4165
4166        return MDB2_OK;
4167    }
4168
4169    // }}}
4170}
4171
4172// }}}
4173// {{{ class MDB2_Module_Common
4174
4175/**
4176 * The common modules class for MDB2 module objects
4177 *
4178 * @package     MDB2
4179 * @category    Database
4180 * @author      Lukas Smith <smith@pooteeweet.org>
4181 */
4182class MDB2_Module_Common
4183{
4184    // {{{ Variables (Properties)
4185
4186    /**
4187     * contains the key to the global MDB2 instance array of the associated
4188     * MDB2 instance
4189     *
4190     * @var     int
4191     * @access  protected
4192     */
4193    var $db_index;
4194
4195    // }}}
4196    // {{{ constructor: function __construct($db_index)
4197
4198    /**
4199     * Constructor
4200     */
4201    function __construct($db_index)
4202    {
4203        $this->db_index = $db_index;
4204    }
4205
4206    // }}}
4207    // {{{ function MDB2_Module_Common($db_index)
4208
4209    /**
4210     * PHP 4 Constructor
4211     */
4212    function MDB2_Module_Common($db_index)
4213    {
4214        $this->__construct($db_index);
4215    }
4216
4217    // }}}
4218    // {{{ function &getDBInstance()
4219
4220    /**
4221     * Get the instance of MDB2 associated with the module instance
4222     *
4223     * @return  object  MDB2 instance or a MDB2 error on failure
4224     *
4225     * @access  public
4226     */
4227    function &getDBInstance()
4228    {
4229        if (isset($GLOBALS['_MDB2_databases'][$this->db_index])) {
4230            $result =& $GLOBALS['_MDB2_databases'][$this->db_index];
4231        } else {
4232            $result =& MDB2::raiseError(MDB2_ERROR_NOT_FOUND, null, null,
4233                'could not find MDB2 instance');
4234        }
4235        return $result;
4236    }
4237
4238    // }}}
4239}
4240
4241// }}}
4242// {{{ function MDB2_closeOpenTransactions()
4243
4244/**
4245 * Close any open transactions form persistent connections
4246 *
4247 * @return  void
4248 *
4249 * @access  public
4250 */
4251
4252function MDB2_closeOpenTransactions()
4253{
4254    reset($GLOBALS['_MDB2_databases']);
4255    while (next($GLOBALS['_MDB2_databases'])) {
4256        $key = key($GLOBALS['_MDB2_databases']);
4257        if ($GLOBALS['_MDB2_databases'][$key]->opened_persistent
4258            && $GLOBALS['_MDB2_databases'][$key]->in_transaction
4259        ) {
4260            $GLOBALS['_MDB2_databases'][$key]->rollback();
4261        }
4262    }
4263}
4264
4265// }}}
4266// {{{ function MDB2_defaultDebugOutput(&$db, $scope, $message, $is_manip = null)
4267
4268/**
4269 * default debug output handler
4270 *
4271 * @param   object  reference to an MDB2 database object
4272 * @param   string  usually the method name that triggered the debug call:
4273 *                  for example 'query', 'prepare', 'execute', 'parameters',
4274 *                  'beginTransaction', 'commit', 'rollback'
4275 * @param   string  message that should be appended to the debug variable
4276 * @param   array   contains context information about the debug() call
4277 *                  common keys are: is_manip, time, result etc.
4278 *
4279 * @return  void|string optionally return a modified message, this allows
4280 *                      rewriting a query before being issued or prepared
4281 *
4282 * @access  public
4283 */
4284function MDB2_defaultDebugOutput(&$db, $scope, $message, $context = array())
4285{
4286    $db->debug_output.= $scope.'('.$db->db_index.'): ';
4287    $db->debug_output.= $message.$db->getOption('log_line_break');
4288    return $message;
4289}
4290
4291// }}}
4292?>
Note: See TracBrowser for help on using the repository browser.