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