connect_sql.php ➔ spip_connect_main() - Code Metrics - Inspection of "Report de r24007 : Éviter une notice PHP si cette..." - spip/SPIP - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 1a3b2f...b50fb4 )

by cam

created 2018-06-23 19:00 UTC

connect_sql.php ➔ spip_connect_main() B

↳ Parent: Project

Complexity

Conditions	9
Paths	12

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	9
nc	12
nop	2
dl	0
loc	27
rs	8.0555
c	0
b	0
f	0

<?php

/***************************************************************************\
 *  SPIP, Systeme de publication pour l'internet                           *
 *                                                                         *
 *  Copyright (c) 2001-2018                                                *
 *  Arnaud Martin, Antoine Pitrou, Philippe Riviere, Emmanuel Saint-James  *
 *                                                                         *
 *  Ce programme est un logiciel libre distribue sous licence GNU/GPL.     *
 *  Pour plus de details voir le fichier COPYING.txt ou l'aide en ligne.   *
\***************************************************************************/

/**
 * Utilitaires indispensables autour des serveurs SQL
 *
 * @package SPIP\Core\SQL
 **/
if (!defined('_ECRIRE_INC_VERSION')) {
	return;
}
require_once _ROOT_RESTREINT . 'base/objets.php';


/**
 * Connexion à un serveur de base de données
 *
 * On charge le fichier `config/$serveur` (`$serveur='connect'` pour le principal)
 * qui est censé initaliser la connexion en appelant la fonction `spip_connect_db`
 * laquelle met dans la globale `db_ok` la description de la connexion.
 *
 * On la mémorise dans un tableau pour permettre plusieurs serveurs.
 *
 * À l'installation, il faut simuler l'existence de ce fichier.
 *
 * @uses spip_connect_main()
 *
 * @param string $serveur Nom du connecteur
 * @param string $version Version de l'API SQL
 * @return bool|array
 *     - false si la connexion a échouée,
 *     - tableau décrivant la connexion sinon
 **/
function spip_connect($serveur = '', $version = '') {

	$serveur = !is_string($serveur) ? '' : strtolower($serveur);
	$index = $serveur ? $serveur : 0;
	if (!$version) {
		$version = $GLOBALS['spip_sql_version'];
	}
	if (isset($GLOBALS['connexions'][$index][$version])) {
		return $GLOBALS['connexions'][$index];
	}

	include_spip('base/abstract_sql');
	$install = (_request('exec') == 'install');

	// Premiere connexion ?
	if (!($old = isset($GLOBALS['connexions'][$index]))) {
		$f = (!preg_match('/^[\w\.]*$/', $serveur))
			? '' // nom de serveur mal ecrit
			: ($serveur ?
				(_DIR_CONNECT . $serveur . '.php') // serveur externe
				: (_FILE_CONNECT ? _FILE_CONNECT // serveur principal ok
					: ($install ? _FILE_CONNECT_TMP // init du serveur principal
						: ''))); // installation pas faite

		unset($GLOBALS['db_ok']);
		unset($GLOBALS['spip_connect_version']);
		if ($f) {
			if (is_readable($f)) {
				include($f);
			} elseif ($serveur and !$install) {
				// chercher une declaration de serveur dans le path
				// qui pourra un jour servir a declarer des bases sqlite
				// par des plugins. Et sert aussi aux boucles POUR.
				find_in_path("$serveur.php", 'connect/', true);
			}
		}
		if (!isset($GLOBALS['db_ok'])) {
			// fera mieux la prochaine fois
			if ($install) {
				return false;
			}
			if ($f and is_readable($f)) {
				spip_log("spip_connect: fichier de connexion '$f' OK.", _LOG_INFO_IMPORTANTE);
			} else {
				spip_log("spip_connect: fichier de connexion '$f' non trouve", _LOG_INFO_IMPORTANTE);
			}
			spip_log("spip_connect: echec connexion ou serveur $index mal defini dans '$f'.", _LOG_HS);

			// ne plus reessayer si ce n'est pas l'install
			return $GLOBALS['connexions'][$index] = false;
		}
		$GLOBALS['connexions'][$index] = $GLOBALS['db_ok'];
	}
	// si la connexion a deja ete tentee mais a echoue, le dire!
	if (!$GLOBALS['connexions'][$index]) {
		return false;
	}

	// la connexion a reussi ou etait deja faite.
	// chargement de la version du jeu de fonctions
	// si pas dans le fichier par defaut
	$type = $GLOBALS['db_ok']['type'];
	$jeu = 'spip_' . $type . '_functions_' . $version;
	if (!isset($GLOBALS[$jeu])) {
		if (!find_in_path($type . '_' . $version . '.php', 'req/', true)) {
			spip_log("spip_connect: serveur $index version '$version' non defini pour '$type'", _LOG_HS);

			// ne plus reessayer
			return $GLOBALS['connexions'][$index][$version] = array();
		}
	}
	$GLOBALS['connexions'][$index][$version] = $GLOBALS[$jeu];
	if ($old) {
		return $GLOBALS['connexions'][$index];
	}

	$GLOBALS['connexions'][$index]['spip_connect_version'] = isset($GLOBALS['spip_connect_version']) ? $GLOBALS['spip_connect_version'] : 0;

	// initialisation de l'alphabet utilise dans les connexions SQL
	// si l'installation l'a determine.
	// Celui du serveur principal l'impose aux serveurs secondaires
	// s'ils le connaissent

	if (!$serveur) {
		$charset = spip_connect_main($GLOBALS[$jeu], $GLOBALS['db_ok']['charset']);
		if (!$charset) {
			unset($GLOBALS['connexions'][$index]);
			spip_log("spip_connect: absence de charset", _LOG_AVERTISSEMENT);

			return false;
		}
	} else {
		if ($GLOBALS['db_ok']['charset']) {
			$charset = $GLOBALS['db_ok']['charset'];
		}
		// spip_meta n'existe pas toujours dans la base
		// C'est le cas d'un dump sqlite par exemple 
		elseif ($GLOBALS['connexions'][$index]['spip_connect_version']
			and sql_showtable('spip_meta', true, $serveur)
			and $r = sql_getfetsel('valeur', 'spip_meta', "nom='charset_sql_connexion'", '', '', '', '', $serveur)
		) {
			$charset = $r;
		} else {
			$charset = -1;
		}
	}
	if ($charset != -1) {
		$f = $GLOBALS[$jeu]['set_charset'];
		if (function_exists($f)) {
			$f($charset, $serveur);
		}
	}

	return $GLOBALS['connexions'][$index];
}

/**
 * Log la dernière erreur SQL présente sur la connexion indiquée
 *
 * @param string $serveur Nom du connecteur de bdd utilisé
 **/
function spip_sql_erreur($serveur = '') {
	$connexion = spip_connect($serveur);
	$e = sql_errno($serveur);
	$t = (isset($connexion['type']) ? $connexion['type'] : 'sql');
	$m = "Erreur $e de $t: " . sql_error($serveur) . "\nin " . sql_error_backtrace() . "\n" . trim($connexion['last']);
	$f = $t . $serveur;
	spip_log($m, $f . '.' . _LOG_ERREUR);
}

/**
 * Retourne le nom de la fonction adaptée de l'API SQL en fonction du type de serveur
 *
 * Cette fonction ne doit être appelée qu'à travers la fonction sql_serveur
 * définie dans base/abstract_sql
 *
 * Elle existe en tant que gestionnaire de versions,
 * connue seulement des convertisseurs automatiques
 *
 * @param string $version Numéro de version de l'API SQL
 * @param string $ins Instruction de l'API souhaitée, tel que 'allfetsel'
 * @param string $serveur Nom du connecteur
 * @param bool $continue true pour continuer même si le serveur SQL ou l'instruction est indisponible
 * @return array|bool|string
 *     - string : nom de la fonction à utiliser,
 *     - false : si la connexion a échouée
 *     - array : description de la connexion, si l'instruction sql est indisponible pour cette connexion
 **/
function spip_connect_sql($version, $ins = '', $serveur = '', $continue = false) {
	$desc = spip_connect($serveur, $version);
	if (function_exists($f = @$desc[$version][$ins])) {
		return $f;
	}
	if ($continue) {
		return $desc;
	}
	if ($ins) {
		spip_log("Le serveur '$serveur' version $version n'a pas '$ins'", _LOG_ERREUR);
	}
	include_spip('inc/minipres');
	echo minipres(_T('info_travaux_titre'), _T('titre_probleme_technique'), array('status' => 503));
	exit;

}

/**
 * Fonction appelée par le fichier connecteur de base de données
 * crée dans `config/` à l'installation.
 *
 * Il contient un appel direct à cette fonction avec comme arguments
 * les identifants de connexion.
 *
 * Si la connexion reussit, la globale `db_ok` mémorise sa description.
 * C'est un tableau également retourné en valeur, pour les appels
 * lors de l'installation.
 *
 * @param string $host Adresse du serveur de base de données
 * @param string $port Port utilisé pour la connexion
 * @param string $login Identifiant de connexion à la base de données
 * @param string $pass Mot de passe pour cet identifiant
 * @param string $db Nom de la base de données à utiliser
 * @param string $type Type de base de données tel que 'mysql', 'sqlite3' (cf ecrire/req/)
 * @param string $prefixe Préfixe des tables SPIP
 * @param string $auth Type d'authentification (cas si 'ldap')
 * @param string $charset Charset de la connexion SQL (optionnel)
 * @return array          Description de la connexion

 */
function spip_connect_db(
	$host,
	$port,
	$login,
	$pass,
	$db = '',
	$type = 'mysql',
	$prefixe = '',
	$auth = '',
	$charset = ''
) {
	// temps avant nouvelle tentative de connexion
	// suite a une connection echouee
	if (!defined('_CONNECT_RETRY_DELAY')) {
		define('_CONNECT_RETRY_DELAY', 30);
	}

	$f = "";
	// un fichier de identifiant par combinaison (type,host,port,db)
	// pour ne pas declarer tout indisponible d'un coup
	// si en cours d'installation ou si db=@test@ on ne pose rien
	// car c'est un test de connexion
	if (!defined('_ECRIRE_INSTALL') and $db !== "@test@") {
		$f = _DIR_TMP . $type . '.' . substr(md5($host . $port . $db), 0, 8) . '.out';
	} elseif ($db == '@test@') {
		$db = '';
	}

	if ($f
		and @file_exists($f)
		and (time() - @filemtime($f) < _CONNECT_RETRY_DELAY)
	) {
		spip_log("Echec : $f recent. Pas de tentative de connexion", _LOG_HS);

		return;
	}

	if (!$prefixe) {
		$prefixe = isset($GLOBALS['table_prefix'])
			? $GLOBALS['table_prefix'] : $db;
	}
	$h = charger_fonction($type, 'req', true);
	if (!$h) {
		spip_log("les requetes $type ne sont pas fournies", _LOG_HS);

		return;
	}
	if ($g = $h($host, $port, $login, $pass, $db, $prefixe)) {

		if (!is_array($auth)) {
			// compatibilite version 0.7 initiale
			$g['ldap'] = $auth;
			$auth = array('ldap' => $auth);
		}
		$g['authentification'] = $auth;
		$g['type'] = $type;
		$g['charset'] = $charset;

		return $GLOBALS['db_ok'] = $g;
	}
	// En cas d'indisponibilite du serveur, eviter de le bombarder
	if ($f) {
		@touch($f);
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
		spip_log("Echec connexion serveur $type : host[$host] port[$port] login[$login] base[$db]", $type . '.' . _LOG_HS);
	}
}


/**
 * Première connexion au serveur principal de base de données
 *
 * Retourner le charset donnée par la table principale
 * mais vérifier que le fichier de connexion n'est pas trop vieux
 *
 * @note
 *   Version courante = 0.8
 *
 *   - La version 0.8 indique un charset de connexion comme 9e arg
 *   - La version 0.7 indique un serveur d'authentification comme 8e arg
 *   - La version 0.6 indique le prefixe comme 7e arg
 *   - La version 0.5 indique le serveur comme 6e arg
 *
 *   La version 0.0 (non numerotée) doit être refaite par un admin.
 *   Les autres fonctionnent toujours, même si :
 *
 *   - la version 0.1 est moins performante que la 0.2
 *   - la 0.2 fait un include_ecrire('inc_db_mysql.php3').
 *
 * @param array $connexion Description de la connexion
 * @param string $charset_sql_connexion charset de connexion fourni dans l'appal a spip_connect_db
 * @return string|bool|int
 *     - false si pas de charset connu pour la connexion
 *     - -1 charset non renseigné
 *     - nom du charset sinon
 **/
function spip_connect_main($connexion, $charset_sql_connexion = '') {
	if ($GLOBALS['spip_connect_version'] < 0.1 and _DIR_RESTREINT) {
		include_spip('inc/headers');
		redirige_url_ecrire('upgrade', 'reinstall=oui');
	}

	if (!($f = $connexion['select'])) {
		return false;
	}
	// si le charset est fourni, l'utiliser
	if ($charset_sql_connexion) {
		return $charset_sql_connexion;
	}
	// sinon on regarde la table spip_meta
	// en cas d'erreur select retourne la requette (is_string=true donc)
	if (!$r = $f('valeur', 'spip_meta', "nom='charset_sql_connexion'")
		or is_string($r)
	) {
		return false;
	}
	if (!($f = $connexion['fetch'])) {
		return false;
	}
	$r = $f($r);

	return ($r['valeur'] ? $r['valeur'] : -1);
}

/**
 * Connection à LDAP
 *
 * Fonction présente pour compatibilité
 *
 * @deprecated Utiliser l'authentification LDAP de auth/ldap
 * @uses auth_ldap_connect()
 *
 * @param string $serveur Nom du connecteur
 * @return array
 */
function spip_connect_ldap($serveur = '') {
	include_spip('auth/ldap');

	return auth_ldap_connect($serveur);
}

/**
 * Échappement d'une valeur sous forme de chaîne PHP
 *
 * Échappe une valeur (num, string, array) pour en faire une chaîne pour PHP.
 * Un `array(1,'a',"a'")` renvoie la chaine `"'1','a','a\''"`
 *
 * @note
 *   L'usage comme échappement SQL est déprécié, à remplacer par sql_quote().
 *
 * @param num|string|array $a Valeur à échapper
 * @return string Valeur échappée.
 **/
function _q($a) {
	return (is_numeric($a)) ? strval($a) :
		(!is_array($a) ? ("'" . addslashes($a) . "'")
			: join(",", array_map('_q', $a)));
}


/**
 * Récupérer le nom de la table de jointure `xxxx` sur l'objet `yyyy`
 *
 * @deprecated
 *     Utiliser l'API editer_liens ou les tables de liaisons spip_xx_liens
 *     ou spip_yy_liens selon.
 *
 * @param string $x Table de destination
 * @param string $y Objet source
 * @return array|string
 *     - array : Description de la table de jointure si connue
 *     - chaîne vide si non trouvé.
 **/
function table_jointure($x, $y) {
	$trouver_table = charger_fonction('trouver_table', 'base');
	$xdesc = $trouver_table(table_objet($x));
	$ydesc = $trouver_table(table_objet($y));
	$ix = @$xdesc['key']["PRIMARY KEY"];
	$iy = @$ydesc['key']["PRIMARY KEY"];
	if ($table = $ydesc['tables_jointures'][$ix]) {
		return $table;
	}
	if ($table = $xdesc['tables_jointures'][$iy]) {
		return $table;
	}

	return '';
}

/**
 * Echapper les textes entre ' ' ou " " d'une requête SQL
 * avant son pre-traitement
 *
 * On renvoi la query sans textes et les textes séparés, dans
 * leur ordre d'apparition dans la query
 *
 * @see query_reinjecte_textes()
 *
 * @param string $query
 * @return array

 */
function query_echappe_textes($query) {
	static $codeEchappements = array("''" => "\x1@##@\x1", "\'" => "\x2@##@\x2", "\\\"" => "\x3@##@\x3");
	$query = str_replace(array_keys($codeEchappements), array_values($codeEchappements), $query);
	if (preg_match_all("/((['])[^']*(\\2))|(([\"])[^\"]*(\\5))/S", $query, $textes)) {
		$textes = reset($textes); // indice 0 du match
		switch (count($textes)) {
			case 0:
				$replace = array();
				break;
			case 1:
				$replace = array('%1$s');
				break;
			case 2:
				$replace = array('%1$s', '%2$s');
				break;
			case 3:
				$replace = array('%1$s', '%2$s', '%3$s');
				break;
			case 4:
				$replace = array('%1$s', '%2$s', '%3$s', '%4$s');
				break;
			case 5:
				$replace = array('%1$s', '%2$s', '%3$s', '%4$s', '%5$s');
				break;
			default:
				$replace = range(1, count($textes));
				$replace = '%' . implode('$s,%', $replace) . '$s';
				$replace = explode(',', $replace);
				break;
		}
		$query = str_replace($textes, $replace, $query);
	} else {
		$textes = array();
	}

	return array($query, $textes);
}

/**
 * Réinjecter les textes d'une requete SQL à leur place initiale,
 * après traitement de la requête
 *
 * @see query_echappe_textes()
 *
 * @param string $query
 * @param array $textes
 * @return string
 */
function query_reinjecte_textes($query, $textes) {
	static $codeEchappements = array("''" => "\x1@##@\x1", "\'" => "\x2@##@\x2", "\\\"" => "\x3@##@\x3");
	# debug de la substitution
	#if (($c1=substr_count($query,"%"))!=($c2=count($textes))){
	#	spip_log("$c1 ::". $query,"tradquery"._LOG_ERREUR);
	#	spip_log("$c2 ::". var_export($textes,1),"tradquery"._LOG_ERREUR);
	#	spip_log("ini ::". $qi,"tradquery"._LOG_ERREUR);
	#}
	switch (count($textes)) {
		case 0:
			break;
		case 1:
			$query = sprintf($query, $textes[0]);
			break;
		case 2:
			$query = sprintf($query, $textes[0], $textes[1]);
			break;
		case 3:
			$query = sprintf($query, $textes[0], $textes[1], $textes[2]);
			break;
		case 4:

			$query = sprintf($query, $textes[0], $textes[1], $textes[2], $textes[3]);
			break;
		case 5:

			$query = sprintf($query, $textes[0], $textes[1], $textes[2], $textes[3], $textes[4]);
			break;
		default:
			array_unshift($textes, $query);
			$query = call_user_func_array('sprintf', $textes);
			break;
	}

	$query = str_replace(array_values($codeEchappements), array_keys($codeEchappements), $query);

	return $query;
}


/**
 * Exécute une requête sur le serveur SQL
 *
 * @note Ne génère pas d’erreur fatale si la connexion à la BDD n’existe pas
 * @see sql_query()
 * @deprecated  Pour compatibilité. Utiliser `sql_query()` ou l'API `sql_*`.
 *
 * @param string $query Texte de la requête
 * @param string $serveur Nom du connecteur pour la base de données
 * @return bool|mixed
 *     - false si on ne peut pas exécuter la requête
 *     - indéfini sinon.
 **/
function spip_query($query, $serveur = '') {
	$f = spip_connect_sql($GLOBALS['spip_sql_version'], 'query', $serveur, true);

	return function_exists($f) ? $f($query, $serveur) : false;
}


1		<?php
2
3		/***************************************************************************\
4		* SPIP, Systeme de publication pour l'internet *
5		* *
6		* Copyright (c) 2001-2018 *
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		/**
14		* Utilitaires indispensables autour des serveurs SQL
15		*
16		* @package SPIP\Core\SQL
17		**/
18		if (!defined('_ECRIRE_INC_VERSION')) {
19		return;
20		}
21		require_once _ROOT_RESTREINT . 'base/objets.php';
22
23
24		/**
25		* Connexion à un serveur de base de données
26		*
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.
30		*
31		* On la mémorise dans un tableau pour permettre plusieurs serveurs.
32		*
33		* À l'installation, il faut simuler l'existence de ce fichier.
34		*
35		* @uses spip_connect_main()
36		*
37		* @param string $serveur Nom du connecteur
38		* @param string $version Version de l'API SQL
39		* @return bool\|array
40		* - false si la connexion a échouée,
41		* - tableau décrivant la connexion sinon
42		**/
43		function spip_connect($serveur = '', $version = '') {
44
45		$serveur = !is_string($serveur) ? '' : strtolower($serveur);
46		$index = $serveur ? $serveur : 0;
47		if (!$version) {
48		$version = $GLOBALS['spip_sql_version'];
49		}
50		if (isset($GLOBALS['connexions'][$index][$version])) {
51		return $GLOBALS['connexions'][$index];
52		}
53
54		include_spip('base/abstract_sql');
55		$install = (_request('exec') == 'install');
56
57		// Premiere connexion ?
58		if (!($old = isset($GLOBALS['connexions'][$index]))) {
59		$f = (!preg_match('/^[\w\.]*$/', $serveur))
60		? '' // nom de serveur mal ecrit
61		: ($serveur ?
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
66
67		unset($GLOBALS['db_ok']);
68		unset($GLOBALS['spip_connect_version']);
69		if ($f) {
70		if (is_readable($f)) {
71		include($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);
77		}
78		}
79		if (!isset($GLOBALS['db_ok'])) {
80		// fera mieux la prochaine fois
81		if ($install) {
82		return false;
83		}
84		if ($f and is_readable($f)) {
85		spip_log("spip_connect: fichier de connexion '$f' OK.", _LOG_INFO_IMPORTANTE);
86		} else {
87		spip_log("spip_connect: fichier de connexion '$f' non trouve", _LOG_INFO_IMPORTANTE);
88		}
89		spip_log("spip_connect: echec connexion ou serveur $index mal defini dans '$f'.", _LOG_HS);
90
91		// ne plus reessayer si ce n'est pas l'install
92		return $GLOBALS['connexions'][$index] = false;
93		}
94		$GLOBALS['connexions'][$index] = $GLOBALS['db_ok'];
95		}
96		// si la connexion a deja ete tentee mais a echoue, le dire!
97		if (!$GLOBALS['connexions'][$index]) {
98		return false;
99		}
100
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);
109
110		// ne plus reessayer
111		return $GLOBALS['connexions'][$index][$version] = array();
112		}
113		}
114		$GLOBALS['connexions'][$index][$version] = $GLOBALS[$jeu];
115		if ($old) {
116		return $GLOBALS['connexions'][$index];
117		}
118
119		$GLOBALS['connexions'][$index]['spip_connect_version'] = isset($GLOBALS['spip_connect_version']) ? $GLOBALS['spip_connect_version'] : 0;
120
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
125
126		if (!$serveur) {
127		$charset = spip_connect_main($GLOBALS[$jeu], $GLOBALS['db_ok']['charset']);
128		if (!$charset) {
129		unset($GLOBALS['connexions'][$index]);
130		spip_log("spip_connect: absence de charset", _LOG_AVERTISSEMENT);
131
132		return false;
133		}
134		} else {
135		if ($GLOBALS['db_ok']['charset']) {
136		$charset = $GLOBALS['db_ok']['charset'];
137		}
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)
143		) {
144		$charset = $r;
145		} else {
146		$charset = -1;
147		}
148		}
149		if ($charset != -1) {
150		$f = $GLOBALS[$jeu]['set_charset'];
151		if (function_exists($f)) {
152		$f($charset, $serveur);
153		}
154		}
155
156		return $GLOBALS['connexions'][$index];
157		}
158
159		/**
160		* Log la dernière erreur SQL présente sur la connexion indiquée
161		*
162		* @param string $serveur Nom du connecteur de bdd utilisé
163		**/
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']);
169		$f = $t . $serveur;
170		spip_log($m, $f . '.' . _LOG_ERREUR);
171		}
172
173		/**
174		* Retourne le nom de la fonction adaptée de l'API SQL en fonction du type de serveur
175		*
176		* Cette fonction ne doit être appelée qu'à travers la fonction sql_serveur
177		* définie dans base/abstract_sql
178		*
179		* Elle existe en tant que gestionnaire de versions,
180		* connue seulement des convertisseurs automatiques
181		*
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 $continue 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
190		**/
191		function spip_connect_sql($version, $ins = '', $serveur = '', $continue = false) {
192		$desc = spip_connect($serveur, $version);
193		if (function_exists($f = @$desc[$version][$ins])) {
194		return $f;
195		}
196		if ($continue) {
197		return $desc;
198		}
199		if ($ins) {
200		spip_log("Le serveur '$serveur' version $version n'a pas '$ins'", _LOG_ERREUR);
201		}
202		include_spip('inc/minipres');
203		echo minipres(_T('info_travaux_titre'), _T('titre_probleme_technique'), array('status' => 503));
204		exit;
		0 ignored issues – show Coding Style Compatibility introduced 2016-04-05 12:02 UTC by Report Bug Copy Issue Report The function spip_connect_sql() contains an exit expression. An exit expression should only be used in rare cases. For example, if you write a short command line script. In most cases however, using an `exit` expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage. Loading history...
205		}
206
207		/**
208		* Fonction appelée par le fichier connecteur de base de données
209		* crée dans `config/` à l'installation.
210		*
211		* Il contient un appel direct à cette fonction avec comme arguments
212		* les identifants de connexion.
213		*
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.
217		*
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
		0 ignored issues – show Documentation introduced 2016-04-05 12:13 UTC by Report Bug Copy Issue Report Should the return type not be `null\|array<string,array\|string>`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
228		*/
229		function spip_connect_db(
230		$host,
231		$port,
232		$login,
233		$pass,
234		$db = '',
235		$type = 'mysql',
236		$prefixe = '',
237		$auth = '',
238		$charset = ''
239		) {
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);
244		}
245
246		$f = "";
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@') {
254		$db = '';
255		}
256
257		if ($f
258		and @file_exists($f)
259		and (time() - @filemtime($f) < _CONNECT_RETRY_DELAY)
260		) {
261		spip_log("Echec : $f recent. Pas de tentative de connexion", _LOG_HS);
262
263		return;
264		}
265
266		if (!$prefixe) {
267		$prefixe = isset($GLOBALS['table_prefix'])
268		? $GLOBALS['table_prefix'] : $db;
269		}
270		$h = charger_fonction($type, 'req', true);
271		if (!$h) {
272		spip_log("les requetes $type ne sont pas fournies", _LOG_HS);
273
274		return;
275		}
276		if ($g = $h($host, $port, $login, $pass, $db, $prefixe)) {
277
278		if (!is_array($auth)) {
279		// compatibilite version 0.7 initiale
280		$g['ldap'] = $auth;
281		$auth = array('ldap' => $auth);
282		}
283		$g['authentification'] = $auth;
284		$g['type'] = $type;
285		$g['charset'] = $charset;
286
287		return $GLOBALS['db_ok'] = $g;
288		}
289		// En cas d'indisponibilite du serveur, eviter de le bombarder
290		if ($f) {
291		@touch($f);
		0 ignored issues – show Security Best Practice introduced 2016-04-05 12:02 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
292		spip_log("Echec connexion serveur $type : host[$host] port[$port] login[$login] base[$db]", $type . '.' . _LOG_HS);
293		}
294		}
295
296
297		/**
298		* Première connexion au serveur principal de base de données
299		*
300		* Retourner le charset donnée par la table principale
301		* mais vérifier que le fichier de connexion n'est pas trop vieux
302		*
303		* @note
304		* Version courante = 0.8
305		*
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
310		*
311		* La version 0.0 (non numerotée) doit être refaite par un admin.
312		* Les autres fonctionnent toujours, même si :
313		*
314		* - la version 0.1 est moins performante que la 0.2
315		* - la 0.2 fait un include_ecrire('inc_db_mysql.php3').
316		*
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
323		**/
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');
328		}
329
330		if (!($f = $connexion['select'])) {
331		return false;
332		}
333		// si le charset est fourni, l'utiliser
334		if ($charset_sql_connexion) {
335		return $charset_sql_connexion;
336		}
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'")
340		or is_string($r)
341		) {
342		return false;
343		}
344		if (!($f = $connexion['fetch'])) {
345		return false;
346		}
347		$r = $f($r);
348
349		return ($r['valeur'] ? $r['valeur'] : -1);
350		}
351
352		/**
353		* Connection à LDAP
354		*
355		* Fonction présente pour compatibilité
356		*
357		* @deprecated Utiliser l'authentification LDAP de auth/ldap
358		* @uses auth_ldap_connect()
359		*
360		* @param string $serveur Nom du connecteur
361		* @return array
362		*/
363		function spip_connect_ldap($serveur = '') {
364		include_spip('auth/ldap');
365
366		return auth_ldap_connect($serveur);
367		}
368
369		/**
370		* Échappement d'une valeur sous forme de chaîne PHP
371		*
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\''"`
374		*
375		* @note
376		* L'usage comme échappement SQL est déprécié, à remplacer par sql_quote().
377		*
378		* @param num\|string\|array $a Valeur à échapper
379		* @return string Valeur échappée.
380		**/
381		function _q($a) {
382		return (is_numeric($a)) ? strval($a) :
383		(!is_array($a) ? ("'" . addslashes($a) . "'")
384		: join(",", array_map('_q', $a)));
385		}
386
387
388		/**
389		* Récupérer le nom de la table de jointure `xxxx` sur l'objet `yyyy`
390		*
391		* @deprecated
392		* Utiliser l'API editer_liens ou les tables de liaisons spip_xx_liens
393		* ou spip_yy_liens selon.
394		*
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é.
400		**/
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]) {
408		return $table;
409		}
410		if ($table = $xdesc['tables_jointures'][$iy]) {
411		return $table;
412		}
413
414		return '';
415		}
416
417		/**
418		* Echapper les textes entre ' ' ou " " d'une requête SQL
419		* avant son pre-traitement
420		*
421		* On renvoi la query sans textes et les textes séparés, dans
422		* leur ordre d'apparition dans la query
423		*
424		* @see query_reinjecte_textes()
425		*
426		* @param string $query
427		* @return array
		0 ignored issues – show Documentation introduced 2016-04-05 12:02 UTC by Report Bug Copy Issue Report Consider making the return type a bit more specific; maybe use `array<string\|false\|array>`. This check looks for the generic type `array` as a return type and suggests a more specific type. This type is inferred from the actual code. Loading history...
428		*/
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)) {
435		case 0:
436		$replace = array();
437		break;
438		case 1:
439		$replace = array('%1$s');
440		break;
441		case 2:
442		$replace = array('%1$s', '%2$s');
443		break;
444		case 3:
445		$replace = array('%1$s', '%2$s', '%3$s');
446		break;
447		case 4:
448		$replace = array('%1$s', '%2$s', '%3$s', '%4$s');
449		break;
450		case 5:
451		$replace = array('%1$s', '%2$s', '%3$s', '%4$s', '%5$s');
452		break;
453		default:
454		$replace = range(1, count($textes));
455		$replace = '%' . implode('$s,%', $replace) . '$s';
456		$replace = explode(',', $replace);
457		break;
458		}
459		$query = str_replace($textes, $replace, $query);
460		} else {
461		$textes = array();
462		}
463
464		return array($query, $textes);
465		}
466
467		/**
468		* Réinjecter les textes d'une requete SQL à leur place initiale,
469		* après traitement de la requête
470		*
471		* @see query_echappe_textes()
472		*
473		* @param string $query
474		* @param array $textes
475		* @return string
476		*/
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);
484		#}
485		switch (count($textes)) {
486		case 0:
487		break;
488		case 1:
489		$query = sprintf($query, $textes[0]);
490		break;
491		case 2:
492		$query = sprintf($query, $textes[0], $textes[1]);
493		break;
494		case 3:
495		$query = sprintf($query, $textes[0], $textes[1], $textes[2]);
496		break;
497	View Code Duplication	case 4:
		0 ignored issues – show Duplication introduced 2016-04-05 13:09 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
498		$query = sprintf($query, $textes[0], $textes[1], $textes[2], $textes[3]);
499		break;
500	View Code Duplication	case 5:
		0 ignored issues – show Duplication introduced 2016-04-05 13:09 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
501		$query = sprintf($query, $textes[0], $textes[1], $textes[2], $textes[3], $textes[4]);
502		break;
503		default:
504		array_unshift($textes, $query);
505		$query = call_user_func_array('sprintf', $textes);
506		break;
507		}
508
509		$query = str_replace(array_values($codeEchappements), array_keys($codeEchappements), $query);
510
511		return $query;
512		}
513
514
515		/**
516		* Exécute une requête sur le serveur SQL
517		*
518		* @note Ne génère pas d’erreur fatale si la connexion à la BDD n’existe pas
519		* @see sql_query()
520		* @deprecated Pour compatibilité. Utiliser `sql_query()` ou l'API `sql_*`.
521		*
522		* @param string $query Texte de la requête
523		* @param string $serveur Nom du connecteur pour la base de données
524		* @return bool\|mixed
525		* - false si on ne peut pas exécuter la requête
526		* - indéfini sinon.
527		**/
528		function spip_query($query, $serveur = '') {
529		$f = spip_connect_sql($GLOBALS['spip_sql_version'], 'query', $serveur, true);
530
531		return function_exists($f) ? $f($query, $serveur) : false;
532		}
533

spip / SPIP

Push — master ( 1a3b2f...b50fb4 )

connect_sql.php ➔ spip_connect_main() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like