1587 lines
38 KiB
PHP
1587 lines
38 KiB
PHP
<?php
|
|
/**
|
|
* Akeeba Engine
|
|
*
|
|
* @package akeebaengine
|
|
* @copyright Copyright (c)2006-2022 Nicholas K. Dionysopoulos / Akeeba Ltd
|
|
* @license GNU General Public License version 3, or later
|
|
*/
|
|
|
|
namespace Akeeba\Engine\Driver;
|
|
|
|
defined('AKEEBAENGINE') || die();
|
|
|
|
use Akeeba\Engine\Driver\Query\Base as QueryBase;
|
|
use RuntimeException;
|
|
|
|
/**
|
|
* Database driver superclass. Used as the base of all Akeeba Engine database drivers.
|
|
* Strongly based on Joomla Platform's JDatabase class.
|
|
*
|
|
* @method qn(string $name, string $as = null) Alias for quoteName
|
|
* @method q(string $text, bool $escape = true) Alias for quote
|
|
*/
|
|
abstract class Base
|
|
{
|
|
/** @var string The minimum supported database version. */
|
|
protected static $dbMinimum;
|
|
|
|
/** @var array JDatabaseDriver instances container. */
|
|
protected static $instances = [];
|
|
|
|
/** @var string The name of the database driver. */
|
|
public $name;
|
|
|
|
/** @var string The name of the database. */
|
|
protected $_database;
|
|
|
|
/** @var resource The db connection resource */
|
|
protected $connection = '';
|
|
|
|
/** @var integer The number of SQL statements executed by the database driver. */
|
|
protected $count = 0;
|
|
|
|
/** @var resource The database connection cursor from the last query. */
|
|
protected $cursor;
|
|
|
|
/** @var boolean The database driver debugging state. */
|
|
protected $debug = false;
|
|
|
|
/** @var string Driver type. This should always be mysql as we don't support anything else anymore. */
|
|
protected $driverType = '';
|
|
|
|
/** @var string The db server's error string */
|
|
protected $errorMsg = '';
|
|
|
|
/** @var int The db server's error number */
|
|
protected $errorNum = 0;
|
|
|
|
/** @var int Query's limit */
|
|
protected $limit = 0;
|
|
|
|
/** @var array The log of executed SQL statements by the database driver. */
|
|
protected $log = [];
|
|
|
|
/** @var string Quote for named objects */
|
|
protected $nameQuote = '';
|
|
|
|
/** @var string The null or zero representation of a timestamp for the database driver. */
|
|
protected $nullDate;
|
|
|
|
/** @var int Query's offset */
|
|
protected $offset = 0;
|
|
|
|
/** @var array Passed in upon instantiation and saved. */
|
|
protected $options;
|
|
|
|
/** @var mixed The SQL query string */
|
|
protected $sql = '';
|
|
|
|
/** @var string The prefix used in the database, if any */
|
|
protected $tablePrefix = '';
|
|
|
|
/** @var bool Support for UTF-8 */
|
|
protected $utf = true;
|
|
|
|
/**
|
|
* Database object constructor
|
|
*
|
|
* @param array $options List of options used to configure the connection
|
|
*/
|
|
public function __construct($options)
|
|
{
|
|
$prefix = array_key_exists('prefix', $options) ? $options['prefix'] : '';
|
|
$database = array_key_exists('database', $options) ? $options['database'] : '';
|
|
$connection = array_key_exists('connection', $options) ? $options['connection'] : null;
|
|
|
|
$this->tablePrefix = $prefix;
|
|
$this->_database = $database;
|
|
$this->connection = $connection;
|
|
$this->errorNum = 0;
|
|
$this->count = 0;
|
|
$this->log = [];
|
|
$this->options = $options;
|
|
}
|
|
|
|
/**
|
|
* Is this driver class supported on this server? Child classes are supposed to override this and perform a
|
|
* compatibility check.
|
|
*
|
|
* @return bool True if the driver class is supported on the server
|
|
*/
|
|
public static function isSupported()
|
|
{
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Splits a string of multiple queries into an array of individual queries.
|
|
*
|
|
* @param string $query Input SQL string with which to split into individual queries.
|
|
*
|
|
* @return array The queries from the input string separated into an array.
|
|
*/
|
|
public static function splitSql($query)
|
|
{
|
|
$start = 0;
|
|
$open = false;
|
|
$char = '';
|
|
$end = strlen($query);
|
|
$queries = [];
|
|
|
|
for ($i = 0; $i < $end; $i++)
|
|
{
|
|
$current = substr($query, $i, 1);
|
|
if (($current == '"' || $current == '\''))
|
|
{
|
|
$n = 2;
|
|
|
|
while (substr($query, $i - $n + 1, 1) == '\\' && $n < $i)
|
|
{
|
|
$n++;
|
|
}
|
|
|
|
if ($n % 2 == 0)
|
|
{
|
|
if ($open)
|
|
{
|
|
if ($current == $char)
|
|
{
|
|
$open = false;
|
|
$char = '';
|
|
}
|
|
}
|
|
else
|
|
{
|
|
$open = true;
|
|
$char = $current;
|
|
}
|
|
}
|
|
}
|
|
|
|
if (($current == ';' && !$open) || $i == $end - 1)
|
|
{
|
|
$queries[] = substr($query, $start, ($i - $start + 1));
|
|
$start = $i + 1;
|
|
}
|
|
}
|
|
|
|
return $queries;
|
|
}
|
|
|
|
/**
|
|
* Is this driver supported under the current system configuration?
|
|
*
|
|
* @return bool
|
|
*/
|
|
public static function test()
|
|
{
|
|
return self::isSupported();
|
|
}
|
|
|
|
/**
|
|
* Magic method to provide method alias support for quote() and quoteName().
|
|
*
|
|
* @param string $method The called method.
|
|
* @param array $args The array of arguments passed to the method.
|
|
*
|
|
* @return string The aliased method's return value or null.
|
|
*/
|
|
public function __call($method, $args)
|
|
{
|
|
if (empty($args))
|
|
{
|
|
return null;
|
|
}
|
|
|
|
switch ($method)
|
|
{
|
|
case 'q':
|
|
return $this->quote($args[0], $args[1] ?? true);
|
|
break;
|
|
case 'nq':
|
|
case 'qn':
|
|
return $this->quoteName($args[0]);
|
|
break;
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Database object destructor
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function __destruct()
|
|
{
|
|
return $this->close();
|
|
}
|
|
|
|
public function __wakeup()
|
|
{
|
|
$this->open();
|
|
}
|
|
|
|
/**
|
|
* By default, when the object is shutting down, the connection is closed
|
|
*/
|
|
public function _onSerialize()
|
|
{
|
|
$this->close();
|
|
}
|
|
|
|
/**
|
|
* Alter database's character set, obtaining query string from protected member.
|
|
*
|
|
* @param string $dbName The database name that will be altered
|
|
*
|
|
* @return string The query that alter the database query string
|
|
*
|
|
* @throws RuntimeException
|
|
*/
|
|
public function alterDbCharacterSet($dbName)
|
|
{
|
|
if (is_null($dbName))
|
|
{
|
|
throw new RuntimeException('Database name must not be null.');
|
|
}
|
|
|
|
$this->setQuery($this->getAlterDbCharacterSet($dbName));
|
|
|
|
return $this->execute();
|
|
}
|
|
|
|
/**
|
|
* Closes the database connection
|
|
*/
|
|
abstract public function close();
|
|
|
|
/**
|
|
* Determines if the connection to the server is active.
|
|
*
|
|
* @return boolean True if connected to the database engine.
|
|
*/
|
|
abstract public function connected();
|
|
|
|
/**
|
|
* Create a new database using information from $options object, obtaining query string
|
|
* from protected member.
|
|
*
|
|
* @param object $options Object used to pass user and database name to database driver.
|
|
* This object must have "db_name" and "db_user" set.
|
|
* @param boolean $utf True if the database supports the UTF-8 character set.
|
|
*
|
|
* @return string The query that creates database
|
|
*
|
|
* @throws RuntimeException
|
|
*/
|
|
public function createDatabase($options, $utf = true)
|
|
{
|
|
if (is_null($options))
|
|
{
|
|
throw new RuntimeException('$options object must not be null.');
|
|
}
|
|
elseif (empty($options->db_name))
|
|
{
|
|
throw new RuntimeException('$options object must have db_name set.');
|
|
}
|
|
elseif (empty($options->db_user))
|
|
{
|
|
throw new RuntimeException('$options object must have db_user set.');
|
|
}
|
|
|
|
$this->setQuery($this->getCreateDatabaseQuery($options, $utf));
|
|
|
|
return $this->execute();
|
|
}
|
|
|
|
/**
|
|
* Drops a table from the database.
|
|
*
|
|
* @param string $table The name of the database table to drop.
|
|
* @param boolean $ifExists Optionally specify that the table must exist before it is dropped.
|
|
*
|
|
* @return Base Returns this object to support chaining.
|
|
*/
|
|
public abstract function dropTable($table, $ifExists = true);
|
|
|
|
/**
|
|
* Method to escape a string for usage in an SQL statement.
|
|
*
|
|
* @param string $text The string to be escaped.
|
|
* @param boolean $extra Optional parameter to provide extra escaping.
|
|
*
|
|
* @return string The escaped string.
|
|
*/
|
|
abstract public function escape($text, $extra = false);
|
|
|
|
/**
|
|
* An alias for query()
|
|
*
|
|
* @return mixed A database cursor resource on success, boolean false on failure.
|
|
*/
|
|
public function execute()
|
|
{
|
|
return $this->query();
|
|
}
|
|
|
|
/**
|
|
* Method to fetch a row from the result set cursor as an associative array.
|
|
*
|
|
* @param mixed $cursor The optional result set cursor from which to fetch the row.
|
|
*
|
|
* @return mixed Either the next row from the result set or false if there are no more rows.
|
|
*/
|
|
abstract public function fetchAssoc($cursor = null);
|
|
|
|
/**
|
|
* Method to free up the memory used for the result set.
|
|
*
|
|
* @param mixed $cursor The optional result set cursor from which to fetch the row.
|
|
*
|
|
* @return void
|
|
*/
|
|
abstract public function freeResult($cursor = null);
|
|
|
|
/**
|
|
* Returns the abstracted name of a database object
|
|
*
|
|
* @param string $tableName
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getAbstract($tableName)
|
|
{
|
|
$prefix = $this->getPrefix();
|
|
|
|
// Don't return abstract names for non-CMS tables
|
|
if (is_null($prefix))
|
|
{
|
|
return $tableName;
|
|
}
|
|
|
|
switch ($prefix)
|
|
{
|
|
case '':
|
|
// This is more of a hack; it assumes all tables are CMS tables if the prefix is empty.
|
|
return '#__' . $tableName;
|
|
break;
|
|
|
|
default:
|
|
// Normal behaviour for 99% of sites
|
|
$tableAbstract = $tableName;
|
|
if (!empty($prefix))
|
|
{
|
|
if (substr($tableName, 0, strlen($prefix)) == $prefix)
|
|
{
|
|
$tableAbstract = '#__' . substr($tableName, strlen($prefix));
|
|
}
|
|
else
|
|
{
|
|
$tableAbstract = $tableName;
|
|
}
|
|
}
|
|
|
|
return $tableAbstract;
|
|
break;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Get the number of affected rows for the previous executed SQL statement.
|
|
*
|
|
* @return integer The number of affected rows.
|
|
*/
|
|
abstract public function getAffectedRows();
|
|
|
|
/**
|
|
* Method to get the database collation in use by sampling a text field of a table in the database.
|
|
*
|
|
* @return mixed The collation in use by the database or boolean false if not supported.
|
|
*/
|
|
abstract public function getCollation();
|
|
|
|
/**
|
|
* Method that provides access to the underlying database connection.
|
|
*
|
|
* @return resource The underlying database connection resource.
|
|
*/
|
|
public function getConnection()
|
|
{
|
|
return $this->connection;
|
|
}
|
|
|
|
/**
|
|
* Inherits the connection of another database driver. Useful for cloning
|
|
* the CMS database connection into an Akeeba Engine database driver.
|
|
*
|
|
* @param resource $connection
|
|
*/
|
|
public function setConnection($connection)
|
|
{
|
|
$this->connection = $connection;
|
|
}
|
|
|
|
/**
|
|
* Get the total number of SQL statements executed by the database driver.
|
|
*
|
|
* @return integer
|
|
*
|
|
* @since 11.1
|
|
*/
|
|
public function getCount()
|
|
{
|
|
return $this->count;
|
|
}
|
|
|
|
/**
|
|
* Returns a PHP date() function compliant date format for the database driver.
|
|
*
|
|
* @return string The format string.
|
|
*/
|
|
public function getDateFormat()
|
|
{
|
|
return 'Y-m-d H:i:s';
|
|
}
|
|
|
|
/**
|
|
* Return the database driver type, e.g. "mysql" for all drivers which can talk to MySQL
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getDriverType()
|
|
{
|
|
return $this->driverType;
|
|
}
|
|
|
|
/**
|
|
* Get the error message
|
|
*
|
|
* @return string The error message for the most recent query
|
|
*/
|
|
public function getErrorMsg($escaped = false)
|
|
{
|
|
if ($escaped)
|
|
{
|
|
return addslashes($this->errorMsg);
|
|
}
|
|
else
|
|
{
|
|
return $this->errorMsg;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Get the error number
|
|
*
|
|
* @return int The error number for the most recent query
|
|
*/
|
|
public function getErrorNum()
|
|
{
|
|
return $this->errorNum;
|
|
}
|
|
|
|
/**
|
|
* Method to escape a string for usage in an SQL statement.
|
|
*
|
|
* @param string $text The string to be escaped.
|
|
* @param boolean $extra Optional parameter to provide extra escaping.
|
|
*
|
|
* @return string The escaped string.
|
|
*/
|
|
public function getEscaped($text, $extra = false)
|
|
{
|
|
return $this->escape($text, $extra);
|
|
}
|
|
|
|
/**
|
|
* Get the database driver SQL statement log.
|
|
*
|
|
* @return array SQL statements executed by the database driver.
|
|
*
|
|
* @since 11.1
|
|
*/
|
|
public function getLog()
|
|
{
|
|
return $this->log;
|
|
}
|
|
|
|
/**
|
|
* Get the minimum supported database version.
|
|
*
|
|
* @return string The minimum version number for the database driver.
|
|
*
|
|
* @since 12.1
|
|
*/
|
|
public function getMinimum()
|
|
{
|
|
return static::$dbMinimum;
|
|
}
|
|
|
|
/**
|
|
* Get the null or zero representation of a timestamp for the database driver.
|
|
*
|
|
* @return string Null or zero representation of a timestamp.
|
|
*/
|
|
public function getNullDate()
|
|
{
|
|
return $this->nullDate;
|
|
}
|
|
|
|
/**
|
|
* Get the number of returned rows for the previous executed SQL statement.
|
|
*
|
|
* @param resource $cursor An optional database cursor resource to extract the row count from.
|
|
*
|
|
* @return integer The number of returned rows.
|
|
*/
|
|
abstract public function getNumRows($cursor = null);
|
|
|
|
/**
|
|
* Get the database table prefix
|
|
*
|
|
* @return string The database prefix
|
|
*/
|
|
public function getPrefix()
|
|
{
|
|
return $this->tablePrefix;
|
|
}
|
|
|
|
/**
|
|
* Get the current query object or a new QueryBase object.
|
|
*
|
|
* @param boolean $new False to return the current query object, True to return a new QueryBase object.
|
|
*
|
|
* @return QueryBase The current query object or a new object extending the QueryBase class.
|
|
*/
|
|
abstract public function getQuery($new = false);
|
|
|
|
/**
|
|
* Retrieves field information about the given tables.
|
|
*
|
|
* @param string $table The name of the database table.
|
|
* @param boolean $typeOnly True (default) to only return field types.
|
|
*
|
|
* @return array An array of fields by table.
|
|
*/
|
|
abstract public function getTableColumns($table, $typeOnly = true);
|
|
|
|
/**
|
|
* Shows the table CREATE statement that creates the given tables.
|
|
*
|
|
* @param mixed $tables A table name or a list of table names.
|
|
*
|
|
* @return array A list of the create SQL for the tables.
|
|
*/
|
|
abstract public function getTableCreate($tables);
|
|
|
|
/**
|
|
* Retrieves field information about the given tables.
|
|
*
|
|
* @param mixed $tables A table name or a list of table names.
|
|
* @param boolean $typeOnly True to only return field types.
|
|
*
|
|
* @return array An array of fields by table.
|
|
*/
|
|
public function getTableFields($tables, $typeOnly = true)
|
|
{
|
|
$results = [];
|
|
|
|
$tables = (array) $tables;
|
|
|
|
foreach ($tables as $table)
|
|
{
|
|
$results[$table] = $this->getTableColumns($table, $typeOnly);
|
|
}
|
|
|
|
return $results;
|
|
}
|
|
|
|
/**
|
|
* Retrieves field information about the given tables.
|
|
*
|
|
* @param mixed $tables A table name or a list of table names.
|
|
*
|
|
* @return array An array of keys for the table(s).
|
|
*/
|
|
abstract public function getTableKeys($tables);
|
|
|
|
/**
|
|
* Method to get an array of all tables in the database.
|
|
*
|
|
* @return array An array of all the tables in the database.
|
|
*/
|
|
abstract public function getTableList();
|
|
|
|
/**
|
|
* Returns an array with the names of tables, views, procedures, functions and triggers
|
|
* in the database. The table names are the keys of the tables, whereas the value is
|
|
* the type of each element: table, view, merge, temp, procedure, function or trigger.
|
|
* Note that merge are MRG_MYISAM tables and temp is non-permanent data table, usually
|
|
* set up as temporary, black hole or federated tables. These two types should never,
|
|
* ever, have their data dumped in the SQL dump file.
|
|
*
|
|
* @param bool $abstract Return abstract or normal names? Defaults to true (abstract names)
|
|
*
|
|
* @return array
|
|
*/
|
|
abstract public function getTables($abstract = true);
|
|
|
|
/**
|
|
* Determine whether or not the database engine supports UTF-8 character encoding.
|
|
*
|
|
* @return boolean True if the database engine supports UTF-8 character encoding.
|
|
*/
|
|
public function getUTFSupport()
|
|
{
|
|
return $this->utf;
|
|
}
|
|
|
|
/**
|
|
* Get the version of the database connector
|
|
*
|
|
* @return string The database connector version.
|
|
*/
|
|
abstract public function getVersion();
|
|
|
|
/**
|
|
* Determines if the database engine supports UTF-8 character encoding.
|
|
*
|
|
* @return boolean True if supported.
|
|
*/
|
|
public function hasUTF()
|
|
{
|
|
return $this->utf;
|
|
}
|
|
|
|
/**
|
|
* Determine whether or not the database engine supports UTF-8 character encoding.
|
|
*
|
|
* @return boolean True if the database engine supports UTF-8 character encoding.
|
|
*/
|
|
public function hasUTFSupport()
|
|
{
|
|
return $this->utf;
|
|
}
|
|
|
|
/**
|
|
* Inserts a row into a table based on an object's properties.
|
|
*
|
|
* @param string $table The name of the database table to insert into.
|
|
* @param object &$object A reference to an object whose public properties match the table fields.
|
|
* @param string $key The name of the primary key. If provided the object property is updated.
|
|
*
|
|
* @return boolean True on success.
|
|
*/
|
|
public function insertObject($table, &$object, $key = null)
|
|
{
|
|
$fields = [];
|
|
$values = [];
|
|
|
|
// Iterate over the object variables to build the query fields and values.
|
|
foreach (get_object_vars($object) as $k => $v)
|
|
{
|
|
// Only process non-null scalars.
|
|
if (is_array($v) || is_object($v) || ($v === null))
|
|
{
|
|
continue;
|
|
}
|
|
|
|
// Ignore any internal fields.
|
|
if ($k[0] == '_')
|
|
{
|
|
continue;
|
|
}
|
|
|
|
// Prepare and sanitize the fields and values for the database query.
|
|
$fields[] = $this->quoteName($k);
|
|
$values[] = $this->quote($v);
|
|
}
|
|
|
|
// Create the base insert statement.
|
|
$query = $this->getQuery(true)
|
|
->insert($this->quoteName($table))
|
|
->columns($fields)
|
|
->values(implode(',', $values));
|
|
|
|
// Set the query and execute the insert.
|
|
$this->setQuery($query);
|
|
if (!$this->execute())
|
|
{
|
|
return false;
|
|
}
|
|
|
|
// Update the primary key if it exists.
|
|
$id = $this->insertid();
|
|
if ($key && $id && is_string($key))
|
|
{
|
|
$object->$key = $id;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Method to get the auto-incremented value from the last INSERT statement.
|
|
*
|
|
* @return integer The value of the auto-increment field from the last inserted row.
|
|
*/
|
|
abstract public function insertid();
|
|
|
|
/**
|
|
* Method to check whether the installed database version is supported by the database driver
|
|
*
|
|
* @return boolean True if the database version is supported
|
|
*
|
|
* @since 12.1
|
|
*/
|
|
public function isMinimumVersion()
|
|
{
|
|
return version_compare($this->getVersion(), static::$dbMinimum) >= 0;
|
|
}
|
|
|
|
/**
|
|
* Method to get the first row of the result set from the database query as an associative array
|
|
* of ['field_name' => 'row_value'].
|
|
*
|
|
* @return mixed The return value or null if the query failed.
|
|
*/
|
|
public function loadAssoc()
|
|
{
|
|
$ret = null;
|
|
|
|
// Execute the query and get the result set cursor.
|
|
if (!($cursor = $this->execute()))
|
|
{
|
|
return null;
|
|
}
|
|
|
|
// Get the first row from the result set as an associative array.
|
|
if ($array = $this->fetchAssoc($cursor))
|
|
{
|
|
$ret = $array;
|
|
}
|
|
|
|
// Free up system resources and return.
|
|
$this->freeResult($cursor);
|
|
|
|
return $ret;
|
|
}
|
|
|
|
/**
|
|
* Method to get an array of the result set rows from the database query where each row is an associative array
|
|
* of ['field_name' => 'row_value']. The array of rows can optionally be keyed by a field name, but defaults to
|
|
* a sequential numeric array.
|
|
*
|
|
* NOTE: Chosing to key the result array by a non-unique field name can result in unwanted
|
|
* behavior and should be avoided.
|
|
*
|
|
* @param string $key The name of a field on which to key the result array.
|
|
* @param string $column An optional column name. Instead of the whole row, only this column value will be in
|
|
* the result array.
|
|
*
|
|
* @return mixed The return value or null if the query failed.
|
|
*/
|
|
public function loadAssocList($key = null, $column = null)
|
|
{
|
|
$array = [];
|
|
|
|
// Execute the query and get the result set cursor.
|
|
if (!($cursor = $this->execute()))
|
|
{
|
|
return null;
|
|
}
|
|
|
|
// Get all of the rows from the result set.
|
|
while ($row = $this->fetchAssoc($cursor))
|
|
{
|
|
$value = ($column) ? ($row[$column] ?? $row) : $row;
|
|
if ($key)
|
|
{
|
|
$array[$row[$key]] = $value;
|
|
}
|
|
else
|
|
{
|
|
$array[] = $value;
|
|
}
|
|
}
|
|
|
|
// Free up system resources and return.
|
|
$this->freeResult($cursor);
|
|
|
|
return $array;
|
|
}
|
|
|
|
/**
|
|
* Method to get an array of values from the <var>$offset</var> field in each row of the result set from
|
|
* the database query.
|
|
*
|
|
* @param integer $offset The row offset to use to build the result array.
|
|
*
|
|
* @return mixed The return value or null if the query failed.
|
|
*/
|
|
public function loadColumn($offset = 0)
|
|
{
|
|
$array = [];
|
|
|
|
// Execute the query and get the result set cursor.
|
|
if (!($cursor = $this->execute()))
|
|
{
|
|
return null;
|
|
}
|
|
|
|
// Get all of the rows from the result set as arrays.
|
|
while ($row = $this->fetchArray($cursor))
|
|
{
|
|
$array[] = $row[$offset];
|
|
}
|
|
|
|
// Free up system resources and return.
|
|
$this->freeResult($cursor);
|
|
|
|
return $array;
|
|
}
|
|
|
|
/**
|
|
* Method to get the next row in the result set from the database query as an object.
|
|
*
|
|
* @param string $class The class name to use for the returned row object.
|
|
*
|
|
* @return mixed The result of the query as an array, false if there are no more rows.
|
|
*/
|
|
public function loadNextObject($class = 'stdClass')
|
|
{
|
|
// Execute the query and get the result set cursor.
|
|
if (is_null($this->cursor))
|
|
{
|
|
if (!($this->cursor = $this->execute()))
|
|
{
|
|
return $this->errorNum ? null : false;
|
|
}
|
|
}
|
|
|
|
// Get the next row from the result set as an object of type $class.
|
|
if ($row = $this->fetchObject($this->cursor, $class))
|
|
{
|
|
return $row;
|
|
}
|
|
|
|
// Free up system resources and return.
|
|
$this->freeResult($this->cursor);
|
|
$this->cursor = null;
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Method to get the next row in the result set from the database query as an array.
|
|
*
|
|
* @return mixed The result of the query as an array, false if there are no more rows.
|
|
*/
|
|
public function loadNextRow()
|
|
{
|
|
// Execute the query and get the result set cursor.
|
|
if (is_null($this->cursor))
|
|
{
|
|
if (!($this->cursor = $this->execute()))
|
|
{
|
|
return $this->errorNum ? null : false;
|
|
}
|
|
}
|
|
|
|
// Get the next row from the result set as an object of type $class.
|
|
if ($row = $this->fetchArray($this->cursor))
|
|
{
|
|
return $row;
|
|
}
|
|
|
|
// Free up system resources and return.
|
|
$this->freeResult($this->cursor);
|
|
$this->cursor = null;
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Method to get the first row of the result set from the database query as an object.
|
|
*
|
|
* @param string $class The class name to use for the returned row object.
|
|
*
|
|
* @return mixed The return value or null if the query failed.
|
|
*/
|
|
public function loadObject($class = 'stdClass')
|
|
{
|
|
$ret = null;
|
|
|
|
// Execute the query and get the result set cursor.
|
|
if (!($cursor = $this->execute()))
|
|
{
|
|
return null;
|
|
}
|
|
|
|
// Get the first row from the result set as an object of type $class.
|
|
if ($object = $this->fetchObject($cursor, $class))
|
|
{
|
|
$ret = $object;
|
|
}
|
|
|
|
// Free up system resources and return.
|
|
$this->freeResult($cursor);
|
|
|
|
return $ret;
|
|
}
|
|
|
|
/**
|
|
* Method to get an array of the result set rows from the database query where each row is an object. The array
|
|
* of objects can optionally be keyed by a field name, but defaults to a sequential numeric array.
|
|
*
|
|
* NOTE: Choosing to key the result array by a non-unique field name can result in unwanted
|
|
* behavior and should be avoided.
|
|
*
|
|
* @param string $key The name of a field on which to key the result array.
|
|
* @param string $class The class name to use for the returned row objects.
|
|
*
|
|
* @return mixed The return value or null if the query failed.
|
|
*/
|
|
public function loadObjectList($key = '', $class = 'stdClass')
|
|
{
|
|
$array = [];
|
|
|
|
// Execute the query and get the result set cursor.
|
|
if (!($cursor = $this->execute()))
|
|
{
|
|
return null;
|
|
}
|
|
|
|
// Get all of the rows from the result set as objects of type $class.
|
|
while ($row = $this->fetchObject($cursor, $class))
|
|
{
|
|
if ($key)
|
|
{
|
|
$array[$row->$key] = $row;
|
|
}
|
|
else
|
|
{
|
|
$array[] = $row;
|
|
}
|
|
}
|
|
|
|
// Free up system resources and return.
|
|
$this->freeResult($cursor);
|
|
|
|
return $array;
|
|
}
|
|
|
|
/**
|
|
* Method to get the first field of the first row of the result set from the database query.
|
|
*
|
|
* @return mixed The return value or null if the query failed.
|
|
*/
|
|
public function loadResult()
|
|
{
|
|
$ret = null;
|
|
|
|
// Execute the query and get the result set cursor.
|
|
if (!($cursor = $this->execute()))
|
|
{
|
|
return null;
|
|
}
|
|
|
|
// Get the first row from the result set as an array.
|
|
if ($row = $this->fetchArray($cursor))
|
|
{
|
|
$ret = $row[0];
|
|
}
|
|
|
|
// Free up system resources and return.
|
|
$this->freeResult($cursor);
|
|
|
|
return $ret;
|
|
}
|
|
|
|
/**
|
|
* Method to get an array of values from the <var>$offset</var> field in each row of the result set from
|
|
* the database query.
|
|
*
|
|
* @param integer $offset The row offset to use to build the result array.
|
|
*
|
|
* @return mixed The return value or null if the query failed.
|
|
*/
|
|
public function loadResultArray($offset = 0)
|
|
{
|
|
return $this->loadColumn($offset);
|
|
}
|
|
|
|
/**
|
|
* Method to get the first row of the result set from the database query as an array. Columns are indexed
|
|
* numerically so the first column in the result set would be accessible via <var>$row[0]</var>, etc.
|
|
*
|
|
* @return mixed The return value or null if the query failed.
|
|
*/
|
|
public function loadRow()
|
|
{
|
|
$ret = null;
|
|
|
|
// Execute the query and get the result set cursor.
|
|
if (!($cursor = $this->execute()))
|
|
{
|
|
return null;
|
|
}
|
|
|
|
// Get the first row from the result set as an array.
|
|
if ($row = $this->fetchArray($cursor))
|
|
{
|
|
$ret = $row;
|
|
}
|
|
|
|
// Free up system resources and return.
|
|
$this->freeResult($cursor);
|
|
|
|
return $ret;
|
|
}
|
|
|
|
/**
|
|
* Method to get an array of the result set rows from the database query where each row is an array. The array
|
|
* of objects can optionally be keyed by a field offset, but defaults to a sequential numeric array.
|
|
*
|
|
* NOTE: Choosing to key the result array by a non-unique field can result in unwanted
|
|
* behavior and should be avoided.
|
|
*
|
|
* @param string $key The name of a field on which to key the result array.
|
|
*
|
|
* @return mixed The return value or null if the query failed.
|
|
*/
|
|
public function loadRowList($key = null)
|
|
{
|
|
$array = [];
|
|
|
|
// Execute the query and get the result set cursor.
|
|
if (!($cursor = $this->execute()))
|
|
{
|
|
return null;
|
|
}
|
|
|
|
// Get all of the rows from the result set as arrays.
|
|
while ($row = $this->fetchArray($cursor))
|
|
{
|
|
if ($key !== null)
|
|
{
|
|
$array[$row[$key]] = $row;
|
|
}
|
|
else
|
|
{
|
|
$array[] = $row;
|
|
}
|
|
}
|
|
|
|
// Free up system resources and return.
|
|
$this->freeResult($cursor);
|
|
|
|
return $array;
|
|
}
|
|
|
|
/**
|
|
* Locks a table in the database.
|
|
*
|
|
* @param string $tableName The name of the table to unlock.
|
|
*
|
|
* @return Base Returns this object to support chaining.
|
|
*/
|
|
public abstract function lockTable($tableName);
|
|
|
|
/**
|
|
* Wrap an SQL statement identifier name such as column, table or database names in quotes to prevent injection
|
|
* risks and reserved word conflicts.
|
|
*
|
|
* @param string $name The identifier name to wrap in quotes.
|
|
*
|
|
* @return string The quote wrapped name.
|
|
*/
|
|
public function nameQuote($name)
|
|
{
|
|
return $this->quoteName($name);
|
|
}
|
|
|
|
/**
|
|
* Opens a database connection. It MUST be overriden by children classes
|
|
*
|
|
* @return Base
|
|
*/
|
|
public function open()
|
|
{
|
|
// Don't try to reconnect if we're already connected
|
|
if (is_resource($this->connection) && !is_null($this->connection))
|
|
{
|
|
return $this;
|
|
}
|
|
|
|
// Determine utf-8 support
|
|
$this->utf = $this->hasUTF();
|
|
|
|
// Set charactersets (needed for MySQL 4.1.2+)
|
|
if ($this->utf)
|
|
{
|
|
$this->setUTF();
|
|
}
|
|
|
|
// Select the current database
|
|
$this->select($this->_database);
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Execute the SQL statement.
|
|
*
|
|
* @return mixed A database cursor resource on success, boolean false on failure.
|
|
*/
|
|
abstract public function query();
|
|
|
|
/**
|
|
* Method to quote and optionally escape a string to database requirements for insertion into the database.
|
|
*
|
|
* @param string $text The string to quote.
|
|
* @param boolean $escape True (default) to escape the string, false to leave it unchanged.
|
|
*/
|
|
public function quote($text, $escape = true)
|
|
{
|
|
return '\'' . ($escape ? $this->escape($text) : $text) . '\'';
|
|
}
|
|
|
|
/**
|
|
* Wrap an SQL statement identifier name such as column, table or database names in quotes to prevent injection
|
|
* risks and reserved word conflicts.
|
|
*
|
|
* @param mixed $name The identifier name to wrap in quotes, or an array of identifier names to wrap in
|
|
* quotes. Each type supports dot-notation name.
|
|
* @param mixed $as The AS query part associated to $name. It can be string or array, in latter case it
|
|
* has to be same length of $name; if is null there will not be any AS part for string
|
|
* or array element.
|
|
*/
|
|
public function quoteName($name, $as = null)
|
|
{
|
|
if (!is_array($name))
|
|
{
|
|
$quotedName = $this->quoteNameStr(explode('.', $name));
|
|
|
|
$quotedAs = '';
|
|
if (!is_null($as))
|
|
{
|
|
$as = (array) $as;
|
|
$quotedAs .= ' AS ' . $this->quoteNameStr($as);
|
|
}
|
|
|
|
return $quotedName . $quotedAs;
|
|
}
|
|
else
|
|
{
|
|
$fin = [];
|
|
|
|
if (is_null($as))
|
|
{
|
|
foreach ($name as $str)
|
|
{
|
|
$fin[] = $this->quoteName($str);
|
|
}
|
|
}
|
|
elseif (is_array($name) && (count($name) == (is_array($as) || $as instanceof \Countable ? count($as) : 0)))
|
|
{
|
|
$count = count($name);
|
|
for ($i = 0; $i < $count; $i++)
|
|
{
|
|
$fin[] = $this->quoteName($name[$i], $as[$i]);
|
|
}
|
|
}
|
|
|
|
return $fin;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Renames a table in the database.
|
|
*
|
|
* @param string $oldTable The name of the table to be renamed
|
|
* @param string $newTable The new name for the table.
|
|
* @param string $backup Table prefix
|
|
* @param string $prefix For the table - used to rename constraints in non-mysql databases
|
|
*
|
|
* @return Base Returns this object to support chaining.
|
|
*/
|
|
public abstract function renameTable($oldTable, $newTable, $backup = null, $prefix = null);
|
|
|
|
/**
|
|
* This function replaces a string identifier <var>$prefix</var> with the string held is the
|
|
* <var>tablePrefix</var> class variable.
|
|
*
|
|
* @param string $query The SQL statement to prepare.
|
|
* @param string $prefix The common table prefix.
|
|
*
|
|
* @return string The processed SQL statement.
|
|
*/
|
|
public function replacePrefix($query, $prefix = '#__')
|
|
{
|
|
$escaped = false;
|
|
$startPos = 0;
|
|
$quoteChar = '';
|
|
$literal = '';
|
|
|
|
$query = trim($query);
|
|
$n = strlen($query);
|
|
|
|
while ($startPos < $n)
|
|
{
|
|
$ip = strpos($query, $prefix, $startPos);
|
|
if ($ip === false)
|
|
{
|
|
break;
|
|
}
|
|
|
|
$j = strpos($query, "'", $startPos);
|
|
$k = strpos($query, '"', $startPos);
|
|
if (($k !== false) && (($k < $j) || ($j === false)))
|
|
{
|
|
$quoteChar = '"';
|
|
$j = $k;
|
|
}
|
|
else
|
|
{
|
|
$quoteChar = "'";
|
|
}
|
|
|
|
if ($j === false)
|
|
{
|
|
$j = $n;
|
|
}
|
|
|
|
$literal .= str_replace($prefix, $this->tablePrefix, substr($query, $startPos, $j - $startPos));
|
|
$startPos = $j;
|
|
|
|
$j = $startPos + 1;
|
|
|
|
if ($j >= $n)
|
|
{
|
|
break;
|
|
}
|
|
|
|
// Quote comes first, find end of quote
|
|
while (true)
|
|
{
|
|
$k = strpos($query, $quoteChar, $j);
|
|
$escaped = false;
|
|
if ($k === false)
|
|
{
|
|
break;
|
|
}
|
|
$l = $k - 1;
|
|
while ($l >= 0 && $query[$l] == '\\')
|
|
{
|
|
$l--;
|
|
$escaped = !$escaped;
|
|
}
|
|
if ($escaped)
|
|
{
|
|
$j = $k + 1;
|
|
continue;
|
|
}
|
|
break;
|
|
}
|
|
if ($k === false)
|
|
{
|
|
// Error in the query - no end quote; ignore it
|
|
break;
|
|
}
|
|
$literal .= substr($query, $startPos, $k - $startPos + 1);
|
|
$startPos = $k + 1;
|
|
}
|
|
if ($startPos < $n)
|
|
{
|
|
$literal .= substr($query, $startPos, $n - $startPos);
|
|
}
|
|
|
|
return $literal;
|
|
}
|
|
|
|
/**
|
|
* Resets the error condition in the driver. Useful to reset the error state after handling a thrown exception.
|
|
*
|
|
* @return $this for chaining
|
|
*/
|
|
public function resetErrors()
|
|
{
|
|
$this->errorNum = 0;
|
|
$this->errorMsg = '';
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Select a database for use.
|
|
*
|
|
* @param string $database The name of the database to select for use.
|
|
*
|
|
* @return boolean True if the database was successfully selected.
|
|
*/
|
|
abstract public function select($database);
|
|
|
|
/**
|
|
* Sets the database debugging state for the driver.
|
|
*
|
|
* @param boolean $level True to enable debugging.
|
|
*
|
|
* @return boolean The old debugging level.
|
|
*/
|
|
public function setDebug($level)
|
|
{
|
|
$previous = $this->debug;
|
|
$this->debug = (bool) $level;
|
|
|
|
return $previous;
|
|
}
|
|
|
|
/**
|
|
* Sets the SQL statement string for later execution.
|
|
*
|
|
* @param mixed $query The SQL statement to set either as a QueryBase object or a string.
|
|
* @param integer $offset The affected row offset to set.
|
|
* @param integer $limit The maximum affected rows to set.
|
|
*
|
|
* @return self This object to support method chaining.
|
|
*/
|
|
public function setQuery($query, $offset = 0, $limit = 0)
|
|
{
|
|
$this->sql = $query;
|
|
$this->limit = (int) $limit;
|
|
$this->offset = (int) $offset;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Set the connection to use UTF-8 character encoding.
|
|
*
|
|
* @return boolean True on success.
|
|
*/
|
|
abstract public function setUTF();
|
|
|
|
/**
|
|
* Method to commit a transaction.
|
|
*
|
|
* @return void
|
|
*/
|
|
abstract public function transactionCommit();
|
|
|
|
/**
|
|
* Method to roll back a transaction.
|
|
*
|
|
* @return void
|
|
*/
|
|
abstract public function transactionRollback();
|
|
|
|
/**
|
|
* Method to initialize a transaction.
|
|
*
|
|
* @return void
|
|
*/
|
|
abstract public function transactionStart();
|
|
|
|
/**
|
|
* Method to truncate a table.
|
|
*
|
|
* @param string $table The table to truncate
|
|
*
|
|
* @return void
|
|
*/
|
|
public function truncateTable($table)
|
|
{
|
|
$this->setQuery('TRUNCATE TABLE ' . $this->quoteName($table));
|
|
$this->query();
|
|
}
|
|
|
|
/**
|
|
* Unlocks tables in the database.
|
|
*
|
|
* @return Base Returns this object to support chaining.
|
|
*/
|
|
public abstract function unlockTables();
|
|
|
|
/**
|
|
* Updates a row in a table based on an object's properties.
|
|
*
|
|
* @param string $table The name of the database table to update.
|
|
* @param object &$object A reference to an object whose public properties match the table fields.
|
|
* @param string $key The name of the primary key.
|
|
* @param boolean $nulls True to update null fields or false to ignore them.
|
|
*
|
|
* @return boolean True on success.
|
|
*/
|
|
public function updateObject($table, &$object, $key, $nulls = false)
|
|
{
|
|
$fields = [];
|
|
$where = [];
|
|
|
|
if (is_string($key))
|
|
{
|
|
$key = [$key];
|
|
}
|
|
|
|
if (is_object($key))
|
|
{
|
|
$key = (array) $key;
|
|
}
|
|
|
|
// Create the base update statement.
|
|
$statement = 'UPDATE ' . $this->quoteName($table) . ' SET %s WHERE %s';
|
|
|
|
// Iterate over the object variables to build the query fields/value pairs.
|
|
foreach (get_object_vars($object) as $k => $v)
|
|
{
|
|
// Only process scalars that are not internal fields.
|
|
if (is_array($v) || is_object($v) || ($k[0] == '_'))
|
|
{
|
|
continue;
|
|
}
|
|
|
|
// Set the primary key to the WHERE clause instead of a field to update.
|
|
if (in_array($k, $key))
|
|
{
|
|
$where[] = $this->quoteName($k) . '=' . $this->quote($v);
|
|
continue;
|
|
}
|
|
|
|
// Prepare and sanitize the fields and values for the database query.
|
|
if ($v === null)
|
|
{
|
|
// If the value is null and we want to update nulls then set it.
|
|
if ($nulls)
|
|
{
|
|
$val = 'NULL';
|
|
}
|
|
// If the value is null and we do not want to update nulls then ignore this field.
|
|
else
|
|
{
|
|
continue;
|
|
}
|
|
}
|
|
// The field is not null so we prep it for update.
|
|
else
|
|
{
|
|
$val = $this->quote($v);
|
|
}
|
|
|
|
// Add the field to be updated.
|
|
$fields[] = $this->quoteName($k) . '=' . $val;
|
|
}
|
|
|
|
// We don't have any fields to update.
|
|
if (empty($fields))
|
|
{
|
|
return true;
|
|
}
|
|
|
|
// Set the query and execute the update.
|
|
$this->setQuery(sprintf($statement, implode(",", $fields), implode(' AND ', $where)));
|
|
|
|
return $this->execute();
|
|
}
|
|
|
|
/**
|
|
* Method to fetch a row from the result set cursor as an array.
|
|
*
|
|
* @param mixed $cursor The optional result set cursor from which to fetch the row.
|
|
*
|
|
* @return mixed Either the next row from the result set or false if there are no more rows.
|
|
*/
|
|
abstract protected function fetchArray($cursor = null);
|
|
|
|
/**
|
|
* Method to fetch a row from the result set cursor as an object.
|
|
*
|
|
* @param mixed $cursor The optional result set cursor from which to fetch the row.
|
|
* @param string $class The class name to use for the returned row object.
|
|
*
|
|
* @return mixed Either the next row from the result set or false if there are no more rows.
|
|
*/
|
|
abstract protected function fetchObject($cursor = null, $class = 'stdClass');
|
|
|
|
/**
|
|
* Return the query string to alter the database character set.
|
|
*
|
|
* @param string $dbName The database name
|
|
*
|
|
* @return string The query that alter the database query string
|
|
*/
|
|
protected function getAlterDbCharacterSet($dbName)
|
|
{
|
|
$query = 'ALTER DATABASE ' . $this->quoteName($dbName) . ' CHARACTER SET `utf8`';
|
|
|
|
return $query;
|
|
}
|
|
|
|
/**
|
|
* Return the query string to create new Database.
|
|
* Each database driver, other than MySQL, need to override this member to return correct string.
|
|
*
|
|
* @param object $options Object used to pass user and database name to database driver.
|
|
* This object must have "db_name" and "db_user" set.
|
|
* @param boolean $utf True if the database supports the UTF-8 character set.
|
|
*
|
|
* @return string The query that creates database
|
|
*/
|
|
protected function getCreateDatabaseQuery($options, $utf)
|
|
{
|
|
if ($utf)
|
|
{
|
|
$query = 'CREATE DATABASE ' . $this->quoteName($options->db_name) . ' CHARACTER SET `utf8`';
|
|
}
|
|
else
|
|
{
|
|
$query = 'CREATE DATABASE ' . $this->quoteName($options->db_name);
|
|
}
|
|
|
|
return $query;
|
|
}
|
|
|
|
/**
|
|
* Gets the name of the database used by this connection.
|
|
*
|
|
* @return string
|
|
*/
|
|
protected function getDatabase()
|
|
{
|
|
return $this->_database;
|
|
}
|
|
|
|
/**
|
|
* Quote strings coming from quoteName call.
|
|
*
|
|
* @param array $strArr Array of strings coming from quoteName dot-explosion.
|
|
*
|
|
* @return string Dot-imploded string of quoted parts.
|
|
*/
|
|
protected function quoteNameStr($strArr)
|
|
{
|
|
$parts = [];
|
|
$q = $this->nameQuote;
|
|
|
|
foreach ($strArr as $part)
|
|
{
|
|
if (is_null($part))
|
|
{
|
|
continue;
|
|
}
|
|
|
|
if (strlen($q) == 1)
|
|
{
|
|
$parts[] = $q . $part . $q;
|
|
}
|
|
else
|
|
{
|
|
$parts[] = $q[0] . $part . $q[1];
|
|
}
|
|
}
|
|
|
|
return implode('.', $parts);
|
|
}
|
|
}
|