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