www/ecrire/base/connect_sql.php

   1 <?php
   2
   3 /***************************************************************************\
   4  *  SPIP, Systeme de publication pour l'internet                           *
   5  *                                                                         *
   6  *  Copyright (c) 2001-2012                                                *
   7  *  Arnaud Martin, Antoine Pitrou, Philippe Riviere, Emmanuel Saint-James  *
   8  *                                                                         *
   9  *  Ce programme est un logiciel libre distribue sous licence GNU/GPL.     *
  10  *  Pour plus de details voir le fichier COPYING.txt ou l'aide en ligne.   *
  11 \***************************************************************************/
  12
  13 if (!defined('_ECRIRE_INC_VERSION')) return;
  14 include_spip('base/objets');
  15
  16 //
  17 // Utilitaires indispensables autour des serveurs SQL
  18 //
  19
  20 // API d'appel aux bases de donnees:
  21 // on charge le fichier config/$serveur ($serveur='connect' pour le principal)
  22 // qui est cense initaliser la connexion en appelant spip_connect_db
  23 // laquelle met dans la globale db_ok la description de la connexion
  24 // On la memorise dans un tableau pour permettre plusieurs serveurs.
  25 // A l'installation, il faut simuler l'existence de ce fichier
  26
  27 // http://doc.spip.org/@spip_connect
  28 function spip_connect($serveur='', $version='') {
  29         global $connexions, $spip_sql_version;
  30
  31         $serveur = !is_string($serveur) ? '' : strtolower($serveur);
  32         $index = $serveur ? $serveur : 0;
  33         if (!$version) $version = $spip_sql_version;
  34         if (isset($connexions[$index][$version])) return $connexions[$index];
  35
  36         include_spip('base/abstract_sql');
  37         $install = (_request('exec') == 'install');
  38
  39         // Premiere connexion ?
  40         if (!($old = isset($connexions[$index]))) {
  41                 $f = (!preg_match('/^[\w\.]*$/', $serveur))
  42                 ? '' // nom de serveur mal ecrit
  43                 : ($serveur ?
  44                    ( _DIR_CONNECT. $serveur . '.php') // serveur externe
  45                     : (_FILE_CONNECT ? _FILE_CONNECT // serveur principal ok
  46                        : ($install ? _FILE_CONNECT_TMP // init du serveur principal
  47                          : ''))); // installation pas faite
  48
  49                 unset($GLOBALS['db_ok']);
  50                 unset($GLOBALS['spip_connect_version']);
  51                 if ($f) {
  52                         if (is_readable($f)) {
  53                                 include($f);
  54                         } elseif ($serveur AND !$install) {
  55                                 // chercher une declaration de serveur dans le path
  56                                 // qui pourra un jour servir a declarer des bases sqlite
  57                                 // par des plugins. Et sert aussi aux boucles POUR.
  58                                 find_in_path("$serveur.php",'connect/',true);
  59                         }
  60                 }
  61                 if (!isset($GLOBALS['db_ok'])) {
  62                   // fera mieux la prochaine fois
  63                         if ($install) return false;
  64                         if ($f AND is_readable($f))
  65                                 spip_log("spip_connect: fichier de connexion '$f' OK.", _LOG_INFO_IMPORTANTE);
  66                         else
  67                                 spip_log("spip_connect: fichier de connexion '$f' non trouve", _LOG_INFO_IMPORTANTE);
  68                         spip_log("spip_connect: echec connexion ou serveur $index mal defini dans '$f'.", _LOG_HS);
  69                         // ne plus reessayer si ce n'est pas l'install
  70                         return $connexions[$index]=false;
  71                 }
  72                 $connexions[$index] = $GLOBALS['db_ok'];
  73         }
  74         // si la connexion a deja ete tentee mais a echoue, le dire!
  75         if (!$connexions[$index]) return false;
  76
  77         // la connexion a reussi ou etait deja faite.
  78         // chargement de la version du jeu de fonctions
  79         // si pas dans le fichier par defaut
  80         $type = $GLOBALS['db_ok']['type'];
  81         $jeu = 'spip_' . $type .'_functions_' . $version;
  82         if (!isset($GLOBALS[$jeu])) {
  83                 if (!find_in_path($type . '_' . $version . '.php', 'req/', true)){
  84                   spip_log("spip_connect: serveur $index version '$version' non defini pour '$type'", _LOG_HS);
  85                         // ne plus reessayer
  86                         return $connexions[$index][$version] = array();
  87                 }
  88         }
  89         $connexions[$index][$version] = $GLOBALS[$jeu];
  90         if ($old) return $connexions[$index];
  91
  92         $connexions[$index]['spip_connect_version'] = isset($GLOBALS['spip_connect_version']) ? $GLOBALS['spip_connect_version'] : 0;
  93
  94         // initialisation de l'alphabet utilise dans les connexions SQL
  95         // si l'installation l'a determine.
  96         // Celui du serveur principal l'impose aux serveurs secondaires
  97         // s'ils le connaissent
  98
  99         if (!$serveur) {
 100                 $charset = spip_connect_main($GLOBALS[$jeu]);
 101                 if (!$charset) {
 102                         unset($connexions[$index]);
 103                         spip_log("spip_connect: absence de charset", _LOG_AVERTISSEMENT);
 104                         return false;
 105                 }
 106         } else  {
 107                 if ($connexions[$index]['spip_connect_version']
 108                 AND $r = sql_getfetsel('valeur', 'spip_meta', "nom='charset_sql_connexion'",'','','','',$serveur))
 109                         $charset = $r;
 110                 else $charset = -1;
 111         }
 112         if ($charset != -1) {
 113                 $f = $GLOBALS[$jeu]['set_charset'];
 114                 if (function_exists($f))
 115                         $f($charset, $serveur);
 116         }
 117         return $connexions[$index];
 118 }
 119
 120 function spip_sql_erreur($serveur='')
 121 {
 122         $connexion = spip_connect($serveur);
 123         $e = sql_errno($serveur);
 124         $t = (isset($connexion['type']) ? $connexion['type'] : 'sql');
 125         $m = "Erreur $e de $t: " . sql_error($serveur) . "\n" . $connexion['last'];
 126         $f = $t . $serveur;
 127         spip_log($m, $f.'.'._LOG_ERREUR);
 128 }
 129
 130 // Cette fonction ne doit etre appelee qu'a travers la fonction sql_serveur
 131 // definie dans base/abstract_sql
 132 // Elle existe en tant que gestionnaire de versions,
 133 // connue seulement des convertisseurs automatiques
 134
 135 // http://doc.spip.org/@spip_connect_sql
 136 function spip_connect_sql($version, $ins='', $serveur='', $cont=false) {
 137         $desc = spip_connect($serveur, $version);
 138         if (function_exists($f = @$desc[$version][$ins])) return $f;
 139         if ($cont) return $desc;
 140         if ($ins)
 141                 spip_log("Le serveur '$serveur' version $version n'a pas '$ins'", _LOG_ERREUR);
 142         include_spip('inc/minipres');
 143         echo minipres(_T('info_travaux_titre'), _T('titre_probleme_technique'));
 144         exit;
 145 }
 146
 147 /**
 148  * Fonction appelee par le fichier cree dans config/ a l'instal'.
 149  * Il contient un appel direct a cette fonction avec comme arguments
 150  * les identifants de connexion.
 151  * Si la connexion reussit, la globale db_ok memorise sa description.
 152  * C'est un tableau egalement retourne en valeur, pour les appels a l'install'
 153  *
 154  * http://doc.spip.org/@spip_connect_db
 155  *
 156  * @param string $host
 157  * @param string $port
 158  * @param string $login
 159  * @param string $pass
 160  * @param string $db
 161  * @param string $type
 162  * @param string $prefixe
 163  * @param string $auth
 164  * @return array
 165  */
 166 function spip_connect_db($host, $port, $login, $pass, $db='', $type='mysql', $prefixe='', $auth='') {
 167         global $db_ok;
 168
 169         // temps avant nouvelle tentative de connexion
 170         // suite a une connection echouee
 171         if (!defined('_CONNECT_RETRY_DELAY'))
 172                 define('_CONNECT_RETRY_DELAY',30);
 173
 174         $f = "";
 175         // un fichier de identifiant par combinaison (type,host,port,db)
 176         // pour ne pas declarer tout indisponible d'un coup
 177         // si en cours d'installation ou si db=@test@ on ne pose rien
 178         // car c'est un test de connexion
 179         if (!defined('_ECRIRE_INSTALL') AND !$db=="@test@")
 180                 $f = _DIR_TMP . $type . '.' . substr(md5($host.$port.$db),0,8) . '.out';
 181         elseif ($db=='@test@')
 182                 $db = '';
 183
 184         if ($f
 185                 AND @file_exists($f)
 186           AND (time() - @filemtime($f) < _CONNECT_RETRY_DELAY)) {
 187                 spip_log( "Echec : $f recent. Pas de tentative de connexion", _LOG_HS);
 188                 return;
 189         }
 190
 191         if (!$prefixe)
 192                 $prefixe = isset($GLOBALS['table_prefix'])
 193                 ? $GLOBALS['table_prefix'] : $db;
 194         $h = charger_fonction($type, 'req', true);
 195         if (!$h) {
 196                 spip_log( "les requetes $type ne sont pas fournies", _LOG_HS);
 197                 return;
 198         }
 199         if ($g = $h($host, $port, $login, $pass, $db, $prefixe)) {
 200
 201                 if (!is_array($auth)) {
 202                         // compatibilite version 0.7 initiale
 203                         $g['ldap'] = $auth;
 204                         $auth = array('ldap' => $auth);
 205                 }
 206                 $g['authentification'] = $auth;
 207                 $g['type'] = $type;
 208                 return $db_ok = $g;
 209         }
 210         // En cas d'indisponibilite du serveur, eviter de le bombarder
 211         if ($f) {
 212                 @touch($f);
 213                 spip_log( "Echec connexion serveur $type : host[$host] port[$port] login[$login] base[$db]", $type.'.'._LOG_HS);
 214         }
 215 }
 216
 217 // Premiere connexion au serveur principal:
 218 // retourner le charset donnee par la table principale
 219 // mais verifier que le fichier de connexion n'est pas trop vieux
 220 // Version courante = 0.7
 221 // La version 0.7 indique un serveur d'authentification comme 8e arg
 222 // La version 0.6 indique le prefixe comme 7e arg
 223 // La version 0.5 indique le serveur comme 6e arg
 224 //
 225 // La version 0.0 (non numerotee) doit etre refaite par un admin
 226 // les autres fonctionnent toujours, meme si :
 227 // - la version 0.1 est moins performante que la 0.2
 228 // - la 0.2 fait un include_ecrire('inc_db_mysql.php3').
 229
 230 // http://doc.spip.org/@spip_connect_main
 231 function spip_connect_main($connexion)
 232 {
 233         if ($GLOBALS['spip_connect_version']< 0.1 AND _DIR_RESTREINT){
 234                 include_spip('inc/headers');
 235                 redirige_url_ecrire('upgrade', 'reinstall=oui');
 236         }
 237
 238         if (!($f = $connexion['select'])) return false;
 239         if (!$r = $f('valeur','spip_meta', "nom='charset_sql_connexion'"))
 240                 return false;
 241         if (!($f = $connexion['fetch'])) return false;
 242         $r = $f($r);
 243         return ($r['valeur'] ? $r['valeur'] : -1);
 244 }
 245
 246 // compatibilite
 247 function spip_connect_ldap($serveur='') {
 248         include_spip('auth/ldap');
 249         return auth_ldap_connect($serveur);
 250 }
 251
 252 // Echappement d'une valeur (num, string, array) sous forme de chaine PHP
 253 // pour un array(1,'a',"a'") renvoie la chaine "'1','a','a\''"
 254 // Usage sql un peu deprecie, a remplacer par sql_quote()
 255 // http://doc.spip.org/@_q
 256 function _q ($a) {
 257         return (is_numeric($a)) ? strval($a) :
 258                 (!is_array($a) ? ("'" . addslashes($a) . "'")
 259                  : join(",", array_map('_q', $a)));
 260 }
 261
 262
 263 // Recuperer le nom de la table de jointure xxxx sur l'objet yyyy
 264 // http://doc.spip.org/@table_jointure
 265 function table_jointure($x, $y) {
 266         $trouver_table = charger_fonction('trouver_table', 'base');
 267         $xdesc = $trouver_table(table_objet($x));
 268         $ydesc = $trouver_table(table_objet($y));
 269         $ix = @$xdesc['key']["PRIMARY KEY"];
 270         $iy = @$ydesc['key']["PRIMARY KEY"];
 271         if ($table = $ydesc['tables_jointures'][$ix]) return $table;
 272         if ($table = $xdesc['tables_jointures'][$iy]) return $table;
 273         return '';
 274 }
 275
 276 /**
 277  * Echapper les textes entre ' ' ou " " d'une requete SQL
 278  * avant son pre-traitement
 279  * On renvoi la query sans textes et les textes separes, dans
 280  * leur ordre d'apparition dans la query
 281  *
 282  * @param string $query
 283  * @return array
 284  */
 285 function query_echappe_textes($query){
 286         static $codeEchappements = array("''"=>"\x1@##@\x1", "\'"=>"\x2@##@\x2", "\\\""=>"\x3@##@\x3");
 287         $query = str_replace(array_keys($codeEchappements), array_values($codeEchappements), $query);
 288         if (preg_match_all("/((['])[^']*(\\2))|(([\"])[^\"]*(\\5))/S",$query,$textes)){
 289                 $textes = reset($textes); // indice 0 du match
 290                 switch(count($textes)){
 291                         case 0:$replace=array();break;
 292                         case 1:$replace=array('%1$s');break;
 293                         case 2:$replace=array('%1$s','%2$s');break;
 294                         case 3:$replace=array('%1$s','%2$s','%3$s');break;
 295                         case 4:$replace=array('%1$s','%2$s','%3$s','%4$s');break;
 296                         case 5:$replace=array('%1$s','%2$s','%3$s','%4$s','%5$s');break;
 297                         default:
 298                                 $replace = range(1,count($textes));
 299                                 $replace = '%'.implode('$s,%',$replace).'$s';
 300                                 $replace = explode(',',$replace);
 301                                 break;
 302                 }
 303                 $query = str_replace($textes,$replace,$query);
 304         }
 305         else
 306                 $textes = array();
 307
 308         return array($query, $textes);
 309 }
 310
 311 /**
 312  * Reinjecter les textes d'une requete SQL a leur place initiale,
 313  * apres traitement de la requete
 314  *
 315  * @param string $query
 316  * @param array $textes
 317  * @return string
 318  */
 319 function query_reinjecte_textes($query, $textes){
 320         static $codeEchappements = array("''"=>"\x1@##@\x1", "\'"=>"\x2@##@\x2", "\\\""=>"\x3@##@\x3");
 321         # debug de la substitution
 322         #if (($c1=substr_count($query,"%"))!=($c2=count($textes))){
 323         #       spip_log("$c1 ::". $query,"tradquery"._LOG_ERREUR);
 324         #       spip_log("$c2 ::". var_export($textes,1),"tradquery"._LOG_ERREUR);
 325         #       spip_log("ini ::". $qi,"tradquery"._LOG_ERREUR);
 326         #}
 327         switch (count($textes)){
 328                 case 0:break;
 329                 case 1:$query=sprintf($query,$textes[0]);break;
 330                 case 2:$query=sprintf($query,$textes[0],$textes[1]);break;
 331                 case 3:$query=sprintf($query,$textes[0],$textes[1],$textes[2]);break;
 332                 case 4:$query=sprintf($query,$textes[0],$textes[1],$textes[2],$textes[3]);break;
 333                 case 5:$query=sprintf($query,$textes[0],$textes[1],$textes[2],$textes[3],$textes[4]);break;
 334                 default:
 335                         array_unshift($textes,$query);
 336                         $query = call_user_func_array('sprintf',$textes);
 337                         break;
 338         }
 339
 340         $query = str_replace(array_values($codeEchappements), array_keys($codeEchappements), $query);
 341
 342         return $query;
 343 }
 344
 345 // Pour compatibilite. Ne plus utiliser.
 346 // http://doc.spip.org/@spip_query
 347 function spip_query($query, $serveur='') {
 348         global $spip_sql_version;
 349         $f = spip_connect_sql($spip_sql_version, 'query', $serveur, true);
 350         return function_exists($f) ? $f($query, $serveur) : false;
 351 }
 352
 353 ?>