Subversion Repositories Applications.framework

Rev

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

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