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

+ *
  * Encodage en entrée : utf8
  * Encodage en sortie : utf8
+ *
  * @category	Php 5.2
- * @package	Framework
+ * @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		GPL v3 <http://www.gnu.org/licenses/gpl.txt>
- * @license	CECILL v2 <http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt>
+ * @license		CECILL v2 <http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt>
  * @since 		0.3
- * @version	$Id: RestServeur.php 344 2011-06-10 07:51:56Z jpm $
+ * @version		$Id: RestServeur.php 359 2011-08-30 13:53:45Z delphine $
  * @link		/doc/framework/
  */
 // TODO : gerer les retours : dans ce controleur : code retour et envoi ...
 class RestServeur {
 	/** Code d'erreur HTTP 500 Internal Server Error.
 	 * L'utiliser quand le serveur ou un service soulève une erreur ou une exception. */
+	const HTTP_CODE_ERREUR = '500';
+	/** 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 HTTP_CODE_ERREUR = '500';
+	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 */
 	/** 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 $config = array();
+	private static $messages = array();
 	/** Codes HTTP. */
 	private static $http10 = array(
 		if (isset($_SERVER['REQUEST_URI']) && isset($_SERVER['REQUEST_METHOD']) && isset($_SERVER['QUERY_STRING'])) {
 			$this->initialiserMethode();
 			$this->initialiserRequeteDonnees();
+			$urlParts = $this->decouperUrlChemin();
 			$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'));
-			spl_autoload_register(array(get_class(), 'chargerClasse'));
+		} else {
-		} 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.";
-			trigger_error($e, E_USER_ERROR);
+			self::ajouterMessage($e);
+		}
+	}
+		}
+	}
 	private function decouperUrlChemin() {
 		if (isset($_SERVER['REDIRECT_URL']) && $_SERVER['REDIRECT_URL'] != '') {
-			if (isset($_SERVER['REDIRECT_QUERY_STRING'])) {
+			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'];
-		}
+		}
 		//echo '<pre>'; print_r($_SERVER); echo '</pre>';
 		if (strlen($_SERVER['QUERY_STRING']) == 0) {
 			$tailleURL = strlen($url);
 		} else {
 			$tailleURL = -(strlen($_SERVER['QUERY_STRING']) + 1);
-		}
+		}
 		//echo '<br/>url : '.$url;
 		$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 (isset($apiVersion) && !empty($apiVersion)) {
+		if ($this->verifierApiVersion($apiVersion)) {
 			$this->apiVersion = $apiVersion;
+			self::$config['chemins']['api'] = Config::get('chemin_modules').$this->apiVersion.DS;
+		} else {
+			self::envoyerEnteteStatutHttp(self::HTTP_CODE_MAUVAISE_REQUETE);
-			self::$config['chemins']['api'] = Config::get('chemin_modules').$this->apiVersion.DS;
+			$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".
-		} else {
+			  	"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;
-			$e = "Aucune version d'API n'a été spécifié dans l'url qui doit avoir la forme suivante http://www.mondomaine.org/services/apiVersion/monService/";
+		if (isset($apiVersion) && !empty($apiVersion) && preg_match(self::MOTIF_API_VERSION, $apiVersion)) {
+			$apiOk = true;
 			trigger_error($e, E_USER_ERROR);
 		return $apiOk;
 	}
 	private function initialiserServiceNom($serviceNom) {
+		if ($this->verifierServiceNom($serviceNom)) {
+			$this->service = $this->traiterNomService($serviceNom);
+		} else {
-		if (isset($serviceNom) && !empty($serviceNom)) {
+			self::envoyerEnteteStatutHttp(self::HTTP_CODE_MAUVAISE_REQUETE);
+			$e = "Aucune nom de service n'a été spécifié.\n".
-			$this->service = $this->traiterNomService($serviceNom);
+				"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) {
-		} else {
+		$serviceNomOk = false;
+		if (isset($serviceNom) && !empty($serviceNom) && preg_match(self::MOTIF_SERVICE_NOM, $serviceNom)) {
-			$e = "Aucun service n'a été spécifié dans l'url qui doit avoir la forme suivante http://www.mondomaine.org/services/apiVersion/monService/";
+			$serviceNomOk = true;
 			trigger_error($e, E_USER_ERROR);
 		return $serviceNomOk;
+	}
 	*/
 	public static function chargerClasse($classe) {
 		if (class_exists($classe)) {
 			return null;
+		}
+		$classeTrouvee = false;
 		$chemins = array('', self::$config['chemins']['api']);
 		foreach ($chemins as $chemin) {
 			$chemin = $chemin.$classe.'.php';
 			if (file_exists($chemin)) {
 				require_once $chemin;
+				$classeTrouvee = true;
+			}
+		}
+		if ($classeTrouvee === false) {
+			self::envoyerEnteteStatutHttp(self::HTTP_CODE_RESSOURCE_INTROUVABLE);
+			$e = "La classe '$classe' du service n'a pas été trouvée par le serveur.\n".
+				"Cela peut signifier que le nom du service saisi comporte une erreur.";
+			self::ajouterMessage($e);
+			self::cloreAccesServeur();
+		}
+	}
 	/**
 	 * Execute la requête.
 	 */
-	function executer() {
+	public function executer() {
 		switch ($this->methode) {
 			case 'GET':
 				$this->get();
 				break;
 				break;
 			case 'PUT':
 				$this->put();
 				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.";
+				$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.";
-				trigger_error($e, E_USER_WARNING);
+				self::ajouterMessage($e);
+		}
-		// 	Affichage des exceptions et erreurs générées par les services
-		$this->gererErreurs();
+		$this->cloreAccesServeur();
+	}
 	/**
 	 * Execute a GET request. A GET request fetches a list of resource when no resource name is given, a list of element
 			$Service = new $this->service(self::$config);
 			if (method_exists($Service, self::METHODE_GET)) {
 				$methodeGet = self::METHODE_GET;
 				$Service->$methodeGet($this->ressources, $this->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.";
-				trigger_error($e, E_USER_ERROR);
+				self::ajouterMessage($e);
+			}
+		}
+	}
 	private function post() {
-		$paires = $this->parserDonneesRequete();
 		$paires = $this->parserDonneesRequete();
 		if (count($paires) != 0) {
 			if (isset($paires['action']) && $paires['action'] == 'DELETE') {// Altnative à l'utilisation de DELETE
 				$this->delete();
 			} else if (count($this->ressources) == 0) {// Altnative à l'utilisation de PUT
 				$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 ($Service->$methodePost($this->ressources, $paires)) {
+						if ($info === true) {
 							$this->envoyerEnteteStatutHttp(self::HTTP_CODE_CREATION_OK);
+						}
+					} else {
-					} 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 POST.";
+							"lors de l'appel du service via la méthode HTTP GET.";
-						trigger_error($e, E_USER_ERROR);
+						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.";
-			$this->envoyerEnteteStatutHttp(self::HTTP_CODE_CONTENU_REQUIS);
+			self::ajouterMessage($e);
+		}
+	}
-	private function put() {
-		$paires = $this->parserDonneesRequete();
+	private function put() {
 		$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;
-					$methodePut = self::METHODE_PUT;
+					$info = $Service->$methodePut($this->ressources, $paires);
-					if ($Service->$methodePut($this->ressources, $paires)) {
+					if ($info === true) {
 						$this->envoyerEnteteStatutHttp(self::HTTP_CODE_CREATION_OK);
+					}
 				} else {
-				} 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 PUT (ou équivalant).";
+						"lors de l'appel du service via la méthode HTTP GET.";
-					trigger_error($e, E_USER_ERROR);
+					self::ajouterMessage($e);
+				}
+			}
+		} else {
+			$this->envoyerEnteteStatutHttp(self::HTTP_CODE_CONTENU_REQUIS);
-		} else {
+			$e = "Il est nécessaire de fournir du contenu dans le corps de la requête pour créer une nouvelle ressource.";
-			$this->envoyerEnteteStatutHttp(self::HTTP_CODE_CONTENU_REQUIS);
+			self::ajouterMessage($e);
+		}
+	}
 	private function delete() {
 		if (count($this->ressources) != 0) {
 			if ($this->service != null) {
 				$Service = new $this->service(self::$config);
+				if (method_exists($Service, self::METHODE_DELETE)) {
-				if (method_exists($Service, self::METHODE_DELETE)) {
+					$methodeDelete = self::METHODE_DELETE;
-					$methodeDelete = self::METHODE_DELETE;
+					$info = $Service->$methodeDelete($this->ressources);
-					if ($Service->$methodeDelete($this->ressources, $paires)) {
+					if ($info === true) {
+						$this->envoyerEnteteStatutHttp(self::HTTP_CODE_SUPPRESSION_OK);
+					} else if ($info === false) {
-						$this->envoyerEnteteStatutHttp(self::HTTP_CODE_SUPPRESSION_OK);
+						$this->envoyerEnteteStatutHttp(self::HTTP_CODE_RESSOURCE_INTROUVABLE);
-					} else {
+						$e = "La ressource à supprimer est introuvable. Il se peut qu'elle ait été préalablement supprimé.";
+						self::ajouterMessage($e);
 						$this->envoyerEnteteStatutHttp(self::HTTP_CODE_RESSOURCE_INTROUVABLE);
-					}
+				} else {
-				} 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 DELETE (ou équivalant).";
+						"lors de l'appel du service via la méthode HTTP GET.";
-					trigger_error($e, E_USER_ERROR);
+					self::ajouterMessage($e);
+				}
+			}
+		} else {
 			$this->envoyerEnteteStatutHttp(self::HTTP_CODE_MAUVAISE_REQUETE);
-		} else {
+			$e = "Il est nécessaire d'indiquer dans l'url la ressource à supprimer.";
-			$this->envoyerEnteteStatutHttp(self::HTTP_CODE_MAUVAISE_REQUETE);
+			self::ajouterMessage($e);
+		}
 			header("HTTP/1.0 $code $txt", true);
+		}
+	}
+	/**
+	 * Termine l'accès au serveur après envoir envoyer les messages.
+	 */
+	private static function cloreAccesServeur() {
+		// 	Gestion des exceptions et erreurs générées par les services
+		self::gererErreurs();
+		// Envoie des messages d'erreur et d'avertissement du serveur
+		self::envoyerMessages();
+		// 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
 			if ($debogageSeulement && self::$debogageMode == Debug::MODE_ENTETE_HTTP) {
 				header('X_REST_DEBOGAGE_MESSAGES: '.json_encode($exceptionsFormatees));
+			}
+		}
+	}
+	/**
+	 * 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");
+			print implode("\n", self::$messages);
+		}
+	}
+}
 ?>

Subversion Repositories Applications.framework

(root)/trunk/framework/RestServeur.php – Rev 357 → 360