Subversion Repositories Applications.framework

Rev

Rev 399 | Rev 417 | 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
360 jpm 38
 * @version		$Id: RestServeur.php 359 2011-08-30 13:53:45Z delphine $
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é.
143
	 * Ex. http://www.mondomaine.org/services/apiVersion/mon-service?monParametre1=maValeur1&monParametre2=maValeur2
144
	 * @var array
145
	 */
146
	private $parametres = array();
399 jpm 147
 
346 jpm 148
	/** Tableau contenant les paramètres de configuration du serveur.
149
	 * @var array
150
	 */
151
	private static $config = array();
360 jpm 152
 
153
	/** Tableau contenant les messages d'erreur et/ou d'avertissement du Serveur.
154
	 * @var array
155
	 * */
156
	private static $messages = array();
399 jpm 157
 
346 jpm 158
	/** Codes HTTP. */
159
	private static $http10 = array(
399 jpm 160
		self::HTTP_CODE_OK => 'OK',
346 jpm 161
		self::HTTP_CODE_CREATION_OK => 'Created',
162
		self::HTTP_CODE_SUPPRESSION_OK => 'No Content',
163
		self::HTTP_CODE_MAUVAISE_REQUETE => 'Bad Request',
164
		self::HTTP_CODE_ACCES_NON_AUTORISE => 'Unauthorized',
165
		self::HTTP_CODE_RESSOURCE_INTROUVABLE => 'Not Found',
166
		self::HTTP_CODE_METHODE_NON_AUTORISE => 'Method Not Allowed',
167
		self::HTTP_CODE_CONFLIT => 'Conflict',
168
		self::HTTP_CODE_CONTENU_REQUIS => 'Length Required',
169
		self::HTTP_CODE_ERREUR => 'Internal Server Error'
170
	);
399 jpm 171
 
346 jpm 172
	/** Tableau des noms des paramètres à définir dans le fichier de config car obligatoirement nécessaire à cette classe.*/
173
	private $parametres_obligatoires = array('debogage', 'debogage_mode', 'serveur.baseURL', 'chemin_modules');
174
 
175
	/**
176
	 * Analyse les données envoyées au serveur, enregistre la méthode HTTP utilisée pour appeler le serveur et parse
177
	 * l'url appelée pour trouver le service demandé.
178
	 */
179
	public function __construct() {
180
		Config::verifierPresenceParametres($this->parametres_obligatoires);
399 jpm 181
 
346 jpm 182
		self::$debogageActivation = Config::get('debogage');
183
		self::$debogageMode = Config::get('debogage_mode');
184
 
185
		if (isset($_SERVER['REQUEST_URI']) && isset($_SERVER['REQUEST_METHOD']) && isset($_SERVER['QUERY_STRING'])) {
186
			$this->initialiserMethode();
187
			$this->initialiserRequeteDonnees();
399 jpm 188
 
346 jpm 189
			$urlParts = $this->decouperUrlChemin();
399 jpm 190
 
346 jpm 191
			$this->initialiserApiVersion(array_shift($urlParts));
192
			$this->initialiserServiceNom(array_shift($urlParts));
193
			$this->initialiserRessource($urlParts);
399 jpm 194
 
346 jpm 195
			$this->initialiserParametres();
399 jpm 196
			// Enregistrement en première position des autoload de la méthode gérant les classes des services
346 jpm 197
			spl_autoload_register(array(get_class(), 'chargerClasse'));
198
		} else {
360 jpm 199
			self::envoyerEnteteStatutHttp(self::HTTP_CODE_ERREUR);
346 jpm 200
			$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 201
			self::ajouterMessage($e);
346 jpm 202
		}
203
	}
399 jpm 204
 
346 jpm 205
	private function initialiserMethode() {
206
		if (isset($_SERVER['HTTP_X_HTTP_METHOD_OVERRIDE']) && count(trim($_SERVER['HTTP_X_HTTP_METHOD_OVERRIDE'])) > 0) {
207
			$this->methode = trim($_SERVER['HTTP_X_HTTP_METHOD_OVERRIDE']);
208
		} else {
209
			$this->methode = $_SERVER['REQUEST_METHOD'];
210
		}
211
	}
399 jpm 212
 
346 jpm 213
	private function initialiserRequeteDonnees() {
214
		if (isset($_SERVER['CONTENT_LENGTH']) && $_SERVER['CONTENT_LENGTH'] > 0) {
215
			$this->requeteDonnees = '';
216
			$httpContent = fopen('php://input', 'r');
217
			while ($data = fread($httpContent, 1024)) {
218
				$this->requeteDonnees .= $data;
219
			}
220
			fclose($httpContent);
221
		}
222
	}
399 jpm 223
 
346 jpm 224
	private function decouperUrlChemin() {
225
		if (isset($_SERVER['REDIRECT_URL']) && $_SERVER['REDIRECT_URL'] != '') {
360 jpm 226
			if (isset($_SERVER['REDIRECT_QUERY_STRING']) && !empty($_SERVER['REDIRECT_QUERY_STRING'])) {
346 jpm 227
				$url = $_SERVER['REDIRECT_URL'].'?'.$_SERVER['REDIRECT_QUERY_STRING'];
228
			} else {
229
				$url = $_SERVER['REDIRECT_URL'];
230
			}
231
		} else {
232
			$url = $_SERVER['REQUEST_URI'];
233
		}
399 jpm 234
 
346 jpm 235
		if (strlen($_SERVER['QUERY_STRING']) == 0) {
236
			$tailleURL = strlen($url);
237
		} else {
238
			$tailleURL = -(strlen($_SERVER['QUERY_STRING']) + 1);
239
		}
399 jpm 240
 
346 jpm 241
		$urlChaine = '';
242
		if (strpos($url, Config::get('serveur.baseURL')) !== false) {
243
			$urlChaine = substr($url, strlen(Config::get('serveur.baseURL')), $tailleURL);
244
		} else if (strpos($url, Config::get('serveur.baseAlternativeURL')) !== false) {
245
			$urlChaine = substr($url, strlen(Config::get('serveur.baseAlternativeURL')), $tailleURL);
246
		}
247
		return explode('/', $urlChaine);
248
	}
399 jpm 249
 
346 jpm 250
	private function initialiserApiVersion($apiVersion) {
360 jpm 251
		if ($this->verifierApiVersion($apiVersion)) {
346 jpm 252
			$this->apiVersion = $apiVersion;
253
			self::$config['chemins']['api'] = Config::get('chemin_modules').$this->apiVersion.DS;
254
		} else {
360 jpm 255
			self::envoyerEnteteStatutHttp(self::HTTP_CODE_MAUVAISE_REQUETE);
256
			$e = "Aucune version d'API n'a été spécifiée.\n".
257
				"La version doit respecter l'expression régulière suivante : ".self::MOTIF_API_VERSION.".\n".
258
			  	"L'url doit avoir la forme suivante : http://www.mondomaine.org/services/apiVersion/monService/";
259
			self::ajouterMessage($e);
260
			self::cloreAccesServeur();
346 jpm 261
		}
262
	}
399 jpm 263
 
360 jpm 264
	private function verifierApiVersion($apiVersion) {
265
		$apiOk = false;
266
		if (isset($apiVersion) && !empty($apiVersion) && preg_match(self::MOTIF_API_VERSION, $apiVersion)) {
267
			$apiOk = true;
268
		}
269
		return $apiOk;
270
	}
399 jpm 271
 
346 jpm 272
	private function initialiserServiceNom($serviceNom) {
360 jpm 273
		if ($this->verifierServiceNom($serviceNom)) {
346 jpm 274
			$this->service = $this->traiterNomService($serviceNom);
275
		} else {
360 jpm 276
			self::envoyerEnteteStatutHttp(self::HTTP_CODE_MAUVAISE_REQUETE);
277
			$e = "Aucune nom de service n'a été spécifié.\n".
278
				"La nom du service doit respecter l'expression régulière suivante : ".self::MOTIF_SERVICE_NOM.".\n".
279
			  	"L'url doit avoir la forme suivante : http://www.mondomaine.org/services/apiVersion/monService/";
280
			self::ajouterMessage($e);
281
			self::cloreAccesServeur();
346 jpm 282
		}
283
	}
399 jpm 284
 
360 jpm 285
	private function verifierServiceNom($serviceNom) {
286
		$serviceNomOk = false;
287
		if (isset($serviceNom) && !empty($serviceNom) && preg_match(self::MOTIF_SERVICE_NOM, $serviceNom)) {
288
			$serviceNomOk = true;
289
		}
290
		return $serviceNomOk;
291
	}
399 jpm 292
 
346 jpm 293
	private function traiterNomService($serviceNom) {
294
		return str_replace(' ', '', ucwords(str_replace('-', ' ', strtolower($serviceNom))));
295
	}
399 jpm 296
 
346 jpm 297
	private function initialiserRessource($urlParts) {
298
		if (is_array($urlParts) && count($urlParts) > 0) {
299
			foreach ($urlParts as $ressource) {
300
				// Ne pas utiliser empty() car valeur 0 acceptée
301
				if ($ressource != '') {
302
					$this->ressources[] = urldecode($ressource);
303
				}
304
			}
305
		}
306
	}
399 jpm 307
 
346 jpm 308
	private function initialiserParametres() {
309
		$this->nettoyerGet();
310
		$this->parametres = $_GET;
311
	}
399 jpm 312
 
346 jpm 313
	private function nettoyerGet() {
399 jpm 314
		// Pas besoin d'utiliser urldecode car déjà fait par php pour les clés et valeur de $_GET
346 jpm 315
		if (isset($_GET) && count($_GET) > 0) {
316
			foreach ($_GET as $cle => $valeur) {
317
				$verifier = array('NULL', "\n", "\r", "\\", "'", '"', "\x00", "\x1a", ';');
318
				$_GET[$cle] = strip_tags(str_replace($verifier, '', $valeur));
319
			}
320
		}
321
	}
399 jpm 322
 
346 jpm 323
	/**
324
	* La méthode __autoload() charge dynamiquement les classes trouvées dans le code.
325
	* Cette fonction est appelée par php5 quand il trouve une instanciation de classe dans le code.
326
	*
327
	*@param string le nom de la classe appelée.
328
	*@return void le fichier contenant la classe doit être inclu par la fonction.
329
	*/
330
	public static function chargerClasse($classe) {
331
		if (class_exists($classe)) {
332
			return null;
333
		}
334
		$chemins = array('', self::$config['chemins']['api']);
335
		foreach ($chemins as $chemin) {
336
			$chemin = $chemin.$classe.'.php';
337
			if (file_exists($chemin)) {
338
				require_once $chemin;
339
			}
340
		}
341
	}
399 jpm 342
 
346 jpm 343
	/**
344
	 * Execute la requête.
345
	 */
360 jpm 346
	public function executer() {
374 jpm 347
		$retour = '';
346 jpm 348
		switch ($this->methode) {
349
			case 'GET':
372 aurelien 350
				$retour = $this->get();
346 jpm 351
				break;
352
			case 'POST':
412 jpm 353
				$retour = $this->post();// Retour pour l'alternative PUT
346 jpm 354
				break;
355
			case 'DELETE':
356
				$this->delete();
357
				break;
358
			case 'PUT':
372 aurelien 359
				$retour = $this->put();
346 jpm 360
				break;
361
			default :
360 jpm 362
				self::envoyerEnteteStatutHttp(self::HTTP_CODE_METHODE_NON_AUTORISE);
363
				header('Allow: GET, POST, DELETE, PUT');
364
				$e = "La méthode HTTP '{$this->methode}' n'est pas prise en compte par ce serveur REST.\n".
365
					"Consulter l'entête Allow pour connaître les méthodes autorisées.";
366
				self::ajouterMessage($e);
346 jpm 367
		}
372 aurelien 368
		$this->cloreAccesServeur($retour);
346 jpm 369
	}
370
 
371
	/**
372
	 * Execute a GET request. A GET request fetches a list of resource when no resource name is given, a list of element
373
	 * when a resource name is given, or a resource element when a resource and resource unique identifier are given. It does not change the
374
	 * database contents.
375
	 */
376
	private function get() {
365 jpm 377
		$retour = '';
346 jpm 378
		if ($this->service != null) {
379
			$Service = new $this->service(self::$config);
380
			if (method_exists($Service, self::METHODE_GET)) {
381
				$methodeGet = self::METHODE_GET;
365 jpm 382
				$retour = $Service->$methodeGet($this->ressources, $this->parametres);
346 jpm 383
			} else {
360 jpm 384
				self::envoyerEnteteStatutHttp(self::HTTP_CODE_RESSOURCE_INTROUVABLE);
346 jpm 385
				$e = "Le service '{$this->service}' ne contient pas la méthode '".self::METHODE_GET."' nécessaire ".
386
					"lors de l'appel du service via la méthode HTTP GET.";
360 jpm 387
				self::ajouterMessage($e);
346 jpm 388
			}
389
		}
365 jpm 390
		return $retour;
346 jpm 391
	}
392
 
393
	private function post() {
412 jpm 394
		$retour = '';
346 jpm 395
		$paires = $this->parserDonneesRequete();
396
		if (count($paires) != 0) {
397
			if (isset($paires['action']) && $paires['action'] == 'DELETE') {// Altnative à l'utilisation de DELETE
398
				$this->delete();
399
			} else if (count($this->ressources) == 0) {// Altnative à l'utilisation de PUT
412 jpm 400
				$retour = $this->put();
346 jpm 401
			} else {
402
				if ($this->service != null) {
403
					$Service = new $this->service(self::$config);
404
					if (method_exists($Service, self::METHODE_POST)) {
405
						$methodePost = self::METHODE_POST;
360 jpm 406
						$info = $Service->$methodePost($this->ressources, $paires);
407
						if ($info === true) {
346 jpm 408
							$this->envoyerEnteteStatutHttp(self::HTTP_CODE_CREATION_OK);
409
						}
410
					} else {
360 jpm 411
						self::envoyerEnteteStatutHttp(self::HTTP_CODE_RESSOURCE_INTROUVABLE);
346 jpm 412
						$e = "Le service '{$this->service}' ne contient pas la méthode '".self::METHODE_POST."' nécessaire ".
360 jpm 413
							"lors de l'appel du service via la méthode HTTP GET.";
414
						self::ajouterMessage($e);
346 jpm 415
					}
416
				}
399 jpm 417
			}
346 jpm 418
		} else {
419
			$this->envoyerEnteteStatutHttp(self::HTTP_CODE_CONTENU_REQUIS);
360 jpm 420
			$e = "Le service '{$this->service}' requiert de fournir le contenu à modifier dans le corps ".
421
				"de la requête avec la méthode HTTP POST.";
422
			self::ajouterMessage($e);
346 jpm 423
		}
412 jpm 424
		return $retour;
346 jpm 425
	}
426
 
427
	private function put() {
365 jpm 428
		$retour = '';
346 jpm 429
		$paires = $this->parserDonneesRequete();
430
		if (count($paires) != 0) {
431
			if ($this->service != null) {
432
				$Service = new $this->service(self::$config);
433
				if (method_exists($Service, self::METHODE_PUT)) {
434
					$methodePut = self::METHODE_PUT;
365 jpm 435
					$retour = $Service->$methodePut($this->ressources, $paires);
436
					if ($retour !== false) {
346 jpm 437
						$this->envoyerEnteteStatutHttp(self::HTTP_CODE_CREATION_OK);
438
					}
439
				} else {
360 jpm 440
					self::envoyerEnteteStatutHttp(self::HTTP_CODE_RESSOURCE_INTROUVABLE);
346 jpm 441
					$e = "Le service '{$this->service}' ne contient pas la méthode '".self::METHODE_PUT."' nécessaire ".
360 jpm 442
						"lors de l'appel du service via la méthode HTTP GET.";
443
					self::ajouterMessage($e);
346 jpm 444
				}
445
			}
446
		} else {
447
			$this->envoyerEnteteStatutHttp(self::HTTP_CODE_CONTENU_REQUIS);
360 jpm 448
			$e = "Il est nécessaire de fournir du contenu dans le corps de la requête pour créer une nouvelle ressource.";
449
			self::ajouterMessage($e);
346 jpm 450
		}
365 jpm 451
		return $retour;
346 jpm 452
	}
453
 
454
	private function delete() {
455
		if (count($this->ressources) != 0) {
456
			if ($this->service != null) {
457
				$Service = new $this->service(self::$config);
458
				if (method_exists($Service, self::METHODE_DELETE)) {
459
					$methodeDelete = self::METHODE_DELETE;
360 jpm 460
					$info = $Service->$methodeDelete($this->ressources);
461
					if ($info === true) {
346 jpm 462
						$this->envoyerEnteteStatutHttp(self::HTTP_CODE_SUPPRESSION_OK);
360 jpm 463
					} else if ($info === false) {
346 jpm 464
						$this->envoyerEnteteStatutHttp(self::HTTP_CODE_RESSOURCE_INTROUVABLE);
360 jpm 465
						$e = "La ressource à supprimer est introuvable. Il se peut qu'elle ait été préalablement supprimé.";
466
						self::ajouterMessage($e);
346 jpm 467
					}
468
				} else {
360 jpm 469
					self::envoyerEnteteStatutHttp(self::HTTP_CODE_RESSOURCE_INTROUVABLE);
346 jpm 470
					$e = "Le service '{$this->service}' ne contient pas la méthode '".self::METHODE_DELETE."' nécessaire ".
360 jpm 471
						"lors de l'appel du service via la méthode HTTP GET.";
472
					self::ajouterMessage($e);
346 jpm 473
				}
474
			}
475
		} else {
476
			$this->envoyerEnteteStatutHttp(self::HTTP_CODE_MAUVAISE_REQUETE);
360 jpm 477
			$e = "Il est nécessaire d'indiquer dans l'url la ressource à supprimer.";
478
			self::ajouterMessage($e);
346 jpm 479
		}
480
	}
399 jpm 481
 
346 jpm 482
	/**
483
	 * Parse les données contenu dans le corps de la requête HTTP (= POST) en :
484
	 *  - décodant les clés et valeurs.
485
	 *  - supprimant les espaces en début et fin des clés et des valeurs.
399 jpm 486
	 *
346 jpm 487
	 * @return array Tableau de paires clé et valeur.
488
	 */
489
	private function parserDonneesRequete() {
490
		$donnees = array();
491
		if ($this->requeteDonneesParsees != null) {
492
			$donnees = $this->requeteDonneesParsees;
493
		} else if ($this->requeteDonnees != null) {
494
			$paires = explode('&', $this->requeteDonnees);
495
			foreach ($paires as $paire) {
496
				list($cle, $valeur) = explode('=', $paire);
497
				$cle = (isset($cle)) ? trim(urldecode($cle)) : '';
498
				$valeur = (isset($valeur)) ? trim(urldecode($valeur)) : '';
499
				$donnees[$cle] = $valeur;
500
			}
501
			$this->requeteDonneesParsees = $donnees;
502
		}
503
		return $donnees;
504
	}
399 jpm 505
 
346 jpm 506
	/**
507
	 * Envoyer un entête HTTP (version 1.0) de statut.
508
	 * Il remplacera systématiquement tout entête HTTP de statut précédement envoyé.
399 jpm 509
	 * @param int $code entier indiquant le code du statut de l'entête HTTP à envoyer.
346 jpm 510
	 */
511
	public static function envoyerEnteteStatutHttp($code) {
512
		if (isset(self::$http10[$code])) {
513
			$txt = self::$http10[$code];
514
			header("HTTP/1.0 $code $txt", true);
515
		}
516
	}
399 jpm 517
 
346 jpm 518
	/**
360 jpm 519
	 * Termine l'accès au serveur après envoir envoyer les messages.
520
	 */
373 aurelien 521
	private static function cloreAccesServeur($retour = '') {
360 jpm 522
		// 	Gestion des exceptions et erreurs générées par les services
365 jpm 523
		$retour .= self::gererErreurs();
399 jpm 524
 
360 jpm 525
		// Envoie des messages d'erreur et d'avertissement du serveur
365 jpm 526
		$retour .= self::envoyerMessages();
399 jpm 527
 
365 jpm 528
		// Envoie sur la sortie standard le contenu de la réponse HTTP
529
		print $retour;
399 jpm 530
 
360 jpm 531
		// Nous terminons le script
532
		exit(0);
533
	}
399 jpm 534
 
360 jpm 535
	/**
346 jpm 536
	 * 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 537
	 * 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 538
	 * standard (via echo).
399 jpm 539
	 * 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 540
	 * config "debogage_mode" :
399 jpm 541
	 *  - Debug::MODE_ECHO : les messages sont affichés en utilisant echo au moment où ils sont déclenchés dans le code.
542
	 *  - Debug::MODE_NOTICE : les message sont stockés par le gestionnaire d'exception sous forme d'erreur de type
346 jpm 543
	 *  E_USER_NOTICE et sont renvoyés sur la sortie standard à la fin de l'execution du programme (via echo).
399 jpm 544
	 *  - Debug::MODE_ENTETE_HTTP : les message sont stockés par le gestionnaire d'exception sous forme d'erreur de type
346 jpm 545
	 *  E_USER_NOTICE et sont renvoyés dans un entête HTTP (X_REST_DEBOGAGE_MESSAGES) à la fin de l'execution du programme.
546
	 *  - Autre valeur : les messages sont formatés puis retournés par la fonction de débogage (à vous de les afficher).
547
	 */
548
	public static function gererErreurs() {
365 jpm 549
		$retour = '';
346 jpm 550
		if (self::$debogageActivation && GestionnaireException::getExceptionsNbre() > 0) {
399 jpm 551
 
346 jpm 552
			$exceptionsTriees = GestionnaireException::getExceptionsTriees();
553
			reset($exceptionsTriees);
554
			$debogageSeulement = true;
357 jpm 555
			if (array_key_exists(E_USER_ERROR, $exceptionsTriees)) {
346 jpm 556
				self::envoyerEnteteStatutHttp(self::HTTP_CODE_ERREUR);
557
				$debogageSeulement = false;
558
			}
399 jpm 559
 
346 jpm 560
			$exceptionsFormatees = array();
561
			foreach ($exceptionsTriees as $exceptions) {
562
				foreach ($exceptions as $e) {
563
					if ($debogageSeulement && self::$debogageMode == Debug::MODE_ENTETE_HTTP) {
365 jpm 564
						$exceptionsFormatees[] = GestionnaireException::formaterExceptionDebug($e);
346 jpm 565
					} else {
365 jpm 566
						$retour = GestionnaireException::formaterExceptionXhtml($e);
346 jpm 567
					}
568
				}
569
			}
399 jpm 570
 
346 jpm 571
			if ($debogageSeulement && self::$debogageMode == Debug::MODE_ENTETE_HTTP) {
572
				header('X_REST_DEBOGAGE_MESSAGES: '.json_encode($exceptionsFormatees));
573
			}
574
		}
365 jpm 575
		return $retour;
346 jpm 576
	}
399 jpm 577
 
578
 
360 jpm 579
	/**
580
	 * Permet d'ajouter un message d'erreur ou d'avertissement qui sera envoyé au client.
581
	 * Le message doit être au format texte et en UTF-8.
399 jpm 582
	 * @param string $message le message à envoyer.
360 jpm 583
	 */
584
	public static function ajouterMessage($message) {
585
		if (isset($message) && !empty($message)) {
586
			self::$messages[] = $message;
587
		}
588
	}
399 jpm 589
 
360 jpm 590
	/**
591
	 * Envoie au client les éventuels messages d'erreur et d'avertissement du Serveur.
592
	 * Le format d'envoie est text/plain encodé en UTF-8.
593
	 */
594
	private static function envoyerMessages() {
595
		if (count(self::$messages) > 0) {
596
			header("Content-Type: text/plain; charset=utf-8");
365 jpm 597
			return implode("\n", self::$messages);
360 jpm 598
		}
599
	}
346 jpm 600
}
601
?>