lib/WikiDB/adodb/adodb-pear.inc.php

   1 <?php
   2 /**
   3  * @version V4.22 15 Apr 2004 (c) 2000-2004 John Lim (jlim@natsoft.com.my). All rights reserved.
   4  * Released under both BSD license and Lesser GPL library license.
   5  * Whenever there is any discrepancy between the two licenses,
   6  * the BSD license will take precedence.
   7  *
   8  * Set tabs to 4 for best viewing.
   9  *
  10  * PEAR DB Emulation Layer for ADODB.
  11  *
  12  * The following code is modelled on PEAR DB code by Stig Bakken <ssb@fast.no>                                                             |
  13  * and Tomas V.V.Cox <cox@idecnet.com>. Portions (c)1997-2002 The PHP Group.
  14  */
  15
  16  /*
  17  We support:
  18
  19  DB_Common
  20  ---------
  21      query - returns PEAR_Error on error
  22     limitQuery - return PEAR_Error on error
  23     prepare - does not return PEAR_Error on error
  24     execute - does not return PEAR_Error on error
  25     setFetchMode - supports ASSOC and ORDERED
  26     errorNative
  27     quote
  28     nextID
  29     disconnect
  30
  31  DB_Result
  32  ---------
  33      numRows - returns -1 if not supported
  34     numCols
  35     fetchInto - does not support passing of fetchmode
  36     fetchRows - does not support passing of fetchmode
  37     free
  38  */
  39
  40 define('ADODB_PEAR',dirname(__FILE__));
  41 include_once "PEAR.php";
  42 include_once ADODB_PEAR."/adodb-errorpear.inc.php";
  43 include_once ADODB_PEAR."/adodb.inc.php";
  44
  45 if (!defined('DB_OK')) {
  46 define("DB_OK", 1);
  47 define("DB_ERROR",-1);
  48 /**
  49  * This is a special constant that tells DB the user hasn't specified
  50  * any particular get mode, so the default should be used.
  51  */
  52
  53 define('DB_FETCHMODE_DEFAULT', 0);
  54
  55 /**
  56  * Column data indexed by numbers, ordered from 0 and up
  57  */
  58
  59 define('DB_FETCHMODE_ORDERED', 1);
  60
  61 /**
  62  * Column data indexed by column names
  63  */
  64
  65 define('DB_FETCHMODE_ASSOC', 2);
  66
  67 /* for compatibility */
  68
  69 define('DB_GETMODE_ORDERED', DB_FETCHMODE_ORDERED);
  70 define('DB_GETMODE_ASSOC',   DB_FETCHMODE_ASSOC);
  71
  72 /**
  73  * these are constants for the tableInfo-function
  74  * they are bitwised or'ed. so if there are more constants to be defined
  75  * in the future, adjust DB_TABLEINFO_FULL accordingly
  76  */
  77
  78 define('DB_TABLEINFO_ORDER', 1);
  79 define('DB_TABLEINFO_ORDERTABLE', 2);
  80 define('DB_TABLEINFO_FULL', 3);
  81 }
  82
  83 /**
  84  * The main "DB" class is simply a container class with some static
  85  * methods for creating DB objects as well as some utility functions
  86  * common to all parts of DB.
  87  *
  88  */
  89
  90 class DB
  91 {
  92     /**
  93      * Create a new DB object for the specified database type
  94      *
  95      * @param $type string database type, for example "mysql"
  96      *
  97      * @return object a newly created DB object, or a DB error code on
  98      * error
  99      */
 100
 101     function &factory($type)
 102     {
 103         include_once(ADODB_DIR."/drivers/adodb-$type.inc.php");
 104         $obj = &NewADOConnection($type);
 105         if (!is_object($obj)) $obj =& new PEAR_Error('Unknown Database Driver: '.$dsninfo['phptype'],-1);
 106         return $obj;
 107     }
 108
 109     /**
 110      * Create a new DB object and connect to the specified database
 111      *
 112      * @param $dsn mixed "data source name", see the DB::parseDSN
 113      * method for a description of the dsn format.  Can also be
 114      * specified as an array of the format returned by DB::parseDSN.
 115      *
 116      * @param $options mixed if boolean (or scalar), tells whether
 117      * this connection should be persistent (for backends that support
 118      * this).  This parameter can also be an array of options, see
 119      * DB_common::setOption for more information on connection
 120      * options.
 121      *
 122      * @return object a newly created DB connection object, or a DB
 123      * error object on error
 124      *
 125      * @see DB::parseDSN
 126      * @see DB::isError
 127      */
 128     function &connect($dsn, $options = false)
 129     {
 130         if (is_array($dsn)) {
 131             $dsninfo = $dsn;
 132         } else {
 133             $dsninfo = DB::parseDSN($dsn);
 134         }
 135         switch ($dsninfo["phptype"]) {
 136             case 'pgsql':       $type = 'postgres7'; break;
 137             case 'ifx':         $type = 'informix9'; break;
 138             default:            $type = $dsninfo["phptype"]; break;
 139         }
 140
 141         if (is_array($options) && isset($options["debug"]) &&
 142             $options["debug"] >= 2) {
 143             // expose php errors with sufficient debug level
 144              @include_once("adodb-$type.inc.php");
 145         } else {
 146              @include_once("adodb-$type.inc.php");
 147         }
 148
 149         @$obj =& NewADOConnection($type);
 150         if (!is_object($obj)) {
 151             $obj =& new PEAR_Error('Unknown Database Driver: '.$dsninfo['phptype'],-1);
 152             return $obj;
 153         }
 154         if (is_array($options)) {
 155             foreach($options as $k => $v) {
 156                 switch(strtolower($k)) {
 157                 case 'persistent':      $persist = $v; break;
 158                 #ibase
 159                 case 'dialect':         $obj->dialect = $v; break;
 160                 case 'charset':         $obj->charset = $v; break;
 161                 case 'buffers':         $obj->buffers = $v; break;
 162                 #ado
 163                 case 'charpage':        $obj->charPage = $v; break;
 164                 #mysql
 165                 case 'clientflags': $obj->clientFlags = $v; break;
 166                 }
 167             }
 168         } else {
 169                $persist = false;
 170         }
 171
 172         if (isset($dsninfo['socket'])) $dsninfo['hostspec'] .= ':'.$dsninfo['socket'];
 173         else if (isset($dsninfo['port'])) $dsninfo['hostspec'] .= ':'.$dsninfo['port'];
 174
 175         if($persist) $ok = $obj->PConnect($dsninfo['hostspec'], $dsninfo['username'],$dsninfo['password'],$dsninfo['database']);
 176         else  $ok = $obj->Connect($dsninfo['hostspec'], $dsninfo['username'],$dsninfo['password'],$dsninfo['database']);
 177
 178         if (!$ok) $obj = ADODB_PEAR_Error();
 179         return $obj;
 180     }
 181
 182     /**
 183      * Return the DB API version
 184      *
 185      * @return int the DB API version number
 186      */
 187     function apiVersion()
 188     {
 189         return 2;
 190     }
 191
 192     /**
 193      * Tell whether a result code from a DB method is an error
 194      *
 195      * @param $value int result code
 196      *
 197      * @return bool whether $value is an error
 198      */
 199     function isError($value)
 200     {
 201         return (is_object($value) &&
 202                         (strtolower(get_class($value)) == 'db_error' ||
 203                  is_subclass_of($value, 'db_error')));
 204     }
 205
 206     /**
 207      * Tell whether a result code from a DB method is a warning.
 208      * Warnings differ from errors in that they are generated by DB,
 209      * and are not fatal.
 210      *
 211      * @param $value mixed result value
 212      *
 213      * @return bool whether $value is a warning
 214      */
 215     function isWarning($value)
 216     {
 217         return is_object($value) &&
 218                     (strtolower(get_class( $value )) == "db_warning" ||
 219              is_subclass_of($value, "db_warning"));
 220     }
 221
 222     /**
 223      * Parse a data source name
 224      *
 225      * @param $dsn string Data Source Name to be parsed
 226      *
 227      * @return array an associative array with the following keys:
 228      *
 229      *  phptype: Database backend used in PHP (mysql, odbc etc.)
 230      *  dbsyntax: Database used with regards to SQL syntax etc.
 231      *  protocol: Communication protocol to use (tcp, unix etc.)
 232      *  hostspec: Host specification (hostname[:port])
 233      *  database: Database to use on the DBMS server
 234      *  username: User name for login
 235      *  password: Password for login
 236      *
 237      * The format of the supplied DSN is in its fullest form:
 238      *
 239      *  phptype(dbsyntax)://username:password@protocol+hostspec/database
 240      *
 241      * Most variations are allowed:
 242      *
 243      *  phptype://username:password@protocol+hostspec:110//usr/db_file.db
 244      *  phptype://username:password@hostspec/database_name
 245      *  phptype://username:password@hostspec
 246      *  phptype://username@hostspec
 247      *  phptype://hostspec/database
 248      *  phptype://hostspec
 249      *  phptype(dbsyntax)
 250      *  phptype
 251      *
 252      * @author Tomas V.V.Cox <cox@idecnet.com>
 253      */
 254     function parseDSN($dsn)
 255     {
 256         if (is_array($dsn)) {
 257             return $dsn;
 258         }
 259
 260         $parsed = array(
 261             'phptype'  => false,
 262             'dbsyntax' => false,
 263             'protocol' => false,
 264             'hostspec' => false,
 265             'database' => false,
 266             'username' => false,
 267             'password' => false
 268         );
 269
 270         // Find phptype and dbsyntax
 271         if (($pos = strpos($dsn, '://')) !== false) {
 272             $str = substr($dsn, 0, $pos);
 273             $dsn = substr($dsn, $pos + 3);
 274         } else {
 275             $str = $dsn;
 276             $dsn = NULL;
 277         }
 278
 279         // Get phptype and dbsyntax
 280         // $str => phptype(dbsyntax)
 281         if (preg_match('|^(.+?)\((.*?)\)$|', $str, $arr)) {
 282             $parsed['phptype'] = $arr[1];
 283             $parsed['dbsyntax'] = (empty($arr[2])) ? $arr[1] : $arr[2];
 284         } else {
 285             $parsed['phptype'] = $str;
 286             $parsed['dbsyntax'] = $str;
 287         }
 288
 289         if (empty($dsn)) {
 290             return $parsed;
 291         }
 292
 293         // Get (if found): username and password
 294         // $dsn => username:password@protocol+hostspec/database
 295         if (($at = strpos($dsn,'@')) !== false) {
 296             $str = substr($dsn, 0, $at);
 297             $dsn = substr($dsn, $at + 1);
 298             if (($pos = strpos($str, ':')) !== false) {
 299                 $parsed['username'] = urldecode(substr($str, 0, $pos));
 300                 $parsed['password'] = urldecode(substr($str, $pos + 1));
 301             } else {
 302                 $parsed['username'] = urldecode($str);
 303             }
 304         }
 305
 306         // Find protocol and hostspec
 307         // $dsn => protocol+hostspec/database
 308         if (($pos=strpos($dsn, '/')) !== false) {
 309             $str = substr($dsn, 0, $pos);
 310             $dsn = substr($dsn, $pos + 1);
 311         } else {
 312             $str = $dsn;
 313             $dsn = NULL;
 314         }
 315
 316         // Get protocol + hostspec
 317         // $str => protocol+hostspec
 318         if (($pos=strpos($str, '+')) !== false) {
 319             $parsed['protocol'] = substr($str, 0, $pos);
 320             $parsed['hostspec'] = urldecode(substr($str, $pos + 1));
 321         } else {
 322             $parsed['hostspec'] = urldecode($str);
 323         }
 324
 325         // Get dabase if any
 326         // $dsn => database
 327         if (!empty($dsn)) {
 328             $parsed['database'] = $dsn;
 329         }
 330
 331         return $parsed;
 332     }
 333
 334     /**
 335      * Load a PHP database extension if it is not loaded already.
 336      *
 337      * @access public
 338      *
 339      * @param $name the base name of the extension (without the .so or
 340      * .dll suffix)
 341      *
 342      * @return bool true if the extension was already or successfully
 343      * loaded, false if it could not be loaded
 344      */
 345     function assertExtension($name)
 346     {
 347         if (!extension_loaded($name)) {
 348             $dlext = (strncmp(PHP_OS,'WIN',3) === 0) ? '.dll' : '.so';
 349             @dl($name . $dlext);
 350         }
 351         if (!extension_loaded($name)) {
 352             return false;
 353         }
 354         return true;
 355     }
 356 }
 357
 358 ?>