Subversion Repositories Applications.framework

Rev

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

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