3be81389e17c1a4ecb6cacd92122c1d26fc67d04
[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    moodlecore
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 require_once($CFG->libdir.'/dml/moodle_database.php');
29 require_once($CFG->libdir.'/dml/oci_native_moodle_recordset.php');
30 require_once($CFG->libdir.'/dml/oci_native_moodle_temptables.php');
32 /**
33  * Native oci class representing moodle database interface.
34  *
35  * One complete reference for PHP + OCI:
36  * http://www.oracle.com/technology/tech/php/underground-php-oracle-manual.html
37  */
38 class oci_native_moodle_database extends moodle_database {
40     protected $oci     = null;
42     private $last_stmt_error = null; // To store stmt errors and enable get_last_error() to detect them
43     private $commit_status = null;   // default value initialised in connect method, we need the driver to be present
45     private $last_error_reporting; // To handle oci driver default verbosity
46     private $unique_session_id; // To store unique_session_id. Needed for temp tables unique naming
48     private $dblocks_supported = null; // To cache locks support along the connection life
51     /**
52      * Detects if all needed PHP stuff installed.
53      * Note: can be used before connect()
54      * @return mixed true if ok, string if something
55      */
56     public function driver_installed() {
57         if (!extension_loaded('oci8')) {
58             return get_string('ociextensionisnotpresentinphp', 'install');
59         }
60         return true;
61     }
63     /**
64      * Returns database family type - describes SQL dialect
65      * Note: can be used before connect()
66      * @return string db family name (mysql, postgres, mssql, oracle, etc.)
67      */
68     public function get_dbfamily() {
69         return 'oracle';
70     }
72     /**
73      * Returns more specific database driver type
74      * Note: can be used before connect()
75      * @return string db type mysql, oci, postgres7
76      */
77     protected function get_dbtype() {
78         return 'oci';
79     }
81     /**
82      * Returns general database library name
83      * Note: can be used before connect()
84      * @return string db type pdo, native
85      */
86     protected function get_dblibrary() {
87         return 'native';
88     }
90     /**
91      * Returns localised database type name
92      * Note: can be used before connect()
93      * @return string
94      */
95     public function get_name() {
96         return get_string('nativeoci', 'install'); // TODO: localise
97     }
99     /**
100      * Returns localised database configuration help.
101      * Note: can be used before connect()
102      * @return string
103      */
104     public function get_configuration_help() {
105         return get_string('nativeocihelp', 'install');
106     }
108     /**
109      * Returns localised database description
110      * Note: can be used before connect()
111      * @return string
112      */
113     public function get_configuration_hints() {
114         return get_string('databasesettingssub_oci', 'install'); // TODO: l
115     }
117     /**
118      * Connect to db
119      * Must be called before other methods.
120      * @param string $dbhost
121      * @param string $dbuser
122      * @param string $dbpass
123      * @param string $dbname
124      * @param mixed $prefix string means moodle db prefix, false used for external databases where prefix not used
125      * @param array $dboptions driver specific options
126      * @return bool true
127      * @throws dml_connection_exception if error
128      */
129     public function connect($dbhost, $dbuser, $dbpass, $dbname, $prefix, array $dboptions=null) {
130         if ($prefix == '' and !$this->external) {
131             //Enforce prefixes for everybody but mysql
132             throw new dml_exception('prefixcannotbeempty', $this->get_dbfamily());
133         }
134         if (!$this->external and strlen($prefix) > 2) {
135             //Max prefix length for Oracle is 2cc
136             $a = (object)array('dbfamily'=>'oracle', 'maxlength'=>2);
137             throw new dml_exception('prefixtoolong', $a);
138         }
140         $driverstatus = $this->driver_installed();
142         if ($driverstatus !== true) {
143             throw new dml_exception('dbdriverproblem', $driverstatus);
144         }
146         // Autocommit ON by default.
147         // Switching to OFF (OCI_DEFAULT), when playing with transactions
148         // please note this thing is not defined if oracle driver not present in PHP
149         // which means it can not be used as default value of object property!
150         $this->commit_status = OCI_COMMIT_ON_SUCCESS;
152         $this->store_settings($dbhost, $dbuser, $dbpass, $dbname, $prefix, $dboptions);
153         unset($this->dboptions['dbsocket']);
155         $pass = addcslashes($this->dbpass, "'\\");
157         if (empty($this->dbhost)) {
158             // old style full address (TNS)
159             $dbstring = $this->dbname;
160         } else {
161             if (empty($this->dboptions['dbport'])) {
162                 $this->dboptions['dbport'] = 1521;
163             }
164             $dbstring = '//'.$this->dbhost.':'.$this->dboptions['dbport'].'/'.$this->dbname;
165         }
167         ob_start();
168         if (empty($this->dboptions['dbpersist'])) {
169             $this->oci = oci_new_connect($this->dbuser, $this->dbpass, $dbstring, 'AL32UTF8');
170         } else {
171             $this->oci = oci_pconnect($this->dbuser, $this->dbpass, $dbstring, 'AL32UTF8');
172         }
173         $dberr = ob_get_contents();
174         ob_end_clean();
177         if ($this->oci === false) {
178             $this->oci = null;
179             $e = oci_error();
180             if (isset($e['message'])) {
181                 $dberr = $e['message'];
182             }
183             throw new dml_connection_exception($dberr);
184         }
186         // get unique session id, to be used later for temp tables stuff
187         $sql = 'SELECT DBMS_SESSION.UNIQUE_SESSION_ID() FROM DUAL';
188         $this->query_start($sql, null, SQL_QUERY_AUX);
189         $stmt = $this->parse_query($sql);
190         $result = oci_execute($stmt, $this->commit_status);
191         $this->query_end($result, $stmt);
192         $records = null;
193         oci_fetch_all($stmt, $records, 0, -1, OCI_FETCHSTATEMENT_BY_ROW);
194         oci_free_statement($stmt);
195         $this->unique_session_id = reset($records[0]);
197         //note: do not send "ALTER SESSION SET NLS_NUMERIC_CHARACTERS='.,'" !
198         //      instead fix our PHP code to convert "," to "." properly!
200         // Connection stabilished and configured, going to instantiate the temptables controller
201         $this->temptables = new oci_native_moodle_temptables($this, $this->unique_session_id);
203         return true;
204     }
206     /**
207      * Close database connection and release all resources
208      * and memory (especially circular memory references).
209      * Do NOT use connect() again, create a new instance if needed.
210      */
211     public function dispose() {
212         parent::dispose(); // Call parent dispose to write/close session and other common stuff before clossing conn
213         if ($this->oci) {
214             oci_close($this->oci);
215             $this->oci = null;
216         }
217     }
220     /**
221      * Called before each db query.
222      * @param string $sql
223      * @param array array of parameters
224      * @param int $type type of query
225      * @param mixed $extrainfo driver specific extra information
226      * @return void
227      */
228     protected function query_start($sql, array $params=null, $type, $extrainfo=null) {
229         parent::query_start($sql, $params, $type, $extrainfo);
230         // oci driver tents to send debug to output, we do not need that ;-)
231         $this->last_error_reporting = error_reporting(0);
232     }
234     /**
235      * Called immediately after each db query.
236      * @param mixed db specific result
237      * @return void
238      */
239     protected function query_end($result, $stmt=null) {
240         // reset original debug level
241         error_reporting($this->last_error_reporting);
242         if ($stmt and $result === false) {
243             // Look for stmt error and store it
244             if (is_resource($stmt)) {
245                 $e = oci_error($stmt);
246                 if ($e !== false) {
247                     $this->last_stmt_error = $e['message'];
248                 }
249             }
250             oci_free_statement($stmt);
251         }
252         parent::query_end($result);
253     }
255     /**
256      * Returns database server info array
257      * @return array
258      */
259     public function get_server_info() {
260         static $info = null; // TODO: move to real object property
262         if (is_null($info)) {
263             $this->query_start("--oci_server_version()", null, SQL_QUERY_AUX);
264             $description = oci_server_version($this->oci);
265             $this->query_end(true);
266             preg_match('/(\d+\.)+\d+/', $description, $matches);
267             $info = array('description'=>$description, 'version'=>$matches[0]);
268         }
270         return $info;
271     }
273     protected function is_min_version($version) {
274         $server = $this->get_server_info();
275         $server = $server['version'];
276         return version_compare($server, $version, '>=');
277     }
279     /**
280      * Converts short table name {tablename} to real table name
281      * supporting temp tables ($this->unique_session_id based) if detected
282      *
283      * @param string sql
284      * @return string sql
285      */
286     protected function fix_table_names($sql) {
287         if (preg_match_all('/\{([a-z][a-z0-9_]*)\}/', $sql, $matches)) {
288             foreach($matches[0] as $key=>$match) {
289                 $name = $matches[1][$key];
290                 if ($this->temptables->is_temptable($name)) {
291                     $sql = str_replace($match, $this->temptables->get_correct_name($name), $sql);
292                 } else {
293                     $sql = str_replace($match, $this->prefix.$name, $sql);
294                 }
295             }
296         }
297         return $sql;
298     }
300     /**
301      * Returns supported query parameter types
302      * @return bitmask
303      */
304     protected function allowed_param_types() {
305         return SQL_PARAMS_NAMED;
306     }
308     /**
309      * Returns last error reported by database engine.
310      */
311     public function get_last_error() {
312         $error = false;
313         // First look for any previously saved stmt error
314         if (!empty($this->last_stmt_error)) {
315             $error = $this->last_stmt_error;
316             $this->last_stmt_error = null;
317         } else { // Now try connection error
318             $e = oci_error($this->oci);
319             if ($e !== false) {
320                 $error = $e['message'];
321             }
322         }
323         return $error;
324     }
326     protected function parse_query($sql) {
327         $stmt = oci_parse($this->oci, $sql);
328         if ($stmt == false) {
329             throw new dml_connection_exception('Can not parse sql query'); //TODO: maybe add better info
330         }
331         return $stmt;
332     }
334     /**
335      * Return tables in database WITHOUT current prefix
336      * @return array of table names in lowercase and without prefix
337      */
338     public function get_tables($usecache=true) {
339         if ($usecache and $this->tables !== null) {
340             return $this->tables;
341         }
342         $this->tables = array();
343         $prefix = str_replace('_', "\\_", strtoupper($this->prefix));
344         $sql = "SELECT TABLE_NAME
345                   FROM CAT
346                  WHERE TABLE_TYPE='TABLE'
347                        AND TABLE_NAME NOT LIKE 'BIN\$%'
348                        AND TABLE_NAME LIKE '$prefix%' ESCAPE '\\'";
349         $this->query_start($sql, null, SQL_QUERY_AUX);
350         $stmt = $this->parse_query($sql);
351         $result = oci_execute($stmt, $this->commit_status);
352         $this->query_end($result, $stmt);
353         $records = null;
354         oci_fetch_all($stmt, $records, 0, -1, OCI_ASSOC);
355         oci_free_statement($stmt);
356         $records = array_map('strtolower', $records['TABLE_NAME']);
357         foreach ($records as $tablename) {
358             if (strpos($tablename, $this->prefix) !== 0) {
359                 continue;
360             }
361             $tablename = substr($tablename, strlen($this->prefix));
362             $this->tables[$tablename] = $tablename;
363         }
365         // Add the currently available temptables
366         $this->tables = array_merge($this->tables, $this->temptables->get_temptables());
368         return $this->tables;
369     }
371     /**
372      * Return table indexes - everything lowercased
373      * @return array of arrays
374      */
375     public function get_indexes($table) {
376         $indexes = array();
377         $tablename = strtoupper($this->prefix.$table);
379         $sql = "SELECT i.INDEX_NAME, i.UNIQUENESS, c.COLUMN_POSITION, c.COLUMN_NAME, ac.CONSTRAINT_TYPE
380                   FROM ALL_INDEXES i
381                   JOIN ALL_IND_COLUMNS c ON c.INDEX_NAME=i.INDEX_NAME
382              LEFT JOIN ALL_CONSTRAINTS ac ON (ac.TABLE_NAME=i.TABLE_NAME AND ac.CONSTRAINT_NAME=i.INDEX_NAME AND ac.CONSTRAINT_TYPE='P')
383                  WHERE i.TABLE_NAME = '$tablename'
384               ORDER BY i.INDEX_NAME, c.COLUMN_POSITION";
386         $stmt = $this->parse_query($sql);
387         $result = oci_execute($stmt, $this->commit_status);
388         $this->query_end($result, $stmt);
389         $records = null;
390         oci_fetch_all($stmt, $records, 0, -1, OCI_FETCHSTATEMENT_BY_ROW);
391         oci_free_statement($stmt);
393         foreach ($records as $record) {
394             if ($record['CONSTRAINT_TYPE'] === 'P') {
395                 //ignore for now;
396                 continue;
397             }
398             $indexname = strtolower($record['INDEX_NAME']);
399             if (!isset($indexes[$indexname])) {
400                 $indexes[$indexname] = array('primary' => ($record['CONSTRAINT_TYPE'] === 'P'),
401                                              'unique'  => ($record['UNIQUENESS'] === 'UNIQUE'),
402                                              'columns' => array());
403             }
404             $indexes[$indexname]['columns'][] = strtolower($record['COLUMN_NAME']);
405         }
407         return $indexes;
408     }
410     /**
411      * Returns datailed information about columns in table. This information is cached internally.
412      * @param string $table name
413      * @param bool $usecache
414      * @return array array of database_column_info objects indexed with column names
415      */
416     public function get_columns($table, $usecache=true) {
417         if ($usecache and isset($this->columns[$table])) {
418             return $this->columns[$table];
419         }
421         if (!$table) { // table not specified, return empty array directly
422             return array();
423         }
425         $this->columns[$table] = array();
427         $sql = "SELECT CNAME, COLTYPE, WIDTH, SCALE, PRECISION, NULLS, DEFAULTVAL
428                   FROM COL
429                  WHERE TNAME = UPPER('{" . $table . "}')
430               ORDER BY COLNO";
432         list($sql, $params, $type) = $this->fix_sql_params($sql, null);
434         $this->query_start($sql, null, SQL_QUERY_AUX);
435         $stmt = $this->parse_query($sql);
436         $result = oci_execute($stmt, $this->commit_status);
437         $this->query_end($result, $stmt);
438         $records = null;
439         oci_fetch_all($stmt, $records, 0, -1, OCI_FETCHSTATEMENT_BY_ROW);
440         oci_free_statement($stmt);
442         if (!$records) {
443             return array();
444         }
445         foreach ($records as $rawcolumn) {
446             $rawcolumn = (object)$rawcolumn;
448             $info = new object();
449             $info->name = strtolower($rawcolumn->CNAME);
450             $matches = null;
452             if ($rawcolumn->COLTYPE === 'VARCHAR2'
453              or $rawcolumn->COLTYPE === 'VARCHAR'
454              or $rawcolumn->COLTYPE === 'NVARCHAR2'
455              or $rawcolumn->COLTYPE === 'NVARCHAR'
456              or $rawcolumn->COLTYPE === 'CHAR'
457              or $rawcolumn->COLTYPE === 'NCHAR') {
458                 //TODO add some basic enum support here
459                 $info->type          = $rawcolumn->COLTYPE;
460                 $info->meta_type     = 'C';
461                 $info->max_length    = $rawcolumn->WIDTH;
462                 $info->scale         = null;
463                 $info->not_null      = ($rawcolumn->NULLS === 'NOT NULL');
464                 $info->has_default   = !is_null($rawcolumn->DEFAULTVAL);
465                 if ($info->has_default) {
467                     // this is hacky :-(
468                     if ($rawcolumn->DEFAULTVAL === 'NULL') {
469                         $info->default_value = null;
470                     } else if ($rawcolumn->DEFAULTVAL === "' ' ") { // Sometimes it's stored with trailing space
471                         $info->default_value = "";
472                     } else if ($rawcolumn->DEFAULTVAL === "' '") { // Sometimes it's stored without trailing space
473                         $info->default_value = "";
474                     } else {
475                         $info->default_value = trim($rawcolumn->DEFAULTVAL); // remove trailing space
476                         $info->default_value = substr($info->default_value, 1, strlen($info->default_value)-2); //trim ''
477                     }
478                 } else {
479                     $info->default_value = null;
480                 }
481                 $info->primary_key   = false;
482                 $info->binary        = false;
483                 $info->unsigned      = null;
484                 $info->auto_increment= false;
485                 $info->unique        = null;
487             } else if ($rawcolumn->COLTYPE === 'NUMBER') {
488                 $info->type       = $rawcolumn->COLTYPE;
489                 $info->max_length = $rawcolumn->PRECISION;
490                 $info->binary     = false;
491                 if (!is_null($rawcolumn->SCALE) && $rawcolumn->SCALE == 0) { // null in oracle scale allows decimals => not integer
492                     // integer
493                     if ($info->name === 'id') {
494                         $info->primary_key   = true;
495                         $info->meta_type     = 'R';
496                         $info->unique        = true;
497                         $info->auto_increment= true;
498                         $info->has_default   = false;
499                     } else {
500                         $info->primary_key   = false;
501                         $info->meta_type     = 'I';
502                         $info->unique        = null;
503                         $info->auto_increment= false;
504                     }
505                     $info->scale = null;
507                 } else {
508                     //float
509                     $info->meta_type     = 'N';
510                     $info->primary_key   = false;
511                     $info->unsigned      = null;
512                     $info->auto_increment= false;
513                     $info->unique        = null;
514                     $info->scale         = $rawcolumn->SCALE;
515                 }
516                 $info->not_null      = ($rawcolumn->NULLS === 'NOT NULL');
517                 $info->has_default   = !is_null($rawcolumn->DEFAULTVAL);
518                 if ($info->has_default) {
519                     $info->default_value = trim($rawcolumn->DEFAULTVAL); // remove trailing space
520                 } else {
521                     $info->default_value = null;
522                 }
524             } else if ($rawcolumn->COLTYPE === 'FLOAT') {
525                 $info->type       = $rawcolumn->COLTYPE;
526                 $info->max_length = (int)($rawcolumn->PRECISION * 3.32193);
527                 $info->primary_key   = false;
528                 $info->meta_type     = 'N';
529                 $info->unique        = null;
530                 $info->auto_increment= false;
531                 $info->not_null      = ($rawcolumn->NULLS === 'NOT NULL');
532                 $info->has_default   = !is_null($rawcolumn->DEFAULTVAL);
533                 if ($info->has_default) {
534                     $info->default_value = trim($rawcolumn->DEFAULTVAL); // remove trailing space
535                 } else {
536                     $info->default_value = null;
537                 }
539             } else if ($rawcolumn->COLTYPE === 'CLOB'
540                     or $rawcolumn->COLTYPE === 'NCLOB') {
541                 $info->type          = $rawcolumn->COLTYPE;
542                 $info->meta_type     = 'X';
543                 $info->max_length    = -1;
544                 $info->scale         = null;
545                 $info->scale         = null;
546                 $info->not_null      = ($rawcolumn->NULLS === 'NOT NULL');
547                 $info->has_default   = !is_null($rawcolumn->DEFAULTVAL);
548                 if ($info->has_default) {
549                     // this is hacky :-(
550                     if ($rawcolumn->DEFAULTVAL === 'NULL') {
551                         $info->default_value = null;
552                     } else if ($rawcolumn->DEFAULTVAL === "' ' ") { // Sometimes it's stored with trailing space
553                         $info->default_value = "";
554                     } else if ($rawcolumn->DEFAULTVAL === "' '") { // Other times it's stored without trailing space
555                         $info->default_value = "";
556                     } else {
557                         $info->default_value = trim($rawcolumn->DEFAULTVAL); // remove trailing space
558                         $info->default_value = substr($info->default_value, 1, strlen($info->default_value)-2); //trim ''
559                     }
560                 } else {
561                     $info->default_value = null;
562                 }
563                 $info->primary_key   = false;
564                 $info->binary        = false;
565                 $info->unsigned      = null;
566                 $info->auto_increment= false;
567                 $info->unique        = null;
569             } else if ($rawcolumn->COLTYPE === 'BLOB') {
570                 $info->type          = $rawcolumn->COLTYPE;
571                 $info->meta_type     = 'B';
572                 $info->max_length    = -1;
573                 $info->scale         = null;
574                 $info->scale         = null;
575                 $info->not_null      = ($rawcolumn->NULLS === 'NOT NULL');
576                 $info->has_default   = !is_null($rawcolumn->DEFAULTVAL);
577                 if ($info->has_default) {
578                     // this is hacky :-(
579                     if ($rawcolumn->DEFAULTVAL === 'NULL') {
580                         $info->default_value = null;
581                     } else if ($rawcolumn->DEFAULTVAL === "' ' ") { // Sometimes it's stored with trailing space
582                         $info->default_value = "";
583                     } else if ($rawcolumn->DEFAULTVAL === "' '") { // Sometimes it's stored without trailing space
584                         $info->default_value = "";
585                     } else {
586                         $info->default_value = trim($rawcolumn->DEFAULTVAL); // remove trailing space
587                         $info->default_value = substr($info->default_value, 1, strlen($info->default_value)-2); //trim ''
588                     }
589                 } else {
590                     $info->default_value = null;
591                 }
592                 $info->primary_key   = false;
593                 $info->binary        = true;
594                 $info->unsigned      = null;
595                 $info->auto_increment= false;
596                 $info->unique        = null;
598             } else {
599                 // unknown type - sorry
600                 $info->type          = $rawcolumn->COLTYPE;
601                 $info->meta_type     = '?';
602             }
604             $this->columns[$table][$info->name] = new database_column_info($info);
605         }
607         return $this->columns[$table];
608     }
610     /**
611      * Normalise values based in RDBMS dependencies (booleans, LOBs...)
612      *
613      * @param database_column_info $column column metadata corresponding with the value we are going to normalise
614      * @param mixed $value value we are going to normalise
615      * @return mixed the normalised value
616      */
617     protected function normalise_value($column, $value) {
618         if (is_bool($value)) { // Always, convert boolean to int
619             $value = (int)$value;
621         } else if ($column->meta_type == 'B') { // CLOB detected, we return 'blob' array instead of raw value to allow
622             if (!is_null($value)) {             // binding/executing code later to know about its nature
623                 $value = array('blob' => $value);
624             }
626         } else if ($column->meta_type == 'X' && strlen($value) > 4000) { // CLOB detected (>4000 optimisation), we return 'clob'
627             if (!is_null($value)) {                                      // array instead of raw value to allow binding/
628                 $value = array('clob' => (string)$value);                // executing code later to know about its nature
629             }
631         } else if ($value === '') {
632             if ($column->meta_type == 'I' or $column->meta_type == 'F' or $column->meta_type == 'N') {
633                 $value = 0; // prevent '' problems in numeric fields
634             }
635         }
636         return $value;
637     }
639     /**
640      * Transforms the sql and params in order to emulate the LIMIT clause available in other DBs
641      *
642      * @param string $sql the SQL select query to execute.
643      * @param array $params array of sql parameters
644      * @param int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
645      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
646      * @return array with the transformed sql and params updated
647      */
648     private function get_limit_sql($sql, array $params = null, $limitfrom=0, $limitnum=0) {
650         $limitfrom = (int)$limitfrom;
651         $limitnum  = (int)$limitnum;
652         $limitfrom = ($limitfrom < 0) ? 0 : $limitfrom;
653         $limitnum  = ($limitnum < 0)  ? 0 : $limitnum;
655         // TODO: Add the /*+ FIRST_ROWS */ hint if there isn't another hint
657         if ($limitfrom and $limitnum) {
658             $sql = "SELECT oracle_o.*
659                       FROM (SELECT oracle_i.*, rownum AS oracle_rownum
660                               FROM ($sql) oracle_i
661                              WHERE rownum <= :oracle_num_rows
662                             ) oracle_o
663                      WHERE oracle_rownum > :oracle_skip_rows";
664             $params['oracle_num_rows'] = $limitfrom + $limitnum;
665             $params['oracle_skip_rows'] = $limitfrom;
667         } else if ($limitfrom and !$limitnum) {
668             $sql = "SELECT oracle_o.*
669                       FROM (SELECT oracle_i.*, rownum AS oracle_rownum
670                               FROM ($sql) oracle_i
671                             ) oracle_o
672                      WHERE oracle_rownum > :oracle_skip_rows";
673             $params['oracle_skip_rows'] = $limitfrom;
675         } else if (!$limitfrom and $limitnum) {
676             $sql = "SELECT *
677                       FROM ($sql)
678                      WHERE rownum <= :oracle_num_rows";
679             $params['oracle_num_rows'] = $limitnum;
680         }
682         return array($sql, $params);
683     }
685     /**
686      * This function will handle all the column values before being inserted/updated to DB for Oracle
687      * installations. This is because the "special feature" of Oracle where the empty string is
688      * equal to NULL and this presents a problem with all our currently NOT NULL default '' fields.
689      * (and with empties handling in general)
690      *
691      * Note that this function is 100% private and should be used, exclusively by DML functions
692      * in this file. Also, this is considered a DIRTY HACK to be removed when possible.
693      *
694      * This function is private and must not be used outside this driver at all
695      *
696      * @param $table string the table where the record is going to be inserted/updated (without prefix)
697      * @param $field string the field where the record is going to be inserted/updated
698      * @param $value mixed the value to be inserted/updated
699      */
700     private function oracle_dirty_hack ($table, $field, $value) {
702         // Get metadata
703         $columns = $this->get_columns($table);
704         if (!isset($columns[$field])) {
705             return $value;
706         }
707         $column = $columns[$field];
709         // !! This paragraph explains behaviour before Moodle 2.0:
710         //
711         // For Oracle DB, empty strings are converted to NULLs in DB
712         // and this breaks a lot of NOT NULL columns currenty Moodle. In the future it's
713         // planned to move some of them to NULL, if they must accept empty values and this
714         // piece of code will become less and less used. But, for now, we need it.
715         // What we are going to do is to examine all the data being inserted and if it's
716         // an empty string (NULL for Oracle) and the field is defined as NOT NULL, we'll modify
717         // such data in the best form possible ("0" for booleans and numbers and " " for the
718         // rest of strings. It isn't optimal, but the only way to do so.
719         // In the oppsite, when retrieving records from Oracle, we'll decode " " back to
720         // empty strings to allow everything to work properly. DIRTY HACK.
722         // !! These paragraphs explain the rationale about the change for Moodle 2.0:
723         //
724         // Before Moodle 2.0, we only used to apply this DIRTY HACK to NOT NULL columns, as
725         // stated above, but it causes one problem in NULL columns where both empty strings
726         // and real NULLs are stored as NULLs, being impossible to diferentiate them when
727         // being retrieved from DB.
728         //
729         // So, starting with Moodle 2.0, we are going to apply the DIRTY HACK to all the
730         // CHAR/CLOB columns no matter of their nullability. That way, when retrieving
731         // NULLABLE fields we'll get proper empties and NULLs diferentiated, so we'll be able
732         // to rely in NULL/empty/content contents without problems, until now that wasn't
733         // possible at all.
734         //
735         // No breackage with old data is expected as long as at the time of writing this
736         // (20090922) all the current uses of both sql_empty() and sql_isempty() has been
737         // revised in 2.0 and all them were being performed against NOT NULL columns,
738         // where nothing has changed (the DIRTY HACK was already being applied).
739         //
740         // !! Conclusions:
741         //
742         // From Moodle 2.0 onwards, ALL empty strings in Oracle DBs will be stored as
743         // 1-whitespace char, ALL NULLs as NULLs and, obviously, content as content. And
744         // those 1-whitespace chars will be converted back to empty strings by all the
745         // get_field/record/set() functions transparently and any SQL needing direct handling
746         // of empties will need to use the sql_empty() and sql_isempty() helper functions.
747         // MDL-17491.
749         // If the field ins't VARCHAR or CLOB, skip
750         if ($column->meta_type != 'C' and $column->meta_type != 'X') {
751             return $value;
752         }
754         // If the value isn't empty, skip
755         if (!empty($value)) {
756             return $value;
757         }
759         // Now, we have one empty value, going to be inserted to one VARCHAR2 or CLOB field
760         // Try to get the best value to be inserted
762         // The '0' string doesn't need any transformation, skip
763         if ($value === '0') {
764             return $value;
765         }
767         // Transformations start
768         if (gettype($value) == 'boolean') {
769             return '0'; // Transform false to '0' that evaluates the same for PHP
771         } else if (gettype($value) == 'integer') {
772             return '0'; // Transform 0 to '0' that evaluates the same for PHP
774         } else if ($value === '') {
775             return ' '; // Transform '' to ' ' that DONT'T EVALUATE THE SAME
776                         // (we'll transform back again on get_records_XXX functions and others)!!
777         }
779         // Fail safe to original value
780         return $value;
781     }
783     /**
784      * Is db in unicode mode?
785      * @return bool
786      */
787     public function setup_is_unicodedb() {
788         $sql = "SELECT VALUE
789                   FROM NLS_DATABASE_PARAMETERS
790                  WHERE PARAMETER = 'NLS_CHARACTERSET'";
791         $this->query_start($sql, null, SQL_QUERY_AUX);
792         $stmt = $this->parse_query($sql);
793         $result = oci_execute($stmt, $this->commit_status);
794         $this->query_end($result, $stmt);
795         $records = null;
796         oci_fetch_all($stmt, $records, 0, -1, OCI_FETCHSTATEMENT_BY_COLUMN);
797         oci_free_statement($stmt);
799         return (isset($records['VALUE'][0]) and $records['VALUE'][0] === 'AL32UTF8');
800     }
802     /**
803      * Do NOT use in code, to be used by database_manager only!
804      * @param string $sql query
805      * @return bool true
806      * @throws dml_exception if error
807      */
808     public function change_database_structure($sql) {
809         $this->reset_caches();
811         $this->query_start($sql, null, SQL_QUERY_STRUCTURE);
812         $stmt = $this->parse_query($sql);
813         $result = oci_execute($stmt, $this->commit_status);
814         $this->query_end($result, $stmt);
815         oci_free_statement($stmt);
817         return true;
818     }
820     protected function bind_params($stmt, array $params=null, $tablename=null) {
821         $descriptors = array();
822         if ($params) {
823             $columns = array();
824             if ($tablename) {
825                 $columns = $this->get_columns($tablename);
826             }
827             foreach($params as $key => $value) {
828                 // Decouple column name and param name as far as sometimes they aren't the same
829                 $columnname = $key; // Defaul columname (for DB introspecting is key), but...
830                 if ($key == 'newfieldtoset') { // found case where column and key diverge, handle that
831                     $columnname   = key($value);    // columnname is the key of the array
832                     $params[$key] = $value[$columnname]; // set the proper value in the $params array and
833                     $value        = $value[$columnname]; // set the proper value in the $value variable
834                 }
835                 // Continue processing
836                 // Now, handle already detected LOBs
837                 if (is_array($value)) { // Let's go to bind special cases (lob descriptors)
838                     if (isset($value['clob'])) {
839                         $lob = oci_new_descriptor($this->oci, OCI_DTYPE_LOB);
840                         oci_bind_by_name($stmt, $key, $lob, -1, SQLT_CLOB);
841                         $lob->writeTemporary($this->oracle_dirty_hack($tablename, $columnname, $params[$key]['clob']), OCI_TEMP_CLOB);
842                         $descriptors[] = $lob;
843                         continue; // Column binding finished, go to next one
844                     } else if (isset($value['blob'])) {
845                         $lob = oci_new_descriptor($this->oci, OCI_DTYPE_LOB);
846                         oci_bind_by_name($stmt, $key, $lob, -1, SQLT_BLOB);
847                         $lob->writeTemporary($params[$key]['blob'], OCI_TEMP_BLOB);
848                         $descriptors[] = $lob;
849                         continue; // Column binding finished, go to next one
850                     }
851                 }
852                 // TODO: Put propper types and length is possible (enormous speedup)
853                 // Arrived here, continue with standard processing, using metadata if possible
854                 if (isset($columns[$columnname])) {
855                     $type = $columns[$columnname]->meta_type;
856                     $maxlength = $columns[$columnname]->max_length;
857                 } else {
858                     $type = '?';
859                     $maxlength = -1;
860                 }
861                 switch ($type) {
862                     case 'I':
863                     case 'R':
864                         // TODO: Optimise
865                         oci_bind_by_name($stmt, $key, $params[$key]);
866                         break;
868                     case 'N':
869                     case 'F':
870                         // TODO: Optimise
871                         oci_bind_by_name($stmt, $key, $params[$key]);
872                         break;
874                     case 'B':
875                         // TODO: Only arrive here if BLOB is null: Bind if so, else exception!
876                         // don't break here
878                     case 'X':
879                         // TODO: Only arrive here if CLOB is null or <= 4000 cc, else exception
880                         // don't break here
882                     default: // Bind as CHAR (applying dirty hack)
883                         // TODO: Optimise
884                         oci_bind_by_name($stmt, $key, $this->oracle_dirty_hack($tablename, $columnname, $params[$key]));
885                 }
886             }
887         }
888         return $descriptors;
889     }
891     protected function free_descriptors($descriptors) {
892         foreach ($descriptors as $descriptor) {
893             oci_free_descriptor($descriptor);
894         }
895     }
897     /**
898      * This function is used to convert all the Oracle 1-space defaults to the empty string
899      * like a really DIRTY HACK to allow it to work better until all those NOT NULL DEFAULT ''
900      * fields will be out from Moodle.
901      * @param string the string to be converted to '' (empty string) if it's ' ' (one space)
902      * @param mixed the key of the array in case we are using this function from array_walk,
903      *              defaults to null for other (direct) uses
904      * @return boolean always true (the converted variable is returned by reference)
905      */
906     public static function onespace2empty(&$item, $key=null) {
907         $item = ($item === ' ') ? '' : $item;
908         return true;
909     }
911     /**
912      * Execute general sql query. Should be used only when no other method suitable.
913      * Do NOT use this to make changes in db structure, use database_manager::execute_sql() instead!
914      * @param string $sql query
915      * @param array $params query parameters
916      * @return bool true
917      * @throws dml_exception if error
918      */
919     public function execute($sql, array $params=null) {
920         list($sql, $params, $type) = $this->fix_sql_params($sql, $params);
922         if (strpos($sql, ';') !== false) {
923             throw new coding_exception('moodle_database::execute() Multiple sql statements found or bound parameters not used properly in query!');
924         }
926         $this->query_start($sql, $params, SQL_QUERY_UPDATE);
927         $stmt = $this->parse_query($sql);
928         $this->bind_params($stmt, $params);
929         $result = oci_execute($stmt, $this->commit_status);
930         $this->query_end($result, $stmt);
931         oci_free_statement($stmt);
933         return true;
934     }
936     /**
937      * Get a single database record as an object using a SQL statement.
938      *
939      * The SQL statement should normally only return one record.
940      * It is recommended to use get_records_sql() if more matches possible!
941      *
942      * @param string $sql The SQL string you wish to be executed, should normally only return one record.
943      * @param array $params array of sql parameters
944      * @param int $strictness IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found;
945      *                        IGNORE_MULTIPLE means return first, ignore multiple records found(not recommended);
946      *                        MUST_EXIST means throw exception if no record or multiple records found
947      * @return mixed a fieldset object containing the first matching record, false or exception if error not found depending on mode
948      * @throws dml_exception if error
949      */
950     public function get_record_sql($sql, array $params=null, $strictness=IGNORE_MISSING) {
951         $strictness = (int)$strictness;
952         if ($strictness == IGNORE_MULTIPLE) {
953             // do not limit here - ORA does not like that
954             if (!$rs = $this->get_recordset_sql($sql, $params)) {
955                 return false;
956             }
957             foreach ($rs as $result) {
958                 $rs->close();
959                 return $result;
960             }
961             $rs->close();
962             return false;
963         }
964         return parent::get_record_sql($sql, $params, $strictness);
965     }
967     /**
968      * Get a number of records as a moodle_recordset using a SQL statement.
969      *
970      * Since this method is a little less readable, use of it should be restricted to
971      * code where it's possible there might be large datasets being returned.  For known
972      * small datasets use get_records_sql - it leads to simpler code.
973      *
974      * The return type is as for @see function get_recordset.
975      *
976      * @param string $sql the SQL select query to execute.
977      * @param array $params array of sql parameters
978      * @param int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
979      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
980      * @return mixed an moodle_recordset object
981      * @throws dml_exception if error
982      */
983     public function get_recordset_sql($sql, array $params=null, $limitfrom=0, $limitnum=0) {
985         list($sql, $params, $type) = $this->fix_sql_params($sql, $params);
987         list($rawsql, $params) = $this->get_limit_sql($sql, $params, $limitfrom, $limitnum);
989         $this->query_start($sql, $params, SQL_QUERY_SELECT);
990         $stmt = $this->parse_query($rawsql);
991         $this->bind_params($stmt, $params);
992         $result = oci_execute($stmt, $this->commit_status);
993         $this->query_end($result, $stmt);
995         return $this->create_recordset($stmt);
996     }
998     protected function create_recordset($stmt) {
999         return new oci_native_moodle_recordset($stmt);
1000     }
1002     /**
1003      * Get a number of records as an array of objects using a SQL statement.
1004      *
1005      * Return value as for @see function get_records.
1006      *
1007      * @param string $sql the SQL select query to execute. The first column of this SELECT statement
1008      *   must be a unique value (usually the 'id' field), as it will be used as the key of the
1009      *   returned array.
1010      * @param array $params array of sql parameters
1011      * @param int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
1012      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
1013      * @return mixed an array of objects, or empty array if no records were found
1014      * @throws dml_exception if error
1015      */
1016     public function get_records_sql($sql, array $params=null, $limitfrom=0, $limitnum=0) {
1018         list($sql, $params, $type) = $this->fix_sql_params($sql, $params);
1020         list($rawsql, $params) = $this->get_limit_sql($sql, $params, $limitfrom, $limitnum);
1022         $this->query_start($sql, $params, SQL_QUERY_SELECT);
1023         $stmt = $this->parse_query($rawsql);
1024         $this->bind_params($stmt, $params);
1025         $result = oci_execute($stmt, $this->commit_status);
1026         $this->query_end($result, $stmt);
1028         $records = null;
1029         oci_fetch_all($stmt, $records, 0, -1, OCI_FETCHSTATEMENT_BY_ROW);
1030         oci_free_statement($stmt);
1032         $return = array();
1034         foreach ($records as $row) {
1035             $row = array_change_key_case($row, CASE_LOWER);
1036             unset($row['oracle_rownum']);
1037             array_walk($row, array('oci_native_moodle_database', 'onespace2empty'));
1038             $id = reset($row);
1039             if (isset($return[$id])) {
1040                 $colname = key($row);
1041                 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);
1042             }
1043             $return[$id] = (object)$row;
1044         }
1046         return $return;
1047     }
1049     /**
1050      * Selects records and return values (first field) as an array using a SQL statement.
1051      *
1052      * @param string $sql The SQL query
1053      * @param array $params array of sql parameters
1054      * @return array of values
1055      * @throws dml_exception if error
1056      */
1057     public function get_fieldset_sql($sql, array $params=null) {
1058         list($sql, $params, $type) = $this->fix_sql_params($sql, $params);
1060         $this->query_start($sql, $params, SQL_QUERY_SELECT);
1061         $stmt = $this->parse_query($sql);
1062         $this->bind_params($stmt, $params);
1063         $result = oci_execute($stmt, $this->commit_status);
1064         $this->query_end($result, $stmt);
1066         $records = null;
1067         oci_fetch_all($stmt, $records, 0, -1, OCI_FETCHSTATEMENT_BY_COLUMN);
1068         oci_free_statement($stmt);
1070         $return = reset($records);
1071         array_walk($return, array('oci_native_moodle_database', 'onespace2empty'));
1073         return $return;
1074     }
1076     /**
1077      * Insert new record into database, as fast as possible, no safety checks, lobs not supported.
1078      * @param string $table name
1079      * @param mixed $params data record as object or array
1080      * @param bool $returnit return it of inserted record
1081      * @param bool $bulk true means repeated inserts expected
1082      * @param bool $customsequence true if 'id' included in $params, disables $returnid
1083      * @return true or new id
1084      * @throws dml_exception if error
1085      */
1086     public function insert_record_raw($table, $params, $returnid=true, $bulk=false, $customsequence=false) {
1087         if (!is_array($params)) {
1088             $params = (array)$params;
1089         }
1091         $returning = "";
1093         if ($customsequence) {
1094             if (!isset($params['id'])) {
1095                 throw new coding_exception('moodle_database::insert_record_raw() id field must be specified if custom sequences used.');
1096             }
1097             $returnid = false;
1098         } else {
1099             unset($params['id']);
1100             if ($returnid) {
1101                 $returning = " RETURNING id INTO :oracle_id"; // crazy name nobody is ever going to use or parameter ;-)
1102             }
1103         }
1105         if (empty($params)) {
1106             throw new coding_exception('moodle_database::insert_record_raw() no fields found.');
1107         }
1109         $fields = implode(',', array_keys($params));
1110         $values = array();
1111         foreach ($params as $pname => $value) {
1112             $values[] = ":$pname";
1113         }
1114         $values = implode(',', $values);
1116         $sql = "INSERT INTO {" . $table . "} ($fields) VALUES ($values)";
1117         list($sql, $params, $type) = $this->fix_sql_params($sql, $params);
1118         $sql .= $returning;
1120         $id = null;
1122         $this->query_start($sql, $params, SQL_QUERY_INSERT);
1123         $stmt = $this->parse_query($sql);
1124         $descriptors = $this->bind_params($stmt, $params, $table);
1125         if ($returning) {
1126             oci_bind_by_name($stmt, ":oracle_id", $id, -1, SQLT_INT);
1127         }
1128         $result = oci_execute($stmt, $this->commit_status);
1129         $this->free_descriptors($descriptors);
1130         $this->query_end($result, $stmt);
1131         oci_free_statement($stmt);
1133         if (!$returnid) {
1134             return true;
1135         }
1137         if (!$returning) {
1138             die('TODO - implement oracle 9.2 insert support'); //TODO
1139         }
1141         return (int)$id;
1142     }
1144     /**
1145      * Insert a record into a table and return the "id" field if required.
1146      *
1147      * Some conversions and safety checks are carried out. Lobs are supported.
1148      * If the return ID isn't required, then this just reports success as true/false.
1149      * $data is an object containing needed data
1150      * @param string $table The database table to be inserted into
1151      * @param object $data A data object with values for one or more fields in the record
1152      * @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.
1153      * @return true or new id
1154      * @throws dml_exception if error
1155      */
1156     public function insert_record($table, $dataobject, $returnid=true, $bulk=false) {
1157         if (!is_object($dataobject)) {
1158             $dataobject = (object)$dataobject;
1159         }
1161         unset($dataobject->id);
1163         $columns = $this->get_columns($table);
1164         $cleaned = array();
1166         foreach ($dataobject as $field=>$value) {
1167             if (!isset($columns[$field])) { // Non-existing table field, skip it
1168                 continue;
1169             }
1170             $column = $columns[$field];
1171             $cleaned[$field] = $this->normalise_value($column, $value);
1172         }
1174         return $this->insert_record_raw($table, $cleaned, $returnid, $bulk);
1175     }
1177     /**
1178      * Import a record into a table, id field is required.
1179      * Safety checks are NOT carried out. Lobs are supported.
1180      *
1181      * @param string $table name of database table to be inserted into
1182      * @param object $dataobject A data object with values for one or more fields in the record
1183      * @return bool true
1184      * @throws dml_exception if error
1185      */
1186     public function import_record($table, $dataobject) {
1187         if (!is_object($dataobject)) {
1188             $dataobject = (object)$dataobject;
1189         }
1191         $columns = $this->get_columns($table);
1192         $cleaned = array();
1194         foreach ($dataobject as $field=>$value) {
1195             if (!isset($columns[$field])) {
1196                 continue;
1197             }
1198             $column = $columns[$field];
1199             $cleaned[$field] = $this->normalise_value($column, $value);
1200         }
1202         return $this->insert_record_raw($table, $cleaned, false, true, true);
1203     }
1205     /**
1206      * Update record in database, as fast as possible, no safety checks, lobs not supported.
1207      * @param string $table name
1208      * @param mixed $params data record as object or array
1209      * @param bool true means repeated updates expected
1210      * @return bool true
1211      * @throws dml_exception if error
1212      */
1213     public function update_record_raw($table, $params, $bulk=false) {
1214         if (!is_array($params)) {
1215             $params = (array)$params;
1216         }
1217         if (!isset($params['id'])) {
1218             throw new coding_exception('moodle_database::update_record_raw() id field must be specified.');
1219         }
1221         if (empty($params)) {
1222             throw new coding_exception('moodle_database::update_record_raw() no fields found.');
1223         }
1225         $sets = array();
1226         foreach ($params as $field=>$value) {
1227             if ($field == 'id') {
1228                 continue;
1229             }
1230             $sets[] = "$field = :$field";
1231         }
1233         $sets = implode(',', $sets);
1234         $sql = "UPDATE {" . $table . "} SET $sets WHERE id=:id";
1235         list($sql, $params, $type) = $this->fix_sql_params($sql, $params);
1237         $this->query_start($sql, $params, SQL_QUERY_UPDATE);
1238         $stmt = $this->parse_query($sql);
1239         $descriptors = $this->bind_params($stmt, $params, $table);
1240         $result = oci_execute($stmt, $this->commit_status);
1241         $this->free_descriptors($descriptors);
1242         $this->query_end($result, $stmt);
1243         oci_free_statement($stmt);
1245         return true;
1246     }
1248     /**
1249      * Update a record in a table
1250      *
1251      * $dataobject is an object containing needed data
1252      * Relies on $dataobject having a variable "id" to
1253      * specify the record to update
1254      *
1255      * @param string $table The database table to be checked against.
1256      * @param object $dataobject An object with contents equal to fieldname=>fieldvalue. Must have an entry for 'id' to map to the table specified.
1257      * @param bool true means repeated updates expected
1258      * @return bool true
1259      * @throws dml_exception if error
1260      */
1261     public function update_record($table, $dataobject, $bulk=false) {
1262         if (!is_object($dataobject)) {
1263             $dataobject = (object)$dataobject;
1264         }
1266         $columns = $this->get_columns($table);
1267         $cleaned = array();
1269         foreach ($dataobject as $field=>$value) {
1270             if (!isset($columns[$field])) {
1271                 continue;
1272             }
1273             $column = $columns[$field];
1274             $cleaned[$field] = $this->normalise_value($column, $value);
1275         }
1277         $this->update_record_raw($table, $cleaned, $bulk);
1279         return true;
1280     }
1282     /**
1283      * Set a single field in every table record which match a particular WHERE clause.
1284      *
1285      * @param string $table The database table to be checked against.
1286      * @param string $newfield the field to set.
1287      * @param string $newvalue the value to set the field to.
1288      * @param string $select A fragment of SQL to be used in a where clause in the SQL call.
1289      * @param array $params array of sql parameters
1290      * @return bool true
1291      * @throws dml_exception if error
1292      */
1293     public function set_field_select($table, $newfield, $newvalue, $select, array $params=null) {
1295         if ($select) {
1296             $select = "WHERE $select";
1297         }
1298         if (is_null($params)) {
1299             $params = array();
1300         }
1302         // Get column metadata
1303         $columns = $this->get_columns($table);
1304         $column = $columns[$newfield];
1306         $newvalue = $this->normalise_value($column, $newvalue);
1308         list($select, $params, $type) = $this->fix_sql_params($select, $params);
1310         if (is_bool($newvalue)) {
1311             $newvalue = (int)$newvalue; // prevent "false" problems
1312         }
1313         if (is_null($newvalue)) {
1314             $newsql = "$newfield = NULL";
1315         } else {
1316             // Set the param to array ($newfield => $newvalue) and key to 'newfieldtoset'
1317             // name in the build sql. Later, bind_params() will detect the value array and
1318             // perform the needed modifications to allow the query to work. Note that
1319             // 'newfieldtoset' is one arbitrary name that hopefully won't be used ever
1320             // in order to avoid problems where the same field is used both in the set clause and in
1321             // the conditions. This was breaking badly in drivers using NAMED params like oci.
1322             $params['newfieldtoset'] = array($newfield => $newvalue);
1323             $newsql = "$newfield = :newfieldtoset";
1324         }
1325         $sql = "UPDATE {" . $table . "} SET $newsql $select";
1326         list($sql, $params, $type) = $this->fix_sql_params($sql, $params);
1328         $this->query_start($sql, $params, SQL_QUERY_UPDATE);
1329         $stmt = $this->parse_query($sql);
1330         $descriptors = $this->bind_params($stmt, $params, $table);
1331         $result = oci_execute($stmt, $this->commit_status);
1332         $this->free_descriptors($descriptors);
1333         $this->query_end($result, $stmt);
1334         oci_free_statement($stmt);
1336         return true;
1337     }
1339     /**
1340      * Delete one or more records from a table which match a particular WHERE clause.
1341      *
1342      * @param string $table The database table to be checked against.
1343      * @param string $select A fragment of SQL to be used in a where clause in the SQL call (used to define the selection criteria).
1344      * @param array $params array of sql parameters
1345      * @return bool true
1346      * @throws dml_exception if error
1347      */
1348     public function delete_records_select($table, $select, array $params=null) {
1350         if ($select) {
1351             $select = "WHERE $select";
1352         }
1354         $sql = "DELETE FROM {" . $table . "} $select";
1356         list($sql, $params, $type) = $this->fix_sql_params($sql, $params);
1358         $this->query_start($sql, $params, SQL_QUERY_UPDATE);
1359         $stmt = $this->parse_query($sql);
1360         $this->bind_params($stmt, $params);
1361         $result = oci_execute($stmt, $this->commit_status);
1362         $this->query_end($result, $stmt);
1363         oci_free_statement($stmt);
1365         return true;
1366     }
1368     function sql_null_from_clause() {
1369         return ' FROM dual';
1370     }
1372     public function sql_bitand($int1, $int2) {
1373         return 'bitand((' . $int1 . '), (' . $int2 . '))';
1374     }
1376     public function sql_bitnot($int1) {
1377         return '((0 - (' . $int1 . ')) - 1)';
1378     }
1380     public function sql_bitor($int1, $int2) {
1381         return '((' . $int1 . ') + (' . $int2 . ') - ' . $this->sql_bitand($int1, $int2) . ')';
1382     }
1384     public function sql_bitxor($int1, $int2) {
1385         return '(' . $this->sql_bitor($int1, $int2) . ' - ' . $this->sql_bitand($int1, $int2) . ')';
1386     }
1388     /**
1389      * Returns the SQL text to be used in order to perform module '%'
1390      * opration - remainder after division
1391      *
1392      * @param integer int1 first integer in the operation
1393      * @param integer int2 second integer in the operation
1394      * @return string the piece of SQL code to be used in your statement.
1395      */
1396     public function sql_modulo($int1, $int2) {
1397         return 'MOD(' . $int1 . ', ' . $int2 . ')';
1398     }
1400     public function sql_cast_char2int($fieldname, $text=false) {
1401         if (!$text) {
1402             return ' CAST(' . $fieldname . ' AS INT) ';
1403         } else {
1404             return ' CAST(' . $this->sql_compare_text($fieldname) . ' AS INT) ';
1405         }
1406     }
1408     // TODO: Change this function and uses to support 2 parameters: fieldname and value
1409     // that way we can use REGEXP_LIKE(x, y, 'i') to provide case-insensitive like searches
1410     // to lower() comparison or whatever
1411     public function sql_ilike() {
1412         // TODO: add some ilike workaround
1413         return 'LIKE';
1414     }
1416     // NOTE: Oracle concat implementation isn't ANSI compliant when using NULLs (the result of
1417     // any concatenation with NULL must return NULL) because of his inability to diferentiate
1418     // NULLs and empty strings. So this function will cause some tests to fail. Hopefully
1419     // it's only a side case and it won't affect normal concatenation operations in Moodle.
1420     public function sql_concat() {
1421         $arr = func_get_args();
1422         $s = implode(' || ', $arr);
1423         if ($s === '') {
1424             return " '' ";
1425         }
1426         return " $s ";
1427     }
1429     public function sql_concat_join($separator="' '", $elements=array()) {
1430         for ($n=count($elements)-1; $n > 0 ; $n--) {
1431             array_splice($elements, $n, 0, $separator);
1432         }
1433         $s = implode(' || ', $elements);
1434         if ($s === '') {
1435             return " '' ";
1436         }
1437         return " $s ";
1438     }
1440     /**
1441      * Returns the SQL for returning searching one string for the location of another.
1442      */
1443     public function sql_position($needle, $haystack) {
1444         return "INSTR(($haystack), ($needle))";
1445     }
1447     public function sql_isempty($tablename, $fieldname, $nullablefield, $textfield) {
1448         if ($textfield) {
1449             return " (".$this->sql_compare_text($fieldname)." = '".$this->sql_empty()."') ";
1450         } else {
1451             return " ($fieldname = '".$this->sql_empty()."') ";
1452         }
1453     }
1455     public function sql_empty() {
1456         return ' ';
1457     }
1459     public function sql_order_by_text($fieldname, $numchars=32) {
1460         return 'dbms_lob.substr(' . $fieldname . ', ' . $numchars . ',1)';
1461     }
1463 /// session locking
1464     public function session_lock_supported() {
1465         if (isset($this->dblocks_supported)) { // Use cached value if available
1466             return $this->dblocks_supported;
1467         }
1468         $sql = "SELECT 1
1469                 FROM user_objects
1470                 WHERE object_type = 'PACKAGE BODY'
1471                   AND object_name = 'MOODLE_LOCKS'
1472                   AND status = 'VALID'";
1473         $this->query_start($sql, null, SQL_QUERY_AUX);
1474         $stmt = $this->parse_query($sql);
1475         $result = oci_execute($stmt, $this->commit_status);
1476         $this->query_end($result, $stmt);
1477         $records = null;
1478         oci_fetch_all($stmt, $records, 0, -1, OCI_FETCHSTATEMENT_BY_ROW);
1479         oci_free_statement($stmt);
1480         $this->dblocks_supported = isset($records[0]) && reset($records[0]) ? true : false;
1481         return $this->dblocks_supported;;
1482     }
1484     public function get_session_lock($rowid) {
1485         if (!$this->session_lock_supported()) {
1486             return;
1487         }
1488         parent::get_session_lock($rowid);
1490         $fullname = $this->dbname.'-'.$this->prefix.'-session-'.$rowid;
1491         $sql = 'SELECT MOODLE_LOCKS.GET_LOCK(:lockname, :locktimeout) FROM DUAL';
1492         $params = array('lockname' => $fullname , 'locktimeout' => 120);
1493         $this->query_start($sql, $params, SQL_QUERY_AUX);
1494         $stmt = $this->parse_query($sql);
1495         $this->bind_params($stmt, $params);
1496         $result = oci_execute($stmt, $this->commit_status);
1497         $this->query_end($result, $stmt);
1498         oci_free_statement($stmt);
1499     }
1501     public function release_session_lock($rowid) {
1502         if (!$this->session_lock_supported()) {
1503             return;
1504         }
1505         parent::release_session_lock($rowid);
1507         $fullname = $this->dbname.'-'.$this->prefix.'-session-'.$rowid;
1508         $params = array('lockname' => $fullname);
1509         $sql = 'SELECT MOODLE_LOCKS.RELEASE_LOCK(:lockname) FROM DUAL';
1510         $this->query_start($sql, $params, SQL_QUERY_AUX);
1511         $stmt = $this->parse_query($sql);
1512         $this->bind_params($stmt, $params);
1513         $result = oci_execute($stmt, $this->commit_status);
1514         $this->query_end($result, $stmt);
1515         oci_free_statement($stmt);
1516     }
1518 /// transactions
1519     /**
1520      * Driver specific start of real database transaction,
1521      * this can not be used directly in code.
1522      * @return void
1523      */
1524     protected function begin_transaction() {
1525         $this->commit_status = OCI_DEFAULT; //Done! ;-)
1526     }
1528     /**
1529      * Driver specific commit of real database transaction,
1530      * this can not be used directly in code.
1531      * @return void
1532      */
1533     protected function commit_transaction() {
1534         $this->query_start('--oracle_commit', NULL, SQL_QUERY_AUX);
1535         $result = oci_commit($this->oci);
1536         $this->commit_status = OCI_COMMIT_ON_SUCCESS;
1537         $this->query_end($result);
1538     }
1540     /**
1541      * Driver specific abort of real database transaction,
1542      * this can not be used directly in code.
1543      * @return void
1544      */
1545     protected function rollback_transaction() {
1546         $this->query_start('--oracle_rollback', NULL, SQL_QUERY_AUX);
1547         $result = oci_rollback($this->oci);
1548         $this->commit_status = OCI_COMMIT_ON_SUCCESS;
1549         $this->query_end($result);
1550     }