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