MDL-30979 output: Further changes are validation
[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         // We accept nulls in conditions
499         $conditions = is_null($conditions) ? array() : $conditions;
500         // Some checks performed under debugging only
501         if (debugging()) {
502             $columns = $this->get_columns($table);
503             if (empty($columns)) {
504                 // no supported columns means most probably table does not exist
505                 throw new dml_exception('ddltablenotexist', $table);
506             }
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         $allowed_types = $this->allowed_param_types();
523         if (empty($conditions)) {
524             return array('', array());
525         }
526         $where = array();
527         $params = array();
529         foreach ($conditions as $key=>$value) {
530             if (is_int($key)) {
531                 throw new dml_exception('invalidnumkey');
532             }
533             if (is_null($value)) {
534                 $where[] = "$key IS NULL";
535             } else {
536                 if ($allowed_types & SQL_PARAMS_NAMED) {
537                     // Need to verify key names because they can contain, originally,
538                     // spaces and other forbidden chars when using sql_xxx() functions and friends.
539                     $normkey = trim(preg_replace('/[^a-zA-Z0-9_-]/', '_', $key), '-_');
540                     if ($normkey !== $key) {
541                         debugging('Invalid key found in the conditions array.');
542                     }
543                     $where[] = "$key = :$normkey";
544                     $params[$normkey] = $value;
545                 } else {
546                     $where[] = "$key = ?";
547                     $params[] = $value;
548                 }
549             }
550         }
551         $where = implode(" AND ", $where);
552         return array($where, $params);
553     }
555     /**
556      * Returns SQL WHERE conditions for the ..._list methods.
557      *
558      * @param string $field the name of a field.
559      * @param array $values the values field might take.
560      * @return array sql part and params
561      */
562     protected function where_clause_list($field, array $values) {
563         $params = array();
564         $select = array();
565         $values = (array)$values;
566         foreach ($values as $value) {
567             if (is_bool($value)) {
568                 $value = (int)$value;
569             }
570             if (is_null($value)) {
571                 $select[] = "$field IS NULL";
572             } else {
573                 $select[] = "$field = ?";
574                 $params[] = $value;
575             }
576         }
577         $select = implode(" OR ", $select);
578         return array($select, $params);
579     }
581     /**
582      * Constructs IN() or = sql fragment
583      * @param mixed $items single or array of values
584      * @param int $type bound param type SQL_PARAMS_QM or SQL_PARAMS_NAMED
585      * @param string $prefix named parameter placeholder prefix (unique counter value is appended to each parameter name)
586      * @param bool $equal true means equal, false not equal
587      * @param mixed $onemptyitems defines the behavior when the array of items is empty. Defaults to false,
588      *              meaning throw exceptions. Other values will become part of the returned SQL fragment.
589      * @return array - $sql and $params
590      */
591     public function get_in_or_equal($items, $type=SQL_PARAMS_QM, $prefix='param', $equal=true, $onemptyitems=false) {
593         // default behavior, throw exception on empty array
594         if (is_array($items) and empty($items) and $onemptyitems === false) {
595             throw new coding_exception('moodle_database::get_in_or_equal() does not accept empty arrays');
596         }
597         // handle $onemptyitems on empty array of items
598         if (is_array($items) and empty($items)) {
599             if (is_null($onemptyitems)) {             // Special case, NULL value
600                 $sql = $equal ? ' IS NULL' : ' IS NOT NULL';
601                 return (array($sql, array()));
602             } else {
603                 $items = array($onemptyitems);        // Rest of cases, prepare $items for std processing
604             }
605         }
607         if ($type == SQL_PARAMS_QM) {
608             if (!is_array($items) or count($items) == 1) {
609                 $sql = $equal ? '= ?' : '<> ?';
610                 $items = (array)$items;
611                 $params = array_values($items);
612             } else {
613                 if ($equal) {
614                     $sql = 'IN ('.implode(',', array_fill(0, count($items), '?')).')';
615                 } else {
616                     $sql = 'NOT IN ('.implode(',', array_fill(0, count($items), '?')).')';
617                 }
618                 $params = array_values($items);
619             }
621         } else if ($type == SQL_PARAMS_NAMED) {
622             if (empty($prefix)) {
623                 $prefix = 'param';
624             }
626             if (!is_array($items)){
627                 $param = $prefix.$this->inorequaluniqueindex++;
628                 $sql = $equal ? "= :$param" : "<> :$param";
629                 $params = array($param=>$items);
630             } else if (count($items) == 1) {
631                 $param = $prefix.$this->inorequaluniqueindex++;
632                 $sql = $equal ? "= :$param" : "<> :$param";
633                 $item = reset($items);
634                 $params = array($param=>$item);
635             } else {
636                 $params = array();
637                 $sql = array();
638                 foreach ($items as $item) {
639                     $param = $prefix.$this->inorequaluniqueindex++;
640                     $params[$param] = $item;
641                     $sql[] = ':'.$param;
642                 }
643                 if ($equal) {
644                     $sql = 'IN ('.implode(',', $sql).')';
645                 } else {
646                     $sql = 'NOT IN ('.implode(',', $sql).')';
647                 }
648             }
650         } else {
651             throw new dml_exception('typenotimplement');
652         }
653         return array($sql, $params);
654     }
656     /**
657      * Converts short table name {tablename} to real table name
658      * @param string sql
659      * @return string sql
660      */
661     protected function fix_table_names($sql) {
662         return preg_replace('/\{([a-z][a-z0-9_]*)\}/', $this->prefix.'$1', $sql);
663     }
665     /** Internal function */
666     private function _fix_sql_params_dollar_callback($match) {
667         $this->fix_sql_params_i++;
668         return "\$".$this->fix_sql_params_i;
669     }
671     /**
672      * Normalizes sql query parameters and verifies parameters.
673      * @param string $sql query or part of it
674      * @param array $params query parameters
675      * @return array (sql, params, type of params)
676      */
677     public function fix_sql_params($sql, array $params=null) {
678         $params = (array)$params; // mke null array if needed
679         $allowed_types = $this->allowed_param_types();
681         // convert table names
682         $sql = $this->fix_table_names($sql);
684         // cast booleans to 1/0 int
685         foreach ($params as $key => $value) {
686             $params[$key] = is_bool($value) ? (int)$value : $value;
687         }
689         // NICOLAS C: Fixed regexp for negative backwards lookahead of double colons. Thanks for Sam Marshall's help
690         $named_count = preg_match_all('/(?<!:):[a-z][a-z0-9_]*/', $sql, $named_matches); // :: used in pgsql casts
691         $dollar_count = preg_match_all('/\$[1-9][0-9]*/', $sql, $dollar_matches);
692         $q_count     = substr_count($sql, '?');
694         $count = 0;
696         if ($named_count) {
697             $type = SQL_PARAMS_NAMED;
698             $count = $named_count;
700         }
701         if ($dollar_count) {
702             if ($count) {
703                 throw new dml_exception('mixedtypesqlparam');
704             }
705             $type = SQL_PARAMS_DOLLAR;
706             $count = $dollar_count;
708         }
709         if ($q_count) {
710             if ($count) {
711                 throw new dml_exception('mixedtypesqlparam');
712             }
713             $type = SQL_PARAMS_QM;
714             $count = $q_count;
716         }
718         if (!$count) {
719              // ignore params
720             if ($allowed_types & SQL_PARAMS_NAMED) {
721                 return array($sql, array(), SQL_PARAMS_NAMED);
722             } else if ($allowed_types & SQL_PARAMS_QM) {
723                 return array($sql, array(), SQL_PARAMS_QM);
724             } else {
725                 return array($sql, array(), SQL_PARAMS_DOLLAR);
726             }
727         }
729         if ($count > count($params)) {
730             $a = new stdClass;
731             $a->expected = $count;
732             $a->actual = count($params);
733             throw new dml_exception('invalidqueryparam', $a);
734         }
736         $target_type = $allowed_types;
738         if ($type & $allowed_types) { // bitwise AND
739             if ($count == count($params)) {
740                 if ($type == SQL_PARAMS_QM) {
741                     return array($sql, array_values($params), SQL_PARAMS_QM); // 0-based array required
742                 } else {
743                     //better do the validation of names below
744                 }
745             }
746             // needs some fixing or validation - there might be more params than needed
747             $target_type = $type;
748         }
750         if ($type == SQL_PARAMS_NAMED) {
751             $finalparams = array();
752             foreach ($named_matches[0] as $key) {
753                 $key = trim($key, ':');
754                 if (!array_key_exists($key, $params)) {
755                     throw new dml_exception('missingkeyinsql', $key, '');
756                 }
757                 if (strlen($key) > 30) {
758                     throw new coding_exception(
759                             "Placeholder names must be 30 characters or shorter. '" .
760                             $key . "' is too long.", $sql);
761                 }
762                 $finalparams[$key] = $params[$key];
763             }
764             if ($count != count($finalparams)) {
765                 throw new dml_exception('duplicateparaminsql');
766             }
768             if ($target_type & SQL_PARAMS_QM) {
769                 $sql = preg_replace('/(?<!:):[a-z][a-z0-9_]*/', '?', $sql);
770                 return array($sql, array_values($finalparams), SQL_PARAMS_QM); // 0-based required
771             } else if ($target_type & SQL_PARAMS_NAMED) {
772                 return array($sql, $finalparams, SQL_PARAMS_NAMED);
773             } else {  // $type & SQL_PARAMS_DOLLAR
774                 //lambda-style functions eat memory - we use globals instead :-(
775                 $this->fix_sql_params_i = 0;
776                 $sql = preg_replace_callback('/(?<!:):[a-z][a-z0-9_]*/', array($this, '_fix_sql_params_dollar_callback'), $sql);
777                 return array($sql, array_values($finalparams), SQL_PARAMS_DOLLAR); // 0-based required
778             }
780         } else if ($type == SQL_PARAMS_DOLLAR) {
781             if ($target_type & SQL_PARAMS_DOLLAR) {
782                 return array($sql, array_values($params), SQL_PARAMS_DOLLAR); // 0-based required
783             } else if ($target_type & SQL_PARAMS_QM) {
784                 $sql = preg_replace('/\$[0-9]+/', '?', $sql);
785                 return array($sql, array_values($params), SQL_PARAMS_QM); // 0-based required
786             } else { //$target_type & SQL_PARAMS_NAMED
787                 $sql = preg_replace('/\$([0-9]+)/', ':param\\1', $sql);
788                 $finalparams = array();
789                 foreach ($params as $key=>$param) {
790                     $key++;
791                     $finalparams['param'.$key] = $param;
792                 }
793                 return array($sql, $finalparams, SQL_PARAMS_NAMED);
794             }
796         } else { // $type == SQL_PARAMS_QM
797             if (count($params) != $count) {
798                 $params = array_slice($params, 0, $count);
799             }
801             if ($target_type & SQL_PARAMS_QM) {
802                 return array($sql, array_values($params), SQL_PARAMS_QM); // 0-based required
803             } else if ($target_type & SQL_PARAMS_NAMED) {
804                 $finalparams = array();
805                 $pname = 'param0';
806                 $parts = explode('?', $sql);
807                 $sql = array_shift($parts);
808                 foreach ($parts as $part) {
809                     $param = array_shift($params);
810                     $pname++;
811                     $sql .= ':'.$pname.$part;
812                     $finalparams[$pname] = $param;
813                 }
814                 return array($sql, $finalparams, SQL_PARAMS_NAMED);
815             } else {  // $type & SQL_PARAMS_DOLLAR
816                 //lambda-style functions eat memory - we use globals instead :-(
817                 $this->fix_sql_params_i = 0;
818                 $sql = preg_replace_callback('/\?/', array($this, '_fix_sql_params_dollar_callback'), $sql);
819                 return array($sql, array_values($params), SQL_PARAMS_DOLLAR); // 0-based required
820             }
821         }
822     }
824     /**
825      * Return tables in database WITHOUT current prefix
826      * @return array of table names in lowercase and without prefix
827      */
828     public abstract function get_tables($usecache=true);
830     /**
831      * Return table indexes - everything lowercased
832      * @return array of arrays
833      */
834     public abstract function get_indexes($table);
836     /**
837      * Returns detailed information about columns in table. This information is cached internally.
838      * @param string $table name
839      * @param bool $usecache
840      * @return array of database_column_info objects indexed with column names
841      */
842     public abstract function get_columns($table, $usecache=true);
844     /**
845      * Normalise values based in RDBMS dependencies (booleans, LOBs...)
846      *
847      * @param database_column_info $column column metadata corresponding with the value we are going to normalise
848      * @param mixed $value value we are going to normalise
849      * @return mixed the normalised value
850      */
851     protected abstract function normalise_value($column, $value);
853     /**
854      * Reset internal column details cache
855      * @param string $table - empty means all, or one if name of table given
856      * @return void
857      */
858     public function reset_caches() {
859         $this->columns = array();
860         $this->tables  = null;
861     }
863     /**
864      * Returns sql generator used for db manipulation.
865      * Used mostly in upgrade.php scripts.
866      * @return database_manager instance
867      */
868     public function get_manager() {
869         global $CFG;
871         if (!$this->database_manager) {
872             require_once($CFG->libdir.'/ddllib.php');
874             $classname = $this->get_dbfamily().'_sql_generator';
875             require_once("$CFG->libdir/ddl/$classname.php");
876             $generator = new $classname($this, $this->temptables);
878             $this->database_manager = new database_manager($this, $generator);
879         }
880         return $this->database_manager;
881     }
883     /**
884      * Attempt to change db encoding toUTF-8 if possible
885      * @return bool success
886      */
887     public function change_db_encoding() {
888         return false;
889     }
891     /**
892      * Is db in unicode mode?
893      * @return bool
894      */
895     public function setup_is_unicodedb() {
896         return true;
897     }
899     /**
900      * Enable/disable very detailed debugging
901      * @param bool $state
902      * @return void
903      */
904     public function set_debug($state) {
905         $this->debug = $state;
906     }
908     /**
909      * Returns debug status
910      * @return bool $state
911      */
912     public function get_debug() {
913         return $this->debug;
914     }
916     /**
917      * Enable/disable detailed sql logging
918      * @param bool $state
919      */
920     public function set_logging($state) {
921         // adodb sql logging shares one table without prefix per db - this is no longer acceptable :-(
922         // we must create one table shared by all drivers
923     }
925     /**
926      * Do NOT use in code, to be used by database_manager only!
927      * @param string $sql query
928      * @return bool true
929      * @throws dml_exception if error
930      */
931     public abstract function change_database_structure($sql);
933     /**
934      * Execute general sql query. Should be used only when no other method suitable.
935      * Do NOT use this to make changes in db structure, use database_manager::execute_sql() instead!
936      * @param string $sql query
937      * @param array $params query parameters
938      * @return bool true
939      * @throws dml_exception if error
940      */
941     public abstract function execute($sql, array $params=null);
943     /**
944      * Get a number of records as a moodle_recordset where all the given conditions met.
945      *
946      * Selects records from the table $table.
947      *
948      * If specified, only records meeting $conditions.
949      *
950      * If specified, the results will be sorted as specified by $sort. This
951      * is added to the SQL as "ORDER BY $sort". Example values of $sort
952      * might be "time ASC" or "time DESC".
953      *
954      * If $fields is specified, only those fields are returned.
955      *
956      * Since this method is a little less readable, use of it should be restricted to
957      * code where it's possible there might be large datasets being returned.  For known
958      * small datasets use get_records - it leads to simpler code.
959      *
960      * If you only want some of the records, specify $limitfrom and $limitnum.
961      * The query will skip the first $limitfrom records (according to the sort
962      * order) and then return the next $limitnum records. If either of $limitfrom
963      * or $limitnum is specified, both must be present.
964      *
965      * The return value is a moodle_recordset
966      * if the query succeeds. If an error occurs, false is returned.
967      *
968      * @param string $table the table to query.
969      * @param array $conditions optional array $fieldname=>requestedvalue with AND in between
970      * @param string $sort an order to sort the results in (optional, a valid SQL ORDER BY parameter).
971      * @param string $fields a comma separated list of fields to return (optional, by default all fields are returned).
972      * @param int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
973      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
974      * @return moodle_recordset instance
975      * @throws dml_exception if error
976      */
977     public function get_recordset($table, array $conditions=null, $sort='', $fields='*', $limitfrom=0, $limitnum=0) {
978         list($select, $params) = $this->where_clause($table, $conditions);
979         return $this->get_recordset_select($table, $select, $params, $sort, $fields, $limitfrom, $limitnum);
980     }
982     /**
983      * Get a number of records as a moodle_recordset where one field match one list of values.
984      *
985      * Only records where $field takes one of the values $values are returned.
986      * $values must be an array of values.
987      *
988      * Other arguments and the return type as for @see function get_recordset.
989      *
990      * @param string $table the table to query.
991      * @param string $field a field to check (optional).
992      * @param array $values array of values the field must have
993      * @param string $sort an order to sort the results in (optional, a valid SQL ORDER BY parameter).
994      * @param string $fields a comma separated list of fields to return (optional, by default all fields are returned).
995      * @param int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
996      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
997      * @return moodle_recordset instance
998      * @throws dml_exception if error
999      */
1000     public function get_recordset_list($table, $field, array $values, $sort='', $fields='*', $limitfrom=0, $limitnum=0) {
1001         list($select, $params) = $this->where_clause_list($field, $values);
1002         if (empty($select)) {
1003             $select = '1 = 2'; /// Fake condition, won't return rows ever. MDL-17645
1004             $params = array();
1005         }
1006         return $this->get_recordset_select($table, $select, $params, $sort, $fields, $limitfrom, $limitnum);
1007     }
1009     /**
1010      * Get a number of records as a moodle_recordset which match a particular WHERE clause.
1011      *
1012      * If given, $select is used as the SELECT parameter in the SQL query,
1013      * otherwise all records from the table are returned.
1014      *
1015      * Other arguments and the return type as for @see function get_recordset.
1016      *
1017      * @param string $table the table to query.
1018      * @param string $select A fragment of SQL to be used in a where clause in the SQL call.
1019      * @param array $params array of sql parameters
1020      * @param string $sort an order to sort the results in (optional, a valid SQL ORDER BY parameter).
1021      * @param string $fields a comma separated list of fields to return (optional, by default all fields are returned).
1022      * @param int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
1023      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
1024      * @return moodle_recordset instance
1025      * @throws dml_exception if error
1026      */
1027     public function get_recordset_select($table, $select, array $params=null, $sort='', $fields='*', $limitfrom=0, $limitnum=0) {
1028         $sql = "SELECT $fields FROM {".$table."}";
1029         if ($select) {
1030             $sql .= " WHERE $select";
1031         }
1032         if ($sort) {
1033             $sql .= " ORDER BY $sort";
1034         }
1035         return $this->get_recordset_sql($sql, $params, $limitfrom, $limitnum);
1036     }
1038     /**
1039      * Get a number of records as a moodle_recordset using a SQL statement.
1040      *
1041      * Since this method is a little less readable, use of it should be restricted to
1042      * code where it's possible there might be large datasets being returned.  For known
1043      * small datasets use get_records_sql - it leads to simpler code.
1044      *
1045      * The return type is as for @see function get_recordset.
1046      *
1047      * @param string $sql the SQL select query to execute.
1048      * @param array $params array of sql parameters
1049      * @param int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
1050      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
1051      * @return moodle_recordset instance
1052      * @throws dml_exception if error
1053      */
1054     public abstract function get_recordset_sql($sql, array $params=null, $limitfrom=0, $limitnum=0);
1056     /**
1057      * Get a number of records as an array of objects where all the given conditions met.
1058      *
1059      * If the query succeeds and returns at least one record, the
1060      * return value is an array of objects, one object for each
1061      * record found. The array key is the value from the first
1062      * column of the result set. The object associated with that key
1063      * has a member variable for each column of the results.
1064      *
1065      * @param string $table the table to query.
1066      * @param array $conditions optional array $fieldname=>requestedvalue with AND in between
1067      * @param string $sort an order to sort the results in (optional, a valid SQL ORDER BY parameter).
1068      * @param string $fields a comma separated list of fields to return (optional, by default
1069      *   all fields are returned). The first field will be used as key for the
1070      *   array so must be a unique field such as 'id'.
1071      * @param int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
1072      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
1073      * @return array of objects indexed by first column
1074      * @throws dml_exception if error
1075      */
1076     public function get_records($table, array $conditions=null, $sort='', $fields='*', $limitfrom=0, $limitnum=0) {
1077         list($select, $params) = $this->where_clause($table, $conditions);
1078         return $this->get_records_select($table, $select, $params, $sort, $fields, $limitfrom, $limitnum);
1079     }
1081     /**
1082      * Get a number of records as an array of objects where one field match one list of values.
1083      *
1084      * Return value as for @see function get_records.
1085      *
1086      * @param string $table The database table to be checked against.
1087      * @param string $field The field to search
1088      * @param string $values array of values
1089      * @param string $sort Sort order (as valid SQL sort parameter)
1090      * @param string $fields A comma separated list of fields to be returned from the chosen table. If specified,
1091      *   the first field should be a unique one such as 'id' since it will be used as a key in the associative
1092      *   array.
1093      * @return array of objects indexed by first column
1094      * @throws dml_exception if error
1095      */
1096     public function get_records_list($table, $field, array $values, $sort='', $fields='*', $limitfrom=0, $limitnum=0) {
1097         list($select, $params) = $this->where_clause_list($field, $values);
1098         if (empty($select)) {
1099             // nothing to return
1100             return array();
1101         }
1102         return $this->get_records_select($table, $select, $params, $sort, $fields, $limitfrom, $limitnum);
1103     }
1105     /**
1106      * Get a number of records as an array of objects which match a particular WHERE clause.
1107      *
1108      * Return value as for @see function get_records.
1109      *
1110      * @param string $table the table to query.
1111      * @param string $select A fragment of SQL to be used in a where clause in the SQL call.
1112      * @param array $params array of sql parameters
1113      * @param string $sort an order to sort the results in (optional, a valid SQL ORDER BY parameter).
1114      * @param string $fields a comma separated list of fields to return
1115      *   (optional, by default all fields are returned). The first field will be used as key for the
1116      *   array so must be a unique field such as 'id'.
1117      * @param int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
1118      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
1119      * @return array of objects indexed by first column
1120      * @throws dml_exception if error
1121      */
1122     public function get_records_select($table, $select, array $params=null, $sort='', $fields='*', $limitfrom=0, $limitnum=0) {
1123         if ($select) {
1124             $select = "WHERE $select";
1125         }
1126         if ($sort) {
1127             $sort = " ORDER BY $sort";
1128         }
1129         return $this->get_records_sql("SELECT $fields FROM {" . $table . "} $select $sort", $params, $limitfrom, $limitnum);
1130     }
1132     /**
1133      * Get a number of records as an array of objects using a SQL statement.
1134      *
1135      * Return value as for @see function get_records.
1136      *
1137      * @param string $sql the SQL select query to execute. The first column of this SELECT statement
1138      *   must be a unique value (usually the 'id' field), as it will be used as the key of the
1139      *   returned array.
1140      * @param array $params array of sql parameters
1141      * @param int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
1142      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
1143      * @return array of objects indexed by first column
1144      * @throws dml_exception if error
1145      */
1146     public abstract function get_records_sql($sql, array $params=null, $limitfrom=0, $limitnum=0);
1148     /**
1149      * Get the first two columns from a number of records as an associative array where all the given conditions met.
1150      *
1151      * Arguments as for @see function get_recordset.
1152      *
1153      * If no errors occur the return value
1154      * is an associative whose keys come from the first field of each record,
1155      * and whose values are the corresponding second fields.
1156      * False is returned if an error occurs.
1157      *
1158      * @param string $table the table to query.
1159      * @param array $conditions optional array $fieldname=>requestedvalue with AND in between
1160      * @param string $sort an order to sort the results in (optional, a valid SQL ORDER BY parameter).
1161      * @param string $fields a comma separated list of fields to return - the number of fields should be 2!
1162      * @param int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
1163      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
1164      * @return array an associative array
1165      * @throws dml_exception if error
1166      */
1167     public function get_records_menu($table, array $conditions=null, $sort='', $fields='*', $limitfrom=0, $limitnum=0) {
1168         $menu = array();
1169         if ($records = $this->get_records($table, $conditions, $sort, $fields, $limitfrom, $limitnum)) {
1170             foreach ($records as $record) {
1171                 $record = (array)$record;
1172                 $key   = array_shift($record);
1173                 $value = array_shift($record);
1174                 $menu[$key] = $value;
1175             }
1176         }
1177         return $menu;
1178     }
1180     /**
1181      * Get the first two columns from a number of records as an associative array which match a particular WHERE clause.
1182      *
1183      * Arguments as for @see function get_recordset_select.
1184      * Return value as for @see function get_records_menu.
1185      *
1186      * @param string $table The database table to be checked against.
1187      * @param string $select A fragment of SQL to be used in a where clause in the SQL call.
1188      * @param array $params array of sql parameters
1189      * @param string $sort Sort order (optional) - a valid SQL order parameter
1190      * @param string $fields A comma separated list of fields to be returned from the chosen table - the number of fields should be 2!
1191      * @param int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
1192      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
1193      * @return array an associative array
1194      * @throws dml_exception if error
1195      */
1196     public function get_records_select_menu($table, $select, array $params=null, $sort='', $fields='*', $limitfrom=0, $limitnum=0) {
1197         $menu = array();
1198         if ($records = $this->get_records_select($table, $select, $params, $sort, $fields, $limitfrom, $limitnum)) {
1199             foreach ($records as $record) {
1200                 $record = (array)$record;
1201                 $key   = array_shift($record);
1202                 $value = array_shift($record);
1203                 $menu[$key] = $value;
1204             }
1205         }
1206         return $menu;
1207     }
1209     /**
1210      * Get the first two columns from a number of records as an associative array using a SQL statement.
1211      *
1212      * Arguments as for @see function get_recordset_sql.
1213      * Return value as for @see function get_records_menu.
1214      *
1215      * @param string $sql The SQL string you wish to be executed.
1216      * @param array $params array of sql parameters
1217      * @param int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
1218      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
1219      * @return array an associative array
1220      * @throws dml_exception if error
1221      */
1222     public function get_records_sql_menu($sql, array $params=null, $limitfrom=0, $limitnum=0) {
1223         $menu = array();
1224         if ($records = $this->get_records_sql($sql, $params, $limitfrom, $limitnum)) {
1225             foreach ($records as $record) {
1226                 $record = (array)$record;
1227                 $key   = array_shift($record);
1228                 $value = array_shift($record);
1229                 $menu[$key] = $value;
1230             }
1231         }
1232         return $menu;
1233     }
1235     /**
1236      * Get a single database record as an object where all the given conditions met.
1237      *
1238      * @param string $table The table to select from.
1239      * @param array $conditions optional array $fieldname=>requestedvalue with AND in between
1240      * @param string $fields A comma separated list of fields to be returned from the chosen table.
1241      * @param int $strictness IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found;
1242      *                        IGNORE_MULTIPLE means return first, ignore multiple records found(not recommended);
1243      *                        MUST_EXIST means throw exception if no record or multiple records found
1244      * @return mixed a fieldset object containing the first matching record, false or exception if error not found depending on mode
1245      * @throws dml_exception if error
1246      */
1247     public function get_record($table, array $conditions, $fields='*', $strictness=IGNORE_MISSING) {
1248         list($select, $params) = $this->where_clause($table, $conditions);
1249         return $this->get_record_select($table, $select, $params, $fields, $strictness);
1250     }
1252     /**
1253      * Get a single database record as an object which match a particular WHERE clause.
1254      *
1255      * @param string $table The database table to be checked against.
1256      * @param string $select A fragment of SQL to be used in a where clause in the SQL call.
1257      * @param array $params array of sql parameters
1258      * @param int $strictness IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found;
1259      *                        IGNORE_MULTIPLE means return first, ignore multiple records found(not recommended);
1260      *                        MUST_EXIST means throw exception if no record or multiple records found
1261      * @return mixed a fieldset object containing the first matching record, false or exception if error not found depending on mode
1262      * @throws dml_exception if error
1263      */
1264     public function get_record_select($table, $select, array $params=null, $fields='*', $strictness=IGNORE_MISSING) {
1265         if ($select) {
1266             $select = "WHERE $select";
1267         }
1268         try {
1269             return $this->get_record_sql("SELECT $fields FROM {" . $table . "} $select", $params, $strictness);
1270         } catch (dml_missing_record_exception $e) {
1271             // create new exception which will contain correct table name
1272             throw new dml_missing_record_exception($table, $e->sql, $e->params);
1273         }
1274     }
1276     /**
1277      * Get a single database record as an object using a SQL statement.
1278      *
1279      * The SQL statement should normally only return one record.
1280      * It is recommended to use get_records_sql() if more matches possible!
1281      *
1282      * @param string $sql The SQL string you wish to be executed, should normally only return one record.
1283      * @param array $params array of sql parameters
1284      * @param int $strictness IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found;
1285      *                        IGNORE_MULTIPLE means return first, ignore multiple records found(not recommended);
1286      *                        MUST_EXIST means throw exception if no record or multiple records found
1287      * @return mixed a fieldset object containing the first matching record, false or exception if error not found depending on mode
1288      * @throws dml_exception if error
1289      */
1290     public function get_record_sql($sql, array $params=null, $strictness=IGNORE_MISSING) {
1291         $strictness = (int)$strictness; // we support true/false for BC reasons too
1292         if ($strictness == IGNORE_MULTIPLE) {
1293             $count = 1;
1294         } else {
1295             $count = 0;
1296         }
1297         if (!$records = $this->get_records_sql($sql, $params, 0, $count)) {
1298             // not found
1299             if ($strictness == MUST_EXIST) {
1300                 throw new dml_missing_record_exception('', $sql, $params);
1301             }
1302             return false;
1303         }
1305         if (count($records) > 1) {
1306             if ($strictness == MUST_EXIST) {
1307                 throw new dml_multiple_records_exception($sql, $params);
1308             }
1309             debugging('Error: mdb->get_record() found more than one record!');
1310         }
1312         $return = reset($records);
1313         return $return;
1314     }
1316     /**
1317      * Get a single field value from a table record where all the given conditions met.
1318      *
1319      * @param string $table the table to query.
1320      * @param string $return the field to return the value of.
1321      * @param array $conditions optional array $fieldname=>requestedvalue with AND in between
1322      * @param int $strictness IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found;
1323      *                        IGNORE_MULTIPLE means return first, ignore multiple records found(not recommended);
1324      *                        MUST_EXIST means throw exception if no record or multiple records found
1325      * @return mixed the specified value false if not found
1326      * @throws dml_exception if error
1327      */
1328     public function get_field($table, $return, array $conditions, $strictness=IGNORE_MISSING) {
1329         list($select, $params) = $this->where_clause($table, $conditions);
1330         return $this->get_field_select($table, $return, $select, $params, $strictness);
1331     }
1333     /**
1334      * Get a single field value from a table record which match a particular WHERE clause.
1335      *
1336      * @param string $table the table to query.
1337      * @param string $return the field to return the value of.
1338      * @param string $select A fragment of SQL to be used in a where clause returning one row with one column
1339      * @param array $params array of sql parameters
1340      * @param int $strictness IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found;
1341      *                        IGNORE_MULTIPLE means return first, ignore multiple records found(not recommended);
1342      *                        MUST_EXIST means throw exception if no record or multiple records found
1343      * @return mixed the specified value false if not found
1344      * @throws dml_exception if error
1345      */
1346     public function get_field_select($table, $return, $select, array $params=null, $strictness=IGNORE_MISSING) {
1347         if ($select) {
1348             $select = "WHERE $select";
1349         }
1350         try {
1351             return $this->get_field_sql("SELECT $return FROM {" . $table . "} $select", $params, $strictness);
1352         } catch (dml_missing_record_exception $e) {
1353             // create new exception which will contain correct table name
1354             throw new dml_missing_record_exception($table, $e->sql, $e->params);
1355         }
1356     }
1358     /**
1359      * Get a single field value (first field) using a SQL statement.
1360      *
1361      * @param string $table the table to query.
1362      * @param string $return the field to return the value of.
1363      * @param string $sql The SQL query returning one row with one column
1364      * @param array $params array of sql parameters
1365      * @param int $strictness IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found;
1366      *                        IGNORE_MULTIPLE means return first, ignore multiple records found(not recommended);
1367      *                        MUST_EXIST means throw exception if no record or multiple records found
1368      * @return mixed the specified value false if not found
1369      * @throws dml_exception if error
1370      */
1371     public function get_field_sql($sql, array $params=null, $strictness=IGNORE_MISSING) {
1372         if (!$record = $this->get_record_sql($sql, $params, $strictness)) {
1373             return false;
1374         }
1376         $record = (array)$record;
1377         return reset($record); // first column
1378     }
1380     /**
1381      * Selects records and return values of chosen field as an array which match a particular WHERE clause.
1382      *
1383      * @param string $table the table to query.
1384      * @param string $return the field we are intered in
1385      * @param string $select A fragment of SQL to be used in a where clause in the SQL call.
1386      * @param array $params array of sql parameters
1387      * @return array of values
1388      * @throws dml_exception if error
1389      */
1390     public function get_fieldset_select($table, $return, $select, array $params=null) {
1391         if ($select) {
1392             $select = "WHERE $select";
1393         }
1394         return $this->get_fieldset_sql("SELECT $return FROM {" . $table . "} $select", $params);
1395     }
1397     /**
1398      * Selects records and return values (first field) as an array using a SQL statement.
1399      *
1400      * @param string $sql The SQL query
1401      * @param array $params array of sql parameters
1402      * @return array of values
1403      * @throws dml_exception if error
1404      */
1405     public abstract function get_fieldset_sql($sql, array $params=null);
1407     /**
1408      * Insert new record into database, as fast as possible, no safety checks, lobs not supported.
1409      * @param string $table name
1410      * @param mixed $params data record as object or array
1411      * @param bool $returnit return it of inserted record
1412      * @param bool $bulk true means repeated inserts expected
1413      * @param bool $customsequence true if 'id' included in $params, disables $returnid
1414      * @return bool|int true or new id
1415      * @throws dml_exception if error
1416      */
1417     public abstract function insert_record_raw($table, $params, $returnid=true, $bulk=false, $customsequence=false);
1419     /**
1420      * Insert a record into a table and return the "id" field if required.
1421      *
1422      * Some conversions and safety checks are carried out. Lobs are supported.
1423      * If the return ID isn't required, then this just reports success as true/false.
1424      * $data is an object containing needed data
1425      * @param string $table The database table to be inserted into
1426      * @param object $data A data object with values for one or more fields in the record
1427      * @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.
1428      * @return bool|int true or new id
1429      * @throws dml_exception if error
1430      */
1431     public abstract function insert_record($table, $dataobject, $returnid=true, $bulk=false);
1433     /**
1434      * Import a record into a table, id field is required.
1435      * Safety checks are NOT carried out. Lobs are supported.
1436      *
1437      * @param string $table name of database table to be inserted into
1438      * @param object $dataobject A data object with values for one or more fields in the record
1439      * @return bool true
1440      * @throws dml_exception if error
1441      */
1442     public abstract function import_record($table, $dataobject);
1444     /**
1445      * Update record in database, as fast as possible, no safety checks, lobs not supported.
1446      * @param string $table name
1447      * @param mixed $params data record as object or array
1448      * @param bool true means repeated updates expected
1449      * @return bool true
1450      * @throws dml_exception if error
1451      */
1452     public abstract function update_record_raw($table, $params, $bulk=false);
1454     /**
1455      * Update a record in a table
1456      *
1457      * $dataobject is an object containing needed data
1458      * Relies on $dataobject having a variable "id" to
1459      * specify the record to update
1460      *
1461      * @param string $table The database table to be checked against.
1462      * @param object $dataobject An object with contents equal to fieldname=>fieldvalue. Must have an entry for 'id' to map to the table specified.
1463      * @param bool true means repeated updates expected
1464      * @return bool true
1465      * @throws dml_exception if error
1466      */
1467     public abstract function update_record($table, $dataobject, $bulk=false);
1470     /**
1471      * Set a single field in every table record where all the given conditions met.
1472      *
1473      * @param string $table The database table to be checked against.
1474      * @param string $newfield the field to set.
1475      * @param string $newvalue the value to set the field to.
1476      * @param array $conditions optional array $fieldname=>requestedvalue with AND in between
1477      * @return bool true
1478      * @throws dml_exception if error
1479      */
1480     public function set_field($table, $newfield, $newvalue, array $conditions=null) {
1481         list($select, $params) = $this->where_clause($table, $conditions);
1482         return $this->set_field_select($table, $newfield, $newvalue, $select, $params);
1483     }
1485     /**
1486      * Set a single field in every table record which match a particular WHERE clause.
1487      *
1488      * @param string $table The database table to be checked against.
1489      * @param string $newfield the field to set.
1490      * @param string $newvalue the value to set the field to.
1491      * @param string $select A fragment of SQL to be used in a where clause in the SQL call.
1492      * @param array $params array of sql parameters
1493      * @return bool true
1494      * @throws dml_exception if error
1495      */
1496     public abstract function set_field_select($table, $newfield, $newvalue, $select, array $params=null);
1499     /**
1500      * Count the records in a table where all the given conditions met.
1501      *
1502      * @param string $table The table to query.
1503      * @param array $conditions optional array $fieldname=>requestedvalue with AND in between
1504      * @return int The count of records returned from the specified criteria.
1505      * @throws dml_exception if error
1506      */
1507     public function count_records($table, array $conditions=null) {
1508         list($select, $params) = $this->where_clause($table, $conditions);
1509         return $this->count_records_select($table, $select, $params);
1510     }
1512     /**
1513      * Count the records in a table which match a particular WHERE clause.
1514      *
1515      * @param string $table The database table to be checked against.
1516      * @param string $select A fragment of SQL to be used in a WHERE clause in the SQL call.
1517      * @param array $params array of sql parameters
1518      * @param string $countitem The count string to be used in the SQL call. Default is COUNT('x').
1519      * @return int The count of records returned from the specified criteria.
1520      * @throws dml_exception if error
1521      */
1522     public function count_records_select($table, $select, array $params=null, $countitem="COUNT('x')") {
1523         if ($select) {
1524             $select = "WHERE $select";
1525         }
1526         return $this->count_records_sql("SELECT $countitem FROM {" . $table . "} $select", $params);
1527     }
1529     /**
1530      * Get the result of a SQL SELECT COUNT(...) query.
1531      *
1532      * Given a query that counts rows, return that count. (In fact,
1533      * given any query, return the first field of the first record
1534      * returned. However, this method should only be used for the
1535      * intended purpose.) If an error occurs, 0 is returned.
1536      *
1537      * @param string $sql The SQL string you wish to be executed.
1538      * @param array $params array of sql parameters
1539      * @return int the count
1540      * @throws dml_exception if error
1541      */
1542     public function count_records_sql($sql, array $params=null) {
1543         if ($count = $this->get_field_sql($sql, $params)) {
1544             return $count;
1545         } else {
1546             return 0;
1547         }
1548     }
1550     /**
1551      * Test whether a record exists in a table where all the given conditions met.
1552      *
1553      * The record to test is specified by giving up to three fields that must
1554      * equal the corresponding values.
1555      *
1556      * @param string $table The table to check.
1557      * @param array $conditions optional array $fieldname=>requestedvalue with AND in between
1558      * @return bool true if a matching record exists, else false.
1559      * @throws dml_exception if error
1560      */
1561     public function record_exists($table, array $conditions) {
1562         list($select, $params) = $this->where_clause($table, $conditions);
1563         return $this->record_exists_select($table, $select, $params);
1564     }
1566     /**
1567      * Test whether any records exists in a table which match a particular WHERE clause.
1568      *
1569      * @param string $table The database table to be checked against.
1570      * @param string $select A fragment of SQL to be used in a WHERE clause in the SQL call.
1571      * @param array $params array of sql parameters
1572      * @return bool true if a matching record exists, else false.
1573      * @throws dml_exception if error
1574      */
1575     public function record_exists_select($table, $select, array $params=null) {
1576         if ($select) {
1577             $select = "WHERE $select";
1578         }
1579         return $this->record_exists_sql("SELECT 'x' FROM {" . $table . "} $select", $params);
1580     }
1582     /**
1583      * Test whether a SQL SELECT statement returns any records.
1584      *
1585      * This function returns true if the SQL statement executes
1586      * without any errors and returns at least one record.
1587      *
1588      * @param string $sql The SQL statement to execute.
1589      * @param array $params array of sql parameters
1590      * @return bool true if the SQL executes without errors and returns at least one record.
1591      * @throws dml_exception if error
1592      */
1593     public function record_exists_sql($sql, array $params=null) {
1594         $mrs = $this->get_recordset_sql($sql, $params, 0, 1);
1595         $return = $mrs->valid();
1596         $mrs->close();
1597         return $return;
1598     }
1600     /**
1601      * Delete the records from a table where all the given conditions met.
1602      * If conditions not specified, table is truncated.
1603      *
1604      * @param string $table the table to delete from.
1605      * @param array $conditions optional array $fieldname=>requestedvalue with AND in between
1606      * @return bool true.
1607      * @throws dml_exception if error
1608      */
1609     public function delete_records($table, array $conditions=null) {
1610         // truncate is drop/create (DDL), not transactional safe,
1611         // so we don't use the shortcut within them. MDL-29198
1612         if (is_null($conditions) && empty($this->transactions)) {
1613             return $this->execute("TRUNCATE TABLE {".$table."}");
1614         }
1615         list($select, $params) = $this->where_clause($table, $conditions);
1616         return $this->delete_records_select($table, $select, $params);
1617     }
1619     /**
1620      * Delete the records from a table where one field match one list of values.
1621      *
1622      * @param string $table the table to delete from.
1623      * @param string $field The field to search
1624      * @param array $values array of values
1625      * @return bool true.
1626      * @throws dml_exception if error
1627      */
1628     public function delete_records_list($table, $field, array $values) {
1629         list($select, $params) = $this->where_clause_list($field, $values);
1630         if (empty($select)) {
1631             // nothing to delete
1632             return true;
1633         }
1634         return $this->delete_records_select($table, $select, $params);
1635     }
1637     /**
1638      * Delete one or more records from a table which match a particular WHERE clause.
1639      *
1640      * @param string $table The database table to be checked against.
1641      * @param string $select A fragment of SQL to be used in a where clause in the SQL call (used to define the selection criteria).
1642      * @param array $params array of sql parameters
1643      * @return bool true.
1644      * @throws dml_exception if error
1645      */
1646     public abstract function delete_records_select($table, $select, array $params=null);
1650 /// sql constructs
1651     /**
1652      * Returns the FROM clause required by some DBs in all SELECT statements.
1653      *
1654      * To be used in queries not having FROM clause to provide cross_db
1655      * Most DBs don't need it, hence the default is ''
1656      * @return string
1657      */
1658     public function sql_null_from_clause() {
1659         return '';
1660     }
1662     /**
1663      * Returns the SQL text to be used in order to perform one bitwise AND operation
1664      * between 2 integers.
1665      *
1666      * NOTE: The SQL result is a number and can not be used directly in
1667      *       SQL condition, please compare it to some number to get a bool!!
1668      *
1669      * @param int $int1 first integer in the operation
1670      * @param int $int2 second integer in the operation
1671      * @return string the piece of SQL code to be used in your statement
1672      */
1673     public function sql_bitand($int1, $int2) {
1674         return '((' . $int1 . ') & (' . $int2 . '))';
1675     }
1677     /**
1678      * Returns the SQL text to be used in order to perform one bitwise NOT operation
1679      * with 1 integer.
1680      *
1681      * @param int $int1 integer in the operation
1682      * @return string the piece of SQL code to be used in your statement.
1683      */
1684     public function sql_bitnot($int1) {
1685         return '(~(' . $int1 . '))';
1686     }
1688     /**
1689      * Returns the SQL text to be used in order to perform one bitwise OR operation
1690      * between 2 integers.
1691      *
1692      * NOTE: The SQL result is a number and can not be used directly in
1693      *       SQL condition, please compare it to some number to get a bool!!
1694      *
1695      * @param int $int1 first integer in the operation
1696      * @param int $int2 second integer in the operation
1697      * @return string the piece of SQL code to be used in your statement.
1698      */
1699     public function sql_bitor($int1, $int2) {
1700         return '((' . $int1 . ') | (' . $int2 . '))';
1701     }
1703     /**
1704      * Returns the SQL text to be used in order to perform one bitwise XOR operation
1705      * between 2 integers.
1706      *
1707      * NOTE: The SQL result is a number and can not be used directly in
1708      *       SQL condition, please compare it to some number to get a bool!!
1709      *
1710      * @param int $int1 first integer in the operation
1711      * @param int $int2 second integer in the operation
1712      * @return string the piece of SQL code to be used in your statement.
1713      */
1714     public function sql_bitxor($int1, $int2) {
1715         return '((' . $int1 . ') ^ (' . $int2 . '))';
1716     }
1718     /**
1719      * Returns the SQL text to be used in order to perform module '%'
1720      * operation - remainder after division
1721      *
1722      * @param int $int1 first integer in the operation
1723      * @param int $int2 second integer in the operation
1724      * @return string the piece of SQL code to be used in your statement.
1725      */
1726     public function sql_modulo($int1, $int2) {
1727         return '((' . $int1 . ') % (' . $int2 . '))';
1728     }
1730     /**
1731      * Returns the correct CEIL expression applied to fieldname.
1732      *
1733      * @param string $fieldname the field (or expression) we are going to ceil
1734      * @return string the piece of SQL code to be used in your ceiling statement
1735      * Most DB use CEIL(), hence it's the default.
1736      */
1737     public function sql_ceil($fieldname) {
1738         return ' CEIL(' . $fieldname . ')';
1739     }
1741     /**
1742      * Returns the SQL to be used in order to CAST one CHAR column to INTEGER.
1743      *
1744      * Be aware that the CHAR column you're trying to cast contains really
1745      * int values or the RDBMS will throw an error!
1746      *
1747      * @param string $fieldname the name of the field to be casted
1748      * @param bool $text to specify if the original column is one TEXT (CLOB) column (true). Defaults to false.
1749      * @return string the piece of SQL code to be used in your statement.
1750      */
1751     public function sql_cast_char2int($fieldname, $text=false) {
1752         return ' ' . $fieldname . ' ';
1753     }
1755     /**
1756      * Returns the SQL to be used in order to CAST one CHAR column to REAL number.
1757      *
1758      * Be aware that the CHAR column you're trying to cast contains really
1759      * numbers or the RDBMS will throw an error!
1760      *
1761      * @param string $fieldname the name of the field to be casted
1762      * @param bool $text to specify if the original column is one TEXT (CLOB) column (true). Defaults to false.
1763      * @return string the piece of SQL code to be used in your statement.
1764      */
1765     public function sql_cast_char2real($fieldname, $text=false) {
1766         return ' ' . $fieldname . ' ';
1767     }
1769     /**
1770      * Returns the SQL to be used in order to an UNSIGNED INTEGER column to SIGNED.
1771      *
1772      * (Only MySQL needs this. MySQL things that 1 * -1 = 18446744073709551615
1773      * if the 1 comes from an unsigned column).
1774      *
1775      * @param string $fieldname the name of the field to be cast
1776      * @return string the piece of SQL code to be used in your statement.
1777      */
1778     public function sql_cast_2signed($fieldname) {
1779         return ' ' . $fieldname . ' ';
1780     }
1782     /**
1783      * Returns the SQL text to be used to compare one TEXT (clob) column with
1784      * one varchar column, because some RDBMS doesn't support such direct
1785      * comparisons.
1786      *
1787      * @param string $fieldname the name of the TEXT field we need to order by
1788      * @param int $numchars of chars to use for the ordering (defaults to 32)
1789      * @return string the piece of SQL code to be used in your statement.
1790      */
1791     public function sql_compare_text($fieldname, $numchars=32) {
1792         return $this->sql_order_by_text($fieldname, $numchars);
1793     }
1795     /**
1796      * Returns 'LIKE' part of a query.
1797      *
1798      * @param string $fieldname usually name of the table column
1799      * @param string $param usually bound query parameter (?, :named)
1800      * @param bool $casesensitive use case sensitive search
1801      * @param bool $accensensitive use accent sensitive search (not all databases support accent insensitive)
1802      * @param bool $notlike true means "NOT LIKE"
1803      * @param string $escapechar escape char for '%' and '_'
1804      * @return string SQL code fragment
1805      */
1806     public function sql_like($fieldname, $param, $casesensitive = true, $accentsensitive = true, $notlike = false, $escapechar = '\\') {
1807         if (strpos($param, '%') !== false) {
1808             debugging('Potential SQL injection detected, sql_like() expects bound parameters (? or :named)');
1809         }
1810         $LIKE = $notlike ? 'NOT LIKE' : 'LIKE';
1811         // by default ignore any sensitiveness - each database does it in a different way
1812         return "$fieldname $LIKE $param ESCAPE '$escapechar'";
1813     }
1815     /**
1816      * Escape sql LIKE special characters.
1817      * @param string $text
1818      * @param string $escapechar
1819      * @return string
1820      */
1821     public function sql_like_escape($text, $escapechar = '\\') {
1822         $text = str_replace('_', $escapechar.'_', $text);
1823         $text = str_replace('%', $escapechar.'%', $text);
1824         return $text;
1825     }
1827     /**
1828      * Returns the proper SQL to do LIKE in a case-insensitive way.
1829      *
1830      * Note the LIKE are case sensitive for Oracle. Oracle 10g is required to use
1831      * the case insensitive search using regexp_like() or NLS_COMP=LINGUISTIC :-(
1832      * See http://docs.moodle.org/en/XMLDB_Problems#Case-insensitive_searches
1833      *
1834      * @deprecated
1835      * @return string
1836      */
1837     public function sql_ilike() {
1838         debugging('sql_ilike() is deprecated, please use sql_like() instead');
1839         return 'LIKE';
1840     }
1842     /**
1843      * Returns the proper SQL to do CONCAT between the elements passed
1844      * Can take many parameters
1845      *
1846      * This function accepts variable number of string parameters.
1847      *
1848      * @return string
1849      */
1850     public abstract function sql_concat();
1852     /**
1853      * Returns the proper SQL to do CONCAT between the elements passed
1854      * with a given separator
1855      *
1856      * @param string $separator
1857      * @param array  $elements
1858      * @return string
1859      */
1860     public abstract function sql_concat_join($separator="' '", $elements=array());
1862     /**
1863      * Returns the proper SQL (for the dbms in use) to concatenate $firstname and $lastname
1864      * TODO: Does this really need to be here? Eloy 20070727.
1865      * TODO: we definitely do not! (skodak)
1866      *
1867      * @param string $first User's first name
1868      * @param string $last User's last name
1869      * @return string
1870      */
1871     function sql_fullname($first='firstname', $last='lastname') {
1872         return $this->sql_concat($first, "' '", $last);
1873     }
1875     /**
1876      * Returns the SQL text to be used to order by one TEXT (clob) column, because
1877      * some RDBMS doesn't support direct ordering of such fields.
1878      *
1879      * Note that the use or queries being ordered by TEXT columns must be minimised,
1880      * because it's really slooooooow.
1881      *
1882      * @param string $fieldname the name of the TEXT field we need to order by
1883      * @param string $numchars of chars to use for the ordering (defaults to 32)
1884      * @return string the piece of SQL code to be used in your statement.
1885      */
1886     public function sql_order_by_text($fieldname, $numchars=32) {
1887         return $fieldname;
1888     }
1890     /**
1891      * Returns the SQL text to be used to calculate the length in characters of one expression.
1892      * @param string $fieldname or expression to calculate its length in characters.
1893      * @return string the piece of SQL code to be used in the statement.
1894      */
1895     public function sql_length($fieldname) {
1896         return ' LENGTH(' . $fieldname . ')';
1897     }
1899     /**
1900      * Returns the proper substr() SQL text used to extract substrings from DB
1901      * NOTE: this was originally returning only function name
1902      *
1903      * @param string $expr some string field, no aggregates
1904      * @param mixed $start integer or expression evaluating to int (1 based value; first char has index 1)
1905      * @param mixed $length optional integer or expression evaluating to int
1906      * @return string sql fragment
1907      */
1908     public function sql_substr($expr, $start, $length=false) {
1909         if (count(func_get_args()) < 2) {
1910             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.');
1911         }
1912         if ($length === false) {
1913             return "SUBSTR($expr, $start)";
1914         } else {
1915             return "SUBSTR($expr, $start, $length)";
1916         }
1917     }
1919     /**
1920      * Returns the SQL for returning searching one string for the location of another.
1921      * Note, there is no guarantee which order $needle, $haystack will be in
1922      * the resulting SQL, so when using this method, and both arguments contain
1923      * placeholders, you should use named placeholders.
1924      * @param string $needle the SQL expression that will be searched for.
1925      * @param string $haystack the SQL expression that will be searched in.
1926      * @return string the required SQL
1927      */
1928     public function sql_position($needle, $haystack) {
1929         // Implementation using standard SQL.
1930         return "POSITION(($needle) IN ($haystack))";
1931     }
1933     /**
1934      * Returns the empty string char used by every supported DB. To be used when
1935      * we are searching for that values in our queries. Only Oracle uses this
1936      * for now (will be out, once we migrate to proper NULLs if that days arrives)
1937      * @return string
1938      */
1939     function sql_empty() {
1940         return '';
1941     }
1943     /**
1944      * Returns the proper SQL to know if one field is empty.
1945      *
1946      * Note that the function behavior strongly relies on the
1947      * parameters passed describing the field so, please,  be accurate
1948      * when specifying them.
1949      *
1950      * Also, note that this function is not suitable to look for
1951      * fields having NULL contents at all. It's all for empty values!
1952      *
1953      * This function should be applied in all the places where conditions of
1954      * the type:
1955      *
1956      *     ... AND fieldname = '';
1957      *
1958      * are being used. Final result should be:
1959      *
1960      *     ... AND ' . sql_isempty('tablename', 'fieldname', true/false, true/false);
1961      *
1962      * (see parameters description below)
1963      *
1964      * @param string $tablename name of the table (without prefix). Not used for now but can be
1965      *                          necessary in the future if we want to use some introspection using
1966      *                          meta information against the DB. /// TODO ///
1967      * @param string $fieldname name of the field we are going to check
1968      * @param boolean $nullablefield to specify if the field us nullable (true) or no (false) in the DB
1969      * @param boolean $textfield to specify if it is a text (also called clob) field (true) or a varchar one (false)
1970      * @return string the sql code to be added to check for empty values
1971      */
1972     public function sql_isempty($tablename, $fieldname, $nullablefield, $textfield) {
1973         return " ($fieldname = '') ";
1974     }
1976     /**
1977      * Returns the proper SQL to know if one field is not empty.
1978      *
1979      * Note that the function behavior strongly relies on the
1980      * parameters passed describing the field so, please,  be accurate
1981      * when specifying them.
1982      *
1983      * This function should be applied in all the places where conditions of
1984      * the type:
1985      *
1986      *     ... AND fieldname != '';
1987      *
1988      * are being used. Final result should be:
1989      *
1990      *     ... AND ' . sql_isnotempty('tablename', 'fieldname', true/false, true/false);
1991      *
1992      * (see parameters description below)
1993      *
1994      * @param string $tablename name of the table (without prefix). Not used for now but can be
1995      *                          necessary in the future if we want to use some introspection using
1996      *                          meta information against the DB. /// TODO ///
1997      * @param string $fieldname name of the field we are going to check
1998      * @param boolean $nullablefield to specify if the field us nullable (true) or no (false) in the DB
1999      * @param boolean $textfield to specify if it is a text (also called clob) field (true) or a varchar one (false)
2000      * @return string the sql code to be added to check for non empty values
2001      */
2002     public function sql_isnotempty($tablename, $fieldname, $nullablefield, $textfield) {
2003         return ' ( NOT ' . $this->sql_isempty($tablename, $fieldname, $nullablefield, $textfield) . ') ';
2004     }
2006     /**
2007      * Does this driver suppoer regex syntax when searching
2008      * @return bool
2009      */
2010     public function sql_regex_supported() {
2011         return false;
2012     }
2014     /**
2015      * Return regex positive or negative match sql
2016      * @param bool $positivematch
2017      * @return string or empty if not supported
2018      */
2019     public function sql_regex($positivematch=true) {
2020         return '';
2021     }
2023 /// transactions
2025     /**
2026      * Are transactions supported?
2027      * It is not responsible to run productions servers
2028      * on databases without transaction support ;-)
2029      *
2030      * Override in driver if needed.
2031      *
2032      * @return bool
2033      */
2034     protected function transactions_supported() {
2035         // protected for now, this might be changed to public if really necessary
2036         return true;
2037     }
2039     /**
2040      * Returns true if transaction in progress
2041      * @return bool
2042      */
2043     public function is_transaction_started() {
2044         return !empty($this->transactions);
2045     }
2047     /**
2048      * Throws exception if transaction in progress.
2049      * This test does not force rollback of active transactions.
2050      * @return void
2051      */
2052     public function transactions_forbidden() {
2053         if ($this->is_transaction_started()) {
2054             throw new dml_transaction_exception('This code can not be excecuted in transaction');
2055         }
2056     }
2058     /**
2059      * On DBs that support it, switch to transaction mode and begin a transaction
2060      * you'll need to ensure you call allow_commit() on the returned object
2061      * or your changes *will* be lost.
2062      *
2063      * this is _very_ useful for massive updates
2064      *
2065      * Delegated database transactions can be nested, but only one actual database
2066      * transaction is used for the outer-most delegated transaction. This method
2067      * returns a transaction object which you should keep until the end of the
2068      * delegated transaction. The actual database transaction will
2069      * only be committed if all the nested delegated transactions commit
2070      * successfully. If any part of the transaction rolls back then the whole
2071      * thing is rolled back.
2072      *
2073      * @return moodle_transaction
2074      */
2075     public function start_delegated_transaction() {
2076         $transaction = new moodle_transaction($this);
2077         $this->transactions[] = $transaction;
2078         if (count($this->transactions) == 1) {
2079             $this->begin_transaction();
2080         }
2081         return $transaction;
2082     }
2084     /**
2085      * Driver specific start of real database transaction,
2086      * this can not be used directly in code.
2087      * @return void
2088      */
2089     protected abstract function begin_transaction();
2091     /**
2092      * Indicates delegated transaction finished successfully.
2093      * The real database transaction is committed only if
2094      * all delegated transactions committed.
2095      * @return void
2096      */
2097     public function commit_delegated_transaction(moodle_transaction $transaction) {
2098         if ($transaction->is_disposed()) {
2099             throw new dml_transaction_exception('Transactions already disposed', $transaction);
2100         }
2101         // mark as disposed so that it can not be used again
2102         $transaction->dispose();
2104         if (empty($this->transactions)) {
2105             throw new dml_transaction_exception('Transaction not started', $transaction);
2106         }
2108         if ($this->force_rollback) {
2109             throw new dml_transaction_exception('Tried to commit transaction after lower level rollback', $transaction);
2110         }
2112         if ($transaction !== $this->transactions[count($this->transactions) - 1]) {
2113             // one incorrect commit at any level rollbacks everything
2114             $this->force_rollback = true;
2115             throw new dml_transaction_exception('Invalid transaction commit attempt', $transaction);
2116         }
2118         if (count($this->transactions) == 1) {
2119             // only commit the top most level
2120             $this->commit_transaction();
2121         }
2122         array_pop($this->transactions);
2123     }
2125     /**
2126      * Driver specific commit of real database transaction,
2127      * this can not be used directly in code.
2128      * @return void
2129      */
2130     protected abstract function commit_transaction();
2132     /**
2133      * Call when delegated transaction failed, this rolls back
2134      * all delegated transactions up to the top most level.
2135      *
2136      * In many cases you do not need to call this method manually,
2137      * because all open delegated transactions are rolled back
2138      * automatically if exceptions not caught.
2139      *
2140      * @param moodle_transaction $transaction
2141      * @param Exception $e exception that caused the problem
2142      * @return void - does not return, exception is rethrown
2143      */
2144     public function rollback_delegated_transaction(moodle_transaction $transaction, Exception $e) {
2145         if ($transaction->is_disposed()) {
2146             throw new dml_transaction_exception('Transactions already disposed', $transaction);
2147         }
2148         // mark as disposed so that it can not be used again
2149         $transaction->dispose();
2151         // one rollback at any level rollbacks everything
2152         $this->force_rollback = true;
2154         if (empty($this->transactions) or $transaction !== $this->transactions[count($this->transactions) - 1]) {
2155             // this may or may not be a coding problem, better just rethrow the exception,
2156             // because we do not want to loose the original $e
2157             throw $e;
2158         }
2160         if (count($this->transactions) == 1) {
2161             // only rollback the top most level
2162             $this->rollback_transaction();
2163         }
2164         array_pop($this->transactions);
2165         if (empty($this->transactions)) {
2166             // finally top most level rolled back
2167             $this->force_rollback = false;
2168         }
2169         throw $e;
2170     }
2172     /**
2173      * Driver specific abort of real database transaction,
2174      * this can not be used directly in code.
2175      * @return void
2176      */
2177     protected abstract function rollback_transaction();
2179     /**
2180      * Force rollback of all delegated transaction.
2181      * Does not trow any exceptions and does not log anything.
2182      *
2183      * This method should be used only from default exception handlers and other
2184      * core code.
2185      *
2186      * @return void
2187      */
2188     public function force_transaction_rollback() {
2189         if ($this->transactions) {
2190             try {
2191                 $this->rollback_transaction();
2192             } catch (dml_exception $e) {
2193                 // ignore any sql errors here, the connection might be broken
2194             }
2195         }
2197         // now enable transactions again
2198         $this->transactions = array(); // unfortunately all unfinished exceptions are kept in memory
2199         $this->force_rollback = false;
2200     }
2202 /// session locking
2203     /**
2204      * Is session lock supported in this driver?
2205      * @return bool
2206      */
2207     public function session_lock_supported() {
2208         return false;
2209     }
2211     /**
2212      * Obtain session lock
2213      * @param int $rowid id of the row with session record
2214      * @param int $timeout max allowed time to wait for the lock in seconds
2215      * @return bool success
2216      */
2217     public function get_session_lock($rowid, $timeout) {
2218         $this->used_for_db_sessions = true;
2219     }
2221     /**
2222      * Release session lock
2223      * @param int $rowid id of the row with session record
2224      * @return bool success
2225      */
2226     public function release_session_lock($rowid) {
2227     }
2229 /// performance and logging
2230     /**
2231      * Returns number of reads done by this database
2232      * @return int
2233      */
2234     public function perf_get_reads() {
2235         return $this->reads;
2236     }
2238     /**
2239      * Returns number of writes done by this database
2240      * @return int
2241      */
2242     public function perf_get_writes() {
2243         return $this->writes;
2244     }
2246     /**
2247      * Returns number of queries done by this database
2248      * @return int
2249      */
2250     public function perf_get_queries() {
2251         return $this->writes + $this->reads;
2252     }