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