MDL-23925, MDL-23888 new sql_ilike() and sql_binary_equal() - this should finally...
[moodle.git] / lib / dml / moodle_database.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
19 /**
20  * Abstract database driver class.
21  *
22  * @package    core
23  * @subpackage dml
24  * @copyright  2008 Petr Skoda (http://skodak.org)
25  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
26  */
28 defined('MOODLE_INTERNAL') || die();
30 require_once($CFG->libdir.'/dml/database_column_info.php');
31 require_once($CFG->libdir.'/dml/moodle_recordset.php');
32 require_once($CFG->libdir.'/dml/moodle_transaction.php');
34 /// GLOBAL CONSTANTS /////////////////////////////////////////////////////////
36 /** Bitmask, indicates :name type parameters are supported by db backend. */
37 define('SQL_PARAMS_NAMED', 1);
39 /** Bitmask, indicates ? type parameters are supported by db backend. */
40 define('SQL_PARAMS_QM', 2);
42 /** Bitmask, indicates $1, $2, ... type parameters are supported by db backend. */
43 define('SQL_PARAMS_DOLLAR', 4);
46 /** Normal select query, reading only */
47 define('SQL_QUERY_SELECT', 1);
49 /** Insert select query, writing */
50 define('SQL_QUERY_INSERT', 2);
52 /** Update select query, writing */
53 define('SQL_QUERY_UPDATE', 3);
55 /** Query changing db structure, writing */
56 define('SQL_QUERY_STRUCTURE', 4);
58 /** Auxiliary query done by driver, setting connection config, getting table info, etc. */
59 define('SQL_QUERY_AUX', 5);
61 /**
62  * Abstract class representing moodle database interface.
63  */
64 abstract class moodle_database {
66     /** @var database_manager db manager which allows db structure modifications */
67     protected $database_manager;
68     /** @var moodle_temptables temptables manager to provide cross-db support for temp tables */
69     protected $temptables;
70     /** @var array cache of column info */
71     protected $columns = array(); // I wish we had a shared memory cache for this :-(
72     /** @var array cache of table info */
73     protected $tables  = null;
75     // db connection options
76     /** @var string db host name */
77     protected $dbhost;
78     /** @var string db host user */
79     protected $dbuser;
80     /** @var string db host password */
81     protected $dbpass;
82     /** @var string db name */
83     protected $dbname;
84     /** @var string table prefix */
85     protected $prefix;
87     /** @var array Database or driver specific options, such as sockets or TCPIP db connections */
88     protected $dboptions;
90     /** @var bool true means non-moodle external database used.*/
91     protected $external;
93     /** @var int The database reads (performance counter).*/
94     protected $reads = 0;
95     /** @var int The database writes (performance counter).*/
96     protected $writes = 0;
98     /** @var int Debug level */
99     protected $debug  = 0;
101     /** @var string last query sql */
102     protected $last_sql;
103     /** @var array last query parameters */
104     protected $last_params;
105     /** @var int last query type */
106     protected $last_type;
107     /** @var string last extra info */
108     protected $last_extrainfo;
109     /** @var float last time in seconds with millisecond precision */
110     protected $last_time;
111     /** @var bool flag indicating logging of query in progress, prevents infinite loops */
112     private $loggingquery = false;
114     /** @var bool true if db used for db sessions */
115     protected $used_for_db_sessions = false;
117     /** @var array open transactions */
118     private $transactions = array();
119     /** @var bool force rollback of all current transactions */
120     private $force_rollback = false;
122     /** @var int internal temporary variable */
123     private $fix_sql_params_i;
125     /**
126      * Constructor - instantiates the database, specifying if it's external (connect to other systems) or no (Moodle DB)
127      *              note this has effect to decide if prefix checks must be performed or no
128      * @param bool true means external database used
129      */
130     public function __construct($external=false) {
131         $this->external  = $external;
132     }
134     /**
135      * Destructor - cleans up and flushes everything needed.
136      */
137     public function __destruct() {
138         $this->dispose();
139     }
141     /**
142      * Detects if all needed PHP stuff installed.
143      * Note: can be used before connect()
144      * @return mixed true if ok, string if something
145      */
146     public abstract function driver_installed();
148     /**
149      * Returns database table prefix
150      * Note: can be used before connect()
151      * @return string database table prefix
152      */
153     public function get_prefix() {
154         return $this->prefix;
155     }
157     /**
158      * Loads and returns a database instance with the specified type and library.
159      * @param string $type database type of the driver (mysql, postgres7, mssql, etc)
160      * @param string $library database library of the driver (adodb, pdo, native, etc)
161      * @return moodle_database driver object or null if error
162      */
163     public static function get_driver_instance($type, $library) {
164         global $CFG;
166         $classname = $type.'_'.$library.'_moodle_database';
167         $libfile   = "$CFG->libdir/dml/$classname.php";
169         if (!file_exists($libfile)) {
170             return null;
171         }
173         require_once($libfile);
174         return new $classname();
175     }
177     /**
178      * Returns database family type - describes SQL dialect
179      * Note: can be used before connect()
180      * @return string db family name (mysql, postgres, mssql, oracle, etc.)
181      */
182     public abstract function get_dbfamily();
184     /**
185      * Returns more specific database driver type
186      * Note: can be used before connect()
187      * @return string db type mysql, mysqli, postgres7
188      */
189     protected abstract function get_dbtype();
191     /**
192      * Returns general database library name
193      * Note: can be used before connect()
194      * @return string db type pdo, native
195      */
196     protected abstract function get_dblibrary();
198     /**
199      * Returns localised database type name
200      * Note: can be used before connect()
201      * @return string
202      */
203     public abstract function get_name();
205     /**
206      * Returns localised database configuration help.
207      * Note: can be used before connect()
208      * @return string
209      */
210     public abstract function get_configuration_help();
212     /**
213      * Returns localised database description
214      * Note: can be used before connect()
215      * @return string
216      */
217     public abstract function get_configuration_hints();
219     /**
220      * Returns db related part of config.php
221      * @return object
222      */
223     public function export_dbconfig() {
224         $cfg = new stdClass();
225         $cfg->dbtype    = $this->get_dbtype();
226         $cfg->dblibrary = $this->get_dblibrary();
227         $cfg->dbhost    = $this->dbhost;
228         $cfg->dbname    = $this->dbname;
229         $cfg->dbuser    = $this->dbuser;
230         $cfg->dbpass    = $this->dbpass;
231         $cfg->prefix    = $this->prefix;
232         if ($this->dboptions) {
233             $cfg->dboptions = $this->dboptions;
234         }
236         return $cfg;
237     }
239     /**
240      * Diagnose database and tables, this function is used
241      * to verify database and driver settings, db engine types, etc.
242      *
243      * @return string null means everything ok, string means problem found.
244      */
245     public function diagnose() {
246         return null;
247     }
249     /**
250      * Connect to db
251      * Must be called before other methods.
252      * @param string $dbhost
253      * @param string $dbuser
254      * @param string $dbpass
255      * @param string $dbname
256      * @param mixed $prefix string means moodle db prefix, false used for external databases where prefix not used
257      * @param array $dboptions driver specific options
258      * @return bool true
259      * @throws dml_connection_exception if error
260      */
261     public abstract function connect($dbhost, $dbuser, $dbpass, $dbname, $prefix, array $dboptions=null);
263     /**
264      * Store various database settings
265      * @param string $dbhost
266      * @param string $dbuser
267      * @param string $dbpass
268      * @param string $dbname
269      * @param mixed $prefix string means moodle db prefix, false used for external databases where prefix not used
270      * @param array $dboptions driver specific options
271      * @return void
272      */
273     protected function store_settings($dbhost, $dbuser, $dbpass, $dbname, $prefix, array $dboptions=null) {
274         $this->dbhost    = $dbhost;
275         $this->dbuser    = $dbuser;
276         $this->dbpass    = $dbpass;
277         $this->dbname    = $dbname;
278         $this->prefix    = $prefix;
279         $this->dboptions = (array)$dboptions;
280     }
282     /**
283      * Attempt to create the database
284      * @param string $dbhost
285      * @param string $dbuser
286      * @param string $dbpass
287      * @param string $dbname
288      *
289      * @return bool success
290      */
291     public function create_database($dbhost, $dbuser, $dbpass, $dbname, array $dboptions=null) {
292         return false;
293     }
295     /**
296      * Close database connection and release all resources
297      * and memory (especially circular memory references).
298      * Do NOT use connect() again, create a new instance if needed.
299      * @return void
300      */
301     public function dispose() {
302         if ($this->transactions) {
303             // this should not happen, it usually indicates wrong catching of exceptions,
304             // because all transactions should be finished manually or in default exception handler.
305             // unfortunately we can not access global $CFG any more and can not print debug,
306             // the diagnostic info should be printed in footer instead
307             $lowesttransaction = end($this->transactions);
308             $backtrace = $lowesttransaction->get_backtrace();
310             error_log('Potential coding error - active database transaction detected when disposing database:'."\n".format_backtrace($backtrace, true));
311             $this->force_transaction_rollback();
312         }
313         if ($this->used_for_db_sessions) {
314             // this is needed because we need to save session to db before closing it
315             session_get_instance()->write_close();
316             $this->used_for_db_sessions = false;
317         }
318         if ($this->temptables) {
319             $this->temptables->dispose();
320             $this->temptables = null;
321         }
322         if ($this->database_manager) {
323             $this->database_manager->dispose();
324             $this->database_manager = null;
325         }
326         $this->columns = array();
327         $this->tables  = null;
328     }
330     /**
331      * Called before each db query.
332      * @param string $sql
333      * @param array array of parameters
334      * @param int $type type of query
335      * @param mixed $extrainfo driver specific extra information
336      * @return void
337      */
338     protected function query_start($sql, array $params=null, $type, $extrainfo=null) {
339         if ($this->loggingquery) {
340             return;
341         }
342         $this->last_sql       = $sql;
343         $this->last_params    = $params;
344         $this->last_type      = $type;
345         $this->last_extrainfo = $extrainfo;
346         $this->last_time      = microtime(true);
348         switch ($type) {
349             case SQL_QUERY_SELECT:
350             case SQL_QUERY_AUX:
351                 $this->reads++;
352                 break;
353             case SQL_QUERY_INSERT:
354             case SQL_QUERY_UPDATE:
355             case SQL_QUERY_STRUCTURE:
356                 $this->writes++;
357         }
359         $this->print_debug($sql, $params);
360     }
362     /**
363      * Called immediately after each db query.
364      * @param mixed db specific result
365      * @return void
366      */
367     protected function query_end($result) {
368         if ($this->loggingquery) {
369             return;
370         }
371         if ($result !== false) {
372             $this->query_log();
373             // free memory
374             $this->last_sql    = null;
375             $this->last_params = null;
376             return;
377         }
379         // remember current info, log queries may alter it
380         $type   = $this->last_type;
381         $sql    = $this->last_sql;
382         $params = $this->last_params;
383         $time   = microtime(true) - $this->last_time;
384         $error  = $this->get_last_error();
386         $this->query_log($error);
388         switch ($type) {
389             case SQL_QUERY_SELECT:
390             case SQL_QUERY_AUX:
391                 throw new dml_read_exception($error, $sql, $params);
392             case SQL_QUERY_INSERT:
393             case SQL_QUERY_UPDATE:
394                 throw new dml_write_exception($error, $sql, $params);
395             case SQL_QUERY_STRUCTURE:
396                 $this->get_manager(); // includes ddl exceptions classes ;-)
397                 throw new ddl_change_structure_exception($error, $sql);
398         }
399     }
401     /**
402      * Log last database query if requested
403      * @param mixed string error or false if not error
404      * @return void
405      */
406     public function query_log($error=false) {
407         $logall    = !empty($this->dboptions['logall']);
408         $logslow   = !empty($this->dboptions['logslow']) ? $this->dboptions['logslow'] : false;
409         $logerrors = !empty($this->dboptions['logerrors']);
410         $iserror   = ($error !== false);
412         $time = microtime(true) - $this->last_time;
414         if ($logall or ($logslow and ($logslow < ($time+0.00001))) or ($iserror and $logerrors)) {
415             $this->loggingquery = true;
416             try {
417                 $backtrace = debug_backtrace();
418                 if ($backtrace) {
419                     //remove query_log()
420                     array_shift($backtrace);
421                 }
422                 if ($backtrace) {
423                     //remove query_end()
424                     array_shift($backtrace);
425                 }
426                 $log = new object();
427                 $log->qtype      = $this->last_type;
428                 $log->sqltext    = $this->last_sql;
429                 $log->sqlparams  = var_export((array)$this->last_params, true);
430                 $log->error      = (int)$iserror;
431                 $log->info       = $iserror ? $error : null;
432                 $log->backtrace  = format_backtrace($backtrace, true);
433                 $log->exectime   = $time;
434                 $log->timelogged = time();
435                 $this->insert_record('log_queries', $log);
436             } catch (Exception $ignored) {
437             }
438             $this->loggingquery = false;
439         }
440     }
442     /**
443      * Returns database server info array
444      * @return array
445      */
446     public abstract function get_server_info();
448     /**
449      * Returns supported query parameter types
450      * @return int bitmask
451      */
452     protected abstract function allowed_param_types();
454     /**
455      * Returns last error reported by database engine.
456      * @return string error message
457      */
458     public abstract function get_last_error();
460     /**
461      * Print sql debug info
462      * @param string $sql query which caused problems
463      * @param array $params optional query parameters
464      * @param mixed $obj optional library specific object
465      * @return void
466      */
467     protected function print_debug($sql, array $params=null, $obj=null) {
468         if (!$this->get_debug()) {
469             return;
470         }
471         if (CLI_SCRIPT) {
472             echo "--------------------------------\n";
473             echo $sql."\n";
474             if (!is_null($params)) {
475                 echo "[".var_export($params, true)."]\n";
476             }
477             echo "--------------------------------\n";
478         } else {
479             echo "<hr />\n";
480             echo s($sql)."\n";
481             if (!is_null($params)) {
482                 echo "[".s(var_export($params, true))."]\n";
483             }
484             echo "<hr />\n";
485         }
486     }
488     /**
489      * Returns SQL WHERE conditions.
490      *
491      * @param array conditions - must not contain numeric indexes
492      * @return array sql part and params
493      */
494     protected function where_clause(array $conditions=null) {
495         $allowed_types = $this->allowed_param_types();
496         if (empty($conditions)) {
497             return array('', array());
498         }
499         $where = array();
500         $params = array();
501         foreach ($conditions as $key=>$value) {
502             if (is_int($key)) {
503                 throw new dml_exception('invalidnumkey');
504             }
505             if (is_null($value)) {
506                 $where[] = "$key IS NULL";
507             } else {
508                 $isstring = (is_string($value) && !is_number($value));
509                 if ($allowed_types & SQL_PARAMS_NAMED) {
510                     // Need to verify key names because they can contain, originally,
511                     // spaces and other forbidden chars when using sql_xxx() functions and friends.
512                     $normkey = trim(preg_replace('/[^a-zA-Z0-9-_]/', '_', $key), '-_');
513                     if ($normkey !== $key) {
514                         debugging('Invalid key found in the conditions array.');
515                     }
516                     if ($isstring) {
517                         $where[] = $this->sql_binary_equal($key, ':'.$normkey);
518                     } else {
519                         $where[] = "$key = :$normkey";
520                     }
521                     $params[$normkey] = $value;
522                 } else {
523                     if ($isstring) {
524                         $where[] = $this->sql_binary_equal($key, '?');
525                     } else {
526                         $where[] = "$key = ?";
527                     }
528                     $params[] = $value;
529                 }
530             }
531         }
532         $where = implode(" AND ", $where);
533         return array($where, $params);
534     }
536     /**
537      * Returns SQL WHERE conditions for the ..._list methods.
538      *
539      * @param string $field the name of a field.
540      * @param array $values the values field might take.
541      * @return array sql part and params
542      */
543     protected function where_clause_list($field, array $values) {
544         $params = array();
545         $select = array();
546         $values = (array)$values;
547         foreach ($values as $value) {
548             if (is_bool($value)) {
549                 $value = (int)$value;
550             }
551             if (is_null($value)) {
552                 $select[] = "$field IS NULL";
553             } else {
554                 $select[] = "$field = ?";
555                 $params[] = $value;
556             }
557         }
558         $select = implode(" OR ", $select);
559         return array($select, $params);
560     }
562     /**
563      * Constructs IN() or = sql fragment
564      * @param mixed $items single or array of values
565      * @param int $type bound param type SQL_PARAMS_QM or SQL_PARAMS_NAMED
566      * @param string named param placeholder start
567      * @param bool true means equal, false not equal
568      * @return array - $sql and $params
569      */
570     public function get_in_or_equal($items, $type=SQL_PARAMS_QM, $start='param0000', $equal=true) {
571         if (is_array($items) and empty($items)) {
572             throw new coding_exception('moodle_database::get_in_or_equal() does not accept empty arrays');
573         }
574         if ($type == SQL_PARAMS_QM) {
575             if (!is_array($items) or count($items) == 1) {
576                 $sql = $equal ? '= ?' : '<> ?';
577                 $items = (array)$items;
578                 $params = array_values($items);
579             } else {
580                 if ($equal) {
581                     $sql = 'IN ('.implode(',', array_fill(0, count($items), '?')).')';
582                 } else {
583                     $sql = 'NOT IN ('.implode(',', array_fill(0, count($items), '?')).')';
584                 }
585                 $params = array_values($items);
586             }
588         } else if ($type == SQL_PARAMS_NAMED) {
589             if (!is_array($items)){
590                 $sql = $equal ? "= :$start" : "<> :$start";
591                 $params = array($start=>$items);
592             } else if (count($items) == 1) {
593                 $sql = $equal ? "= :$start" : "<> :$start";
594                 $item = reset($items);
595                 $params = array($start=>$item);
596             } else {
597                 $params = array();
598                 $sql = array();
599                 foreach ($items as $item) {
600                     $params[$start] = $item;
601                     $sql[] = ':'.$start++;
602                 }
603                 if ($equal) {
604                     $sql = 'IN ('.implode(',', $sql).')';
605                 } else {
606                     $sql = 'NOT IN ('.implode(',', $sql).')';
607                 }
608             }
610         } else {
611             throw new dml_exception('typenotimplement');
612         }
613         return array($sql, $params);
614     }
616     /**
617      * Converts short table name {tablename} to real table name
618      * @param string sql
619      * @return string sql
620      */
621     protected function fix_table_names($sql) {
622         return preg_replace('/\{([a-z][a-z0-9_]*)\}/', $this->prefix.'$1', $sql);
623     }
625     /** Internal function */
626     private function _fix_sql_params_dollar_callback($match) {
627         $this->fix_sql_params_i++;
628         return "\$".$this->fix_sql_params_i;
629     }
631     /**
632      * Normalizes sql query parameters and verifies parameters.
633      * @param string $sql query or part of it
634      * @param array $params query parameters
635      * @return array (sql, params, type of params)
636      */
637     public function fix_sql_params($sql, array $params=null) {
638         $params = (array)$params; // mke null array if needed
639         $allowed_types = $this->allowed_param_types();
641         // convert table names
642         $sql = $this->fix_table_names($sql);
644         // NICOLAS C: Fixed regexp for negative backwards lookahead of double colons. Thanks for Sam Marshall's help
645         $named_count = preg_match_all('/(?<!:):[a-z][a-z0-9_]*/', $sql, $named_matches); // :: used in pgsql casts
646         $dollar_count = preg_match_all('/\$[1-9][0-9]*/', $sql, $dollar_matches);
647         $q_count     = substr_count($sql, '?');
649         $count = 0;
651         if ($named_count) {
652             $type = SQL_PARAMS_NAMED;
653             $count = $named_count;
655         }
656         if ($dollar_count) {
657             if ($count) {
658                 throw new dml_exception('mixedtypesqlparam');
659             }
660             $type = SQL_PARAMS_DOLLAR;
661             $count = $dollar_count;
663         }
664         if ($q_count) {
665             if ($count) {
666                 throw new dml_exception('mixedtypesqlparam');
667             }
668             $type = SQL_PARAMS_QM;
669             $count = $q_count;
671         }
673         if (!$count) {
674              // ignore params
675             if ($allowed_types & SQL_PARAMS_NAMED) {
676                 return array($sql, array(), SQL_PARAMS_NAMED);
677             } else if ($allowed_types & SQL_PARAMS_QM) {
678                 return array($sql, array(), SQL_PARAMS_QM);
679             } else {
680                 return array($sql, array(), SQL_PARAMS_DOLLAR);
681             }
682         }
684         if ($count > count($params)) {
685             $a = new stdClass;
686             $a->expected = $count;
687             $a->actual = count($params);
688             throw new dml_exception('invalidqueryparam', $a);
689         }
691         $target_type = $allowed_types;
693         if ($type & $allowed_types) { // bitwise AND
694             if ($count == count($params)) {
695                 if ($type == SQL_PARAMS_QM) {
696                     return array($sql, array_values($params), SQL_PARAMS_QM); // 0-based array required
697                 } else {
698                     //better do the validation of names below
699                 }
700             }
701             // needs some fixing or validation - there might be more params than needed
702             $target_type = $type;
703         }
705         if ($type == SQL_PARAMS_NAMED) {
706             $finalparams = array();
707             foreach ($named_matches[0] as $key) {
708                 $key = trim($key, ':');
709                 if (!array_key_exists($key, $params)) {
710                     throw new dml_exception('missingkeyinsql', $key, '');
711                 }
712                 $finalparams[$key] = $params[$key];
713             }
714             if ($count != count($finalparams)) {
715                 throw new dml_exception('duplicateparaminsql');
716             }
718             if ($target_type & SQL_PARAMS_QM) {
719                 $sql = preg_replace('/(?<!:):[a-z][a-z0-9_]*/', '?', $sql);
720                 return array($sql, array_values($finalparams), SQL_PARAMS_QM); // 0-based required
721             } else if ($target_type & SQL_PARAMS_NAMED) {
722                 return array($sql, $finalparams, SQL_PARAMS_NAMED);
723             } else {  // $type & SQL_PARAMS_DOLLAR
724                 //lambda-style functions eat memory - we use globals instead :-(
725                 $this->fix_sql_params_i = 0;
726                 $sql = preg_replace_callback('/(?<!:):[a-z][a-z0-9_]*/', array($this, '_fix_sql_params_dollar_callback'), $sql);
727                 return array($sql, array_values($finalparams), SQL_PARAMS_DOLLAR); // 0-based required
728             }
730         } else if ($type == SQL_PARAMS_DOLLAR) {
731             if ($target_type & SQL_PARAMS_DOLLAR) {
732                 return array($sql, array_values($params), SQL_PARAMS_DOLLAR); // 0-based required
733             } else if ($target_type & SQL_PARAMS_QM) {
734                 $sql = preg_replace('/\$[0-9]+/', '?', $sql);
735                 return array($sql, array_values($params), SQL_PARAMS_QM); // 0-based required
736             } else { //$target_type & SQL_PARAMS_NAMED
737                 $sql = preg_replace('/\$([0-9]+)/', ':param\\1', $sql);
738                 $finalparams = array();
739                 foreach ($params as $key=>$param) {
740                     $key++;
741                     $finalparams['param'.$key] = $param;
742                 }
743                 return array($sql, $finalparams, SQL_PARAMS_NAMED);
744             }
746         } else { // $type == SQL_PARAMS_QM
747             if (count($params) != $count) {
748                 $params = array_slice($params, 0, $count);
749             }
751             if ($target_type & SQL_PARAMS_QM) {
752                 return array($sql, array_values($params), SQL_PARAMS_QM); // 0-based required
753             } else if ($target_type & SQL_PARAMS_NAMED) {
754                 $finalparams = array();
755                 $pname = 'param0';
756                 $parts = explode('?', $sql);
757                 $sql = array_shift($parts);
758                 foreach ($parts as $part) {
759                     $param = array_shift($params);
760                     $pname++;
761                     $sql .= ':'.$pname.$part;
762                     $finalparams[$pname] = $param;
763                 }
764                 return array($sql, $finalparams, SQL_PARAMS_NAMED);
765             } else {  // $type & SQL_PARAMS_DOLLAR
766                 //lambda-style functions eat memory - we use globals instead :-(
767                 $this->fix_sql_params_i = 0;
768                 $sql = preg_replace_callback('/\?/', array($this, '_fix_sql_params_dollar_callback'), $sql);
769                 return array($sql, array_values($params), SQL_PARAMS_DOLLAR); // 0-based required
770             }
771         }
772     }
774     /**
775      * Return tables in database WITHOUT current prefix
776      * @return array of table names in lowercase and without prefix
777      */
778     public abstract function get_tables($usecache=true);
780     /**
781      * Return table indexes - everything lowercased
782      * @return array of arrays
783      */
784     public abstract function get_indexes($table);
786     /**
787      * Returns datailed information about columns in table. This information is cached internally.
788      * @param string $table name
789      * @param bool $usecache
790      * @return array array of database_column_info objects indexed with column names
791      */
792     public abstract function get_columns($table, $usecache=true);
794     /**
795      * Normalise values based in RDBMS dependencies (booleans, LOBs...)
796      *
797      * @param database_column_info $column column metadata corresponding with the value we are going to normalise
798      * @param mixed $value value we are going to normalise
799      * @return mixed the normalised value
800      */
801     protected abstract function normalise_value($column, $value);
803     /**
804      * Reset internal column details cache
805      * @param string $table - empty means all, or one if name of table given
806      * @return void
807      */
808     public function reset_caches() {
809         $this->columns = array();
810         $this->tables  = null;
811     }
813     /**
814      * Returns sql generator used for db manipulation.
815      * Used mostly in upgrade.php scripts.
816      * @return object database_manager instance
817      */
818     public function get_manager() {
819         global $CFG;
821         if (!$this->database_manager) {
822             require_once($CFG->libdir.'/ddllib.php');
824             $classname = $this->get_dbfamily().'_sql_generator';
825             require_once("$CFG->libdir/ddl/$classname.php");
826             $generator = new $classname($this, $this->temptables);
828             $this->database_manager = new database_manager($this, $generator);
829         }
830         return $this->database_manager;
831     }
833     /**
834      * Attempt to change db encoding toUTF-8 if possible
835      * @return bool success
836      */
837     public function change_db_encoding() {
838         return false;
839     }
841     /**
842      * Is db in unicode mode?
843      * @return bool
844      */
845     public function setup_is_unicodedb() {
846         return true;
847     }
849     /**
850      * Enable/disable very detailed debugging
851      * @param bool $state
852      */
853     public function set_debug($state) {
854         $this->debug = $state;
855     }
857     /**
858      * Returns debug status
859      * @return bool $state
860      */
861     public function get_debug() {
862         return $this->debug;
863     }
865     /**
866      * Enable/disable detailed sql logging
867      * @param bool $state
868      */
869     public function set_logging($state) {
870         // adodb sql logging shares one table without prefix per db - this is no longer acceptable :-(
871         // we must create one table shared by all drivers
872     }
874     /**
875      * Do NOT use in code, to be used by database_manager only!
876      * @param string $sql query
877      * @return bool true
878      * @throws dml_exception if error
879      */
880     public abstract function change_database_structure($sql);
882     /**
883      * Execute general sql query. Should be used only when no other method suitable.
884      * Do NOT use this to make changes in db structure, use database_manager::execute_sql() instead!
885      * @param string $sql query
886      * @param array $params query parameters
887      * @return bool true
888      * @throws dml_exception if error
889      */
890     public abstract function execute($sql, array $params=null);
892     /**
893      * Get a number of records as a moodle_recordset where all the given conditions met.
894      *
895      * Selects records from the table $table.
896      *
897      * If specified, only records meeting $conditions.
898      *
899      * If specified, the results will be sorted as specified by $sort. This
900      * is added to the SQL as "ORDER BY $sort". Example values of $sort
901      * might be "time ASC" or "time DESC".
902      *
903      * If $fields is specified, only those fields are returned.
904      *
905      * Since this method is a little less readable, use of it should be restricted to
906      * code where it's possible there might be large datasets being returned.  For known
907      * small datasets use get_records - it leads to simpler code.
908      *
909      * If you only want some of the records, specify $limitfrom and $limitnum.
910      * The query will skip the first $limitfrom records (according to the sort
911      * order) and then return the next $limitnum records. If either of $limitfrom
912      * or $limitnum is specified, both must be present.
913      *
914      * The return value is a moodle_recordset
915      * if the query succeeds. If an error occurs, false is returned.
916      *
917      * @param string $table the table to query.
918      * @param array $conditions optional array $fieldname=>requestedvalue with AND in between
919      * @param string $sort an order to sort the results in (optional, a valid SQL ORDER BY parameter).
920      * @param string $fields a comma separated list of fields to return (optional, by default all fields are returned).
921      * @param int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
922      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
923      * @return moodle_recordset instance
924      * @throws dml_exception if error
925      */
926     public function get_recordset($table, array $conditions=null, $sort='', $fields='*', $limitfrom=0, $limitnum=0) {
927         list($select, $params) = $this->where_clause($conditions);
928         return $this->get_recordset_select($table, $select, $params, $sort, $fields, $limitfrom, $limitnum);
929     }
931     /**
932      * Get a number of records as a moodle_recordset where one field match one list of values.
933      *
934      * Only records where $field takes one of the values $values are returned.
935      * $values must be an array of values.
936      *
937      * Other arguments and the return type as for @see function get_recordset.
938      *
939      * @param string $table the table to query.
940      * @param string $field a field to check (optional).
941      * @param array $values array of values the field must have
942      * @param string $sort an order to sort the results in (optional, a valid SQL ORDER BY parameter).
943      * @param string $fields a comma separated list of fields to return (optional, by default all fields are returned).
944      * @param int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
945      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
946      * @return moodle_recordset instance
947      * @throws dml_exception if error
948      */
949     public function get_recordset_list($table, $field, array $values, $sort='', $fields='*', $limitfrom=0, $limitnum=0) {
950         list($select, $params) = $this->where_clause_list($field, $values);
951         if (empty($select)) {
952             $select = '? = ?'; /// Fake condition, won't return rows ever. MDL-17645
953             $params = array(1, 2);
954         }
955         return $this->get_recordset_select($table, $select, $params, $sort, $fields, $limitfrom, $limitnum);
956     }
958     /**
959      * Get a number of records as a moodle_recordset which match a particular WHERE clause.
960      *
961      * If given, $select is used as the SELECT parameter in the SQL query,
962      * otherwise all records from the table are returned.
963      *
964      * Other arguments and the return type as for @see function get_recordset.
965      *
966      * @param string $table the table to query.
967      * @param string $select A fragment of SQL to be used in a where clause in the SQL call.
968      * @param array $params array of sql parameters
969      * @param string $sort an order to sort the results in (optional, a valid SQL ORDER BY parameter).
970      * @param string $fields a comma separated list of fields to return (optional, by default all fields are returned).
971      * @param int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
972      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
973      * @return moodle_recordset instance
974      * @throws dml_exception if error
975      */
976     public function get_recordset_select($table, $select, array $params=null, $sort='', $fields='*', $limitfrom=0, $limitnum=0) {
977         $sql = "SELECT $fields FROM {".$table."}";
978         if ($select) {
979             $sql .= " WHERE $select";
980         }
981         if ($sort) {
982             $sql .= " ORDER BY $sort";
983         }
984         return $this->get_recordset_sql($sql, $params, $limitfrom, $limitnum);
985     }
987     /**
988      * Get a number of records as a moodle_recordset using a SQL statement.
989      *
990      * Since this method is a little less readable, use of it should be restricted to
991      * code where it's possible there might be large datasets being returned.  For known
992      * small datasets use get_records_sql - it leads to simpler code.
993      *
994      * The return type is as for @see function get_recordset.
995      *
996      * @param string $sql the SQL select query to execute.
997      * @param array $params array of sql parameters
998      * @param int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
999      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
1000      * @return moodle_recordset instance
1001      * @throws dml_exception if error
1002      */
1003     public abstract function get_recordset_sql($sql, array $params=null, $limitfrom=0, $limitnum=0);
1005     /**
1006      * Get a number of records as an array of objects where all the given conditions met.
1007      *
1008      * If the query succeeds and returns at least one record, the
1009      * return value is an array of objects, one object for each
1010      * record found. The array key is the value from the first
1011      * column of the result set. The object associated with that key
1012      * has a member variable for each column of the results.
1013      *
1014      * @param string $table the table to query.
1015      * @param array $conditions optional array $fieldname=>requestedvalue with AND in between
1016      * @param string $sort an order to sort the results in (optional, a valid SQL ORDER BY parameter).
1017      * @param string $fields a comma separated list of fields to return (optional, by default
1018      *   all fields are returned). The first field will be used as key for the
1019      *   array so must be a unique field such as 'id'.
1020      * @param int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
1021      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
1022      * @return array of objects indexed by first column
1023      * @throws dml_exception if error
1024      */
1025     public function get_records($table, array $conditions=null, $sort='', $fields='*', $limitfrom=0, $limitnum=0) {
1026         list($select, $params) = $this->where_clause($conditions);
1027         return $this->get_records_select($table, $select, $params, $sort, $fields, $limitfrom, $limitnum);
1028     }
1030     /**
1031      * Get a number of records as an array of objects where one field match one list of values.
1032      *
1033      * Return value as for @see function get_records.
1034      *
1035      * @param string $table The database table to be checked against.
1036      * @param string $field The field to search
1037      * @param string $values array of values
1038      * @param string $sort Sort order (as valid SQL sort parameter)
1039      * @param string $fields A comma separated list of fields to be returned from the chosen table. If specified,
1040      *   the first field should be a unique one such as 'id' since it will be used as a key in the associative
1041      *   array.
1042      * @return array of objects indexed by first column
1043      * @throws dml_exception if error
1044      */
1045     public function get_records_list($table, $field, array $values, $sort='', $fields='*', $limitfrom=0, $limitnum=0) {
1046         list($select, $params) = $this->where_clause_list($field, $values);
1047         if (empty($select)) {
1048             // nothing to return
1049             return array();
1050         }
1051         return $this->get_records_select($table, $select, $params, $sort, $fields, $limitfrom, $limitnum);
1052     }
1054     /**
1055      * Get a number of records as an array of objects which match a particular WHERE clause.
1056      *
1057      * Return value as for @see function get_records.
1058      *
1059      * @param string $table the table to query.
1060      * @param string $select A fragment of SQL to be used in a where clause in the SQL call.
1061      * @param array $params array of sql parameters
1062      * @param string $sort an order to sort the results in (optional, a valid SQL ORDER BY parameter).
1063      * @param string $fields a comma separated list of fields to return
1064      *   (optional, by default all fields are returned). The first field will be used as key for the
1065      *   array so must be a unique field such as 'id'.
1066      * @param int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
1067      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
1068      * @return array of objects indexed by first column
1069      * @throws dml_exception if error
1070      */
1071     public function get_records_select($table, $select, array $params=null, $sort='', $fields='*', $limitfrom=0, $limitnum=0) {
1072         if ($select) {
1073             $select = "WHERE $select";
1074         }
1075         if ($sort) {
1076             $sort = " ORDER BY $sort";
1077         }
1078         return $this->get_records_sql("SELECT $fields FROM {" . $table . "} $select $sort", $params, $limitfrom, $limitnum);
1079     }
1081     /**
1082      * Get a number of records as an array of objects using a SQL statement.
1083      *
1084      * Return value as for @see function get_records.
1085      *
1086      * @param string $sql the SQL select query to execute. The first column of this SELECT statement
1087      *   must be a unique value (usually the 'id' field), as it will be used as the key of the
1088      *   returned array.
1089      * @param array $params array of sql parameters
1090      * @param int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
1091      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
1092      * @return array of objects indexed by first column
1093      * @throws dml_exception if error
1094      */
1095     public abstract function get_records_sql($sql, array $params=null, $limitfrom=0, $limitnum=0);
1097     /**
1098      * Get the first two columns from a number of records as an associative array where all the given conditions met.
1099      *
1100      * Arguments as for @see function get_recordset.
1101      *
1102      * If no errors occur the return value
1103      * is an associative whose keys come from the first field of each record,
1104      * and whose values are the corresponding second fields.
1105      * False is returned if an error occurs.
1106      *
1107      * @param string $table the table to query.
1108      * @param array $conditions optional array $fieldname=>requestedvalue with AND in between
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 - the number of fields should be 2!
1111      * @param int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
1112      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
1113      * @return array an associative array
1114      * @throws dml_exception if error
1115      */
1116     public function get_records_menu($table, array $conditions=null, $sort='', $fields='*', $limitfrom=0, $limitnum=0) {
1117         $menu = array();
1118         if ($records = $this->get_records($table, $conditions, $sort, $fields, $limitfrom, $limitnum)) {
1119             foreach ($records as $record) {
1120                 $record = (array)$record;
1121                 $key   = array_shift($record);
1122                 $value = array_shift($record);
1123                 $menu[$key] = $value;
1124             }
1125         }
1126         return $menu;
1127     }
1129     /**
1130      * Get the first two columns from a number of records as an associative array which match a particular WHERE clause.
1131      *
1132      * Arguments as for @see function get_recordset_select.
1133      * Return value as for @see function get_records_menu.
1134      *
1135      * @param string $table The database table to be checked against.
1136      * @param string $select A fragment of SQL to be used in a where clause in the SQL call.
1137      * @param array $params array of sql parameters
1138      * @param string $sort Sort order (optional) - a valid SQL order parameter
1139      * @param string $fields A comma separated list of fields to be returned from the chosen table - the number of fields should be 2!
1140      * @param int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
1141      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
1142      * @return array an associative array
1143      * @throws dml_exception if error
1144      */
1145     public function get_records_select_menu($table, $select, array $params=null, $sort='', $fields='*', $limitfrom=0, $limitnum=0) {
1146         $menu = array();
1147         if ($records = $this->get_records_select($table, $select, $params, $sort, $fields, $limitfrom, $limitnum)) {
1148             foreach ($records as $record) {
1149                 $record = (array)$record;
1150                 $key   = array_shift($record);
1151                 $value = array_shift($record);
1152                 $menu[$key] = $value;
1153             }
1154         }
1155         return $menu;
1156     }
1158     /**
1159      * Get the first two columns from a number of records as an associative array using a SQL statement.
1160      *
1161      * Arguments as for @see function get_recordset_sql.
1162      * Return value as for @see function get_records_menu.
1163      *
1164      * @param string $sql The SQL string you wish to be executed.
1165      * @param array $params array of sql parameters
1166      * @param int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
1167      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
1168      * @return array an associative array
1169      * @throws dml_exception if error
1170      */
1171     public function get_records_sql_menu($sql, array $params=null, $limitfrom=0, $limitnum=0) {
1172         $menu = array();
1173         if ($records = $this->get_records_sql($sql, $params, $limitfrom, $limitnum)) {
1174             foreach ($records as $record) {
1175                 $record = (array)$record;
1176                 $key   = array_shift($record);
1177                 $value = array_shift($record);
1178                 $menu[$key] = $value;
1179             }
1180         }
1181         return $menu;
1182     }
1184     /**
1185      * Get a single database record as an object where all the given conditions met.
1186      *
1187      * @param string $table The table to select from.
1188      * @param array $conditions optional array $fieldname=>requestedvalue with AND in between
1189      * @param string $fields A comma separated list of fields to be returned from the chosen table.
1190      * @param int $strictness IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found;
1191      *                        IGNORE_MULTIPLE means return first, ignore multiple records found(not recommended);
1192      *                        MUST_EXIST means throw exception if no record or multiple records found
1193      * @return mixed a fieldset object containing the first matching record, false or exception if error not found depending on mode
1194      * @throws dml_exception if error
1195      */
1196     public function get_record($table, array $conditions, $fields='*', $strictness=IGNORE_MISSING) {
1197         list($select, $params) = $this->where_clause($conditions);
1198         return $this->get_record_select($table, $select, $params, $fields, $strictness);
1199     }
1201     /**
1202      * Get a single database record as an object which match a particular WHERE clause.
1203      *
1204      * @param string $table The database table to be checked against.
1205      * @param string $select A fragment of SQL to be used in a where clause in the SQL call.
1206      * @param array $params array of sql parameters
1207      * @param int $strictness IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found;
1208      *                        IGNORE_MULTIPLE means return first, ignore multiple records found(not recommended);
1209      *                        MUST_EXIST means throw exception if no record or multiple records found
1210      * @return mixed a fieldset object containing the first matching record, false or exception if error not found depending on mode
1211      * @throws dml_exception if error
1212      */
1213     public function get_record_select($table, $select, array $params=null, $fields='*', $strictness=IGNORE_MISSING) {
1214         if ($select) {
1215             $select = "WHERE $select";
1216         }
1217         try {
1218             return $this->get_record_sql("SELECT $fields FROM {" . $table . "} $select", $params, $strictness);
1219         } catch (dml_missing_record_exception $e) {
1220             // create new exception which will contain correct table name
1221             throw new dml_missing_record_exception($table, $e->sql, $e->params);
1222         }
1223     }
1225     /**
1226      * Get a single database record as an object using a SQL statement.
1227      *
1228      * The SQL statement should normally only return one record.
1229      * It is recommended to use get_records_sql() if more matches possible!
1230      *
1231      * @param string $sql The SQL string you wish to be executed, should normally only return one record.
1232      * @param array $params array of sql parameters
1233      * @param int $strictness IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found;
1234      *                        IGNORE_MULTIPLE means return first, ignore multiple records found(not recommended);
1235      *                        MUST_EXIST means throw exception if no record or multiple records found
1236      * @return mixed a fieldset object containing the first matching record, false or exception if error not found depending on mode
1237      * @throws dml_exception if error
1238      */
1239     public function get_record_sql($sql, array $params=null, $strictness=IGNORE_MISSING) {
1240         $strictness = (int)$strictness; // we support true/false for BC reasons too
1241         if ($strictness == IGNORE_MULTIPLE) {
1242             $count = 1;
1243         } else {
1244             $count = 0;
1245         }
1246         if (!$records = $this->get_records_sql($sql, $params, 0, $count)) {
1247             // not found
1248             if ($strictness == MUST_EXIST) {
1249                 throw new dml_missing_record_exception('', $sql, $params);
1250             }
1251             return false;
1252         }
1254         if (count($records) > 1) {
1255             if ($strictness == MUST_EXIST) {
1256                 throw new dml_multiple_records_exception($sql, $params);
1257             }
1258             debugging('Error: mdb->get_record() found more than one record!');
1259         }
1261         $return = reset($records);
1262         return $return;
1263     }
1265     /**
1266      * Get a single field value from a table record where all the given conditions met.
1267      *
1268      * @param string $table the table to query.
1269      * @param string $return the field to return the value of.
1270      * @param array $conditions optional array $fieldname=>requestedvalue with AND in between
1271      * @param int $strictness IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found;
1272      *                        IGNORE_MULTIPLE means return first, ignore multiple records found(not recommended);
1273      *                        MUST_EXIST means throw exception if no record or multiple records found
1274      * @return mixed the specified value false if not found
1275      * @throws dml_exception if error
1276      */
1277     public function get_field($table, $return, array $conditions, $strictness=IGNORE_MISSING) {
1278         list($select, $params) = $this->where_clause($conditions);
1279         return $this->get_field_select($table, $return, $select, $params, $strictness);
1280     }
1282     /**
1283      * Get a single field value from a table record which match a particular WHERE clause.
1284      *
1285      * @param string $table the table to query.
1286      * @param string $return the field to return the value of.
1287      * @param string $select A fragment of SQL to be used in a where clause returning one row with one column
1288      * @param array $params array of sql parameters
1289      * @param int $strictness IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found;
1290      *                        IGNORE_MULTIPLE means return first, ignore multiple records found(not recommended);
1291      *                        MUST_EXIST means throw exception if no record or multiple records found
1292      * @return mixed the specified value false if not found
1293      * @throws dml_exception if error
1294      */
1295     public function get_field_select($table, $return, $select, array $params=null, $strictness=IGNORE_MISSING) {
1296         if ($select) {
1297             $select = "WHERE $select";
1298         }
1299         try {
1300             return $this->get_field_sql("SELECT $return FROM {" . $table . "} $select", $params, $strictness);
1301         } catch (dml_missing_record_exception $e) {
1302             // create new exception which will contain correct table name
1303             throw new dml_missing_record_exception($table, $e->sql, $e->params);
1304         }
1305     }
1307     /**
1308      * Get a single field value (first field) using a SQL statement.
1309      *
1310      * @param string $table the table to query.
1311      * @param string $return the field to return the value of.
1312      * @param string $sql The SQL query returning one row with one column
1313      * @param array $params array of sql parameters
1314      * @param int $strictness IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found;
1315      *                        IGNORE_MULTIPLE means return first, ignore multiple records found(not recommended);
1316      *                        MUST_EXIST means throw exception if no record or multiple records found
1317      * @return mixed the specified value false if not found
1318      * @throws dml_exception if error
1319      */
1320     public function get_field_sql($sql, array $params=null, $strictness=IGNORE_MISSING) {
1321         if (!$record = $this->get_record_sql($sql, $params, $strictness)) {
1322             return false;
1323         }
1325         $record = (array)$record;
1326         return reset($record); // first column
1327     }
1329     /**
1330      * Selects records and return values of chosen field as an array which match a particular WHERE clause.
1331      *
1332      * @param string $table the table to query.
1333      * @param string $return the field we are intered in
1334      * @param string $select A fragment of SQL to be used in a where clause in the SQL call.
1335      * @param array $params array of sql parameters
1336      * @return array of values
1337      * @throws dml_exception if error
1338      */
1339     public function get_fieldset_select($table, $return, $select, array $params=null) {
1340         if ($select) {
1341             $select = "WHERE $select";
1342         }
1343         return $this->get_fieldset_sql("SELECT $return FROM {" . $table . "} $select", $params);
1344     }
1346     /**
1347      * Selects records and return values (first field) as an array using a SQL statement.
1348      *
1349      * @param string $sql The SQL query
1350      * @param array $params array of sql parameters
1351      * @return array of values
1352      * @throws dml_exception if error
1353      */
1354     public abstract function get_fieldset_sql($sql, array $params=null);
1356     /**
1357      * Insert new record into database, as fast as possible, no safety checks, lobs not supported.
1358      * @param string $table name
1359      * @param mixed $params data record as object or array
1360      * @param bool $returnit return it of inserted record
1361      * @param bool $bulk true means repeated inserts expected
1362      * @param bool $customsequence true if 'id' included in $params, disables $returnid
1363      * @return bool|int true or new id
1364      * @throws dml_exception if error
1365      */
1366     public abstract function insert_record_raw($table, $params, $returnid=true, $bulk=false, $customsequence=false);
1368     /**
1369      * Insert a record into a table and return the "id" field if required.
1370      *
1371      * Some conversions and safety checks are carried out. Lobs are supported.
1372      * If the return ID isn't required, then this just reports success as true/false.
1373      * $data is an object containing needed data
1374      * @param string $table The database table to be inserted into
1375      * @param object $data A data object with values for one or more fields in the record
1376      * @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.
1377      * @return bool|int true or new id
1378      * @throws dml_exception if error
1379      */
1380     public abstract function insert_record($table, $dataobject, $returnid=true, $bulk=false);
1382     /**
1383      * Import a record into a table, id field is required.
1384      * Safety checks are NOT carried out. Lobs are supported.
1385      *
1386      * @param string $table name of database table to be inserted into
1387      * @param object $dataobject A data object with values for one or more fields in the record
1388      * @return bool true
1389      * @throws dml_exception if error
1390      */
1391     public abstract function import_record($table, $dataobject);
1393     /**
1394      * Update record in database, as fast as possible, no safety checks, lobs not supported.
1395      * @param string $table name
1396      * @param mixed $params data record as object or array
1397      * @param bool true means repeated updates expected
1398      * @return bool true
1399      * @throws dml_exception if error
1400      */
1401     public abstract function update_record_raw($table, $params, $bulk=false);
1403     /**
1404      * Update a record in a table
1405      *
1406      * $dataobject is an object containing needed data
1407      * Relies on $dataobject having a variable "id" to
1408      * specify the record to update
1409      *
1410      * @param string $table The database table to be checked against.
1411      * @param object $dataobject An object with contents equal to fieldname=>fieldvalue. Must have an entry for 'id' to map to the table specified.
1412      * @param bool true means repeated updates expected
1413      * @return bool true
1414      * @throws dml_exception if error
1415      */
1416     public abstract function update_record($table, $dataobject, $bulk=false);
1419     /**
1420      * Set a single field in every table record where all the given conditions met.
1421      *
1422      * @param string $table The database table to be checked against.
1423      * @param string $newfield the field to set.
1424      * @param string $newvalue the value to set the field to.
1425      * @param array $conditions optional array $fieldname=>requestedvalue with AND in between
1426      * @return bool true
1427      * @throws dml_exception if error
1428      */
1429     public function set_field($table, $newfield, $newvalue, array $conditions=null) {
1430         list($select, $params) = $this->where_clause($conditions);
1431         return $this->set_field_select($table, $newfield, $newvalue, $select, $params);
1432     }
1434     /**
1435      * Set a single field in every table record which match a particular WHERE clause.
1436      *
1437      * @param string $table The database table to be checked against.
1438      * @param string $newfield the field to set.
1439      * @param string $newvalue the value to set the field to.
1440      * @param string $select A fragment of SQL to be used in a where clause in the SQL call.
1441      * @param array $params array of sql parameters
1442      * @return bool true
1443      * @throws dml_exception if error
1444      */
1445     public abstract function set_field_select($table, $newfield, $newvalue, $select, array $params=null);
1448     /**
1449      * Count the records in a table where all the given conditions met.
1450      *
1451      * @param string $table The table to query.
1452      * @param array $conditions optional array $fieldname=>requestedvalue with AND in between
1453      * @return int The count of records returned from the specified criteria.
1454      * @throws dml_exception if error
1455      */
1456     public function count_records($table, array $conditions=null) {
1457         list($select, $params) = $this->where_clause($conditions);
1458         return $this->count_records_select($table, $select, $params);
1459     }
1461     /**
1462      * Count the records in a table which match a particular WHERE clause.
1463      *
1464      * @param string $table The database table to be checked against.
1465      * @param string $select A fragment of SQL to be used in a WHERE clause in the SQL call.
1466      * @param array $params array of sql parameters
1467      * @param string $countitem The count string to be used in the SQL call. Default is COUNT('x').
1468      * @return int The count of records returned from the specified criteria.
1469      * @throws dml_exception if error
1470      */
1471     public function count_records_select($table, $select, array $params=null, $countitem="COUNT('x')") {
1472         if ($select) {
1473             $select = "WHERE $select";
1474         }
1475         return $this->count_records_sql("SELECT $countitem FROM {" . $table . "} $select", $params);
1476     }
1478     /**
1479      * Get the result of a SQL SELECT COUNT(...) query.
1480      *
1481      * Given a query that counts rows, return that count. (In fact,
1482      * given any query, return the first field of the first record
1483      * returned. However, this method should only be used for the
1484      * intended purpose.) If an error occurs, 0 is returned.
1485      *
1486      * @param string $sql The SQL string you wish to be executed.
1487      * @param array $params array of sql parameters
1488      * @return int the count
1489      * @throws dml_exception if error
1490      */
1491     public function count_records_sql($sql, array $params=null) {
1492         if ($count = $this->get_field_sql($sql, $params)) {
1493             return $count;
1494         } else {
1495             return 0;
1496         }
1497     }
1499     /**
1500      * Test whether a record exists in a table where all the given conditions met.
1501      *
1502      * The record to test is specified by giving up to three fields that must
1503      * equal the corresponding values.
1504      *
1505      * @param string $table The table to check.
1506      * @param array $conditions optional array $fieldname=>requestedvalue with AND in between
1507      * @return bool true if a matching record exists, else false.
1508      * @throws dml_exception if error
1509      */
1510     public function record_exists($table, array $conditions) {
1511         list($select, $params) = $this->where_clause($conditions);
1512         return $this->record_exists_select($table, $select, $params);
1513     }
1515     /**
1516      * Test whether any records exists in a table which match a particular WHERE clause.
1517      *
1518      * @param string $table The database table to be checked against.
1519      * @param string $select A fragment of SQL to be used in a WHERE clause in the SQL call.
1520      * @param array $params array of sql parameters
1521      * @return bool true if a matching record exists, else false.
1522      * @throws dml_exception if error
1523      */
1524     public function record_exists_select($table, $select, array $params=null) {
1525         if ($select) {
1526             $select = "WHERE $select";
1527         }
1528         return $this->record_exists_sql("SELECT 'x' FROM {" . $table . "} $select", $params);
1529     }
1531     /**
1532      * Test whether a SQL SELECT statement returns any records.
1533      *
1534      * This function returns true if the SQL statement executes
1535      * without any errors and returns at least one record.
1536      *
1537      * @param string $sql The SQL statement to execute.
1538      * @param array $params array of sql parameters
1539      * @return bool true if the SQL executes without errors and returns at least one record.
1540      * @throws dml_exception if error
1541      */
1542     public function record_exists_sql($sql, array $params=null) {
1543         if ($mrs = $this->get_recordset_sql($sql, $params, 0, 1)) {
1544             $return = $mrs->valid();
1545             $mrs->close();
1546             return $return;
1547         }
1548         return false;
1549     }
1551     /**
1552      * Delete the records from a table where all the given conditions met.
1553      * If conditions not specified, table is truncated.
1554      *
1555      * @param string $table the table to delete from.
1556      * @param array $conditions optional array $fieldname=>requestedvalue with AND in between
1557      * @return bool true.
1558      * @throws dml_exception if error
1559      */
1560     public function delete_records($table, array $conditions=null) {
1561         if (is_null($conditions)) {
1562             return $this->execute("TRUNCATE TABLE {".$table."}");
1563         }
1564         list($select, $params) = $this->where_clause($conditions);
1565         return $this->delete_records_select($table, $select, $params);
1566     }
1568     /**
1569      * Delete the records from a table where one field match one list of values.
1570      *
1571      * @param string $table the table to delete from.
1572      * @param string $field The field to search
1573      * @param array $values array of values
1574      * @return bool true.
1575      * @throws dml_exception if error
1576      */
1577     public function delete_records_list($table, $field, array $values) {
1578         list($select, $params) = $this->where_clause_list($field, $values);
1579         if (empty($select)) {
1580             // nothing to delete
1581             return true;
1582         }
1583         return $this->delete_records_select($table, $select, $params);
1584     }
1586     /**
1587      * Delete one or more records from a table which match a particular WHERE clause.
1588      *
1589      * @param string $table The database table to be checked against.
1590      * @param string $select A fragment of SQL to be used in a where clause in the SQL call (used to define the selection criteria).
1591      * @param array $params array of sql parameters
1592      * @return bool true.
1593      * @throws dml_exception if error
1594      */
1595     public abstract function delete_records_select($table, $select, array $params=null);
1599 /// sql constructs
1600     /**
1601      * Returns the FROM clause required by some DBs in all SELECT statements.
1602      *
1603      * To be used in queries not having FROM clause to provide cross_db
1604      * Most DBs don't need it, hence the default is ''
1605      * @return string
1606      */
1607     public function sql_null_from_clause() {
1608         return '';
1609     }
1611     /**
1612      * Returns the SQL text to be used in order to perform one bitwise AND operation
1613      * between 2 integers.
1614      *
1615      * NOTE: The SQL result is a number and can not be used directly in
1616      *       SQL condition, please compare it to some number to get a bool!!
1617      *
1618      * @param int $int1 first integer in the operation
1619      * @param int $int2 second integer in the operation
1620      * @return string the piece of SQL code to be used in your statement
1621      */
1622     public function sql_bitand($int1, $int2) {
1623         return '((' . $int1 . ') & (' . $int2 . '))';
1624     }
1626     /**
1627      * Returns the SQL text to be used in order to perform one bitwise NOT operation
1628      * with 1 integer.
1629      *
1630      * @param int $int1 integer in the operation
1631      * @return string the piece of SQL code to be used in your statement.
1632      */
1633     public function sql_bitnot($int1) {
1634         return '(~(' . $int1 . '))';
1635     }
1637     /**
1638      * Returns the SQL text to be used in order to perform one bitwise OR operation
1639      * between 2 integers.
1640      *
1641      * NOTE: The SQL result is a number and can not be used directly in
1642      *       SQL condition, please compare it to some number to get a bool!!
1643      *
1644      * @param int $int1 first integer in the operation
1645      * @param int $int2 second integer in the operation
1646      * @return string the piece of SQL code to be used in your statement.
1647      */
1648     public function sql_bitor($int1, $int2) {
1649         return '((' . $int1 . ') | (' . $int2 . '))';
1650     }
1652     /**
1653      * Returns the SQL text to be used in order to perform one bitwise XOR operation
1654      * between 2 integers.
1655      *
1656      * NOTE: The SQL result is a number and can not be used directly in
1657      *       SQL condition, please compare it to some number to get a bool!!
1658      *
1659      * @param int $int1 first integer in the operation
1660      * @param int $int2 second integer in the operation
1661      * @return string the piece of SQL code to be used in your statement.
1662      */
1663     public function sql_bitxor($int1, $int2) {
1664         return '((' . $int1 . ') ^ (' . $int2 . '))';
1665     }
1667     /**
1668      * Returns the SQL text to be used in order to perform module '%'
1669      * operation - remainder after division
1670      *
1671      * @param int $int1 first integer in the operation
1672      * @param int $int2 second integer in the operation
1673      * @return string the piece of SQL code to be used in your statement.
1674      */
1675     public function sql_modulo($int1, $int2) {
1676         return '((' . $int1 . ') % (' . $int2 . '))';
1677     }
1679     /**
1680      * Returns the correct CEIL expression applied to fieldname.
1681      *
1682      * @param string $fieldname the field (or expression) we are going to ceil
1683      * @return string the piece of SQL code to be used in your ceiling statement
1684      * Most DB use CEIL(), hence it's the default.
1685      */
1686     public function sql_ceil($fieldname) {
1687         return ' CEIL(' . $fieldname . ')';
1688     }
1690     /**
1691      * Returns the SQL to be used in order to CAST one CHAR column to INTEGER.
1692      *
1693      * Be aware that the CHAR column you're trying to cast contains really
1694      * int values or the RDBMS will throw an error!
1695      *
1696      * @param string $fieldname the name of the field to be casted
1697      * @param bool $text to specify if the original column is one TEXT (CLOB) column (true). Defaults to false.
1698      * @return string the piece of SQL code to be used in your statement.
1699      */
1700     public function sql_cast_char2int($fieldname, $text=false) {
1701         return ' ' . $fieldname . ' ';
1702     }
1704     /**
1705      * Returns the SQL to be used in order to CAST one CHAR column to REAL number.
1706      *
1707      * Be aware that the CHAR column you're trying to cast contains really
1708      * numbers or the RDBMS will throw an error!
1709      *
1710      * @param string $fieldname the name of the field to be casted
1711      * @param bool $text to specify if the original column is one TEXT (CLOB) column (true). Defaults to false.
1712      * @return string the piece of SQL code to be used in your statement.
1713      */
1714     public function sql_cast_char2real($fieldname, $text=false) {
1715         return ' ' . $fieldname . ' ';
1716     }
1718     /**
1719      * Returns the SQL to be used in order to an UNSIGNED INTEGER column to SIGNED.
1720      *
1721      * (Only MySQL needs this. MySQL things that 1 * -1 = 18446744073709551615
1722      * if the 1 comes from an unsigned column).
1723      *
1724      * @param string $fieldname the name of the field to be cast
1725      * @return string the piece of SQL code to be used in your statement.
1726      */
1727     public function sql_cast_2signed($fieldname) {
1728         return ' ' . $fieldname . ' ';
1729     }
1731     /**
1732      * Returns the SQL text to be used to compare one TEXT (clob) column with
1733      * one varchar column, because some RDBMS doesn't support such direct
1734      * comparisons.
1735      *
1736      * @param string $fieldname the name of the TEXT field we need to order by
1737      * @param int $numchars of chars to use for the ordering (defaults to 32)
1738      * @return string the piece of SQL code to be used in your statement.
1739      */
1740     public function sql_compare_text($fieldname, $numchars=32) {
1741         return $this->sql_order_by_text($fieldname, $numchars);
1742     }
1744     /**
1745      * Case and collation sensitive string 'string = string'
1746      * @param string $string1
1747      * @param string $string2
1748      * @return string SQL fragment
1749      */
1750     public function sql_binary_equal($string1, $string2) {
1751         return "$string1 = $string2";
1752     }
1754     /**
1755      * Returns 'LIKE' part of a query.
1756      *
1757      * @param string $fieldname usually name of the table column
1758      * @param string $param usually bound query parameter (?, :named)
1759      * @param bool $casesensitive use case sensitive search
1760      * @param bool $accensensitive use accent sensitive search (not all databases support accent insensitive)
1761      * @param string $escapechar escape char for '%' and '_'
1762      * @return string SQL code fragment
1763      */
1764     public function sql_like($fieldname, $param, $casesensitive = true, $accentsensitive = true, $escapechar = '\\') {
1765         if (strpos($param, '%') !== false) {
1766             debugging('Potential SQL injection detected, sql_ilike() expects bound parameters (? or :named)');
1767         }
1768         // by default ignore any sensitiveness - each database does it in a different way
1769         return "$fieldname LIKE $param ESCAPE '$escapechar'";
1770     }
1772     /**
1773      * Escape sql LIKE special characters.
1774      * @param string $text
1775      * @param string $escapechar
1776      * @return string
1777      */
1778     public function sql_like_escape($text, $escapechar = '\\') {
1779         $text = str_replace('_', $escapechar.'_', $text);
1780         $text = str_replace('%', $escapechar.'%', $text);
1781         return $text;
1782     }
1784     /**
1785      * Returns the proper SQL to do LIKE in a case-insensitive way.
1786      *
1787      * Note the LIKE are case sensitive for Oracle. Oracle 10g is required to use
1788      * the case insensitive search using regexp_like() or NLS_COMP=LINGUISTIC :-(
1789      * See http://docs.moodle.org/en/XMLDB_Problems#Case-insensitive_searches
1790      *
1791      * @deprecated
1792      * @return string
1793      */
1794     public function sql_ilike() {
1795         //TODO: debugging('sql_ilike() is deprecated, please use sql_like() instead');
1796         return 'LIKE';
1797     }
1799     /**
1800      * Returns the proper SQL to do CONCAT between the elements passed
1801      * Can take many parameters
1802      *
1803      * This function accepts variable number of string parameters.
1804      *
1805      * @return string
1806      */
1807     public abstract function sql_concat();
1809     /**
1810      * Returns the proper SQL to do CONCAT between the elements passed
1811      * with a given separator
1812      *
1813      * @param string $separator
1814      * @param array  $elements
1815      * @return string
1816      */
1817     public abstract function sql_concat_join($separator="' '", $elements=array());
1819     /**
1820      * Returns the proper SQL (for the dbms in use) to concatenate $firstname and $lastname
1821      * TODO: Does this really need to be here? Eloy 20070727.
1822      * TODO: we definitely do not! (skodak)
1823      *
1824      * @param string $first User's first name
1825      * @param string $last User's last name
1826      * @return string
1827      */
1828     function sql_fullname($first='firstname', $last='lastname') {
1829         return $this->sql_concat($first, "' '", $last);
1830     }
1832     /**
1833      * Returns the SQL text to be used to order by one TEXT (clob) column, because
1834      * some RDBMS doesn't support direct ordering of such fields.
1835      *
1836      * Note that the use or queries being ordered by TEXT columns must be minimised,
1837      * because it's really slooooooow.
1838      *
1839      * @param string $fieldname the name of the TEXT field we need to order by
1840      * @param string $numchars of chars to use for the ordering (defaults to 32)
1841      * @return string the piece of SQL code to be used in your statement.
1842      */
1843     public function sql_order_by_text($fieldname, $numchars=32) {
1844         return $fieldname;
1845     }
1847     /**
1848      * Returns the SQL text to be used to calculate the length in characters of one expression.
1849      * @param string $fieldname or expression to calculate its length in characters.
1850      * @return string the piece of SQL code to be used in the statement.
1851      */
1852     public function sql_length($fieldname) {
1853         return ' LENGTH(' . $fieldname . ')';
1854     }
1856     /**
1857      * Returns the proper substr() SQL text used to extract substrings from DB
1858      * NOTE: this was originally returning only function name
1859      *
1860      * @param string $expr some string field, no aggregates
1861      * @param mixed $start integer or expression evaluating to int (1 based value; first char has index 1)
1862      * @param mixed $length optional integer or expression evaluating to int
1863      * @return string sql fragment
1864      */
1865     public function sql_substr($expr, $start, $length=false) {
1866         if (count(func_get_args()) < 2) {
1867             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.');
1868         }
1869         if ($length === false) {
1870             return "SUBSTR($expr, $start)";
1871         } else {
1872             return "SUBSTR($expr, $start, $length)";
1873         }
1874     }
1876     /**
1877      * Returns the SQL for returning searching one string for the location of another.
1878      * Note, there is no guarantee which order $needle, $haystack will be in
1879      * the resulting SQL, so when using this method, and both arguments contain
1880      * placeholders, you should use named placeholders.
1881      * @param string $needle the SQL expression that will be searched for.
1882      * @param string $haystack the SQL expression that will be searched in.
1883      * @return string the required SQL
1884      */
1885     public function sql_position($needle, $haystack) {
1886         // Implementation using standard SQL.
1887         return "POSITION(($needle) IN ($haystack))";
1888     }
1890     /**
1891      * Returns the empty string char used by every supported DB. To be used when
1892      * we are searching for that values in our queries. Only Oracle uses this
1893      * for now (will be out, once we migrate to proper NULLs if that days arrives)
1894      * @return string
1895      */
1896     function sql_empty() {
1897         return '';
1898     }
1900     /**
1901      * Returns the proper SQL to know if one field is empty.
1902      *
1903      * Note that the function behavior strongly relies on the
1904      * parameters passed describing the field so, please,  be accurate
1905      * when specifying them.
1906      *
1907      * Also, note that this function is not suitable to look for
1908      * fields having NULL contents at all. It's all for empty values!
1909      *
1910      * This function should be applied in all the places where conditions of
1911      * the type:
1912      *
1913      *     ... AND fieldname = '';
1914      *
1915      * are being used. Final result should be:
1916      *
1917      *     ... AND ' . sql_isempty('tablename', 'fieldname', true/false, true/false);
1918      *
1919      * (see parameters description below)
1920      *
1921      * @param string $tablename name of the table (without prefix). Not used for now but can be
1922      *                          necessary in the future if we want to use some introspection using
1923      *                          meta information against the DB. /// TODO ///
1924      * @param string $fieldname name of the field we are going to check
1925      * @param boolean $nullablefield to specify if the field us nullable (true) or no (false) in the DB
1926      * @param boolean $textfield to specify if it is a text (also called clob) field (true) or a varchar one (false)
1927      * @return string the sql code to be added to check for empty values
1928      */
1929     public function sql_isempty($tablename, $fieldname, $nullablefield, $textfield) {
1930         return " ($fieldname = '') ";
1931     }
1933     /**
1934      * Returns the proper SQL to know if one field is not empty.
1935      *
1936      * Note that the function behavior strongly relies on the
1937      * parameters passed describing the field so, please,  be accurate
1938      * when specifying them.
1939      *
1940      * This function should be applied in all the places where conditions of
1941      * the type:
1942      *
1943      *     ... AND fieldname != '';
1944      *
1945      * are being used. Final result should be:
1946      *
1947      *     ... AND ' . sql_isnotempty('tablename', 'fieldname', true/false, true/false);
1948      *
1949      * (see parameters description below)
1950      *
1951      * @param string $tablename name of the table (without prefix). Not used for now but can be
1952      *                          necessary in the future if we want to use some introspection using
1953      *                          meta information against the DB. /// TODO ///
1954      * @param string $fieldname name of the field we are going to check
1955      * @param boolean $nullablefield to specify if the field us nullable (true) or no (false) in the DB
1956      * @param boolean $textfield to specify if it is a text (also called clob) field (true) or a varchar one (false)
1957      * @return string the sql code to be added to check for non empty values
1958      */
1959     public function sql_isnotempty($tablename, $fieldname, $nullablefield, $textfield) {
1960         return ' ( NOT ' . $this->sql_isempty($tablename, $fieldname, $nullablefield, $textfield) . ') ';
1961     }
1963     /**
1964      * Does this driver suppoer regex syntax when searching
1965      * @return bool
1966      */
1967     public function sql_regex_supported() {
1968         return false;
1969     }
1971     /**
1972      * Return regex positive or negative match sql
1973      * @param bool $positivematch
1974      * @return string or empty if not supported
1975      */
1976     public function sql_regex($positivematch=true) {
1977         return '';
1978     }
1980 /// transactions
1982     /**
1983      * Are transactions supported?
1984      * It is not responsible to run productions servers
1985      * on databases without transaction support ;-)
1986      *
1987      * Override in driver if needed.
1988      *
1989      * @return bool
1990      */
1991     protected function transactions_supported() {
1992         // protected for now, this might be changed to public if really necessary
1993         return true;
1994     }
1996     /**
1997      * Returns true if transaction in progress
1998      * @return bool
1999      */
2000     public function is_transaction_started() {
2001         return !empty($this->transactions);
2002     }
2004     /**
2005      * Throws exception if transaction in progress.
2006      * This test does not force rollback of active transactions.
2007      * @return void
2008      */
2009     public function transactions_forbidden() {
2010         if ($this->is_transaction_started()) {
2011             throw new dml_transaction_exception('This code can not be excecuted in transaction');
2012         }
2013     }
2015     /**
2016      * On DBs that support it, switch to transaction mode and begin a transaction
2017      * you'll need to ensure you call allow_commit() on the returned object
2018      * or your changes *will* be lost.
2019      *
2020      * this is _very_ useful for massive updates
2021      *
2022      * Delegated database transactions can be nested, but only one actual database
2023      * transaction is used for the outer-most delegated transaction. This method
2024      * returns a transaction object which you should keep until the end of the
2025      * delegated transaction. The actual database transaction will
2026      * only be committed if all the nested delegated transactions commit
2027      * successfully. If any part of the transaction rolls back then the whole
2028      * thing is rolled back.
2029      *
2030      * @return moodle_transaction
2031      */
2032     public function start_delegated_transaction() {
2033         $transaction = new moodle_transaction($this);
2034         $this->transactions[] = $transaction;
2035         if (count($this->transactions) == 1) {
2036             $this->begin_transaction();
2037         }
2038         return $transaction;
2039     }
2041     /**
2042      * Driver specific start of real database transaction,
2043      * this can not be used directly in code.
2044      * @return void
2045      */
2046     protected abstract function begin_transaction();
2048     /**
2049      * Indicates delegated transaction finished successfully.
2050      * The real database transaction is committed only if
2051      * all delegated transactions committed.
2052      * @return void
2053      */
2054     public function commit_delegated_transaction(moodle_transaction $transaction) {
2055         if ($transaction->is_disposed()) {
2056             throw new dml_transaction_exception('Transactions already disposed', $transaction);
2057         }
2058         // mark as disposed so that it can not be used again
2059         $transaction->dispose();
2061         if (empty($this->transactions)) {
2062             throw new dml_transaction_exception('Transaction not started', $transaction);
2063         }
2065         if ($this->force_rollback) {
2066             throw new dml_transaction_exception('Tried to commit transaction after lower level rollback', $transaction);
2067         }
2069         if ($transaction !== $this->transactions[count($this->transactions) - 1]) {
2070             // one incorrect commit at any level rollbacks everything
2071             $this->force_rollback = true;
2072             throw new dml_transaction_exception('Invalid transaction commit attempt', $transaction);
2073         }
2075         if (count($this->transactions) == 1) {
2076             // only commit the top most level
2077             $this->commit_transaction();
2078         }
2079         array_pop($this->transactions);
2080     }
2082     /**
2083      * Driver specific commit of real database transaction,
2084      * this can not be used directly in code.
2085      * @return void
2086      */
2087     protected abstract function commit_transaction();
2089     /**
2090      * Call when delegated transaction failed, this rolls back
2091      * all delegated transactions up to the top most level.
2092      *
2093      * In many cases you do not need to call this method manually,
2094      * because all open delegated transactions are rolled back
2095      * automatically if exceptions not caught.
2096      *
2097      * @param moodle_transaction $transaction
2098      * @param Exception $e exception that caused the problem
2099      * @return void - does not return, exception is rethrown
2100      */
2101     public function rollback_delegated_transaction(moodle_transaction $transaction, Exception $e) {
2102         if ($transaction->is_disposed()) {
2103             throw new dml_transaction_exception('Transactions already disposed', $transaction);
2104         }
2105         // mark as disposed so that it can not be used again
2106         $transaction->dispose();
2108         // one rollback at any level rollbacks everything
2109         $this->force_rollback = true;
2111         if (empty($this->transactions) or $transaction !== $this->transactions[count($this->transactions) - 1]) {
2112             // this may or may not be a coding problem, better just rethrow the exception,
2113             // because we do not want to loose the original $e
2114             throw $e;
2115         }
2117         if (count($this->transactions) == 1) {
2118             // only rollback the top most level
2119             $this->rollback_transaction();
2120         }
2121         array_pop($this->transactions);
2122         if (empty($this->transactions)) {
2123             // finally top most level rolled back
2124             $this->force_rollback = false;
2125         }
2126         throw $e;
2127     }
2129     /**
2130      * Driver specific abort of real database transaction,
2131      * this can not be used directly in code.
2132      * @return void
2133      */
2134     protected abstract function rollback_transaction();
2136     /**
2137      * Force rollback of all delegated transaction.
2138      * Does not trow any exceptions and does not log anything.
2139      *
2140      * This method should be used only from default exception handlers and other
2141      * core code.
2142      *
2143      * @return void
2144      */
2145     public function force_transaction_rollback() {
2146         if ($this->transactions) {
2147             try {
2148                 $this->rollback_transaction();
2149             } catch (dml_exception $e) {
2150                 // ignore any sql errors here, the connection might be broken
2151             }
2152         }
2154         // now enable transactions again
2155         $this->transactions = array(); // unfortunately all unfinished exceptions are kept in memory
2156         $this->force_rollback = false;
2157     }
2159 /// session locking
2160     /**
2161      * Is session lock supported in this driver?
2162      * @return bool
2163      */
2164     public function session_lock_supported() {
2165         return false;
2166     }
2168     /**
2169      * Obtain session lock
2170      * @param int $rowid id of the row with session record
2171      * @return bool success
2172      */
2173     public function get_session_lock($rowid) {
2174         $this->used_for_db_sessions = true;
2175     }
2177     /**
2178      * Release session lock
2179      * @param int $rowid id of the row with session record
2180      * @return bool success
2181      */
2182     public function release_session_lock($rowid) {
2183     }
2185 /// performance and logging
2186     /**
2187      * Returns number of reads done by this database
2188      * @return int
2189      */
2190     public function perf_get_reads() {
2191         return $this->reads;
2192     }
2194     /**
2195      * Returns number of writes done by this database
2196      * @return int
2197      */
2198     public function perf_get_writes() {
2199         return $this->writes;
2200     }
2202     /**
2203      * Returns number of queries done by this database
2204      * @return int
2205      */
2206     public function perf_get_queries() {
2207         return $this->writes + $this->reads;
2208     }