MDL-48228 database: Make utf8mb4 the default character set for mysql.
[moodle.git] / lib / dml / mysqli_native_moodle_database.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Native mysqli class representing moodle database interface.
19  *
20  * @package    core_dml
21  * @copyright  2008 Petr Skoda (http://skodak.org)
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 defined('MOODLE_INTERNAL') || die();
27 require_once(__DIR__.'/moodle_database.php');
28 require_once(__DIR__.'/mysqli_native_moodle_recordset.php');
29 require_once(__DIR__.'/mysqli_native_moodle_temptables.php');
31 /**
32  * Native mysqli class representing moodle database interface.
33  *
34  * @package    core_dml
35  * @copyright  2008 Petr Skoda (http://skodak.org)
36  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
37  */
38 class mysqli_native_moodle_database extends moodle_database {
40     /** @var mysqli $mysqli */
41     protected $mysqli = null;
42     /** @var bool is compressed row format supported cache */
43     protected $compressedrowformatsupported = null;
45     private $transactions_supported = null;
47     /**
48      * Attempt to create the database
49      * @param string $dbhost
50      * @param string $dbuser
51      * @param string $dbpass
52      * @param string $dbname
53      * @return bool success
54      * @throws dml_exception A DML specific exception is thrown for any errors.
55      */
56     public function create_database($dbhost, $dbuser, $dbpass, $dbname, array $dboptions=null) {
57         $driverstatus = $this->driver_installed();
59         if ($driverstatus !== true) {
60             throw new dml_exception('dbdriverproblem', $driverstatus);
61         }
63         if (!empty($dboptions['dbsocket'])
64                 and (strpos($dboptions['dbsocket'], '/') !== false or strpos($dboptions['dbsocket'], '\\') !== false)) {
65             $dbsocket = $dboptions['dbsocket'];
66         } else {
67             $dbsocket = ini_get('mysqli.default_socket');
68         }
69         if (empty($dboptions['dbport'])) {
70             $dbport = (int)ini_get('mysqli.default_port');
71         } else {
72             $dbport = (int)$dboptions['dbport'];
73         }
74         // verify ini.get does not return nonsense
75         if (empty($dbport)) {
76             $dbport = 3306;
77         }
78         ob_start();
79         $conn = new mysqli($dbhost, $dbuser, $dbpass, '', $dbport, $dbsocket); // Connect without db
80         $dberr = ob_get_contents();
81         ob_end_clean();
82         $errorno = @$conn->connect_errno;
84         if ($errorno !== 0) {
85             throw new dml_connection_exception($dberr);
86         }
88         // Normally a check would be done before setting utf8mb4, but the database can be created
89         // before the enviroment checks are done. We'll proceed with creating the database and then do checks next.
90         $charset = 'utf8mb4';
91         if (isset($dboptions['dbcollation']) and (strpos($dboptions['dbcollation'], 'utf8_') === 0
92                 || strpos($dboptions['dbcollation'], 'utf8mb4_') === 0)) {
93             $collation = $dboptions['dbcollation'];
94             $collationinfo = explode('_', $dboptions['dbcollation']);
95             $charset = reset($collationinfo);
96         } else {
97             $collation = 'utf8mb4_unicode_ci';
98         }
100         $result = $conn->query("CREATE DATABASE $dbname DEFAULT CHARACTER SET $charset DEFAULT COLLATE ".$collation);
102         $conn->close();
104         if (!$result) {
105             throw new dml_exception('cannotcreatedb');
106         }
108         return true;
109     }
111     /**
112      * Detects if all needed PHP stuff installed.
113      * Note: can be used before connect()
114      * @return mixed true if ok, string if something
115      */
116     public function driver_installed() {
117         if (!extension_loaded('mysqli')) {
118             return get_string('mysqliextensionisnotpresentinphp', 'install');
119         }
120         return true;
121     }
123     /**
124      * Returns database family type - describes SQL dialect
125      * Note: can be used before connect()
126      * @return string db family name (mysql, postgres, mssql, oracle, etc.)
127      */
128     public function get_dbfamily() {
129         return 'mysql';
130     }
132     /**
133      * Returns more specific database driver type
134      * Note: can be used before connect()
135      * @return string db type mysqli, pgsql, oci, mssql, sqlsrv
136      */
137     protected function get_dbtype() {
138         return 'mysqli';
139     }
141     /**
142      * Returns general database library name
143      * Note: can be used before connect()
144      * @return string db type pdo, native
145      */
146     protected function get_dblibrary() {
147         return 'native';
148     }
150     /**
151      * Returns the current MySQL db engine.
152      *
153      * This is an ugly workaround for MySQL default engine problems,
154      * Moodle is designed to work best on ACID compliant databases
155      * with full transaction support. Do not use MyISAM.
156      *
157      * @return string or null MySQL engine name
158      */
159     public function get_dbengine() {
160         if (isset($this->dboptions['dbengine'])) {
161             return $this->dboptions['dbengine'];
162         }
164         if ($this->external) {
165             return null;
166         }
168         $engine = null;
170         // Look for current engine of our config table (the first table that gets created),
171         // so that we create all tables with the same engine.
172         $sql = "SELECT engine
173                   FROM INFORMATION_SCHEMA.TABLES
174                  WHERE table_schema = DATABASE() AND table_name = '{$this->prefix}config'";
175         $this->query_start($sql, NULL, SQL_QUERY_AUX);
176         $result = $this->mysqli->query($sql);
177         $this->query_end($result);
178         if ($rec = $result->fetch_assoc()) {
179             $engine = $rec['engine'];
180         }
181         $result->close();
183         if ($engine) {
184             // Cache the result to improve performance.
185             $this->dboptions['dbengine'] = $engine;
186             return $engine;
187         }
189         // Get the default database engine.
190         $sql = "SELECT @@default_storage_engine engine";
191         $this->query_start($sql, NULL, SQL_QUERY_AUX);
192         $result = $this->mysqli->query($sql);
193         $this->query_end($result);
194         if ($rec = $result->fetch_assoc()) {
195             $engine = $rec['engine'];
196         }
197         $result->close();
199         if ($engine === 'MyISAM') {
200             // we really do not want MyISAM for Moodle, InnoDB or XtraDB is a reasonable defaults if supported
201             $sql = "SHOW STORAGE ENGINES";
202             $this->query_start($sql, NULL, SQL_QUERY_AUX);
203             $result = $this->mysqli->query($sql);
204             $this->query_end($result);
205             $engines = array();
206             while ($res = $result->fetch_assoc()) {
207                 if ($res['Support'] === 'YES' or $res['Support'] === 'DEFAULT') {
208                     $engines[$res['Engine']] = true;
209                 }
210             }
211             $result->close();
212             if (isset($engines['InnoDB'])) {
213                 $engine = 'InnoDB';
214             }
215             if (isset($engines['XtraDB'])) {
216                 $engine = 'XtraDB';
217             }
218         }
220         // Cache the result to improve performance.
221         $this->dboptions['dbengine'] = $engine;
222         return $engine;
223     }
225     /**
226      * Returns the current MySQL db collation.
227      *
228      * This is an ugly workaround for MySQL default collation problems.
229      *
230      * @return string or null MySQL collation name
231      */
232     public function get_dbcollation() {
233         if (isset($this->dboptions['dbcollation'])) {
234             return $this->dboptions['dbcollation'];
235         }
236         if ($this->external) {
237             return null;
238         }
240         $collation = null;
242         // Look for current collation of our config table (the first table that gets created),
243         // so that we create all tables with the same collation.
244         $sql = "SELECT collation_name
245                   FROM INFORMATION_SCHEMA.COLUMNS
246                  WHERE table_schema = DATABASE() AND table_name = '{$this->prefix}config' AND column_name = 'value'";
247         $this->query_start($sql, NULL, SQL_QUERY_AUX);
248         $result = $this->mysqli->query($sql);
249         $this->query_end($result);
250         if ($rec = $result->fetch_assoc()) {
251             $collation = $rec['collation_name'];
252         }
253         $result->close();
256         if (!$collation) {
257             // Get the default database collation, but only if using UTF-8.
258             $sql = "SELECT @@collation_database";
259             $this->query_start($sql, NULL, SQL_QUERY_AUX);
260             $result = $this->mysqli->query($sql);
261             $this->query_end($result);
262             if ($rec = $result->fetch_assoc()) {
263                 if (strpos($rec['@@collation_database'], 'utf8_') === 0 || strpos($rec['@@collation_database'], 'utf8mb4_') === 0) {
264                     $collation = $rec['@@collation_database'];
265                 }
266             }
267             $result->close();
268         }
270         if (!$collation) {
271             // We want only utf8 compatible collations.
272             $collation = null;
273             $sql = "SHOW COLLATION WHERE Collation LIKE 'utf8mb4\_%' AND Charset = 'utf8mb4'";
274             $this->query_start($sql, NULL, SQL_QUERY_AUX);
275             $result = $this->mysqli->query($sql);
276             $this->query_end($result);
277             while ($res = $result->fetch_assoc()) {
278                 $collation = $res['Collation'];
279                 if (strtoupper($res['Default']) === 'YES') {
280                     $collation = $res['Collation'];
281                     break;
282                 }
283             }
284             $result->close();
285         }
287         // Cache the result to improve performance.
288         $this->dboptions['dbcollation'] = $collation;
289         return $collation;
290     }
292     /**
293      * Get the row format from the database schema.
294      *
295      * @param string $table
296      * @return string row_format name or null if not known or table does not exist.
297      */
298     public function get_row_format($table = null) {
299         $rowformat = null;
300         if (isset($table)) {
301             $table = $this->mysqli->real_escape_string($table);
302             $sql = "SELECT row_format
303                       FROM INFORMATION_SCHEMA.TABLES
304                      WHERE table_schema = DATABASE() AND table_name = '{$this->prefix}$table'";
305         } else {
306             $sql = "SHOW VARIABLES LIKE 'innodb_file_format'";
307         }
308         $this->query_start($sql, NULL, SQL_QUERY_AUX);
309         $result = $this->mysqli->query($sql);
310         $this->query_end($result);
311         if ($rec = $result->fetch_assoc()) {
312             if (isset($table)) {
313                 $rowformat = $rec['row_format'];
314             } else {
315                 $rowformat = $rec['Value'];
316             }
317         }
318         $result->close();
320         return $rowformat;
321     }
323     /**
324      * Is this database compatible with compressed row format?
325      * This feature is necessary for support of large number of text
326      * columns in InnoDB/XtraDB database.
327      *
328      * @param bool $cached use cached result
329      * @return bool true if table can be created or changed to compressed row format.
330      */
331     public function is_compressed_row_format_supported($cached = true) {
332         if ($cached and isset($this->compressedrowformatsupported)) {
333             return($this->compressedrowformatsupported);
334         }
336         $engine = strtolower($this->get_dbengine());
337         $info = $this->get_server_info();
339         if (version_compare($info['version'], '5.5.0') < 0) {
340             // MySQL 5.1 is not supported here because we cannot read the file format.
341             $this->compressedrowformatsupported = false;
343         } else if ($engine !== 'innodb' and $engine !== 'xtradb') {
344             // Other engines are not supported, most probably not compatible.
345             $this->compressedrowformatsupported = false;
347         } else if (!$this->is_file_per_table_enabled()) {
348             $this->compressedrowformatsupported = false;
350         } else if ($this->get_row_format() !== 'Barracuda') {
351             $this->compressedrowformatsupported = false;
353         } else {
354             // All the tests passed, we can safely use ROW_FORMAT=Compressed in sql statements.
355             $this->compressedrowformatsupported = true;
356         }
358         return $this->compressedrowformatsupported;
359     }
361     /**
362      * Check the database to see if innodb_file_per_table is on.
363      *
364      * @return bool True if on otherwise false.
365      */
366     public function is_file_per_table_enabled() {
367         if ($filepertable = $this->get_record_sql("SHOW VARIABLES LIKE 'innodb_file_per_table'")) {
368             if ($filepertable->value == 'ON') {
369                 return true;
370             }
371         }
372         return false;
373     }
375     /**
376      * Check the database to see if innodb_large_prefix is on.
377      *
378      * @return bool True if on otherwise false.
379      */
380     public function is_large_prefix_enabled() {
381         if ($largeprefix = $this->get_record_sql("SHOW VARIABLES LIKE 'innodb_large_prefix'")) {
382             if ($largeprefix->value == 'ON') {
383                 return true;
384             }
385         }
386         return false;
387     }
389     /**
390      * Determine if the row format should be set to compressed, dynamic, or default.
391      *
392      * Terrible kludge. If we're using utf8mb4 AND we're using InnoDB, we need to specify row format to
393      * be either dynamic or compressed (default is compact) in order to allow for bigger indexes (MySQL
394      * errors #1709 and #1071).
395      *
396      * @param  string $engine The database engine being used. Will be looked up if not supplied.
397      * @param  string $collation The database collation to use. Will look up the current collation if not supplied.
398      * @return string An sql fragment to add to sql statements.
399      */
400     public function get_row_format_sql($engine = null, $collation = null) {
402         if (!isset($engine)) {
403             $engine = $this->get_dbengine();
404         }
405         $engine = strtolower($engine);
407         if (!isset($collation)) {
408             $collation = $this->get_dbcollation();
409         }
411         $rowformat = '';
412         if (($engine === 'innodb' || $engine === 'xtradb') && strpos($collation, 'utf8mb4_') === 0) {
413             if ($this->is_compressed_row_format_supported()) {
414                 $rowformat = "ROW_FORMAT=Compressed";
415             } else {
416                 $rowformat = "ROW_FORMAT=Dynamic";
417             }
418         }
419         return $rowformat;
420     }
422     /**
423      * Returns localised database type name
424      * Note: can be used before connect()
425      * @return string
426      */
427     public function get_name() {
428         return get_string('nativemysqli', 'install');
429     }
431     /**
432      * Returns localised database configuration help.
433      * Note: can be used before connect()
434      * @return string
435      */
436     public function get_configuration_help() {
437         return get_string('nativemysqlihelp', 'install');
438     }
440     /**
441      * Diagnose database and tables, this function is used
442      * to verify database and driver settings, db engine types, etc.
443      *
444      * @return string null means everything ok, string means problem found.
445      */
446     public function diagnose() {
447         $sloppymyisamfound = false;
448         $prefix = str_replace('_', '\\_', $this->prefix);
449         $sql = "SELECT COUNT('x')
450                   FROM INFORMATION_SCHEMA.TABLES
451                  WHERE table_schema = DATABASE()
452                        AND table_name LIKE BINARY '$prefix%'
453                        AND Engine = 'MyISAM'";
454         $this->query_start($sql, null, SQL_QUERY_AUX);
455         $result = $this->mysqli->query($sql);
456         $this->query_end($result);
457         if ($result) {
458             if ($arr = $result->fetch_assoc()) {
459                 $count = reset($arr);
460                 if ($count) {
461                     $sloppymyisamfound = true;
462                 }
463             }
464             $result->close();
465         }
467         if ($sloppymyisamfound) {
468             return get_string('myisamproblem', 'error');
469         } else {
470             return null;
471         }
472     }
474     /**
475      * Connect to db
476      * Must be called before other methods.
477      * @param string $dbhost The database host.
478      * @param string $dbuser The database username.
479      * @param string $dbpass The database username's password.
480      * @param string $dbname The name of the database being connected to.e
481      * @param mixed $prefix string means moodle db prefix, false used for external databases where prefix not used
482      * @param array $dboptions driver specific options
483      * @return bool success
484      */
485     public function connect($dbhost, $dbuser, $dbpass, $dbname, $prefix, array $dboptions=null) {
486         $driverstatus = $this->driver_installed();
488         if ($driverstatus !== true) {
489             throw new dml_exception('dbdriverproblem', $driverstatus);
490         }
492         $this->store_settings($dbhost, $dbuser, $dbpass, $dbname, $prefix, $dboptions);
494         // dbsocket is used ONLY if host is NULL or 'localhost',
495         // you can not disable it because it is always tried if dbhost is 'localhost'
496         if (!empty($this->dboptions['dbsocket'])
497                 and (strpos($this->dboptions['dbsocket'], '/') !== false or strpos($this->dboptions['dbsocket'], '\\') !== false)) {
498             $dbsocket = $this->dboptions['dbsocket'];
499         } else {
500             $dbsocket = ini_get('mysqli.default_socket');
501         }
502         if (empty($this->dboptions['dbport'])) {
503             $dbport = (int)ini_get('mysqli.default_port');
504         } else {
505             $dbport = (int)$this->dboptions['dbport'];
506         }
507         // verify ini.get does not return nonsense
508         if (empty($dbport)) {
509             $dbport = 3306;
510         }
511         if ($dbhost and !empty($this->dboptions['dbpersist'])) {
512             $dbhost = "p:$dbhost";
513         }
514         $this->mysqli = @new mysqli($dbhost, $dbuser, $dbpass, $dbname, $dbport, $dbsocket);
516         if ($this->mysqli->connect_errno !== 0) {
517             $dberr = $this->mysqli->connect_error;
518             $this->mysqli = null;
519             throw new dml_connection_exception($dberr);
520         }
522         if (isset($dboptions['dbcollation'])) {
523             $collationinfo = explode('_', $dboptions['dbcollation']);
524             $this->dboptions['dbcollation'] = $dboptions['dbcollation'];
525         } else {
526             $collationinfo = explode('_', $this->get_dbcollation());
527         }
528         $charset = reset($collationinfo);
530         // Disable logging until we are fully setup.
531         $this->query_log_prevent();
533         $this->query_start("--set_charset()", null, SQL_QUERY_AUX);
534         $this->mysqli->set_charset($charset);
535         $this->query_end(true);
537         // If available, enforce strict mode for the session. That guaranties
538         // standard behaviour under some situations, avoiding some MySQL nasty
539         // habits like truncating data or performing some transparent cast losses.
540         // With strict mode enforced, Moodle DB layer will be consistently throwing
541         // the corresponding exceptions as expected.
542         $si = $this->get_server_info();
543         if (version_compare($si['version'], '5.0.2', '>=')) {
544             $sql = "SET SESSION sql_mode = 'STRICT_ALL_TABLES'";
545             $this->query_start($sql, null, SQL_QUERY_AUX);
546             $result = $this->mysqli->query($sql);
547             $this->query_end($result);
548         }
550         // We can enable logging now.
551         $this->query_log_allow();
553         // Connection stabilised and configured, going to instantiate the temptables controller
554         $this->temptables = new mysqli_native_moodle_temptables($this);
556         return true;
557     }
559     /**
560      * Close database connection and release all resources
561      * and memory (especially circular memory references).
562      * Do NOT use connect() again, create a new instance if needed.
563      */
564     public function dispose() {
565         parent::dispose(); // Call parent dispose to write/close session and other common stuff before closing connection
566         if ($this->mysqli) {
567             $this->mysqli->close();
568             $this->mysqli = null;
569         }
570     }
572     /**
573      * Returns database server info array
574      * @return array Array containing 'description' and 'version' info
575      */
576     public function get_server_info() {
577         return array('description'=>$this->mysqli->server_info, 'version'=>$this->mysqli->server_info);
578     }
580     /**
581      * Returns supported query parameter types
582      * @return int bitmask of accepted SQL_PARAMS_*
583      */
584     protected function allowed_param_types() {
585         return SQL_PARAMS_QM;
586     }
588     /**
589      * Returns last error reported by database engine.
590      * @return string error message
591      */
592     public function get_last_error() {
593         return $this->mysqli->error;
594     }
596     /**
597      * Return tables in database WITHOUT current prefix
598      * @param bool $usecache if true, returns list of cached tables.
599      * @return array of table names in lowercase and without prefix
600      */
601     public function get_tables($usecache=true) {
602         if ($usecache and $this->tables !== null) {
603             return $this->tables;
604         }
605         $this->tables = array();
606         $prefix = str_replace('_', '\\_', $this->prefix);
607         $sql = "SHOW TABLES LIKE '$prefix%'";
608         $this->query_start($sql, null, SQL_QUERY_AUX);
609         $result = $this->mysqli->query($sql);
610         $this->query_end($result);
611         $len = strlen($this->prefix);
612         if ($result) {
613             while ($arr = $result->fetch_assoc()) {
614                 $tablename = reset($arr);
615                 $tablename = substr($tablename, $len);
616                 $this->tables[$tablename] = $tablename;
617             }
618             $result->close();
619         }
621         // Add the currently available temptables
622         $this->tables = array_merge($this->tables, $this->temptables->get_temptables());
623         return $this->tables;
624     }
626     /**
627      * Return table indexes - everything lowercased.
628      * @param string $table The table we want to get indexes from.
629      * @return array An associative array of indexes containing 'unique' flag and 'columns' being indexed
630      */
631     public function get_indexes($table) {
632         $indexes = array();
633         $sql = "SHOW INDEXES FROM {$this->prefix}$table";
634         $this->query_start($sql, null, SQL_QUERY_AUX);
635         $result = $this->mysqli->query($sql);
636         try {
637             $this->query_end($result);
638         } catch (dml_read_exception $e) {
639             return $indexes; // table does not exist - no indexes...
640         }
641         if ($result) {
642             while ($res = $result->fetch_object()) {
643                 if ($res->Key_name === 'PRIMARY') {
644                     continue;
645                 }
646                 if (!isset($indexes[$res->Key_name])) {
647                     $indexes[$res->Key_name] = array('unique'=>empty($res->Non_unique), 'columns'=>array());
648                 }
649                 $indexes[$res->Key_name]['columns'][$res->Seq_in_index-1] = $res->Column_name;
650             }
651             $result->close();
652         }
653         return $indexes;
654     }
656     /**
657      * Returns detailed information about columns in table. This information is cached internally.
658      * @param string $table name
659      * @param bool $usecache
660      * @return database_column_info[] array of database_column_info objects indexed with column names
661      */
662     public function get_columns($table, $usecache=true) {
663         if ($usecache) {
664             if ($this->temptables->is_temptable($table)) {
665                 if ($data = $this->get_temp_tables_cache()->get($table)) {
666                     return $data;
667                 }
668             } else {
669                 if ($data = $this->get_metacache()->get($table)) {
670                     return $data;
671                 }
672             }
673         }
675         $structure = array();
677         $sql = "SELECT column_name, data_type, character_maximum_length, numeric_precision,
678                        numeric_scale, is_nullable, column_type, column_default, column_key, extra
679                   FROM information_schema.columns
680                  WHERE table_name = '" . $this->prefix.$table . "'
681                        AND table_schema = '" . $this->dbname . "'
682               ORDER BY ordinal_position";
683         $this->query_start($sql, null, SQL_QUERY_AUX);
684         $result = $this->mysqli->query($sql);
685         $this->query_end(true); // Don't want to throw anything here ever. MDL-30147
687         if ($result === false) {
688             return array();
689         }
691         if ($result->num_rows > 0) {
692             // standard table exists
693             while ($rawcolumn = $result->fetch_assoc()) {
694                 $info = (object)$this->get_column_info((object)$rawcolumn);
695                 $structure[$info->name] = new database_column_info($info);
696             }
697             $result->close();
699         } else {
700             // temporary tables are not in information schema, let's try it the old way
701             $result->close();
702             $sql = "SHOW COLUMNS FROM {$this->prefix}$table";
703             $this->query_start($sql, null, SQL_QUERY_AUX);
704             $result = $this->mysqli->query($sql);
705             $this->query_end(true);
706             if ($result === false) {
707                 return array();
708             }
709             while ($rawcolumn = $result->fetch_assoc()) {
710                 $rawcolumn = (object)array_change_key_case($rawcolumn, CASE_LOWER);
711                 $rawcolumn->column_name              = $rawcolumn->field; unset($rawcolumn->field);
712                 $rawcolumn->column_type              = $rawcolumn->type; unset($rawcolumn->type);
713                 $rawcolumn->character_maximum_length = null;
714                 $rawcolumn->numeric_precision        = null;
715                 $rawcolumn->numeric_scale            = null;
716                 $rawcolumn->is_nullable              = $rawcolumn->null; unset($rawcolumn->null);
717                 $rawcolumn->column_default           = $rawcolumn->default; unset($rawcolumn->default);
718                 $rawcolumn->column_key               = $rawcolumn->key; unset($rawcolumn->default);
720                 if (preg_match('/(enum|varchar)\((\d+)\)/i', $rawcolumn->column_type, $matches)) {
721                     $rawcolumn->data_type = $matches[1];
722                     $rawcolumn->character_maximum_length = $matches[2];
724                 } else if (preg_match('/([a-z]*int[a-z]*)\((\d+)\)/i', $rawcolumn->column_type, $matches)) {
725                     $rawcolumn->data_type = $matches[1];
726                     $rawcolumn->numeric_precision = $matches[2];
727                     $rawcolumn->max_length = $rawcolumn->numeric_precision;
729                     $type = strtoupper($matches[1]);
730                     if ($type === 'BIGINT') {
731                         $maxlength = 18;
732                     } else if ($type === 'INT' or $type === 'INTEGER') {
733                         $maxlength = 9;
734                     } else if ($type === 'MEDIUMINT') {
735                         $maxlength = 6;
736                     } else if ($type === 'SMALLINT') {
737                         $maxlength = 4;
738                     } else if ($type === 'TINYINT') {
739                         $maxlength = 2;
740                     } else {
741                         // This should not happen.
742                         $maxlength = 0;
743                     }
744                     if ($maxlength < $rawcolumn->max_length) {
745                         $rawcolumn->max_length = $maxlength;
746                     }
748                 } else if (preg_match('/(decimal)\((\d+),(\d+)\)/i', $rawcolumn->column_type, $matches)) {
749                     $rawcolumn->data_type = $matches[1];
750                     $rawcolumn->numeric_precision = $matches[2];
751                     $rawcolumn->numeric_scale = $matches[3];
753                 } else if (preg_match('/(double|float)(\((\d+),(\d+)\))?/i', $rawcolumn->column_type, $matches)) {
754                     $rawcolumn->data_type = $matches[1];
755                     $rawcolumn->numeric_precision = isset($matches[3]) ? $matches[3] : null;
756                     $rawcolumn->numeric_scale = isset($matches[4]) ? $matches[4] : null;
758                 } else if (preg_match('/([a-z]*text)/i', $rawcolumn->column_type, $matches)) {
759                     $rawcolumn->data_type = $matches[1];
760                     $rawcolumn->character_maximum_length = -1; // unknown
762                 } else if (preg_match('/([a-z]*blob)/i', $rawcolumn->column_type, $matches)) {
763                     $rawcolumn->data_type = $matches[1];
765                 } else {
766                     $rawcolumn->data_type = $rawcolumn->column_type;
767                 }
769                 $info = $this->get_column_info($rawcolumn);
770                 $structure[$info->name] = new database_column_info($info);
771             }
772             $result->close();
773         }
775         if ($usecache) {
776             if ($this->temptables->is_temptable($table)) {
777                 $this->get_temp_tables_cache()->set($table, $structure);
778             } else {
779                 $this->get_metacache()->set($table, $structure);
780             }
781         }
783         return $structure;
784     }
786     /**
787      * Returns moodle column info for raw column from information schema.
788      * @param stdClass $rawcolumn
789      * @return stdClass standardised colum info
790      */
791     private function get_column_info(stdClass $rawcolumn) {
792         $rawcolumn = (object)$rawcolumn;
793         $info = new stdClass();
794         $info->name           = $rawcolumn->column_name;
795         $info->type           = $rawcolumn->data_type;
796         $info->meta_type      = $this->mysqltype2moodletype($rawcolumn->data_type);
797         $info->default_value  = $rawcolumn->column_default;
798         $info->has_default    = !is_null($rawcolumn->column_default);
799         $info->not_null       = ($rawcolumn->is_nullable === 'NO');
800         $info->primary_key    = ($rawcolumn->column_key === 'PRI');
801         $info->binary         = false;
802         $info->unsigned       = null;
803         $info->auto_increment = false;
804         $info->unique         = null;
805         $info->scale          = null;
807         if ($info->meta_type === 'C') {
808             $info->max_length = $rawcolumn->character_maximum_length;
810         } else if ($info->meta_type === 'I') {
811             if ($info->primary_key) {
812                 $info->meta_type = 'R';
813                 $info->unique    = true;
814             }
815             // Return number of decimals, not bytes here.
816             $info->max_length    = $rawcolumn->numeric_precision;
817             if (preg_match('/([a-z]*int[a-z]*)\((\d+)\)/i', $rawcolumn->column_type, $matches)) {
818                 $type = strtoupper($matches[1]);
819                 if ($type === 'BIGINT') {
820                     $maxlength = 18;
821                 } else if ($type === 'INT' or $type === 'INTEGER') {
822                     $maxlength = 9;
823                 } else if ($type === 'MEDIUMINT') {
824                     $maxlength = 6;
825                 } else if ($type === 'SMALLINT') {
826                     $maxlength = 4;
827                 } else if ($type === 'TINYINT') {
828                     $maxlength = 2;
829                 } else {
830                     // This should not happen.
831                     $maxlength = 0;
832                 }
833                 // It is possible that display precision is different from storage type length,
834                 // always use the smaller value to make sure our data fits.
835                 if ($maxlength < $info->max_length) {
836                     $info->max_length = $maxlength;
837                 }
838             }
839             $info->unsigned      = (stripos($rawcolumn->column_type, 'unsigned') !== false);
840             $info->auto_increment= (strpos($rawcolumn->extra, 'auto_increment') !== false);
842         } else if ($info->meta_type === 'N') {
843             $info->max_length    = $rawcolumn->numeric_precision;
844             $info->scale         = $rawcolumn->numeric_scale;
845             $info->unsigned      = (stripos($rawcolumn->column_type, 'unsigned') !== false);
847         } else if ($info->meta_type === 'X') {
848             if ("$rawcolumn->character_maximum_length" === '4294967295') { // watch out for PHP max int limits!
849                 // means maximum moodle size for text column, in other drivers it may also mean unknown size
850                 $info->max_length = -1;
851             } else {
852                 $info->max_length = $rawcolumn->character_maximum_length;
853             }
854             $info->primary_key   = false;
856         } else if ($info->meta_type === 'B') {
857             $info->max_length    = -1;
858             $info->primary_key   = false;
859             $info->binary        = true;
860         }
862         return $info;
863     }
865     /**
866      * Normalise column type.
867      * @param string $mysql_type
868      * @return string one character
869      * @throws dml_exception
870      */
871     private function mysqltype2moodletype($mysql_type) {
872         $type = null;
874         switch(strtoupper($mysql_type)) {
875             case 'BIT':
876                 $type = 'L';
877                 break;
879             case 'TINYINT':
880             case 'SMALLINT':
881             case 'MEDIUMINT':
882             case 'INT':
883             case 'INTEGER':
884             case 'BIGINT':
885                 $type = 'I';
886                 break;
888             case 'FLOAT':
889             case 'DOUBLE':
890             case 'DECIMAL':
891                 $type = 'N';
892                 break;
894             case 'CHAR':
895             case 'ENUM':
896             case 'SET':
897             case 'VARCHAR':
898                 $type = 'C';
899                 break;
901             case 'TINYTEXT':
902             case 'TEXT':
903             case 'MEDIUMTEXT':
904             case 'LONGTEXT':
905                 $type = 'X';
906                 break;
908             case 'BINARY':
909             case 'VARBINARY':
910             case 'BLOB':
911             case 'TINYBLOB':
912             case 'MEDIUMBLOB':
913             case 'LONGBLOB':
914                 $type = 'B';
915                 break;
917             case 'DATE':
918             case 'TIME':
919             case 'DATETIME':
920             case 'TIMESTAMP':
921             case 'YEAR':
922                 $type = 'D';
923                 break;
924         }
926         if (!$type) {
927             throw new dml_exception('invalidmysqlnativetype', $mysql_type);
928         }
929         return $type;
930     }
932     /**
933      * Normalise values based in RDBMS dependencies (booleans, LOBs...)
934      *
935      * @param database_column_info $column column metadata corresponding with the value we are going to normalise
936      * @param mixed $value value we are going to normalise
937      * @return mixed the normalised value
938      */
939     protected function normalise_value($column, $value) {
940         $this->detect_objects($value);
942         if (is_bool($value)) { // Always, convert boolean to int
943             $value = (int)$value;
945         } else if ($value === '') {
946             if ($column->meta_type == 'I' or $column->meta_type == 'F' or $column->meta_type == 'N') {
947                 $value = 0; // prevent '' problems in numeric fields
948             }
949         // Any float value being stored in varchar or text field is converted to string to avoid
950         // any implicit conversion by MySQL
951         } else if (is_float($value) and ($column->meta_type == 'C' or $column->meta_type == 'X')) {
952             $value = "$value";
953         }
954         return $value;
955     }
957     /**
958      * Is this database compatible with utf8?
959      * @return bool
960      */
961     public function setup_is_unicodedb() {
962         // All new tables are created with this collation, we just have to make sure it is utf8 compatible,
963         // if config table already exists it has this collation too.
964         $collation = $this->get_dbcollation();
966         $collationinfo = explode('_', $collation);
967         $charset = reset($collationinfo);
969         $sql = "SHOW COLLATION WHERE Collation ='$collation' AND Charset = '$charset'";
970         $this->query_start($sql, NULL, SQL_QUERY_AUX);
971         $result = $this->mysqli->query($sql);
972         $this->query_end($result);
973         if ($result->fetch_assoc()) {
974             $return = true;
975         } else {
976             $return = false;
977         }
978         $result->close();
980         return $return;
981     }
983     /**
984      * Do NOT use in code, to be used by database_manager only!
985      * @param string|array $sql query
986      * @param array|null $tablenames an array of xmldb table names affected by this request.
987      * @return bool true
988      * @throws ddl_change_structure_exception A DDL specific exception is thrown for any errors.
989      */
990     public function change_database_structure($sql, $tablenames = null) {
991         $this->get_manager(); // Includes DDL exceptions classes ;-)
992         if (is_array($sql)) {
993             $sql = implode("\n;\n", $sql);
994         }
996         try {
997             $this->query_start($sql, null, SQL_QUERY_STRUCTURE);
998             $result = $this->mysqli->multi_query($sql);
999             if ($result === false) {
1000                 $this->query_end(false);
1001             }
1002             while ($this->mysqli->more_results()) {
1003                 $result = $this->mysqli->next_result();
1004                 if ($result === false) {
1005                     $this->query_end(false);
1006                 }
1007             }
1008             $this->query_end(true);
1009         } catch (ddl_change_structure_exception $e) {
1010             while (@$this->mysqli->more_results()) {
1011                 @$this->mysqli->next_result();
1012             }
1013             $this->reset_caches($tablenames);
1014             throw $e;
1015         }
1017         $this->reset_caches($tablenames);
1018         return true;
1019     }
1021     /**
1022      * Very ugly hack which emulates bound parameters in queries
1023      * because prepared statements do not use query cache.
1024      */
1025     protected function emulate_bound_params($sql, array $params=null) {
1026         if (empty($params)) {
1027             return $sql;
1028         }
1029         // ok, we have verified sql statement with ? and correct number of params
1030         $parts = array_reverse(explode('?', $sql));
1031         $return = array_pop($parts);
1032         foreach ($params as $param) {
1033             if (is_bool($param)) {
1034                 $return .= (int)$param;
1035             } else if (is_null($param)) {
1036                 $return .= 'NULL';
1037             } else if (is_number($param)) {
1038                 $return .= "'".$param."'"; // we have to always use strings because mysql is using weird automatic int casting
1039             } else if (is_float($param)) {
1040                 $return .= $param;
1041             } else {
1042                 $param = $this->mysqli->real_escape_string($param);
1043                 $return .= "'$param'";
1044             }
1045             $return .= array_pop($parts);
1046         }
1047         return $return;
1048     }
1050     /**
1051      * Execute general sql query. Should be used only when no other method suitable.
1052      * Do NOT use this to make changes in db structure, use database_manager methods instead!
1053      * @param string $sql query
1054      * @param array $params query parameters
1055      * @return bool true
1056      * @throws dml_exception A DML specific exception is thrown for any errors.
1057      */
1058     public function execute($sql, array $params=null) {
1059         list($sql, $params, $type) = $this->fix_sql_params($sql, $params);
1061         if (strpos($sql, ';') !== false) {
1062             throw new coding_exception('moodle_database::execute() Multiple sql statements found or bound parameters not used properly in query!');
1063         }
1065         $rawsql = $this->emulate_bound_params($sql, $params);
1067         $this->query_start($sql, $params, SQL_QUERY_UPDATE);
1068         $result = $this->mysqli->query($rawsql);
1069         $this->query_end($result);
1071         if ($result === true) {
1072             return true;
1074         } else {
1075             $result->close();
1076             return true;
1077         }
1078     }
1080     /**
1081      * Get a number of records as a moodle_recordset using a SQL statement.
1082      *
1083      * Since this method is a little less readable, use of it should be restricted to
1084      * code where it's possible there might be large datasets being returned.  For known
1085      * small datasets use get_records_sql - it leads to simpler code.
1086      *
1087      * The return type is like:
1088      * @see function get_recordset.
1089      *
1090      * @param string $sql the SQL select query to execute.
1091      * @param array $params array of sql parameters
1092      * @param int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
1093      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
1094      * @return moodle_recordset instance
1095      * @throws dml_exception A DML specific exception is thrown for any errors.
1096      */
1097     public function get_recordset_sql($sql, array $params=null, $limitfrom=0, $limitnum=0) {
1099         list($limitfrom, $limitnum) = $this->normalise_limit_from_num($limitfrom, $limitnum);
1101         if ($limitfrom or $limitnum) {
1102             if ($limitnum < 1) {
1103                 $limitnum = "18446744073709551615";
1104             }
1105             $sql .= " LIMIT $limitfrom, $limitnum";
1106         }
1108         list($sql, $params, $type) = $this->fix_sql_params($sql, $params);
1109         $rawsql = $this->emulate_bound_params($sql, $params);
1111         $this->query_start($sql, $params, SQL_QUERY_SELECT);
1112         // no MYSQLI_USE_RESULT here, it would block write ops on affected tables
1113         $result = $this->mysqli->query($rawsql, MYSQLI_STORE_RESULT);
1114         $this->query_end($result);
1116         return $this->create_recordset($result);
1117     }
1119     /**
1120      * Get all records from a table.
1121      *
1122      * This method works around potential memory problems and may improve performance,
1123      * this method may block access to table until the recordset is closed.
1124      *
1125      * @param string $table Name of database table.
1126      * @return moodle_recordset A moodle_recordset instance {@link function get_recordset}.
1127      * @throws dml_exception A DML specific exception is thrown for any errors.
1128      */
1129     public function export_table_recordset($table) {
1130         $sql = $this->fix_table_names("SELECT * FROM {{$table}}");
1132         $this->query_start($sql, array(), SQL_QUERY_SELECT);
1133         // MYSQLI_STORE_RESULT may eat all memory for large tables, unfortunately MYSQLI_USE_RESULT blocks other queries.
1134         $result = $this->mysqli->query($sql, MYSQLI_USE_RESULT);
1135         $this->query_end($result);
1137         return $this->create_recordset($result);
1138     }
1140     protected function create_recordset($result) {
1141         return new mysqli_native_moodle_recordset($result);
1142     }
1144     /**
1145      * Get a number of records as an array of objects using a SQL statement.
1146      *
1147      * Return value is like:
1148      * @see function get_records.
1149      *
1150      * @param string $sql the SQL select query to execute. The first column of this SELECT statement
1151      *   must be a unique value (usually the 'id' field), as it will be used as the key of the
1152      *   returned array.
1153      * @param array $params array of sql parameters
1154      * @param int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
1155      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
1156      * @return array of objects, or empty array if no records were found
1157      * @throws dml_exception A DML specific exception is thrown for any errors.
1158      */
1159     public function get_records_sql($sql, array $params=null, $limitfrom=0, $limitnum=0) {
1161         list($limitfrom, $limitnum) = $this->normalise_limit_from_num($limitfrom, $limitnum);
1163         if ($limitfrom or $limitnum) {
1164             if ($limitnum < 1) {
1165                 $limitnum = "18446744073709551615";
1166             }
1167             $sql .= " LIMIT $limitfrom, $limitnum";
1168         }
1170         list($sql, $params, $type) = $this->fix_sql_params($sql, $params);
1171         $rawsql = $this->emulate_bound_params($sql, $params);
1173         $this->query_start($sql, $params, SQL_QUERY_SELECT);
1174         $result = $this->mysqli->query($rawsql, MYSQLI_STORE_RESULT);
1175         $this->query_end($result);
1177         $return = array();
1179         while($row = $result->fetch_assoc()) {
1180             $row = array_change_key_case($row, CASE_LOWER);
1181             $id  = reset($row);
1182             if (isset($return[$id])) {
1183                 $colname = key($row);
1184                 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);
1185             }
1186             $return[$id] = (object)$row;
1187         }
1188         $result->close();
1190         return $return;
1191     }
1193     /**
1194      * Selects records and return values (first field) as an array using a SQL statement.
1195      *
1196      * @param string $sql The SQL query
1197      * @param array $params array of sql parameters
1198      * @return array of values
1199      * @throws dml_exception A DML specific exception is thrown for any errors.
1200      */
1201     public function get_fieldset_sql($sql, array $params=null) {
1202         list($sql, $params, $type) = $this->fix_sql_params($sql, $params);
1203         $rawsql = $this->emulate_bound_params($sql, $params);
1205         $this->query_start($sql, $params, SQL_QUERY_SELECT);
1206         $result = $this->mysqli->query($rawsql, MYSQLI_STORE_RESULT);
1207         $this->query_end($result);
1209         $return = array();
1211         while($row = $result->fetch_assoc()) {
1212             $return[] = reset($row);
1213         }
1214         $result->close();
1216         return $return;
1217     }
1219     /**
1220      * Insert new record into database, as fast as possible, no safety checks, lobs not supported.
1221      * @param string $table name
1222      * @param mixed $params data record as object or array
1223      * @param bool $returnit return it of inserted record
1224      * @param bool $bulk true means repeated inserts expected
1225      * @param bool $customsequence true if 'id' included in $params, disables $returnid
1226      * @return bool|int true or new id
1227      * @throws dml_exception A DML specific exception is thrown for any errors.
1228      */
1229     public function insert_record_raw($table, $params, $returnid=true, $bulk=false, $customsequence=false) {
1230         if (!is_array($params)) {
1231             $params = (array)$params;
1232         }
1234         if ($customsequence) {
1235             if (!isset($params['id'])) {
1236                 throw new coding_exception('moodle_database::insert_record_raw() id field must be specified if custom sequences used.');
1237             }
1238             $returnid = false;
1239         } else {
1240             unset($params['id']);
1241         }
1243         if (empty($params)) {
1244             throw new coding_exception('moodle_database::insert_record_raw() no fields found.');
1245         }
1247         $fields = implode(',', array_keys($params));
1248         $qms    = array_fill(0, count($params), '?');
1249         $qms    = implode(',', $qms);
1251         $sql = "INSERT INTO {$this->prefix}$table ($fields) VALUES($qms)";
1253         list($sql, $params, $type) = $this->fix_sql_params($sql, $params);
1254         $rawsql = $this->emulate_bound_params($sql, $params);
1256         $this->query_start($sql, $params, SQL_QUERY_INSERT);
1257         $result = $this->mysqli->query($rawsql);
1258         $id = @$this->mysqli->insert_id; // must be called before query_end() which may insert log into db
1259         $this->query_end($result);
1261         if (!$customsequence and !$id) {
1262             throw new dml_write_exception('unknown error fetching inserted id');
1263         }
1265         if (!$returnid) {
1266             return true;
1267         } else {
1268             return (int)$id;
1269         }
1270     }
1272     /**
1273      * Insert a record into a table and return the "id" field if required.
1274      *
1275      * Some conversions and safety checks are carried out. Lobs are supported.
1276      * If the return ID isn't required, then this just reports success as true/false.
1277      * $data is an object containing needed data
1278      * @param string $table The database table to be inserted into
1279      * @param object $data A data object with values for one or more fields in the record
1280      * @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.
1281      * @return bool|int true or new id
1282      * @throws dml_exception A DML specific exception is thrown for any errors.
1283      */
1284     public function insert_record($table, $dataobject, $returnid=true, $bulk=false) {
1285         $dataobject = (array)$dataobject;
1287         $columns = $this->get_columns($table);
1288         if (empty($columns)) {
1289             throw new dml_exception('ddltablenotexist', $table);
1290         }
1292         $cleaned = array();
1294         foreach ($dataobject as $field=>$value) {
1295             if ($field === 'id') {
1296                 continue;
1297             }
1298             if (!isset($columns[$field])) {
1299                 continue;
1300             }
1301             $column = $columns[$field];
1302             $cleaned[$field] = $this->normalise_value($column, $value);
1303         }
1305         return $this->insert_record_raw($table, $cleaned, $returnid, $bulk);
1306     }
1308     /**
1309      * Insert multiple records into database as fast as possible.
1310      *
1311      * Order of inserts is maintained, but the operation is not atomic,
1312      * use transactions if necessary.
1313      *
1314      * This method is intended for inserting of large number of small objects,
1315      * do not use for huge objects with text or binary fields.
1316      *
1317      * @since Moodle 2.7
1318      *
1319      * @param string $table  The database table to be inserted into
1320      * @param array|Traversable $dataobjects list of objects to be inserted, must be compatible with foreach
1321      * @return void does not return new record ids
1322      *
1323      * @throws coding_exception if data objects have different structure
1324      * @throws dml_exception A DML specific exception is thrown for any errors.
1325      */
1326     public function insert_records($table, $dataobjects) {
1327         if (!is_array($dataobjects) and !$dataobjects instanceof Traversable) {
1328             throw new coding_exception('insert_records() passed non-traversable object');
1329         }
1331         // MySQL has a relatively small query length limit by default,
1332         // make sure 'max_allowed_packet' in my.cnf is high enough
1333         // if you change the following default...
1334         static $chunksize = null;
1335         if ($chunksize === null) {
1336             if (!empty($this->dboptions['bulkinsertsize'])) {
1337                 $chunksize = (int)$this->dboptions['bulkinsertsize'];
1339             } else {
1340                 if (PHP_INT_SIZE === 4) {
1341                     // Bad luck for Windows, we cannot do any maths with large numbers.
1342                     $chunksize = 5;
1343                 } else {
1344                     $sql = "SHOW VARIABLES LIKE 'max_allowed_packet'";
1345                     $this->query_start($sql, null, SQL_QUERY_AUX);
1346                     $result = $this->mysqli->query($sql);
1347                     $this->query_end($result);
1348                     $size = 0;
1349                     if ($rec = $result->fetch_assoc()) {
1350                         $size = $rec['Value'];
1351                     }
1352                     $result->close();
1353                     // Hopefully 200kb per object are enough.
1354                     $chunksize = (int)($size / 200000);
1355                     if ($chunksize > 50) {
1356                         $chunksize = 50;
1357                     }
1358                 }
1359             }
1360         }
1362         $columns = $this->get_columns($table, true);
1363         $fields = null;
1364         $count = 0;
1365         $chunk = array();
1366         foreach ($dataobjects as $dataobject) {
1367             if (!is_array($dataobject) and !is_object($dataobject)) {
1368                 throw new coding_exception('insert_records() passed invalid record object');
1369             }
1370             $dataobject = (array)$dataobject;
1371             if ($fields === null) {
1372                 $fields = array_keys($dataobject);
1373                 $columns = array_intersect_key($columns, $dataobject);
1374                 unset($columns['id']);
1375             } else if ($fields !== array_keys($dataobject)) {
1376                 throw new coding_exception('All dataobjects in insert_records() must have the same structure!');
1377             }
1379             $count++;
1380             $chunk[] = $dataobject;
1382             if ($count === $chunksize) {
1383                 $this->insert_chunk($table, $chunk, $columns);
1384                 $chunk = array();
1385                 $count = 0;
1386             }
1387         }
1389         if ($count) {
1390             $this->insert_chunk($table, $chunk, $columns);
1391         }
1392     }
1394     /**
1395      * Insert records in chunks.
1396      *
1397      * Note: can be used only from insert_records().
1398      *
1399      * @param string $table
1400      * @param array $chunk
1401      * @param database_column_info[] $columns
1402      */
1403     protected function insert_chunk($table, array $chunk, array $columns) {
1404         $fieldssql = '('.implode(',', array_keys($columns)).')';
1406         $valuessql = '('.implode(',', array_fill(0, count($columns), '?')).')';
1407         $valuessql = implode(',', array_fill(0, count($chunk), $valuessql));
1409         $params = array();
1410         foreach ($chunk as $dataobject) {
1411             foreach ($columns as $field => $column) {
1412                 $params[] = $this->normalise_value($column, $dataobject[$field]);
1413             }
1414         }
1416         $sql = "INSERT INTO {$this->prefix}$table $fieldssql VALUES $valuessql";
1418         list($sql, $params, $type) = $this->fix_sql_params($sql, $params);
1419         $rawsql = $this->emulate_bound_params($sql, $params);
1421         $this->query_start($sql, $params, SQL_QUERY_INSERT);
1422         $result = $this->mysqli->query($rawsql);
1423         $this->query_end($result);
1424     }
1426     /**
1427      * Import a record into a table, id field is required.
1428      * Safety checks are NOT carried out. Lobs are supported.
1429      *
1430      * @param string $table name of database table to be inserted into
1431      * @param object $dataobject A data object with values for one or more fields in the record
1432      * @return bool true
1433      * @throws dml_exception A DML specific exception is thrown for any errors.
1434      */
1435     public function import_record($table, $dataobject) {
1436         $dataobject = (array)$dataobject;
1438         $columns = $this->get_columns($table);
1439         $cleaned = array();
1441         foreach ($dataobject as $field=>$value) {
1442             if (!isset($columns[$field])) {
1443                 continue;
1444             }
1445             $cleaned[$field] = $value;
1446         }
1448         return $this->insert_record_raw($table, $cleaned, false, true, true);
1449     }
1451     /**
1452      * Update record in database, as fast as possible, no safety checks, lobs not supported.
1453      * @param string $table name
1454      * @param mixed $params data record as object or array
1455      * @param bool true means repeated updates expected
1456      * @return bool true
1457      * @throws dml_exception A DML specific exception is thrown for any errors.
1458      */
1459     public function update_record_raw($table, $params, $bulk=false) {
1460         $params = (array)$params;
1462         if (!isset($params['id'])) {
1463             throw new coding_exception('moodle_database::update_record_raw() id field must be specified.');
1464         }
1465         $id = $params['id'];
1466         unset($params['id']);
1468         if (empty($params)) {
1469             throw new coding_exception('moodle_database::update_record_raw() no fields found.');
1470         }
1472         $sets = array();
1473         foreach ($params as $field=>$value) {
1474             $sets[] = "$field = ?";
1475         }
1477         $params[] = $id; // last ? in WHERE condition
1479         $sets = implode(',', $sets);
1480         $sql = "UPDATE {$this->prefix}$table SET $sets WHERE id=?";
1482         list($sql, $params, $type) = $this->fix_sql_params($sql, $params);
1483         $rawsql = $this->emulate_bound_params($sql, $params);
1485         $this->query_start($sql, $params, SQL_QUERY_UPDATE);
1486         $result = $this->mysqli->query($rawsql);
1487         $this->query_end($result);
1489         return true;
1490     }
1492     /**
1493      * Update a record in a table
1494      *
1495      * $dataobject is an object containing needed data
1496      * Relies on $dataobject having a variable "id" to
1497      * specify the record to update
1498      *
1499      * @param string $table The database table to be checked against.
1500      * @param object $dataobject An object with contents equal to fieldname=>fieldvalue. Must have an entry for 'id' to map to the table specified.
1501      * @param bool true means repeated updates expected
1502      * @return bool true
1503      * @throws dml_exception A DML specific exception is thrown for any errors.
1504      */
1505     public function update_record($table, $dataobject, $bulk=false) {
1506         $dataobject = (array)$dataobject;
1508         $columns = $this->get_columns($table);
1509         $cleaned = array();
1511         foreach ($dataobject as $field=>$value) {
1512             if (!isset($columns[$field])) {
1513                 continue;
1514             }
1515             $column = $columns[$field];
1516             $cleaned[$field] = $this->normalise_value($column, $value);
1517         }
1519         return $this->update_record_raw($table, $cleaned, $bulk);
1520     }
1522     /**
1523      * Set a single field in every table record which match a particular WHERE clause.
1524      *
1525      * @param string $table The database table to be checked against.
1526      * @param string $newfield the field to set.
1527      * @param string $newvalue the value to set the field to.
1528      * @param string $select A fragment of SQL to be used in a where clause in the SQL call.
1529      * @param array $params array of sql parameters
1530      * @return bool true
1531      * @throws dml_exception A DML specific exception is thrown for any errors.
1532      */
1533     public function set_field_select($table, $newfield, $newvalue, $select, array $params=null) {
1534         if ($select) {
1535             $select = "WHERE $select";
1536         }
1537         if (is_null($params)) {
1538             $params = array();
1539         }
1540         list($select, $params, $type) = $this->fix_sql_params($select, $params);
1542         // Get column metadata
1543         $columns = $this->get_columns($table);
1544         $column = $columns[$newfield];
1546         $normalised_value = $this->normalise_value($column, $newvalue);
1548         if (is_null($normalised_value)) {
1549             $newfield = "$newfield = NULL";
1550         } else {
1551             $newfield = "$newfield = ?";
1552             array_unshift($params, $normalised_value);
1553         }
1554         $sql = "UPDATE {$this->prefix}$table SET $newfield $select";
1555         $rawsql = $this->emulate_bound_params($sql, $params);
1557         $this->query_start($sql, $params, SQL_QUERY_UPDATE);
1558         $result = $this->mysqli->query($rawsql);
1559         $this->query_end($result);
1561         return true;
1562     }
1564     /**
1565      * Delete one or more records from a table which match a particular WHERE clause.
1566      *
1567      * @param string $table The database table to be checked against.
1568      * @param string $select A fragment of SQL to be used in a where clause in the SQL call (used to define the selection criteria).
1569      * @param array $params array of sql parameters
1570      * @return bool true
1571      * @throws dml_exception A DML specific exception is thrown for any errors.
1572      */
1573     public function delete_records_select($table, $select, array $params=null) {
1574         if ($select) {
1575             $select = "WHERE $select";
1576         }
1577         $sql = "DELETE FROM {$this->prefix}$table $select";
1579         list($sql, $params, $type) = $this->fix_sql_params($sql, $params);
1580         $rawsql = $this->emulate_bound_params($sql, $params);
1582         $this->query_start($sql, $params, SQL_QUERY_UPDATE);
1583         $result = $this->mysqli->query($rawsql);
1584         $this->query_end($result);
1586         return true;
1587     }
1589     public function sql_cast_char2int($fieldname, $text=false) {
1590         return ' CAST(' . $fieldname . ' AS SIGNED) ';
1591     }
1593     public function sql_cast_char2real($fieldname, $text=false) {
1594         // Set to 65 (max mysql 5.5 precision) with 7 as scale
1595         // because we must ensure at least 6 decimal positions
1596         // per casting given that postgres is casting to that scale (::real::).
1597         // Can be raised easily but that must be done in all DBs and tests.
1598         return ' CAST(' . $fieldname . ' AS DECIMAL(65,7)) ';
1599     }
1601     public function sql_equal($fieldname, $param, $casesensitive = true, $accentsensitive = true, $notequal = false) {
1602         $equalop = $notequal ? '<>' : '=';
1604         $collationinfo = explode('_', $this->get_dbcollation());
1605         $bincollate = reset($collationinfo) . '_bin';
1607         if ($casesensitive) {
1608             // Current MySQL versions do not support case sensitive and accent insensitive.
1609             return "$fieldname COLLATE $bincollate $equalop $param";
1610         } else if ($accentsensitive) {
1611             // Case insensitive and accent sensitive, we can force a binary comparison once all texts are using the same case.
1612             return "LOWER($fieldname) COLLATE $bincollate $equalop LOWER($param)";
1613         } else {
1614             // Case insensitive and accent insensitive. All collations are that way, but utf8_bin.
1615             $collation = '';
1616             if ($this->get_dbcollation() == 'utf8_bin') {
1617                 $collation = 'COLLATE utf8_unicode_ci';
1618             } else if ($this->get_dbcollation() == 'utf8mb4_bin') {
1619                 $collation = 'COLLATE utf8mb4_unicode_ci';
1620             }
1621             return "$fieldname $collation $equalop $param";
1622         }
1623     }
1625     /**
1626      * Returns 'LIKE' part of a query.
1627      *
1628      * Note that mysql does not support $casesensitive = true and $accentsensitive = false.
1629      * More information in http://bugs.mysql.com/bug.php?id=19567.
1630      *
1631      * @param string $fieldname usually name of the table column
1632      * @param string $param usually bound query parameter (?, :named)
1633      * @param bool $casesensitive use case sensitive search
1634      * @param bool $accensensitive use accent sensitive search (ignored if $casesensitive is true)
1635      * @param bool $notlike true means "NOT LIKE"
1636      * @param string $escapechar escape char for '%' and '_'
1637      * @return string SQL code fragment
1638      */
1639     public function sql_like($fieldname, $param, $casesensitive = true, $accentsensitive = true, $notlike = false, $escapechar = '\\') {
1640         if (strpos($param, '%') !== false) {
1641             debugging('Potential SQL injection detected, sql_like() expects bound parameters (? or :named)');
1642         }
1643         $escapechar = $this->mysqli->real_escape_string($escapechar); // prevents problems with C-style escapes of enclosing '\'
1645         $collationinfo = explode('_', $this->get_dbcollation());
1646         $bincollate = reset($collationinfo) . '_bin';
1648         $LIKE = $notlike ? 'NOT LIKE' : 'LIKE';
1650         if ($casesensitive) {
1651             // Current MySQL versions do not support case sensitive and accent insensitive.
1652             return "$fieldname $LIKE $param COLLATE $bincollate ESCAPE '$escapechar'";
1654         } else if ($accentsensitive) {
1655             // Case insensitive and accent sensitive, we can force a binary comparison once all texts are using the same case.
1656             return "LOWER($fieldname) $LIKE LOWER($param) COLLATE $bincollate ESCAPE '$escapechar'";
1658         } else {
1659             // Case insensitive and accent insensitive.
1660             $collation = '';
1661             if ($this->get_dbcollation() == 'utf8_bin') {
1662                 // Force a case insensitive comparison if using utf8_bin.
1663                 $collation = 'COLLATE utf8_unicode_ci';
1664             } else if ($this->get_dbcollation() == 'utf8mb4_bin') {
1665                 // Force a case insensitive comparison if using utf8mb4_bin.
1666                 $collation = 'COLLATE utf8mb4_unicode_ci';
1667             }
1669             return "$fieldname $LIKE $param $collation ESCAPE '$escapechar'";
1670         }
1671     }
1673     /**
1674      * Returns the proper SQL to do CONCAT between the elements passed
1675      * Can take many parameters
1676      *
1677      * @param string $str,... 1 or more fields/strings to concat
1678      *
1679      * @return string The concat sql
1680      */
1681     public function sql_concat() {
1682         $arr = func_get_args();
1683         $s = implode(', ', $arr);
1684         if ($s === '') {
1685             return "''";
1686         }
1687         return "CONCAT($s)";
1688     }
1690     /**
1691      * Returns the proper SQL to do CONCAT between the elements passed
1692      * with a given separator
1693      *
1694      * @param string $separator The string to use as the separator
1695      * @param array $elements An array of items to concatenate
1696      * @return string The concat SQL
1697      */
1698     public function sql_concat_join($separator="' '", $elements=array()) {
1699         $s = implode(', ', $elements);
1701         if ($s === '') {
1702             return "''";
1703         }
1704         return "CONCAT_WS($separator, $s)";
1705     }
1707     /**
1708      * Returns the SQL text to be used to calculate the length in characters of one expression.
1709      * @param string fieldname or expression to calculate its length in characters.
1710      * @return string the piece of SQL code to be used in the statement.
1711      */
1712     public function sql_length($fieldname) {
1713         return ' CHAR_LENGTH(' . $fieldname . ')';
1714     }
1716     /**
1717      * Does this driver support regex syntax when searching
1718      */
1719     public function sql_regex_supported() {
1720         return true;
1721     }
1723     /**
1724      * Return regex positive or negative match sql
1725      * @param bool $positivematch
1726      * @return string or empty if not supported
1727      */
1728     public function sql_regex($positivematch=true) {
1729         return $positivematch ? 'REGEXP' : 'NOT REGEXP';
1730     }
1732     /**
1733      * Returns the SQL to be used in order to an UNSIGNED INTEGER column to SIGNED.
1734      *
1735      * @deprecated since 2.3
1736      * @param string $fieldname The name of the field to be cast
1737      * @return string The piece of SQL code to be used in your statement.
1738      */
1739     public function sql_cast_2signed($fieldname) {
1740         return ' CAST(' . $fieldname . ' AS SIGNED) ';
1741     }
1743     /**
1744      * Returns the SQL that allows to find intersection of two or more queries
1745      *
1746      * @since Moodle 2.8
1747      *
1748      * @param array $selects array of SQL select queries, each of them only returns fields with the names from $fields
1749      * @param string $fields comma-separated list of fields
1750      * @return string SQL query that will return only values that are present in each of selects
1751      */
1752     public function sql_intersect($selects, $fields) {
1753         if (count($selects) <= 1) {
1754             return parent::sql_intersect($selects, $fields);
1755         }
1756         $fields = preg_replace('/\s/', '', $fields);
1757         static $aliascnt = 0;
1758         $falias = 'intsctal'.($aliascnt++);
1759         $rv = "SELECT $falias.".
1760             preg_replace('/,/', ','.$falias.'.', $fields).
1761             " FROM ($selects[0]) $falias";
1762         for ($i = 1; $i < count($selects); $i++) {
1763             $alias = 'intsctal'.($aliascnt++);
1764             $rv .= " JOIN (".$selects[$i].") $alias ON ".
1765                 join(' AND ',
1766                     array_map(
1767                         create_function('$a', 'return "'.$falias.'.$a = '.$alias.'.$a";'),
1768                         preg_split('/,/', $fields))
1769                 );
1770         }
1771         return $rv;
1772     }
1774     /**
1775      * Does this driver support tool_replace?
1776      *
1777      * @since Moodle 2.6.1
1778      * @return bool
1779      */
1780     public function replace_all_text_supported() {
1781         return true;
1782     }
1784     public function session_lock_supported() {
1785         return true;
1786     }
1788     /**
1789      * Obtain session lock
1790      * @param int $rowid id of the row with session record
1791      * @param int $timeout max allowed time to wait for the lock in seconds
1792      * @return void
1793      */
1794     public function get_session_lock($rowid, $timeout) {
1795         parent::get_session_lock($rowid, $timeout);
1797         $fullname = $this->dbname.'-'.$this->prefix.'-session-'.$rowid;
1798         $sql = "SELECT GET_LOCK('$fullname', $timeout)";
1799         $this->query_start($sql, null, SQL_QUERY_AUX);
1800         $result = $this->mysqli->query($sql);
1801         $this->query_end($result);
1803         if ($result) {
1804             $arr = $result->fetch_assoc();
1805             $result->close();
1807             if (reset($arr) == 1) {
1808                 return;
1809             } else {
1810                 throw new dml_sessionwait_exception();
1811             }
1812         }
1813     }
1815     public function release_session_lock($rowid) {
1816         if (!$this->used_for_db_sessions) {
1817             return;
1818         }
1820         parent::release_session_lock($rowid);
1821         $fullname = $this->dbname.'-'.$this->prefix.'-session-'.$rowid;
1822         $sql = "SELECT RELEASE_LOCK('$fullname')";
1823         $this->query_start($sql, null, SQL_QUERY_AUX);
1824         $result = $this->mysqli->query($sql);
1825         $this->query_end($result);
1827         if ($result) {
1828             $result->close();
1829         }
1830     }
1832     /**
1833      * Are transactions supported?
1834      * It is not responsible to run productions servers
1835      * on databases without transaction support ;-)
1836      *
1837      * MyISAM does not support support transactions.
1838      *
1839      * You can override this via the dbtransactions option.
1840      *
1841      * @return bool
1842      */
1843     protected function transactions_supported() {
1844         if (!is_null($this->transactions_supported)) {
1845             return $this->transactions_supported;
1846         }
1848         // this is all just guessing, might be better to just specify it in config.php
1849         if (isset($this->dboptions['dbtransactions'])) {
1850             $this->transactions_supported = $this->dboptions['dbtransactions'];
1851             return $this->transactions_supported;
1852         }
1854         $this->transactions_supported = false;
1856         $engine = $this->get_dbengine();
1858         // Only will accept transactions if using compatible storage engine (more engines can be added easily BDB, Falcon...)
1859         if (in_array($engine, array('InnoDB', 'INNOBASE', 'BDB', 'XtraDB', 'Aria', 'Falcon'))) {
1860             $this->transactions_supported = true;
1861         }
1863         return $this->transactions_supported;
1864     }
1866     /**
1867      * Driver specific start of real database transaction,
1868      * this can not be used directly in code.
1869      * @return void
1870      */
1871     protected function begin_transaction() {
1872         if (!$this->transactions_supported()) {
1873             return;
1874         }
1876         $sql = "SET SESSION TRANSACTION ISOLATION LEVEL READ COMMITTED";
1877         $this->query_start($sql, NULL, SQL_QUERY_AUX);
1878         $result = $this->mysqli->query($sql);
1879         $this->query_end($result);
1881         $sql = "START TRANSACTION";
1882         $this->query_start($sql, NULL, SQL_QUERY_AUX);
1883         $result = $this->mysqli->query($sql);
1884         $this->query_end($result);
1885     }
1887     /**
1888      * Driver specific commit of real database transaction,
1889      * this can not be used directly in code.
1890      * @return void
1891      */
1892     protected function commit_transaction() {
1893         if (!$this->transactions_supported()) {
1894             return;
1895         }
1897         $sql = "COMMIT";
1898         $this->query_start($sql, NULL, SQL_QUERY_AUX);
1899         $result = $this->mysqli->query($sql);
1900         $this->query_end($result);
1901     }
1903     /**
1904      * Driver specific abort of real database transaction,
1905      * this can not be used directly in code.
1906      * @return void
1907      */
1908     protected function rollback_transaction() {
1909         if (!$this->transactions_supported()) {
1910             return;
1911         }
1913         $sql = "ROLLBACK";
1914         $this->query_start($sql, NULL, SQL_QUERY_AUX);
1915         $result = $this->mysqli->query($sql);
1916         $this->query_end($result);
1918         return true;
1919     }