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
* @version		$Id: RestClient.php 353 2011-08-01 16:02:32Z jpm $
*/
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 = null;
	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 = null;
	}
	
	//+----------------------------------------------------------------------------------------------------------------+
	// 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();
			}
			$contexte = stream_context_create(array(
				'http' => array(
      				'method' => $mode,
					'header' => "Content-type: application/x-www-form-urlencoded\r\n",
      				'content' => http_build_query($donnees, null, self::HTTP_URL_REQUETE_SEPARATEUR))));
			$flux = @fopen($this->url, 'r', false, $contexte);
			if (!$flux) {
				$this->reponse_entetes = $http_response_header;
				$e = "L'ouverture de l'url '{$this->url}' par la méthode HTTP '$mode' a échoué!";
				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 @ 499 – Rev 350 → 353

Rev 350		Rev 353
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	`* @version $Id: RestClient.php 350 2011-06-16 16:50:33Z jpm $`	12	`* @version $Id: RestClient.php 353 2011-08-01 16:02:32Z jpm $`
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 = null;`
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($cle) {`	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 = null;`
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	`$contexte = stream_context_create(array(`	79	`$contexte = stream_context_create(array(`
80	`'http' => array(`	80	`'http' => array(`
81	`'method' => $mode,`	81	`'method' => $mode,`
82	`'header' => "Content-type: application/x-www-form-urlencoded\r\n",`	82	`'header' => "Content-type: application/x-www-form-urlencoded\r\n",`
83	`'content' => http_build_query($donnees, null, self::HTTP_URL_REQUETE_SEPARATEUR))));`	83	`'content' => http_build_query($donnees, null, self::HTTP_URL_REQUETE_SEPARATEUR))));`
84	`$flux = @fopen($this->url, 'r', false, $contexte);`	84	`$flux = @fopen($this->url, 'r', false, $contexte);`
85	`if (!$flux) {`	85	`if (!$flux) {`
86	`$this->reponse_entetes = $http_response_header;`	86	`$this->reponse_entetes = $http_response_header;`
87	`$e = "L'ouverture de l'url '{$this->url}' par la méthode HTTP '$mode' a échoué!";`	87	`$e = "L'ouverture de l'url '{$this->url}' par la méthode HTTP '$mode' a échoué!";`
88	`trigger_error($e, E_USER_WARNING);`	88	`trigger_error($e, E_USER_WARNING);`
89	`} else {`	89	`} else {`
90	`// Informations sur les en-têtes et métadonnées du flux`	90	`// Informations sur les en-têtes et métadonnées du flux`
91	`$this->reponse_entetes = stream_get_meta_data($flux);`	91	`$this->reponse_entetes = stream_get_meta_data($flux);`
92		92
93	`// Contenu actuel de $url`	93	`// Contenu actuel de $url`
94	`$contenu = stream_get_contents($flux);`	94	`$contenu = stream_get_contents($flux);`
95		95
96	`fclose($flux);`	96	`fclose($flux);`
97	`}`	97	`}`
98	`$this->traiterEntete();`	98	`$this->traiterEntete();`
99	`}`	99	`}`
100	`$this->reinitialiser();`	100	`$this->reinitialiser();`
101	`return $contenu;`	101	`return $contenu;`
102	`}`	102	`}`
103		103
104	`private function traiterUrlParametres() {`	104	`private function traiterUrlParametres() {`
105	`$parametres = array();`	105	`$parametres = array();`
106	`if (count($this->parametres) > 0) {`	106	`if (count($this->parametres) > 0) {`
107	`foreach ($this->parametres as $cle => $valeur) {`	107	`foreach ($this->parametres as $cle => $valeur) {`
108	`$cle = rawurlencode($cle);`	108	`$cle = rawurlencode($cle);`
109	`$valeur = rawurlencode($valeur);`	109	`$valeur = rawurlencode($valeur);`
110	`$parametres[] = $cle.self::HTTP_URL_REQUETE_CLE_VALEUR_SEPARATEUR.$valeur;`	110	`$parametres[] = $cle.self::HTTP_URL_REQUETE_CLE_VALEUR_SEPARATEUR.$valeur;`
111	`}`	111	`}`
112	`$url_parametres = implode(self::HTTP_URL_REQUETE_SEPARATEUR, $parametres);`	112	`$url_parametres = implode(self::HTTP_URL_REQUETE_SEPARATEUR, $parametres);`
113	`$this->url = $this->url.'?'.$url_parametres;`	113	`$this->url = $this->url.'?'.$url_parametres;`
114	`}`	114	`}`
115	`}`	115	`}`
116		116
117	`private function traiterEntete() {`	117	`private function traiterEntete() {`
118	`$infos = $this->analyserEntete();`	118	`$infos = $this->analyserEntete();`
119	`$this->traiterEnteteDebogage($infos);`	119	`$this->traiterEnteteDebogage($infos);`
120	`}`	120	`}`
121		121
122	`private function analyserEntete() {`	122	`private function analyserEntete() {`
123	`$entetes = $this->reponse_entetes;`	123	`$entetes = $this->reponse_entetes;`
124	`$infos = array('date' => null, 'uri' => $this->url, 'debogages' => null);`	124	`$infos = array('date' => null, 'uri' => $this->url, 'debogages' => null);`
125		125
126	`if (isset($entetes['wrapper_data'])) {`	126	`if (isset($entetes['wrapper_data'])) {`
127	`$entetes = $entetes['wrapper_data'];`	127	`$entetes = $entetes['wrapper_data'];`
128	`}`	128	`}`
129	`foreach ($entetes as $entete) {`	129	`foreach ($entetes as $entete) {`
130	`if (preg_match('/^X_REST_DEBOGAGE_MESSAGES: (.+)$/', $entete, $match)) {`	130	`if (preg_match('/^X_REST_DEBOGAGE_MESSAGES: (.+)$/', $entete, $match)) {`
131	`$infos['debogages'] = json_decode($match[1]);`	131	`$infos['debogages'] = json_decode($match[1]);`
132	`}`	132	`}`
133	`if (preg_match('/^Date: .+ ([012][0-9]:[012345][0-9]:[012345][0-9]) .*$/', $entete, $match)) {`	133	`if (preg_match('/^Date: .+ ([012][0-9]:[012345][0-9]:[012345][0-9]) .*$/', $entete, $match)) {`
134	`$infos['date'] = $match[1];`	134	`$infos['date'] = $match[1];`
135	`}`	135	`}`
136	`}`	136	`}`
137	`return $infos;`	137	`return $infos;`
138	`}`	138	`}`
139		139
140	`private function traiterEnteteDebogage($entetes_analyses) {`	140	`private function traiterEnteteDebogage($entetes_analyses) {`
141	`if (isset($entetes['debogages'])) {`	141	`if (isset($entetes['debogages'])) {`
142	`$date = $entetes['date'];`	142	`$date = $entetes['date'];`
143	`$uri = $entetes['uri'];`	143	`$uri = $entetes['uri'];`
144	`$debogages = $entetes['debogages'];`	144	`$debogages = $entetes['debogages'];`
145	`foreach ($debogages as $debogage) {`	145	`foreach ($debogages as $debogage) {`
146	`$e = "DEBOGAGE : $date - $uri :\n$debogage";`	146	`$e = "DEBOGAGE : $date - $uri :\n$debogage";`
147	`trigger_error($e, E_USER_NOTICE);`	147	`trigger_error($e, E_USER_NOTICE);`
148	`}`	148	`}`
149	`}`	149	`}`
150	`}`	150	`}`
151		151
152	`private function reinitialiser() {`	152	`private function reinitialiser() {`
153	`$this->nettoyerParametres();`	153	`$this->nettoyerParametres();`
154	`}`	154	`}`
155	`}`	155	`}`