source: moodle/trunk/fuentes/lib/dml/oci_native_moodle_database.php @ 1331

Last change on this file since 1331 was 1331, checked in by jrpelegrina, 3 years ago

Updated to moodle 3.0.3

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