Home | Classes | Modules | Annotated | Functions | Files

Creole.php

Go to the documentation of this file.

<?php
/*
 *  $Id: Creole.php,v 1.6 2004/05/22 13:40:28 micha Exp $
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * This software consists of voluntary contributions made by many individuals
 * and is licensed under the LGPL. For more information please see
 * <http://creole.phpdb.org>.
 */

include_once 'creole/SQLException.php';
include_once 'creole/Connection.php';

define('CREOLE_ERROR',                     -1);
define('CREOLE_ERROR_SYNTAX',              -2);
define('CREOLE_ERROR_CONSTRAINT',          -3);
define('CREOLE_ERROR_NOT_FOUND',           -4);
define('CREOLE_ERROR_ALREADY_EXISTS',      -5);
define('CREOLE_ERROR_UNSUPPORTED',         -6);
define('CREOLE_ERROR_MISMATCH',            -7);
define('CREOLE_ERROR_INVALID',             -8);
define('CREOLE_ERROR_NOT_CAPABLE',         -9);
define('CREOLE_ERROR_TRUNCATED',          -10);
define('CREOLE_ERROR_INVALID_NUMBER',     -11);
define('CREOLE_ERROR_INVALID_DATE',       -12);
define('CREOLE_ERROR_DIVZERO',            -13);
define('CREOLE_ERROR_NODBSELECTED',       -14);
define('CREOLE_ERROR_CANNOT_CREATE',      -15);
define('CREOLE_ERROR_CANNOT_DELETE',      -16);
define('CREOLE_ERROR_CANNOT_DROP',        -17);
define('CREOLE_ERROR_NOSUCHTABLE',        -18);
define('CREOLE_ERROR_NOSUCHFIELD',        -19);
define('CREOLE_ERROR_NEED_MORE_DATA',     -20);
define('CREOLE_ERROR_NOT_LOCKED',         -21);
define('CREOLE_ERROR_VALUE_COUNT_ON_ROW', -22);
define('CREOLE_ERROR_INVALID_DSN',        -23);
define('CREOLE_ERROR_CONNECT_FAILED',     -24);
define('CREOLE_ERROR_EXTENSION_NOT_FOUND',-25);
define('CREOLE_ERROR_ACCESS_VIOLATION',   -26);
define('CREOLE_ERROR_NOSUCHDB',           -27);
define('CREOLE_ERROR_CONSTRAINT_NOT_NULL',-29);

// static:
// track errors is used by drivers to get better error messages
// make sure it's set.

@ini_set('track_errors', true);

class Creole
{
  function PERSISTENT() { return 1; }
  function NO_ASSOC_LOWER() { return 16; }

  var $driverMap = array
      (
        'mysql' => 'creole.drivers.mysql.MySQLConnection',
        'pgsql' => 'creole.drivers.pgsql.PgSQLConnection',
        'mssql' => 'creole.drivers.mssql.MSSQLConnection',
      );
      /*
        'sqlite' => 'creole.drivers.sqlite.SQLiteConnection',
        'oracle' => 'creole.drivers.oracle.OCI8Connection',
      */

  function registerDriver($phptype, $dotpath)
  {
    $self =& Creole::getInstance();
    $self->driverMap[$phptype] = $dotpath;
  }

  function deregisterDriver($phptype)
  {
    $self =& Creole::getInstance();
    unset($self->driverMap[$phptype]);
  }

  function getDriver($phptype)
  {
    $self =& Creole::getInstance();

    if (isset($self->driverMap[$phptype])) {
      return $self->driverMap[$phptype];
    } else {
      return null;
    }
  }

  function getConnection($dsn, $flags = 0)
  {
    if (is_array($dsn)) {
      $dsninfo = $dsn;
    } else {
      $dsninfo = Creole::parseDSN($dsn);
    }

    $self =& Creole::getInstance();

    // support "catchall" drivers which will themselves handle the details of connecting
    // using the proper RDBMS driver.
    if (isset($self->driverMap['*'])) {
      $type = '*';
    }
    else
    {
      $type = $dsninfo['phptype'];
      if (! isset($self->driverMap[$type])) {
        return new SQLException(CREOLE_ERROR_NOT_FOUND, "No driver has been registered to handle connection type: $type");
      }
    }

    // may need to make this more complex if we add support
    // for 'dbsyntax'
    $clazz = Creole::import($self->driverMap[$type]);

    if (Creole::isError($clazz)) {
      return $clazz;
    }

    $obj = new $clazz();

    if (! is_a($obj, 'Connection')) {
      return new SQLException(CREOLE_ERROR_NOT_FOUND, "Class does not implement creole.Connection interface: $clazz");
    }

    if (($e = $obj->connect($dsninfo, $flags)) !== true) {
      $e->setUserInfo($dsninfo);
      return $e;
    }

    return $obj;
  }

  function parseDSN($dsn)
  {
    if (is_array($dsn)) {
        return $dsn;
    }

    $parsed = array(
        'phptype'  => null,
        'username' => null,
        'password' => null,
        'protocol' => null,
        'hostspec' => null,
        'port'     => null,
        'socket'   => null,
        'database' => null
    );

    $info = parse_url($dsn);

    if (count($info) === 1) { // if there's only one element in result, then it must be the phptype
        $parsed['phptype'] = array_pop($info);
        return $parsed;
    }

    // some values can be copied directly
    $parsed['phptype'] = @$info['scheme'];
    $parsed['username'] = @$info['user'];
    $parsed['password'] = @$info['pass'];
    $parsed['port'] = @$info['port'];

    $host = @$info['host'];
    if (false !== ($pluspos = strpos($host, '+'))) {
        $parsed['protocol'] = substr($host,0,$pluspos);
        if ($parsed['protocol'] === 'unix') {
            $parsed['socket'] = substr($host,$pluspos+1);
        } else {
            $parsed['hostspec'] = substr($host,$pluspos+1);
        }
    } else {
        $parsed['hostspec'] = $host;
    }

    if (isset($info['path'])) {
        $parsed['database'] = substr($info['path'], 1); // remove first char, which is '/'
    }

    if (isset($info['query'])) {
            $opts = explode('&', $info['query']);
            foreach ($opts as $opt) {
                list($key, $value) = explode('=', $opt);
                if (!isset($parsed[$key])) { // don't allow params overwrite
                    $parsed[$key] = urldecode($value);
                }
            }
    }

    return $parsed;
  }

  function import($class)
  {
    if (! class_exists($class))
    {
      $path = strtr($class, '.', DIRECTORY_SEPARATOR) . '.php';
      $ret = @(include_once($path));
      if ($ret === false) {
        return new SQLException(CREOLE_ERROR_NOT_FOUND, "Unable to load driver class: " . $class);
      }

      // get just classname ('path.to.ClassName' -> 'ClassName')
      $pos = strrpos($class, '.');
      if ($pos !== false) {
        $class = substr($class, $pos + 1);
      }

      if (!class_exists($class)) {
        return new SQLException(CREOLE_ERROR_NOT_FOUND, "Unable to find loaded class: $class (Hint: make sure classname matches filename)");
      }
    }
    return $class;
  }

  function isError($value)
  {
    return (is_a($value, 'Exception'));
  }

  function typeHint(&$value, $type, $class, $func, $param = 1)
  {
    if (! is_a($value, "$type")) {
      trigger_error (
        "$class::$func(): parameter '$param' not of type '$type' !",
        E_USER_ERROR
      );
    }
  }

  /*
  * @private
  */
  function & getInstance()
  {
    static $instance;

    if ($instance === null)
    {
      $instance = new Creole();
    }

    return $instance;
  }

}

---

This file is part of the Creole[php4] library.