dolibarr/htdocs/lib/pgsql.lib.php

<?php
/* Copyright (C) 2001      Fabien Seisen        <seisen@linuxfr.org>
 * Copyright (C) 2002-2005 Rodolphe Quiedeville <rodolphe@quiedeville.org>
 * Copyright (C) 2004      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>
 *
 * 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, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 *
 * $Id$
 * $Source$
 */

/**
	    \file       htdocs/lib/pgsql.lib.php
		\brief      Fichier de la classe permettant de g<EFBFBD>r<EFBFBD>r une base pgsql
		\author     Fabien Seisen
		\author     Rodolphe Quiedeville.
		\author	    Laurent Destailleur.
		\author     S<EFBFBD>bastien Di Cintio
		\author     Benoit Mortier
		\version    $Revision$
*/


/**
     	\class      DoliDb
		\brief      Classe permettant de g<EFBFBD>r<EFBFBD>r la database de dolibarr
*/

class DoliDb 
{
    var $db;                      // Handler de base
    var $type='pgsql';            // Nom du gestionnaire

    var $results;                 // Resultset de la derni<6E>re requete
    
    var $connected;               // 1 si connect<63>, 0 sinon
    var $database_selected;       // 1 si base s<>lectionn<6E>, 0 sinon
    var $database_name;			  // Nom base s<>lectionn<6E>e
    var $transaction_opened;      // 1 si une transaction est en cours, 0 sinon
    var $lastquery;
    
    var $ok;
    var $error;
    
    
    /**
        \brief      Ouverture d'une connection vers le serveur et une database.
        \param		type		type de base de donn<EFBFBD>es (mysql ou pgsql)
        \param		host		addresse de la base de donn<EFBFBD>es
    	\param	    user		nom de l'utilisateur autoris<EFBFBD>
        \param		pass		mot de passe
        \param		name		nom de la database
        \return		int			1 en cas de succ<EFBFBD>s, 0 sinon
    */
    function DoliDb($type='pgsql', $host, $user, $pass, $name='')
    {
        global $conf,$langs;
        $this->transaction_opened=0;
    
        //print "Name DB: $host,$user,$pass,$name<br>";
        if (! $host)
        {
        	$this->connected = 0;
        	$this->ok = 0;
            $this->error=$langs->trans("ErrorWrongHostParameter");
        	dolibarr_syslog("DoliDB::DoliDB : Erreur Connect, wrong host parameters");
            return $this->ok;
        }
    
        // Essai connexion serveur
        $this->db = $this->connect($host, $user, $pass, $name);
    
        if ($this->db)
        {
            $this->connected = 1;
            $this->ok = 1;
        }
        else
        {
            // host, login ou password incorrect
            $this->connected = 0;
            $this->ok = 0;
            dolibarr_syslog("DoliDB::DoliDB : Erreur Connect");
        }
    
        // Si connexion serveur ok et si connexion base demand<6E>e, on essaie connexion base
        if ($this->connected && $name)
        {
            if ($this->select_db($name) == 1)
            {
                $this->database_selected = 1;
                $this->database_name = $name;
                $this->ok = 1;
            }
            else
            {
                $this->database_selected = 0;
                $this->ok = 0;
                $this->error=$this->error();
                dolibarr_syslog("DoliDB::DoliDB : Erreur Select_db");
            }
        }
        else
        {
            // Pas de selection de base demand<6E>e, ok ou ko
            $this->database_selected = 0;
        }
    
        return $this->ok;
    }
    
    /**
        \brief      Selectionne une database.
        \param		database		nom de la database
        \return		resource
        \remarks 	ici postgresql n'a aucune fonction equivalente de mysql_select_db
        \remarks 	comparaison manuel si la database est bien celle choisie par l'utilisateur
        \remarks 	en cas de succes renverra 1 ou 0
    */
    function select_db($database)
    {
        if ($database == $this->database_name)
        	return 1;
        else
        	return 0;
    }
    
    /**
        \brief      Connection vers le serveur
        \param		host		addresse de la base de donn<EFBFBD>es
        \param		login		nom de l'utilisateur autoris
        \param		passwd		mot de passe
        \param		name		nom de la database (ne sert pas sous mysql, sert sous pgsql)
        \return		resource	handler d'acc<EFBFBD>s <EFBFBD> la base
    */
    function connect($host, $login, $passwd, $name)
    {
        $con_string = "host=$host dbname=$name user=$login password=$passwd ";
        $this->db = pg_connect($con_string);
        return $this->db;
    }
    
    /**
            \brief          Cr<EFBFBD>ation d'une nouvelle base de donn<EFBFBD>e
            \param	        database		nom de la database <EFBFBD> cr<EFBFBD>er
            \return	        resource		resource d<EFBFBD>finie si ok, null si ko
            \remarks        Ne pas utiliser les fonctions xxx_create_db (xxx=mysql, ...) car elles sont deprecated
    */
    function create_db($database)
    {
        $ret=$this->query('CREATE DATABASE '.$database.';');
        return $ret;
    }
        
    
    /**
            \brief      Copie d'un handler de database.
            \return	    resource
    */
    
    function dbclone()
    {
        $db2 = new DoliDb("", "", "", "", "");
        $db2->db = $this->db;
        return $db2;
    }
    
    /**
            \brief      Ouverture d'une connection vers une database.
            \param		host		Adresse de la base de donn<EFBFBD>es
            \param		login		Nom de l'utilisateur autoris<EFBFBD>
            \param		passwd		Mot de passe
            \param		name		Nom de la database
            \return		resource	handler d'acc<EFBFBD>s <EFBFBD> la base
    */
    
    function pconnect($host, $login, $passwd, $name)
    {
        $con_string = "host=$host dbname=$name user=$login password=$passwd";
        $this->db = pg_pconnect($con_string);
        return $this->db;
    }
    
    /**
            \brief      Fermeture d'une connection vers une database.
            \return	    resource
    */
    
    function close()
    {
        return pg_close($this->db);
    }
    
    /**
        \brief      Debut d'une transaction.
        \return	    int         1 si ouverture transaction ok ou deja ouverte, 0 en cas d'erreur
    */
    
    function begin()
    {
        if (! $this->transaction_opened)
        {
            $ret=$this->query("BEGIN;");
            if ($ret) $this->transaction_opened++;
            return $ret;
        }
        else
        {
            $this->transaction_opened++;
            return 1;
        }
    }
    
    /**
        \brief      Validation d'une transaction
        \return	    int         1 si validation ok ou niveau de transaction non ouverte, 0 en cas d'erreur
    */

    function commit()
    {
        if ($this->transaction_opened==1)
        {
            $ret=$this->query("COMMIT;");
            if ($ret) $this->transaction_opened=0;
            return $ret;
        }
        else
        {
            $this->transaction_opened--;
            return 1;
        }
    }
    
    /**
        \brief      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)
        {
            $ret=$this->query("ROLLBACK;");
            $this->transaction_opened=0;
            return $ret;
        }
        else
        {
            return 1;
        }
    }
    
    /**
        \brief      Effectue une requete et renvoi le resultset de r<EFBFBD>ponse de la base
        \param		query		Contenu de la query
        \return	    resource    Resultset de la reponse
    */
    
    function query($query)
    {
        $query = trim($query);
        $ret = pg_query($this->db, $query);

        if (! eregi("^COMMIT",$query) && ! eregi("^ROLLBACK",$query)) {
            // Si requete utilisateur, on la sauvegarde ainsi que son resultset
            $this->lastquery=$query;
            $this->results = $ret;
        }
    
        return $ret;
    }
    
    /**
        \brief      Renvoie les donn<EFBFBD>es de la requete.
        \param	    nb			Contenu de la query
        \param	    fieldname	Nom du champ
        \return		resource
    */
    
    function result($nb, $fieldname)
    {
        return pg_fetch_result($this->results, $nb, $fieldname);
    }
    
    /**
        \brief      Renvoie la ligne courante (comme un objet) pour le curseur resultset.
        \param      resultset   Curseur de la requete voulue
        \return		resource
    */
    
    function fetch_object($resultset=0)
    {
        // Si le resultset n'est pas fourni, on prend le dernier utilis<69> sur cette connexion
        if (! is_resource($resultset)) { $resultset=$this->results; }
        return pg_fetch_object($resultset);
    }
    
    /**
        \brief      Renvoie les donn<EFBFBD>es dans un tableau.
        \param      resultset   Curseur de la requete voulue
        \return		array
    */
    
    function fetch_array($resultset=0)
    {
        // Si le resultset n'est pas fourni, on prend le dernier utilis<69> sur cette connexion
        if (! is_resource($resultset)) { $resultset=$this->results; }
        return pg_fetch_array($resultset);
    }
    
    /**
        \brief      Renvoie les donn<EFBFBD>es comme un tableau.
        \param      resultset   Curseur de la requete voulue
        \return	    array
    */
    
    function fetch_row($resultset=0)
    {
        // Si le resultset n'est pas fourni, on prend le dernier utilis<69> sur cette connexion
        if (! is_resource($resultset)) { $resultset=$this->results; }
        return pg_fetch_row($resultset);
    }
    
    /**
        \brief      Obtient les donn<EFBFBD>es d'un colonne et renvoie les donn<6E>es sous forme d'objet.
        \param      resultset   Curseur de la requete voulue
        \return     array
    */
    
    function fetch_field($resultset=0)
    {
        // Si le resultset n'est pas fourni, on prend le dernier utilis<69> sur cette connexion
        if (! is_resource($resultset)) { $resultset=$this->results; }
        return pg_field_name($resultset);
    }
    
    /**
        \brief      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=0)
    {
        // Si le resultset n'est pas fourni, on prend le dernier utilis<69> sur cette connexion
        if (! is_resource($resultset)) { $resultset=$this->results; }
        return pg_num_rows($resultset);
    }
    
    /**
        \brief      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=0)
    {
        // Si le resultset n'est pas fourni, on prend le dernier utilis<69> sur cette 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);
    }
    
    
    /**
        \brief      Renvoie le nombre de champs dans le resultat de la requete.
        \param      resultset   Curseur de la requete voulue
        \return	    int
    */
    
    function num_fields($resultset=0)
    {
        // Si le resultset n'est pas fourni, on prend le dernier utilis<69> sur cette connexion
        if (! is_resource($resultset)) { $resultset=$this->results; }
        return pg_num_fields($resultset);
    }

    /**
        \brief      Lib<EFBFBD>re le dernier resultset utilis<EFBFBD> sur cette connexion.
        \param      resultset   Curseur de la requete voulue
    */
    
    function free($resultset=0)
    {
        // Si le resultset n'est pas fourni, on prend le dernier utilis<69> sur cette connexion
        if (! is_resource($resultset)) { $resultset=$this->results; }
        // Si resultset en est un, on libere la m<>moire
        if (is_resource($resultset)) pg_free_result($resultset);
    }
    

    /**
        \brief      D<EFBFBD>fini les limites de la requ<EFBFBD>te.
        \param	    limit       nombre maximum de lignes retourn<EFBFBD>es
        \param	    offset      num<EFBFBD>ro de la ligne <EFBFBD> partir de laquelle recup<EFBFBD>rer 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 $offset,$limit ";
        else return " LIMIT $limit ";
    }
    
    
    /**
        \brief      Formatage (par la base de donn<EFBFBD>es) d'un champ de la base au format tms ou Date (YYYY-MM-DD HH:MM:SS)
                    afin de retourner une donn<EFBFBD>e toujours au format universel date tms unix.
        \param	    param
        \return	    date        date au format tms.
    */
    function pdate($param)
    {
        return "unix_timestamp(".$param.")";
    }

    /**
        \brief      Formatage (par la base de donn<EFBFBD>es) d'un champ de la base au format tms
                    afin de retourner une donn<EFBFBD>e au format text YYYYMMDDHHMMSS.
        \param	    param
        \return	    string      date au format text YYYYMMDDHHMMSS.
    */
    function qdate($param)
    {
        return "from_unixtime(".$param.")";
    }
    
    /**
        \brief      Formatage (par PHP) de la date en texte.
        \param	    param
        \return		date
    */
    function idate($param)
    {
        return strftime("%Y%m%d%H%M%S",$param);
    }


    /**
        \brief      Formatage d'un if SQL
        \param		test            chaine test
        \param		resok           resultat si test egal
        \param		resko           resultat si test non egal
        \return		string          chaine format<EFBFBD> SQL
    */
    function ifsql($test,$resok,$resko)
    {
        return 'IF('.$test.','.$resok.','.$resko.')';
    }


    /**
        \brief 		Renvoie la derniere requete soumise par la methode query()
        \return	    lastquery
    */
    
    function lastquery()
    {
        return $this->lastquery;
    }
    
    /**
         \brief     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()
    {
        static $error_regexps;
        if (empty($error_regexps)) {
            $error_regexps = array(
                '/(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'
            );
        }
        foreach ($error_regexps as $regexp => $code) {
            if (preg_match($regexp, pg_last_error($this->db))) {
                return $code;
            }
        }
        $errno=pg_last_error($this->db);
        return ($errno?'DB_ERROR':'0');
    }
    
    /**
        \brief 		Renvoie le texte de l'erreur pgsql de l'operation precedente.
        \return		error_text
    */
    
    function error()
    {
        return pg_last_error($this->db);
    }
    
    /**
        \brief      R<EFBFBD>cup<EFBFBD>re l'id gen<EFBFBD>r<EFBFBD> par le dernier INSERT.
        \param     	tab     Nom de la table concern<EFBFBD>e par l'insert. Ne sert pas sous MySql mais requis pour compatibilit<EFBFBD> avec Postgresql
        \return     int     id
    */
    
    function last_insert_id($tab)
    {
        $result = pg_query($this->db,"SELECT MAX(rowid) FROM ".$tab." ;");
        $nbre = pg_num_rows($result);
        $row = pg_fetch_result($result,0,0);
        return $row;
    }
    
    /**
        \brief      Retourne le dsn pear
        \return     dsn
    */
    
    function getdsn($db_type,$db_user,$db_pass,$db_host,$dbname)
    {
        $pear = $db_type.'://'.$db_user.':'.$db_pass.'@'.
        $db_host.'/'.$db_name;
    
        return $pear;
    }

    /**
        \brief      Liste des tables dans une database.
        \param	    database	Nom de la database
        \return		resource
    */
    
    function list_tables($database)
    {
        $this->results = pg_query($this->db, "SHOW TABLES;");
        return  $this->results;
    }
	

    function setLastQuery($s)
    {
        $this->lastquery=$s;
    }


    /**
        \brief      Renvoie toutes les donn<EFBFBD>es comme un tableau.
        \param      sql         Requete sql
        \param      datas       Tableau de donn<EFBFBD>es pour retour
        \return	    int         >0 si ok, <0 si ko
    */
    function fetch_all_rows($sql, &$datas)
    {
        $datas = array();
    
        $resql = $this->query($sql);
        if ($resql)
        {
            $i = 0;
            $num = $this->num_rows($resql);
    
            while ($i < $num)
            {
                $row = $this->fetch_row($resql);
                array_push($datas, $row[0]);
                $i++;
            }
        }
        else
        {
            print $this->error();
            return -1;
        }
        return 1;
    }

}

?>