WebSVN – Applications.framework – Diff – /trunk/framework/RestServeur.php


<?php
// declare(encoding='UTF-8');
/**
 * Classe principale gérant les services web de type (@link(REST, http://fr.wikipedia.org/wiki/Rest).
 *
 * Elle contient  :
 *  - les constantes indiquant les différentes (@link(méthode HTTP, http://fr.wikipedia.org/wiki/Http) prises en compte.
 *  - les @link(codes HTTP des réponses, http://fr.wikipedia.org/wiki/Liste_des_codes_HTTP)
 *
 * Ce serveur REST accepte 4 types de méthodes HTTP : GET, PUT, POST, DELETE.
 * 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.
 * Vous pouvez donc pour réaliser :
 *  - DELETE : utiliser la méthode POST avec action=DELETE dans le corps de la requête.
 *  - PUT : utiliser la méthode POST avec une url ne contenant aucune indication de ressource.
 * Une autre solution consiste à utiliser n'importe quelle méthode et à ajouter l'entête "X_HTTP_METHOD_OVERRIDE" avec pour
 * valeur le nom de la méthode que vous souhaitez utiliser. Exemple d'entête : "X_HTTP_METHOD_OVERRIDE: PUT".
 * Exemple : <code>curl -v -v -H "X_HTTP_METHOD_OVERRIDE: DELETE" "http://www.mondomaine.org/services/apiVersion/[mon-service]/"</code>
 * Cela fonctionne avec Apache.
 *
 * 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
 * en minuscule où les mots sont séparés par des tirets "mon-service".
 *
 * Paramètres liés dans config.ini :
 *  - serveur.baseURL : morceau de l'url pour appeler le serveur relative au domaine. Exemple : pour http://www.tela-botanica.org/mon_serveur/
 *  	mettre : "/mon_serveur/"
 *  - serveur.baseAlternativeURL : sur le même principe que ci-dessus permet d'affecter une deuxième url (pour gérer des raccourci via htaccess)
 *
 * Encodage en entrée : utf8
 * Encodage en sortie : utf8
 *
 * @category	Php 5.2
 * @package		Framework
 * @author		Jean-Pascal MILCENT <jpm@tela-botanica.org>
 * @copyright	Copyright (c) 2010, Tela Botanica (accueil@tela-botanica.org)
 * @license		GPL v3 <http://www.gnu.org/licenses/gpl.txt>
 * @license		CECILL v2 <http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt>
 * @since 		0.3
 
 
 */
// TODO : gerer les retours : dans ce controleur : code retour et envoi ...
class RestServeur {
 
	/** Nom de la méthode appelée dans un service pour éxécuter une requête de type GET. */
	const METHODE_GET = 'consulter';
 
	/** Nom de la méthode appelée dans un service pour éxécuter une requête de type POST. */
	const METHODE_POST = 'modifier';
 
	/** Nom de la méthode appelée dans un service pour éxécuter une requête de type DELETE. */
	const METHODE_DELETE = 'supprimer';
 
	/** Nom de la méthode appelée dans un service pour éxécuter une requête de type PUT. */
	const METHODE_PUT = 'ajouter';
 
	/** Code HTTP 200 : OK
	 * Indiquant le succès de l'accès à un service web par la méthode GET.
	 * L'utiliser lors d'une requète de type GET (consulter) pour indiquer le succès de l'opération.
	 * Sera renvoyée par défaut par PHP.
	 * @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1
	 */
	const HTTP_CODE_OK = '200';
 
	/** Code HTTP 201 : Created
	 * Indiquant que l'accès à un service web est un succès et que la ressource a été créée ou modifié.
	 * L'utiliser lors d'une requète de type PUT (ajouter) ou POST (modifier) pour indiquer le succès de l'opération.
	 * @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.2
	 */
	const HTTP_CODE_CREATION_OK = '201';
 
	/** Code HTTP 202 : Accepted
	 * Indiquant que la requête a été acceptée mais que son traitement n'est pas encore terminé.
	 * L'utiliser lors d'une requète de type PUT (ajouter) ou POST (modifier) pour indiquer que les données
	 * seront traitées ultérieurement.
	 * @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.3
	 */
	const HTTP_CODE_ACCEPTE_OK = '202';
 
	/** Code HTTP 204 : No Content
	 * Indique que l'accès à un service web est un succès et qu'il n'y a pas de contenu à renvoyer.
	 * L'utiliser lors d'une requète de type DELETE (supprimer) pour indiquer le succès de l'opération si aucun
	 * contenu (status) ne doit être renvoyé, sinon utiliser 200 OK.
	 * @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.5
	 */
	const HTTP_CODE_SUPPRESSION_OK = '204';
 
	/** Code HTTP 400 : Bad Request
	 * Indique que les paramètres envoyés au service contiennent des erreurs.
	 * L'utiliser pour indiquer l'échec de l'accès au service. La réponse pourra contenir un message expliquant la source
	 * de l'erreur.
	 * @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
	 */
	const HTTP_CODE_MAUVAISE_REQUETE = '400';
 
	/** Code HTTP 401 : Unauthorized
	 * Indiquant que l'accès à un service web est refusé car l'authentification (obligatoire) a échoué pour
	 * accéder à la ressource.
	 * @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2
	 */
	const HTTP_CODE_ACCES_NON_AUTORISE = '401';
 
	/** Code HTTP 403 : Forbidden
	 * Indiquant que le service a compris la requête mais refuse de la réaliser.
	 * @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4
	 */
	const HTTP_CODE_ACCES_INTERDIT = '403';
 
	/** Code HTTP 404 : Not Found
	 * Indiquant que la ressource indiquée par l'url est introuvable.
	 * @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5
	 */
	const HTTP_CODE_RESSOURCE_INTROUVABLE = '404';
 
	/** Code HTTP 405 : Method Not Allowed
	 * Indique soit :
	 *  - que le service web ne possède pas d'accès la ressource correspondant à la méthode HTTP employée.
	 *  - que la méthode HTTP enployée n'est pas en accord avec la ressource indiquée par l'url.
	 * @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6
	 */
	const HTTP_CODE_METHODE_NON_AUTORISE = '405';
 
	/** Code HTTP 409 : Conflict
	 * Indique qu'un conflit est survenu vis à vis de la ressource.
	 * 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
	 * ailleurs.
	 * @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.10
	 */
	const HTTP_CODE_CONFLIT = '409';
 
	/** Code HTTP 411 : Length Required
	 * Indique que des paramètres passés dans le contenu de la requête sont nécessaires au service.
	 * @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.12
	 */
	const HTTP_CODE_CONTENU_REQUIS = '411';
 
	/** Code HTTP 412 : Precondition Failed
	 * Indique que des entêtes envoyés au serveur sont erronnés.
	 * À utiliser quand un service web reçoit de mauvais entêtes, paramètres et/ou ressources.
	 * @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.13
	 */
	const HTTP_CODE_ECHEC_CONDITION = '411';
 
	/** Code HTTP 415 : Unsupported Media Type
	 * Indique que le type de média envoyé au serveur n'est pas accepté par la ressource.
	 * À utiliser quand un service web reçoit un mauvais type de contenu.
	 * @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16
	 */
	const HTTP_CODE_CONTENU_NON_SUPPORTE = '415';
 
	/** Code HTTP 500 : Internal Server Error.
	 * L'utiliser quand le serveur ou un service soulève une erreur ou une exception.
	 * @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1
	 */
	const HTTP_CODE_ERREUR = '500';
 
	/** Code HTTP 501 : Not Implemented
	 * Indique que le web service ne supporte pas la fonctionnalité demandée.
	 * @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2
	 */
	const HTTP_NON_IMPLEMENTE= '501';
 
	/** Code HTTP 503 : Service Unavailable
	 * L'utiliser quand le web service est momentanément indisponible.
	 * @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4
	 */
	const HTTP_CODE_SERVICE_INDISPONIBLE = '503';
 
	/** Motif de l'epression régulière vérfiant la version de l'API. */
	const MOTIF_API_VERSION = '/^[0-9]+(?:[.][0-9]+)*$/';
 
	/** Motif de l'epression régulière vérfiant le nom du service. */
	const MOTIF_SERVICE_NOM = '/^[a-z0-9]+(?:[-][a-z0-9]+)*$/';
 
	/** Mettre à true pour activer l'affichage des messages d'erreurs et de débogage.
	 * @var boolean */
	private static $debogageActivation = false;
 
	/** Indiquer le mode de débogage à utiliser (@see Debug).
	 * @var string */
	private static $debogageMode = '';
 
	/** La méthode de la requête HTTP utilisée.
	 * @var string */
	private $methode = 'GET';
 
	/** Le contenu brut du corps de la requête HTTP (s'il y en a).
	 * @var array */
	private $requeteDonnees = null;
 
	/** Le contenu sous forme de tableau de paires clés-valeurs du corps de la requête HTTP (s'il y en a).
	 * @var array */
	private $requeteDonneesParsees = null;
 
	/** Version de l'API demandée.
	 * Ex. http://www.mondomaine.org/services/[apiVersion]/mon-service/
	 * @var mixed Généralement deux nombres séparés par un point. Ex. : 1.0
	 */
	private $apiVersion = null;
 
	/** Nom du service demandé.
	 * Ex. http://www.mondomaine.org/services/apiVersion/[mon-service]/
	 * @var string par défaut vaut null.
	 */
	private $service = null;
 
	/** Morceaux de l'url servant à préciser la ressource concerné pour le service demandé.
	 * Ex. http://www.mondomaine.org/services/apiVersion/mon-service/[maRessource/maSousResource...]
	 * @var array
	 */
	private $ressources = array();
 
	/** Partie de l'url situé après le '?' servant à paramétrer le service demandé.
	 * Les données proviennent de $_GET où les caractères suivant ont été transformé en '_' undescrore dans les clés :
	 * - chr(32) ( ) (space)
	 * - chr(46) (.) (dot)
	 * - chr(91) ([) (open square bracket)
	 * - chr(128) - chr(159) (various)
	 * En outre nous appliquons la méthode nettoyerGet() qui effectue d'autres remplacement dans les valeurs.
	 * Ex. http://www.mondomaine.org/services/apiVersion/mon-service?monParametre1=maValeur1&monParametre2=maValeur2
	 * @see parametresBruts
	 * @var array
	 */
	private $parametres = array();
 
	/** Partie de l'url situé après le '?' servant à paramétrer le service demandé.
	 * Les données proviennent de $_SERVER['QUERY_STRING'] et n'ont subies aucune transformation au niveau des clés.
	 * Cependant nous appliquons la méthode nettoyerGet() qui effectue d'autres remplacement dans les valeurs.
	 * Ex. http://www.mondomaine.org/services/apiVersion/mon-service?monParametre1=maValeur1&monParametre2=maValeur2
	 * @see parametres
	 * @var array
	 */
	private $parametresBruts = array();
 
	/** Tableau contenant les paramètres de configuration du serveur.
	 * @var array
	 */
	private static $config = array();
 
	/** Tableau contenant les messages d'erreur et/ou d'avertissement du Serveur.
	 * @var array
	 * */
	private static $messages = array();
 
	/** Codes HTTP. */
	private static $http10 = array(
		self::HTTP_CODE_OK => 'OK',
		self::HTTP_CODE_CREATION_OK => 'Created',
		self::HTTP_CODE_SUPPRESSION_OK => 'No Content',
		self::HTTP_CODE_MAUVAISE_REQUETE => 'Bad Request',
		self::HTTP_CODE_ACCES_NON_AUTORISE => 'Unauthorized',
		self::HTTP_CODE_RESSOURCE_INTROUVABLE => 'Not Found',
		self::HTTP_CODE_METHODE_NON_AUTORISE => 'Method Not Allowed',
		self::HTTP_CODE_CONFLIT => 'Conflict',
		self::HTTP_CODE_CONTENU_REQUIS => 'Length Required',
		self::HTTP_CODE_ERREUR => 'Internal Server Error'
	);
 
	/** Tableau des noms des paramètres à définir dans le fichier de config car obligatoirement nécessaire à cette classe.*/
	private $parametres_obligatoires = array('debogage', 'debogage_mode', 'serveur.baseURL', 'chemin_modules');
 
	/**
	 * Analyse les données envoyées au serveur, enregistre la méthode HTTP utilisée pour appeler le serveur et parse
	 * l'url appelée pour trouver le service demandé.
	 */
	public function __construct() {
		Config::verifierPresenceParametres($this->parametres_obligatoires);
 
		self::$debogageActivation = Config::get('debogage');
		self::$debogageMode = Config::get('debogage_mode');
 
		if (isset($_SERVER['REQUEST_URI']) && isset($_SERVER['REQUEST_METHOD']) && isset($_SERVER['QUERY_STRING'])) {
			$this->initialiserMethode();
			$this->initialiserRequeteDonnees();
 
			$urlParts = $this->decouperUrlChemin();
 
			$this->initialiserApiVersion(array_shift($urlParts));
			$this->initialiserServiceNom(array_shift($urlParts));
			$this->initialiserRessource($urlParts);
 
			$this->initialiserParametres();
			// Enregistrement en première position des autoload de la méthode gérant les classes des services
			spl_autoload_register(array(get_class(), 'chargerClasse'));
		} else {
			self::envoyerEnteteStatutHttp(self::HTTP_CODE_ERREUR);
			$e = "La classe Serveur du TBFRamework nécessite, pour fonctionner, l'accès aux variables serveurs REQUEST_URI, REQUEST_METHOD et QUERY_STRING.";
			self::ajouterMessage($e);
		}
	}
 
	private function initialiserMethode() {
		if (isset($_SERVER['HTTP_X_HTTP_METHOD_OVERRIDE']) && count(trim($_SERVER['HTTP_X_HTTP_METHOD_OVERRIDE'])) > 0) {
			$this->methode = trim($_SERVER['HTTP_X_HTTP_METHOD_OVERRIDE']);
		} else {
			$this->methode = $_SERVER['REQUEST_METHOD'];
		}
	}
 
	private function initialiserRequeteDonnees() {
		if (isset($_SERVER['CONTENT_LENGTH']) && $_SERVER['CONTENT_LENGTH'] > 0) {
			$this->requeteDonnees = '';
			$httpContent = fopen('php://input', 'r');
			while ($data = fread($httpContent, 1024)) {
				$this->requeteDonnees .= $data;
			}
			fclose($httpContent);
		}
	}
 
	private function decouperUrlChemin() {
		if (isset($_SERVER['REDIRECT_URL']) && $_SERVER['REDIRECT_URL'] != '') {
			if (isset($_SERVER['REDIRECT_QUERY_STRING']) && !empty($_SERVER['REDIRECT_QUERY_STRING'])) {
				$url = $_SERVER['REDIRECT_URL'].'?'.$_SERVER['REDIRECT_QUERY_STRING'];
			} else {
				$url = $_SERVER['REDIRECT_URL'];
			}
		} else {
			$url = $_SERVER['REQUEST_URI'];
		}
 
		if (strlen($_SERVER['QUERY_STRING']) == 0) {
			$tailleURL = strlen($url);
		} else {
			$tailleURL = -(strlen($_SERVER['QUERY_STRING']) + 1);
		}
 
		$urlChaine = '';
		if (strpos($url, Config::get('serveur.baseURL')) !== false) {
			$urlChaine = substr($url, strlen(Config::get('serveur.baseURL')), $tailleURL);
		} else if (strpos($url, Config::get('serveur.baseAlternativeURL')) !== false) {
			$urlChaine = substr($url, strlen(Config::get('serveur.baseAlternativeURL')), $tailleURL);
		}
		return explode('/', $urlChaine);
	}
 
	private function initialiserApiVersion($apiVersion) {
		if ($this->verifierApiVersion($apiVersion)) {
			$this->apiVersion = $apiVersion;
			self::$config['chemins']['api'] = Config::get('chemin_modules').$this->apiVersion.DS;
			self::$config['chemins']['api_bibliotheque'] = self::$config['chemins']['api'].Config::get('dossier_bibliotheque').DS;
		} else {
			self::envoyerEnteteStatutHttp(self::HTTP_CODE_MAUVAISE_REQUETE);
			$e = "Aucune version d'API n'a été spécifiée.\n".
				"La version doit respecter l'expression régulière suivante : ".self::MOTIF_API_VERSION.".\n".
			  	"L'url doit avoir la forme suivante : http://www.mondomaine.org/services/apiVersion/monService/";
			self::ajouterMessage($e);
			self::cloreAccesServeur();
		}
	}
 
	private function verifierApiVersion($apiVersion) {
		$apiOk = false;
		if (isset($apiVersion) && !empty($apiVersion) && preg_match(self::MOTIF_API_VERSION, $apiVersion)) {
			$apiOk = true;
		}
		return $apiOk;
	}
 
	private function initialiserServiceNom($serviceNom) {
		if ($this->verifierServiceNom($serviceNom)) {
			$this->service = $this->traiterNomService($serviceNom);
		} else {
			self::envoyerEnteteStatutHttp(self::HTTP_CODE_MAUVAISE_REQUETE);
			$e = "Aucune nom de service n'a été spécifié.\n".
				"La nom du service doit respecter l'expression régulière suivante : ".self::MOTIF_SERVICE_NOM.".\n".
			  	"L'url doit avoir la forme suivante : http://www.mondomaine.org/services/apiVersion/monService/";
			self::ajouterMessage($e);
			self::cloreAccesServeur();
		}
	}
 
	private function verifierServiceNom($serviceNom) {
		$serviceNomOk = false;
		if (isset($serviceNom) && !empty($serviceNom) && preg_match(self::MOTIF_SERVICE_NOM, $serviceNom)) {
			$serviceNomOk = true;
		}
		return $serviceNomOk;
	}
 
	private function traiterNomService($serviceNom) {
		return str_replace(' ', '', ucwords(str_replace('-', ' ', strtolower($serviceNom))));
	}
 
	private function initialiserRessource($urlParts) {
		if (is_array($urlParts) && count($urlParts) > 0) {
			foreach ($urlParts as $ressource) {
				// Ne pas utiliser empty() car valeur 0 acceptée
				if ($ressource != '') {
					$this->ressources[] = urldecode($ressource);
				}
			}
		}
	}
 
	private function initialiserParametres() {
		$this->parametres = $this->recupererParametresGet();
		$this->parametresBruts = $this->recupererParametresBruts();
	}
 
	private function recupererParametresGet() {
		$_GET = $this->nettoyerParametres($_GET);
		return $_GET;
	}
 
	private function nettoyerParametres(Array $parametres) {
		// Pas besoin d'utiliser urldecode car déjà fait par php pour les clés et valeur de $_GET
		if (isset($parametres) && count($parametres) > 0) {
			foreach ($parametres as $cle => $valeur) {
				// les quotes, guillements et points-virgules ont été retirés des caractères à vérifier car
				//ça n'a plus lieu d'être maintenant que l'on utilise protéger à peu près partout
				$verifier = array('NULL', "\\", "\x00", "\x1a");
				$parametres[$cle] = strip_tags(str_replace($verifier, '', $valeur));
			}
		}
		return $parametres;
	}
 
	private function recupererParametresBruts() {
		$parametres_bruts = array();
		if (!empty($_SERVER['QUERY_STRING'])) {
			$paires = explode('&', $_SERVER['QUERY_STRING']);
			foreach ($paires as $paire) {
				$nv = explode('=', $paire);
				$nom = urldecode($nv[0]);
				$valeur = urldecode($nv[1]);
				$parametres_bruts[$nom] = $valeur;
			}
			$parametres_bruts = $this->nettoyerParametres($parametres_bruts);
		}
		return $parametres_bruts;
	}
 
	/**
	* La méthode __autoload() charge dynamiquement les classes trouvées dans le code.
	* Cette fonction est appelée par php5 quand il trouve une instanciation de classe dans le code.
	*
	*@param string le nom de la classe appelée.
	*@return void le fichier contenant la classe doit être inclu par la fonction.
	*/
	public static function chargerClasse($classe) {
		if (class_exists($classe)) {
			return null;
		}
		$chemins = array('', self::$config['chemins']['api'], self::$config['chemins']['api_bibliotheque']);
		foreach ($chemins as $chemin) {
			$chemin = $chemin.$classe.'.php';
			if (file_exists($chemin)) {
				require_once $chemin;
			}
		}
	}
 
	/**
	 * Execute la requête.
	 */
	public function executer() {
		$retour = '';
		switch ($this->methode) {
			case 'GET':
				$retour = $this->get();
				break;
			case 'POST':
				$retour = $this->post();// Retour pour l'alternative PUT
				break;
			case 'DELETE':
				$retour = $this->delete();
				break;
			case 'PUT':
				$retour = $this->put();
				break;
			// Autorise l'accès depuis des serveurs tiers
			case 'OPTIONS':
				/*header('Access-Control-Allow-Origin: *');
				header('Access-Control-Allow-Headers:origin, content-type');
				header('Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS');
				header('Access-Control-Allow-Content-Type: application/json');
				header('Access-Control-Max-Age: 3628800');
				header('Access-Control-Allow-Credentials: false');*/
				break;
			default :
				self::envoyerEnteteStatutHttp(self::HTTP_CODE_METHODE_NON_AUTORISE);
				header('Allow: GET, POST, DELETE, PUT');
				$e = "La méthode HTTP '{$this->methode}' n'est pas prise en compte par ce serveur REST.\n".
					"Consulter l'entête Allow pour connaître les méthodes autorisées.";
				self::ajouterMessage($e);
		}
		$this->cloreAccesServeur($retour);
	}
 
	/**
	 * Execute a GET request. A GET request fetches a list of resource when no resource name is given, a list of element
	 * when a resource name is given, or a resource element when a resource and resource unique identifier are given. It does not change the
	 * database contents.
	 */
	private function get() {
		$retour = '';
		if ($this->service != null) {
			$Service = new $this->service(self::$config);
			if (method_exists($Service, self::METHODE_GET)) {
				$methodeGet = self::METHODE_GET;
				$parametres = $Service->utiliserParametresBruts() ? $this->parametresBruts : $this->parametres;
				$retour = $Service->$methodeGet($this->ressources, $parametres);
			} else {
				self::envoyerEnteteStatutHttp(self::HTTP_CODE_RESSOURCE_INTROUVABLE);
				$e = "Le service '{$this->service}' ne contient pas la méthode '".self::METHODE_GET."' nécessaire ".
					"lors de l'appel du service via la méthode HTTP GET.";
				self::ajouterMessage($e);
			}
		}
		return $retour;
	}
 
	private function post() {
		$retour = '';
		$paires = $this->parserDonneesRequete();
		if (count($paires) != 0) {
			if (isset($paires['action']) && $paires['action'] == 'DELETE') {// Alternative à l'utilisation de DELETE
				$retour = $this->delete();
			} else if (count($this->ressources) == 0) {// Alternative à l'utilisation de PUT
				$retour = $this->put();
			} else {
				if ($this->service != null) {
					$Service = new $this->service(self::$config);
					if (method_exists($Service, self::METHODE_POST)) {
						$methodePost = self::METHODE_POST;
						$info = $Service->$methodePost($this->ressources, $paires);
						if ($info !== false) {
							$this->envoyerEnteteStatutHttp(self::HTTP_CODE_CREATION_OK);
							$retour = $info;
						}
					} else {
						self::envoyerEnteteStatutHttp(self::HTTP_CODE_RESSOURCE_INTROUVABLE);
						$e = "Le service '{$this->service}' ne contient pas la méthode '".self::METHODE_POST."' nécessaire ".
							"lors de l'appel du service via la méthode HTTP GET.";
						self::ajouterMessage($e);
					}
				}
			}
		} else {
			$this->envoyerEnteteStatutHttp(self::HTTP_CODE_CONTENU_REQUIS);
			$e = "Le service '{$this->service}' requiert de fournir le contenu à modifier dans le corps ".
				"de la requête avec la méthode HTTP POST.";
			self::ajouterMessage($e);
		}
		return $retour;
	}
 
	private function put() {
		$retour = '';
		$paires = $this->parserDonneesRequete();
		if (count($paires) != 0) {
			if ($this->service != null) {
				$Service = new $this->service(self::$config);
				if (method_exists($Service, self::METHODE_PUT)) {
					$methodePut = self::METHODE_PUT;
					$info = $Service->$methodePut($this->ressources, $paires);
					if ($info !== false) {
						$this->envoyerEnteteStatutHttp(self::HTTP_CODE_CREATION_OK);
						$retour = $info;
					}
				} else {
					self::envoyerEnteteStatutHttp(self::HTTP_CODE_RESSOURCE_INTROUVABLE);
					$e = "Le service '{$this->service}' ne contient pas la méthode '".self::METHODE_PUT."' nécessaire ".
						"lors de l'appel du service via la méthode HTTP GET.";
					self::ajouterMessage($e);
				}
			}
		} else {
			$this->envoyerEnteteStatutHttp(self::HTTP_CODE_CONTENU_REQUIS);
			$e = "Il est nécessaire de fournir du contenu dans le corps de la requête pour créer une nouvelle ressource.";
			self::ajouterMessage($e);
		}
		return $retour;
	}
 
	private function delete() {
		$retour = '';
		if (count($this->ressources) != 0) {
			$paires = $this->parserDonneesRequete();
			if ($this->service != null) {
				$Service = new $this->service(self::$config);
				if (method_exists($Service, self::METHODE_DELETE)) {
					$methodeDelete = self::METHODE_DELETE;
					$info = $Service->$methodeDelete($this->ressources, $paires);
					if ($info === true) {
						$this->envoyerEnteteStatutHttp(self::HTTP_CODE_SUPPRESSION_OK);
					} else if ($info === false) {
						$this->envoyerEnteteStatutHttp(self::HTTP_CODE_RESSOURCE_INTROUVABLE);
						$e = "La ressource à supprimer est introuvable. Il se peut qu'elle ait été préalablement supprimé.";
						self::ajouterMessage($e);
					} else {
						$this->envoyerEnteteStatutHttp(self::HTTP_CODE_OK);
						$retour = $info;
					}
				} else {
					self::envoyerEnteteStatutHttp(self::HTTP_CODE_RESSOURCE_INTROUVABLE);
					$e = "Le service '{$this->service}' ne contient pas la méthode '".self::METHODE_DELETE."' nécessaire ".
						"lors de l'appel du service via la méthode HTTP GET.";
					self::ajouterMessage($e);
				}
			}
		} else {
			$this->envoyerEnteteStatutHttp(self::HTTP_CODE_MAUVAISE_REQUETE);
			$e = "Il est nécessaire d'indiquer dans l'url la ressource à supprimer.";
			self::ajouterMessage($e);
		}
		return $retour;
	}
 
	/**
	 * Parse les données contenu dans le corps de la requête HTTP (= POST) en :
	 *  - décodant les clés et valeurs.
	 *  - supprimant les espaces en début et fin des clés et des valeurs.
	 *
	 * @return array Tableau de paires clé et valeur.
	 */
	private function parserDonneesRequete() {
		$donnees = array();
		if ($this->requeteDonneesParsees != null) {
			$donnees = $this->requeteDonneesParsees;
		} else if ($this->requeteDonnees != null) {
			if (preg_match('/application\/json/', $_SERVER['CONTENT_TYPE'])) {
				$donnees = json_decode($this->requeteDonnees, true);
			} else {
				$paires = explode('&', $this->requeteDonnees);
				foreach ($paires as $paire) {
					list($cle, $valeur) = explode('=', $paire);
					$cle = (isset($cle)) ? trim(urldecode($cle)) : '';
					$valeur = (isset($valeur)) ? trim(urldecode($valeur)) : '';
					$donnees[$cle] = $valeur;
				}
			}
			$this->requeteDonneesParsees = $donnees;
		}
		return $donnees;
	}
 
	/**
	 * Envoyer un entête HTTP (version 1.0) de statut.
	 * Il remplacera systématiquement tout entête HTTP de statut précédement envoyé.
	 * @param int $code entier indiquant le code du statut de l'entête HTTP à envoyer.
	 */
	public static function envoyerEnteteStatutHttp($code) {
		if (isset(self::$http10[$code])) {
			$txt = self::$http10[$code];
			header("HTTP/1.0 $code $txt", true);
		}
	}
 
	/**
	 * Termine l'accès au serveur après envoir envoyer les messages.
	 */
	private static function cloreAccesServeur($retour = '') {
		// 	Gestion des exceptions et erreurs générées par les services
		$retour .= self::gererErreurs();
 
		// Envoie des messages d'erreur et d'avertissement du serveur
		$retour .= self::envoyerMessages();
 
		// Autorise l'accès depuis des serveurs tiers
		//header('Access-Control-Allow-Origin: *');
 
		// Envoie sur la sortie standard le contenu de la réponse HTTP
		print $retour;
 
		// Nous terminons le script
		exit(0);
	}
 
	/**
	 * Si des exceptions ou des erreurs sont soulevées par le serveur ou les services, elles sont gérées par cette méthode.
	 * 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
	 * standard (via echo).
	 * Si seulement des erreurs de type E_USER_NOTICE, sont présentes, elle sont envoyées en fonction du contenu du paramètre de
	 * config "debogage_mode" :
	 *  - Debug::MODE_ECHO : les messages sont affichés en utilisant echo au moment où ils sont déclenchés dans le code.
	 *  - Debug::MODE_NOTICE : les message sont stockés par le gestionnaire d'exception sous forme d'erreur de type
	 *  E_USER_NOTICE et sont renvoyés sur la sortie standard à la fin de l'execution du programme (via echo).
	 *  - Debug::MODE_ENTETE_HTTP : les message sont stockés par le gestionnaire d'exception sous forme d'erreur de type
	 *  E_USER_NOTICE et sont renvoyés dans un entête HTTP (X_REST_DEBOGAGE_MESSAGES) à la fin de l'execution du programme.
	 *  - Autre valeur : les messages sont formatés puis retournés par la fonction de débogage (à vous de les afficher).
	 */
	public static function gererErreurs() {
		$retour = '';
		if (self::$debogageActivation && GestionnaireException::getExceptionsNbre() > 0) {
 
			$exceptionsTriees = GestionnaireException::getExceptionsTriees();
			reset($exceptionsTriees);
			$debogageSeulement = true;
			if (array_key_exists(E_USER_ERROR, $exceptionsTriees)) {
				self::envoyerEnteteStatutHttp(self::HTTP_CODE_ERREUR);
				$debogageSeulement = false;
			}
 
			$exceptionsFormatees = array();
			foreach ($exceptionsTriees as $exceptions) {
				foreach ($exceptions as $e) {
					if ($debogageSeulement && self::$debogageMode == Debug::MODE_ENTETE_HTTP) {
						$exceptionsFormatees[] = GestionnaireException::formaterExceptionDebug($e);
					} else {
						$retour = GestionnaireException::formaterExceptionXhtml($e);
					}
				}
			}
 
			if ($debogageSeulement && self::$debogageMode == Debug::MODE_ENTETE_HTTP) {
				header('X_REST_DEBOGAGE_MESSAGES: '.json_encode($exceptionsFormatees));
			}
		}
		return $retour;
	}
 
 
	/**
	 * Permet d'ajouter un message d'erreur ou d'avertissement qui sera envoyé au client.
	 * Le message doit être au format texte et en UTF-8.
	 * @param string $message le message à envoyer.
	 */
	public static function ajouterMessage($message) {
		if (isset($message) && !empty($message)) {
			self::$messages[] = $message;
		}
	}
 
	/**
	 * Envoie au client les éventuels messages d'erreur et d'avertissement du Serveur.
	 * Le format d'envoie est text/plain encodé en UTF-8.
	 */
	private static function envoyerMessages() {
		if (count(self::$messages) > 0) {
			header("Content-Type: text/plain; charset=utf-8");
			return implode("\n", self::$messages);
		}
	}
}
 


Rev 458	Rev 472
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 421 2013-04-11 14:43:49Z jpm $`	-
39	`* @link /doc/framework/`	-
40	`*/`	38	`*/`
41	`// TODO : gerer les retours : dans ce controleur : code retour et envoi ...`	39	`// TODO : gerer les retours : dans ce controleur : code retour et envoi ...`
42	`class RestServeur {`	40	`class RestServeur {`
43		41
44	`/** Nom de la méthode appelée dans un service pour éxécuter une requête de type GET. */`	42	`/** Nom de la méthode appelée dans un service pour éxécuter une requête de type GET. */`
45	`const METHODE_GET = 'consulter';`	43	`const METHODE_GET = 'consulter';`
46		44
47	`/** Nom de la méthode appelée dans un service pour éxécuter une requête de type POST. */`	45	`/** Nom de la méthode appelée dans un service pour éxécuter une requête de type POST. */`
48	`const METHODE_POST = 'modifier';`	46	`const METHODE_POST = 'modifier';`
49		47
50	`/** Nom de la méthode appelée dans un service pour éxécuter une requête de type DELETE. */`	48	`/** Nom de la méthode appelée dans un service pour éxécuter une requête de type DELETE. */`
51	`const METHODE_DELETE = 'supprimer';`	49	`const METHODE_DELETE = 'supprimer';`
52		50
53	`/** Nom de la méthode appelée dans un service pour éxécuter une requête de type PUT. */`	51	`/** Nom de la méthode appelée dans un service pour éxécuter une requête de type PUT. */`
54	`const METHODE_PUT = 'ajouter';`	52	`const METHODE_PUT = 'ajouter';`
-		53
55		54	`/** Code HTTP 200 : OK`
56	`/** Code HTTP 200 indiquant le succès de l'accès à un service web par la méthode GET.`	55	`* 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.`	56	`* L'utiliser lors d'une requète de type GET (consulter) pour indiquer le succès de l'opération.`
-		57	`* Sera renvoyée par défaut par PHP.`
-		58	`* @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1`
58	`* Sera renvoyée par défaut par PHP. */`	59	`*/`
-		60	`const HTTP_CODE_OK = '200';`
59	`const HTTP_CODE_OK = '200';`	61
60		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.`
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é.`	65	`* @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.2`
-		66	`*/`
-		67	`const HTTP_CODE_CREATION_OK = '201';`
-		68
-		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	`*/`
62	`* L'utiliser lors d'une requète de type PUT (ajouter) ou POST (modifier) pour indiquer le succès de l'opération. */`	75	`const HTTP_CODE_ACCEPTE_OK = '202';`
63	`const HTTP_CODE_CREATION_OK = '201';`	76
64		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.`
-		79	`* L'utiliser lors d'une requète de type DELETE (supprimer) pour indiquer le succès de l'opération si aucun`
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.`	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`
66	`* L'utiliser lors d'une requète de type DELETE (supprimer) pour indiquer le succès de l'opération si aucun`	82	`*/`
67	`* contenu (status) ne doit être renvoyé, sinon utiliser 200 OK. */`	83	`const HTTP_CODE_SUPPRESSION_OK = '204';`
68	`const HTTP_CODE_SUPPRESSION_OK = '204';`	84
-		85	`/** Code HTTP 400 : Bad Request`
-		86	`* Indique que les paramètres envoyés au service contiennent des erreurs.`
69		87	`* L'utiliser pour indiquer l'échec de l'accès au service. La réponse pourra contenir un message expliquant la source`
-		88	`* de l'erreur.`
70	`/** Code HTTP 400 indique que les paramètres envoyés au service contiennent des erreurs.`	89	`* @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1`
71	`* L'utiliser pour indiquer l'échec de l'accès au service. La réponse pourra contenir un message expliquant la source`	90	`*/`
-		91	`const HTTP_CODE_MAUVAISE_REQUETE = '400';`
-		92
72	`* de l'erreur. */`	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	`*/`
-		98	`const HTTP_CODE_ACCES_NON_AUTORISE = '401';`
-		99
-		100	`/** Code HTTP 403 : Forbidden`
73	`const HTTP_CODE_MAUVAISE_REQUETE = '400';`	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	`*/`
74		104	`const HTTP_CODE_ACCES_INTERDIT = '403';`
75	`/** Code HTTP 401 indiquant que l'accès à un service web est refusé car l'authentification (obligatoire) a échoué pour`	105
-		106	`/** Code HTTP 404 : Not Found`
76	`* accéder à la ressource. */`	107	`* Indiquant que la ressource indiquée par l'url est introuvable.`
77	`const HTTP_CODE_ACCES_NON_AUTORISE = '401';`	108	`* @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5`
-		109	`*/`
-		110	`const HTTP_CODE_RESSOURCE_INTROUVABLE = '404';`
78		111
-		112	`/** Code HTTP 405 : Method Not Allowed`
79	`/** Code HTTP 404 indiquant que la ressource indiquée par l'url est introuvable. */`	113	`* Indique soit :`
80	`const HTTP_CODE_RESSOURCE_INTROUVABLE = '404';`	114	`* - que le service web ne possède pas d'accès la ressource correspondant à la méthode HTTP employée.`
81		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	`*/`
82	`/** Code HTTP 405 indiquant soit :`	118	`const HTTP_CODE_METHODE_NON_AUTORISE = '405';`
-		119
83	`* - que le service web ne possède pas d'accès la ressource correspondant à la méthode HTTP employée.`	120	`/** Code HTTP 409 : Conflict`
-		121	`* Indique qu'un conflit est survenu vis à vis de la ressource.`
-		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`
84	`* - que la méthode HTTP enployée n'est pas en accord avec la ressource indiquée par l'url. */`	123	`* ailleurs.`
-		124	`* @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.10`
-		125	`*/`
-		126	`const HTTP_CODE_CONFLIT = '409';`
-		127
-		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	`*/`
-		132	`const HTTP_CODE_CONTENU_REQUIS = '411';`
-		133
-		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`
85	`const HTTP_CODE_METHODE_NON_AUTORISE = '405';`	138	`*/`
86		139	`const HTTP_CODE_ECHEC_CONDITION = '411';`
-		140
-		141	`/** Code HTTP 415 : Unsupported Media Type`
87	`/** Code d'erreur HTTP 409 indiquant qu'un conflit est survenu vis à vis de la ressource.`	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	`*/`
-		152	`const HTTP_CODE_ERREUR = '500';`
-		153
-		154	`/** Code HTTP 501 : Not Implemented`
88	`* Par exemple, essayer de créer deux fois la même ressource ou bien tenter de modifier une ressource qui a été modifiée par`	155	`* Indique que le web service ne supporte pas la fonctionnalité demandée.`
89	`* ailleurs. */`	156	`* @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2`
90	`const HTTP_CODE_CONFLIT = '409';`	157	`*/`
91		158	`const HTTP_NON_IMPLEMENTE= '501';`
92	`/** Code HTTP 411 indiquant que des paramètres passés dans le contenu de la requête sont nécessaires au service. */`	159
93	`const HTTP_CODE_CONTENU_REQUIS = '411';`	160	`/** Code HTTP 503 : Service Unavailable`
94		161	`* L'utiliser quand le web service est momentanément indisponible.`
95	`/** Code d'erreur HTTP 500 Internal Server Error.`	162	`* @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4`
96	`* L'utiliser quand le serveur ou un service soulève une erreur ou une exception. */`	163	`*/`
97	`const HTTP_CODE_ERREUR = '500';`	164	`const HTTP_CODE_SERVICE_INDISPONIBLE = '503';`
98		165
99	`/** Motif de l'epression régulière vérfiant la version de l'API. */`	166	`/** Motif de l'epression régulière vérfiant la version de l'API. */`
100	`const MOTIF_API_VERSION = '/^[0-9]+(?:[.][0-9]+)*$/';`	167	`const MOTIF_API_VERSION = '/^[0-9]+(?:[.][0-9]+)*$/';`
101		168
102	`/** Motif de l'epression régulière vérfiant le nom du service. */`	169	`/** Motif de l'epression régulière vérfiant le nom du service. */`
103	`const MOTIF_SERVICE_NOM = '/^[a-z0-9]+(?:[-][a-z0-9]+)*$/';`	170	`const MOTIF_SERVICE_NOM = '/^[a-z0-9]+(?:[-][a-z0-9]+)*$/';`
104		171
105	`/** Mettre à true pour activer l'affichage des messages d'erreurs et de débogage.`	172	`/** Mettre à true pour activer l'affichage des messages d'erreurs et de débogage.`
106	`* @var boolean */`	173	`* @var boolean */`
107	`private static $debogageActivation = false;`	174	`private static $debogageActivation = false;`
108		175
109	`/** Indiquer le mode de débogage à utiliser (@see Debug).`	176	`/** Indiquer le mode de débogage à utiliser (@see Debug).`
110	`* @var string */`	177	`* @var string */`
111	`private static $debogageMode = '';`	178	`private static $debogageMode = '';`
112		179
113	`/** La méthode de la requête HTTP utilisée.`	180	`/** La méthode de la requête HTTP utilisée.`
114	`* @var string */`	181	`* @var string */`
115	`private $methode = 'GET';`	182	`private $methode = 'GET';`
116		183
117	`/** Le contenu brut du corps de la requête HTTP (s'il y en a).`	184	`/** Le contenu brut du corps de la requête HTTP (s'il y en a).`
118	`* @var array */`	185	`* @var array */`
119	`private $requeteDonnees = null;`	186	`private $requeteDonnees = null;`
120		187
121	`/** Le contenu sous forme de tableau de paires clés-valeurs du corps de la requête HTTP (s'il y en a).`	188	`/** Le contenu sous forme de tableau de paires clés-valeurs du corps de la requête HTTP (s'il y en a).`
122	`* @var array */`	189	`* @var array */`
123	`private $requeteDonneesParsees = null;`	190	`private $requeteDonneesParsees = null;`
124		191
125	`/** Version de l'API demandée.`	192	`/** Version de l'API demandée.`
126	`* Ex. http://www.mondomaine.org/services/[apiVersion]/mon-service/`	193	`* Ex. http://www.mondomaine.org/services/[apiVersion]/mon-service/`
127	`* @var mixed Généralement deux nombres séparés par un point. Ex. : 1.0`	194	`* @var mixed Généralement deux nombres séparés par un point. Ex. : 1.0`
128	`*/`	195	`*/`
129	`private $apiVersion = null;`	196	`private $apiVersion = null;`
130		197
131	`/** Nom du service demandé.`	198	`/** Nom du service demandé.`
132	`* Ex. http://www.mondomaine.org/services/apiVersion/[mon-service]/`	199	`* Ex. http://www.mondomaine.org/services/apiVersion/[mon-service]/`
133	`* @var string par défaut vaut null.`	200	`* @var string par défaut vaut null.`
134	`*/`	201	`*/`
135	`private $service = null;`	202	`private $service = null;`
136		203
137	`/** Morceaux de l'url servant à préciser la ressource concerné pour le service demandé.`	204	`/** Morceaux de l'url servant à préciser la ressource concerné pour le service demandé.`
138	`* Ex. http://www.mondomaine.org/services/apiVersion/mon-service/[maRessource/maSousResource...]`	205	`* Ex. http://www.mondomaine.org/services/apiVersion/mon-service/[maRessource/maSousResource...]`
139	`* @var array`	206	`* @var array`
140	`*/`	207	`*/`
141	`private $ressources = array();`	208	`private $ressources = array();`
142		209
143	`/** Partie de l'url situé après le '?' servant à paramétrer le service demandé.`	210	`/** Partie de l'url situé après le '?' servant à paramétrer le service demandé.`
144	`* Les données proviennent de $_GET où les caractères suivant ont été transformé en '_' undescrore dans les clés :`	211	`* Les données proviennent de $_GET où les caractères suivant ont été transformé en '_' undescrore dans les clés :`
145	`* - chr(32) ( ) (space)`	212	`* - chr(32) ( ) (space)`
146	`* - chr(46) (.) (dot)`	213	`* - chr(46) (.) (dot)`
147	`* - chr(91) ([) (open square bracket)`	214	`* - chr(91) ([) (open square bracket)`
148	`* - chr(128) - chr(159) (various)`	215	`* - chr(128) - chr(159) (various)`
149	`* En outre nous appliquons la méthode nettoyerGet() qui effectue d'autres remplacement dans les valeurs.`	216	`* En outre nous appliquons la méthode nettoyerGet() qui effectue d'autres remplacement dans les valeurs.`
150	`* Ex. http://www.mondomaine.org/services/apiVersion/mon-service?monParametre1=maValeur1&monParametre2=maValeur2`	217	`* Ex. http://www.mondomaine.org/services/apiVersion/mon-service?monParametre1=maValeur1&monParametre2=maValeur2`
151	`* @see parametresBruts`	218	`* @see parametresBruts`
152	`* @var array`	219	`* @var array`
153	`*/`	220	`*/`
154	`private $parametres = array();`	221	`private $parametres = array();`
155		222
156	`/** Partie de l'url situé après le '?' servant à paramétrer le service demandé.`	223	`/** Partie de l'url situé après le '?' servant à paramétrer le service demandé.`
157	`* Les données proviennent de $_SERVER['QUERY_STRING'] et n'ont subies aucune transformation au niveau des clés.`	224	`* Les données proviennent de $_SERVER['QUERY_STRING'] et n'ont subies aucune transformation au niveau des clés.`
158	`* Cependant nous appliquons la méthode nettoyerGet() qui effectue d'autres remplacement dans les valeurs.`	225	`* Cependant nous appliquons la méthode nettoyerGet() qui effectue d'autres remplacement dans les valeurs.`
159	`* Ex. http://www.mondomaine.org/services/apiVersion/mon-service?monParametre1=maValeur1&monParametre2=maValeur2`	226	`* Ex. http://www.mondomaine.org/services/apiVersion/mon-service?monParametre1=maValeur1&monParametre2=maValeur2`
160	`* @see parametres`	227	`* @see parametres`
161	`* @var array`	228	`* @var array`
162	`*/`	229	`*/`
163	`private $parametresBruts = array();`	230	`private $parametresBruts = array();`
164		231
165	`/** Tableau contenant les paramètres de configuration du serveur.`	232	`/** Tableau contenant les paramètres de configuration du serveur.`
166	`* @var array`	233	`* @var array`
167	`*/`	234	`*/`
168	`private static $config = array();`	235	`private static $config = array();`
169		236
170	`/** Tableau contenant les messages d'erreur et/ou d'avertissement du Serveur.`	237	`/** Tableau contenant les messages d'erreur et/ou d'avertissement du Serveur.`
171	`* @var array`	238	`* @var array`
172	`* */`	239	`* */`
173	`private static $messages = array();`	240	`private static $messages = array();`
174		241
175	`/** Codes HTTP. */`	242	`/** Codes HTTP. */`
176	`private static $http10 = array(`	243	`private static $http10 = array(`
177	`self::HTTP_CODE_OK => 'OK',`	244	`self::HTTP_CODE_OK => 'OK',`
178	`self::HTTP_CODE_CREATION_OK => 'Created',`	245	`self::HTTP_CODE_CREATION_OK => 'Created',`
179	`self::HTTP_CODE_SUPPRESSION_OK => 'No Content',`	246	`self::HTTP_CODE_SUPPRESSION_OK => 'No Content',`
180	`self::HTTP_CODE_MAUVAISE_REQUETE => 'Bad Request',`	247	`self::HTTP_CODE_MAUVAISE_REQUETE => 'Bad Request',`
181	`self::HTTP_CODE_ACCES_NON_AUTORISE => 'Unauthorized',`	248	`self::HTTP_CODE_ACCES_NON_AUTORISE => 'Unauthorized',`
182	`self::HTTP_CODE_RESSOURCE_INTROUVABLE => 'Not Found',`	249	`self::HTTP_CODE_RESSOURCE_INTROUVABLE => 'Not Found',`
183	`self::HTTP_CODE_METHODE_NON_AUTORISE => 'Method Not Allowed',`	250	`self::HTTP_CODE_METHODE_NON_AUTORISE => 'Method Not Allowed',`
184	`self::HTTP_CODE_CONFLIT => 'Conflict',`	251	`self::HTTP_CODE_CONFLIT => 'Conflict',`
185	`self::HTTP_CODE_CONTENU_REQUIS => 'Length Required',`	252	`self::HTTP_CODE_CONTENU_REQUIS => 'Length Required',`
186	`self::HTTP_CODE_ERREUR => 'Internal Server Error'`	253	`self::HTTP_CODE_ERREUR => 'Internal Server Error'`
187	`);`	254	`);`
188		255
189	`/** Tableau des noms des paramètres à définir dans le fichier de config car obligatoirement nécessaire à cette classe.*/`	256	`/** Tableau des noms des paramètres à définir dans le fichier de config car obligatoirement nécessaire à cette classe.*/`
190	`private $parametres_obligatoires = array('debogage', 'debogage_mode', 'serveur.baseURL', 'chemin_modules');`	257	`private $parametres_obligatoires = array('debogage', 'debogage_mode', 'serveur.baseURL', 'chemin_modules');`
191		258
192	`/**`	259	`/**`
193	`* Analyse les données envoyées au serveur, enregistre la méthode HTTP utilisée pour appeler le serveur et parse`	260	`* Analyse les données envoyées au serveur, enregistre la méthode HTTP utilisée pour appeler le serveur et parse`
194	`* l'url appelée pour trouver le service demandé.`	261	`* l'url appelée pour trouver le service demandé.`
195	`*/`	262	`*/`
196	`public function __construct() {`	263	`public function __construct() {`
197	`Config::verifierPresenceParametres($this->parametres_obligatoires);`	264	`Config::verifierPresenceParametres($this->parametres_obligatoires);`
198		265
199	`self::$debogageActivation = Config::get('debogage');`	266	`self::$debogageActivation = Config::get('debogage');`
200	`self::$debogageMode = Config::get('debogage_mode');`	267	`self::$debogageMode = Config::get('debogage_mode');`
201		268
202	`if (isset($_SERVER['REQUEST_URI']) && isset($_SERVER['REQUEST_METHOD']) && isset($_SERVER['QUERY_STRING'])) {`	269	`if (isset($_SERVER['REQUEST_URI']) && isset($_SERVER['REQUEST_METHOD']) && isset($_SERVER['QUERY_STRING'])) {`
203	`$this->initialiserMethode();`	270	`$this->initialiserMethode();`
204	`$this->initialiserRequeteDonnees();`	271	`$this->initialiserRequeteDonnees();`
205		272
206	`$urlParts = $this->decouperUrlChemin();`	273	`$urlParts = $this->decouperUrlChemin();`
207		274
208	`$this->initialiserApiVersion(array_shift($urlParts));`	275	`$this->initialiserApiVersion(array_shift($urlParts));`
209	`$this->initialiserServiceNom(array_shift($urlParts));`	276	`$this->initialiserServiceNom(array_shift($urlParts));`
210	`$this->initialiserRessource($urlParts);`	277	`$this->initialiserRessource($urlParts);`
211		278
212	`$this->initialiserParametres();`	279	`$this->initialiserParametres();`
213	`// Enregistrement en première position des autoload de la méthode gérant les classes des services`	280	`// Enregistrement en première position des autoload de la méthode gérant les classes des services`
214	`spl_autoload_register(array(get_class(), 'chargerClasse'));`	281	`spl_autoload_register(array(get_class(), 'chargerClasse'));`
215	`} else {`	282	`} else {`
216	`self::envoyerEnteteStatutHttp(self::HTTP_CODE_ERREUR);`	283	`self::envoyerEnteteStatutHttp(self::HTTP_CODE_ERREUR);`
217	`$e = "La classe Serveur du TBFRamework nécessite, pour fonctionner, l'accès aux variables serveurs REQUEST_URI, REQUEST_METHOD et QUERY_STRING.";`	284	`$e = "La classe Serveur du TBFRamework nécessite, pour fonctionner, l'accès aux variables serveurs REQUEST_URI, REQUEST_METHOD et QUERY_STRING.";`
218	`self::ajouterMessage($e);`	285	`self::ajouterMessage($e);`
219	`}`	286	`}`
220	`}`	287	`}`
221		288
222	`private function initialiserMethode() {`	289	`private function initialiserMethode() {`
223	`if (isset($_SERVER['HTTP_X_HTTP_METHOD_OVERRIDE']) && count(trim($_SERVER['HTTP_X_HTTP_METHOD_OVERRIDE'])) > 0) {`	290	`if (isset($_SERVER['HTTP_X_HTTP_METHOD_OVERRIDE']) && count(trim($_SERVER['HTTP_X_HTTP_METHOD_OVERRIDE'])) > 0) {`
224	`$this->methode = trim($_SERVER['HTTP_X_HTTP_METHOD_OVERRIDE']);`	291	`$this->methode = trim($_SERVER['HTTP_X_HTTP_METHOD_OVERRIDE']);`
225	`} else {`	292	`} else {`
226	`$this->methode = $_SERVER['REQUEST_METHOD'];`	293	`$this->methode = $_SERVER['REQUEST_METHOD'];`
227	`}`	294	`}`
228	`}`	295	`}`
229		296
230	`private function initialiserRequeteDonnees() {`	297	`private function initialiserRequeteDonnees() {`
231	`if (isset($_SERVER['CONTENT_LENGTH']) && $_SERVER['CONTENT_LENGTH'] > 0) {`	298	`if (isset($_SERVER['CONTENT_LENGTH']) && $_SERVER['CONTENT_LENGTH'] > 0) {`
232	`$this->requeteDonnees = '';`	299	`$this->requeteDonnees = '';`
233	`$httpContent = fopen('php://input', 'r');`	300	`$httpContent = fopen('php://input', 'r');`
234	`while ($data = fread($httpContent, 1024)) {`	301	`while ($data = fread($httpContent, 1024)) {`
235	`$this->requeteDonnees .= $data;`	302	`$this->requeteDonnees .= $data;`
236	`}`	303	`}`
237	`fclose($httpContent);`	304	`fclose($httpContent);`
238	`}`	305	`}`
239	`}`	306	`}`
240		307
241	`private function decouperUrlChemin() {`	308	`private function decouperUrlChemin() {`
242	`if (isset($_SERVER['REDIRECT_URL']) && $_SERVER['REDIRECT_URL'] != '') {`	309	`if (isset($_SERVER['REDIRECT_URL']) && $_SERVER['REDIRECT_URL'] != '') {`
243	`if (isset($_SERVER['REDIRECT_QUERY_STRING']) && !empty($_SERVER['REDIRECT_QUERY_STRING'])) {`	310	`if (isset($_SERVER['REDIRECT_QUERY_STRING']) && !empty($_SERVER['REDIRECT_QUERY_STRING'])) {`
244	`$url = $_SERVER['REDIRECT_URL'].'?'.$_SERVER['REDIRECT_QUERY_STRING'];`	311	`$url = $_SERVER['REDIRECT_URL'].'?'.$_SERVER['REDIRECT_QUERY_STRING'];`
245	`} else {`	312	`} else {`
246	`$url = $_SERVER['REDIRECT_URL'];`	313	`$url = $_SERVER['REDIRECT_URL'];`
247	`}`	314	`}`
248	`} else {`	315	`} else {`
249	`$url = $_SERVER['REQUEST_URI'];`	316	`$url = $_SERVER['REQUEST_URI'];`
250	`}`	317	`}`
251		318
252	`if (strlen($_SERVER['QUERY_STRING']) == 0) {`	319	`if (strlen($_SERVER['QUERY_STRING']) == 0) {`
253	`$tailleURL = strlen($url);`	320	`$tailleURL = strlen($url);`
254	`} else {`	321	`} else {`
255	`$tailleURL = -(strlen($_SERVER['QUERY_STRING']) + 1);`	322	`$tailleURL = -(strlen($_SERVER['QUERY_STRING']) + 1);`
256	`}`	323	`}`
257		324
258	`$urlChaine = '';`	325	`$urlChaine = '';`
259	`if (strpos($url, Config::get('serveur.baseURL')) !== false) {`	326	`if (strpos($url, Config::get('serveur.baseURL')) !== false) {`
260	`$urlChaine = substr($url, strlen(Config::get('serveur.baseURL')), $tailleURL);`	327	`$urlChaine = substr($url, strlen(Config::get('serveur.baseURL')), $tailleURL);`
261	`} else if (strpos($url, Config::get('serveur.baseAlternativeURL')) !== false) {`	328	`} else if (strpos($url, Config::get('serveur.baseAlternativeURL')) !== false) {`
262	`$urlChaine = substr($url, strlen(Config::get('serveur.baseAlternativeURL')), $tailleURL);`	329	`$urlChaine = substr($url, strlen(Config::get('serveur.baseAlternativeURL')), $tailleURL);`
263	`}`	330	`}`
264	`return explode('/', $urlChaine);`	331	`return explode('/', $urlChaine);`
265	`}`	332	`}`
266		333
267	`private function initialiserApiVersion($apiVersion) {`	334	`private function initialiserApiVersion($apiVersion) {`
268	`if ($this->verifierApiVersion($apiVersion)) {`	335	`if ($this->verifierApiVersion($apiVersion)) {`
269	`$this->apiVersion = $apiVersion;`	336	`$this->apiVersion = $apiVersion;`
270	`self::$config['chemins']['api'] = Config::get('chemin_modules').$this->apiVersion.DS;`	337	`self::$config['chemins']['api'] = Config::get('chemin_modules').$this->apiVersion.DS;`
271	`self::$config['chemins']['api_bibliotheque'] = self::$config['chemins']['api'].Config::get('dossier_bibliotheque').DS;`	338	`self::$config['chemins']['api_bibliotheque'] = self::$config['chemins']['api'].Config::get('dossier_bibliotheque').DS;`
272	`} else {`	339	`} else {`
273	`self::envoyerEnteteStatutHttp(self::HTTP_CODE_MAUVAISE_REQUETE);`	340	`self::envoyerEnteteStatutHttp(self::HTTP_CODE_MAUVAISE_REQUETE);`
274	`$e = "Aucune version d'API n'a été spécifiée.\n".`	341	`$e = "Aucune version d'API n'a été spécifiée.\n".`
275	`"La version doit respecter l'expression régulière suivante : ".self::MOTIF_API_VERSION.".\n".`	342	`"La version doit respecter l'expression régulière suivante : ".self::MOTIF_API_VERSION.".\n".`
276	`"L'url doit avoir la forme suivante : http://www.mondomaine.org/services/apiVersion/monService/";`	343	`"L'url doit avoir la forme suivante : http://www.mondomaine.org/services/apiVersion/monService/";`
277	`self::ajouterMessage($e);`	344	`self::ajouterMessage($e);`
278	`self::cloreAccesServeur();`	345	`self::cloreAccesServeur();`
279	`}`	346	`}`
280	`}`	347	`}`
281		348
282	`private function verifierApiVersion($apiVersion) {`	349	`private function verifierApiVersion($apiVersion) {`
283	`$apiOk = false;`	350	`$apiOk = false;`
284	`if (isset($apiVersion) && !empty($apiVersion) && preg_match(self::MOTIF_API_VERSION, $apiVersion)) {`	351	`if (isset($apiVersion) && !empty($apiVersion) && preg_match(self::MOTIF_API_VERSION, $apiVersion)) {`
285	`$apiOk = true;`	352	`$apiOk = true;`
286	`}`	353	`}`
287	`return $apiOk;`	354	`return $apiOk;`
288	`}`	355	`}`
289		356
290	`private function initialiserServiceNom($serviceNom) {`	357	`private function initialiserServiceNom($serviceNom) {`
291	`if ($this->verifierServiceNom($serviceNom)) {`	358	`if ($this->verifierServiceNom($serviceNom)) {`
292	`$this->service = $this->traiterNomService($serviceNom);`	359	`$this->service = $this->traiterNomService($serviceNom);`
293	`} else {`	360	`} else {`
294	`self::envoyerEnteteStatutHttp(self::HTTP_CODE_MAUVAISE_REQUETE);`	361	`self::envoyerEnteteStatutHttp(self::HTTP_CODE_MAUVAISE_REQUETE);`
295	`$e = "Aucune nom de service n'a été spécifié.\n".`	362	`$e = "Aucune nom de service n'a été spécifié.\n".`
296	`"La nom du service doit respecter l'expression régulière suivante : ".self::MOTIF_SERVICE_NOM.".\n".`	363	`"La nom du service doit respecter l'expression régulière suivante : ".self::MOTIF_SERVICE_NOM.".\n".`
297	`"L'url doit avoir la forme suivante : http://www.mondomaine.org/services/apiVersion/monService/";`	364	`"L'url doit avoir la forme suivante : http://www.mondomaine.org/services/apiVersion/monService/";`
298	`self::ajouterMessage($e);`	365	`self::ajouterMessage($e);`
299	`self::cloreAccesServeur();`	366	`self::cloreAccesServeur();`
300	`}`	367	`}`
301	`}`	368	`}`
302		369
303	`private function verifierServiceNom($serviceNom) {`	370	`private function verifierServiceNom($serviceNom) {`
304	`$serviceNomOk = false;`	371	`$serviceNomOk = false;`
305	`if (isset($serviceNom) && !empty($serviceNom) && preg_match(self::MOTIF_SERVICE_NOM, $serviceNom)) {`	372	`if (isset($serviceNom) && !empty($serviceNom) && preg_match(self::MOTIF_SERVICE_NOM, $serviceNom)) {`
306	`$serviceNomOk = true;`	373	`$serviceNomOk = true;`
307	`}`	374	`}`
308	`return $serviceNomOk;`	375	`return $serviceNomOk;`
309	`}`	376	`}`
310		377
311	`private function traiterNomService($serviceNom) {`	378	`private function traiterNomService($serviceNom) {`
312	`return str_replace(' ', '', ucwords(str_replace('-', ' ', strtolower($serviceNom))));`	379	`return str_replace(' ', '', ucwords(str_replace('-', ' ', strtolower($serviceNom))));`
313	`}`	380	`}`
314		381
315	`private function initialiserRessource($urlParts) {`	382	`private function initialiserRessource($urlParts) {`
316	`if (is_array($urlParts) && count($urlParts) > 0) {`	383	`if (is_array($urlParts) && count($urlParts) > 0) {`
317	`foreach ($urlParts as $ressource) {`	384	`foreach ($urlParts as $ressource) {`
318	`// Ne pas utiliser empty() car valeur 0 acceptée`	385	`// Ne pas utiliser empty() car valeur 0 acceptée`
319	`if ($ressource != '') {`	386	`if ($ressource != '') {`
320	`$this->ressources[] = urldecode($ressource);`	387	`$this->ressources[] = urldecode($ressource);`
321	`}`	388	`}`
322	`}`	389	`}`
323	`}`	390	`}`
324	`}`	391	`}`
325		392
326	`private function initialiserParametres() {`	393	`private function initialiserParametres() {`
327	`$this->parametres = $this->recupererParametresGet();`	394	`$this->parametres = $this->recupererParametresGet();`
328	`$this->parametresBruts = $this->recupererParametresBruts();`	395	`$this->parametresBruts = $this->recupererParametresBruts();`
329	`}`	396	`}`
330		397
331	`private function recupererParametresGet() {`	398	`private function recupererParametresGet() {`
332	`$_GET = $this->nettoyerParametres($_GET);`	399	`$_GET = $this->nettoyerParametres($_GET);`
333	`return $_GET;`	400	`return $_GET;`
334	`}`	401	`}`
335		402
336	`private function nettoyerParametres(Array $parametres) {`	403	`private function nettoyerParametres(Array $parametres) {`
337	`// Pas besoin d'utiliser urldecode car déjà fait par php pour les clés et valeur de $_GET`	404	`// Pas besoin d'utiliser urldecode car déjà fait par php pour les clés et valeur de $_GET`
338	`if (isset($parametres) && count($parametres) > 0) {`	405	`if (isset($parametres) && count($parametres) > 0) {`
339	`foreach ($parametres as $cle => $valeur) {`	406	`foreach ($parametres as $cle => $valeur) {`
340	`// les quotes, guillements et points-virgules ont été retirés des caractères à vérifier car`	407	`// les quotes, guillements et points-virgules ont été retirés des caractères à vérifier car`
341	`//ça n'a plus lieu d'être maintenant que l'on utilise protéger à peu près partout`	408	`//ça n'a plus lieu d'être maintenant que l'on utilise protéger à peu près partout`
342	`$verifier = array('NULL', "\\", "\x00", "\x1a");`	409	`$verifier = array('NULL', "\\", "\x00", "\x1a");`
343	`$parametres[$cle] = strip_tags(str_replace($verifier, '', $valeur));`	410	`$parametres[$cle] = strip_tags(str_replace($verifier, '', $valeur));`
344	`}`	411	`}`
345	`}`	412	`}`
346	`return $parametres;`	413	`return $parametres;`
347	`}`	414	`}`
348		415
349	`private function recupererParametresBruts() {`	416	`private function recupererParametresBruts() {`
350	`$parametres_bruts = array();`	417	`$parametres_bruts = array();`
351	`if (!empty($_SERVER['QUERY_STRING'])) {`	418	`if (!empty($_SERVER['QUERY_STRING'])) {`
352	`$paires = explode('&', $_SERVER['QUERY_STRING']);`	419	`$paires = explode('&', $_SERVER['QUERY_STRING']);`
353	`foreach ($paires as $paire) {`	420	`foreach ($paires as $paire) {`
354	`$nv = explode('=', $paire);`	421	`$nv = explode('=', $paire);`
355	`$nom = urldecode($nv[0]);`	422	`$nom = urldecode($nv[0]);`
356	`$valeur = urldecode($nv[1]);`	423	`$valeur = urldecode($nv[1]);`
357	`$parametres_bruts[$nom] = $valeur;`	424	`$parametres_bruts[$nom] = $valeur;`
358	`}`	425	`}`
359	`$parametres_bruts = $this->nettoyerParametres($parametres_bruts);`	426	`$parametres_bruts = $this->nettoyerParametres($parametres_bruts);`
360	`}`	427	`}`
361	`return $parametres_bruts;`	428	`return $parametres_bruts;`
362	`}`	429	`}`
363		430
364	`/**`	431	`/**`
365	`* La méthode __autoload() charge dynamiquement les classes trouvées dans le code.`	432	`* La méthode __autoload() charge dynamiquement les classes trouvées dans le code.`
366	`* Cette fonction est appelée par php5 quand il trouve une instanciation de classe dans le code.`	433	`* Cette fonction est appelée par php5 quand il trouve une instanciation de classe dans le code.`
367	`*`	434	`*`
368	`*@param string le nom de la classe appelée.`	435	`*@param string le nom de la classe appelée.`
369	`*@return void le fichier contenant la classe doit être inclu par la fonction.`	436	`*@return void le fichier contenant la classe doit être inclu par la fonction.`
370	`*/`	437	`*/`
371	`public static function chargerClasse($classe) {`	438	`public static function chargerClasse($classe) {`
372	`if (class_exists($classe)) {`	439	`if (class_exists($classe)) {`
373	`return null;`	440	`return null;`
374	`}`	441	`}`
375	`$chemins = array('', self::$config['chemins']['api'], self::$config['chemins']['api_bibliotheque']);`	442	`$chemins = array('', self::$config['chemins']['api'], self::$config['chemins']['api_bibliotheque']);`
376	`foreach ($chemins as $chemin) {`	443	`foreach ($chemins as $chemin) {`
377	`$chemin = $chemin.$classe.'.php';`	444	`$chemin = $chemin.$classe.'.php';`
378	`if (file_exists($chemin)) {`	445	`if (file_exists($chemin)) {`
379	`require_once $chemin;`	446	`require_once $chemin;`
380	`}`	447	`}`
381	`}`	448	`}`
382	`}`	449	`}`
383		450
384	`/**`	451	`/**`
385	`* Execute la requête.`	452	`* Execute la requête.`
386	`*/`	453	`*/`
387	`public function executer() {`	454	`public function executer() {`
388	`$retour = '';`	455	`$retour = '';`
389	`switch ($this->methode) {`	456	`switch ($this->methode) {`
390	`case 'GET':`	457	`case 'GET':`
391	`$retour = $this->get();`	458	`$retour = $this->get();`
392	`break;`	459	`break;`
393	`case 'POST':`	460	`case 'POST':`
394	`$retour = $this->post();// Retour pour l'alternative PUT`	461	`$retour = $this->post();// Retour pour l'alternative PUT`
395	`break;`	462	`break;`
396	`case 'DELETE':`	463	`case 'DELETE':`
397	`$retour = $this->delete();`	464	`$retour = $this->delete();`
398	`break;`	465	`break;`
399	`case 'PUT':`	466	`case 'PUT':`
400	`$retour = $this->put();`	467	`$retour = $this->put();`
401	`break;`	468	`break;`
402	`// Autorise l'accès depuis des serveurs tiers`	469	`// Autorise l'accès depuis des serveurs tiers`
403	`case 'OPTIONS':`	470	`case 'OPTIONS':`
404	`/header('Access-Control-Allow-Origin: ');`	471	`/header('Access-Control-Allow-Origin: ');`
405	`header('Access-Control-Allow-Headers:origin, content-type');`	472	`header('Access-Control-Allow-Headers:origin, content-type');`
406	`header('Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS');`	473	`header('Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS');`
407	`header('Access-Control-Allow-Content-Type: application/json');`	474	`header('Access-Control-Allow-Content-Type: application/json');`
408	`header('Access-Control-Max-Age: 3628800');`	475	`header('Access-Control-Max-Age: 3628800');`
409	`header('Access-Control-Allow-Credentials: false');*/`	476	`header('Access-Control-Allow-Credentials: false');*/`
410	`break;`	477	`break;`
411	`default :`	478	`default :`
412	`self::envoyerEnteteStatutHttp(self::HTTP_CODE_METHODE_NON_AUTORISE);`	479	`self::envoyerEnteteStatutHttp(self::HTTP_CODE_METHODE_NON_AUTORISE);`
413	`header('Allow: GET, POST, DELETE, PUT');`	480	`header('Allow: GET, POST, DELETE, PUT');`
414	`$e = "La méthode HTTP '{$this->methode}' n'est pas prise en compte par ce serveur REST.\n".`	481	`$e = "La méthode HTTP '{$this->methode}' n'est pas prise en compte par ce serveur REST.\n".`
415	`"Consulter l'entête Allow pour connaître les méthodes autorisées.";`	482	`"Consulter l'entête Allow pour connaître les méthodes autorisées.";`
416	`self::ajouterMessage($e);`	483	`self::ajouterMessage($e);`
417	`}`	484	`}`
418	`$this->cloreAccesServeur($retour);`	485	`$this->cloreAccesServeur($retour);`
419	`}`	486	`}`
420		487
421	`/**`	488	`/**`
422	`* Execute a GET request. A GET request fetches a list of resource when no resource name is given, a list of element`	489	`* Execute a GET request. A GET request fetches a list of resource when no resource name is given, a list of element`
423	`* when a resource name is given, or a resource element when a resource and resource unique identifier are given. It does not change the`	490	`* when a resource name is given, or a resource element when a resource and resource unique identifier are given. It does not change the`
424	`* database contents.`	491	`* database contents.`
425	`*/`	492	`*/`
426	`private function get() {`	493	`private function get() {`
427	`$retour = '';`	494	`$retour = '';`
428	`if ($this->service != null) {`	495	`if ($this->service != null) {`
429	`$Service = new $this->service(self::$config);`	496	`$Service = new $this->service(self::$config);`
430	`if (method_exists($Service, self::METHODE_GET)) {`	497	`if (method_exists($Service, self::METHODE_GET)) {`
431	`$methodeGet = self::METHODE_GET;`	498	`$methodeGet = self::METHODE_GET;`

Subversion Repositories Applications.framework

(root)/trunk/framework/RestServeur.php – Rev 458 → 472