MDL-29415 xmldb - fix get_columns() in oracle to get char based lengths + test
[moodle.git] / lib / dml / oci_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 oci class representing moodle database interface.
21  *
22  * @package    core
23  * @subpackage dml
24  * @copyright  2008 Petr Skoda (http://skodak.org)
25  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
26  */
28 defined('MOODLE_INTERNAL') || die();
30 require_once($CFG->libdir.'/dml/moodle_database.php');
31 require_once($CFG->libdir.'/dml/oci_native_moodle_recordset.php');
32 require_once($CFG->libdir.'/dml/oci_native_moodle_temptables.php');
34 /**
35  * Native oci class representing moodle database interface.
36  *
37  * One complete reference for PHP + OCI:
38  * http://www.oracle.com/technology/tech/php/underground-php-oracle-manual.html
39  */
40 class oci_native_moodle_database extends moodle_database {
42     protected $oci     = null;
44     private $last_stmt_error = null; // To store stmt errors and enable get_last_error() to detect them
45     private $commit_status = null;   // default value initialised in connect method, we need the driver to be present
47     private $last_error_reporting; // To handle oci driver default verbosity
48     private $unique_session_id; // To store unique_session_id. Needed for temp tables unique naming
50     private $dblocks_supported = null; // To cache locks support along the connection life
51     private $bitwise_supported = null; // To cache bitwise operations support along the connection life
53     /**
54      * Detects if all needed PHP stuff installed.
55      * Note: can be used before connect()
56      * @return mixed true if ok, string if something
57      */
58     public function driver_installed() {
59         if (!extension_loaded('oci8')) {
60             return get_string('ociextensionisnotpresentinphp', 'install');
61         }
62         return true;
63     }
65     /**
66      * Returns database family type - describes SQL dialect
67      * Note: can be used before connect()
68      * @return string db family name (mysql, postgres, mssql, oracle, etc.)
69      */
70     public function get_dbfamily() {
71         return 'oracle';
72     }
74     /**
75      * Returns more specific database driver type
76      * Note: can be used before connect()
77      * @return string db type mysqli, pgsql, oci, mssql, sqlsrv
78      */
79     protected function get_dbtype() {
80         return 'oci';
81     }
83     /**
84      * Returns general database library name
85      * Note: can be used before connect()
86      * @return string db type pdo, native
87      */
88     protected function get_dblibrary() {
89         return 'native';
90     }
92     /**
93      * Returns localised database type name
94      * Note: can be used before connect()
95      * @return string
96      */
97     public function get_name() {
98         return get_string('nativeoci', 'install');
99     }
101     /**
102      * Returns localised database configuration help.
103      * Note: can be used before connect()
104      * @return string
105      */
106     public function get_configuration_help() {
107         return get_string('nativeocihelp', 'install');
108     }
110     /**
111      * Returns localised database description
112      * Note: can be used before connect()
113      * @return string
114      */
115     public function get_configuration_hints() {
116         return get_string('databasesettingssub_oci', 'install');
117     }
119     /**
120      * Diagnose database and tables, this function is used
121      * to verify database and driver settings, db engine types, etc.
122      *
123      * @return string null means everything ok, string means problem found.
124      */
125     public function diagnose() {
126         if (!$this->bitwise_supported() or !$this->session_lock_supported()) {
127             return 'Oracle PL/SQL Moodle support packages are not installed! Database administrator has to execute /lib/dml/oci_native_moodle_package.sql script.';
128         }
129         return null;
130     }
132     /**
133      * Connect to db
134      * Must be called before other methods.
135      * @param string $dbhost
136      * @param string $dbuser
137      * @param string $dbpass
138      * @param string $dbname
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         }
149         if (!$this->external and strlen($prefix) > 2) {
150             //Max prefix length for Oracle is 2cc
151             $a = (object)array('dbfamily'=>'oracle', 'maxlength'=>2);
152             throw new dml_exception('prefixtoolong', $a);
153         }
155         $driverstatus = $this->driver_installed();
157         if ($driverstatus !== true) {
158             throw new dml_exception('dbdriverproblem', $driverstatus);
159         }
161         // Autocommit ON by default.
162         // Switching to OFF (OCI_DEFAULT), when playing with transactions
163         // please note this thing is not defined if oracle driver not present in PHP
164         // which means it can not be used as default value of object property!
165         $this->commit_status = OCI_COMMIT_ON_SUCCESS;
167         $this->store_settings($dbhost, $dbuser, $dbpass, $dbname, $prefix, $dboptions);
168         unset($this->dboptions['dbsocket']);
170         // NOTE: use of ', ", /¬†and \ is very problematic, even native oracle tools seem to have
171         //       problems with these, so just forget them and do not report problems into tracker...
173         if (empty($this->dbhost)) {
174             // old style full address (TNS)
175             $dbstring = $this->dbname;
176         } else {
177             if (empty($this->dboptions['dbport'])) {
178                 $this->dboptions['dbport'] = 1521;
179             }
180             $dbstring = '//'.$this->dbhost.':'.$this->dboptions['dbport'].'/'.$this->dbname;
181         }
183         ob_start();
184         if (empty($this->dboptions['dbpersist'])) {
185             $this->oci = oci_new_connect($this->dbuser, $this->dbpass, $dbstring, 'AL32UTF8');
186         } else {
187             $this->oci = oci_pconnect($this->dbuser, $this->dbpass, $dbstring, 'AL32UTF8');
188         }
189         $dberr = ob_get_contents();
190         ob_end_clean();
193         if ($this->oci === false) {
194             $this->oci = null;
195             $e = oci_error();
196             if (isset($e['message'])) {
197                 $dberr = $e['message'];
198             }
199             throw new dml_connection_exception($dberr);
200         }
202         // get unique session id, to be used later for temp tables stuff
203         $sql = 'SELECT DBMS_SESSION.UNIQUE_SESSION_ID() FROM DUAL';
204         $this->query_start($sql, null, SQL_QUERY_AUX);
205         $stmt = $this->parse_query($sql);
206         $result = oci_execute($stmt, $this->commit_status);
207         $this->query_end($result, $stmt);
208         $records = null;
209         oci_fetch_all($stmt, $records, 0, -1, OCI_FETCHSTATEMENT_BY_ROW);
210         oci_free_statement($stmt);
211         $this->unique_session_id = reset($records[0]);
213         //note: do not send "ALTER SESSION SET NLS_NUMERIC_CHARACTERS='.,'" !
214         //      instead fix our PHP code to convert "," to "." properly!
216         // Connection stabilised and configured, going to instantiate the temptables controller
217         $this->temptables = new oci_native_moodle_temptables($this, $this->unique_session_id);
219         return true;
220     }
222     /**
223      * Close database connection and release all resources
224      * and memory (especially circular memory references).
225      * Do NOT use connect() again, create a new instance if needed.
226      */
227     public function dispose() {
228         parent::dispose(); // Call parent dispose to write/close session and other common stuff before closing connection
229         if ($this->oci) {
230             oci_close($this->oci);
231             $this->oci = null;
232         }
233     }
236     /**
237      * Called before each db query.
238      * @param string $sql
239      * @param array array of parameters
240      * @param int $type type of query
241      * @param mixed $extrainfo driver specific extra information
242      * @return void
243      */
244     protected function query_start($sql, array $params=null, $type, $extrainfo=null) {
245         parent::query_start($sql, $params, $type, $extrainfo);
246         // oci driver tents to send debug to output, we do not need that ;-)
247         $this->last_error_reporting = error_reporting(0);
248     }
250     /**
251      * Called immediately after each db query.
252      * @param mixed db specific result
253      * @return void
254      */
255     protected function query_end($result, $stmt=null) {
256         // reset original debug level
257         error_reporting($this->last_error_reporting);
258         if ($stmt and $result === false) {
259             // Look for stmt error and store it
260             if (is_resource($stmt)) {
261                 $e = oci_error($stmt);
262                 if ($e !== false) {
263                     $this->last_stmt_error = $e['message'];
264                 }
265             }
266             oci_free_statement($stmt);
267         }
268         parent::query_end($result);
269     }
271     /**
272      * Returns database server info array
273      * @return array
274      */
275     public function get_server_info() {
276         static $info = null; // TODO: move to real object property
278         if (is_null($info)) {
279             $this->query_start("--oci_server_version()", null, SQL_QUERY_AUX);
280             $description = oci_server_version($this->oci);
281             $this->query_end(true);
282             preg_match('/(\d+\.)+\d+/', $description, $matches);
283             $info = array('description'=>$description, 'version'=>$matches[0]);
284         }
286         return $info;
287     }
289     protected function is_min_version($version) {
290         $server = $this->get_server_info();
291         $server = $server['version'];
292         return version_compare($server, $version, '>=');
293     }
295     /**
296      * Converts short table name {tablename} to real table name
297      * supporting temp tables ($this->unique_session_id based) if detected
298      *
299      * @param string sql
300      * @return string sql
301      */
302     protected function fix_table_names($sql) {
303         if (preg_match_all('/\{([a-z][a-z0-9_]*)\}/', $sql, $matches)) {
304             foreach($matches[0] as $key=>$match) {
305                 $name = $matches[1][$key];
306                 if ($this->temptables->is_temptable($name)) {
307                     $sql = str_replace($match, $this->temptables->get_correct_name($name), $sql);
308                 } else {
309                     $sql = str_replace($match, $this->prefix.$name, $sql);
310                 }
311             }
312         }
313         return $sql;
314     }
316     /**
317      * Returns supported query parameter types
318      * @return int bitmask
319      */
320     protected function allowed_param_types() {
321         return SQL_PARAMS_NAMED;
322     }
324     /**
325      * Returns last error reported by database engine.
326      * @return string error message
327      */
328     public function get_last_error() {
329         $error = false;
330         // First look for any previously saved stmt error
331         if (!empty($this->last_stmt_error)) {
332             $error = $this->last_stmt_error;
333             $this->last_stmt_error = null;
334         } else { // Now try connection error
335             $e = oci_error($this->oci);
336             if ($e !== false) {
337                 $error = $e['message'];
338             }
339         }
340         return $error;
341     }
343     /**
344      * Prepare the statement for execution
345      * @throws dml_connection_exception
346      * @param string $sql
347      * @return resource
348      */
349     protected function parse_query($sql) {
350         $stmt = oci_parse($this->oci, $sql);
351         if ($stmt == false) {
352             throw new dml_connection_exception('Can not parse sql query'); //TODO: maybe add better info
353         }
354         return $stmt;
355     }
357     /**
358      * Make sure there are no reserved words in param names...
359      * @param string $sql
360      * @param array $params
361      * @return array ($sql, $params) updated query and parameters
362      */
363     protected function tweak_param_names($sql, array $params) {
364         if (empty($params)) {
365             return array($sql, $params);
366         }
368         $newparams = array();
369         $searcharr = array(); // search => replace pairs
370         foreach ($params as $name => $value) {
371             // Keep the name within the 30 chars limit always (prefixing/replacing)
372             if (strlen($name) <= 28) {
373                 $newname = 'o_' . $name;
374             } else {
375                 $newname = 'o_' . substr($name, 2);
376             }
377             $newparams[$newname] = $value;
378             $searcharr[':' . $name] = ':' . $newname;
379         }
380         // sort by length desc to avoid potential str_replace() overlap
381         uksort($searcharr, array('oci_native_moodle_database', 'compare_by_length_desc'));
383         $sql = str_replace(array_keys($searcharr), $searcharr, $sql);
384         return array($sql, $newparams);
385     }
387     /**
388      * Return tables in database WITHOUT current prefix
389      * @return array of table names in lowercase and without prefix
390      */
391     public function get_tables($usecache=true) {
392         if ($usecache and $this->tables !== null) {
393             return $this->tables;
394         }
395         $this->tables = array();
396         $prefix = str_replace('_', "\\_", strtoupper($this->prefix));
397         $sql = "SELECT TABLE_NAME
398                   FROM CAT
399                  WHERE TABLE_TYPE='TABLE'
400                        AND TABLE_NAME NOT LIKE 'BIN\$%'
401                        AND TABLE_NAME LIKE '$prefix%' ESCAPE '\\'";
402         $this->query_start($sql, null, SQL_QUERY_AUX);
403         $stmt = $this->parse_query($sql);
404         $result = oci_execute($stmt, $this->commit_status);
405         $this->query_end($result, $stmt);
406         $records = null;
407         oci_fetch_all($stmt, $records, 0, -1, OCI_ASSOC);
408         oci_free_statement($stmt);
409         $records = array_map('strtolower', $records['TABLE_NAME']);
410         foreach ($records as $tablename) {
411             if (strpos($tablename, $this->prefix) !== 0) {
412                 continue;
413             }
414             $tablename = substr($tablename, strlen($this->prefix));
415             $this->tables[$tablename] = $tablename;
416         }
418         // Add the currently available temptables
419         $this->tables = array_merge($this->tables, $this->temptables->get_temptables());
421         return $this->tables;
422     }
424     /**
425      * Return table indexes - everything lowercased
426      * @return array of arrays
427      */
428     public function get_indexes($table) {
429         $indexes = array();
430         $tablename = strtoupper($this->prefix.$table);
432         $sql = "SELECT i.INDEX_NAME, i.UNIQUENESS, c.COLUMN_POSITION, c.COLUMN_NAME, ac.CONSTRAINT_TYPE
433                   FROM ALL_INDEXES i
434                   JOIN ALL_IND_COLUMNS c ON c.INDEX_NAME=i.INDEX_NAME
435              LEFT JOIN ALL_CONSTRAINTS ac ON (ac.TABLE_NAME=i.TABLE_NAME AND ac.CONSTRAINT_NAME=i.INDEX_NAME AND ac.CONSTRAINT_TYPE='P')
436                  WHERE i.TABLE_NAME = '$tablename'
437               ORDER BY i.INDEX_NAME, c.COLUMN_POSITION";
439         $stmt = $this->parse_query($sql);
440         $result = oci_execute($stmt, $this->commit_status);
441         $this->query_end($result, $stmt);
442         $records = null;
443         oci_fetch_all($stmt, $records, 0, -1, OCI_FETCHSTATEMENT_BY_ROW);
444         oci_free_statement($stmt);
446         foreach ($records as $record) {
447             if ($record['CONSTRAINT_TYPE'] === 'P') {
448                 //ignore for now;
449                 continue;
450             }
451             $indexname = strtolower($record['INDEX_NAME']);
452             if (!isset($indexes[$indexname])) {
453                 $indexes[$indexname] = array('primary' => ($record['CONSTRAINT_TYPE'] === 'P'),
454                                              'unique'  => ($record['UNIQUENESS'] === 'UNIQUE'),
455                                              'columns' => array());
456             }
457             $indexes[$indexname]['columns'][] = strtolower($record['COLUMN_NAME']);
458         }
460         return $indexes;
461     }
463     /**
464      * Returns detailed information about columns in table. This information is cached internally.
465      * @param string $table name
466      * @param bool $usecache
467      * @return array array of database_column_info objects indexed with column names
468      */
469     public function get_columns($table, $usecache=true) {
470         if ($usecache and isset($this->columns[$table])) {
471             return $this->columns[$table];
472         }
474         if (!$table) { // table not specified, return empty array directly
475             return array();
476         }
478         $this->columns[$table] = array();
480         // We give precedence to CHAR_LENGTH for VARCHAR2 columns over WIDTH because the former is always
481         // BYTE based and, for cross-db operations, we want CHAR based results. See MDL-29415
482         $sql = "SELECT CNAME, COLTYPE, nvl(CHAR_LENGTH, WIDTH) AS WIDTH, SCALE, PRECISION, NULLS, DEFAULTVAL
483                   FROM COL c
484              LEFT JOIN USER_TAB_COLUMNS u ON (u.TABLE_NAME = c.TNAME AND u.COLUMN_NAME = c.CNAME AND u.DATA_TYPE = 'VARCHAR2')
485                  WHERE TNAME = UPPER('{" . $table . "}')
486               ORDER BY COLNO";
488         list($sql, $params, $type) = $this->fix_sql_params($sql, null);
490         $this->query_start($sql, null, SQL_QUERY_AUX);
491         $stmt = $this->parse_query($sql);
492         $result = oci_execute($stmt, $this->commit_status);
493         $this->query_end($result, $stmt);
494         $records = null;
495         oci_fetch_all($stmt, $records, 0, -1, OCI_FETCHSTATEMENT_BY_ROW);
496         oci_free_statement($stmt);
498         if (!$records) {
499             return array();
500         }
501         foreach ($records as $rawcolumn) {
502             $rawcolumn = (object)$rawcolumn;
504             $info = new stdClass();
505             $info->name = strtolower($rawcolumn->CNAME);
506             $matches = null;
508             if ($rawcolumn->COLTYPE === 'VARCHAR2'
509              or $rawcolumn->COLTYPE === 'VARCHAR'
510              or $rawcolumn->COLTYPE === 'NVARCHAR2'
511              or $rawcolumn->COLTYPE === 'NVARCHAR'
512              or $rawcolumn->COLTYPE === 'CHAR'
513              or $rawcolumn->COLTYPE === 'NCHAR') {
514                 //TODO add some basic enum support here
515                 $info->type          = $rawcolumn->COLTYPE;
516                 $info->meta_type     = 'C';
517                 $info->max_length    = $rawcolumn->WIDTH;
518                 $info->scale         = null;
519                 $info->not_null      = ($rawcolumn->NULLS === 'NOT NULL');
520                 $info->has_default   = !is_null($rawcolumn->DEFAULTVAL);
521                 if ($info->has_default) {
523                     // this is hacky :-(
524                     if ($rawcolumn->DEFAULTVAL === 'NULL') {
525                         $info->default_value = null;
526                     } else if ($rawcolumn->DEFAULTVAL === "' ' ") { // Sometimes it's stored with trailing space
527                         $info->default_value = "";
528                     } else if ($rawcolumn->DEFAULTVAL === "' '") { // Sometimes it's stored without trailing space
529                         $info->default_value = "";
530                     } else {
531                         $info->default_value = trim($rawcolumn->DEFAULTVAL); // remove trailing space
532                         $info->default_value = substr($info->default_value, 1, strlen($info->default_value)-2); //trim ''
533                     }
534                 } else {
535                     $info->default_value = null;
536                 }
537                 $info->primary_key   = false;
538                 $info->binary        = false;
539                 $info->unsigned      = null;
540                 $info->auto_increment= false;
541                 $info->unique        = null;
543             } else if ($rawcolumn->COLTYPE === 'NUMBER') {
544                 $info->type       = $rawcolumn->COLTYPE;
545                 $info->max_length = $rawcolumn->PRECISION;
546                 $info->binary     = false;
547                 if (!is_null($rawcolumn->SCALE) && $rawcolumn->SCALE == 0) { // null in oracle scale allows decimals => not integer
548                     // integer
549                     if ($info->name === 'id') {
550                         $info->primary_key   = true;
551                         $info->meta_type     = 'R';
552                         $info->unique        = true;
553                         $info->auto_increment= true;
554                         $info->has_default   = false;
555                     } else {
556                         $info->primary_key   = false;
557                         $info->meta_type     = 'I';
558                         $info->unique        = null;
559                         $info->auto_increment= false;
560                     }
561                     $info->scale = null;
563                 } else {
564                     //float
565                     $info->meta_type     = 'N';
566                     $info->primary_key   = false;
567                     $info->unsigned      = null;
568                     $info->auto_increment= false;
569                     $info->unique        = null;
570                     $info->scale         = $rawcolumn->SCALE;
571                 }
572                 $info->not_null      = ($rawcolumn->NULLS === 'NOT NULL');
573                 $info->has_default   = !is_null($rawcolumn->DEFAULTVAL);
574                 if ($info->has_default) {
575                     $info->default_value = trim($rawcolumn->DEFAULTVAL); // remove trailing space
576                 } else {
577                     $info->default_value = null;
578                 }
580             } else if ($rawcolumn->COLTYPE === 'FLOAT') {
581                 $info->type       = $rawcolumn->COLTYPE;
582                 $info->max_length = (int)($rawcolumn->PRECISION * 3.32193);
583                 $info->primary_key   = false;
584                 $info->meta_type     = 'N';
585                 $info->unique        = null;
586                 $info->auto_increment= false;
587                 $info->not_null      = ($rawcolumn->NULLS === 'NOT NULL');
588                 $info->has_default   = !is_null($rawcolumn->DEFAULTVAL);
589                 if ($info->has_default) {
590                     $info->default_value = trim($rawcolumn->DEFAULTVAL); // remove trailing space
591                 } else {
592                     $info->default_value = null;
593                 }
595             } else if ($rawcolumn->COLTYPE === 'CLOB'
596                     or $rawcolumn->COLTYPE === 'NCLOB') {
597                 $info->type          = $rawcolumn->COLTYPE;
598                 $info->meta_type     = 'X';
599                 $info->max_length    = -1;
600                 $info->scale         = null;
601                 $info->scale         = null;
602                 $info->not_null      = ($rawcolumn->NULLS === 'NOT NULL');
603                 $info->has_default   = !is_null($rawcolumn->DEFAULTVAL);
604                 if ($info->has_default) {
605                     // this is hacky :-(
606                     if ($rawcolumn->DEFAULTVAL === 'NULL') {
607                         $info->default_value = null;
608                     } else if ($rawcolumn->DEFAULTVAL === "' ' ") { // Sometimes it's stored with trailing space
609                         $info->default_value = "";
610                     } else if ($rawcolumn->DEFAULTVAL === "' '") { // Other times it's stored without trailing space
611                         $info->default_value = "";
612                     } else {
613                         $info->default_value = trim($rawcolumn->DEFAULTVAL); // remove trailing space
614                         $info->default_value = substr($info->default_value, 1, strlen($info->default_value)-2); //trim ''
615                     }
616                 } else {
617                     $info->default_value = null;
618                 }
619                 $info->primary_key   = false;
620                 $info->binary        = false;
621                 $info->unsigned      = null;
622                 $info->auto_increment= false;
623                 $info->unique        = null;
625             } else if ($rawcolumn->COLTYPE === 'BLOB') {
626                 $info->type          = $rawcolumn->COLTYPE;
627                 $info->meta_type     = 'B';
628                 $info->max_length    = -1;
629                 $info->scale         = null;
630                 $info->scale         = null;
631                 $info->not_null      = ($rawcolumn->NULLS === 'NOT NULL');
632                 $info->has_default   = !is_null($rawcolumn->DEFAULTVAL);
633                 if ($info->has_default) {
634                     // this is hacky :-(
635                     if ($rawcolumn->DEFAULTVAL === 'NULL') {
636                         $info->default_value = null;
637                     } else if ($rawcolumn->DEFAULTVAL === "' ' ") { // Sometimes it's stored with trailing space
638                         $info->default_value = "";
639                     } else if ($rawcolumn->DEFAULTVAL === "' '") { // Sometimes it's stored without trailing space
640                         $info->default_value = "";
641                     } else {
642                         $info->default_value = trim($rawcolumn->DEFAULTVAL); // remove trailing space
643                         $info->default_value = substr($info->default_value, 1, strlen($info->default_value)-2); //trim ''
644                     }
645                 } else {
646                     $info->default_value = null;
647                 }
648                 $info->primary_key   = false;
649                 $info->binary        = true;
650                 $info->unsigned      = null;
651                 $info->auto_increment= false;
652                 $info->unique        = null;
654             } else {
655                 // unknown type - sorry
656                 $info->type          = $rawcolumn->COLTYPE;
657                 $info->meta_type     = '?';
658             }
660             $this->columns[$table][$info->name] = new database_column_info($info);
661         }
663         return $this->columns[$table];
664     }
666     /**
667      * Normalise values based in RDBMS dependencies (booleans, LOBs...)
668      *
669      * @param database_column_info $column column metadata corresponding with the value we are going to normalise
670      * @param mixed $value value we are going to normalise
671      * @return mixed the normalised value
672      */
673     protected function normalise_value($column, $value) {
674         if (is_bool($value)) { // Always, convert boolean to int
675             $value = (int)$value;
677         } else if ($column->meta_type == 'B') { // CLOB detected, we return 'blob' array instead of raw value to allow
678             if (!is_null($value)) {             // binding/executing code later to know about its nature
679                 $value = array('blob' => $value);
680             }
682         } else if ($column->meta_type == 'X' && strlen($value) > 4000) { // CLOB detected (>4000 optimisation), we return 'clob'
683             if (!is_null($value)) {                                      // array instead of raw value to allow binding/
684                 $value = array('clob' => (string)$value);                // executing code later to know about its nature
685             }
687         } else if ($value === '') {
688             if ($column->meta_type == 'I' or $column->meta_type == 'F' or $column->meta_type == 'N') {
689                 $value = 0; // prevent '' problems in numeric fields
690             }
691         }
692         return $value;
693     }
695     /**
696      * Transforms the sql and params in order to emulate the LIMIT clause available in other DBs
697      *
698      * @param string $sql the SQL select query to execute.
699      * @param array $params array of sql parameters
700      * @param int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
701      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
702      * @return array with the transformed sql and params updated
703      */
704     private function get_limit_sql($sql, array $params = null, $limitfrom=0, $limitnum=0) {
706         $limitfrom = (int)$limitfrom;
707         $limitnum  = (int)$limitnum;
708         $limitfrom = ($limitfrom < 0) ? 0 : $limitfrom;
709         $limitnum  = ($limitnum < 0)  ? 0 : $limitnum;
711         // TODO: Add the /*+ FIRST_ROWS */ hint if there isn't another hint
713         if ($limitfrom and $limitnum) {
714             $sql = "SELECT oracle_o.*
715                       FROM (SELECT oracle_i.*, rownum AS oracle_rownum
716                               FROM ($sql) oracle_i
717                              WHERE rownum <= :oracle_num_rows
718                             ) oracle_o
719                      WHERE oracle_rownum > :oracle_skip_rows";
720             $params['oracle_num_rows'] = $limitfrom + $limitnum;
721             $params['oracle_skip_rows'] = $limitfrom;
723         } else if ($limitfrom and !$limitnum) {
724             $sql = "SELECT oracle_o.*
725                       FROM (SELECT oracle_i.*, rownum AS oracle_rownum
726                               FROM ($sql) oracle_i
727                             ) oracle_o
728                      WHERE oracle_rownum > :oracle_skip_rows";
729             $params['oracle_skip_rows'] = $limitfrom;
731         } else if (!$limitfrom and $limitnum) {
732             $sql = "SELECT *
733                       FROM ($sql)
734                      WHERE rownum <= :oracle_num_rows";
735             $params['oracle_num_rows'] = $limitnum;
736         }
738         return array($sql, $params);
739     }
741     /**
742      * This function will handle all the column values before being inserted/updated to DB for Oracle
743      * installations. This is because the "special feature" of Oracle where the empty string is
744      * equal to NULL and this presents a problem with all our currently NOT NULL default '' fields.
745      * (and with empties handling in general)
746      *
747      * Note that this function is 100% private and should be used, exclusively by DML functions
748      * in this file. Also, this is considered a DIRTY HACK to be removed when possible.
749      *
750      * This function is private and must not be used outside this driver at all
751      *
752      * @param $table string the table where the record is going to be inserted/updated (without prefix)
753      * @param $field string the field where the record is going to be inserted/updated
754      * @param $value mixed the value to be inserted/updated
755      */
756     private function oracle_dirty_hack ($table, $field, $value) {
758         // Get metadata
759         $columns = $this->get_columns($table);
760         if (!isset($columns[$field])) {
761             return $value;
762         }
763         $column = $columns[$field];
765         // !! This paragraph explains behaviour before Moodle 2.0:
766         //
767         // For Oracle DB, empty strings are converted to NULLs in DB
768         // and this breaks a lot of NOT NULL columns currently Moodle. In the future it's
769         // planned to move some of them to NULL, if they must accept empty values and this
770         // piece of code will become less and less used. But, for now, we need it.
771         // What we are going to do is to examine all the data being inserted and if it's
772         // an empty string (NULL for Oracle) and the field is defined as NOT NULL, we'll modify
773         // such data in the best form possible ("0" for booleans and numbers and " " for the
774         // rest of strings. It isn't optimal, but the only way to do so.
775         // In the opposite, when retrieving records from Oracle, we'll decode " " back to
776         // empty strings to allow everything to work properly. DIRTY HACK.
778         // !! These paragraphs explain the rationale about the change for Moodle 2.0:
779         //
780         // Before Moodle 2.0, we only used to apply this DIRTY HACK to NOT NULL columns, as
781         // stated above, but it causes one problem in NULL columns where both empty strings
782         // and real NULLs are stored as NULLs, being impossible to differentiate them when
783         // being retrieved from DB.
784         //
785         // So, starting with Moodle 2.0, we are going to apply the DIRTY HACK to all the
786         // CHAR/CLOB columns no matter of their nullability. That way, when retrieving
787         // NULLABLE fields we'll get proper empties and NULLs differentiated, so we'll be able
788         // to rely in NULL/empty/content contents without problems, until now that wasn't
789         // possible at all.
790         //
791         // No breakage with old data is expected as long as at the time of writing this
792         // (20090922) all the current uses of both sql_empty() and sql_isempty() has been
793         // revised in 2.0 and all them were being performed against NOT NULL columns,
794         // where nothing has changed (the DIRTY HACK was already being applied).
795         //
796         // !! Conclusions:
797         //
798         // From Moodle 2.0 onwards, ALL empty strings in Oracle DBs will be stored as
799         // 1-whitespace char, ALL NULLs as NULLs and, obviously, content as content. And
800         // those 1-whitespace chars will be converted back to empty strings by all the
801         // get_field/record/set() functions transparently and any SQL needing direct handling
802         // of empties will need to use the sql_empty() and sql_isempty() helper functions.
803         // MDL-17491.
805         // If the field ins't VARCHAR or CLOB, skip
806         if ($column->meta_type != 'C' and $column->meta_type != 'X') {
807             return $value;
808         }
810         // If the value isn't empty, skip
811         if (!empty($value)) {
812             return $value;
813         }
815         // Now, we have one empty value, going to be inserted to one VARCHAR2 or CLOB field
816         // Try to get the best value to be inserted
818         // The '0' string doesn't need any transformation, skip
819         if ($value === '0') {
820             return $value;
821         }
823         // Transformations start
824         if (gettype($value) == 'boolean') {
825             return '0'; // Transform false to '0' that evaluates the same for PHP
827         } else if (gettype($value) == 'integer') {
828             return '0'; // Transform 0 to '0' that evaluates the same for PHP
830         } else if ($value === '') {
831             return ' '; // Transform '' to ' ' that DONT'T EVALUATE THE SAME
832                         // (we'll transform back again on get_records_XXX functions and others)!!
833         }
835         // Fail safe to original value
836         return $value;
837     }
839     /**
840      * Helper function to order by string length desc
841      *
842      * @param $a string first element to compare
843      * @param $b string second element to compare
844      * @return int < 0 $a goes first (is less), 0 $b goes first, 0 doesn't matter
845      */
846     private function compare_by_length_desc($a, $b) {
847         return strlen($b) - strlen($a);
848     }
850     /**
851      * Is db in unicode mode?
852      * @return bool
853      */
854     public function setup_is_unicodedb() {
855         $sql = "SELECT VALUE
856                   FROM NLS_DATABASE_PARAMETERS
857                  WHERE PARAMETER = 'NLS_CHARACTERSET'";
858         $this->query_start($sql, null, SQL_QUERY_AUX);
859         $stmt = $this->parse_query($sql);
860         $result = oci_execute($stmt, $this->commit_status);
861         $this->query_end($result, $stmt);
862         $records = null;
863         oci_fetch_all($stmt, $records, 0, -1, OCI_FETCHSTATEMENT_BY_COLUMN);
864         oci_free_statement($stmt);
866         return (isset($records['VALUE'][0]) and $records['VALUE'][0] === 'AL32UTF8');
867     }
869     /**
870      * Do NOT use in code, to be used by database_manager only!
871      * @param string $sql query
872      * @return bool true
873      * @throws dml_exception if error
874      */
875     public function change_database_structure($sql) {
876         $this->reset_caches();
878         $this->query_start($sql, null, SQL_QUERY_STRUCTURE);
879         $stmt = $this->parse_query($sql);
880         $result = oci_execute($stmt, $this->commit_status);
881         $this->query_end($result, $stmt);
882         oci_free_statement($stmt);
884         return true;
885     }
887     protected function bind_params($stmt, array $params=null, $tablename=null) {
888         $descriptors = array();
889         if ($params) {
890             $columns = array();
891             if ($tablename) {
892                 $columns = $this->get_columns($tablename);
893             }
894             foreach($params as $key => $value) {
895                 // Decouple column name and param name as far as sometimes they aren't the same
896                 if ($key == 'o_newfieldtoset') { // found case where column and key diverge, handle that
897                     $columnname   = key($value);    // columnname is the key of the array
898                     $params[$key] = $value[$columnname]; // set the proper value in the $params array and
899                     $value        = $value[$columnname]; // set the proper value in the $value variable
900                 } else {
901                     $columnname = preg_replace('/^o_/', '', $key); // Default columnname (for DB introspecting is key), but...
902                 }
903                 // Continue processing
904                 // Now, handle already detected LOBs
905                 if (is_array($value)) { // Let's go to bind special cases (lob descriptors)
906                     if (isset($value['clob'])) {
907                         $lob = oci_new_descriptor($this->oci, OCI_DTYPE_LOB);
908                         oci_bind_by_name($stmt, $key, $lob, -1, SQLT_CLOB);
909                         $lob->writeTemporary($this->oracle_dirty_hack($tablename, $columnname, $params[$key]['clob']), OCI_TEMP_CLOB);
910                         $descriptors[] = $lob;
911                         continue; // Column binding finished, go to next one
912                     } else if (isset($value['blob'])) {
913                         $lob = oci_new_descriptor($this->oci, OCI_DTYPE_LOB);
914                         oci_bind_by_name($stmt, $key, $lob, -1, SQLT_BLOB);
915                         $lob->writeTemporary($params[$key]['blob'], OCI_TEMP_BLOB);
916                         $descriptors[] = $lob;
917                         continue; // Column binding finished, go to next one
918                     }
919                 }
920                 // TODO: Put proper types and length is possible (enormous speedup)
921                 // Arrived here, continue with standard processing, using metadata if possible
922                 if (isset($columns[$columnname])) {
923                     $type = $columns[$columnname]->meta_type;
924                     $maxlength = $columns[$columnname]->max_length;
925                 } else {
926                     $type = '?';
927                     $maxlength = -1;
928                 }
929                 switch ($type) {
930                     case 'I':
931                     case 'R':
932                         // TODO: Optimise
933                         oci_bind_by_name($stmt, $key, $params[$key]);
934                         break;
936                     case 'N':
937                     case 'F':
938                         // TODO: Optimise
939                         oci_bind_by_name($stmt, $key, $params[$key]);
940                         break;
942                     case 'B':
943                         // TODO: Only arrive here if BLOB is null: Bind if so, else exception!
944                         // don't break here
946                     case 'X':
947                         // TODO: Only arrive here if CLOB is null or <= 4000 cc, else exception
948                         // don't break here
950                     default: // Bind as CHAR (applying dirty hack)
951                         // TODO: Optimise
952                         oci_bind_by_name($stmt, $key, $this->oracle_dirty_hack($tablename, $columnname, $params[$key]));
953                 }
954             }
955         }
956         return $descriptors;
957     }
959     protected function free_descriptors($descriptors) {
960         foreach ($descriptors as $descriptor) {
961             oci_free_descriptor($descriptor);
962         }
963     }
965     /**
966      * This function is used to convert all the Oracle 1-space defaults to the empty string
967      * like a really DIRTY HACK to allow it to work better until all those NOT NULL DEFAULT ''
968      * fields will be out from Moodle.
969      * @param string the string to be converted to '' (empty string) if it's ' ' (one space)
970      * @param mixed the key of the array in case we are using this function from array_walk,
971      *              defaults to null for other (direct) uses
972      * @return boolean always true (the converted variable is returned by reference)
973      */
974     public static function onespace2empty(&$item, $key=null) {
975         $item = ($item === ' ') ? '' : $item;
976         return true;
977     }
979     /**
980      * Execute general sql query. Should be used only when no other method suitable.
981      * Do NOT use this to make changes in db structure, use database_manager::execute_sql() instead!
982      * @param string $sql query
983      * @param array $params query parameters
984      * @return bool true
985      * @throws dml_exception if error
986      */
987     public function execute($sql, array $params=null) {
988         list($sql, $params, $type) = $this->fix_sql_params($sql, $params);
990         if (strpos($sql, ';') !== false) {
991             throw new coding_exception('moodle_database::execute() Multiple sql statements found or bound parameters not used properly in query!');
992         }
994         list($sql, $params) = $this->tweak_param_names($sql, $params);
995         $this->query_start($sql, $params, SQL_QUERY_UPDATE);
996         $stmt = $this->parse_query($sql);
997         $this->bind_params($stmt, $params);
998         $result = oci_execute($stmt, $this->commit_status);
999         $this->query_end($result, $stmt);
1000         oci_free_statement($stmt);
1002         return true;
1003     }
1005     /**
1006      * Get a single database record as an object using a SQL statement.
1007      *
1008      * The SQL statement should normally only return one record.
1009      * It is recommended to use get_records_sql() if more matches possible!
1010      *
1011      * @param string $sql The SQL string you wish to be executed, should normally only return one record.
1012      * @param array $params array of sql parameters
1013      * @param int $strictness IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found;
1014      *                        IGNORE_MULTIPLE means return first, ignore multiple records found(not recommended);
1015      *                        MUST_EXIST means throw exception if no record or multiple records found
1016      * @return mixed a fieldset object containing the first matching record, false or exception if error not found depending on mode
1017      * @throws dml_exception if error
1018      */
1019     public function get_record_sql($sql, array $params=null, $strictness=IGNORE_MISSING) {
1020         $strictness = (int)$strictness;
1021         if ($strictness == IGNORE_MULTIPLE) {
1022             // do not limit here - ORA does not like that
1023             $rs = $this->get_recordset_sql($sql, $params);
1024             $result = false;
1025             foreach ($rs as $rec) {
1026                 $result = $rec;
1027                 break;
1028             }
1029             $rs->close();
1030             return $result;
1031         }
1032         return parent::get_record_sql($sql, $params, $strictness);
1033     }
1035     /**
1036      * Get a number of records as a moodle_recordset using a SQL statement.
1037      *
1038      * Since this method is a little less readable, use of it should be restricted to
1039      * code where it's possible there might be large datasets being returned.  For known
1040      * small datasets use get_records_sql - it leads to simpler code.
1041      *
1042      * The return type is as for @see function get_recordset.
1043      *
1044      * @param string $sql the SQL select query to execute.
1045      * @param array $params array of sql parameters
1046      * @param int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
1047      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
1048      * @return moodle_recordset instance
1049      * @throws dml_exception if error
1050      */
1051     public function get_recordset_sql($sql, array $params=null, $limitfrom=0, $limitnum=0) {
1053         list($sql, $params, $type) = $this->fix_sql_params($sql, $params);
1055         list($rawsql, $params) = $this->get_limit_sql($sql, $params, $limitfrom, $limitnum);
1057         list($rawsql, $params) = $this->tweak_param_names($rawsql, $params);
1058         $this->query_start($rawsql, $params, SQL_QUERY_SELECT);
1059         $stmt = $this->parse_query($rawsql);
1060         $this->bind_params($stmt, $params);
1061         $result = oci_execute($stmt, $this->commit_status);
1062         $this->query_end($result, $stmt);
1064         return $this->create_recordset($stmt);
1065     }
1067     protected function create_recordset($stmt) {
1068         return new oci_native_moodle_recordset($stmt);
1069     }
1071     /**
1072      * Get a number of records as an array of objects using a SQL statement.
1073      *
1074      * Return value as for @see function get_records.
1075      *
1076      * @param string $sql the SQL select query to execute. The first column of this SELECT statement
1077      *   must be a unique value (usually the 'id' field), as it will be used as the key of the
1078      *   returned array.
1079      * @param array $params array of sql parameters
1080      * @param int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
1081      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
1082      * @return array of objects, or empty array if no records were found
1083      * @throws dml_exception if error
1084      */
1085     public function get_records_sql($sql, array $params=null, $limitfrom=0, $limitnum=0) {
1087         list($sql, $params, $type) = $this->fix_sql_params($sql, $params);
1089         list($rawsql, $params) = $this->get_limit_sql($sql, $params, $limitfrom, $limitnum);
1091         list($rawsql, $params) = $this->tweak_param_names($rawsql, $params);
1092         $this->query_start($rawsql, $params, SQL_QUERY_SELECT);
1093         $stmt = $this->parse_query($rawsql);
1094         $this->bind_params($stmt, $params);
1095         $result = oci_execute($stmt, $this->commit_status);
1096         $this->query_end($result, $stmt);
1098         $records = null;
1099         oci_fetch_all($stmt, $records, 0, -1, OCI_FETCHSTATEMENT_BY_ROW);
1100         oci_free_statement($stmt);
1102         $return = array();
1104         foreach ($records as $row) {
1105             $row = array_change_key_case($row, CASE_LOWER);
1106             unset($row['oracle_rownum']);
1107             array_walk($row, array('oci_native_moodle_database', 'onespace2empty'));
1108             $id = reset($row);
1109             if (isset($return[$id])) {
1110                 $colname = key($row);
1111                 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);
1112             }
1113             $return[$id] = (object)$row;
1114         }
1116         return $return;
1117     }
1119     /**
1120      * Selects records and return values (first field) as an array using a SQL statement.
1121      *
1122      * @param string $sql The SQL query
1123      * @param array $params array of sql parameters
1124      * @return array of values
1125      * @throws dml_exception if error
1126      */
1127     public function get_fieldset_sql($sql, array $params=null) {
1128         list($sql, $params, $type) = $this->fix_sql_params($sql, $params);
1130         list($sql, $params) = $this->tweak_param_names($sql, $params);
1131         $this->query_start($sql, $params, SQL_QUERY_SELECT);
1132         $stmt = $this->parse_query($sql);
1133         $this->bind_params($stmt, $params);
1134         $result = oci_execute($stmt, $this->commit_status);
1135         $this->query_end($result, $stmt);
1137         $records = null;
1138         oci_fetch_all($stmt, $records, 0, -1, OCI_FETCHSTATEMENT_BY_COLUMN);
1139         oci_free_statement($stmt);
1141         $return = reset($records);
1142         array_walk($return, array('oci_native_moodle_database', 'onespace2empty'));
1144         return $return;
1145     }
1147     /**
1148      * Insert new record into database, as fast as possible, no safety checks, lobs not supported.
1149      * @param string $table name
1150      * @param mixed $params data record as object or array
1151      * @param bool $returnit return it of inserted record
1152      * @param bool $bulk true means repeated inserts expected
1153      * @param bool $customsequence true if 'id' included in $params, disables $returnid
1154      * @return bool|int true or new id
1155      * @throws dml_exception if error
1156      */
1157     public function insert_record_raw($table, $params, $returnid=true, $bulk=false, $customsequence=false) {
1158         if (!is_array($params)) {
1159             $params = (array)$params;
1160         }
1162         $returning = "";
1164         if ($customsequence) {
1165             if (!isset($params['id'])) {
1166                 throw new coding_exception('moodle_database::insert_record_raw() id field must be specified if custom sequences used.');
1167             }
1168             $returnid = false;
1169         } else {
1170             unset($params['id']);
1171             if ($returnid) {
1172                 $returning = " RETURNING id INTO :oracle_id"; // crazy name nobody is ever going to use or parameter ;-)
1173             }
1174         }
1176         if (empty($params)) {
1177             throw new coding_exception('moodle_database::insert_record_raw() no fields found.');
1178         }
1180         $fields = implode(',', array_keys($params));
1181         $values = array();
1182         foreach ($params as $pname => $value) {
1183             $values[] = ":$pname";
1184         }
1185         $values = implode(',', $values);
1187         $sql = "INSERT INTO {" . $table . "} ($fields) VALUES ($values)";
1188         list($sql, $params, $type) = $this->fix_sql_params($sql, $params);
1189         $sql .= $returning;
1191         $id = null;
1193         // note we don't need tweak_param_names() here. Placeholders are safe column names. MDL-28080
1194         // list($sql, $params) = $this->tweak_param_names($sql, $params);
1195         $this->query_start($sql, $params, SQL_QUERY_INSERT);
1196         $stmt = $this->parse_query($sql);
1197         $descriptors = $this->bind_params($stmt, $params, $table);
1198         if ($returning) {
1199             oci_bind_by_name($stmt, ":oracle_id", $id, 10, SQLT_INT);
1200         }
1201         $result = oci_execute($stmt, $this->commit_status);
1202         $this->free_descriptors($descriptors);
1203         $this->query_end($result, $stmt);
1204         oci_free_statement($stmt);
1206         if (!$returnid) {
1207             return true;
1208         }
1210         if (!$returning) {
1211             die('TODO - implement oracle 9.2 insert support'); //TODO
1212         }
1214         return (int)$id;
1215     }
1217     /**
1218      * Insert a record into a table and return the "id" field if required.
1219      *
1220      * Some conversions and safety checks are carried out. Lobs are supported.
1221      * If the return ID isn't required, then this just reports success as true/false.
1222      * $data is an object containing needed data
1223      * @param string $table The database table to be inserted into
1224      * @param object $data A data object with values for one or more fields in the record
1225      * @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.
1226      * @return bool|int true or new id
1227      * @throws dml_exception if error
1228      */
1229     public function insert_record($table, $dataobject, $returnid=true, $bulk=false) {
1230         $dataobject = (array)$dataobject;
1232         $columns = $this->get_columns($table);
1233         $cleaned = array();
1235         foreach ($dataobject as $field=>$value) {
1236             if ($field === 'id') {
1237                 continue;
1238             }
1239             if (!isset($columns[$field])) { // Non-existing table field, skip it
1240                 continue;
1241             }
1242             $column = $columns[$field];
1243             $cleaned[$field] = $this->normalise_value($column, $value);
1244         }
1246         return $this->insert_record_raw($table, $cleaned, $returnid, $bulk);
1247     }
1249     /**
1250      * Import a record into a table, id field is required.
1251      * Safety checks are NOT carried out. Lobs are supported.
1252      *
1253      * @param string $table name of database table to be inserted into
1254      * @param object $dataobject A data object with values for one or more fields in the record
1255      * @return bool true
1256      * @throws dml_exception if error
1257      */
1258     public function import_record($table, $dataobject) {
1259         $dataobject = (array)$dataobject;
1261         $columns = $this->get_columns($table);
1262         $cleaned = array();
1264         foreach ($dataobject as $field=>$value) {
1265             if (!isset($columns[$field])) {
1266                 continue;
1267             }
1268             $column = $columns[$field];
1269             $cleaned[$field] = $this->normalise_value($column, $value);
1270         }
1272         return $this->insert_record_raw($table, $cleaned, false, true, true);
1273     }
1275     /**
1276      * Update record in database, as fast as possible, no safety checks, lobs not supported.
1277      * @param string $table name
1278      * @param mixed $params data record as object or array
1279      * @param bool true means repeated updates expected
1280      * @return bool true
1281      * @throws dml_exception if error
1282      */
1283     public function update_record_raw($table, $params, $bulk=false) {
1284         $params = (array)$params;
1286         if (!isset($params['id'])) {
1287             throw new coding_exception('moodle_database::update_record_raw() id field must be specified.');
1288         }
1290         if (empty($params)) {
1291             throw new coding_exception('moodle_database::update_record_raw() no fields found.');
1292         }
1294         $sets = array();
1295         foreach ($params as $field=>$value) {
1296             if ($field == 'id') {
1297                 continue;
1298             }
1299             $sets[] = "$field = :$field";
1300         }
1302         $sets = implode(',', $sets);
1303         $sql = "UPDATE {" . $table . "} SET $sets WHERE id=:id";
1304         list($sql, $params, $type) = $this->fix_sql_params($sql, $params);
1306         // note we don't need tweak_param_names() here. Placeholders are safe column names. MDL-28080
1307         // list($sql, $params) = $this->tweak_param_names($sql, $params);
1308         $this->query_start($sql, $params, SQL_QUERY_UPDATE);
1309         $stmt = $this->parse_query($sql);
1310         $descriptors = $this->bind_params($stmt, $params, $table);
1311         $result = oci_execute($stmt, $this->commit_status);
1312         $this->free_descriptors($descriptors);
1313         $this->query_end($result, $stmt);
1314         oci_free_statement($stmt);
1316         return true;
1317     }
1319     /**
1320      * Update a record in a table
1321      *
1322      * $dataobject is an object containing needed data
1323      * Relies on $dataobject having a variable "id" to
1324      * specify the record to update
1325      *
1326      * @param string $table The database table to be checked against.
1327      * @param object $dataobject An object with contents equal to fieldname=>fieldvalue. Must have an entry for 'id' to map to the table specified.
1328      * @param bool true means repeated updates expected
1329      * @return bool true
1330      * @throws dml_exception if error
1331      */
1332     public function update_record($table, $dataobject, $bulk=false) {
1333         $dataobject = (array)$dataobject;
1335         $columns = $this->get_columns($table);
1336         $cleaned = array();
1338         foreach ($dataobject as $field=>$value) {
1339             if (!isset($columns[$field])) {
1340                 continue;
1341             }
1342             $column = $columns[$field];
1343             $cleaned[$field] = $this->normalise_value($column, $value);
1344         }
1346         $this->update_record_raw($table, $cleaned, $bulk);
1348         return true;
1349     }
1351     /**
1352      * Set a single field in every table record which match a particular WHERE clause.
1353      *
1354      * @param string $table The database table to be checked against.
1355      * @param string $newfield the field to set.
1356      * @param string $newvalue the value to set the field to.
1357      * @param string $select A fragment of SQL to be used in a where clause in the SQL call.
1358      * @param array $params array of sql parameters
1359      * @return bool true
1360      * @throws dml_exception if error
1361      */
1362     public function set_field_select($table, $newfield, $newvalue, $select, array $params=null) {
1364         if ($select) {
1365             $select = "WHERE $select";
1366         }
1367         if (is_null($params)) {
1368             $params = array();
1369         }
1371         // Get column metadata
1372         $columns = $this->get_columns($table);
1373         $column = $columns[$newfield];
1375         $newvalue = $this->normalise_value($column, $newvalue);
1377         list($select, $params, $type) = $this->fix_sql_params($select, $params);
1379         if (is_bool($newvalue)) {
1380             $newvalue = (int)$newvalue; // prevent "false" problems
1381         }
1382         if (is_null($newvalue)) {
1383             $newsql = "$newfield = NULL";
1384         } else {
1385             // Set the param to array ($newfield => $newvalue) and key to 'newfieldtoset'
1386             // name in the build sql. Later, bind_params() will detect the value array and
1387             // perform the needed modifications to allow the query to work. Note that
1388             // 'newfieldtoset' is one arbitrary name that hopefully won't be used ever
1389             // in order to avoid problems where the same field is used both in the set clause and in
1390             // the conditions. This was breaking badly in drivers using NAMED params like oci.
1391             $params['newfieldtoset'] = array($newfield => $newvalue);
1392             $newsql = "$newfield = :newfieldtoset";
1393         }
1394         $sql = "UPDATE {" . $table . "} SET $newsql $select";
1395         list($sql, $params, $type) = $this->fix_sql_params($sql, $params);
1397         list($sql, $params) = $this->tweak_param_names($sql, $params);
1398         $this->query_start($sql, $params, SQL_QUERY_UPDATE);
1399         $stmt = $this->parse_query($sql);
1400         $descriptors = $this->bind_params($stmt, $params, $table);
1401         $result = oci_execute($stmt, $this->commit_status);
1402         $this->free_descriptors($descriptors);
1403         $this->query_end($result, $stmt);
1404         oci_free_statement($stmt);
1406         return true;
1407     }
1409     /**
1410      * Delete one or more records from a table which match a particular WHERE clause.
1411      *
1412      * @param string $table The database table to be checked against.
1413      * @param string $select A fragment of SQL to be used in a where clause in the SQL call (used to define the selection criteria).
1414      * @param array $params array of sql parameters
1415      * @return bool true
1416      * @throws dml_exception if error
1417      */
1418     public function delete_records_select($table, $select, array $params=null) {
1420         if ($select) {
1421             $select = "WHERE $select";
1422         }
1424         $sql = "DELETE FROM {" . $table . "} $select";
1426         list($sql, $params, $type) = $this->fix_sql_params($sql, $params);
1428         list($sql, $params) = $this->tweak_param_names($sql, $params);
1429         $this->query_start($sql, $params, SQL_QUERY_UPDATE);
1430         $stmt = $this->parse_query($sql);
1431         $this->bind_params($stmt, $params);
1432         $result = oci_execute($stmt, $this->commit_status);
1433         $this->query_end($result, $stmt);
1434         oci_free_statement($stmt);
1436         return true;
1437     }
1439     function sql_null_from_clause() {
1440         return ' FROM dual';
1441     }
1443 // Bitwise operations
1444    protected function bitwise_supported() {
1445         if (isset($this->bitwise_supported)) { // Use cached value if available
1446             return $this->bitwise_supported;
1447         }
1448         $sql = "SELECT 1
1449                 FROM user_objects
1450                 WHERE object_type = 'PACKAGE BODY'
1451                   AND object_name = 'MOODLE_BITS'
1452                   AND status = 'VALID'";
1453         $this->query_start($sql, null, SQL_QUERY_AUX);
1454         $stmt = $this->parse_query($sql);
1455         $result = oci_execute($stmt, $this->commit_status);
1456         $this->query_end($result, $stmt);
1457         $records = null;
1458         oci_fetch_all($stmt, $records, 0, -1, OCI_FETCHSTATEMENT_BY_ROW);
1459         oci_free_statement($stmt);
1460         $this->bitwise_supported = isset($records[0]) && reset($records[0]) ? true : false;
1461         return $this->bitwise_supported;
1462     }
1464     public function sql_bitand($int1, $int2) {
1465         return 'bitand((' . $int1 . '), (' . $int2 . '))';
1466     }
1468     public function sql_bitnot($int1) {
1469         return '((0 - (' . $int1 . ')) - 1)';
1470     }
1472     public function sql_bitor($int1, $int2) {
1473         // Use the MOODLE_BITS package if available
1474         if ($this->bitwise_supported()) {
1475             return 'MOODLE_BITS.BITOR(' . $int1 . ', ' . $int2 . ')';
1476         }
1477         // fallback to PHP bool operations, can break if using placeholders
1478         return '((' . $int1 . ') + (' . $int2 . ') - ' . $this->sql_bitand($int1, $int2) . ')';
1479     }
1481     public function sql_bitxor($int1, $int2) {
1482         // Use the MOODLE_BITS package if available
1483         if ($this->bitwise_supported()) {
1484             return 'MOODLE_BITS.BITXOR(' . $int1 . ', ' . $int2 . ')';
1485         }
1486         // fallback to PHP bool operations, can break if using placeholders
1487         return '(' . $this->sql_bitor($int1, $int2) . ' - ' . $this->sql_bitand($int1, $int2) . ')';
1488     }
1490     /**
1491      * Returns the SQL text to be used in order to perform module '%'
1492      * operation - remainder after division
1493      *
1494      * @param integer int1 first integer in the operation
1495      * @param integer int2 second integer in the operation
1496      * @return string the piece of SQL code to be used in your statement.
1497      */
1498     public function sql_modulo($int1, $int2) {
1499         return 'MOD(' . $int1 . ', ' . $int2 . ')';
1500     }
1502     public function sql_cast_char2int($fieldname, $text=false) {
1503         if (!$text) {
1504             return ' CAST(' . $fieldname . ' AS INT) ';
1505         } else {
1506             return ' CAST(' . $this->sql_compare_text($fieldname) . ' AS INT) ';
1507         }
1508     }
1510     public function sql_cast_char2real($fieldname, $text=false) {
1511         if (!$text) {
1512             return ' CAST(' . $fieldname . ' AS FLOAT) ';
1513         } else {
1514             return ' CAST(' . $this->sql_compare_text($fieldname) . ' AS FLOAT) ';
1515         }
1516     }
1518     /**
1519      * Returns 'LIKE' part of a query.
1520      *
1521      * @param string $fieldname usually name of the table column
1522      * @param string $param usually bound query parameter (?, :named)
1523      * @param bool $casesensitive use case sensitive search
1524      * @param bool $accensensitive use accent sensitive search (not all databases support accent insensitive)
1525      * @param bool $notlike true means "NOT LIKE"
1526      * @param string $escapechar escape char for '%' and '_'
1527      * @return string SQL code fragment
1528      */
1529     public function sql_like($fieldname, $param, $casesensitive = true, $accentsensitive = true, $notlike = false, $escapechar = '\\') {
1530         if (strpos($param, '%') !== false) {
1531             debugging('Potential SQL injection detected, sql_ilike() expects bound parameters (? or :named)');
1532         }
1534         $LIKE = $notlike ? 'NOT LIKE' : 'LIKE';
1536         // no accent sensitiveness here for now, sorry
1538         if ($casesensitive) {
1539             return "$fieldname $LIKE $param ESCAPE '$escapechar'";
1540         } else {
1541             return "LOWER($fieldname) $LIKE LOWER($param) ESCAPE '$escapechar'";
1542         }
1543     }
1545     // NOTE: Oracle concat implementation isn't ANSI compliant when using NULLs (the result of
1546     // any concatenation with NULL must return NULL) because of his inability to differentiate
1547     // NULLs and empty strings. So this function will cause some tests to fail. Hopefully
1548     // it's only a side case and it won't affect normal concatenation operations in Moodle.
1549     public function sql_concat() {
1550         $arr = func_get_args();
1551         $s = implode(' || ', $arr);
1552         if ($s === '') {
1553             return " '' ";
1554         }
1555         return " $s ";
1556     }
1558     public function sql_concat_join($separator="' '", $elements=array()) {
1559         for ($n=count($elements)-1; $n > 0 ; $n--) {
1560             array_splice($elements, $n, 0, $separator);
1561         }
1562         $s = implode(' || ', $elements);
1563         if ($s === '') {
1564             return " '' ";
1565         }
1566         return " $s ";
1567     }
1569     /**
1570      * Returns the SQL for returning searching one string for the location of another.
1571      */
1572     public function sql_position($needle, $haystack) {
1573         return "INSTR(($haystack), ($needle))";
1574     }
1576     public function sql_isempty($tablename, $fieldname, $nullablefield, $textfield) {
1577         if ($textfield) {
1578             return " (".$this->sql_compare_text($fieldname)." = '".$this->sql_empty()."') ";
1579         } else {
1580             return " ($fieldname = '".$this->sql_empty()."') ";
1581         }
1582     }
1584     public function sql_empty() {
1585         return ' ';
1586     }
1588     public function sql_order_by_text($fieldname, $numchars=32) {
1589         return 'dbms_lob.substr(' . $fieldname . ', ' . $numchars . ',1)';
1590     }
1592 /// session locking
1593     public function session_lock_supported() {
1594         if (isset($this->dblocks_supported)) { // Use cached value if available
1595             return $this->dblocks_supported;
1596         }
1597         $sql = "SELECT 1
1598                 FROM user_objects
1599                 WHERE object_type = 'PACKAGE BODY'
1600                   AND object_name = 'MOODLE_LOCKS'
1601                   AND status = 'VALID'";
1602         $this->query_start($sql, null, SQL_QUERY_AUX);
1603         $stmt = $this->parse_query($sql);
1604         $result = oci_execute($stmt, $this->commit_status);
1605         $this->query_end($result, $stmt);
1606         $records = null;
1607         oci_fetch_all($stmt, $records, 0, -1, OCI_FETCHSTATEMENT_BY_ROW);
1608         oci_free_statement($stmt);
1609         $this->dblocks_supported = isset($records[0]) && reset($records[0]) ? true : false;
1610         return $this->dblocks_supported;
1611     }
1613     public function get_session_lock($rowid) {
1614         if (!$this->session_lock_supported()) {
1615             return;
1616         }
1617         parent::get_session_lock($rowid);
1619         $fullname = $this->dbname.'-'.$this->prefix.'-session-'.$rowid;
1620         $sql = 'SELECT MOODLE_LOCKS.GET_LOCK(:lockname, :locktimeout) FROM DUAL';
1621         $params = array('lockname' => $fullname , 'locktimeout' => 120);
1622         $this->query_start($sql, $params, SQL_QUERY_AUX);
1623         $stmt = $this->parse_query($sql);
1624         $this->bind_params($stmt, $params);
1625         $result = oci_execute($stmt, $this->commit_status);
1626         $this->query_end($result, $stmt);
1627         oci_free_statement($stmt);
1628     }
1630     public function release_session_lock($rowid) {
1631         if (!$this->session_lock_supported()) {
1632             return;
1633         }
1634         parent::release_session_lock($rowid);
1636         $fullname = $this->dbname.'-'.$this->prefix.'-session-'.$rowid;
1637         $params = array('lockname' => $fullname);
1638         $sql = 'SELECT MOODLE_LOCKS.RELEASE_LOCK(:lockname) FROM DUAL';
1639         $this->query_start($sql, $params, SQL_QUERY_AUX);
1640         $stmt = $this->parse_query($sql);
1641         $this->bind_params($stmt, $params);
1642         $result = oci_execute($stmt, $this->commit_status);
1643         $this->query_end($result, $stmt);
1644         oci_free_statement($stmt);
1645     }
1647 /// transactions
1648     /**
1649      * Driver specific start of real database transaction,
1650      * this can not be used directly in code.
1651      * @return void
1652      */
1653     protected function begin_transaction() {
1654         $this->commit_status = OCI_DEFAULT; //Done! ;-)
1655     }
1657     /**
1658      * Driver specific commit of real database transaction,
1659      * this can not be used directly in code.
1660      * @return void
1661      */
1662     protected function commit_transaction() {
1663         $this->query_start('--oracle_commit', NULL, SQL_QUERY_AUX);
1664         $result = oci_commit($this->oci);
1665         $this->commit_status = OCI_COMMIT_ON_SUCCESS;
1666         $this->query_end($result);
1667     }
1669     /**
1670      * Driver specific abort of real database transaction,
1671      * this can not be used directly in code.
1672      * @return void
1673      */
1674     protected function rollback_transaction() {
1675         $this->query_start('--oracle_rollback', NULL, SQL_QUERY_AUX);
1676         $result = oci_rollback($this->oci);
1677         $this->commit_status = OCI_COMMIT_ON_SUCCESS;
1678         $this->query_end($result);
1679     }