3 /***************************************************************************\
4 * SPIP, Systeme de publication pour l'internet *
6 * Copyright (c) 2001-2019 *
7 * Arnaud Martin, Antoine Pitrou, Philippe Riviere, Emmanuel Saint-James *
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 \***************************************************************************/
14 * Utilitaires indispensables autour des serveurs SQL
16 * @package SPIP\Core\SQL
18 if (!defined('_ECRIRE_INC_VERSION')) {
21 require_once _ROOT_RESTREINT
. 'base/objets.php';
25 * Connexion à un serveur de base de données
27 * On charge le fichier `config/$serveur` (`$serveur='connect'` pour le principal)
28 * qui est censé initaliser la connexion en appelant la fonction `spip_connect_db`
29 * laquelle met dans la globale `db_ok` la description de la connexion.
31 * On la mémorise dans un tableau pour permettre plusieurs serveurs.
33 * À l'installation, il faut simuler l'existence de ce fichier.
35 * @uses spip_connect_main()
37 * @param string $serveur Nom du connecteur
38 * @param string $version Version de l'API SQL
40 * - false si la connexion a échouée,
41 * - tableau décrivant la connexion sinon
43 function spip_connect($serveur = '', $version = '') {
45 $serveur = !is_string($serveur) ?
'' : strtolower($serveur);
46 $index = $serveur ?
$serveur : 0;
48 $version = $GLOBALS['spip_sql_version'];
50 if (isset($GLOBALS['connexions'][$index][$version])) {
51 return $GLOBALS['connexions'][$index];
54 include_spip('base/abstract_sql');
55 $install = (_request('exec') == 'install');
57 // Premiere connexion ?
58 if (!($old = isset($GLOBALS['connexions'][$index]))) {
59 $f = (!preg_match('/^[\w\.]*$/', $serveur))
60 ?
'' // nom de serveur mal ecrit
62 (_DIR_CONNECT
. $serveur . '.php') // serveur externe
63 : (_FILE_CONNECT ? _FILE_CONNECT
// serveur principal ok
64 : ($install ? _FILE_CONNECT_TMP
// init du serveur principal
65 : ''))); // installation pas faite
67 unset($GLOBALS['db_ok']);
68 unset($GLOBALS['spip_connect_version']);
70 if (is_readable($f)) {
72 } elseif ($serveur and !$install) {
73 // chercher une declaration de serveur dans le path
74 // qui pourra un jour servir a declarer des bases sqlite
75 // par des plugins. Et sert aussi aux boucles POUR.
76 find_in_path("$serveur.php", 'connect/', true);
79 if (!isset($GLOBALS['db_ok'])) {
80 // fera mieux la prochaine fois
84 if ($f and is_readable($f)) {
85 spip_log("spip_connect: fichier de connexion '$f' OK.", _LOG_INFO_IMPORTANTE
);
87 spip_log("spip_connect: fichier de connexion '$f' non trouve", _LOG_INFO_IMPORTANTE
);
89 spip_log("spip_connect: echec connexion ou serveur $index mal defini dans '$f'.", _LOG_HS
);
91 // ne plus reessayer si ce n'est pas l'install
92 return $GLOBALS['connexions'][$index] = false;
94 $GLOBALS['connexions'][$index] = $GLOBALS['db_ok'];
96 // si la connexion a deja ete tentee mais a echoue, le dire!
97 if (!$GLOBALS['connexions'][$index]) {
101 // la connexion a reussi ou etait deja faite.
102 // chargement de la version du jeu de fonctions
103 // si pas dans le fichier par defaut
104 $type = $GLOBALS['db_ok']['type'];
105 $jeu = 'spip_' . $type . '_functions_' . $version;
106 if (!isset($GLOBALS[$jeu])) {
107 if (!find_in_path($type . '_' . $version . '.php', 'req/', true)) {
108 spip_log("spip_connect: serveur $index version '$version' non defini pour '$type'", _LOG_HS
);
111 return $GLOBALS['connexions'][$index][$version] = array();
114 $GLOBALS['connexions'][$index][$version] = $GLOBALS[$jeu];
116 return $GLOBALS['connexions'][$index];
119 $GLOBALS['connexions'][$index]['spip_connect_version'] = isset($GLOBALS['spip_connect_version']) ?
$GLOBALS['spip_connect_version'] : 0;
121 // initialisation de l'alphabet utilise dans les connexions SQL
122 // si l'installation l'a determine.
123 // Celui du serveur principal l'impose aux serveurs secondaires
124 // s'ils le connaissent
127 $charset = spip_connect_main($GLOBALS[$jeu], $GLOBALS['db_ok']['charset']);
129 unset($GLOBALS['connexions'][$index]);
130 spip_log("spip_connect: absence de charset", _LOG_AVERTISSEMENT
);
135 if ($GLOBALS['db_ok']['charset']) {
136 $charset = $GLOBALS['db_ok']['charset'];
138 // spip_meta n'existe pas toujours dans la base
139 // C'est le cas d'un dump sqlite par exemple
140 elseif ($GLOBALS['connexions'][$index]['spip_connect_version']
141 and sql_showtable('spip_meta', true, $serveur)
142 and $r = sql_getfetsel('valeur', 'spip_meta', "nom='charset_sql_connexion'", '', '', '', '', $serveur)
149 if ($charset != -1) {
150 $f = $GLOBALS[$jeu]['set_charset'];
151 if (function_exists($f)) {
152 $f($charset, $serveur);
156 return $GLOBALS['connexions'][$index];
160 * Log la dernière erreur SQL présente sur la connexion indiquée
162 * @param string $serveur Nom du connecteur de bdd utilisé
164 function spip_sql_erreur($serveur = '') {
165 $connexion = spip_connect($serveur);
166 $e = sql_errno($serveur);
167 $t = (isset($connexion['type']) ?
$connexion['type'] : 'sql');
168 $m = "Erreur $e de $t: " . sql_error($serveur) . "\nin " . sql_error_backtrace() . "\n" . trim($connexion['last']);
170 spip_log($m, $f . '.' . _LOG_ERREUR
);
174 * Retourne le nom de la fonction adaptée de l'API SQL en fonction du type de serveur
176 * Cette fonction ne doit être appelée qu'à travers la fonction sql_serveur
177 * définie dans base/abstract_sql
179 * Elle existe en tant que gestionnaire de versions,
180 * connue seulement des convertisseurs automatiques
182 * @param string $version Numéro de version de l'API SQL
183 * @param string $ins Instruction de l'API souhaitée, tel que 'allfetsel'
184 * @param string $serveur Nom du connecteur
185 * @param bool $cont true pour continuer même si le serveur SQL ou l'instruction est indisponible
186 * @return array|bool|string
187 * - string : nom de la fonction à utiliser,
188 * - false : si la connexion a échouée
189 * - array : description de la connexion, si l'instruction sql est indisponible pour cette connexion
191 function spip_connect_sql($version, $ins = '', $serveur = '', $cont = false) {
192 $desc = spip_connect($serveur, $version);
193 if (function_exists($f = @$desc[$version][$ins])) {
200 spip_log("Le serveur '$serveur' version $version n'a pas '$ins'", _LOG_ERREUR
);
202 include_spip('inc/minipres');
203 echo minipres(_T('info_travaux_titre'), _T('titre_probleme_technique'), array('status' => 503));
208 * Fonction appelée par le fichier connecteur de base de données
209 * crée dans `config/` à l'installation.
211 * Il contient un appel direct à cette fonction avec comme arguments
212 * les identifants de connexion.
214 * Si la connexion reussit, la globale `db_ok` mémorise sa description.
215 * C'est un tableau également retourné en valeur, pour les appels
216 * lors de l'installation.
218 * @param string $host Adresse du serveur de base de données
219 * @param string $port Port utilisé pour la connexion
220 * @param string $login Identifiant de connexion à la base de données
221 * @param string $pass Mot de passe pour cet identifiant
222 * @param string $db Nom de la base de données à utiliser
223 * @param string $type Type de base de données tel que 'mysql', 'sqlite3' (cf ecrire/req/)
224 * @param string $prefixe Préfixe des tables SPIP
225 * @param string $auth Type d'authentification (cas si 'ldap')
226 * @param string $charset Charset de la connexion SQL (optionnel)
227 * @return array Description de la connexion
229 function spip_connect_db(
240 // temps avant nouvelle tentative de connexion
241 // suite a une connection echouee
242 if (!defined('_CONNECT_RETRY_DELAY')) {
243 define('_CONNECT_RETRY_DELAY', 30);
247 // un fichier de identifiant par combinaison (type,host,port,db)
248 // pour ne pas declarer tout indisponible d'un coup
249 // si en cours d'installation ou si db=@test@ on ne pose rien
250 // car c'est un test de connexion
251 if (!defined('_ECRIRE_INSTALL') and $db !== "@test@") {
252 $f = _DIR_TMP
. $type . '.' . substr(md5($host . $port . $db), 0, 8) . '.out';
253 } elseif ($db == '@test@') {
259 and (time() - @filemtime
($f) < _CONNECT_RETRY_DELAY
)
261 spip_log("Echec : $f recent. Pas de tentative de connexion", _LOG_HS
);
267 $prefixe = isset($GLOBALS['table_prefix'])
268 ?
$GLOBALS['table_prefix'] : $db;
270 $h = charger_fonction($type, 'req', true);
272 spip_log("les requetes $type ne sont pas fournies", _LOG_HS
);
276 if ($g = $h($host, $port, $login, $pass, $db, $prefixe)) {
278 if (!is_array($auth)) {
279 // compatibilite version 0.7 initiale
281 $auth = array('ldap' => $auth);
283 $g['authentification'] = $auth;
285 $g['charset'] = $charset;
287 return $GLOBALS['db_ok'] = $g;
289 // En cas d'indisponibilite du serveur, eviter de le bombarder
292 spip_log("Echec connexion serveur $type : host[$host] port[$port] login[$login] base[$db]", $type . '.' . _LOG_HS
);
298 * Première connexion au serveur principal de base de données
300 * Retourner le charset donnée par la table principale
301 * mais vérifier que le fichier de connexion n'est pas trop vieux
304 * Version courante = 0.8
306 * - La version 0.8 indique un charset de connexion comme 9e arg
307 * - La version 0.7 indique un serveur d'authentification comme 8e arg
308 * - La version 0.6 indique le prefixe comme 7e arg
309 * - La version 0.5 indique le serveur comme 6e arg
311 * La version 0.0 (non numerotée) doit être refaite par un admin.
312 * Les autres fonctionnent toujours, même si :
314 * - la version 0.1 est moins performante que la 0.2
315 * - la 0.2 fait un include_ecrire('inc_db_mysql.php3').
317 * @param array $connexion Description de la connexion
318 * @param string $charset_sql_connexion charset de connexion fourni dans l'appal a spip_connect_db
319 * @return string|bool|int
320 * - false si pas de charset connu pour la connexion
321 * - -1 charset non renseigné
322 * - nom du charset sinon
324 function spip_connect_main($connexion, $charset_sql_connexion = '') {
325 if ($GLOBALS['spip_connect_version'] < 0.1 and _DIR_RESTREINT
) {
326 include_spip('inc/headers');
327 redirige_url_ecrire('upgrade', 'reinstall=oui');
330 if (!($f = $connexion['select'])) {
333 // si le charset est fourni, l'utiliser
334 if ($charset_sql_connexion) {
335 return $charset_sql_connexion;
337 // sinon on regarde la table spip_meta
338 // en cas d'erreur select retourne la requette (is_string=true donc)
339 if (!$r = $f('valeur', 'spip_meta', "nom='charset_sql_connexion'")
344 if (!($f = $connexion['fetch'])) {
349 return ($r['valeur'] ?
$r['valeur'] : -1);
355 * Fonction présente pour compatibilité
357 * @deprecated Utiliser l'authentification LDAP de auth/ldap
358 * @uses auth_ldap_connect()
360 * @param string $serveur Nom du connecteur
363 function spip_connect_ldap($serveur = '') {
364 include_spip('auth/ldap');
366 return auth_ldap_connect($serveur);
370 * Échappement d'une valeur sous forme de chaîne PHP
372 * Échappe une valeur (num, string, array) pour en faire une chaîne pour PHP.
373 * Un `array(1,'a',"a'")` renvoie la chaine `"'1','a','a\''"`
376 * L'usage comme échappement SQL est déprécié, à remplacer par sql_quote().
378 * @param num|string|array $a Valeur à échapper
379 * @return string Valeur échappée.
382 return (is_numeric($a)) ?
strval($a) :
383 (!is_array($a) ?
("'" . addslashes($a) . "'")
384 : join(",", array_map('_q', $a)));
389 * Récupérer le nom de la table de jointure `xxxx` sur l'objet `yyyy`
392 * Utiliser l'API editer_liens ou les tables de liaisons spip_xx_liens
393 * ou spip_yy_liens selon.
395 * @param string $x Table de destination
396 * @param string $y Objet source
397 * @return array|string
398 * - array : Description de la table de jointure si connue
399 * - chaîne vide si non trouvé.
401 function table_jointure($x, $y) {
402 $trouver_table = charger_fonction('trouver_table', 'base');
403 $xdesc = $trouver_table(table_objet($x));
404 $ydesc = $trouver_table(table_objet($y));
405 $ix = @$xdesc['key']["PRIMARY KEY"];
406 $iy = @$ydesc['key']["PRIMARY KEY"];
407 if ($table = $ydesc['tables_jointures'][$ix]) {
410 if ($table = $xdesc['tables_jointures'][$iy]) {
418 * Echapper les textes entre ' ' ou " " d'une requête SQL
419 * avant son pre-traitement
421 * On renvoi la query sans textes et les textes séparés, dans
422 * leur ordre d'apparition dans la query
424 * @see query_reinjecte_textes()
426 * @param string $query
429 function query_echappe_textes($query) {
430 static $codeEchappements = array("''" => "\x1@##@\x1", "\'" => "\x2@##@\x2", "\\\"" => "\x3@##@\x3");
431 $query = str_replace(array_keys($codeEchappements), array_values($codeEchappements), $query);
432 if (preg_match_all("/((['])[^']*(\\2))|(([\"])[^\"]*(\\5))/S", $query, $textes)) {
433 $textes = reset($textes); // indice 0 du match
434 switch (count($textes)) {
439 $replace = array('%1$s');
442 $replace = array('%1$s', '%2$s');
445 $replace = array('%1$s', '%2$s', '%3$s');
448 $replace = array('%1$s', '%2$s', '%3$s', '%4$s');
451 $replace = array('%1$s', '%2$s', '%3$s', '%4$s', '%5$s');
454 $replace = range(1, count($textes));
455 $replace = '%' . implode('$s,%', $replace) . '$s';
456 $replace = explode(',', $replace);
459 $query = str_replace($textes, $replace, $query);
464 return array($query, $textes);
468 * Réinjecter les textes d'une requete SQL à leur place initiale,
469 * après traitement de la requête
471 * @see query_echappe_textes()
473 * @param string $query
474 * @param array $textes
477 function query_reinjecte_textes($query, $textes) {
478 static $codeEchappements = array("''" => "\x1@##@\x1", "\'" => "\x2@##@\x2", "\\\"" => "\x3@##@\x3");
479 # debug de la substitution
480 #if (($c1=substr_count($query,"%"))!=($c2=count($textes))){
481 # spip_log("$c1 ::". $query,"tradquery"._LOG_ERREUR);
482 # spip_log("$c2 ::". var_export($textes,1),"tradquery"._LOG_ERREUR);
483 # spip_log("ini ::". $qi,"tradquery"._LOG_ERREUR);
485 switch (count($textes)) {
489 $query = sprintf($query, $textes[0]);
492 $query = sprintf($query, $textes[0], $textes[1]);
495 $query = sprintf($query, $textes[0], $textes[1], $textes[2]);
498 $query = sprintf($query, $textes[0], $textes[1], $textes[2], $textes[3]);
501 $query = sprintf($query, $textes[0], $textes[1], $textes[2], $textes[3], $textes[4]);
504 array_unshift($textes, $query);
505 $query = call_user_func_array('sprintf', $textes);
509 $query = str_replace(array_values($codeEchappements), array_keys($codeEchappements), $query);
516 * Exécute une requête sur le serveur SQL
519 * @deprecated Pour compatibilité. Utiliser `sql_query()` ou l'API `sql_*`.
521 * @param string $query Texte de la requête
522 * @param string $serveur Nom du connecteur pour la base de données
524 * - false si on ne peut pas exécuter la requête
527 function spip_query($query, $serveur = '') {
528 $f = spip_connect_sql($GLOBALS['spip_sql_version'], 'query', $serveur, true);
530 return function_exists($f) ?
$f($query, $serveur) : false;