MDL-30972 Documentation : improved @see as well as added appropriate uses of inline...
[moodle.git] / lib / dml / mssql_native_moodle_database.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
19 /**
20  * Native mssql class representing moodle database interface.
21  *
22  * @package    core
23  * @subpackage dml_driver
24  * @copyright  2009 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
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/moodle_database.php');
31 require_once($CFG->libdir.'/dml/mssql_native_moodle_recordset.php');
32 require_once($CFG->libdir.'/dml/mssql_native_moodle_temptables.php');
34 /**
35  * Native mssql class representing moodle database interface.
36  *
37  * @package    core
38  * @subpackage dml_driver
39  * @copyright  2009 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
40  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
41  */
42 class mssql_native_moodle_database extends moodle_database {
44     protected $mssql     = null;
45     protected $last_error_reporting; // To handle mssql driver default verbosity
46     protected $collation;  // current DB collation cache
48     /**
49      * Detects if all needed PHP stuff installed.
50      * Note: can be used before connect()
51      * @return mixed true if ok, string if something
52      */
53     public function driver_installed() {
54         if (!function_exists('mssql_connect')) {
55             return get_string('mssqlextensionisnotpresentinphp', 'install');
56         }
57         return true;
58     }
60     /**
61      * Returns database family type - describes SQL dialect
62      * Note: can be used before connect()
63      * @return string db family name (mysql, postgres, mssql, oracle, etc.)
64      */
65     public function get_dbfamily() {
66         return 'mssql';
67     }
69     /**
70      * Returns more specific database driver type
71      * Note: can be used before connect()
72      * @return string db type mysqli, pgsql, oci, mssql, sqlsrv
73      */
74     protected function get_dbtype() {
75         return 'mssql';
76     }
78     /**
79      * Returns general database library name
80      * Note: can be used before connect()
81      * @return string db type pdo, native
82      */
83     protected function get_dblibrary() {
84         return 'native';
85     }
87     /**
88      * Returns localised database type name
89      * Note: can be used before connect()
90      * @return string
91      */
92     public function get_name() {
93         return get_string('nativemssql', 'install');
94     }
96     /**
97      * Returns localised database configuration help.
98      * Note: can be used before connect()
99      * @return string
100      */
101     public function get_configuration_help() {
102         return get_string('nativemssqlhelp', 'install');
103     }
105     /**
106      * Returns localised database description
107      * Note: can be used before connect()
108      * @return string
109      */
110     public function get_configuration_hints() {
111         $str = get_string('databasesettingssub_mssql', 'install');
112         $str .= "<p style='text-align:right'><a href=\"javascript:void(0)\" ";
113         $str .= "onclick=\"return window.open('http://docs.moodle.org/en/Installing_MSSQL_for_PHP')\"";
114         $str .= ">";
115         $str .= '<img src="pix/docs.gif' . '" alt="Docs" class="iconhelp" />';
116         $str .= get_string('moodledocslink', 'install') . '</a></p>';
117         return $str;
118     }
120     /**
121      * Connect to db
122      * Must be called before other methods.
123      * @param string $dbhost The database host.
124      * @param string $dbuser The database username.
125      * @param string $dbpass The database username's password.
126      * @param string $dbname The name of the database being connected to.
127      * @param mixed $prefix string means moodle db prefix, false used for external databases where prefix not used
128      * @param array $dboptions driver specific options
129      * @return bool true
130      * @throws dml_connection_exception if error
131      */
132     public function connect($dbhost, $dbuser, $dbpass, $dbname, $prefix, array $dboptions=null) {
133         if ($prefix == '' and !$this->external) {
134             //Enforce prefixes for everybody but mysql
135             throw new dml_exception('prefixcannotbeempty', $this->get_dbfamily());
136         }
138         $driverstatus = $this->driver_installed();
140         if ($driverstatus !== true) {
141             throw new dml_exception('dbdriverproblem', $driverstatus);
142         }
144         $this->store_settings($dbhost, $dbuser, $dbpass, $dbname, $prefix, $dboptions);
146         $dbhost = $this->dbhost;
147         if (isset($dboptions['dbport'])) {
148             if (stristr(PHP_OS, 'win') && !stristr(PHP_OS, 'darwin')) {
149                 $dbhost .= ','.$dboptions['dbport'];
150             } else {
151                 $dbhost .= ':'.$dboptions['dbport'];
152             }
153         }
154         ob_start();
155         if (!empty($this->dboptions['dbpersist'])) { // persistent connection
156             $this->mssql = mssql_pconnect($dbhost, $this->dbuser, $this->dbpass, true);
157         } else {
158             $this->mssql = mssql_connect($dbhost, $this->dbuser, $this->dbpass, true);
159         }
160         $dberr = ob_get_contents();
161         ob_end_clean();
163         if ($this->mssql === false) {
164             $this->mssql = null;
165             throw new dml_connection_exception($dberr);
166         }
168         // already connected, select database and set some env. variables
169         $this->query_start("--mssql_select_db", null, SQL_QUERY_AUX);
170         $result = mssql_select_db($this->dbname, $this->mssql);
171         $this->query_end($result);
173         // No need to set charset. It's UTF8, with transparent conversions
174         // back and forth performed both by FreeTDS or ODBTP
176         // Allow quoted identifiers
177         $sql = "SET QUOTED_IDENTIFIER ON";
178         $this->query_start($sql, null, SQL_QUERY_AUX);
179         $result = mssql_query($sql, $this->mssql);
180         $this->query_end($result);
182         $this->free_result($result);
184         // Force ANSI nulls so the NULL check was done by IS NULL and NOT IS NULL
185         // instead of equal(=) and distinct(<>) symbols
186         $sql = "SET ANSI_NULLS ON";
187         $this->query_start($sql, null, SQL_QUERY_AUX);
188         $result = mssql_query($sql, $this->mssql);
189         $this->query_end($result);
191         $this->free_result($result);
193         // Force ANSI warnings so arithmetic/string overflows will be
194         // returning error instead of transparently truncating data
195         $sql = "SET ANSI_WARNINGS ON";
196         $this->query_start($sql, null, SQL_QUERY_AUX);
197         $result = mssql_query($sql, $this->mssql);
198         $this->query_end($result);
200         // Concatenating null with anything MUST return NULL
201         $sql = "SET CONCAT_NULL_YIELDS_NULL  ON";
202         $this->query_start($sql, null, SQL_QUERY_AUX);
203         $result = mssql_query($sql, $this->mssql);
204         $this->query_end($result);
206         $this->free_result($result);
208         // Set transactions isolation level to READ_COMMITTED
209         // prevents dirty reads when using transactions +
210         // is the default isolation level of MSSQL
211         // Requires database to run with READ_COMMITTED_SNAPSHOT ON
212         $sql = "SET TRANSACTION ISOLATION LEVEL READ COMMITTED";
213         $this->query_start($sql, NULL, SQL_QUERY_AUX);
214         $result = mssql_query($sql, $this->mssql);
215         $this->query_end($result);
217         $this->free_result($result);
219         // Connection stabilised and configured, going to instantiate the temptables controller
220         $this->temptables = new mssql_native_moodle_temptables($this);
222         return true;
223     }
225     /**
226      * Close database connection and release all resources
227      * and memory (especially circular memory references).
228      * Do NOT use connect() again, create a new instance if needed.
229      */
230     public function dispose() {
231         parent::dispose(); // Call parent dispose to write/close session and other common stuff before closing connection
232         if ($this->mssql) {
233             mssql_close($this->mssql);
234             $this->mssql = null;
235         }
236     }
238     /**
239      * Called before each db query.
240      * @param string $sql
241      * @param array array of parameters
242      * @param int $type type of query
243      * @param mixed $extrainfo driver specific extra information
244      * @return void
245      */
246     protected function query_start($sql, array $params=null, $type, $extrainfo=null) {
247         parent::query_start($sql, $params, $type, $extrainfo);
248         // mssql driver tends to send debug to output, we do not need that ;-)
249         $this->last_error_reporting = error_reporting(0);
250     }
252     /**
253      * Called immediately after each db query.
254      * @param mixed db specific result
255      * @return void
256      */
257     protected function query_end($result) {
258         // reset original debug level
259         error_reporting($this->last_error_reporting);
260         parent::query_end($result);
261     }
263     /**
264      * Returns database server info array
265      * @return array Array containing 'description' and 'version' info
266      */
267     public function get_server_info() {
268         static $info;
269         if (!$info) {
270             $info = array();
271             $sql = 'sp_server_info 2';
272             $this->query_start($sql, null, SQL_QUERY_AUX);
273             $result = mssql_query($sql, $this->mssql);
274             $this->query_end($result);
275             $row = mssql_fetch_row($result);
276             $info['description'] = $row[2];
277             $this->free_result($result);
279             $sql = 'sp_server_info 500';
280             $this->query_start($sql, null, SQL_QUERY_AUX);
281             $result = mssql_query($sql, $this->mssql);
282             $this->query_end($result);
283             $row = mssql_fetch_row($result);
284             $info['version'] = $row[2];
285             $this->free_result($result);
286         }
287         return $info;
288     }
290     protected function is_min_version($version) {
291         $server = $this->get_server_info();
292         $server = $server['version'];
293         return version_compare($server, $version, '>=');
294     }
296     /**
297      * Converts short table name {tablename} to real table name
298      * supporting temp tables (#) if detected
299      *
300      * @param string sql
301      * @return string sql
302      */
303     protected function fix_table_names($sql) {
304         if (preg_match_all('/\{([a-z][a-z0-9_]*)\}/', $sql, $matches)) {
305             foreach($matches[0] as $key=>$match) {
306                 $name = $matches[1][$key];
307                 if ($this->temptables->is_temptable($name)) {
308                     $sql = str_replace($match, $this->temptables->get_correct_name($name), $sql);
309                 } else {
310                     $sql = str_replace($match, $this->prefix.$name, $sql);
311                 }
312             }
313         }
314         return $sql;
315     }
317     /**
318      * Returns supported query parameter types
319      * @return int bitmask of accepted SQL_PARAMS_*
320      */
321     protected function allowed_param_types() {
322         return SQL_PARAMS_QM; // Not really, but emulated, see emulate_bound_params()
323     }
325     /**
326      * Returns last error reported by database engine.
327      * @return string error message
328      */
329     public function get_last_error() {
330         return mssql_get_last_message();
331     }
333     /**
334      * Return tables in database WITHOUT current prefix
335      * @param bool $usecache if true, returns list of cached tables.
336      * @return array of table names in lowercase and without prefix
337      */
338     public function get_tables($usecache=true) {
339         if ($usecache and $this->tables !== null) {
340             return $this->tables;
341         }
342         $this->tables = array();
343         $sql = "SELECT table_name
344                   FROM information_schema.tables
345                  WHERE table_name LIKE '$this->prefix%'
346                    AND table_type = 'BASE TABLE'";
347         $this->query_start($sql, null, SQL_QUERY_AUX);
348         $result = mssql_query($sql, $this->mssql);
349         $this->query_end($result);
351         if ($result) {
352             while ($row = mssql_fetch_row($result)) {
353                 $tablename = reset($row);
354                 if (strpos($tablename, $this->prefix) !== 0) {
355                     continue;
356                 }
357                 $tablename = substr($tablename, strlen($this->prefix));
358                 $this->tables[$tablename] = $tablename;
359             }
360             $this->free_result($result);
361         }
363         // Add the currently available temptables
364         $this->tables = array_merge($this->tables, $this->temptables->get_temptables());
365         return $this->tables;
366     }
368     /**
369      * Return table indexes - everything lowercased.
370      * @param string $table The table we want to get indexes from.
371      * @return array An associative array of indexes containing 'unique' flag and 'columns' being indexed
372      */
373     public function get_indexes($table) {
374         $indexes = array();
375         $tablename = $this->prefix.$table;
377         // Indexes aren't covered by information_schema metatables, so we need to
378         // go to sys ones. Skipping primary key indexes on purpose.
379         $sql = "SELECT i.name AS index_name, i.is_unique, ic.index_column_id, c.name AS column_name
380                   FROM sys.indexes i
381                   JOIN sys.index_columns ic ON i.object_id = ic.object_id AND i.index_id = ic.index_id
382                   JOIN sys.columns c ON ic.object_id = c.object_id AND ic.column_id = c.column_id
383                   JOIN sys.tables t ON i.object_id = t.object_id
384                  WHERE t.name = '$tablename'
385                    AND i.is_primary_key = 0
386               ORDER BY i.name, i.index_id, ic.index_column_id";
388         $this->query_start($sql, null, SQL_QUERY_AUX);
389         $result = mssql_query($sql, $this->mssql);
390         $this->query_end($result);
392         if ($result) {
393             $lastindex = '';
394             $unique = false;
395             $columns = array();
396             while ($row = mssql_fetch_assoc($result)) {
397                 if ($lastindex and $lastindex != $row['index_name']) { // Save lastindex to $indexes and reset info
398                     $indexes[$lastindex] = array('unique' => $unique, 'columns' => $columns);
399                     $unique = false;
400                     $columns = array();
401                 }
402                 $lastindex = $row['index_name'];
403                 $unique = empty($row['is_unique']) ? false : true;
404                 $columns[] = $row['column_name'];
405             }
406             if ($lastindex ) { // Add the last one if exists
407                 $indexes[$lastindex] = array('unique' => $unique, 'columns' => $columns);
408             }
409             $this->free_result($result);
410         }
411         return $indexes;
412     }
414     /**
415      * Returns datailed information about columns in table. This information is cached internally.
416      * @param string $table name
417      * @param bool $usecache
418      * @return array array of database_column_info objects indexed with column names
419      */
420     public function get_columns($table, $usecache=true) {
421         if ($usecache and isset($this->columns[$table])) {
422             return $this->columns[$table];
423         }
425         $this->columns[$table] = array();
427         if (!$this->temptables->is_temptable($table)) { // normal table, get metadata from own schema
428             $sql = "SELECT column_name AS name,
429                            data_type AS type,
430                            numeric_precision AS max_length,
431                            character_maximum_length AS char_max_length,
432                            numeric_scale AS scale,
433                            is_nullable AS is_nullable,
434                            columnproperty(object_id(quotename(table_schema) + '.' +
435                                quotename(table_name)), column_name, 'IsIdentity') AS auto_increment,
436                            column_default AS default_value
437                       FROM information_schema.columns
438                      WHERE table_name = '{" . $table . "}'
439                   ORDER BY ordinal_position";
440         } else { // temp table, get metadata from tempdb schema
441             $sql = "SELECT column_name AS name,
442                            data_type AS type,
443                            numeric_precision AS max_length,
444                            character_maximum_length AS char_max_length,
445                            numeric_scale AS scale,
446                            is_nullable AS is_nullable,
447                            columnproperty(object_id(quotename(table_schema) + '.' +
448                                quotename(table_name)), column_name, 'IsIdentity') AS auto_increment,
449                            column_default AS default_value
450                       FROM tempdb.information_schema.columns
451                       JOIN tempdb..sysobjects ON name = table_name
452                      WHERE id = object_id('tempdb..{" . $table . "}')
453                   ORDER BY ordinal_position";
454         }
456         list($sql, $params, $type) = $this->fix_sql_params($sql, null);
458         $this->query_start($sql, null, SQL_QUERY_AUX);
459         $result = mssql_query($sql, $this->mssql);
460         $this->query_end($result);
462         if (!$result) {
463             return array();
464         }
466         while ($rawcolumn = mssql_fetch_assoc($result)) {
468             $rawcolumn = (object)$rawcolumn;
470             $info = new stdClass();
471             $info->name = $rawcolumn->name;
472             $info->type = $rawcolumn->type;
473             $info->meta_type = $this->mssqltype2moodletype($info->type);
475             // Prepare auto_increment info
476             $info->auto_increment = $rawcolumn->auto_increment ? true : false;
478             // Define type for auto_increment columns
479             $info->meta_type = ($info->auto_increment && $info->meta_type == 'I') ? 'R' : $info->meta_type;
481             // id columns being auto_incremnt are PK by definition
482             $info->primary_key = ($info->name == 'id' && $info->meta_type == 'R' && $info->auto_increment);
484             // Put correct length for character and LOB types
485             $info->max_length = $info->meta_type == 'C' ? $rawcolumn->char_max_length : $rawcolumn->max_length;
486             $info->max_length = ($info->meta_type == 'X' || $info->meta_type == 'B') ? -1 : $info->max_length;
488             // Scale
489             $info->scale = $rawcolumn->scale ? $rawcolumn->scale : false;
491             // Prepare not_null info
492             $info->not_null = $rawcolumn->is_nullable == 'NO'  ? true : false;
494             // Process defaults
495             $info->has_default = !empty($rawcolumn->default_value);
496             if ($rawcolumn->default_value === NULL) {
497                 $info->default_value = NULL;
498             } else {
499                 $info->default_value = preg_replace("/^[\(N]+[']?(.*?)[']?[\)]+$/", '\\1', $rawcolumn->default_value);
500             }
502             // Process binary
503             $info->binary = $info->meta_type == 'B' ? true : false;
505             $this->columns[$table][$info->name] = new database_column_info($info);
506         }
507         $this->free_result($result);
509         return $this->columns[$table];
510     }
512     /**
513      * Normalise values based on varying RDBMS's dependencies (booleans, LOBs...)
514      *
515      * @param database_column_info $column column metadata corresponding with the value we are going to normalise
516      * @param mixed $value value we are going to normalise
517      * @return mixed the normalised value
518      */
519     protected function normalise_value($column, $value) {
520         if (is_bool($value)) { /// Always, convert boolean to int
521             $value = (int)$value;
522         } // And continue processing because text columns with numeric info need special handling below
524         if ($column->meta_type == 'B') {   // BLOBs need to be properly "packed", but can be inserted directly if so.
525             if (!is_null($value)) {               // If value not null, unpack it to unquoted hexadecimal byte-string format
526                 $value = unpack('H*hex', $value); // we leave it as array, so emulate_bound_params() can detect it
527             }                                     // easily and "bind" the param ok.
529         } else if ($column->meta_type == 'X') {             // MSSQL doesn't cast from int to text, so if text column
530             if (is_numeric($value)) {                       // and is numeric value then cast to string
531                 $value = array('numstr' => (string)$value); // and put into array, so emulate_bound_params() will know how
532             }                                               // to "bind" the param ok, avoiding reverse conversion to number
534         } else if ($value === '') {
535             if ($column->meta_type == 'I' or $column->meta_type == 'F' or $column->meta_type == 'N') {
536                 $value = 0; // prevent '' problems in numeric fields
537             }
538         }
539         return $value;
540     }
542     /**
543      * Selectively call mssql_free_result(), avoiding some warnings without using the horrible @
544      *
545      * @param mssql_resource $resource resource to be freed if possible
546      */
547     private function free_result($resource) {
548         if (!is_bool($resource)) { // true/false resources cannot be freed
549             mssql_free_result($resource);
550         }
551     }
553     /**
554      * Provides mapping between mssql native data types and moodle_database - database_column_info - ones)
555      *
556      * @param string $mssql_type native mssql data type
557      * @return string 1-char database_column_info data type
558      */
559     private function mssqltype2moodletype($mssql_type) {
560         $type = null;
561         switch (strtoupper($mssql_type)) {
562             case 'BIT':
563                 $type = 'L';
564                 break;
565             case 'INT':
566             case 'SMALLINT':
567             case 'INTEGER':
568             case 'BIGINT':
569                 $type = 'I';
570                 break;
571             case 'DECIMAL':
572             case 'REAL':
573             case 'FLOAT':
574                 $type = 'N';
575                 break;
576             case 'VARCHAR':
577             case 'NVARCHAR':
578                 $type = 'C';
579                 break;
580             case 'TEXT':
581             case 'NTEXT':
582             case 'VARCHAR(MAX)':
583             case 'NVARCHAR(MAX)':
584                 $type = 'X';
585                 break;
586             case 'IMAGE':
587             case 'VARBINARY(MAX)':
588                 $type = 'B';
589                 break;
590             case 'DATETIME':
591                 $type = 'D';
592                 break;
593         }
594         if (!$type) {
595             throw new dml_exception('invalidmssqlnativetype', $mssql_type);
596         }
597         return $type;
598     }
600     /**
601      * Do NOT use in code, to be used by database_manager only!
602      * @param string $sql query
603      * @return bool true
604      * @throws dml_exception A DML specific exception is thrown for any errors.
605      */
606     public function change_database_structure($sql) {
607         $this->reset_caches();
609         $this->query_start($sql, null, SQL_QUERY_STRUCTURE);
610         $result = mssql_query($sql, $this->mssql);
611         $this->query_end($result);
613         return true;
614     }
616     /**
617      * Very ugly hack which emulates bound parameters in queries
618      * because the mssql driver doesn't support placeholders natively at all
619      */
620     protected function emulate_bound_params($sql, array $params=null) {
621         if (empty($params)) {
622             return $sql;
623         }
624         /// ok, we have verified sql statement with ? and correct number of params
625         $parts = explode('?', $sql);
626         $return = array_shift($parts);
627         foreach ($params as $param) {
628             if (is_bool($param)) {
629                 $return .= (int)$param;
631             } else if (is_array($param) && isset($param['hex'])) { // detect hex binary, bind it specially
632                 $return .= '0x' . $param['hex'];
634             } else if (is_array($param) && isset($param['numstr'])) { // detect numerical strings that *must not*
635                 $return .= "N'{$param['numstr']}'";                   // be converted back to number params, but bound as strings
637             } else if (is_null($param)) {
638                 $return .= 'NULL';
640             } else if (is_number($param)) { // we can not use is_numeric() because it eats leading zeros from strings like 0045646
641                 $return .= "'".$param."'"; //fix for MDL-24863 to prevent auto-cast to int.
643             } else if (is_float($param)) {
644                 $return .= $param;
646             } else {
647                 $param = str_replace("'", "''", $param);
648                 $return .= "N'$param'";
649             }
651             $return .= array_shift($parts);
652         }
653         return $return;
654     }
656     /**
657      * Execute general sql query. Should be used only when no other method suitable.
658      * Do NOT use this to make changes in db structure, use database_manager::execute_sql() instead!
659      * @param string $sql query
660      * @param array $params query parameters
661      * @return bool true
662      * @throws dml_exception A DML specific exception is thrown for any errors.
663      */
664     public function execute($sql, array $params=null) {
666         list($sql, $params, $type) = $this->fix_sql_params($sql, $params);
667         $rawsql = $this->emulate_bound_params($sql, $params);
669         if (strpos($sql, ';') !== false) {
670             throw new coding_exception('moodle_database::execute() Multiple sql statements found or bound parameters not used properly in query!');
671         }
673         $this->query_start($sql, $params, SQL_QUERY_UPDATE);
674         $result = mssql_query($rawsql, $this->mssql);
675         $this->query_end($result);
676         $this->free_result($result);
678         return true;
679     }
681     /**
682      * Get a number of records as a moodle_recordset using a SQL statement.
683      *
684      * Since this method is a little less readable, use of it should be restricted to
685      * code where it's possible there might be large datasets being returned.  For known
686      * small datasets use get_records_sql - it leads to simpler code.
687      *
688      * The return type is like:
689      * @see function get_recordset.
690      *
691      * @param string $sql the SQL select query to execute.
692      * @param array $params array of sql parameters
693      * @param int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
694      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
695      * @return moodle_recordset instance
696      * @throws dml_exception A DML specific exception is thrown for any errors.
697      */
698     public function get_recordset_sql($sql, array $params=null, $limitfrom=0, $limitnum=0) {
699         $limitfrom = (int)$limitfrom;
700         $limitnum  = (int)$limitnum;
701         $limitfrom = ($limitfrom < 0) ? 0 : $limitfrom;
702         $limitnum  = ($limitnum < 0)  ? 0 : $limitnum;
703         if ($limitfrom or $limitnum) {
704             if ($limitnum >= 1) { // Only apply TOP clause if we have any limitnum (limitfrom offset is handled later)
705                 $fetch = $limitfrom + $limitnum;
706                 if (PHP_INT_MAX - $limitnum < $limitfrom) { // Check PHP_INT_MAX overflow
707                     $fetch = PHP_INT_MAX;
708                 }
709                 $sql = preg_replace('/^([\s(])*SELECT([\s]+(DISTINCT|ALL))?(?!\s*TOP\s*\()/i',
710                                     "\\1SELECT\\2 TOP $fetch", $sql);
711             }
712         }
714         list($sql, $params, $type) = $this->fix_sql_params($sql, $params);
715         $rawsql = $this->emulate_bound_params($sql, $params);
717         $this->query_start($sql, $params, SQL_QUERY_SELECT);
718         $result = mssql_query($rawsql, $this->mssql);
719         $this->query_end($result);
721         if ($limitfrom) { // Skip $limitfrom records
722             mssql_data_seek($result, $limitfrom);
723         }
725         return $this->create_recordset($result);
726     }
728     protected function create_recordset($result) {
729         return new mssql_native_moodle_recordset($result);
730     }
732     /**
733      * Get a number of records as an array of objects using a SQL statement.
734      *
735      * Return value is like:
736      * @see function get_records.
737      *
738      * @param string $sql the SQL select query to execute. The first column of this SELECT statement
739      *   must be a unique value (usually the 'id' field), as it will be used as the key of the
740      *   returned array.
741      * @param array $params array of sql parameters
742      * @param int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
743      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
744      * @return array of objects, or empty array if no records were found
745      * @throws dml_exception A DML specific exception is thrown for any errors.
746      */
747     public function get_records_sql($sql, array $params=null, $limitfrom=0, $limitnum=0) {
749         $rs = $this->get_recordset_sql($sql, $params, $limitfrom, $limitnum);
751         $results = array();
753         foreach ($rs as $row) {
754             $id = reset($row);
755             if (isset($results[$id])) {
756                 $colname = key($row);
757                 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);
758             }
759             $results[$id] = $row;
760         }
761         $rs->close();
763         return $results;
764     }
766     /**
767      * Selects records and return values (first field) as an array using a SQL statement.
768      *
769      * @param string $sql The SQL query
770      * @param array $params array of sql parameters
771      * @return array of values
772      * @throws dml_exception A DML specific exception is thrown for any errors.
773      */
774     public function get_fieldset_sql($sql, array $params=null) {
776         $rs = $this->get_recordset_sql($sql, $params);
778         $results = array();
780         foreach ($rs as $row) {
781             $results[] = reset($row);
782         }
783         $rs->close();
785         return $results;
786     }
788     /**
789      * Insert new record into database, as fast as possible, no safety checks, lobs not supported.
790      * @param string $table name
791      * @param mixed $params data record as object or array
792      * @param bool $returnit return it of inserted record
793      * @param bool $bulk true means repeated inserts expected
794      * @param bool $customsequence true if 'id' included in $params, disables $returnid
795      * @return bool|int true or new id
796      * @throws dml_exception A DML specific exception is thrown for any errors.
797      */
798     public function insert_record_raw($table, $params, $returnid=true, $bulk=false, $customsequence=false) {
799         if (!is_array($params)) {
800             $params = (array)$params;
801         }
803         $returning = "";
805         if ($customsequence) {
806             if (!isset($params['id'])) {
807                 throw new coding_exception('moodle_database::insert_record_raw() id field must be specified if custom sequences used.');
808             }
809             $returnid = false;
811             // Disable IDENTITY column before inserting record with id
812             $sql = 'SET IDENTITY_INSERT {' . $table . '} ON'; // Yes, it' ON!!
813             list($sql, $xparams, $xtype) = $this->fix_sql_params($sql, null);
814             $this->query_start($sql, null, SQL_QUERY_AUX);
815             $result = mssql_query($sql, $this->mssql);
816             $this->query_end($result);
817             $this->free_result($result);
819         } else {
820             unset($params['id']);
821             if ($returnid) {
822                 $returning = "; SELECT SCOPE_IDENTITY()";
823             }
824         }
826         if (empty($params)) {
827             throw new coding_exception('moodle_database::insert_record_raw() no fields found.');
828         }
830         $fields = implode(',', array_keys($params));
831         $qms    = array_fill(0, count($params), '?');
832         $qms    = implode(',', $qms);
834         $sql = "INSERT INTO {" . $table . "} ($fields) VALUES($qms) $returning";
836         list($sql, $params, $type) = $this->fix_sql_params($sql, $params);
837         $rawsql = $this->emulate_bound_params($sql, $params);
839         $this->query_start($sql, $params, SQL_QUERY_INSERT);
840         $result = mssql_query($rawsql, $this->mssql);
841         $this->query_end($result);
843         if ($returning !== "") {
844             $row = mssql_fetch_assoc($result);
845             $params['id'] = reset($row);
846         }
847         $this->free_result($result);
849         if ($customsequence) {
850             // Enable IDENTITY column after inserting record with id
851             $sql = 'SET IDENTITY_INSERT {' . $table . '} OFF'; // Yes, it' OFF!!
852             list($sql, $xparams, $xtype) = $this->fix_sql_params($sql, null);
853             $this->query_start($sql, null, SQL_QUERY_AUX);
854             $result = mssql_query($sql, $this->mssql);
855             $this->query_end($result);
856             $this->free_result($result);
857         }
859         if (!$returnid) {
860             return true;
861         }
863         return (int)$params['id'];
864     }
866     /**
867      * Insert a record into a table and return the "id" field if required.
868      *
869      * Some conversions and safety checks are carried out. Lobs are supported.
870      * If the return ID isn't required, then this just reports success as true/false.
871      * $data is an object containing needed data
872      * @param string $table The database table to be inserted into
873      * @param object $data A data object with values for one or more fields in the record
874      * @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.
875      * @return bool|int true or new id
876      * @throws dml_exception A DML specific exception is thrown for any errors.
877      */
878     public function insert_record($table, $dataobject, $returnid=true, $bulk=false) {
879         $dataobject = (array)$dataobject;
881         $columns = $this->get_columns($table);
882         $cleaned = array();
884         foreach ($dataobject as $field => $value) {
885             if ($field === 'id') {
886                 continue;
887             }
888             if (!isset($columns[$field])) {
889                 continue;
890             }
891             $column = $columns[$field];
892             $cleaned[$field] = $this->normalise_value($column, $value);
893         }
895         return $this->insert_record_raw($table, $cleaned, $returnid, $bulk);
896     }
898     /**
899      * Import a record into a table, id field is required.
900      * Safety checks are NOT carried out. Lobs are supported.
901      *
902      * @param string $table name of database table to be inserted into
903      * @param object $dataobject A data object with values for one or more fields in the record
904      * @return bool true
905      * @throws dml_exception A DML specific exception is thrown for any errors.
906      */
907     public function import_record($table, $dataobject) {
908         $dataobject = (array)$dataobject;
910         $columns = $this->get_columns($table);
911         $cleaned = array();
913         foreach ($dataobject as $field => $value) {
914             if (!isset($columns[$field])) {
915                 continue;
916             }
917             $column = $columns[$field];
918             $cleaned[$field] = $this->normalise_value($column, $value);
919         }
921         $this->insert_record_raw($table, $cleaned, false, false, true);
923         return true;
924     }
926     /**
927      * Update record in database, as fast as possible, no safety checks, lobs not supported.
928      * @param string $table name
929      * @param mixed $params data record as object or array
930      * @param bool true means repeated updates expected
931      * @return bool true
932      * @throws dml_exception A DML specific exception is thrown for any errors.
933      */
934     public function update_record_raw($table, $params, $bulk=false) {
935         $params = (array)$params;
937         if (!isset($params['id'])) {
938             throw new coding_exception('moodle_database::update_record_raw() id field must be specified.');
939         }
940         $id = $params['id'];
941         unset($params['id']);
943         if (empty($params)) {
944             throw new coding_exception('moodle_database::update_record_raw() no fields found.');
945         }
947         $sets = array();
948         foreach ($params as $field=>$value) {
949             $sets[] = "$field = ?";
950         }
952         $params[] = $id; // last ? in WHERE condition
954         $sets = implode(',', $sets);
955         $sql = "UPDATE {" . $table . "} SET $sets WHERE id = ?";
957         list($sql, $params, $type) = $this->fix_sql_params($sql, $params);
958         $rawsql = $this->emulate_bound_params($sql, $params);
960         $this->query_start($sql, $params, SQL_QUERY_UPDATE);
961         $result = mssql_query($rawsql, $this->mssql);
962         $this->query_end($result);
964         $this->free_result($result);
965         return true;
966     }
968     /**
969      * Update a record in a table
970      *
971      * $dataobject is an object containing needed data
972      * Relies on $dataobject having a variable "id" to
973      * specify the record to update
974      *
975      * @param string $table The database table to be checked against.
976      * @param object $dataobject An object with contents equal to fieldname=>fieldvalue. Must have an entry for 'id' to map to the table specified.
977      * @param bool true means repeated updates expected
978      * @return bool true
979      * @throws dml_exception A DML specific exception is thrown for any errors.
980      */
981     public function update_record($table, $dataobject, $bulk=false) {
982         $dataobject = (array)$dataobject;
984         $columns = $this->get_columns($table);
985         $cleaned = array();
987         foreach ($dataobject as $field => $value) {
988             if (!isset($columns[$field])) {
989                 continue;
990             }
991             $column = $columns[$field];
992             $cleaned[$field] = $this->normalise_value($column, $value);
993         }
995         return $this->update_record_raw($table, $cleaned, $bulk);
996     }
998     /**
999      * Set a single field in every table record which match a particular WHERE clause.
1000      *
1001      * @param string $table The database table to be checked against.
1002      * @param string $newfield the field to set.
1003      * @param string $newvalue the value to set the field to.
1004      * @param string $select A fragment of SQL to be used in a where clause in the SQL call.
1005      * @param array $params array of sql parameters
1006      * @return bool true
1007      * @throws dml_exception A DML specific exception is thrown for any errors.
1008      */
1009     public function set_field_select($table, $newfield, $newvalue, $select, array $params=null) {
1011         if ($select) {
1012             $select = "WHERE $select";
1013         }
1014         if (is_null($params)) {
1015             $params = array();
1016         }
1018         // convert params to ? types
1019         list($select, $params, $type) = $this->fix_sql_params($select, $params);
1021     /// Get column metadata
1022         $columns = $this->get_columns($table);
1023         $column = $columns[$newfield];
1025         $newvalue = $this->normalise_value($column, $newvalue);
1027         if (is_null($newvalue)) {
1028             $newfield = "$newfield = NULL";
1029         } else {
1030             $newfield = "$newfield = ?";
1031             array_unshift($params, $newvalue);
1032         }
1033         $sql = "UPDATE {" . $table . "} SET $newfield $select";
1035         list($sql, $params, $type) = $this->fix_sql_params($sql, $params);
1036         $rawsql = $this->emulate_bound_params($sql, $params);
1038         $this->query_start($sql, $params, SQL_QUERY_UPDATE);
1039         $result = mssql_query($rawsql, $this->mssql);
1040         $this->query_end($result);
1042         $this->free_result($result);
1044         return true;
1045     }
1047     /**
1048      * Delete one or more records from a table which match a particular WHERE clause.
1049      *
1050      * @param string $table The database table to be checked against.
1051      * @param string $select A fragment of SQL to be used in a where clause in the SQL call (used to define the selection criteria).
1052      * @param array $params array of sql parameters
1053      * @return bool true
1054      * @throws dml_exception A DML specific exception is thrown for any errors.
1055      */
1056     public function delete_records_select($table, $select, array $params=null) {
1058         if ($select) {
1059             $select = "WHERE $select";
1060         }
1062         $sql = "DELETE FROM {" . $table . "} $select";
1064         list($sql, $params, $type) = $this->fix_sql_params($sql, $params);
1065         $rawsql = $this->emulate_bound_params($sql, $params);
1067         $this->query_start($sql, $params, SQL_QUERY_UPDATE);
1068         $result = mssql_query($rawsql, $this->mssql);
1069         $this->query_end($result);
1071         $this->free_result($result);
1073         return true;
1074     }
1076 /// SQL helper functions
1078     public function sql_cast_char2int($fieldname, $text=false) {
1079         if (!$text) {
1080             return ' CAST(' . $fieldname . ' AS INT) ';
1081         } else {
1082             return ' CAST(' . $this->sql_compare_text($fieldname) . ' AS INT) ';
1083         }
1084     }
1086     public function sql_cast_char2real($fieldname, $text=false) {
1087         if (!$text) {
1088             return ' CAST(' . $fieldname . ' AS REAL) ';
1089         } else {
1090             return ' CAST(' . $this->sql_compare_text($fieldname) . ' AS REAL) ';
1091         }
1092     }
1094     public function sql_ceil($fieldname) {
1095         return ' CEILING(' . $fieldname . ')';
1096     }
1099     protected function get_collation() {
1100         if (isset($this->collation)) {
1101             return $this->collation;
1102         }
1103         if (!empty($this->dboptions['dbcollation'])) {
1104             // perf speedup
1105             $this->collation = $this->dboptions['dbcollation'];
1106             return $this->collation;
1107         }
1109         // make some default
1110         $this->collation = 'Latin1_General_CI_AI';
1112         $sql = "SELECT CAST(DATABASEPROPERTYEX('$this->dbname', 'Collation') AS varchar(255)) AS SQLCollation";
1113         $this->query_start($sql, null, SQL_QUERY_AUX);
1114         $result = mssql_query($sql, $this->mssql);
1115         $this->query_end($result);
1117         if ($result) {
1118             if ($rawcolumn = mssql_fetch_assoc($result)) {
1119                 $this->collation = reset($rawcolumn);
1120             }
1121             $this->free_result($result);
1122         }
1124         return $this->collation;
1125     }
1127     /**
1128      * Returns 'LIKE' part of a query.
1129      *
1130      * @param string $fieldname usually name of the table column
1131      * @param string $param usually bound query parameter (?, :named)
1132      * @param bool $casesensitive use case sensitive search
1133      * @param bool $accensensitive use accent sensitive search (not all databases support accent insensitive)
1134      * @param bool $notlike true means "NOT LIKE"
1135      * @param string $escapechar escape char for '%' and '_'
1136      * @return string SQL code fragment
1137      */
1138     public function sql_like($fieldname, $param, $casesensitive = true, $accentsensitive = true, $notlike = false, $escapechar = '\\') {
1139         if (strpos($param, '%') !== false) {
1140             debugging('Potential SQL injection detected, sql_ilike() expects bound parameters (? or :named)');
1141         }
1143         $collation = $this->get_collation();
1145         if ($casesensitive) {
1146             $collation = str_replace('_CI', '_CS', $collation);
1147         } else {
1148             $collation = str_replace('_CS', '_CI', $collation);
1149         }
1150         if ($accentsensitive) {
1151             $collation = str_replace('_AI', '_AS', $collation);
1152         } else {
1153             $collation = str_replace('_AS', '_AI', $collation);
1154         }
1156         $LIKE = $notlike ? 'NOT LIKE' : 'LIKE';
1158         return "$fieldname COLLATE $collation $LIKE $param ESCAPE '$escapechar'";
1159     }
1161     public function sql_concat() {
1162         $arr = func_get_args();
1163         foreach ($arr as $key => $ele) {
1164             $arr[$key] = ' CAST(' . $ele . ' AS VARCHAR(255)) ';
1165         }
1166         $s = implode(' + ', $arr);
1167         if ($s === '') {
1168             return " '' ";
1169         }
1170         return " $s ";
1171     }
1173     public function sql_concat_join($separator="' '", $elements=array()) {
1174         for ($n=count($elements)-1; $n > 0 ; $n--) {
1175             array_splice($elements, $n, 0, $separator);
1176         }
1177         $s = implode(' + ', $elements);
1178         if ($s === '') {
1179             return " '' ";
1180         }
1181         return " $s ";
1182     }
1184    public function sql_isempty($tablename, $fieldname, $nullablefield, $textfield) {
1185         if ($textfield) {
1186             return ' (' . $this->sql_compare_text($fieldname) . " = '') ";
1187         } else {
1188             return " ($fieldname = '') ";
1189         }
1190     }
1192    /**
1193      * Returns the SQL text to be used to calculate the length in characters of one expression.
1194      * @param string fieldname or expression to calculate its length in characters.
1195      * @return string the piece of SQL code to be used in the statement.
1196      */
1197     public function sql_length($fieldname) {
1198         return ' LEN(' . $fieldname . ')';
1199     }
1201     public function sql_order_by_text($fieldname, $numchars=32) {
1202         return ' CONVERT(varchar, ' . $fieldname . ', ' . $numchars . ')';
1203     }
1205    /**
1206      * Returns the SQL for returning searching one string for the location of another.
1207      */
1208     public function sql_position($needle, $haystack) {
1209         return "CHARINDEX(($needle), ($haystack))";
1210     }
1212     /**
1213      * Returns the proper substr() SQL text used to extract substrings from DB
1214      * NOTE: this was originally returning only function name
1215      *
1216      * @param string $expr some string field, no aggregates
1217      * @param mixed $start integer or expression evaluating to int
1218      * @param mixed $length optional integer or expression evaluating to int
1219      * @return string sql fragment
1220      */
1221     public function sql_substr($expr, $start, $length=false) {
1222         if (count(func_get_args()) < 2) {
1223             throw new coding_exception('moodle_database::sql_substr() requires at least two parameters', 'Originaly this function wa
1224 s only returning name of SQL substring function, it now requires all parameters.');
1225         }
1226         if ($length === false) {
1227             return "SUBSTRING($expr, $start, (LEN($expr) - $start + 1))";
1228         } else {
1229             return "SUBSTRING($expr, $start, $length)";
1230         }
1231     }
1233 /// session locking
1235     public function session_lock_supported() {
1236         return true;
1237     }
1239     /**
1240      * Obtain session lock
1241      * @param int $rowid id of the row with session record
1242      * @param int $timeout max allowed time to wait for the lock in seconds
1243      * @return bool success
1244      */
1245     public function get_session_lock($rowid, $timeout) {
1246         if (!$this->session_lock_supported()) {
1247             return;
1248         }
1249         parent::get_session_lock($rowid, $timeout);
1251         $timeoutmilli = $timeout * 1000;
1253         $fullname = $this->dbname.'-'.$this->prefix.'-session-'.$rowid;
1254         // There is one bug in PHP/freetds (both reproducible with mssql_query()
1255         // and its mssql_init()/mssql_bind()/mssql_execute() alternative) for
1256         // stored procedures, causing scalar results of the execution
1257         // to be cast to boolean (true/fals). Here there is one
1258         // workaround that forces the return of one recordset resource.
1259         // $sql = "sp_getapplock '$fullname', 'Exclusive', 'Session',  $timeoutmilli";
1260         $sql = "BEGIN
1261                     DECLARE @result INT
1262                     EXECUTE @result = sp_getapplock @Resource='$fullname',
1263                                                     @LockMode='Exclusive',
1264                                                     @LockOwner='Session',
1265                                                     @LockTimeout='$timeoutmilli'
1266                     SELECT @result
1267                 END";
1268         $this->query_start($sql, null, SQL_QUERY_AUX);
1269         $result = mssql_query($sql, $this->mssql);
1270         $this->query_end($result);
1272         if ($result) {
1273             $row = mssql_fetch_row($result);
1274             if ($row[0] < 0) {
1275                 throw new dml_sessionwait_exception();
1276             }
1277         }
1279         $this->free_result($result);
1280     }
1282     public function release_session_lock($rowid) {
1283         if (!$this->session_lock_supported()) {
1284             return;
1285         }
1286         parent::release_session_lock($rowid);
1288         $fullname = $this->dbname.'-'.$this->prefix.'-session-'.$rowid;
1289         $sql = "sp_releaseapplock '$fullname', 'Session'";
1290         $this->query_start($sql, null, SQL_QUERY_AUX);
1291         $result = mssql_query($sql, $this->mssql);
1292         $this->query_end($result);
1294         $this->free_result($result);
1295     }
1297 /// transactions
1299     /**
1300      * Driver specific start of real database transaction,
1301      * this can not be used directly in code.
1302      * @return void
1303      */
1304     protected function begin_transaction() {
1305         // requires database to run with READ_COMMITTED_SNAPSHOT ON
1306         $sql = "BEGIN TRANSACTION"; // Will be using READ COMMITTED isolation
1307         $this->query_start($sql, NULL, SQL_QUERY_AUX);
1308         $result = mssql_query($sql, $this->mssql);
1309         $this->query_end($result);
1311         $this->free_result($result);
1312     }
1314     /**
1315      * Driver specific commit of real database transaction,
1316      * this can not be used directly in code.
1317      * @return void
1318      */
1319     protected function commit_transaction() {
1320         $sql = "COMMIT TRANSACTION";
1321         $this->query_start($sql, NULL, SQL_QUERY_AUX);
1322         $result = mssql_query($sql, $this->mssql);
1323         $this->query_end($result);
1325         $this->free_result($result);
1326     }
1328     /**
1329      * Driver specific abort of real database transaction,
1330      * this can not be used directly in code.
1331      * @return void
1332      */
1333     protected function rollback_transaction() {
1334         $sql = "ROLLBACK TRANSACTION";
1335         $this->query_start($sql, NULL, SQL_QUERY_AUX);
1336         $result = mssql_query($sql, $this->mssql);
1337         $this->query_end($result);
1339         $this->free_result($result);
1340     }