/htdocs/core/db/pgsql.class.php
PHP | 1337 lines | 744 code | 137 blank | 456 comment | 132 complexity | 5a1a6350b1d511a3696b28b7e9b7b046 MD5 | raw file
Possible License(s): LGPL-2.0
- <?php
- /* Copyright (C) 2001 Fabien Seisen <seisen@linuxfr.org>
- * Copyright (C) 2002-2005 Rodolphe Quiedeville <rodolphe@quiedeville.org>
- * Copyright (C) 2004-2010 Laurent Destailleur <eldy@users.sourceforge.net>
- * Copyright (C) 2004 Sebastien Di Cintio <sdicintio@ressource-toi.org>
- * Copyright (C) 2004 Benoit Mortier <benoit.mortier@opensides.be>
- * Copyright (C) 2005-2009 Regis Houssin <regis@dolibarr.fr>
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program. If not, see <http://www.gnu.org/licenses/>.
- */
- /**
- * \file htdocs/core/db/pgsql.class.php
- * \brief Fichier de la classe permettant de gerer une base pgsql
- */
- /**
- * \class DoliDBPgsql
- * \brief Class to drive a Postgresql database for Dolibarr
- */
- class DoliDBPgsql
- {
- var $db; // Database handler
- var $type='pgsql'; // Name of manager
- var $label='PostgreSQL'; // Label of manager
- //! Charset
- var $forcecharset='latin1';
- var $versionmin=array(8,4,0); // Version min database
- var $results; // Resultset de la derniere requete
- var $connected; // 1 si connecte, 0 sinon
- var $database_selected; // 1 si base selectionne, 0 sinon
- var $database_name; //! Nom base selectionnee
- var $database_user; //! Nom user base
- var $transaction_opened; // 1 si une transaction est en cours, 0 sinon
- var $lastquery;
- var $lastqueryerror; // Ajout d'une variable en cas d'erreur
- var $unescapeslashquot=0; // By default we do not force the unescape of \'. This is used only to process sql with mysql escaped data.
- var $standard_conforming_strings=1; // Database has option standard_conforming_strings to on
- var $ok;
- var $error;
- var $lasterror;
- /**
- * Constructor.
- * This create an opened connexion to a database server and eventually to a database
- *
- * @param string $type Type of database (mysql, pgsql...)
- * @param string $host Address of database server
- * @param string $user Nom de l'utilisateur autorise
- * @param string $pass Mot de passe
- * @param string $name Nom de la database
- * @param int $port Port of database server
- * @return int 1 if OK, 0 if not
- */
- function DoliDBPgsql($type, $host, $user, $pass, $name='', $port=0)
- {
- global $conf,$langs;
- $this->forcecharset=$conf->file->character_set_client;
- $this->forcecollate=$conf->db->dolibarr_main_db_collation;
- $this->database_user=$user;
- $this->transaction_opened=0;
- //print "Name DB: $host,$user,$pass,$name<br>";
- if (! function_exists("pg_connect"))
- {
- $this->connected = 0;
- $this->ok = 0;
- $this->error="Pgsql PHP functions are not available in this version of PHP";
- dol_syslog("DoliDB::DoliDB : Pgsql PHP functions are not available in this version of PHP",LOG_ERR);
- return $this->ok;
- }
- if (! $host)
- {
- $this->connected = 0;
- $this->ok = 0;
- $this->error=$langs->trans("ErrorWrongHostParameter");
- dol_syslog("DoliDB::DoliDB : Erreur Connect, wrong host parameters",LOG_ERR);
- return $this->ok;
- }
- // Essai connexion serveur
- //print "$host, $user, $pass, $name, $port";
- $this->db = $this->connect($host, $user, $pass, $name, $port);
- if ($this->db)
- {
- $this->connected = 1;
- $this->ok = 1;
- }
- else
- {
- // host, login ou password incorrect
- $this->connected = 0;
- $this->ok = 0;
- $this->error='Host, login or password incorrect';
- dol_syslog("DoliDB::DoliDB : Erreur Connect ".$this->error,LOG_ERR);
- }
- // Si connexion serveur ok et si connexion base demandee, on essaie connexion base
- if ($this->connected && $name)
- {
- if ($this->select_db($name))
- {
- $this->database_selected = 1;
- $this->database_name = $name;
- $this->ok = 1;
- }
- else
- {
- $this->database_selected = 0;
- $this->database_name = '';
- $this->ok = 0;
- $this->error=$this->error();
- dol_syslog("DoliDB::DoliDB : Erreur Select_db ".$this->error,LOG_ERR);
- }
- }
- else
- {
- // Pas de selection de base demandee, ok ou ko
- $this->database_selected = 0;
- }
- return $this->ok;
- }
- /**
- * Convert a SQL request in Mysql syntax to native syntax
- *
- * @param string $line SQL request line to convert
- * @param string $type Type of SQL order ('ddl' for insert, update, select, delete or 'dml' for create, alter...)
- * @return string SQL request line converted
- */
- function convertSQLFromMysql($line,$type='auto')
- {
- // Removed empty line if this is a comment line for SVN tagging
- if (preg_match('/^--\s\$Id/i',$line)) {
- return '';
- }
- // Return line if this is a comment
- if (preg_match('/^#/i',$line) || preg_match('/^$/i',$line) || preg_match('/^--/i',$line))
- {
- return $line;
- }
- if ($line != "")
- {
- if ($type == 'auto')
- {
- if (preg_match('/ALTER TABLE/i',$line)) $type='dml';
- else if (preg_match('/CREATE TABLE/i',$line)) $type='dml';
- else if (preg_match('/DROP TABLE/i',$line)) $type='dml';
- }
- if ($type == 'dml')
- {
- $line=preg_replace('/\s/',' ',$line); // Replace tabulation with space
- // we are inside create table statement so lets process datatypes
- if (preg_match('/(ISAM|innodb)/i',$line)) { // end of create table sequence
- $line=preg_replace('/\)[\s\t]*type[\s\t]*=[\s\t]*(MyISAM|innodb);/i',');',$line);
- $line=preg_replace('/\)[\s\t]*engine[\s\t]*=[\s\t]*(MyISAM|innodb);/i',');',$line);
- $line=preg_replace('/,$/','',$line);
- }
- // Process case: "CREATE TABLE llx_mytable(rowid integer NOT NULL AUTO_INCREMENT PRIMARY KEY,code..."
- if (preg_match('/[\s\t\(]*(\w*)[\s\t]+int.*auto_increment/i',$line,$reg)) {
- $newline=preg_replace('/([\s\t\(]*)([a-zA-Z_0-9]*)[\s\t]+int.*auto_increment[^,]*/i','\\1 \\2 SERIAL PRIMARY KEY',$line);
- //$line = "-- ".$line." replaced by --\n".$newline;
- $line=$newline;
- }
- // tinyint type conversion
- $line=str_replace('tinyint','smallint',$line);
- // nuke unsigned
- $line=preg_replace('/(int\w+|smallint)\s+unsigned/i','\\1',$line);
- // blob -> text
- $line=preg_replace('/\w*blob/i','text',$line);
- // tinytext/mediumtext -> text
- $line=preg_replace('/tinytext/i','text',$line);
- $line=preg_replace('/mediumtext/i','text',$line);
- // change not null datetime field to null valid ones
- // (to support remapping of "zero time" to null
- $line=preg_replace('/datetime not null/i','datetime',$line);
- $line=preg_replace('/datetime/i','timestamp',$line);
- // double -> numeric
- $line=preg_replace('/^double/i','numeric',$line);
- $line=preg_replace('/(\s*)double/i','\\1numeric',$line);
- // float -> numeric
- $line=preg_replace('/^float/i','numeric',$line);
- $line=preg_replace('/(\s*)float/i','\\1numeric',$line);
- // unique index(field1,field2)
- if (preg_match('/unique index\s*\((\w+\s*,\s*\w+)\)/i',$line))
- {
- $line=preg_replace('/unique index\s*\((\w+\s*,\s*\w+)\)/i','UNIQUE\(\\1\)',$line);
- }
- // We remove end of requests "AFTER fieldxxx"
- $line=preg_replace('/AFTER [a-z0-9_]+/i','',$line);
- // We remove start of requests "ALTER TABLE tablexxx" if this is a DROP INDEX
- $line=preg_replace('/ALTER TABLE [a-z0-9_]+ DROP INDEX/i','DROP INDEX',$line);
- // Translate order to rename fields
- if (preg_match('/ALTER TABLE ([a-z0-9_]+) CHANGE(?: COLUMN)? ([a-z0-9_]+) ([a-z0-9_]+)(.*)$/i',$line,$reg))
- {
- $line = "-- ".$line." replaced by --\n";
- $line.= "ALTER TABLE ".$reg[1]." RENAME COLUMN ".$reg[2]." TO ".$reg[3];
- }
- // Translate order to modify field format
- if (preg_match('/ALTER TABLE ([a-z0-9_]+) MODIFY(?: COLUMN)? ([a-z0-9_]+) (.*)$/i',$line,$reg))
- {
- $line = "-- ".$line." replaced by --\n";
- $newreg3=$reg[3];
- $newreg3=preg_replace('/ DEFAULT NULL/i','',$newreg3);
- $newreg3=preg_replace('/ NOT NULL/i','',$newreg3);
- $newreg3=preg_replace('/ NULL/i','',$newreg3);
- $newreg3=preg_replace('/ DEFAULT 0/i','',$newreg3);
- $newreg3=preg_replace('/ DEFAULT \'[0-9a-zA-Z_@]*\'/i','',$newreg3);
- $line.= "ALTER TABLE ".$reg[1]." ALTER COLUMN ".$reg[2]." TYPE ".$newreg3;
- // TODO Add alter to set default value or null/not null if there is this in $reg[3]
- }
- // alter table add primary key (field1, field2 ...) -> We remove the primary key name not accepted by PostGreSQL
- // ALTER TABLE llx_dolibarr_modules ADD PRIMARY KEY pk_dolibarr_modules (numero, entity);
- if (preg_match('/ALTER\s+TABLE\s*(.*)\s*ADD\s+PRIMARY\s+KEY\s*(.*)\s*\((.*)$/i',$line,$reg))
- {
- $line = "-- ".$line." replaced by --\n";
- $line.= "ALTER TABLE ".$reg[1]." ADD PRIMARY KEY (".$reg[3];
- }
- // Translate order to drop foreign keys
- // ALTER TABLE llx_dolibarr_modules DROP FOREIGN KEY fk_xxx;
- if (preg_match('/ALTER\s+TABLE\s*(.*)\s*DROP\s+FOREIGN\s+KEY\s*(.*)$/i',$line,$reg))
- {
- $line = "-- ".$line." replaced by --\n";
- $line.= "ALTER TABLE ".$reg[1]." DROP CONSTRAINT ".$reg[2];
- }
- // alter table add [unique] [index] (field1, field2 ...)
- // ALTER TABLE llx_accountingaccount ADD INDEX idx_accountingaccount_fk_pcg_version (fk_pcg_version)
- if (preg_match('/ALTER\s+TABLE\s*(.*)\s*ADD\s+(UNIQUE INDEX|INDEX|UNIQUE)\s+(.*)\s*\(([\w,\s]+)\)/i',$line,$reg))
- {
- $fieldlist=$reg[4];
- $idxname=$reg[3];
- $tablename=$reg[1];
- $line = "-- ".$line." replaced by --\n";
- $line.= "CREATE ".(preg_match('/UNIQUE/',$reg[2])?'UNIQUE ':'')."INDEX ".$idxname." ON ".$tablename." (".$fieldlist.")";
- }
- }
- // To have postgresql case sensitive
- $line=str_replace(' LIKE \'',' ILIKE \'',$line);
- // Delete using criteria on other table must not declare twice the deleted table
- // DELETE FROM tabletodelete USING tabletodelete, othertable -> DELETE FROM tabletodelete USING othertable
- if (preg_match('/DELETE FROM ([a-z_]+) USING ([a-z_]+), ([a-z_]+)/i',$line,$reg))
- {
- if ($reg[1] == $reg[2]) // If same table, we remove second one
- {
- $line=preg_replace('/DELETE FROM ([a-z_]+) USING ([a-z_]+), ([a-z_]+)/i','DELETE FROM \\1 USING \\3', $line);
- }
- }
- // Remove () in the tables in FROM if one table
- $line=preg_replace('/FROM\s*\((([a-z_]+)\s+as\s+([a-z_]+)\s*)\)/i','FROM \\1',$line);
- //print $line."\n";
- // Remove () in the tables in FROM if two table
- $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);
- //print $line."\n";
- // Remove () in the tables in FROM if two table
- $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);
- //print $line."\n";
- // Replace espacing \' by ''.
- // By default we do not (should be already done by db->escape function if required)
- if (! empty($this->unescapeslashquot))
- {
- // Except for sql insert in data file that
- // are mysql escaped so we removed them to be compatible with standard_conforming_strings=on
- // that considers \ as ordinary character).
- if ($this->standard_conforming_strings)
- {
- $line=preg_replace("/\\\'/","''",$line);
- }
- }
- //print "type=".$type." newline=".$line."<br>\n";
- }
- return $line;
- }
- /**
- * Select a database
- * Ici postgresql n'a aucune fonction equivalente de mysql_select_db
- * On compare juste manuellement si la database choisie est bien celle activee par la connexion
- *
- * @param string $database Name of database
- * @return boolean true if OK, false if KO
- */
- function select_db($database)
- {
- if ($database == $this->database_name) return true;
- else return false;
- }
- /**
- * Connexion to server
- *
- * @param string $host database server host
- * @param string $login login
- * @param string $passwd password
- * @param string $name name of database (not used for mysql, used for pgsql)
- * @param string $port Port of database server
- * @return resource Database access handler
- * @see close
- */
- function connect($host, $login, $passwd, $name, $port=0)
- {
- if (!$name){
- $name="postgres";
- }
- if (!$port){
- $port=5432;
- }
- $con_string = "host=$host port=$port dbname=$name user=$login password=$passwd";
- //print 'xxx'.$con_string;
- //$this->db = pg_pconnect($con_string); // To us persistent connection because this one cost 1ms, non ersisten cost 30ms
- $this->db = pg_connect($con_string);
- if ($this->db)
- {
- $this->database_name = $name;
- pg_set_error_verbosity($this->db, PGSQL_ERRORS_VERBOSE); // Set verbosity to max
- }
- return $this->db;
- }
- /**
- * Return label of manager
- *
- * @return string Label
- */
- function getLabel()
- {
- return $this->label;
- }
- /**
- * Return version of database server
- *
- * @return string Version string
- */
- function getVersion()
- {
- $resql=$this->query('SHOW server_version');
- if ($resql)
- {
- $liste=$this->fetch_array($resql);
- return $liste['server_version'];
- }
- return '';
- }
- /**
- * Return version of database server into an array
- *
- * @return array Version array
- */
- function getVersionArray()
- {
- return explode('.',$this->getVersion());
- }
- /**
- * Close database connexion
- *
- * @return boolean True if disconnect successfull, false otherwise
- * @see connect
- */
- function close()
- {
- if ($this->db)
- {
- //dol_syslog("DoliDB::disconnect",LOG_DEBUG);
- $this->connected=0;
- return pg_close($this->db);
- }
- return false;
- }
- /**
- * Start transaction
- *
- * @return int 1 if transaction successfuly opened or already opened, 0 if error
- */
- function begin()
- {
- if (! $this->transaction_opened)
- {
- $ret=$this->query("BEGIN;");
- if ($ret)
- {
- $this->transaction_opened++;
- dol_syslog("BEGIN Transaction",LOG_DEBUG);
- }
- return $ret;
- }
- else
- {
- $this->transaction_opened++;
- return 1;
- }
- }
- /**
- * Validate a database transaction
- *
- * @param log Add more log to default log line
- * @return int 1 if validation is OK or transaction level no started, 0 if ERROR
- */
- function commit($log='')
- {
- if ($this->transaction_opened<=1)
- {
- $ret=$this->query("COMMIT;");
- if ($ret)
- {
- $this->transaction_opened=0;
- dol_syslog("COMMIT Transaction",LOG_DEBUG);
- }
- return $ret;
- }
- else
- {
- $this->transaction_opened--;
- return 1;
- }
- }
- /**
- * Annulation d'une transaction et retour aux anciennes valeurs
- * @return int 1 si annulation ok ou transaction non ouverte, 0 en cas d'erreur
- */
- function rollback()
- {
- if ($this->transaction_opened<=1)
- {
- $ret=$this->query("ROLLBACK;");
- $this->transaction_opened=0;
- dol_syslog("ROLLBACK Transaction",LOG_DEBUG);
- return $ret;
- }
- else
- {
- $this->transaction_opened--;
- return 1;
- }
- }
- /**
- * Convert request to PostgreSQL syntax, execute it and return the resultset
- *
- * @param query SQL query string
- * @param usesavepoint 0=Default mode, 1=Run a savepoint before and a rollback to savepoint if error (this allow to have some request with errors inside global transactions).
- * @param type Type of SQL order ('ddl' for insert, update, select, delete or 'dml' for create, alter...)
- * @return resource Resultset of answer
- */
- function query($query,$usesavepoint=0,$type='auto')
- {
- $query = trim($query);
- // Convert MySQL syntax to PostgresSQL syntax
- $query=$this->convertSQLFromMysql($query,$type);
- //print "FF\n".$query."<br>\n";
- // Fix bad formed requests. If request contains a date without quotes, we fix this but this should not occurs.
- $loop=true;
- while ($loop)
- {
- 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))
- {
- $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);
- dol_syslog("Warning: Bad formed request converted into ".$query,LOG_WARNING);
- }
- else $loop=false;
- }
- if ($usesavepoint && $this->transaction_opened)
- {
- @pg_query($this->db, 'SAVEPOINT mysavepoint');
- }
- $ret = @pg_query($this->db, $query);
- //print $query;
- if (! preg_match("/^COMMIT/i",$query) && ! preg_match("/^ROLLBACK/i",$query)) // Si requete utilisateur, on la sauvegarde ainsi que son resultset
- {
- if (! $ret)
- {
- $this->lastqueryerror = $query;
- $this->lasterror = $this->error();
- $this->lasterrno = $this->errno();
- dol_syslog("Pgsql.lib::query SQL error: ".$query." ".$this->lasterrno, LOG_WARNING);
- //print "\n>> ".$query."<br>\n";
- //print '>> '.$this->lasterrno.' - '.$this->lasterror.' - '.$this->lastqueryerror."<br>\n";
- if ($usesavepoint && $this->transaction_opened)
- {
- @pg_query($this->db, 'ROLLBACK TO SAVEPOINT mysavepoint');
- }
- }
- $this->lastquery=$query;
- $this->results = $ret;
- }
- return $ret;
- }
- /**
- * Renvoie la ligne courante (comme un objet) pour le curseur resultset
- *
- * @param resultset Curseur de la requete voulue
- * @return object Object result line or false if KO or end of cursor
- */
- function fetch_object($resultset)
- {
- // If resultset not provided, we take the last used by connexion
- if (! is_resource($resultset)) { $resultset=$this->results; }
- return pg_fetch_object($resultset);
- }
- /**
- * Renvoie les donnees dans un tableau
- *
- * @param resultset Curseur de la requete voulue
- * @return array
- */
- function fetch_array($resultset)
- {
- // If resultset not provided, we take the last used by connexion
- if (! is_resource($resultset)) { $resultset=$this->results; }
- return pg_fetch_array($resultset);
- }
- /**
- * Renvoie les donnees comme un tableau
- *
- * @param resultset Curseur de la requete voulue
- * @return array
- */
- function fetch_row($resultset)
- {
- // Si le resultset n'est pas fourni, on prend le dernier utilise sur cette connexion
- if (! is_resource($resultset)) { $resultset=$this->results; }
- return pg_fetch_row($resultset);
- }
- /**
- * Renvoie le nombre de lignes dans le resultat d'une requete SELECT
- *
- * @see affected_rows
- * @param resultset Curseur de la requete voulue
- * @return int Nombre de lignes
- */
- function num_rows($resultset)
- {
- // If resultset not provided, we take the last used by connexion
- if (! is_resource($resultset)) { $resultset=$this->results; }
- return pg_num_rows($resultset);
- }
- /**
- * Renvoie le nombre de lignes dans le resultat d'une requete INSERT, DELETE ou UPDATE
- *
- * @see num_rows
- * @param resultset Curseur de la requete voulue
- * @return int Nombre de lignes
- */
- function affected_rows($resultset)
- {
- // If resultset not provided, we take the last used by connexion
- if (! is_resource($resultset)) { $resultset=$this->results; }
- // pgsql necessite un resultset pour cette fonction contrairement
- // a mysql qui prend un link de base
- return pg_affected_rows($resultset);
- }
- /**
- * Libere le dernier resultset utilise sur cette connexion
- *
- * @param resultset Curseur de la requete voulue
- */
- function free($resultset=0)
- {
- // If resultset not provided, we take the last used by connexion
- if (! is_resource($resultset)) { $resultset=$this->results; }
- // Si resultset en est un, on libere la memoire
- if (is_resource($resultset)) pg_free_result($resultset);
- }
- /**
- * Defini les limites de la requete
- *
- * @param limit nombre maximum de lignes retournees
- * @param offset numero de la ligne a partir de laquelle recuperer les lignes
- * @return string chaine exprimant la syntax sql de la limite
- */
- function plimit($limit=0,$offset=0)
- {
- global $conf;
- if (! $limit) $limit=$conf->liste_limit;
- if ($offset > 0) return " LIMIT ".$limit." OFFSET ".$offset." ";
- else return " LIMIT $limit ";
- }
- /**
- * Define sort criteria of request
- *
- * @param sortfield List of sort fields
- * @param sortorder Sort order
- * @return string String to provide syntax of a sort sql string
- * TODO Mutualized this into a mother class
- */
- function order($sortfield=0,$sortorder=0)
- {
- if ($sortfield)
- {
- $return='';
- $fields=explode(',',$sortfield);
- foreach($fields as $val)
- {
- if (! $return) $return.=' ORDER BY ';
- else $return.=',';
- $return.=preg_replace('/[^0-9a-z_\.]/i','',$val);
- if ($sortorder) $return.=' '.preg_replace('/[^0-9a-z]/i','',$sortorder);
- }
- return $return;
- }
- else
- {
- return '';
- }
- }
- /**
- * Escape a string to insert data
- *
- * @param stringtoencode String to escape
- * @return string String escaped
- */
- function escape($stringtoencode)
- {
- return pg_escape_string($stringtoencode);
- }
- /**
- * Convert (by PHP) a GM Timestamp date into a GM string date to insert into a date field.
- * Function to use to build INSERT, UPDATE or WHERE predica
- *
- * @param param Date TMS to convert
- * @return string Date in a string YYYYMMDDHHMMSS
- */
- function idate($param)
- {
- return adodb_strftime("%Y-%m-%d %H:%M:%S",$param);
- }
- /**
- * Convert (by PHP) a PHP server TZ string date into a GM Timestamps date
- * 19700101020000 -> 3600 with TZ+1
- *
- * @param string Date in a string (YYYYMMDDHHMMSS, YYYYMMDD, YYYY-MM-DD HH:MM:SS)
- * @return date Date TMS
- */
- function jdate($string)
- {
- $string=preg_replace('/([^0-9])/i','',$string);
- $tmp=$string.'000000';
- $date=dol_mktime(substr($tmp,8,2),substr($tmp,10,2),substr($tmp,12,2),substr($tmp,4,2),substr($tmp,6,2),substr($tmp,0,4));
- return $date;
- }
- /**
- * Formate a SQL IF
- *
- * @param test chaine test
- * @param resok resultat si test egal
- * @param resko resultat si test non egal
- * @return string chaine formate SQL
- */
- function ifsql($test,$resok,$resko)
- {
- return '(CASE WHEN '.$test.' THEN '.$resok.' ELSE '.$resko.' END)';
- }
- /**
- * Renvoie la derniere requete soumise par la methode query()
- *
- * @return lastquery
- */
- function lastquery()
- {
- return $this->lastquery;
- }
- /**
- * Renvoie la derniere requete en erreur
- *
- * @return string lastqueryerror
- */
- function lastqueryerror()
- {
- return $this->lastqueryerror;
- }
- /**
- * Renvoie le libelle derniere erreur
- *
- * @return string lasterror
- */
- function lasterror()
- {
- return $this->lasterror;
- }
- /**
- * Renvoie le code derniere erreur
- *
- * @return string lasterrno
- */
- function lasterrno()
- {
- return $this->lasterrno;
- }
- /**
- * Renvoie le code erreur generique de l'operation precedente.
- *
- * @return error_num (Exemples: DB_ERROR_TABLE_ALREADY_EXISTS, DB_ERROR_RECORD_ALREADY_EXISTS...)
- */
- function errno()
- {
- if (! $this->connected) {
- // Si il y a eu echec de connexion, $this->db n'est pas valide.
- return 'DB_ERROR_FAILED_TO_CONNECT';
- }
- else {
- // Constants to convert a MySql error code to a generic Dolibarr error code
- $errorcode_map = array(
- 1004 => 'DB_ERROR_CANNOT_CREATE',
- 1005 => 'DB_ERROR_CANNOT_CREATE',
- 1006 => 'DB_ERROR_CANNOT_CREATE',
- 1007 => 'DB_ERROR_ALREADY_EXISTS',
- 1008 => 'DB_ERROR_CANNOT_DROP',
- 1025 => 'DB_ERROR_NO_FOREIGN_KEY_TO_DROP',
- 1044 => 'DB_ERROR_ACCESSDENIED',
- 1046 => 'DB_ERROR_NODBSELECTED',
- 1048 => 'DB_ERROR_CONSTRAINT',
- '42P07' => 'DB_ERROR_TABLE_OR_KEY_ALREADY_EXISTS',
- '42703' => 'DB_ERROR_NOSUCHFIELD',
- 1060 => 'DB_ERROR_COLUMN_ALREADY_EXISTS',
- 42701=> 'DB_ERROR_COLUMN_ALREADY_EXISTS',
- '42710' => 'DB_ERROR_KEY_NAME_ALREADY_EXISTS',
- '23505' => 'DB_ERROR_RECORD_ALREADY_EXISTS',
- '42704' => 'DB_ERROR_NO_INDEX_TO_DROP',
- '42601' => 'DB_ERROR_SYNTAX',
- '42P16' => 'DB_ERROR_PRIMARY_KEY_ALREADY_EXISTS',
- 1075 => 'DB_ERROR_CANT_DROP_PRIMARY_KEY',
- 1091 => 'DB_ERROR_NOSUCHFIELD',
- 1100 => 'DB_ERROR_NOT_LOCKED',
- 1136 => 'DB_ERROR_VALUE_COUNT_ON_ROW',
- '42P01' => 'DB_ERROR_NOSUCHTABLE',
- '23503' => 'DB_ERROR_NO_PARENT',
- 1217 => 'DB_ERROR_CHILD_EXISTS',
- 1451 => 'DB_ERROR_CHILD_EXISTS',
- '42P04' => 'DB_DATABASE_ALREADY_EXISTS'
- );
- $errorlabel=pg_last_error($this->db);
- $errorcode='';
- if (preg_match('/: *([0-9P]+):/',$errorlabel,$reg))
- {
- $errorcode=$reg[1];
- if (isset($errorcode_map[$errorcode]))
- {
- return $errorcode_map[$errorcode];
- }
- }
- $errno=$errorcode?$errorcode:$errorlabel;
- return ($errno?'DB_ERROR_'.$errno:'0');
- }
- // '/(Table does not exist\.|Relation [\"\'].*[\"\'] does not exist|sequence does not exist|class ".+" not found)$/' => 'DB_ERROR_NOSUCHTABLE',
- // '/table [\"\'].*[\"\'] does not exist/' => 'DB_ERROR_NOSUCHTABLE',
- // '/Relation [\"\'].*[\"\'] already exists|Cannot insert a duplicate key into (a )?unique index.*/' => 'DB_ERROR_RECORD_ALREADY_EXISTS',
- // '/divide by zero$/' => 'DB_ERROR_DIVZERO',
- // '/pg_atoi: error in .*: can\'t parse /' => 'DB_ERROR_INVALID_NUMBER',
- // '/ttribute [\"\'].*[\"\'] not found$|Relation [\"\'].*[\"\'] does not have attribute [\"\'].*[\"\']/' => 'DB_ERROR_NOSUCHFIELD',
- // '/parser: parse error at or near \"/' => 'DB_ERROR_SYNTAX',
- // '/referential integrity violation/' => 'DB_ERROR_CONSTRAINT'
- }
- /**
- * Renvoie le texte de l'erreur pgsql de l'operation precedente
- *
- * @return error_text
- */
- function error()
- {
- return pg_last_error($this->db);
- }
- /**
- * Get last ID after an insert INSERT
- *
- * @param tab Table name concerned by insert. Ne sert pas sous MySql mais requis pour compatibilite avec Postgresql
- * @return int id
- */
- function last_insert_id($tab,$fieldid='rowid')
- {
- //$result = pg_query($this->db,"SELECT MAX(".$fieldid.") FROM ".$tab);
- $result = pg_query($this->db,"SELECT currval('".$tab."_".$fieldid."_seq')");
- if (! $result)
- {
- print pg_last_error($this->db);
- exit;
- }
- //$nbre = pg_num_rows($result);
- $row = pg_fetch_result($result,0,0);
- return $row;
- }
- /**
- * Encrypt sensitive data in database
- * Warning: This function includes the escape, so it must use direct value
- *
- * @param fieldorvalue Field name or value to encrypt
- * @param withQuotes Return string with quotes
- * @return return XXX(field) or XXX('value') or field or 'value'
- */
- function encrypt($fieldorvalue, $withQuotes=0)
- {
- global $conf;
- // Type of encryption (2: AES (recommended), 1: DES , 0: no encryption)
- $cryptType = ($conf->db->dolibarr_main_db_encryption?$conf->db->dolibarr_main_db_encryption:0);
- //Encryption key
- $cryptKey = (!empty($conf->db->dolibarr_main_db_cryptkey)?$conf->db->dolibarr_main_db_cryptkey:'');
- $return = $fieldorvalue;
- return ($withQuotes?"'":"").$this->escape($return).($withQuotes?"'":"");
- }
- /**
- * Decrypt sensitive data in database
- *
- * @param value Value to decrypt
- * @return return Decrypted value if used
- */
- function decrypt($value)
- {
- global $conf;
- // Type of encryption (2: AES (recommended), 1: DES , 0: no encryption)
- $cryptType = ($conf->db->dolibarr_main_db_encryption?$conf->db->dolibarr_main_db_encryption:0);
- //Encryption key
- $cryptKey = (!empty($conf->db->dolibarr_main_db_cryptkey)?$conf->db->dolibarr_main_db_cryptkey:'');
- $return = $value;
- return $return;
- }
- // Next function are not required. Only minor features use them.
- //--------------------------------------------------------------
- /**
- * Renvoie l'id de la connexion
- *
- * @return string Id connexion
- */
- function DDLGetConnectId()
- {
- return '?';
- }
- /**
- * Create a new database
- * Ne pas utiliser les fonctions xxx_create_db (xxx=mysql, ...) car elles sont deprecated
- *
- * @param database Database name to create
- * @param charset Charset used to store data
- * @param collation Charset used to sort data
- * @param owner Username of database owner
- * @return resource resource defined if OK, null if KO
- */
- function DDLCreateDb($database,$charset='',$collation='',$owner='')
- {
- if (empty($charset)) $charset=$this->forcecharset;
- if (empty($collation)) $collation=$this->collation;
- $ret=$this->query('CREATE DATABASE '.$database.' OWNER '.$owner.' ENCODING \''.$charset.'\'');
- return $ret;
- }
- /**
- * Liste des tables dans une database.
- * @param database Nom de la database
- * @return resource
- */
- function DDLListTables($database, $table='')
- {
- $listtables=array();
- $like = '';
- if ($table) $like = " AND table_name LIKE '".$table."'";
- $result = pg_query($this->db, "SELECT table_name FROM information_schema.tables WHERE table_schema = 'public'".$like." ORDER BY table_name");
- while($row = $this->fetch_row($result))
- {
- $listtables[] = $row[0];
- }
- return $listtables;
- }
- /**
- * Liste les informations des champs d'une table.
- * @param table Nom de la table
- * @return array Tableau des informations des champs de la table
- * TODO modifier pour postgresql
- */
- function DDLInfoTable($table)
- {
- /*
- $infotables=array();
- $sql="SHOW FULL COLUMNS FROM ".$table.";";
- dol_syslog($sql,LOG_DEBUG);
- $result = $this->pg_query($this->db,$sql);
- while($row = $this->fetch_row($result))
- {
- $infotables[] = $row;
- }
- return $infotables;
- */
- }
- /**
- * Create a table into database
- *
- * @param string $table Nom de la table
- * @param array $fields Tableau associatif [nom champ][tableau des descriptions]
- * @param string $primary_key Nom du champ qui sera la clef primaire
- * @param string $type Type de la table
- * @param array $unique_keys Tableau associatifs Nom de champs qui seront clef unique => valeur
- * @param array $fulltext_keys Tableau des Nom de champs qui seront indexes en fulltext
- * @param string $keys Tableau des champs cles noms => valeur
- * @return int <0 if KO, >=0 if OK
- */
- function DDLCreateTable($table,$fields,$primary_key,$type,$unique_keys="",$fulltext_keys="",$keys="")
- {
- // cles recherchees dans le tableau des descriptions (fields) : type,value,attribute,null,default,extra
- // ex. : $fields['rowid'] = array('type'=>'int','value'=>'11','null'=>'not null','extra'=> 'auto_increment');
- $sql = "create table ".$table."(";
- $i=0;
- foreach($fields as $field_name => $field_desc)
- {
- $sqlfields[$i] = $field_name." ";
- $sqlfields[$i] .= $field_desc['type'];
- if( preg_match("/^[^\s]/i",$field_desc['value']))
- $sqlfields[$i] .= "(".$field_desc['value'].")";
- else if( preg_match("/^[^\s]/i",$field_desc['attribute']))
- $sqlfields[$i] .= " ".$field_desc['attribute'];
- else if( preg_match("/^[^\s]/i",$field_desc['default']))
- {
- if(preg_match("/null/i",$field_desc['default']))
- $sqlfields[$i] .= " default ".$field_desc['default'];
- else
- $sqlfields[$i] .= " default '".$field_desc['default']."'";
- }
- else if( preg_match("/^[^\s]/i",$field_desc['null']))
- $sqlfields[$i] .= " ".$field_desc['null'];
- else if( preg_match("/^[^\s]/i",$field_desc['extra']))
- $sqlfields[$i] .= " ".$field_desc['extra'];
- $i++;
- }
- if($primary_key != "")
- $pk = "primary key(".$primary_key.")";
- if($unique_keys != "")
- {
- $i = 0;
- foreach($unique_keys as $key => $value)
- {
- $sqluq[$i] = "UNIQUE KEY '".$key."' ('".$value."')";
- $i++;
- }
- }
- if($keys != "")
- {
- $i = 0;
- foreach($keys as $key => $value)
- {
- $sqlk[$i] = "KEY ".$key." (".$value.")";
- $i++;
- }
- }
- $sql .= implode(',',$sqlfields);
- if($primary_key != "")
- $sql .= ",".$pk;
- if($unique_keys != "")
- $sql .= ",".implode(',',$sqluq);
- if($keys != "")
- $sql .= ",".implode(',',$sqlk);
- $sql .=") type=".$type;
- dol_syslog($sql,LOG_DEBUG);
- if(! $this->query($sql))
- return -1;
- else
- return 1;
- }
- /**
- * Create a user
- *
- * @param dolibarr_main_db_host Ip serveur
- * @param dolibarr_main_db_user Nom user a creer
- * @param dolibarr_main_db_pass Mot de passe user a creer
- * @param dolibarr_main_db_name Database name where user must be granted
- * @return int <0 si KO, >=0 si OK
- */
- function DDLCreateUser($dolibarr_main_db_host,$dolibarr_main_db_user,$dolibarr_main_db_pass,$dolibarr_main_db_name)
- {
- $sql = "create user \"".addslashes($dolibarr_main_db_user)."\" with password '".addslashes($dolibarr_main_db_pass)."'";
- dol_syslog("pgsql.lib::DDLCreateUser", LOG_DEBUG); // No sql to avoid password in log
- $resql=$this->query($sql);
- if (! $resql)
- {
- return -1;
- }
- return 1;
- }
- /**
- * Decrit une table dans une database
- *
- * @param table Nom de la table
- * @param field Optionnel : Nom du champ si l'on veut la desc d'un champ
- * @return resource
- */
- function DDLDescTable($table,$field="")
- {
- $sql ="SELECT attname FROM pg_attribute, pg_type WHERE typname = '".$table."' AND attrelid = typrelid";
- $sql.=" AND attname NOT IN ('cmin', 'cmax', 'ctid', 'oid', 'tableoid', 'xmin', 'xmax')";
- if ($field) $sql.= " AND attname = '".$field."'";
- dol_syslog($sql,LOG_DEBUG);
- $this->results = $this->query($sql);
- return $this->results;
- }
- /**
- * Insert a new field in table
- *
- * @param table Nom de la table
- * @param field_name Nom du champ a inserer
- * @param field_desc Tableau associatif de description du champ a inserer[nom du parametre][valeur du parametre]
- * @param field_position Optionnel ex.: "after champtruc"
- * @return int <0 si KO, >0 si OK
- */
- function DDLAddField($table,$field_name,$field_desc,$field_position="")
- {
- // cles recherchees dans le tableau des descriptions (field_desc) : type,value,attribute,null,default,extra
- // ex. : $field_desc = array('type'=>'int','value'=>'11','null'=>'not null','extra'=> 'auto_increment');
- $sql= "ALTER TABLE ".$table." ADD ".$field_name." ";
- $sql .= $field_desc['type'];
- if ($field_desc['type'] != 'int' && preg_match("/^[^\s]/i",$field_desc['value']))
- $sql .= "(".$field_desc['value'].")";
- if (preg_match("/^[^\s]/i",$field_desc['attribute']))
- $sql .= " ".$field_desc['attribute'];
- if (preg_match("/^[^\s]/i",$field_desc['null']))
- $sql .= " ".$field_desc['null'];
- if (preg_match("/^[^\s]/i",$field_desc['default']))
- if (preg_match("/null/i",$field_desc['default']))
- $sql .= " default ".$field_desc['default'];
- else
- $sql .= " default '".$field_desc['default']."'";
- if (preg_match("/^[^\s]/i",$field_desc['extra']))
- $sql .= " ".$field_desc['extra'];
- $sql .= " ".$field_position;
- dol_syslog($sql,LOG_DEBUG);
- if(! $this -> query($sql))
- return -1;
- else
- return 1;
- }
- /**
- * Update format of a field into a table
- *
- * @param table Name of table
- * @param field_name Name of field to modify
- * @param field_desc Array with description of field format
- * @return int <0 if KO, >0 if OK
- */
- function DDLUpdateField($table,$field_name,$field_desc)
- {
- $sql = "ALTER TABLE ".$table;
- $sql .= " MODIFY COLUMN ".$field_name." ".$field_desc['type'];
- if ($field_desc['type'] == 'int' || $field_desc['type'] == 'varchar') $sql.="(".$field_desc['value'].")";
- dol_syslog($sql,LOG_DEBUG);
- if (! $this->query($sql))
- return -1;
- else
- return 1;
- }
- /**
- * Drop a field in table
- *
- * @param table Nom de la table
- * @param field_name Nom du champ a inserer
- * @return int <0 si KO, >0 si OK
- */
- function DDLDropField($table,$field_name)
- {
- $sql= "ALTER TABLE ".$table." DROP COLUMN `".$field_name."`";
- dol_syslog($sql,LOG_DEBUG);
- if (! $this->query($sql))
- {
- $this->error=$this->lasterror();
- return -1;
- }
- else return 1;
- }
- /**
- * Return charset used to store data in database
- *
- * @return string Charset
- */
- function getDefaultCharacterSetDatabase()
- {
- $resql=$this->query('SHOW SERVER_ENCODING');
- $liste=$this->fetch_array($resql);
- return $liste['server_encoding'];
- }
- /**
- * Return list of available charset that can be used to store data in database
- *
- * @return array List of Charset
- */
- function getListOfCharacterSet()
- {
- $resql=$this->query('SHOW SERVER_ENCODING');
- $liste = array();
- if ($resql)
- {
- $i = 0;
- while ($obj = $this->fetch_object($resql) )
- {
- $liste[$i]['charset'] = $obj->server_encoding;
- $liste[$i]['description'] = 'Default database charset';
- $i++;
- }
- $this->free($resql);
- } else {
- return null;
- }
- return $liste;
- }
- /**
- * Return collation used in database
- *
- * @return string Collation value
- */
- function getDefaultCollationDatabase()
- {
- $resql=$this->query('SHOW LC_COLLATE');
- $liste=$this->fetch_array($resql);
- return $liste['lc_collate'];
- }
- /**
- * Return list of available collation that can be used for database
- *
- * @return array Liste of Collation
- */
- function getListOfCollation()
- {
- $resql=$this->query('SHOW LC_COLLATE');
- $liste = array();
- if ($resql)
- {
- $i = 0;
- while ($obj = $this->fetch_object($resql) )
- {
- $liste[$i]['collation'] = $obj->lc_collate;
- $i++;
- }
- $this->free($resql);
- } else {
- return null;
- }
- return $liste;
- }
- /**
- * Return full path of dump program
- *
- * @return string Full path of dump program
- */
- function getPathOfDump()
- {
- $fullpathofdump='/pathtopgdump/pg_dump';
- if (file_exists('/usr/bin/pg_dump'))
- {
- $fullpathofdump='/usr/bin/pg_dump';
- }
- else
- {
- // TODO L'utilisateur de la base doit etre un superadmin pour lancer cette commande
- $resql=$this->query('SHOW data_directory');
- if ($resql)
- {
- $liste=$this->fetch_array($resql);
- $basedir=$liste['data_directory'];
- $fullpathofdump=preg_replace('/data$/','bin',$basedir).'/pg_dump';
- }
- }
- return $fullpathofdump;
- }
- /**
- * Return full path of restore program
- *
- * @return string Full path of restore program
- */
- function getPathOfRestore()
- {
- $fullpathofdump='/pathtopgrestore/pg_restore';
- if (file_exists('/usr/bin/pg_restore'))
- {
- $fullpathofdump='/usr/bin/pg_restore';
- }
- else
- {
- // TODO L'utilisateur de la base doit etre un superadmin pour lancer cette commande
- $resql=$this->query('SHOW data_directory');
- if ($resql)
- {
- $liste=$this->fetch_array($resql);
- $basedir=$liste['data_directory'];
- $fullpathofdump=preg_replace('/data$/','bin',$basedir).'/pg_restore';
- }
- }
- return $fullpathofdump;
- }
- /**
- * Return value of server parameters
- *
- * @param filter Filter list on a particular value
- * @return string Value for parameter
- */
- function getServerParametersValues($filter='')
- {
- $result=array();
- $resql='select name,setting from pg_settings';
- if ($filter) $resql.=" WHERE name = '".addslashes($filter)."'";
- $resql=$this->query($resql);
- if ($resql)
- {
- $obj=$this->fetch_object($resql);
- $result[$obj->name]=$obj->setting;
- }
- return $result;
- }
- }
- ?>