MDL-37585 Make $DB->set_debug(true) show run time of each query.
[moodle.git] / lib / dml / 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  * Abstract database driver class.
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__.'/database_column_info.php');
28 require_once(__DIR__.'/moodle_recordset.php');
29 require_once(__DIR__.'/moodle_transaction.php');
31 /** SQL_PARAMS_NAMED - Bitmask, indicates :name type parameters are supported by db backend. */
32 define('SQL_PARAMS_NAMED', 1);
34 /** SQL_PARAMS_QM - Bitmask, indicates ? type parameters are supported by db backend. */
35 define('SQL_PARAMS_QM', 2);
37 /** SQL_PARAMS_DOLLAR - Bitmask, indicates $1, $2, ... type parameters are supported by db backend. */
38 define('SQL_PARAMS_DOLLAR', 4);
40 /** SQL_QUERY_SELECT - Normal select query, reading only. */
41 define('SQL_QUERY_SELECT', 1);
43 /** SQL_QUERY_INSERT - Insert select query, writing. */
44 define('SQL_QUERY_INSERT', 2);
46 /** SQL_QUERY_UPDATE - Update select query, writing. */
47 define('SQL_QUERY_UPDATE', 3);
49 /** SQL_QUERY_STRUCTURE - Query changing db structure, writing. */
50 define('SQL_QUERY_STRUCTURE', 4);
52 /** SQL_QUERY_AUX - Auxiliary query done by driver, setting connection config, getting table info, etc. */
53 define('SQL_QUERY_AUX', 5);
55 /**
56  * Abstract class representing moodle database interface.
57  * @link http://docs.moodle.org/dev/DML_functions
58  *
59  * @package    core_dml
60  * @copyright  2008 Petr Skoda (http://skodak.org)
61  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
62  */
63 abstract class moodle_database {
65     /** @var database_manager db manager which allows db structure modifications. */
66     protected $database_manager;
67     /** @var moodle_temptables temptables manager to provide cross-db support for temp tables. */
68     protected $temptables;
69     /** @var array Cache of column info. */
70     protected $columns = array(); // I wish we had a shared memory cache for this :-(
71     /** @var array Cache of table info. */
72     protected $tables  = null;
74     // db connection options
75     /** @var string db host name. */
76     protected $dbhost;
77     /** @var string db host user. */
78     protected $dbuser;
79     /** @var string db host password. */
80     protected $dbpass;
81     /** @var string db name. */
82     protected $dbname;
83     /** @var string Prefix added to table names. */
84     protected $prefix;
86     /** @var array Database or driver specific options, such as sockets or TCP/IP db connections. */
87     protected $dboptions;
89     /** @var bool True means non-moodle external database used.*/
90     protected $external;
92     /** @var int The database reads (performance counter).*/
93     protected $reads = 0;
94     /** @var int The database writes (performance counter).*/
95     protected $writes = 0;
97     /** @var int Debug level. */
98     protected $debug  = 0;
100     /** @var string Last used query sql. */
101     protected $last_sql;
102     /** @var array Last query parameters. */
103     protected $last_params;
104     /** @var int Last query type. */
105     protected $last_type;
106     /** @var string Last extra info. */
107     protected $last_extrainfo;
108     /** @var float Last time in seconds with millisecond precision. */
109     protected $last_time;
110     /** @var bool Flag indicating logging of query in progress. This helps prevent infinite loops. */
111     private $loggingquery = false;
113     /** @var bool True if the db is used for db sessions. */
114     protected $used_for_db_sessions = false;
116     /** @var array Array containing open transactions. */
117     private $transactions = array();
118     /** @var bool Flag used to force rollback of all current transactions. */
119     private $force_rollback = false;
121     /** @var string MD5 of settings used for connection. Used by MUC as an identifier. */
122     private $settingshash;
124     /**
125      * @var int internal temporary variable used to fix params. Its used by {@link _fix_sql_params_dollar_callback()}.
126      */
127     private $fix_sql_params_i;
128     /**
129      * @var int internal temporary variable used to guarantee unique parameters in each request. Its used by {@link get_in_or_equal()}.
130      */
131     private $inorequaluniqueindex = 1;
133     /**
134      * Constructor - Instantiates the database, specifying if it's external (connect to other systems) or not (Moodle DB).
135      *              Note that this affects the decision of whether prefix checks must be performed or not.
136      * @param bool $external True means that an external database is used.
137      */
138     public function __construct($external=false) {
139         $this->external  = $external;
140     }
142     /**
143      * Destructor - cleans up and flushes everything needed.
144      */
145     public function __destruct() {
146         $this->dispose();
147     }
149     /**
150      * Detects if all needed PHP stuff are installed for DB connectivity.
151      * Note: can be used before connect()
152      * @return mixed True if requirements are met, otherwise a string if something isn't installed.
153      */
154     public abstract function driver_installed();
156     /**
157      * Returns database table prefix
158      * Note: can be used before connect()
159      * @return string The prefix used in the database.
160      */
161     public function get_prefix() {
162         return $this->prefix;
163     }
165     /**
166      * Loads and returns a database instance with the specified type and library.
167      *
168      * The loaded class is within lib/dml directory and of the form: $type.'_'.$library.'_moodle_database'
169      *
170      * @param string $type Database driver's type. (eg: mysqli, pgsql, mssql, sqldrv, oci, etc.)
171      * @param string $library Database driver's library (native, pdo, etc.)
172      * @param bool $external True if this is an external database.
173      * @return moodle_database driver object or null if error, for example of driver object see {@link mysqli_native_moodle_database}
174      */
175     public static function get_driver_instance($type, $library, $external = false) {
176         global $CFG;
178         $classname = $type.'_'.$library.'_moodle_database';
179         $libfile   = "$CFG->libdir/dml/$classname.php";
181         if (!file_exists($libfile)) {
182             return null;
183         }
185         require_once($libfile);
186         return new $classname($external);
187     }
189     /**
190      * Returns the database family type. (This sort of describes the SQL 'dialect')
191      * Note: can be used before connect()
192      * @return string The db family name (mysql, postgres, mssql, oracle, etc.)
193      */
194     public abstract function get_dbfamily();
196     /**
197      * Returns a more specific database driver type
198      * Note: can be used before connect()
199      * @return string The db type mysqli, pgsql, oci, mssql, sqlsrv
200      */
201     protected abstract function get_dbtype();
203     /**
204      * Returns the general database library name
205      * Note: can be used before connect()
206      * @return string The db library type -  pdo, native etc.
207      */
208     protected abstract function get_dblibrary();
210     /**
211      * Returns the localised database type name
212      * Note: can be used before connect()
213      * @return string
214      */
215     public abstract function get_name();
217     /**
218      * Returns the localised database configuration help.
219      * Note: can be used before connect()
220      * @return string
221      */
222     public abstract function get_configuration_help();
224     /**
225      * Returns the localised database description
226      * Note: can be used before connect()
227      * @return string
228      */
229     public abstract function get_configuration_hints();
231     /**
232      * Returns the db related part of config.php
233      * @return stdClass
234      */
235     public function export_dbconfig() {
236         $cfg = new stdClass();
237         $cfg->dbtype    = $this->get_dbtype();
238         $cfg->dblibrary = $this->get_dblibrary();
239         $cfg->dbhost    = $this->dbhost;
240         $cfg->dbname    = $this->dbname;
241         $cfg->dbuser    = $this->dbuser;
242         $cfg->dbpass    = $this->dbpass;
243         $cfg->prefix    = $this->prefix;
244         if ($this->dboptions) {
245             $cfg->dboptions = $this->dboptions;
246         }
248         return $cfg;
249     }
251     /**
252      * Diagnose database and tables, this function is used
253      * to verify database and driver settings, db engine types, etc.
254      *
255      * @return string null means everything ok, string means problem found.
256      */
257     public function diagnose() {
258         return null;
259     }
261     /**
262      * Connects to the database.
263      * Must be called before other methods.
264      * @param string $dbhost The database host.
265      * @param string $dbuser The database user to connect as.
266      * @param string $dbpass The password to use when connecting to the database.
267      * @param string $dbname The name of the database being connected to.
268      * @param mixed $prefix string means moodle db prefix, false used for external databases where prefix not used
269      * @param array $dboptions driver specific options
270      * @return bool true
271      * @throws dml_connection_exception if error
272      */
273     public abstract function connect($dbhost, $dbuser, $dbpass, $dbname, $prefix, array $dboptions=null);
275     /**
276      * Store various database settings
277      * @param string $dbhost The database host.
278      * @param string $dbuser The database user to connect as.
279      * @param string $dbpass The password to use when connecting to the database.
280      * @param string $dbname The name of the database being connected to.
281      * @param mixed $prefix string means moodle db prefix, false used for external databases where prefix not used
282      * @param array $dboptions driver specific options
283      * @return void
284      */
285     protected function store_settings($dbhost, $dbuser, $dbpass, $dbname, $prefix, array $dboptions=null) {
286         $this->dbhost    = $dbhost;
287         $this->dbuser    = $dbuser;
288         $this->dbpass    = $dbpass;
289         $this->dbname    = $dbname;
290         $this->prefix    = $prefix;
291         $this->dboptions = (array)$dboptions;
292     }
294     /**
295      * Returns a hash for the settings used during connection.
296      *
297      * If not already requested it is generated and stored in a private property.
298      *
299      * @return string
300      */
301     protected function get_settings_hash() {
302         if (empty($this->settingshash)) {
303             $this->settingshash = md5($this->dbhost . $this->dbuser . $this->dbname . $this->prefix);
304         }
305         return $this->settingshash;
306     }
308     /**
309      * Attempt to create the database
310      * @param string $dbhost The database host.
311      * @param string $dbuser The database user to connect as.
312      * @param string $dbpass The password to use when connecting to the database.
313      * @param string $dbname The name of the database being connected to.
314      * @param array $dboptions An array of optional database options (eg: dbport)
315      *
316      * @return bool success True for successful connection. False otherwise.
317      */
318     public function create_database($dbhost, $dbuser, $dbpass, $dbname, array $dboptions=null) {
319         return false;
320     }
322     /**
323      * Closes the database connection and releases all resources
324      * and memory (especially circular memory references).
325      * Do NOT use connect() again, create a new instance if needed.
326      * @return void
327      */
328     public function dispose() {
329         if ($this->transactions) {
330             // this should not happen, it usually indicates wrong catching of exceptions,
331             // because all transactions should be finished manually or in default exception handler.
332             // unfortunately we can not access global $CFG any more and can not print debug,
333             // the diagnostic info should be printed in footer instead
334             $lowesttransaction = end($this->transactions);
335             $backtrace = $lowesttransaction->get_backtrace();
337             if (defined('PHPUNIT_TEST') and PHPUNIT_TEST) {
338                 //no need to log sudden exits in our PHPUnit test cases
339             } else {
340                 error_log('Potential coding error - active database transaction detected when disposing database:'."\n".format_backtrace($backtrace, true));
341             }
342             $this->force_transaction_rollback();
343         }
344         // Always terminate sessions here to make it consistent,
345         // this is needed because we need to save session to db before closing it.
346         if (function_exists('session_get_instance')) {
347             session_get_instance()->write_close();
348         }
349         $this->used_for_db_sessions = false;
351         if ($this->temptables) {
352             $this->temptables->dispose();
353             $this->temptables = null;
354         }
355         if ($this->database_manager) {
356             $this->database_manager->dispose();
357             $this->database_manager = null;
358         }
359         $this->columns = array();
360         $this->tables  = null;
361     }
363     /**
364      * This should be called before each db query.
365      * @param string $sql The query string.
366      * @param array $params An array of parameters.
367      * @param int $type The type of query. ( SQL_QUERY_SELECT | SQL_QUERY_AUX | SQL_QUERY_INSERT | SQL_QUERY_UPDATE | SQL_QUERY_STRUCTURE )
368      * @param mixed $extrainfo This is here for any driver specific extra information.
369      * @return void
370      */
371     protected function query_start($sql, array $params=null, $type, $extrainfo=null) {
372         if ($this->loggingquery) {
373             return;
374         }
375         $this->last_sql       = $sql;
376         $this->last_params    = $params;
377         $this->last_type      = $type;
378         $this->last_extrainfo = $extrainfo;
379         $this->last_time      = microtime(true);
381         switch ($type) {
382             case SQL_QUERY_SELECT:
383             case SQL_QUERY_AUX:
384                 $this->reads++;
385                 break;
386             case SQL_QUERY_INSERT:
387             case SQL_QUERY_UPDATE:
388             case SQL_QUERY_STRUCTURE:
389                 $this->writes++;
390         }
392         $this->print_debug($sql, $params);
393     }
395     /**
396      * This should be called immediately after each db query. It does a clean up of resources.
397      * It also throws exceptions if the sql that ran produced errors.
398      * @param mixed $result The db specific result obtained from running a query.
399      * @throws dml_read_exception | dml_write_exception | ddl_change_structure_exception
400      * @return void
401      */
402     protected function query_end($result) {
403         if ($this->loggingquery) {
404             return;
405         }
406         if ($result !== false) {
407             $this->query_log();
408             // free memory
409             $this->last_sql    = null;
410             $this->last_params = null;
411             $this->print_debug_time();
412             return;
413         }
415         // remember current info, log queries may alter it
416         $type   = $this->last_type;
417         $sql    = $this->last_sql;
418         $params = $this->last_params;
419         $error  = $this->get_last_error();
421         $this->query_log($error);
423         switch ($type) {
424             case SQL_QUERY_SELECT:
425             case SQL_QUERY_AUX:
426                 throw new dml_read_exception($error, $sql, $params);
427             case SQL_QUERY_INSERT:
428             case SQL_QUERY_UPDATE:
429                 throw new dml_write_exception($error, $sql, $params);
430             case SQL_QUERY_STRUCTURE:
431                 $this->get_manager(); // includes ddl exceptions classes ;-)
432                 throw new ddl_change_structure_exception($error, $sql);
433         }
434     }
436     /**
437      * This logs the last query based on 'logall', 'logslow' and 'logerrors' options configured via $CFG->dboptions .
438      * @param string|bool $error or false if not error
439      * @return void
440      */
441     public function query_log($error=false) {
442         $logall    = !empty($this->dboptions['logall']);
443         $logslow   = !empty($this->dboptions['logslow']) ? $this->dboptions['logslow'] : false;
444         $logerrors = !empty($this->dboptions['logerrors']);
445         $iserror   = ($error !== false);
447         $time = microtime(true) - $this->last_time;
449         if ($logall or ($logslow and ($logslow < ($time+0.00001))) or ($iserror and $logerrors)) {
450             $this->loggingquery = true;
451             try {
452                 $backtrace = debug_backtrace();
453                 if ($backtrace) {
454                     //remove query_log()
455                     array_shift($backtrace);
456                 }
457                 if ($backtrace) {
458                     //remove query_end()
459                     array_shift($backtrace);
460                 }
461                 $log = new stdClass();
462                 $log->qtype      = $this->last_type;
463                 $log->sqltext    = $this->last_sql;
464                 $log->sqlparams  = var_export((array)$this->last_params, true);
465                 $log->error      = (int)$iserror;
466                 $log->info       = $iserror ? $error : null;
467                 $log->backtrace  = format_backtrace($backtrace, true);
468                 $log->exectime   = $time;
469                 $log->timelogged = time();
470                 $this->insert_record('log_queries', $log);
471             } catch (Exception $ignored) {
472             }
473             $this->loggingquery = false;
474         }
475     }
477     /**
478      * Returns database server info array
479      * @return array Array containing 'description' and 'version' at least.
480      */
481     public abstract function get_server_info();
483     /**
484      * Returns supported query parameter types
485      * @return int bitmask of accepted SQL_PARAMS_*
486      */
487     protected abstract function allowed_param_types();
489     /**
490      * Returns the last error reported by the database engine.
491      * @return string The error message.
492      */
493     public abstract function get_last_error();
495     /**
496      * Prints sql debug info
497      * @param string $sql The query which is being debugged.
498      * @param array $params The query parameters. (optional)
499      * @param mixed $obj The library specific object. (optional)
500      * @return void
501      */
502     protected function print_debug($sql, array $params=null, $obj=null) {
503         if (!$this->get_debug()) {
504             return;
505         }
506         if (CLI_SCRIPT) {
507             echo "--------------------------------\n";
508             echo $sql."\n";
509             if (!is_null($params)) {
510                 echo "[".var_export($params, true)."]\n";
511             }
512             echo "--------------------------------\n";
513         } else {
514             echo "<hr />\n";
515             echo s($sql)."\n";
516             if (!is_null($params)) {
517                 echo "[".s(var_export($params, true))."]\n";
518             }
519             echo "<hr />\n";
520         }
521     }
523     /**
524      * Prints the time a query took to run.
525      * @return void
526      */
527     protected function print_debug_time() {
528         if (!$this->get_debug()) {
529             return;
530         }
531         $time = microtime(true) - $this->last_time;
532         $message = "Query took: {$time} seconds.\n";
533         if (CLI_SCRIPT) {
534             echo $message;
535             echo "--------------------------------\n";
536         } else {
537             echo s($message);
538             echo "<hr />\n";
539         }
540     }
542     /**
543      * Returns the SQL WHERE conditions.
544      * @param string $table The table name that these conditions will be validated against.
545      * @param array $conditions The conditions to build the where clause. (must not contain numeric indexes)
546      * @throws dml_exception
547      * @return array An array list containing sql 'where' part and 'params'.
548      */
549     protected function where_clause($table, array $conditions=null) {
550         // We accept nulls in conditions
551         $conditions = is_null($conditions) ? array() : $conditions;
552         // Some checks performed under debugging only
553         if (debugging()) {
554             $columns = $this->get_columns($table);
555             if (empty($columns)) {
556                 // no supported columns means most probably table does not exist
557                 throw new dml_exception('ddltablenotexist', $table);
558             }
559             foreach ($conditions as $key=>$value) {
560                 if (!isset($columns[$key])) {
561                     $a = new stdClass();
562                     $a->fieldname = $key;
563                     $a->tablename = $table;
564                     throw new dml_exception('ddlfieldnotexist', $a);
565                 }
566                 $column = $columns[$key];
567                 if ($column->meta_type == 'X') {
568                     //ok so the column is a text column. sorry no text columns in the where clause conditions
569                     throw new dml_exception('textconditionsnotallowed', $conditions);
570                 }
571             }
572         }
574         $allowed_types = $this->allowed_param_types();
575         if (empty($conditions)) {
576             return array('', array());
577         }
578         $where = array();
579         $params = array();
581         foreach ($conditions as $key=>$value) {
582             if (is_int($key)) {
583                 throw new dml_exception('invalidnumkey');
584             }
585             if (is_null($value)) {
586                 $where[] = "$key IS NULL";
587             } else {
588                 if ($allowed_types & SQL_PARAMS_NAMED) {
589                     // Need to verify key names because they can contain, originally,
590                     // spaces and other forbidden chars when using sql_xxx() functions and friends.
591                     $normkey = trim(preg_replace('/[^a-zA-Z0-9_-]/', '_', $key), '-_');
592                     if ($normkey !== $key) {
593                         debugging('Invalid key found in the conditions array.');
594                     }
595                     $where[] = "$key = :$normkey";
596                     $params[$normkey] = $value;
597                 } else {
598                     $where[] = "$key = ?";
599                     $params[] = $value;
600                 }
601             }
602         }
603         $where = implode(" AND ", $where);
604         return array($where, $params);
605     }
607     /**
608      * Returns SQL WHERE conditions for the ..._list group of methods.
609      *
610      * @param string $field the name of a field.
611      * @param array $values the values field might take.
612      * @return array An array containing sql 'where' part and 'params'
613      */
614     protected function where_clause_list($field, array $values) {
615         if (empty($values)) {
616             return array("1 = 2", array()); // Fake condition, won't return rows ever. MDL-17645
617         }
619         // Note: Do not use get_in_or_equal() because it can not deal with bools and nulls.
621         $params = array();
622         $select = "";
623         $values = (array)$values;
624         foreach ($values as $value) {
625             if (is_bool($value)) {
626                 $value = (int)$value;
627             }
628             if (is_null($value)) {
629                 $select = "$field IS NULL";
630             } else {
631                 $params[] = $value;
632             }
633         }
634         if ($params) {
635             if ($select !== "") {
636                 $select = "$select OR ";
637             }
638             $count = count($params);
639             if ($count == 1) {
640                 $select = $select."$field = ?";
641             } else {
642                 $qs = str_repeat(',?', $count);
643                 $qs = ltrim($qs, ',');
644                 $select = $select."$field IN ($qs)";
645             }
646         }
647         return array($select, $params);
648     }
650     /**
651      * Constructs 'IN()' or '=' sql fragment
652      * @param mixed $items A single value or array of values for the expression.
653      * @param int $type Parameter bounding type : SQL_PARAMS_QM or SQL_PARAMS_NAMED.
654      * @param string $prefix Named parameter placeholder prefix (a unique counter value is appended to each parameter name).
655      * @param bool $equal True means we want to equate to the constructed expression, false means we don't want to equate to it.
656      * @param mixed $onemptyitems This defines the behavior when the array of items provided is empty. Defaults to false,
657      *              meaning throw exceptions. Other values will become part of the returned SQL fragment.
658      * @throws coding_exception | dml_exception
659      * @return array A list containing the constructed sql fragment and an array of parameters.
660      */
661     public function get_in_or_equal($items, $type=SQL_PARAMS_QM, $prefix='param', $equal=true, $onemptyitems=false) {
663         // default behavior, throw exception on empty array
664         if (is_array($items) and empty($items) and $onemptyitems === false) {
665             throw new coding_exception('moodle_database::get_in_or_equal() does not accept empty arrays');
666         }
667         // handle $onemptyitems on empty array of items
668         if (is_array($items) and empty($items)) {
669             if (is_null($onemptyitems)) {             // Special case, NULL value
670                 $sql = $equal ? ' IS NULL' : ' IS NOT NULL';
671                 return (array($sql, array()));
672             } else {
673                 $items = array($onemptyitems);        // Rest of cases, prepare $items for std processing
674             }
675         }
677         if ($type == SQL_PARAMS_QM) {
678             if (!is_array($items) or count($items) == 1) {
679                 $sql = $equal ? '= ?' : '<> ?';
680                 $items = (array)$items;
681                 $params = array_values($items);
682             } else {
683                 if ($equal) {
684                     $sql = 'IN ('.implode(',', array_fill(0, count($items), '?')).')';
685                 } else {
686                     $sql = 'NOT IN ('.implode(',', array_fill(0, count($items), '?')).')';
687                 }
688                 $params = array_values($items);
689             }
691         } else if ($type == SQL_PARAMS_NAMED) {
692             if (empty($prefix)) {
693                 $prefix = 'param';
694             }
696             if (!is_array($items)){
697                 $param = $prefix.$this->inorequaluniqueindex++;
698                 $sql = $equal ? "= :$param" : "<> :$param";
699                 $params = array($param=>$items);
700             } else if (count($items) == 1) {
701                 $param = $prefix.$this->inorequaluniqueindex++;
702                 $sql = $equal ? "= :$param" : "<> :$param";
703                 $item = reset($items);
704                 $params = array($param=>$item);
705             } else {
706                 $params = array();
707                 $sql = array();
708                 foreach ($items as $item) {
709                     $param = $prefix.$this->inorequaluniqueindex++;
710                     $params[$param] = $item;
711                     $sql[] = ':'.$param;
712                 }
713                 if ($equal) {
714                     $sql = 'IN ('.implode(',', $sql).')';
715                 } else {
716                     $sql = 'NOT IN ('.implode(',', $sql).')';
717                 }
718             }
720         } else {
721             throw new dml_exception('typenotimplement');
722         }
723         return array($sql, $params);
724     }
726     /**
727      * Converts short table name {tablename} to the real prefixed table name in given sql.
728      * @param string $sql The sql to be operated on.
729      * @return string The sql with tablenames being prefixed with $CFG->prefix
730      */
731     protected function fix_table_names($sql) {
732         return preg_replace('/\{([a-z][a-z0-9_]*)\}/', $this->prefix.'$1', $sql);
733     }
735     /**
736      * Internal private utitlity function used to fix parameters.
737      * Used with {@link preg_replace_callback()}
738      * @param array $match Refer to preg_replace_callback usage for description.
739      * @return string
740      */
741     private function _fix_sql_params_dollar_callback($match) {
742         $this->fix_sql_params_i++;
743         return "\$".$this->fix_sql_params_i;
744     }
746     /**
747      * Detects object parameters and throws exception if found
748      * @param mixed $value
749      * @return void
750      * @throws coding_exception if object detected
751      */
752     protected function detect_objects($value) {
753         if (is_object($value)) {
754             throw new coding_exception('Invalid database query parameter value', 'Objects are are not allowed: '.get_class($value));
755         }
756     }
758     /**
759      * Normalizes sql query parameters and verifies parameters.
760      * @param string $sql The query or part of it.
761      * @param array $params The query parameters.
762      * @return array (sql, params, type of params)
763      */
764     public function fix_sql_params($sql, array $params=null) {
765         $params = (array)$params; // mke null array if needed
766         $allowed_types = $this->allowed_param_types();
768         // convert table names
769         $sql = $this->fix_table_names($sql);
771         // cast booleans to 1/0 int and detect forbidden objects
772         foreach ($params as $key => $value) {
773             $this->detect_objects($value);
774             $params[$key] = is_bool($value) ? (int)$value : $value;
775         }
777         // NICOLAS C: Fixed regexp for negative backwards look-ahead of double colons. Thanks for Sam Marshall's help
778         $named_count = preg_match_all('/(?<!:):[a-z][a-z0-9_]*/', $sql, $named_matches); // :: used in pgsql casts
779         $dollar_count = preg_match_all('/\$[1-9][0-9]*/', $sql, $dollar_matches);
780         $q_count     = substr_count($sql, '?');
782         $count = 0;
784         if ($named_count) {
785             $type = SQL_PARAMS_NAMED;
786             $count = $named_count;
788         }
789         if ($dollar_count) {
790             if ($count) {
791                 throw new dml_exception('mixedtypesqlparam');
792             }
793             $type = SQL_PARAMS_DOLLAR;
794             $count = $dollar_count;
796         }
797         if ($q_count) {
798             if ($count) {
799                 throw new dml_exception('mixedtypesqlparam');
800             }
801             $type = SQL_PARAMS_QM;
802             $count = $q_count;
804         }
806         if (!$count) {
807              // ignore params
808             if ($allowed_types & SQL_PARAMS_NAMED) {
809                 return array($sql, array(), SQL_PARAMS_NAMED);
810             } else if ($allowed_types & SQL_PARAMS_QM) {
811                 return array($sql, array(), SQL_PARAMS_QM);
812             } else {
813                 return array($sql, array(), SQL_PARAMS_DOLLAR);
814             }
815         }
817         if ($count > count($params)) {
818             $a = new stdClass;
819             $a->expected = $count;
820             $a->actual = count($params);
821             throw new dml_exception('invalidqueryparam', $a);
822         }
824         $target_type = $allowed_types;
826         if ($type & $allowed_types) { // bitwise AND
827             if ($count == count($params)) {
828                 if ($type == SQL_PARAMS_QM) {
829                     return array($sql, array_values($params), SQL_PARAMS_QM); // 0-based array required
830                 } else {
831                     //better do the validation of names below
832                 }
833             }
834             // needs some fixing or validation - there might be more params than needed
835             $target_type = $type;
836         }
838         if ($type == SQL_PARAMS_NAMED) {
839             $finalparams = array();
840             foreach ($named_matches[0] as $key) {
841                 $key = trim($key, ':');
842                 if (!array_key_exists($key, $params)) {
843                     throw new dml_exception('missingkeyinsql', $key, '');
844                 }
845                 if (strlen($key) > 30) {
846                     throw new coding_exception(
847                             "Placeholder names must be 30 characters or shorter. '" .
848                             $key . "' is too long.", $sql);
849                 }
850                 $finalparams[$key] = $params[$key];
851             }
852             if ($count != count($finalparams)) {
853                 throw new dml_exception('duplicateparaminsql');
854             }
856             if ($target_type & SQL_PARAMS_QM) {
857                 $sql = preg_replace('/(?<!:):[a-z][a-z0-9_]*/', '?', $sql);
858                 return array($sql, array_values($finalparams), SQL_PARAMS_QM); // 0-based required
859             } else if ($target_type & SQL_PARAMS_NAMED) {
860                 return array($sql, $finalparams, SQL_PARAMS_NAMED);
861             } else {  // $type & SQL_PARAMS_DOLLAR
862                 //lambda-style functions eat memory - we use globals instead :-(
863                 $this->fix_sql_params_i = 0;
864                 $sql = preg_replace_callback('/(?<!:):[a-z][a-z0-9_]*/', array($this, '_fix_sql_params_dollar_callback'), $sql);
865                 return array($sql, array_values($finalparams), SQL_PARAMS_DOLLAR); // 0-based required
866             }
868         } else if ($type == SQL_PARAMS_DOLLAR) {
869             if ($target_type & SQL_PARAMS_DOLLAR) {
870                 return array($sql, array_values($params), SQL_PARAMS_DOLLAR); // 0-based required
871             } else if ($target_type & SQL_PARAMS_QM) {
872                 $sql = preg_replace('/\$[0-9]+/', '?', $sql);
873                 return array($sql, array_values($params), SQL_PARAMS_QM); // 0-based required
874             } else { //$target_type & SQL_PARAMS_NAMED
875                 $sql = preg_replace('/\$([0-9]+)/', ':param\\1', $sql);
876                 $finalparams = array();
877                 foreach ($params as $key=>$param) {
878                     $key++;
879                     $finalparams['param'.$key] = $param;
880                 }
881                 return array($sql, $finalparams, SQL_PARAMS_NAMED);
882             }
884         } else { // $type == SQL_PARAMS_QM
885             if (count($params) != $count) {
886                 $params = array_slice($params, 0, $count);
887             }
889             if ($target_type & SQL_PARAMS_QM) {
890                 return array($sql, array_values($params), SQL_PARAMS_QM); // 0-based required
891             } else if ($target_type & SQL_PARAMS_NAMED) {
892                 $finalparams = array();
893                 $pname = 'param0';
894                 $parts = explode('?', $sql);
895                 $sql = array_shift($parts);
896                 foreach ($parts as $part) {
897                     $param = array_shift($params);
898                     $pname++;
899                     $sql .= ':'.$pname.$part;
900                     $finalparams[$pname] = $param;
901                 }
902                 return array($sql, $finalparams, SQL_PARAMS_NAMED);
903             } else {  // $type & SQL_PARAMS_DOLLAR
904                 //lambda-style functions eat memory - we use globals instead :-(
905                 $this->fix_sql_params_i = 0;
906                 $sql = preg_replace_callback('/\?/', array($this, '_fix_sql_params_dollar_callback'), $sql);
907                 return array($sql, array_values($params), SQL_PARAMS_DOLLAR); // 0-based required
908             }
909         }
910     }
912     /**
913      * Return tables in database WITHOUT current prefix.
914      * @param bool $usecache if true, returns list of cached tables.
915      * @return array of table names in lowercase and without prefix
916      */
917     public abstract function get_tables($usecache=true);
919     /**
920      * Return table indexes - everything lowercased.
921      * @param string $table The table we want to get indexes from.
922      * @return array An associative array of indexes containing 'unique' flag and 'columns' being indexed
923      */
924     public abstract function get_indexes($table);
926     /**
927      * Returns detailed information about columns in table. This information is cached internally.
928      * @param string $table The table's name.
929      * @param bool $usecache Flag to use internal cacheing. The default is true.
930      * @return array of database_column_info objects indexed with column names
931      */
932     public abstract function get_columns($table, $usecache=true);
934     /**
935      * Normalise values based on varying RDBMS's dependencies (booleans, LOBs...)
936      *
937      * @param database_column_info $column column metadata corresponding with the value we are going to normalise
938      * @param mixed $value value we are going to normalise
939      * @return mixed the normalised value
940      */
941     protected abstract function normalise_value($column, $value);
943     /**
944      * Resets the internal column details cache
945      * @return void
946      */
947     public function reset_caches() {
948         $this->columns = array();
949         $this->tables  = null;
950         // Purge MUC as well
951         $identifiers = array('dbfamily' => $this->get_dbfamily(), 'settings' => $this->get_settings_hash());
952         cache_helper::purge_by_definition('core', 'databasemeta', $identifiers);
953     }
955     /**
956      * Returns the sql generator used for db manipulation.
957      * Used mostly in upgrade.php scripts.
958      * @return database_manager The instance used to perform ddl operations.
959      * @see lib/ddl/database_manager.php
960      */
961     public function get_manager() {
962         global $CFG;
964         if (!$this->database_manager) {
965             require_once($CFG->libdir.'/ddllib.php');
967             $classname = $this->get_dbfamily().'_sql_generator';
968             require_once("$CFG->libdir/ddl/$classname.php");
969             $generator = new $classname($this, $this->temptables);
971             $this->database_manager = new database_manager($this, $generator);
972         }
973         return $this->database_manager;
974     }
976     /**
977      * Attempts to change db encoding to UTF-8 encoding if possible.
978      * @return bool True is successful.
979      */
980     public function change_db_encoding() {
981         return false;
982     }
984     /**
985      * Checks to see if the database is in unicode mode?
986      * @return bool
987      */
988     public function setup_is_unicodedb() {
989         return true;
990     }
992     /**
993      * Enable/disable very detailed debugging.
994      * @param bool $state
995      * @return void
996      */
997     public function set_debug($state) {
998         $this->debug = $state;
999     }
1001     /**
1002      * Returns debug status
1003      * @return bool $state
1004      */
1005     public function get_debug() {
1006         return $this->debug;
1007     }
1009     /**
1010      * Enable/disable detailed sql logging
1011      * @param bool $state
1012      */
1013     public function set_logging($state) {
1014         // adodb sql logging shares one table without prefix per db - this is no longer acceptable :-(
1015         // we must create one table shared by all drivers
1016     }
1018     /**
1019      * Do NOT use in code, this is for use by database_manager only!
1020      * @param string $sql query
1021      * @return bool true
1022      * @throws dml_exception A DML specific exception is thrown for any errors.
1023      */
1024     public abstract function change_database_structure($sql);
1026     /**
1027      * Executes a general sql query. Should be used only when no other method suitable.
1028      * Do NOT use this to make changes in db structure, use database_manager methods instead!
1029      * @param string $sql query
1030      * @param array $params query parameters
1031      * @return bool true
1032      * @throws dml_exception A DML specific exception is thrown for any errors.
1033      */
1034     public abstract function execute($sql, array $params=null);
1036     /**
1037      * Get a number of records as a moodle_recordset where all the given conditions met.
1038      *
1039      * Selects records from the table $table.
1040      *
1041      * If specified, only records meeting $conditions.
1042      *
1043      * If specified, the results will be sorted as specified by $sort. This
1044      * is added to the SQL as "ORDER BY $sort". Example values of $sort
1045      * might be "time ASC" or "time DESC".
1046      *
1047      * If $fields is specified, only those fields are returned.
1048      *
1049      * Since this method is a little less readable, use of it should be restricted to
1050      * code where it's possible there might be large datasets being returned.  For known
1051      * small datasets use get_records - it leads to simpler code.
1052      *
1053      * If you only want some of the records, specify $limitfrom and $limitnum.
1054      * The query will skip the first $limitfrom records (according to the sort
1055      * order) and then return the next $limitnum records. If either of $limitfrom
1056      * or $limitnum is specified, both must be present.
1057      *
1058      * The return value is a moodle_recordset
1059      * if the query succeeds. If an error occurs, false is returned.
1060      *
1061      * @param string $table the table to query.
1062      * @param array $conditions optional array $fieldname=>requestedvalue with AND in between
1063      * @param string $sort an order to sort the results in (optional, a valid SQL ORDER BY parameter).
1064      * @param string $fields a comma separated list of fields to return (optional, by default all fields are returned).
1065      * @param int $limitfrom return a subset of records, starting at this point (optional).
1066      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
1067      * @return moodle_recordset A moodle_recordset instance
1068      * @throws dml_exception A DML specific exception is thrown for any errors.
1069      */
1070     public function get_recordset($table, array $conditions=null, $sort='', $fields='*', $limitfrom=0, $limitnum=0) {
1071         list($select, $params) = $this->where_clause($table, $conditions);
1072         return $this->get_recordset_select($table, $select, $params, $sort, $fields, $limitfrom, $limitnum);
1073     }
1075     /**
1076      * Get a number of records as a moodle_recordset where one field match one list of values.
1077      *
1078      * Only records where $field takes one of the values $values are returned.
1079      * $values must be an array of values.
1080      *
1081      * Other arguments and the return type are like {@link function get_recordset}.
1082      *
1083      * @param string $table the table to query.
1084      * @param string $field a field to check (optional).
1085      * @param array $values array of values the field must have
1086      * @param string $sort an order to sort the results in (optional, a valid SQL ORDER BY parameter).
1087      * @param string $fields a comma separated list of fields to return (optional, by default all fields are returned).
1088      * @param int $limitfrom return a subset of records, starting at this point (optional).
1089      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
1090      * @return moodle_recordset A moodle_recordset instance.
1091      * @throws dml_exception A DML specific exception is thrown for any errors.
1092      */
1093     public function get_recordset_list($table, $field, array $values, $sort='', $fields='*', $limitfrom=0, $limitnum=0) {
1094         list($select, $params) = $this->where_clause_list($field, $values);
1095         return $this->get_recordset_select($table, $select, $params, $sort, $fields, $limitfrom, $limitnum);
1096     }
1098     /**
1099      * Get a number of records as a moodle_recordset which match a particular WHERE clause.
1100      *
1101      * If given, $select is used as the SELECT parameter in the SQL query,
1102      * otherwise all records from the table are returned.
1103      *
1104      * Other arguments and the return type are like {@link function get_recordset}.
1105      *
1106      * @param string $table the table to query.
1107      * @param string $select A fragment of SQL to be used in a where clause in the SQL call.
1108      * @param array $params array of sql parameters
1109      * @param string $sort an order to sort the results in (optional, a valid SQL ORDER BY parameter).
1110      * @param string $fields a comma separated list of fields to return (optional, by default all fields are returned).
1111      * @param int $limitfrom return a subset of records, starting at this point (optional).
1112      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
1113      * @return moodle_recordset A moodle_recordset instance.
1114      * @throws dml_exception A DML specific exception is thrown for any errors.
1115      */
1116     public function get_recordset_select($table, $select, array $params=null, $sort='', $fields='*', $limitfrom=0, $limitnum=0) {
1117         $sql = "SELECT $fields FROM {".$table."}";
1118         if ($select) {
1119             $sql .= " WHERE $select";
1120         }
1121         if ($sort) {
1122             $sql .= " ORDER BY $sort";
1123         }
1124         return $this->get_recordset_sql($sql, $params, $limitfrom, $limitnum);
1125     }
1127     /**
1128      * Get a number of records as a moodle_recordset using a SQL statement.
1129      *
1130      * Since this method is a little less readable, use of it should be restricted to
1131      * code where it's possible there might be large datasets being returned.  For known
1132      * small datasets use get_records_sql - it leads to simpler code.
1133      *
1134      * The return type is like {@link function get_recordset}.
1135      *
1136      * @param string $sql the SQL select query to execute.
1137      * @param array $params array of sql parameters
1138      * @param int $limitfrom return a subset of records, starting at this point (optional).
1139      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
1140      * @return moodle_recordset A moodle_recordset instance.
1141      * @throws dml_exception A DML specific exception is thrown for any errors.
1142      */
1143     public abstract function get_recordset_sql($sql, array $params=null, $limitfrom=0, $limitnum=0);
1145     /**
1146      * Get all records from a table.
1147      *
1148      * This method works around potential memory problems and may improve performance,
1149      * this method may block access to table until the recordset is closed.
1150      *
1151      * @param string $table Name of database table.
1152      * @return moodle_recordset A moodle_recordset instance {@link function get_recordset}.
1153      * @throws dml_exception A DML specific exception is thrown for any errors.
1154      */
1155     public function export_table_recordset($table) {
1156         return $this->get_recordset($table, array());
1157     }
1159     /**
1160      * Get a number of records as an array of objects where all the given conditions met.
1161      *
1162      * If the query succeeds and returns at least one record, the
1163      * return value is an array of objects, one object for each
1164      * record found. The array key is the value from the first
1165      * column of the result set. The object associated with that key
1166      * has a member variable for each column of the results.
1167      *
1168      * @param string $table the table to query.
1169      * @param array $conditions optional array $fieldname=>requestedvalue with AND in between
1170      * @param string $sort an order to sort the results in (optional, a valid SQL ORDER BY parameter).
1171      * @param string $fields a comma separated list of fields to return (optional, by default
1172      *   all fields are returned). The first field will be used as key for the
1173      *   array so must be a unique field such as 'id'.
1174      * @param int $limitfrom return a subset of records, starting at this point (optional).
1175      * @param int $limitnum return a subset comprising this many records in total (optional, required if $limitfrom is set).
1176      * @return array An array of Objects indexed by first column.
1177      * @throws dml_exception A DML specific exception is thrown for any errors.
1178      */
1179     public function get_records($table, array $conditions=null, $sort='', $fields='*', $limitfrom=0, $limitnum=0) {
1180         list($select, $params) = $this->where_clause($table, $conditions);
1181         return $this->get_records_select($table, $select, $params, $sort, $fields, $limitfrom, $limitnum);
1182     }
1184     /**
1185      * Get a number of records as an array of objects where one field match one list of values.
1186      *
1187      * Return value is like {@link function get_records}.
1188      *
1189      * @param string $table The database table to be checked against.
1190      * @param string $field The field to search
1191      * @param array $values An array of values
1192      * @param string $sort Sort order (as valid SQL sort parameter)
1193      * @param string $fields A comma separated list of fields to be returned from the chosen table. If specified,
1194      *   the first field should be a unique one such as 'id' since it will be used as a key in the associative
1195      *   array.
1196      * @param int $limitfrom return a subset of records, starting at this point (optional).
1197      * @param int $limitnum return a subset comprising this many records in total (optional).
1198      * @return array An array of objects indexed by first column
1199      * @throws dml_exception A DML specific exception is thrown for any errors.
1200      */
1201     public function get_records_list($table, $field, array $values, $sort='', $fields='*', $limitfrom=0, $limitnum=0) {
1202         list($select, $params) = $this->where_clause_list($field, $values);
1203         return $this->get_records_select($table, $select, $params, $sort, $fields, $limitfrom, $limitnum);
1204     }
1206     /**
1207      * Get a number of records as an array of objects which match a particular WHERE clause.
1208      *
1209      * Return value is like {@link function get_records}.
1210      *
1211      * @param string $table The table to query.
1212      * @param string $select A fragment of SQL to be used in a where clause in the SQL call.
1213      * @param array $params An array of sql parameters
1214      * @param string $sort An order to sort the results in (optional, a valid SQL ORDER BY parameter).
1215      * @param string $fields A comma separated list of fields to return
1216      *   (optional, by default all fields are returned). The first field will be used as key for the
1217      *   array so must be a unique field such as 'id'.
1218      * @param int $limitfrom return a subset of records, starting at this point (optional).
1219      * @param int $limitnum return a subset comprising this many records in total (optional, required if $limitfrom is set).
1220      * @return array of objects indexed by first column
1221      * @throws dml_exception A DML specific exception is thrown for any errors.
1222      */
1223     public function get_records_select($table, $select, array $params=null, $sort='', $fields='*', $limitfrom=0, $limitnum=0) {
1224         if ($select) {
1225             $select = "WHERE $select";
1226         }
1227         if ($sort) {
1228             $sort = " ORDER BY $sort";
1229         }
1230         return $this->get_records_sql("SELECT $fields FROM {" . $table . "} $select $sort", $params, $limitfrom, $limitnum);
1231     }
1233     /**
1234      * Get a number of records as an array of objects using a SQL statement.
1235      *
1236      * Return value is like {@link function get_records}.
1237      *
1238      * @param string $sql the SQL select query to execute. The first column of this SELECT statement
1239      *   must be a unique value (usually the 'id' field), as it will be used as the key of the
1240      *   returned array.
1241      * @param array $params array of sql parameters
1242      * @param int $limitfrom return a subset of records, starting at this point (optional).
1243      * @param int $limitnum return a subset comprising this many records in total (optional, required if $limitfrom is set).
1244      * @return array of objects indexed by first column
1245      * @throws dml_exception A DML specific exception is thrown for any errors.
1246      */
1247     public abstract function get_records_sql($sql, array $params=null, $limitfrom=0, $limitnum=0);
1249     /**
1250      * Get the first two columns from a number of records as an associative array where all the given conditions met.
1251      *
1252      * Arguments are like {@link function get_recordset}.
1253      *
1254      * If no errors occur the return value
1255      * is an associative whose keys come from the first field of each record,
1256      * and whose values are the corresponding second fields.
1257      * False is returned if an error occurs.
1258      *
1259      * @param string $table the table to query.
1260      * @param array $conditions optional array $fieldname=>requestedvalue with AND in between
1261      * @param string $sort an order to sort the results in (optional, a valid SQL ORDER BY parameter).
1262      * @param string $fields a comma separated list of fields to return - the number of fields should be 2!
1263      * @param int $limitfrom return a subset of records, starting at this point (optional).
1264      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
1265      * @return array an associative array
1266      * @throws dml_exception A DML specific exception is thrown for any errors.
1267      */
1268     public function get_records_menu($table, array $conditions=null, $sort='', $fields='*', $limitfrom=0, $limitnum=0) {
1269         $menu = array();
1270         if ($records = $this->get_records($table, $conditions, $sort, $fields, $limitfrom, $limitnum)) {
1271             foreach ($records as $record) {
1272                 $record = (array)$record;
1273                 $key   = array_shift($record);
1274                 $value = array_shift($record);
1275                 $menu[$key] = $value;
1276             }
1277         }
1278         return $menu;
1279     }
1281     /**
1282      * Get the first two columns from a number of records as an associative array which match a particular WHERE clause.
1283      *
1284      * Arguments are like {@link function get_recordset_select}.
1285      * Return value is like {@link function get_records_menu}.
1286      *
1287      * @param string $table The database table to be checked against.
1288      * @param string $select A fragment of SQL to be used in a where clause in the SQL call.
1289      * @param array $params array of sql parameters
1290      * @param string $sort Sort order (optional) - a valid SQL order parameter
1291      * @param string $fields A comma separated list of fields to be returned from the chosen table - the number of fields should be 2!
1292      * @param int $limitfrom return a subset of records, starting at this point (optional).
1293      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
1294      * @return array an associative array
1295      * @throws dml_exception A DML specific exception is thrown for any errors.
1296      */
1297     public function get_records_select_menu($table, $select, array $params=null, $sort='', $fields='*', $limitfrom=0, $limitnum=0) {
1298         $menu = array();
1299         if ($records = $this->get_records_select($table, $select, $params, $sort, $fields, $limitfrom, $limitnum)) {
1300             foreach ($records as $record) {
1301                 $record = (array)$record;
1302                 $key   = array_shift($record);
1303                 $value = array_shift($record);
1304                 $menu[$key] = $value;
1305             }
1306         }
1307         return $menu;
1308     }
1310     /**
1311      * Get the first two columns from a number of records as an associative array using a SQL statement.
1312      *
1313      * Arguments are like {@link function get_recordset_sql}.
1314      * Return value is like {@link function get_records_menu}.
1315      *
1316      * @param string $sql The SQL string you wish to be executed.
1317      * @param array $params array of sql parameters
1318      * @param int $limitfrom return a subset of records, starting at this point (optional).
1319      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
1320      * @return array an associative array
1321      * @throws dml_exception A DML specific exception is thrown for any errors.
1322      */
1323     public function get_records_sql_menu($sql, array $params=null, $limitfrom=0, $limitnum=0) {
1324         $menu = array();
1325         if ($records = $this->get_records_sql($sql, $params, $limitfrom, $limitnum)) {
1326             foreach ($records as $record) {
1327                 $record = (array)$record;
1328                 $key   = array_shift($record);
1329                 $value = array_shift($record);
1330                 $menu[$key] = $value;
1331             }
1332         }
1333         return $menu;
1334     }
1336     /**
1337      * Get a single database record as an object where all the given conditions met.
1338      *
1339      * @param string $table The table to select from.
1340      * @param array $conditions optional array $fieldname=>requestedvalue with AND in between
1341      * @param string $fields A comma separated list of fields to be returned from the chosen table.
1342      * @param int $strictness IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found;
1343      *                        IGNORE_MULTIPLE means return first, ignore multiple records found(not recommended);
1344      *                        MUST_EXIST means we will throw an exception if no record or multiple records found.
1345      *
1346      * @todo MDL-30407 MUST_EXIST option should not throw a dml_exception, it should throw a different exception as it's a requested check.
1347      * @return mixed a fieldset object containing the first matching record, false or exception if error not found depending on mode
1348      * @throws dml_exception A DML specific exception is thrown for any errors.
1349      */
1350     public function get_record($table, array $conditions, $fields='*', $strictness=IGNORE_MISSING) {
1351         list($select, $params) = $this->where_clause($table, $conditions);
1352         return $this->get_record_select($table, $select, $params, $fields, $strictness);
1353     }
1355     /**
1356      * Get a single database record as an object which match a particular WHERE clause.
1357      *
1358      * @param string $table The database table to be checked against.
1359      * @param string $select A fragment of SQL to be used in a where clause in the SQL call.
1360      * @param array $params array of sql parameters
1361      * @param string $fields A comma separated list of fields to be returned from the chosen table.
1362      * @param int $strictness IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found;
1363      *                        IGNORE_MULTIPLE means return first, ignore multiple records found(not recommended);
1364      *                        MUST_EXIST means throw exception if no record or multiple records found
1365      * @return stdClass|false a fieldset object containing the first matching record, false or exception if error not found depending on mode
1366      * @throws dml_exception A DML specific exception is thrown for any errors.
1367      */
1368     public function get_record_select($table, $select, array $params=null, $fields='*', $strictness=IGNORE_MISSING) {
1369         if ($select) {
1370             $select = "WHERE $select";
1371         }
1372         try {
1373             return $this->get_record_sql("SELECT $fields FROM {" . $table . "} $select", $params, $strictness);
1374         } catch (dml_missing_record_exception $e) {
1375             // create new exception which will contain correct table name
1376             throw new dml_missing_record_exception($table, $e->sql, $e->params);
1377         }
1378     }
1380     /**
1381      * Get a single database record as an object using a SQL statement.
1382      *
1383      * The SQL statement should normally only return one record.
1384      * It is recommended to use get_records_sql() if more matches possible!
1385      *
1386      * @param string $sql The SQL string you wish to be executed, should normally only return one record.
1387      * @param array $params array of sql parameters
1388      * @param int $strictness IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found;
1389      *                        IGNORE_MULTIPLE means return first, ignore multiple records found(not recommended);
1390      *                        MUST_EXIST means throw exception if no record or multiple records found
1391      * @return mixed a fieldset object containing the first matching record, false or exception if error not found depending on mode
1392      * @throws dml_exception A DML specific exception is thrown for any errors.
1393      */
1394     public function get_record_sql($sql, array $params=null, $strictness=IGNORE_MISSING) {
1395         $strictness = (int)$strictness; // we support true/false for BC reasons too
1396         if ($strictness == IGNORE_MULTIPLE) {
1397             $count = 1;
1398         } else {
1399             $count = 0;
1400         }
1401         if (!$records = $this->get_records_sql($sql, $params, 0, $count)) {
1402             // not found
1403             if ($strictness == MUST_EXIST) {
1404                 throw new dml_missing_record_exception('', $sql, $params);
1405             }
1406             return false;
1407         }
1409         if (count($records) > 1) {
1410             if ($strictness == MUST_EXIST) {
1411                 throw new dml_multiple_records_exception($sql, $params);
1412             }
1413             debugging('Error: mdb->get_record() found more than one record!');
1414         }
1416         $return = reset($records);
1417         return $return;
1418     }
1420     /**
1421      * Get a single field value from a table record where all the given conditions met.
1422      *
1423      * @param string $table the table to query.
1424      * @param string $return the field to return the value of.
1425      * @param array $conditions optional array $fieldname=>requestedvalue with AND in between
1426      * @param int $strictness IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found;
1427      *                        IGNORE_MULTIPLE means return first, ignore multiple records found(not recommended);
1428      *                        MUST_EXIST means throw exception if no record or multiple records found
1429      * @return mixed the specified value false if not found
1430      * @throws dml_exception A DML specific exception is thrown for any errors.
1431      */
1432     public function get_field($table, $return, array $conditions, $strictness=IGNORE_MISSING) {
1433         list($select, $params) = $this->where_clause($table, $conditions);
1434         return $this->get_field_select($table, $return, $select, $params, $strictness);
1435     }
1437     /**
1438      * Get a single field value from a table record which match a particular WHERE clause.
1439      *
1440      * @param string $table the table to query.
1441      * @param string $return the field to return the value of.
1442      * @param string $select A fragment of SQL to be used in a where clause returning one row with one column
1443      * @param array $params array of sql parameters
1444      * @param int $strictness IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found;
1445      *                        IGNORE_MULTIPLE means return first, ignore multiple records found(not recommended);
1446      *                        MUST_EXIST means throw exception if no record or multiple records found
1447      * @return mixed the specified value false if not found
1448      * @throws dml_exception A DML specific exception is thrown for any errors.
1449      */
1450     public function get_field_select($table, $return, $select, array $params=null, $strictness=IGNORE_MISSING) {
1451         if ($select) {
1452             $select = "WHERE $select";
1453         }
1454         try {
1455             return $this->get_field_sql("SELECT $return FROM {" . $table . "} $select", $params, $strictness);
1456         } catch (dml_missing_record_exception $e) {
1457             // create new exception which will contain correct table name
1458             throw new dml_missing_record_exception($table, $e->sql, $e->params);
1459         }
1460     }
1462     /**
1463      * Get a single field value (first field) using a SQL statement.
1464      *
1465      * @param string $sql The SQL query returning one row with one column
1466      * @param array $params array of sql parameters
1467      * @param int $strictness IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found;
1468      *                        IGNORE_MULTIPLE means return first, ignore multiple records found(not recommended);
1469      *                        MUST_EXIST means throw exception if no record or multiple records found
1470      * @return mixed the specified value false if not found
1471      * @throws dml_exception A DML specific exception is thrown for any errors.
1472      */
1473     public function get_field_sql($sql, array $params=null, $strictness=IGNORE_MISSING) {
1474         if (!$record = $this->get_record_sql($sql, $params, $strictness)) {
1475             return false;
1476         }
1478         $record = (array)$record;
1479         return reset($record); // first column
1480     }
1482     /**
1483      * Selects records and return values of chosen field as an array which match a particular WHERE clause.
1484      *
1485      * @param string $table the table to query.
1486      * @param string $return the field we are intered in
1487      * @param string $select A fragment of SQL to be used in a where clause in the SQL call.
1488      * @param array $params array of sql parameters
1489      * @return array of values
1490      * @throws dml_exception A DML specific exception is thrown for any errors.
1491      */
1492     public function get_fieldset_select($table, $return, $select, array $params=null) {
1493         if ($select) {
1494             $select = "WHERE $select";
1495         }
1496         return $this->get_fieldset_sql("SELECT $return FROM {" . $table . "} $select", $params);
1497     }
1499     /**
1500      * Selects records and return values (first field) as an array using a SQL statement.
1501      *
1502      * @param string $sql The SQL query
1503      * @param array $params array of sql parameters
1504      * @return array of values
1505      * @throws dml_exception A DML specific exception is thrown for any errors.
1506      */
1507     public abstract function get_fieldset_sql($sql, array $params=null);
1509     /**
1510      * Insert new record into database, as fast as possible, no safety checks, lobs not supported.
1511      * @param string $table name
1512      * @param mixed $params data record as object or array
1513      * @param bool $returnid Returns id of inserted record.
1514      * @param bool $bulk true means repeated inserts expected
1515      * @param bool $customsequence true if 'id' included in $params, disables $returnid
1516      * @return bool|int true or new id
1517      * @throws dml_exception A DML specific exception is thrown for any errors.
1518      */
1519     public abstract function insert_record_raw($table, $params, $returnid=true, $bulk=false, $customsequence=false);
1521     /**
1522      * Insert a record into a table and return the "id" field if required.
1523      *
1524      * Some conversions and safety checks are carried out. Lobs are supported.
1525      * If the return ID isn't required, then this just reports success as true/false.
1526      * $data is an object containing needed data
1527      * @param string $table The database table to be inserted into
1528      * @param object $dataobject A data object with values for one or more fields in the record
1529      * @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.
1530      * @param bool $bulk Set to true is multiple inserts are expected
1531      * @return bool|int true or new id
1532      * @throws dml_exception A DML specific exception is thrown for any errors.
1533      */
1534     public abstract function insert_record($table, $dataobject, $returnid=true, $bulk=false);
1536     /**
1537      * Import a record into a table, id field is required.
1538      * Safety checks are NOT carried out. Lobs are supported.
1539      *
1540      * @param string $table name of database table to be inserted into
1541      * @param object $dataobject A data object with values for one or more fields in the record
1542      * @return bool true
1543      * @throws dml_exception A DML specific exception is thrown for any errors.
1544      */
1545     public abstract function import_record($table, $dataobject);
1547     /**
1548      * Update record in database, as fast as possible, no safety checks, lobs not supported.
1549      * @param string $table name
1550      * @param mixed $params data record as object or array
1551      * @param bool $bulk True means repeated updates expected.
1552      * @return bool true
1553      * @throws dml_exception A DML specific exception is thrown for any errors.
1554      */
1555     public abstract function update_record_raw($table, $params, $bulk=false);
1557     /**
1558      * Update a record in a table
1559      *
1560      * $dataobject is an object containing needed data
1561      * Relies on $dataobject having a variable "id" to
1562      * specify the record to update
1563      *
1564      * @param string $table The database table to be checked against.
1565      * @param object $dataobject An object with contents equal to fieldname=>fieldvalue. Must have an entry for 'id' to map to the table specified.
1566      * @param bool $bulk True means repeated updates expected.
1567      * @return bool true
1568      * @throws dml_exception A DML specific exception is thrown for any errors.
1569      */
1570     public abstract function update_record($table, $dataobject, $bulk=false);
1572     /**
1573      * Set a single field in every table record where all the given conditions met.
1574      *
1575      * @param string $table The database table to be checked against.
1576      * @param string $newfield the field to set.
1577      * @param string $newvalue the value to set the field to.
1578      * @param array $conditions optional array $fieldname=>requestedvalue with AND in between
1579      * @return bool true
1580      * @throws dml_exception A DML specific exception is thrown for any errors.
1581      */
1582     public function set_field($table, $newfield, $newvalue, array $conditions=null) {
1583         list($select, $params) = $this->where_clause($table, $conditions);
1584         return $this->set_field_select($table, $newfield, $newvalue, $select, $params);
1585     }
1587     /**
1588      * Set a single field in every table record which match a particular WHERE clause.
1589      *
1590      * @param string $table The database table to be checked against.
1591      * @param string $newfield the field to set.
1592      * @param string $newvalue the value to set the field to.
1593      * @param string $select A fragment of SQL to be used in a where clause in the SQL call.
1594      * @param array $params array of sql parameters
1595      * @return bool true
1596      * @throws dml_exception A DML specific exception is thrown for any errors.
1597      */
1598     public abstract function set_field_select($table, $newfield, $newvalue, $select, array $params=null);
1601     /**
1602      * Count the records in a table where all the given conditions met.
1603      *
1604      * @param string $table The table to query.
1605      * @param array $conditions optional array $fieldname=>requestedvalue with AND in between
1606      * @return int The count of records returned from the specified criteria.
1607      * @throws dml_exception A DML specific exception is thrown for any errors.
1608      */
1609     public function count_records($table, array $conditions=null) {
1610         list($select, $params) = $this->where_clause($table, $conditions);
1611         return $this->count_records_select($table, $select, $params);
1612     }
1614     /**
1615      * Count the records in a table which match a particular WHERE clause.
1616      *
1617      * @param string $table The database table to be checked against.
1618      * @param string $select A fragment of SQL to be used in a WHERE clause in the SQL call.
1619      * @param array $params array of sql parameters
1620      * @param string $countitem The count string to be used in the SQL call. Default is COUNT('x').
1621      * @return int The count of records returned from the specified criteria.
1622      * @throws dml_exception A DML specific exception is thrown for any errors.
1623      */
1624     public function count_records_select($table, $select, array $params=null, $countitem="COUNT('x')") {
1625         if ($select) {
1626             $select = "WHERE $select";
1627         }
1628         return $this->count_records_sql("SELECT $countitem FROM {" . $table . "} $select", $params);
1629     }
1631     /**
1632      * Get the result of a SQL SELECT COUNT(...) query.
1633      *
1634      * Given a query that counts rows, return that count. (In fact,
1635      * given any query, return the first field of the first record
1636      * returned. However, this method should only be used for the
1637      * intended purpose.) If an error occurs, 0 is returned.
1638      *
1639      * @param string $sql The SQL string you wish to be executed.
1640      * @param array $params array of sql parameters
1641      * @return int the count
1642      * @throws dml_exception A DML specific exception is thrown for any errors.
1643      */
1644     public function count_records_sql($sql, array $params=null) {
1645         $count = $this->get_field_sql($sql, $params);
1646         if ($count === false or !is_number($count) or $count < 0) {
1647             throw new coding_exception("count_records_sql() expects the first field to contain non-negative number from COUNT(), '$count' found instead.");
1648         }
1649         return (int)$count;
1650     }
1652     /**
1653      * Test whether a record exists in a table where all the given conditions met.
1654      *
1655      * @param string $table The table to check.
1656      * @param array $conditions optional array $fieldname=>requestedvalue with AND in between
1657      * @return bool true if a matching record exists, else false.
1658      * @throws dml_exception A DML specific exception is thrown for any errors.
1659      */
1660     public function record_exists($table, array $conditions) {
1661         list($select, $params) = $this->where_clause($table, $conditions);
1662         return $this->record_exists_select($table, $select, $params);
1663     }
1665     /**
1666      * Test whether any records exists in a table which match a particular WHERE clause.
1667      *
1668      * @param string $table The database table to be checked against.
1669      * @param string $select A fragment of SQL to be used in a WHERE clause in the SQL call.
1670      * @param array $params array of sql parameters
1671      * @return bool true if a matching record exists, else false.
1672      * @throws dml_exception A DML specific exception is thrown for any errors.
1673      */
1674     public function record_exists_select($table, $select, array $params=null) {
1675         if ($select) {
1676             $select = "WHERE $select";
1677         }
1678         return $this->record_exists_sql("SELECT 'x' FROM {" . $table . "} $select", $params);
1679     }
1681     /**
1682      * Test whether a SQL SELECT statement returns any records.
1683      *
1684      * This function returns true if the SQL statement executes
1685      * without any errors and returns at least one record.
1686      *
1687      * @param string $sql The SQL statement to execute.
1688      * @param array $params array of sql parameters
1689      * @return bool true if the SQL executes without errors and returns at least one record.
1690      * @throws dml_exception A DML specific exception is thrown for any errors.
1691      */
1692     public function record_exists_sql($sql, array $params=null) {
1693         $mrs = $this->get_recordset_sql($sql, $params, 0, 1);
1694         $return = $mrs->valid();
1695         $mrs->close();
1696         return $return;
1697     }
1699     /**
1700      * Delete the records from a table where all the given conditions met.
1701      * If conditions not specified, table is truncated.
1702      *
1703      * @param string $table the table to delete from.
1704      * @param array $conditions optional array $fieldname=>requestedvalue with AND in between
1705      * @return bool true.
1706      * @throws dml_exception A DML specific exception is thrown for any errors.
1707      */
1708     public function delete_records($table, array $conditions=null) {
1709         // truncate is drop/create (DDL), not transactional safe,
1710         // so we don't use the shortcut within them. MDL-29198
1711         if (is_null($conditions) && empty($this->transactions)) {
1712             return $this->execute("TRUNCATE TABLE {".$table."}");
1713         }
1714         list($select, $params) = $this->where_clause($table, $conditions);
1715         return $this->delete_records_select($table, $select, $params);
1716     }
1718     /**
1719      * Delete the records from a table where one field match one list of values.
1720      *
1721      * @param string $table the table to delete from.
1722      * @param string $field The field to search
1723      * @param array $values array of values
1724      * @return bool true.
1725      * @throws dml_exception A DML specific exception is thrown for any errors.
1726      */
1727     public function delete_records_list($table, $field, array $values) {
1728         list($select, $params) = $this->where_clause_list($field, $values);
1729         return $this->delete_records_select($table, $select, $params);
1730     }
1732     /**
1733      * Delete one or more records from a table which match a particular WHERE clause.
1734      *
1735      * @param string $table The database table to be checked against.
1736      * @param string $select A fragment of SQL to be used in a where clause in the SQL call (used to define the selection criteria).
1737      * @param array $params array of sql parameters
1738      * @return bool true.
1739      * @throws dml_exception A DML specific exception is thrown for any errors.
1740      */
1741     public abstract function delete_records_select($table, $select, array $params=null);
1743     /**
1744      * Returns the FROM clause required by some DBs in all SELECT statements.
1745      *
1746      * To be used in queries not having FROM clause to provide cross_db
1747      * Most DBs don't need it, hence the default is ''
1748      * @return string
1749      */
1750     public function sql_null_from_clause() {
1751         return '';
1752     }
1754     /**
1755      * Returns the SQL text to be used in order to perform one bitwise AND operation
1756      * between 2 integers.
1757      *
1758      * NOTE: The SQL result is a number and can not be used directly in
1759      *       SQL condition, please compare it to some number to get a bool!!
1760      *
1761      * @param int $int1 First integer in the operation.
1762      * @param int $int2 Second integer in the operation.
1763      * @return string The piece of SQL code to be used in your statement.
1764      */
1765     public function sql_bitand($int1, $int2) {
1766         return '((' . $int1 . ') & (' . $int2 . '))';
1767     }
1769     /**
1770      * Returns the SQL text to be used in order to perform one bitwise NOT operation
1771      * with 1 integer.
1772      *
1773      * @param int $int1 The operand integer in the operation.
1774      * @return string The piece of SQL code to be used in your statement.
1775      */
1776     public function sql_bitnot($int1) {
1777         return '(~(' . $int1 . '))';
1778     }
1780     /**
1781      * Returns the SQL text to be used in order to perform one bitwise OR operation
1782      * between 2 integers.
1783      *
1784      * NOTE: The SQL result is a number and can not be used directly in
1785      *       SQL condition, please compare it to some number to get a bool!!
1786      *
1787      * @param int $int1 The first operand integer in the operation.
1788      * @param int $int2 The second operand integer in the operation.
1789      * @return string The piece of SQL code to be used in your statement.
1790      */
1791     public function sql_bitor($int1, $int2) {
1792         return '((' . $int1 . ') | (' . $int2 . '))';
1793     }
1795     /**
1796      * Returns the SQL text to be used in order to perform one bitwise XOR operation
1797      * between 2 integers.
1798      *
1799      * NOTE: The SQL result is a number and can not be used directly in
1800      *       SQL condition, please compare it to some number to get a bool!!
1801      *
1802      * @param int $int1 The first operand integer in the operation.
1803      * @param int $int2 The second operand integer in the operation.
1804      * @return string The piece of SQL code to be used in your statement.
1805      */
1806     public function sql_bitxor($int1, $int2) {
1807         return '((' . $int1 . ') ^ (' . $int2 . '))';
1808     }
1810     /**
1811      * Returns the SQL text to be used in order to perform module '%'
1812      * operation - remainder after division
1813      *
1814      * @param int $int1 The first operand integer in the operation.
1815      * @param int $int2 The second operand integer in the operation.
1816      * @return string The piece of SQL code to be used in your statement.
1817      */
1818     public function sql_modulo($int1, $int2) {
1819         return '((' . $int1 . ') % (' . $int2 . '))';
1820     }
1822     /**
1823      * Returns the cross db correct CEIL (ceiling) expression applied to fieldname.
1824      * note: Most DBs use CEIL(), hence it's the default here.
1825      *
1826      * @param string $fieldname The field (or expression) we are going to ceil.
1827      * @return string The piece of SQL code to be used in your ceiling statement.
1828      */
1829     public function sql_ceil($fieldname) {
1830         return ' CEIL(' . $fieldname . ')';
1831     }
1833     /**
1834      * Returns the SQL to be used in order to CAST one CHAR column to INTEGER.
1835      *
1836      * Be aware that the CHAR column you're trying to cast contains really
1837      * int values or the RDBMS will throw an error!
1838      *
1839      * @param string $fieldname The name of the field to be casted.
1840      * @param bool $text Specifies if the original column is one TEXT (CLOB) column (true). Defaults to false.
1841      * @return string The piece of SQL code to be used in your statement.
1842      */
1843     public function sql_cast_char2int($fieldname, $text=false) {
1844         return ' ' . $fieldname . ' ';
1845     }
1847     /**
1848      * Returns the SQL to be used in order to CAST one CHAR column to REAL number.
1849      *
1850      * Be aware that the CHAR column you're trying to cast contains really
1851      * numbers or the RDBMS will throw an error!
1852      *
1853      * @param string $fieldname The name of the field to be casted.
1854      * @param bool $text Specifies if the original column is one TEXT (CLOB) column (true). Defaults to false.
1855      * @return string The piece of SQL code to be used in your statement.
1856      */
1857     public function sql_cast_char2real($fieldname, $text=false) {
1858         return ' ' . $fieldname . ' ';
1859     }
1861     /**
1862      * Returns the SQL to be used in order to an UNSIGNED INTEGER column to SIGNED.
1863      *
1864      * (Only MySQL needs this. MySQL things that 1 * -1 = 18446744073709551615
1865      * if the 1 comes from an unsigned column).
1866      *
1867      * @deprecated since 2.3
1868      * @param string $fieldname The name of the field to be cast
1869      * @return string The piece of SQL code to be used in your statement.
1870      */
1871     public function sql_cast_2signed($fieldname) {
1872         return ' ' . $fieldname . ' ';
1873     }
1875     /**
1876      * Returns the SQL text to be used to compare one TEXT (clob) column with
1877      * one varchar column, because some RDBMS doesn't support such direct
1878      * comparisons.
1879      *
1880      * @param string $fieldname The name of the TEXT field we need to order by
1881      * @param int $numchars Number of chars to use for the ordering (defaults to 32).
1882      * @return string The piece of SQL code to be used in your statement.
1883      */
1884     public function sql_compare_text($fieldname, $numchars=32) {
1885         return $this->sql_order_by_text($fieldname, $numchars);
1886     }
1888     /**
1889      * Returns 'LIKE' part of a query.
1890      *
1891      * @param string $fieldname Usually the name of the table column.
1892      * @param string $param Usually the bound query parameter (?, :named).
1893      * @param bool $casesensitive Use case sensitive search when set to true (default).
1894      * @param bool $accentsensitive Use accent sensitive search when set to true (default). (not all databases support accent insensitive)
1895      * @param bool $notlike True means "NOT LIKE".
1896      * @param string $escapechar The escape char for '%' and '_'.
1897      * @return string The SQL code fragment.
1898      */
1899     public function sql_like($fieldname, $param, $casesensitive = true, $accentsensitive = true, $notlike = false, $escapechar = '\\') {
1900         if (strpos($param, '%') !== false) {
1901             debugging('Potential SQL injection detected, sql_like() expects bound parameters (? or :named)');
1902         }
1903         $LIKE = $notlike ? 'NOT LIKE' : 'LIKE';
1904         // by default ignore any sensitiveness - each database does it in a different way
1905         return "$fieldname $LIKE $param ESCAPE '$escapechar'";
1906     }
1908     /**
1909      * Escape sql LIKE special characters like '_' or '%'.
1910      * @param string $text The string containing characters needing escaping.
1911      * @param string $escapechar The desired escape character, defaults to '\\'.
1912      * @return string The escaped sql LIKE string.
1913      */
1914     public function sql_like_escape($text, $escapechar = '\\') {
1915         $text = str_replace('_', $escapechar.'_', $text);
1916         $text = str_replace('%', $escapechar.'%', $text);
1917         return $text;
1918     }
1920     /**
1921      * Returns the proper SQL to do CONCAT between the elements(fieldnames) passed.
1922      *
1923      * This function accepts variable number of string parameters.
1924      * All strings/fieldnames will used in the SQL concatenate statement generated.
1925      *
1926      * @return string The SQL to concatenate strings passed in.
1927      * @uses func_get_args()  and thus parameters are unlimited OPTIONAL number of additional field names.
1928      */
1929     public abstract function sql_concat();
1931     /**
1932      * Returns the proper SQL to do CONCAT between the elements passed
1933      * with a given separator
1934      *
1935      * @param string $separator The separator desired for the SQL concatenating $elements.
1936      * @param array  $elements The array of strings to be concatenated.
1937      * @return string The SQL to concatenate the strings.
1938      */
1939     public abstract function sql_concat_join($separator="' '", $elements=array());
1941     /**
1942      * Returns the proper SQL (for the dbms in use) to concatenate $firstname and $lastname
1943      *
1944      * @todo MDL-31233 This may not be needed here.
1945      *
1946      * @param string $first User's first name (default:'firstname').
1947      * @param string $last User's last name (default:'lastname').
1948      * @return string The SQL to concatenate strings.
1949      */
1950     function sql_fullname($first='firstname', $last='lastname') {
1951         return $this->sql_concat($first, "' '", $last);
1952     }
1954     /**
1955      * Returns the SQL text to be used to order by one TEXT (clob) column, because
1956      * some RDBMS doesn't support direct ordering of such fields.
1957      *
1958      * Note that the use or queries being ordered by TEXT columns must be minimised,
1959      * because it's really slooooooow.
1960      *
1961      * @param string $fieldname The name of the TEXT field we need to order by.
1962      * @param int $numchars The number of chars to use for the ordering (defaults to 32).
1963      * @return string The piece of SQL code to be used in your statement.
1964      */
1965     public function sql_order_by_text($fieldname, $numchars=32) {
1966         return $fieldname;
1967     }
1969     /**
1970      * Returns the SQL text to be used to calculate the length in characters of one expression.
1971      * @param string $fieldname The fieldname/expression to calculate its length in characters.
1972      * @return string the piece of SQL code to be used in the statement.
1973      */
1974     public function sql_length($fieldname) {
1975         return ' LENGTH(' . $fieldname . ')';
1976     }
1978     /**
1979      * Returns the proper substr() SQL text used to extract substrings from DB
1980      * NOTE: this was originally returning only function name
1981      *
1982      * @param string $expr Some string field, no aggregates.
1983      * @param mixed $start Integer or expression evaluating to integer (1 based value; first char has index 1)
1984      * @param mixed $length Optional integer or expression evaluating to integer.
1985      * @return string The sql substring extraction fragment.
1986      */
1987     public function sql_substr($expr, $start, $length=false) {
1988         if (count(func_get_args()) < 2) {
1989             throw new coding_exception('moodle_database::sql_substr() requires at least two parameters', 'Originally this function was only returning name of SQL substring function, it now requires all parameters.');
1990         }
1991         if ($length === false) {
1992             return "SUBSTR($expr, $start)";
1993         } else {
1994             return "SUBSTR($expr, $start, $length)";
1995         }
1996     }
1998     /**
1999      * Returns the SQL for returning searching one string for the location of another.
2000      *
2001      * Note, there is no guarantee which order $needle, $haystack will be in
2002      * the resulting SQL so when using this method, and both arguments contain
2003      * placeholders, you should use named placeholders.
2004      *
2005      * @param string $needle the SQL expression that will be searched for.
2006      * @param string $haystack the SQL expression that will be searched in.
2007      * @return string The required searching SQL part.
2008      */
2009     public function sql_position($needle, $haystack) {
2010         // Implementation using standard SQL.
2011         return "POSITION(($needle) IN ($haystack))";
2012     }
2014     /**
2015      * Returns the empty string char used by every supported DB. To be used when
2016      * we are searching for that values in our queries. Only Oracle uses this
2017      * for now (will be out, once we migrate to proper NULLs if that days arrives)
2018      * @return string An empty string.
2019      */
2020     function sql_empty() {
2021         return '';
2022     }
2024     /**
2025      * Returns the proper SQL to know if one field is empty.
2026      *
2027      * Note that the function behavior strongly relies on the
2028      * parameters passed describing the field so, please,  be accurate
2029      * when specifying them.
2030      *
2031      * Also, note that this function is not suitable to look for
2032      * fields having NULL contents at all. It's all for empty values!
2033      *
2034      * This function should be applied in all the places where conditions of
2035      * the type:
2036      *
2037      *     ... AND fieldname = '';
2038      *
2039      * are being used. Final result should be:
2040      *
2041      *     ... AND ' . sql_isempty('tablename', 'fieldname', true/false, true/false);
2042      *
2043      * (see parameters description below)
2044      *
2045      * @param string $tablename Name of the table (without prefix). Not used for now but can be
2046      *                          necessary in the future if we want to use some introspection using
2047      *                          meta information against the DB. /// TODO ///
2048      * @param string $fieldname Name of the field we are going to check
2049      * @param bool $nullablefield For specifying if the field is nullable (true) or no (false) in the DB.
2050      * @param bool $textfield For specifying if it is a text (also called clob) field (true) or a varchar one (false)
2051      * @return string the sql code to be added to check for empty values
2052      */
2053     public function sql_isempty($tablename, $fieldname, $nullablefield, $textfield) {
2054         return " ($fieldname = '') ";
2055     }
2057     /**
2058      * Returns the proper SQL to know if one field is not empty.
2059      *
2060      * Note that the function behavior strongly relies on the
2061      * parameters passed describing the field so, please,  be accurate
2062      * when specifying them.
2063      *
2064      * This function should be applied in all the places where conditions of
2065      * the type:
2066      *
2067      *     ... AND fieldname != '';
2068      *
2069      * are being used. Final result should be:
2070      *
2071      *     ... AND ' . sql_isnotempty('tablename', 'fieldname', true/false, true/false);
2072      *
2073      * (see parameters description below)
2074      *
2075      * @param string $tablename Name of the table (without prefix). This is not used for now but can be
2076      *                          necessary in the future if we want to use some introspection using
2077      *                          meta information against the DB.
2078      * @param string $fieldname The name of the field we are going to check.
2079      * @param bool $nullablefield Specifies if the field is nullable (true) or not (false) in the DB.
2080      * @param bool $textfield Specifies if it is a text (also called clob) field (true) or a varchar one (false).
2081      * @return string The sql code to be added to check for non empty values.
2082      */
2083     public function sql_isnotempty($tablename, $fieldname, $nullablefield, $textfield) {
2084         return ' ( NOT ' . $this->sql_isempty($tablename, $fieldname, $nullablefield, $textfield) . ') ';
2085     }
2087     /**
2088      * Returns true if this database driver supports regex syntax when searching.
2089      * @return bool True if supported.
2090      */
2091     public function sql_regex_supported() {
2092         return false;
2093     }
2095     /**
2096      * Returns the driver specific syntax (SQL part) for matching regex positively or negatively (inverted matching).
2097      * Eg: 'REGEXP':'NOT REGEXP' or '~*' : '!~*'
2098      * @param bool $positivematch
2099      * @return string or empty if not supported
2100      */
2101     public function sql_regex($positivematch=true) {
2102         return '';
2103     }
2105     /**
2106      * Checks and returns true if transactions are supported.
2107      *
2108      * It is not responsible to run productions servers
2109      * on databases without transaction support ;-)
2110      *
2111      * Override in driver if needed.
2112      *
2113      * @return bool
2114      */
2115     protected function transactions_supported() {
2116         // protected for now, this might be changed to public if really necessary
2117         return true;
2118     }
2120     /**
2121      * Returns true if a transaction is in progress.
2122      * @return bool
2123      */
2124     public function is_transaction_started() {
2125         return !empty($this->transactions);
2126     }
2128     /**
2129      * This is a test that throws an exception if transaction in progress.
2130      * This test does not force rollback of active transactions.
2131      * @return void
2132      * @throws dml_transaction_exception if stansaction active
2133      */
2134     public function transactions_forbidden() {
2135         if ($this->is_transaction_started()) {
2136             throw new dml_transaction_exception('This code can not be excecuted in transaction');
2137         }
2138     }
2140     /**
2141      * On DBs that support it, switch to transaction mode and begin a transaction
2142      * you'll need to ensure you call allow_commit() on the returned object
2143      * or your changes *will* be lost.
2144      *
2145      * this is _very_ useful for massive updates
2146      *
2147      * Delegated database transactions can be nested, but only one actual database
2148      * transaction is used for the outer-most delegated transaction. This method
2149      * returns a transaction object which you should keep until the end of the
2150      * delegated transaction. The actual database transaction will
2151      * only be committed if all the nested delegated transactions commit
2152      * successfully. If any part of the transaction rolls back then the whole
2153      * thing is rolled back.
2154      *
2155      * @return moodle_transaction
2156      */
2157     public function start_delegated_transaction() {
2158         $transaction = new moodle_transaction($this);
2159         $this->transactions[] = $transaction;
2160         if (count($this->transactions) == 1) {
2161             $this->begin_transaction();
2162         }
2163         return $transaction;
2164     }
2166     /**
2167      * Driver specific start of real database transaction,
2168      * this can not be used directly in code.
2169      * @return void
2170      */
2171     protected abstract function begin_transaction();
2173     /**
2174      * Indicates delegated transaction finished successfully.
2175      * The real database transaction is committed only if
2176      * all delegated transactions committed.
2177      * @param moodle_transaction $transaction The transaction to commit
2178      * @return void
2179      * @throws dml_transaction_exception Creates and throws transaction related exceptions.
2180      */
2181     public function commit_delegated_transaction(moodle_transaction $transaction) {
2182         if ($transaction->is_disposed()) {
2183             throw new dml_transaction_exception('Transactions already disposed', $transaction);
2184         }
2185         // mark as disposed so that it can not be used again
2186         $transaction->dispose();
2188         if (empty($this->transactions)) {
2189             throw new dml_transaction_exception('Transaction not started', $transaction);
2190         }
2192         if ($this->force_rollback) {
2193             throw new dml_transaction_exception('Tried to commit transaction after lower level rollback', $transaction);
2194         }
2196         if ($transaction !== $this->transactions[count($this->transactions) - 1]) {
2197             // one incorrect commit at any level rollbacks everything
2198             $this->force_rollback = true;
2199             throw new dml_transaction_exception('Invalid transaction commit attempt', $transaction);
2200         }
2202         if (count($this->transactions) == 1) {
2203             // only commit the top most level
2204             $this->commit_transaction();
2205         }
2206         array_pop($this->transactions);
2207     }
2209     /**
2210      * Driver specific commit of real database transaction,
2211      * this can not be used directly in code.
2212      * @return void
2213      */
2214     protected abstract function commit_transaction();
2216     /**
2217      * Call when delegated transaction failed, this rolls back
2218      * all delegated transactions up to the top most level.
2219      *
2220      * In many cases you do not need to call this method manually,
2221      * because all open delegated transactions are rolled back
2222      * automatically if exceptions not caught.
2223      *
2224      * @param moodle_transaction $transaction An instance of a moodle_transaction.
2225      * @param Exception $e The related exception to this transaction rollback.
2226      * @return void This does not return, instead the exception passed in will be rethrown.
2227      */
2228     public function rollback_delegated_transaction(moodle_transaction $transaction, Exception $e) {
2229         if ($transaction->is_disposed()) {
2230             throw new dml_transaction_exception('Transactions already disposed', $transaction);
2231         }
2232         // mark as disposed so that it can not be used again
2233         $transaction->dispose();
2235         // one rollback at any level rollbacks everything
2236         $this->force_rollback = true;
2238         if (empty($this->transactions) or $transaction !== $this->transactions[count($this->transactions) - 1]) {
2239             // this may or may not be a coding problem, better just rethrow the exception,
2240             // because we do not want to loose the original $e
2241             throw $e;
2242         }
2244         if (count($this->transactions) == 1) {
2245             // only rollback the top most level
2246             $this->rollback_transaction();
2247         }
2248         array_pop($this->transactions);
2249         if (empty($this->transactions)) {
2250             // finally top most level rolled back
2251             $this->force_rollback = false;
2252         }
2253         throw $e;
2254     }
2256     /**
2257      * Driver specific abort of real database transaction,
2258      * this can not be used directly in code.
2259      * @return void
2260      */
2261     protected abstract function rollback_transaction();
2263     /**
2264      * Force rollback of all delegated transaction.
2265      * Does not throw any exceptions and does not log anything.
2266      *
2267      * This method should be used only from default exception handlers and other
2268      * core code.
2269      *
2270      * @return void
2271      */
2272     public function force_transaction_rollback() {
2273         if ($this->transactions) {
2274             try {
2275                 $this->rollback_transaction();
2276             } catch (dml_exception $e) {
2277                 // ignore any sql errors here, the connection might be broken
2278             }
2279         }
2281         // now enable transactions again
2282         $this->transactions = array(); // unfortunately all unfinished exceptions are kept in memory
2283         $this->force_rollback = false;
2284     }
2286     /**
2287      * Is session lock supported in this driver?
2288      * @return bool
2289      */
2290     public function session_lock_supported() {
2291         return false;
2292     }
2294     /**
2295      * Obtains the session lock.
2296      * @param int $rowid The id of the row with session record.
2297      * @param int $timeout The maximum allowed time to wait for the lock in seconds.
2298      * @return void
2299      * @throws dml_exception A DML specific exception is thrown for any errors.
2300      */
2301     public function get_session_lock($rowid, $timeout) {
2302         $this->used_for_db_sessions = true;
2303     }
2305     /**
2306      * Releases the session lock.
2307      * @param int $rowid The id of the row with session record.
2308      * @return void
2309      * @throws dml_exception A DML specific exception is thrown for any errors.
2310      */
2311     public function release_session_lock($rowid) {
2312     }
2314     /**
2315      * Returns the number of reads done by this database.
2316      * @return int Number of reads.
2317      */
2318     public function perf_get_reads() {
2319         return $this->reads;
2320     }
2322     /**
2323      * Returns the number of writes done by this database.
2324      * @return int Number of writes.
2325      */
2326     public function perf_get_writes() {
2327         return $this->writes;
2328     }
2330     /**
2331      * Returns the number of queries done by this database.
2332      * @return int Number of queries.
2333      */
2334     public function perf_get_queries() {
2335         return $this->writes + $this->reads;
2336     }