www/ecrire/base/connect_sql.php

   1 <?php
   2
   3 /***************************************************************************\
   4  *  SPIP, Systeme de publication pour l'internet                           *
   5  *                                                                         *
   6  *  Copyright (c) 2001-2011                                                *
   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
  15 //
  16 // Utilitaires indispensables autour des serveurs SQL
  17 //
  18
  19 // API d'appel aux bases de donnees:
  20 // on charge le fichier config/$serveur ($serveur='connect' pour le principal)
  21 // qui est cense initaliser la connexion en appelant spip_connect_db
  22 // laquelle met dans la globale db_ok la description de la connexion
  23 // On la memorise dans un tableau pour permettre plusieurs serveurs.
  24 // A l'installation, il faut simuler l'existence de ce fichier
  25
  26 // http://doc.spip.org/@spip_connect
  27 function spip_connect($serveur='', $version='') {
  28         global $connexions, $spip_sql_version;
  29
  30         $serveur = !is_string($serveur) ? '' : strtolower($serveur);
  31         $index = $serveur ? $serveur : 0;
  32         if (!$version) $version = $spip_sql_version;
  33         if (isset($connexions[$index][$version])) return $connexions[$index];
  34
  35         include_spip('base/abstract_sql');
  36         $install = (_request('exec') == 'install');
  37
  38         // Premiere connexion ?
  39         if (!($old = isset($connexions[$index]))) {
  40                 $f = (!preg_match('/^[\w\.]*$/', $serveur))
  41                 ? '' // nom de serveur mal ecrit
  42                 : ($serveur ?
  43                    ( _DIR_CONNECT. $serveur . '.php') // serveur externe
  44                     : (_FILE_CONNECT ? _FILE_CONNECT // serveur principal ok
  45                        : ($install ? _FILE_CONNECT_TMP // init du serveur principal
  46                          : ''))); // installation pas faite
  47
  48                 unset($GLOBALS['db_ok']);
  49                 unset($GLOBALS['spip_connect_version']);
  50                 if ($f) {
  51                         if (is_readable($f)) {
  52                                 include($f);
  53                         } elseif ($serveur AND !$install) {
  54                                 // chercher une declaration de serveur dans le path
  55                                 // qui pourra un jour servir a declarer des bases sqlite
  56                                 // par des plugins. Et sert aussi aux boucles POUR.
  57                                 find_in_path("$serveur.php",'connect/',true);
  58                         }
  59                 }
  60                 if (!isset($GLOBALS['db_ok'])) {
  61                   // fera mieux la prochaine fois
  62                         if ($install) return false;
  63                         if ($f AND $readable)
  64                                 spip_log("spip_connect: fichier de connexion '$f' OK.");
  65                         else
  66                                 spip_log("spip_connect: fichier de connexion '$f' non trouve");
  67                         spip_log("spip_connect: echec connexion ou serveur $index mal defini dans '$f'.");
  68                         // ne plus reessayer si ce n'est pas l'install
  69                         return $connexions[$index]=false;
  70                 }
  71                 $connexions[$index] = $GLOBALS['db_ok'];
  72         }
  73         // si la connexion a deja ete tentee mais a echoue, le dire!
  74         if (!$connexions[$index]) return false;
  75
  76         // la connexion a reussi ou etait deja faite.
  77         // chargement de la version du jeu de fonctions
  78         // si pas dans le fichier par defaut
  79         $type = $GLOBALS['db_ok']['type'];
  80         $jeu = 'spip_' . $type .'_functions_' . $version;
  81         if (!isset($GLOBALS[$jeu])) {
  82                 if (!find_in_path($type . '_' . $version . '.php', 'req/', true)){
  83                   spip_log("spip_connect: serveur $index version '$version' non defini pour '$type'");
  84                         // ne plus reessayer
  85                         return $connexions[$index][$version] = array();
  86                 }
  87         }
  88         $connexions[$index][$version] = $GLOBALS[$jeu];
  89         if ($old) return $connexions[$index];
  90
  91         $connexions[$index]['spip_connect_version'] = isset($GLOBALS['spip_connect_version']) ? $GLOBALS['spip_connect_version'] : 0;
  92
  93         // initialisation de l'alphabet utilise dans les connexions SQL
  94         // si l'installation l'a determine.
  95         // Celui du serveur principal l'impose aux serveurs secondaires
  96         // s'ils le connaissent
  97
  98         if (!$serveur) {
  99                 $charset = spip_connect_main($GLOBALS[$jeu]);
 100                 if (!$charset) {
 101                         unset($connexions[$index]);
 102                         spip_log("spip_connect: absence de charset");
 103                         return false;
 104                 }
 105         } else  {
 106                 if ($connexions[$index]['spip_connect_version']
 107                 AND $r = sql_getfetsel('valeur', 'spip_meta', "nom='charset_sql_connexion'",'','','','',$serveur))
 108                         $charset = $r;
 109                 else $charset = -1;
 110         }
 111         if ($charset != -1) {
 112                 $f = $GLOBALS[$jeu]['set_charset'];
 113                 if (function_exists($f))
 114                         $f($charset, $serveur);
 115         }
 116         return $connexions[$index];
 117 }
 118
 119 function spip_sql_erreur($serveur='')
 120 {
 121         $connexion = spip_connect($serveur);
 122         $e = sql_errno($serveur);
 123         $t = (isset($connexion['type']) ? $connexion['type'] : 'sql');
 124         $m = "Erreur $e de $t: " . sql_error($serveur) . "\n" . $connexion['last'];
 125         $f = $t . $serveur;
 126         spip_log($m, $f);
 127 }
 128
 129 // Cette fonction ne doit etre appelee qu'a travers la fonction sql_serveur
 130 // definie dans base/abstract_sql
 131 // Elle existe en tant que gestionnaire de versions,
 132 // connue seulement des convertisseurs automatiques
 133
 134 // http://doc.spip.org/@spip_connect_sql
 135 function spip_connect_sql($version, $ins='', $serveur='', $cont=false) {
 136         $desc = spip_connect($serveur, $version);
 137         if (function_exists($f = @$desc[$version][$ins])) return $f;
 138         if ($cont) return $desc;
 139         if ($ins)
 140                 spip_log("Le serveur '$serveur' version $version n'a pas '$ins'");
 141         include_spip('inc/minipres');
 142         echo minipres(_T('info_travaux_titre'), _T('titre_probleme_technique'));
 143         exit;
 144 }
 145
 146 // Fonction appelee par le fichier cree dans config/ a l'instal'.
 147 // Il contient un appel direct a cette fonction avec comme arguments
 148 // les identifants de connexion.
 149 // Si la connexion reussit, la globale db_ok memorise sa description.
 150 // C'est un tableau egalement retourne en valeur, pour les appels a l'install'
 151
 152 // http://doc.spip.org/@spip_connect_db
 153 function spip_connect_db($host, $port, $login, $pass, $db='', $type='mysql', $prefixe='', $auth='') {
 154         global $db_ok;
 155
 156         ## TODO : mieux differencier les serveurs
 157         $f = _DIR_TMP . $type . 'out';
 158
 159         if (@file_exists($f)
 160         AND (time() - @filemtime($f) < 30)
 161         AND !defined('_ECRIRE_INSTALL')) {
 162                 spip_log("Echec : $f recent. Pas de tentative de connexion");
 163                 return;
 164         }
 165         if (!$prefixe)
 166                 $prefixe = isset($GLOBALS['table_prefix'])
 167                 ? $GLOBALS['table_prefix'] : $db;
 168         $h = charger_fonction($type, 'req', true);
 169         if (!$h) {
 170                 spip_log("les requetes $type ne sont pas fournies");
 171                 return;
 172         }
 173         if ($g = $h($host, $port, $login, $pass, $db, $prefixe)) {
 174
 175                 if (!is_array($auth)) {
 176                         // compatibilite version 0.7 initiale
 177                         $g['ldap'] = $auth;
 178                         $auth = array('ldap' => $auth);
 179                 }
 180                 $g['authentification'] = $auth;
 181                 $g['type'] = $type;
 182                 return $db_ok = $g;
 183         }
 184         // En cas d'indisponibilite du serveur, eviter de le bombarder
 185         if (!defined('_ECRIRE_INSTALL')) {
 186                 @touch($f);
 187                 spip_log("Echec connexion serveur $type : host[$host] port[$port] login[$login] base[$db]", $type);
 188         }
 189 }
 190
 191 // Premiere connexion au serveur principal:
 192 // retourner le charset donnee par la table principale
 193 // mais verifier que le fichier de connexion n'est pas trop vieux
 194 // Version courante = 0.7
 195 // La version 0.7 indique un serveur d'authentification comme 8e arg
 196 // La version 0.6 indique le prefixe comme 7e arg
 197 // La version 0.5 indique le serveur comme 6e arg
 198 //
 199 // La version 0.0 (non numerotee) doit etre refaite par un admin
 200 // les autres fonctionnent toujours, meme si :
 201 // - la version 0.1 est moins performante que la 0.2
 202 // - la 0.2 fait un include_ecrire('inc_db_mysql.php3').
 203
 204 // http://doc.spip.org/@spip_connect_main
 205 function spip_connect_main($connexion)
 206 {
 207         if ($GLOBALS['spip_connect_version']< 0.1 AND _DIR_RESTREINT){
 208                 include_spip('inc/headers');
 209                 redirige_url_ecrire('upgrade', 'reinstall=oui');
 210         }
 211
 212         if (!($f = $connexion['select'])) return false;
 213         if (!$r = $f('valeur','spip_meta', "nom='charset_sql_connexion'"))
 214                 return false;
 215         if (!($f = $connexion['fetch'])) return false;
 216         $r = $f($r);
 217         return ($r['valeur'] ? $r['valeur'] : -1);
 218 }
 219
 220 // compatibilite
 221 function spip_connect_ldap($serveur='') {
 222         include_spip('auth/ldap');
 223         return auth_ldap_connect($serveur);
 224 }
 225
 226 // 1 interface de abstract_sql a demenager dans base/abstract_sql a terme
 227
 228 // http://doc.spip.org/@_q
 229 function _q ($a) {
 230         return (is_numeric($a)) ? strval($a) :
 231                 (!is_array($a) ? ("'" . addslashes($a) . "'")
 232                  : join(",", array_map('_q', $a)));
 233 }
 234
 235 // Nommage bizarre des tables d'objets
 236 // http://doc.spip.org/@table_objet
 237 function table_objet($type) {
 238         static $surnoms = null;
 239         if (!$type) return;
 240         if (!$surnoms){
 241                 // passer dans un pipeline qui permet aux plugins de declarer leurs exceptions
 242                 $surnoms = pipeline('declarer_tables_objets_surnoms',
 243                         array(
 244                                 'article' => 'articles',
 245                                 'auteur' => 'auteurs',
 246                                 'breve' => 'breves',
 247                                 'document' => 'documents',
 248                                 'doc' => 'documents', # pour les modeles
 249                                 'img' => 'documents',
 250                                 'emb' => 'documents',
 251                                 'groupe_mots' => 'groupes_mots', # hum
 252                                 'groupe_mot' => 'groupes_mots', # hum
 253                                 'groupe' => 'groupes_mots', # hum (EXPOSE)
 254                                 'message' => 'messages',
 255                                 'mot' => 'mots',
 256                                 'petition' => 'petitions',
 257                                 'rubrique' => 'rubriques',
 258                                 'signature' => 'signatures',
 259                                 'syndic' => 'syndic',
 260                                 'site' => 'syndic', # hum hum
 261                                 'syndic_article' => 'syndic_articles',
 262                                 'type_document' => 'types_documents', # hum
 263                                 'extension' => 'types_documents' # hum
 264                         ));
 265         }
 266         return isset($surnoms[$type])
 267                 ? $surnoms[$type]
 268                 : preg_replace(',ss$,', 's', $type."s");
 269 }
 270
 271 // http://doc.spip.org/@table_objet_sql
 272 function table_objet_sql($type) {
 273         global $table_des_tables;
 274         $nom = table_objet($type);
 275         include_spip('public/interfaces');
 276         if (isset($table_des_tables[$nom])) {
 277                 $t = $table_des_tables[$nom];
 278                 $nom = 'spip_' . $t;
 279         }
 280         return $nom ;
 281 }
 282
 283 // http://doc.spip.org/@id_table_objet
 284 function id_table_objet($type,$serveur='') {
 285         $type = preg_replace(',^spip_|s$,', '', $type);
 286         if ($type == 'type')
 287                 return 'extension';
 288         else {
 289                 if (!$type) return;
 290                 $t = table_objet($type);
 291                 $trouver_table = charger_fonction('trouver_table', 'base');
 292                 $desc = $trouver_table($t,$serveur);
 293                 return @$desc['key']["PRIMARY KEY"];
 294         }
 295 }
 296
 297 // http://doc.spip.org/@objet_type
 298 function objet_type($table_objet){
 299         static $surnoms = null;
 300         if (!$surnoms){
 301                 // passer dans un pipeline qui permet aux plugins de declarer leurs exceptions
 302                 $surnoms = pipeline('declarer_type_surnoms', array());
 303         }
 304
 305         // scenario de base
 306         // le type est decline a partir du nom de la table en enlevant le prefixe eventuel
 307         // et la marque du pluriel
 308         $type = preg_replace(',^spip_|s$,', '', $table_objet);
 309         if (isset($surnoms[$type]))
 310                 return $surnoms[$type];
 311
 312         // si le type redonne bien la table c'est bon
 313         if ( (table_objet($type)==$table_objet)
 314           OR (table_objet_sql($type)==$table_objet))
 315           return $type;
 316
 317         // sinon on passe par la cle primaire id_xx pour trouver le type
 318         // car le s a la fin est incertain
 319         // notamment en cas de pluriel derogatoire
 320         // id_jeu/spip_jeux id_journal/spip_journaux qui necessitent tout deux
 321         // une declaration jeu => jeux, journal => journaux
 322         // dans le pipeline declarer_tables_objets_surnoms
 323         $trouver_table = charger_fonction('trouver_table', 'base');
 324         if ($desc = $trouver_table($table_objet)
 325           AND isset($desc['key']["PRIMARY KEY"])){
 326                 $primary = $desc['key']["PRIMARY KEY"];
 327                 $primary = explode(',',$primary);
 328                 $primary = reset($primary);
 329                 $type = preg_replace(',^id_,', '', $primary);
 330         }
 331         // on a fait ce qu'on a pu
 332         return $type;
 333 }
 334
 335 // Recuperer le nom de la table de jointure xxxx sur l'objet yyyy
 336 // http://doc.spip.org/@table_jointure
 337 function table_jointure($x, $y) {
 338         $trouver_table = charger_fonction('trouver_table', 'base');
 339         $xdesc = $trouver_table(table_objet($x));
 340         $ydesc = $trouver_table(table_objet($y));
 341         $tx = $xdesc['table'];
 342         $ty = $ydesc['table'];
 343         $ix = @$xdesc['key']["PRIMARY KEY"];
 344         $iy = @$ydesc['key']["PRIMARY KEY"];
 345         if ($table = $GLOBALS['tables_jointures'][$ty][$ix]) return $table;
 346         if ($table = $GLOBALS['tables_jointures'][$tx][$iy]) return $table;
 347         return '';
 348 }
 349
 350 // Pour compatibilite. Ne plus utiliser.
 351 // http://doc.spip.org/@spip_query
 352 function spip_query($query, $serveur='') {
 353         global $spip_sql_version;
 354         $f = spip_connect_sql($spip_sql_version, 'query', $serveur, true);
 355         return function_exists($f) ? $f($query, $serveur) : false;
 356 }
 357
 358 ?>