lib/AkActiveRecord/AkDbAdapter.php

   1 <?php
   2 /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
   3
   4 // +----------------------------------------------------------------------+
   5 // | Akelos Framework - http://www.akelos.org                             |
   6 // +----------------------------------------------------------------------+
   7 // | Copyright (c) 2002-2006, Akelos Media, S.L.  & Bermi Ferrer Martinez |
   8 // | Released under the GNU Lesser General Public License, see LICENSE.txt|
   9 // +----------------------------------------------------------------------+
  10
  11 /**
  12  * @package ActiveRecord
  13  * @subpackage Base
  14  * @component DbAdapter
  15  * @author Bermi Ferrer <bermi a.t akelos c.om> 2004 - 2007
  16  * @author Kaste 2007
  17  * @copyright Copyright (c) 2002-2006, Akelos Media, S.L. http://www.akelos.org
  18  * @license GNU Lesser General Public License <http://www.gnu.org/copyleft/lesser.html>
  19  */
  20
  21 defined('AK_AVAILABLE_DATABASES') ? null : define('AK_AVAILABLE_DATABASES', 'mysql,pgsql,sqlite');
  22
  23 require_once(AK_LIB_DIR.DS.'AkObject.php');
  24
  25 class AkDbAdapter extends AkObject
  26 {
  27
  28     var $connection;
  29     var $settings;
  30     var $dictionary;
  31     var $debug=false;
  32     var $logger;
  33
  34     /**
  35      * @param array $database_settings
  36      */
  37     function __construct($database_settings, $auto_connect = false)
  38     {
  39         $this->settings = $database_settings;
  40         if ($auto_connect){
  41             $this->connect();
  42         }
  43         if (AK_LOG_EVENTS){
  44             $this->logger =& Ak::getLogger();
  45         }
  46     }
  47
  48     function __destruct()
  49     {
  50     }
  51
  52     function connect()
  53     {
  54         $dsn = $this->_constructDsn($this->settings);
  55         require_once(AK_CONTRIB_DIR.DS.'adodb'.DS.'adodb.inc.php');
  56         $this->connection = AK_DEBUG ? NewADOConnection($dsn) : @NewADOConnection($dsn);
  57         if (!$this->connection){
  58             error_reporting(E_ALL);
  59             if(defined('AK_DATABASE_CONNECTION_FAILURE_CALLBACK') && function_exists(AK_DATABASE_CONNECTION_FAILURE_CALLBACK)){
  60                 $fn = AK_DATABASE_CONNECTION_FAILURE_CALLBACK;
  61                 $fn();
  62             }
  63             if(!AK_PHP5 && $this->type() == 'sqlite'){
  64                 trigger_error(Ak::t("\nWarning, sqlite support is not available by default on PHP4.\n Check your PHP version by running \"env php -v\", and change the first line in your scripts/ so they point to a php5 binary\n\n"),E_USER_WARNING);
  65             }
  66             trigger_error(Ak::t("Connection to the database failed. %dsn",
  67             array('%dsn'=> AK_DEBUG ? preg_replace('/\/\/(\w+):(.*)@/i','//$1:******@', urldecode($dsn))."\n" : '')),
  68             E_USER_ERROR);
  69         } else {
  70             $this->connection->debug = AK_DEBUG == 2;
  71             $this->connection->SetFetchMode(ADODB_FETCH_ASSOC);
  72             defined('AK_DATABASE_CONNECTION_AVAILABLE') ? null : define('AK_DATABASE_CONNECTION_AVAILABLE', true);
  73         }
  74     }
  75
  76     function connected()
  77     {
  78         return !empty($this->connection);
  79     }
  80
  81
  82     /**
  83      * @param array $database_settings
  84      */
  85     /* static */
  86     function &getInstance($database_specifications = AK_DEFAULT_DATABASE_PROFILE, $auto_connect = true)
  87     {
  88         static $connections;
  89
  90         $settings_hash = is_string($database_specifications) ? $database_specifications : AkDbAdapter::_hash($database_specifications);
  91
  92         if (empty($connections[$settings_hash])){
  93             global $database_settings;
  94             if (is_string($database_specifications)){
  95                 if (!empty($database_settings[$database_specifications])){
  96                     $database_specifications = $database_settings[$database_specifications];
  97                 } elseif(strstr($database_specifications, '://')) {
  98                     $database_specifications = AkDbAdapter::_getDbSettingsFromDsn($database_specifications);
  99                     $settings_hash = AK_ENVIRONMENT;
 100                 } else {
 101                     trigger_error(Ak::t("Could not find the database profile '%profile_name' in config/config.php.",array('%profile_name'=>$database_specifications)),E_USER_ERROR);
 102                     $return = false;
 103                     return $return;
 104                 }
 105             }elseif (!empty($database_settings[$settings_hash])){
 106                 $database_specifications = $database_settings[$settings_hash];
 107             }
 108
 109             $available_adapters = Ak::toArray(AK_AVAILABLE_DATABASES);
 110             $class_name = 'AkDbAdapter';
 111             $designated_database = strtolower($database_specifications['type']);
 112             if (in_array($designated_database, $available_adapters)) {
 113                 $class_name = 'Ak'.ucfirst($designated_database).'DbAdapter';
 114                 require_once(AK_LIB_DIR.DS.'AkActiveRecord'.DS.'AkDbAdapters'.DS.$class_name.'.php');
 115             }
 116             $connections[$settings_hash] =& new $class_name($database_specifications,$auto_connect);
 117         }
 118         return $connections[$settings_hash];
 119     }
 120
 121     /**
 122      * @param array $settings
 123      * @return string
 124      */
 125     function _hash($settings)
 126     {
 127         if(!is_array($settings)){
 128             return AK_ENVIRONMENT;
 129         }
 130         if (isset($settings['password'])){
 131             unset($settings['password']);
 132         }
 133         return join(':',$settings);
 134     }
 135
 136     function &getDictionary()
 137     {
 138         if (empty($this->dictionary)){
 139             if (!$this->connected()){
 140                 $this->connect();
 141             }
 142             require_once(AK_CONTRIB_DIR.DS.'adodb'.DS.'adodb.inc.php');
 143             $this->dictionary =& NewDataDictionary($this->connection);
 144         }
 145         return $this->dictionary;
 146     }
 147
 148     /**
 149      * @param array $database_settings
 150      * @return string
 151      */
 152     function _constructDsn($database_settings)
 153     {
 154         if(is_string($database_settings)){
 155             return $database_settings;
 156         }
 157         $dsn  = $database_settings['type'].'://';
 158         $dsn .= $database_settings['user'].':'.$database_settings['password'];
 159         $dsn .= !empty($database_settings['host']) ? '@'.$database_settings['host'] : '@localhost';
 160         $dsn .= !empty($database_settings['port']) ? ':'.$database_settings['port'] : '';
 161         $dsn .= '/'.$database_settings['database_name'];
 162         $dsn .= !empty($database_settings['options']) ? $database_settings['options'] : '';
 163         return $dsn;
 164
 165     }
 166
 167     function _getDbSettingsFromDsn($dsn)
 168     {
 169         $settings = $result = parse_url($dsn);
 170         $result['type'] = $settings['scheme'];
 171         $result['password'] = $settings['pass'];
 172         $result['database_name'] = trim($settings['path'],'/');
 173         return $result;
 174     }
 175
 176     function type()
 177     {
 178         return $this->settings['type'];
 179     }
 180
 181     function debug($on = 'switch')
 182     {
 183         if ($on == 'switch') {
 184             $this->debug = !$this->debug;
 185         }else{
 186             $this->debug = $on;
 187         }
 188         return $this->debug;
 189     }
 190
 191     function _log($message)
 192     {
 193         if (!AK_LOG_EVENTS){
 194             return;
 195         }
 196         $this->logger->message($message);
 197     }
 198
 199     function addLimitAndOffset(&$sql,$options)
 200     {
 201         if (isset($options['limit']) && $limit = $options['limit']){
 202             $sql .= " LIMIT $limit";
 203             if (isset($options['offset']) && $offset = $options['offset']){
 204                 $sql .= " OFFSET $offset";
 205             }
 206         }
 207         return $sql;
 208     }
 209
 210     /* DATABASE STATEMENTS - CRUD */
 211
 212     function execute($sql, $message = 'SQL')
 213     {
 214         if (is_array($sql)) {
 215             $sql_string = array_shift($sql);
 216             $bindings = $sql;
 217         } else $sql_string = $sql;
 218
 219         $this->_log($message.': '.$sql_string);
 220         $result = isset($bindings) ? $this->connection->Execute($sql_string, $bindings) : $this->connection->Execute($sql_string);
 221
 222         if (!$result){
 223             $error_message = '['.$this->connection->ErrorNo().'] '.$this->connection->ErrorMsg();
 224             $this->_log('SQL Error: '.$error_message);
 225             if ($this->debug || AK_DEBUG) trigger_error("Tried '$sql_string'. Got: $error_message", E_USER_NOTICE);
 226         }
 227         return $result;
 228     }
 229
 230     function incrementsPrimaryKeyAutomatically()
 231     {
 232         return true;
 233     }
 234
 235     function getLastInsertedId($table,$pk)
 236     {
 237         return $this->connection->Insert_ID($table,$pk);
 238     }
 239
 240     function getAffectedRows()
 241     {
 242         return $this->connection->Affected_Rows();
 243     }
 244
 245     function insert($sql,$id=null,$pk=null,$table=null,$message = '')
 246     {
 247         $result = $this->execute($sql,$message);
 248         if (!$result){
 249             return false;
 250         }
 251         return is_null($id) ? $this->getLastInsertedId($table,$pk) : $id;
 252     }
 253
 254     function update($sql,$message = '')
 255     {
 256         $result = $this->execute($sql,$message);
 257         return ($result) ? $this->getAffectedRows() : false;
 258     }
 259
 260     function delete($sql,$message = '')
 261     {
 262         $result = $this->execute($sql,$message);
 263         return ($result) ? $this->getAffectedRows() : false;
 264     }
 265
 266     /**
 267     * Returns a single value, the first column from the first row, from a record
 268     */
 269     function selectValue($sql)
 270     {
 271         $result = $this->selectOne($sql);
 272         return !is_null($result) ? array_shift($result) : null;
 273     }
 274
 275     /**
 276      * Returns an array of the values of the first column in a select:
 277      *   sqlSelectValues("SELECT id FROM companies LIMIT 3") => array(1,2,3)
 278      */
 279     function selectValues($sql)
 280     {
 281         $values = array();
 282         if($results = $this->select($sql)){
 283             foreach ($results as $result){
 284                 $values[] = array_shift($result);
 285             }
 286         }
 287         return $values;
 288     }
 289
 290     /**
 291      * Returns a record array of the first row with the column names as keys and column values
 292      * as values.
 293      */
 294     function selectOne($sql)
 295     {
 296         $result = $this->select($sql);
 297         return  !is_null($result) ? array_shift($result) : null;
 298     }
 299
 300     /**
 301      * alias for select
 302      */
 303     function selectAll($sql)
 304     {
 305         return $this->select($sql);
 306     }
 307
 308     /**
 309     * Returns an array of record hashes with the column names as keys and
 310     * column values as values.
 311     */
 312     function select($sql, $message = '')
 313     {
 314         $result = $this->execute($sql, $message);
 315         if (!$result){
 316             return array();
 317         }
 318
 319         $records = array();
 320         while ($record = $result->FetchRow()) {
 321             $records[] = $record;
 322         }
 323         $result->Close();
 324         return $records;
 325     }
 326
 327     /* TRANSACTIONS */
 328
 329     function startTransaction()
 330     {
 331         return $this->connection->StartTrans();
 332     }
 333
 334     function stopTransaction()
 335     {
 336         return $this->connection->CompleteTrans();
 337     }
 338
 339     function failTransaction()
 340     {
 341         return $this->connection->FailTrans();
 342     }
 343
 344     function hasTransactionFailed()
 345     {
 346         return $this->connection->HasFailedTrans();
 347     }
 348
 349     /* SCHEMA */
 350
 351     function renameColumn($table_name,$column_name,$new_name)
 352     {
 353         trigger_error(Ak::t('renameColumn is not available for your DbAdapter. Using %db_type.',array('%db_type'=>$this->type())));
 354     }
 355
 356     /* META */
 357
 358     function availableTables()
 359     {
 360         return $this->connection->MetaTables();
 361     }
 362
 363     function getColumnDetails($table_name)
 364     {
 365         return $this->connection->MetaColumns($table_name);
 366     }
 367
 368     function getIndexes($table_name)
 369     {
 370         return $this->connection->MetaIndexes($table_name);
 371     }
 372
 373     /* QUOTING */
 374
 375     function quote_string($value)
 376     {
 377         return $this->connection->qstr($value);
 378     }
 379
 380     function quote_datetime($value)
 381     {
 382         return $this->connection->DBTimeStamp($value);
 383     }
 384
 385     function quote_date($value)
 386     {
 387         return $this->connection->DBDate($value);
 388     }
 389
 390     // will be moved to postgre
 391     function escape_blob($value)
 392     {
 393         return $this->connection->BlobEncode($value);
 394     }
 395
 396     // will be moved to postgre
 397     function unescape_blob($value)
 398     {
 399         return $this->connection->BlobDecode($value);
 400     }
 401
 402 }
 403
 404 ?>