From: skodak Date: Fri, 17 Oct 2008 22:43:42 +0000 (+0000) Subject: MDL-14679 dml/native_mysqli new experimental native driver for mysqli - not fully... X-Git-Url: http://git.mjollnir.org/gw?a=commitdiff_plain;h=7466a42fb4a8eeaf0ba03706cc95d7e82b51b78b;p=moodle.git MDL-14679 dml/native_mysqli new experimental native driver for mysqli - not fully finished yet, seems to work fine --- diff --git a/lib/dml/mysqli_native_moodle_database.php b/lib/dml/mysqli_native_moodle_database.php new file mode 100644 index 0000000000..a1ca048949 --- /dev/null +++ b/lib/dml/mysqli_native_moodle_database.php @@ -0,0 +1,866 @@ +libdir.'/dml/moodle_database.php'); +require_once($CFG->libdir.'/dml/mysqli_native_moodle_recordset.php'); + +/** + * Native mysqli class representing moodle database interface. + * @package dml + */ +class mysqli_native_moodle_database extends moodle_database { + + protected $mysqli=null; + + /** + * 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 mysql, mysqli, postgres7 + */ + protected function get_dbtype() { + return 'mysqli'; + } + + /** + * Returns general database library name + * Note: can be used before connect() + * @return string db type adodb, pdo, native + */ + protected function get_dblibrary() { + return 'native'; + } + + /** + * Returns localised database type name + * Note: can be used before connect() + * @return string + */ + public function get_name() { + return get_string('nativemysqli', 'install'); //TODO: localise + } + + /** + * Returns localised database description + * Note: can be used before connect() + * @return string + */ + public function get_configuration_hints() { + return get_string('databasesettingssub_mysqlinative', 'install'); //TODO: localise + } + + /** + * Connect to db + * Must be called before other methods. + * @param string $dbhost + * @param string $dbuser + * @param string $dbpass + * @param string $dbname + * @param bool $dbpersist + * @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, $dbpersist, $prefix, array $dboptions=null) { + global $CFG; + + $this->store_settings($dbhost, $dbuser, $dbpass, $dbname, false, $prefix, $dboptions); + + $this->mysqli = new mysqli($dbhost, $dbuser, $dbpass, $dbname); + if ($this->mysqli->connect_error) { + return false; + } + $this->mysqli->set_charset('utf8'); + 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() { + if ($this->mysqli) { + $this->mysqli->close(); + $this->mysqli = null; + } + parent::dispose(); + } + + /** + * Returns database server info array + * @return array + */ + public function get_server_info() { + return array('description'=>$this->mysqli->server_info, 'version'=>$this->mysqli->server_info); + } + + /** + * Returns supported query parameter types + * @return bitmask + */ + protected function allowed_param_types() { + return SQL_PARAMS_QM; + } + + /** + * Returns last error reported by database engine. + */ + public function get_last_error() { + return $this->mysqli->error; + } + + /** + * Return tables in database WITHOUT current prefix + * @return array of table names in lowercase and without prefix + */ + public function get_tables() { + $this->reads++; + $tables = array(); + if ($result = $this->mysqli->query("SHOW TABLES")) { + while ($arr = $result->fetch_assoc()) { + $tablename = reset($arr); + if (strpos($tablename, $this->prefix) !== 0) { + continue; + } + $tablename = substr($tablename, strlen($this->prefix)); + $tables[$tablename] = $tablename; + } + $result->close(); + } + return $tables; + } + + /** + * Return table indexes - everything lowercased + * @return array of arrays + */ + public function get_indexes($table) { + $preflen = strlen($this->prefix); + $indexes = array(); + if ($result = $this->mysqli->query("SHOW INDEXES FROM {$this->prefix}$table")) { + 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 datailed 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 and isset($this->columns[$table])) { + return $this->columns[$table]; + } + + $this->columns[$table] = array(); + + if (!$rawcolumns = $this->get_records_sql("SHOW COLUMNS FROM {".$table."}")) { + return array(); + } + + foreach ($rawcolumns as $rawcolumn) { + $info = new object(); + $info->name = $rawcolumn->field; + $matches = null; + + if (preg_match('/varchar\((\d+)\)/i', $rawcolumn->type, $matches)) { + $info->type = 'varchar'; + $info->meta_type = 'C'; + $info->max_length = $matches[1]; + $info->scale = null; + $info->not_null = ($rawcolumn->null === 'NO'); + $info->default_value = $rawcolumn->default; + $info->has_default = is_null($info->default_value) ? false : true; + $info->primary_key = ($rawcolumn->key === 'PRI'); + $info->binary = false; + $info->unsigned = null; + $info->auto_increment= false; + $info->unique = null; + + } else if (preg_match('/([a-z]*int[a-z]*)\((\d+)\)/i', $rawcolumn->type, $matches)) { + $info->type = $matches[1]; + $info->primary_key = ($rawcolumn->key === 'PRI'); + if ($info->primary_key) { + $info->meta_type = 'R'; + $info->max_length = $matches[2]; + $info->scale = null; + $info->not_null = ($rawcolumn->null === 'NO'); + $info->default_value = $rawcolumn->default; + $info->has_default = is_null($info->default_value) ? false : true; + $info->binary = false; + $info->unsigned = (stripos($rawcolumn->type, 'unsigned') !== false); + $info->auto_increment= true; + $info->unique = true; + } else { + $info->meta_type = 'I'; + $info->max_length = $matches[2]; + $info->scale = null; + $info->not_null = ($rawcolumn->null === 'NO'); + $info->default_value = $rawcolumn->default; + $info->has_default = is_null($info->default_value) ? false : true; + $info->binary = false; + $info->unsigned = (stripos($rawcolumn->type, 'unsigned') !== false); + $info->auto_increment= false; + $info->unique = null; + } + + } else if (preg_match('/decimal\((\d+),(\d+)\)/i', $rawcolumn->type, $matches)) { + $info->type = 'decimal'; + $info->meta_type = 'N'; + $info->max_length = $matches[1]; + $info->scale = $matches[2]; + $info->not_null = ($rawcolumn->null === 'NO'); + $info->default_value = $rawcolumn->default; + $info->has_default = is_null($info->default_value) ? false : true; + $info->primary_key = ($rawcolumn->key === 'PRI'); + $info->binary = false; + $info->unsigned = null; + $info->auto_increment= false; + $info->unique = null; + + } else if (preg_match('/([a-z]*text)/i', $rawcolumn->type, $matches)) { + $info->type = $matches[1]; + $info->meta_type = 'X'; + $info->max_length = -1; + $info->scale = null; + $info->not_null = ($rawcolumn->null === 'NO'); + $info->default_value = $rawcolumn->default; + $info->has_default = is_null($info->default_value) ? false : true; + $info->primary_key = ($rawcolumn->key === 'PRI'); + $info->binary = false; + $info->unsigned = null; + $info->auto_increment= false; + $info->unique = null; + + } else if (preg_match('/enum\((.*)\)/i', $rawcolumn->type, $matches)) { + $info->type = 'enum'; + $info->meta_type = 'C'; + $info->enums = array(); + $info->max_length = 0; + $values = $matches[1]; + $values = explode(',', $values); + $textlib = textlib_get_instance(); + foreach ($values as $val) { + $val = trim($val, "'"); + $length = $textlib->strlen($val); + $info->enums[] = $val; + $info->max_length = ($info->max_length < $length) ? $length : $info->max_length; + } + $info->scale = null; + $info->not_null = ($rawcolumn->null === 'NO'); + $info->default_value = $rawcolumn->default; + $info->has_default = is_null($info->default_value) ? false : true; + $info->primary_key = ($rawcolumn->key === 'PRI'); + $info->binary = false; + $info->unsigned = null; + $info->auto_increment= false; + $info->unique = null; + } + + $this->columns[$table][$info->name] = new database_column_info($info); + } + + return $this->columns[$table]; + } + + /** + * Reset a sequence to the id field of a table. + * @param string $table name of table + * @return success + */ + public function reset_sequence($table) { + // From http://dev.mysql.com/doc/refman/5.0/en/alter-table.html + if (!$this->get_manager()->table_exists($table)) { + return false; + } + $value = (int)$this->get_field_sql('SELECT MAX(id) FROM {'.$table.'}'); + $value++; + return $this->change_database_structure("ALTER TABLE $this->prefix$table AUTO_INCREMENT = $value"); + } + + /** + * Is db in unicode mode? + * @return bool + */ + public function setup_is_unicodedb() { + $this->reads++; + if ($result = $this->mysqli->query("SHOW LOCAL VARIABLES LIKE 'character_set_database'")) { + $result->close(); + return true; + } + return false; + } + + /** + * Enable/disable very detailed debugging + * TODO: do we need levels? + * @param bool $state + */ + public function set_debug($state) { + //TODO + } + + /** + * Returns debug status + * @return bool $state + */ + public function get_debug() { + //TODO + } + + /** + * Enable/disable detailed sql logging + * TODO: do we need levels? + * @param bool $state + */ + public function set_logging($state) { + //TODO + } + + /** + * Do NOT use in code, to be used by database_manager only! + * @param string $sql query + * @return bool success + */ + public function change_database_structure($sql) { + return ($this->mysqli->query($sql) === 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 + $return = strtok($sql, '?'); + foreach ($params as $param) { + if (is_bool($param)) { + $return .= (int)$param; + } else if (is_null($param)) { + $return .= 'NULL'; + } else if (is_numeric($param)) { + $return .= $param; + } else { + $param = $this->mysqli->real_escape_string($param); + $return .= "'$param'"; + } + $return .= strtok('?'); + } + 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::execute_sql() instead! + * @param string $sql query + * @param array $params query parameters + * @return bool success + */ + public function execute($sql, array $params=null) { + list($sql, $params, $type) = $this->fix_sql_params($sql, $params); + + if (strpos($sql, ';') !== false) { + debugging('Error: Multiple sql statements found or bound parameters not used properly in query!'); + return false; + } + + $rawsql = $this->emulate_bound_params($sql, $params); + + $this->writes++; + + $result = $this->mysqli->query($rawsql); + + if ($result === false) { + $this->report_error($sql, $params); + return false; + + } else 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 as for @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 mixed an moodle_recorset object, or false if an error occured. + */ + public function get_recordset_sql($sql, array $params=null, $limitfrom=0, $limitnum=0) { + list($sql, $params, $type) = $this->fix_sql_params($sql, $params); + $rawsql = $this->emulate_bound_params($sql, $params); + + if ($limitfrom or $limitnum) { + $limitfrom = (int)$limitfrom; + $limitnum = (int)$limitnum; + if ($limitnum < 1) { + $limitnum = "18446744073709551615"; + } + $rawsql .= " LIMIT $limitfrom, $limitnum"; + } + + $this->reads++; + // no MYSQLI_USE_RESULT here, it would block write ops on affected tables + $result = $this->mysqli->query($rawsql, MYSQLI_STORE_RESULT); + + if ($result === false) { + $this->report_error($sql, $params); + return false; + } + + 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 as for @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 mixed an array of objects, or empty array if no records were found, or false if an error occured. + */ + public function get_records_sql($sql, array $params=null, $limitfrom=0, $limitnum=0) { + list($sql, $params, $type) = $this->fix_sql_params($sql, $params); + $rawsql = $this->emulate_bound_params($sql, $params); + + if ($limitfrom or $limitnum) { + $limitfrom = (int)$limitfrom; + $limitnum = (int)$limitnum; + if ($limitnum < 1) { + $limitnum = "18446744073709551615"; + } + $rawsql .= " LIMIT $limitfrom, $limitnum"; + } + + $this->reads++; + $result = $this->mysqli->query($rawsql, MYSQLI_STORE_RESULT); + + if ($result === false) { + $this->report_error($sql, $params); + return false; + } + + $return = array(); + + while($row = $result->fetch_assoc()) { + $row = array_change_key_case($row, CASE_LOWER); + $id = reset($row); + $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 mixed array of values or false if an error occured + */ + 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->reads++; + $result = $this->mysqli->query($rawsql, MYSQLI_STORE_RESULT); + + if ($result === false) { + $this->report_error($sql, $params); + return false; + } + + $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 mixed success or new id + */ + 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'])) { + return false; + } + $returnid = false; + } else { + unset($params['id']); + } + + if (empty($params)) { + return false; + } + + $this->writes++; + + $fields = implode(',', array_keys($params)); + $qms = array_fill(0, count($params), '?'); + $qms = implode(',', $qms); + + $sql = "INSERT INTO {$this->prefix}$table ($fields) VALUES($qms)"; + $rawsql = $this->emulate_bound_params($sql, $params); + + $result = $this->mysqli->query($rawsql); + + if ($result === false) { + $this->report_error($sql, $params); + return false; + } + + if (!$id = $this->mysqli->insert_id) { + return false; + } + + 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 mixed success or new ID + */ + public function insert_record($table, $dataobject, $returnid=true, $bulk=false) { + if (!is_object($dataobject)) { + $dataobject = (object)$dataobject; + } + + $columns = $this->get_columns($table); + + unset($dataobject->id); + $cleaned = array(); + + foreach ($dataobject as $field=>$value) { + if (!isset($columns[$field])) { + continue; + } + $column = $columns[$field]; + if (is_bool($value)) { + $value = (int)$value; // prevent "false" problems + } + if (!empty($column->enums)) { + // workaround for problem with wrong enums in mysql + if (is_null($value) and !$column->not_null) { + // ok - nulls allowed + } else { + if (!in_array((string)$value, $column->enums)) { + debugging('Enum value '.s($value).' not allowed in field '.$field.' table '.$table.'.'); + return false; + } + } + } + $cleaned[$field] = $value; + } + + if (empty($cleaned)) { + return false; + } + + 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 success + */ + public function import_record($table, $dataobject) { + $dataobject = (object)$dataobject; + + if (empty($dataobject->id)) { + return false; + } + + $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 success + */ + public function update_record_raw($table, $params, $bulk=false) { + if (!is_array($params)) { + $params = (array)$params; + } + if (!isset($params['id'])) { + return false; + } + $id = $params['id']; + unset($params['id']); + + if (empty($params)) { + return false; + } + + $this->writes++; + + $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=?"; + $rawsql = $this->emulate_bound_params($sql, $params); + + $result = $this->mysqli->query($rawsql); + + if ($result === false) { + $this->report_error($sql, $params); + return false; + } + + 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 success + */ + public function update_record($table, $dataobject, $bulk=false) { + if (!is_object($dataobject)) { + $dataobject = (object)$dataobject; + } + + if (!isset($dataobject->id) ) { + return false; + } + + $columns = $this->get_columns($table); + $cleaned = array(); + + foreach ($dataobject as $field=>$value) { + if (!isset($columns[$field])) { + continue; + } + if (is_bool($value)) { + $value = (int)$value; // prevent "false" problems + } + $cleaned[$field] = $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 success + */ + 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); + + if (is_bool($newvalue)) { + $newvalue = (int)$newvalue; // prevent "false" problems + } + if (is_null($newvalue)) { + $newfield = "$newfield = NULL"; + } else { + $newfield = "$newfield = ?"; + array_unshift($params, $newvalue); + } + $sql = "UPDATE {$this->prefix}$table SET $newfield $select"; + $rawsql = $this->emulate_bound_params($sql, $params); + + $this->writes++; + $result = $this->mysqli->query($rawsql); + + if ($result === false) { + $this->report_error($sql, $params); + return false; + } + + 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 returns success. + */ + 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->writes++; + $result = $this->mysqli->query($rawsql); + + if ($result === false) { + $this->report_error($sql, $params); + return false; + } + + return true; + } + + public function sql_cast_char2int($fieldname, $text=false) { + return ' CAST(' . $fieldname . ' AS SIGNED) '; + } + + public function sql_concat() { + $arr = func_get_args(); + $s = implode(',', $arr); + if ($s === '') { + //TODO: error + } + return "CONCAT($s)"; + } + + public function sql_concat_join($separator="' '", $elements=array()) { + for ($n=count($elements)-1; $n > 0 ; $n--) { + array_splice($elements, $n, 0, $separator); + } + $s = implode(',', $elements); + if ($s === '') { + //TODO: error + } + return "CONCAT ($s)"; + } + + public function sql_substr() { + return "SUBSTRING"; + } + + + /** + * Does this driver suppoer regex syntax when searching + */ + public function sql_regex_supported() { + return true; + } + + /** + * Return regex positive or negative match sql + * @param bool $positivematch + * @return string or empty if not supported + */ + public function sql_regex($positivematch=true) { + return $positivematch ? 'REGEXP' : 'NOT REGEXP'; + } +} diff --git a/lib/dml/mysqli_native_moodle_recordset.php b/lib/dml/mysqli_native_moodle_recordset.php new file mode 100644 index 0000000000..fd9ff7ea2c --- /dev/null +++ b/lib/dml/mysqli_native_moodle_recordset.php @@ -0,0 +1,60 @@ +libdir.'/dml/moodle_recordset.php'); + +class mysqli_native_moodle_recordset extends moodle_recordset { + + protected $result; + protected $current; + protected $row; + + public function __construct($result) { + $this->result = $result; + $this->current = $this->fetch_next(); + $this->row = 0; + } + + public function __destruct() { + $this->close(); + } + + private function fetch_next() { + if ($row = $this->result->fetch_assoc()) { + $row = array_change_key_case($row, CASE_LOWER); + $row = (object)$row; + } + return $row; + } + + public function current() { + return $this->current; + } + + public function key() { + return $this->row; + } + + public function next() { + if ($this->current = $this->fetch_next()) { + $this->row++; + } + return $this->current; + } + + public function rewind() { + // we can not seek, sorry - let's ignore it ;-) + } + + public function valid() { + return !is_null($this->current); + } + + public function close() { + if ($this->result) { + $this->result->close(); + $this->result = null; + } + $this->current = null; + $this->row = 0; + } +}