dolibarr 22.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-2025 MDW <mdeweerd@users.noreply.github.com>
12 * Copyright (C) 2024 Frédéric France <frederic.france@free.fr>
13 *
14 * This program is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License as published by
16 * the Free Software Foundation; either version 3 of the License, or
17 * (at your option) any later version.
18 *
19 * This program is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU General Public License for more details.
23 *
24 * You should have received a copy of the GNU General Public License
25 * along with this program. If not, see <https://www.gnu.org/licenses/>.
26 */
27
33require_once DOL_DOCUMENT_ROOT.'/core/db/DoliDB.class.php';
34
38class DoliDBPgsql extends DoliDB
39{
41 public $type = 'pgsql'; // Name of manager
42
44 const LABEL = 'PostgreSQL'; // Label of manager
45
47 public $forcecharset = 'UTF8'; // Can't be static as it may be forced with a dynamic value
48
50 public $forcecollate = ''; // Can't be static as it may be forced with a dynamic value
51
53 const VERSIONMIN = '9.0.0'; // Version min database
54
58 public $unescapeslashquot = false;
62 public $standard_conforming_strings = false;
63
64
66 private $_results;
67
68
69
81 public function __construct($type, $host, $user, $pass, $name = '', $port = 0)
82 {
83 global $conf, $langs;
84
85 // Note that having "static" property for "$forcecharset" and "$forcecollate" will make error here in strict mode, so they are not static
86 if (!empty($conf->db->character_set)) {
87 $this->forcecharset = $conf->db->character_set;
88 }
89 if (!empty($conf->db->dolibarr_main_db_collation)) {
90 $this->forcecollate = $conf->db->dolibarr_main_db_collation;
91 }
92
93 $this->database_user = $user;
94 $this->database_host = $host;
95 $this->database_port = $port;
96
97 $this->transaction_opened = 0;
98
99 //print "Name DB: $host,$user,$pass,$name<br>";
100
101 if (!function_exists("pg_connect")) {
102 $this->connected = false;
103 $this->ok = false;
104 $this->error = "Pgsql PHP functions are not available in this version of PHP";
105 dol_syslog(get_class($this)."::DoliDBPgsql : Pgsql PHP functions are not available in this version of PHP", LOG_ERR);
106 return;
107 }
108
109 if (!$host) {
110 $this->connected = false;
111 $this->ok = false;
112 $this->error = $langs->trans("ErrorWrongHostParameter");
113 dol_syslog(get_class($this)."::DoliDBPgsql : Erreur Connect, wrong host parameters", LOG_ERR);
114 return;
115 }
116
117 // Essai connection serveur
118 //print "$host, $user, $pass, $name, $port";
119 $this->db = $this->connect($host, $user, $pass, $name, $port);
120
121 if ($this->db) {
122 $this->connected = true;
123 $this->ok = true;
124 } else {
125 // host, login ou password incorrect
126 $this->connected = false;
127 $this->ok = false;
128 $this->error = 'Host, login or password incorrect';
129 dol_syslog(get_class($this)."::DoliDBPgsql : Erreur Connect ".$this->error.'. Failed to connect to host='.$host.' port='.$port.' user='.$user, LOG_ERR);
130 }
131
132 // If server connection serveur ok and DB connection is requested, try to connect to DB
133 if ($this->connected && $name) {
134 if ($this->select_db($name)) {
135 $this->database_selected = true;
136 $this->database_name = $name;
137 $this->ok = true;
138 } else {
139 $this->database_selected = false;
140 $this->database_name = '';
141 $this->ok = false;
142 $this->error = $this->error();
143 dol_syslog(get_class($this)."::DoliDBPgsql : Erreur Select_db ".$this->error, LOG_ERR);
144 }
145 } else {
146 // Pas de selection de base demandee, ok ou ko
147 $this->database_selected = false;
148 }
149 }
150
151
160 public function convertSQLFromMysql($line, $type = 'auto', $unescapeslashquot = false)
161 {
162 global $conf;
163
164 // Removed empty line if this is a comment line for SVN tagging
165 if (preg_match('/^--\s\$Id/i', $line)) {
166 return '';
167 }
168 // Return line if this is a comment
169 if (preg_match('/^#/i', $line) || preg_match('/^$/i', $line) || preg_match('/^--/i', $line)) {
170 return $line;
171 }
172 if ($line != "") {
173 // group_concat support (PgSQL >= 9.0)
174 // Replace group_concat(x) or group_concat(x SEPARATOR ',') with string_agg(x, ',')
175 $line = preg_replace('/GROUP_CONCAT/i', 'STRING_AGG', $line);
176 $line = preg_replace('/ SEPARATOR/i', ',', $line);
177 $line = preg_replace('/STRING_AGG\‍(([^,\‍)]+)\‍)/i', 'STRING_AGG(\\1, \',\')', $line);
178 $line = preg_replace('/STRING_AGG\‍(([^,]+),([^\‍)]+)\‍)/i', 'STRING_AGG(\\1::TEXT,\\2::TEXT)', $line);
179 //print $line."\n";
180
181 if ($type == 'auto') {
182 if (preg_match('/ALTER TABLE/i', $line)) {
183 $type = 'dml';
184 } elseif (preg_match('/CREATE TABLE/i', $line)) {
185 $type = 'dml';
186 } elseif (preg_match('/DROP TABLE/i', $line)) {
187 $type = 'dml';
188 }
189 }
190
191 $line = preg_replace('/ as signed\‍)/i', ' as integer)', $line);
192
193 if ($type == 'dml') {
194 $reg = array();
195
196 $line = preg_replace('/\s/', ' ', $line); // Replace tabulation with space
197
198 // we are inside create table statement so let's process datatypes
199 if (preg_match('/(ISAM|innodb)/i', $line)) { // end of create table sequence
200 $line = preg_replace('/\‍)[\s\t]*type[\s\t]*=[\s\t]*(MyISAM|innodb).*;/i', ');', $line);
201 $line = preg_replace('/\‍)[\s\t]*engine[\s\t]*=[\s\t]*(MyISAM|innodb).*;/i', ');', $line);
202 $line = preg_replace('/,$/', '', $line);
203 }
204
205 // Process case: "CREATE TABLE llx_mytable(rowid integer NOT NULL AUTO_INCREMENT PRIMARY KEY,code..."
206 if (preg_match('/[\s\t\‍(]*(\w*)[\s\t]+int.*auto_increment/i', $line, $reg)) {
207 $newline = preg_replace('/([\s\t\‍(]*)([a-zA-Z_0-9]*)[\s\t]+int.*auto_increment[^,]*/i', '\\1 \\2 SERIAL PRIMARY KEY', $line);
208 //$line = "-- ".$line." replaced by --\n".$newline;
209 $line = $newline;
210 }
211
212 if (preg_match('/[\s\t\‍(]*(\w*)[\s\t]+bigint.*auto_increment/i', $line, $reg)) {
213 $newline = preg_replace('/([\s\t\‍(]*)([a-zA-Z_0-9]*)[\s\t]+bigint.*auto_increment[^,]*/i', '\\1 \\2 BIGSERIAL PRIMARY KEY', $line);
214 //$line = "-- ".$line." replaced by --\n".$newline;
215 $line = $newline;
216 }
217
218 // tinyint type conversion
219 $line = preg_replace('/tinyint\‍(?[0-9]*\‍)?/', 'smallint', $line);
220 $line = preg_replace('/tinyint/i', 'smallint', $line);
221
222 // nuke unsigned
223 $line = preg_replace('/(int\w+|smallint|bigint)\s+unsigned/i', '\\1', $line);
224
225 // blob -> text
226 $line = preg_replace('/\w*blob/i', 'text', $line);
227
228 // tinytext/mediumtext -> text
229 $line = preg_replace('/tinytext/i', 'text', $line);
230 $line = preg_replace('/mediumtext/i', 'text', $line);
231 $line = preg_replace('/longtext/i', 'text', $line);
232
233 $line = preg_replace('/text\‍([0-9]+\‍)/i', 'text', $line);
234
235 // change not null datetime field to null valid ones
236 // (to support remapping of "zero time" to null
237 $line = preg_replace('/datetime not null/i', 'datetime', $line);
238 $line = preg_replace('/datetime/i', 'timestamp', $line);
239
240 // double -> numeric
241 $line = preg_replace('/^double/i', 'numeric', $line);
242 $line = preg_replace('/(\s*)double/i', '\\1numeric', $line);
243 // float -> numeric
244 $line = preg_replace('/^float/i', 'numeric', $line);
245 $line = preg_replace('/(\s*)float/i', '\\1numeric', $line);
246
247 //Check tms timestamp field case (in Mysql this field is defaulted to now and
248 // on update defaulted by now
249 $line = preg_replace('/(\s*)tms(\s*)timestamp/i', '\\1tms timestamp without time zone DEFAULT now() NOT NULL', $line);
250
251 // nuke DEFAULT CURRENT_TIMESTAMP
252 $line = preg_replace('/(\s*)DEFAULT(\s*)CURRENT_TIMESTAMP/i', '\\1', $line);
253
254 // nuke ON UPDATE CURRENT_TIMESTAMP
255 $line = preg_replace('/(\s*)ON(\s*)UPDATE(\s*)CURRENT_TIMESTAMP/i', '\\1', $line);
256
257 // unique index(field1,field2)
258 if (preg_match('/unique index\s*\‍((\w+\s*,\s*\w+)\‍)/i', $line)) {
259 $line = preg_replace('/unique index\s*\‍((\w+\s*,\s*\w+)\‍)/i', 'UNIQUE\‍(\\1\‍)', $line);
260 }
261
262 // We remove end of requests "AFTER fieldxxx"
263 $line = preg_replace('/\sAFTER [a-z0-9_]+/i', '', $line);
264
265 // We remove start of requests "ALTER TABLE tablexxx" if this is a DROP INDEX
266 $line = preg_replace('/ALTER TABLE [a-z0-9_]+\s+DROP INDEX/i', 'DROP INDEX', $line);
267
268 // Translate order to rename fields
269 if (preg_match('/ALTER TABLE ([a-z0-9_]+)\s+CHANGE(?: COLUMN)? ([a-z0-9_]+) ([a-z0-9_]+)(.*)$/i', $line, $reg)) {
270 $line = "-- ".$line." replaced by --\n";
271 $line .= "ALTER TABLE ".$reg[1]." RENAME COLUMN ".$reg[2]." TO ".$reg[3];
272 }
273
274 // Translate order to modify field format
275 if (preg_match('/ALTER TABLE ([a-z0-9_]+)\s+MODIFY(?: COLUMN)? ([a-z0-9_]+) (.*)$/i', $line, $reg)) {
276 $line = "-- ".$line." replaced by --\n";
277 $newreg3 = $reg[3];
278 $newreg3 = preg_replace('/ DEFAULT NULL/i', '', $newreg3);
279 $newreg3 = preg_replace('/ NOT NULL/i', '', $newreg3);
280 $newreg3 = preg_replace('/ NULL/i', '', $newreg3);
281 $newreg3 = preg_replace('/ DEFAULT 0/i', '', $newreg3);
282 $newreg3 = preg_replace('/ DEFAULT \'?[0-9a-zA-Z_@]*\'?/i', '', $newreg3);
283 $line .= "ALTER TABLE ".$reg[1]." ALTER COLUMN ".$reg[2]." TYPE ".$newreg3;
284 // TODO Add alter to set default value or null/not null if there is this in $reg[3]
285 }
286
287 // alter table add primary key (field1, field2 ...) -> We remove the primary key name not accepted by PostGreSQL
288 // ALTER TABLE llx_dolibarr_modules ADD PRIMARY KEY pk_dolibarr_modules (numero, entity)
289 if (preg_match('/ALTER\s+TABLE\s*(.*)\s*ADD\s+PRIMARY\s+KEY\s*(.*)\s*\‍((.*)$/i', $line, $reg)) {
290 $line = "-- ".$line." replaced by --\n";
291 $line .= "ALTER TABLE ".$reg[1]." ADD PRIMARY KEY (".$reg[3];
292 }
293
294 // Translate order to drop primary keys
295 // ALTER TABLE llx_dolibarr_modules DROP PRIMARY KEY pk_xxx
296 if (preg_match('/ALTER\s+TABLE\s*(.*)\s*DROP\s+PRIMARY\s+KEY\s*([^;]+)$/i', $line, $reg)) {
297 $line = "-- ".$line." replaced by --\n";
298 $line .= "ALTER TABLE ".$reg[1]." DROP CONSTRAINT ".$reg[2];
299 }
300
301 // Translate order to drop foreign keys
302 // ALTER TABLE llx_dolibarr_modules DROP FOREIGN KEY fk_xxx
303 if (preg_match('/ALTER\s+TABLE\s*(.*)\s*DROP\s+FOREIGN\s+KEY\s*(.*)$/i', $line, $reg)) {
304 $line = "-- ".$line." replaced by --\n";
305 $line .= "ALTER TABLE ".$reg[1]." DROP CONSTRAINT ".$reg[2];
306 }
307
308 // Translate order to add foreign keys
309 // ALTER TABLE llx_tablechild ADD CONSTRAINT fk_tablechild_fk_fieldparent FOREIGN KEY (fk_fieldparent) REFERENCES llx_tableparent (rowid)
310 if (preg_match('/ALTER\s+TABLE\s+(.*)\s*ADD CONSTRAINT\s+(.*)\s*FOREIGN\s+KEY\s*(.*)$/i', $line, $reg)) {
311 $line = preg_replace('/;$/', '', $line);
312 $line .= " DEFERRABLE INITIALLY IMMEDIATE;";
313 }
314
315 // alter table add [unique] [index] (field1, field2 ...)
316 // ALTER TABLE llx_accountingaccount ADD INDEX idx_accountingaccount_fk_pcg_version (fk_pcg_version)
317 if (preg_match('/ALTER\s+TABLE\s*(.*)\s*ADD\s+(UNIQUE INDEX|INDEX|UNIQUE)\s+(.*)\s*\‍(([\w,\s]+)\‍)/i', $line, $reg)) {
318 $fieldlist = $reg[4];
319 $idxname = $reg[3];
320 $tablename = $reg[1];
321 $line = "-- ".$line." replaced by --\n";
322 $line .= "CREATE ".(preg_match('/UNIQUE/', $reg[2]) ? 'UNIQUE ' : '')."INDEX ".$idxname." ON ".$tablename." (".$fieldlist.")";
323 }
324 }
325
326 // To have PostgreSQL case sensitive
327 $count_like = 0;
328 $line = str_replace(" LIKE '", " ILIKE '", $line, $count_like);
329 if (getDolGlobalString('PSQL_USE_UNACCENT') && $count_like > 0) {
330 // @see https://docs.PostgreSQL.fr/11/unaccent.html : 'unaccent()' function must be installed before
331 $line = preg_replace('/\s+(\‍(+\s*)([a-zA-Z0-9\-\_\.]+) ILIKE /', ' \1unaccent(\2) ILIKE ', $line);
332 }
333
334 $line = str_replace(" LIKE BINARY '", " LIKE '", $line);
335
336 // Replace INSERT IGNORE into INSERT
337 $line = preg_replace('/^INSERT IGNORE/', 'INSERT', $line);
338
339 // Delete using criteria on other table must not declare twice the deleted table
340 // DELETE FROM tabletodelete USING tabletodelete, othertable -> DELETE FROM tabletodelete USING othertable
341 if (preg_match('/DELETE FROM ([a-z_]+) USING ([a-z_]+), ([a-z_]+)/i', $line, $reg)) {
342 if ($reg[1] == $reg[2]) { // If same table, we remove second one
343 $line = preg_replace('/DELETE FROM ([a-z_]+) USING ([a-z_]+), ([a-z_]+)/i', 'DELETE FROM \\1 USING \\3', $line);
344 }
345 }
346
347 // Remove () in the tables in FROM if 1 table
348 $line = preg_replace('/FROM\s*\‍((([a-z_]+)\s+as\s+([a-z_]+)\s*)\‍)/i', 'FROM \\1', $line);
349 //print $line."\n";
350
351 // Remove () in the tables in FROM if 2 table
352 $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);
353 //print $line."\n";
354
355 // Remove () in the tables in FROM if 3 table
356 $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);
357 //print $line."\n";
358
359 // Remove () in the tables in FROM if 4 table
360 $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);
361 //print $line."\n";
362
363 // Remove () in the tables in FROM if 5 table
364 $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);
365 //print $line."\n";
366
367 // Replace spacing ' with ''.
368 // By default we do not (should be already done by db->escape function if required
369 // except for sql insert in data file that are mysql escaped so we removed them to
370 // be compatible with standard_conforming_strings=on that considers \ as ordinary character).
371 if ($unescapeslashquot) {
372 $line = preg_replace("/\\\'/", "''", $line);
373 }
374
375 //print "type=".$type." newline=".$line."<br>\n";
376 }
377
378 return $line;
379 }
380
381 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
390 public function select_db($database)
391 {
392 // phpcs:enable
393 if ($database == $this->database_name) {
394 return true;
395 } else {
396 return false;
397 }
398 }
399
411 public function connect($host, $login, $passwd, $name, $port = 0)
412 {
413 // use pg_pconnect() instead of pg_connect() if you want to use persistent connection costing 1ms, instead of 30ms for non persistent
414
415 $this->db = false;
416
417 // connections parameters must be protected (only \ and ' according to pg_connect() manual)
418 $host = str_replace(array("\\", "'"), array("\\\\", "\\'"), $host);
419 $login = str_replace(array("\\", "'"), array("\\\\", "\\'"), $login);
420 $passwd = str_replace(array("\\", "'"), array("\\\\", "\\'"), $passwd);
421 $name = str_replace(array("\\", "'"), array("\\\\", "\\'"), $name);
422 $port = str_replace(array("\\", "'"), array("\\\\", "\\'"), (string) $port);
423
424 if (!$name) {
425 $name = "postgres"; // When try to connect using admin user
426 }
427
428 // try first Unix domain socket (local)
429 if ((!empty($host) && $host == "socket") && !defined('NOLOCALSOCKETPGCONNECT')) {
430 $con_string = "dbname='".$name."' user='".$login."' password='".$passwd."'"; // $name may be empty
431 try {
432 $this->db = @pg_connect($con_string);
433 } catch (Exception $e) {
434 // No message
435 }
436 }
437
438 // if local connection failed or not requested, use TCP/IP
439 if (empty($this->db)) {
440 if (!$host) {
441 $host = "localhost";
442 }
443 if (!$port) {
444 $port = 5432;
445 }
446
447 $con_string = "host='".$host."' port='".$port."' dbname='".$name."' user='".$login."' password='".$passwd."'";
448 try {
449 $this->db = @pg_connect($con_string);
450 } catch (Exception $e) {
451 print $e->getMessage();
452 }
453 }
454
455 // now we test if at least one connect method was a success
456 if ($this->db) {
457 $this->database_name = $name;
458 pg_set_error_verbosity($this->db, PGSQL_ERRORS_VERBOSE); // Set verbosity to max
459 pg_query($this->db, "set datestyle = 'ISO, YMD';");
460 }
461
462 return $this->db;
463 }
464
470 public function getVersion()
471 {
472 $resql = $this->query('SHOW server_version');
473 if ($resql) {
474 $liste = $this->fetch_array($resql);
475 return $liste['server_version'];
476 }
477 return '';
478 }
479
485 public function getDriverInfo()
486 {
487 return 'pgsql php driver';
488 }
489
496 public function close()
497 {
498 if ($this->db) {
499 if ($this->transaction_opened > 0) {
500 dol_syslog(get_class($this)."::close Closing a connection with an opened transaction depth=".$this->transaction_opened, LOG_ERR);
501 }
502 $this->connected = false;
503 return pg_close($this->db);
504 }
505 return false;
506 }
507
517 public function query($query, $usesavepoint = 0, $type = 'auto', $result_mode = 0)
518 {
519 global $dolibarr_main_db_readonly;
520
521 $query = trim($query);
522
523 // Convert MySQL syntax to PostgreSQL syntax
524 $query = $this->convertSQLFromMysql($query, $type, ($this->unescapeslashquot && $this->standard_conforming_strings));
525 //print "After convertSQLFromMysql:\n".$query."<br>\n";
526
527 if (getDolGlobalString('MAIN_DB_AUTOFIX_BAD_SQL_REQUEST')) {
528 // Fix bad formed requests. If request contains a date without quotes, we fix this but this should not occurs.
529 $loop = true;
530 while ($loop) {
531 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)) {
532 $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);
533 dol_syslog("Warning: Bad formed request converted into ".$query, LOG_WARNING);
534 } else {
535 $loop = false;
536 }
537 }
538 }
539
540 if ($usesavepoint && $this->transaction_opened) {
541 @pg_query($this->db, 'SAVEPOINT mysavepoint');
542 }
543
544 if (!in_array($query, array('BEGIN', 'COMMIT', 'ROLLBACK'))) {
545 $SYSLOG_SQL_LIMIT = 10000; // limit log to 10kb per line to limit DOS attacks
546 dol_syslog('sql='.substr($query, 0, $SYSLOG_SQL_LIMIT), LOG_DEBUG);
547 }
548 if (empty($query)) {
549 return false; // Return false = error if empty request
550 }
551
552 if (!empty($dolibarr_main_db_readonly)) {
553 if (preg_match('/^(INSERT|UPDATE|REPLACE|DELETE|CREATE|ALTER|TRUNCATE|DROP)/i', $query)) {
554 $this->lasterror = 'Application in read-only mode';
555 $this->lasterrno = 'APPREADONLY';
556 $this->lastquery = $query;
557 return false;
558 }
559 }
560
561 $ret = @pg_query($this->db, $query);
562
563 //print $query;
564 if (!preg_match("/^COMMIT/i", $query) && !preg_match("/^ROLLBACK/i", $query)) { // Si requete utilisateur, on la sauvegarde ainsi que son resultset
565 if (!$ret) {
566 if ($this->errno() != 'DB_ERROR_25P02') { // Do not overwrite errors if this is a consecutive error
567 $this->lastqueryerror = $query;
568 $this->lasterror = $this->error();
569 $this->lasterrno = $this->errno();
570
571 if (getDolGlobalInt('SYSLOG_LEVEL') < LOG_DEBUG) {
572 dol_syslog(get_class($this)."::query SQL Error query: ".$query, LOG_ERR); // Log of request was not yet done previously
573 }
574 dol_syslog(get_class($this)."::query SQL Error message: ".$this->lasterror." (".$this->lasterrno.")", LOG_ERR);
575 dol_syslog(get_class($this)."::query SQL Error usesavepoint = ".$usesavepoint, LOG_ERR);
576 }
577
578 if ($usesavepoint && $this->transaction_opened) { // Warning, after that errno will be erased
579 @pg_query($this->db, 'ROLLBACK TO SAVEPOINT mysavepoint');
580 }
581 }
582 $this->lastquery = $query;
583 $this->_results = $ret;
584 }
585
586 return $ret;
587 }
588
589 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
596 public function fetch_object($resultset)
597 {
598 // phpcs:enable
599 // If resultset not provided, we take the last used by connection
600 if (!is_resource($resultset) && !is_object($resultset)) {
601 $resultset = $this->_results;
602 }
603 return pg_fetch_object($resultset);
604 }
605
606 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
613 public function fetch_array($resultset)
614 {
615 // phpcs:enable
616 // If resultset not provided, we take the last used by connection
617 if (!is_resource($resultset) && !is_object($resultset)) {
618 $resultset = $this->_results;
619 }
620 return pg_fetch_array($resultset);
621 }
622
623 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
630 public function fetch_row($resultset)
631 {
632 // phpcs:enable
633 // Si le resultset n'est pas fourni, on prend le dernier utilise sur cette connection
634 if (!is_resource($resultset) && !is_object($resultset)) {
635 $resultset = $this->_results;
636 }
637 return pg_fetch_row($resultset); // @phan-suppress-current-line PhanTypeMismatchArgumentProbablyReal
638 }
639
640 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
648 public function num_rows($resultset)
649 {
650 // phpcs:enable
651 // If resultset not provided, we take the last used by connection
652 if (!is_resource($resultset) && !is_object($resultset)) {
653 $resultset = $this->_results;
654 }
655 // avoid error if $resultset = null or false
656 if ($resultset) {
657 return pg_num_rows($resultset);
658 } else {
659 return 0;
660 } // end of avoid error
661 }
662
663 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
671 public function affected_rows($resultset)
672 {
673 // phpcs:enable
674 // If resultset not provided, we take the last used by connection
675 if (!is_resource($resultset) && !is_object($resultset)) {
676 $resultset = $this->_results;
677 }
678 // pgsql necessite un resultset pour cette fonction contrairement
679 // a mysql qui prend un link de base
680 return pg_affected_rows($resultset);
681 }
682
683
690 public function free($resultset = null)
691 {
692 // If resultset not provided, we take the last used by connection
693 if (!is_resource($resultset) && !is_object($resultset)) {
694 $resultset = $this->_results;
695 }
696 // Si resultset en est un, on libere la memoire
697 if (is_resource($resultset) || is_object($resultset)) {
698 pg_free_result($resultset);
699 }
700 }
701
702
710 public function plimit($limit = 0, $offset = 0)
711 {
712 global $conf;
713 if (empty($limit)) {
714 return "";
715 }
716 if ($limit < 0) {
717 $limit = $conf->liste_limit;
718 }
719 if ($offset > 0) {
720 return " LIMIT ".$limit." OFFSET ".$offset." ";
721 } else {
722 return " LIMIT $limit ";
723 }
724 }
725
726
733 public function escape($stringtoencode)
734 {
735 return pg_escape_string($this->db, $stringtoencode);
736 }
737
744 public function escapeforlike($stringtoencode)
745 {
746 return str_replace(array('\\', '_', '%'), array('\\\\', '\_', '\%'), (string) $stringtoencode);
747 }
748
757 public function ifsql($test, $resok, $resko)
758 {
759 return '(CASE WHEN '.$test.' THEN '.$resok.' ELSE '.$resko.' END)';
760 }
761
770 public function regexpsql($subject, $pattern, $sqlstring = 0)
771 {
772 if ($sqlstring) {
773 return "(". $subject ." ~ '" . $this->escape($pattern) . "')";
774 }
775
776 return "('". $this->escape($subject) ."' ~ '" . $this->escape($pattern) . "')";
777 }
778
779
785 public function errno()
786 {
787 if (!$this->connected) {
788 // Si il y a eu echec de connection, $this->db n'est pas valide.
789 return 'DB_ERROR_FAILED_TO_CONNECT';
790 } else {
791 // Constants to convert error code to a generic Dolibarr error code
792 $errorcode_map = array(
793 1004 => 'DB_ERROR_CANNOT_CREATE',
794 1005 => 'DB_ERROR_CANNOT_CREATE',
795 1006 => 'DB_ERROR_CANNOT_CREATE',
796 1007 => 'DB_ERROR_ALREADY_EXISTS',
797 1008 => 'DB_ERROR_CANNOT_DROP',
798 1025 => 'DB_ERROR_NO_FOREIGN_KEY_TO_DROP',
799 1044 => 'DB_ERROR_ACCESSDENIED',
800 1046 => 'DB_ERROR_NODBSELECTED',
801 1048 => 'DB_ERROR_CONSTRAINT',
802 '42P07' => 'DB_ERROR_TABLE_OR_KEY_ALREADY_EXISTS',
803 '42703' => 'DB_ERROR_NOSUCHFIELD',
804 1060 => 'DB_ERROR_COLUMN_ALREADY_EXISTS',
805 42701 => 'DB_ERROR_COLUMN_ALREADY_EXISTS',
806 '42710' => 'DB_ERROR_KEY_NAME_ALREADY_EXISTS',
807 '23505' => 'DB_ERROR_RECORD_ALREADY_EXISTS',
808 '42704' => 'DB_ERROR_NO_INDEX_TO_DROP', // May also be Type xxx does not exists
809 '42601' => 'DB_ERROR_SYNTAX',
810 '42P16' => 'DB_ERROR_PRIMARY_KEY_ALREADY_EXISTS',
811 1075 => 'DB_ERROR_CANT_DROP_PRIMARY_KEY',
812 1091 => 'DB_ERROR_NOSUCHFIELD',
813 1100 => 'DB_ERROR_NOT_LOCKED',
814 1136 => 'DB_ERROR_VALUE_COUNT_ON_ROW',
815 '42P01' => 'DB_ERROR_NOSUCHTABLE',
816 '23503' => 'DB_ERROR_NO_PARENT',
817 1217 => 'DB_ERROR_CHILD_EXISTS',
818 1451 => 'DB_ERROR_CHILD_EXISTS',
819 '42P04' => 'DB_DATABASE_ALREADY_EXISTS'
820 );
821
822 $errorlabel = pg_last_error($this->db);
823 $errorcode = '';
824 $reg = array();
825 if (preg_match('/: *([0-9P]+):/', $errorlabel, $reg)) {
826 $errorcode = $reg[1];
827 if (isset($errorcode_map[$errorcode])) {
828 return $errorcode_map[$errorcode];
829 }
830 }
831 $errno = $errorcode ? $errorcode : $errorlabel;
832 return ($errno ? 'DB_ERROR_'.$errno : '0');
833 }
834 // '/(Table does not exist\.|Relation [\"\'].*[\"\'] does not exist|sequence does not exist|class ".+" not found)$/' => 'DB_ERROR_NOSUCHTABLE',
835 // '/table [\"\'].*[\"\'] does not exist/' => 'DB_ERROR_NOSUCHTABLE',
836 // '/Relation [\"\'].*[\"\'] already exists|Cannot insert a duplicate key into (a )?unique index.*/' => 'DB_ERROR_RECORD_ALREADY_EXISTS',
837 // '/divide by zero$/' => 'DB_ERROR_DIVZERO',
838 // '/pg_atoi: error in .*: can\'t parse /' => 'DB_ERROR_INVALID_NUMBER',
839 // '/ttribute [\"\'].*[\"\'] not found$|Relation [\"\'].*[\"\'] does not have attribute [\"\'].*[\"\']/' => 'DB_ERROR_NOSUCHFIELD',
840 // '/parser: parse error at or near \"/' => 'DB_ERROR_SYNTAX',
841 // '/referential integrity violation/' => 'DB_ERROR_CONSTRAINT'
842 }
843
849 public function error()
850 {
851 return pg_last_error($this->db);
852 }
853
854 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
862 public function last_insert_id($tab, $fieldid = 'rowid')
863 {
864 // phpcs:enable
865 //$result = pg_query($this->db,"SELECT MAX(".$fieldid.") FROM ".$tab);
866 $result = pg_query($this->db, "SELECT currval('".$tab."_".$fieldid."_seq')");
867 if (!$result) {
868 print pg_last_error($this->db);
869 exit;
870 }
871 //$nbre = pg_num_rows($result);
872 $row = pg_fetch_result($result, 0, 0);
873 return (int) $row;
874 }
875
884 public function encrypt($fieldorvalue, $withQuotes = 1)
885 {
886 //global $conf;
887
888 // Type of encryption (2: AES (recommended), 1: DES , 0: no encryption)
889 //$cryptType = ($conf->db->dolibarr_main_db_encryption ? $conf->db->dolibarr_main_db_encryption : 0);
890
891 //Encryption key
892 //$cryptKey = (!empty($conf->db->dolibarr_main_db_cryptkey) ? $conf->db->dolibarr_main_db_cryptkey : '');
893
894 $return = $fieldorvalue;
895 return ($withQuotes ? "'" : "").$this->escape($return).($withQuotes ? "'" : "");
896 }
897
898
905 public function decrypt($value)
906 {
907 //global $conf;
908
909 // Type of encryption (2: AES (recommended), 1: DES , 0: no encryption)
910 //$cryptType = ($conf->db->dolibarr_main_db_encryption ? $conf->db->dolibarr_main_db_encryption : 0);
911
912 //Encryption key
913 //$cryptKey = (!empty($conf->db->dolibarr_main_db_cryptkey) ? $conf->db->dolibarr_main_db_cryptkey : '');
914
915 $return = $value;
916 return $return;
917 }
918
919
920 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
926 public function DDLGetConnectId()
927 {
928 // phpcs:enable
929 return '?';
930 }
931
932
933
934 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
946 public function DDLCreateDb($database, $charset = '', $collation = '', $owner = '')
947 {
948 // phpcs:enable
949 if (empty($charset)) {
950 $charset = $this->forcecharset;
951 }
952 if (empty($collation)) {
953 $collation = $this->forcecollate;
954 }
955
956 // Test charset match LC_TYPE (pgsql error otherwise)
957 //print $charset.' '.setlocale(LC_CTYPE,'0'); exit;
958
959 // NOTE: Do not use ' around the database name
960 $sql = "CREATE DATABASE ".$this->escape($database)." OWNER '".$this->escape($owner)."' ENCODING '".$this->escape((string) $charset)."'";
961
962 dol_syslog($sql, LOG_DEBUG);
963 $ret = $this->query($sql);
964
965 return $ret;
966 }
967
968 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
976 public function DDLListTables($database, $table = '')
977 {
978 // phpcs:enable
979 $listtables = array();
980
981 $escapedlike = '';
982 if ($table) {
983 $tmptable = preg_replace('/[^a-z0-9\.\-\_%]/i', '', $table);
984
985 $escapedlike = " AND table_name LIKE '".$this->escape($tmptable)."'";
986 }
987 $result = pg_query($this->db, "SELECT table_name FROM information_schema.tables WHERE table_schema = 'public'".$escapedlike." ORDER BY table_name");
988 if ($result) {
989 while ($row = $this->fetch_row($result)) { // @phan-suppress-current-line PhanTypeMismatchArgumentProbablyReal
990 $listtables[] = $row[0];
991 }
992 }
993 return $listtables;
994 }
995
996 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1004 public function DDLListTablesFull($database, $table = '')
1005 {
1006 // phpcs:enable
1007 $listtables = array();
1008
1009 $escapedlike = '';
1010 if ($table) {
1011 $tmptable = preg_replace('/[^a-z0-9\.\-\_%]/i', '', $table);
1012
1013 $escapedlike = " AND table_name LIKE '".$this->escape($tmptable)."'";
1014 }
1015 $result = pg_query($this->db, "SELECT table_name, table_type FROM information_schema.tables WHERE table_schema = 'public'".$escapedlike." ORDER BY table_name");
1016 if ($result) {
1017 while ($row = $this->fetch_row($result)) { // @phan-suppress-current-line PhanTypeMismatchArgumentProbablyReal
1018 $listtables[] = $row;
1019 }
1020 }
1021 return $listtables;
1022 }
1023
1024 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1031 public function DDLInfoTable($table)
1032 {
1033 // phpcs:enable
1034 $infotables = array();
1035
1036 $sql = "SELECT ";
1037 $sql .= " infcol.column_name as \"Column\","; // pgsql need " for alias names !
1038 $sql .= " CASE WHEN infcol.character_maximum_length IS NOT NULL THEN infcol.udt_name || '('||infcol.character_maximum_length||')'";
1039 $sql .= " ELSE infcol.udt_name";
1040 $sql .= " END as \"Type\","; // pgsql need " for alias names !
1041 $sql .= " infcol.collation_name as \"Collation\","; // pgsql need " for alias names !
1042 $sql .= " infcol.is_nullable as \"Null\","; // pgsql need " for alias names !
1043 $sql .= " '' as \"Key\","; // pgsql need " for alias names !
1044 $sql .= " infcol.column_default as \"Default\","; // pgsql need " for alias names !
1045 $sql .= " '' as \"Extra\","; // pgsql need " for alias names !
1046 $sql .= " '' as \"Privileges\""; // pgsql need " for alias names !
1047 $sql .= " FROM information_schema.columns infcol";
1048 $sql .= " WHERE table_schema = 'public' ";
1049 $sql .= " AND table_name = '".$this->escape($table)."'";
1050 $sql .= " ORDER BY ordinal_position;";
1051
1052 $result = $this->query($sql);
1053 if ($result) {
1054 while ($row = $this->fetch_row($result)) {
1055 $infotables[] = $row;
1056 }
1057 }
1058 return $infotables;
1059 }
1060
1061
1062 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1075 public function DDLCreateTable($table, $fields, $primary_key, $type, $unique_keys = null, $fulltext_keys = null, $keys = null)
1076 {
1077 // phpcs:enable
1078 // @TODO: $fulltext_keys parameter is unused
1079
1080 $sqlk = array();
1081 $sqluq = array();
1082
1083 // Keys found into the array $fields: type,value,attribute,null,default,extra
1084 // ex. : $fields['rowid'] = array(
1085 // 'type'=>'int' or 'integer',
1086 // 'value'=>'11',
1087 // 'null'=>'not null',
1088 // 'extra'=> 'auto_increment'
1089 // );
1090 $sql = "CREATE TABLE ".$this->sanitize($table)."(";
1091 $i = 0;
1092 $sqlfields = array();
1093 foreach ($fields as $field_name => $field_desc) {
1094 $sqlfields[$i] = $this->sanitize($field_name)." ";
1095 $sqlfields[$i] .= $this->sanitize($field_desc['type']);
1096 if (isset($field_desc['value']) && $field_desc['value'] !== '') {
1097 $sqlfields[$i] .= "(".$this->sanitize($field_desc['value']).")";
1098 }
1099 if (isset($field_desc['attribute']) && $field_desc['attribute'] !== '') {
1100 $sqlfields[$i] .= " ".$this->sanitize($field_desc['attribute']);
1101 }
1102 if (isset($field_desc['default']) && $field_desc['default'] !== '') {
1103 if (in_array($field_desc['type'], array('tinyint', 'smallint', 'int', 'double'))) {
1104 $sqlfields[$i] .= " DEFAULT ".((float) $field_desc['default']);
1105 } elseif ($field_desc['default'] == 'null' || $field_desc['default'] == 'CURRENT_TIMESTAMP') {
1106 $sqlfields[$i] .= " DEFAULT ".$this->sanitize($field_desc['default']);
1107 } else {
1108 $sqlfields[$i] .= " DEFAULT '".$this->escape($field_desc['default'])."'";
1109 }
1110 }
1111 if (isset($field_desc['null']) && $field_desc['null'] !== '') {
1112 $sqlfields[$i] .= " ".$this->sanitize($field_desc['null'], 0, 0, 1);
1113 }
1114 if (isset($field_desc['extra']) && $field_desc['extra'] !== '') {
1115 $sqlfields[$i] .= " ".$this->sanitize($field_desc['extra'], 0, 0, 1);
1116 }
1117 if (!empty($primary_key) && $primary_key == $field_name) {
1118 $sqlfields[$i] .= " AUTO_INCREMENT PRIMARY KEY"; // mysql instruction that will be converted by driver late
1119 }
1120 $i++;
1121 }
1122
1123 if (is_array($unique_keys)) {
1124 $i = 0;
1125 foreach ($unique_keys as $key => $value) {
1126 $sqluq[$i] = "UNIQUE KEY '".$this->sanitize($key)."' ('".$this->escape($value)."')";
1127 $i++;
1128 }
1129 }
1130 if (is_array($keys)) {
1131 $i = 0;
1132 foreach ($keys as $key => $value) {
1133 $sqlk[$i] = "KEY ".$this->sanitize($key)." (".$value.")";
1134 $i++;
1135 }
1136 }
1137 $sql .= implode(', ', $sqlfields);
1138 if ($unique_keys != "") {
1139 $sql .= ",".implode(',', $sqluq);
1140 }
1141 if (is_array($keys)) {
1142 $sql .= ",".implode(',', $sqlk);
1143 }
1144 $sql .= ")";
1145 //$sql .= " engine=".$this->sanitize($type);
1146
1147 if (!$this->query($sql, 1)) {
1148 return -1;
1149 } else {
1150 return 1;
1151 }
1152 }
1153
1154 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1161 public function DDLDropTable($table)
1162 {
1163 // phpcs:enable
1164 $tmptable = preg_replace('/[^a-z0-9\.\-\_]/i', '', $table);
1165
1166 $sql = "DROP TABLE ".$this->sanitize($tmptable);
1167
1168 if (!$this->query($sql, 1)) {
1169 return -1;
1170 } else {
1171 return 1;
1172 }
1173 }
1174
1175 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1183 public function DDLDescTable($table, $field = "")
1184 {
1185 // phpcs:enable
1186 $sql = "SELECT attname FROM pg_attribute, pg_type WHERE typname = '".$this->escape($table)."' AND attrelid = typrelid";
1187 $sql .= " AND attname NOT IN ('cmin', 'cmax', 'ctid', 'oid', 'tableoid', 'xmin', 'xmax')";
1188 if ($field) {
1189 $sql .= " AND attname = '".$this->escape($field)."'";
1190 }
1191
1192 dol_syslog($sql, LOG_DEBUG);
1193 $this->_results = $this->query($sql);
1194 return $this->_results;
1195 }
1196
1197 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1207 public function DDLAddField($table, $field_name, $field_desc, $field_position = "")
1208 {
1209 // phpcs:enable
1210 // cles recherchees dans le tableau des descriptions (field_desc) : type,value,attribute,null,default,extra
1211 // ex. : $field_desc = array('type'=>'int','value'=>'11','null'=>'not null','extra'=> 'auto_increment');
1212 $sql = "ALTER TABLE ".$this->sanitize($table)." ADD ".$this->sanitize($field_name)." ";
1213 $sql .= $this->sanitize($field_desc['type']);
1214 if (isset($field_desc['value']) && preg_match("/^[^\s]/i", $field_desc['value'])) {
1215 if (!in_array($field_desc['type'], array('tinyint', 'smallint', 'int', 'date', 'datetime')) && $field_desc['value']) {
1216 $sql .= "(".$this->sanitize($field_desc['value']).")";
1217 }
1218 }
1219 if (isset($field_desc['attribute']) && preg_match("/^[^\s]/i", $field_desc['attribute'])) {
1220 $sql .= " ".$this->sanitize($field_desc['attribute']);
1221 }
1222 if (isset($field_desc['null']) && preg_match("/^[^\s]/i", $field_desc['null'])) {
1223 if ($field_desc['null'] == 'NOT NULL') {
1224 $sql .= " ".$this->sanitize($field_desc['null'], 0, 0, 1);
1225 } else {
1226 $sql .= " ".$this->sanitize($field_desc['null']);
1227 }
1228 }
1229 if (isset($field_desc['default']) && preg_match("/^[^\s]/i", $field_desc['default'])) {
1230 if (in_array($field_desc['type'], array('tinyint', 'smallint', 'int', 'double'))) {
1231 $sql .= " DEFAULT ".((float) $field_desc['default']);
1232 } elseif ($field_desc['default'] == 'null' || $field_desc['default'] == 'CURRENT_TIMESTAMP') {
1233 $sql .= " DEFAULT ".$this->sanitize($field_desc['default']);
1234 } else {
1235 $sql .= " DEFAULT '".$this->escape($field_desc['default'])."'";
1236 }
1237 }
1238 if (isset($field_desc['extra']) && preg_match("/^[^\s]/i", $field_desc['extra'])) {
1239 $sql .= " ".$this->sanitize($field_desc['extra'], 0, 0, 1);
1240 }
1241 $sql .= " ".$this->sanitize($field_position, 0, 0, 1);
1242
1243 dol_syslog($sql, LOG_DEBUG);
1244 if (!$this -> query($sql)) {
1245 return -1;
1246 }
1247 return 1;
1248 }
1249
1250 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1259 public function DDLUpdateField($table, $field_name, $field_desc)
1260 {
1261 // phpcs:enable
1262 $sql = "ALTER TABLE ".$this->sanitize($table);
1263 $sql .= " ALTER COLUMN ".$this->sanitize($field_name)." TYPE ".$this->sanitize($field_desc['type']);
1264 if (isset($field_desc['value']) && preg_match("/^[^\s]/i", $field_desc['value'])) {
1265 if (!in_array($field_desc['type'], array('smallint', 'int', 'date', 'datetime')) && $field_desc['value']) {
1266 $sql .= "(".$this->sanitize($field_desc['value']).")";
1267 }
1268 }
1269
1270 if (isset($field_desc['null']) && ($field_desc['null'] == 'not null' || $field_desc['null'] == 'NOT NULL')) {
1271 // 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
1272 if ($field_desc['type'] == 'varchar' || $field_desc['type'] == 'text') {
1273 $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";
1274 $this->query($sqlbis);
1275 } elseif (in_array($field_desc['type'], array('tinyint', 'smallint', 'int', 'double'))) {
1276 $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";
1277 $this->query($sqlbis);
1278 }
1279 }
1280
1281 if (isset($field_desc['default']) && $field_desc['default'] != '') {
1282 if (in_array($field_desc['type'], array('tinyint', 'smallint', 'int', 'double'))) {
1283 $sql .= ", ALTER COLUMN ".$this->sanitize($field_name)." SET DEFAULT ".((float) $field_desc['default']);
1284 } elseif ($field_desc['type'] != 'text') { // Default not supported on text fields ?
1285 $sql .= ", ALTER COLUMN ".$this->sanitize($field_name)." SET DEFAULT '".$this->escape($field_desc['default'])."'";
1286 }
1287 }
1288
1289 dol_syslog($sql, LOG_DEBUG);
1290 if (!$this->query($sql)) {
1291 return -1;
1292 }
1293 return 1;
1294 }
1295
1296 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1304 public function DDLDropField($table, $field_name)
1305 {
1306 // phpcs:enable
1307 $tmp_field_name = preg_replace('/[^a-z0-9\.\-\_]/i', '', $field_name);
1308
1309 $sql = "ALTER TABLE ".$this->sanitize($table)." DROP COLUMN ".$this->sanitize($tmp_field_name);
1310 if (!$this->query($sql)) {
1311 $this->error = $this->lasterror();
1312 return -1;
1313 }
1314 return 1;
1315 }
1316
1317 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
1327 public function DDLCreateUser($dolibarr_main_db_host, $dolibarr_main_db_user, $dolibarr_main_db_pass, $dolibarr_main_db_name)
1328 {
1329 // phpcs:enable
1330 // Note: using ' on user does not works with pgsql
1331 $sql = "CREATE USER ".$this->sanitize($dolibarr_main_db_user)." with password '".$this->escape($dolibarr_main_db_pass)."'";
1332
1333 dol_syslog(get_class($this)."::DDLCreateUser", LOG_DEBUG); // No sql to avoid password in log
1334 $resql = $this->query($sql);
1335 if (!$resql) {
1336 return -1;
1337 }
1338
1339 return 1;
1340 }
1341
1348 {
1349 $resql = $this->query('SHOW SERVER_ENCODING');
1350 if ($resql) {
1351 $liste = $this->fetch_array($resql);
1352 return $liste['server_encoding'];
1353 } else {
1354 return '';
1355 }
1356 }
1357
1363 public function getListOfCharacterSet()
1364 {
1365 $resql = $this->query('SHOW SERVER_ENCODING');
1366 $liste = array();
1367 if ($resql) {
1368 $i = 0;
1369 while ($obj = $this->fetch_object($resql)) {
1370 $liste[$i]['charset'] = $obj->server_encoding;
1371 $liste[$i]['description'] = 'Default database charset';
1372 $i++;
1373 }
1374 $this->free($resql);
1375 } else {
1376 return null;
1377 }
1378 return $liste;
1379 }
1380
1387 {
1388 $resql = $this->query('SHOW LC_COLLATE');
1389 if ($resql) {
1390 $liste = $this->fetch_array($resql);
1391 return $liste['lc_collate'];
1392 } else {
1393 return '';
1394 }
1395 }
1396
1402 public function getListOfCollation()
1403 {
1404 $resql = $this->query('SHOW LC_COLLATE');
1405 $liste = array();
1406 if ($resql) {
1407 $i = 0;
1408 while ($obj = $this->fetch_object($resql)) {
1409 $liste[$i]['collation'] = $obj->lc_collate;
1410 $i++;
1411 }
1412 $this->free($resql);
1413 } else {
1414 return null;
1415 }
1416 return $liste;
1417 }
1418
1424 public function getPathOfDump()
1425 {
1426 $fullpathofdump = '/pathtopgdump/pg_dump';
1427
1428 if (file_exists('/usr/bin/pg_dump')) {
1429 $fullpathofdump = '/usr/bin/pg_dump';
1430 } else {
1431 // TODO L'utilisateur de la base doit etre un superadmin pour lancer cette commande
1432 $resql = $this->query('SHOW data_directory');
1433 if ($resql) {
1434 $liste = $this->fetch_array($resql);
1435 $basedir = $liste['data_directory'];
1436 $fullpathofdump = preg_replace('/data$/', 'bin', $basedir).'/pg_dump';
1437 }
1438 }
1439
1440 return $fullpathofdump;
1441 }
1442
1448 public function getPathOfRestore()
1449 {
1450 //$tool='pg_restore';
1451 $tool = 'psql';
1452
1453 $fullpathofdump = '/pathtopgrestore/'.$tool;
1454
1455 if (file_exists('/usr/bin/'.$tool)) {
1456 $fullpathofdump = '/usr/bin/'.$tool;
1457 } else {
1458 // TODO L'utilisateur de la base doit etre un superadmin pour lancer cette commande
1459 $resql = $this->query('SHOW data_directory');
1460 if ($resql) {
1461 $liste = $this->fetch_array($resql);
1462 $basedir = $liste['data_directory'];
1463 $fullpathofdump = preg_replace('/data$/', 'bin', $basedir).'/'.$tool;
1464 }
1465 }
1466
1467 return $fullpathofdump;
1468 }
1469
1476 public function getServerParametersValues($filter = '')
1477 {
1478 $result = array();
1479
1480 $resql = 'select name,setting from pg_settings';
1481 if ($filter) {
1482 $resql .= " WHERE name = '".$this->escape($filter)."'";
1483 }
1484 $resql = $this->query($resql);
1485 if ($resql) {
1486 while ($obj = $this->fetch_object($resql)) {
1487 $result[$obj->name] = $obj->setting;
1488 }
1489 }
1490
1491 return $result;
1492 }
1493
1500 public function getServerStatusValues($filter = '')
1501 {
1502 /* This is to return current running requests.
1503 $sql='SELECT datname,procpid,current_query FROM pg_stat_activity ORDER BY procpid';
1504 if ($filter) $sql.=" LIKE '".$this->escape($filter)."'";
1505 $resql=$this->query($sql);
1506 if ($resql)
1507 {
1508 $obj=$this->fetch_object($resql);
1509 $result[$obj->Variable_name]=$obj->Value;
1510 }
1511 */
1512
1513 return array();
1514 }
1515}
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 in 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 a Dolibarr global constant string value.
dol_syslog($message, $level=LOG_INFO, $ident=0, $suffixinfilename='', $restricttologhandler='', $logcontext=null)
Write log message into outputs.
global $conf
The following vars must be defined: $type2label $form $conf, $lang, The following vars may also be de...
Definition member.php:79