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