Subversion Repositories Applications.framework

Rev

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

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