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