WebSVN – Applications.framework – Diff – /branches/v0.3-aleaume/framework/RestClient.php


<?php
// declare(encoding='UTF-8');
/**
* Classe client permettant d'interroger des services web REST.
*
* @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		http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt Licence CECILL
* @license		http://www.gnu.org/licenses/gpl.html Licence GNU-GPL
* @since		0.2
*/
class RestClient {
	const HTTP_URL_REQUETE_SEPARATEUR = '&';
	const HTTP_URL_REQUETE_CLE_VALEUR_SEPARATEUR = '=';
	private $http_methodes = array('GET', 'POST', 'PUT', 'DELETE', 'HEAD', 'OPTIONS', 'CONNECT', 'TRACE');
	protected $parametres = array();
	private $url = null;
	private $reponse_entetes = null;
 
	//+----------------------------------------------------------------------------------------------------------------+
	// ACCESSEURS
 
	public function getReponseEntetes() {
		return $this->reponse_entetes;
	}
 
	public function getParametre($cle) {
		$valeur = (isset($this->parametres[$cle])) ? $this->parametres[$cle] : null;
		return $valeur;
	}
 
	public function ajouterParametre($cle, $valeur) {
		$this->parametres[$cle] = $valeur;
	}
 
	public function supprimerParametre($cle) {
		unset($this->parametres[$cle]);
	}
 
	public function nettoyerParametres() {
		$this->parametres = array();
	}
 
	//+----------------------------------------------------------------------------------------------------------------+
	// MÉTHODES
 
	public function consulter($url) {
		$retour = $this->envoyerRequete($url, 'GET');
		return $retour;
	}
 
	public function ajouter($url, Array $donnees) {
		$retour = $this->envoyerRequete($url, 'PUT', $donnees);
		return $retour;
	}
 
	public function modifier($url, Array $donnees) {
		$retour = $this->envoyerRequete($url, 'POST', $donnees);
		return $retour;
	}
 
	public function supprimer($url) {
		$retour = $this->envoyerRequete($url, 'DELETE');
		return $retour;
	}
 
	public function envoyerRequete($url, $mode, Array $donnees = array()) {
		$this->url = $url;
		$contenu = false;
		if (! in_array($mode, $this->http_methodes)) {
			$e = "Le mode de requête '$mode' n'est pas accepté!";
			trigger_error($e, E_USER_WARNING);
		} else {
			if ($mode == 'GET') {
				$this->traiterUrlParametres();
			}
			$content = http_build_query($donnees, null, self::HTTP_URL_REQUETE_SEPARATEUR);
			$contexte = stream_context_create(array(
				'http' => array(
      				'method' => $mode,
					'header' => "Content-type: application/x-www-form-urlencoded\r\n",
      				'content' => $content)));
			$flux = @fopen($this->url, 'r', false, $contexte);
			if (!$flux) {
				$this->reponse_entetes = $http_response_header;
				$entetesFmt = print_r($this->analyserEntete(), true);
				$e = "L'ouverture de l'url '{$this->url}' par la méthode HTTP '$mode' a échoué!\n".
					"Le contenu des métadonnées était : $entetesFmt \n".
					"Les paramètres de la requête HTTP étaient : $content \n".
					"Le contenu était : ".stream_get_contents($flux);
				trigger_error($e, E_USER_WARNING);
			} else {
				// Informations sur les en-têtes et métadonnées du flux
				$this->reponse_entetes = stream_get_meta_data($flux);
 
				// Contenu actuel de $url
				$contenu = stream_get_contents($flux);
 
				fclose($flux);
			}
			$this->traiterEntete();
		}
		$this->reinitialiser();
		return $contenu;
	}
 
	private function traiterUrlParametres() {
		$parametres = array();
		if (count($this->parametres) > 0) {
			foreach ($this->parametres as $cle => $valeur) {
				$cle = rawurlencode($cle);
				$valeur = rawurlencode($valeur);
				$parametres[] = $cle.self::HTTP_URL_REQUETE_CLE_VALEUR_SEPARATEUR.$valeur;
			}
			$url_parametres = implode(self::HTTP_URL_REQUETE_SEPARATEUR, $parametres);
			$this->url = $this->url.'?'.$url_parametres;
		}
	}
 
	private function traiterEntete() {
		$infos = $this->analyserEntete();
		$this->traiterEnteteDebogage($infos);
	}
 
	private function analyserEntete() {
		$entetes = $this->reponse_entetes;
		$infos = array('date' => null, 'uri' => $this->url, 'debogages' => null);
 
		if (isset($entetes['wrapper_data'])) {
			$entetes = $entetes['wrapper_data'];
		}
		foreach ($entetes as $entete) {
			if (preg_match('/^X_REST_DEBOGAGE_MESSAGES: (.+)$/', $entete, $match)) {
				$infos['debogages'] = json_decode($match[1]);
			}
			if (preg_match('/^Date: .+ ([012][0-9]:[012345][0-9]:[012345][0-9]) .*$/', $entete, $match)) {
				$infos['date'] = $match[1];
			}
		}
		return $infos;
	}
 
	private function traiterEnteteDebogage($entetes_analyses) {
		if (isset($entetes['debogages'])) {
			$date = $entetes['date'];
			$uri = $entetes['uri'];
			$debogages = $entetes['debogages'];
			foreach ($debogages as $debogage) {
				$e = "DEBOGAGE : $date - $uri :\n$debogage";
				trigger_error($e, E_USER_NOTICE);
			}
		}
	}
 
	private function reinitialiser() {
		$this->nettoyerParametres();
	}
 
}


Subversion Repositories Applications.framework

(root)/branches/v0.3-aleaume/framework/RestClient.php – Rev 470 → 499

Rev 470		Rev 499
1	`<?php`	1	`<?php`
2	`// declare(encoding='UTF-8');`	2	`// declare(encoding='UTF-8');`
3	`/**`	3	`/**`
4	`* Classe client permettant d'interroger des services web REST.`	4	`* Classe client permettant d'interroger des services web REST.`
5	`*`	5	`*`
6	`* @category php 5.2`	6	`* @category php 5.2`
7	`* @package Framework`	7	`* @package Framework`
8	`* @author Jean-Pascal MILCENT <jpm@tela-botanica.org>`	8	`* @author Jean-Pascal MILCENT <jpm@tela-botanica.org>`
9	`* @copyright Copyright (c) 2010, Tela Botanica (accueil@tela-botanica.org)`	9	`* @copyright Copyright (c) 2010, Tela Botanica (accueil@tela-botanica.org)`
10	`* @license http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt Licence CECILL`	10	`* @license http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt Licence CECILL`
11	`* @license http://www.gnu.org/licenses/gpl.html Licence GNU-GPL`	11	`* @license http://www.gnu.org/licenses/gpl.html Licence GNU-GPL`
12	`* @since 0.2`	12	`* @since 0.2`
13	`*/`	13	`*/`
14	`class RestClient {`	14	`class RestClient {`
15	`const HTTP_URL_REQUETE_SEPARATEUR = '&';`	15	`const HTTP_URL_REQUETE_SEPARATEUR = '&';`
16	`const HTTP_URL_REQUETE_CLE_VALEUR_SEPARATEUR = '=';`	16	`const HTTP_URL_REQUETE_CLE_VALEUR_SEPARATEUR = '=';`
17	`private $http_methodes = array('GET', 'POST', 'PUT', 'DELETE', 'HEAD', 'OPTIONS', 'CONNECT', 'TRACE');`	17	`private $http_methodes = array('GET', 'POST', 'PUT', 'DELETE', 'HEAD', 'OPTIONS', 'CONNECT', 'TRACE');`
18	`protected $parametres = null;`	18	`protected $parametres = array();`
19	`private $url = null;`	19	`private $url = null;`
20	`private $reponse_entetes = null;`	20	`private $reponse_entetes = null;`
21		21
22	`//+----------------------------------------------------------------------------------------------------------------+`	22	`//+----------------------------------------------------------------------------------------------------------------+`
23	`// ACCESSEURS`	23	`// ACCESSEURS`
24		24
25	`public function getReponseEntetes() {`	25	`public function getReponseEntetes() {`
26	`return $this->reponse_entetes;`	26	`return $this->reponse_entetes;`
27	`}`	27	`}`
28		28
29	`public function getParametre($cle) {`	29	`public function getParametre($cle) {`
30	`$valeur = (isset($this->parametres[$cle])) ? $this->parametres[$cle] : null;`	30	`$valeur = (isset($this->parametres[$cle])) ? $this->parametres[$cle] : null;`
31	`return $valeur;`	31	`return $valeur;`
32	`}`	32	`}`
33		33
34	`public function ajouterParametre($cle, $valeur) {`	34	`public function ajouterParametre($cle, $valeur) {`
35	`$this->parametres[$cle] = $valeur;`	35	`$this->parametres[$cle] = $valeur;`
36	`}`	36	`}`
37		37
38	`public function supprimerParametre($cle) {`	38	`public function supprimerParametre($cle) {`
39	`unset($this->parametres[$cle]);`	39	`unset($this->parametres[$cle]);`
40	`}`	40	`}`
41		41
42	`public function nettoyerParametres() {`	42	`public function nettoyerParametres() {`
43	`$this->parametres = null;`	43	`$this->parametres = array();`
44	`}`	44	`}`
45		45
46	`//+----------------------------------------------------------------------------------------------------------------+`	46	`//+----------------------------------------------------------------------------------------------------------------+`
47	`// MÉTHODES`	47	`// MÉTHODES`
48		48
49	`public function consulter($url) {`	49	`public function consulter($url) {`
50	`$retour = $this->envoyerRequete($url, 'GET');`	50	`$retour = $this->envoyerRequete($url, 'GET');`
51	`return $retour;`	51	`return $retour;`
52	`}`	52	`}`
53		53
54	`public function ajouter($url, Array $donnees) {`	54	`public function ajouter($url, Array $donnees) {`
55	`$retour = $this->envoyerRequete($url, 'PUT', $donnees);`	55	`$retour = $this->envoyerRequete($url, 'PUT', $donnees);`
56	`return $retour;`	56	`return $retour;`
57	`}`	57	`}`
58		58
59	`public function modifier($url, Array $donnees) {`	59	`public function modifier($url, Array $donnees) {`
60	`$retour = $this->envoyerRequete($url, 'POST', $donnees);`	60	`$retour = $this->envoyerRequete($url, 'POST', $donnees);`
61	`return $retour;`	61	`return $retour;`
62	`}`	62	`}`
63		63
64	`public function supprimer($url) {`	64	`public function supprimer($url) {`
65	`$retour = $this->envoyerRequete($url, 'DELETE');`	65	`$retour = $this->envoyerRequete($url, 'DELETE');`
66	`return $retour;`	66	`return $retour;`
67	`}`	67	`}`
68		68
69	`public function envoyerRequete($url, $mode, Array $donnees = array()) {`	69	`public function envoyerRequete($url, $mode, Array $donnees = array()) {`
70	`$this->url = $url;`	70	`$this->url = $url;`
71	`$contenu = false;`	71	`$contenu = false;`
72	`if (! in_array($mode, $this->http_methodes)) {`	72	`if (! in_array($mode, $this->http_methodes)) {`
73	`$e = "Le mode de requête '$mode' n'est pas accepté!";`	73	`$e = "Le mode de requête '$mode' n'est pas accepté!";`
74	`trigger_error($e, E_USER_WARNING);`	74	`trigger_error($e, E_USER_WARNING);`
75	`} else {`	75	`} else {`
76	`if ($mode == 'GET') {`	76	`if ($mode == 'GET') {`
77	`$this->traiterUrlParametres();`	77	`$this->traiterUrlParametres();`
78	`}`	78	`}`
79	`$content = http_build_query($donnees, null, self::HTTP_URL_REQUETE_SEPARATEUR);`	79	`$content = http_build_query($donnees, null, self::HTTP_URL_REQUETE_SEPARATEUR);`
80	`$contexte = stream_context_create(array(`	80	`$contexte = stream_context_create(array(`
81	`'http' => array(`	81	`'http' => array(`
82	`'method' => $mode,`	82	`'method' => $mode,`
83	`'header' => "Content-type: application/x-www-form-urlencoded\r\n",`	83	`'header' => "Content-type: application/x-www-form-urlencoded\r\n",`
84	`'content' => $content)));`	84	`'content' => $content)));`
85	`$flux = @fopen($this->url, 'r', false, $contexte);`	85	`$flux = @fopen($this->url, 'r', false, $contexte);`
86	`if (!$flux) {`	86	`if (!$flux) {`
87	`$this->reponse_entetes = $http_response_header;`	87	`$this->reponse_entetes = $http_response_header;`
88	`$entetesFmt = print_r($this->analyserEntete(), true);`	88	`$entetesFmt = print_r($this->analyserEntete(), true);`
89	`$e = "L'ouverture de l'url '{$this->url}' par la méthode HTTP '$mode' a échoué!\n".`	89	`$e = "L'ouverture de l'url '{$this->url}' par la méthode HTTP '$mode' a échoué!\n".`
90	`"Le contenu des métadonnées était : $entetesFmt \n".`	90	`"Le contenu des métadonnées était : $entetesFmt \n".`
91	`"Les paramètres de la requête HTTP étaient : $content \n".`	91	`"Les paramètres de la requête HTTP étaient : $content \n".`
92	`"Le contenu était : ".stream_get_contents($flux);`	92	`"Le contenu était : ".stream_get_contents($flux);`
93	`trigger_error($e, E_USER_WARNING);`	93	`trigger_error($e, E_USER_WARNING);`
94	`} else {`	94	`} else {`
95	`// Informations sur les en-têtes et métadonnées du flux`	95	`// Informations sur les en-têtes et métadonnées du flux`
96	`$this->reponse_entetes = stream_get_meta_data($flux);`	96	`$this->reponse_entetes = stream_get_meta_data($flux);`
97		97
98	`// Contenu actuel de $url`	98	`// Contenu actuel de $url`
99	`$contenu = stream_get_contents($flux);`	99	`$contenu = stream_get_contents($flux);`
100		100
101	`fclose($flux);`	101	`fclose($flux);`
102	`}`	102	`}`
103	`$this->traiterEntete();`	103	`$this->traiterEntete();`
104	`}`	104	`}`
105	`$this->reinitialiser();`	105	`$this->reinitialiser();`
106	`return $contenu;`	106	`return $contenu;`
107	`}`	107	`}`
108		108
109	`private function traiterUrlParametres() {`	109	`private function traiterUrlParametres() {`
110	`$parametres = array();`	110	`$parametres = array();`
111	`if (count($this->parametres) > 0) {`	111	`if (count($this->parametres) > 0) {`
112	`foreach ($this->parametres as $cle => $valeur) {`	112	`foreach ($this->parametres as $cle => $valeur) {`
113	`$cle = rawurlencode($cle);`	113	`$cle = rawurlencode($cle);`
114	`$valeur = rawurlencode($valeur);`	114	`$valeur = rawurlencode($valeur);`
115	`$parametres[] = $cle.self::HTTP_URL_REQUETE_CLE_VALEUR_SEPARATEUR.$valeur;`	115	`$parametres[] = $cle.self::HTTP_URL_REQUETE_CLE_VALEUR_SEPARATEUR.$valeur;`
116	`}`	116	`}`
117	`$url_parametres = implode(self::HTTP_URL_REQUETE_SEPARATEUR, $parametres);`	117	`$url_parametres = implode(self::HTTP_URL_REQUETE_SEPARATEUR, $parametres);`
118	`$this->url = $this->url.'?'.$url_parametres;`	118	`$this->url = $this->url.'?'.$url_parametres;`
119	`}`	119	`}`
120	`}`	120	`}`
121		121
122	`private function traiterEntete() {`	122	`private function traiterEntete() {`
123	`$infos = $this->analyserEntete();`	123	`$infos = $this->analyserEntete();`
124	`$this->traiterEnteteDebogage($infos);`	124	`$this->traiterEnteteDebogage($infos);`
125	`}`	125	`}`
126		126
127	`private function analyserEntete() {`	127	`private function analyserEntete() {`
128	`$entetes = $this->reponse_entetes;`	128	`$entetes = $this->reponse_entetes;`
129	`$infos = array('date' => null, 'uri' => $this->url, 'debogages' => null);`	129	`$infos = array('date' => null, 'uri' => $this->url, 'debogages' => null);`
130		130
131	`if (isset($entetes['wrapper_data'])) {`	131	`if (isset($entetes['wrapper_data'])) {`
132	`$entetes = $entetes['wrapper_data'];`	132	`$entetes = $entetes['wrapper_data'];`
133	`}`	133	`}`
134	`foreach ($entetes as $entete) {`	134	`foreach ($entetes as $entete) {`
135	`if (preg_match('/^X_REST_DEBOGAGE_MESSAGES: (.+)$/', $entete, $match)) {`	135	`if (preg_match('/^X_REST_DEBOGAGE_MESSAGES: (.+)$/', $entete, $match)) {`
136	`$infos['debogages'] = json_decode($match[1]);`	136	`$infos['debogages'] = json_decode($match[1]);`
137	`}`	137	`}`
138	`if (preg_match('/^Date: .+ ([012][0-9]:[012345][0-9]:[012345][0-9]) .*$/', $entete, $match)) {`	138	`if (preg_match('/^Date: .+ ([012][0-9]:[012345][0-9]:[012345][0-9]) .*$/', $entete, $match)) {`
139	`$infos['date'] = $match[1];`	139	`$infos['date'] = $match[1];`
140	`}`	140	`}`
141	`}`	141	`}`
142	`return $infos;`	142	`return $infos;`
143	`}`	143	`}`
144		144
145	`private function traiterEnteteDebogage($entetes_analyses) {`	145	`private function traiterEnteteDebogage($entetes_analyses) {`
146	`if (isset($entetes['debogages'])) {`	146	`if (isset($entetes['debogages'])) {`
147	`$date = $entetes['date'];`	147	`$date = $entetes['date'];`
148	`$uri = $entetes['uri'];`	148	`$uri = $entetes['uri'];`
149	`$debogages = $entetes['debogages'];`	149	`$debogages = $entetes['debogages'];`
150	`foreach ($debogages as $debogage) {`	150	`foreach ($debogages as $debogage) {`
151	`$e = "DEBOGAGE : $date - $uri :\n$debogage";`	151	`$e = "DEBOGAGE : $date - $uri :\n$debogage";`
152	`trigger_error($e, E_USER_NOTICE);`	152	`trigger_error($e, E_USER_NOTICE);`
153	`}`	153	`}`
154	`}`	154	`}`
155	`}`	155	`}`
156		156
157	`private function reinitialiser() {`	157	`private function reinitialiser() {`
158	`$this->nettoyerParametres();`	158	`$this->nettoyerParametres();`
159	`}`	159	`}`
160	`}`	-
161		160	`}`
-		161