MDL-51245 mssql: Diagnose missing READ_COMMITTED_SNAPSHOT mode
[moodle.git] / lib / dml / mssql_native_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/>.
17 /**
18  * Native mssql class representing moodle database interface.
19  *
20  * @package    core_dml
21  * @copyright  2009 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 defined('MOODLE_INTERNAL') || die();
27 require_once(__DIR__.'/moodle_database.php');
28 require_once(__DIR__.'/mssql_native_moodle_recordset.php');
29 require_once(__DIR__.'/mssql_native_moodle_temptables.php');
31 /**
32  * Native mssql class representing moodle database interface.
33  *
34  * @package    core_dml
35  * @copyright  2009 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
36  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
37  */
38 class mssql_native_moodle_database extends moodle_database {
40     protected $mssql     = null;
41     protected $last_error_reporting; // To handle mssql driver default verbosity
42     protected $collation;  // current DB collation cache
44     /**
45      * Detects if all needed PHP stuff installed.
46      * Note: can be used before connect()
47      * @return mixed true if ok, string if something
48      */
49     public function driver_installed() {
50         if (!function_exists('mssql_connect')) {
51             return get_string('mssqlextensionisnotpresentinphp', 'install');
52         }
53         return true;
54     }
56     /**
57      * Returns database family type - describes SQL dialect
58      * Note: can be used before connect()
59      * @return string db family name (mysql, postgres, mssql, oracle, etc.)
60      */
61     public function get_dbfamily() {
62         return 'mssql';
63     }
65     /**
66      * Returns more specific database driver type
67      * Note: can be used before connect()
68      * @return string db type mysqli, pgsql, oci, mssql, sqlsrv
69      */
70     protected function get_dbtype() {
71         return 'mssql';
72     }
74     /**
75      * Returns general database library name
76      * Note: can be used before connect()
77      * @return string db type pdo, native
78      */
79     protected function get_dblibrary() {
80         return 'native';
81     }
83     /**
84      * Returns localised database type name
85      * Note: can be used before connect()
86      * @return string
87      */
88     public function get_name() {
89         return get_string('nativemssql', 'install');
90     }
92     /**
93      * Returns localised database configuration help.
94      * Note: can be used before connect()
95      * @return string
96      */
97     public function get_configuration_help() {
98         return get_string('nativemssqlhelp', 'install');
99     }
101     /**
102      * Diagnose database and tables, this function is used
103      * to verify database and driver settings, db engine types, etc.
104      *
105      * @return string null means everything ok, string means problem found.
106      */
107     public function diagnose() {
108         // Verify the database is running with READ_COMMITTED_SNAPSHOT enabled.
109         // (that's required to get snapshots/row versioning on READ_COMMITED mode).
110         $correctrcsmode = false;
111         $sql = "SELECT is_read_committed_snapshot_on
112                   FROM sys.databases
113                  WHERE name = '{$this->dbname}'";
114         $this->query_start($sql, null, SQL_QUERY_AUX);
115         $result = mssql_query($sql, $this->mssql);
116         $this->query_end($result);
117         if ($result) {
118             if ($row = mssql_fetch_assoc($result)) {
119                 $correctrcsmode = (bool)reset($row);
120             }
121         }
122         $this->free_result($result);
124         if (!$correctrcsmode) {
125             return get_string('mssqlrcsmodemissing', 'error');
126         }
128         // Arrived here, all right.
129         return null;
130     }
132     /**
133      * Connect to db
134      * Must be called before other methods.
135      * @param string $dbhost The database host.
136      * @param string $dbuser The database username.
137      * @param string $dbpass The database username's password.
138      * @param string $dbname The name of the database being connected to.
139      * @param mixed $prefix string means moodle db prefix, false used for external databases where prefix not used
140      * @param array $dboptions driver specific options
141      * @return bool true
142      * @throws dml_connection_exception if error
143      */
144     public function connect($dbhost, $dbuser, $dbpass, $dbname, $prefix, array $dboptions=null) {
145         if ($prefix == '' and !$this->external) {
146             //Enforce prefixes for everybody but mysql
147             throw new dml_exception('prefixcannotbeempty', $this->get_dbfamily());
148         }
150         $driverstatus = $this->driver_installed();
152         if ($driverstatus !== true) {
153             throw new dml_exception('dbdriverproblem', $driverstatus);
154         }
156         $this->store_settings($dbhost, $dbuser, $dbpass, $dbname, $prefix, $dboptions);
158         $dbhost = $this->dbhost;
159         // Zero shouldn't be used as a port number so doing a check with empty() should be fine.
160         if (!empty($dboptions['dbport'])) {
161             if (stristr(PHP_OS, 'win') && !stristr(PHP_OS, 'darwin')) {
162                 $dbhost .= ','.$dboptions['dbport'];
163             } else {
164                 $dbhost .= ':'.$dboptions['dbport'];
165             }
166         }
167         ob_start();
168         if (!empty($this->dboptions['dbpersist'])) { // persistent connection
169             $this->mssql = mssql_pconnect($dbhost, $this->dbuser, $this->dbpass, true);
170         } else {
171             $this->mssql = mssql_connect($dbhost, $this->dbuser, $this->dbpass, true);
172         }
173         $dberr = ob_get_contents();
174         ob_end_clean();
176         if ($this->mssql === false) {
177             $this->mssql = null;
178             throw new dml_connection_exception($dberr);
179         }
181         // already connected, select database and set some env. variables
182         $this->query_start("--mssql_select_db", null, SQL_QUERY_AUX);
183         $result = mssql_select_db($this->dbname, $this->mssql);
184         $this->query_end($result);
186         // No need to set charset. It's UTF8, with transparent conversions
187         // back and forth performed both by FreeTDS or ODBTP
189         // Allow quoted identifiers
190         $sql = "SET QUOTED_IDENTIFIER ON";
191         $this->query_start($sql, null, SQL_QUERY_AUX);
192         $result = mssql_query($sql, $this->mssql);
193         $this->query_end($result);
195         $this->free_result($result);
197         // Force ANSI nulls so the NULL check was done by IS NULL and NOT IS NULL
198         // instead of equal(=) and distinct(<>) symbols
199         $sql = "SET ANSI_NULLS ON";
200         $this->query_start($sql, null, SQL_QUERY_AUX);
201         $result = mssql_query($sql, $this->mssql);
202         $this->query_end($result);
204         $this->free_result($result);
206         // Force ANSI warnings so arithmetic/string overflows will be
207         // returning error instead of transparently truncating data
208         $sql = "SET ANSI_WARNINGS ON";
209         $this->query_start($sql, null, SQL_QUERY_AUX);
210         $result = mssql_query($sql, $this->mssql);
211         $this->query_end($result);
213         // Concatenating null with anything MUST return NULL
214         $sql = "SET CONCAT_NULL_YIELDS_NULL  ON";
215         $this->query_start($sql, null, SQL_QUERY_AUX);
216         $result = mssql_query($sql, $this->mssql);
217         $this->query_end($result);
219         $this->free_result($result);
221         // Set transactions isolation level to READ_COMMITTED
222         // prevents dirty reads when using transactions +
223         // is the default isolation level of MSSQL
224         // Requires database to run with READ_COMMITTED_SNAPSHOT ON
225         $sql = "SET TRANSACTION ISOLATION LEVEL READ COMMITTED";
226         $this->query_start($sql, NULL, SQL_QUERY_AUX);
227         $result = mssql_query($sql, $this->mssql);
228         $this->query_end($result);
230         $this->free_result($result);
232         // Connection stabilised and configured, going to instantiate the temptables controller
233         $this->temptables = new mssql_native_moodle_temptables($this);
235         return true;
236     }
238     /**
239      * Close database connection and release all resources
240      * and memory (especially circular memory references).
241      * Do NOT use connect() again, create a new instance if needed.
242      */
243     public function dispose() {
244         parent::dispose(); // Call parent dispose to write/close session and other common stuff before closing connection
245         if ($this->mssql) {
246             mssql_close($this->mssql);
247             $this->mssql = null;
248         }
249     }
251     /**
252      * Called before each db query.
253      * @param string $sql
254      * @param array array of parameters
255      * @param int $type type of query
256      * @param mixed $extrainfo driver specific extra information
257      * @return void
258      */
259     protected function query_start($sql, array $params=null, $type, $extrainfo=null) {
260         parent::query_start($sql, $params, $type, $extrainfo);
261         // mssql driver tends to send debug to output, we do not need that ;-)
262         $this->last_error_reporting = error_reporting(0);
263     }
265     /**
266      * Called immediately after each db query.
267      * @param mixed db specific result
268      * @return void
269      */
270     protected function query_end($result) {
271         // reset original debug level
272         error_reporting($this->last_error_reporting);
273         parent::query_end($result);
274     }
276     /**
277      * Returns database server info array
278      * @return array Array containing 'description' and 'version' info
279      */
280     public function get_server_info() {
281         static $info;
282         if (!$info) {
283             $info = array();
284             $sql = 'sp_server_info 2';
285             $this->query_start($sql, null, SQL_QUERY_AUX);
286             $result = mssql_query($sql, $this->mssql);
287             $this->query_end($result);
288             $row = mssql_fetch_row($result);
289             $info['description'] = $row[2];
290             $this->free_result($result);
292             $sql = 'sp_server_info 500';
293             $this->query_start($sql, null, SQL_QUERY_AUX);
294             $result = mssql_query($sql, $this->mssql);
295             $this->query_end($result);
296             $row = mssql_fetch_row($result);
297             $info['version'] = $row[2];
298             $this->free_result($result);
299         }
300         return $info;
301     }
303     /**
304      * Converts short table name {tablename} to real table name
305      * supporting temp tables (#) if detected
306      *
307      * @param string sql
308      * @return string sql
309      */
310     protected function fix_table_names($sql) {
311         if (preg_match_all('/\{([a-z][a-z0-9_]*)\}/', $sql, $matches)) {
312             foreach($matches[0] as $key=>$match) {
313                 $name = $matches[1][$key];
314                 if ($this->temptables->is_temptable($name)) {
315                     $sql = str_replace($match, $this->temptables->get_correct_name($name), $sql);
316                 } else {
317                     $sql = str_replace($match, $this->prefix.$name, $sql);
318                 }
319             }
320         }
321         return $sql;
322     }
324     /**
325      * Returns supported query parameter types
326      * @return int bitmask of accepted SQL_PARAMS_*
327      */
328     protected function allowed_param_types() {
329         return SQL_PARAMS_QM; // Not really, but emulated, see emulate_bound_params()
330     }
332     /**
333      * Returns last error reported by database engine.
334      * @return string error message
335      */
336     public function get_last_error() {
337         return mssql_get_last_message();
338     }
340     /**
341      * Return tables in database WITHOUT current prefix
342      * @param bool $usecache if true, returns list of cached tables.
343      * @return array of table names in lowercase and without prefix
344      */
345     public function get_tables($usecache=true) {
346         if ($usecache and $this->tables !== null) {
347             return $this->tables;
348         }
349         $this->tables = array();
350         $sql = "SELECT table_name
351                   FROM INFORMATION_SCHEMA.TABLES
352                  WHERE table_name LIKE '$this->prefix%'
353                    AND table_type = 'BASE TABLE'";
354         $this->query_start($sql, null, SQL_QUERY_AUX);
355         $result = mssql_query($sql, $this->mssql);
356         $this->query_end($result);
358         if ($result) {
359             while ($row = mssql_fetch_row($result)) {
360                 $tablename = reset($row);
361                 if ($this->prefix !== false && $this->prefix !== '') {
362                     if (strpos($tablename, $this->prefix) !== 0) {
363                         continue;
364                     }
365                     $tablename = substr($tablename, strlen($this->prefix));
366                 }
367                 $this->tables[$tablename] = $tablename;
368             }
369             $this->free_result($result);
370         }
372         // Add the currently available temptables
373         $this->tables = array_merge($this->tables, $this->temptables->get_temptables());
374         return $this->tables;
375     }
377     /**
378      * Return table indexes - everything lowercased.
379      * @param string $table The table we want to get indexes from.
380      * @return array An associative array of indexes containing 'unique' flag and 'columns' being indexed
381      */
382     public function get_indexes($table) {
383         $indexes = array();
384         $tablename = $this->prefix.$table;
386         // Indexes aren't covered by information_schema metatables, so we need to
387         // go to sys ones. Skipping primary key indexes on purpose.
388         $sql = "SELECT i.name AS index_name, i.is_unique, ic.index_column_id, c.name AS column_name
389                   FROM sys.indexes i
390                   JOIN sys.index_columns ic ON i.object_id = ic.object_id AND i.index_id = ic.index_id
391                   JOIN sys.columns c ON ic.object_id = c.object_id AND ic.column_id = c.column_id
392                   JOIN sys.tables t ON i.object_id = t.object_id
393                  WHERE t.name = '$tablename'
394                    AND i.is_primary_key = 0
395               ORDER BY i.name, i.index_id, ic.index_column_id";
397         $this->query_start($sql, null, SQL_QUERY_AUX);
398         $result = mssql_query($sql, $this->mssql);
399         $this->query_end($result);
401         if ($result) {
402             $lastindex = '';
403             $unique = false;
404             $columns = array();
405             while ($row = mssql_fetch_assoc($result)) {
406                 if ($lastindex and $lastindex != $row['index_name']) { // Save lastindex to $indexes and reset info
407                     $indexes[$lastindex] = array('unique' => $unique, 'columns' => $columns);
408                     $unique = false;
409                     $columns = array();
410                 }
411                 $lastindex = $row['index_name'];
412                 $unique = empty($row['is_unique']) ? false : true;
413                 $columns[] = $row['column_name'];
414             }
415             if ($lastindex ) { // Add the last one if exists
416                 $indexes[$lastindex] = array('unique' => $unique, 'columns' => $columns);
417             }
418             $this->free_result($result);
419         }
420         return $indexes;
421     }
423     /**
424      * Returns datailed information about columns in table. This information is cached internally.
425      * @param string $table name
426      * @param bool $usecache
427      * @return array array of database_column_info objects indexed with column names
428      */
429     public function get_columns($table, $usecache=true) {
431         if ($usecache) {
432             $properties = array('dbfamily' => $this->get_dbfamily(), 'settings' => $this->get_settings_hash());
433             $cache = cache::make('core', 'databasemeta', $properties);
434             if ($data = $cache->get($table)) {
435                 return $data;
436             }
437         }
439         $structure = array();
441         if (!$this->temptables->is_temptable($table)) { // normal table, get metadata from own schema
442             $sql = "SELECT column_name AS name,
443                            data_type AS type,
444                            numeric_precision AS max_length,
445                            character_maximum_length AS char_max_length,
446                            numeric_scale AS scale,
447                            is_nullable AS is_nullable,
448                            columnproperty(object_id(quotename(table_schema) + '.' +
449                                quotename(table_name)), column_name, 'IsIdentity') AS auto_increment,
450                            column_default AS default_value
451                       FROM INFORMATION_SCHEMA.COLUMNS
452                      WHERE table_name = '{" . $table . "}'
453                   ORDER BY ordinal_position";
454         } else { // temp table, get metadata from tempdb schema
455             $sql = "SELECT column_name AS name,
456                            data_type AS type,
457                            numeric_precision AS max_length,
458                            character_maximum_length AS char_max_length,
459                            numeric_scale AS scale,
460                            is_nullable AS is_nullable,
461                            columnproperty(object_id(quotename(table_schema) + '.' +
462                                quotename(table_name)), column_name, 'IsIdentity') AS auto_increment,
463                            column_default AS default_value
464                       FROM tempdb.INFORMATION_SCHEMA.COLUMNS
465                       JOIN tempdb..sysobjects ON name = table_name
466                      WHERE id = object_id('tempdb..{" . $table . "}')
467                   ORDER BY ordinal_position";
468         }
470         list($sql, $params, $type) = $this->fix_sql_params($sql, null);
472         $this->query_start($sql, null, SQL_QUERY_AUX);
473         $result = mssql_query($sql, $this->mssql);
474         $this->query_end($result);
476         if (!$result) {
477             return array();
478         }
480         while ($rawcolumn = mssql_fetch_assoc($result)) {
482             $rawcolumn = (object)$rawcolumn;
484             $info = new stdClass();
485             $info->name = $rawcolumn->name;
486             $info->type = $rawcolumn->type;
487             $info->meta_type = $this->mssqltype2moodletype($info->type);
489             // Prepare auto_increment info
490             $info->auto_increment = $rawcolumn->auto_increment ? true : false;
492             // Define type for auto_increment columns
493             $info->meta_type = ($info->auto_increment && $info->meta_type == 'I') ? 'R' : $info->meta_type;
495             // id columns being auto_incremnt are PK by definition
496             $info->primary_key = ($info->name == 'id' && $info->meta_type == 'R' && $info->auto_increment);
498             if ($info->meta_type === 'C' and $rawcolumn->char_max_length == -1) {
499                 // This is NVARCHAR(MAX), not a normal NVARCHAR.
500                 $info->max_length = -1;
501                 $info->meta_type = 'X';
502             } else {
503                 // Put correct length for character and LOB types
504                 $info->max_length = $info->meta_type == 'C' ? $rawcolumn->char_max_length : $rawcolumn->max_length;
505                 $info->max_length = ($info->meta_type == 'X' || $info->meta_type == 'B') ? -1 : $info->max_length;
506             }
508             // Scale
509             $info->scale = $rawcolumn->scale;
511             // Prepare not_null info
512             $info->not_null = $rawcolumn->is_nullable == 'NO'  ? true : false;
514             // Process defaults
515             $info->has_default = !empty($rawcolumn->default_value);
516             if ($rawcolumn->default_value === NULL) {
517                 $info->default_value = NULL;
518             } else {
519                 $info->default_value = preg_replace("/^[\(N]+[']?(.*?)[']?[\)]+$/", '\\1', $rawcolumn->default_value);
520             }
522             // Process binary
523             $info->binary = $info->meta_type == 'B' ? true : false;
525             $structure[$info->name] = new database_column_info($info);
526         }
527         $this->free_result($result);
529         if ($usecache) {
530             $cache->set($table, $structure);
531         }
533         return $structure;
534     }
536     /**
537      * Normalise values based on varying RDBMS's dependencies (booleans, LOBs...)
538      *
539      * @param database_column_info $column column metadata corresponding with the value we are going to normalise
540      * @param mixed $value value we are going to normalise
541      * @return mixed the normalised value
542      */
543     protected function normalise_value($column, $value) {
544         $this->detect_objects($value);
546         if (is_bool($value)) { // Always, convert boolean to int
547             $value = (int)$value;
548         } // And continue processing because text columns with numeric info need special handling below
550         if ($column->meta_type == 'B') {   // BLOBs need to be properly "packed", but can be inserted directly if so.
551             if (!is_null($value)) {               // If value not null, unpack it to unquoted hexadecimal byte-string format
552                 $value = unpack('H*hex', $value); // we leave it as array, so emulate_bound_params() can detect it
553             }                                     // easily and "bind" the param ok.
555         } else if ($column->meta_type == 'X') {             // MSSQL doesn't cast from int to text, so if text column
556             if (is_numeric($value)) {                       // and is numeric value then cast to string
557                 $value = array('numstr' => (string)$value); // and put into array, so emulate_bound_params() will know how
558             }                                               // to "bind" the param ok, avoiding reverse conversion to number
560         } else if ($value === '') {
561             if ($column->meta_type == 'I' or $column->meta_type == 'F' or $column->meta_type == 'N') {
562                 $value = 0; // prevent '' problems in numeric fields
563             }
564         }
565         return $value;
566     }
568     /**
569      * Selectively call mssql_free_result(), avoiding some warnings without using the horrible @
570      *
571      * @param mssql_resource $resource resource to be freed if possible
572      */
573     private function free_result($resource) {
574         if (!is_bool($resource)) { // true/false resources cannot be freed
575             mssql_free_result($resource);
576         }
577     }
579     /**
580      * Provides mapping between mssql native data types and moodle_database - database_column_info - ones)
581      *
582      * @param string $mssql_type native mssql data type
583      * @return string 1-char database_column_info data type
584      */
585     private function mssqltype2moodletype($mssql_type) {
586         $type = null;
587         switch (strtoupper($mssql_type)) {
588             case 'BIT':
589                 $type = 'L';
590                 break;
591             case 'INT':
592             case 'SMALLINT':
593             case 'INTEGER':
594             case 'BIGINT':
595                 $type = 'I';
596                 break;
597             case 'DECIMAL':
598             case 'REAL':
599             case 'FLOAT':
600                 $type = 'N';
601                 break;
602             case 'VARCHAR':
603             case 'NVARCHAR':
604                 $type = 'C';
605                 break;
606             case 'TEXT':
607             case 'NTEXT':
608             case 'VARCHAR(MAX)':
609             case 'NVARCHAR(MAX)':
610                 $type = 'X';
611                 break;
612             case 'IMAGE':
613             case 'VARBINARY':
614             case 'VARBINARY(MAX)':
615                 $type = 'B';
616                 break;
617             case 'DATETIME':
618                 $type = 'D';
619                 break;
620         }
621         if (!$type) {
622             throw new dml_exception('invalidmssqlnativetype', $mssql_type);
623         }
624         return $type;
625     }
627     /**
628      * Do NOT use in code, to be used by database_manager only!
629      * @param string|array $sql query
630      * @return bool true
631      * @throws ddl_change_structure_exception A DDL specific exception is thrown for any errors.
632      */
633     public function change_database_structure($sql) {
634         $this->get_manager(); // Includes DDL exceptions classes ;-)
635         $sqls = (array)$sql;
637         try {
638             foreach ($sqls as $sql) {
639                 $this->query_start($sql, null, SQL_QUERY_STRUCTURE);
640                 $result = mssql_query($sql, $this->mssql);
641                 $this->query_end($result);
642             }
643         } catch (ddl_change_structure_exception $e) {
644             $this->reset_caches();
645             throw $e;
646         }
648         $this->reset_caches();
649         return true;
650     }
652     /**
653      * Very ugly hack which emulates bound parameters in queries
654      * because the mssql driver doesn't support placeholders natively at all
655      */
656     protected function emulate_bound_params($sql, array $params=null) {
657         if (empty($params)) {
658             return $sql;
659         }
660         // ok, we have verified sql statement with ? and correct number of params
661         $parts = array_reverse(explode('?', $sql));
662         $return = array_pop($parts);
663         foreach ($params as $param) {
664             if (is_bool($param)) {
665                 $return .= (int)$param;
667             } else if (is_array($param) && isset($param['hex'])) { // detect hex binary, bind it specially
668                 $return .= '0x' . $param['hex'];
670             } else if (is_array($param) && isset($param['numstr'])) { // detect numerical strings that *must not*
671                 $return .= "N'{$param['numstr']}'";                   // be converted back to number params, but bound as strings
673             } else if (is_null($param)) {
674                 $return .= 'NULL';
676             } else if (is_number($param)) { // we can not use is_numeric() because it eats leading zeros from strings like 0045646
677                 $return .= "'".$param."'"; //fix for MDL-24863 to prevent auto-cast to int.
679             } else if (is_float($param)) {
680                 $return .= $param;
682             } else {
683                 $param = str_replace("'", "''", $param);
684                 $param = str_replace("\0", "", $param);
685                 $return .= "N'$param'";
686             }
688             $return .= array_pop($parts);
689         }
690         return $return;
691     }
693     /**
694      * Execute general sql query. Should be used only when no other method suitable.
695      * Do NOT use this to make changes in db structure, use database_manager methods instead!
696      * @param string $sql query
697      * @param array $params query parameters
698      * @return bool true
699      * @throws dml_exception A DML specific exception is thrown for any errors.
700      */
701     public function execute($sql, array $params=null) {
703         list($sql, $params, $type) = $this->fix_sql_params($sql, $params);
704         $rawsql = $this->emulate_bound_params($sql, $params);
706         if (strpos($sql, ';') !== false) {
707             throw new coding_exception('moodle_database::execute() Multiple sql statements found or bound parameters not used properly in query!');
708         }
710         $this->query_start($sql, $params, SQL_QUERY_UPDATE);
711         $result = mssql_query($rawsql, $this->mssql);
712         $this->query_end($result);
713         $this->free_result($result);
715         return true;
716     }
718     /**
719      * Get a number of records as a moodle_recordset using a SQL statement.
720      *
721      * Since this method is a little less readable, use of it should be restricted to
722      * code where it's possible there might be large datasets being returned.  For known
723      * small datasets use get_records_sql - it leads to simpler code.
724      *
725      * The return type is like:
726      * @see function get_recordset.
727      *
728      * @param string $sql the SQL select query to execute.
729      * @param array $params array of sql parameters
730      * @param int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
731      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
732      * @return moodle_recordset instance
733      * @throws dml_exception A DML specific exception is thrown for any errors.
734      */
735     public function get_recordset_sql($sql, array $params=null, $limitfrom=0, $limitnum=0) {
737         list($limitfrom, $limitnum) = $this->normalise_limit_from_num($limitfrom, $limitnum);
739         if ($limitfrom or $limitnum) {
740             if ($limitnum >= 1) { // Only apply TOP clause if we have any limitnum (limitfrom offset is handled later)
741                 $fetch = $limitfrom + $limitnum;
742                 if (PHP_INT_MAX - $limitnum < $limitfrom) { // Check PHP_INT_MAX overflow
743                     $fetch = PHP_INT_MAX;
744                 }
745                 $sql = preg_replace('/^([\s(])*SELECT([\s]+(DISTINCT|ALL))?(?!\s*TOP\s*\()/i',
746                                     "\\1SELECT\\2 TOP $fetch", $sql);
747             }
748         }
750         list($sql, $params, $type) = $this->fix_sql_params($sql, $params);
751         $rawsql = $this->emulate_bound_params($sql, $params);
753         $this->query_start($sql, $params, SQL_QUERY_SELECT);
754         $result = mssql_query($rawsql, $this->mssql);
755         $this->query_end($result);
757         if ($limitfrom) { // Skip $limitfrom records
758             if (!@mssql_data_seek($result, $limitfrom)) {
759                 // Nothing, most probably seek past the end.
760                 mssql_free_result($result);
761                 $result = null;
762             }
763         }
765         return $this->create_recordset($result);
766     }
768     protected function create_recordset($result) {
769         return new mssql_native_moodle_recordset($result);
770     }
772     /**
773      * Get a number of records as an array of objects using a SQL statement.
774      *
775      * Return value is like:
776      * @see function get_records.
777      *
778      * @param string $sql the SQL select query to execute. The first column of this SELECT statement
779      *   must be a unique value (usually the 'id' field), as it will be used as the key of the
780      *   returned array.
781      * @param array $params array of sql parameters
782      * @param int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
783      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
784      * @return array of objects, or empty array if no records were found
785      * @throws dml_exception A DML specific exception is thrown for any errors.
786      */
787     public function get_records_sql($sql, array $params=null, $limitfrom=0, $limitnum=0) {
789         $rs = $this->get_recordset_sql($sql, $params, $limitfrom, $limitnum);
791         $results = array();
793         foreach ($rs as $row) {
794             $id = reset($row);
795             if (isset($results[$id])) {
796                 $colname = key($row);
797                 debugging("Did you remember to make the first column something unique in your call to get_records? Duplicate value '$id' found in column '$colname'.", DEBUG_DEVELOPER);
798             }
799             $results[$id] = $row;
800         }
801         $rs->close();
803         return $results;
804     }
806     /**
807      * Selects records and return values (first field) as an array using a SQL statement.
808      *
809      * @param string $sql The SQL query
810      * @param array $params array of sql parameters
811      * @return array of values
812      * @throws dml_exception A DML specific exception is thrown for any errors.
813      */
814     public function get_fieldset_sql($sql, array $params=null) {
816         $rs = $this->get_recordset_sql($sql, $params);
818         $results = array();
820         foreach ($rs as $row) {
821             $results[] = reset($row);
822         }
823         $rs->close();
825         return $results;
826     }
828     /**
829      * Insert new record into database, as fast as possible, no safety checks, lobs not supported.
830      * @param string $table name
831      * @param mixed $params data record as object or array
832      * @param bool $returnit return it of inserted record
833      * @param bool $bulk true means repeated inserts expected
834      * @param bool $customsequence true if 'id' included in $params, disables $returnid
835      * @return bool|int true or new id
836      * @throws dml_exception A DML specific exception is thrown for any errors.
837      */
838     public function insert_record_raw($table, $params, $returnid=true, $bulk=false, $customsequence=false) {
839         if (!is_array($params)) {
840             $params = (array)$params;
841         }
843         $returning = "";
844         $isidentity = false;
846         if ($customsequence) {
847             if (!isset($params['id'])) {
848                 throw new coding_exception('moodle_database::insert_record_raw() id field must be specified if custom sequences used.');
849             }
850             $returnid = false;
852             $columns = $this->get_columns($table);
853             if (isset($columns['id']) and $columns['id']->auto_increment) {
854                 $isidentity = true;
855             }
857             // Disable IDENTITY column before inserting record with id, only if the
858             // column is identity, from meta information.
859             if ($isidentity) {
860                 $sql = 'SET IDENTITY_INSERT {' . $table . '} ON'; // Yes, it' ON!!
861                 list($sql, $xparams, $xtype) = $this->fix_sql_params($sql, null);
862                 $this->query_start($sql, null, SQL_QUERY_AUX);
863                 $result = mssql_query($sql, $this->mssql);
864                 $this->query_end($result);
865                 $this->free_result($result);
866             }
868         } else {
869             unset($params['id']);
870             if ($returnid) {
871                 $returning = "OUTPUT inserted.id";
872             }
873         }
875         if (empty($params)) {
876             throw new coding_exception('moodle_database::insert_record_raw() no fields found.');
877         }
879         $fields = implode(',', array_keys($params));
880         $qms    = array_fill(0, count($params), '?');
881         $qms    = implode(',', $qms);
883         $sql = "INSERT INTO {" . $table . "} ($fields) $returning VALUES ($qms)";
885         list($sql, $params, $type) = $this->fix_sql_params($sql, $params);
886         $rawsql = $this->emulate_bound_params($sql, $params);
888         $this->query_start($sql, $params, SQL_QUERY_INSERT);
889         $result = mssql_query($rawsql, $this->mssql);
890         // Expected results are:
891         //     - true: insert ok and there isn't returned information.
892         //     - false: insert failed and there isn't returned information.
893         //     - resource: insert executed, need to look for returned (output)
894         //           values to know if the insert was ok or no. Posible values
895         //           are false = failed, integer = insert ok, id returned.
896         $end = false;
897         if (is_bool($result)) {
898             $end = $result;
899         } else if (is_resource($result)) {
900             $end = mssql_result($result, 0, 0); // Fetch 1st column from 1st row.
901         }
902         $this->query_end($end); // End the query with the calculated $end.
904         if ($returning !== "") {
905             $params['id'] = $end;
906         }
907         $this->free_result($result);
909         if ($customsequence) {
910             // Enable IDENTITY column after inserting record with id, only if the
911             // column is identity, from meta information.
912             if ($isidentity) {
913                 $sql = 'SET IDENTITY_INSERT {' . $table . '} OFF'; // Yes, it' OFF!!
914                 list($sql, $xparams, $xtype) = $this->fix_sql_params($sql, null);
915                 $this->query_start($sql, null, SQL_QUERY_AUX);
916                 $result = mssql_query($sql, $this->mssql);
917                 $this->query_end($result);
918                 $this->free_result($result);
919             }
920         }
922         if (!$returnid) {
923             return true;
924         }
926         return (int)$params['id'];
927     }
929     /**
930      * Insert a record into a table and return the "id" field if required.
931      *
932      * Some conversions and safety checks are carried out. Lobs are supported.
933      * If the return ID isn't required, then this just reports success as true/false.
934      * $data is an object containing needed data
935      * @param string $table The database table to be inserted into
936      * @param object $data A data object with values for one or more fields in the record
937      * @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.
938      * @return bool|int true or new id
939      * @throws dml_exception A DML specific exception is thrown for any errors.
940      */
941     public function insert_record($table, $dataobject, $returnid=true, $bulk=false) {
942         $dataobject = (array)$dataobject;
944         $columns = $this->get_columns($table);
945         if (empty($columns)) {
946             throw new dml_exception('ddltablenotexist', $table);
947         }
948         $cleaned = array();
950         foreach ($dataobject as $field => $value) {
951             if ($field === 'id') {
952                 continue;
953             }
954             if (!isset($columns[$field])) {
955                 continue;
956             }
957             $column = $columns[$field];
958             $cleaned[$field] = $this->normalise_value($column, $value);
959         }
961         return $this->insert_record_raw($table, $cleaned, $returnid, $bulk);
962     }
964     /**
965      * Import a record into a table, id field is required.
966      * Safety checks are NOT carried out. Lobs are supported.
967      *
968      * @param string $table name of database table to be inserted into
969      * @param object $dataobject A data object with values for one or more fields in the record
970      * @return bool true
971      * @throws dml_exception A DML specific exception is thrown for any errors.
972      */
973     public function import_record($table, $dataobject) {
974         $dataobject = (array)$dataobject;
976         $columns = $this->get_columns($table);
977         $cleaned = array();
979         foreach ($dataobject as $field => $value) {
980             if (!isset($columns[$field])) {
981                 continue;
982             }
983             $column = $columns[$field];
984             $cleaned[$field] = $this->normalise_value($column, $value);
985         }
987         $this->insert_record_raw($table, $cleaned, false, false, true);
989         return true;
990     }
992     /**
993      * Update record in database, as fast as possible, no safety checks, lobs not supported.
994      * @param string $table name
995      * @param mixed $params data record as object or array
996      * @param bool true means repeated updates expected
997      * @return bool true
998      * @throws dml_exception A DML specific exception is thrown for any errors.
999      */
1000     public function update_record_raw($table, $params, $bulk=false) {
1001         $params = (array)$params;
1003         if (!isset($params['id'])) {
1004             throw new coding_exception('moodle_database::update_record_raw() id field must be specified.');
1005         }
1006         $id = $params['id'];
1007         unset($params['id']);
1009         if (empty($params)) {
1010             throw new coding_exception('moodle_database::update_record_raw() no fields found.');
1011         }
1013         $sets = array();
1014         foreach ($params as $field=>$value) {
1015             $sets[] = "$field = ?";
1016         }
1018         $params[] = $id; // last ? in WHERE condition
1020         $sets = implode(',', $sets);
1021         $sql = "UPDATE {" . $table . "} SET $sets WHERE id = ?";
1023         list($sql, $params, $type) = $this->fix_sql_params($sql, $params);
1024         $rawsql = $this->emulate_bound_params($sql, $params);
1026         $this->query_start($sql, $params, SQL_QUERY_UPDATE);
1027         $result = mssql_query($rawsql, $this->mssql);
1028         $this->query_end($result);
1030         $this->free_result($result);
1031         return true;
1032     }
1034     /**
1035      * Update a record in a table
1036      *
1037      * $dataobject is an object containing needed data
1038      * Relies on $dataobject having a variable "id" to
1039      * specify the record to update
1040      *
1041      * @param string $table The database table to be checked against.
1042      * @param object $dataobject An object with contents equal to fieldname=>fieldvalue. Must have an entry for 'id' to map to the table specified.
1043      * @param bool true means repeated updates expected
1044      * @return bool true
1045      * @throws dml_exception A DML specific exception is thrown for any errors.
1046      */
1047     public function update_record($table, $dataobject, $bulk=false) {
1048         $dataobject = (array)$dataobject;
1050         $columns = $this->get_columns($table);
1051         $cleaned = array();
1053         foreach ($dataobject as $field => $value) {
1054             if (!isset($columns[$field])) {
1055                 continue;
1056             }
1057             $column = $columns[$field];
1058             $cleaned[$field] = $this->normalise_value($column, $value);
1059         }
1061         return $this->update_record_raw($table, $cleaned, $bulk);
1062     }
1064     /**
1065      * Set a single field in every table record which match a particular WHERE clause.
1066      *
1067      * @param string $table The database table to be checked against.
1068      * @param string $newfield the field to set.
1069      * @param string $newvalue the value to set the field to.
1070      * @param string $select A fragment of SQL to be used in a where clause in the SQL call.
1071      * @param array $params array of sql parameters
1072      * @return bool true
1073      * @throws dml_exception A DML specific exception is thrown for any errors.
1074      */
1075     public function set_field_select($table, $newfield, $newvalue, $select, array $params=null) {
1077         if ($select) {
1078             $select = "WHERE $select";
1079         }
1080         if (is_null($params)) {
1081             $params = array();
1082         }
1084         // convert params to ? types
1085         list($select, $params, $type) = $this->fix_sql_params($select, $params);
1087         // Get column metadata
1088         $columns = $this->get_columns($table);
1089         $column = $columns[$newfield];
1091         $newvalue = $this->normalise_value($column, $newvalue);
1093         if (is_null($newvalue)) {
1094             $newfield = "$newfield = NULL";
1095         } else {
1096             $newfield = "$newfield = ?";
1097             array_unshift($params, $newvalue);
1098         }
1099         $sql = "UPDATE {" . $table . "} SET $newfield $select";
1101         list($sql, $params, $type) = $this->fix_sql_params($sql, $params);
1102         $rawsql = $this->emulate_bound_params($sql, $params);
1104         $this->query_start($sql, $params, SQL_QUERY_UPDATE);
1105         $result = mssql_query($rawsql, $this->mssql);
1106         $this->query_end($result);
1108         $this->free_result($result);
1110         return true;
1111     }
1113     /**
1114      * Delete one or more records from a table which match a particular WHERE clause.
1115      *
1116      * @param string $table The database table to be checked against.
1117      * @param string $select A fragment of SQL to be used in a where clause in the SQL call (used to define the selection criteria).
1118      * @param array $params array of sql parameters
1119      * @return bool true
1120      * @throws dml_exception A DML specific exception is thrown for any errors.
1121      */
1122     public function delete_records_select($table, $select, array $params=null) {
1124         if ($select) {
1125             $select = "WHERE $select";
1126         }
1128         $sql = "DELETE FROM {" . $table . "} $select";
1130         list($sql, $params, $type) = $this->fix_sql_params($sql, $params);
1131         $rawsql = $this->emulate_bound_params($sql, $params);
1133         $this->query_start($sql, $params, SQL_QUERY_UPDATE);
1134         $result = mssql_query($rawsql, $this->mssql);
1135         $this->query_end($result);
1137         $this->free_result($result);
1139         return true;
1140     }
1142     public function sql_cast_char2int($fieldname, $text=false) {
1143         if (!$text) {
1144             return ' CAST(' . $fieldname . ' AS INT) ';
1145         } else {
1146             return ' CAST(' . $this->sql_compare_text($fieldname) . ' AS INT) ';
1147         }
1148     }
1150     public function sql_cast_char2real($fieldname, $text=false) {
1151         if (!$text) {
1152             return ' CAST(' . $fieldname . ' AS REAL) ';
1153         } else {
1154             return ' CAST(' . $this->sql_compare_text($fieldname) . ' AS REAL) ';
1155         }
1156     }
1158     public function sql_ceil($fieldname) {
1159         return ' CEILING(' . $fieldname . ')';
1160     }
1163     protected function get_collation() {
1164         if (isset($this->collation)) {
1165             return $this->collation;
1166         }
1167         if (!empty($this->dboptions['dbcollation'])) {
1168             // perf speedup
1169             $this->collation = $this->dboptions['dbcollation'];
1170             return $this->collation;
1171         }
1173         // make some default
1174         $this->collation = 'Latin1_General_CI_AI';
1176         $sql = "SELECT CAST(DATABASEPROPERTYEX('$this->dbname', 'Collation') AS varchar(255)) AS SQLCollation";
1177         $this->query_start($sql, null, SQL_QUERY_AUX);
1178         $result = mssql_query($sql, $this->mssql);
1179         $this->query_end($result);
1181         if ($result) {
1182             if ($rawcolumn = mssql_fetch_assoc($result)) {
1183                 $this->collation = reset($rawcolumn);
1184             }
1185             $this->free_result($result);
1186         }
1188         return $this->collation;
1189     }
1191     /**
1192      * Returns 'LIKE' part of a query.
1193      *
1194      * @param string $fieldname usually name of the table column
1195      * @param string $param usually bound query parameter (?, :named)
1196      * @param bool $casesensitive use case sensitive search
1197      * @param bool $accensensitive use accent sensitive search (not all databases support accent insensitive)
1198      * @param bool $notlike true means "NOT LIKE"
1199      * @param string $escapechar escape char for '%' and '_'
1200      * @return string SQL code fragment
1201      */
1202     public function sql_like($fieldname, $param, $casesensitive = true, $accentsensitive = true, $notlike = false, $escapechar = '\\') {
1203         if (strpos($param, '%') !== false) {
1204             debugging('Potential SQL injection detected, sql_like() expects bound parameters (? or :named)');
1205         }
1207         $collation = $this->get_collation();
1209         if ($casesensitive) {
1210             $collation = str_replace('_CI', '_CS', $collation);
1211         } else {
1212             $collation = str_replace('_CS', '_CI', $collation);
1213         }
1214         if ($accentsensitive) {
1215             $collation = str_replace('_AI', '_AS', $collation);
1216         } else {
1217             $collation = str_replace('_AS', '_AI', $collation);
1218         }
1220         $LIKE = $notlike ? 'NOT LIKE' : 'LIKE';
1222         return "$fieldname COLLATE $collation $LIKE $param ESCAPE '$escapechar'";
1223     }
1225     public function sql_concat() {
1226         $arr = func_get_args();
1227         foreach ($arr as $key => $ele) {
1228             $arr[$key] = ' CAST(' . $ele . ' AS NVARCHAR(255)) ';
1229         }
1230         $s = implode(' + ', $arr);
1231         if ($s === '') {
1232             return " '' ";
1233         }
1234         return " $s ";
1235     }
1237     public function sql_concat_join($separator="' '", $elements=array()) {
1238         for ($n=count($elements)-1; $n > 0 ; $n--) {
1239             array_splice($elements, $n, 0, $separator);
1240         }
1241         return call_user_func_array(array($this, 'sql_concat'), $elements);
1242     }
1244    public function sql_isempty($tablename, $fieldname, $nullablefield, $textfield) {
1245         if ($textfield) {
1246             return ' (' . $this->sql_compare_text($fieldname) . " = '') ";
1247         } else {
1248             return " ($fieldname = '') ";
1249         }
1250     }
1252    /**
1253      * Returns the SQL text to be used to calculate the length in characters of one expression.
1254      * @param string fieldname or expression to calculate its length in characters.
1255      * @return string the piece of SQL code to be used in the statement.
1256      */
1257     public function sql_length($fieldname) {
1258         return ' LEN(' . $fieldname . ')';
1259     }
1261     public function sql_order_by_text($fieldname, $numchars=32) {
1262         return " CONVERT(varchar({$numchars}), {$fieldname})";
1263     }
1265    /**
1266      * Returns the SQL for returning searching one string for the location of another.
1267      */
1268     public function sql_position($needle, $haystack) {
1269         return "CHARINDEX(($needle), ($haystack))";
1270     }
1272     /**
1273      * Returns the proper substr() SQL text used to extract substrings from DB
1274      * NOTE: this was originally returning only function name
1275      *
1276      * @param string $expr some string field, no aggregates
1277      * @param mixed $start integer or expression evaluating to int
1278      * @param mixed $length optional integer or expression evaluating to int
1279      * @return string sql fragment
1280      */
1281     public function sql_substr($expr, $start, $length=false) {
1282         if (count(func_get_args()) < 2) {
1283             throw new coding_exception('moodle_database::sql_substr() requires at least two parameters', 'Originaly this function wa
1284 s only returning name of SQL substring function, it now requires all parameters.');
1285         }
1286         if ($length === false) {
1287             return "SUBSTRING($expr, " . $this->sql_cast_char2int($start) . ", 2^31-1)";
1288         } else {
1289             return "SUBSTRING($expr, " . $this->sql_cast_char2int($start) . ", " . $this->sql_cast_char2int($length) . ")";
1290         }
1291     }
1293     /**
1294      * Does this driver support tool_replace?
1295      *
1296      * @since Moodle 2.6.1
1297      * @return bool
1298      */
1299     public function replace_all_text_supported() {
1300         return true;
1301     }
1303     public function session_lock_supported() {
1304         return true;
1305     }
1307     /**
1308      * Obtain session lock
1309      * @param int $rowid id of the row with session record
1310      * @param int $timeout max allowed time to wait for the lock in seconds
1311      * @return bool success
1312      */
1313     public function get_session_lock($rowid, $timeout) {
1314         if (!$this->session_lock_supported()) {
1315             return;
1316         }
1317         parent::get_session_lock($rowid, $timeout);
1319         $timeoutmilli = $timeout * 1000;
1321         $fullname = $this->dbname.'-'.$this->prefix.'-session-'.$rowid;
1322         // There is one bug in PHP/freetds (both reproducible with mssql_query()
1323         // and its mssql_init()/mssql_bind()/mssql_execute() alternative) for
1324         // stored procedures, causing scalar results of the execution
1325         // to be cast to boolean (true/fals). Here there is one
1326         // workaround that forces the return of one recordset resource.
1327         // $sql = "sp_getapplock '$fullname', 'Exclusive', 'Session',  $timeoutmilli";
1328         $sql = "BEGIN
1329                     DECLARE @result INT
1330                     EXECUTE @result = sp_getapplock @Resource='$fullname',
1331                                                     @LockMode='Exclusive',
1332                                                     @LockOwner='Session',
1333                                                     @LockTimeout='$timeoutmilli'
1334                     SELECT @result
1335                 END";
1336         $this->query_start($sql, null, SQL_QUERY_AUX);
1337         $result = mssql_query($sql, $this->mssql);
1338         $this->query_end($result);
1340         if ($result) {
1341             $row = mssql_fetch_row($result);
1342             if ($row[0] < 0) {
1343                 throw new dml_sessionwait_exception();
1344             }
1345         }
1347         $this->free_result($result);
1348     }
1350     public function release_session_lock($rowid) {
1351         if (!$this->session_lock_supported()) {
1352             return;
1353         }
1354         if (!$this->used_for_db_sessions) {
1355             return;
1356         }
1358         parent::release_session_lock($rowid);
1360         $fullname = $this->dbname.'-'.$this->prefix.'-session-'.$rowid;
1361         $sql = "sp_releaseapplock '$fullname', 'Session'";
1362         $this->query_start($sql, null, SQL_QUERY_AUX);
1363         $result = mssql_query($sql, $this->mssql);
1364         $this->query_end($result);
1366         $this->free_result($result);
1367     }
1369     /**
1370      * Driver specific start of real database transaction,
1371      * this can not be used directly in code.
1372      * @return void
1373      */
1374     protected function begin_transaction() {
1375         // requires database to run with READ_COMMITTED_SNAPSHOT ON
1376         $sql = "BEGIN TRANSACTION"; // Will be using READ COMMITTED isolation
1377         $this->query_start($sql, NULL, SQL_QUERY_AUX);
1378         $result = mssql_query($sql, $this->mssql);
1379         $this->query_end($result);
1381         $this->free_result($result);
1382     }
1384     /**
1385      * Driver specific commit of real database transaction,
1386      * this can not be used directly in code.
1387      * @return void
1388      */
1389     protected function commit_transaction() {
1390         $sql = "COMMIT TRANSACTION";
1391         $this->query_start($sql, NULL, SQL_QUERY_AUX);
1392         $result = mssql_query($sql, $this->mssql);
1393         $this->query_end($result);
1395         $this->free_result($result);
1396     }
1398     /**
1399      * Driver specific abort of real database transaction,
1400      * this can not be used directly in code.
1401      * @return void
1402      */
1403     protected function rollback_transaction() {
1404         $sql = "ROLLBACK TRANSACTION";
1405         $this->query_start($sql, NULL, SQL_QUERY_AUX);
1406         $result = mssql_query($sql, $this->mssql);
1407         $this->query_end($result);
1409         $this->free_result($result);
1410     }