Subversion Repositories Applications.framework

Rev

Rev 428 | Rev 439 | Go to most recent revision | Only display areas with differences | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

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