DBConnection.inc.php

<?php
 
define('ADODB_OUTP', array('DBConnection', 'logAdodbMessage'));
 
class DBConnection {
 
   var $dbconn;
 
   var $driver;
   var $host;
   var $username;
   var $password;
   var $databaseName;
   var $persistent;
   var $connectionCharset;
   var $forceNew; // Only applicable if non-persistent
 
   var $connectOnInit;
 
   /* @var boolean enable debugging output */
   var $debug;
 
   var $connected;
 
   function __construct() {
      $this->connected = false;
 
      if (func_num_args() == 0) {
         $this->initDefaultDBConnection();
      } else {
         $args = func_get_args();
         call_user_func_array(array($this, 'initCustomDBConnection'), $args);
      }
   }
 
   static function logAdodbMessage($msg, $newline=true) {
      error_log('PKP-Database-Logger ' . Registry::get('system.debug.startTime') . ': ' . PKPString::html2text($msg));
   }
 
   function initDefaultDBConnection() {
      $this->driver = Config::getVar('database', 'driver');
      $this->host = Config::getVar('database', 'host');
      $socket = Config::getVar('database', 'unix_socket');
      $port = Config::getVar('database', 'port');
      if ($socket) {
         $this->host .= ':' . $socket;
      } elseif ($port) {
         $this->host .= ':' . $port;
      }
      $this->username = Config::getVar('database', 'username');
      $this->password = Config::getVar('database', 'password');
      $this->databaseName = Config::getVar('database', 'name');
      $this->persistent = Config::getVar('database', 'persistent') ? true : false;
      $this->connectionCharset = Config::getVar('i18n', 'connection_charset');
      $this->debug = Config::getVar('database', 'debug') ? true : false;
      $this->connectOnInit = true;
      $this->forceNew = false;
 
      return $this->initConn();
   }
 
   function initCustomDBConnection($driver, $host, $username, $password, $databaseName, $persistent = false, $connectionCharset = false, $connectOnInit = true, $debug = false, $forceNew = false) {
      $this->driver = $driver;
      $this->host = $host;
      $this->username = $username;
      $this->password = $password;
      $this->databaseName = $databaseName;
      $this->persistent = $persistent;
      $this->connectionCharset = $connectionCharset;
      $this->connectOnInit = $connectOnInit;
      $this->debug = $debug;
      $this->forceNew = $forceNew;
 
      return $this->initConn();
   }
 
   function initConn() {
      require_once('lib/pkp/lib/vendor/adodb/adodb-php/adodb.inc.php');
 
      $this->dbconn = ADONewConnection($this->driver);
 
      if ($this->connectOnInit) {
         return $this->connect();
      } else {
         return true;
      }
   }
 
   function connect() {
      if ($this->persistent) {
         $this->connected = @$this->dbconn->PConnect(
            $this->host,
            $this->username,
            $this->password,
            $this->databaseName
         );
 
      } else {
         $this->connected = @$this->dbconn->Connect(
            $this->host,
            $this->username,
            $this->password,
            $this->databaseName,
            $this->forceNew
         );
      }
 
      if ($this->debug) {
         // Enable verbose database debugging (prints all SQL statements as they're executed)
         $this->dbconn->debug = true;
      }
 
      if ($this->connected && $this->connectionCharset) {
         // Set client/connection character set
         // NOTE: Only supported on some database servers and versions
         $this->dbconn->SetCharSet($this->connectionCharset);
      }
 
      return $this->connected;
   }
 
   function disconnect() {
      if ($this->connected) {
         $this->dbconn->Disconnect();
         $this->connected = false;
      }
   }
 
   function reconnect($forceNew = false) {
      $this->disconnect();
      if ($forceNew) {
         $this->persistent = false;
      }
      $this->forceNew = $forceNew;
      return $this->connect();
   }
 
   function &getDBConn() {
      return $this->dbconn;
   }
 
   function isConnected() {
      return $this->connected;
   }
 
   function getNumQueries() {
      return isset($this->dbconn) ? $this->dbconn->numQueries : 0;
   }
 
   static function getInstance($setInstance = null) {
      $instance =& Registry::get('dbInstance', true, null);
 
      if (isset($setInstance)) {
         $instance = $setInstance;
      } else if ($instance === null) {
         $instance = new DBConnection();
      }
 
      return $instance;
   }
 
   static function &getConn() {
      $conn = DBConnection::getInstance();
      return $conn->getDBConn();
   }
 
   function getDriver() {
      return $this->driver;
   }
}