/lib/dml/mysqli_native_moodle_database.php
PHP | 1327 lines | 976 code | 123 blank | 228 comment | 113 complexity | 5a211702214189d508b20a763961033f MD5 | raw file
- <?php
- // This file is part of Moodle - http://moodle.org/
- //
- // Moodle is free software: you can redistribute it and/or modify
- // it under the terms of the GNU General Public License as published by
- // the Free Software Foundation, either version 3 of the License, or
- // (at your option) any later version.
- //
- // Moodle is distributed in the hope that it will be useful,
- // but WITHOUT ANY WARRANTY; without even the implied warranty of
- // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- // GNU General Public License for more details.
- //
- // You should have received a copy of the GNU General Public License
- // along with Moodle. If not, see <http://www.gnu.org/licenses/>.
- /**
- * Native mysqli class representing moodle database interface.
- *
- * @package core_dml
- * @copyright 2008 Petr Skoda (http://skodak.org)
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
- defined('MOODLE_INTERNAL') || die();
- require_once(__DIR__.'/moodle_database.php');
- require_once(__DIR__.'/mysqli_native_moodle_recordset.php');
- require_once(__DIR__.'/mysqli_native_moodle_temptables.php');
- /**
- * Native mysqli class representing moodle database interface.
- *
- * @package core_dml
- * @copyright 2008 Petr Skoda (http://skodak.org)
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
- class mysqli_native_moodle_database extends moodle_database {
- protected $mysqli = null;
- private $transactions_supported = null;
- /**
- * Attempt to create the database
- * @param string $dbhost
- * @param string $dbuser
- * @param string $dbpass
- * @param string $dbname
- * @return bool success
- * @throws dml_exception A DML specific exception is thrown for any errors.
- */
- public function create_database($dbhost, $dbuser, $dbpass, $dbname, array $dboptions=null) {
- $driverstatus = $this->driver_installed();
- if ($driverstatus !== true) {
- throw new dml_exception('dbdriverproblem', $driverstatus);
- }
- if (!empty($dboptions['dbsocket'])
- and (strpos($dboptions['dbsocket'], '/') !== false or strpos($dboptions['dbsocket'], '\\') !== false)) {
- $dbsocket = $dboptions['dbsocket'];
- } else {
- $dbsocket = ini_get('mysqli.default_socket');
- }
- if (empty($dboptions['dbport'])) {
- $dbport = (int)ini_get('mysqli.default_port');
- } else {
- $dbport = (int)$dboptions['dbport'];
- }
- // verify ini.get does not return nonsense
- if (empty($dbport)) {
- $dbport = 3306;
- }
- ob_start();
- $conn = new mysqli($dbhost, $dbuser, $dbpass, '', $dbport, $dbsocket); // Connect without db
- $dberr = ob_get_contents();
- ob_end_clean();
- $errorno = @$conn->connect_errno;
- if ($errorno !== 0) {
- throw new dml_connection_exception($dberr);
- }
- if (isset($dboptions['dbcollation']) and strpos($dboptions['dbcollation'], 'utf8_') === 0) {
- $collation = $dboptions['dbcollation'];
- } else {
- $collation = 'utf8_unicode_ci';
- }
- $result = $conn->query("CREATE DATABASE $dbname DEFAULT CHARACTER SET utf8 DEFAULT COLLATE ".$collation);
- $conn->close();
- if (!$result) {
- throw new dml_exception('cannotcreatedb');
- }
- return true;
- }
- /**
- * Detects if all needed PHP stuff installed.
- * Note: can be used before connect()
- * @return mixed true if ok, string if something
- */
- public function driver_installed() {
- if (!extension_loaded('mysqli')) {
- return get_string('mysqliextensionisnotpresentinphp', 'install');
- }
- return true;
- }
- /**
- * Returns database family type - describes SQL dialect
- * Note: can be used before connect()
- * @return string db family name (mysql, postgres, mssql, oracle, etc.)
- */
- public function get_dbfamily() {
- return 'mysql';
- }
- /**
- * Returns more specific database driver type
- * Note: can be used before connect()
- * @return string db type mysqli, pgsql, oci, mssql, sqlsrv
- */
- protected function get_dbtype() {
- return 'mysqli';
- }
- /**
- * Returns general database library name
- * Note: can be used before connect()
- * @return string db type pdo, native
- */
- protected function get_dblibrary() {
- return 'native';
- }
- /**
- * Returns the current MySQL db engine.
- *
- * This is an ugly workaround for MySQL default engine problems,
- * Moodle is designed to work best on ACID compliant databases
- * with full transaction support. Do not use MyISAM.
- *
- * @return string or null MySQL engine name
- */
- public function get_dbengine() {
- if (isset($this->dboptions['dbengine'])) {
- return $this->dboptions['dbengine'];
- }
- if ($this->external) {
- return null;
- }
- $engine = null;
- // Look for current engine of our config table (the first table that gets created),
- // so that we create all tables with the same engine.
- $sql = "SELECT engine
- FROM INFORMATION_SCHEMA.TABLES
- WHERE table_schema = DATABASE() AND table_name = '{$this->prefix}config'";
- $this->query_start($sql, NULL, SQL_QUERY_AUX);
- $result = $this->mysqli->query($sql);
- $this->query_end($result);
- if ($rec = $result->fetch_assoc()) {
- $engine = $rec['engine'];
- }
- $result->close();
- if ($engine) {
- // Cache the result to improve performance.
- $this->dboptions['dbengine'] = $engine;
- return $engine;
- }
- // get the default database engine
- $sql = "SELECT @@storage_engine";
- $this->query_start($sql, NULL, SQL_QUERY_AUX);
- $result = $this->mysqli->query($sql);
- $this->query_end($result);
- if ($rec = $result->fetch_assoc()) {
- $engine = $rec['@@storage_engine'];
- }
- $result->close();
- if ($engine === 'MyISAM') {
- // we really do not want MyISAM for Moodle, InnoDB or XtraDB is a reasonable defaults if supported
- $sql = "SHOW STORAGE ENGINES";
- $this->query_start($sql, NULL, SQL_QUERY_AUX);
- $result = $this->mysqli->query($sql);
- $this->query_end($result);
- $engines = array();
- while ($res = $result->fetch_assoc()) {
- if ($res['Support'] === 'YES' or $res['Support'] === 'DEFAULT') {
- $engines[$res['Engine']] = true;
- }
- }
- $result->close();
- if (isset($engines['InnoDB'])) {
- $engine = 'InnoDB';
- }
- if (isset($engines['XtraDB'])) {
- $engine = 'XtraDB';
- }
- }
- // Cache the result to improve performance.
- $this->dboptions['dbengine'] = $engine;
- return $engine;
- }
- /**
- * Returns the current MySQL db collation.
- *
- * This is an ugly workaround for MySQL default collation problems.
- *
- * @return string or null MySQL collation name
- */
- public function get_dbcollation() {
- if (isset($this->dboptions['dbcollation'])) {
- return $this->dboptions['dbcollation'];
- }
- if ($this->external) {
- return null;
- }
- $collation = null;
- // Look for current collation of our config table (the first table that gets created),
- // so that we create all tables with the same collation.
- $sql = "SELECT collation_name
- FROM INFORMATION_SCHEMA.COLUMNS
- WHERE table_schema = DATABASE() AND table_name = '{$this->prefix}config' AND column_name = 'value'";
- $this->query_start($sql, NULL, SQL_QUERY_AUX);
- $result = $this->mysqli->query($sql);
- $this->query_end($result);
- if ($rec = $result->fetch_assoc()) {
- $collation = $rec['collation_name'];
- }
- $result->close();
- if (!$collation) {
- // Get the default database collation, but only if using UTF-8.
- $sql = "SELECT @@collation_database";
- $this->query_start($sql, NULL, SQL_QUERY_AUX);
- $result = $this->mysqli->query($sql);
- $this->query_end($result);
- if ($rec = $result->fetch_assoc()) {
- if (strpos($rec['@@collation_database'], 'utf8_') === 0) {
- $collation = $rec['@@collation_database'];
- }
- }
- $result->close();
- }
- if (!$collation) {
- // We want only utf8 compatible collations.
- $collation = null;
- $sql = "SHOW COLLATION WHERE Collation LIKE 'utf8\_%' AND Charset = 'utf8'";
- $this->query_start($sql, NULL, SQL_QUERY_AUX);
- $result = $this->mysqli->query($sql);
- $this->query_end($result);
- while ($res = $result->fetch_assoc()) {
- $collation = $res['Collation'];
- if (strtoupper($res['Default']) === 'YES') {
- $collation = $res['Collation'];
- break;
- }
- }
- $result->close();
- }
- // Cache the result to improve performance.
- $this->dboptions['dbcollation'] = $collation;
- return $collation;
- }
- /**
- * Returns localised database type name
- * Note: can be used before connect()
- * @return string
- */
- public function get_name() {
- return get_string('nativemysqli', 'install');
- }
- /**
- * Returns localised database configuration help.
- * Note: can be used before connect()
- * @return string
- */
- public function get_configuration_help() {
- return get_string('nativemysqlihelp', 'install');
- }
- /**
- * Returns localised database description
- * Note: can be used before connect()
- * @return string
- */
- public function get_configuration_hints() {
- return get_string('databasesettingssub_mysqli', 'install');
- }
- /**
- * Diagnose database and tables, this function is used
- * to verify database and driver settings, db engine types, etc.
- *
- * @return string null means everything ok, string means problem found.
- */
- public function diagnose() {
- $sloppymyisamfound = false;
- $prefix = str_replace('_', '\\_', $this->prefix);
- $sql = "SELECT COUNT('x')
- FROM INFORMATION_SCHEMA.TABLES
- WHERE table_schema = DATABASE()
- AND table_name LIKE BINARY '$prefix%'
- AND Engine = 'MyISAM'";
- $this->query_start($sql, null, SQL_QUERY_AUX);
- $result = $this->mysqli->query($sql);
- $this->query_end($result);
- if ($result) {
- if ($arr = $result->fetch_assoc()) {
- $count = reset($arr);
- if ($count) {
- $sloppymyisamfound = true;
- }
- }
- $result->close();
- }
- if ($sloppymyisamfound) {
- return get_string('myisamproblem', 'error');
- } else {
- return null;
- }
- }
- /**
- * Connect to db
- * Must be called before other methods.
- * @param string $dbhost The database host.
- * @param string $dbuser The database username.
- * @param string $dbpass The database username's password.
- * @param string $dbname The name of the database being connected to.e
- * @param mixed $prefix string means moodle db prefix, false used for external databases where prefix not used
- * @param array $dboptions driver specific options
- * @return bool success
- */
- public function connect($dbhost, $dbuser, $dbpass, $dbname, $prefix, array $dboptions=null) {
- $driverstatus = $this->driver_installed();
- if ($driverstatus !== true) {
- throw new dml_exception('dbdriverproblem', $driverstatus);
- }
- $this->store_settings($dbhost, $dbuser, $dbpass, $dbname, $prefix, $dboptions);
- // dbsocket is used ONLY if host is NULL or 'localhost',
- // you can not disable it because it is always tried if dbhost is 'localhost'
- if (!empty($this->dboptions['dbsocket'])
- and (strpos($this->dboptions['dbsocket'], '/') !== false or strpos($this->dboptions['dbsocket'], '\\') !== false)) {
- $dbsocket = $this->dboptions['dbsocket'];
- } else {
- $dbsocket = ini_get('mysqli.default_socket');
- }
- if (empty($this->dboptions['dbport'])) {
- $dbport = (int)ini_get('mysqli.default_port');
- } else {
- $dbport = (int)$this->dboptions['dbport'];
- }
- // verify ini.get does not return nonsense
- if (empty($dbport)) {
- $dbport = 3306;
- }
- if ($dbhost and !empty($this->dboptions['dbpersist'])) {
- $dbhost = "p:$dbhost";
- }
- ob_start();
- $this->mysqli = new mysqli($dbhost, $dbuser, $dbpass, $dbname, $dbport, $dbsocket);
- $dberr = ob_get_contents();
- ob_end_clean();
- $errorno = @$this->mysqli->connect_errno;
- if ($errorno !== 0) {
- $this->mysqli = null;
- throw new dml_connection_exception($dberr);
- }
- $this->query_start("--set_charset()", null, SQL_QUERY_AUX);
- $this->mysqli->set_charset('utf8');
- $this->query_end(true);
- // If available, enforce strict mode for the session. That guaranties
- // standard behaviour under some situations, avoiding some MySQL nasty
- // habits like truncating data or performing some transparent cast losses.
- // With strict mode enforced, Moodle DB layer will be consistently throwing
- // the corresponding exceptions as expected.
- $si = $this->get_server_info();
- if (version_compare($si['version'], '5.0.2', '>=')) {
- $sql = "SET SESSION sql_mode = 'STRICT_ALL_TABLES'";
- $this->query_start($sql, null, SQL_QUERY_AUX);
- $result = $this->mysqli->query($sql);
- $this->query_end($result);
- }
- // Connection stabilised and configured, going to instantiate the temptables controller
- $this->temptables = new mysqli_native_moodle_temptables($this);
- return true;
- }
- /**
- * Close database connection and release all resources
- * and memory (especially circular memory references).
- * Do NOT use connect() again, create a new instance if needed.
- */
- public function dispose() {
- parent::dispose(); // Call parent dispose to write/close session and other common stuff before closing connection
- if ($this->mysqli) {
- $this->mysqli->close();
- $this->mysqli = null;
- }
- }
- /**
- * Returns database server info array
- * @return array Array containing 'description' and 'version' info
- */
- public function get_server_info() {
- return array('description'=>$this->mysqli->server_info, 'version'=>$this->mysqli->server_info);
- }
- /**
- * Returns supported query parameter types
- * @return int bitmask of accepted SQL_PARAMS_*
- */
- protected function allowed_param_types() {
- return SQL_PARAMS_QM;
- }
- /**
- * Returns last error reported by database engine.
- * @return string error message
- */
- public function get_last_error() {
- return $this->mysqli->error;
- }
- /**
- * Return tables in database WITHOUT current prefix
- * @param bool $usecache if true, returns list of cached tables.
- * @return array of table names in lowercase and without prefix
- */
- public function get_tables($usecache=true) {
- if ($usecache and $this->tables !== null) {
- return $this->tables;
- }
- $this->tables = array();
- $prefix = str_replace('_', '\\_', $this->prefix);
- $sql = "SHOW TABLES LIKE '$prefix%'";
- $this->query_start($sql, null, SQL_QUERY_AUX);
- $result = $this->mysqli->query($sql);
- $this->query_end($result);
- $len = strlen($this->prefix);
- if ($result) {
- while ($arr = $result->fetch_assoc()) {
- $tablename = reset($arr);
- $tablename = substr($tablename, $len);
- $this->tables[$tablename] = $tablename;
- }
- $result->close();
- }
- // Add the currently available temptables
- $this->tables = array_merge($this->tables, $this->temptables->get_temptables());
- return $this->tables;
- }
- /**
- * Return table indexes - everything lowercased.
- * @param string $table The table we want to get indexes from.
- * @return array An associative array of indexes containing 'unique' flag and 'columns' being indexed
- */
- public function get_indexes($table) {
- $indexes = array();
- $sql = "SHOW INDEXES FROM {$this->prefix}$table";
- $this->query_start($sql, null, SQL_QUERY_AUX);
- $result = $this->mysqli->query($sql);
- try {
- $this->query_end($result);
- } catch (dml_read_exception $e) {
- return $indexes; // table does not exist - no indexes...
- }
- if ($result) {
- while ($res = $result->fetch_object()) {
- if ($res->Key_name === 'PRIMARY') {
- continue;
- }
- if (!isset($indexes[$res->Key_name])) {
- $indexes[$res->Key_name] = array('unique'=>empty($res->Non_unique), 'columns'=>array());
- }
- $indexes[$res->Key_name]['columns'][$res->Seq_in_index-1] = $res->Column_name;
- }
- $result->close();
- }
- return $indexes;
- }
- /**
- * Returns detailed information about columns in table. This information is cached internally.
- * @param string $table name
- * @param bool $usecache
- * @return array array of database_column_info objects indexed with column names
- */
- public function get_columns($table, $usecache=true) {
- if ($usecache) {
- $properties = array('dbfamily' => $this->get_dbfamily(), 'settings' => $this->get_settings_hash());
- $cache = cache::make('core', 'databasemeta', $properties);
- if ($data = $cache->get($table)) {
- return $data;
- }
- }
- $structure = array();
- $sql = "SELECT column_name, data_type, character_maximum_length, numeric_precision,
- numeric_scale, is_nullable, column_type, column_default, column_key, extra
- FROM information_schema.columns
- WHERE table_name = '" . $this->prefix.$table . "'
- AND table_schema = '" . $this->dbname . "'
- ORDER BY ordinal_position";
- $this->query_start($sql, null, SQL_QUERY_AUX);
- $result = $this->mysqli->query($sql);
- $this->query_end(true); // Don't want to throw anything here ever. MDL-30147
- if ($result === false) {
- return array();
- }
- if ($result->num_rows > 0) {
- // standard table exists
- while ($rawcolumn = $result->fetch_assoc()) {
- $info = (object)$this->get_column_info((object)$rawcolumn);
- $structure[$info->name] = new database_column_info($info);
- }
- $result->close();
- } else {
- // temporary tables are not in information schema, let's try it the old way
- $result->close();
- $sql = "SHOW COLUMNS FROM {$this->prefix}$table";
- $this->query_start($sql, null, SQL_QUERY_AUX);
- $result = $this->mysqli->query($sql);
- $this->query_end(true);
- if ($result === false) {
- return array();
- }
- while ($rawcolumn = $result->fetch_assoc()) {
- $rawcolumn = (object)array_change_key_case($rawcolumn, CASE_LOWER);
- $rawcolumn->column_name = $rawcolumn->field; unset($rawcolumn->field);
- $rawcolumn->column_type = $rawcolumn->type; unset($rawcolumn->type);
- $rawcolumn->character_maximum_length = null;
- $rawcolumn->numeric_precision = null;
- $rawcolumn->numeric_scale = null;
- $rawcolumn->is_nullable = $rawcolumn->null; unset($rawcolumn->null);
- $rawcolumn->column_default = $rawcolumn->default; unset($rawcolumn->default);
- $rawcolumn->column_key = $rawcolumn->key; unset($rawcolumn->default);
- if (preg_match('/(enum|varchar)\((\d+)\)/i', $rawcolumn->column_type, $matches)) {
- $rawcolumn->data_type = $matches[1];
- $rawcolumn->character_maximum_length = $matches[2];
- } else if (preg_match('/([a-z]*int[a-z]*)\((\d+)\)/i', $rawcolumn->column_type, $matches)) {
- $rawcolumn->data_type = $matches[1];
- $rawcolumn->numeric_precision = $matches[2];
- $rawcolumn->max_length = $rawcolumn->numeric_precision;
- $type = strtoupper($matches[1]);
- if ($type === 'BIGINT') {
- $maxlength = 18;
- } else if ($type === 'INT' or $type === 'INTEGER') {
- $maxlength = 9;
- } else if ($type === 'MEDIUMINT') {
- $maxlength = 6;
- } else if ($type === 'SMALLINT') {
- $maxlength = 4;
- } else if ($type === 'TINYINT') {
- $maxlength = 2;
- } else {
- // This should not happen.
- $maxlength = 0;
- }
- if ($maxlength < $rawcolumn->max_length) {
- $rawcolumn->max_length = $maxlength;
- }
- } else if (preg_match('/(decimal)\((\d+),(\d+)\)/i', $rawcolumn->column_type, $matches)) {
- $rawcolumn->data_type = $matches[1];
- $rawcolumn->numeric_precision = $matches[2];
- $rawcolumn->numeric_scale = $matches[3];
- } else if (preg_match('/(double|float)(\((\d+),(\d+)\))?/i', $rawcolumn->column_type, $matches)) {
- $rawcolumn->data_type = $matches[1];
- $rawcolumn->numeric_precision = isset($matches[3]) ? $matches[3] : null;
- $rawcolumn->numeric_scale = isset($matches[4]) ? $matches[4] : null;
- } else if (preg_match('/([a-z]*text)/i', $rawcolumn->column_type, $matches)) {
- $rawcolumn->data_type = $matches[1];
- $rawcolumn->character_maximum_length = -1; // unknown
- } else if (preg_match('/([a-z]*blob)/i', $rawcolumn->column_type, $matches)) {
- $rawcolumn->data_type = $matches[1];
- } else {
- $rawcolumn->data_type = $rawcolumn->column_type;
- }
- $info = $this->get_column_info($rawcolumn);
- $structure[$info->name] = new database_column_info($info);
- }
- $result->close();
- }
- if ($usecache) {
- $result = $cache->set($table, $structure);
- }
- return $structure;
- }
- /**
- * Returns moodle column info for raw column from information schema.
- * @param stdClass $rawcolumn
- * @return stdClass standardised colum info
- */
- private function get_column_info(stdClass $rawcolumn) {
- $rawcolumn = (object)$rawcolumn;
- $info = new stdClass();
- $info->name = $rawcolumn->column_name;
- $info->type = $rawcolumn->data_type;
- $info->meta_type = $this->mysqltype2moodletype($rawcolumn->data_type);
- $info->default_value = $rawcolumn->column_default;
- $info->has_default = !is_null($rawcolumn->column_default);
- $info->not_null = ($rawcolumn->is_nullable === 'NO');
- $info->primary_key = ($rawcolumn->column_key === 'PRI');
- $info->binary = false;
- $info->unsigned = null;
- $info->auto_increment = false;
- $info->unique = null;
- $info->scale = null;
- if ($info->meta_type === 'C') {
- $info->max_length = $rawcolumn->character_maximum_length;
- } else if ($info->meta_type === 'I') {
- if ($info->primary_key) {
- $info->meta_type = 'R';
- $info->unique = true;
- }
- // Return number of decimals, not bytes here.
- $info->max_length = $rawcolumn->numeric_precision;
- if (preg_match('/([a-z]*int[a-z]*)\((\d+)\)/i', $rawcolumn->column_type, $matches)) {
- $type = strtoupper($matches[1]);
- if ($type === 'BIGINT') {
- $maxlength = 18;
- } else if ($type === 'INT' or $type === 'INTEGER') {
- $maxlength = 9;
- } else if ($type === 'MEDIUMINT') {
- $maxlength = 6;
- } else if ($type === 'SMALLINT') {
- $maxlength = 4;
- } else if ($type === 'TINYINT') {
- $maxlength = 2;
- } else {
- // This should not happen.
- $maxlength = 0;
- }
- // It is possible that display precision is different from storage type length,
- // always use the smaller value to make sure our data fits.
- if ($maxlength < $info->max_length) {
- $info->max_length = $maxlength;
- }
- }
- $info->unsigned = (stripos($rawcolumn->column_type, 'unsigned') !== false);
- $info->auto_increment= (strpos($rawcolumn->extra, 'auto_increment') !== false);
- } else if ($info->meta_type === 'N') {
- $info->max_length = $rawcolumn->numeric_precision;
- $info->scale = $rawcolumn->numeric_scale;
- $info->unsigned = (stripos($rawcolumn->column_type, 'unsigned') !== false);
- } else if ($info->meta_type === 'X') {
- if ("$rawcolumn->character_maximum_length" === '4294967295') { // watch out for PHP max int limits!
- // means maximum moodle size for text column, in other drivers it may also mean unknown size
- $info->max_length = -1;
- } else {
- $info->max_length = $rawcolumn->character_maximum_length;
- }
- $info->primary_key = false;
- } else if ($info->meta_type === 'B') {
- $info->max_length = -1;
- $info->primary_key = false;
- $info->binary = true;
- }
- return $info;
- }
- /**
- * Normalise column type.
- * @param string $mysql_type
- * @return string one character
- * @throws dml_exception
- */
- private function mysqltype2moodletype($mysql_type) {
- $type = null;
- switch(strtoupper($mysql_type)) {
- case 'BIT':
- $type = 'L';
- break;
- case 'TINYINT':
- case 'SMALLINT':
- case 'MEDIUMINT':
- case 'INT':
- case 'INTEGER':
- case 'BIGINT':
- $type = 'I';
- break;
- case 'FLOAT':
- case 'DOUBLE':
- case 'DECIMAL':
- $type = 'N';
- break;
- case 'CHAR':
- case 'ENUM':
- case 'SET':
- case 'VARCHAR':
- $type = 'C';
- break;
- case 'TINYTEXT':
- case 'TEXT':
- case 'MEDIUMTEXT':
- case 'LONGTEXT':
- $type = 'X';
- break;
- case 'BINARY':
- case 'VARBINARY':
- case 'BLOB':
- case 'TINYBLOB':
- case 'MEDIUMBLOB':
- case 'LONGBLOB':
- $type = 'B';
- break;
- case 'DATE':
- case 'TIME':
- case 'DATETIME':
- case 'TIMESTAMP':
- case 'YEAR':
- $type = 'D';
- break;
- }
- if (!$type) {
- throw new dml_exception('invalidmysqlnativetype', $mysql_type);
- }
- return $type;
- }
- /**
- * Normalise values based in RDBMS dependencies (booleans, LOBs...)
- *
- * @param database_column_info $column column metadata corresponding with the value we are going to normalise
- * @param mixed $value value we are going to normalise
- * @return mixed the normalised value
- */
- protected function normalise_value($column, $value) {
- $this->detect_objects($value);
- if (is_bool($value)) { // Always, convert boolean to int
- $value = (int)$value;
- } else if ($value === '') {
- if ($column->meta_type == 'I' or $column->meta_type == 'F' or $column->meta_type == 'N') {
- $value = 0; // prevent '' problems in numeric fields
- }
- // Any float value being stored in varchar or text field is converted to string to avoid
- // any implicit conversion by MySQL
- } else if (is_float($value) and ($column->meta_type == 'C' or $column->meta_type == 'X')) {
- $value = "$value";
- }
- return $value;
- }
- /**
- * Is this database compatible with utf8?
- * @return bool
- */
- public function setup_is_unicodedb() {
- // All new tables are created with this collation, we just have to make sure it is utf8 compatible,
- // if config table already exists it has this collation too.
- $collation = $this->get_dbcollation();
- $sql = "SHOW COLLATION WHERE Collation ='$collation' AND Charset = 'utf8'";
- $this->query_start($sql, NULL, SQL_QUERY_AUX);
- $result = $this->mysqli->query($sql);
- $this->query_end($result);
- if ($result->fetch_assoc()) {
- $return = true;
- } else {
- $return = false;
- }
- $result->close();
- return $return;
- }
- /**
- * Do NOT use in code, to be used by database_manager only!
- * @param string $sql query
- * @return bool true
- * @throws dml_exception A DML specific exception is thrown for any errors.
- */
- public function change_database_structure($sql) {
- $this->reset_caches();
- $this->query_start($sql, null, SQL_QUERY_STRUCTURE);
- $result = $this->mysqli->query($sql);
- $this->query_end($result);
- return true;
- }
- /**
- * Very ugly hack which emulates bound parameters in queries
- * because prepared statements do not use query cache.
- */
- protected function emulate_bound_params($sql, array $params=null) {
- if (empty($params)) {
- return $sql;
- }
- // ok, we have verified sql statement with ? and correct number of params
- $parts = explode('?', $sql);
- $return = array_shift($parts);
- foreach ($params as $param) {
- if (is_bool($param)) {
- $return .= (int)$param;
- } else if (is_null($param)) {
- $return .= 'NULL';
- } else if (is_number($param)) {
- $return .= "'".$param."'"; // we have to always use strings because mysql is using weird automatic int casting
- } else if (is_float($param)) {
- $return .= $param;
- } else {
- $param = $this->mysqli->real_escape_string($param);
- $return .= "'$param'";
- }
- $return .= array_shift($parts);
- }
- return $return;
- }
- /**
- * Execute general sql query. Should be used only when no other method suitable.
- * Do NOT use this to make changes in db structure, use database_manager methods instead!
- * @param string $sql query
- * @param array $params query parameters
- * @return bool true
- * @throws dml_exception A DML specific exception is thrown for any errors.
- */
- public function execute($sql, array $params=null) {
- list($sql, $params, $type) = $this->fix_sql_params($sql, $params);
- if (strpos($sql, ';') !== false) {
- throw new coding_exception('moodle_database::execute() Multiple sql statements found or bound parameters not used properly in query!');
- }
- $rawsql = $this->emulate_bound_params($sql, $params);
- $this->query_start($sql, $params, SQL_QUERY_UPDATE);
- $result = $this->mysqli->query($rawsql);
- $this->query_end($result);
- if ($result === true) {
- return true;
- } else {
- $result->close();
- return true;
- }
- }
- /**
- * Get a number of records as a moodle_recordset using a SQL statement.
- *
- * Since this method is a little less readable, use of it should be restricted to
- * code where it's possible there might be large datasets being returned. For known
- * small datasets use get_records_sql - it leads to simpler code.
- *
- * The return type is like:
- * @see function get_recordset.
- *
- * @param string $sql the SQL select query to execute.
- * @param array $params array of sql parameters
- * @param int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
- * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
- * @return moodle_recordset instance
- * @throws dml_exception A DML specific exception is thrown for any errors.
- */
- public function get_recordset_sql($sql, array $params=null, $limitfrom=0, $limitnum=0) {
- $limitfrom = (int)$limitfrom;
- $limitnum = (int)$limitnum;
- $limitfrom = ($limitfrom < 0) ? 0 : $limitfrom;
- $limitnum = ($limitnum < 0) ? 0 : $limitnum;
- if ($limitfrom or $limitnum) {
- if ($limitnum < 1) {
- $limitnum = "18446744073709551615";
- }
- $sql .= " LIMIT $limitfrom, $limitnum";
- }
- list($sql, $params, $type) = $this->fix_sql_params($sql, $params);
- $rawsql = $this->emulate_bound_params($sql, $params);
- $this->query_start($sql, $params, SQL_QUERY_SELECT);
- // no MYSQLI_USE_RESULT here, it would block write ops on affected tables
- $result = $this->mysqli->query($rawsql, MYSQLI_STORE_RESULT);
- $this->query_end($result);
- return $this->create_recordset($result);
- }
- /**
- * Get all records from a table.
- *
- * This method works around potential memory problems and may improve performance,
- * this method may block access to table until the recordset is closed.
- *
- * @param string $table Name of database table.
- * @return moodle_recordset A moodle_recordset instance {@link function get_recordset}.
- * @throws dml_exception A DML specific exception is thrown for any errors.
- */
- public function export_table_recordset($table) {
- $sql = $this->fix_table_names("SELECT * FROM {{$table}}");
- $this->query_start($sql, array(), SQL_QUERY_SELECT);
- // MYSQLI_STORE_RESULT may eat all memory for large tables, unfortunately MYSQLI_USE_RESULT blocks other queries.
- $result = $this->mysqli->query($sql, MYSQLI_USE_RESULT);
- $this->query_end($result);
- return $this->create_recordset($result);
- }
- protected function create_recordset($result) {
- return new mysqli_native_moodle_recordset($result);
- }
- /**
- * Get a number of records as an array of objects using a SQL statement.
- *
- * Return value is like:
- * @see function get_records.
- *
- * @param string $sql the SQL select query to execute. The first column of this SELECT statement
- * must be a unique value (usually the 'id' field), as it will be used as the key of the
- * returned array.
- * @param array $params array of sql parameters
- * @param int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
- * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
- * @return array of objects, or empty array if no records were found
- * @throws dml_exception A DML specific exception is thrown for any errors.
- */
- public function get_records_sql($sql, array $params=null, $limitfrom=0, $limitnum=0) {
- $limitfrom = (int)$limitfrom;
- $limitnum = (int)$limitnum;
- $limitfrom = ($limitfrom < 0) ? 0 : $limitfrom;
- $limitnum = ($limitnum < 0) ? 0 : $limitnum;
- if ($limitfrom or $limitnum) {
- if ($limitnum < 1) {
- $limitnum = "18446744073709551615";
- }
- $sql .= " LIMIT $limitfrom, $limitnum";
- }
- list($sql, $params, $type) = $this->fix_sql_params($sql, $params);
- $rawsql = $this->emulate_bound_params($sql, $params);
- $this->query_start($sql, $params, SQL_QUERY_SELECT);
- $result = $this->mysqli->query($rawsql, MYSQLI_STORE_RESULT);
- $this->query_end($result);
- $return = array();
- while($row = $result->fetch_assoc()) {
- $row = array_change_key_case($row, CASE_LOWER);
- $id = reset($row);
- if (isset($return[$id])) {
- $colname = key($row);
- debugging("Did you remember to make the first column something unique in your call to get_records? Duplicate value '$id' found in column '$colname'.", DEBUG_DEVELOPER);
- }
- $return[$id] = (object)$row;
- }
- $result->close();
- return $return;
- }
- /**
- * Selects records and return values (first field) as an array using a SQL statement.
- *
- * @param string $sql The SQL query
- * @param array $params array of sql parameters
- * @return array of values
- * @throws dml_exception A DML specific exception is thrown for any errors.
- */
- public function get_fieldset_sql($sql, array $params=null) {
- list($sql, $params, $type) = $this->fix_sql_params($sql, $params);
- $rawsql = $this->emulate_bound_params($sql, $params);
- $this->query_start($sql, $params, SQL_QUERY_SELECT);
- $result = $this->mysqli->query($rawsql, MYSQLI_STORE_RESULT);
- $this->query_end($result);
- $return = array();
- while($row = $result->fetch_assoc()) {
- $return[] = reset($row);
- }
- $result->close();
- return $return;
- }
- /**
- * Insert new record into database, as fast as possible, no safety checks, lobs not supported.
- * @param string $table name
- * @param mixed $params data record as object or array
- * @param bool $returnit return it of inserted record
- * @param bool $bulk true means repeated inserts expected
- * @param bool $customsequence true if 'id' included in $params, disables $returnid
- * @return bool|int true or new id
- * @throws dml_exception A DML specific exception is thrown for any errors.
- */
- public function insert_record_raw($table, $params, $returnid=true, $bulk=false, $customsequence=false) {
- if (!is_array($params)) {
- $params = (array)$params;
- }
- if ($customsequence) {
- if (!isset($params['id'])) {
- throw new coding_exception('moodle_database::insert_record_raw() id field must be specified if custom sequences used.');
- }
- $returnid = false;
- } else {
- unset($params['id']);
- }
- if (empty($params)) {
- throw new coding_exception('moodle_database::insert_record_raw() no fields found.');
- }
- $fields = implode(',', array_keys($params));
- $qms = array_fill(0, count($params), '?');
- $qms = implode(',', $qms);
- $sql = "INSERT INTO {$this->prefix}$table ($fields) VALUES($qms)";
- list($sql, $params, $type) = $this->fix_sql_params($sql, $params);
- $rawsql = $this->emulate_bound_params($sql, $params);
- $this->query_start($sql, $params, SQL_QUERY_INSERT);
- $result = $this->mysqli->query($rawsql);
- $id = @$this->mysqli->insert_id; // must be called before query_end() which may insert log into db
- $this->query_end($result);
- if (!$customsequence and !$id) {
- throw new dml_write_exception('unknown error fetching inserted id');
- }
- if (!$returnid) {
- return true;
- } else {
- return (int)$id;
- }
- }
- /**
- * Insert a record into a table and return the "id" field if required.
- *
- * Some conversions and safety checks are carried out. Lobs are supported.
- * If the return ID isn't required, then this just reports success as true/false.
- * $data is an object containing needed data
- * @param string $table The database table to be inserted into
- * @param object $data A data object with values for one or more fields in the record
- * @param bool $returnid Should the id of the newly created record entry be returned? If this option is not requested then true/false is returned.
- * @return bool|int true or new id
- * @throws dml_exception A DML specific exception is thrown for any errors.
- */
- public function insert_record($table, $dataobject, $returnid=true, $bulk=false) {
- $dataobject = (array)$dataobject;
- $columns = $this->get_columns($table);
- $cleaned = array();
- foreach ($dataobject as $field=>$value) {
- if ($field === 'id') {
- continue;
- }
- if (!isset($columns[$field])) {
- continue;
- }
- $column = $columns[$field];
- $cleaned[$field] = $this->normalise_value($column, $value);
- }
- return $this->insert_record_raw($table, $cleaned, $returnid, $bulk);
- }
- /**
- * Import a record into a table, id field is required.
- * Safety checks are NOT carried out. Lobs are supported.
- *
- * @param string $table name of database table to be inserted into
- * @param object $dataobject A data object with values for one or more fields in the record
- * @return bool true
- * @throws dml_exception A DML specific exception is thrown for any errors.
- */
- public function import_record($table, $dataobject) {
- $dataobject = (array)$dataobject;
- $columns = $this->get_columns($table);
- $cleaned = array();
- foreach ($dataobject as $field=>$value) {
- if (!isset($columns[$field])) {
- continue;
- }
- $cleaned[$field] = $value;
- }
- return $this->insert_record_raw($table, $cleaned, false, true, true);
- }
- /**
- * Update record in database, as fast as possible, no safety checks, lobs not supported.
- * @param string $table name
- * @param mixed $params data record as object or array
- * @param bool true means repeated updates expected
- * @return bool true
- * @throws dml_exception A DML specific exception is thrown for any errors.
- */
- public function update_record_raw($table, $params, $bulk=false) {
- $params = (array)$params;
- if (!isset($params['id'])) {
- throw new coding_exception('moodle_database::update_record_raw() id field must be specified.');
- }
- $id = $params['id'];
- unset($params['id']);
- if (empty($params)) {
- throw new coding_exception('moodle_database::update_record_raw() no fields found.');
- }
- $sets = array();
- foreach ($params as $field=>$value) {
- $sets[] = "$field = ?";
- }
- $params[] = $id; // last ? in WHERE condition
- $sets = implode(',', $sets);
- $sql = "UPDATE {$this->prefix}$table SET $sets WHERE id=?";
- list($sql, $params, $type) = $this->fix_sql_params($sql, $params);
- $rawsql = $this->emulate_bound_params($sql, $params);
- $this->query_start($sql, $params, SQL_QUERY_UPDATE);
- $result = $this->mysqli->query($rawsql);
- $this->query_end($result);
- return true;
- }
- /**
- * Update a record in a table
- *
- * $dataobject is an object containing needed data
- * Relies on $dataobject having a variable "id" to
- * specify the record to update
- *
- * @param string $table The database table to be checked against.
- * @param object $dataobject An object with contents equal to fieldname=>fieldvalue. Must have an entry for 'id' to map to the table specified.
- * @param bool true means repeated updates expected
- * @return bool true
- * @throws dml_exception A DML specific exception is thrown for any errors.
- */
- public function update_record($table, $dataobject, $bulk=false) {
- $dataobject = (array)$dataobject;
- $columns = $this->get_columns($table);
- $cleaned = array();
- foreach ($dataobject as $field=>$value) {
- if (!isset($columns[$field])) {
- continue;
- }
- $column = $columns[$field];
- $cleaned[$field] = $this->normalise_value($column, $value);
- }
- return $this->update_record_raw($table, $cleaned, $bulk);
- }
- /**
- * Set a single field in every table record which match a particular WHERE clause.
- *
- * @param string $table The database table to be checked against.
- * @param string $newfield the field to set.
- * @param string $newvalue the value to set the field to.
- * @param string $select A fragment of SQL to be used in a where clause in the SQL call.
- * @param array $params array of sql parameters
- * @return bool true
- * @throws dml_exception A DML specific exception is thrown for any errors.
- */
- public function set_field_select($table, $newfield, $newvalue, $select, array $params=null) {
- if ($select) {
- $select = "WHERE $select";
- }
- if (is_null($params)) {
- $params = array();
- }
- list($select, $params, $type) = $this->fix_sql_params($select, $params);
- // Get column metadata
- $columns = $this->get_columns($table);
- $column = $columns[$newfield];
- $normalised_value = $this->normalise_value($column, $newvalue);
- if (is_null($normalised_value)) {
- $newfield = "$newfield = NULL";
- } else {
- $newfield = "$newfield = ?";
- array_unshift($params, $normalised_value);
- }
- $sql = "UPDATE {$this->prefix}$table SET $newfield $select";
- $rawsql = $this->emulate_bound_params($sql, $params);
- $this->query_start($sql, $params, SQL_QUERY_UPDATE);
- $result = $this->mysqli->query($rawsql);
- $this->query_end($result);
- return true;
- }
- /**
- * Delete one or more records from a table which match a particular WHERE clause.
- *
- * @param string $table The database table to be checked against.
- * @param string $select A fragment of SQL to be used in a where clause in the SQL call (used to define the selection criteria).
- * @param array $params array of sql parameters
- * @return bool true
- * @throws dml_exception A DML specific exception is thrown for any errors.
- */
- public function delete_records_select($table, $select, array $params=null) {
- if ($select) {
- $select = "WHERE $select";
- }
- $sql = "DELETE FROM {$this->prefix}$table $select";
- list($sql, $params, $type) = $this->fix_sql_params($sql, $params);
- $rawsql = $this->emulate_bound_params($sql, $params);
- $this->query_start($sql, $params, SQL_QUERY_UPDATE);
- $result = $this->mysqli->query($rawsql);
- $this->query_end($result);
- return true;
- }
- public function sql_cast_char2int($fieldname, $text=false) {
- return ' CAST(' . $fieldname . ' AS SIGNED) ';
- }
- public function sql_cast_char2real($fieldname, $text=false) {
- return ' CAST(' . $fieldname . ' AS DECIMAL) ';
- }
- /**
- * Returns 'LIKE' part of a query.
- *
- * @param string $fieldname usually name of the table column
- * @param string $param usually bound query parameter (?, :named)
- * @param bool $casesensitive use case sensitive search
- * @param bool $accensensitive use accent sensitive search (not all databases support accent insensitive)
- * @param bool $notlike true means "NOT LIKE"
- * @param string $escapechar escape char for '%' and '_'
- * @return string SQL code fragment
- */
- public function sql_like($fieldname, $param, $casesensitive = true, $accentsensitive = true, $notlike = false, $escapechar = '\\') {
- if (strpos($param, '%') !== false) {
- debugging('Potential SQL injection detected, sql_like() expects bound parameters (? or :named)');
- }
- $escapechar = $this->mysqli->real_escape_string($escapechar); // prevents problems with C-style escapes of enclosing '\'
- $LIKE = $notlike ? 'NOT LIKE' : 'LIKE';
- if ($casesensitive) {
- return "$fieldname $LIKE $param COLLATE utf8_bin ESCAPE '$escapechar'";
- } else {
- if ($accentsensitive) {
- return "LOWER($fieldnam