| 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).
|
|
|
5 |
*
|
|
|
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)
|
|
|
9 |
*
|
|
|
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.
|
|
|
15 |
* Une autre solution consiste à utiliser n'importe quelle méthode et à ajouter l'entête "X_HTTP_METHOD_OVERRIDE" avec pour
|
|
|
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.
|
|
|
19 |
*
|
|
|
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".
|
|
|
22 |
*
|
|
|
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)
|
|
|
27 |
*
|
|
|
28 |
* Encodage en entrée : utf8
|
|
|
29 |
* Encodage en sortie : utf8
|
|
|
30 |
*
|
|
|
31 |
* @category Php 5.2
|
|
|
32 |
* @package Framework
|
|
|
33 |
* @author Jean-Pascal MILCENT <jpm@tela-botanica.org>
|
|
|
34 |
* @copyright Copyright (c) 2010, Tela Botanica (accueil@tela-botanica.org)
|
|
|
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>
|
|
|
37 |
* @since 0.3
|
|
|
38 |
* @version $Id: RestServeur.php 344 2011-06-10 07:51:56Z jpm $
|
|
|
39 |
* @link /doc/framework/
|
|
|
40 |
*/
|
|
|
41 |
// TODO : gerer les retours : dans ce controleur : code retour et envoi ...
|
|
|
42 |
class RestServeur {
|
|
|
43 |
|
|
|
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';
|
|
|
46 |
|
|
|
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';
|
|
|
49 |
|
|
|
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';
|
|
|
52 |
|
|
|
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';
|
|
|
55 |
|
|
|
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';
|
|
|
60 |
|
|
|
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';
|
|
|
64 |
|
|
|
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';
|
|
|
68 |
|
|
|
69 |
/** Code HTTP 400 indique que les paramètres envoyés au service contiennent des erreurs.
|
|
|
70 |
* L'utiliser pour indiquer l'échec de l'accès au service. La réponse pourra contenir un message expliquant la source
|
|
|
71 |
* de l'erreur. */
|
|
|
72 |
const HTTP_CODE_MAUVAISE_REQUETE = '400';
|
|
|
73 |
|
|
|
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';
|
|
|
77 |
|
|
|
78 |
/** Code HTTP 404 indiquant que la ressource indiquée par l'url est introuvable. */
|
|
|
79 |
const HTTP_CODE_RESSOURCE_INTROUVABLE = '404';
|
|
|
80 |
|
|
|
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';
|
|
|
85 |
|
|
|
86 |
/** Code d'erreur HTTP 409 indiquant qu'un conflit est survenu vis à vis de la ressource.
|
|
|
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
|
|
|
88 |
* ailleurs. */
|
|
|
89 |
const HTTP_CODE_CONFLIT = '409';
|
|
|
90 |
|
|
|
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';
|
|
|
93 |
|
|
|
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';
|
|
|
97 |
|
|
|
98 |
/** Mettre à true pour activer l'affichage des messages d'erreurs et de débogage.
|
|
|
99 |
* @var boolean */
|
|
|
100 |
private static $debogageActivation = false;
|
|
|
101 |
|
|
|
102 |
/** Indiquer le mode de débogage à utiliser (@see Debug).
|
|
|
103 |
* @var string */
|
|
|
104 |
private static $debogageMode = '';
|
|
|
105 |
|
|
|
106 |
/** La méthode de la requête HTTP utilisée.
|
|
|
107 |
* @var string */
|
|
|
108 |
private $methode = 'GET';
|
|
|
109 |
|
|
|
110 |
/** Le contenu brut du corps de la requête HTTP (s'il y en a).
|
|
|
111 |
* @var array */
|
|
|
112 |
private $requeteDonnees = null;
|
|
|
113 |
|
|
|
114 |
/** Le contenu sous forme de tableau de paires clés-valeurs du corps de la requête HTTP (s'il y en a).
|
|
|
115 |
* @var array */
|
|
|
116 |
private $requeteDonneesParsees = null;
|
|
|
117 |
|
|
|
118 |
/** Version de l'API demandée.
|
|
|
119 |
* Ex. http://www.mondomaine.org/services/[apiVersion]/mon-service/
|
|
|
120 |
* @var mixed Généralement deux nombres séparés par un point. Ex. : 1.0
|
|
|
121 |
*/
|
|
|
122 |
private $apiVersion = null;
|
|
|
123 |
|
|
|
124 |
/** Nom du service demandé.
|
|
|
125 |
* Ex. http://www.mondomaine.org/services/apiVersion/[mon-service]/
|
|
|
126 |
* @var string par défaut vaut null.
|
|
|
127 |
*/
|
|
|
128 |
private $service = null;
|
|
|
129 |
|
|
|
130 |
/** Morceaux de l'url servant à préciser la ressource concerné pour le service demandé.
|
|
|
131 |
* Ex. http://www.mondomaine.org/services/apiVersion/mon-service/[maRessource/maSousResource...]
|
|
|
132 |
* @var array
|
|
|
133 |
*/
|
|
|
134 |
private $ressources = array();
|
|
|
135 |
|
|
|
136 |
/** Partie de l'url situé après le '?' servant à paramétrer le service demandé.
|
|
|
137 |
* Ex. http://www.mondomaine.org/services/apiVersion/mon-service?monParametre1=maValeur1&monParametre2=maValeur2
|
|
|
138 |
* @var array
|
|
|
139 |
*/
|
|
|
140 |
private $parametres = array();
|
|
|
141 |
|
|
|
142 |
/** Tableau contenant les paramètres de configuration du serveur.
|
|
|
143 |
* @var array
|
|
|
144 |
*/
|
|
|
145 |
private static $config = array();
|
|
|
146 |
|
|
|
147 |
/** Codes HTTP. */
|
|
|
148 |
private static $http10 = array(
|
|
|
149 |
self::HTTP_CODE_OK => 'OK',
|
|
|
150 |
self::HTTP_CODE_CREATION_OK => 'Created',
|
|
|
151 |
self::HTTP_CODE_SUPPRESSION_OK => 'No Content',
|
|
|
152 |
self::HTTP_CODE_MAUVAISE_REQUETE => 'Bad Request',
|
|
|
153 |
self::HTTP_CODE_ACCES_NON_AUTORISE => 'Unauthorized',
|
|
|
154 |
self::HTTP_CODE_RESSOURCE_INTROUVABLE => 'Not Found',
|
|
|
155 |
self::HTTP_CODE_METHODE_NON_AUTORISE => 'Method Not Allowed',
|
|
|
156 |
self::HTTP_CODE_CONFLIT => 'Conflict',
|
|
|
157 |
self::HTTP_CODE_CONTENU_REQUIS => 'Length Required',
|
|
|
158 |
self::HTTP_CODE_ERREUR => 'Internal Server Error'
|
|
|
159 |
);
|
|
|
160 |
|
|
|
161 |
/** Tableau des noms des paramètres à définir dans le fichier de config car obligatoirement nécessaire à cette classe.*/
|
|
|
162 |
private $parametres_obligatoires = array('debogage', 'debogage_mode', 'serveur.baseURL', 'chemin_modules');
|
|
|
163 |
|
|
|
164 |
/**
|
|
|
165 |
* Analyse les données envoyées au serveur, enregistre la méthode HTTP utilisée pour appeler le serveur et parse
|
|
|
166 |
* l'url appelée pour trouver le service demandé.
|
|
|
167 |
*/
|
|
|
168 |
public function __construct() {
|
|
|
169 |
Config::verifierPresenceParametres($this->parametres_obligatoires);
|
|
|
170 |
|
|
|
171 |
self::$debogageActivation = Config::get('debogage');
|
|
|
172 |
self::$debogageMode = Config::get('debogage_mode');
|
|
|
173 |
|
|
|
174 |
if (isset($_SERVER['REQUEST_URI']) && isset($_SERVER['REQUEST_METHOD']) && isset($_SERVER['QUERY_STRING'])) {
|
|
|
175 |
$this->initialiserMethode();
|
|
|
176 |
$this->initialiserRequeteDonnees();
|
|
|
177 |
|
|
|
178 |
$urlParts = $this->decouperUrlChemin();
|
|
|
179 |
$this->initialiserApiVersion(array_shift($urlParts));
|
|
|
180 |
$this->initialiserServiceNom(array_shift($urlParts));
|
|
|
181 |
$this->initialiserRessource($urlParts);
|
|
|
182 |
|
|
|
183 |
$this->initialiserParametres();
|
|
|
184 |
// Enregistrement en première position des autoload de la méthode gérant les classes des services
|
|
|
185 |
spl_autoload_register(array(get_class(), 'chargerClasse'));
|
|
|
186 |
} else {
|
|
|
187 |
$e = "La classe Serveur du TBFRamework nécessite, pour fonctionner, l'accès aux variables serveurs REQUEST_URI, REQUEST_METHOD et QUERY_STRING.";
|
|
|
188 |
trigger_error($e, E_USER_ERROR);
|
|
|
189 |
}
|
|
|
190 |
}
|
|
|
191 |
|
|
|
192 |
private function initialiserMethode() {
|
|
|
193 |
if (isset($_SERVER['HTTP_X_HTTP_METHOD_OVERRIDE']) && count(trim($_SERVER['HTTP_X_HTTP_METHOD_OVERRIDE'])) > 0) {
|
|
|
194 |
$this->methode = trim($_SERVER['HTTP_X_HTTP_METHOD_OVERRIDE']);
|
|
|
195 |
} else {
|
|
|
196 |
$this->methode = $_SERVER['REQUEST_METHOD'];
|
|
|
197 |
}
|
|
|
198 |
}
|
|
|
199 |
|
|
|
200 |
private function initialiserRequeteDonnees() {
|
|
|
201 |
if (isset($_SERVER['CONTENT_LENGTH']) && $_SERVER['CONTENT_LENGTH'] > 0) {
|
|
|
202 |
$this->requeteDonnees = '';
|
|
|
203 |
$httpContent = fopen('php://input', 'r');
|
|
|
204 |
while ($data = fread($httpContent, 1024)) {
|
|
|
205 |
$this->requeteDonnees .= $data;
|
|
|
206 |
}
|
|
|
207 |
fclose($httpContent);
|
|
|
208 |
}
|
|
|
209 |
}
|
|
|
210 |
|
|
|
211 |
private function decouperUrlChemin() {
|
|
|
212 |
if (isset($_SERVER['REDIRECT_URL']) && $_SERVER['REDIRECT_URL'] != '') {
|
|
|
213 |
if (isset($_SERVER['REDIRECT_QUERY_STRING'])) {
|
|
|
214 |
$url = $_SERVER['REDIRECT_URL'].'?'.$_SERVER['REDIRECT_QUERY_STRING'];
|
|
|
215 |
} else {
|
|
|
216 |
$url = $_SERVER['REDIRECT_URL'];
|
|
|
217 |
}
|
|
|
218 |
} else {
|
|
|
219 |
$url = $_SERVER['REQUEST_URI'];
|
|
|
220 |
}
|
|
|
221 |
//echo '<pre>'; print_r($_SERVER); echo '</pre>';
|
|
|
222 |
if (strlen($_SERVER['QUERY_STRING']) == 0) {
|
|
|
223 |
$tailleURL = strlen($url);
|
|
|
224 |
} else {
|
|
|
225 |
$tailleURL = -(strlen($_SERVER['QUERY_STRING']) + 1);
|
|
|
226 |
}
|
|
|
227 |
//echo '<br/>url : '.$url;
|
|
|
228 |
$urlChaine = '';
|
|
|
229 |
if (strpos($url, Config::get('serveur.baseURL')) !== false) {
|
|
|
230 |
$urlChaine = substr($url, strlen(Config::get('serveur.baseURL')), $tailleURL);
|
|
|
231 |
} else if (strpos($url, Config::get('serveur.baseAlternativeURL')) !== false) {
|
|
|
232 |
$urlChaine = substr($url, strlen(Config::get('serveur.baseAlternativeURL')), $tailleURL);
|
|
|
233 |
}
|
|
|
234 |
return explode('/', $urlChaine);
|
|
|
235 |
}
|
|
|
236 |
|
|
|
237 |
private function initialiserApiVersion($apiVersion) {
|
|
|
238 |
if (isset($apiVersion) && !empty($apiVersion)) {
|
|
|
239 |
$this->apiVersion = $apiVersion;
|
|
|
240 |
self::$config['chemins']['api'] = Config::get('chemin_modules').$this->apiVersion.DS;
|
|
|
241 |
} else {
|
|
|
242 |
$e = "Aucune version d'API n'a été spécifié dans l'url qui doit avoir la forme suivante http://www.mondomaine.org/services/apiVersion/monService/";
|
|
|
243 |
trigger_error($e, E_USER_ERROR);
|
|
|
244 |
}
|
|
|
245 |
}
|
|
|
246 |
|
|
|
247 |
private function initialiserServiceNom($serviceNom) {
|
|
|
248 |
if (isset($serviceNom) && !empty($serviceNom)) {
|
|
|
249 |
$this->service = $this->traiterNomService($serviceNom);
|
|
|
250 |
} else {
|
|
|
251 |
$e = "Aucun service n'a été spécifié dans l'url qui doit avoir la forme suivante http://www.mondomaine.org/services/apiVersion/monService/";
|
|
|
252 |
trigger_error($e, E_USER_ERROR);
|
|
|
253 |
}
|
|
|
254 |
}
|
|
|
255 |
|
|
|
256 |
private function traiterNomService($serviceNom) {
|
|
|
257 |
return str_replace(' ', '', ucwords(str_replace('-', ' ', strtolower($serviceNom))));
|
|
|
258 |
}
|
|
|
259 |
|
|
|
260 |
private function initialiserRessource($urlParts) {
|
|
|
261 |
if (is_array($urlParts) && count($urlParts) > 0) {
|
|
|
262 |
foreach ($urlParts as $ressource) {
|
|
|
263 |
// Ne pas utiliser empty() car valeur 0 acceptée
|
|
|
264 |
if ($ressource != '') {
|
|
|
265 |
$this->ressources[] = urldecode($ressource);
|
|
|
266 |
}
|
|
|
267 |
}
|
|
|
268 |
}
|
|
|
269 |
}
|
|
|
270 |
|
|
|
271 |
private function initialiserParametres() {
|
|
|
272 |
$this->nettoyerGet();
|
|
|
273 |
$this->parametres = $_GET;
|
|
|
274 |
}
|
|
|
275 |
|
|
|
276 |
private function nettoyerGet() {
|
|
|
277 |
// Pas besoin d'utiliser urldecode car déjà fait par php pour les clés et valeur de $_GET
|
|
|
278 |
if (isset($_GET) && count($_GET) > 0) {
|
|
|
279 |
foreach ($_GET as $cle => $valeur) {
|
|
|
280 |
$verifier = array('NULL', "\n", "\r", "\\", "'", '"', "\x00", "\x1a", ';');
|
|
|
281 |
$_GET[$cle] = strip_tags(str_replace($verifier, '', $valeur));
|
|
|
282 |
}
|
|
|
283 |
}
|
|
|
284 |
}
|
|
|
285 |
|
|
|
286 |
/**
|
|
|
287 |
* La méthode __autoload() charge dynamiquement les classes trouvées dans le code.
|
|
|
288 |
* Cette fonction est appelée par php5 quand il trouve une instanciation de classe dans le code.
|
|
|
289 |
*
|
|
|
290 |
*@param string le nom de la classe appelée.
|
|
|
291 |
*@return void le fichier contenant la classe doit être inclu par la fonction.
|
|
|
292 |
*/
|
|
|
293 |
public static function chargerClasse($classe) {
|
|
|
294 |
if (class_exists($classe)) {
|
|
|
295 |
return null;
|
|
|
296 |
}
|
|
|
297 |
|
|
|
298 |
$chemins = array('', self::$config['chemins']['api']);
|
|
|
299 |
foreach ($chemins as $chemin) {
|
|
|
300 |
$chemin = $chemin.$classe.'.php';
|
|
|
301 |
if (file_exists($chemin)) {
|
|
|
302 |
require_once $chemin;
|
|
|
303 |
}
|
|
|
304 |
}
|
|
|
305 |
}
|
|
|
306 |
|
|
|
307 |
/**
|
|
|
308 |
* Execute la requête.
|
|
|
309 |
*/
|
|
|
310 |
function executer() {
|
|
|
311 |
switch ($this->methode) {
|
|
|
312 |
case 'GET':
|
|
|
313 |
$this->get();
|
|
|
314 |
break;
|
|
|
315 |
case 'POST':
|
|
|
316 |
$this->post();
|
|
|
317 |
break;
|
|
|
318 |
case 'DELETE':
|
|
|
319 |
$this->delete();
|
|
|
320 |
break;
|
|
|
321 |
case 'PUT':
|
|
|
322 |
$this->put();
|
|
|
323 |
break;
|
|
|
324 |
default :
|
|
|
325 |
$e = "La méthode HTTP '{$this->methode}' n'est pas prise en compte par ce serveur REST.";
|
|
|
326 |
trigger_error($e, E_USER_WARNING);
|
|
|
327 |
}
|
|
|
328 |
// Affichage des exceptions et erreurs générées par les services
|
|
|
329 |
$this->gererErreurs();
|
|
|
330 |
}
|
|
|
331 |
|
|
|
332 |
/**
|
|
|
333 |
* Execute a GET request. A GET request fetches a list of resource when no resource name is given, a list of element
|
|
|
334 |
* when a resource name is given, or a resource element when a resource and resource unique identifier are given. It does not change the
|
|
|
335 |
* database contents.
|
|
|
336 |
*/
|
|
|
337 |
private function get() {
|
|
|
338 |
if ($this->service != null) {
|
|
|
339 |
$Service = new $this->service(self::$config);
|
|
|
340 |
if (method_exists($Service, self::METHODE_GET)) {
|
|
|
341 |
$methodeGet = self::METHODE_GET;
|
|
|
342 |
$Service->$methodeGet($this->ressources, $this->parametres);
|
|
|
343 |
} else {
|
|
|
344 |
$e = "Le service '{$this->service}' ne contient pas la méthode '".self::METHODE_GET."' nécessaire ".
|
|
|
345 |
"lors de l'appel du service via la méthode HTTP GET.";
|
|
|
346 |
trigger_error($e, E_USER_ERROR);
|
|
|
347 |
}
|
|
|
348 |
}
|
|
|
349 |
}
|
|
|
350 |
|
|
|
351 |
private function post() {
|
|
|
352 |
$paires = $this->parserDonneesRequete();
|
|
|
353 |
|
|
|
354 |
if (count($paires) != 0) {
|
|
|
355 |
if (isset($paires['action']) && $paires['action'] == 'DELETE') {// Altnative à l'utilisation de DELETE
|
|
|
356 |
$this->delete();
|
|
|
357 |
} else if (count($this->ressources) == 0) {// Altnative à l'utilisation de PUT
|
|
|
358 |
$this->put();
|
|
|
359 |
} else {
|
|
|
360 |
if ($this->service != null) {
|
|
|
361 |
$Service = new $this->service(self::$config);
|
|
|
362 |
if (method_exists($Service, self::METHODE_POST)) {
|
|
|
363 |
$methodePost = self::METHODE_POST;
|
|
|
364 |
if ($Service->$methodePost($this->ressources, $paires)) {
|
|
|
365 |
$this->envoyerEnteteStatutHttp(self::HTTP_CODE_CREATION_OK);
|
|
|
366 |
}
|
|
|
367 |
} else {
|
|
|
368 |
$e = "Le service '{$this->service}' ne contient pas la méthode '".self::METHODE_POST."' nécessaire ".
|
|
|
369 |
"lors de l'appel du service via la méthode HTTP POST.";
|
|
|
370 |
trigger_error($e, E_USER_ERROR);
|
|
|
371 |
}
|
|
|
372 |
}
|
|
|
373 |
}
|
|
|
374 |
} else {
|
|
|
375 |
$this->envoyerEnteteStatutHttp(self::HTTP_CODE_CONTENU_REQUIS);
|
|
|
376 |
}
|
|
|
377 |
}
|
|
|
378 |
|
|
|
379 |
private function put() {
|
|
|
380 |
$paires = $this->parserDonneesRequete();
|
|
|
381 |
|
|
|
382 |
if (count($paires) != 0) {
|
|
|
383 |
if ($this->service != null) {
|
|
|
384 |
$Service = new $this->service(self::$config);
|
|
|
385 |
if (method_exists($Service, self::METHODE_PUT)) {
|
|
|
386 |
$methodePut = self::METHODE_PUT;
|
|
|
387 |
if ($Service->$methodePut($this->ressources, $paires)) {
|
|
|
388 |
$this->envoyerEnteteStatutHttp(self::HTTP_CODE_CREATION_OK);
|
|
|
389 |
}
|
|
|
390 |
} else {
|
|
|
391 |
$e = "Le service '{$this->service}' ne contient pas la méthode '".self::METHODE_PUT."' nécessaire ".
|
|
|
392 |
"lors de l'appel du service via la méthode HTTP PUT (ou équivalant).";
|
|
|
393 |
trigger_error($e, E_USER_ERROR);
|
|
|
394 |
}
|
|
|
395 |
}
|
|
|
396 |
} else {
|
|
|
397 |
$this->envoyerEnteteStatutHttp(self::HTTP_CODE_CONTENU_REQUIS);
|
|
|
398 |
}
|
|
|
399 |
}
|
|
|
400 |
|
|
|
401 |
private function delete() {
|
|
|
402 |
if (count($this->ressources) != 0) {
|
|
|
403 |
if ($this->service != null) {
|
|
|
404 |
$Service = new $this->service(self::$config);
|
|
|
405 |
if (method_exists($Service, self::METHODE_DELETE)) {
|
|
|
406 |
$methodeDelete = self::METHODE_DELETE;
|
|
|
407 |
if ($Service->$methodeDelete($this->ressources, $paires)) {
|
|
|
408 |
$this->envoyerEnteteStatutHttp(self::HTTP_CODE_SUPPRESSION_OK);
|
|
|
409 |
} else {
|
|
|
410 |
$this->envoyerEnteteStatutHttp(self::HTTP_CODE_RESSOURCE_INTROUVABLE);
|
|
|
411 |
}
|
|
|
412 |
} else {
|
|
|
413 |
$e = "Le service '{$this->service}' ne contient pas la méthode '".self::METHODE_DELETE."' nécessaire ".
|
|
|
414 |
"lors de l'appel du service via la méthode HTTP DELETE (ou équivalant).";
|
|
|
415 |
trigger_error($e, E_USER_ERROR);
|
|
|
416 |
}
|
|
|
417 |
}
|
|
|
418 |
} else {
|
|
|
419 |
$this->envoyerEnteteStatutHttp(self::HTTP_CODE_MAUVAISE_REQUETE);
|
|
|
420 |
}
|
|
|
421 |
}
|
|
|
422 |
|
|
|
423 |
/**
|
|
|
424 |
* Parse les données contenu dans le corps de la requête HTTP (= POST) en :
|
|
|
425 |
* - décodant les clés et valeurs.
|
|
|
426 |
* - supprimant les espaces en début et fin des clés et des valeurs.
|
|
|
427 |
*
|
|
|
428 |
* @return array Tableau de paires clé et valeur.
|
|
|
429 |
*/
|
|
|
430 |
private function parserDonneesRequete() {
|
|
|
431 |
$donnees = array();
|
|
|
432 |
if ($this->requeteDonneesParsees != null) {
|
|
|
433 |
$donnees = $this->requeteDonneesParsees;
|
|
|
434 |
} else if ($this->requeteDonnees != null) {
|
|
|
435 |
$paires = explode('&', $this->requeteDonnees);
|
|
|
436 |
foreach ($paires as $paire) {
|
|
|
437 |
list($cle, $valeur) = explode('=', $paire);
|
|
|
438 |
$cle = (isset($cle)) ? trim(urldecode($cle)) : '';
|
|
|
439 |
$valeur = (isset($valeur)) ? trim(urldecode($valeur)) : '';
|
|
|
440 |
$donnees[$cle] = $valeur;
|
|
|
441 |
}
|
|
|
442 |
$this->requeteDonneesParsees = $donnees;
|
|
|
443 |
}
|
|
|
444 |
return $donnees;
|
|
|
445 |
}
|
|
|
446 |
|
|
|
447 |
/**
|
|
|
448 |
* Envoyer un entête HTTP (version 1.0) de statut.
|
|
|
449 |
* Il remplacera systématiquement tout entête HTTP de statut précédement envoyé.
|
|
|
450 |
* @param int $code entier indiquant le code du statut de l'entête HTTP à envoyer.
|
|
|
451 |
*/
|
|
|
452 |
public static function envoyerEnteteStatutHttp($code) {
|
|
|
453 |
if (isset(self::$http10[$code])) {
|
|
|
454 |
$txt = self::$http10[$code];
|
|
|
455 |
header("HTTP/1.0 $code $txt", true);
|
|
|
456 |
}
|
|
|
457 |
}
|
|
|
458 |
|
|
|
459 |
/**
|
|
|
460 |
* Si des exceptions ou des erreurs sont soulevées par le serveur ou les services, elles sont gérées par cette méthode.
|
|
|
461 |
* 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
|
|
|
462 |
* standard (via echo).
|
|
|
463 |
* Si seulement des erreurs de type E_USER_NOTICE, sont présentes, elle sont envoyées en fonction du contenu du paramètre de
|
|
|
464 |
* config "debogage_mode" :
|
|
|
465 |
* - Debug::MODE_ECHO : les messages sont affichés en utilisant echo au moment où ils sont déclenchés dans le code.
|
|
|
466 |
* - Debug::MODE_NOTICE : les message sont stockés par le gestionnaire d'exception sous forme d'erreur de type
|
|
|
467 |
* E_USER_NOTICE et sont renvoyés sur la sortie standard à la fin de l'execution du programme (via echo).
|
|
|
468 |
* - Debug::MODE_ENTETE_HTTP : les message sont stockés par le gestionnaire d'exception sous forme d'erreur de type
|
|
|
469 |
* E_USER_NOTICE et sont renvoyés dans un entête HTTP (X_REST_DEBOGAGE_MESSAGES) à la fin de l'execution du programme.
|
|
|
470 |
* - Autre valeur : les messages sont formatés puis retournés par la fonction de débogage (à vous de les afficher).
|
|
|
471 |
*/
|
|
|
472 |
public static function gererErreurs() {
|
|
|
473 |
if (self::$debogageActivation && GestionnaireException::getExceptionsNbre() > 0) {
|
|
|
474 |
$exceptionsTriees = GestionnaireException::getExceptionsTriees();
|
|
|
475 |
reset($exceptionsTriees);
|
|
|
476 |
$debogageSeulement = true;
|
|
|
477 |
if (! (count($exceptionsTriees) == 1 && key($exceptionsTriees) == E_USER_NOTICE)) {
|
|
|
478 |
self::envoyerEnteteStatutHttp(self::HTTP_CODE_ERREUR);
|
|
|
479 |
$debogageSeulement = false;
|
|
|
480 |
}
|
|
|
481 |
|
|
|
482 |
$exceptionsFormatees = array();
|
|
|
483 |
foreach ($exceptionsTriees as $exceptions) {
|
|
|
484 |
foreach ($exceptions as $e) {
|
|
|
485 |
if ($debogageSeulement && self::$debogageMode == Debug::MODE_ENTETE_HTTP) {
|
|
|
486 |
$exceptionsFormatees[] = GestionnaireException::formaterExceptionTxt($e);
|
|
|
487 |
} else {
|
|
|
488 |
echo GestionnaireException::formaterExceptionXhtml($e);
|
|
|
489 |
}
|
|
|
490 |
}
|
|
|
491 |
}
|
|
|
492 |
|
|
|
493 |
if ($debogageSeulement && self::$debogageMode == Debug::MODE_ENTETE_HTTP) {
|
|
|
494 |
header('X_REST_DEBOGAGE_MESSAGES: '.json_encode($exceptionsFormatees));
|
|
|
495 |
}
|
|
|
496 |
}
|
|
|
497 |
}
|
|
|
498 |
}
|
|
|
499 |
?>
|