MDL-53019 travis: adjust runs to use PHP 5.6
[moodle.git] / lib / dml / pgsql_native_moodle_database.php
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/>.
17 /**
18  * Native pgsql 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  */
25 defined('MOODLE_INTERNAL') || die();
27 require_once(__DIR__.'/moodle_database.php');
28 require_once(__DIR__.'/pgsql_native_moodle_recordset.php');
29 require_once(__DIR__.'/pgsql_native_moodle_temptables.php');
31 /**
32  * Native pgsql class representing moodle database interface.
33  *
34  * @package    core_dml
35  * @copyright  2008 Petr Skoda (http://skodak.org)
36  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
37  */
38 class pgsql_native_moodle_database extends moodle_database {
40     /** @var resource $pgsql database resource */
41     protected $pgsql     = null;
42     protected $bytea_oid = null;
44     protected $last_error_reporting; // To handle pgsql driver default verbosity
46     /** @var bool savepoint hack for MDL-35506 - workaround for automatic transaction rollback on error */
47     protected $savepointpresent = false;
49     /**
50      * Detects if all needed PHP stuff installed.
51      * Note: can be used before connect()
52      * @return mixed true if ok, string if something
53      */
54     public function driver_installed() {
55         if (!extension_loaded('pgsql')) {
56             return get_string('pgsqlextensionisnotpresentinphp', 'install');
57         }
58         return true;
59     }
61     /**
62      * Returns database family type - describes SQL dialect
63      * Note: can be used before connect()
64      * @return string db family name (mysql, postgres, mssql, oracle, etc.)
65      */
66     public function get_dbfamily() {
67         return 'postgres';
68     }
70     /**
71      * Returns more specific database driver type
72      * Note: can be used before connect()
73      * @return string db type mysqli, pgsql, oci, mssql, sqlsrv
74      */
75     protected function get_dbtype() {
76         return 'pgsql';
77     }
79     /**
80      * Returns general database library name
81      * Note: can be used before connect()
82      * @return string db type pdo, native
83      */
84     protected function get_dblibrary() {
85         return 'native';
86     }
88     /**
89      * Returns localised database type name
90      * Note: can be used before connect()
91      * @return string
92      */
93     public function get_name() {
94         return get_string('nativepgsql', 'install');
95     }
97     /**
98      * Returns localised database configuration help.
99      * Note: can be used before connect()
100      * @return string
101      */
102     public function get_configuration_help() {
103         return get_string('nativepgsqlhelp', 'install');
104     }
106     /**
107      * Connect to db
108      * Must be called before other methods.
109      * @param string $dbhost The database host.
110      * @param string $dbuser The database username.
111      * @param string $dbpass The database username's password.
112      * @param string $dbname The name of the database being connected to.
113      * @param mixed $prefix string means moodle db prefix, false used for external databases where prefix not used
114      * @param array $dboptions driver specific options
115      * @return bool true
116      * @throws dml_connection_exception if error
117      */
118     public function connect($dbhost, $dbuser, $dbpass, $dbname, $prefix, array $dboptions=null) {
119         if ($prefix == '' and !$this->external) {
120             //Enforce prefixes for everybody but mysql
121             throw new dml_exception('prefixcannotbeempty', $this->get_dbfamily());
122         }
124         $driverstatus = $this->driver_installed();
126         if ($driverstatus !== true) {
127             throw new dml_exception('dbdriverproblem', $driverstatus);
128         }
130         $this->store_settings($dbhost, $dbuser, $dbpass, $dbname, $prefix, $dboptions);
132         $pass = addcslashes($this->dbpass, "'\\");
134         // Unix socket connections should have lower overhead
135         if (!empty($this->dboptions['dbsocket']) and ($this->dbhost === 'localhost' or $this->dbhost === '127.0.0.1')) {
136             $connection = "user='$this->dbuser' password='$pass' dbname='$this->dbname'";
137             if (strpos($this->dboptions['dbsocket'], '/') !== false) {
138                 $connection = $connection." host='".$this->dboptions['dbsocket']."'";
139                 if (!empty($this->dboptions['dbport'])) {
140                     // Somehow non-standard port is important for sockets - see MDL-44862.
141                     $connection = $connection." port ='".$this->dboptions['dbport']."'";
142                 }
143             }
144         } else {
145             $this->dboptions['dbsocket'] = '';
146             if (empty($this->dbname)) {
147                 // probably old style socket connection - do not add port
148                 $port = "";
149             } else if (empty($this->dboptions['dbport'])) {
150                 $port = "port ='5432'";
151             } else {
152                 $port = "port ='".$this->dboptions['dbport']."'";
153             }
154             $connection = "host='$this->dbhost' $port user='$this->dbuser' password='$pass' dbname='$this->dbname'";
155         }
157         ob_start();
158         if (empty($this->dboptions['dbpersist'])) {
159             $this->pgsql = pg_connect($connection, PGSQL_CONNECT_FORCE_NEW);
160         } else {
161             $this->pgsql = pg_pconnect($connection, PGSQL_CONNECT_FORCE_NEW);
162         }
163         $dberr = ob_get_contents();
164         ob_end_clean();
166         $status = pg_connection_status($this->pgsql);
168         if ($status === false or $status === PGSQL_CONNECTION_BAD) {
169             $this->pgsql = null;
170             throw new dml_connection_exception($dberr);
171         }
173         $this->query_start("--pg_set_client_encoding()", null, SQL_QUERY_AUX);
174         pg_set_client_encoding($this->pgsql, 'utf8');
175         $this->query_end(true);
177         $sql = '';
178         // Only for 9.0 and upwards, set bytea encoding to old format.
179         if ($this->is_min_version('9.0')) {
180             $sql = "SET bytea_output = 'escape'; ";
181         }
183         // Select schema if specified, otherwise the first one wins.
184         if (!empty($this->dboptions['dbschema'])) {
185             $sql .= "SET search_path = '".$this->dboptions['dbschema']."'; ";
186         }
188         // Find out the bytea oid.
189         $sql .= "SELECT oid FROM pg_type WHERE typname = 'bytea'";
190         $this->query_start($sql, null, SQL_QUERY_AUX);
191         $result = pg_query($this->pgsql, $sql);
192         $this->query_end($result);
194         $this->bytea_oid = pg_fetch_result($result, 0, 0);
195         pg_free_result($result);
196         if ($this->bytea_oid === false) {
197             $this->pgsql = null;
198             throw new dml_connection_exception('Can not read bytea type.');
199         }
201         // Connection stabilised and configured, going to instantiate the temptables controller
202         $this->temptables = new pgsql_native_moodle_temptables($this);
204         return true;
205     }
207     /**
208      * Close database connection and release all resources
209      * and memory (especially circular memory references).
210      * Do NOT use connect() again, create a new instance if needed.
211      */
212     public function dispose() {
213         parent::dispose(); // Call parent dispose to write/close session and other common stuff before closing connection
214         if ($this->pgsql) {
215             pg_close($this->pgsql);
216             $this->pgsql = null;
217         }
218     }
221     /**
222      * Called before each db query.
223      * @param string $sql
224      * @param array array of parameters
225      * @param int $type type of query
226      * @param mixed $extrainfo driver specific extra information
227      * @return void
228      */
229     protected function query_start($sql, array $params=null, $type, $extrainfo=null) {
230         parent::query_start($sql, $params, $type, $extrainfo);
231         // pgsql driver tents to send debug to output, we do not need that ;-)
232         $this->last_error_reporting = error_reporting(0);
233     }
235     /**
236      * Called immediately after each db query.
237      * @param mixed db specific result
238      * @return void
239      */
240     protected function query_end($result) {
241         // reset original debug level
242         error_reporting($this->last_error_reporting);
243         try {
244             parent::query_end($result);
245             if ($this->savepointpresent and $this->last_type != SQL_QUERY_AUX and $this->last_type != SQL_QUERY_SELECT) {
246                 $res = @pg_query($this->pgsql, "RELEASE SAVEPOINT moodle_pg_savepoint; SAVEPOINT moodle_pg_savepoint");
247                 if ($res) {
248                     pg_free_result($res);
249                 }
250             }
251         } catch (Exception $e) {
252             if ($this->savepointpresent) {
253                 $res = @pg_query($this->pgsql, "ROLLBACK TO SAVEPOINT moodle_pg_savepoint; SAVEPOINT moodle_pg_savepoint");
254                 if ($res) {
255                     pg_free_result($res);
256                 }
257             }
258             throw $e;
259         }
260     }
262     /**
263      * Returns database server info array
264      * @return array Array containing 'description' and 'version' info
265      */
266     public function get_server_info() {
267         static $info;
268         if (!$info) {
269             $this->query_start("--pg_version()", null, SQL_QUERY_AUX);
270             $info = pg_version($this->pgsql);
271             $this->query_end(true);
272         }
273         return array('description'=>$info['server'], 'version'=>$info['server']);
274     }
276     /**
277      * Returns if the RDBMS server fulfills the required version
278      *
279      * @param string $version version to check against
280      * @return bool returns if the version is fulfilled (true) or no (false)
281      */
282     private function is_min_version($version) {
283         $server = $this->get_server_info();
284         $server = $server['version'];
285         return version_compare($server, $version, '>=');
286     }
288     /**
289      * Returns supported query parameter types
290      * @return int bitmask of accepted SQL_PARAMS_*
291      */
292     protected function allowed_param_types() {
293         return SQL_PARAMS_DOLLAR;
294     }
296     /**
297      * Returns last error reported by database engine.
298      * @return string error message
299      */
300     public function get_last_error() {
301         return pg_last_error($this->pgsql);
302     }
304     /**
305      * Return tables in database WITHOUT current prefix.
306      * @param bool $usecache if true, returns list of cached tables.
307      * @return array of table names in lowercase and without prefix
308      */
309     public function get_tables($usecache=true) {
310         if ($usecache and $this->tables !== null) {
311             return $this->tables;
312         }
313         $this->tables = array();
314         $prefix = str_replace('_', '|_', $this->prefix);
315         $sql = "SELECT c.relname
316                   FROM pg_catalog.pg_class c
317                   JOIN pg_catalog.pg_namespace as ns ON ns.oid = c.relnamespace
318                  WHERE c.relname LIKE '$prefix%' ESCAPE '|'
319                        AND c.relkind = 'r'
320                        AND (ns.nspname = current_schema() OR ns.oid = pg_my_temp_schema())";
321         $this->query_start($sql, null, SQL_QUERY_AUX);
322         $result = pg_query($this->pgsql, $sql);
323         $this->query_end($result);
325         if ($result) {
326             while ($row = pg_fetch_row($result)) {
327                 $tablename = reset($row);
328                 if ($this->prefix !== false && $this->prefix !== '') {
329                     if (strpos($tablename, $this->prefix) !== 0) {
330                         continue;
331                     }
332                     $tablename = substr($tablename, strlen($this->prefix));
333                 }
334                 $this->tables[$tablename] = $tablename;
335             }
336             pg_free_result($result);
337         }
338         return $this->tables;
339     }
341     /**
342      * Return table indexes - everything lowercased.
343      * @param string $table The table we want to get indexes from.
344      * @return array of arrays
345      */
346     public function get_indexes($table) {
347         $indexes = array();
348         $tablename = $this->prefix.$table;
350         $sql = "SELECT i.*
351                   FROM pg_catalog.pg_indexes i
352                   JOIN pg_catalog.pg_namespace as ns ON ns.nspname = i.schemaname
353                  WHERE i.tablename = '$tablename'
354                        AND (i.schemaname = current_schema() OR ns.oid = pg_my_temp_schema())";
356         $this->query_start($sql, null, SQL_QUERY_AUX);
357         $result = pg_query($this->pgsql, $sql);
358         $this->query_end($result);
360         if ($result) {
361             while ($row = pg_fetch_assoc($result)) {
362                 if (!preg_match('/CREATE (|UNIQUE )INDEX ([^\s]+) ON '.$tablename.' USING ([^\s]+) \(([^\)]+)\)/i', $row['indexdef'], $matches)) {
363                     continue;
364                 }
365                 if ($matches[4] === 'id') {
366                     continue;
367                 }
368                 $columns = explode(',', $matches[4]);
369                 foreach ($columns as $k=>$column) {
370                     $column = trim($column);
371                     if ($pos = strpos($column, ' ')) {
372                         // index type is separated by space
373                         $column = substr($column, 0, $pos);
374                     }
375                     $columns[$k] = $this->trim_quotes($column);
376                 }
377                 $indexes[$row['indexname']] = array('unique'=>!empty($matches[1]),
378                                               'columns'=>$columns);
379             }
380             pg_free_result($result);
381         }
382         return $indexes;
383     }
385     /**
386      * Returns detailed information about columns in table. This information is cached internally.
387      * @param string $table name
388      * @param bool $usecache
389      * @return database_column_info[] array of database_column_info objects indexed with column names
390      */
391     public function get_columns($table, $usecache=true) {
392         if ($usecache) {
393             if ($this->temptables->is_temptable($table)) {
394                 if ($data = $this->get_temp_tables_cache()->get($table)) {
395                     return $data;
396                 }
397             } else {
398                 if ($data = $this->get_metacache()->get($table)) {
399                     return $data;
400                 }
401             }
402         }
404         $structure = array();
406         $tablename = $this->prefix.$table;
408         $sql = "SELECT a.attnum, a.attname AS field, t.typname AS type, a.attlen, a.atttypmod, a.attnotnull, a.atthasdef, d.adsrc
409                   FROM pg_catalog.pg_class c
410                   JOIN pg_catalog.pg_namespace as ns ON ns.oid = c.relnamespace
411                   JOIN pg_catalog.pg_attribute a ON a.attrelid = c.oid
412                   JOIN pg_catalog.pg_type t ON t.oid = a.atttypid
413              LEFT JOIN pg_catalog.pg_attrdef d ON (d.adrelid = c.oid AND d.adnum = a.attnum)
414                  WHERE relkind = 'r' AND c.relname = '$tablename' AND c.reltype > 0 AND a.attnum > 0
415                        AND (ns.nspname = current_schema() OR ns.oid = pg_my_temp_schema())
416               ORDER BY a.attnum";
418         $this->query_start($sql, null, SQL_QUERY_AUX);
419         $result = pg_query($this->pgsql, $sql);
420         $this->query_end($result);
422         if (!$result) {
423             return array();
424         }
425         while ($rawcolumn = pg_fetch_object($result)) {
427             $info = new stdClass();
428             $info->name = $rawcolumn->field;
429             $matches = null;
431             if ($rawcolumn->type === 'varchar') {
432                 $info->type          = 'varchar';
433                 $info->meta_type     = 'C';
434                 $info->max_length    = $rawcolumn->atttypmod - 4;
435                 $info->scale         = null;
436                 $info->not_null      = ($rawcolumn->attnotnull === 't');
437                 $info->has_default   = ($rawcolumn->atthasdef === 't');
438                 if ($info->has_default) {
439                     $parts = explode('::', $rawcolumn->adsrc);
440                     if (count($parts) > 1) {
441                         $info->default_value = reset($parts);
442                         $info->default_value = trim($info->default_value, "'");
443                     } else {
444                         $info->default_value = $rawcolumn->adsrc;
445                     }
446                 } else {
447                     $info->default_value = null;
448                 }
449                 $info->primary_key   = false;
450                 $info->binary        = false;
451                 $info->unsigned      = null;
452                 $info->auto_increment= false;
453                 $info->unique        = null;
455             } else if (preg_match('/int(\d)/i', $rawcolumn->type, $matches)) {
456                 $info->type = 'int';
457                 if (strpos($rawcolumn->adsrc, 'nextval') === 0) {
458                     $info->primary_key   = true;
459                     $info->meta_type     = 'R';
460                     $info->unique        = true;
461                     $info->auto_increment= true;
462                     $info->has_default   = false;
463                 } else {
464                     $info->primary_key   = false;
465                     $info->meta_type     = 'I';
466                     $info->unique        = null;
467                     $info->auto_increment= false;
468                     $info->has_default   = ($rawcolumn->atthasdef === 't');
469                 }
470                 // Return number of decimals, not bytes here.
471                 if ($matches[1] >= 8) {
472                     $info->max_length = 18;
473                 } else if ($matches[1] >= 4) {
474                     $info->max_length = 9;
475                 } else if ($matches[1] >= 2) {
476                     $info->max_length = 4;
477                 } else if ($matches[1] >= 1) {
478                     $info->max_length = 2;
479                 } else {
480                     $info->max_length = 0;
481                 }
482                 $info->scale         = null;
483                 $info->not_null      = ($rawcolumn->attnotnull === 't');
484                 if ($info->has_default) {
485                     // PG 9.5+ uses ::<TYPE> syntax for some defaults.
486                     $parts = explode('::', $rawcolumn->adsrc);
487                     if (count($parts) > 1) {
488                         $info->default_value = reset($parts);
489                     } else {
490                         $info->default_value = $rawcolumn->adsrc;
491                     }
492                     $info->default_value = trim($info->default_value, "()'");
493                 } else {
494                     $info->default_value = null;
495                 }
496                 $info->binary        = false;
497                 $info->unsigned      = false;
499             } else if ($rawcolumn->type === 'numeric') {
500                 $info->type = $rawcolumn->type;
501                 $info->meta_type     = 'N';
502                 $info->primary_key   = false;
503                 $info->binary        = false;
504                 $info->unsigned      = null;
505                 $info->auto_increment= false;
506                 $info->unique        = null;
507                 $info->not_null      = ($rawcolumn->attnotnull === 't');
508                 $info->has_default   = ($rawcolumn->atthasdef === 't');
509                 if ($info->has_default) {
510                     // PG 9.5+ uses ::<TYPE> syntax for some defaults.
511                     $parts = explode('::', $rawcolumn->adsrc);
512                     if (count($parts) > 1) {
513                         $info->default_value = reset($parts);
514                     } else {
515                         $info->default_value = $rawcolumn->adsrc;
516                     }
517                     $info->default_value = trim($info->default_value, "()'");
518                 } else {
519                     $info->default_value = null;
520                 }
521                 $info->max_length    = $rawcolumn->atttypmod >> 16;
522                 $info->scale         = ($rawcolumn->atttypmod & 0xFFFF) - 4;
524             } else if (preg_match('/float(\d)/i', $rawcolumn->type, $matches)) {
525                 $info->type = 'float';
526                 $info->meta_type     = 'N';
527                 $info->primary_key   = false;
528                 $info->binary        = false;
529                 $info->unsigned      = null;
530                 $info->auto_increment= false;
531                 $info->unique        = null;
532                 $info->not_null      = ($rawcolumn->attnotnull === 't');
533                 $info->has_default   = ($rawcolumn->atthasdef === 't');
534                 if ($info->has_default) {
535                     // PG 9.5+ uses ::<TYPE> syntax for some defaults.
536                     $parts = explode('::', $rawcolumn->adsrc);
537                     if (count($parts) > 1) {
538                         $info->default_value = reset($parts);
539                     } else {
540                         $info->default_value = $rawcolumn->adsrc;
541                     }
542                     $info->default_value = trim($info->default_value, "()'");
543                 } else {
544                     $info->default_value = null;
545                 }
546                 // just guess expected number of deciaml places :-(
547                 if ($matches[1] == 8) {
548                     // total 15 digits
549                     $info->max_length = 8;
550                     $info->scale      = 7;
551                 } else {
552                     // total 6 digits
553                     $info->max_length = 4;
554                     $info->scale      = 2;
555                 }
557             } else if ($rawcolumn->type === 'text') {
558                 $info->type          = $rawcolumn->type;
559                 $info->meta_type     = 'X';
560                 $info->max_length    = -1;
561                 $info->scale         = null;
562                 $info->not_null      = ($rawcolumn->attnotnull === 't');
563                 $info->has_default   = ($rawcolumn->atthasdef === 't');
564                 if ($info->has_default) {
565                     $parts = explode('::', $rawcolumn->adsrc);
566                     if (count($parts) > 1) {
567                         $info->default_value = reset($parts);
568                         $info->default_value = trim($info->default_value, "'");
569                     } else {
570                         $info->default_value = $rawcolumn->adsrc;
571                     }
572                 } else {
573                     $info->default_value = null;
574                 }
575                 $info->primary_key   = false;
576                 $info->binary        = false;
577                 $info->unsigned      = null;
578                 $info->auto_increment= false;
579                 $info->unique        = null;
581             } else if ($rawcolumn->type === 'bytea') {
582                 $info->type          = $rawcolumn->type;
583                 $info->meta_type     = 'B';
584                 $info->max_length    = -1;
585                 $info->scale         = null;
586                 $info->not_null      = ($rawcolumn->attnotnull === 't');
587                 $info->has_default   = false;
588                 $info->default_value = null;
589                 $info->primary_key   = false;
590                 $info->binary        = true;
591                 $info->unsigned      = null;
592                 $info->auto_increment= false;
593                 $info->unique        = null;
595             }
597             $structure[$info->name] = new database_column_info($info);
598         }
600         pg_free_result($result);
602         if ($usecache) {
603             if ($this->temptables->is_temptable($table)) {
604                 $this->get_temp_tables_cache()->set($table, $structure);
605             } else {
606                 $this->get_metacache()->set($table, $structure);
607             }
608         }
610         return $structure;
611     }
613     /**
614      * Normalise values based in RDBMS dependencies (booleans, LOBs...)
615      *
616      * @param database_column_info $column column metadata corresponding with the value we are going to normalise
617      * @param mixed $value value we are going to normalise
618      * @return mixed the normalised value
619      */
620     protected function normalise_value($column, $value) {
621         $this->detect_objects($value);
623         if (is_bool($value)) { // Always, convert boolean to int
624             $value = (int)$value;
626         } else if ($column->meta_type === 'B') { // BLOB detected, we return 'blob' array instead of raw value to allow
627             if (!is_null($value)) {             // binding/executing code later to know about its nature
628                 $value = array('blob' => $value);
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      * Is db in unicode mode?
641      * @return bool
642      */
643     public function setup_is_unicodedb() {
644         // Get PostgreSQL server_encoding value
645         $sql = "SHOW server_encoding";
646         $this->query_start($sql, null, SQL_QUERY_AUX);
647         $result = pg_query($this->pgsql, $sql);
648         $this->query_end($result);
650         if (!$result) {
651             return false;
652         }
653         $rawcolumn = pg_fetch_object($result);
654         $encoding = $rawcolumn->server_encoding;
655         pg_free_result($result);
657         return (strtoupper($encoding) == 'UNICODE' || strtoupper($encoding) == 'UTF8');
658     }
660     /**
661      * Do NOT use in code, to be used by database_manager only!
662      * @param string|array $sql query
663      * @param array|null $tablenames an array of xmldb table names affected by this request.
664      * @return bool true
665      * @throws ddl_change_structure_exception A DDL specific exception is thrown for any errors.
666      */
667     public function change_database_structure($sql, $tablenames = null) {
668         $this->get_manager(); // Includes DDL exceptions classes ;-)
669         if (is_array($sql)) {
670             $sql = implode("\n;\n", $sql);
671         }
672         if (!$this->is_transaction_started()) {
673             // It is better to do all or nothing, this helps with recovery...
674             $sql = "BEGIN ISOLATION LEVEL SERIALIZABLE;\n$sql\n; COMMIT";
675         }
677         try {
678             $this->query_start($sql, null, SQL_QUERY_STRUCTURE);
679             $result = pg_query($this->pgsql, $sql);
680             $this->query_end($result);
681             pg_free_result($result);
682         } catch (ddl_change_structure_exception $e) {
683             if (!$this->is_transaction_started()) {
684                 $result = @pg_query($this->pgsql, "ROLLBACK");
685                 @pg_free_result($result);
686             }
687             $this->reset_caches($tablenames);
688             throw $e;
689         }
691         $this->reset_caches($tablenames);
692         return true;
693     }
695     /**
696      * Execute general sql query. Should be used only when no other method suitable.
697      * Do NOT use this to make changes in db structure, use database_manager methods instead!
698      * @param string $sql query
699      * @param array $params query parameters
700      * @return bool true
701      * @throws dml_exception A DML specific exception is thrown for any errors.
702      */
703     public function execute($sql, array $params=null) {
704         list($sql, $params, $type) = $this->fix_sql_params($sql, $params);
706         if (strpos($sql, ';') !== false) {
707             throw new coding_exception('moodle_database::execute() Multiple sql statements found or bound parameters not used properly in query!');
708         }
710         $this->query_start($sql, $params, SQL_QUERY_UPDATE);
711         $result = pg_query_params($this->pgsql, $sql, $params);
712         $this->query_end($result);
714         pg_free_result($result);
715         return true;
716     }
718     /**
719      * Get a number of records as a moodle_recordset using a SQL statement.
720      *
721      * Since this method is a little less readable, use of it should be restricted to
722      * code where it's possible there might be large datasets being returned.  For known
723      * small datasets use get_records_sql - it leads to simpler code.
724      *
725      * The return type is like:
726      * @see function get_recordset.
727      *
728      * @param string $sql the SQL select query to execute.
729      * @param array $params array of sql parameters
730      * @param int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
731      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
732      * @return moodle_recordset instance
733      * @throws dml_exception A DML specific exception is thrown for any errors.
734      */
735     public function get_recordset_sql($sql, array $params=null, $limitfrom=0, $limitnum=0) {
737         list($limitfrom, $limitnum) = $this->normalise_limit_from_num($limitfrom, $limitnum);
739         if ($limitfrom or $limitnum) {
740             if ($limitnum < 1) {
741                 $limitnum = "ALL";
742             } else if (PHP_INT_MAX - $limitnum < $limitfrom) {
743                 // this is a workaround for weird max int problem
744                 $limitnum = "ALL";
745             }
746             $sql .= " LIMIT $limitnum OFFSET $limitfrom";
747         }
749         list($sql, $params, $type) = $this->fix_sql_params($sql, $params);
751         $this->query_start($sql, $params, SQL_QUERY_SELECT);
752         $result = pg_query_params($this->pgsql, $sql, $params);
753         $this->query_end($result);
755         return $this->create_recordset($result);
756     }
758     protected function create_recordset($result) {
759         return new pgsql_native_moodle_recordset($result, $this->bytea_oid);
760     }
762     /**
763      * Get a number of records as an array of objects using a SQL statement.
764      *
765      * Return value is like:
766      * @see function get_records.
767      *
768      * @param string $sql the SQL select query to execute. The first column of this SELECT statement
769      *   must be a unique value (usually the 'id' field), as it will be used as the key of the
770      *   returned array.
771      * @param array $params array of sql parameters
772      * @param int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
773      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
774      * @return array of objects, or empty array if no records were found
775      * @throws dml_exception A DML specific exception is thrown for any errors.
776      */
777     public function get_records_sql($sql, array $params=null, $limitfrom=0, $limitnum=0) {
779         list($limitfrom, $limitnum) = $this->normalise_limit_from_num($limitfrom, $limitnum);
781         if ($limitfrom or $limitnum) {
782             if ($limitnum < 1) {
783                 $limitnum = "ALL";
784             } else if (PHP_INT_MAX - $limitnum < $limitfrom) {
785                 // this is a workaround for weird max int problem
786                 $limitnum = "ALL";
787             }
788             $sql .= " LIMIT $limitnum OFFSET $limitfrom";
789         }
791         list($sql, $params, $type) = $this->fix_sql_params($sql, $params);
792         $this->query_start($sql, $params, SQL_QUERY_SELECT);
793         $result = pg_query_params($this->pgsql, $sql, $params);
794         $this->query_end($result);
796         // find out if there are any blobs
797         $numrows = pg_num_fields($result);
798         $blobs = array();
799         for($i=0; $i<$numrows; $i++) {
800             $type_oid = pg_field_type_oid($result, $i);
801             if ($type_oid == $this->bytea_oid) {
802                 $blobs[] = pg_field_name($result, $i);
803             }
804         }
806         $rows = pg_fetch_all($result);
807         pg_free_result($result);
809         $return = array();
810         if ($rows) {
811             foreach ($rows as $row) {
812                 $id = reset($row);
813                 if ($blobs) {
814                     foreach ($blobs as $blob) {
815                         // note: in PostgreSQL 9.0 the returned blobs are hexencoded by default - see http://www.postgresql.org/docs/9.0/static/runtime-config-client.html#GUC-BYTEA-OUTPUT
816                         $row[$blob] = $row[$blob] !== null ? pg_unescape_bytea($row[$blob]) : null;
817                     }
818                 }
819                 if (isset($return[$id])) {
820                     $colname = key($row);
821                     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);
822                 }
823                 $return[$id] = (object)$row;
824             }
825         }
827         return $return;
828     }
830     /**
831      * Selects records and return values (first field) as an array using a SQL statement.
832      *
833      * @param string $sql The SQL query
834      * @param array $params array of sql parameters
835      * @return array of values
836      * @throws dml_exception A DML specific exception is thrown for any errors.
837      */
838     public function get_fieldset_sql($sql, array $params=null) {
839         list($sql, $params, $type) = $this->fix_sql_params($sql, $params);
841         $this->query_start($sql, $params, SQL_QUERY_SELECT);
842         $result = pg_query_params($this->pgsql, $sql, $params);
843         $this->query_end($result);
845         $return = pg_fetch_all_columns($result, 0);
846         pg_free_result($result);
848         return $return;
849     }
851     /**
852      * Insert new record into database, as fast as possible, no safety checks, lobs not supported.
853      * @param string $table name
854      * @param mixed $params data record as object or array
855      * @param bool $returnit return it of inserted record
856      * @param bool $bulk true means repeated inserts expected
857      * @param bool $customsequence true if 'id' included in $params, disables $returnid
858      * @return bool|int true or new id
859      * @throws dml_exception A DML specific exception is thrown for any errors.
860      */
861     public function insert_record_raw($table, $params, $returnid=true, $bulk=false, $customsequence=false) {
862         if (!is_array($params)) {
863             $params = (array)$params;
864         }
866         $returning = "";
868         if ($customsequence) {
869             if (!isset($params['id'])) {
870                 throw new coding_exception('moodle_database::insert_record_raw() id field must be specified if custom sequences used.');
871             }
872             $returnid = false;
873         } else {
874             if ($returnid) {
875                 $returning = "RETURNING id";
876                 unset($params['id']);
877             } else {
878                 unset($params['id']);
879             }
880         }
882         if (empty($params)) {
883             throw new coding_exception('moodle_database::insert_record_raw() no fields found.');
884         }
886         $fields = implode(',', array_keys($params));
887         $values = array();
888         $i = 1;
889         foreach ($params as $value) {
890             $this->detect_objects($value);
891             $values[] = "\$".$i++;
892         }
893         $values = implode(',', $values);
895         $sql = "INSERT INTO {$this->prefix}$table ($fields) VALUES($values) $returning";
896         $this->query_start($sql, $params, SQL_QUERY_INSERT);
897         $result = pg_query_params($this->pgsql, $sql, $params);
898         $this->query_end($result);
900         if ($returning !== "") {
901             $row = pg_fetch_assoc($result);
902             $params['id'] = reset($row);
903         }
904         pg_free_result($result);
906         if (!$returnid) {
907             return true;
908         }
910         return (int)$params['id'];
911     }
913     /**
914      * Insert a record into a table and return the "id" field if required.
915      *
916      * Some conversions and safety checks are carried out. Lobs are supported.
917      * If the return ID isn't required, then this just reports success as true/false.
918      * $data is an object containing needed data
919      * @param string $table The database table to be inserted into
920      * @param object $data A data object with values for one or more fields in the record
921      * @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.
922      * @return bool|int true or new id
923      * @throws dml_exception A DML specific exception is thrown for any errors.
924      */
925     public function insert_record($table, $dataobject, $returnid=true, $bulk=false) {
926         $dataobject = (array)$dataobject;
928         $columns = $this->get_columns($table);
929         if (empty($columns)) {
930             throw new dml_exception('ddltablenotexist', $table);
931         }
933         $cleaned = array();
934         $blobs   = array();
936         foreach ($dataobject as $field=>$value) {
937             if ($field === 'id') {
938                 continue;
939             }
940             if (!isset($columns[$field])) {
941                 continue;
942             }
943             $column = $columns[$field];
944             $normalised_value = $this->normalise_value($column, $value);
945             if (is_array($normalised_value) && array_key_exists('blob', $normalised_value)) {
946                 $cleaned[$field] = '@#BLOB#@';
947                 $blobs[$field] = $normalised_value['blob'];
948             } else {
949                 $cleaned[$field] = $normalised_value;
950             }
951         }
953         if (empty($blobs)) {
954             return $this->insert_record_raw($table, $cleaned, $returnid, $bulk);
955         }
957         $id = $this->insert_record_raw($table, $cleaned, true, $bulk);
959         foreach ($blobs as $key=>$value) {
960             $value = pg_escape_bytea($this->pgsql, $value);
961             $sql = "UPDATE {$this->prefix}$table SET $key = '$value'::bytea WHERE id = $id";
962             $this->query_start($sql, NULL, SQL_QUERY_UPDATE);
963             $result = pg_query($this->pgsql, $sql);
964             $this->query_end($result);
965             if ($result !== false) {
966                 pg_free_result($result);
967             }
968         }
970         return ($returnid ? $id : true);
972     }
974     /**
975      * Insert multiple records into database as fast as possible.
976      *
977      * Order of inserts is maintained, but the operation is not atomic,
978      * use transactions if necessary.
979      *
980      * This method is intended for inserting of large number of small objects,
981      * do not use for huge objects with text or binary fields.
982      *
983      * @since Moodle 2.7
984      *
985      * @param string $table  The database table to be inserted into
986      * @param array|Traversable $dataobjects list of objects to be inserted, must be compatible with foreach
987      * @return void does not return new record ids
988      *
989      * @throws coding_exception if data objects have different structure
990      * @throws dml_exception A DML specific exception is thrown for any errors.
991      */
992     public function insert_records($table, $dataobjects) {
993         if (!is_array($dataobjects) and !($dataobjects instanceof Traversable)) {
994             throw new coding_exception('insert_records() passed non-traversable object');
995         }
997         // PostgreSQL does not seem to have problems with huge queries.
998         $chunksize = 500;
999         if (!empty($this->dboptions['bulkinsertsize'])) {
1000             $chunksize = (int)$this->dboptions['bulkinsertsize'];
1001         }
1003         $columns = $this->get_columns($table, true);
1005         // Make sure there are no nasty blobs!
1006         foreach ($columns as $column) {
1007             if ($column->binary) {
1008                 parent::insert_records($table, $dataobjects);
1009                 return;
1010             }
1011         }
1013         $fields = null;
1014         $count = 0;
1015         $chunk = array();
1016         foreach ($dataobjects as $dataobject) {
1017             if (!is_array($dataobject) and !is_object($dataobject)) {
1018                 throw new coding_exception('insert_records() passed invalid record object');
1019             }
1020             $dataobject = (array)$dataobject;
1021             if ($fields === null) {
1022                 $fields = array_keys($dataobject);
1023                 $columns = array_intersect_key($columns, $dataobject);
1024                 unset($columns['id']);
1025             } else if ($fields !== array_keys($dataobject)) {
1026                 throw new coding_exception('All dataobjects in insert_records() must have the same structure!');
1027             }
1029             $count++;
1030             $chunk[] = $dataobject;
1032             if ($count === $chunksize) {
1033                 $this->insert_chunk($table, $chunk, $columns);
1034                 $chunk = array();
1035                 $count = 0;
1036             }
1037         }
1039         if ($count) {
1040             $this->insert_chunk($table, $chunk, $columns);
1041         }
1042     }
1044     /**
1045      * Insert records in chunks, no binary support, strict param types...
1046      *
1047      * Note: can be used only from insert_records().
1048      *
1049      * @param string $table
1050      * @param array $chunk
1051      * @param database_column_info[] $columns
1052      */
1053     protected function insert_chunk($table, array $chunk, array $columns) {
1054         $i = 1;
1055         $params = array();
1056         $values = array();
1057         foreach ($chunk as $dataobject) {
1058             $vals = array();
1059             foreach ($columns as $field => $column) {
1060                 $params[] = $this->normalise_value($column, $dataobject[$field]);
1061                 $vals[] = "\$".$i++;
1062             }
1063             $values[] = '('.implode(',', $vals).')';
1064         }
1066         $fieldssql = '('.implode(',', array_keys($columns)).')';
1067         $valuessql = implode(',', $values);
1069         $sql = "INSERT INTO {$this->prefix}$table $fieldssql VALUES $valuessql";
1070         $this->query_start($sql, $params, SQL_QUERY_INSERT);
1071         $result = pg_query_params($this->pgsql, $sql, $params);
1072         $this->query_end($result);
1073         pg_free_result($result);
1074     }
1076     /**
1077      * Import a record into a table, id field is required.
1078      * Safety checks are NOT carried out. Lobs are supported.
1079      *
1080      * @param string $table name of database table to be inserted into
1081      * @param object $dataobject A data object with values for one or more fields in the record
1082      * @return bool true
1083      * @throws dml_exception A DML specific exception is thrown for any errors.
1084      */
1085     public function import_record($table, $dataobject) {
1086         $dataobject = (array)$dataobject;
1088         $columns = $this->get_columns($table);
1089         $cleaned = array();
1090         $blobs   = array();
1092         foreach ($dataobject as $field=>$value) {
1093             $this->detect_objects($value);
1094             if (!isset($columns[$field])) {
1095                 continue;
1096             }
1097             if ($columns[$field]->meta_type === 'B') {
1098                 if (!is_null($value)) {
1099                     $cleaned[$field] = '@#BLOB#@';
1100                     $blobs[$field] = $value;
1101                     continue;
1102                 }
1103             }
1105             $cleaned[$field] = $value;
1106         }
1108         $this->insert_record_raw($table, $cleaned, false, true, true);
1109         $id = $dataobject['id'];
1111         foreach ($blobs as $key=>$value) {
1112             $value = pg_escape_bytea($this->pgsql, $value);
1113             $sql = "UPDATE {$this->prefix}$table SET $key = '$value'::bytea WHERE id = $id";
1114             $this->query_start($sql, NULL, SQL_QUERY_UPDATE);
1115             $result = pg_query($this->pgsql, $sql);
1116             $this->query_end($result);
1117             if ($result !== false) {
1118                 pg_free_result($result);
1119             }
1120         }
1122         return true;
1123     }
1125     /**
1126      * Update record in database, as fast as possible, no safety checks, lobs not supported.
1127      * @param string $table name
1128      * @param mixed $params data record as object or array
1129      * @param bool true means repeated updates expected
1130      * @return bool true
1131      * @throws dml_exception A DML specific exception is thrown for any errors.
1132      */
1133     public function update_record_raw($table, $params, $bulk=false) {
1134         $params = (array)$params;
1136         if (!isset($params['id'])) {
1137             throw new coding_exception('moodle_database::update_record_raw() id field must be specified.');
1138         }
1139         $id = $params['id'];
1140         unset($params['id']);
1142         if (empty($params)) {
1143             throw new coding_exception('moodle_database::update_record_raw() no fields found.');
1144         }
1146         $i = 1;
1148         $sets = array();
1149         foreach ($params as $field=>$value) {
1150             $this->detect_objects($value);
1151             $sets[] = "$field = \$".$i++;
1152         }
1154         $params[] = $id; // last ? in WHERE condition
1156         $sets = implode(',', $sets);
1157         $sql = "UPDATE {$this->prefix}$table SET $sets WHERE id=\$".$i;
1159         $this->query_start($sql, $params, SQL_QUERY_UPDATE);
1160         $result = pg_query_params($this->pgsql, $sql, $params);
1161         $this->query_end($result);
1163         pg_free_result($result);
1164         return true;
1165     }
1167     /**
1168      * Update a record in a table
1169      *
1170      * $dataobject is an object containing needed data
1171      * Relies on $dataobject having a variable "id" to
1172      * specify the record to update
1173      *
1174      * @param string $table The database table to be checked against.
1175      * @param object $dataobject An object with contents equal to fieldname=>fieldvalue. Must have an entry for 'id' to map to the table specified.
1176      * @param bool true means repeated updates expected
1177      * @return bool true
1178      * @throws dml_exception A DML specific exception is thrown for any errors.
1179      */
1180     public function update_record($table, $dataobject, $bulk=false) {
1181         $dataobject = (array)$dataobject;
1183         $columns = $this->get_columns($table);
1184         $cleaned = array();
1185         $blobs   = array();
1187         foreach ($dataobject as $field=>$value) {
1188             if (!isset($columns[$field])) {
1189                 continue;
1190             }
1191             $column = $columns[$field];
1192             $normalised_value = $this->normalise_value($column, $value);
1193             if (is_array($normalised_value) && array_key_exists('blob', $normalised_value)) {
1194                 $cleaned[$field] = '@#BLOB#@';
1195                 $blobs[$field] = $normalised_value['blob'];
1196             } else {
1197                 $cleaned[$field] = $normalised_value;
1198             }
1199         }
1201         $this->update_record_raw($table, $cleaned, $bulk);
1203         if (empty($blobs)) {
1204             return true;
1205         }
1207         $id = (int)$dataobject['id'];
1209         foreach ($blobs as $key=>$value) {
1210             $value = pg_escape_bytea($this->pgsql, $value);
1211             $sql = "UPDATE {$this->prefix}$table SET $key = '$value'::bytea WHERE id = $id";
1212             $this->query_start($sql, NULL, SQL_QUERY_UPDATE);
1213             $result = pg_query($this->pgsql, $sql);
1214             $this->query_end($result);
1216             pg_free_result($result);
1217         }
1219         return true;
1220     }
1222     /**
1223      * Set a single field in every table record which match a particular WHERE clause.
1224      *
1225      * @param string $table The database table to be checked against.
1226      * @param string $newfield the field to set.
1227      * @param string $newvalue the value to set the field to.
1228      * @param string $select A fragment of SQL to be used in a where clause in the SQL call.
1229      * @param array $params array of sql parameters
1230      * @return bool true
1231      * @throws dml_exception A DML specific exception is thrown for any errors.
1232      */
1233     public function set_field_select($table, $newfield, $newvalue, $select, array $params=null) {
1235         if ($select) {
1236             $select = "WHERE $select";
1237         }
1238         if (is_null($params)) {
1239             $params = array();
1240         }
1241         list($select, $params, $type) = $this->fix_sql_params($select, $params);
1242         $i = count($params)+1;
1244         // Get column metadata
1245         $columns = $this->get_columns($table);
1246         $column = $columns[$newfield];
1248         $normalised_value = $this->normalise_value($column, $newvalue);
1249         if (is_array($normalised_value) && array_key_exists('blob', $normalised_value)) {
1250             // Update BYTEA and return
1251             $normalised_value = pg_escape_bytea($this->pgsql, $normalised_value['blob']);
1252             $sql = "UPDATE {$this->prefix}$table SET $newfield = '$normalised_value'::bytea $select";
1253             $this->query_start($sql, NULL, SQL_QUERY_UPDATE);
1254             $result = pg_query_params($this->pgsql, $sql, $params);
1255             $this->query_end($result);
1256             pg_free_result($result);
1257             return true;
1258         }
1260         if (is_null($normalised_value)) {
1261             $newfield = "$newfield = NULL";
1262         } else {
1263             $newfield = "$newfield = \$".$i;
1264             $params[] = $normalised_value;
1265         }
1266         $sql = "UPDATE {$this->prefix}$table SET $newfield $select";
1268         $this->query_start($sql, $params, SQL_QUERY_UPDATE);
1269         $result = pg_query_params($this->pgsql, $sql, $params);
1270         $this->query_end($result);
1272         pg_free_result($result);
1274         return true;
1275     }
1277     /**
1278      * Delete one or more records from a table which match a particular WHERE clause.
1279      *
1280      * @param string $table The database table to be checked against.
1281      * @param string $select A fragment of SQL to be used in a where clause in the SQL call (used to define the selection criteria).
1282      * @param array $params array of sql parameters
1283      * @return bool true
1284      * @throws dml_exception A DML specific exception is thrown for any errors.
1285      */
1286     public function delete_records_select($table, $select, array $params=null) {
1287         if ($select) {
1288             $select = "WHERE $select";
1289         }
1290         $sql = "DELETE FROM {$this->prefix}$table $select";
1292         list($sql, $params, $type) = $this->fix_sql_params($sql, $params);
1294         $this->query_start($sql, $params, SQL_QUERY_UPDATE);
1295         $result = pg_query_params($this->pgsql, $sql, $params);
1296         $this->query_end($result);
1298         pg_free_result($result);
1300         return true;
1301     }
1303     /**
1304      * Returns 'LIKE' part of a query.
1305      *
1306      * @param string $fieldname usually name of the table column
1307      * @param string $param usually bound query parameter (?, :named)
1308      * @param bool $casesensitive use case sensitive search
1309      * @param bool $accensensitive use accent sensitive search (not all databases support accent insensitive)
1310      * @param bool $notlike true means "NOT LIKE"
1311      * @param string $escapechar escape char for '%' and '_'
1312      * @return string SQL code fragment
1313      */
1314     public function sql_like($fieldname, $param, $casesensitive = true, $accentsensitive = true, $notlike = false, $escapechar = '\\') {
1315         if (strpos($param, '%') !== false) {
1316             debugging('Potential SQL injection detected, sql_like() expects bound parameters (? or :named)');
1317         }
1318         if ($escapechar === '\\') {
1319             // Prevents problems with C-style escapes of enclosing '\',
1320             // E'... bellow prevents compatibility warnings.
1321             $escapechar = '\\\\';
1322         }
1324         // postgresql does not support accent insensitive text comparisons, sorry
1325         if ($casesensitive) {
1326             $LIKE = $notlike ? 'NOT LIKE' : 'LIKE';
1327         } else {
1328             $LIKE = $notlike ? 'NOT ILIKE' : 'ILIKE';
1329         }
1330         return "$fieldname $LIKE $param ESCAPE E'$escapechar'";
1331     }
1333     public function sql_bitxor($int1, $int2) {
1334         return '((' . $int1 . ') # (' . $int2 . '))';
1335     }
1337     public function sql_cast_char2int($fieldname, $text=false) {
1338         return ' CAST(' . $fieldname . ' AS INT) ';
1339     }
1341     public function sql_cast_char2real($fieldname, $text=false) {
1342         return " $fieldname::real ";
1343     }
1345     public function sql_concat() {
1346         $arr = func_get_args();
1347         $s = implode(' || ', $arr);
1348         if ($s === '') {
1349             return " '' ";
1350         }
1351         // Add always empty string element so integer-exclusive concats
1352         // will work without needing to cast each element explicitly
1353         return " '' || $s ";
1354     }
1356     public function sql_concat_join($separator="' '", $elements=array()) {
1357         for ($n=count($elements)-1; $n > 0 ; $n--) {
1358             array_splice($elements, $n, 0, $separator);
1359         }
1360         $s = implode(' || ', $elements);
1361         if ($s === '') {
1362             return " '' ";
1363         }
1364         return " $s ";
1365     }
1367     public function sql_regex_supported() {
1368         return true;
1369     }
1371     public function sql_regex($positivematch=true) {
1372         return $positivematch ? '~*' : '!~*';
1373     }
1375     /**
1376      * Does this driver support tool_replace?
1377      *
1378      * @since Moodle 2.6.1
1379      * @return bool
1380      */
1381     public function replace_all_text_supported() {
1382         return true;
1383     }
1385     public function session_lock_supported() {
1386         return true;
1387     }
1389     /**
1390      * Obtain session lock
1391      * @param int $rowid id of the row with session record
1392      * @param int $timeout max allowed time to wait for the lock in seconds
1393      * @return bool success
1394      */
1395     public function get_session_lock($rowid, $timeout) {
1396         // NOTE: there is a potential locking problem for database running
1397         //       multiple instances of moodle, we could try to use pg_advisory_lock(int, int),
1398         //       luckily there is not a big chance that they would collide
1399         if (!$this->session_lock_supported()) {
1400             return;
1401         }
1403         parent::get_session_lock($rowid, $timeout);
1405         $timeoutmilli = $timeout * 1000;
1407         $sql = "SET statement_timeout TO $timeoutmilli";
1408         $this->query_start($sql, null, SQL_QUERY_AUX);
1409         $result = pg_query($this->pgsql, $sql);
1410         $this->query_end($result);
1412         if ($result) {
1413             pg_free_result($result);
1414         }
1416         $sql = "SELECT pg_advisory_lock($rowid)";
1417         $this->query_start($sql, null, SQL_QUERY_AUX);
1418         $start = time();
1419         $result = pg_query($this->pgsql, $sql);
1420         $end = time();
1421         try {
1422             $this->query_end($result);
1423         } catch (dml_exception $ex) {
1424             if ($end - $start >= $timeout) {
1425                 throw new dml_sessionwait_exception();
1426             } else {
1427                 throw $ex;
1428             }
1429         }
1431         if ($result) {
1432             pg_free_result($result);
1433         }
1435         $sql = "SET statement_timeout TO DEFAULT";
1436         $this->query_start($sql, null, SQL_QUERY_AUX);
1437         $result = pg_query($this->pgsql, $sql);
1438         $this->query_end($result);
1440         if ($result) {
1441             pg_free_result($result);
1442         }
1443     }
1445     public function release_session_lock($rowid) {
1446         if (!$this->session_lock_supported()) {
1447             return;
1448         }
1449         if (!$this->used_for_db_sessions) {
1450             return;
1451         }
1453         parent::release_session_lock($rowid);
1455         $sql = "SELECT pg_advisory_unlock($rowid)";
1456         $this->query_start($sql, null, SQL_QUERY_AUX);
1457         $result = pg_query($this->pgsql, $sql);
1458         $this->query_end($result);
1460         if ($result) {
1461             pg_free_result($result);
1462         }
1463     }
1465     /**
1466      * Driver specific start of real database transaction,
1467      * this can not be used directly in code.
1468      * @return void
1469      */
1470     protected function begin_transaction() {
1471         $this->savepointpresent = true;
1472         $sql = "BEGIN ISOLATION LEVEL READ COMMITTED; SAVEPOINT moodle_pg_savepoint";
1473         $this->query_start($sql, NULL, SQL_QUERY_AUX);
1474         $result = pg_query($this->pgsql, $sql);
1475         $this->query_end($result);
1477         pg_free_result($result);
1478     }
1480     /**
1481      * Driver specific commit of real database transaction,
1482      * this can not be used directly in code.
1483      * @return void
1484      */
1485     protected function commit_transaction() {
1486         $this->savepointpresent = false;
1487         $sql = "RELEASE SAVEPOINT moodle_pg_savepoint; COMMIT";
1488         $this->query_start($sql, NULL, SQL_QUERY_AUX);
1489         $result = pg_query($this->pgsql, $sql);
1490         $this->query_end($result);
1492         pg_free_result($result);
1493     }
1495     /**
1496      * Driver specific abort of real database transaction,
1497      * this can not be used directly in code.
1498      * @return void
1499      */
1500     protected function rollback_transaction() {
1501         $this->savepointpresent = false;
1502         $sql = "RELEASE SAVEPOINT moodle_pg_savepoint; ROLLBACK";
1503         $this->query_start($sql, NULL, SQL_QUERY_AUX);
1504         $result = pg_query($this->pgsql, $sql);
1505         $this->query_end($result);
1507         pg_free_result($result);
1508     }
1510     /**
1511      * Helper function trimming (whitespace + quotes) any string
1512      * needed because PG uses to enclose with double quotes some
1513      * fields in indexes definition and others
1514      *
1515      * @param string $str string to apply whitespace + quotes trim
1516      * @return string trimmed string
1517      */
1518     private function trim_quotes($str) {
1519         return trim(trim($str), "'\"");
1520     }