dolibarr 20.0.5
pgsql.class.php
Go to the documentation of this file.
1<?php
2/* Copyright (C) 2001 Fabien Seisen <seisen@linuxfr.org>
3 * Copyright (C) 2002-2005 Rodolphe Quiedeville <rodolphe@quiedeville.org>
4 * Copyright (C) 2004-2014 Laurent Destailleur <eldy@users.sourceforge.net>
5 * Copyright (C) 2004 Sebastien Di Cintio <sdicintio@ressource-toi.org>
6 * Copyright (C) 2004 Benoit Mortier <benoit.mortier@opensides.be>
7 * Copyright (C) 2005-2012 Regis Houssin <regis.houssin@inodbox.com>
8 * Copyright (C) 2012 Yann Droneaud <yann@droneaud.fr>
9 * Copyright (C) 2012 Florian Henry <florian.henry@open-concept.pro>
10 * Copyright (C) 2015 Marcos García <marcosgdf@gmail.com>
11 * Copyright (C) 2024 MDW <mdeweerd@users.noreply.github.com>
12 *
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation; either version 3 of the License, or
16 * (at your option) any later version.
17 *
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
22 *
23 * You should have received a copy of the GNU General Public License
24 * along with this program. If not, see <https://www.gnu.org/licenses/>.
25 */
26
32require_once DOL_DOCUMENT_ROOT.'/core/db/DoliDB.class.php';
33
37class DoliDBPgsql extends DoliDB
38{
40 public $type = 'pgsql'; // Name of manager
41
43 const LABEL = 'PostgreSQL'; // Label of manager
44
46 public $forcecharset = 'UTF8'; // Can't be static as it may be forced with a dynamic value
47
49 public $forcecollate = ''; // Can't be static as it may be forced with a dynamic value
50
52 const VERSIONMIN = '9.0.0'; // Version min database
53
57 public $unescapeslashquot = false;
61 public $standard_conforming_strings = false;
62
63
65 private $_results;
66
67
68
80 public function __construct($type, $host, $user, $pass, $name = '', $port = 0)
81 {
82 global $conf, $langs;
83
84 // Note that having "static" property for "$forcecharset" and "$forcecollate" will make error here in strict mode, so they are not static
85 if (!empty($conf->db->character_set)) {
86 $this->forcecharset = $conf->db->character_set;
87 }
88 if (!empty($conf->db->dolibarr_main_db_collation)) {
89 $this->forcecollate = $conf->db->dolibarr_main_db_collation;
90 }
91
92 $this->database_user = $user;
93 $this->database_host = $host;
94 $this->database_port = $port;
95
96 $this->transaction_opened = 0;
97
98 //print "Name DB: $host,$user,$pass,$name<br>";
99
100 if (!function_exists("pg_connect")) {
101 $this->connected = false;
102 $this->ok = false;
103 $this->error = "Pgsql PHP functions are not available in this version of PHP";
104 dol_syslog(get_class($this)."::DoliDBPgsql : Pgsql PHP functions are not available in this version of PHP", LOG_ERR);
105 return;
106 }
107
108 if (!$host) {
109 $this->connected = false;
110 $this->ok = false;
111 $this->error = $langs->trans("ErrorWrongHostParameter");
112 dol_syslog(get_class($this)."::DoliDBPgsql : Erreur Connect, wrong host parameters", LOG_ERR);
113 return;
114 }
115
116 // Essai connection serveur
117 //print "$host, $user, $pass, $name, $port";
118 $this->db = $this->connect($host, $user, $pass, $name, $port);
119
120 if ($this->db) {
121 $this->connected = true;
122 $this->ok = true;
123 } else {
124 // host, login ou password incorrect
125 $this->connected = false;
126 $this->ok = false;
127 $this->error = 'Host, login or password incorrect';
128 dol_syslog(get_class($this)."::DoliDBPgsql : Erreur Connect ".$this->error.'. Failed to connect to host='.$host.' port='.$port.' user='.$user, LOG_ERR);
129 }
130
131 // If server connection serveur ok and DB connection is requested, try to connect to DB
132 if ($this->connected && $name) {
133 if ($this->select_db($name)) {
134 $this->database_selected = true;
135 $this->database_name = $name;
136 $this->ok = true;
137 } else {
138 $this->database_selected = false;
139 $this->database_name = '';
140 $this->ok = false;
141 $this->error = $this->error();
142 dol_syslog(get_class($this)."::DoliDBPgsql : Erreur Select_db ".$this->error, LOG_ERR);
143 }
144 } else {
145 // Pas de selection de base demandee, ok ou ko
146 $this->database_selected = false;
147 }
148 }
149
150
159 public function convertSQLFromMysql($line, $type = 'auto', $unescapeslashquot = false)
160 {
161 global $conf;
162
163 // Removed empty line if this is a comment line for SVN tagging
164 if (preg_match('/^--\s\$Id/i', $line)) {
165 return '';
166 }
167 // Return line if this is a comment
168 if (preg_match('/^#/i', $line) || preg_match('/^$/i', $line) || preg_match('/^--/i', $line)) {
169 return $line;
170 }
171 if ($line != "") {
172 // group_concat support (PgSQL >= 9.0)
173 // Replace group_concat(x) or group_concat(x SEPARATOR ',') with string_agg(x, ',')
174 $line = preg_replace('/GROUP_CONCAT/i', 'STRING_AGG', $line);
175 $line = preg_replace('/ SEPARATOR/i', ',', $line);
176 $line = preg_replace('/STRING_AGG\‍(([^,\‍)]+)\‍)/i', 'STRING_AGG(\\1, \',\')', $line);
177 //print $line."\n";
178
179 if ($type == 'auto') {
180 if (preg_match('/ALTER TABLE/i', $line)) {
181 $type = 'dml';
182 } elseif (preg_match('/CREATE TABLE/i', $line)) {
183 $type = 'dml';
184 } elseif (preg_match('/DROP TABLE/i', $line)) {
185 $type = 'dml';
186 }
187 }
188
189 $line = preg_replace('/ as signed\‍)/i', ' as integer)', $line);
190
191 if ($type == 'dml') {
192 $reg = array();
193
194 $line = preg_replace('/\s/', ' ', $line); // Replace tabulation with space
195
196 // we are inside create table statement so lets process datatypes
197 if (preg_match('/(ISAM|innodb)/i', $line)) { // end of create table sequence
198 $line = preg_replace('/\‍)[\s\t]*type[\s\t]*=[\s\t]*(MyISAM|innodb).*;/i', ');', $line);
199 $line = preg_replace('/\‍)[\s\t]*engine[\s\t]*=[\s\t]*(MyISAM|innodb).*;/i', ');', $line);
200 $line = preg_replace('/,$/', '', $line);
201 }
202
203 // Process case: "CREATE TABLE llx_mytable(rowid integer NOT NULL AUTO_INCREMENT PRIMARY KEY,code..."
204 if (preg_match('/[\s\t\‍(]*(\w*)[\s\t]+int.*auto_increment/i', $line, $reg)) {
205 $newline = preg_replace('/([\s\t\‍(]*)([a-zA-Z_0-9]*)[\s\t]+int.*auto_increment[^,]*/i', '\\1 \\2 SERIAL PRIMARY KEY', $line);
206 //$line = "-- ".$line." replaced by --\n".$newline;
207 $line = $newline;
208 }
209
210 if (preg_match('/[\s\t\‍(]*(\w*)[\s\t]+bigint.*auto_increment/i', $line, $reg)) {
211 $newline = preg_replace('/([\s\t\‍(]*)([a-zA-Z_0-9]*)[\s\t]+bigint.*auto_increment[^,]*/i', '\\1 \\2 BIGSERIAL PRIMARY KEY', $line);
212 //$line = "-- ".$line." replaced by --\n".$newline;
213 $line = $newline;
214 }
215
216 // tinyint type conversion
217 $line = preg_replace('/tinyint\‍(?[0-9]*\‍)?/', 'smallint', $line);
218 $line = preg_replace('/tinyint/i', 'smallint', $line);
219
220 // nuke unsigned
221 $line = preg_replace('/(int\w+|smallint|bigint)\s+unsigned/i', '\\1', $line);
222
223 // blob -> text
224 $line = preg_replace('/\w*blob/i', 'text', $line);
225
226 // tinytext/mediumtext -> text
227 $line = preg_replace('/tinytext/i', 'text', $line);
228 $line = preg_replace('/mediumtext/i', 'text', $line);
229 $line = preg_replace('/longtext/i', 'text', $line);
230
231 $line = preg_replace('/text\‍([0-9]+\‍)/i', 'text', $line);
232
233 // change not null datetime field to null valid ones
234 // (to support remapping of "zero time" to null
235 $line = preg_replace('/datetime not null/i', 'datetime', $line);
236 $line = preg_replace('/datetime/i', 'timestamp', $line);
237
238 // double -> numeric
239 $line = preg_replace('/^double/i', 'numeric', $line);
240 $line = preg_replace('/(\s*)double/i', '\\1numeric', $line);
241 // float -> numeric
242 $line = preg_replace('/^float/i', 'numeric', $line);
243 $line = preg_replace('/(\s*)float/i', '\\1numeric', $line);
244
245 //Check tms timestamp field case (in Mysql this field is defaulted to now and
246 // on update defaulted by now
247 $line = preg_replace('/(\s*)tms(\s*)timestamp/i', '\\1tms timestamp without time zone DEFAULT now() NOT NULL', $line);
248
249 // nuke DEFAULT CURRENT_TIMESTAMP
250 $line = preg_replace('/(\s*)DEFAULT(\s*)CURRENT_TIMESTAMP/i', '\\1', $line);
251
252 // nuke ON UPDATE CURRENT_TIMESTAMP
253 $line = preg_replace('/(\s*)ON(\s*)UPDATE(\s*)CURRENT_TIMESTAMP/i', '\\1', $line);
254
255 // unique index(field1,field2)
256 if (preg_match('/unique index\s*\‍((\w+\s*,\s*\w+)\‍)/i', $line)) {
257 $line = preg_replace('/unique index\s*\‍((\w+\s*,\s*\w+)\‍)/i', 'UNIQUE\‍(\\1\‍)', $line);
258 }
259
260 // We remove end of requests "AFTER fieldxxx"
261 $line = preg_replace('/\sAFTER [a-z0-9_]+/i', '', $line);
262
263 // We remove start of requests "ALTER TABLE tablexxx" if this is a DROP INDEX
264 $line = preg_replace('/ALTER TABLE [a-z0-9_]+\s+DROP INDEX/i', 'DROP INDEX', $line);
265
266 // Translate order to rename fields
267 if (preg_match('/ALTER TABLE ([a-z0-9_]+)\s+CHANGE(?: COLUMN)? ([a-z0-9_]+) ([a-z0-9_]+)(.*)$/i', $line, $reg)) {
268 $line = "-- ".$line." replaced by --\n";
269 $line .= "ALTER TABLE ".$reg[1]." RENAME COLUMN ".$reg[2]." TO ".$reg[3];
270 }
271
272 // Translate order to modify field format
273 if (preg_match('/ALTER TABLE ([a-z0-9_]+)\s+MODIFY(?: COLUMN)? ([a-z0-9_]+) (.*)$/i', $line, $reg)) {
274 $line = "-- ".$line." replaced by --\n";
275 $newreg3 = $reg[3];
276 $newreg3 = preg_replace('/ DEFAULT NULL/i', '', $newreg3);
277 $newreg3 = preg_replace('/ NOT NULL/i', '', $newreg3);
278 $newreg3 = preg_replace('/ NULL/i', '', $newreg3);
279 $newreg3 = preg_replace('/ DEFAULT 0/i', '', $newreg3);
280 $newreg3 = preg_replace('/ DEFAULT \'?[0-9a-zA-Z_@]*\'?/i', '', $newreg3);
281 $line .= "ALTER TABLE ".$reg[1]." ALTER COLUMN ".$reg[2]." TYPE ".$newreg3;
282 // TODO Add alter to set default value or null/not null if there is this in $reg[3]
283 }
284
285 // alter table add primary key (field1, field2 ...) -> We remove the primary key name not accepted by PostGreSQL
286 // ALTER TABLE llx_dolibarr_modules ADD PRIMARY KEY pk_dolibarr_modules (numero, entity)
287 if (preg_match('/ALTER\s+TABLE\s*(.*)\s*ADD\s+PRIMARY\s+KEY\s*(.*)\s*\‍((.*)$/i', $line, $reg)) {
288 $line = "-- ".$line." replaced by --\n";
289 $line .= "ALTER TABLE ".$reg[1]." ADD PRIMARY KEY (".$reg[3];
290 }
291
292 // Translate order to drop primary keys
293 // ALTER TABLE llx_dolibarr_modules DROP PRIMARY KEY pk_xxx
294 if (preg_match('/ALTER\s+TABLE\s*(.*)\s*DROP\s+PRIMARY\s+KEY\s*([^;]+)$/i', $line, $reg)) {
295 $line = "-- ".$line." replaced by --\n";
296 $line .= "ALTER TABLE ".$reg[1]." DROP CONSTRAINT ".$reg[2];
297 }
298
299 // Translate order to drop foreign keys
300 // ALTER TABLE llx_dolibarr_modules DROP FOREIGN KEY fk_xxx
301 if (preg_match('/ALTER\s+TABLE\s*(.*)\s*DROP\s+FOREIGN\s+KEY\s*(.*)$/i', $line, $reg)) {
302 $line = "-- ".$line." replaced by --\n";
303 $line .= "ALTER TABLE ".$reg[1]." DROP CONSTRAINT ".$reg[2];
304 }
305
306 // Translate order to add foreign keys
307 // ALTER TABLE llx_tablechild ADD CONSTRAINT fk_tablechild_fk_fieldparent FOREIGN KEY (fk_fieldparent) REFERENCES llx_tableparent (rowid)
308 if (preg_match('/ALTER\s+TABLE\s+(.*)\s*ADD CONSTRAINT\s+(.*)\s*FOREIGN\s+KEY\s*(.*)$/i', $line, $reg)) {
309 $line = preg_replace('/;$/', '', $line);
310 $line .= " DEFERRABLE INITIALLY IMMEDIATE;";
311 }
312
313 // alter table add [unique] [index] (field1, field2 ...)
314 // ALTER TABLE llx_accountingaccount ADD INDEX idx_accountingaccount_fk_pcg_version (fk_pcg_version)
315 if (preg_match('/ALTER\s+TABLE\s*(.*)\s*ADD\s+(UNIQUE INDEX|INDEX|UNIQUE)\s+(.*)\s*\‍(([\w,\s]+)\‍)/i', $line, $reg)) {
316 $fieldlist = $reg[4];
317 $idxname = $reg[3];
318 $tablename = $reg[1];
319 $line = "-- ".$line." replaced by --\n";
320 $line .= "CREATE ".(preg_match('/UNIQUE/', $reg[2]) ? 'UNIQUE ' : '')."INDEX ".$idxname." ON ".$tablename." (".$fieldlist.")";
321 }
322 }
323
324 // To have PostgreSQL case sensitive
325 $count_like = 0;
326 $line = str_replace(' LIKE \'', ' ILIKE \'', $line, $count_like);
327 if (getDolGlobalString('PSQL_USE_UNACCENT') && $count_like > 0) {
328 // @see https://docs.PostgreSQL.fr/11/unaccent.html : 'unaccent()' function must be installed before
329 $line = preg_replace('/\s+(\‍(+\s*)([a-zA-Z0-9\-\_\.]+) ILIKE /', ' \1unaccent(\2) ILIKE ', $line);
330 }
331
332 $line = str_replace(' LIKE BINARY \'', ' LIKE \'', $line);
333
334 // Replace INSERT IGNORE into INSERT
335 $line = preg_replace('/^INSERT IGNORE/', 'INSERT', $line);
336
337 // Delete using criteria on other table must not declare twice the deleted table
338 // DELETE FROM tabletodelete USING tabletodelete, othertable -> DELETE FROM tabletodelete USING othertable
339 if (preg_match('/DELETE FROM ([a-z_]+) USING ([a-z_]+), ([a-z_]+)/i', $line, $reg)) {
340 if ($reg[1] == $reg[2]) { // If same table, we remove second one
341 $line = preg_replace('/DELETE FROM ([a-z_]+) USING ([a-z_]+), ([a-z_]+)/i', 'DELETE FROM \\1 USING \\3', $line);
342 }
343 }
344
345 // Remove () in the tables in FROM if 1 table
346 $line = preg_replace('/FROM\s*\‍((([a-z_]+)\s+as\s+([a-z_]+)\s*)\‍)/i', 'FROM \\1', $line);
347 //print $line."\n";
348
349 // Remove () in the tables in FROM if 2 table
350 $line = preg_replace('/FROM\s*\‍(([a-z_]+\s+as\s+[a-z_]+)\s*,\s*([a-z_]+\s+as\s+[a-z_]+\s*)\‍)/i', 'FROM \\1, \\2', $line);
351 //print $line."\n";
352
353 // Remove () in the tables in FROM if 3 table
354 $line = preg_replace('/FROM\s*\‍(([a-z_]+\s+as\s+[a-z_]+)\s*,\s*([a-z_]+\s+as\s+[a-z_]+\s*),\s*([a-z_]+\s+as\s+[a-z_]+\s*)\‍)/i', 'FROM \\1, \\2, \\3', $line);
355 //print $line."\n";
356
357 // Remove () in the tables in FROM if 4 table
358 $line = preg_replace('/FROM\s*\‍(([a-z_]+\s+as\s+[a-z_]+)\s*,\s*([a-z_]+\s+as\s+[a-z_]+\s*),\s*([a-z_]+\s+as\s+[a-z_]+\s*),\s*([a-z_]+\s+as\s+[a-z_]+\s*)\‍)/i', 'FROM \\1, \\2, \\3, \\4', $line);
359 //print $line."\n";
360
361 // Remove () in the tables in FROM if 5 table
362 $line = preg_replace('/FROM\s*\‍(([a-z_]+\s+as\s+[a-z_]+)\s*,\s*([a-z_]+\s+as\s+[a-z_]+\s*),\s*([a-z_]+\s+as\s+[a-z_]+\s*),\s*([a-z_]+\s+as\s+[a-z_]+\s*),\s*([a-z_]+\s+as\s+[a-z_]+\s*)\‍)/i', 'FROM \\1, \\2, \\3, \\4, \\5', $line);
363 //print $line."\n";
364
365 // Replace spacing ' with ''.
366 // By default we do not (should be already done by db->escape function if required
367 // except for sql insert in data file that are mysql escaped so we removed them to
368 // be compatible with standard_conforming_strings=on that considers \ as ordinary character).
369 if ($unescapeslashquot) {
370 $line = preg_replace("/\\\'/", "''", $line);
371 }
372
373 //print "type=".$type." newline=".$line."<br>\n";
374 }
375
376 return $line;
377 }
378
379 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
388 public function select_db($database)
389 {
390 // phpcs:enable
391 if ($database == $this->database_name) {
392 return true;
393 } else {
394 return false;
395 }
396 }
397
409 public function connect($host, $login, $passwd, $name, $port = 0)
410 {
411 // use pg_pconnect() instead of pg_connect() if you want to use persistent connection costing 1ms, instead of 30ms for non persistent
412
413 $this->db = false;
414
415 // connections parameters must be protected (only \ and ' according to pg_connect() manual)
416 $host = str_replace(array("\\", "'"), array("\\\\", "\\'"), $host);
417 $login = str_replace(array("\\", "'"), array("\\\\", "\\'"), $login);
418 $passwd = str_replace(array("\\", "'"), array("\\\\", "\\'"), $passwd);
419 $name = str_replace(array("\\", "'"), array("\\\\", "\\'"), $name);
420 $port = str_replace(array("\\", "'"), array("\\\\", "\\'"), (string) $port);
421
422 if (!$name) {
423 $name = "postgres"; // When try to connect using admin user
424 }
425
426 // try first Unix domain socket (local)
427 if ((!empty($host) && $host == "socket") && !defined('NOLOCALSOCKETPGCONNECT')) {
428 $con_string = "dbname='".$name."' user='".$login."' password='".$passwd."'"; // $name may be empty
429 try {
430 // PGSQL_CONNECT_FORCE_NEW is required: pg_connect() otherwise returns the connection already
431 // opened for the same connection string, so a second handle would share the main one and
432 // closing it would close the connection still in use by the caller.
433 $this->db = @pg_connect($con_string, PGSQL_CONNECT_FORCE_NEW);
434 } catch (Exception $e) {
435 // No message
436 }
437 }
438
439 // if local connection failed or not requested, use TCP/IP
440 if (empty($this->db)) {
441 if (!$host) {
442 $host = "localhost";
443 }
444 if (!$port) {
445 $port = 5432;
446 }
447
448 $con_string = "host='".$host."' port='".$port."' dbname='".$name."' user='".$login."' password='".$passwd."'";
449 try {
450 $this->db = @pg_connect($con_string, PGSQL_CONNECT_FORCE_NEW);
451 } catch (Exception $e) {
452 print $e->getMessage();
453 }
454 }
455
456 // now we test if at least one connect method was a success
457 if ($this->db) {
458 $this->database_name = $name;
459 pg_set_error_verbosity($this->db, PGSQL_ERRORS_VERBOSE); // Set verbosity to max
460 pg_query($this->db, "set datestyle = 'ISO, YMD';");
461 }
462
463 return $this->db;
464 }
465
471 public function getVersion()
472 {
473 $resql = $this->query('SHOW server_version');
474 if ($resql) {
475 $liste = $this->fetch_array($resql);
476 return $liste['server_version'];
477 }
478 return '';
479 }
480
486 public function getDriverInfo()
487 {
488 return 'pgsql php driver';
489 }
490
497 public function close()
498 {
499 if ($this->db) {
500 if ($this->transaction_opened > 0) {
501 dol_syslog(get_class($this)."::close Closing a connection with an opened transaction depth=".$this->transaction_opened, LOG_ERR);
502 }
503 $this->connected = false;
504 return pg_close($this->db);
505 }
506 return false;
507 }
508
518 public function query($query, $usesavepoint = 0, $type = 'auto', $result_mode = 0)
519 {
520 global $dolibarr_main_db_readonly;
521
522 $query = trim($query);
523
524 // Convert MySQL syntax to PostgreSQL syntax
525 $query = $this->convertSQLFromMysql($query, $type, ($this->unescapeslashquot && $this->standard_conforming_strings));
526 //print "After convertSQLFromMysql:\n".$query."<br>\n";
527
528 if (getDolGlobalString('MAIN_DB_AUTOFIX_BAD_SQL_REQUEST')) {
529 // Fix bad formed requests. If request contains a date without quotes, we fix this but this should not occurs.
530 $loop = true;
531 while ($loop) {
532 if (preg_match('/([^\'])([0-9][0-9][0-9][0-9]-[0-9][0-9]-[0-9][0-9] [0-9][0-9]:[0-9][0-9]:[0-9][0-9])/', $query)) {
533 $query = preg_replace('/([^\'])([0-9][0-9][0-9][0-9]-[0-9][0-9]-[0-9][0-9] [0-9][0-9]:[0-9][0-9]:[0-9][0-9])/', '\\1\'\\2\'', $query);
534 dol_syslog("Warning: Bad formed request converted into ".$query, LOG_WARNING);
535 } else {
536 $loop = false;
537 }
538 }
539 }
540
541 if ($usesavepoint && $this->transaction_opened) {
542 @pg_query($this->db, 'SAVEPOINT mysavepoint');
543 }
544
545 if (!in_array($query, array('BEGIN', 'COMMIT', 'ROLLBACK'))) {
546 $SYSLOG_SQL_LIMIT = 10000; // limit log to 10kb per line to limit DOS attacks
547 dol_syslog('sql='.substr($query, 0, $SYSLOG_SQL_LIMIT), LOG_DEBUG);
548 }
549 if (empty($query)) {
550 return false; // Return false = error if empty request
551 }
552
553 if (!empty($dolibarr_main_db_readonly)) {
554 if (preg_match('/^(INSERT|UPDATE|REPLACE|DELETE|CREATE|ALTER|TRUNCATE|DROP)/i', $query)) {
555 $this->lasterror = 'Application in read-only mode';
556 $this->lasterrno = 'APPREADONLY';
557 $this->lastquery = $query;
558 return false;
559 }
560 }
561
562 $ret = @pg_query($this->db, $query);
563
564 //print $query;
565 if (!preg_match("/^COMMIT/i", $query) && !preg_match("/^ROLLBACK/i", $query)) { // Si requete utilisateur, on la sauvegarde ainsi que son resultset
566 if (!$ret) {
567 if ($this->errno() != 'DB_ERROR_25P02') { // Do not overwrite errors if this is a consecutive error
568 $this->lastqueryerror = $query;
569 $this->lasterror = $this->error();
570 $this->lasterrno = $this->errno();
571
572 if (getDolGlobalInt('SYSLOG_LEVEL') < LOG_DEBUG) {
573 dol_syslog(get_class($this)."::query SQL Error query: ".$query, LOG_ERR); // Log of request was not yet done previously
574 }
575 dol_syslog(get_class($this)."::query SQL Error message: ".$this->lasterror." (".$this->lasterrno.")", LOG_ERR);
576 dol_syslog(get_class($this)."::query SQL Error usesavepoint = ".$usesavepoint, LOG_ERR);
577 }
578
579 if ($usesavepoint && $this->transaction_opened) { // Warning, after that errno will be erased
580 @pg_query($this->db, 'ROLLBACK TO SAVEPOINT mysavepoint');
581 }
582 }
583 $this->lastquery = $query;
584 $this->_results = $ret;
585 }
586
587 return $ret;
588 }
589
590 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
597 public function fetch_object($resultset)
598 {
599 // phpcs:enable
600 // If resultset not provided, we take the last used by connection
601 if (!is_resource($resultset) && !is_object($resultset)) {
602 $resultset = $this->_results;
603 }
604 return pg_fetch_object($resultset);
605 }
606
607 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
614 public function fetch_array($resultset)
615 {
616 // phpcs:enable
617 // If resultset not provided, we take the last used by connection
618 if (!is_resource($resultset) && !is_object($resultset)) {
619 $resultset = $this->_results;
620 }
621 return pg_fetch_array($resultset);
622 }
623
624 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
631 public function fetch_row($resultset)
632 {
633 // phpcs:enable
634 // Si le resultset n'est pas fourni, on prend le dernier utilise sur cette connection
635 if (!is_resource($resultset) && !is_object($resultset)) {
636 $resultset = $this->_results;
637 }
638 return pg_fetch_row($resultset);
639 }
640
641 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
649 public function num_rows($resultset)
650 {
651 // phpcs:enable
652 // If resultset not provided, we take the last used by connection
653 if (!is_resource($resultset) && !is_object($resultset)) {
654 $resultset = $this->_results;
655 }
656 return pg_num_rows($resultset);
657 }
658
659 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
667 public function affected_rows($resultset)
668 {
669 // phpcs:enable
670 // If resultset not provided, we take the last used by connection
671 if (!is_resource($resultset) && !is_object($resultset)) {
672 $resultset = $this->_results;
673 }
674 // pgsql necessite un resultset pour cette fonction contrairement
675 // a mysql qui prend un link de base
676 return pg_affected_rows($resultset);
677 }
678
679
686 public function free($resultset = null)
687 {
688 // If resultset not provided, we take the last used by connection
689 if (!is_resource($resultset) && !is_object($resultset)) {
690 $resultset = $this->_results;
691 }
692 // Si resultset en est un, on libere la memoire
693 if (is_resource($resultset) || is_object($resultset)) {
694 pg_free_result($resultset);
695 }
696 }
697
698
706 public function plimit($limit = 0, $offset = 0)
707 {
708 global $conf;
709 if (empty($limit)) {
710 return "";
711 }
712 if ($limit < 0) {
713 $limit = $conf->liste_limit;
714 }
715 if ($offset > 0) {
716 return " LIMIT ".$limit." OFFSET ".$offset." ";
717 } else {
718 return " LIMIT $limit ";
719 }
720 }
721
722
729 public function escape($stringtoencode)
730 {
731 return pg_escape_string($this->db, $stringtoencode);
732 }
733
740 public function escapeforlike($stringtoencode)
741 {
742 return str_replace(array('\\', '_', '%'), array('\\\\', '\_', '\%'), (string) $stringtoencode);
743 }
744
753 public function ifsql($test, $resok, $resko)
754 {
755 return '(CASE WHEN '.$test.' THEN '.$resok.' ELSE '.$resko.' END)';
756 }
757
766 public function regexpsql($subject, $pattern, $sqlstring = 0)
767 {
768 if ($sqlstring) {
769 return "(". $subject ." ~ '" . $this->escape($pattern) . "')";
770 }
771
772 return "('". $this->escape($subject) ."' ~ '" . $this->escape($pattern) . "')";
773 }
774
775
781 public function errno()
782 {
783 if (!$this->connected) {
784 // Si il y a eu echec de connection, $this->db n'est pas valide.
785 return 'DB_ERROR_FAILED_TO_CONNECT';
786 } else {
787 // Constants to convert error code to a generic Dolibarr error code
788 $errorcode_map = array(
789 1004 => 'DB_ERROR_CANNOT_CREATE',
790 1005 => 'DB_ERROR_CANNOT_CREATE',
791 1006 => 'DB_ERROR_CANNOT_CREATE',
792 1007 => 'DB_ERROR_ALREADY_EXISTS',
793 1008 => 'DB_ERROR_CANNOT_DROP',
794 1025 => 'DB_ERROR_NO_FOREIGN_KEY_TO_DROP',
795 1044 => 'DB_ERROR_ACCESSDENIED',
796 1046 => 'DB_ERROR_NODBSELECTED',
797 1048 => 'DB_ERROR_CONSTRAINT',
798 '42P07' => 'DB_ERROR_TABLE_OR_KEY_ALREADY_EXISTS',
799 '42703' => 'DB_ERROR_NOSUCHFIELD',
800 1060 => 'DB_ERROR_COLUMN_ALREADY_EXISTS',
801 42701 => 'DB_ERROR_COLUMN_ALREADY_EXISTS',
802 '42710' => 'DB_ERROR_KEY_NAME_ALREADY_EXISTS',
803 '23505' => 'DB_ERROR_RECORD_ALREADY_EXISTS',
804 '42704' => 'DB_ERROR_NO_INDEX_TO_DROP', // May also be Type xxx does not exists
805 '42601' => 'DB_ERROR_SYNTAX',
806 '42P16' => 'DB_ERROR_PRIMARY_KEY_ALREADY_EXISTS',
807 1075 => 'DB_ERROR_CANT_DROP_PRIMARY_KEY',
808 1091 => 'DB_ERROR_NOSUCHFIELD',
809 1100 => 'DB_ERROR_NOT_LOCKED',
810 1136 => 'DB_ERROR_VALUE_COUNT_ON_ROW',
811 '42P01' => 'DB_ERROR_NOSUCHTABLE',
812 '23503' => 'DB_ERROR_NO_PARENT',
813 1217 => 'DB_ERROR_CHILD_EXISTS',
814 1451 => 'DB_ERROR_CHILD_EXISTS',
815 '42P04' => 'DB_DATABASE_ALREADY_EXISTS'
816 );
817
818 $errorlabel = pg_last_error($this->db);
819 $errorcode = '';
820 $reg = array();
821 if (preg_match('/: *([0-9P]+):/', $errorlabel, $reg)) {
822 $errorcode = $reg[1];
823 if (isset($errorcode_map[$errorcode])) {
824 return $errorcode_map[$errorcode];
825 }
826 }
827 $errno = $errorcode ? $errorcode : $errorlabel;
828 return ($errno ? 'DB_ERROR_'.$errno : '0');
829 }
830 // '/(Table does not exist\.|Relation [\"\'].*[\"\'] does not exist|sequence does not exist|class ".+" not found)$/' => 'DB_ERROR_NOSUCHTABLE',
831 // '/table [\"\'].*[\"\'] does not exist/' => 'DB_ERROR_NOSUCHTABLE',
832 // '/Relation [\"\'].*[\"\'] already exists|Cannot insert a duplicate key into (a )?unique index.*/' => 'DB_ERROR_RECORD_ALREADY_EXISTS',
833 // '/divide by zero$/' => 'DB_ERROR_DIVZERO',
834 // '/pg_atoi: error in .*: can\'t parse /' => 'DB_ERROR_INVALID_NUMBER',
835 // '/ttribute [\"\'].*[\"\'] not found$|Relation [\"\'].*[\"\'] does not have attribute [\"\'].*[\"\']/' => 'DB_ERROR_NOSUCHFIELD',
836 // '/parser: parse error at or near \"/' => 'DB_ERROR_SYNTAX',
837 // '/referential integrity violation/' => 'DB_ERROR_CONSTRAINT'
838 }
839
845 public function error()
846 {
847 return pg_last_error($this->db);
848 }
849
850 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
858 public function last_insert_id($tab, $fieldid = 'rowid')
859 {
860 // phpcs:enable
861 //$result = pg_query($this->db,"SELECT MAX(".$fieldid.") FROM ".$tab);
862 $result = pg_query($this->db, "SELECT currval('".$tab."_".$fieldid."_seq')");
863 if (!$result) {
864 print pg_last_error($this->db);
865 exit;
866 }
867 //$nbre = pg_num_rows($result);
868 $row = pg_fetch_result($result, 0, 0);
869 return (int) $row;
870 }
871
880 public function encrypt($fieldorvalue, $withQuotes = 1)
881 {
882 //global $conf;
883
884 // Type of encryption (2: AES (recommended), 1: DES , 0: no encryption)
885 //$cryptType = ($conf->db->dolibarr_main_db_encryption ? $conf->db->dolibarr_main_db_encryption : 0);
886
887 //Encryption key
888 //$cryptKey = (!empty($conf->db->dolibarr_main_db_cryptkey) ? $conf->db->dolibarr_main_db_cryptkey : '');
889
890 $return = $fieldorvalue;
891 return ($withQuotes ? "'" : "").$this->escape($return).($withQuotes ? "'" : "");
892 }
893
894
901 public function decrypt($value)
902 {
903 //global $conf;
904
905 // Type of encryption (2: AES (recommended), 1: DES , 0: no encryption)
906 //$cryptType = ($conf->db->dolibarr_main_db_encryption ? $conf->db->dolibarr_main_db_encryption : 0);
907
908 //Encryption key
909 //$cryptKey = (!empty($conf->db->dolibarr_main_db_cryptkey) ? $conf->db->dolibarr_main_db_cryptkey : '');
910
911 $return = $value;
912 return $return;
913 }
914
915
916 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
922 public function DDLGetConnectId()
923 {
924 // phpcs:enable
925 return '?';
926 }
927
928
929
930 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
942 public function DDLCreateDb($database, $charset = '', $collation = '', $owner = '')
943 {
944 // phpcs:enable
945 if (empty($charset)) {
946 $charset = $this->forcecharset;
947 }
948 if (empty($collation)) {
949 $collation = $this->forcecollate;
950 }
951
952 // Test charset match LC_TYPE (pgsql error otherwise)
953 //print $charset.' '.setlocale(LC_CTYPE,'0'); exit;
954
955 // NOTE: Do not use ' around the database name
956 $sql = "CREATE DATABASE ".$this->escape($database)." OWNER '".$this->escape($owner)."' ENCODING '".$this->escape($charset)."'";
957
958 dol_syslog($sql, LOG_DEBUG);
959 $ret = $this->query($sql);
960
961 return $ret;
962 }
963
964 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
972 public function DDLListTables($database, $table = '')
973 {
974 // phpcs:enable
975 $listtables = array();
976
977 $escapedlike = '';
978 if ($table) {
979 $tmptable = preg_replace('/[^a-z0-9\.\-\_%]/i', '', $table);
980
981 $escapedlike = " AND table_name LIKE '".$this->escape($tmptable)."'";
982 }
983 $result = pg_query($this->db, "SELECT table_name FROM information_schema.tables WHERE table_schema = 'public'".$escapedlike." ORDER BY table_name");
984 if ($result) {
985 while ($row = $this->fetch_row($result)) {
986 $listtables[] = $row[0];
987 }
988 }
989 return $listtables;
990 }
991
992 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1000 public function DDLListTablesFull($database, $table = '')
1001 {
1002 // phpcs:enable
1003 $listtables = array();
1004
1005 $escapedlike = '';
1006 if ($table) {
1007 $tmptable = preg_replace('/[^a-z0-9\.\-\_%]/i', '', $table);
1008
1009 $escapedlike = " AND table_name LIKE '".$this->escape($tmptable)."'";
1010 }
1011 $result = pg_query($this->db, "SELECT table_name, table_type FROM information_schema.tables WHERE table_schema = 'public'".$escapedlike." ORDER BY table_name");
1012 if ($result) {
1013 while ($row = $this->fetch_row($result)) {
1014 $listtables[] = $row;
1015 }
1016 }
1017 return $listtables;
1018 }
1019
1020 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1027 public function DDLInfoTable($table)
1028 {
1029 // phpcs:enable
1030 $infotables = array();
1031
1032 $sql = "SELECT ";
1033 $sql .= " infcol.column_name as 'Column',";
1034 $sql .= " CASE WHEN infcol.character_maximum_length IS NOT NULL THEN infcol.udt_name || '('||infcol.character_maximum_length||')'";
1035 $sql .= " ELSE infcol.udt_name";
1036 $sql .= " END as 'Type',";
1037 $sql .= " infcol.collation_name as 'Collation',";
1038 $sql .= " infcol.is_nullable as 'Null',";
1039 $sql .= " '' as 'Key',";
1040 $sql .= " infcol.column_default as 'Default',";
1041 $sql .= " '' as 'Extra',";
1042 $sql .= " '' as 'Privileges'";
1043 $sql .= " FROM information_schema.columns infcol";
1044 $sql .= " WHERE table_schema = 'public' ";
1045 $sql .= " AND table_name = '".$this->escape($table)."'";
1046 $sql .= " ORDER BY ordinal_position;";
1047
1048 $result = $this->query($sql);
1049 if ($result) {
1050 while ($row = $this->fetch_row($result)) {
1051 $infotables[] = $row;
1052 }
1053 }
1054 return $infotables;
1055 }
1056
1057
1058 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1071 public function DDLCreateTable($table, $fields, $primary_key, $type, $unique_keys = null, $fulltext_keys = null, $keys = null)
1072 {
1073 // phpcs:enable
1074 // @TODO: $fulltext_keys parameter is unused
1075
1076 $sqlk = array();
1077 $sqluq = array();
1078
1079 // Keys found into the array $fields: type,value,attribute,null,default,extra
1080 // ex. : $fields['rowid'] = array(
1081 // 'type'=>'int' or 'integer',
1082 // 'value'=>'11',
1083 // 'null'=>'not null',
1084 // 'extra'=> 'auto_increment'
1085 // );
1086 $sql = "CREATE TABLE ".$this->sanitize($table)."(";
1087 $i = 0;
1088 $sqlfields = array();
1089 foreach ($fields as $field_name => $field_desc) {
1090 $sqlfields[$i] = $this->sanitize($field_name)." ";
1091 $sqlfields[$i] .= $this->sanitize($field_desc['type']);
1092 if (isset($field_desc['value']) && $field_desc['value'] !== '') {
1093 $sqlfields[$i] .= "(".$this->sanitize($field_desc['value']).")";
1094 }
1095 if (isset($field_desc['attribute']) && $field_desc['attribute'] !== '') {
1096 $sqlfields[$i] .= " ".$this->sanitize($field_desc['attribute']);
1097 }
1098 if (isset($field_desc['default']) && $field_desc['default'] !== '') {
1099 if (in_array($field_desc['type'], array('tinyint', 'smallint', 'int', 'double'))) {
1100 $sqlfields[$i] .= " DEFAULT ".((float) $field_desc['default']);
1101 } elseif ($field_desc['default'] == 'null' || $field_desc['default'] == 'CURRENT_TIMESTAMP') {
1102 $sqlfields[$i] .= " DEFAULT ".$this->sanitize($field_desc['default']);
1103 } else {
1104 $sqlfields[$i] .= " DEFAULT '".$this->escape($field_desc['default'])."'";
1105 }
1106 }
1107 if (isset($field_desc['null']) && $field_desc['null'] !== '') {
1108 $sqlfields[$i] .= " ".$this->sanitize($field_desc['null'], 0, 0, 1);
1109 }
1110 if (isset($field_desc['extra']) && $field_desc['extra'] !== '') {
1111 $sqlfields[$i] .= " ".$this->sanitize($field_desc['extra'], 0, 0, 1);
1112 }
1113 if (!empty($primary_key) && $primary_key == $field_name) {
1114 $sqlfields[$i] .= " AUTO_INCREMENT PRIMARY KEY"; // mysql instruction that will be converted by driver late
1115 }
1116 $i++;
1117 }
1118
1119 if (is_array($unique_keys)) {
1120 $i = 0;
1121 foreach ($unique_keys as $key => $value) {
1122 $sqluq[$i] = "UNIQUE KEY '".$this->sanitize($key)."' ('".$this->escape($value)."')";
1123 $i++;
1124 }
1125 }
1126 if (is_array($keys)) {
1127 $i = 0;
1128 foreach ($keys as $key => $value) {
1129 $sqlk[$i] = "KEY ".$this->sanitize($key)." (".$value.")";
1130 $i++;
1131 }
1132 }
1133 $sql .= implode(', ', $sqlfields);
1134 if ($unique_keys != "") {
1135 $sql .= ",".implode(',', $sqluq);
1136 }
1137 if (is_array($keys)) {
1138 $sql .= ",".implode(',', $sqlk);
1139 }
1140 $sql .= ")";
1141 //$sql .= " engine=".$this->sanitize($type);
1142
1143 if (!$this->query($sql, 1)) {
1144 return -1;
1145 } else {
1146 return 1;
1147 }
1148 }
1149
1150 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1157 public function DDLDropTable($table)
1158 {
1159 // phpcs:enable
1160 $tmptable = preg_replace('/[^a-z0-9\.\-\_]/i', '', $table);
1161
1162 $sql = "DROP TABLE ".$this->sanitize($tmptable);
1163
1164 if (!$this->query($sql, 1)) {
1165 return -1;
1166 } else {
1167 return 1;
1168 }
1169 }
1170
1171 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1179 public function DDLDescTable($table, $field = "")
1180 {
1181 // phpcs:enable
1182 $sql = "SELECT attname FROM pg_attribute, pg_type WHERE typname = '".$this->escape($table)."' AND attrelid = typrelid";
1183 $sql .= " AND attname NOT IN ('cmin', 'cmax', 'ctid', 'oid', 'tableoid', 'xmin', 'xmax')";
1184 if ($field) {
1185 $sql .= " AND attname = '".$this->escape($field)."'";
1186 }
1187
1188 dol_syslog($sql, LOG_DEBUG);
1189 $this->_results = $this->query($sql);
1190 return $this->_results;
1191 }
1192
1193 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1203 public function DDLAddField($table, $field_name, $field_desc, $field_position = "")
1204 {
1205 // phpcs:enable
1206 // cles recherchees dans le tableau des descriptions (field_desc) : type,value,attribute,null,default,extra
1207 // ex. : $field_desc = array('type'=>'int','value'=>'11','null'=>'not null','extra'=> 'auto_increment');
1208 $sql = "ALTER TABLE ".$this->sanitize($table)." ADD ".$this->sanitize($field_name)." ";
1209 $sql .= $this->sanitize($field_desc['type']);
1210 if (isset($field_desc['value']) && preg_match("/^[^\s]/i", $field_desc['value'])) {
1211 if (!in_array($field_desc['type'], array('tinyint', 'smallint', 'int', 'date', 'datetime')) && $field_desc['value']) {
1212 $sql .= "(".$this->sanitize($field_desc['value']).")";
1213 }
1214 }
1215 if (isset($field_desc['attribute']) && preg_match("/^[^\s]/i", $field_desc['attribute'])) {
1216 $sql .= " ".$this->sanitize($field_desc['attribute']);
1217 }
1218 if (isset($field_desc['null']) && preg_match("/^[^\s]/i", $field_desc['null'])) {
1219 $sql .= " ".$field_desc['null'];
1220 }
1221 if (isset($field_desc['default']) && preg_match("/^[^\s]/i", $field_desc['default'])) {
1222 if (in_array($field_desc['type'], array('tinyint', 'smallint', 'int', 'double'))) {
1223 $sql .= " DEFAULT ".((float) $field_desc['default']);
1224 } elseif ($field_desc['default'] == 'null' || $field_desc['default'] == 'CURRENT_TIMESTAMP') {
1225 $sql .= " DEFAULT ".$this->sanitize($field_desc['default']);
1226 } else {
1227 $sql .= " DEFAULT '".$this->escape($field_desc['default'])."'";
1228 }
1229 }
1230 if (isset($field_desc['extra']) && preg_match("/^[^\s]/i", $field_desc['extra'])) {
1231 $sql .= " ".$this->sanitize($field_desc['extra'], 0, 0, 1);
1232 }
1233 $sql .= " ".$this->sanitize($field_position, 0, 0, 1);
1234
1235 dol_syslog($sql, LOG_DEBUG);
1236 if (!$this -> query($sql)) {
1237 return -1;
1238 }
1239 return 1;
1240 }
1241
1242 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1251 public function DDLUpdateField($table, $field_name, $field_desc)
1252 {
1253 // phpcs:enable
1254 $sql = "ALTER TABLE ".$this->sanitize($table);
1255 $sql .= " ALTER COLUMN ".$this->sanitize($field_name)." TYPE ".$this->sanitize($field_desc['type']);
1256 if (isset($field_desc['value']) && preg_match("/^[^\s]/i", $field_desc['value'])) {
1257 if (!in_array($field_desc['type'], array('smallint', 'int', 'date', 'datetime')) && $field_desc['value']) {
1258 $sql .= "(".$this->sanitize($field_desc['value']).")";
1259 }
1260 }
1261
1262 if (isset($field_desc['value']) && ($field_desc['null'] == 'not null' || $field_desc['null'] == 'NOT NULL')) {
1263 // We will try to change format of column to NOT NULL. To be sure the ALTER works, we try to update fields that are NULL
1264 if ($field_desc['type'] == 'varchar' || $field_desc['type'] == 'text') {
1265 $sqlbis = "UPDATE ".$this->sanitize($table)." SET ".$this->escape($field_name)." = '".$this->escape(isset($field_desc['default']) ? $field_desc['default'] : '')."' WHERE ".$this->escape($field_name)." IS NULL";
1266 $this->query($sqlbis);
1267 } elseif (in_array($field_desc['type'], array('tinyint', 'smallint', 'int', 'double'))) {
1268 $sqlbis = "UPDATE ".$this->sanitize($table)." SET ".$this->escape($field_name)." = ".((float) $this->escape(isset($field_desc['default']) ? $field_desc['default'] : 0))." WHERE ".$this->escape($field_name)." IS NULL";
1269 $this->query($sqlbis);
1270 }
1271 }
1272
1273 if (isset($field_desc['default']) && $field_desc['default'] != '') {
1274 if (in_array($field_desc['type'], array('tinyint', 'smallint', 'int', 'double'))) {
1275 $sql .= ", ALTER COLUMN ".$this->sanitize($field_name)." SET DEFAULT ".((float) $field_desc['default']);
1276 } elseif ($field_desc['type'] != 'text') { // Default not supported on text fields ?
1277 $sql .= ", ALTER COLUMN ".$this->sanitize($field_name)." SET DEFAULT '".$this->escape($field_desc['default'])."'";
1278 }
1279 }
1280
1281 dol_syslog($sql, LOG_DEBUG);
1282 if (!$this->query($sql)) {
1283 return -1;
1284 }
1285 return 1;
1286 }
1287
1288 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1296 public function DDLDropField($table, $field_name)
1297 {
1298 // phpcs:enable
1299 $tmp_field_name = preg_replace('/[^a-z0-9\.\-\_]/i', '', $field_name);
1300
1301 $sql = "ALTER TABLE ".$this->sanitize($table)." DROP COLUMN ".$this->sanitize($tmp_field_name);
1302 if (!$this->query($sql)) {
1303 $this->error = $this->lasterror();
1304 return -1;
1305 }
1306 return 1;
1307 }
1308
1309 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1319 public function DDLCreateUser($dolibarr_main_db_host, $dolibarr_main_db_user, $dolibarr_main_db_pass, $dolibarr_main_db_name)
1320 {
1321 // phpcs:enable
1322 // Note: using ' on user does not works with pgsql
1323 $sql = "CREATE USER ".$this->sanitize($dolibarr_main_db_user)." with password '".$this->escape($dolibarr_main_db_pass)."'";
1324
1325 dol_syslog(get_class($this)."::DDLCreateUser", LOG_DEBUG); // No sql to avoid password in log
1326 $resql = $this->query($sql);
1327 if (!$resql) {
1328 return -1;
1329 }
1330
1331 return 1;
1332 }
1333
1340 {
1341 $resql = $this->query('SHOW SERVER_ENCODING');
1342 if ($resql) {
1343 $liste = $this->fetch_array($resql);
1344 return $liste['server_encoding'];
1345 } else {
1346 return '';
1347 }
1348 }
1349
1355 public function getListOfCharacterSet()
1356 {
1357 $resql = $this->query('SHOW SERVER_ENCODING');
1358 $liste = array();
1359 if ($resql) {
1360 $i = 0;
1361 while ($obj = $this->fetch_object($resql)) {
1362 $liste[$i]['charset'] = $obj->server_encoding;
1363 $liste[$i]['description'] = 'Default database charset';
1364 $i++;
1365 }
1366 $this->free($resql);
1367 } else {
1368 return null;
1369 }
1370 return $liste;
1371 }
1372
1379 {
1380 $resql = $this->query('SHOW LC_COLLATE');
1381 if ($resql) {
1382 $liste = $this->fetch_array($resql);
1383 return $liste['lc_collate'];
1384 } else {
1385 return '';
1386 }
1387 }
1388
1394 public function getListOfCollation()
1395 {
1396 $resql = $this->query('SHOW LC_COLLATE');
1397 $liste = array();
1398 if ($resql) {
1399 $i = 0;
1400 while ($obj = $this->fetch_object($resql)) {
1401 $liste[$i]['collation'] = $obj->lc_collate;
1402 $i++;
1403 }
1404 $this->free($resql);
1405 } else {
1406 return null;
1407 }
1408 return $liste;
1409 }
1410
1416 public function getPathOfDump()
1417 {
1418 $fullpathofdump = '/pathtopgdump/pg_dump';
1419
1420 if (file_exists('/usr/bin/pg_dump')) {
1421 $fullpathofdump = '/usr/bin/pg_dump';
1422 } else {
1423 // TODO L'utilisateur de la base doit etre un superadmin pour lancer cette commande
1424 $resql = $this->query('SHOW data_directory');
1425 if ($resql) {
1426 $liste = $this->fetch_array($resql);
1427 $basedir = $liste['data_directory'];
1428 $fullpathofdump = preg_replace('/data$/', 'bin', $basedir).'/pg_dump';
1429 }
1430 }
1431
1432 return $fullpathofdump;
1433 }
1434
1440 public function getPathOfRestore()
1441 {
1442 //$tool='pg_restore';
1443 $tool = 'psql';
1444
1445 $fullpathofdump = '/pathtopgrestore/'.$tool;
1446
1447 if (file_exists('/usr/bin/'.$tool)) {
1448 $fullpathofdump = '/usr/bin/'.$tool;
1449 } else {
1450 // TODO L'utilisateur de la base doit etre un superadmin pour lancer cette commande
1451 $resql = $this->query('SHOW data_directory');
1452 if ($resql) {
1453 $liste = $this->fetch_array($resql);
1454 $basedir = $liste['data_directory'];
1455 $fullpathofdump = preg_replace('/data$/', 'bin', $basedir).'/'.$tool;
1456 }
1457 }
1458
1459 return $fullpathofdump;
1460 }
1461
1468 public function getServerParametersValues($filter = '')
1469 {
1470 $result = array();
1471
1472 $resql = 'select name,setting from pg_settings';
1473 if ($filter) {
1474 $resql .= " WHERE name = '".$this->escape($filter)."'";
1475 }
1476 $resql = $this->query($resql);
1477 if ($resql) {
1478 while ($obj = $this->fetch_object($resql)) {
1479 $result[$obj->name] = $obj->setting;
1480 }
1481 }
1482
1483 return $result;
1484 }
1485
1492 public function getServerStatusValues($filter = '')
1493 {
1494 /* This is to return current running requests.
1495 $sql='SELECT datname,procpid,current_query FROM pg_stat_activity ORDER BY procpid';
1496 if ($filter) $sql.=" LIKE '".$this->escape($filter)."'";
1497 $resql=$this->query($sql);
1498 if ($resql)
1499 {
1500 $obj=$this->fetch_object($resql);
1501 $result[$obj->Variable_name]=$obj->Value;
1502 }
1503 */
1504
1505 return array();
1506 }
1507}
Class to manage Dolibarr database access.
lastqueryerror()
Return last query in error.
lasterror()
Return last error label.
lasterrno()
Return last error code.
lastquery()
Return last request executed with query()
sanitize($stringtosanitize, $allowsimplequote=0, $allowsequals=0, $allowsspace=0, $allowschars=1)
Sanitize a string for SQL forging.
Class to drive a PostgreSQL database for Dolibarr.
errno()
Renvoie le code erreur generique de l'operation precedente.
DDLListTablesFull($database, $table='')
List tables into a database.
DDLGetConnectId()
Return connection ID.
num_rows($resultset)
Return number of lines for result of a SELECT.
const VERSIONMIN
Version min database.
__construct($type, $host, $user, $pass, $name='', $port=0)
Constructor.
DDLCreateUser($dolibarr_main_db_host, $dolibarr_main_db_user, $dolibarr_main_db_pass, $dolibarr_main_db_name)
Create a user to connect to database.
DDLCreateTable($table, $fields, $primary_key, $type, $unique_keys=null, $fulltext_keys=null, $keys=null)
Create a table into database.
DDLDropTable($table)
Drop a table into database.
DDLUpdateField($table, $field_name, $field_desc)
Update format of a field into a table.
getPathOfDump()
Return full path of dump program.
select_db($database)
Select a database PostgreSQL does not have an equivalent for mysql_select_db Only compare if the chos...
getServerStatusValues($filter='')
Return value of server status.
plimit($limit=0, $offset=0)
Define limits and offset of request.
decrypt($value)
Decrypt sensitive data in database.
error()
Renvoie le texte de l'erreur pgsql de l'operation precedente.
escape($stringtoencode)
Escape a string to insert data.
query($query, $usesavepoint=0, $type='auto', $result_mode=0)
Convert request to PostgreSQL syntax, execute it and return the resultset.
fetch_object($resultset)
Returns the current line (as an object) for the resultset cursor.
close()
Close database connection.
encrypt($fieldorvalue, $withQuotes=1)
Encrypt sensitive data in database Warning: This function includes the escape and add the SQL simple ...
getListOfCharacterSet()
Return list of available charset that can be used to store data in database.
fetch_array($resultset)
Return datas as an array.
last_insert_id($tab, $fieldid='rowid')
Get last ID after an insert INSERT.
getPathOfRestore()
Return full path of restore program.
DDLAddField($table, $field_name, $field_desc, $field_position="")
Create a new field into table.
$type
Database type.
DDLInfoTable($table)
List information of columns into a table.
connect($host, $login, $passwd, $name, $port=0)
Connection to server.
getVersion()
Return version of database server.
$forcecharset
Charset.
escapeforlike($stringtoencode)
Escape a string to insert data into a like.
affected_rows($resultset)
Return the number of lines in the result of a request INSERT, DELETE or UPDATE.
DDLDropField($table, $field_name)
Drop a field from table.
regexpsql($subject, $pattern, $sqlstring=0)
Format a SQL REGEXP.
DDLCreateDb($database, $charset='', $collation='', $owner='')
Create a new database Do not use function xxx_create_db (xxx=mysql, ...) as they are deprecated We fo...
const LABEL
Database label.
getListOfCollation()
Return list of available collation that can be used for database.
getDriverInfo()
Return version of database client driver.
free($resultset=null)
Libere le dernier resultset utilise sur cette connection.
DDLDescTable($table, $field="")
Return a pointer of line with description of a table or field.
ifsql($test, $resok, $resko)
Format a SQL IF.
getDefaultCollationDatabase()
Return collation used in database.
convertSQLFromMysql($line, $type='auto', $unescapeslashquot=false)
Convert a SQL request in Mysql syntax to native syntax.
getDefaultCharacterSetDatabase()
Return charset used to store data in database.
$forcecollate
Collate used to force collate when creating database.
fetch_row($resultset)
Return datas as an array.
getServerParametersValues($filter='')
Return value of server parameters.
DDLListTables($database, $table='')
List tables into a database.
getDolGlobalInt($key, $default=0)
Return a Dolibarr global constant int value.
getDolGlobalString($key, $default='')
Return dolibarr global constant string value.
dol_syslog($message, $level=LOG_INFO, $ident=0, $suffixinfilename='', $restricttologhandler='', $logcontext=null)
Write log message into outputs.