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

Revision 15963, 137.3 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            if ($phptype_specific === false
1869                || (!MDB2::classExists($class_name) && !MDB2::fileExists($file_name))
1870            ) {
1871                $version = false;
1872                $class_name = 'MDB2_'.$module;
1873                $file_name = str_replace('_', DIRECTORY_SEPARATOR, $class_name).'.php';
1874            }
1875           
1876            $err = MDB2::loadClass($class_name, $this->getOption('debug'));
1877            if (PEAR::isError($err)) {
1878                return $err;
1879            }
1880
1881            // load modul in a specific version
1882            if ($version) {
1883                if (method_exists($class_name, 'getClassName')) {
1884                    $class_name_new = call_user_func(array($class_name, 'getClassName'), $this->db_index);
1885                    if ($class_name != $class_name_new) {
1886                        $class_name = $class_name_new;
1887                        $err = MDB2::loadClass($class_name, $this->getOption('debug'));
1888                        if (PEAR::isError($err)) {
1889                            return $err;
1890                        }
1891                    }
1892                }
1893            }
1894
1895            if (!MDB2::classExists($class_name)) {
1896                $err =& $this->raiseError(MDB2_ERROR_LOADMODULE, null, null,
1897                    "unable to load module '$module' into property '$property'", __FUNCTION__);
1898                return $err;
1899            }
1900            $this->{$property} =& new $class_name($this->db_index);
1901            $this->modules[$module] =& $this->{$property};
1902            if ($version) {
1903                // this will be used in the connect method to determine if the module
1904                // needs to be loaded with a different version if the server
1905                // version changed in between connects
1906                $this->loaded_version_modules[] = $property;
1907            }
1908        }
1909
1910        return $this->{$property};
1911    }
1912
1913    // }}}
1914    // {{{ function __call($method, $params)
1915
1916    /**
1917     * Calls a module method using the __call magic method
1918     *
1919     * @param   string  Method name.
1920     * @param   array   Arguments.
1921     *
1922     * @return  mixed   Returned value.
1923     */
1924    function __call($method, $params)
1925    {
1926        $module = null;
1927        if (preg_match('/^([a-z]+)([A-Z])(.*)$/', $method, $match)
1928            && isset($this->options['modules'][$match[1]])
1929        ) {
1930            $module = $this->options['modules'][$match[1]];
1931            $method = strtolower($match[2]).$match[3];
1932            if (!isset($this->modules[$module]) || !is_object($this->modules[$module])) {
1933                $result =& $this->loadModule($module);
1934                if (PEAR::isError($result)) {
1935                    return $result;
1936                }
1937            }
1938        } else {
1939            foreach ($this->modules as $key => $foo) {
1940                if (is_object($this->modules[$key])
1941                    && method_exists($this->modules[$key], $method)
1942                ) {
1943                    $module = $key;
1944                    break;
1945                }
1946            }
1947        }
1948        if (!is_null($module)) {
1949            return call_user_func_array(array(&$this->modules[$module], $method), $params);
1950        }
1951        trigger_error(sprintf('Call to undefined function: %s::%s().', get_class($this), $method), E_USER_ERROR);
1952    }
1953
1954    // }}}
1955    // {{{ function beginTransaction($savepoint = null)
1956
1957    /**
1958     * Start a transaction or set a savepoint.
1959     *
1960     * @param   string  name of a savepoint to set
1961     * @return  mixed   MDB2_OK on success, a MDB2 error on failure
1962     *
1963     * @access  public
1964     */
1965    function beginTransaction($savepoint = null)
1966    {
1967        $this->debug('Starting transaction', __FUNCTION__, array('is_manip' => true, 'savepoint' => $savepoint));
1968        return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
1969            'transactions are not supported', __FUNCTION__);
1970    }
1971
1972    // }}}
1973    // {{{ function commit($savepoint = null)
1974
1975    /**
1976     * Commit the database changes done during a transaction that is in
1977     * progress or release a savepoint. This function may only be called when
1978     * auto-committing is disabled, otherwise it will fail. Therefore, a new
1979     * transaction is implicitly started after committing the pending changes.
1980     *
1981     * @param   string  name of a savepoint to release
1982     * @return  mixed   MDB2_OK on success, a MDB2 error on failure
1983     *
1984     * @access  public
1985     */
1986    function commit($savepoint = null)
1987    {
1988        $this->debug('Committing transaction/savepoint', __FUNCTION__, array('is_manip' => true, 'savepoint' => $savepoint));
1989        return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
1990            'commiting transactions is not supported', __FUNCTION__);
1991    }
1992
1993    // }}}
1994    // {{{ function rollback($savepoint = null)
1995
1996    /**
1997     * Cancel any database changes done during a transaction or since a specific
1998     * savepoint that is in progress. This function may only be called when
1999     * auto-committing is disabled, otherwise it will fail. Therefore, a new
2000     * transaction is implicitly started after canceling the pending changes.
2001     *
2002     * @param   string  name of a savepoint to rollback to
2003     * @return  mixed   MDB2_OK on success, a MDB2 error on failure
2004     *
2005     * @access  public
2006     */
2007    function rollback($savepoint = null)
2008    {
2009        $this->debug('Rolling back transaction/savepoint', __FUNCTION__, array('is_manip' => true, 'savepoint' => $savepoint));
2010        return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
2011            'rolling back transactions is not supported', __FUNCTION__);
2012    }
2013
2014    // }}}
2015    // {{{ function inTransaction($ignore_nested = false)
2016
2017    /**
2018     * If a transaction is currently open.
2019     *
2020     * @param   bool    if the nested transaction count should be ignored
2021     * @return  int|bool    - an integer with the nesting depth is returned if a
2022     *                      nested transaction is open
2023     *                      - true is returned for a normal open transaction
2024     *                      - false is returned if no transaction is open
2025     *
2026     * @access  public
2027     */
2028    function inTransaction($ignore_nested = false)
2029    {
2030        if (!$ignore_nested && isset($this->nested_transaction_counter)) {
2031            return $this->nested_transaction_counter;
2032        }
2033        return $this->in_transaction;
2034    }
2035
2036    // }}}
2037    // {{{ function setTransactionIsolation($isolation)
2038
2039    /**
2040     * Set the transacton isolation level.
2041     *
2042     * @param   string  standard isolation level
2043     *                  READ UNCOMMITTED (allows dirty reads)
2044     *                  READ COMMITTED (prevents dirty reads)
2045     *                  REPEATABLE READ (prevents nonrepeatable reads)
2046     *                  SERIALIZABLE (prevents phantom reads)
2047     * @param   array some transaction options:
2048     *                  'wait' => 'WAIT' | 'NO WAIT'
2049     *                  'rw'   => 'READ WRITE' | 'READ ONLY'
2050     * @return  mixed   MDB2_OK on success, a MDB2 error on failure
2051     *
2052     * @access  public
2053     * @since   2.1.1
2054     */
2055    function setTransactionIsolation($isolation, $options = array())
2056    {
2057        $this->debug('Setting transaction isolation level', __FUNCTION__, array('is_manip' => true));
2058        return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
2059            'isolation level setting is not supported', __FUNCTION__);
2060    }
2061
2062    // }}}
2063    // {{{ function beginNestedTransaction($savepoint = false)
2064
2065    /**
2066     * Start a nested transaction.
2067     *
2068     * EXPERIMENTAL
2069     *
2070     * WARNING: this function is experimental and may change signature at
2071     * any time until labelled as non-experimental
2072     *
2073     * @return  mixed   MDB2_OK on success/savepoint name, a MDB2 error on failure
2074     *
2075     * @access  public
2076     * @since   2.1.1
2077     */
2078    function beginNestedTransaction()
2079    {
2080        if ($this->in_transaction) {
2081            ++$this->nested_transaction_counter;
2082            $savepoint = sprintf($this->options['savepoint_format'], $this->nested_transaction_counter);
2083            if ($this->supports('savepoints') && $savepoint) {
2084                return $this->beginTransaction($savepoint);
2085            }
2086            return MDB2_OK;
2087        }
2088        $this->has_transaction_error = false;
2089        $result = $this->beginTransaction();
2090        $this->nested_transaction_counter = 1;
2091        return $result;
2092    }
2093
2094    // }}}
2095    // {{{ function completeNestedTransaction($force_rollback = false, $release = false)
2096
2097    /**
2098     * Finish a nested transaction by rolling back if an error occured or
2099     * committing otherwise.
2100     *
2101     * EXPERIMENTAL
2102     *
2103     * WARNING: this function is experimental and may change signature at
2104     * any time until labelled as non-experimental
2105     *
2106     * @param   bool    if the transaction should be rolled back regardless
2107     *                  even if no error was set within the nested transaction
2108     * @return  mixed   MDB_OK on commit/counter decrementing, false on rollback
2109     *                  and a MDB2 error on failure
2110     *
2111     * @access  public
2112     * @since   2.1.1
2113     */
2114    function completeNestedTransaction($force_rollback = false)
2115    {
2116        if ($this->nested_transaction_counter > 1) {
2117            $savepoint = sprintf($this->options['savepoint_format'], $this->nested_transaction_counter);
2118            if ($this->supports('savepoints') && $savepoint) {
2119                if ($force_rollback || $this->has_transaction_error) {
2120                    $result = $this->rollback($savepoint);
2121                    if (!PEAR::isError($result)) {
2122                        $result = false;
2123                        $this->has_transaction_error = false;
2124                    }
2125                } else {
2126                    $result = $this->commit($savepoint);
2127                }
2128            } else {
2129                $result = MDB2_OK;
2130            }
2131            --$this->nested_transaction_counter;
2132            return $result;
2133        }
2134
2135        $this->nested_transaction_counter = null;
2136        $result = MDB2_OK;
2137
2138        // transaction has not yet been rolled back
2139        if ($this->in_transaction) {
2140            if ($force_rollback || $this->has_transaction_error) {
2141                $result = $this->rollback();
2142                if (!PEAR::isError($result)) {
2143                    $result = false;
2144                }
2145            } else {
2146                $result = $this->commit();
2147            }
2148        }
2149        $this->has_transaction_error = false;
2150        return $result;
2151    }
2152
2153    // }}}
2154    // {{{ function failNestedTransaction($error = null, $immediately = false)
2155
2156    /**
2157     * Force setting nested transaction to failed.
2158     *
2159     * EXPERIMENTAL
2160     *
2161     * WARNING: this function is experimental and may change signature at
2162     * any time until labelled as non-experimental
2163     *
2164     * @param   mixed   value to return in getNestededTransactionError()
2165     * @param   bool    if the transaction should be rolled back immediately
2166     * @return  bool    MDB2_OK
2167     *
2168     * @access  public
2169     * @since   2.1.1
2170     */
2171    function failNestedTransaction($error = null, $immediately = false)
2172    {
2173        if (is_null($error)) {
2174            $error = $this->has_transaction_error ? $this->has_transaction_error : true;
2175        } elseif (!$error) {
2176            $error = true;
2177        }
2178        $this->has_transaction_error = $error;
2179        if (!$immediately) {
2180            return MDB2_OK;
2181        }
2182        return $this->rollback();
2183    }
2184
2185    // }}}
2186    // {{{ function getNestedTransactionError()
2187
2188    /**
2189     * The first error that occured since the transaction start.
2190     *
2191     * EXPERIMENTAL
2192     *
2193     * WARNING: this function is experimental and may change signature at
2194     * any time until labelled as non-experimental
2195     *
2196     * @return  MDB2_Error|bool     MDB2 error object if an error occured or false.
2197     *
2198     * @access  public
2199     * @since   2.1.1
2200     */
2201    function getNestedTransactionError()
2202    {
2203        return $this->has_transaction_error;
2204    }
2205
2206    // }}}
2207    // {{{ connect()
2208
2209    /**
2210     * Connect to the database
2211     *
2212     * @return true on success, MDB2 Error Object on failure
2213     */
2214    function connect()
2215    {
2216        return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
2217            'method not implemented', __FUNCTION__);
2218    }
2219
2220    // }}}
2221    // {{{ setCharset($charset, $connection = null)
2222
2223    /**
2224     * Set the charset on the current connection
2225     *
2226     * @param string    charset
2227     * @param resource  connection handle
2228     *
2229     * @return true on success, MDB2 Error Object on failure
2230     */
2231    function setCharset($charset, $connection = null)
2232    {
2233        return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
2234            'method not implemented', __FUNCTION__);
2235    }
2236
2237    // }}}
2238    // {{{ function disconnect($force = true)
2239
2240    /**
2241     * Log out and disconnect from the database.
2242     *
2243     * @param   bool    if the disconnect should be forced even if the
2244     *                  connection is opened persistently
2245     *
2246     * @return  mixed   true on success, false if not connected and error
2247     *                  object on error
2248     *
2249     * @access  public
2250     */
2251    function disconnect($force = true)
2252    {
2253        $this->connection = 0;
2254        $this->connected_dsn = array();
2255        $this->connected_database_name = '';
2256        $this->opened_persistent = null;
2257        $this->connected_server_info = '';
2258        $this->in_transaction = null;
2259        $this->nested_transaction_counter = null;
2260        return MDB2_OK;
2261    }
2262
2263    // }}}
2264    // {{{ function setDatabase($name)
2265
2266    /**
2267     * Select a different database
2268     *
2269     * @param   string  name of the database that should be selected
2270     *
2271     * @return  string  name of the database previously connected to
2272     *
2273     * @access  public
2274     */
2275    function setDatabase($name)
2276    {
2277        $previous_database_name = (isset($this->database_name)) ? $this->database_name : '';
2278        $this->database_name = $name;
2279        $this->disconnect(false);
2280        return $previous_database_name;
2281    }
2282
2283    // }}}
2284    // {{{ function getDatabase()
2285
2286    /**
2287     * Get the current database
2288     *
2289     * @return  string  name of the database
2290     *
2291     * @access  public
2292     */
2293    function getDatabase()
2294    {
2295        return $this->database_name;
2296    }
2297
2298    // }}}
2299    // {{{ function setDSN($dsn)
2300
2301    /**
2302     * set the DSN
2303     *
2304     * @param   mixed   DSN string or array
2305     *
2306     * @return  MDB2_OK
2307     *
2308     * @access  public
2309     */
2310    function setDSN($dsn)
2311    {
2312        $dsn_default = $GLOBALS['_MDB2_dsninfo_default'];
2313        $dsn = MDB2::parseDSN($dsn);
2314        if (array_key_exists('database', $dsn)) {
2315            $this->database_name = $dsn['database'];
2316            unset($dsn['database']);
2317        }
2318        $this->dsn = array_merge($dsn_default, $dsn);
2319        return $this->disconnect(false);
2320    }
2321
2322    // }}}
2323    // {{{ function getDSN($type = 'string', $hidepw = false)
2324
2325    /**
2326     * return the DSN as a string
2327     *
2328     * @param   string  format to return ("array", "string")
2329     * @param   string  string to hide the password with
2330     *
2331     * @return  mixed   DSN in the chosen type
2332     *
2333     * @access  public
2334     */
2335    function getDSN($type = 'string', $hidepw = false)
2336    {
2337        $dsn = array_merge($GLOBALS['_MDB2_dsninfo_default'], $this->dsn);
2338        $dsn['phptype'] = $this->phptype;
2339        $dsn['database'] = $this->database_name;
2340        if ($hidepw) {
2341            $dsn['password'] = $hidepw;
2342        }
2343        switch ($type) {
2344        // expand to include all possible options
2345        case 'string':
2346           $dsn = $dsn['phptype'].
2347               ($dsn['dbsyntax'] ? ('('.$dsn['dbsyntax'].')') : '').
2348               '://'.$dsn['username'].':'.
2349                $dsn['password'].'@'.$dsn['hostspec'].
2350                ($dsn['port'] ? (':'.$dsn['port']) : '').
2351                '/'.$dsn['database'];
2352            break;
2353        case 'array':
2354        default:
2355            break;
2356        }
2357        return $dsn;
2358    }
2359
2360    // }}}
2361    // {{{ function &standaloneQuery($query, $types = null, $is_manip = false)
2362
2363   /**
2364     * execute a query as database administrator
2365     *
2366     * @param   string  the SQL query
2367     * @param   mixed   array that contains the types of the columns in
2368     *                        the result set
2369     * @param   bool    if the query is a manipulation query
2370     *
2371     * @return  mixed   MDB2_OK on success, a MDB2 error on failure
2372     *
2373     * @access  public
2374     */
2375    function &standaloneQuery($query, $types = null, $is_manip = false)
2376    {
2377        $offset = $this->offset;
2378        $limit = $this->limit;
2379        $this->offset = $this->limit = 0;
2380        $query = $this->_modifyQuery($query, $is_manip, $limit, $offset);
2381
2382        $connection = $this->getConnection();
2383        if (PEAR::isError($connection)) {
2384            return $connection;
2385        }
2386
2387        $result =& $this->_doQuery($query, $is_manip, $connection, false);
2388        if (PEAR::isError($result)) {
2389            return $result;
2390        }
2391
2392        if ($is_manip) {
2393            $affected_rows =  $this->_affectedRows($connection, $result);
2394            return $affected_rows;
2395        }
2396        $result =& $this->_wrapResult($result, $types, true, false, $limit, $offset);
2397        return $result;
2398    }
2399
2400    // }}}
2401    // {{{ function _modifyQuery($query, $is_manip, $limit, $offset)
2402
2403    /**
2404     * Changes a query string for various DBMS specific reasons
2405     *
2406     * @param   string  query to modify
2407     * @param   bool    if it is a DML query
2408     * @param   int  limit the number of rows
2409     * @param   int  start reading from given offset
2410     *
2411     * @return  string  modified query
2412     *
2413     * @access  protected
2414     */
2415    function _modifyQuery($query, $is_manip, $limit, $offset)
2416    {
2417        return $query;
2418    }
2419
2420    // }}}
2421    // {{{ function &_doQuery($query, $is_manip = false, $connection = null, $database_name = null)
2422
2423    /**
2424     * Execute a query
2425     * @param   string  query
2426     * @param   bool    if the query is a manipulation query
2427     * @param   resource connection handle
2428     * @param   string  database name
2429     *
2430     * @return  result or error object
2431     *
2432     * @access  protected
2433     */
2434    function &_doQuery($query, $is_manip = false, $connection = null, $database_name = null)
2435    {
2436        $this->last_query = $query;
2437        $result = $this->debug($query, 'query', array('is_manip' => $is_manip, 'when' => 'pre'));
2438        if ($result) {
2439            if (PEAR::isError($result)) {
2440                return $result;
2441            }
2442            $query = $result;
2443        }
2444        $err =& $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
2445            'method not implemented', __FUNCTION__);
2446        return $err;
2447    }
2448
2449    // }}}
2450    // {{{ function _affectedRows($connection, $result = null)
2451
2452    /**
2453     * Returns the number of rows affected
2454     *
2455     * @param   resource result handle
2456     * @param   resource connection handle
2457     *
2458     * @return  mixed   MDB2 Error Object or the number of rows affected
2459     *
2460     * @access  private
2461     */
2462    function _affectedRows($connection, $result = null)
2463    {
2464        return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
2465            'method not implemented', __FUNCTION__);
2466    }
2467
2468    // }}}
2469    // {{{ function &exec($query)
2470
2471    /**
2472     * Execute a manipulation query to the database and return the number of affected rows
2473     *
2474     * @param   string  the SQL query
2475     *
2476     * @return  mixed   number of affected rows on success, a MDB2 error on failure
2477     *
2478     * @access  public
2479     */
2480    function &exec($query)
2481    {
2482        $offset = $this->offset;
2483        $limit = $this->limit;
2484        $this->offset = $this->limit = 0;
2485        $query = $this->_modifyQuery($query, true, $limit, $offset);
2486
2487        $connection = $this->getConnection();
2488        if (PEAR::isError($connection)) {
2489            return $connection;
2490        }
2491
2492        $result =& $this->_doQuery($query, true, $connection, $this->database_name);
2493        if (PEAR::isError($result)) {
2494            return $result;
2495        }
2496
2497        $affectedRows = $this->_affectedRows($connection, $result);
2498        return $affectedRows;
2499    }
2500
2501    // }}}
2502    // {{{ function &query($query, $types = null, $result_class = true, $result_wrap_class = false)
2503
2504    /**
2505     * Send a query to the database and return any results
2506     *
2507     * @param   string  the SQL query
2508     * @param   mixed   array that contains the types of the columns in
2509     *                        the result set
2510     * @param   mixed   string which specifies which result class to use
2511     * @param   mixed   string which specifies which class to wrap results in
2512     *
2513     * @return mixed   an MDB2_Result handle on success, a MDB2 error on failure
2514     *
2515     * @access  public
2516     */
2517    function &query($query, $types = null, $result_class = true, $result_wrap_class = false)
2518    {
2519        $offset = $this->offset;
2520        $limit = $this->limit;
2521        $this->offset = $this->limit = 0;
2522        $query = $this->_modifyQuery($query, false, $limit, $offset);
2523
2524        $connection = $this->getConnection();
2525        if (PEAR::isError($connection)) {
2526            return $connection;
2527        }
2528
2529        $result =& $this->_doQuery($query, false, $connection, $this->database_name);
2530        if (PEAR::isError($result)) {
2531            return $result;
2532        }
2533
2534        $result =& $this->_wrapResult($result, $types, $result_class, $result_wrap_class, $limit, $offset);
2535        return $result;
2536    }
2537
2538    // }}}
2539    // {{{ function &_wrapResult($result, $types = array(), $result_class = true, $result_wrap_class = false, $limit = null, $offset = null)
2540
2541    /**
2542     * wrap a result set into the correct class
2543     *
2544     * @param   resource result handle
2545     * @param   mixed   array that contains the types of the columns in
2546     *                        the result set
2547     * @param   mixed   string which specifies which result class to use
2548     * @param   mixed   string which specifies which class to wrap results in
2549     * @param   string  number of rows to select
2550     * @param   string  first row to select
2551     *
2552     * @return mixed   an MDB2_Result, a MDB2 error on failure
2553     *
2554     * @access  protected
2555     */
2556    function &_wrapResult($result, $types = array(), $result_class = true,
2557        $result_wrap_class = false, $limit = null, $offset = null)
2558    {
2559        if ($types === true) {
2560            if ($this->supports('result_introspection')) {
2561                $this->loadModule('Reverse', null, true);
2562                $tableInfo = $this->reverse->tableInfo($result);
2563                if (PEAR::isError($tableInfo)) {
2564                    return $tableInfo;
2565                }
2566                $types = array();
2567                foreach ($tableInfo as $field) {
2568                    $types[] = $field['mdb2type'];
2569                }
2570            } else {
2571                $types = null;
2572            }
2573        }
2574
2575        if ($result_class === true) {
2576            $result_class = $this->options['result_buffering']
2577                ? $this->options['buffered_result_class'] : $this->options['result_class'];
2578        }
2579
2580        if ($result_class) {
2581            $class_name = sprintf($result_class, $this->phptype);
2582            if (!MDB2::classExists($class_name)) {
2583                $err =& $this->raiseError(MDB2_ERROR_NOT_FOUND, null, null,
2584                    'result class does not exist '.$class_name, __FUNCTION__);
2585                return $err;
2586            }
2587            $result =& new $class_name($this, $result, $limit, $offset);
2588            if (!MDB2::isResultCommon($result)) {
2589                $err =& $this->raiseError(MDB2_ERROR_NOT_FOUND, null, null,
2590                    'result class is not extended from MDB2_Result_Common', __FUNCTION__);
2591                return $err;
2592            }
2593            if (!empty($types)) {
2594                $err = $result->setResultTypes($types);
2595                if (PEAR::isError($err)) {
2596                    $result->free();
2597                    return $err;
2598                }
2599            }
2600        }
2601        if ($result_wrap_class === true) {
2602            $result_wrap_class = $this->options['result_wrap_class'];
2603        }
2604        if ($result_wrap_class) {
2605            if (!MDB2::classExists($result_wrap_class)) {
2606                $err =& $this->raiseError(MDB2_ERROR_NOT_FOUND, null, null,
2607                    'result wrap class does not exist '.$result_wrap_class, __FUNCTION__);
2608                return $err;
2609            }
2610            $result =& new $result_wrap_class($result, $this->fetchmode);
2611        }
2612        return $result;
2613    }
2614
2615    // }}}
2616    // {{{ function getServerVersion($native = false)
2617
2618    /**
2619     * return version information about the server
2620     *
2621     * @param   bool    determines if the raw version string should be returned
2622     *
2623     * @return  mixed   array with version information or row string
2624     *
2625     * @access  public
2626     */
2627    function getServerVersion($native = false)
2628    {
2629        return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
2630            'method not implemented', __FUNCTION__);
2631    }
2632
2633    // }}}
2634    // {{{ function setLimit($limit, $offset = null)
2635
2636    /**
2637     * set the range of the next query
2638     *
2639     * @param   string  number of rows to select
2640     * @param   string  first row to select
2641     *
2642     * @return  mixed   MDB2_OK on success, a MDB2 error on failure
2643     *
2644     * @access  public
2645     */
2646    function setLimit($limit, $offset = null)
2647    {
2648        if (!$this->supports('limit_queries')) {
2649            return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
2650                'limit is not supported by this driver', __FUNCTION__);
2651        }
2652        $limit = (int)$limit;
2653        if ($limit < 0) {
2654            return $this->raiseError(MDB2_ERROR_SYNTAX, null, null,
2655                'it was not specified a valid selected range row limit', __FUNCTION__);
2656        }
2657        $this->limit = $limit;
2658        if (!is_null($offset)) {
2659            $offset = (int)$offset;
2660            if ($offset < 0) {
2661                return $this->raiseError(MDB2_ERROR_SYNTAX, null, null,
2662                    'it was not specified a valid first selected range row', __FUNCTION__);
2663            }
2664            $this->offset = $offset;
2665        }
2666        return MDB2_OK;
2667    }
2668
2669    // }}}
2670    // {{{ function subSelect($query, $type = false)
2671
2672    /**
2673     * simple subselect emulation: leaves the query untouched for all RDBMS
2674     * that support subselects
2675     *
2676     * @param   string  the SQL query for the subselect that may only
2677     *                      return a column
2678     * @param   string  determines type of the field
2679     *
2680     * @return  string  the query
2681     *
2682     * @access  public
2683     */
2684    function subSelect($query, $type = false)
2685    {
2686        if ($this->supports('sub_selects') === true) {
2687            return $query;
2688        }
2689
2690        if (!$this->supports('sub_selects')) {
2691            return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
2692                'method not implemented', __FUNCTION__);
2693        }
2694
2695        $col = $this->queryCol($query, $type);
2696        if (PEAR::isError($col)) {
2697            return $col;
2698        }
2699        if (!is_array($col) || count($col) == 0) {
2700            return 'NULL';
2701        }
2702        if ($type) {
2703            $this->loadModule('Datatype', null, true);
2704            return $this->datatype->implodeArray($col, $type);
2705        }
2706        return implode(', ', $col);
2707    }
2708
2709    // }}}
2710    // {{{ function replace($table, $fields)
2711
2712    /**
2713     * Execute a SQL REPLACE query. A REPLACE query is identical to a INSERT
2714     * query, except that if there is already a row in the table with the same
2715     * key field values, the REPLACE query just updates its values instead of
2716     * inserting a new row.
2717     *
2718     * The REPLACE type of query does not make part of the SQL standards. Since
2719     * practically only MySQL and SQLite implement it natively, this type of
2720     * query isemulated through this method for other DBMS using standard types
2721     * of queries inside a transaction to assure the atomicity of the operation.
2722     *
2723     * @param   string  name of the table on which the REPLACE query will
2724     *       be executed.
2725     * @param   array   associative array   that describes the fields and the
2726     *       values that will be inserted or updated in the specified table. The
2727     *       indexes of the array are the names of all the fields of the table.
2728     *       The values of the array are also associative arrays that describe
2729     *       the values and other properties of the table fields.
2730     *
2731     *       Here follows a list of field properties that need to be specified:
2732     *
2733     *       value
2734     *           Value to be assigned to the specified field. This value may be
2735     *           of specified in database independent type format as this
2736     *           function can perform the necessary datatype conversions.
2737     *
2738     *           Default: this property is required unless the Null property is
2739     *           set to 1.
2740     *
2741     *       type
2742     *           Name of the type of the field. Currently, all types MDB2
2743     *           are supported except for clob and blob.
2744     *
2745     *           Default: no type conversion
2746     *
2747     *       null
2748     *           bool    property that indicates that the value for this field
2749     *           should be set to null.
2750     *
2751     *           The default value for fields missing in INSERT queries may be
2752     *           specified the definition of a table. Often, the default value
2753     *           is already null, but since the REPLACE may be emulated using
2754     *           an UPDATE query, make sure that all fields of the table are
2755     *           listed in this function argument array.
2756     *
2757     *           Default: 0
2758     *
2759     *       key
2760     *           bool    property that indicates that this field should be
2761     *           handled as a primary key or at least as part of the compound
2762     *           unique index of the table that will determine the row that will
2763     *           updated if it exists or inserted a new row otherwise.
2764     *
2765     *           This function will fail if no key field is specified or if the
2766     *           value of a key field is set to null because fields that are
2767     *           part of unique index they may not be null.
2768     *
2769     *           Default: 0
2770     *
2771     * @return  mixed   MDB2_OK on success, a MDB2 error on failure
2772     *
2773     * @access  public
2774     */
2775    function replace($table, $fields)
2776    {
2777        if (!$this->supports('replace')) {
2778            return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
2779                'replace query is not supported', __FUNCTION__);
2780        }
2781        $count = count($fields);
2782        $condition = $values = array();
2783        for ($colnum = 0, reset($fields); $colnum < $count; next($fields), $colnum++) {
2784            $name = key($fields);
2785            if (isset($fields[$name]['null']) && $fields[$name]['null']) {
2786                $value = 'NULL';
2787            } else {
2788                $type = isset($fields[$name]['type']) ? $fields[$name]['type'] : null;
2789                $value = $this->quote($fields[$name]['value'], $type);
2790            }
2791            $values[$name] = $value;
2792            if (isset($fields[$name]['key']) && $fields[$name]['key']) {
2793                if ($value === 'NULL') {
2794                    return $this->raiseError(MDB2_ERROR_CANNOT_REPLACE, null, null,
2795                        'key value '.$name.' may not be NULL', __FUNCTION__);
2796                }
2797                $condition[] = $name . '=' . $value;
2798            }
2799        }
2800        if (empty($condition)) {
2801            return $this->raiseError(MDB2_ERROR_CANNOT_REPLACE, null, null,
2802                'not specified which fields are keys', __FUNCTION__);
2803        }
2804
2805        $result = null;
2806        $in_transaction = $this->in_transaction;
2807        if (!$in_transaction && PEAR::isError($result = $this->beginTransaction())) {
2808            return $result;
2809        }
2810
2811        $connection = $this->getConnection();
2812        if (PEAR::isError($connection)) {
2813            return $connection;
2814        }
2815
2816        $condition = ' WHERE '.implode(' AND ', $condition);
2817        $query = "DELETE FROM $table$condition";
2818        $result =& $this->_doQuery($query, true, $connection);
2819        if (!PEAR::isError($result)) {
2820            $affected_rows = $this->_affectedRows($connection, $result);
2821            $insert = implode(', ', array_keys($values));
2822            $values = implode(', ', $values);
2823            $query = "INSERT INTO $table ($insert) VALUES ($values)";
2824            $result =& $this->_doQuery($query, true, $connection);
2825            if (!PEAR::isError($result)) {
2826                $affected_rows += $this->_affectedRows($connection, $result);;
2827            }
2828        }
2829
2830        if (!$in_transaction) {
2831            if (PEAR::isError($result)) {
2832                $this->rollback();
2833            } else {
2834                $result = $this->commit();
2835            }
2836        }
2837
2838        if (PEAR::isError($result)) {
2839            return $result;
2840        }
2841
2842        return $affected_rows;
2843    }
2844
2845    // }}}
2846    // {{{ function &prepare($query, $types = null, $result_types = null, $lobs = array())
2847
2848    /**
2849     * Prepares a query for multiple execution with execute().
2850     * With some database backends, this is emulated.
2851     * prepare() requires a generic query as string like
2852     * 'INSERT INTO numbers VALUES(?,?)' or
2853     * 'INSERT INTO numbers VALUES(:foo,:bar)'.
2854     * The ? and :[a-zA-Z] and  are placeholders which can be set using
2855     * bindParam() and the query can be send off using the execute() method.
2856     *
2857     * @param   string  the query to prepare
2858     * @param   mixed   array that contains the types of the placeholders
2859     * @param   mixed   array that contains the types of the columns in
2860     *                        the result set or MDB2_PREPARE_RESULT, if set to
2861     *                        MDB2_PREPARE_MANIP the query is handled as a manipulation query
2862     * @param   mixed   key (field) value (parameter) pair for all lob placeholders
2863     *
2864     * @return  mixed   resource handle for the prepared query on success,
2865     *                  a MDB2 error on failure
2866     *
2867     * @access  public
2868     * @see     bindParam, execute
2869     */
2870    function &prepare($query, $types = null, $result_types = null, $lobs = array())
2871    {
2872        $is_manip = ($result_types === MDB2_PREPARE_MANIP);
2873        $offset = $this->offset;
2874        $limit = $this->limit;
2875        $this->offset = $this->limit = 0;
2876        $result = $this->debug($query, __FUNCTION__, array('is_manip' => $is_manip, 'when' => 'pre'));
2877        if ($result) {
2878            if (PEAR::isError($result)) {
2879                return $result;
2880            }
2881            $query = $result;
2882        }
2883        $placeholder_type_guess = $placeholder_type = null;
2884        $question = '?';
2885        $colon = ':';
2886        $positions = array();
2887        $position = 0;
2888        $ignores = $this->sql_comments;
2889        $ignores[] = $this->string_quoting;
2890        $ignores[] = $this->identifier_quoting;
2891        while ($position < strlen($query)) {
2892            $q_position = strpos($query, $question, $position);
2893            $c_position = strpos($query, $colon, $position);
2894            if ($q_position && $c_position) {
2895                $p_position = min($q_position, $c_position);
2896            } elseif ($q_position) {
2897                $p_position = $q_position;
2898            } elseif ($c_position) {
2899                $p_position = $c_position;
2900            } else {
2901                break;
2902            }
2903            if (is_null($placeholder_type)) {
2904                $placeholder_type_guess = $query[$p_position];
2905            }
2906
2907            $new_pos = $this->_skipDelimitedStrings($query, $position, $p_position);
2908            if (PEAR::isError($new_pos)) {
2909                return $new_pos;
2910            }
2911            if ($new_pos != $position) {
2912                $position = $new_pos;
2913                continue; //evaluate again starting from the new position
2914            }
2915
2916            if ($query[$position] == $placeholder_type_guess) {
2917                if (is_null($placeholder_type)) {
2918                    $placeholder_type = $query[$p_position];
2919                    $question = $colon = $placeholder_type;
2920                    if (!empty($types) && is_array($types)) {
2921                        if ($placeholder_type == ':') {
2922                            if (is_int(key($types))) {
2923                                $types_tmp = $types;
2924                                $types = array();
2925                                $count = -1;
2926                            }
2927                        } else {
2928                            $types = array_values($types);
2929                        }
2930                    }
2931                }
2932                if ($placeholder_type == ':') {
2933                    $parameter = preg_replace('/^.{'.($position+1).'}([a-z0-9_]+).*$/si', '\\1', $query);
2934                    if ($parameter === '') {
2935                        $err =& $this->raiseError(MDB2_ERROR_SYNTAX, null, null,
2936                            'named parameter with an empty name', __FUNCTION__);
2937                        return $err;
2938                    }
2939                    $positions[$p_position] = $parameter;
2940                    $query = substr_replace($query, '?', $position, strlen($parameter)+1);
2941                    // use parameter name in type array
2942                    if (isset($count) && isset($types_tmp[++$count])) {
2943                        $types[$parameter] = $types_tmp[$count];
2944                    }
2945                } else {
2946                    $positions[$p_position] = count($positions);
2947                }
2948                $position = $p_position + 1;
2949            } else {
2950                $position = $p_position;
2951            }
2952        }
2953        $class_name = 'MDB2_Statement_'.$this->phptype;
2954        $statement = null;
2955        $obj =& new $class_name($this, $statement, $positions, $query, $types, $result_types, $is_manip, $limit, $offset);
2956        $this->debug($query, __FUNCTION__, array('is_manip' => $is_manip, 'when' => 'post', 'result' => $obj));
2957        return $obj;
2958    }
2959
2960    // }}}
2961    // {{{ function _skipDelimitedStrings($query, $position, $p_position)
2962   
2963    /**
2964     * Utility method, used by prepare() to avoid replacing placeholders within delimited strings.
2965     * Check if the placeholder is contained within a delimited string.
2966     * If so, skip it and advance the position, otherwise return the current position,
2967     * which is valid
2968     *
2969     * @param string $query
2970     * @param integer $position current string cursor position
2971     * @param integer $p_position placeholder position
2972     *
2973     * @return mixed integer $new_position on success
2974     *               MDB2_Error on failure
2975     *
2976     * @access  protected
2977     */
2978    function _skipDelimitedStrings($query, $position, $p_position)
2979    {
2980        $ignores = $this->sql_comments;
2981        $ignores[] = $this->string_quoting;
2982        $ignores[] = $this->identifier_quoting;
2983       
2984        foreach ($ignores as $ignore) {
2985            if (!empty($ignore['start'])) {
2986                if (is_int($start_quote = strpos($query, $ignore['start'], $position)) && $start_quote < $p_position) {
2987                    $end_quote = $start_quote;
2988                    do {
2989                        if (!is_int($end_quote = strpos($query, $ignore['end'], $end_quote + 1))) {
2990                            if ($ignore['end'] === "\n") {
2991                                $end_quote = strlen($query) - 1;
2992                            } else {
2993                                $err =& $this->raiseError(MDB2_ERROR_SYNTAX, null, null,
2994                                    'query with an unterminated text string specified', __FUNCTION__);
2995                                return $err;
2996                            }
2997                        }
2998                    } while ($ignore['escape'] && $query[($end_quote - 1)] == $ignore['escape']);
2999                    $position = $end_quote + 1;
3000                    return $position;
3001                }
3002            }
3003        }
3004        return $position;
3005    }
3006   
3007    // }}}
3008    // {{{ function quote($value, $type = null, $quote = true)
3009
3010    /**
3011     * Convert a text value into a DBMS specific format that is suitable to
3012     * compose query statements.
3013     *
3014     * @param   string  text string value that is intended to be converted.
3015     * @param   string  type to which the value should be converted to
3016     * @param   bool    quote
3017     * @param   bool    escape wildcards
3018     *
3019     * @return  string  text string that represents the given argument value in
3020     *       a DBMS specific format.
3021     *
3022     * @access  public
3023     */
3024    function quote($value, $type = null, $quote = true, $escape_wildcards = false)
3025    {
3026        $result = $this->loadModule('Datatype', null, true);
3027        if (PEAR::isError($result)) {
3028            return $result;
3029        }
3030
3031        return $this->datatype->quote($value, $type, $quote, $escape_wildcards);
3032    }
3033
3034    // }}}
3035    // {{{ function getDeclaration($type, $name, $field)
3036
3037    /**
3038     * Obtain DBMS specific SQL code portion needed to declare
3039     * of the given type
3040     *
3041     * @param   string  type to which the value should be converted to
3042     * @param   string  name the field to be declared.
3043     * @param   string  definition of the field
3044     *
3045     * @return  string  DBMS specific SQL code portion that should be used to
3046     *                 declare the specified field.
3047     *
3048     * @access  public
3049     */
3050    function getDeclaration($type, $name, $field)
3051    {
3052        $result = $this->loadModule('Datatype', null, true);
3053        if (PEAR::isError($result)) {
3054            return $result;
3055        }
3056        return $this->datatype->getDeclaration($type, $name, $field);
3057    }
3058
3059    // }}}
3060    // {{{ function compareDefinition($current, $previous)
3061
3062    /**
3063     * Obtain an array of changes that may need to applied
3064     *
3065     * @param   array   new definition
3066     * @param   array   old definition
3067     *
3068     * @return  array   containing all changes that will need to be applied
3069     *
3070     * @access  public
3071     */
3072    function compareDefinition($current, $previous)
3073    {
3074        $result = $this->loadModule('Datatype', null, true);
3075        if (PEAR::isError($result)) {
3076            return $result;
3077        }
3078        return $this->datatype->compareDefinition($current, $previous);
3079    }
3080
3081    // }}}
3082    // {{{ function supports($feature)
3083
3084    /**
3085     * Tell whether a DB implementation or its backend extension
3086     * supports a given feature.
3087     *
3088     * @param   string  name of the feature (see the MDB2 class doc)
3089     *
3090     * @return  bool|string if this DB implementation supports a given feature
3091     *                      false means no, true means native,
3092     *                      'emulated' means emulated
3093     *
3094     * @access  public
3095     */
3096    function supports($feature)
3097    {
3098        if (array_key_exists($feature, $this->supported)) {
3099            return $this->supported[$feature];
3100        }
3101        return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
3102            "unknown support feature $feature", __FUNCTION__);
3103    }
3104
3105    // }}}
3106    // {{{ function getSequenceName($sqn)
3107
3108    /**
3109     * adds sequence name formatting to a sequence name
3110     *
3111     * @param   string  name of the sequence
3112     *
3113     * @return  string  formatted sequence name
3114     *
3115     * @access  public
3116     */
3117    function getSequenceName($sqn)
3118    {
3119        return sprintf($this->options['seqname_format'],
3120            preg_replace('/[^a-z0-9_\$.]/i', '_', $sqn));
3121    }
3122
3123    // }}}
3124    // {{{ function getIndexName($idx)
3125
3126    /**
3127     * adds index name formatting to a index name
3128     *
3129     * @param   string  name of the index
3130     *
3131     * @return  string  formatted index name
3132     *
3133     * @access  public
3134     */
3135    function getIndexName($idx)
3136    {
3137        return sprintf($this->options['idxname_format'],
3138            preg_replace('/[^a-z0-9_\$]/i', '_', $idx));
3139    }
3140
3141    // }}}
3142    // {{{ function nextID($seq_name, $ondemand = true)
3143
3144    /**
3145     * Returns the next free id of a sequence
3146     *
3147     * @param   string  name of the sequence
3148     * @param   bool    when true missing sequences are automatic created
3149     *
3150     * @return  mixed   MDB2 Error Object or id
3151     *
3152     * @access  public
3153     */
3154    function nextID($seq_name, $ondemand = true)
3155    {
3156        return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
3157            'method not implemented', __FUNCTION__);
3158    }
3159
3160    // }}}
3161    // {{{ function lastInsertID($table = null, $field = null)
3162
3163    /**
3164     * Returns the autoincrement ID if supported or $id or fetches the current
3165     * ID in a sequence called: $table.(empty($field) ? '' : '_'.$field)
3166     *
3167     * @param   string  name of the table into which a new row was inserted
3168     * @param   string  name of the field into which a new row was inserted
3169     *
3170     * @return  mixed   MDB2 Error Object or id
3171     *
3172     * @access  public
3173     */
3174    function lastInsertID($table = null, $field = null)
3175    {
3176        return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
3177            'method not implemented', __FUNCTION__);
3178    }
3179
3180    // }}}
3181    // {{{ function currID($seq_name)
3182
3183    /**
3184     * Returns the current id of a sequence
3185     *
3186     * @param   string  name of the sequence
3187     *
3188     * @return  mixed   MDB2 Error Object or id
3189     *
3190     * @access  public
3191     */
3192    function currID($seq_name)
3193    {
3194        $this->warnings[] = 'database does not support getting current
3195            sequence value, the sequence value was incremented';
3196        return $this->nextID($seq_name);
3197    }
3198
3199    // }}}
3200    // {{{ function queryOne($query, $type = null, $colnum = 0)
3201
3202    /**
3203     * Execute the specified query, fetch the value from the first column of
3204     * the first row of the result set and then frees
3205     * the result set.
3206     *
3207     * @param   string  the SELECT query statement to be executed.
3208     * @param   string  optional argument that specifies the expected
3209     *       datatype of the result set field, so that an eventual conversion
3210     *       may be performed. The default datatype is text, meaning that no
3211     *       conversion is performed
3212     * @param   int     the column number to fetch
3213     *
3214     * @return  mixed   MDB2_OK or field value on success, a MDB2 error on failure
3215     *
3216     * @access  public
3217     */
3218    function queryOne($query, $type = null, $colnum = 0)
3219    {
3220        $result = $this->query($query, $type);
3221        if (!MDB2::isResultCommon($result)) {
3222            return $result;
3223        }
3224
3225        $one = $result->fetchOne($colnum);
3226        $result->free();
3227        return $one;
3228    }
3229
3230    // }}}
3231    // {{{ function queryRow($query, $types = null, $fetchmode = MDB2_FETCHMODE_DEFAULT)
3232
3233    /**
3234     * Execute the specified query, fetch the values from the first
3235     * row of the result set into an array and then frees
3236     * the result set.
3237     *
3238     * @param   string  the SELECT query statement to be executed.
3239     * @param   array   optional array argument that specifies a list of
3240     *       expected datatypes of the result set columns, so that the eventual
3241     *       conversions may be performed. The default list of datatypes is
3242     *       empty, meaning that no conversion is performed.
3243     * @param   int     how the array data should be indexed
3244     *
3245     * @return  mixed   MDB2_OK or data array on success, a MDB2 error on failure
3246     *
3247     * @access  public
3248     */
3249    function queryRow($query, $types = null, $fetchmode = MDB2_FETCHMODE_DEFAULT)
3250    {
3251        $result = $this->query($query, $types);
3252        if (!MDB2::isResultCommon($result)) {
3253            return $result;
3254        }
3255
3256        $row = $result->fetchRow($fetchmode);
3257        $result->free();
3258        return $row;
3259    }
3260
3261    // }}}
3262    // {{{ function queryCol($query, $type = null, $colnum = 0)
3263
3264    /**
3265     * Execute the specified query, fetch the value from the first column of
3266     * each row of the result set into an array and then frees the result set.
3267     *
3268     * @param   string  the SELECT query statement to be executed.
3269     * @param   string  optional argument that specifies the expected
3270     *       datatype of the result set field, so that an eventual conversion
3271     *       may be performed. The default datatype is text, meaning that no
3272     *       conversion is performed
3273     * @param   int     the row number to fetch
3274     *
3275     * @return  mixed   MDB2_OK or data array on success, a MDB2 error on failure
3276     *
3277     * @access  public
3278     */
3279    function queryCol($query, $type = null, $colnum = 0)
3280    {
3281        $result = $this->query($query, $type);
3282        if (!MDB2::isResultCommon($result)) {
3283            return $result;
3284        }
3285
3286        $col = $result->fetchCol($colnum);
3287        $result->free();
3288        return $col;
3289    }
3290
3291    // }}}
3292    // {{{ function queryAll($query, $types = null, $fetchmode = MDB2_FETCHMODE_DEFAULT, $rekey = false, $force_array = false, $group = false)
3293
3294    /**
3295     * Execute the specified query, fetch all the rows of the result set into
3296     * a two dimensional array and then frees the result set.
3297     *
3298     * @param   string  the SELECT query statement to be executed.
3299     * @param   array   optional array argument that specifies a list of
3300     *       expected datatypes of the result set columns, so that the eventual
3301     *       conversions may be performed. The default list of datatypes is
3302     *       empty, meaning that no conversion is performed.
3303     * @param   int     how the array data should be indexed
3304     * @param   bool    if set to true, the $all will have the first
3305     *       column as its first dimension
3306     * @param   bool    used only when the query returns exactly
3307     *       two columns. If true, the values of the returned array will be
3308     *       one-element arrays instead of scalars.
3309     * @param   bool    if true, the values of the returned array is
3310     *       wrapped in another array.  If the same key value (in the first
3311     *       column) repeats itself, the values will be appended to this array
3312     *       instead of overwriting the existing values.
3313     *
3314     * @return  mixed   MDB2_OK or data array on success, a MDB2 error on failure
3315     *
3316     * @access  public
3317     */
3318    function queryAll($query, $types = null, $fetchmode = MDB2_FETCHMODE_DEFAULT,
3319        $rekey = false, $force_array = false, $group = false)
3320    {
3321        $result = $this->query($query, $types);
3322        if (!MDB2::isResultCommon($result)) {
3323            return $result;
3324        }
3325
3326        $all = $result->fetchAll($fetchmode, $rekey, $force_array, $group);
3327        $result->free();
3328        return $all;
3329    }
3330
3331    // }}}
3332}
3333
3334// }}}
3335// {{{ class MDB2_Result
3336
3337/**
3338 * The dummy class that all user space result classes should extend from
3339 *
3340 * @package     MDB2
3341 * @category    Database
3342 * @author      Lukas Smith <smith@pooteeweet.org>
3343 */
3344class MDB2_Result
3345{
3346}
3347
3348// }}}
3349// {{{ class MDB2_Result_Common extends MDB2_Result
3350
3351/**
3352 * The common result class for MDB2 result objects
3353 *
3354 * @package     MDB2
3355 * @category    Database
3356 * @author      Lukas Smith <smith@pooteeweet.org>
3357 */
3358class MDB2_Result_Common extends MDB2_Result
3359{
3360    // {{{ Variables (Properties)
3361
3362    var $db;
3363    var $result;
3364    var $rownum = -1;
3365    var $types = array();
3366    var $values = array();
3367    var $offset;
3368    var $offset_count = 0;
3369    var $limit;
3370    var $column_names;
3371
3372    // }}}
3373    // {{{ constructor: function __construct(&$db, &$result, $limit = 0, $offset = 0)
3374
3375    /**
3376     * Constructor
3377     */
3378    function __construct(&$db, &$result, $limit = 0, $offset = 0)
3379    {
3380        $this->db =& $db;
3381        $this->result =& $result;
3382        $this->offset = $offset;
3383        $this->limit = max(0, $limit - 1);
3384    }
3385
3386    // }}}
3387    // {{{ function MDB2_Result_Common(&$db, &$result, $limit = 0, $offset = 0)
3388
3389    /**
3390     * PHP 4 Constructor
3391     */
3392    function MDB2_Result_Common(&$db, &$result, $limit = 0, $offset = 0)
3393    {
3394        $this->__construct($db, $result, $limit, $offset);
3395    }
3396
3397    // }}}
3398    // {{{ function setResultTypes($types)
3399
3400    /**
3401     * Define the list of types to be associated with the columns of a given
3402     * result set.
3403     *
3404     * This function may be called before invoking fetchRow(), fetchOne(),
3405     * fetchCol() and fetchAll() so that the necessary data type
3406     * conversions are performed on the data to be retrieved by them. If this
3407     * function is not called, the type of all result set columns is assumed
3408     * to be text, thus leading to not perform any conversions.
3409     *
3410     * @param   array   variable that lists the
3411     *       data types to be expected in the result set columns. If this array
3412     *       contains less types than the number of columns that are returned
3413     *       in the result set, the remaining columns are assumed to be of the
3414     *       type text. Currently, the types clob and blob are not fully
3415     *       supported.
3416     *
3417     * @return  mixed   MDB2_OK on success, a MDB2 error on failure
3418     *
3419     * @access  public
3420     */
3421    function setResultTypes($types)
3422    {
3423        $load = $this->db->loadModule('Datatype', null, true);
3424        if (PEAR::isError($load)) {
3425            return $load;
3426        }
3427        $types = $this->db->datatype->checkResultTypes($types);
3428        if (PEAR::isError($types)) {
3429            return $types;
3430        }
3431        $this->types = $types;
3432        return MDB2_OK;
3433    }
3434
3435    // }}}
3436    // {{{ function seek($rownum = 0)
3437
3438    /**
3439     * Seek to a specific row in a result set
3440     *
3441     * @param   int     number of the row where the data can be found
3442     *
3443     * @return  mixed   MDB2_OK on success, a MDB2 error on failure
3444     *
3445     * @access  public
3446     */
3447    function seek($rownum = 0)
3448    {
3449        $target_rownum = $rownum - 1;
3450        if ($this->rownum > $target_rownum) {
3451            return $this->db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
3452                'seeking to previous rows not implemented', __FUNCTION__);
3453        }
3454        while ($this->rownum < $target_rownum) {
3455            $this->fetchRow();
3456        }
3457        return MDB2_OK;
3458    }
3459
3460    // }}}
3461    // {{{ function &fetchRow($fetchmode = MDB2_FETCHMODE_DEFAULT, $rownum = null)
3462
3463    /**
3464     * Fetch and return a row of data
3465     *
3466     * @param   int     how the array data should be indexed
3467     * @param   int     number of the row where the data can be found
3468     *
3469     * @return  int     data array on success, a MDB2 error on failure
3470     *
3471     * @access  public
3472     */
3473    function &fetchRow($fetchmode = MDB2_FETCHMODE_DEFAULT, $rownum = null)
3474    {
3475        $err =& $this->db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
3476            'method not implemented', __FUNCTION__);
3477        return $err;
3478    }
3479
3480    // }}}
3481    // {{{ function fetchOne($colnum = 0)
3482
3483    /**
3484     * fetch single column from the next row from a result set
3485     *
3486     * @param   int     the column number to fetch
3487     * @param   int     number of the row where the data can be found
3488     *
3489     * @return  string  data on success, a MDB2 error on failure
3490     *
3491     * @access  public
3492     */
3493    function fetchOne($colnum = 0, $rownum = null)
3494    {
3495        $fetchmode = is_numeric($colnum) ? MDB2_FETCHMODE_ORDERED : MDB2_FETCHMODE_ASSOC;
3496        $row = $this->fetchRow($fetchmode, $rownum);
3497        if (!is_array($row) || PEAR::isError($row)) {
3498            return $row;
3499        }
3500        if (!array_key_exists($colnum, $row)) {
3501            return $this->db->raiseError(MDB2_ERROR_TRUNCATED, null, null,
3502                'column is not defined in the result set: '.$colnum, __FUNCTION__);
3503        }
3504        return $row[$colnum];
3505    }
3506
3507    // }}}
3508    // {{{ function fetchCol($colnum = 0)
3509
3510    /**
3511     * Fetch and return a column from the current row pointer position
3512     *
3513     * @param   int     the column number to fetch
3514     *
3515     * @return  mixed   data array on success, a MDB2 error on failure
3516     *
3517     * @access  public
3518     */
3519    function fetchCol($colnum = 0)
3520    {
3521        $column = array();
3522        $fetchmode = is_numeric($colnum) ? MDB2_FETCHMODE_ORDERED : MDB2_FETCHMODE_ASSOC;
3523        $row = $this->fetchRow($fetchmode);
3524        if (is_array($row)) {
3525            if (!array_key_exists($colnum, $row)) {
3526                return $this->db->raiseError(MDB2_ERROR_TRUNCATED, null, null,
3527                    'column is not defined in the result set: '.$colnum, __FUNCTION__);
3528            }
3529            do {
3530                $column[] = $row[$colnum];
3531            } while (is_array($row = $this->fetchRow($fetchmode)));
3532        }
3533        if (PEAR::isError($row)) {
3534            return $row;
3535        }
3536        return $column;
3537    }
3538
3539    // }}}
3540    // {{{ function fetchAll($fetchmode = MDB2_FETCHMODE_DEFAULT, $rekey = false, $force_array = false, $group = false)
3541
3542    /**
3543     * Fetch and return all rows from the current row pointer position
3544     *
3545     * @param   int     $fetchmode  the fetch mode to use:
3546     *                            + MDB2_FETCHMODE_ORDERED
3547     *                            + MDB2_FETCHMODE_ASSOC
3548     *                            + MDB2_FETCHMODE_ORDERED | MDB2_FETCHMODE_FLIPPED
3549     *                            + MDB2_FETCHMODE_ASSOC | MDB2_FETCHMODE_FLIPPED
3550     * @param   bool    if set to true, the $all will have the first
3551     *       column as its first dimension
3552     * @param   bool    used only when the query returns exactly
3553     *       two columns. If true, the values of the returned array will be
3554     *       one-element arrays instead of scalars.
3555     * @param   bool    if true, the values of the returned array is
3556     *       wrapped in another array.  If the same key value (in the first
3557     *       column) repeats itself, the values will be appended to this array
3558     *       instead of overwriting the existing values.
3559     *
3560     * @return  mixed   data array on success, a MDB2 error on failure
3561     *
3562     * @access  public
3563     * @see     getAssoc()
3564     */
3565    function fetchAll($fetchmode = MDB2_FETCHMODE_DEFAULT, $rekey = false,
3566        $force_array = false, $group = false)
3567    {
3568        $all = array();
3569        $row = $this->fetchRow($fetchmode);
3570        if (PEAR::isError($row)) {
3571            return $row;
3572        } elseif (!$row) {
3573            return $all;
3574        }
3575
3576        $shift_array = $rekey ? false : null;
3577        if (!is_null($shift_array)) {
3578            if (is_object($row)) {
3579                $colnum = count(get_object_vars($row));
3580            } else {
3581                $colnum = count($row);
3582            }
3583            if ($colnum < 2) {
3584                return $this->db->raiseError(MDB2_ERROR_TRUNCATED, null, null,
3585                    'rekey feature requires atleast 2 column', __FUNCTION__);
3586            }
3587            $shift_array = (!$force_array && $colnum == 2);
3588        }
3589
3590        if ($rekey) {
3591            do {
3592                if (is_object($row)) {
3593                    $arr = get_object_vars($row);
3594                    $key = reset($arr);
3595                    unset($row->{$key});
3596                } else {
3597                    if ($fetchmode & MDB2_FETCHMODE_ASSOC) {
3598                        $key = reset($row);
3599                        unset($row[key($row)]);
3600                    } else {
3601                        $key = array_shift($row);
3602                    }
3603                    if ($shift_array) {
3604                        $row = array_shift($row);
3605                    }
3606                }
3607                if ($group) {
3608                    $all[$key][] = $row;
3609                } else {
3610                    $all[$key] = $row;
3611                }
3612            } while (($row = $this->fetchRow($fetchmode)));
3613        } elseif ($fetchmode & MDB2_FETCHMODE_FLIPPED) {
3614            do {
3615                foreach ($row as $key => $val) {
3616                    $all[$key][] = $val;
3617                }
3618            } while (($row = $this->fetchRow($fetchmode)));
3619        } else {
3620            do {
3621                $all[] = $row;
3622            } while (($row = $this->fetchRow($fetchmode)));
3623        }
3624
3625        return $all;
3626    }
3627
3628    // }}}
3629    // {{{ function rowCount()
3630    /**
3631     * Returns the actual row number that was last fetched (count from 0)
3632     * @return  int
3633     *
3634     * @access  public
3635     */
3636    function rowCount()
3637    {
3638        return $this->rownum + 1;
3639    }
3640
3641    // }}}
3642    // {{{ function numRows()
3643
3644    /**
3645     * Returns the number of rows in a result object
3646     *
3647     * @return  mixed   MDB2 Error Object or the number of rows
3648     *
3649     * @access  public
3650     */
3651    function numRows()
3652    {
3653        return $this->db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
3654            'method not implemented', __FUNCTION__);
3655    }
3656
3657    // }}}
3658    // {{{ function nextResult()
3659
3660    /**
3661     * Move the internal result pointer to the next available result
3662     *
3663     * @return  true on success, false if there is no more result set or an error object on failure
3664     *
3665     * @access  public
3666     */
3667    function nextResult()
3668    {
3669        return $this->db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
3670            'method not implemented', __FUNCTION__);
3671    }
3672
3673    // }}}
3674    // {{{ function getColumnNames()
3675
3676    /**
3677     * Retrieve the names of columns returned by the DBMS in a query result or
3678     * from the cache.
3679     *
3680     * @param   bool    If set to true the values are the column names,
3681     *                  otherwise the names of the columns are the keys.
3682     * @return  mixed   Array variable that holds the names of columns or an
3683     *                  MDB2 error on failure.
3684     *                  Some DBMS may not return any columns when the result set
3685     *                  does not contain any rows.
3686     *
3687     * @access  public
3688     */
3689    function getColumnNames($flip = false)
3690    {
3691        if (!isset($this->column_names)) {
3692            $result = $this->_getColumnNames();
3693            if (PEAR::isError($result)) {
3694                return $result;
3695            }
3696            $this->column_names = $result;
3697        }
3698        if ($flip) {
3699            return array_flip($this->column_names);
3700        }
3701        return $this->column_names;
3702    }
3703
3704    // }}}
3705    // {{{ function _getColumnNames()
3706
3707    /**
3708     * Retrieve the names of columns returned by the DBMS in a query result.
3709     *
3710     * @return  mixed   Array variable that holds the names of columns as keys
3711     *                  or an MDB2 error on failure.
3712     *                  Some DBMS may not return any columns when the result set
3713     *                  does not contain any rows.
3714     *
3715     * @access  private
3716     */
3717    function _getColumnNames()
3718    {
3719        return $this->db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
3720            'method not implemented', __FUNCTION__);
3721    }
3722
3723    // }}}
3724    // {{{ function numCols()
3725
3726    /**
3727     * Count the number of columns returned by the DBMS in a query result.
3728     *
3729     * @return  mixed   integer value with the number of columns, a MDB2 error
3730     *       on failure
3731     *
3732     * @access  public
3733     */
3734    function numCols()
3735    {
3736        return $this->db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
3737            'method not implemented', __FUNCTION__);
3738    }
3739
3740    // }}}
3741    // {{{ function getResource()
3742
3743    /**
3744     * return the resource associated with the result object
3745     *
3746     * @return  resource
3747     *
3748     * @access  public
3749     */
3750    function getResource()
3751    {
3752        return $this->result;
3753    }
3754
3755    // }}}
3756    // {{{ function bindColumn($column, &$value, $type = null)
3757
3758    /**
3759     * Set bind variable to a column.
3760     *
3761     * @param   int     column number or name
3762     * @param   mixed   variable reference
3763     * @param   string  specifies the type of the field
3764     *
3765     * @return  mixed   MDB2_OK on success, a MDB2 error on failure
3766     *
3767     * @access  public
3768     */
3769    function bindColumn($column, &$value, $type = null)
3770    {
3771        if (!is_numeric($column)) {
3772            $column_names = $this->getColumnNames();
3773            if ($this->db->options['portability'] & MDB2_PORTABILITY_FIX_CASE) {
3774                if ($this->db->options['field_case'] == CASE_LOWER) {
3775                    $column = strtolower($column);
3776                } else {
3777                    $column = strtoupper($column);
3778                }
3779            }
3780            $column = $column_names[$column];
3781        }
3782        $this->values[$column] =& $value;
3783        if (!is_null($type)) {
3784            $this->types[$column] = $type;
3785        }
3786        return MDB2_OK;
3787    }
3788
3789    // }}}
3790    // {{{ function _assignBindColumns($row)
3791
3792    /**
3793     * Bind a variable to a value in the result row.
3794     *
3795     * @param   array   row data
3796     *
3797     * @return  mixed   MDB2_OK on success, a MDB2 error on failure
3798     *
3799     * @access  private
3800     */
3801    function _assignBindColumns($row)
3802    {
3803        $row = array_values($row);
3804        foreach ($row as $column => $value) {
3805            if (array_key_exists($column, $this->values)) {
3806                $this->values[$column] = $value;
3807            }
3808        }
3809        return MDB2_OK;
3810    }
3811
3812    // }}}
3813    // {{{ function free()
3814
3815    /**
3816     * Free the internal resources associated with result.
3817     *
3818     * @return  bool    true on success, false if result is invalid
3819     *
3820     * @access  public
3821     */
3822    function free()
3823    {
3824        $this->result = false;
3825        return MDB2_OK;
3826    }
3827
3828    // }}}
3829}
3830
3831// }}}
3832// {{{ class MDB2_Row
3833
3834/**
3835 * The simple class that accepts row data as an array
3836 *
3837 * @package     MDB2
3838 * @category    Database
3839 * @author      Lukas Smith <smith@pooteeweet.org>
3840 */
3841class MDB2_Row
3842{
3843    // {{{ constructor: function __construct(&$row)
3844
3845    /**
3846     * constructor
3847     *
3848     * @param   resource    row data as array
3849     */
3850    function __construct(&$row)
3851    {
3852        foreach ($row as $key => $value) {
3853            $this->$key = &$row[$key];
3854        }
3855    }
3856
3857    // }}}
3858    // {{{ function MDB2_Row(&$row)
3859
3860    /**
3861     * PHP 4 Constructor
3862     *
3863     * @param   resource    row data as array
3864     */
3865    function MDB2_Row(&$row)
3866    {
3867        $this->__construct($row);
3868    }
3869
3870    // }}}
3871}
3872
3873// }}}
3874// {{{ class MDB2_Statement_Common
3875
3876/**
3877 * The common statement class for MDB2 statement objects
3878 *
3879 * @package     MDB2
3880 * @category    Database
3881 * @author      Lukas Smith <smith@pooteeweet.org>
3882 */
3883class MDB2_Statement_Common
3884{
3885    // {{{ Variables (Properties)
3886
3887    var $db;
3888    var $statement;
3889    var $query;
3890    var $result_types;
3891    var $types;
3892    var $values = array();
3893    var $limit;
3894    var $offset;
3895    var $is_manip;
3896
3897    // }}}
3898    // {{{ constructor: function __construct(&$db, &$statement, $positions, $query, $types, $result_types, $is_manip = false, $limit = null, $offset = null)
3899
3900    /**
3901     * Constructor
3902     */
3903    function __construct(&$db, &$statement, $positions, $query, $types, $result_types, $is_manip = false, $limit = null, $offset = null)
3904    {
3905        $this->db =& $db;
3906        $this->statement =& $statement;
3907        $this->positions = $positions;
3908        $this->query = $query;
3909        $this->types = (array)$types;
3910        $this->result_types = (array)$result_types;
3911        $this->limit = $limit;
3912        $this->is_manip = $is_manip;
3913        $this->offset = $offset;
3914    }
3915
3916    // }}}
3917    // {{{ function MDB2_Statement_Common(&$db, &$statement, $positions, $query, $types, $result_types, $is_manip = false, $limit = null, $offset = null)
3918
3919    /**
3920     * PHP 4 Constructor
3921     */
3922    function MDB2_Statement_Common(&$db, &$statement, $positions, $query, $types, $result_types, $is_manip = false, $limit = null, $offset = null)
3923    {
3924        $this->__construct($db, $statement, $positions, $query, $types, $result_types, $is_manip, $limit, $offset);
3925    }
3926
3927    // }}}
3928    // {{{ function bindValue($parameter, &$value, $type = null)
3929
3930    /**
3931     * Set the value of a parameter of a prepared query.
3932     *
3933     * @param   int     the order number of the parameter in the query
3934     *       statement. The order number of the first parameter is 1.
3935     * @param   mixed   value that is meant to be assigned to specified
3936     *       parameter. The type of the value depends on the $type argument.
3937     * @param   string  specifies the type of the field
3938     *
3939     * @return  mixed   MDB2_OK on success, a MDB2 error on failure
3940     *
3941     * @access  public
3942     */
3943    function bindValue($parameter, $value, $type = null)
3944    {
3945        if (!is_numeric($parameter)) {
3946            $parameter = preg_replace('/^:(.*)$/', '\\1', $parameter);
3947        }
3948        if (!in_array($parameter, $this->positions)) {
3949            return $this->db->raiseError(MDB2_ERROR_NOT_FOUND, null, null,
3950                'Unable to bind to missing placeholder: '.$parameter, __FUNCTION__);
3951        }
3952        $this->values[$parameter] = $value;
3953        if (!is_null($type)) {
3954            $this->types[$parameter] = $type;
3955        }
3956        return MDB2_OK;
3957    }
3958
3959    // }}}
3960    // {{{ function bindValueArray($values, $types = null)
3961
3962    /**
3963     * Set the values of multiple a parameter of a prepared query in bulk.
3964     *
3965     * @param   array   specifies all necessary information
3966     *       for bindValue() the array elements must use keys corresponding to
3967     *       the number of the position of the parameter.
3968     * @param   array   specifies the types of the fields
3969     *
3970     * @return  mixed   MDB2_OK on success, a MDB2 error on failure
3971     *
3972     * @access  public
3973     * @see     bindParam()
3974     */
3975    function bindValueArray($values, $types = null)
3976    {
3977        $types = is_array($types) ? array_values($types) : array_fill(0, count($values), null);
3978        $parameters = array_keys($values);
3979        foreach ($parameters as $key => $parameter) {
3980            $err = $this->bindValue($parameter, $values[$parameter], $types[$key]);
3981            if (PEAR::isError($err)) {
3982                return $err;
3983            }
3984        }
3985        return MDB2_OK;
3986    }
3987
3988    // }}}
3989    // {{{ function bindParam($parameter, &$value, $type = null)
3990
3991    /**
3992     * Bind a variable to a parameter of a prepared query.
3993     *
3994     * @param   int     the order number of the parameter in the query
3995     *       statement. The order number of the first parameter is 1.
3996     * @param   mixed   variable that is meant to be bound to specified
3997     *       parameter. The type of the value depends on the $type argument.
3998     * @param   string  specifies the type of the field
3999     *
4000     * @return  mixed   MDB2_OK on success, a MDB2 error on failure
4001     *
4002     * @access  public
4003     */
4004    function bindParam($parameter, &$value, $type = null)
4005    {
4006        if (!is_numeric($parameter)) {
4007            $parameter = preg_replace('/^:(.*)$/', '\\1', $parameter);
4008        }
4009        if (!in_array($parameter, $this->positions)) {
4010            return $this->db->raiseError(MDB2_ERROR_NOT_FOUND, null, null,
4011                'Unable to bind to missing placeholder: '.$parameter, __FUNCTION__);
4012        }
4013        $this->values[$parameter] =& $value;
4014        if (!is_null($type)) {
4015            $this->types[$parameter] = $type;
4016        }
4017        return MDB2_OK;
4018    }
4019
4020    // }}}
4021    // {{{ function bindParamArray(&$values, $types = null)
4022
4023    /**
4024     * Bind the variables of multiple a parameter of a prepared query in bulk.
4025     *
4026     * @param   array   specifies all necessary information
4027     *       for bindParam() the array elements must use keys corresponding to
4028     *       the number of the position of the parameter.
4029     * @param   array   specifies the types of the fields
4030     *
4031     * @return  mixed   MDB2_OK on success, a MDB2 error on failure
4032     *
4033     * @access  public
4034     * @see     bindParam()
4035     */
4036    function bindParamArray(&$values, $types = null)
4037    {
4038        $types = is_array($types) ? array_values($types) : array_fill(0, count($values), null);
4039        $parameters = array_keys($values);
4040        foreach ($parameters as $key => $parameter) {
4041            $err = $this->bindParam($parameter, $values[$parameter], $types[$key]);
4042            if (PEAR::isError($err)) {
4043                return $err;
4044            }
4045        }
4046        return MDB2_OK;
4047    }
4048
4049    // }}}
4050    // {{{ function &execute($values = null, $result_class = true, $result_wrap_class = false)
4051
4052    /**
4053     * Execute a prepared query statement.
4054     *
4055     * @param   array   specifies all necessary information
4056     *       for bindParam() the array elements must use keys corresponding to
4057     *       the number of the position of the parameter.
4058     * @param   mixed   specifies which result class to use
4059     * @param   mixed   specifies which class to wrap results in
4060     *
4061     * @return  mixed   a result handle or MDB2_OK on success, a MDB2 error on failure
4062     *
4063     * @access  public
4064     */
4065    function &execute($values = null, $result_class = true, $result_wrap_class = false)
4066    {
4067        if (is_null($this->positions)) {
4068            return $this->db->raiseError(MDB2_ERROR, null, null,
4069                'Prepared statement has already been freed', __FUNCTION__);
4070        }
4071
4072        $values = (array)$values;
4073        if (!empty($values)) {
4074            $err = $this->bindValueArray($values);
4075            if (PEAR::isError($err)) {
4076                return $this->db->raiseError(MDB2_ERROR, null, null,
4077                                            'Binding Values failed with message: ' . $err->getMessage(), __FUNCTION__);
4078            }
4079        }
4080        $result =& $this->_execute($result_class, $result_wrap_class);
4081        return $result;
4082    }
4083
4084    // }}}
4085    // {{{ function &_execute($result_class = true, $result_wrap_class = false)
4086
4087    /**
4088     * Execute a prepared query statement helper method.
4089     *
4090     * @param   mixed   specifies which result class to use
4091     * @param   mixed   specifies which class to wrap results in
4092     *
4093     * @return  mixed   MDB2_Result or integer on success, a MDB2 error on failure
4094     *
4095     * @access  private
4096     */
4097    function &_execute($result_class = true, $result_wrap_class = false)
4098    {
4099        $this->last_query = $this->query;
4100        $query = '';
4101        $last_position = 0;
4102        foreach ($this->positions as $current_position => $parameter) {
4103            if (!array_key_exists($parameter, $this->values)) {
4104                return $this->db->raiseError(MDB2_ERROR_NOT_FOUND, null, null,
4105                    'Unable to bind to missing placeholder: '.$parameter, __FUNCTION__);
4106            }
4107            $value = $this->values[$parameter];
4108            $query.= substr($this->query, $last_position, $current_position - $last_position);
4109            if (!isset($value)) {
4110                $value_quoted = 'NULL';
4111            } else {
4112                $type = !empty($this->types[$parameter]) ? $this->types[$parameter] : null;
4113                $value_quoted = $this->db->quote($value, $type);
4114                if (PEAR::isError($value_quoted)) {
4115                    return $value_quoted;
4116                }
4117            }
4118            $query.= $value_quoted;
4119            $last_position = $current_position + 1;
4120        }
4121        $query.= substr($this->query, $last_position);
4122
4123        $this->db->offset = $this->offset;
4124        $this->db->limit = $this->limit;
4125        if ($this->is_manip) {
4126            $result = $this->db->exec($query);
4127        } else {
4128            $result =& $this->db->query($query, $this->result_types, $result_class, $result_wrap_class);
4129        }
4130        return $result;
4131    }
4132
4133    // }}}
4134    // {{{ function free()
4135
4136    /**
4137     * Release resources allocated for the specified prepared query.
4138     *
4139     * @return  mixed   MDB2_OK on success, a MDB2 error on failure
4140     *
4141     * @access  public
4142     */
4143    function free()
4144    {
4145        if (is_null($this->positions)) {
4146            return $this->db->raiseError(MDB2_ERROR, null, null,
4147                'Prepared statement has already been freed', __FUNCTION__);
4148        }
4149
4150        $this->statement = null;
4151        $this->positions = null;
4152        $this->query = null;
4153        $this->types = null;
4154        $this->result_types = null;
4155        $this->limit = null;
4156        $this->is_manip = null;
4157        $this->offset = null;
4158        $this->values = null;
4159
4160        return MDB2_OK;
4161    }
4162
4163    // }}}
4164}
4165
4166// }}}
4167// {{{ class MDB2_Module_Common
4168
4169/**
4170 * The common modules class for MDB2 module objects
4171 *
4172 * @package     MDB2
4173 * @category    Database
4174 * @author      Lukas Smith <smith@pooteeweet.org>
4175 */
4176class MDB2_Module_Common
4177{
4178    // {{{ Variables (Properties)
4179
4180    /**
4181     * contains the key to the global MDB2 instance array of the associated
4182     * MDB2 instance
4183     *
4184     * @var     int
4185     * @access  protected
4186     */
4187    var $db_index;
4188
4189    // }}}
4190    // {{{ constructor: function __construct($db_index)
4191
4192    /**
4193     * Constructor
4194     */
4195    function __construct($db_index)
4196    {
4197        $this->db_index = $db_index;
4198    }
4199
4200    // }}}
4201    // {{{ function MDB2_Module_Common($db_index)
4202
4203    /**
4204     * PHP 4 Constructor
4205     */
4206    function MDB2_Module_Common($db_index)
4207    {
4208        $this->__construct($db_index);
4209    }
4210
4211    // }}}
4212    // {{{ function &getDBInstance()
4213
4214    /**
4215     * Get the instance of MDB2 associated with the module instance
4216     *
4217     * @return  object  MDB2 instance or a MDB2 error on failure
4218     *
4219     * @access  public
4220     */
4221    function &getDBInstance()
4222    {
4223        if (isset($GLOBALS['_MDB2_databases'][$this->db_index])) {
4224            $result =& $GLOBALS['_MDB2_databases'][$this->db_index];
4225        } else {
4226            $result =& MDB2::raiseError(MDB2_ERROR_NOT_FOUND, null, null,
4227                'could not find MDB2 instance');
4228        }
4229        return $result;
4230    }
4231
4232    // }}}
4233}
4234
4235// }}}
4236// {{{ function MDB2_closeOpenTransactions()
4237
4238/**
4239 * Close any open transactions form persistent connections
4240 *
4241 * @return  void
4242 *
4243 * @access  public
4244 */
4245
4246function MDB2_closeOpenTransactions()
4247{
4248    reset($GLOBALS['_MDB2_databases']);
4249    while (next($GLOBALS['_MDB2_databases'])) {
4250        $key = key($GLOBALS['_MDB2_databases']);
4251        if ($GLOBALS['_MDB2_databases'][$key]->opened_persistent
4252            && $GLOBALS['_MDB2_databases'][$key]->in_transaction
4253        ) {
4254            $GLOBALS['_MDB2_databases'][$key]->rollback();
4255        }
4256    }
4257}
4258
4259// }}}
4260// {{{ function MDB2_defaultDebugOutput(&$db, $scope, $message, $is_manip = null)
4261
4262/**
4263 * default debug output handler
4264 *
4265 * @param   object  reference to an MDB2 database object
4266 * @param   string  usually the method name that triggered the debug call:
4267 *                  for example 'query', 'prepare', 'execute', 'parameters',
4268 *                  'beginTransaction', 'commit', 'rollback'
4269 * @param   string  message that should be appended to the debug variable
4270 * @param   array   contains context information about the debug() call
4271 *                  common keys are: is_manip, time, result etc.
4272 *
4273 * @return  void|string optionally return a modified message, this allows
4274 *                      rewriting a query before being issued or prepared
4275 *
4276 * @access  public
4277 */
4278function MDB2_defaultDebugOutput(&$db, $scope, $message, $context = array())
4279{
4280    $db->debug_output.= $scope.'('.$db->db_index.'): ';
4281    $db->debug_output.= $message.$db->getOption('log_line_break');
4282    return $message;
4283}
4284
4285// }}}
4286?>
Note: See TracBrowser for help on using the repository browser.