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

Revision 15931, 137.1 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        if (!@ini_get('safe_mode')) {
930             $dirs = explode(PATH_SEPARATOR, ini_get('include_path'));
931             foreach ($dirs as $dir) {
932                 if (is_readable($dir . DIRECTORY_SEPARATOR . $file)) {
933                     return true;
934                 }
935            }
936        } else {
937            $fp = @fopen($file, 'r', true);
938            if (is_resource($fp)) {
939                @fclose($fp);
940                return true;
941            }
942        }
943        return false;
944    }
945    // }}}
946}
947
948// }}}
949// {{{ class MDB2_Error extends PEAR_Error
950
951/**
952 * MDB2_Error implements a class for reporting portable database error
953 * messages.
954 *
955 * @package     MDB2
956 * @category    Database
957 * @author Stig Bakken <ssb@fast.no>
958 */
959class MDB2_Error extends PEAR_Error
960{
961    // {{{ constructor: function MDB2_Error($code = MDB2_ERROR, $mode = PEAR_ERROR_RETURN, $level = E_USER_NOTICE, $debuginfo = null)
962
963    /**
964     * MDB2_Error constructor.
965     *
966     * @param   mixed   MDB2 error code, or string with error message.
967     * @param   int     what 'error mode' to operate in
968     * @param   int     what error level to use for $mode & PEAR_ERROR_TRIGGER
969     * @param   smixed   additional debug info, such as the last query
970     */
971    function MDB2_Error($code = MDB2_ERROR, $mode = PEAR_ERROR_RETURN,
972              $level = E_USER_NOTICE, $debuginfo = null)
973    {
974        if (is_null($code)) {
975            $code = MDB2_ERROR;
976        }
977        $this->PEAR_Error('MDB2 Error: '.MDB2::errorMessage($code), $code,
978            $mode, $level, $debuginfo);
979    }
980
981    // }}}
982}
983
984// }}}
985// {{{ class MDB2_Driver_Common extends PEAR
986
987/**
988 * MDB2_Driver_Common: Base class that is extended by each MDB2 driver
989 *
990 * @package     MDB2
991 * @category    Database
992 * @author      Lukas Smith <smith@pooteeweet.org>
993 */
994class MDB2_Driver_Common extends PEAR
995{
996    // {{{ Variables (Properties)
997
998    /**
999     * index of the MDB2 object within the $GLOBALS['_MDB2_databases'] array
1000     * @var     int
1001     * @access  public
1002     */
1003    var $db_index = 0;
1004
1005    /**
1006     * DSN used for the next query
1007     * @var     array
1008     * @access  protected
1009     */
1010    var $dsn = array();
1011
1012    /**
1013     * DSN that was used to create the current connection
1014     * @var     array
1015     * @access  protected
1016     */
1017    var $connected_dsn = array();
1018
1019    /**
1020     * connection resource
1021     * @var     mixed
1022     * @access  protected
1023     */
1024    var $connection = 0;
1025
1026    /**
1027     * if the current opened connection is a persistent connection
1028     * @var     bool
1029     * @access  protected
1030     */
1031    var $opened_persistent;
1032
1033    /**
1034     * the name of the database for the next query
1035     * @var     string
1036     * @access  protected
1037     */
1038    var $database_name = '';
1039
1040    /**
1041     * the name of the database currently selected
1042     * @var     string
1043     * @access  protected
1044     */
1045    var $connected_database_name = '';
1046
1047    /**
1048     * server version information
1049     * @var     string
1050     * @access  protected
1051     */
1052    var $connected_server_info = '';
1053
1054    /**
1055     * list of all supported features of the given driver
1056     * @var     array
1057     * @access  public
1058     */
1059    var $supported = array(
1060        'sequences' => false,
1061        'indexes' => false,
1062        'affected_rows' => false,
1063        'summary_functions' => false,
1064        'order_by_text' => false,
1065        'transactions' => false,
1066        'savepoints' => false,
1067        'current_id' => false,
1068        'limit_queries' => false,
1069        'LOBs' => false,
1070        'replace' => false,
1071        'sub_selects' => false,
1072        'auto_increment' => false,
1073        'primary_key' => false,
1074        'result_introspection' => false,
1075        'prepared_statements' => false,
1076        'identifier_quoting' => false,
1077        'pattern_escaping' => false,
1078        'new_link' => false,
1079    );
1080
1081    /**
1082     * Array of supported options that can be passed to the MDB2 instance.
1083     *
1084     * The options can be set during object creation, using
1085     * MDB2::connect(), MDB2::factory() or MDB2::singleton(). The options can
1086     * also be set after the object is created, using MDB2::setOptions() or
1087     * MDB2_Driver_Common::setOption().
1088     * The list of available option includes:
1089     * <ul>
1090     *  <li>$options['ssl'] -> boolean: determines if ssl should be used for connections</li>
1091     *  <li>$options['field_case'] -> CASE_LOWER|CASE_UPPER: determines what case to force on field/table names</li>
1092     *  <li>$options['disable_query'] -> boolean: determines if queries should be executed</li>
1093     *  <li>$options['result_class'] -> string: class used for result sets</li>
1094     *  <li>$options['buffered_result_class'] -> string: class used for buffered result sets</li>
1095     *  <li>$options['result_wrap_class'] -> string: class used to wrap result sets into</li>
1096     *  <li>$options['result_buffering'] -> boolean should results be buffered or not?</li>
1097     *  <li>$options['fetch_class'] -> string: class to use when fetch mode object is used</li>
1098     *  <li>$options['persistent'] -> boolean: persistent connection?</li>
1099     *  <li>$options['debug'] -> integer: numeric debug level</li>
1100     *  <li>$options['debug_handler'] -> string: function/method that captures debug messages</li>
1101     *  <li>$options['debug_expanded_output'] -> bool: BC option to determine if more context information should be send to the debug handler</li>
1102     *  <li>$options['default_text_field_length'] -> integer: default text field length to use</li>
1103     *  <li>$options['lob_buffer_length'] -> integer: LOB buffer length</li>
1104     *  <li>$options['log_line_break'] -> string: line-break format</li>
1105     *  <li>$options['idxname_format'] -> string: pattern for index name</li>
1106     *  <li>$options['seqname_format'] -> string: pattern for sequence name</li>
1107     *  <li>$options['savepoint_format'] -> string: pattern for auto generated savepoint names</li>
1108     *  <li>$options['statement_format'] -> string: pattern for prepared statement names</li>
1109     *  <li>$options['seqcol_name'] -> string: sequence column name</li>
1110     *  <li>$options['quote_identifier'] -> boolean: if identifier quoting should be done when check_option is used</li>
1111     *  <li>$options['use_transactions'] -> boolean: if transaction use should be enabled</li>
1112     *  <li>$options['decimal_places'] -> integer: number of decimal places to handle</li>
1113     *  <li>$options['portability'] -> integer: portability constant</li>
1114     *  <li>$options['modules'] -> array: short to long module name mapping for __call()</li>
1115     *  <li>$options['emulate_prepared'] -> boolean: force prepared statements to be emulated</li>
1116     *  <li>$options['datatype_map'] -> array: map user defined datatypes to other primitive datatypes</li>
1117     *  <li>$options['datatype_map_callback'] -> array: callback function/method that should be called</li>
1118     * </ul>
1119     *
1120     * @var     array
1121     * @access  public
1122     * @see     MDB2::connect()
1123     * @see     MDB2::factory()
1124     * @see     MDB2::singleton()
1125     * @see     MDB2_Driver_Common::setOption()
1126     */
1127    var $options = array(
1128        'ssl' => false,
1129        'field_case' => CASE_LOWER,
1130        'disable_query' => false,
1131        'result_class' => 'MDB2_Result_%s',
1132        'buffered_result_class' => 'MDB2_BufferedResult_%s',
1133        'result_wrap_class' => false,
1134        'result_buffering' => true,
1135        'fetch_class' => 'stdClass',
1136        'persistent' => false,
1137        'debug' => 0,
1138        'debug_handler' => 'MDB2_defaultDebugOutput',
1139        'debug_expanded_output' => false,
1140        'default_text_field_length' => 4096,
1141        'lob_buffer_length' => 8192,
1142        'log_line_break' => "\n",
1143        'idxname_format' => '%s_idx',
1144        'seqname_format' => '%s_seq',
1145        'savepoint_format' => 'MDB2_SAVEPOINT_%s',
1146        'statement_format' => 'MDB2_STATEMENT_%1$s_%2$s',
1147        'seqcol_name' => 'sequence',
1148        'quote_identifier' => false,
1149        'use_transactions' => true,
1150        'decimal_places' => 2,
1151        'portability' => MDB2_PORTABILITY_ALL,
1152        'modules' => array(
1153            'ex' => 'Extended',
1154            'dt' => 'Datatype',
1155            'mg' => 'Manager',
1156            'rv' => 'Reverse',
1157            'na' => 'Native',
1158            'fc' => 'Function',
1159        ),
1160        'emulate_prepared' => false,
1161        'datatype_map' => array(),
1162        'datatype_map_callback' => array(),
1163        'nativetype_map_callback' => array(),
1164    );
1165
1166    /**
1167     * string array
1168     * @var     string
1169     * @access  protected
1170     */
1171    var $string_quoting = array('start' => "'", 'end' => "'", 'escape' => false, 'escape_pattern' => false);
1172
1173    /**
1174     * identifier quoting
1175     * @var     array
1176     * @access  protected
1177     */
1178    var $identifier_quoting = array('start' => '"', 'end' => '"', 'escape' => '"');
1179
1180    /**
1181     * sql comments
1182     * @var     array
1183     * @access  protected
1184     */
1185    var $sql_comments = array(
1186        array('start' => '--', 'end' => "\n", 'escape' => false),
1187        array('start' => '/*', 'end' => '*/', 'escape' => false),
1188    );
1189
1190    /**
1191     * comparision wildcards
1192     * @var     array
1193     * @access  protected
1194     */
1195    var $wildcards = array('%', '_');
1196
1197    /**
1198     * column alias keyword
1199     * @var     string
1200     * @access  protected
1201     */
1202    var $as_keyword = ' AS ';
1203
1204    /**
1205     * warnings
1206     * @var     array
1207     * @access  protected
1208     */
1209    var $warnings = array();
1210
1211    /**
1212     * string with the debugging information
1213     * @var     string
1214     * @access  public
1215     */
1216    var $debug_output = '';
1217
1218    /**
1219     * determine if there is an open transaction
1220     * @var     bool
1221     * @access  protected
1222     */
1223    var $in_transaction = false;
1224
1225    /**
1226     * the smart transaction nesting depth
1227     * @var     int
1228     * @access  protected
1229     */
1230    var $nested_transaction_counter = null;
1231
1232    /**
1233     * the first error that occured inside a nested transaction
1234     * @var     MDB2_Error|bool
1235     * @access  protected
1236     */
1237    var $has_transaction_error = false;
1238
1239    /**
1240     * result offset used in the next query
1241     * @var     int
1242     * @access  protected
1243     */
1244    var $offset = 0;
1245
1246    /**
1247     * result limit used in the next query
1248     * @var     int
1249     * @access  protected
1250     */
1251    var $limit = 0;
1252
1253    /**
1254     * Database backend used in PHP (mysql, odbc etc.)
1255     * @var     string
1256     * @access  public
1257     */
1258    var $phptype;
1259
1260    /**
1261     * Database used with regards to SQL syntax etc.
1262     * @var     string
1263     * @access  public
1264     */
1265    var $dbsyntax;
1266
1267    /**
1268     * the last query sent to the driver
1269     * @var     string
1270     * @access  public
1271     */
1272    var $last_query;
1273
1274    /**
1275     * the default fetchmode used
1276     * @var     int
1277     * @access  protected
1278     */
1279    var $fetchmode = MDB2_FETCHMODE_ORDERED;
1280
1281    /**
1282     * array of module instances
1283     * @var     array
1284     * @access  protected
1285     */
1286    var $modules = array();
1287
1288    /**
1289     * determines of the PHP4 destructor emulation has been enabled yet
1290     * @var     array
1291     * @access  protected
1292     */
1293    var $destructor_registered = true;
1294
1295    // }}}
1296    // {{{ constructor: function __construct()
1297
1298    /**
1299     * Constructor
1300     */
1301    function __construct()
1302    {
1303        end($GLOBALS['_MDB2_databases']);
1304        $db_index = key($GLOBALS['_MDB2_databases']) + 1;
1305        $GLOBALS['_MDB2_databases'][$db_index] = &$this;
1306        $this->db_index = $db_index;
1307    }
1308
1309    // }}}
1310    // {{{ function MDB2_Driver_Common()
1311
1312    /**
1313     * PHP 4 Constructor
1314     */
1315    function MDB2_Driver_Common()
1316    {
1317        $this->destructor_registered = false;
1318        $this->__construct();
1319    }
1320
1321    // }}}
1322    // {{{ destructor: function __destruct()
1323
1324    /**
1325     *  Destructor
1326     */
1327    function __destruct()
1328    {
1329        $this->disconnect(false);
1330    }
1331
1332    // }}}
1333    // {{{ function free()
1334
1335    /**
1336     * Free the internal references so that the instance can be destroyed
1337     *
1338     * @return  bool    true on success, false if result is invalid
1339     *
1340     * @access  public
1341     */
1342    function free()
1343    {
1344        unset($GLOBALS['_MDB2_databases'][$this->db_index]);
1345        unset($this->db_index);
1346        return MDB2_OK;
1347    }
1348
1349    // }}}
1350    // {{{ function __toString()
1351
1352    /**
1353     * String conversation
1354     *
1355     * @return  string representation of the object
1356     *
1357     * @access  public
1358     */
1359    function __toString()
1360    {
1361        $info = get_class($this);
1362        $info.= ': (phptype = '.$this->phptype.', dbsyntax = '.$this->dbsyntax.')';
1363        if ($this->connection) {
1364            $info.= ' [connected]';
1365        }
1366        return $info;
1367    }
1368
1369    // }}}
1370    // {{{ function errorInfo($error = null)
1371
1372    /**
1373     * This method is used to collect information about an error
1374     *
1375     * @param   mixed   error code or resource
1376     *
1377     * @return  array   with MDB2 errorcode, native error code, native message
1378     *
1379     * @access  public
1380     */
1381    function errorInfo($error = null)
1382    {
1383        return array($error, null, null);
1384    }
1385
1386    // }}}
1387    // {{{ function &raiseError($code = null, $mode = null, $options = null, $userinfo = null)
1388
1389    /**
1390     * This method is used to communicate an error and invoke error
1391     * callbacks etc.  Basically a wrapper for PEAR::raiseError
1392     * without the message string.
1393     *
1394     * @param   mixed   integer error code, or a PEAR error object (all other
1395     *                  parameters are ignored if this parameter is an object
1396     * @param   int     error mode, see PEAR_Error docs
1397     * @param   mixed   If error mode is PEAR_ERROR_TRIGGER, this is the
1398         *              error level (E_USER_NOTICE etc).  If error mode is
1399     *                  PEAR_ERROR_CALLBACK, this is the callback function,
1400     *                  either as a function name, or as an array of an
1401     *                  object and method name.  For other error modes this
1402     *                  parameter is ignored.
1403     * @param   string  Extra debug information.  Defaults to the last
1404     *                  query and native error code.
1405     * @param   string  name of the method that triggered the error
1406     *
1407     * @return PEAR_Error   instance of a PEAR Error object
1408     *
1409     * @access  public
1410     * @see     PEAR_Error
1411     */
1412    function &raiseError($code = null, $mode = null, $options = null, $userinfo = null, $method = null)
1413    {
1414        $userinfo = "[Error message: $userinfo]\n";
1415        // The error is yet a MDB2 error object
1416        if (PEAR::isError($code)) {
1417            // because we use the static PEAR::raiseError, our global
1418            // handler should be used if it is set
1419            if (is_null($mode) && !empty($this->_default_error_mode)) {
1420                $mode    = $this->_default_error_mode;
1421                $options = $this->_default_error_options;
1422            }
1423            if (is_null($userinfo)) {
1424                $userinfo = $code->getUserinfo();
1425            }
1426            $code = $code->getCode();
1427        } elseif ($code == MDB2_ERROR_NOT_FOUND) {
1428            // extension not loaded: don't call $this->errorInfo() or the script
1429            // will die
1430        } elseif (isset($this->connection)) {
1431            if (!empty($this->last_query)) {
1432                $userinfo.= "[Last executed query: {$this->last_query}]\n";
1433            }
1434            $native_errno = $native_msg = null;
1435            list($code, $native_errno, $native_msg) = $this->errorInfo($code);
1436            if (!is_null($native_errno) && $native_errno !== '') {
1437                $userinfo.= "[Native code: $native_errno]\n";
1438            }
1439            if (!is_null($native_msg) && $native_msg !== '') {
1440                $userinfo.= "[Native message: ". strip_tags($native_msg) ."]\n";
1441            }
1442            if (!is_null($method)) {
1443                $userinfo = $method.': '.$userinfo;
1444            }
1445        }
1446
1447        $err =& PEAR::raiseError(null, $code, $mode, $options, $userinfo, 'MDB2_Error', true);
1448        if ($err->getMode() !== PEAR_ERROR_RETURN
1449            && isset($this->nested_transaction_counter) && !$this->has_transaction_error) {
1450            $this->has_transaction_error =& $err;
1451        }
1452        return $err;
1453    }
1454
1455    // }}}
1456    // {{{ function resetWarnings()
1457
1458    /**
1459     * reset the warning array
1460     *
1461     * @return void
1462     *
1463     * @access  public
1464     */
1465    function resetWarnings()
1466    {
1467        $this->warnings = array();
1468    }
1469
1470    // }}}
1471    // {{{ function getWarnings()
1472
1473    /**
1474     * Get all warnings in reverse order.
1475     * This means that the last warning is the first element in the array
1476     *
1477     * @return  array   with warnings
1478     *
1479     * @access  public
1480     * @see     resetWarnings()
1481     */
1482    function getWarnings()
1483    {
1484        return array_reverse($this->warnings);
1485    }
1486
1487    // }}}
1488    // {{{ function setFetchMode($fetchmode, $object_class = 'stdClass')
1489
1490    /**
1491     * Sets which fetch mode should be used by default on queries
1492     * on this connection
1493     *
1494     * @param   int     MDB2_FETCHMODE_ORDERED, MDB2_FETCHMODE_ASSOC
1495     *                               or MDB2_FETCHMODE_OBJECT
1496     * @param   string  the class name of the object to be returned
1497     *                               by the fetch methods when the
1498     *                               MDB2_FETCHMODE_OBJECT mode is selected.
1499     *                               If no class is specified by default a cast
1500     *                               to object from the assoc array row will be
1501     *                               done.  There is also the possibility to use
1502     *                               and extend the 'MDB2_row' class.
1503     *
1504     * @return  mixed   MDB2_OK or MDB2 Error Object
1505     *
1506     * @access  public
1507     * @see     MDB2_FETCHMODE_ORDERED, MDB2_FETCHMODE_ASSOC, MDB2_FETCHMODE_OBJECT
1508     */
1509    function setFetchMode($fetchmode, $object_class = 'stdClass')
1510    {
1511        switch ($fetchmode) {
1512        case MDB2_FETCHMODE_OBJECT:
1513            $this->options['fetch_class'] = $object_class;
1514        case MDB2_FETCHMODE_ORDERED:
1515        case MDB2_FETCHMODE_ASSOC:
1516            $this->fetchmode = $fetchmode;
1517            break;
1518        default:
1519            return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
1520                'invalid fetchmode mode', __FUNCTION__);
1521        }
1522
1523        return MDB2_OK;
1524    }
1525
1526    // }}}
1527    // {{{ function setOption($option, $value)
1528
1529    /**
1530     * set the option for the db class
1531     *
1532     * @param   string  option name
1533     * @param   mixed   value for the option
1534     *
1535     * @return  mixed   MDB2_OK or MDB2 Error Object
1536     *
1537     * @access  public
1538     */
1539    function setOption($option, $value)
1540    {
1541        if (array_key_exists($option, $this->options)) {
1542            $this->options[$option] = $value;
1543            return MDB2_OK;
1544        }
1545        return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
1546            "unknown option $option", __FUNCTION__);
1547    }
1548
1549    // }}}
1550    // {{{ function getOption($option)
1551
1552    /**
1553     * Returns the value of an option
1554     *
1555     * @param   string  option name
1556     *
1557     * @return  mixed   the option value or error object
1558     *
1559     * @access  public
1560     */
1561    function getOption($option)
1562    {
1563        if (array_key_exists($option, $this->options)) {
1564            return $this->options[$option];
1565        }
1566        return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
1567            "unknown option $option", __FUNCTION__);
1568    }
1569
1570    // }}}
1571    // {{{ function debug($message, $scope = '', $is_manip = null)
1572
1573    /**
1574     * set a debug message
1575     *
1576     * @param   string  message that should be appended to the debug variable
1577     * @param   string  usually the method name that triggered the debug call:
1578     *                  for example 'query', 'prepare', 'execute', 'parameters',
1579     *                  'beginTransaction', 'commit', 'rollback'
1580     * @param   array   contains context information about the debug() call
1581     *                  common keys are: is_manip, time, result etc.
1582     *
1583     * @return void
1584     *
1585     * @access  public
1586     */
1587    function debug($message, $scope = '', $context = array())
1588    {
1589        if ($this->options['debug'] && $this->options['debug_handler']) {
1590            if (!$this->options['debug_expanded_output']) {
1591                if (!empty($context['when']) && $context['when'] !== 'pre') {
1592                    return null;
1593                }
1594                $context = empty($context['is_manip']) ? false : $context['is_manip'];
1595            }
1596            return call_user_func_array($this->options['debug_handler'], array(&$this, $scope, $message, $context));
1597        }
1598        return null;
1599    }
1600
1601    // }}}
1602    // {{{ function getDebugOutput()
1603
1604    /**
1605     * output debug info
1606     *
1607     * @return  string  content of the debug_output class variable
1608     *
1609     * @access  public
1610     */
1611    function getDebugOutput()
1612    {
1613        return $this->debug_output;
1614    }
1615
1616    // }}}
1617    // {{{ function escape($text)
1618
1619    /**
1620     * Quotes a string so it can be safely used in a query. It will quote
1621     * the text so it can safely be used within a query.
1622     *
1623     * @param   string  the input string to quote
1624     * @param   bool    escape wildcards
1625     *
1626     * @return  string  quoted string
1627     *
1628     * @access  public
1629     */
1630    function escape($text, $escape_wildcards = false)
1631    {
1632        if ($escape_wildcards) {
1633            $text = $this->escapePattern($text);
1634        }
1635
1636        $text = str_replace($this->string_quoting['end'], $this->string_quoting['escape'] . $this->string_quoting['end'], $text);
1637        return $text;
1638    }
1639
1640    // }}}
1641    // {{{ function escapePattern($text)
1642
1643    /**
1644     * Quotes pattern (% and _) characters in a string)
1645     *
1646     * EXPERIMENTAL
1647     *
1648     * WARNING: this function is experimental and may change signature at
1649     * any time until labelled as non-experimental
1650     *
1651     * @param   string  the input string to quote
1652     *
1653     * @return  string  quoted string
1654     *
1655     * @access  public
1656     */
1657    function escapePattern($text)
1658    {
1659        if ($this->string_quoting['escape_pattern']) {
1660            $text = str_replace($this->string_quoting['escape_pattern'], $this->string_quoting['escape_pattern'] . $this->string_quoting['escape_pattern'], $text);
1661            foreach ($this->wildcards as $wildcard) {
1662                $text = str_replace($wildcard, $this->string_quoting['escape_pattern'] . $wildcard, $text);
1663            }
1664        }
1665        return $text;
1666    }
1667
1668    // }}}
1669    // {{{ function quoteIdentifier($str, $check_option = false)
1670
1671    /**
1672     * Quote a string so it can be safely used as a table or column name
1673     *
1674     * Delimiting style depends on which database driver is being used.
1675     *
1676     * NOTE: just because you CAN use delimited identifiers doesn't mean
1677     * you SHOULD use them.  In general, they end up causing way more
1678     * problems than they solve.
1679     *
1680     * Portability is broken by using the following characters inside
1681     * delimited identifiers:
1682     *   + backtick (<kbd>`</kbd>) -- due to MySQL
1683     *   + double quote (<kbd>"</kbd>) -- due to Oracle
1684     *   + brackets (<kbd>[</kbd> or <kbd>]</kbd>) -- due to Access
1685     *
1686     * Delimited identifiers are known to generally work correctly under
1687     * the following drivers:
1688     *   + mssql
1689     *   + mysql
1690     *   + mysqli
1691     *   + oci8
1692     *   + pgsql
1693     *   + sqlite
1694     *
1695     * InterBase doesn't seem to be able to use delimited identifiers
1696     * via PHP 4.  They work fine under PHP 5.
1697     *
1698     * @param   string  identifier name to be quoted
1699     * @param   bool    check the 'quote_identifier' option
1700     *
1701     * @return  string  quoted identifier string
1702     *
1703     * @access  public
1704     */
1705    function quoteIdentifier($str, $check_option = false)
1706    {
1707        if ($check_option && !$this->options['quote_identifier']) {
1708            return $str;
1709        }
1710        $str = str_replace($this->identifier_quoting['end'], $this->identifier_quoting['escape'] . $this->identifier_quoting['end'], $str);
1711        return $this->identifier_quoting['start'] . $str . $this->identifier_quoting['end'];
1712    }
1713
1714    // }}}
1715    // {{{ function getAsKeyword()
1716
1717    /**
1718     * Gets the string to alias column
1719     *
1720     * @return string to use when aliasing a column
1721     */
1722    function getAsKeyword()
1723    {
1724        return $this->as_keyword;
1725    }
1726
1727    // }}}
1728    // {{{ function getConnection()
1729
1730    /**
1731     * Returns a native connection
1732     *
1733     * @return  mixed   a valid MDB2 connection object,
1734     *                  or a MDB2 error object on error
1735     *
1736     * @access  public
1737     */
1738    function getConnection()
1739    {
1740        $result = $this->connect();
1741        if (PEAR::isError($result)) {
1742            return $result;
1743        }
1744        return $this->connection;
1745    }
1746
1747     // }}}
1748    // {{{ function _fixResultArrayValues(&$row, $mode)
1749
1750    /**
1751     * Do all necessary conversions on result arrays to fix DBMS quirks
1752     *
1753     * @param   array   the array to be fixed (passed by reference)
1754     * @param   array   bit-wise addition of the required portability modes
1755     *
1756     * @return  void
1757     *
1758     * @access  protected
1759     */
1760    function _fixResultArrayValues(&$row, $mode)
1761    {
1762        switch ($mode) {
1763        case MDB2_PORTABILITY_EMPTY_TO_NULL:
1764            foreach ($row as $key => $value) {
1765                if ($value === '') {
1766                    $row[$key] = null;
1767                }
1768            }
1769            break;
1770        case MDB2_PORTABILITY_RTRIM:
1771            foreach ($row as $key => $value) {
1772                if (is_string($value)) {
1773                    $row[$key] = rtrim($value);
1774                }
1775            }
1776            break;
1777        case MDB2_PORTABILITY_FIX_ASSOC_FIELD_NAMES:
1778            $tmp_row = array();
1779            foreach ($row as $key => $value) {
1780                $tmp_row[preg_replace('/^(?:.*\.)?([^.]+)$/', '\\1', $key)] = $value;
1781            }
1782            $row = $tmp_row;
1783            break;
1784        case (MDB2_PORTABILITY_RTRIM + MDB2_PORTABILITY_EMPTY_TO_NULL):
1785            foreach ($row as $key => $value) {
1786                if ($value === '') {
1787                    $row[$key] = null;
1788                } elseif (is_string($value)) {
1789                    $row[$key] = rtrim($value);
1790                }
1791            }
1792            break;
1793        case (MDB2_PORTABILITY_RTRIM + MDB2_PORTABILITY_FIX_ASSOC_FIELD_NAMES):
1794            $tmp_row = array();
1795            foreach ($row as $key => $value) {
1796                if (is_string($value)) {
1797                    $value = rtrim($value);
1798                }
1799                $tmp_row[preg_replace('/^(?:.*\.)?([^.]+)$/', '\\1', $key)] = $value;
1800            }
1801            $row = $tmp_row;
1802            break;
1803        case (MDB2_PORTABILITY_EMPTY_TO_NULL + MDB2_PORTABILITY_FIX_ASSOC_FIELD_NAMES):
1804            $tmp_row = array();
1805            foreach ($row as $key => $value) {
1806                if ($value === '') {
1807                    $value = null;
1808                }
1809                $tmp_row[preg_replace('/^(?:.*\.)?([^.]+)$/', '\\1', $key)] = $value;
1810            }
1811            $row = $tmp_row;
1812            break;
1813        case (MDB2_PORTABILITY_RTRIM + MDB2_PORTABILITY_EMPTY_TO_NULL + MDB2_PORTABILITY_FIX_ASSOC_FIELD_NAMES):
1814            $tmp_row = array();
1815            foreach ($row as $key => $value) {
1816                if ($value === '') {
1817                    $value = null;
1818                } elseif (is_string($value)) {
1819                    $value = rtrim($value);
1820                }
1821                $tmp_row[preg_replace('/^(?:.*\.)?([^.]+)$/', '\\1', $key)] = $value;
1822            }
1823            $row = $tmp_row;
1824            break;
1825        }
1826    }
1827
1828    // }}}
1829    // {{{ function &loadModule($module, $property = null, $phptype_specific = null)
1830
1831    /**
1832     * loads a module
1833     *
1834     * @param   string  name of the module that should be loaded
1835     *                  (only used for error messages)
1836     * @param   string  name of the property into which the class will be loaded
1837     * @param   bool    if the class to load for the module is specific to the
1838     *                  phptype
1839     *
1840     * @return  object  on success a reference to the given module is returned
1841     *                  and on failure a PEAR error
1842     *
1843     * @access  public
1844     */
1845    function &loadModule($module, $property = null, $phptype_specific = null)
1846    {
1847        if (!$property) {
1848            $property = strtolower($module);
1849        }
1850
1851        if (!isset($this->{$property})) {
1852            $version = $phptype_specific;
1853            if ($phptype_specific !== false) {
1854                $version = true;
1855                $class_name = 'MDB2_Driver_'.$module.'_'.$this->phptype;
1856                $file_name = str_replace('_', DIRECTORY_SEPARATOR, $class_name).'.php';
1857            }
1858            if ($phptype_specific === false
1859                || (!MDB2::classExists($class_name) && !MDB2::fileExists($file_name))
1860            ) {
1861                $version = false;
1862                $class_name = 'MDB2_'.$module;
1863                $file_name = str_replace('_', DIRECTORY_SEPARATOR, $class_name).'.php';
1864            }
1865
1866            $err = MDB2::loadClass($class_name, $this->getOption('debug'));
1867            if (PEAR::isError($err)) {
1868                return $err;
1869            }
1870
1871            // load modul in a specific version
1872            if ($version) {
1873                if (method_exists($class_name, 'getClassName')) {
1874                    $class_name_new = call_user_func(array($class_name, 'getClassName'), $this->db_index);
1875                    if ($class_name != $class_name_new) {
1876                        $class_name = $class_name_new;
1877                        $err = MDB2::loadClass($class_name, $this->getOption('debug'));
1878                        if (PEAR::isError($err)) {
1879                            return $err;
1880                        }
1881                    }
1882                }
1883            }
1884
1885            if (!MDB2::classExists($class_name)) {
1886                $err =& $this->raiseError(MDB2_ERROR_LOADMODULE, null, null,
1887                    "unable to load module '$module' into property '$property'", __FUNCTION__);
1888                return $err;
1889            }
1890            $this->{$property} =& new $class_name($this->db_index);
1891            $this->modules[$module] =& $this->{$property};
1892            if ($version) {
1893                // this will be used in the connect method to determine if the module
1894                // needs to be loaded with a different version if the server
1895                // version changed in between connects
1896                $this->loaded_version_modules[] = $property;
1897            }
1898        }
1899
1900        return $this->{$property};
1901    }
1902
1903    // }}}
1904    // {{{ function __call($method, $params)
1905
1906    /**
1907     * Calls a module method using the __call magic method
1908     *
1909     * @param   string  Method name.
1910     * @param   array   Arguments.
1911     *
1912     * @return  mixed   Returned value.
1913     */
1914    function __call($method, $params)
1915    {
1916        $module = null;
1917        if (preg_match('/^([a-z]+)([A-Z])(.*)$/', $method, $match)
1918            && isset($this->options['modules'][$match[1]])
1919        ) {
1920            $module = $this->options['modules'][$match[1]];
1921            $method = strtolower($match[2]).$match[3];
1922            if (!isset($this->modules[$module]) || !is_object($this->modules[$module])) {
1923                $result =& $this->loadModule($module);
1924                if (PEAR::isError($result)) {
1925                    return $result;
1926                }
1927            }
1928        } else {
1929            foreach ($this->modules as $key => $foo) {
1930                if (is_object($this->modules[$key])
1931                    && method_exists($this->modules[$key], $method)
1932                ) {
1933                    $module = $key;
1934                    break;
1935                }
1936            }
1937        }
1938        if (!is_null($module)) {
1939            return call_user_func_array(array(&$this->modules[$module], $method), $params);
1940        }
1941        trigger_error(sprintf('Call to undefined function: %s::%s().', get_class($this), $method), E_USER_ERROR);
1942    }
1943
1944    // }}}
1945    // {{{ function beginTransaction($savepoint = null)
1946
1947    /**
1948     * Start a transaction or set a savepoint.
1949     *
1950     * @param   string  name of a savepoint to set
1951     * @return  mixed   MDB2_OK on success, a MDB2 error on failure
1952     *
1953     * @access  public
1954     */
1955    function beginTransaction($savepoint = null)
1956    {
1957        $this->debug('Starting transaction', __FUNCTION__, array('is_manip' => true, 'savepoint' => $savepoint));
1958        return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
1959            'transactions are not supported', __FUNCTION__);
1960    }
1961
1962    // }}}
1963    // {{{ function commit($savepoint = null)
1964
1965    /**
1966     * Commit the database changes done during a transaction that is in
1967     * progress or release a savepoint. This function may only be called when
1968     * auto-committing is disabled, otherwise it will fail. Therefore, a new
1969     * transaction is implicitly started after committing the pending changes.
1970     *
1971     * @param   string  name of a savepoint to release
1972     * @return  mixed   MDB2_OK on success, a MDB2 error on failure
1973     *
1974     * @access  public
1975     */
1976    function commit($savepoint = null)
1977    {
1978        $this->debug('Committing transaction/savepoint', __FUNCTION__, array('is_manip' => true, 'savepoint' => $savepoint));
1979        return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
1980            'commiting transactions is not supported', __FUNCTION__);
1981    }
1982
1983    // }}}
1984    // {{{ function rollback($savepoint = null)
1985
1986    /**
1987     * Cancel any database changes done during a transaction or since a specific
1988     * savepoint that is in progress. This function may only be called when
1989     * auto-committing is disabled, otherwise it will fail. Therefore, a new
1990     * transaction is implicitly started after canceling the pending changes.
1991     *
1992     * @param   string  name of a savepoint to rollback to
1993     * @return  mixed   MDB2_OK on success, a MDB2 error on failure
1994     *
1995     * @access  public
1996     */
1997    function rollback($savepoint = null)
1998    {
1999        $this->debug('Rolling back transaction/savepoint', __FUNCTION__, array('is_manip' => true, 'savepoint' => $savepoint));
2000        return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
2001            'rolling back transactions is not supported', __FUNCTION__);
2002    }
2003
2004    // }}}
2005    // {{{ function inTransaction($ignore_nested = false)
2006
2007    /**
2008     * If a transaction is currently open.
2009     *
2010     * @param   bool    if the nested transaction count should be ignored
2011     * @return  int|bool    - an integer with the nesting depth is returned if a
2012     *                      nested transaction is open
2013     *                      - true is returned for a normal open transaction
2014     *                      - false is returned if no transaction is open
2015     *
2016     * @access  public
2017     */
2018    function inTransaction($ignore_nested = false)
2019    {
2020        if (!$ignore_nested && isset($this->nested_transaction_counter)) {
2021            return $this->nested_transaction_counter;
2022        }
2023        return $this->in_transaction;
2024    }
2025
2026    // }}}
2027    // {{{ function setTransactionIsolation($isolation)
2028
2029    /**
2030     * Set the transacton isolation level.
2031     *
2032     * @param   string  standard isolation level
2033     *                  READ UNCOMMITTED (allows dirty reads)
2034     *                  READ COMMITTED (prevents dirty reads)
2035     *                  REPEATABLE READ (prevents nonrepeatable reads)
2036     *                  SERIALIZABLE (prevents phantom reads)
2037     * @param   array some transaction options:
2038     *                  'wait' => 'WAIT' | 'NO WAIT'
2039     *                  'rw'   => 'READ WRITE' | 'READ ONLY'
2040     * @return  mixed   MDB2_OK on success, a MDB2 error on failure
2041     *
2042     * @access  public
2043     * @since   2.1.1
2044     */
2045    function setTransactionIsolation($isolation, $options = array())
2046    {
2047        $this->debug('Setting transaction isolation level', __FUNCTION__, array('is_manip' => true));
2048        return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
2049            'isolation level setting is not supported', __FUNCTION__);
2050    }
2051
2052    // }}}
2053    // {{{ function beginNestedTransaction($savepoint = false)
2054
2055    /**
2056     * Start a nested transaction.
2057     *
2058     * EXPERIMENTAL
2059     *
2060     * WARNING: this function is experimental and may change signature at
2061     * any time until labelled as non-experimental
2062     *
2063     * @return  mixed   MDB2_OK on success/savepoint name, a MDB2 error on failure
2064     *
2065     * @access  public
2066     * @since   2.1.1
2067     */
2068    function beginNestedTransaction()
2069    {
2070        if ($this->in_transaction) {
2071            ++$this->nested_transaction_counter;
2072            $savepoint = sprintf($this->options['savepoint_format'], $this->nested_transaction_counter);
2073            if ($this->supports('savepoints') && $savepoint) {
2074                return $this->beginTransaction($savepoint);
2075            }
2076            return MDB2_OK;
2077        }
2078        $this->has_transaction_error = false;
2079        $result = $this->beginTransaction();
2080        $this->nested_transaction_counter = 1;
2081        return $result;
2082    }
2083
2084    // }}}
2085    // {{{ function completeNestedTransaction($force_rollback = false, $release = false)
2086
2087    /**
2088     * Finish a nested transaction by rolling back if an error occured or
2089     * committing otherwise.
2090     *
2091     * EXPERIMENTAL
2092     *
2093     * WARNING: this function is experimental and may change signature at
2094     * any time until labelled as non-experimental
2095     *
2096     * @param   bool    if the transaction should be rolled back regardless
2097     *                  even if no error was set within the nested transaction
2098     * @return  mixed   MDB_OK on commit/counter decrementing, false on rollback
2099     *                  and a MDB2 error on failure
2100     *
2101     * @access  public
2102     * @since   2.1.1
2103     */
2104    function completeNestedTransaction($force_rollback = false)
2105    {
2106        if ($this->nested_transaction_counter > 1) {
2107            $savepoint = sprintf($this->options['savepoint_format'], $this->nested_transaction_counter);
2108            if ($this->supports('savepoints') && $savepoint) {
2109                if ($force_rollback || $this->has_transaction_error) {
2110                    $result = $this->rollback($savepoint);
2111                    if (!PEAR::isError($result)) {
2112                        $result = false;
2113                        $this->has_transaction_error = false;
2114                    }
2115                } else {
2116                    $result = $this->commit($savepoint);
2117                }
2118            } else {
2119                $result = MDB2_OK;
2120            }
2121            --$this->nested_transaction_counter;
2122            return $result;
2123        }
2124
2125        $this->nested_transaction_counter = null;
2126        $result = MDB2_OK;
2127
2128        // transaction has not yet been rolled back
2129        if ($this->in_transaction) {
2130            if ($force_rollback || $this->has_transaction_error) {
2131                $result = $this->rollback();
2132                if (!PEAR::isError($result)) {
2133                    $result = false;
2134                }
2135            } else {
2136                $result = $this->commit();
2137            }
2138        }
2139        $this->has_transaction_error = false;
2140        return $result;
2141    }
2142
2143    // }}}
2144    // {{{ function failNestedTransaction($error = null, $immediately = false)
2145
2146    /**
2147     * Force setting nested transaction to failed.
2148     *
2149     * EXPERIMENTAL
2150     *
2151     * WARNING: this function is experimental and may change signature at
2152     * any time until labelled as non-experimental
2153     *
2154     * @param   mixed   value to return in getNestededTransactionError()
2155     * @param   bool    if the transaction should be rolled back immediately
2156     * @return  bool    MDB2_OK
2157     *
2158     * @access  public
2159     * @since   2.1.1
2160     */
2161    function failNestedTransaction($error = null, $immediately = false)
2162    {
2163        if (is_null($error)) {
2164            $error = $this->has_transaction_error ? $this->has_transaction_error : true;
2165        } elseif (!$error) {
2166            $error = true;
2167        }
2168        $this->has_transaction_error = $error;
2169        if (!$immediately) {
2170            return MDB2_OK;
2171        }
2172        return $this->rollback();
2173    }
2174
2175    // }}}
2176    // {{{ function getNestedTransactionError()
2177
2178    /**
2179     * The first error that occured since the transaction start.
2180     *
2181     * EXPERIMENTAL
2182     *
2183     * WARNING: this function is experimental and may change signature at
2184     * any time until labelled as non-experimental
2185     *
2186     * @return  MDB2_Error|bool     MDB2 error object if an error occured or false.
2187     *
2188     * @access  public
2189     * @since   2.1.1
2190     */
2191    function getNestedTransactionError()
2192    {
2193        return $this->has_transaction_error;
2194    }
2195
2196    // }}}
2197    // {{{ connect()
2198
2199    /**
2200     * Connect to the database
2201     *
2202     * @return true on success, MDB2 Error Object on failure
2203     */
2204    function connect()
2205    {
2206        return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
2207            'method not implemented', __FUNCTION__);
2208    }
2209
2210    // }}}
2211    // {{{ setCharset($charset, $connection = null)
2212
2213    /**
2214     * Set the charset on the current connection
2215     *
2216     * @param string    charset
2217     * @param resource  connection handle
2218     *
2219     * @return true on success, MDB2 Error Object on failure
2220     */
2221    function setCharset($charset, $connection = null)
2222    {
2223        return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
2224            'method not implemented', __FUNCTION__);
2225    }
2226
2227    // }}}
2228    // {{{ function disconnect($force = true)
2229
2230    /**
2231     * Log out and disconnect from the database.
2232     *
2233     * @param   bool    if the disconnect should be forced even if the
2234     *                  connection is opened persistently
2235     *
2236     * @return  mixed   true on success, false if not connected and error
2237     *                  object on error
2238     *
2239     * @access  public
2240     */
2241    function disconnect($force = true)
2242    {
2243        $this->connection = 0;
2244        $this->connected_dsn = array();
2245        $this->connected_database_name = '';
2246        $this->opened_persistent = null;
2247        $this->connected_server_info = '';
2248        $this->in_transaction = null;
2249        $this->nested_transaction_counter = null;
2250        return MDB2_OK;
2251    }
2252
2253    // }}}
2254    // {{{ function setDatabase($name)
2255
2256    /**
2257     * Select a different database
2258     *
2259     * @param   string  name of the database that should be selected
2260     *
2261     * @return  string  name of the database previously connected to
2262     *
2263     * @access  public
2264     */
2265    function setDatabase($name)
2266    {
2267        $previous_database_name = (isset($this->database_name)) ? $this->database_name : '';
2268        $this->database_name = $name;
2269        $this->disconnect(false);
2270        return $previous_database_name;
2271    }
2272
2273    // }}}
2274    // {{{ function getDatabase()
2275
2276    /**
2277     * Get the current database
2278     *
2279     * @return  string  name of the database
2280     *
2281     * @access  public
2282     */
2283    function getDatabase()
2284    {
2285        return $this->database_name;
2286    }
2287
2288    // }}}
2289    // {{{ function setDSN($dsn)
2290
2291    /**
2292     * set the DSN
2293     *
2294     * @param   mixed   DSN string or array
2295     *
2296     * @return  MDB2_OK
2297     *
2298     * @access  public
2299     */
2300    function setDSN($dsn)
2301    {
2302        $dsn_default = $GLOBALS['_MDB2_dsninfo_default'];
2303        $dsn = MDB2::parseDSN($dsn);
2304        if (array_key_exists('database', $dsn)) {
2305            $this->database_name = $dsn['database'];
2306            unset($dsn['database']);
2307        }
2308        $this->dsn = array_merge($dsn_default, $dsn);
2309        return $this->disconnect(false);
2310    }
2311
2312    // }}}
2313    // {{{ function getDSN($type = 'string', $hidepw = false)
2314
2315    /**
2316     * return the DSN as a string
2317     *
2318     * @param   string  format to return ("array", "string")
2319     * @param   string  string to hide the password with
2320     *
2321     * @return  mixed   DSN in the chosen type
2322     *
2323     * @access  public
2324     */
2325    function getDSN($type = 'string', $hidepw = false)
2326    {
2327        $dsn = array_merge($GLOBALS['_MDB2_dsninfo_default'], $this->dsn);
2328        $dsn['phptype'] = $this->phptype;
2329        $dsn['database'] = $this->database_name;
2330        if ($hidepw) {
2331            $dsn['password'] = $hidepw;
2332        }
2333        switch ($type) {
2334        // expand to include all possible options
2335        case 'string':
2336           $dsn = $dsn['phptype'].
2337               ($dsn['dbsyntax'] ? ('('.$dsn['dbsyntax'].')') : '').
2338               '://'.$dsn['username'].':'.
2339                $dsn['password'].'@'.$dsn['hostspec'].
2340                ($dsn['port'] ? (':'.$dsn['port']) : '').
2341                '/'.$dsn['database'];
2342            break;
2343        case 'array':
2344        default:
2345            break;
2346        }
2347        return $dsn;
2348    }
2349
2350    // }}}
2351    // {{{ function &standaloneQuery($query, $types = null, $is_manip = false)
2352
2353   /**
2354     * execute a query as database administrator
2355     *
2356     * @param   string  the SQL query
2357     * @param   mixed   array that contains the types of the columns in
2358     *                        the result set
2359     * @param   bool    if the query is a manipulation query
2360     *
2361     * @return  mixed   MDB2_OK on success, a MDB2 error on failure
2362     *
2363     * @access  public
2364     */
2365    function &standaloneQuery($query, $types = null, $is_manip = false)
2366    {
2367        $offset = $this->offset;
2368        $limit = $this->limit;
2369        $this->offset = $this->limit = 0;
2370        $query = $this->_modifyQuery($query, $is_manip, $limit, $offset);
2371
2372        $connection = $this->getConnection();
2373        if (PEAR::isError($connection)) {
2374            return $connection;
2375        }
2376
2377        $result =& $this->_doQuery($query, $is_manip, $connection, false);
2378        if (PEAR::isError($result)) {
2379            return $result;
2380        }
2381
2382        if ($is_manip) {
2383            $affected_rows =  $this->_affectedRows($connection, $result);
2384            return $affected_rows;
2385        }
2386        $result =& $this->_wrapResult($result, $types, true, false, $limit, $offset);
2387        return $result;
2388    }
2389
2390    // }}}
2391    // {{{ function _modifyQuery($query, $is_manip, $limit, $offset)
2392
2393    /**
2394     * Changes a query string for various DBMS specific reasons
2395     *
2396     * @param   string  query to modify
2397     * @param   bool    if it is a DML query
2398     * @param   int  limit the number of rows
2399     * @param   int  start reading from given offset
2400     *
2401     * @return  string  modified query
2402     *
2403     * @access  protected
2404     */
2405    function _modifyQuery($query, $is_manip, $limit, $offset)
2406    {
2407        return $query;
2408    }
2409
2410    // }}}
2411    // {{{ function &_doQuery($query, $is_manip = false, $connection = null, $database_name = null)
2412
2413    /**
2414     * Execute a query
2415     * @param   string  query
2416     * @param   bool    if the query is a manipulation query
2417     * @param   resource connection handle
2418     * @param   string  database name
2419     *
2420     * @return  result or error object
2421     *
2422     * @access  protected
2423     */
2424    function &_doQuery($query, $is_manip = false, $connection = null, $database_name = null)
2425    {
2426        $this->last_query = $query;
2427        $result = $this->debug($query, 'query', array('is_manip' => $is_manip, 'when' => 'pre'));
2428        if ($result) {
2429            if (PEAR::isError($result)) {
2430                return $result;
2431            }
2432            $query = $result;
2433        }
2434        $err =& $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
2435            'method not implemented', __FUNCTION__);
2436        return $err;
2437    }
2438
2439    // }}}
2440    // {{{ function _affectedRows($connection, $result = null)
2441
2442    /**
2443     * Returns the number of rows affected
2444     *
2445     * @param   resource result handle
2446     * @param   resource connection handle
2447     *
2448     * @return  mixed   MDB2 Error Object or the number of rows affected
2449     *
2450     * @access  private
2451     */
2452    function _affectedRows($connection, $result = null)
2453    {
2454        return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
2455            'method not implemented', __FUNCTION__);
2456    }
2457
2458    // }}}
2459    // {{{ function &exec($query)
2460
2461    /**
2462     * Execute a manipulation query to the database and return the number of affected rows
2463     *
2464     * @param   string  the SQL query
2465     *
2466     * @return  mixed   number of affected rows on success, a MDB2 error on failure
2467     *
2468     * @access  public
2469     */
2470    function &exec($query)
2471    {
2472        $offset = $this->offset;
2473        $limit = $this->limit;
2474        $this->offset = $this->limit = 0;
2475        $query = $this->_modifyQuery($query, true, $limit, $offset);
2476
2477        $connection = $this->getConnection();
2478        if (PEAR::isError($connection)) {
2479            return $connection;
2480        }
2481
2482        $result =& $this->_doQuery($query, true, $connection, $this->database_name);
2483        if (PEAR::isError($result)) {
2484            return $result;
2485        }
2486
2487        $affectedRows = $this->_affectedRows($connection, $result);
2488        return $affectedRows;
2489    }
2490
2491    // }}}
2492    // {{{ function &query($query, $types = null, $result_class = true, $result_wrap_class = false)
2493
2494    /**
2495     * Send a query to the database and return any results
2496     *
2497     * @param   string  the SQL query
2498     * @param   mixed   array that contains the types of the columns in
2499     *                        the result set
2500     * @param   mixed   string which specifies which result class to use
2501     * @param   mixed   string which specifies which class to wrap results in
2502     *
2503     * @return mixed   an MDB2_Result handle on success, a MDB2 error on failure
2504     *
2505     * @access  public
2506     */
2507    function &query($query, $types = null, $result_class = true, $result_wrap_class = false)
2508    {
2509        $offset = $this->offset;
2510        $limit = $this->limit;
2511        $this->offset = $this->limit = 0;
2512        $query = $this->_modifyQuery($query, false, $limit, $offset);
2513
2514        $connection = $this->getConnection();
2515        if (PEAR::isError($connection)) {
2516            return $connection;
2517        }
2518
2519        $result =& $this->_doQuery($query, false, $connection, $this->database_name);
2520        if (PEAR::isError($result)) {
2521            return $result;
2522        }
2523
2524        $result =& $this->_wrapResult($result, $types, $result_class, $result_wrap_class, $limit, $offset);
2525        return $result;
2526    }
2527
2528    // }}}
2529    // {{{ function &_wrapResult($result, $types = array(), $result_class = true, $result_wrap_class = false, $limit = null, $offset = null)
2530
2531    /**
2532     * wrap a result set into the correct class
2533     *
2534     * @param   resource result handle
2535     * @param   mixed   array that contains the types of the columns in
2536     *                        the result set
2537     * @param   mixed   string which specifies which result class to use
2538     * @param   mixed   string which specifies which class to wrap results in
2539     * @param   string  number of rows to select
2540     * @param   string  first row to select
2541     *
2542     * @return mixed   an MDB2_Result, a MDB2 error on failure
2543     *
2544     * @access  protected
2545     */
2546    function &_wrapResult($result, $types = array(), $result_class = true,
2547        $result_wrap_class = false, $limit = null, $offset = null)
2548    {
2549        if ($types === true) {
2550            if ($this->supports('result_introspection')) {
2551                $this->loadModule('Reverse', null, true);
2552                $tableInfo = $this->reverse->tableInfo($result);
2553                if (PEAR::isError($tableInfo)) {
2554                    return $tableInfo;
2555                }
2556                $types = array();
2557                foreach ($tableInfo as $field) {
2558                    $types[] = $field['mdb2type'];
2559                }
2560            } else {
2561                $types = null;
2562            }
2563        }
2564
2565        if ($result_class === true) {
2566            $result_class = $this->options['result_buffering']
2567                ? $this->options['buffered_result_class'] : $this->options['result_class'];
2568        }
2569
2570        if ($result_class) {
2571            $class_name = sprintf($result_class, $this->phptype);
2572            if (!MDB2::classExists($class_name)) {
2573                $err =& $this->raiseError(MDB2_ERROR_NOT_FOUND, null, null,
2574                    'result class does not exist '.$class_name, __FUNCTION__);
2575                return $err;
2576            }
2577            $result =& new $class_name($this, $result, $limit, $offset);
2578            if (!MDB2::isResultCommon($result)) {
2579                $err =& $this->raiseError(MDB2_ERROR_NOT_FOUND, null, null,
2580                    'result class is not extended from MDB2_Result_Common', __FUNCTION__);
2581                return $err;
2582            }
2583            if (!empty($types)) {
2584                $err = $result->setResultTypes($types);
2585                if (PEAR::isError($err)) {
2586                    $result->free();
2587                    return $err;
2588                }
2589            }
2590        }
2591        if ($result_wrap_class === true) {
2592            $result_wrap_class = $this->options['result_wrap_class'];
2593        }
2594        if ($result_wrap_class) {
2595            if (!MDB2::classExists($result_wrap_class)) {
2596                $err =& $this->raiseError(MDB2_ERROR_NOT_FOUND, null, null,
2597                    'result wrap class does not exist '.$result_wrap_class, __FUNCTION__);
2598                return $err;
2599            }
2600            $result =& new $result_wrap_class($result, $this->fetchmode);
2601        }
2602        return $result;
2603    }
2604
2605    // }}}
2606    // {{{ function getServerVersion($native = false)
2607
2608    /**
2609     * return version information about the server
2610     *
2611     * @param   bool    determines if the raw version string should be returned
2612     *
2613     * @return  mixed   array with version information or row string
2614     *
2615     * @access  public
2616     */
2617    function getServerVersion($native = false)
2618    {
2619        return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
2620            'method not implemented', __FUNCTION__);
2621    }
2622
2623    // }}}
2624    // {{{ function setLimit($limit, $offset = null)
2625
2626    /**
2627     * set the range of the next query
2628     *
2629     * @param   string  number of rows to select
2630     * @param   string  first row to select
2631     *
2632     * @return  mixed   MDB2_OK on success, a MDB2 error on failure
2633     *
2634     * @access  public
2635     */
2636    function setLimit($limit, $offset = null)
2637    {
2638        if (!$this->supports('limit_queries')) {
2639            return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
2640                'limit is not supported by this driver', __FUNCTION__);
2641        }
2642        $limit = (int)$limit;
2643        if ($limit < 0) {
2644            return $this->raiseError(MDB2_ERROR_SYNTAX, null, null,
2645                'it was not specified a valid selected range row limit', __FUNCTION__);
2646        }
2647        $this->limit = $limit;
2648        if (!is_null($offset)) {
2649            $offset = (int)$offset;
2650            if ($offset < 0) {
2651                return $this->raiseError(MDB2_ERROR_SYNTAX, null, null,
2652                    'it was not specified a valid first selected range row', __FUNCTION__);
2653            }
2654            $this->offset = $offset;
2655        }
2656        return MDB2_OK;
2657    }
2658
2659    // }}}
2660    // {{{ function subSelect($query, $type = false)
2661
2662    /**
2663     * simple subselect emulation: leaves the query untouched for all RDBMS
2664     * that support subselects
2665     *
2666     * @param   string  the SQL query for the subselect that may only
2667     *                      return a column
2668     * @param   string  determines type of the field
2669     *
2670     * @return  string  the query
2671     *
2672     * @access  public
2673     */
2674    function subSelect($query, $type = false)
2675    {
2676        if ($this->supports('sub_selects') === true) {
2677            return $query;
2678        }
2679
2680        if (!$this->supports('sub_selects')) {
2681            return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
2682                'method not implemented', __FUNCTION__);
2683        }
2684
2685        $col = $this->queryCol($query, $type);
2686        if (PEAR::isError($col)) {
2687            return $col;
2688        }
2689        if (!is_array($col) || count($col) == 0) {
2690            return 'NULL';
2691        }
2692        if ($type) {
2693            $this->loadModule('Datatype', null, true);
2694            return $this->datatype->implodeArray($col, $type);
2695        }
2696        return implode(', ', $col);
2697    }
2698
2699    // }}}
2700    // {{{ function replace($table, $fields)
2701
2702    /**
2703     * Execute a SQL REPLACE query. A REPLACE query is identical to a INSERT
2704     * query, except that if there is already a row in the table with the same
2705     * key field values, the REPLACE query just updates its values instead of
2706     * inserting a new row.
2707     *
2708     * The REPLACE type of query does not make part of the SQL standards. Since
2709     * practically only MySQL and SQLite implement it natively, this type of
2710     * query isemulated through this method for other DBMS using standard types
2711     * of queries inside a transaction to assure the atomicity of the operation.
2712     *
2713     * @param   string  name of the table on which the REPLACE query will
2714     *       be executed.
2715     * @param   array   associative array   that describes the fields and the
2716     *       values that will be inserted or updated in the specified table. The
2717     *       indexes of the array are the names of all the fields of the table.
2718     *       The values of the array are also associative arrays that describe
2719     *       the values and other properties of the table fields.
2720     *
2721     *       Here follows a list of field properties that need to be specified:
2722     *
2723     *       value
2724     *           Value to be assigned to the specified field. This value may be
2725     *           of specified in database independent type format as this
2726     *           function can perform the necessary datatype conversions.
2727     *
2728     *           Default: this property is required unless the Null property is
2729     *           set to 1.
2730     *
2731     *       type
2732     *           Name of the type of the field. Currently, all types MDB2
2733     *           are supported except for clob and blob.
2734     *
2735     *           Default: no type conversion
2736     *
2737     *       null
2738     *           bool    property that indicates that the value for this field
2739     *           should be set to null.
2740     *
2741     *           The default value for fields missing in INSERT queries may be
2742     *           specified the definition of a table. Often, the default value
2743     *           is already null, but since the REPLACE may be emulated using
2744     *           an UPDATE query, make sure that all fields of the table are
2745     *           listed in this function argument array.
2746     *
2747     *           Default: 0
2748     *
2749     *       key
2750     *           bool    property that indicates that this field should be
2751     *           handled as a primary key or at least as part of the compound
2752     *           unique index of the table that will determine the row that will
2753     *           updated if it exists or inserted a new row otherwise.
2754     *
2755     *           This function will fail if no key field is specified or if the
2756     *           value of a key field is set to null because fields that are
2757     *           part of unique index they may not be null.
2758     *
2759     *           Default: 0
2760     *
2761     * @return  mixed   MDB2_OK on success, a MDB2 error on failure
2762     *
2763     * @access  public
2764     */
2765    function replace($table, $fields)
2766    {
2767        if (!$this->supports('replace')) {
2768            return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
2769                'replace query is not supported', __FUNCTION__);
2770        }
2771        $count = count($fields);
2772        $condition = $values = array();
2773        for ($colnum = 0, reset($fields); $colnum < $count; next($fields), $colnum++) {
2774            $name = key($fields);
2775            if (isset($fields[$name]['null']) && $fields[$name]['null']) {
2776                $value = 'NULL';
2777            } else {
2778                $type = isset($fields[$name]['type']) ? $fields[$name]['type'] : null;
2779                $value = $this->quote($fields[$name]['value'], $type);
2780            }
2781            $values[$name] = $value;
2782            if (isset($fields[$name]['key']) && $fields[$name]['key']) {
2783                if ($value === 'NULL') {
2784                    return $this->raiseError(MDB2_ERROR_CANNOT_REPLACE, null, null,
2785                        'key value '.$name.' may not be NULL', __FUNCTION__);
2786                }
2787                $condition[] = $name . '=' . $value;
2788            }
2789        }
2790        if (empty($condition)) {
2791            return $this->raiseError(MDB2_ERROR_CANNOT_REPLACE, null, null,
2792                'not specified which fields are keys', __FUNCTION__);
2793        }
2794
2795        $result = null;
2796        $in_transaction = $this->in_transaction;
2797        if (!$in_transaction && PEAR::isError($result = $this->beginTransaction())) {
2798            return $result;
2799        }
2800
2801        $connection = $this->getConnection();
2802        if (PEAR::isError($connection)) {
2803            return $connection;
2804        }
2805
2806        $condition = ' WHERE '.implode(' AND ', $condition);
2807        $query = "DELETE FROM $table$condition";
2808        $result =& $this->_doQuery($query, true, $connection);
2809        if (!PEAR::isError($result)) {
2810            $affected_rows = $this->_affectedRows($connection, $result);
2811            $insert = implode(', ', array_keys($values));
2812            $values = implode(', ', $values);
2813            $query = "INSERT INTO $table ($insert) VALUES ($values)";
2814            $result =& $this->_doQuery($query, true, $connection);
2815            if (!PEAR::isError($result)) {
2816                $affected_rows += $this->_affectedRows($connection, $result);;
2817            }
2818        }
2819
2820        if (!$in_transaction) {
2821            if (PEAR::isError($result)) {
2822                $this->rollback();
2823            } else {
2824                $result = $this->commit();
2825            }
2826        }
2827
2828        if (PEAR::isError($result)) {
2829            return $result;
2830        }
2831
2832        return $affected_rows;
2833    }
2834
2835    // }}}
2836    // {{{ function &prepare($query, $types = null, $result_types = null, $lobs = array())
2837
2838    /**
2839     * Prepares a query for multiple execution with execute().
2840     * With some database backends, this is emulated.
2841     * prepare() requires a generic query as string like
2842     * 'INSERT INTO numbers VALUES(?,?)' or
2843     * 'INSERT INTO numbers VALUES(:foo,:bar)'.
2844     * The ? and :[a-zA-Z] and  are placeholders which can be set using
2845     * bindParam() and the query can be send off using the execute() method.
2846     *
2847     * @param   string  the query to prepare
2848     * @param   mixed   array that contains the types of the placeholders
2849     * @param   mixed   array that contains the types of the columns in
2850     *                        the result set or MDB2_PREPARE_RESULT, if set to
2851     *                        MDB2_PREPARE_MANIP the query is handled as a manipulation query
2852     * @param   mixed   key (field) value (parameter) pair for all lob placeholders
2853     *
2854     * @return  mixed   resource handle for the prepared query on success,
2855     *                  a MDB2 error on failure
2856     *
2857     * @access  public
2858     * @see     bindParam, execute
2859     */
2860    function &prepare($query, $types = null, $result_types = null, $lobs = array())
2861    {
2862        $is_manip = ($result_types === MDB2_PREPARE_MANIP);
2863        $offset = $this->offset;
2864        $limit = $this->limit;
2865        $this->offset = $this->limit = 0;
2866        $result = $this->debug($query, __FUNCTION__, array('is_manip' => $is_manip, 'when' => 'pre'));
2867        if ($result) {
2868            if (PEAR::isError($result)) {
2869                return $result;
2870            }
2871            $query = $result;
2872        }
2873        $placeholder_type_guess = $placeholder_type = null;
2874        $question = '?';
2875        $colon = ':';
2876        $positions = array();
2877        $position = 0;
2878        $ignores = $this->sql_comments;
2879        $ignores[] = $this->string_quoting;
2880        $ignores[] = $this->identifier_quoting;
2881        while ($position < strlen($query)) {
2882            $q_position = strpos($query, $question, $position);
2883            $c_position = strpos($query, $colon, $position);
2884            if ($q_position && $c_position) {
2885                $p_position = min($q_position, $c_position);
2886            } elseif ($q_position) {
2887                $p_position = $q_position;
2888            } elseif ($c_position) {
2889                $p_position = $c_position;
2890            } else {
2891                break;
2892            }
2893            if (is_null($placeholder_type)) {
2894                $placeholder_type_guess = $query[$p_position];
2895            }
2896
2897            $new_pos = $this->_skipDelimitedStrings($query, $position, $p_position);
2898            if (PEAR::isError($new_pos)) {
2899                return $new_pos;
2900            }
2901            if ($new_pos != $position) {
2902                $position = $new_pos;
2903                continue; //evaluate again starting from the new position
2904            }
2905
2906            if ($query[$position] == $placeholder_type_guess) {
2907                if (is_null($placeholder_type)) {
2908                    $placeholder_type = $query[$p_position];
2909                    $question = $colon = $placeholder_type;
2910                    if (!empty($types) && is_array($types)) {
2911                        if ($placeholder_type == ':') {
2912                            if (is_int(key($types))) {
2913                                $types_tmp = $types;
2914                                $types = array();
2915                                $count = -1;
2916                            }
2917                        } else {
2918                            $types = array_values($types);
2919                        }
2920                    }
2921                }
2922                if ($placeholder_type == ':') {
2923                    $parameter = preg_replace('/^.{'.($position+1).'}([a-z0-9_]+).*$/si', '\\1', $query);
2924                    if ($parameter === '') {
2925                        $err =& $this->raiseError(MDB2_ERROR_SYNTAX, null, null,
2926                            'named parameter with an empty name', __FUNCTION__);
2927                        return $err;
2928                    }
2929                    $positions[$p_position] = $parameter;
2930                    $query = substr_replace($query, '?', $position, strlen($parameter)+1);
2931                    // use parameter name in type array
2932                    if (isset($count) && isset($types_tmp[++$count])) {
2933                        $types[$parameter] = $types_tmp[$count];
2934                    }
2935                } else {
2936                    $positions[$p_position] = count($positions);
2937                }
2938                $position = $p_position + 1;
2939            } else {
2940                $position = $p_position;
2941            }
2942        }
2943        $class_name = 'MDB2_Statement_'.$this->phptype;
2944        $statement = null;
2945        $obj =& new $class_name($this, $statement, $positions, $query, $types, $result_types, $is_manip, $limit, $offset);
2946        $this->debug($query, __FUNCTION__, array('is_manip' => $is_manip, 'when' => 'post', 'result' => $obj));
2947        return $obj;
2948    }
2949
2950    // }}}
2951    // {{{ function _skipDelimitedStrings($query, $position, $p_position)
2952   
2953    /**
2954     * Utility method, used by prepare() to avoid replacing placeholders within delimited strings.
2955     * Check if the placeholder is contained within a delimited string.
2956     * If so, skip it and advance the position, otherwise return the current position,
2957     * which is valid
2958     *
2959     * @param string $query
2960     * @param integer $position current string cursor position
2961     * @param integer $p_position placeholder position
2962     *
2963     * @return mixed integer $new_position on success
2964     *               MDB2_Error on failure
2965     *
2966     * @access  protected
2967     */
2968    function _skipDelimitedStrings($query, $position, $p_position)
2969    {
2970        $ignores = $this->sql_comments;
2971        $ignores[] = $this->string_quoting;
2972        $ignores[] = $this->identifier_quoting;
2973       
2974        foreach ($ignores as $ignore) {
2975            if (!empty($ignore['start'])) {
2976                if (is_int($start_quote = strpos($query, $ignore['start'], $position)) && $start_quote < $p_position) {
2977                    $end_quote = $start_quote;
2978                    do {
2979                        if (!is_int($end_quote = strpos($query, $ignore['end'], $end_quote + 1))) {
2980                            if ($ignore['end'] === "\n") {
2981                                $end_quote = strlen($query) - 1;
2982                            } else {
2983                                $err =& $this->raiseError(MDB2_ERROR_SYNTAX, null, null,
2984                                    'query with an unterminated text string specified', __FUNCTION__);
2985                                return $err;
2986                            }
2987                        }
2988                    } while ($ignore['escape'] && $query[($end_quote - 1)] == $ignore['escape']);
2989                    $position = $end_quote + 1;
2990                    return $position;
2991                }
2992            }
2993        }
2994        return $position;
2995    }
2996   
2997    // }}}
2998    // {{{ function quote($value, $type = null, $quote = true)
2999
3000    /**
3001     * Convert a text value into a DBMS specific format that is suitable to
3002     * compose query statements.
3003     *
3004     * @param   string  text string value that is intended to be converted.
3005     * @param   string  type to which the value should be converted to
3006     * @param   bool    quote
3007     * @param   bool    escape wildcards
3008     *
3009     * @return  string  text string that represents the given argument value in
3010     *       a DBMS specific format.
3011     *
3012     * @access  public
3013     */
3014    function quote($value, $type = null, $quote = true, $escape_wildcards = false)
3015    {
3016        $result = $this->loadModule('Datatype', null, true);
3017        if (PEAR::isError($result)) {
3018            return $result;
3019        }
3020
3021        return $this->datatype->quote($value, $type, $quote, $escape_wildcards);
3022    }
3023
3024    // }}}
3025    // {{{ function getDeclaration($type, $name, $field)
3026
3027    /**
3028     * Obtain DBMS specific SQL code portion needed to declare
3029     * of the given type
3030     *
3031     * @param   string  type to which the value should be converted to
3032     * @param   string  name the field to be declared.
3033     * @param   string  definition of the field
3034     *
3035     * @return  string  DBMS specific SQL code portion that should be used to
3036     *                 declare the specified field.
3037     *
3038     * @access  public
3039     */
3040    function getDeclaration($type, $name, $field)
3041    {
3042        $result = $this->loadModule('Datatype', null, true);
3043        if (PEAR::isError($result)) {
3044            return $result;
3045        }
3046        return $this->datatype->getDeclaration($type, $name, $field);
3047    }
3048
3049    // }}}
3050    // {{{ function compareDefinition($current, $previous)
3051
3052    /**
3053     * Obtain an array of changes that may need to applied
3054     *
3055     * @param   array   new definition
3056     * @param   array   old definition
3057     *
3058     * @return  array   containing all changes that will need to be applied
3059     *
3060     * @access  public
3061     */
3062    function compareDefinition($current, $previous)
3063    {
3064        $result = $this->loadModule('Datatype', null, true);
3065        if (PEAR::isError($result)) {
3066            return $result;
3067        }
3068        return $this->datatype->compareDefinition($current, $previous);
3069    }
3070
3071    // }}}
3072    // {{{ function supports($feature)
3073
3074    /**
3075     * Tell whether a DB implementation or its backend extension
3076     * supports a given feature.
3077     *
3078     * @param   string  name of the feature (see the MDB2 class doc)
3079     *
3080     * @return  bool|string if this DB implementation supports a given feature
3081     *                      false means no, true means native,
3082     *                      'emulated' means emulated
3083     *
3084     * @access  public
3085     */
3086    function supports($feature)
3087    {
3088        if (array_key_exists($feature, $this->supported)) {
3089            return $this->supported[$feature];
3090        }
3091        return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
3092            "unknown support feature $feature", __FUNCTION__);
3093    }
3094
3095    // }}}
3096    // {{{ function getSequenceName($sqn)
3097
3098    /**
3099     * adds sequence name formatting to a sequence name
3100     *
3101     * @param   string  name of the sequence
3102     *
3103     * @return  string  formatted sequence name
3104     *
3105     * @access  public
3106     */
3107    function getSequenceName($sqn)
3108    {
3109        return sprintf($this->options['seqname_format'],
3110            preg_replace('/[^a-z0-9_\$.]/i', '_', $sqn));
3111    }
3112
3113    // }}}
3114    // {{{ function getIndexName($idx)
3115
3116    /**
3117     * adds index name formatting to a index name
3118     *
3119     * @param   string  name of the index
3120     *
3121     * @return  string  formatted index name
3122     *
3123     * @access  public
3124     */
3125    function getIndexName($idx)
3126    {
3127        return sprintf($this->options['idxname_format'],
3128            preg_replace('/[^a-z0-9_\$]/i', '_', $idx));
3129    }
3130
3131    // }}}
3132    // {{{ function nextID($seq_name, $ondemand = true)
3133
3134    /**
3135     * Returns the next free id of a sequence
3136     *
3137     * @param   string  name of the sequence
3138     * @param   bool    when true missing sequences are automatic created
3139     *
3140     * @return  mixed   MDB2 Error Object or id
3141     *
3142     * @access  public
3143     */
3144    function nextID($seq_name, $ondemand = true)
3145    {
3146        return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
3147            'method not implemented', __FUNCTION__);
3148    }
3149
3150    // }}}
3151    // {{{ function lastInsertID($table = null, $field = null)
3152
3153    /**
3154     * Returns the autoincrement ID if supported or $id or fetches the current
3155     * ID in a sequence called: $table.(empty($field) ? '' : '_'.$field)
3156     *
3157     * @param   string  name of the table into which a new row was inserted
3158     * @param   string  name of the field into which a new row was inserted
3159     *
3160     * @return  mixed   MDB2 Error Object or id
3161     *
3162     * @access  public
3163     */
3164    function lastInsertID($table = null, $field = null)
3165    {
3166        return $this->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
3167            'method not implemented', __FUNCTION__);
3168    }
3169
3170    // }}}
3171    // {{{ function currID($seq_name)
3172
3173    /**
3174     * Returns the current id of a sequence
3175     *
3176     * @param   string  name of the sequence
3177     *
3178     * @return  mixed   MDB2 Error Object or id
3179     *
3180     * @access  public
3181     */
3182    function currID($seq_name)
3183    {
3184        $this->warnings[] = 'database does not support getting current
3185            sequence value, the sequence value was incremented';
3186        return $this->nextID($seq_name);
3187    }
3188
3189    // }}}
3190    // {{{ function queryOne($query, $type = null, $colnum = 0)
3191
3192    /**
3193     * Execute the specified query, fetch the value from the first column of
3194     * the first row of the result set and then frees
3195     * the result set.
3196     *
3197     * @param   string  the SELECT query statement to be executed.
3198     * @param   string  optional argument that specifies the expected
3199     *       datatype of the result set field, so that an eventual conversion
3200     *       may be performed. The default datatype is text, meaning that no
3201     *       conversion is performed
3202     * @param   int     the column number to fetch
3203     *
3204     * @return  mixed   MDB2_OK or field value on success, a MDB2 error on failure
3205     *
3206     * @access  public
3207     */
3208    function queryOne($query, $type = null, $colnum = 0)
3209    {
3210        $result = $this->query($query, $type);
3211        if (!MDB2::isResultCommon($result)) {
3212            return $result;
3213        }
3214
3215        $one = $result->fetchOne($colnum);
3216        $result->free();
3217        return $one;
3218    }
3219
3220    // }}}
3221    // {{{ function queryRow($query, $types = null, $fetchmode = MDB2_FETCHMODE_DEFAULT)
3222
3223    /**
3224     * Execute the specified query, fetch the values from the first
3225     * row of the result set into an array and then frees
3226     * the result set.
3227     *
3228     * @param   string  the SELECT query statement to be executed.
3229     * @param   array   optional array argument that specifies a list of
3230     *       expected datatypes of the result set columns, so that the eventual
3231     *       conversions may be performed. The default list of datatypes is
3232     *       empty, meaning that no conversion is performed.
3233     * @param   int     how the array data should be indexed
3234     *
3235     * @return  mixed   MDB2_OK or data array on success, a MDB2 error on failure
3236     *
3237     * @access  public
3238     */
3239    function queryRow($query, $types = null, $fetchmode = MDB2_FETCHMODE_DEFAULT)
3240    {
3241        $result = $this->query($query, $types);
3242        if (!MDB2::isResultCommon($result)) {
3243            return $result;
3244        }
3245
3246        $row = $result->fetchRow($fetchmode);
3247        $result->free();
3248        return $row;
3249    }
3250
3251    // }}}
3252    // {{{ function queryCol($query, $type = null, $colnum = 0)
3253
3254    /**
3255     * Execute the specified query, fetch the value from the first column of
3256     * each row of the result set into an array and then frees the result set.
3257     *
3258     * @param   string  the SELECT query statement to be executed.
3259     * @param   string  optional argument that specifies the expected
3260     *       datatype of the result set field, so that an eventual conversion
3261     *       may be performed. The default datatype is text, meaning that no
3262     *       conversion is performed
3263     * @param   int     the row number to fetch
3264     *
3265     * @return  mixed   MDB2_OK or data array on success, a MDB2 error on failure
3266     *
3267     * @access  public
3268     */
3269    function queryCol($query, $type = null, $colnum = 0)
3270    {
3271        $result = $this->query($query, $type);
3272        if (!MDB2::isResultCommon($result)) {
3273            return $result;
3274        }
3275
3276        $col = $result->fetchCol($colnum);
3277        $result->free();
3278        return $col;
3279    }
3280
3281    // }}}
3282    // {{{ function queryAll($query, $types = null, $fetchmode = MDB2_FETCHMODE_DEFAULT, $rekey = false, $force_array = false, $group = false)
3283
3284    /**
3285     * Execute the specified query, fetch all the rows of the result set into
3286     * a two dimensional array and then frees the result set.
3287     *
3288     * @param   string  the SELECT query statement to be executed.
3289     * @param   array   optional array argument that specifies a list of
3290     *       expected datatypes of the result set columns, so that the eventual
3291     *       conversions may be performed. The default list of datatypes is
3292     *       empty, meaning that no conversion is performed.
3293     * @param   int     how the array data should be indexed
3294     * @param   bool    if set to true, the $all will have the first
3295     *       column as its first dimension
3296     * @param   bool    used only when the query returns exactly
3297     *       two columns. If true, the values of the returned array will be
3298     *       one-element arrays instead of scalars.
3299     * @param   bool    if true, the values of the returned array is
3300     *       wrapped in another array.  If the same key value (in the first
3301     *       column) repeats itself, the values will be appended to this array
3302     *       instead of overwriting the existing values.
3303     *
3304     * @return  mixed   MDB2_OK or data array on success, a MDB2 error on failure
3305     *
3306     * @access  public
3307     */
3308    function queryAll($query, $types = null, $fetchmode = MDB2_FETCHMODE_DEFAULT,
3309        $rekey = false, $force_array = false, $group = false)
3310    {
3311        $result = $this->query($query, $types);
3312        if (!MDB2::isResultCommon($result)) {
3313            return $result;
3314        }
3315
3316        $all = $result->fetchAll($fetchmode, $rekey, $force_array, $group);
3317        $result->free();
3318        return $all;
3319    }
3320
3321    // }}}
3322}
3323
3324// }}}
3325// {{{ class MDB2_Result
3326
3327/**
3328 * The dummy class that all user space result classes should extend from
3329 *
3330 * @package     MDB2
3331 * @category    Database
3332 * @author      Lukas Smith <smith@pooteeweet.org>
3333 */
3334class MDB2_Result
3335{
3336}
3337
3338// }}}
3339// {{{ class MDB2_Result_Common extends MDB2_Result
3340
3341/**
3342 * The common result class for MDB2 result objects
3343 *
3344 * @package     MDB2
3345 * @category    Database
3346 * @author      Lukas Smith <smith@pooteeweet.org>
3347 */
3348class MDB2_Result_Common extends MDB2_Result
3349{
3350    // {{{ Variables (Properties)
3351
3352    var $db;
3353    var $result;
3354    var $rownum = -1;
3355    var $types = array();
3356    var $values = array();
3357    var $offset;
3358    var $offset_count = 0;
3359    var $limit;
3360    var $column_names;
3361
3362    // }}}
3363    // {{{ constructor: function __construct(&$db, &$result, $limit = 0, $offset = 0)
3364
3365    /**
3366     * Constructor
3367     */
3368    function __construct(&$db, &$result, $limit = 0, $offset = 0)
3369    {
3370        $this->db =& $db;
3371        $this->result =& $result;
3372        $this->offset = $offset;
3373        $this->limit = max(0, $limit - 1);
3374    }
3375
3376    // }}}
3377    // {{{ function MDB2_Result_Common(&$db, &$result, $limit = 0, $offset = 0)
3378
3379    /**
3380     * PHP 4 Constructor
3381     */
3382    function MDB2_Result_Common(&$db, &$result, $limit = 0, $offset = 0)
3383    {
3384        $this->__construct($db, $result, $limit, $offset);
3385    }
3386
3387    // }}}
3388    // {{{ function setResultTypes($types)
3389
3390    /**
3391     * Define the list of types to be associated with the columns of a given
3392     * result set.
3393     *
3394     * This function may be called before invoking fetchRow(), fetchOne(),
3395     * fetchCol() and fetchAll() so that the necessary data type
3396     * conversions are performed on the data to be retrieved by them. If this
3397     * function is not called, the type of all result set columns is assumed
3398     * to be text, thus leading to not perform any conversions.
3399     *
3400     * @param   array   variable that lists the
3401     *       data types to be expected in the result set columns. If this array
3402     *       contains less types than the number of columns that are returned
3403     *       in the result set, the remaining columns are assumed to be of the
3404     *       type text. Currently, the types clob and blob are not fully
3405     *       supported.
3406     *
3407     * @return  mixed   MDB2_OK on success, a MDB2 error on failure
3408     *
3409     * @access  public
3410     */
3411    function setResultTypes($types)
3412    {
3413        $load = $this->db->loadModule('Datatype', null, true);
3414        if (PEAR::isError($load)) {
3415            return $load;
3416        }
3417        $types = $this->db->datatype->checkResultTypes($types);
3418        if (PEAR::isError($types)) {
3419            return $types;
3420        }
3421        $this->types = $types;
3422        return MDB2_OK;
3423    }
3424
3425    // }}}
3426    // {{{ function seek($rownum = 0)
3427
3428    /**
3429     * Seek to a specific row in a result set
3430     *
3431     * @param   int     number of the row where the data can be found
3432     *
3433     * @return  mixed   MDB2_OK on success, a MDB2 error on failure
3434     *
3435     * @access  public
3436     */
3437    function seek($rownum = 0)
3438    {
3439        $target_rownum = $rownum - 1;
3440        if ($this->rownum > $target_rownum) {
3441            return $this->db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
3442                'seeking to previous rows not implemented', __FUNCTION__);
3443        }
3444        while ($this->rownum < $target_rownum) {
3445            $this->fetchRow();
3446        }
3447        return MDB2_OK;
3448    }
3449
3450    // }}}
3451    // {{{ function &fetchRow($fetchmode = MDB2_FETCHMODE_DEFAULT, $rownum = null)
3452
3453    /**
3454     * Fetch and return a row of data
3455     *
3456     * @param   int     how the array data should be indexed
3457     * @param   int     number of the row where the data can be found
3458     *
3459     * @return  int     data array on success, a MDB2 error on failure
3460     *
3461     * @access  public
3462     */
3463    function &fetchRow($fetchmode = MDB2_FETCHMODE_DEFAULT, $rownum = null)
3464    {
3465        $err =& $this->db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
3466            'method not implemented', __FUNCTION__);
3467        return $err;
3468    }
3469
3470    // }}}
3471    // {{{ function fetchOne($colnum = 0)
3472
3473    /**
3474     * fetch single column from the next row from a result set
3475     *
3476     * @param   int     the column number to fetch
3477     * @param   int     number of the row where the data can be found
3478     *
3479     * @return  string  data on success, a MDB2 error on failure
3480     *
3481     * @access  public
3482     */
3483    function fetchOne($colnum = 0, $rownum = null)
3484    {
3485        $fetchmode = is_numeric($colnum) ? MDB2_FETCHMODE_ORDERED : MDB2_FETCHMODE_ASSOC;
3486        $row = $this->fetchRow($fetchmode, $rownum);
3487        if (!is_array($row) || PEAR::isError($row)) {
3488            return $row;
3489        }
3490        if (!array_key_exists($colnum, $row)) {
3491            return $this->db->raiseError(MDB2_ERROR_TRUNCATED, null, null,
3492                'column is not defined in the result set: '.$colnum, __FUNCTION__);
3493        }
3494        return $row[$colnum];
3495    }
3496
3497    // }}}
3498    // {{{ function fetchCol($colnum = 0)
3499
3500    /**
3501     * Fetch and return a column from the current row pointer position
3502     *
3503     * @param   int     the column number to fetch
3504     *
3505     * @return  mixed   data array on success, a MDB2 error on failure
3506     *
3507     * @access  public
3508     */
3509    function fetchCol($colnum = 0)
3510    {
3511        $column = array();
3512        $fetchmode = is_numeric($colnum) ? MDB2_FETCHMODE_ORDERED : MDB2_FETCHMODE_ASSOC;
3513        $row = $this->fetchRow($fetchmode);
3514        if (is_array($row)) {
3515            if (!array_key_exists($colnum, $row)) {
3516                return $this->db->raiseError(MDB2_ERROR_TRUNCATED, null, null,
3517                    'column is not defined in the result set: '.$colnum, __FUNCTION__);
3518            }
3519            do {
3520                $column[] = $row[$colnum];
3521            } while (is_array($row = $this->fetchRow($fetchmode)));
3522        }
3523        if (PEAR::isError($row)) {
3524            return $row;
3525        }
3526        return $column;
3527    }
3528
3529    // }}}
3530    // {{{ function fetchAll($fetchmode = MDB2_FETCHMODE_DEFAULT, $rekey = false, $force_array = false, $group = false)
3531
3532    /**
3533     * Fetch and return all rows from the current row pointer position
3534     *
3535     * @param   int     $fetchmode  the fetch mode to use:
3536     *                            + MDB2_FETCHMODE_ORDERED
3537     *                            + MDB2_FETCHMODE_ASSOC
3538     *                            + MDB2_FETCHMODE_ORDERED | MDB2_FETCHMODE_FLIPPED
3539     *                            + MDB2_FETCHMODE_ASSOC | MDB2_FETCHMODE_FLIPPED
3540     * @param   bool    if set to true, the $all will have the first
3541     *       column as its first dimension
3542     * @param   bool    used only when the query returns exactly
3543     *       two columns. If true, the values of the returned array will be
3544     *       one-element arrays instead of scalars.
3545     * @param   bool    if true, the values of the returned array is
3546     *       wrapped in another array.  If the same key value (in the first
3547     *       column) repeats itself, the values will be appended to this array
3548     *       instead of overwriting the existing values.
3549     *
3550     * @return  mixed   data array on success, a MDB2 error on failure
3551     *
3552     * @access  public
3553     * @see     getAssoc()
3554     */
3555    function fetchAll($fetchmode = MDB2_FETCHMODE_DEFAULT, $rekey = false,
3556        $force_array = false, $group = false)
3557    {
3558        $all = array();
3559        $row = $this->fetchRow($fetchmode);
3560        if (PEAR::isError($row)) {
3561            return $row;
3562        } elseif (!$row) {
3563            return $all;
3564        }
3565
3566        $shift_array = $rekey ? false : null;
3567        if (!is_null($shift_array)) {
3568            if (is_object($row)) {
3569                $colnum = count(get_object_vars($row));
3570            } else {
3571                $colnum = count($row);
3572            }
3573            if ($colnum < 2) {
3574                return $this->db->raiseError(MDB2_ERROR_TRUNCATED, null, null,
3575                    'rekey feature requires atleast 2 column', __FUNCTION__);
3576            }
3577            $shift_array = (!$force_array && $colnum == 2);
3578        }
3579
3580        if ($rekey) {
3581            do {
3582                if (is_object($row)) {
3583                    $arr = get_object_vars($row);
3584                    $key = reset($arr);
3585                    unset($row->{$key});
3586                } else {
3587                    if ($fetchmode & MDB2_FETCHMODE_ASSOC) {
3588                        $key = reset($row);
3589                        unset($row[key($row)]);
3590                    } else {
3591                        $key = array_shift($row);
3592                    }
3593                    if ($shift_array) {
3594                        $row = array_shift($row);
3595                    }
3596                }
3597                if ($group) {
3598                    $all[$key][] = $row;
3599                } else {
3600                    $all[$key] = $row;
3601                }
3602            } while (($row = $this->fetchRow($fetchmode)));
3603        } elseif ($fetchmode & MDB2_FETCHMODE_FLIPPED) {
3604            do {
3605                foreach ($row as $key => $val) {
3606                    $all[$key][] = $val;
3607                }
3608            } while (($row = $this->fetchRow($fetchmode)));
3609        } else {
3610            do {
3611                $all[] = $row;
3612            } while (($row = $this->fetchRow($fetchmode)));
3613        }
3614
3615        return $all;
3616    }
3617
3618    // }}}
3619    // {{{ function rowCount()
3620    /**
3621     * Returns the actual row number that was last fetched (count from 0)
3622     * @return  int
3623     *
3624     * @access  public
3625     */
3626    function rowCount()
3627    {
3628        return $this->rownum + 1;
3629    }
3630
3631    // }}}
3632    // {{{ function numRows()
3633
3634    /**
3635     * Returns the number of rows in a result object
3636     *
3637     * @return  mixed   MDB2 Error Object or the number of rows
3638     *
3639     * @access  public
3640     */
3641    function numRows()
3642    {
3643        return $this->db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
3644            'method not implemented', __FUNCTION__);
3645    }
3646
3647    // }}}
3648    // {{{ function nextResult()
3649
3650    /**
3651     * Move the internal result pointer to the next available result
3652     *
3653     * @return  true on success, false if there is no more result set or an error object on failure
3654     *
3655     * @access  public
3656     */
3657    function nextResult()
3658    {
3659        return $this->db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
3660            'method not implemented', __FUNCTION__);
3661    }
3662
3663    // }}}
3664    // {{{ function getColumnNames()
3665
3666    /**
3667     * Retrieve the names of columns returned by the DBMS in a query result or
3668     * from the cache.
3669     *
3670     * @param   bool    If set to true the values are the column names,
3671     *                  otherwise the names of the columns are the keys.
3672     * @return  mixed   Array variable that holds the names of columns or an
3673     *                  MDB2 error on failure.
3674     *                  Some DBMS may not return any columns when the result set
3675     *                  does not contain any rows.
3676     *
3677     * @access  public
3678     */
3679    function getColumnNames($flip = false)
3680    {
3681        if (!isset($this->column_names)) {
3682            $result = $this->_getColumnNames();
3683            if (PEAR::isError($result)) {
3684                return $result;
3685            }
3686            $this->column_names = $result;
3687        }
3688        if ($flip) {
3689            return array_flip($this->column_names);
3690        }
3691        return $this->column_names;
3692    }
3693
3694    // }}}
3695    // {{{ function _getColumnNames()
3696
3697    /**
3698     * Retrieve the names of columns returned by the DBMS in a query result.
3699     *
3700     * @return  mixed   Array variable that holds the names of columns as keys
3701     *                  or an MDB2 error on failure.
3702     *                  Some DBMS may not return any columns when the result set
3703     *                  does not contain any rows.
3704     *
3705     * @access  private
3706     */
3707    function _getColumnNames()
3708    {
3709        return $this->db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
3710            'method not implemented', __FUNCTION__);
3711    }
3712
3713    // }}}
3714    // {{{ function numCols()
3715
3716    /**
3717     * Count the number of columns returned by the DBMS in a query result.
3718     *
3719     * @return  mixed   integer value with the number of columns, a MDB2 error
3720     *       on failure
3721     *
3722     * @access  public
3723     */
3724    function numCols()
3725    {
3726        return $this->db->raiseError(MDB2_ERROR_UNSUPPORTED, null, null,
3727            'method not implemented', __FUNCTION__);
3728    }
3729
3730    // }}}
3731    // {{{ function getResource()
3732
3733    /**
3734     * return the resource associated with the result object
3735     *
3736     * @return  resource
3737     *
3738     * @access  public
3739     */
3740    function getResource()
3741    {
3742        return $this->result;
3743    }
3744
3745    // }}}
3746    // {{{ function bindColumn($column, &$value, $type = null)
3747
3748    /**
3749     * Set bind variable to a column.
3750     *
3751     * @param   int     column number or name
3752     * @param   mixed   variable reference
3753     * @param   string  specifies the type of the field
3754     *
3755     * @return  mixed   MDB2_OK on success, a MDB2 error on failure
3756     *
3757     * @access  public
3758     */
3759    function bindColumn($column, &$value, $type = null)
3760    {
3761        if (!is_numeric($column)) {
3762            $column_names = $this->getColumnNames();
3763            if ($this->db->options['portability'] & MDB2_PORTABILITY_FIX_CASE) {
3764                if ($this->db->options['field_case'] == CASE_LOWER) {
3765                    $column = strtolower($column);
3766                } else {
3767                    $column = strtoupper($column);
3768                }
3769            }
3770            $column = $column_names[$column];
3771        }
3772        $this->values[$column] =& $value;
3773        if (!is_null($type)) {
3774            $this->types[$column] = $type;
3775        }
3776        return MDB2_OK;
3777    }
3778
3779    // }}}
3780    // {{{ function _assignBindColumns($row)
3781
3782    /**
3783     * Bind a variable to a value in the result row.
3784     *
3785     * @param   array   row data
3786     *
3787     * @return  mixed   MDB2_OK on success, a MDB2 error on failure
3788     *
3789     * @access  private
3790     */
3791    function _assignBindColumns($row)
3792    {
3793        $row = array_values($row);
3794        foreach ($row as $column => $value) {
3795            if (array_key_exists($column, $this->values)) {
3796                $this->values[$column] = $value;
3797            }
3798        }
3799        return MDB2_OK;
3800    }
3801
3802    // }}}
3803    // {{{ function free()
3804
3805    /**
3806     * Free the internal resources associated with result.
3807     *
3808     * @return  bool    true on success, false if result is invalid
3809     *
3810     * @access  public
3811     */
3812    function free()
3813    {
3814        $this->result = false;
3815        return MDB2_OK;
3816    }
3817
3818    // }}}
3819}
3820
3821// }}}
3822// {{{ class MDB2_Row
3823
3824/**
3825 * The simple class that accepts row data as an array
3826 *
3827 * @package     MDB2
3828 * @category    Database
3829 * @author      Lukas Smith <smith@pooteeweet.org>
3830 */
3831class MDB2_Row
3832{
3833    // {{{ constructor: function __construct(&$row)
3834
3835    /**
3836     * constructor
3837     *
3838     * @param   resource    row data as array
3839     */
3840    function __construct(&$row)
3841    {
3842        foreach ($row as $key => $value) {
3843            $this->$key = &$row[$key];
3844        }
3845    }
3846
3847    // }}}
3848    // {{{ function MDB2_Row(&$row)
3849
3850    /**
3851     * PHP 4 Constructor
3852     *
3853     * @param   resource    row data as array
3854     */
3855    function MDB2_Row(&$row)
3856    {
3857        $this->__construct($row);
3858    }
3859
3860    // }}}
3861}
3862
3863// }}}
3864// {{{ class MDB2_Statement_Common
3865
3866/**
3867 * The common statement class for MDB2 statement objects
3868 *
3869 * @package     MDB2
3870 * @category    Database
3871 * @author      Lukas Smith <smith@pooteeweet.org>
3872 */
3873class MDB2_Statement_Common
3874{
3875    // {{{ Variables (Properties)
3876
3877    var $db;
3878    var $statement;
3879    var $query;
3880    var $result_types;
3881    var $types;
3882    var $values = array();
3883    var $limit;
3884    var $offset;
3885    var $is_manip;
3886
3887    // }}}
3888    // {{{ constructor: function __construct(&$db, &$statement, $positions, $query, $types, $result_types, $is_manip = false, $limit = null, $offset = null)
3889
3890    /**
3891     * Constructor
3892     */
3893    function __construct(&$db, &$statement, $positions, $query, $types, $result_types, $is_manip = false, $limit = null, $offset = null)
3894    {
3895        $this->db =& $db;
3896        $this->statement =& $statement;
3897        $this->positions = $positions;
3898        $this->query = $query;
3899        $this->types = (array)$types;
3900        $this->result_types = (array)$result_types;
3901        $this->limit = $limit;
3902        $this->is_manip = $is_manip;
3903        $this->offset = $offset;
3904    }
3905
3906    // }}}
3907    // {{{ function MDB2_Statement_Common(&$db, &$statement, $positions, $query, $types, $result_types, $is_manip = false, $limit = null, $offset = null)
3908
3909    /**
3910     * PHP 4 Constructor
3911     */
3912    function MDB2_Statement_Common(&$db, &$statement, $positions, $query, $types, $result_types, $is_manip = false, $limit = null, $offset = null)
3913    {
3914        $this->__construct($db, $statement, $positions, $query, $types, $result_types, $is_manip, $limit, $offset);
3915    }
3916
3917    // }}}
3918    // {{{ function bindValue($parameter, &$value, $type = null)
3919
3920    /**
3921     * Set the value of a parameter of a prepared query.
3922     *
3923     * @param   int     the order number of the parameter in the query
3924     *       statement. The order number of the first parameter is 1.
3925     * @param   mixed   value that is meant to be assigned to specified
3926     *       parameter. The type of the value depends on the $type argument.
3927     * @param   string  specifies the type of the field
3928     *
3929     * @return  mixed   MDB2_OK on success, a MDB2 error on failure
3930     *
3931     * @access  public
3932     */
3933    function bindValue($parameter, $value, $type = null)
3934    {
3935        if (!is_numeric($parameter)) {
3936            $parameter = preg_replace('/^:(.*)$/', '\\1', $parameter);
3937        }
3938        if (!in_array($parameter, $this->positions)) {
3939            return $this->db->raiseError(MDB2_ERROR_NOT_FOUND, null, null,
3940                'Unable to bind to missing placeholder: '.$parameter, __FUNCTION__);
3941        }
3942        $this->values[$parameter] = $value;
3943        if (!is_null($type)) {
3944            $this->types[$parameter] = $type;
3945        }
3946        return MDB2_OK;
3947    }
3948
3949    // }}}
3950    // {{{ function bindValueArray($values, $types = null)
3951
3952    /**
3953     * Set the values of multiple a parameter of a prepared query in bulk.
3954     *
3955     * @param   array   specifies all necessary information
3956     *       for bindValue() the array elements must use keys corresponding to
3957     *       the number of the position of the parameter.
3958     * @param   array   specifies the types of the fields
3959     *
3960     * @return  mixed   MDB2_OK on success, a MDB2 error on failure
3961     *
3962     * @access  public
3963     * @see     bindParam()
3964     */
3965    function bindValueArray($values, $types = null)
3966    {
3967        $types = is_array($types) ? array_values($types) : array_fill(0, count($values), null);
3968        $parameters = array_keys($values);
3969        foreach ($parameters as $key => $parameter) {
3970            $err = $this->bindValue($parameter, $values[$parameter], $types[$key]);
3971            if (PEAR::isError($err)) {
3972                return $err;
3973            }
3974        }
3975        return MDB2_OK;
3976    }
3977
3978    // }}}
3979    // {{{ function bindParam($parameter, &$value, $type = null)
3980
3981    /**
3982     * Bind a variable to a parameter of a prepared query.
3983     *
3984     * @param   int     the order number of the parameter in the query
3985     *       statement. The order number of the first parameter is 1.
3986     * @param   mixed   variable that is meant to be bound to specified
3987     *       parameter. The type of the value depends on the $type argument.
3988     * @param   string  specifies the type of the field
3989     *
3990     * @return  mixed   MDB2_OK on success, a MDB2 error on failure
3991     *
3992     * @access  public
3993     */
3994    function bindParam($parameter, &$value, $type = null)
3995    {
3996        if (!is_numeric($parameter)) {
3997            $parameter = preg_replace('/^:(.*)$/', '\\1', $parameter);
3998        }
3999        if (!in_array($parameter, $this->positions)) {
4000            return $this->db->raiseError(MDB2_ERROR_NOT_FOUND, null, null,
4001                'Unable to bind to missing placeholder: '.$parameter, __FUNCTION__);
4002        }
4003        $this->values[$parameter] =& $value;
4004        if (!is_null($type)) {
4005            $this->types[$parameter] = $type;
4006        }
4007        return MDB2_OK;
4008    }
4009
4010    // }}}
4011    // {{{ function bindParamArray(&$values, $types = null)
4012
4013    /**
4014     * Bind the variables of multiple a parameter of a prepared query in bulk.
4015     *
4016     * @param   array   specifies all necessary information
4017     *       for bindParam() the array elements must use keys corresponding to
4018     *       the number of the position of the parameter.
4019     * @param   array   specifies the types of the fields
4020     *
4021     * @return  mixed   MDB2_OK on success, a MDB2 error on failure
4022     *
4023     * @access  public
4024     * @see     bindParam()
4025     */
4026    function bindParamArray(&$values, $types = null)
4027    {
4028        $types = is_array($types) ? array_values($types) : array_fill(0, count($values), null);
4029        $parameters = array_keys($values);
4030        foreach ($parameters as $key => $parameter) {
4031            $err = $this->bindParam($parameter, $values[$parameter], $types[$key]);
4032            if (PEAR::isError($err)) {
4033                return $err;
4034            }
4035        }
4036        return MDB2_OK;
4037    }
4038
4039    // }}}
4040    // {{{ function &execute($values = null, $result_class = true, $result_wrap_class = false)
4041
4042    /**
4043     * Execute a prepared query statement.
4044     *
4045     * @param   array   specifies all necessary information
4046     *       for bindParam() the array elements must use keys corresponding to
4047     *       the number of the position of the parameter.
4048     * @param   mixed   specifies which result class to use
4049     * @param   mixed   specifies which class to wrap results in
4050     *
4051     * @return  mixed   a result handle or MDB2_OK on success, a MDB2 error on failure
4052     *
4053     * @access  public
4054     */
4055    function &execute($values = null, $result_class = true, $result_wrap_class = false)
4056    {
4057        if (is_null($this->positions)) {
4058            return $this->db->raiseError(MDB2_ERROR, null, null,
4059                'Prepared statement has already been freed', __FUNCTION__);
4060        }
4061
4062        $values = (array)$values;
4063        if (!empty($values)) {
4064            $err = $this->bindValueArray($values);
4065            if (PEAR::isError($err)) {
4066                return $this->db->raiseError(MDB2_ERROR, null, null,
4067                                            'Binding Values failed with message: ' . $err->getMessage(), __FUNCTION__);
4068            }
4069        }
4070        $result =& $this->_execute($result_class, $result_wrap_class);
4071        return $result;
4072    }
4073
4074    // }}}
4075    // {{{ function &_execute($result_class = true, $result_wrap_class = false)
4076
4077    /**
4078     * Execute a prepared query statement helper method.
4079     *
4080     * @param   mixed   specifies which result class to use
4081     * @param   mixed   specifies which class to wrap results in
4082     *
4083     * @return  mixed   MDB2_Result or integer on success, a MDB2 error on failure
4084     *
4085     * @access  private
4086     */
4087    function &_execute($result_class = true, $result_wrap_class = false)
4088    {
4089        $this->last_query = $this->query;
4090        $query = '';
4091        $last_position = 0;
4092        foreach ($this->positions as $current_position => $parameter) {
4093            if (!array_key_exists($parameter, $this->values)) {
4094                return $this->db->raiseError(MDB2_ERROR_NOT_FOUND, null, null,
4095                    'Unable to bind to missing placeholder: '.$parameter, __FUNCTION__);
4096            }
4097            $value = $this->values[$parameter];
4098            $query.= substr($this->query, $last_position, $current_position - $last_position);
4099            if (!isset($value)) {
4100                $value_quoted = 'NULL';
4101            } else {
4102                $type = !empty($this->types[$parameter]) ? $this->types[$parameter] : null;
4103                $value_quoted = $this->db->quote($value, $type);
4104                if (PEAR::isError($value_quoted)) {
4105                    return $value_quoted;
4106                }
4107            }
4108            $query.= $value_quoted;
4109            $last_position = $current_position + 1;
4110        }
4111        $query.= substr($this->query, $last_position);
4112
4113        $this->db->offset = $this->offset;
4114        $this->db->limit = $this->limit;
4115        if ($this->is_manip) {
4116            $result = $this->db->exec($query);
4117        } else {
4118            $result =& $this->db->query($query, $this->result_types, $result_class, $result_wrap_class);
4119        }
4120        return $result;
4121    }
4122
4123    // }}}
4124    // {{{ function free()
4125
4126    /**
4127     * Release resources allocated for the specified prepared query.
4128     *
4129     * @return  mixed   MDB2_OK on success, a MDB2 error on failure
4130     *
4131     * @access  public
4132     */
4133    function free()
4134    {
4135        if (is_null($this->positions)) {
4136            return $this->db->raiseError(MDB2_ERROR, null, null,
4137                'Prepared statement has already been freed', __FUNCTION__);
4138        }
4139
4140        $this->statement = null;
4141        $this->positions = null;
4142        $this->query = null;
4143        $this->types = null;
4144        $this->result_types = null;
4145        $this->limit = null;
4146        $this->is_manip = null;
4147        $this->offset = null;
4148        $this->values = null;
4149
4150        return MDB2_OK;
4151    }
4152
4153    // }}}
4154}
4155
4156// }}}
4157// {{{ class MDB2_Module_Common
4158
4159/**
4160 * The common modules class for MDB2 module objects
4161 *
4162 * @package     MDB2
4163 * @category    Database
4164 * @author      Lukas Smith <smith@pooteeweet.org>
4165 */
4166class MDB2_Module_Common
4167{
4168    // {{{ Variables (Properties)
4169
4170    /**
4171     * contains the key to the global MDB2 instance array of the associated
4172     * MDB2 instance
4173     *
4174     * @var     int
4175     * @access  protected
4176     */
4177    var $db_index;
4178
4179    // }}}
4180    // {{{ constructor: function __construct($db_index)
4181
4182    /**
4183     * Constructor
4184     */
4185    function __construct($db_index)
4186    {
4187        $this->db_index = $db_index;
4188    }
4189
4190    // }}}
4191    // {{{ function MDB2_Module_Common($db_index)
4192
4193    /**
4194     * PHP 4 Constructor
4195     */
4196    function MDB2_Module_Common($db_index)
4197    {
4198        $this->__construct($db_index);
4199    }
4200
4201    // }}}
4202    // {{{ function &getDBInstance()
4203
4204    /**
4205     * Get the instance of MDB2 associated with the module instance
4206     *
4207     * @return  object  MDB2 instance or a MDB2 error on failure
4208     *
4209     * @access  public
4210     */
4211    function &getDBInstance()
4212    {
4213        if (isset($GLOBALS['_MDB2_databases'][$this->db_index])) {
4214            $result =& $GLOBALS['_MDB2_databases'][$this->db_index];
4215        } else {
4216            $result =& MDB2::raiseError(MDB2_ERROR_NOT_FOUND, null, null,
4217                'could not find MDB2 instance');
4218        }
4219        return $result;
4220    }
4221
4222    // }}}
4223}
4224
4225// }}}
4226// {{{ function MDB2_closeOpenTransactions()
4227
4228/**
4229 * Close any open transactions form persistent connections
4230 *
4231 * @return  void
4232 *
4233 * @access  public
4234 */
4235
4236function MDB2_closeOpenTransactions()
4237{
4238    reset($GLOBALS['_MDB2_databases']);
4239    while (next($GLOBALS['_MDB2_databases'])) {
4240        $key = key($GLOBALS['_MDB2_databases']);
4241        if ($GLOBALS['_MDB2_databases'][$key]->opened_persistent
4242            && $GLOBALS['_MDB2_databases'][$key]->in_transaction
4243        ) {
4244            $GLOBALS['_MDB2_databases'][$key]->rollback();
4245        }
4246    }
4247}
4248
4249// }}}
4250// {{{ function MDB2_defaultDebugOutput(&$db, $scope, $message, $is_manip = null)
4251
4252/**
4253 * default debug output handler
4254 *
4255 * @param   object  reference to an MDB2 database object
4256 * @param   string  usually the method name that triggered the debug call:
4257 *                  for example 'query', 'prepare', 'execute', 'parameters',
4258 *                  'beginTransaction', 'commit', 'rollback'
4259 * @param   string  message that should be appended to the debug variable
4260 * @param   array   contains context information about the debug() call
4261 *                  common keys are: is_manip, time, result etc.
4262 *
4263 * @return  void|string optionally return a modified message, this allows
4264 *                      rewriting a query before being issued or prepared
4265 *
4266 * @access  public
4267 */
4268function MDB2_defaultDebugOutput(&$db, $scope, $message, $context = array())
4269{
4270    $db->debug_output.= $scope.'('.$db->db_index.'): ';
4271    $db->debug_output.= $message.$db->getOption('log_line_break');
4272    return $message;
4273}
4274
4275// }}}
4276?>
Note: See TracBrowser for help on using the repository browser.