Subversion Repositories Applications.framework

Rev

Rev 439 | Rev 494 | Go to most recent revision | Show entire file | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 439 Rev 473
Line 1... Line 1...
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		CeCILL v2 <http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt>
11 
* @license		http://www.gnu.org/licenses/gpl.html Licence GNU-GPL
 11 
* @license		GNU-GPL <http://www.gnu.org/licenses/gpl.html>
12 
* @version		$Id: RestClient.php 439 2013-10-14 15:48:41Z raphael $
 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 = 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() {
 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 envoyerCurlRequete($url, $mode, Array $donnees = array()) {
 69 
	public function envoyerRequete($url, $mode, Array $donnees = array()) {
- 
 
 70 
		$contenu = false;
- 
 
 71 
		if (FALSE && function_exists('curl_init') && $mode == 'GET') {
- 
 
 72 
			// nous n'activons le wrapper que pour GET pour l'instant
- 
 
 73 
			// car l'utilisation de curl pour les autres modes pourrait
- 
 
 74 
			// vraisemblablement induire des comportements différents. (test-suite needed)
- 
 
 75 
			$contenu = $this->envoyerCurlRequete($url, $mode, $donnees);
- 
 
 76 
		} else {
- 
 
 77 
			$contenu = $this->envoyerStreamRequete($url, $mode, $donnees);
- 
 
 78 
		}
- 
 
 79 
		return $contenu;
- 
 
 80 
	}
- 
 
 81 
 
- 
 
 82 
	private function envoyerStreamRequete($url, $mode, Array $donnees = array()) {
70 
		$this->url = $url;
 83 
		$this->url = $url;
71 
		$contenu = false;
 84 
		$contenu = false;
72 
		if (! in_array($mode, $this->http_methodes)) {
 85 
		if (! in_array($mode, $this->http_methodes)) {
73 
			$e = "Le mode de requête '$mode' n'est pas accepté!";
 86 
			$e = "Le mode de requête '$mode' n'est pas accepté!";
74 
			trigger_error($e, E_USER_WARNING);
 87 
			trigger_error($e, E_USER_WARNING);
75 
		} else {
 88 
		} else {
76 
			if ($mode == 'GET') {
 89 
			if ($mode == 'GET') {
77 
				$this->traiterUrlParametres();
 90 
				$this->traiterUrlParametres();
78 
			}
 91 
			}
79 
 
 - 
 
80 
			$ch = curl_init($this->url);
 - 
 
81 
			curl_setopt($ch, CURLOPT_HEADER, TRUE);
 92 
			$content = http_build_query($donnees, null, self::HTTP_URL_REQUETE_SEPARATEUR);
82 
			curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
 93 
			$contexte = stream_context_create(array(
83 
			curl_setopt($ch, CURLOPT_FOLLOWLOCATION, 1);
 94 
				'http' => array(
84 
 
 - 
 
85 
			if($mode == 'POST') curl_setopt($ch, CURLOPT_POST, TRUE);
 95 
      				'method' => $mode,
86 
			elseif($mode == 'PUT') curl_setopt($ch, CURLOPT_PUT, TRUE);
 96 
					'header' => "Content-type: application/x-www-form-urlencoded\r\n",
87 
			elseif($mode == 'DELETE') curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "DELETE");
 - 
 
88 
 
 - 
 
89 
			if($donnees) curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($donnees, null, self::HTTP_URL_REQUETE_SEPARATEUR));
 - 
 
90 
 
 - 
 
91 
			/* if(isset($_COOKIES["XDEBUG_PROFILE"])) curl_setopt($ch, CURLOPT_COOKIE, "XDEBUG_PROFILE");
 - 
 
92 
			$caller = self::getCaller(debug_backtrace());
 97 
      				'content' => $content)));
93 
			@curl_setopt($ch, CURLOPT_REFERER, sprintf("%s[%s:%d:%s]", $_SERVER['REQUEST_URI'], $caller['file'], $caller['line'], $caller['function'])); // $_SERVER['QUERY_STRING']; // debug */
 - 
 
94 
			$flux = curl_exec($ch);
 98 
			$flux = @fopen($this->url, 'r', false, $contexte);
95 
			curl_close($ch);
 - 
 
96 
 
 - 
 
97 
			if (!$flux) {
 99 
			if (!$flux) {
98 
				$this->reponse_entetes = $http_response_header;
 100 
				$this->reponse_entetes = $http_response_header;
99 
				trigger_error(sprintf("fail: %s \"%s\" (%s)", strtoupper($mode), $this->url, http_build_query($donnees, null, self::HTTP_URL_REQUETE_SEPARATEUR)),
 101 
				$entetesFmt = print_r($this->analyserEntete(), true);
- 
 
 102 
				$e = "Echec requête '$mode' : {$this->url}\n".
- 
 
 103 
					"Paramètres requête : $content \n".
- 
 
 104 
					"Entêtes réponse : $entetesFmt \n";
100 
							  E_USER_WARNING);
 105 
				trigger_error($e, E_USER_WARNING);
101 
			} else {
 106 
			} else {
102 
				// attention, CURLOPT_FOLLOWLOCATION amène le stream à contenir plusieurs section d'header HTTP successives
 - 
 
103 
				$t = explode("\r\n\r\n", $flux);
 - 
 
104 
				$contenu = array_splice($t, -1);
 - 
 
105 
				$dernier_entete = array_splice($t, -1);
 107 
				// Informations sur les en-têtes et métadonnées du flux
106 
				$contenu = $contenu[0];
 - 
 
107 
				$dernier_entete = $dernier_entete[0];
 108 
				$this->reponse_entetes = stream_get_meta_data($flux);
Line 108... Line 109...
108 
 
 109 
 
109 
				// XXX: mimic stream_get_meta_data() (ce qui n'est pas très propre, le code appelant ferait mieux de se mettre à jour)
 110 
				// Contenu actuel de $url
- 
 
 111 
				$contenu = stream_get_contents($flux);
- 
 
 112 
 
110 
				$this->reponse_entetes = array('wrapper_data' => explode("\r\n", $dernier_entete));
 113 
				fclose($flux);
111 
			}
 114 
			}
112 
			$this->traiterEntete();
 115 
			$this->traiterEntete();
113 
		}
 116 
		}
114 
		$this->reinitialiser();
 117 
		$this->reinitialiser();
115 
		return $contenu;
 118 
		return $contenu;
Line 116... Line -...
116 
	}
 - 
 
117 
 
 - 
 
118 
	static function getCaller($trace) {
 - 
 
119 
		foreach($trace as $v) if(strpos($v['file'], '/modules/') !== false) return $v;
 - 
 
120 
		return NULL;
 - 
 
121 
	}
 119 
	}
122 
 
 - 
 
123 
	public function envoyerRequete($url, $mode, Array $donnees = array()) {
 - 
 
124 
		// error_log("framework/envoyerRequete: $mode $url");
 - 
 
125 
 
 - 
 
126 
		// nous n'activons le wrapper que pour GET pour l'instant
 - 
 
127 
		// car l'utilisation de curl pour les autres modes pourrait
 - 
 
128 
		// vraisemblablement induire des comportements différents. (test-suite needed)
 - 
 
129 
		if(FALSE && function_exists('curl_init') && $mode == 'GET') {
 - 
 
130 
			return $this->envoyerCurlRequete($url, $mode, $donnees);
 - 
 
131 
		}
 120 
 
132 
 
 121 
	private function envoyerCurlRequete($url, $mode, Array $donnees = array()) {
133 
		$this->url = $url;
 122 
		$this->url = $url;
134 
		$contenu = false;
 123 
		$contenu = false;
135 
		if (! in_array($mode, $this->http_methodes)) {
 124 
		if (! in_array($mode, $this->http_methodes)) {
136 
			$e = "Le mode de requête '$mode' n'est pas accepté!";
 125 
			$e = "Le mode de requête '$mode' n'est pas accepté!";
137 
			trigger_error($e, E_USER_WARNING);
 126 
			trigger_error($e, E_USER_WARNING);
138 
		} else {
 127 
		} else {
139 
			if ($mode == 'GET') {
 128 
			if ($mode == 'GET') {
- 
 
 129 
				$this->traiterUrlParametres();
140 
				$this->traiterUrlParametres();
 130 
			}
- 
 
 131 
 
- 
 
 132 
			$ch = curl_init($this->url);
- 
 
 133 
			curl_setopt($ch, CURLOPT_HEADER, TRUE);
141 
			}
 134 
			curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
- 
 
 135 
			curl_setopt($ch, CURLOPT_FOLLOWLOCATION, 1);
142 
			$contexte = stream_context_create(array(
 136 
			if ($mode == 'POST') {
- 
 
 137 
				curl_setopt($ch, CURLOPT_POST, TRUE);
- 
 
 138 
			} elseif ($mode == 'PUT') {
143 
				'http' => array(
 139 
				curl_setopt($ch, CURLOPT_PUT, TRUE);
- 
 
 140 
			} elseif($mode == 'DELETE') {
- 
 
 141 
				curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');
- 
 
 142 
			}
- 
 
 143 
 
144 
      				'method' => $mode,
 144 
			$content = '';
145 
					'header' => "Content-type: application/x-www-form-urlencoded\r\n",
 145 
			if ($donnees) {
- 
 
 146 
				$content = http_build_query($donnees, null, self::HTTP_URL_REQUETE_SEPARATEUR);
- 
 
 147 
				curl_setopt($ch, CURLOPT_POSTFIELDS, $content);
- 
 
 148 
			}
- 
 
 149 
 
- 
 
 150 
			$flux = curl_exec($ch);
146 
      				'content' => http_build_query($donnees, null, self::HTTP_URL_REQUETE_SEPARATEUR))));
 151 
			curl_close($ch);
147 
			$flux = @fopen($this->url, 'r', false, $contexte);
 152 
 
- 
 
 153 
			if (!$flux) {
- 
 
 154 
				$this->reponse_entetes = $http_response_header;
148 
			if (!$flux) {
 155 
				$entetesFmt = print_r($this->analyserEntete(), true);
149 
				$this->reponse_entetes = $http_response_header;
 156 
				$msgTpl = "Echec requête (CURL) '%s' : %s\nParamètres requête : %s \nEntêtes réponse : %s \n";
150 
				trigger_error(sprintf("fail: %s \"%s\" (%s)", strtoupper($mode), $this->url, http_build_query($donnees, null, self::HTTP_URL_REQUETE_SEPARATEUR)),
 - 
 
151 
							  E_USER_WARNING);
 157 
				$msg = sprintf($msgTpl, strtoupper($mode), $this->url, $content, $entetesFmt);
- 
 
 158 
				trigger_error($msg, E_USER_WARNING);
- 
 
 159 
			} else {
152 
 
 160 
				// attention, CURLOPT_FOLLOWLOCATION amène le stream à contenir plusieurs section d'header HTTP successives
153 
			} else {
 161 
				$t = explode("\r\n\r\n", $flux);
154 
				// Informations sur les en-têtes et métadonnées du flux
 - 
 
155 
				$this->reponse_entetes = stream_get_meta_data($flux);
 162 
				$contenu = array_splice($t, -1);
156
163 
				$dernier_entete = array_splice($t, -1);
157 
				// Contenu actuel de $url
 164 
				$contenu = $contenu[0];
- 
 
 165 
				$dernier_entete = $dernier_entete[0];
158 
				$contenu = stream_get_contents($flux);
 166 
 
159
167 
				// XXX: mimic stream_get_meta_data() (ce qui n'est pas très propre, le code appelant ferait mieux de se mettre à jour)
160 
				fclose($flux);
 168 
				$this->reponse_entetes = array('wrapper_data' => explode("\r\n", $dernier_entete));
161 
			}
 169 
			}
162 
			$this->traiterEntete();
 170 
			$this->traiterEntete();
163 
		}
 171 
		}
164 
		$this->reinitialiser();
 172 
		$this->reinitialiser();
165 
		return $contenu;
 173 
		return $contenu;
166 
	}
 174 
	}
167
175 
 
168 
	private function traiterUrlParametres() {
 176 
	private function traiterUrlParametres() {
169 
		$parametres = array();
 177 
		$parametres = array();
170 
		if (count($this->parametres) > 0) {
 178 
		if (count($this->parametres) > 0) {
Line 175... Line 183...
175 
			}
 183 
			}
176 
			$url_parametres = implode(self::HTTP_URL_REQUETE_SEPARATEUR, $parametres);
 184 
			$url_parametres = implode(self::HTTP_URL_REQUETE_SEPARATEUR, $parametres);
177 
			$this->url = $this->url.'?'.$url_parametres;
 185 
			$this->url = $this->url.'?'.$url_parametres;
178 
		}
 186 
		}
179 
	}
 187 
	}
180
188 
 
181 
	private function traiterEntete() {
 189 
	private function traiterEntete() {
182 
		$infos = $this->analyserEntete();
 190 
		$infos = $this->analyserEntete();
183 
		$this->traiterEnteteDebogage($infos);
 191 
		$this->traiterEnteteDebogage($infos);
184 
	}
 192 
	}
185
193 
 
186 
	private function analyserEntete() {
 194 
	private function analyserEntete() {
187 
		$entetes = $this->reponse_entetes;
195 
		$entetes = $this->reponse_entetes;
188 
		$infos = array('date' => null, 'uri' => $this->url, 'debogages' => null);
 196 
		$infos = array('date' => null, 'uri' => $this->url, 'debogages' => null);
189
197 
 
190 
		if (isset($entetes['wrapper_data'])) {
 198 
		if (isset($entetes['wrapper_data'])) {
191 
			$entetes = $entetes['wrapper_data'];
 199 
			$entetes = $entetes['wrapper_data'];
192 
		}
 200 
		}
193 
		foreach ($entetes as $entete) {
 201 
		foreach ($entetes as $entete) {
194 
			if (preg_match('/^X_REST_DEBOGAGE_MESSAGES: (.+)$/', $entete, $match)) {
 202 
			if (preg_match('/^X_REST_DEBOGAGE_MESSAGES: (.+)$/', $entete, $match)) {
Line 198... Line 206...
198 
				$infos['date'] = $match[1];
 206 
				$infos['date'] = $match[1];
199 
			}
 207 
			}
200 
		}
 208 
		}
201 
		return $infos;
 209 
		return $infos;
202 
	}
 210 
	}
203
211 
 
204 
	private function traiterEnteteDebogage($entetes_analyses) {
 212 
	private function traiterEnteteDebogage($entetes) {
205 
		if (isset($entetes['debogages'])) {
 213 
		if (isset($entetes['debogages'])) {
206 
			$date = $entetes['date'];
 214 
			$date = $entetes['date'];
207 
			$uri = $entetes['uri'];
 215 
			$uri = $entetes['uri'];
208 
			$debogages = $entetes['debogages'];
 216 
			$debogages = $entetes['debogages'];
209 
			foreach ($debogages as $debogage) {
 217 
			foreach ($debogages as $debogage) {
210 
				$e = "DEBOGAGE : $date - $uri :\n$debogage";
 218 
				$e = "DEBOGAGE : $date - $uri :\n$debogage";
211 
				trigger_error($e, E_USER_NOTICE);
 219 
				trigger_error($e, E_USER_NOTICE);
212 
			}
 220 
			}
213 
		}
 221 
		}
214 
	}
 222 
	}
215
223 
 
216 
	private function reinitialiser() {
 224 
	private function reinitialiser() {
217 
		$this->nettoyerParametres();
 225 
		$this->nettoyerParametres();
218 
	}
 226 
	}
219 
}
 227 
}
220 

            228