Subversion Repositories Applications.framework

Rev

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

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