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