9341b86f0a398ce1994e634a5fec4b650932b788
[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             error_log('Potential coding error - active database transaction detected when disposing database:'."\n".format_backtrace($backtrace, true));
327             $this->force_transaction_rollback();
328         }
329         if ($this->used_for_db_sessions) {
330             // this is needed because we need to save session to db before closing it
331             session_get_instance()->write_close();
332             $this->used_for_db_sessions = false;
333         }
334         if ($this->temptables) {
335             $this->temptables->dispose();
336             $this->temptables = null;
337         }
338         if ($this->database_manager) {
339             $this->database_manager->dispose();
340             $this->database_manager = null;
341         }
342         $this->columns = array();
343         $this->tables  = null;
344     }
346     /**
347      * This should be called before each db query.
348      * @param string $sql The query string.
349      * @param array $params An array of parameters.
350      * @param int $type The type of query. ( SQL_QUERY_SELECT | SQL_QUERY_AUX | SQL_QUERY_INSERT | SQL_QUERY_UPDATE | SQL_QUERY_STRUCTURE )
351      * @param mixed $extrainfo This is here for any driver specific extra information.
352      * @return void
353      */
354     protected function query_start($sql, array $params=null, $type, $extrainfo=null) {
355         if ($this->loggingquery) {
356             return;
357         }
358         $this->last_sql       = $sql;
359         $this->last_params    = $params;
360         $this->last_type      = $type;
361         $this->last_extrainfo = $extrainfo;
362         $this->last_time      = microtime(true);
364         switch ($type) {
365             case SQL_QUERY_SELECT:
366             case SQL_QUERY_AUX:
367                 $this->reads++;
368                 break;
369             case SQL_QUERY_INSERT:
370             case SQL_QUERY_UPDATE:
371             case SQL_QUERY_STRUCTURE:
372                 $this->writes++;
373         }
375         $this->print_debug($sql, $params);
376     }
378     /**
379      * This should be called immediately after each db query. It does a clean up of resources.
380      * It also throws exceptions if the sql that ran produced errors.
381      * @param mixed $result The db specific result obtained from running a query.
382      * @throws dml_read_exception | dml_write_exception | ddl_change_structure_exception
383      * @return void
384      */
385     protected function query_end($result) {
386         if ($this->loggingquery) {
387             return;
388         }
389         if ($result !== false) {
390             $this->query_log();
391             // free memory
392             $this->last_sql    = null;
393             $this->last_params = null;
394             return;
395         }
397         // remember current info, log queries may alter it
398         $type   = $this->last_type;
399         $sql    = $this->last_sql;
400         $params = $this->last_params;
401         $time   = microtime(true) - $this->last_time;
402         $error  = $this->get_last_error();
404         $this->query_log($error);
406         switch ($type) {
407             case SQL_QUERY_SELECT:
408             case SQL_QUERY_AUX:
409                 throw new dml_read_exception($error, $sql, $params);
410             case SQL_QUERY_INSERT:
411             case SQL_QUERY_UPDATE:
412                 throw new dml_write_exception($error, $sql, $params);
413             case SQL_QUERY_STRUCTURE:
414                 $this->get_manager(); // includes ddl exceptions classes ;-)
415                 throw new ddl_change_structure_exception($error, $sql);
416         }
417     }
419     /**
420      * This logs the last query based on 'logall', 'logslow' and 'logerrors' options configured via $CFG->dboptions .
421      * @param string $error or false if not error
422      * @return void
423      */
424     public function query_log($error=false) {
425         $logall    = !empty($this->dboptions['logall']);
426         $logslow   = !empty($this->dboptions['logslow']) ? $this->dboptions['logslow'] : false;
427         $logerrors = !empty($this->dboptions['logerrors']);
428         $iserror   = ($error !== false);
430         $time = microtime(true) - $this->last_time;
432         if ($logall or ($logslow and ($logslow < ($time+0.00001))) or ($iserror and $logerrors)) {
433             $this->loggingquery = true;
434             try {
435                 $backtrace = debug_backtrace();
436                 if ($backtrace) {
437                     //remove query_log()
438                     array_shift($backtrace);
439                 }
440                 if ($backtrace) {
441                     //remove query_end()
442                     array_shift($backtrace);
443                 }
444                 $log = new stdClass();
445                 $log->qtype      = $this->last_type;
446                 $log->sqltext    = $this->last_sql;
447                 $log->sqlparams  = var_export((array)$this->last_params, true);
448                 $log->error      = (int)$iserror;
449                 $log->info       = $iserror ? $error : null;
450                 $log->backtrace  = format_backtrace($backtrace, true);
451                 $log->exectime   = $time;
452                 $log->timelogged = time();
453                 $this->insert_record('log_queries', $log);
454             } catch (Exception $ignored) {
455             }
456             $this->loggingquery = false;
457         }
458     }
460     /**
461      * Returns database server info array
462      * @return array Array containing 'description' and 'version' atleast.
463      */
464     public abstract function get_server_info();
466     /**
467      * Returns supported query parameter types
468      * @return int bitmask of accepted SQL_PARAMS_*
469      */
470     protected abstract function allowed_param_types();
472     /**
473      * Returns the last error reported by the database engine.
474      * @return string The error message.
475      */
476     public abstract function get_last_error();
478     /**
479      * Prints sql debug info
480      * @param string $sql The query which is being debugged.
481      * @param array $params The query parameters. (optional)
482      * @param mixed $obj The library specific object. (optional)
483      * @return void
484      */
485     protected function print_debug($sql, array $params=null, $obj=null) {
486         if (!$this->get_debug()) {
487             return;
488         }
489         if (CLI_SCRIPT) {
490             echo "--------------------------------\n";
491             echo $sql."\n";
492             if (!is_null($params)) {
493                 echo "[".var_export($params, true)."]\n";
494             }
495             echo "--------------------------------\n";
496         } else {
497             echo "<hr />\n";
498             echo s($sql)."\n";
499             if (!is_null($params)) {
500                 echo "[".s(var_export($params, true))."]\n";
501             }
502             echo "<hr />\n";
503         }
504     }
506     /**
507      * Returns the SQL WHERE conditions.
508      * @param string $table The table name that these conditions will be validated against.
509      * @param array $conditions The conditions to build the where clause. (must not contain numeric indexes)
510      * @throws dml_exception
511      * @return array An array list containing sql 'where' part and 'params'.
512      */
513     protected function where_clause($table, array $conditions=null) {
514         // We accept nulls in conditions
515         $conditions = is_null($conditions) ? array() : $conditions;
516         // Some checks performed under debugging only
517         if (debugging()) {
518             $columns = $this->get_columns($table);
519             if (empty($columns)) {
520                 // no supported columns means most probably table does not exist
521                 throw new dml_exception('ddltablenotexist', $table);
522             }
523             foreach ($conditions as $key=>$value) {
524                 if (!isset($columns[$key])) {
525                     $a = new stdClass();
526                     $a->fieldname = $key;
527                     $a->tablename = $table;
528                     throw new dml_exception('ddlfieldnotexist', $a);
529                 }
530                 $column = $columns[$key];
531                 if ($column->meta_type == 'X') {
532                     //ok so the column is a text column. sorry no text columns in the where clause conditions
533                     throw new dml_exception('textconditionsnotallowed', $conditions);
534                 }
535             }
536         }
538         $allowed_types = $this->allowed_param_types();
539         if (empty($conditions)) {
540             return array('', array());
541         }
542         $where = array();
543         $params = array();
545         foreach ($conditions as $key=>$value) {
546             if (is_int($key)) {
547                 throw new dml_exception('invalidnumkey');
548             }
549             if (is_null($value)) {
550                 $where[] = "$key IS NULL";
551             } else {
552                 if ($allowed_types & SQL_PARAMS_NAMED) {
553                     // Need to verify key names because they can contain, originally,
554                     // spaces and other forbidden chars when using sql_xxx() functions and friends.
555                     $normkey = trim(preg_replace('/[^a-zA-Z0-9_-]/', '_', $key), '-_');
556                     if ($normkey !== $key) {
557                         debugging('Invalid key found in the conditions array.');
558                     }
559                     $where[] = "$key = :$normkey";
560                     $params[$normkey] = $value;
561                 } else {
562                     $where[] = "$key = ?";
563                     $params[] = $value;
564                 }
565             }
566         }
567         $where = implode(" AND ", $where);
568         return array($where, $params);
569     }
571     /**
572      * Returns SQL WHERE conditions for the ..._list group of methods.
573      *
574      * @param string $field the name of a field.
575      * @param array $values the values field might take.
576      * @return array An array containing sql 'where' part and 'params'
577      */
578     protected function where_clause_list($field, array $values) {
579         $params = array();
580         $select = array();
581         $values = (array)$values;
582         foreach ($values as $value) {
583             if (is_bool($value)) {
584                 $value = (int)$value;
585             }
586             if (is_null($value)) {
587                 $select[] = "$field IS NULL";
588             } else {
589                 $select[] = "$field = ?";
590                 $params[] = $value;
591             }
592         }
593         $select = implode(" OR ", $select);
594         return array($select, $params);
595     }
597     /**
598      * Constructs 'IN()' or '=' sql fragment
599      * @param mixed $items A single value or array of values for the expression.
600      * @param int $type Parameter bounding type : SQL_PARAMS_QM or SQL_PARAMS_NAMED.
601      * @param string $prefix Named parameter placeholder prefix (a unique counter value is appended to each parameter name).
602      * @param bool $equal True means we want to equate to the constructed expression, false means we don't want to equate to it.
603      * @param mixed $onemptyitems This defines the behavior when the array of items provided is empty. Defaults to false,
604      *              meaning throw exceptions. Other values will become part of the returned SQL fragment.
605      * @throws coding_exception | dml_exception
606      * @return array A list containing the constructed sql fragment and an array of parameters.
607      */
608     public function get_in_or_equal($items, $type=SQL_PARAMS_QM, $prefix='param', $equal=true, $onemptyitems=false) {
610         // default behavior, throw exception on empty array
611         if (is_array($items) and empty($items) and $onemptyitems === false) {
612             throw new coding_exception('moodle_database::get_in_or_equal() does not accept empty arrays');
613         }
614         // handle $onemptyitems on empty array of items
615         if (is_array($items) and empty($items)) {
616             if (is_null($onemptyitems)) {             // Special case, NULL value
617                 $sql = $equal ? ' IS NULL' : ' IS NOT NULL';
618                 return (array($sql, array()));
619             } else {
620                 $items = array($onemptyitems);        // Rest of cases, prepare $items for std processing
621             }
622         }
624         if ($type == SQL_PARAMS_QM) {
625             if (!is_array($items) or count($items) == 1) {
626                 $sql = $equal ? '= ?' : '<> ?';
627                 $items = (array)$items;
628                 $params = array_values($items);
629             } else {
630                 if ($equal) {
631                     $sql = 'IN ('.implode(',', array_fill(0, count($items), '?')).')';
632                 } else {
633                     $sql = 'NOT IN ('.implode(',', array_fill(0, count($items), '?')).')';
634                 }
635                 $params = array_values($items);
636             }
638         } else if ($type == SQL_PARAMS_NAMED) {
639             if (empty($prefix)) {
640                 $prefix = 'param';
641             }
643             if (!is_array($items)){
644                 $param = $prefix.$this->inorequaluniqueindex++;
645                 $sql = $equal ? "= :$param" : "<> :$param";
646                 $params = array($param=>$items);
647             } else if (count($items) == 1) {
648                 $param = $prefix.$this->inorequaluniqueindex++;
649                 $sql = $equal ? "= :$param" : "<> :$param";
650                 $item = reset($items);
651                 $params = array($param=>$item);
652             } else {
653                 $params = array();
654                 $sql = array();
655                 foreach ($items as $item) {
656                     $param = $prefix.$this->inorequaluniqueindex++;
657                     $params[$param] = $item;
658                     $sql[] = ':'.$param;
659                 }
660                 if ($equal) {
661                     $sql = 'IN ('.implode(',', $sql).')';
662                 } else {
663                     $sql = 'NOT IN ('.implode(',', $sql).')';
664                 }
665             }
667         } else {
668             throw new dml_exception('typenotimplement');
669         }
670         return array($sql, $params);
671     }
673     /**
674      * Converts short table name {tablename} to the real prefixed table name in given sql.
675      * @param string $sql The sql to be operated on.
676      * @return string The sql with tablenames being prefixed with $CFG->prefix
677      */
678     protected function fix_table_names($sql) {
679         return preg_replace('/\{([a-z][a-z0-9_]*)\}/', $this->prefix.'$1', $sql);
680     }
682     /**
683      * Internal private utitlity function used to fix parameters.
684      * Used with {@link preg_replace_callback()}
685      * @param array $match Refer to preg_replace_callback usage for description.
686      */
687     private function _fix_sql_params_dollar_callback($match) {
688         $this->fix_sql_params_i++;
689         return "\$".$this->fix_sql_params_i;
690     }
692     /**
693      * Detects object parameters and throws exception if found
694      * @param mixed $value
695      * @return void
696      */
697     protected function detect_objects($value) {
698         if (is_object($value)) {
699             throw new coding_exception('Invalid database query parameter value', 'Objects are are not allowed: '.get_class($value));
700         }
701     }
703     /**
704      * Normalizes sql query parameters and verifies parameters.
705      * @param string $sql The query or part of it.
706      * @param array $params The query parameters.
707      * @return array (sql, params, type of params)
708      */
709     public function fix_sql_params($sql, array $params=null) {
710         $params = (array)$params; // mke null array if needed
711         $allowed_types = $this->allowed_param_types();
713         // convert table names
714         $sql = $this->fix_table_names($sql);
716         // cast booleans to 1/0 int and detect forbidden objects
717         foreach ($params as $key => $value) {
718             $this->detect_objects($value);
719             $params[$key] = is_bool($value) ? (int)$value : $value;
720         }
722         // NICOLAS C: Fixed regexp for negative backwards lookahead of double colons. Thanks for Sam Marshall's help
723         $named_count = preg_match_all('/(?<!:):[a-z][a-z0-9_]*/', $sql, $named_matches); // :: used in pgsql casts
724         $dollar_count = preg_match_all('/\$[1-9][0-9]*/', $sql, $dollar_matches);
725         $q_count     = substr_count($sql, '?');
727         $count = 0;
729         if ($named_count) {
730             $type = SQL_PARAMS_NAMED;
731             $count = $named_count;
733         }
734         if ($dollar_count) {
735             if ($count) {
736                 throw new dml_exception('mixedtypesqlparam');
737             }
738             $type = SQL_PARAMS_DOLLAR;
739             $count = $dollar_count;
741         }
742         if ($q_count) {
743             if ($count) {
744                 throw new dml_exception('mixedtypesqlparam');
745             }
746             $type = SQL_PARAMS_QM;
747             $count = $q_count;
749         }
751         if (!$count) {
752              // ignore params
753             if ($allowed_types & SQL_PARAMS_NAMED) {
754                 return array($sql, array(), SQL_PARAMS_NAMED);
755             } else if ($allowed_types & SQL_PARAMS_QM) {
756                 return array($sql, array(), SQL_PARAMS_QM);
757             } else {
758                 return array($sql, array(), SQL_PARAMS_DOLLAR);
759             }
760         }
762         if ($count > count($params)) {
763             $a = new stdClass;
764             $a->expected = $count;
765             $a->actual = count($params);
766             throw new dml_exception('invalidqueryparam', $a);
767         }
769         $target_type = $allowed_types;
771         if ($type & $allowed_types) { // bitwise AND
772             if ($count == count($params)) {
773                 if ($type == SQL_PARAMS_QM) {
774                     return array($sql, array_values($params), SQL_PARAMS_QM); // 0-based array required
775                 } else {
776                     //better do the validation of names below
777                 }
778             }
779             // needs some fixing or validation - there might be more params than needed
780             $target_type = $type;
781         }
783         if ($type == SQL_PARAMS_NAMED) {
784             $finalparams = array();
785             foreach ($named_matches[0] as $key) {
786                 $key = trim($key, ':');
787                 if (!array_key_exists($key, $params)) {
788                     throw new dml_exception('missingkeyinsql', $key, '');
789                 }
790                 if (strlen($key) > 30) {
791                     throw new coding_exception(
792                             "Placeholder names must be 30 characters or shorter. '" .
793                             $key . "' is too long.", $sql);
794                 }
795                 $finalparams[$key] = $params[$key];
796             }
797             if ($count != count($finalparams)) {
798                 throw new dml_exception('duplicateparaminsql');
799             }
801             if ($target_type & SQL_PARAMS_QM) {
802                 $sql = preg_replace('/(?<!:):[a-z][a-z0-9_]*/', '?', $sql);
803                 return array($sql, array_values($finalparams), SQL_PARAMS_QM); // 0-based required
804             } else if ($target_type & SQL_PARAMS_NAMED) {
805                 return array($sql, $finalparams, SQL_PARAMS_NAMED);
806             } else {  // $type & SQL_PARAMS_DOLLAR
807                 //lambda-style functions eat memory - we use globals instead :-(
808                 $this->fix_sql_params_i = 0;
809                 $sql = preg_replace_callback('/(?<!:):[a-z][a-z0-9_]*/', array($this, '_fix_sql_params_dollar_callback'), $sql);
810                 return array($sql, array_values($finalparams), SQL_PARAMS_DOLLAR); // 0-based required
811             }
813         } else if ($type == SQL_PARAMS_DOLLAR) {
814             if ($target_type & SQL_PARAMS_DOLLAR) {
815                 return array($sql, array_values($params), SQL_PARAMS_DOLLAR); // 0-based required
816             } else if ($target_type & SQL_PARAMS_QM) {
817                 $sql = preg_replace('/\$[0-9]+/', '?', $sql);
818                 return array($sql, array_values($params), SQL_PARAMS_QM); // 0-based required
819             } else { //$target_type & SQL_PARAMS_NAMED
820                 $sql = preg_replace('/\$([0-9]+)/', ':param\\1', $sql);
821                 $finalparams = array();
822                 foreach ($params as $key=>$param) {
823                     $key++;
824                     $finalparams['param'.$key] = $param;
825                 }
826                 return array($sql, $finalparams, SQL_PARAMS_NAMED);
827             }
829         } else { // $type == SQL_PARAMS_QM
830             if (count($params) != $count) {
831                 $params = array_slice($params, 0, $count);
832             }
834             if ($target_type & SQL_PARAMS_QM) {
835                 return array($sql, array_values($params), SQL_PARAMS_QM); // 0-based required
836             } else if ($target_type & SQL_PARAMS_NAMED) {
837                 $finalparams = array();
838                 $pname = 'param0';
839                 $parts = explode('?', $sql);
840                 $sql = array_shift($parts);
841                 foreach ($parts as $part) {
842                     $param = array_shift($params);
843                     $pname++;
844                     $sql .= ':'.$pname.$part;
845                     $finalparams[$pname] = $param;
846                 }
847                 return array($sql, $finalparams, SQL_PARAMS_NAMED);
848             } else {  // $type & SQL_PARAMS_DOLLAR
849                 //lambda-style functions eat memory - we use globals instead :-(
850                 $this->fix_sql_params_i = 0;
851                 $sql = preg_replace_callback('/\?/', array($this, '_fix_sql_params_dollar_callback'), $sql);
852                 return array($sql, array_values($params), SQL_PARAMS_DOLLAR); // 0-based required
853             }
854         }
855     }
857     /**
858      * Return tables in database WITHOUT current prefix.
859      * @param bool $usecache if true, returns list of cached tables.
860      * @return array of table names in lowercase and without prefix
861      */
862     public abstract function get_tables($usecache=true);
864     /**
865      * Return table indexes - everything lowercased.
866      * @param string $table The table we want to get indexes from.
867      * @return array An associative array of indexes containing 'unique' flag and 'columns' being indexed
868      */
869     public abstract function get_indexes($table);
871     /**
872      * Returns detailed information about columns in table. This information is cached internally.
873      * @param string $table The table's name.
874      * @param bool $usecache Flag to use internal cacheing. The default is true.
875      * @return array of database_column_info objects indexed with column names
876      */
877     public abstract function get_columns($table, $usecache=true);
879     /**
880      * Normalise values based on varying RDBMS's dependencies (booleans, LOBs...)
881      *
882      * @param database_column_info $column column metadata corresponding with the value we are going to normalise
883      * @param mixed $value value we are going to normalise
884      * @return mixed the normalised value
885      */
886     protected abstract function normalise_value($column, $value);
888     /**
889      * Resets the internal column details cache
890      * @return void
891      */
892     public function reset_caches() {
893         $this->columns = array();
894         $this->tables  = null;
895     }
897     /**
898      * Returns the sql generator used for db manipulation.
899      * Used mostly in upgrade.php scripts.
900      * @return database_manager The instance used to perform ddl operations.
901      * @see lib/ddl/database_manager.php
902      */
903     public function get_manager() {
904         global $CFG;
906         if (!$this->database_manager) {
907             require_once($CFG->libdir.'/ddllib.php');
909             $classname = $this->get_dbfamily().'_sql_generator';
910             require_once("$CFG->libdir/ddl/$classname.php");
911             $generator = new $classname($this, $this->temptables);
913             $this->database_manager = new database_manager($this, $generator);
914         }
915         return $this->database_manager;
916     }
918     /**
919      * Attempts to change db encoding to UTF-8 encoding if possible.
920      * @return bool True is successful.
921      */
922     public function change_db_encoding() {
923         return false;
924     }
926     /**
927      * Checks to see if the database is in unicode mode?
928      * @return bool
929      */
930     public function setup_is_unicodedb() {
931         return true;
932     }
934     /**
935      * Enable/disable very detailed debugging.
936      * @param bool $state
937      * @return void
938      */
939     public function set_debug($state) {
940         $this->debug = $state;
941     }
943     /**
944      * Returns debug status
945      * @return bool $state
946      */
947     public function get_debug() {
948         return $this->debug;
949     }
951     /**
952      * Enable/disable detailed sql logging
953      * @param bool $state
954      */
955     public function set_logging($state) {
956         // adodb sql logging shares one table without prefix per db - this is no longer acceptable :-(
957         // we must create one table shared by all drivers
958     }
960     /**
961      * Do NOT use in code, this is for use by database_manager only!
962      * @param string $sql query
963      * @return bool true
964      * @throws dml_exception A DML specific exception is thrown for any errors.
965      */
966     public abstract function change_database_structure($sql);
968     /**
969      * Executes a general sql query. Should be used only when no other method suitable.
970      * Do NOT use this to make changes in db structure, use database_manager methods instead!
971      * @param string $sql query
972      * @param array $params query parameters
973      * @return bool true
974      * @throws dml_exception A DML specific exception is thrown for any errors.
975      */
976     public abstract function execute($sql, array $params=null);
978     /**
979      * Get a number of records as a moodle_recordset where all the given conditions met.
980      *
981      * Selects records from the table $table.
982      *
983      * If specified, only records meeting $conditions.
984      *
985      * If specified, the results will be sorted as specified by $sort. This
986      * is added to the SQL as "ORDER BY $sort". Example values of $sort
987      * might be "time ASC" or "time DESC".
988      *
989      * If $fields is specified, only those fields are returned.
990      *
991      * Since this method is a little less readable, use of it should be restricted to
992      * code where it's possible there might be large datasets being returned.  For known
993      * small datasets use get_records - it leads to simpler code.
994      *
995      * If you only want some of the records, specify $limitfrom and $limitnum.
996      * The query will skip the first $limitfrom records (according to the sort
997      * order) and then return the next $limitnum records. If either of $limitfrom
998      * or $limitnum is specified, both must be present.
999      *
1000      * The return value is a moodle_recordset
1001      * if the query succeeds. If an error occurs, false is returned.
1002      *
1003      * @param string $table the table to query.
1004      * @param array $conditions optional array $fieldname=>requestedvalue with AND in between
1005      * @param string $sort an order to sort the results in (optional, a valid SQL ORDER BY parameter).
1006      * @param string $fields a comma separated list of fields to return (optional, by default all fields are returned).
1007      * @param int $limitfrom return a subset of records, starting at this point (optional).
1008      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
1009      * @return moodle_recordset A moodle_recordset instance
1010      * @throws dml_exception A DML specific exception is thrown for any errors.
1011      */
1012     public function get_recordset($table, array $conditions=null, $sort='', $fields='*', $limitfrom=0, $limitnum=0) {
1013         list($select, $params) = $this->where_clause($table, $conditions);
1014         return $this->get_recordset_select($table, $select, $params, $sort, $fields, $limitfrom, $limitnum);
1015     }
1017     /**
1018      * Get a number of records as a moodle_recordset where one field match one list of values.
1019      *
1020      * Only records where $field takes one of the values $values are returned.
1021      * $values must be an array of values.
1022      *
1023      * Other arguments and the return type are like {@link function get_recordset}.
1024      *
1025      * @param string $table the table to query.
1026      * @param string $field a field to check (optional).
1027      * @param array $values array of values the field must have
1028      * @param string $sort an order to sort the results in (optional, a valid SQL ORDER BY parameter).
1029      * @param string $fields a comma separated list of fields to return (optional, by default all fields are returned).
1030      * @param int $limitfrom return a subset of records, starting at this point (optional).
1031      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
1032      * @return moodle_recordset A moodle_recordset instance.
1033      * @throws dml_exception A DML specific exception is thrown for any errors.
1034      */
1035     public function get_recordset_list($table, $field, array $values, $sort='', $fields='*', $limitfrom=0, $limitnum=0) {
1036         list($select, $params) = $this->where_clause_list($field, $values);
1037         if (empty($select)) {
1038             $select = '1 = 2'; // Fake condition, won't return rows ever. MDL-17645
1039             $params = array();
1040         }
1041         return $this->get_recordset_select($table, $select, $params, $sort, $fields, $limitfrom, $limitnum);
1042     }
1044     /**
1045      * Get a number of records as a moodle_recordset which match a particular WHERE clause.
1046      *
1047      * If given, $select is used as the SELECT parameter in the SQL query,
1048      * otherwise all records from the table are returned.
1049      *
1050      * Other arguments and the return type are like {@link function get_recordset}.
1051      *
1052      * @param string $table the table to query.
1053      * @param string $select A fragment of SQL to be used in a where clause in the SQL call.
1054      * @param array $params array of sql parameters
1055      * @param string $sort an order to sort the results in (optional, a valid SQL ORDER BY parameter).
1056      * @param string $fields a comma separated list of fields to return (optional, by default all fields are returned).
1057      * @param int $limitfrom return a subset of records, starting at this point (optional).
1058      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
1059      * @return moodle_recordset A moodle_recordset instance.
1060      * @throws dml_exception A DML specific exception is thrown for any errors.
1061      */
1062     public function get_recordset_select($table, $select, array $params=null, $sort='', $fields='*', $limitfrom=0, $limitnum=0) {
1063         $sql = "SELECT $fields FROM {".$table."}";
1064         if ($select) {
1065             $sql .= " WHERE $select";
1066         }
1067         if ($sort) {
1068             $sql .= " ORDER BY $sort";
1069         }
1070         return $this->get_recordset_sql($sql, $params, $limitfrom, $limitnum);
1071     }
1073     /**
1074      * Get a number of records as a moodle_recordset using a SQL statement.
1075      *
1076      * Since this method is a little less readable, use of it should be restricted to
1077      * code where it's possible there might be large datasets being returned.  For known
1078      * small datasets use get_records_sql - it leads to simpler code.
1079      *
1080      * The return type is like {@link function get_recordset}.
1081      *
1082      * @param string $sql the SQL select query to execute.
1083      * @param array $params array of sql parameters
1084      * @param int $limitfrom return a subset of records, starting at this point (optional).
1085      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
1086      * @return moodle_recordset A moodle_recordset instance.
1087      * @throws dml_exception A DML specific exception is thrown for any errors.
1088      */
1089     public abstract function get_recordset_sql($sql, array $params=null, $limitfrom=0, $limitnum=0);
1091     /**
1092      * Get a number of records as an array of objects where all the given conditions met.
1093      *
1094      * If the query succeeds and returns at least one record, the
1095      * return value is an array of objects, one object for each
1096      * record found. The array key is the value from the first
1097      * column of the result set. The object associated with that key
1098      * has a member variable for each column of the results.
1099      *
1100      * @param string $table the table to query.
1101      * @param array $conditions optional array $fieldname=>requestedvalue with AND in between
1102      * @param string $sort an order to sort the results in (optional, a valid SQL ORDER BY parameter).
1103      * @param string $fields a comma separated list of fields to return (optional, by default
1104      *   all fields are returned). The first field will be used as key for the
1105      *   array so must be a unique field such as 'id'.
1106      * @param int $limitfrom return a subset of records, starting at this point (optional).
1107      * @param int $limitnum return a subset comprising this many records in total (optional, required if $limitfrom is set).
1108      * @return array An array of Objects indexed by first column.
1109      * @throws dml_exception A DML specific exception is thrown for any errors.
1110      */
1111     public function get_records($table, array $conditions=null, $sort='', $fields='*', $limitfrom=0, $limitnum=0) {
1112         list($select, $params) = $this->where_clause($table, $conditions);
1113         return $this->get_records_select($table, $select, $params, $sort, $fields, $limitfrom, $limitnum);
1114     }
1116     /**
1117      * Get a number of records as an array of objects where one field match one list of values.
1118      *
1119      * Return value is like {@link function get_records}.
1120      *
1121      * @param string $table The database table to be checked against.
1122      * @param string $field The field to search
1123      * @param array $values An array of values
1124      * @param string $sort Sort order (as valid SQL sort parameter)
1125      * @param string $fields A comma separated list of fields to be returned from the chosen table. If specified,
1126      *   the first field should be a unique one such as 'id' since it will be used as a key in the associative
1127      *   array.
1128      * @param int $limitfrom return a subset of records, starting at this point (optional).
1129      * @param int $limitnum return a subset comprising this many records in total (optional).
1130      * @return array An array of objects indexed by first column
1131      * @throws dml_exception A DML specific exception is thrown for any errors.
1132      */
1133     public function get_records_list($table, $field, array $values, $sort='', $fields='*', $limitfrom=0, $limitnum=0) {
1134         list($select, $params) = $this->where_clause_list($field, $values);
1135         if (empty($select)) {
1136             // nothing to return
1137             return array();
1138         }
1139         return $this->get_records_select($table, $select, $params, $sort, $fields, $limitfrom, $limitnum);
1140     }
1142     /**
1143      * Get a number of records as an array of objects which match a particular WHERE clause.
1144      *
1145      * Return value is like {@link function get_records}.
1146      *
1147      * @param string $table The table to query.
1148      * @param string $select A fragment of SQL to be used in a where clause in the SQL call.
1149      * @param array $params An array of sql parameters
1150      * @param string $sort An order to sort the results in (optional, a valid SQL ORDER BY parameter).
1151      * @param string $fields A comma separated list of fields to return
1152      *   (optional, by default all fields are returned). The first field will be used as key for the
1153      *   array so must be a unique field such as 'id'.
1154      * @param int $limitfrom return a subset of records, starting at this point (optional).
1155      * @param int $limitnum return a subset comprising this many records in total (optional, required if $limitfrom is set).
1156      * @return array of objects indexed by first column
1157      * @throws dml_exception A DML specific exception is thrown for any errors.
1158      */
1159     public function get_records_select($table, $select, array $params=null, $sort='', $fields='*', $limitfrom=0, $limitnum=0) {
1160         if ($select) {
1161             $select = "WHERE $select";
1162         }
1163         if ($sort) {
1164             $sort = " ORDER BY $sort";
1165         }
1166         return $this->get_records_sql("SELECT $fields FROM {" . $table . "} $select $sort", $params, $limitfrom, $limitnum);
1167     }
1169     /**
1170      * Get a number of records as an array of objects using a SQL statement.
1171      *
1172      * Return value is like {@link function get_records}.
1173      *
1174      * @param string $sql the SQL select query to execute. The first column of this SELECT statement
1175      *   must be a unique value (usually the 'id' field), as it will be used as the key of the
1176      *   returned array.
1177      * @param array $params array of sql parameters
1178      * @param int $limitfrom return a subset of records, starting at this point (optional).
1179      * @param int $limitnum return a subset comprising this many records in total (optional, required if $limitfrom is set).
1180      * @return array of objects indexed by first column
1181      * @throws dml_exception A DML specific exception is thrown for any errors.
1182      */
1183     public abstract function get_records_sql($sql, array $params=null, $limitfrom=0, $limitnum=0);
1185     /**
1186      * Get the first two columns from a number of records as an associative array where all the given conditions met.
1187      *
1188      * Arguments are like {@link function get_recordset}.
1189      *
1190      * If no errors occur the return value
1191      * is an associative whose keys come from the first field of each record,
1192      * and whose values are the corresponding second fields.
1193      * False is returned if an error occurs.
1194      *
1195      * @param string $table the table to query.
1196      * @param array $conditions optional array $fieldname=>requestedvalue with AND in between
1197      * @param string $sort an order to sort the results in (optional, a valid SQL ORDER BY parameter).
1198      * @param string $fields a comma separated list of fields to return - the number of fields should be 2!
1199      * @param int $limitfrom return a subset of records, starting at this point (optional).
1200      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
1201      * @return array an associative array
1202      * @throws dml_exception A DML specific exception is thrown for any errors.
1203      */
1204     public function get_records_menu($table, array $conditions=null, $sort='', $fields='*', $limitfrom=0, $limitnum=0) {
1205         $menu = array();
1206         if ($records = $this->get_records($table, $conditions, $sort, $fields, $limitfrom, $limitnum)) {
1207             foreach ($records as $record) {
1208                 $record = (array)$record;
1209                 $key   = array_shift($record);
1210                 $value = array_shift($record);
1211                 $menu[$key] = $value;
1212             }
1213         }
1214         return $menu;
1215     }
1217     /**
1218      * Get the first two columns from a number of records as an associative array which match a particular WHERE clause.
1219      *
1220      * Arguments are like {@link function get_recordset_select}.
1221      * Return value is like {@link function get_records_menu}.
1222      *
1223      * @param string $table The database table to be checked against.
1224      * @param string $select A fragment of SQL to be used in a where clause in the SQL call.
1225      * @param array $params array of sql parameters
1226      * @param string $sort Sort order (optional) - a valid SQL order parameter
1227      * @param string $fields A comma separated list of fields to be returned from the chosen table - the number of fields should be 2!
1228      * @param int $limitfrom return a subset of records, starting at this point (optional).
1229      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
1230      * @return array an associative array
1231      * @throws dml_exception A DML specific exception is thrown for any errors.
1232      */
1233     public function get_records_select_menu($table, $select, array $params=null, $sort='', $fields='*', $limitfrom=0, $limitnum=0) {
1234         $menu = array();
1235         if ($records = $this->get_records_select($table, $select, $params, $sort, $fields, $limitfrom, $limitnum)) {
1236             foreach ($records as $record) {
1237                 $record = (array)$record;
1238                 $key   = array_shift($record);
1239                 $value = array_shift($record);
1240                 $menu[$key] = $value;
1241             }
1242         }
1243         return $menu;
1244     }
1246     /**
1247      * Get the first two columns from a number of records as an associative array using a SQL statement.
1248      *
1249      * Arguments are like {@link function get_recordset_sql}.
1250      * Return value is like {@link function get_records_menu}.
1251      *
1252      * @param string $sql The SQL string you wish to be executed.
1253      * @param array $params array of sql parameters
1254      * @param int $limitfrom return a subset of records, starting at this point (optional).
1255      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
1256      * @return array an associative array
1257      * @throws dml_exception A DML specific exception is thrown for any errors.
1258      */
1259     public function get_records_sql_menu($sql, array $params=null, $limitfrom=0, $limitnum=0) {
1260         $menu = array();
1261         if ($records = $this->get_records_sql($sql, $params, $limitfrom, $limitnum)) {
1262             foreach ($records as $record) {
1263                 $record = (array)$record;
1264                 $key   = array_shift($record);
1265                 $value = array_shift($record);
1266                 $menu[$key] = $value;
1267             }
1268         }
1269         return $menu;
1270     }
1272     /**
1273      * Get a single database record as an object where all the given conditions met.
1274      *
1275      * @param string $table The table to select from.
1276      * @param array $conditions optional array $fieldname=>requestedvalue with AND in between
1277      * @param string $fields A comma separated list of fields to be returned from the chosen table.
1278      * @param int $strictness IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found;
1279      *                        IGNORE_MULTIPLE means return first, ignore multiple records found(not recommended);
1280      *                        MUST_EXIST means we will throw an exception if no record or multiple records found.
1281      *
1282      * @todo MDL-30407 MUST_EXIST option should not throw a dml_exception, it should throw a different exception as it's a requested check.
1283      * @return mixed a fieldset object containing the first matching record, false or exception if error not found depending on mode
1284      * @throws dml_exception A DML specific exception is thrown for any errors.
1285      */
1286     public function get_record($table, array $conditions, $fields='*', $strictness=IGNORE_MISSING) {
1287         list($select, $params) = $this->where_clause($table, $conditions);
1288         return $this->get_record_select($table, $select, $params, $fields, $strictness);
1289     }
1291     /**
1292      * Get a single database record as an object which match a particular WHERE clause.
1293      *
1294      * @param string $table The database table to be checked against.
1295      * @param string $select A fragment of SQL to be used in a where clause in the SQL call.
1296      * @param array $params array of sql parameters
1297      * @param string $fields A comma separated list of fields to be returned from the chosen table.
1298      * @param int $strictness IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found;
1299      *                        IGNORE_MULTIPLE means return first, ignore multiple records found(not recommended);
1300      *                        MUST_EXIST means throw exception if no record or multiple records found
1301      * @return stdClass|false a fieldset object containing the first matching record, false or exception if error not found depending on mode
1302      * @throws dml_exception A DML specific exception is thrown for any errors.
1303      */
1304     public function get_record_select($table, $select, array $params=null, $fields='*', $strictness=IGNORE_MISSING) {
1305         if ($select) {
1306             $select = "WHERE $select";
1307         }
1308         try {
1309             return $this->get_record_sql("SELECT $fields FROM {" . $table . "} $select", $params, $strictness);
1310         } catch (dml_missing_record_exception $e) {
1311             // create new exception which will contain correct table name
1312             throw new dml_missing_record_exception($table, $e->sql, $e->params);
1313         }
1314     }
1316     /**
1317      * Get a single database record as an object using a SQL statement.
1318      *
1319      * The SQL statement should normally only return one record.
1320      * It is recommended to use get_records_sql() if more matches possible!
1321      *
1322      * @param string $sql The SQL string you wish to be executed, should normally only return one record.
1323      * @param array $params array of sql parameters
1324      * @param int $strictness IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found;
1325      *                        IGNORE_MULTIPLE means return first, ignore multiple records found(not recommended);
1326      *                        MUST_EXIST means throw exception if no record or multiple records found
1327      * @return mixed a fieldset object containing the first matching record, false or exception if error not found depending on mode
1328      * @throws dml_exception A DML specific exception is thrown for any errors.
1329      */
1330     public function get_record_sql($sql, array $params=null, $strictness=IGNORE_MISSING) {
1331         $strictness = (int)$strictness; // we support true/false for BC reasons too
1332         if ($strictness == IGNORE_MULTIPLE) {
1333             $count = 1;
1334         } else {
1335             $count = 0;
1336         }
1337         if (!$records = $this->get_records_sql($sql, $params, 0, $count)) {
1338             // not found
1339             if ($strictness == MUST_EXIST) {
1340                 throw new dml_missing_record_exception('', $sql, $params);
1341             }
1342             return false;
1343         }
1345         if (count($records) > 1) {
1346             if ($strictness == MUST_EXIST) {
1347                 throw new dml_multiple_records_exception($sql, $params);
1348             }
1349             debugging('Error: mdb->get_record() found more than one record!');
1350         }
1352         $return = reset($records);
1353         return $return;
1354     }
1356     /**
1357      * Get a single field value from a table record where all the given conditions met.
1358      *
1359      * @param string $table the table to query.
1360      * @param string $return the field to return the value of.
1361      * @param array $conditions optional array $fieldname=>requestedvalue with AND in between
1362      * @param int $strictness IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found;
1363      *                        IGNORE_MULTIPLE means return first, ignore multiple records found(not recommended);
1364      *                        MUST_EXIST means throw exception if no record or multiple records found
1365      * @return mixed the specified value false if not found
1366      * @throws dml_exception A DML specific exception is thrown for any errors.
1367      */
1368     public function get_field($table, $return, array $conditions, $strictness=IGNORE_MISSING) {
1369         list($select, $params) = $this->where_clause($table, $conditions);
1370         return $this->get_field_select($table, $return, $select, $params, $strictness);
1371     }
1373     /**
1374      * Get a single field value from a table record which match a particular WHERE clause.
1375      *
1376      * @param string $table the table to query.
1377      * @param string $return the field to return the value of.
1378      * @param string $select A fragment of SQL to be used in a where clause returning one row with one column
1379      * @param array $params array of sql parameters
1380      * @param int $strictness IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found;
1381      *                        IGNORE_MULTIPLE means return first, ignore multiple records found(not recommended);
1382      *                        MUST_EXIST means throw exception if no record or multiple records found
1383      * @return mixed the specified value false if not found
1384      * @throws dml_exception A DML specific exception is thrown for any errors.
1385      */
1386     public function get_field_select($table, $return, $select, array $params=null, $strictness=IGNORE_MISSING) {
1387         if ($select) {
1388             $select = "WHERE $select";
1389         }
1390         try {
1391             return $this->get_field_sql("SELECT $return FROM {" . $table . "} $select", $params, $strictness);
1392         } catch (dml_missing_record_exception $e) {
1393             // create new exception which will contain correct table name
1394             throw new dml_missing_record_exception($table, $e->sql, $e->params);
1395         }
1396     }
1398     /**
1399      * Get a single field value (first field) using a SQL statement.
1400      *
1401      * @param string $sql The SQL query returning one row with one column
1402      * @param array $params array of sql parameters
1403      * @param int $strictness IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found;
1404      *                        IGNORE_MULTIPLE means return first, ignore multiple records found(not recommended);
1405      *                        MUST_EXIST means throw exception if no record or multiple records found
1406      * @return mixed the specified value false if not found
1407      * @throws dml_exception A DML specific exception is thrown for any errors.
1408      */
1409     public function get_field_sql($sql, array $params=null, $strictness=IGNORE_MISSING) {
1410         if (!$record = $this->get_record_sql($sql, $params, $strictness)) {
1411             return false;
1412         }
1414         $record = (array)$record;
1415         return reset($record); // first column
1416     }
1418     /**
1419      * Selects records and return values of chosen field as an array which match a particular WHERE clause.
1420      *
1421      * @param string $table the table to query.
1422      * @param string $return the field we are intered in
1423      * @param string $select A fragment of SQL to be used in a where clause in the SQL call.
1424      * @param array $params array of sql parameters
1425      * @return array of values
1426      * @throws dml_exception A DML specific exception is thrown for any errors.
1427      */
1428     public function get_fieldset_select($table, $return, $select, array $params=null) {
1429         if ($select) {
1430             $select = "WHERE $select";
1431         }
1432         return $this->get_fieldset_sql("SELECT $return FROM {" . $table . "} $select", $params);
1433     }
1435     /**
1436      * Selects records and return values (first field) as an array using a SQL statement.
1437      *
1438      * @param string $sql The SQL query
1439      * @param array $params array of sql parameters
1440      * @return array of values
1441      * @throws dml_exception A DML specific exception is thrown for any errors.
1442      */
1443     public abstract function get_fieldset_sql($sql, array $params=null);
1445     /**
1446      * Insert new record into database, as fast as possible, no safety checks, lobs not supported.
1447      * @param string $table name
1448      * @param mixed $params data record as object or array
1449      * @param bool $returnid Returns id of inserted record.
1450      * @param bool $bulk true means repeated inserts expected
1451      * @param bool $customsequence true if 'id' included in $params, disables $returnid
1452      * @return bool|int true or new id
1453      * @throws dml_exception A DML specific exception is thrown for any errors.
1454      */
1455     public abstract function insert_record_raw($table, $params, $returnid=true, $bulk=false, $customsequence=false);
1457     /**
1458      * Insert a record into a table and return the "id" field if required.
1459      *
1460      * Some conversions and safety checks are carried out. Lobs are supported.
1461      * If the return ID isn't required, then this just reports success as true/false.
1462      * $data is an object containing needed data
1463      * @param string $table The database table to be inserted into
1464      * @param object $dataobject A data object with values for one or more fields in the record
1465      * @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.
1466      * @param bool $bulk Set to true is multiple inserts are expected
1467      * @return bool|int true or new id
1468      * @throws dml_exception A DML specific exception is thrown for any errors.
1469      */
1470     public abstract function insert_record($table, $dataobject, $returnid=true, $bulk=false);
1472     /**
1473      * Import a record into a table, id field is required.
1474      * Safety checks are NOT carried out. Lobs are supported.
1475      *
1476      * @param string $table name of database table to be inserted into
1477      * @param object $dataobject A data object with values for one or more fields in the record
1478      * @return bool true
1479      * @throws dml_exception A DML specific exception is thrown for any errors.
1480      */
1481     public abstract function import_record($table, $dataobject);
1483     /**
1484      * Update record in database, as fast as possible, no safety checks, lobs not supported.
1485      * @param string $table name
1486      * @param mixed $params data record as object or array
1487      * @param bool $bulk True means repeated updates expected.
1488      * @return bool true
1489      * @throws dml_exception A DML specific exception is thrown for any errors.
1490      */
1491     public abstract function update_record_raw($table, $params, $bulk=false);
1493     /**
1494      * Update a record in a table
1495      *
1496      * $dataobject is an object containing needed data
1497      * Relies on $dataobject having a variable "id" to
1498      * specify the record to update
1499      *
1500      * @param string $table The database table to be checked against.
1501      * @param object $dataobject An object with contents equal to fieldname=>fieldvalue. Must have an entry for 'id' to map to the table specified.
1502      * @param bool $bulk True means repeated updates expected.
1503      * @return bool true
1504      * @throws dml_exception A DML specific exception is thrown for any errors.
1505      */
1506     public abstract function update_record($table, $dataobject, $bulk=false);
1509     /**
1510      * Set a single field in every table record where all the given conditions met.
1511      *
1512      * @param string $table The database table to be checked against.
1513      * @param string $newfield the field to set.
1514      * @param string $newvalue the value to set the field to.
1515      * @param array $conditions optional array $fieldname=>requestedvalue with AND in between
1516      * @return bool true
1517      * @throws dml_exception A DML specific exception is thrown for any errors.
1518      */
1519     public function set_field($table, $newfield, $newvalue, array $conditions=null) {
1520         list($select, $params) = $this->where_clause($table, $conditions);
1521         return $this->set_field_select($table, $newfield, $newvalue, $select, $params);
1522     }
1524     /**
1525      * Set a single field in every table record which match a particular WHERE clause.
1526      *
1527      * @param string $table The database table to be checked against.
1528      * @param string $newfield the field to set.
1529      * @param string $newvalue the value to set the field to.
1530      * @param string $select A fragment of SQL to be used in a where clause in the SQL call.
1531      * @param array $params array of sql parameters
1532      * @return bool true
1533      * @throws dml_exception A DML specific exception is thrown for any errors.
1534      */
1535     public abstract function set_field_select($table, $newfield, $newvalue, $select, array $params=null);
1538     /**
1539      * Count the records in a table where all the given conditions met.
1540      *
1541      * @param string $table The table to query.
1542      * @param array $conditions optional array $fieldname=>requestedvalue with AND in between
1543      * @return int The count of records returned from the specified criteria.
1544      * @throws dml_exception A DML specific exception is thrown for any errors.
1545      */
1546     public function count_records($table, array $conditions=null) {
1547         list($select, $params) = $this->where_clause($table, $conditions);
1548         return $this->count_records_select($table, $select, $params);
1549     }
1551     /**
1552      * Count the records in a table which match a particular WHERE clause.
1553      *
1554      * @param string $table The database table to be checked against.
1555      * @param string $select A fragment of SQL to be used in a WHERE clause in the SQL call.
1556      * @param array $params array of sql parameters
1557      * @param string $countitem The count string to be used in the SQL call. Default is COUNT('x').
1558      * @return int The count of records returned from the specified criteria.
1559      * @throws dml_exception A DML specific exception is thrown for any errors.
1560      */
1561     public function count_records_select($table, $select, array $params=null, $countitem="COUNT('x')") {
1562         if ($select) {
1563             $select = "WHERE $select";
1564         }
1565         return $this->count_records_sql("SELECT $countitem FROM {" . $table . "} $select", $params);
1566     }
1568     /**
1569      * Get the result of a SQL SELECT COUNT(...) query.
1570      *
1571      * Given a query that counts rows, return that count. (In fact,
1572      * given any query, return the first field of the first record
1573      * returned. However, this method should only be used for the
1574      * intended purpose.) If an error occurs, 0 is returned.
1575      *
1576      * @param string $sql The SQL string you wish to be executed.
1577      * @param array $params array of sql parameters
1578      * @return int the count
1579      * @throws dml_exception A DML specific exception is thrown for any errors.
1580      */
1581     public function count_records_sql($sql, array $params=null) {
1582         if ($count = $this->get_field_sql($sql, $params)) {
1583             return $count;
1584         } else {
1585             return 0;
1586         }
1587     }
1589     /**
1590      * Test whether a record exists in a table where all the given conditions met.
1591      *
1592      * @param string $table The table to check.
1593      * @param array $conditions optional array $fieldname=>requestedvalue with AND in between
1594      * @return bool true if a matching record exists, else false.
1595      * @throws dml_exception A DML specific exception is thrown for any errors.
1596      */
1597     public function record_exists($table, array $conditions) {
1598         list($select, $params) = $this->where_clause($table, $conditions);
1599         return $this->record_exists_select($table, $select, $params);
1600     }
1602     /**
1603      * Test whether any records exists in a table which match a particular WHERE clause.
1604      *
1605      * @param string $table The database table to be checked against.
1606      * @param string $select A fragment of SQL to be used in a WHERE clause in the SQL call.
1607      * @param array $params array of sql parameters
1608      * @return bool true if a matching record exists, else false.
1609      * @throws dml_exception A DML specific exception is thrown for any errors.
1610      */
1611     public function record_exists_select($table, $select, array $params=null) {
1612         if ($select) {
1613             $select = "WHERE $select";
1614         }
1615         return $this->record_exists_sql("SELECT 'x' FROM {" . $table . "} $select", $params);
1616     }
1618     /**
1619      * Test whether a SQL SELECT statement returns any records.
1620      *
1621      * This function returns true if the SQL statement executes
1622      * without any errors and returns at least one record.
1623      *
1624      * @param string $sql The SQL statement to execute.
1625      * @param array $params array of sql parameters
1626      * @return bool true if the SQL executes without errors and returns at least one record.
1627      * @throws dml_exception A DML specific exception is thrown for any errors.
1628      */
1629     public function record_exists_sql($sql, array $params=null) {
1630         $mrs = $this->get_recordset_sql($sql, $params, 0, 1);
1631         $return = $mrs->valid();
1632         $mrs->close();
1633         return $return;
1634     }
1636     /**
1637      * Delete the records from a table where all the given conditions met.
1638      * If conditions not specified, table is truncated.
1639      *
1640      * @param string $table the table to delete from.
1641      * @param array $conditions optional array $fieldname=>requestedvalue with AND in between
1642      * @return bool true.
1643      * @throws dml_exception A DML specific exception is thrown for any errors.
1644      */
1645     public function delete_records($table, array $conditions=null) {
1646         // truncate is drop/create (DDL), not transactional safe,
1647         // so we don't use the shortcut within them. MDL-29198
1648         if (is_null($conditions) && empty($this->transactions)) {
1649             return $this->execute("TRUNCATE TABLE {".$table."}");
1650         }
1651         list($select, $params) = $this->where_clause($table, $conditions);
1652         return $this->delete_records_select($table, $select, $params);
1653     }
1655     /**
1656      * Delete the records from a table where one field match one list of values.
1657      *
1658      * @param string $table the table to delete from.
1659      * @param string $field The field to search
1660      * @param array $values array of values
1661      * @return bool true.
1662      * @throws dml_exception A DML specific exception is thrown for any errors.
1663      */
1664     public function delete_records_list($table, $field, array $values) {
1665         list($select, $params) = $this->where_clause_list($field, $values);
1666         if (empty($select)) {
1667             // nothing to delete
1668             return true;
1669         }
1670         return $this->delete_records_select($table, $select, $params);
1671     }
1673     /**
1674      * Delete one or more records from a table which match a particular WHERE clause.
1675      *
1676      * @param string $table The database table to be checked against.
1677      * @param string $select A fragment of SQL to be used in a where clause in the SQL call (used to define the selection criteria).
1678      * @param array $params array of sql parameters
1679      * @return bool true.
1680      * @throws dml_exception A DML specific exception is thrown for any errors.
1681      */
1682     public abstract function delete_records_select($table, $select, array $params=null);
1686 // sql constructs
1687     /**
1688      * Returns the FROM clause required by some DBs in all SELECT statements.
1689      *
1690      * To be used in queries not having FROM clause to provide cross_db
1691      * Most DBs don't need it, hence the default is ''
1692      * @return string
1693      */
1694     public function sql_null_from_clause() {
1695         return '';
1696     }
1698     /**
1699      * Returns the SQL text to be used in order to perform one bitwise AND operation
1700      * between 2 integers.
1701      *
1702      * NOTE: The SQL result is a number and can not be used directly in
1703      *       SQL condition, please compare it to some number to get a bool!!
1704      *
1705      * @param int $int1 First integer in the operation.
1706      * @param int $int2 Second integer in the operation.
1707      * @return string The piece of SQL code to be used in your statement.
1708      */
1709     public function sql_bitand($int1, $int2) {
1710         return '((' . $int1 . ') & (' . $int2 . '))';
1711     }
1713     /**
1714      * Returns the SQL text to be used in order to perform one bitwise NOT operation
1715      * with 1 integer.
1716      *
1717      * @param int $int1 The operand integer in the operation.
1718      * @return string The piece of SQL code to be used in your statement.
1719      */
1720     public function sql_bitnot($int1) {
1721         return '(~(' . $int1 . '))';
1722     }
1724     /**
1725      * Returns the SQL text to be used in order to perform one bitwise OR operation
1726      * between 2 integers.
1727      *
1728      * NOTE: The SQL result is a number and can not be used directly in
1729      *       SQL condition, please compare it to some number to get a bool!!
1730      *
1731      * @param int $int1 The first operand integer in the operation.
1732      * @param int $int2 The second operand integer in the operation.
1733      * @return string The piece of SQL code to be used in your statement.
1734      */
1735     public function sql_bitor($int1, $int2) {
1736         return '((' . $int1 . ') | (' . $int2 . '))';
1737     }
1739     /**
1740      * Returns the SQL text to be used in order to perform one bitwise XOR operation
1741      * between 2 integers.
1742      *
1743      * NOTE: The SQL result is a number and can not be used directly in
1744      *       SQL condition, please compare it to some number to get a bool!!
1745      *
1746      * @param int $int1 The first operand integer in the operation.
1747      * @param int $int2 The second operand integer in the operation.
1748      * @return string The piece of SQL code to be used in your statement.
1749      */
1750     public function sql_bitxor($int1, $int2) {
1751         return '((' . $int1 . ') ^ (' . $int2 . '))';
1752     }
1754     /**
1755      * Returns the SQL text to be used in order to perform module '%'
1756      * operation - remainder after division
1757      *
1758      * @param int $int1 The first operand integer in the operation.
1759      * @param int $int2 The second operand integer in the operation.
1760      * @return string The piece of SQL code to be used in your statement.
1761      */
1762     public function sql_modulo($int1, $int2) {
1763         return '((' . $int1 . ') % (' . $int2 . '))';
1764     }
1766     /**
1767      * Returns the cross db correct CEIL (ceiling) expression applied to fieldname.
1768      * note: Most DBs use CEIL(), hence it's the default here.
1769      *
1770      * @param string $fieldname The field (or expression) we are going to ceil.
1771      * @return string The piece of SQL code to be used in your ceiling statement.
1772      */
1773     public function sql_ceil($fieldname) {
1774         return ' CEIL(' . $fieldname . ')';
1775     }
1777     /**
1778      * Returns the SQL to be used in order to CAST one CHAR column to INTEGER.
1779      *
1780      * Be aware that the CHAR column you're trying to cast contains really
1781      * int values or the RDBMS will throw an error!
1782      *
1783      * @param string $fieldname The name of the field to be casted.
1784      * @param bool $text Specifies if the original column is one TEXT (CLOB) column (true). Defaults to false.
1785      * @return string The piece of SQL code to be used in your statement.
1786      */
1787     public function sql_cast_char2int($fieldname, $text=false) {
1788         return ' ' . $fieldname . ' ';
1789     }
1791     /**
1792      * Returns the SQL to be used in order to CAST one CHAR column to REAL number.
1793      *
1794      * Be aware that the CHAR column you're trying to cast contains really
1795      * numbers or the RDBMS will throw an error!
1796      *
1797      * @param string $fieldname The name of the field to be casted.
1798      * @param bool $text Specifies if the original column is one TEXT (CLOB) column (true). Defaults to false.
1799      * @return string The piece of SQL code to be used in your statement.
1800      */
1801     public function sql_cast_char2real($fieldname, $text=false) {
1802         return ' ' . $fieldname . ' ';
1803     }
1805     /**
1806      * Returns the SQL to be used in order to an UNSIGNED INTEGER column to SIGNED.
1807      *
1808      * (Only MySQL needs this. MySQL things that 1 * -1 = 18446744073709551615
1809      * if the 1 comes from an unsigned column).
1810      *
1811      * @deprecated since 2.3
1812      * @param string $fieldname The name of the field to be cast
1813      * @return string The piece of SQL code to be used in your statement.
1814      */
1815     public function sql_cast_2signed($fieldname) {
1816         return ' ' . $fieldname . ' ';
1817     }
1819     /**
1820      * Returns the SQL text to be used to compare one TEXT (clob) column with
1821      * one varchar column, because some RDBMS doesn't support such direct
1822      * comparisons.
1823      *
1824      * @param string $fieldname The name of the TEXT field we need to order by
1825      * @param int $numchars Number of chars to use for the ordering (defaults to 32).
1826      * @return string The piece of SQL code to be used in your statement.
1827      */
1828     public function sql_compare_text($fieldname, $numchars=32) {
1829         return $this->sql_order_by_text($fieldname, $numchars);
1830     }
1832     /**
1833      * Returns 'LIKE' part of a query.
1834      *
1835      * @param string $fieldname Usually the name of the table column.
1836      * @param string $param Usually the bound query parameter (?, :named).
1837      * @param bool $casesensitive Use case sensitive search when set to true (default).
1838      * @param bool $accentsensitive Use accent sensitive search when set to true (default). (not all databases support accent insensitive)
1839      * @param bool $notlike True means "NOT LIKE".
1840      * @param string $escapechar The escape char for '%' and '_'.
1841      * @return string The SQL code fragment.
1842      */
1843     public function sql_like($fieldname, $param, $casesensitive = true, $accentsensitive = true, $notlike = false, $escapechar = '\\') {
1844         if (strpos($param, '%') !== false) {
1845             debugging('Potential SQL injection detected, sql_like() expects bound parameters (? or :named)');
1846         }
1847         $LIKE = $notlike ? 'NOT LIKE' : 'LIKE';
1848         // by default ignore any sensitiveness - each database does it in a different way
1849         return "$fieldname $LIKE $param ESCAPE '$escapechar'";
1850     }
1852     /**
1853      * Escape sql LIKE special characters like '_' or '%'.
1854      * @param string $text The string containing characters needing escaping.
1855      * @param string $escapechar The desired escape character, defaults to '\\'.
1856      * @return string The escaped sql LIKE string.
1857      */
1858     public function sql_like_escape($text, $escapechar = '\\') {
1859         $text = str_replace('_', $escapechar.'_', $text);
1860         $text = str_replace('%', $escapechar.'%', $text);
1861         return $text;
1862     }
1864     /**
1865      * Returns the proper SQL to do CONCAT between the elements(fieldnames) passed.
1866      *
1867      * This function accepts variable number of string parameters.
1868      * All strings/fieldnames will used in the SQL concatenate statement generated.
1869      *
1870      * @return string The SQL to concatenate strings passed in.
1871      * @uses func_get_args()  and thus parameters are unlimited OPTIONAL number of additional field names.
1872      */
1873     public abstract function sql_concat();
1875     /**
1876      * Returns the proper SQL to do CONCAT between the elements passed
1877      * with a given separator
1878      *
1879      * @param string $separator The separator desired for the SQL concatenating $elements.
1880      * @param array  $elements The array of strings to be concatenated.
1881      * @return string The SQL to concatenate the strings.
1882      */
1883     public abstract function sql_concat_join($separator="' '", $elements=array());
1885     /**
1886      * Returns the proper SQL (for the dbms in use) to concatenate $firstname and $lastname
1887      *
1888      * @todo MDL-31233 This may not be needed here.
1889      *
1890      * @param string $first User's first name (default:'firstname').
1891      * @param string $last User's last name (default:'lastname').
1892      * @return string The SQL to concatenate strings.
1893      */
1894     function sql_fullname($first='firstname', $last='lastname') {
1895         return $this->sql_concat($first, "' '", $last);
1896     }
1898     /**
1899      * Returns the SQL text to be used to order by one TEXT (clob) column, because
1900      * some RDBMS doesn't support direct ordering of such fields.
1901      *
1902      * Note that the use or queries being ordered by TEXT columns must be minimised,
1903      * because it's really slooooooow.
1904      *
1905      * @param string $fieldname The name of the TEXT field we need to order by.
1906      * @param string $numchars The number of chars to use for the ordering (defaults to 32).
1907      * @return string The piece of SQL code to be used in your statement.
1908      */
1909     public function sql_order_by_text($fieldname, $numchars=32) {
1910         return $fieldname;
1911     }
1913     /**
1914      * Returns the SQL text to be used to calculate the length in characters of one expression.
1915      * @param string $fieldname The fieldname/expression to calculate its length in characters.
1916      * @return string the piece of SQL code to be used in the statement.
1917      */
1918     public function sql_length($fieldname) {
1919         return ' LENGTH(' . $fieldname . ')';
1920     }
1922     /**
1923      * Returns the proper substr() SQL text used to extract substrings from DB
1924      * NOTE: this was originally returning only function name
1925      *
1926      * @param string $expr Some string field, no aggregates.
1927      * @param mixed $start Integer or expression evaluating to integer (1 based value; first char has index 1)
1928      * @param mixed $length Optional integer or expression evaluating to integer.
1929      * @return string The sql substring extraction fragment.
1930      */
1931     public function sql_substr($expr, $start, $length=false) {
1932         if (count(func_get_args()) < 2) {
1933             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.');
1934         }
1935         if ($length === false) {
1936             return "SUBSTR($expr, $start)";
1937         } else {
1938             return "SUBSTR($expr, $start, $length)";
1939         }
1940     }
1942     /**
1943      * Returns the SQL for returning searching one string for the location of another.
1944      *
1945      * Note, there is no guarantee which order $needle, $haystack will be in
1946      * the resulting SQL so when using this method, and both arguments contain
1947      * placeholders, you should use named placeholders.
1948      *
1949      * @param string $needle the SQL expression that will be searched for.
1950      * @param string $haystack the SQL expression that will be searched in.
1951      * @return string The required searching SQL part.
1952      */
1953     public function sql_position($needle, $haystack) {
1954         // Implementation using standard SQL.
1955         return "POSITION(($needle) IN ($haystack))";
1956     }
1958     /**
1959      * Returns the empty string char used by every supported DB. To be used when
1960      * we are searching for that values in our queries. Only Oracle uses this
1961      * for now (will be out, once we migrate to proper NULLs if that days arrives)
1962      * @return string An empty string.
1963      */
1964     function sql_empty() {
1965         return '';
1966     }
1968     /**
1969      * Returns the proper SQL to know if one field is empty.
1970      *
1971      * Note that the function behavior strongly relies on the
1972      * parameters passed describing the field so, please,  be accurate
1973      * when specifying them.
1974      *
1975      * Also, note that this function is not suitable to look for
1976      * fields having NULL contents at all. It's all for empty values!
1977      *
1978      * This function should be applied in all the places where conditions of
1979      * the type:
1980      *
1981      *     ... AND fieldname = '';
1982      *
1983      * are being used. Final result should be:
1984      *
1985      *     ... AND ' . sql_isempty('tablename', 'fieldname', true/false, true/false);
1986      *
1987      * (see parameters description below)
1988      *
1989      * @param string $tablename Name of the table (without prefix). Not used for now but can be
1990      *                          necessary in the future if we want to use some introspection using
1991      *                          meta information against the DB. /// TODO ///
1992      * @param string $fieldname Name of the field we are going to check
1993      * @param bool $nullablefield For specifying if the field is nullable (true) or no (false) in the DB.
1994      * @param bool $textfield For specifying if it is a text (also called clob) field (true) or a varchar one (false)
1995      * @return string the sql code to be added to check for empty values
1996      */
1997     public function sql_isempty($tablename, $fieldname, $nullablefield, $textfield) {
1998         return " ($fieldname = '') ";
1999     }
2001     /**
2002      * Returns the proper SQL to know if one field is not empty.
2003      *
2004      * Note that the function behavior strongly relies on the
2005      * parameters passed describing the field so, please,  be accurate
2006      * when specifying them.
2007      *
2008      * This function should be applied in all the places where conditions of
2009      * the type:
2010      *
2011      *     ... AND fieldname != '';
2012      *
2013      * are being used. Final result should be:
2014      *
2015      *     ... AND ' . sql_isnotempty('tablename', 'fieldname', true/false, true/false);
2016      *
2017      * (see parameters description below)
2018      *
2019      * @param string $tablename Name of the table (without prefix). This is not used for now but can be
2020      *                          necessary in the future if we want to use some introspection using
2021      *                          meta information against the DB.
2022      * @param string $fieldname The name of the field we are going to check.
2023      * @param bool $nullablefield Specifies if the field is nullable (true) or not (false) in the DB.
2024      * @param bool $textfield Specifies if it is a text (also called clob) field (true) or a varchar one (false).
2025      * @return string The sql code to be added to check for non empty values.
2026      */
2027     public function sql_isnotempty($tablename, $fieldname, $nullablefield, $textfield) {
2028         return ' ( NOT ' . $this->sql_isempty($tablename, $fieldname, $nullablefield, $textfield) . ') ';
2029     }
2031     /**
2032      * Returns true if this database driver supports regex syntax when searching.
2033      * @return bool True if supported.
2034      */
2035     public function sql_regex_supported() {
2036         return false;
2037     }
2039     /**
2040      * Returns the driver specific syntax (SQL part) for matching regex positively or negatively (inverted matching).
2041      * Eg: 'REGEXP':'NOT REGEXP' or '~*' : '!~*'
2042      * @param bool $positivematch
2043      * @return string or empty if not supported
2044      */
2045     public function sql_regex($positivematch=true) {
2046         return '';
2047     }
2049 // transactions
2051     /**
2052      * Checks and returns true if transactions are supported.
2053      *
2054      * It is not responsible to run productions servers
2055      * on databases without transaction support ;-)
2056      *
2057      * Override in driver if needed.
2058      *
2059      * @return bool
2060      */
2061     protected function transactions_supported() {
2062         // protected for now, this might be changed to public if really necessary
2063         return true;
2064     }
2066     /**
2067      * Returns true if a transaction is in progress.
2068      * @return bool
2069      */
2070     public function is_transaction_started() {
2071         return !empty($this->transactions);
2072     }
2074     /**
2075      * This is a test that throws an exception if transaction in progress.
2076      * This test does not force rollback of active transactions.
2077      * @return void
2078      */
2079     public function transactions_forbidden() {
2080         if ($this->is_transaction_started()) {
2081             throw new dml_transaction_exception('This code can not be excecuted in transaction');
2082         }
2083     }
2085     /**
2086      * On DBs that support it, switch to transaction mode and begin a transaction
2087      * you'll need to ensure you call allow_commit() on the returned object
2088      * or your changes *will* be lost.
2089      *
2090      * this is _very_ useful for massive updates
2091      *
2092      * Delegated database transactions can be nested, but only one actual database
2093      * transaction is used for the outer-most delegated transaction. This method
2094      * returns a transaction object which you should keep until the end of the
2095      * delegated transaction. The actual database transaction will
2096      * only be committed if all the nested delegated transactions commit
2097      * successfully. If any part of the transaction rolls back then the whole
2098      * thing is rolled back.
2099      *
2100      * @return moodle_transaction
2101      */
2102     public function start_delegated_transaction() {
2103         $transaction = new moodle_transaction($this);
2104         $this->transactions[] = $transaction;
2105         if (count($this->transactions) == 1) {
2106             $this->begin_transaction();
2107         }
2108         return $transaction;
2109     }
2111     /**
2112      * Driver specific start of real database transaction,
2113      * this can not be used directly in code.
2114      * @return void
2115      */
2116     protected abstract function begin_transaction();
2118     /**
2119      * Indicates delegated transaction finished successfully.
2120      * The real database transaction is committed only if
2121      * all delegated transactions committed.
2122      * @param moodle_transaction $transaction The transaction to commit
2123      * @return void
2124      * @throws dml_transaction_exception Creates and throws transaction related exceptions.
2125      */
2126     public function commit_delegated_transaction(moodle_transaction $transaction) {
2127         if ($transaction->is_disposed()) {
2128             throw new dml_transaction_exception('Transactions already disposed', $transaction);
2129         }
2130         // mark as disposed so that it can not be used again
2131         $transaction->dispose();
2133         if (empty($this->transactions)) {
2134             throw new dml_transaction_exception('Transaction not started', $transaction);
2135         }
2137         if ($this->force_rollback) {
2138             throw new dml_transaction_exception('Tried to commit transaction after lower level rollback', $transaction);
2139         }
2141         if ($transaction !== $this->transactions[count($this->transactions) - 1]) {
2142             // one incorrect commit at any level rollbacks everything
2143             $this->force_rollback = true;
2144             throw new dml_transaction_exception('Invalid transaction commit attempt', $transaction);
2145         }
2147         if (count($this->transactions) == 1) {
2148             // only commit the top most level
2149             $this->commit_transaction();
2150         }
2151         array_pop($this->transactions);
2152     }
2154     /**
2155      * Driver specific commit of real database transaction,
2156      * this can not be used directly in code.
2157      * @return void
2158      */
2159     protected abstract function commit_transaction();
2161     /**
2162      * Call when delegated transaction failed, this rolls back
2163      * all delegated transactions up to the top most level.
2164      *
2165      * In many cases you do not need to call this method manually,
2166      * because all open delegated transactions are rolled back
2167      * automatically if exceptions not caught.
2168      *
2169      * @param moodle_transaction $transaction An instance of a moodle_transaction.
2170      * @param Exception $e The related exception to this transaction rollback.
2171      * @return void This does not return, instead the exception passed in will be rethrown.
2172      */
2173     public function rollback_delegated_transaction(moodle_transaction $transaction, Exception $e) {
2174         if ($transaction->is_disposed()) {
2175             throw new dml_transaction_exception('Transactions already disposed', $transaction);
2176         }
2177         // mark as disposed so that it can not be used again
2178         $transaction->dispose();
2180         // one rollback at any level rollbacks everything
2181         $this->force_rollback = true;
2183         if (empty($this->transactions) or $transaction !== $this->transactions[count($this->transactions) - 1]) {
2184             // this may or may not be a coding problem, better just rethrow the exception,
2185             // because we do not want to loose the original $e
2186             throw $e;
2187         }
2189         if (count($this->transactions) == 1) {
2190             // only rollback the top most level
2191             $this->rollback_transaction();
2192         }
2193         array_pop($this->transactions);
2194         if (empty($this->transactions)) {
2195             // finally top most level rolled back
2196             $this->force_rollback = false;
2197         }
2198         throw $e;
2199     }
2201     /**
2202      * Driver specific abort of real database transaction,
2203      * this can not be used directly in code.
2204      * @return void
2205      */
2206     protected abstract function rollback_transaction();
2208     /**
2209      * Force rollback of all delegated transaction.
2210      * Does not throw any exceptions and does not log anything.
2211      *
2212      * This method should be used only from default exception handlers and other
2213      * core code.
2214      *
2215      * @return void
2216      */
2217     public function force_transaction_rollback() {
2218         if ($this->transactions) {
2219             try {
2220                 $this->rollback_transaction();
2221             } catch (dml_exception $e) {
2222                 // ignore any sql errors here, the connection might be broken
2223             }
2224         }
2226         // now enable transactions again
2227         $this->transactions = array(); // unfortunately all unfinished exceptions are kept in memory
2228         $this->force_rollback = false;
2229     }
2231 // session locking
2232     /**
2233      * Is session lock supported in this driver?
2234      * @return bool
2235      */
2236     public function session_lock_supported() {
2237         return false;
2238     }
2240     /**
2241      * Obtains the session lock.
2242      * @param int $rowid The id of the row with session record.
2243      * @param int $timeout The maximum allowed time to wait for the lock in seconds.
2244      * @return void
2245      * @throws dml_exception A DML specific exception is thrown for any errors.
2246      */
2247     public function get_session_lock($rowid, $timeout) {
2248         $this->used_for_db_sessions = true;
2249     }
2251     /**
2252      * Releases the session lock.
2253      * @param int $rowid The id of the row with session record.
2254      * @return void
2255      * @throws dml_exception A DML specific exception is thrown for any errors.
2256      */
2257     public function release_session_lock($rowid) {
2258     }
2260 // performance and logging
2261     /**
2262      * Returns the number of reads done by this database.
2263      * @return int Number of reads.
2264      */
2265     public function perf_get_reads() {
2266         return $this->reads;
2267     }
2269     /**
2270      * Returns the number of writes done by this database.
2271      * @return int Number of writes.
2272      */
2273     public function perf_get_writes() {
2274         return $this->writes;
2275     }
2277     /**
2278      * Returns the number of queries done by this database.
2279      * @return int Number of queries.
2280      */
2281     public function perf_get_queries() {
2282         return $this->writes + $this->reads;
2283     }