Subversion Repositories Applications.framework

Rev

Rev 241 | Rev 390 | Go to most recent revision | Only display areas with differences | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 241 Rev 274
1
<?php
1
<?php
2
// declare(encoding='UTF-8');
2
// declare(encoding='UTF-8');
3
/**
3
/**
4
 * Config permet de charger automatiquement les fichiers ini du Framework et de l'application.
4
 * Config permet de charger automatiquement les fichiers ini du Framework et de l'application.
5
 * Elle offre l'accès en lecture seule aux paramètres de config.
5
 * Elle offre l'accès en lecture seule aux paramètres de config.
6
 * C'est une Singleton.
6
 * C'est une Singleton.
7
 * Si vous avez besoin de modifier dynamiquement des paramètres de configuration, utiliser le @see Registe, il est fait pour ça.
7
 * Si vous avez besoin de modifier dynamiquement des paramètres de configuration, utiliser le @see Registe, il est fait pour ça.
8
 * 
8
 * 
9
 * @category	PHP 5.2
9
 * @category	PHP 5.2
10
 * @package	Framework
10
 * @package	Framework
11
 * @author		Jean-Pascal MILCENT <jpm@tela-botanica.org>
11
 * @author		Jean-Pascal MILCENT <jpm@tela-botanica.org>
12
 * @copyright	Copyright (c) 2009, Tela Botanica (accueil@tela-botanica.org)
12
 * @copyright	Copyright (c) 2009, Tela Botanica (accueil@tela-botanica.org)
13
 * @license	http://www.gnu.org/licenses/gpl.html Licence GNU-GPL-v3
13
 * @license	http://www.gnu.org/licenses/gpl.html Licence GNU-GPL-v3
14
 * @license	http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt Licence CECILL-v2 
14
 * @license	http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt Licence CECILL-v2 
15
 * @version	$Id: Config.php 241 2010-12-06 15:19:07Z jpm $
15
 * @version	$Id: Config.php 274 2010-12-28 15:37:22Z jpm $
16
 * @link		/doc/framework/
16
 * @link		/doc/framework/
17
 */
17
 */
18
 
18
 
19
class Config {
19
class Config {
20
 
20
 
21
	/** Instance de la classe pointant sur elle même (pour le pattern singleton). */
21
	/** Instance de la classe pointant sur elle même (pour le pattern singleton). */
22
	private static $instance = null;
22
	private static $instance = null;
23
 
23
 
24
	/** Paramètres de configuration. */
24
	/** Paramètres de configuration. */
25
	private static $parametres = array();
25
	private static $parametres = array();
26
 
26
 
27
	private function __construct() {
27
	private function __construct() {
28
		// Définition de paramètres avant chargement du config.ini
28
		// Définition de paramètres avant chargement du config.ini
29
		self::$parametres = array(
29
		self::$parametres = array(
30
			'fw_fichier_config' => 'config%s.ini',
30
			'fichier_config' => 'config%s.ini',
31
			'fw_chemin' => dirname(__FILE__).DS
31
			'chemin_framework' => dirname(__FILE__).DS
32
			);
32
			);
33
 
33
 
34
		// Chargement du fichier config.ini du Framework
34
		// Chargement du fichier config.ini du Framework
35
		$existe = self::parserFichierIni(self::$parametres['fw_chemin'].sprintf(self::$parametres['fw_fichier_config'], ''));
35
		$existe = self::parserFichierIni(self::$parametres['chemin_framework'].sprintf(self::$parametres['fichier_config'], ''));
36
		if ($existe === false) {
36
		if ($existe === false) {
37
			trigger_error("Veuillez configurer le Framework en renommant le fichier config.defaut.ini en config.ini.", E_USER_ERROR);
37
			trigger_error("Veuillez configurer le Framework en renommant le fichier config.defaut.ini en config.ini.", E_USER_ERROR);
38
		}
38
		}
39
 
39
 
40
		// Chargement du fichier config.ini par défaut de l'application
40
		// Chargement du fichier config.ini par défaut de l'application
41
		$chemin_config_defaut_appli = self::$parametres['chemin_configurations'].sprintf(self::$parametres['fw_fichier_config'], '');
41
		$chemin_config_defaut_appli = self::$parametres['chemin_configurations'].sprintf(self::$parametres['fichier_config'], '');
42
		self::parserFichierIni($chemin_config_defaut_appli);
42
		self::parserFichierIni($chemin_config_defaut_appli);
43
 
43
 
44
		// Chargement des fichiers config.ini contextuels
44
		// Chargement des fichiers config.ini contextuels
45
		if (PHP_SAPI == 'cli') {// mode console
45
		if (PHP_SAPI == 'cli') {// mode console
46
			foreach ($_SERVER['argv'] as $cle => $valeur) {
46
			foreach ($_SERVER['argv'] as $cle => $valeur) {
47
				if ($valeur == '-contexte') {
47
				if ($valeur == '-contexte') {
48
					chargerFichierContexte($_SERVER['argv'][($cle+1)]);
48
					chargerFichierContexte($_SERVER['argv'][($cle+1)]);
49
					break;
49
					break;
50
				}
50
				}
51
			}
51
			}
52
		} else {// mode web
52
		} else {// mode web
53
			// Pour Papyrus
53
			// Pour Papyrus
54
			if (defined('PAP_VERSION')) {
54
			if (defined('PAP_VERSION')) {
55
				self::chargerFichierContexte('papyrus');
55
				self::chargerFichierContexte('papyrus');
56
			}
56
			}
57
			// Via le fichie .ini par défaut de l'appli
57
			// Via le fichie .ini par défaut de l'appli
58
			if (Config::existeValeur('info.contexte', self::$parametres)) {
58
			if (Config::existeValeur('info.contexte', self::$parametres)) {
59
				self::chargerFichierContexte(Config::get('info.contexte'));
59
				self::chargerFichierContexte(Config::get('info.contexte'));
60
			}
60
			}
61
 
61
 
62
			// Chargement du contexte présent dans le GET
62
			// Chargement du contexte présent dans le GET
63
			if (isset($_GET['contexte'])) {
63
			if (isset($_GET['contexte'])) {
64
				$_GET['contexte'] = strip_tags($_GET['contexte']);
64
				$_GET['contexte'] = strip_tags($_GET['contexte']);
65
				self::chargerFichierContexte($_GET['contexte']);
65
				self::chargerFichierContexte($_GET['contexte']);
66
			}
66
			}
67
 
67
 
68
			// Chargement du contexte présent dans le POST
68
			// Chargement du contexte présent dans le POST
69
			if (isset($_POST['contexte'])) {
69
			if (isset($_POST['contexte'])) {
70
				$_POST['contexte'] = strip_tags($_POST['contexte']);
70
				$_POST['contexte'] = strip_tags($_POST['contexte']);
71
				self::chargerFichierContexte($_POST['contexte']);
71
				self::chargerFichierContexte($_POST['contexte']);
72
			}
72
			}
73
		}
73
		}
74
	}
74
	}
75
 
75
 
76
	/**
76
	/**
77
	 * Charge le fichier de config correspondant au contexte
77
	 * Charge le fichier de config correspondant au contexte
78
	 * @param string $contexte le contexte
78
	 * @param string $contexte le contexte
79
	 */
79
	 */
80
	private static function chargerFichierContexte($contexte) {
80
	private static function chargerFichierContexte($contexte) {
81
		$chemin_config_appli_contextuel = self::$parametres['chemin_configurations'];
81
		$chemin_config_appli_contextuel = self::$parametres['chemin_configurations'];
82
		$chemin_config_appli_contextuel .= sprintf(self::$parametres['fw_fichier_config'], '_'.$contexte);
82
		$chemin_config_appli_contextuel .= sprintf(self::$parametres['ffichier_config'], '_'.$contexte);
83
		self::parserFichierIni($chemin_config_appli_contextuel);
83
		self::parserFichierIni($chemin_config_appli_contextuel);
84
	}
84
	}
85
 
85
 
86
	/**
86
	/**
87
	 * Parse le fichier ini donné en paramètre
87
	 * Parse le fichier ini donné en paramètre
88
	 * @param string $fichier_ini nom du fichier ini à parser
88
	 * @param string $fichier_ini nom du fichier ini à parser
89
	 * @return array tableau contenant les paramètres du fichier ini
89
	 * @return array tableau contenant les paramètres du fichier ini
90
	 */
90
	 */
91
	private static function parserFichierIni($fichier_ini) {
91
	private static function parserFichierIni($fichier_ini) {
92
		$retour = false;
92
		$retour = false;
93
		if (file_exists($fichier_ini)) {
93
		if (file_exists($fichier_ini)) {
94
			$ini = parse_ini_file($fichier_ini, true);
94
			$ini = parse_ini_file($fichier_ini, true);
95
			$ini = self::analyserTableauIni($ini);
95
			$ini = self::analyserTableauIni($ini);
96
			self::fusionner($ini);
96
			self::fusionner($ini);
97
			$retour = true;
97
			$retour = true;
98
		}
98
		}
99
		return $retour;
99
		return $retour;
100
	}
100
	}
101
 
101
 
102
	/**
102
	/**
103
	 * Fusionne un tableau de paramètres avec le tableau de paramètres global
103
	 * Fusionne un tableau de paramètres avec le tableau de paramètres global
104
	 * @param array $ini le tableau à fusionner
104
	 * @param array $ini le tableau à fusionner
105
	 */
105
	 */
106
	private static function fusionner(array $ini) {
106
	private static function fusionner(array $ini) {
107
		self::$parametres = array_merge(self::$parametres, $ini);
107
		self::$parametres = array_merge(self::$parametres, $ini);
108
	}
108
	}
109
 
109
 
110
	/**
110
	/**
111
	 * Renvoie la valeur demandée grâce une chaîne de paramètres
111
	 * Renvoie la valeur demandée grâce une chaîne de paramètres
112
	 * @param string $param la chaine de paramètres
112
	 * @param string $param la chaine de paramètres
113
	 * @param array $config le tableau de paramètre
113
	 * @param array $config le tableau de paramètre
114
	 * @return string la valeur de la chaine demandée
114
	 * @return string la valeur de la chaine demandée
115
	 */
115
	 */
116
	private static function getValeur($param, $config) {
116
	private static function getValeur($param, $config) {
117
		if ($param === null) {
117
		if ($param === null) {
118
			return null;
118
			return null;
119
		} else {
119
		} else {
120
			if (isset($config[$param])) {
120
			if (isset($config[$param])) {
121
				return $config[$param];
121
				return $config[$param];
122
			} else if (strpos($param, '.') !== false) {
122
			} else if (strpos($param, '.') !== false) {
123
				$pieces = explode('.', $param, 2);
123
				$pieces = explode('.', $param, 2);
124
				if (strlen($pieces[0]) && strlen($pieces[1])) {
124
				if (strlen($pieces[0]) && strlen($pieces[1])) {
125
					if (isset($config[$pieces[0]])) {
125
					if (isset($config[$pieces[0]])) {
126
					   if (is_array($config[$pieces[0]])) {
126
					   if (is_array($config[$pieces[0]])) {
127
					   		return self::getValeur($pieces[1], $config[$pieces[0]]);
127
					   		return self::getValeur($pieces[1], $config[$pieces[0]]);
128
					   }
128
					   }
129
					}
129
					}
130
				}
130
				}
131
			} else {
131
			} else {
132
				return null;
132
				return null;
133
			}
133
			}
134
		}
134
		}
135
	}
135
	}
136
 
136
 
137
	/**
137
	/**
138
	 * Teste si param existe dans le tableau config
138
	 * Teste si param existe dans le tableau config
139
	 * @param string $param nom du paramètre
139
	 * @param string $param nom du paramètre
140
	 * @param array tableau de configuration
140
	 * @param array tableau de configuration
141
	 */
141
	 */
142
	private static function existeValeur($param, $config) {
142
	private static function existeValeur($param, $config) {
143
		$retour = false;
143
		$retour = false;
144
		if (self::getValeur($param, $config) !== null) {
144
		if (self::getValeur($param, $config) !== null) {
145
			$retour = true;
145
			$retour = true;
146
		}
146
		}
147
		return $retour;
147
		return $retour;
148
	}
148
	}
149
 
149
 
150
	/**
150
	/**
151
	 * Vérifie si l'instance de classe à été crée, si non la crée
151
	 * Vérifie si l'instance de classe à été crée, si non la crée
152
	 */
152
	 */
153
	private static function verifierCreationInstance() {
153
	private static function verifierCreationInstance() {
154
		if (empty(self::$instance)) {
154
		if (empty(self::$instance)) {
155
			self::$instance = new Config();
155
			self::$instance = new Config();
156
		}
156
		}
157
	}
157
	}
158
 
158
 
159
	/**
159
	/**
160
	 * Analyse un tableau de paramètres.
160
	 * Analyse un tableau de paramètres.
161
	 * @param array $config le tableau de paramètres
161
	 * @param array $config le tableau de paramètres
162
	 * @return array le tableau analysé
162
	 * @return array le tableau analysé
163
	 */
163
	 */
164
	private static function analyserTableauIni($config = array()) {
164
	private static function analyserTableauIni($config = array()) {
165
		foreach ($config as $cle => &$valeur) {
165
		foreach ($config as $cle => &$valeur) {
166
			if (is_array($valeur)) {
166
			if (is_array($valeur)) {
167
				$config[$cle] = self::analyserTableauIni($valeur);
167
				$config[$cle] = self::analyserTableauIni($valeur);
168
			} else {
168
			} else {
169
				self::evaluerReferences($config, $cle);
169
				self::evaluerReferences($config, $cle);
170
				self::evaluerPhp($config, $cle);
170
				self::evaluerPhp($config, $cle);
171
				self::evaluerCle($config, $cle, $config[$cle]);
171
				self::evaluerCle($config, $cle, $config[$cle]);
172
			}
172
			}
173
		}
173
		}
174
		return $config;
174
		return $config;
175
	}
175
	}
176
 
176
 
177
	/**
177
	/**
178
	 * Dans le cas des chaine de configuration à sous clé (ex.: cle.souscle)
178
	 * Dans le cas des chaine de configuration à sous clé (ex.: cle.souscle)
179
	 * évalue les valeurs correspondantes et crée les sous tableaux associés.
179
	 * évalue les valeurs correspondantes et crée les sous tableaux associés.
180
	 * @param array $config tableau de configuration (par référence)
180
	 * @param array $config tableau de configuration (par référence)
181
	 * @param string $cle la cle dans le tableau
181
	 * @param string $cle la cle dans le tableau
182
	 * @param string $valeur la valeur à affecter
182
	 * @param string $valeur la valeur à affecter
183
	 */
183
	 */
184
	private static function evaluerCle(&$config, $cle, $valeur) {
184
	private static function evaluerCle(&$config, $cle, $valeur) {
185
		if (strpos($cle, '.') !== false) {
185
		if (strpos($cle, '.') !== false) {
186
			unset($config[$cle]);
186
			unset($config[$cle]);
187
			$pieces = explode('.', $cle, 2);
187
			$pieces = explode('.', $cle, 2);
188
			if (strlen($pieces[0]) && strlen($pieces[1])) {
188
			if (strlen($pieces[0]) && strlen($pieces[1])) {
189
				if (isset($config[$pieces[0]]) && !is_array($config[$pieces[0]])) {
189
				if (isset($config[$pieces[0]]) && !is_array($config[$pieces[0]])) {
190
					$m = "Ne peut pas créer de sous-clé pour '{$pieces[0]}' car la clé existe déjà";
190
					$m = "Ne peut pas créer de sous-clé pour '{$pieces[0]}' car la clé existe déjà";
191
					trigger_error($m, E_USER_WARNING);
191
					trigger_error($m, E_USER_WARNING);
192
				} else {
192
				} else {
193
					$config[$pieces[0]][$pieces[1]] = $valeur;
193
					$config[$pieces[0]][$pieces[1]] = $valeur;
194
					$config[$pieces[0]] = self::evaluerCle($config[$pieces[0]], $pieces[1], $valeur);
194
					$config[$pieces[0]] = self::evaluerCle($config[$pieces[0]], $pieces[1], $valeur);
195
				}
195
				}
196
			} else {
196
			} else {
197
				$m = "Clé invalide '$cle'";
197
				$m = "Clé invalide '$cle'";
198
				trigger_error($m, E_USER_WARNING);
198
				trigger_error($m, E_USER_WARNING);
199
			}
199
			}
200
		} else {
200
		} else {
201
			$config[$cle] = $valeur;
201
			$config[$cle] = $valeur;
202
		}
202
		}
203
		return $config;
203
		return $config;
204
	}
204
	}
205
 
205
 
206
	/**
206
	/**
207
	 * Évalue les valeurs de références à une clé dans le tableau config (cas du ref:cle).
207
	 * Évalue les valeurs de références à une clé dans le tableau config (cas du ref:cle).
208
	 * @param array $config tableau de configuration
208
	 * @param array $config tableau de configuration
209
	 * @param string $cle la clé dont il faut évaluer les références
209
	 * @param string $cle la clé dont il faut évaluer les références
210
	 */
210
	 */
211
	private static function evaluerReferences(&$config, $cle) {
211
	private static function evaluerReferences(&$config, $cle) {
212
		if (preg_match_all('/{ref:([A-Za-z0-9_.-]+)}/', $config[$cle], $correspondances,  PREG_SET_ORDER)) {
212
		if (preg_match_all('/{ref:([A-Za-z0-9_.-]+)}/', $config[$cle], $correspondances,  PREG_SET_ORDER)) {
213
			foreach ($correspondances as $ref) {
213
			foreach ($correspondances as $ref) {
214
				$config[$cle] = str_replace($ref[0], self::getValeur($ref[1], $config), $config[$cle]);
214
				$config[$cle] = str_replace($ref[0], self::getValeur($ref[1], $config), $config[$cle]);
215
			}
215
			}
216
		}
216
		}
217
	}
217
	}
218
 
218
 
219
	/**
219
	/**
220
	 * Évalue le code php contenu dans un clé tu tableau config.
220
	 * Évalue le code php contenu dans un clé tu tableau config.
221
	 * @param array $config tableau de configuration (par référence)
221
	 * @param array $config tableau de configuration (par référence)
222
	 * @param string $cle le clé du tableau dont il faut évaluer la valeur
222
	 * @param string $cle le clé du tableau dont il faut évaluer la valeur
223
	 */
223
	 */
224
	private static function evaluerPhp(&$config, $cle) {
224
	private static function evaluerPhp(&$config, $cle) {
225
		if (preg_match('/^php:(.+)$/', $config[$cle], $correspondances)) {
225
		if (preg_match('/^php:(.+)$/', $config[$cle], $correspondances)) {
226
			eval('$config["'.$cle.'"] = '.$correspondances[1].';');
226
			eval('$config["'.$cle.'"] = '.$correspondances[1].';');
227
		}
227
		}
228
	}
228
	}
229
 
229
 
230
	/**
230
	/**
231
	 * Charge un fichier ini dans le tableau des paramètres de l'appli.
231
	 * Charge un fichier ini dans le tableau des paramètres de l'appli.
232
	 * @param string $fichier_ini le nom du fichier à charger
232
	 * @param string $fichier_ini le nom du fichier à charger
233
	 * @return array le fichier ini parsé
233
	 * @return array le fichier ini parsé
234
	 */
234
	 */
235
	public static function charger($fichier_ini) {
235
	public static function charger($fichier_ini) {
236
		self::verifierCreationInstance();
236
		self::verifierCreationInstance();
237
		return self::parserFichierIni($fichier_ini);
237
		return self::parserFichierIni($fichier_ini);
238
	}
238
	}
239
 
239
 
240
	/**
240
	/**
241
	 * Accesseur pour la valeur d'un paramètre.
241
	 * Accesseur pour la valeur d'un paramètre.
242
	 * @param string $param le nom du paramètre
242
	 * @param string $param le nom du paramètre
243
	 * @return string la valeur du paramètre
243
	 * @return string la valeur du paramètre
244
	 */
244
	 */
245
	public static function get($param = null) {
245
	public static function get($param = null) {
246
		self::verifierCreationInstance();
246
		self::verifierCreationInstance();
247
		return self::getValeur($param, self::$parametres);
247
		return self::getValeur($param, self::$parametres);
248
	}
248
	}
249
 
249
 
250
	/**
250
	/**
251
	 * Vérifie si la valeur d'un paramètre existe.
251
	 * Vérifie si la valeur d'un paramètre existe.
252
	 * @param string $param le nom du paramètre
252
	 * @param string $param le nom du paramètre
253
	 * @return boolean vrai si le paramètre existe, false sinon
253
	 * @return boolean vrai si le paramètre existe, false sinon
254
	 */
254
	 */
255
	public static function existe($param) {
255
	public static function existe($param) {
256
		self::verifierCreationInstance();
256
		self::verifierCreationInstance();
257
		return self::existeValeur($param, self::$parametres);
257
		return self::existeValeur($param, self::$parametres);
258
	}
258
	}
259
	
259
	
260
	/**
260
	/**
261
	 * Vérifie que tous les paramêtres de config nécessaires au fonctionnement d'une classe existe dans les fichiers
261
	 * Vérifie que tous les paramêtres de config nécessaires au fonctionnement d'une classe existe dans les fichiers
262
	 * de configurations.
262
	 * de configurations.
263
	 * L'utilisation de cette méthode depuis la classe Config évite de faire appel à une classe supplémentaire.
263
	 * L'utilisation de cette méthode depuis la classe Config évite de faire appel à une classe supplémentaire.
264
	 * 
264
	 * 
265
	 * @param array $parametres tableau des noms des paramètres de la config à verifier.
265
	 * @param array $parametres tableau des noms des paramètres de la config à verifier.
266
	 * @return boolean true si tous les paramétres sont présents sinon false.
266
	 * @return boolean true si tous les paramétres sont présents sinon false.
267
	 */
267
	 */
268
	public static function verifierPresenceParametres(Array $parametres) {
268
	public static function verifierPresenceParametres(Array $parametres) {
269
		$ok = true;
269
		$ok = true;
270
		foreach ($parametres as $param) {
270
		foreach ($parametres as $param) {
271
			if (is_null(self::get($param))) {
271
			if (is_null(self::get($param))) {
272
				$classe = get_class();
272
				$classe = get_class();
273
				$m = "L'utilisation de la classe $classe nécessite de définir '$param' dans un fichier de configuration.";
273
				$m = "L'utilisation de la classe $classe nécessite de définir '$param' dans un fichier de configuration.";
274
				trigger_error($m, E_USER_ERROR);
274
				trigger_error($m, E_USER_ERROR);
275
				$ok = false;
275
				$ok = false;
276
			}
276
			}
277
		}
277
		}
278
		return $ok;
278
		return $ok;
279
	}
279
	}
280
}
280
}
281
?>
281
?>