Subversion Repositories Applications.framework

Rev

Rev 412 | Rev 422 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
346 jpm 1
<?php
2
// declare(encoding='UTF-8');
3
/**
4
 * Classe principale gérant les services web de type (@link(REST, http://fr.wikipedia.org/wiki/Rest).
399 jpm 5
 *
346 jpm 6
 * Elle contient  :
7
 *  - les constantes indiquant les différentes (@link(méthode HTTP, http://fr.wikipedia.org/wiki/Http) prises en compte.
8
 *  - les @link(codes HTTP des réponses, http://fr.wikipedia.org/wiki/Liste_des_codes_HTTP)
399 jpm 9
 *
346 jpm 10
 * Ce serveur REST accepte 4 types de méthodes HTTP : GET, PUT, POST, DELETE.
11
 * GET et POST ne pose généralement pas de problème pour les clients HTTP mais ce n'est pas forcément le cas pour PUT et DELETE.
12
 * Vous pouvez donc pour réaliser :
13
 *  - DELETE : utiliser la méthode POST avec action=DELETE dans le corps de la requête.
14
 *  - PUT : utiliser la méthode POST avec une url ne contenant aucune indication de ressource.
399 jpm 15
 * Une autre solution consiste à utiliser n'importe quelle méthode et à ajouter l'entête "X_HTTP_METHOD_OVERRIDE" avec pour
346 jpm 16
 * valeur le nom de la méthode que vous souhaitez utiliser. Exemple d'entête : "X_HTTP_METHOD_OVERRIDE: PUT".
17
 * Exemple : <code>curl -v -v -H "X_HTTP_METHOD_OVERRIDE: DELETE" "http://www.mondomaine.org/services/apiVersion/[mon-service]/"</code>
18
 * Cela fonctionne avec Apache.
399 jpm 19
 *
346 jpm 20
 * Les classes des services web doivent avoir un nom au format ChatMot "MonService" et être appelée dans l'url par le même nom
21
 * en minuscule où les mots sont séparés par des tirets "mon-service".
399 jpm 22
 *
346 jpm 23
 * Paramètres liés dans config.ini :
24
 *  - serveur.baseURL : morceau de l'url pour appeler le serveur relative au domaine. Exemple : pour http://www.tela-botanica.org/mon_serveur/
25
 *  	mettre : "/mon_serveur/"
26
 *  - serveur.baseAlternativeURL : sur le même principe que ci-dessus permet d'affecter une deuxième url (pour gérer des raccourci via htaccess)
399 jpm 27
 *
346 jpm 28
 * Encodage en entrée : utf8
29
 * Encodage en sortie : utf8
399 jpm 30
 *
346 jpm 31
 * @category	Php 5.2
360 jpm 32
 * @package		Framework
346 jpm 33
 * @author		Jean-Pascal MILCENT <jpm@tela-botanica.org>
34
 * @copyright	Copyright (c) 2010, Tela Botanica (accueil@tela-botanica.org)
360 jpm 35
 * @license		GPL v3 <http://www.gnu.org/licenses/gpl.txt>
36
 * @license		CECILL v2 <http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt>
346 jpm 37
 * @since 		0.3
417 jpm 38
 * @version		$Id: RestServeur.php 413 2012-03-15 13:59:19Z jpm $
346 jpm 39
 * @link		/doc/framework/
40
 */
41
// TODO : gerer les retours : dans ce controleur : code retour et envoi ...
42
class RestServeur {
399 jpm 43
 
346 jpm 44
	/** Nom de la méthode appelée dans un service pour éxécuter une requête de type GET. */
45
	const METHODE_GET = 'consulter';
399 jpm 46
 
346 jpm 47
	/** Nom de la méthode appelée dans un service pour éxécuter une requête de type POST. */
48
	const METHODE_POST = 'modifier';
399 jpm 49
 
346 jpm 50
	/** Nom de la méthode appelée dans un service pour éxécuter une requête de type DELETE. */
51
	const METHODE_DELETE = 'supprimer';
399 jpm 52
 
346 jpm 53
	/** Nom de la méthode appelée dans un service pour éxécuter une requête de type PUT. */
54
	const METHODE_PUT = 'ajouter';
399 jpm 55
 
346 jpm 56
	/** Code HTTP 200 indiquant le succès de l'accès à un service web par la méthode GET.
57
	 * L'utiliser lors d'une requète de type GET (consulter) pour indiquer le succès de l'opération.
58
	 * Sera renvoyée par défaut par PHP. */
59
	const HTTP_CODE_OK = '200';
399 jpm 60
 
346 jpm 61
	/** Code HTTP 201 indiquant que l'accès à un service web est un succès et que la ressource a été créée ou modifié.
62
	 * L'utiliser lors d'une requète de type PUT (ajouter) ou POST (modifier) pour indiquer le succès de l'opération. */
63
	const HTTP_CODE_CREATION_OK = '201';
399 jpm 64
 
346 jpm 65
	/** Code HTTP 204 indique que l'accès à un service web est un succès et qu'il n'y a pas de contenu à renvoyer.
66
	 * L'utiliser lors d'une requète de type DELETE (supprimer) pour indiquer le succès de l'opération. */
67
	const HTTP_CODE_SUPPRESSION_OK = '204';
399 jpm 68
 
346 jpm 69
	/** Code HTTP 400 indique que les paramètres envoyés au service contiennent des erreurs.
399 jpm 70
	 * L'utiliser pour indiquer l'échec de l'accès au service. La réponse pourra contenir un message expliquant la source
346 jpm 71
	 * de l'erreur. */
72
	const HTTP_CODE_MAUVAISE_REQUETE = '400';
399 jpm 73
 
346 jpm 74
	/** Code HTTP 401 indiquant que l'accès à un service web est refusé car l'authentification (obligatoire) a échoué pour
75
	 * accéder à la ressource. */
76
	const HTTP_CODE_ACCES_NON_AUTORISE = '401';
399 jpm 77
 
346 jpm 78
	/** Code HTTP 404 indiquant que la ressource indiquée par l'url est introuvable. */
79
	const HTTP_CODE_RESSOURCE_INTROUVABLE = '404';
399 jpm 80
 
346 jpm 81
	/** Code HTTP 405 indiquant soit :
82
	 *  - que le service web ne possède pas d'accès la ressource correspondant à la méthode HTTP employée.
83
	 *  - que la méthode HTTP enployée n'est pas en accord avec la ressource indiquée par l'url. */
84
	const HTTP_CODE_METHODE_NON_AUTORISE = '405';
399 jpm 85
 
346 jpm 86
	/** Code d'erreur HTTP 409 indiquant qu'un conflit est survenu vis à vis de la ressource.
399 jpm 87
	 * Par exemple, essayer de créer deux fois la même ressource ou bien tenter de modifier une ressource qui a été modifiée par
346 jpm 88
	 * ailleurs. */
89
	const HTTP_CODE_CONFLIT = '409';
399 jpm 90
 
346 jpm 91
	/** Code HTTP 411 indiquant que des paramètres passés dans le contenu de la requête sont nécessaires au service. */
92
	const HTTP_CODE_CONTENU_REQUIS = '411';
399 jpm 93
 
346 jpm 94
	/** Code d'erreur HTTP 500 Internal Server Error.
95
	 * L'utiliser quand le serveur ou un service soulève une erreur ou une exception. */
96
	const HTTP_CODE_ERREUR = '500';
399 jpm 97
 
360 jpm 98
	/** Motif de l'epression régulière vérfiant la version de l'API. */
99
	const MOTIF_API_VERSION = '/^[0-9]+(?:[.][0-9]+)*$/';
399 jpm 100
 
360 jpm 101
	/** Motif de l'epression régulière vérfiant le nom du service. */
102
	const MOTIF_SERVICE_NOM = '/^[a-z0-9]+(?:[-][a-z0-9]+)*$/';
399 jpm 103
 
104
	/** Mettre à true pour activer l'affichage des messages d'erreurs et de débogage.
346 jpm 105
	 * @var boolean */
106
	private static $debogageActivation = false;
399 jpm 107
 
108
	/** Indiquer le mode de débogage à utiliser (@see Debug).
346 jpm 109
	 * @var string */
110
	private static $debogageMode = '';
399 jpm 111
 
112
	/** La méthode de la requête HTTP utilisée.
346 jpm 113
	 * @var string */
114
	private $methode = 'GET';
115
 
116
	/** Le contenu brut du corps de la requête HTTP (s'il y en a).
117
	 * @var array */
118
	private $requeteDonnees = null;
399 jpm 119
 
120
	/** Le contenu sous forme de tableau de paires clés-valeurs du corps de la requête HTTP (s'il y en a).
346 jpm 121
	 * @var array */
122
	private $requeteDonneesParsees = null;
123
 
124
	/** Version de l'API demandée.
125
	 * Ex. http://www.mondomaine.org/services/[apiVersion]/mon-service/
126
	 * @var mixed Généralement deux nombres séparés par un point. Ex. : 1.0
127
	 */
128
	private $apiVersion = null;
129
 
399 jpm 130
	/** Nom du service demandé.
346 jpm 131
	 * Ex. http://www.mondomaine.org/services/apiVersion/[mon-service]/
132
	 * @var string par défaut vaut null.
133
	 */
134
	private $service = null;
399 jpm 135
 
346 jpm 136
	/** Morceaux de l'url servant à préciser la ressource concerné pour le service demandé.
137
	 * Ex. http://www.mondomaine.org/services/apiVersion/mon-service/[maRessource/maSousResource...]
138
	 * @var array
139
	 */
140
	private $ressources = array();
399 jpm 141
 
346 jpm 142
	/** Partie de l'url situé après le '?' servant à paramétrer le service demandé.
417 jpm 143
	 * Les données proviennent de $_GET où les caractères suivant ont été transformé en '_' undescrore dans les clés :
144
	 * - chr(32) ( ) (space)
145
	 * - chr(46) (.) (dot)
146
	 * - chr(91) ([) (open square bracket)
147
	 * - chr(128) - chr(159) (various)
148
	 * En outre nous appliquons la méthode nettoyerGet() qui effectue d'autres remplacement dans les valeurs.
346 jpm 149
	 * Ex. http://www.mondomaine.org/services/apiVersion/mon-service?monParametre1=maValeur1&monParametre2=maValeur2
417 jpm 150
	 * @see parametresBruts
346 jpm 151
	 * @var array
152
	 */
153
	private $parametres = array();
399 jpm 154
 
417 jpm 155
	/** Partie de l'url situé après le '?' servant à paramétrer le service demandé.
156
	 * Les données proviennent de $_SERVER['QUERY_STRING'] et n'ont subies aucune transformation au niveau des clés.
157
	 * Cependant nous appliquons la méthode nettoyerGet() qui effectue d'autres remplacement dans les valeurs.
158
	 * Ex. http://www.mondomaine.org/services/apiVersion/mon-service?monParametre1=maValeur1&monParametre2=maValeur2
159
	 * @see parametres
160
	 * @var array
161
	 */
162
	private $parametresBruts = array();
163
 
346 jpm 164
	/** Tableau contenant les paramètres de configuration du serveur.
165
	 * @var array
166
	 */
167
	private static $config = array();
360 jpm 168
 
169
	/** Tableau contenant les messages d'erreur et/ou d'avertissement du Serveur.
170
	 * @var array
171
	 * */
172
	private static $messages = array();
399 jpm 173
 
346 jpm 174
	/** Codes HTTP. */
175
	private static $http10 = array(
399 jpm 176
		self::HTTP_CODE_OK => 'OK',
346 jpm 177
		self::HTTP_CODE_CREATION_OK => 'Created',
178
		self::HTTP_CODE_SUPPRESSION_OK => 'No Content',
179
		self::HTTP_CODE_MAUVAISE_REQUETE => 'Bad Request',
180
		self::HTTP_CODE_ACCES_NON_AUTORISE => 'Unauthorized',
181
		self::HTTP_CODE_RESSOURCE_INTROUVABLE => 'Not Found',
182
		self::HTTP_CODE_METHODE_NON_AUTORISE => 'Method Not Allowed',
183
		self::HTTP_CODE_CONFLIT => 'Conflict',
184
		self::HTTP_CODE_CONTENU_REQUIS => 'Length Required',
185
		self::HTTP_CODE_ERREUR => 'Internal Server Error'
186
	);
399 jpm 187
 
346 jpm 188
	/** Tableau des noms des paramètres à définir dans le fichier de config car obligatoirement nécessaire à cette classe.*/
189
	private $parametres_obligatoires = array('debogage', 'debogage_mode', 'serveur.baseURL', 'chemin_modules');
190
 
191
	/**
192
	 * Analyse les données envoyées au serveur, enregistre la méthode HTTP utilisée pour appeler le serveur et parse
193
	 * l'url appelée pour trouver le service demandé.
194
	 */
195
	public function __construct() {
196
		Config::verifierPresenceParametres($this->parametres_obligatoires);
399 jpm 197
 
346 jpm 198
		self::$debogageActivation = Config::get('debogage');
199
		self::$debogageMode = Config::get('debogage_mode');
200
 
201
		if (isset($_SERVER['REQUEST_URI']) && isset($_SERVER['REQUEST_METHOD']) && isset($_SERVER['QUERY_STRING'])) {
202
			$this->initialiserMethode();
203
			$this->initialiserRequeteDonnees();
399 jpm 204
 
346 jpm 205
			$urlParts = $this->decouperUrlChemin();
399 jpm 206
 
346 jpm 207
			$this->initialiserApiVersion(array_shift($urlParts));
208
			$this->initialiserServiceNom(array_shift($urlParts));
209
			$this->initialiserRessource($urlParts);
399 jpm 210
 
346 jpm 211
			$this->initialiserParametres();
399 jpm 212
			// Enregistrement en première position des autoload de la méthode gérant les classes des services
346 jpm 213
			spl_autoload_register(array(get_class(), 'chargerClasse'));
214
		} else {
360 jpm 215
			self::envoyerEnteteStatutHttp(self::HTTP_CODE_ERREUR);
346 jpm 216
			$e = "La classe Serveur du TBFRamework nécessite, pour fonctionner, l'accès aux variables serveurs REQUEST_URI, REQUEST_METHOD et QUERY_STRING.";
360 jpm 217
			self::ajouterMessage($e);
346 jpm 218
		}
219
	}
399 jpm 220
 
346 jpm 221
	private function initialiserMethode() {
222
		if (isset($_SERVER['HTTP_X_HTTP_METHOD_OVERRIDE']) && count(trim($_SERVER['HTTP_X_HTTP_METHOD_OVERRIDE'])) > 0) {
223
			$this->methode = trim($_SERVER['HTTP_X_HTTP_METHOD_OVERRIDE']);
224
		} else {
225
			$this->methode = $_SERVER['REQUEST_METHOD'];
226
		}
227
	}
399 jpm 228
 
346 jpm 229
	private function initialiserRequeteDonnees() {
230
		if (isset($_SERVER['CONTENT_LENGTH']) && $_SERVER['CONTENT_LENGTH'] > 0) {
231
			$this->requeteDonnees = '';
232
			$httpContent = fopen('php://input', 'r');
233
			while ($data = fread($httpContent, 1024)) {
234
				$this->requeteDonnees .= $data;
235
			}
236
			fclose($httpContent);
237
		}
238
	}
399 jpm 239
 
346 jpm 240
	private function decouperUrlChemin() {
241
		if (isset($_SERVER['REDIRECT_URL']) && $_SERVER['REDIRECT_URL'] != '') {
360 jpm 242
			if (isset($_SERVER['REDIRECT_QUERY_STRING']) && !empty($_SERVER['REDIRECT_QUERY_STRING'])) {
346 jpm 243
				$url = $_SERVER['REDIRECT_URL'].'?'.$_SERVER['REDIRECT_QUERY_STRING'];
244
			} else {
245
				$url = $_SERVER['REDIRECT_URL'];
246
			}
247
		} else {
248
			$url = $_SERVER['REQUEST_URI'];
249
		}
399 jpm 250
 
346 jpm 251
		if (strlen($_SERVER['QUERY_STRING']) == 0) {
252
			$tailleURL = strlen($url);
253
		} else {
254
			$tailleURL = -(strlen($_SERVER['QUERY_STRING']) + 1);
255
		}
399 jpm 256
 
346 jpm 257
		$urlChaine = '';
258
		if (strpos($url, Config::get('serveur.baseURL')) !== false) {
259
			$urlChaine = substr($url, strlen(Config::get('serveur.baseURL')), $tailleURL);
260
		} else if (strpos($url, Config::get('serveur.baseAlternativeURL')) !== false) {
261
			$urlChaine = substr($url, strlen(Config::get('serveur.baseAlternativeURL')), $tailleURL);
262
		}
263
		return explode('/', $urlChaine);
264
	}
399 jpm 265
 
346 jpm 266
	private function initialiserApiVersion($apiVersion) {
360 jpm 267
		if ($this->verifierApiVersion($apiVersion)) {
346 jpm 268
			$this->apiVersion = $apiVersion;
269
			self::$config['chemins']['api'] = Config::get('chemin_modules').$this->apiVersion.DS;
270
		} else {
360 jpm 271
			self::envoyerEnteteStatutHttp(self::HTTP_CODE_MAUVAISE_REQUETE);
272
			$e = "Aucune version d'API n'a été spécifiée.\n".
273
				"La version doit respecter l'expression régulière suivante : ".self::MOTIF_API_VERSION.".\n".
274
			  	"L'url doit avoir la forme suivante : http://www.mondomaine.org/services/apiVersion/monService/";
275
			self::ajouterMessage($e);
276
			self::cloreAccesServeur();
346 jpm 277
		}
278
	}
399 jpm 279
 
360 jpm 280
	private function verifierApiVersion($apiVersion) {
281
		$apiOk = false;
282
		if (isset($apiVersion) && !empty($apiVersion) && preg_match(self::MOTIF_API_VERSION, $apiVersion)) {
283
			$apiOk = true;
284
		}
285
		return $apiOk;
286
	}
399 jpm 287
 
346 jpm 288
	private function initialiserServiceNom($serviceNom) {
360 jpm 289
		if ($this->verifierServiceNom($serviceNom)) {
346 jpm 290
			$this->service = $this->traiterNomService($serviceNom);
291
		} else {
360 jpm 292
			self::envoyerEnteteStatutHttp(self::HTTP_CODE_MAUVAISE_REQUETE);
293
			$e = "Aucune nom de service n'a été spécifié.\n".
294
				"La nom du service doit respecter l'expression régulière suivante : ".self::MOTIF_SERVICE_NOM.".\n".
295
			  	"L'url doit avoir la forme suivante : http://www.mondomaine.org/services/apiVersion/monService/";
296
			self::ajouterMessage($e);
297
			self::cloreAccesServeur();
346 jpm 298
		}
299
	}
399 jpm 300
 
360 jpm 301
	private function verifierServiceNom($serviceNom) {
302
		$serviceNomOk = false;
303
		if (isset($serviceNom) && !empty($serviceNom) && preg_match(self::MOTIF_SERVICE_NOM, $serviceNom)) {
304
			$serviceNomOk = true;
305
		}
306
		return $serviceNomOk;
307
	}
399 jpm 308
 
346 jpm 309
	private function traiterNomService($serviceNom) {
310
		return str_replace(' ', '', ucwords(str_replace('-', ' ', strtolower($serviceNom))));
311
	}
399 jpm 312
 
346 jpm 313
	private function initialiserRessource($urlParts) {
314
		if (is_array($urlParts) && count($urlParts) > 0) {
315
			foreach ($urlParts as $ressource) {
316
				// Ne pas utiliser empty() car valeur 0 acceptée
317
				if ($ressource != '') {
318
					$this->ressources[] = urldecode($ressource);
319
				}
320
			}
321
		}
322
	}
399 jpm 323
 
346 jpm 324
	private function initialiserParametres() {
417 jpm 325
		$this->parametres = $this->recupererParametresGet();
326
		$this->parametresBruts = $this->recupererParametresBruts();
346 jpm 327
	}
399 jpm 328
 
417 jpm 329
	private function recupererParametresGet() {
330
		$_GET = $this->nettoyerParametres($_GET);
331
		return $_GET;
332
	}
333
 
334
	private function nettoyerParametres(Array $parametres) {
399 jpm 335
		// Pas besoin d'utiliser urldecode car déjà fait par php pour les clés et valeur de $_GET
417 jpm 336
		if (isset($parametres) && count($parametres) > 0) {
337
			foreach ($parametres as $cle => $valeur) {
338
				// les quotes, guillements et points-virgules ont été retirés des caractères à vérifier car
339
				//ça n'a plus lieu d'être maintenant que l'on utilise protéger à peu près partout
340
				$verifier = array('NULL', "\\", "\x00", "\x1a");
341
				$parametres[$cle] = strip_tags(str_replace($verifier, '', $valeur));
346 jpm 342
			}
343
		}
417 jpm 344
		return $parametres;
346 jpm 345
	}
399 jpm 346
 
417 jpm 347
	private function recupererParametresBruts() {
348
		$parametres_bruts = array();
349
		if (!empty($_SERVER['QUERY_STRING'])) {
350
			$paires = explode('&', $_SERVER['QUERY_STRING']);
351
			foreach ($paires as $paire) {
352
				$nv = explode('=', $paire);
353
				$nom = urldecode($nv[0]);
354
				$valeur = urldecode($nv[1]);
355
				$parametres_bruts[$nom] = $valeur;
356
			}
357
			$parametres_bruts = $this->nettoyerParametres($parametres_bruts);
358
		}
359
		return $parametres_bruts;
360
	}
361
 
346 jpm 362
	/**
363
	* La méthode __autoload() charge dynamiquement les classes trouvées dans le code.
364
	* Cette fonction est appelée par php5 quand il trouve une instanciation de classe dans le code.
365
	*
366
	*@param string le nom de la classe appelée.
367
	*@return void le fichier contenant la classe doit être inclu par la fonction.
368
	*/
369
	public static function chargerClasse($classe) {
370
		if (class_exists($classe)) {
371
			return null;
372
		}
373
		$chemins = array('', self::$config['chemins']['api']);
374
		foreach ($chemins as $chemin) {
375
			$chemin = $chemin.$classe.'.php';
376
			if (file_exists($chemin)) {
377
				require_once $chemin;
378
			}
379
		}
380
	}
399 jpm 381
 
346 jpm 382
	/**
383
	 * Execute la requête.
384
	 */
360 jpm 385
	public function executer() {
374 jpm 386
		$retour = '';
346 jpm 387
		switch ($this->methode) {
388
			case 'GET':
372 aurelien 389
				$retour = $this->get();
346 jpm 390
				break;
391
			case 'POST':
412 jpm 392
				$retour = $this->post();// Retour pour l'alternative PUT
346 jpm 393
				break;
394
			case 'DELETE':
395
				$this->delete();
396
				break;
397
			case 'PUT':
372 aurelien 398
				$retour = $this->put();
346 jpm 399
				break;
400
			default :
360 jpm 401
				self::envoyerEnteteStatutHttp(self::HTTP_CODE_METHODE_NON_AUTORISE);
402
				header('Allow: GET, POST, DELETE, PUT');
403
				$e = "La méthode HTTP '{$this->methode}' n'est pas prise en compte par ce serveur REST.\n".
404
					"Consulter l'entête Allow pour connaître les méthodes autorisées.";
405
				self::ajouterMessage($e);
346 jpm 406
		}
372 aurelien 407
		$this->cloreAccesServeur($retour);
346 jpm 408
	}
409
 
410
	/**
411
	 * Execute a GET request. A GET request fetches a list of resource when no resource name is given, a list of element
412
	 * when a resource name is given, or a resource element when a resource and resource unique identifier are given. It does not change the
413
	 * database contents.
414
	 */
415
	private function get() {
365 jpm 416
		$retour = '';
346 jpm 417
		if ($this->service != null) {
418
			$Service = new $this->service(self::$config);
419
			if (method_exists($Service, self::METHODE_GET)) {
420
				$methodeGet = self::METHODE_GET;
417 jpm 421
				$parametres = $Service->utiliserParametresBruts() ? $this->parametresBruts : $this->parametres;
422
				$retour = $Service->$methodeGet($this->ressources, $parametres);
346 jpm 423
			} else {
360 jpm 424
				self::envoyerEnteteStatutHttp(self::HTTP_CODE_RESSOURCE_INTROUVABLE);
346 jpm 425
				$e = "Le service '{$this->service}' ne contient pas la méthode '".self::METHODE_GET."' nécessaire ".
426
					"lors de l'appel du service via la méthode HTTP GET.";
360 jpm 427
				self::ajouterMessage($e);
346 jpm 428
			}
429
		}
365 jpm 430
		return $retour;
346 jpm 431
	}
432
 
433
	private function post() {
412 jpm 434
		$retour = '';
346 jpm 435
		$paires = $this->parserDonneesRequete();
436
		if (count($paires) != 0) {
417 jpm 437
			if (isset($paires['action']) && $paires['action'] == 'DELETE') {// Alternative à l'utilisation de DELETE
346 jpm 438
				$this->delete();
417 jpm 439
			} else if (count($this->ressources) == 0) {// Alternative à l'utilisation de PUT
412 jpm 440
				$retour = $this->put();
346 jpm 441
			} else {
442
				if ($this->service != null) {
443
					$Service = new $this->service(self::$config);
444
					if (method_exists($Service, self::METHODE_POST)) {
445
						$methodePost = self::METHODE_POST;
360 jpm 446
						$info = $Service->$methodePost($this->ressources, $paires);
447
						if ($info === true) {
346 jpm 448
							$this->envoyerEnteteStatutHttp(self::HTTP_CODE_CREATION_OK);
449
						}
450
					} else {
360 jpm 451
						self::envoyerEnteteStatutHttp(self::HTTP_CODE_RESSOURCE_INTROUVABLE);
346 jpm 452
						$e = "Le service '{$this->service}' ne contient pas la méthode '".self::METHODE_POST."' nécessaire ".
360 jpm 453
							"lors de l'appel du service via la méthode HTTP GET.";
454
						self::ajouterMessage($e);
346 jpm 455
					}
456
				}
399 jpm 457
			}
346 jpm 458
		} else {
459
			$this->envoyerEnteteStatutHttp(self::HTTP_CODE_CONTENU_REQUIS);
360 jpm 460
			$e = "Le service '{$this->service}' requiert de fournir le contenu à modifier dans le corps ".
461
				"de la requête avec la méthode HTTP POST.";
462
			self::ajouterMessage($e);
346 jpm 463
		}
412 jpm 464
		return $retour;
346 jpm 465
	}
466
 
467
	private function put() {
365 jpm 468
		$retour = '';
346 jpm 469
		$paires = $this->parserDonneesRequete();
470
		if (count($paires) != 0) {
471
			if ($this->service != null) {
472
				$Service = new $this->service(self::$config);
473
				if (method_exists($Service, self::METHODE_PUT)) {
474
					$methodePut = self::METHODE_PUT;
417 jpm 475
					$retour = $Service->$methodePut($this->ressources, $paires);
476
					if ($retour !== false) {
477
						$this->envoyerEnteteStatutHttp(self::HTTP_CODE_CREATION_OK);
346 jpm 478
					}
479
				} else {
360 jpm 480
					self::envoyerEnteteStatutHttp(self::HTTP_CODE_RESSOURCE_INTROUVABLE);
346 jpm 481
					$e = "Le service '{$this->service}' ne contient pas la méthode '".self::METHODE_PUT."' nécessaire ".
360 jpm 482
						"lors de l'appel du service via la méthode HTTP GET.";
483
					self::ajouterMessage($e);
346 jpm 484
				}
485
			}
486
		} else {
487
			$this->envoyerEnteteStatutHttp(self::HTTP_CODE_CONTENU_REQUIS);
360 jpm 488
			$e = "Il est nécessaire de fournir du contenu dans le corps de la requête pour créer une nouvelle ressource.";
489
			self::ajouterMessage($e);
346 jpm 490
		}
365 jpm 491
		return $retour;
346 jpm 492
	}
493
 
494
	private function delete() {
495
		if (count($this->ressources) != 0) {
496
			if ($this->service != null) {
497
				$Service = new $this->service(self::$config);
498
				if (method_exists($Service, self::METHODE_DELETE)) {
499
					$methodeDelete = self::METHODE_DELETE;
360 jpm 500
					$info = $Service->$methodeDelete($this->ressources);
501
					if ($info === true) {
346 jpm 502
						$this->envoyerEnteteStatutHttp(self::HTTP_CODE_SUPPRESSION_OK);
360 jpm 503
					} else if ($info === false) {
346 jpm 504
						$this->envoyerEnteteStatutHttp(self::HTTP_CODE_RESSOURCE_INTROUVABLE);
360 jpm 505
						$e = "La ressource à supprimer est introuvable. Il se peut qu'elle ait été préalablement supprimé.";
506
						self::ajouterMessage($e);
346 jpm 507
					}
508
				} else {
360 jpm 509
					self::envoyerEnteteStatutHttp(self::HTTP_CODE_RESSOURCE_INTROUVABLE);
346 jpm 510
					$e = "Le service '{$this->service}' ne contient pas la méthode '".self::METHODE_DELETE."' nécessaire ".
360 jpm 511
						"lors de l'appel du service via la méthode HTTP GET.";
512
					self::ajouterMessage($e);
346 jpm 513
				}
514
			}
515
		} else {
516
			$this->envoyerEnteteStatutHttp(self::HTTP_CODE_MAUVAISE_REQUETE);
360 jpm 517
			$e = "Il est nécessaire d'indiquer dans l'url la ressource à supprimer.";
518
			self::ajouterMessage($e);
346 jpm 519
		}
520
	}
399 jpm 521
 
346 jpm 522
	/**
523
	 * Parse les données contenu dans le corps de la requête HTTP (= POST) en :
524
	 *  - décodant les clés et valeurs.
525
	 *  - supprimant les espaces en début et fin des clés et des valeurs.
399 jpm 526
	 *
346 jpm 527
	 * @return array Tableau de paires clé et valeur.
528
	 */
529
	private function parserDonneesRequete() {
530
		$donnees = array();
531
		if ($this->requeteDonneesParsees != null) {
532
			$donnees = $this->requeteDonneesParsees;
533
		} else if ($this->requeteDonnees != null) {
534
			$paires = explode('&', $this->requeteDonnees);
535
			foreach ($paires as $paire) {
536
				list($cle, $valeur) = explode('=', $paire);
537
				$cle = (isset($cle)) ? trim(urldecode($cle)) : '';
538
				$valeur = (isset($valeur)) ? trim(urldecode($valeur)) : '';
539
				$donnees[$cle] = $valeur;
540
			}
541
			$this->requeteDonneesParsees = $donnees;
542
		}
543
		return $donnees;
544
	}
399 jpm 545
 
346 jpm 546
	/**
547
	 * Envoyer un entête HTTP (version 1.0) de statut.
548
	 * Il remplacera systématiquement tout entête HTTP de statut précédement envoyé.
399 jpm 549
	 * @param int $code entier indiquant le code du statut de l'entête HTTP à envoyer.
346 jpm 550
	 */
551
	public static function envoyerEnteteStatutHttp($code) {
552
		if (isset(self::$http10[$code])) {
553
			$txt = self::$http10[$code];
554
			header("HTTP/1.0 $code $txt", true);
555
		}
556
	}
399 jpm 557
 
346 jpm 558
	/**
360 jpm 559
	 * Termine l'accès au serveur après envoir envoyer les messages.
560
	 */
373 aurelien 561
	private static function cloreAccesServeur($retour = '') {
360 jpm 562
		// 	Gestion des exceptions et erreurs générées par les services
365 jpm 563
		$retour .= self::gererErreurs();
399 jpm 564
 
360 jpm 565
		// Envoie des messages d'erreur et d'avertissement du serveur
365 jpm 566
		$retour .= self::envoyerMessages();
399 jpm 567
 
365 jpm 568
		// Envoie sur la sortie standard le contenu de la réponse HTTP
569
		print $retour;
399 jpm 570
 
360 jpm 571
		// Nous terminons le script
572
		exit(0);
573
	}
399 jpm 574
 
360 jpm 575
	/**
346 jpm 576
	 * Si des exceptions ou des erreurs sont soulevées par le serveur ou les services, elles sont gérées par cette méthode.
399 jpm 577
	 * Si nous avec des erreurs d'un type différent d'E_USER_NOTICE (réservé au débogage), elle sont renvoyées sur la sortie
346 jpm 578
	 * standard (via echo).
399 jpm 579
	 * Si seulement des erreurs de type E_USER_NOTICE, sont présentes, elle sont envoyées en fonction du contenu du paramètre de
346 jpm 580
	 * config "debogage_mode" :
399 jpm 581
	 *  - Debug::MODE_ECHO : les messages sont affichés en utilisant echo au moment où ils sont déclenchés dans le code.
582
	 *  - Debug::MODE_NOTICE : les message sont stockés par le gestionnaire d'exception sous forme d'erreur de type
346 jpm 583
	 *  E_USER_NOTICE et sont renvoyés sur la sortie standard à la fin de l'execution du programme (via echo).
399 jpm 584
	 *  - Debug::MODE_ENTETE_HTTP : les message sont stockés par le gestionnaire d'exception sous forme d'erreur de type
346 jpm 585
	 *  E_USER_NOTICE et sont renvoyés dans un entête HTTP (X_REST_DEBOGAGE_MESSAGES) à la fin de l'execution du programme.
586
	 *  - Autre valeur : les messages sont formatés puis retournés par la fonction de débogage (à vous de les afficher).
587
	 */
588
	public static function gererErreurs() {
365 jpm 589
		$retour = '';
346 jpm 590
		if (self::$debogageActivation && GestionnaireException::getExceptionsNbre() > 0) {
399 jpm 591
 
346 jpm 592
			$exceptionsTriees = GestionnaireException::getExceptionsTriees();
593
			reset($exceptionsTriees);
594
			$debogageSeulement = true;
357 jpm 595
			if (array_key_exists(E_USER_ERROR, $exceptionsTriees)) {
346 jpm 596
				self::envoyerEnteteStatutHttp(self::HTTP_CODE_ERREUR);
597
				$debogageSeulement = false;
598
			}
399 jpm 599
 
346 jpm 600
			$exceptionsFormatees = array();
601
			foreach ($exceptionsTriees as $exceptions) {
602
				foreach ($exceptions as $e) {
603
					if ($debogageSeulement && self::$debogageMode == Debug::MODE_ENTETE_HTTP) {
365 jpm 604
						$exceptionsFormatees[] = GestionnaireException::formaterExceptionDebug($e);
346 jpm 605
					} else {
365 jpm 606
						$retour = GestionnaireException::formaterExceptionXhtml($e);
346 jpm 607
					}
608
				}
609
			}
399 jpm 610
 
346 jpm 611
			if ($debogageSeulement && self::$debogageMode == Debug::MODE_ENTETE_HTTP) {
612
				header('X_REST_DEBOGAGE_MESSAGES: '.json_encode($exceptionsFormatees));
613
			}
614
		}
365 jpm 615
		return $retour;
346 jpm 616
	}
399 jpm 617
 
618
 
360 jpm 619
	/**
620
	 * Permet d'ajouter un message d'erreur ou d'avertissement qui sera envoyé au client.
621
	 * Le message doit être au format texte et en UTF-8.
399 jpm 622
	 * @param string $message le message à envoyer.
360 jpm 623
	 */
624
	public static function ajouterMessage($message) {
625
		if (isset($message) && !empty($message)) {
626
			self::$messages[] = $message;
627
		}
628
	}
399 jpm 629
 
360 jpm 630
	/**
631
	 * Envoie au client les éventuels messages d'erreur et d'avertissement du Serveur.
632
	 * Le format d'envoie est text/plain encodé en UTF-8.
633
	 */
634
	private static function envoyerMessages() {
635
		if (count(self::$messages) > 0) {
636
			header("Content-Type: text/plain; charset=utf-8");
365 jpm 637
			return implode("\n", self::$messages);
360 jpm 638
		}
639
	}
346 jpm 640
}
641
?>