Subversion Repositories Applications.framework

Rev

Rev 494 | Only display areas with differences | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 494 Rev 496
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
        private $tracer_ip_source = null;
-
 
22
        private $requete_headers = array();
21
 
23
        
-
 
24
        public function __construct() {
-
 
25
        //verifie si paramètre tracer_ip_source est sur TRUE dans config.ini
-
 
26
                    if (Config::existe('tracer_ip_source')) { 
-
 
27
                        //lire la config
-
 
28
                        $valeur = Config::get('tracer_ip_source');
-
 
29
                        //si oui, active X-Forwarded-For                      
-
 
30
                        $this->setTracerIPSource($valeur);
-
 
31
            }
-
 
32
            //pas de else, si pas dans la config $tracer_ip_source sera NULL/FALSE
-
 
33
         }
22
	//+------------------------------------------------------------------------------------------------------+
34
	//+------------------------------------------------------------------------------------------------------+
23
	// ACCESSEURS
35
	// ACCESSEURS
24
 
36
 
25
	public function getReponseEntetes() {
37
	public function getReponseEntetes() {
26
		return $this->reponse_entetes;
38
		return $this->reponse_entetes;
27
	}
39
	}
28
 
40
 
29
	public function getParametre($cle) {
41
	public function getParametre($cle) {
30
		$valeur = (isset($this->parametres[$cle])) ? $this->parametres[$cle] : null;
42
		$valeur = (isset($this->parametres[$cle])) ? $this->parametres[$cle] : null;
31
		return $valeur;
43
		return $valeur;
32
	}
44
	}
33
 
45
 
34
	public function ajouterParametre($cle, $valeur) {
46
	public function ajouterParametre($cle, $valeur) {
35
		$this->parametres[$cle] = $valeur;
47
		$this->parametres[$cle] = $valeur;
36
	}
48
	}
37
 
49
 
38
	public function supprimerParametre($cle) {
50
	public function supprimerParametre($cle) {
39
		unset($this->parametres[$cle]);
51
		unset($this->parametres[$cle]);
40
	}
52
	}
41
 
53
 
42
	public function nettoyerParametres() {
54
	public function nettoyerParametres() {
43
		$this->parametres = null;
55
		$this->parametres = null;
44
	}
56
	}
45
 
57
        
-
 
58
        public function setTracerIPSource($valeur) {
-
 
59
                $this->tracer_ip_source = $valeur;
-
 
60
        }
-
 
61
        
46
	//+------------------------------------------------------------------------------------------------------+
62
	//+------------------------------------------------------------------------------------------------------+
47
	// MÉTHODES
63
	// MÉTHODES
48
 
64
 
49
	public function consulter($url) {
65
	public function consulter($url) {
50
		$retour = $this->envoyerRequete($url, 'GET');
66
		$retour = $this->envoyerRequete($url, 'GET');
51
		return $retour;
67
		return $retour;
52
	}
68
	}
53
 
69
 
54
	public function ajouter($url, Array $donnees) {
70
	public function ajouter($url, Array $donnees) {
55
		$retour = $this->envoyerRequete($url, 'PUT', $donnees);
71
		$retour = $this->envoyerRequete($url, 'PUT', $donnees);
56
		return $retour;
72
		return $retour;
57
	}
73
	}
58
 
74
 
59
	public function modifier($url, Array $donnees) {
75
	public function modifier($url, Array $donnees) {
60
		$retour = $this->envoyerRequete($url, 'POST', $donnees);
76
		$retour = $this->envoyerRequete($url, 'POST', $donnees);
61
		return $retour;
77
		return $retour;
62
	}
78
	}
63
 
79
 
64
	public function supprimer($url) {
80
	public function supprimer($url) {
65
		$retour = $this->envoyerRequete($url, 'DELETE');
81
		$retour = $this->envoyerRequete($url, 'DELETE');
66
		return $retour;
82
		return $retour;
67
	}
83
	}
68
 
84
 
69
	public function envoyerRequete($url, $mode, Array $donnees = array()) {
85
	public function envoyerRequete($url, $mode, Array $donnees = array()) {
70
		$contenu = false;
86
		$contenu = false;
71
		if (FALSE && function_exists('curl_init') && $mode == 'GET') {
87
		if (FALSE && function_exists('curl_init') && $mode == 'GET') {
72
			// nous n'activons le wrapper que pour GET pour l'instant
88
			// nous n'activons le wrapper que pour GET pour l'instant
73
			// car l'utilisation de curl pour les autres modes pourrait
89
			// car l'utilisation de curl pour les autres modes pourrait
74
			// vraisemblablement induire des comportements différents. (test-suite needed)
90
			// vraisemblablement induire des comportements différents. (test-suite needed)
75
			$contenu = $this->envoyerCurlRequete($url, $mode, $donnees);
91
			$contenu = $this->envoyerCurlRequete($url, $mode, $donnees);
76
		} else {
92
		} else {
77
			$contenu = $this->envoyerStreamRequete($url, $mode, $donnees);
93
                        $contenu = $this->envoyerStreamRequete($url, $mode, $donnees);
78
		}
94
		}
79
		return $contenu;
95
		return $contenu;
80
	}
96
	}
81
 
97
 
82
	private function envoyerStreamRequete($url, $mode, Array $donnees = array()) {
98
	private function envoyerStreamRequete($url, $mode, Array $donnees = array()) {
83
		$this->url = $url;
99
                $this->url = $url;
84
		$contenu = false;
100
		$contenu = false;
85
		if (! in_array($mode, $this->http_methodes)) {
101
		if (! in_array($mode, $this->http_methodes)) {
86
			$e = "Le mode de requête '$mode' n'est pas accepté!";
102
			$e = "Le mode de requête '$mode' n'est pas accepté!";
87
			trigger_error($e, E_USER_WARNING);
103
			trigger_error($e, E_USER_WARNING);
88
		} else {
104
		} else {
89
			if ($mode == 'GET') {
105
                    if ($mode == 'GET') {
90
				$this->traiterUrlParametres();
106
				$this->traiterUrlParametres();
91
			}
107
			}
92
			$content = http_build_query($donnees, null, self::HTTP_URL_REQUETE_SEPARATEUR);
108
                    $content = http_build_query($donnees, null, self::HTTP_URL_REQUETE_SEPARATEUR);
93
			$contexte = stream_context_create(array(
109
                    $this->requete_headers['http'] = array();
-
 
110
                    $this->requete_headers['http']['method'] = $mode;
-
 
111
                    $this->requete_headers['http']['header'] = "Content-type: application/x-www-form-urlencoded\r\n";
94
				'http' => array(
112
                    if ($this->tracer_ip_source) {
-
 
113
                        // ajoute  X-Forwarded-For au header
-
 
114
                        $this->requete_headers['http']['header'] .= "X-Forwarded-For: {$_SERVER['REMOTE_ADDR']}, {$_SERVER['SERVER_ADDR']}\r\n";
95
      				'method' => $mode,
115
                    }
-
 
116
                    $this->requete_headers['http']['header'] .= "User-Agent: {$_SERVER['HTTP_USER_AGENT']} ApiTela/";
-
 
117
                    $this->requete_headers['http']['header'] .= Framework::getInfoAppli('nom');
96
					'header' => "Content-type: application/x-www-form-urlencoded\r\n",
118
                    $this->requete_headers['http']['header'] .= "\r\n";
97
      				'content' => $content)));
119
                    $this->requete_headers['http']['content'] = $content;			
-
 
120
			$contexte = stream_context_create($this->requete_headers);
98
			$flux = @fopen($this->url, 'r', false, $contexte);
121
			$flux = @fopen($this->url, 'r', false, $contexte);                        
99
			if (!$flux) {
122
			if (!$flux) {
100
				$entetesFmt = print_r($this->analyserEntete(), true);
123
				$entetesFmt = print_r($this->analyserEntete(), true);
101
				$e = "Echec requête '$mode' : {$this->url}\n".
124
				$e = "Echec requête '$mode' : {$this->url}\n".
102
					"Paramètres requête : $content \n".
125
					"Paramètres requête : $content \n".
103
					"Entêtes réponse : $entetesFmt \n";
126
					"Entêtes réponse : $entetesFmt \n";
104
				trigger_error($e, E_USER_WARNING);
127
				trigger_error($e, E_USER_WARNING);
105
			} else {
128
			} else {
106
				// Informations sur les en-têtes et métadonnées du flux
129
				// Informations sur les en-têtes et métadonnées du flux
107
				$this->reponse_entetes = stream_get_meta_data($flux);
130
				$this->reponse_entetes = stream_get_meta_data($flux);
108
 
131
 
109
				// Contenu actuel de $url
132
				// Contenu actuel de $url
110
				$contenu = stream_get_contents($flux);
133
				$contenu = stream_get_contents($flux);
111
 
134
 
112
				fclose($flux);
135
				fclose($flux);
113
			}
136
			}
114
			$this->traiterEntete();
137
			$this->traiterEntete();
115
		}
138
		}
116
		$this->reinitialiser();
139
		$this->reinitialiser();
117
		return $contenu;
140
		return $contenu;
118
	}
141
	}
119
 
142
 
120
	private function envoyerCurlRequete($url, $mode, Array $donnees = array()) {
143
	private function envoyerCurlRequete($url, $mode, Array $donnees = array()) {
121
		$this->url = $url;
144
		$this->url = $url;
122
		$contenu = false;
145
		$contenu = false;
123
		if (! in_array($mode, $this->http_methodes)) {
146
		if (! in_array($mode, $this->http_methodes)) {
124
			$e = "Le mode de requête '$mode' n'est pas accepté!";
147
			$e = "Le mode de requête '$mode' n'est pas accepté!";
125
			trigger_error($e, E_USER_WARNING);
148
			trigger_error($e, E_USER_WARNING);
126
		} else {
149
		} else {
127
			if ($mode == 'GET') {
150
			if ($mode == 'GET') {
128
				$this->traiterUrlParametres();
151
				$this->traiterUrlParametres();
129
			}
152
			}
130
 
153
 
131
			$ch = curl_init($this->url);
154
			$ch = curl_init($this->url);
132
			curl_setopt($ch, CURLOPT_HEADER, TRUE);
155
			curl_setopt($ch, CURLOPT_HEADER, TRUE);
133
			curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
156
			curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
134
			curl_setopt($ch, CURLOPT_FOLLOWLOCATION, 1);
157
			curl_setopt($ch, CURLOPT_FOLLOWLOCATION, 1);
135
			if ($mode == 'POST') {
158
			if ($mode == 'POST') {
136
				curl_setopt($ch, CURLOPT_POST, TRUE);
159
				curl_setopt($ch, CURLOPT_POST, TRUE);
137
			} elseif ($mode == 'PUT') {
160
			} elseif ($mode == 'PUT') {
138
				curl_setopt($ch, CURLOPT_PUT, TRUE);
161
				curl_setopt($ch, CURLOPT_PUT, TRUE);
139
			} elseif($mode == 'DELETE') {
162
			} elseif($mode == 'DELETE') {
140
				curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');
163
				curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');
141
			}
164
			}
142
 
165
 
143
			$content = '';
166
			$content = '';
144
			if ($donnees) {
167
			if ($donnees) {
145
				$content = http_build_query($donnees, null, self::HTTP_URL_REQUETE_SEPARATEUR);
168
				$content = http_build_query($donnees, null, self::HTTP_URL_REQUETE_SEPARATEUR);
146
				curl_setopt($ch, CURLOPT_POSTFIELDS, $content);
169
				curl_setopt($ch, CURLOPT_POSTFIELDS, $content);
147
			}
170
			}
148
 
171
 
149
			$flux = curl_exec($ch);
172
			$flux = curl_exec($ch);
150
			curl_close($ch);
173
			curl_close($ch);
151
 
174
 
152
			if (!$flux) {
175
			if (!$flux) {
153
				$this->reponse_entetes = $http_response_header;
176
				$this->reponse_entetes = $http_response_header;
154
				$entetesFmt = print_r($this->analyserEntete(), true);
177
				$entetesFmt = print_r($this->analyserEntete(), true);
155
				$msgTpl = "Echec requête (CURL) '%s' : %s\nParamètres requête : %s \nEntêtes réponse : %s \n";
178
				$msgTpl = "Echec requête (CURL) '%s' : %s\nParamètres requête : %s \nEntêtes réponse : %s \n";
156
				$msg = sprintf($msgTpl, strtoupper($mode), $this->url, $content, $entetesFmt);
179
				$msg = sprintf($msgTpl, strtoupper($mode), $this->url, $content, $entetesFmt);
157
				trigger_error($msg, E_USER_WARNING);
180
				trigger_error($msg, E_USER_WARNING);
158
			} else {
181
			} else {
159
				// attention, CURLOPT_FOLLOWLOCATION amène le stream à contenir plusieurs section d'header HTTP successives
182
				// attention, CURLOPT_FOLLOWLOCATION amène le stream à contenir plusieurs section d'header HTTP successives
160
				$t = explode("\r\n\r\n", $flux);
183
				$t = explode("\r\n\r\n", $flux);
161
				$contenu = array_splice($t, -1);
184
				$contenu = array_splice($t, -1);
162
				$dernier_entete = array_splice($t, -1);
185
				$dernier_entete = array_splice($t, -1);
163
				$contenu = $contenu[0];
186
				$contenu = $contenu[0];
164
				$dernier_entete = $dernier_entete[0];
187
				$dernier_entete = $dernier_entete[0];
165
 
188
 
166
				// XXX: mimic stream_get_meta_data() (ce qui n'est pas très propre, le code appelant ferait mieux de se mettre à jour)
189
				// XXX: mimic stream_get_meta_data() (ce qui n'est pas très propre, le code appelant ferait mieux de se mettre à jour)
167
				$this->reponse_entetes = array('wrapper_data' => explode("\r\n", $dernier_entete));
190
				$this->reponse_entetes = array('wrapper_data' => explode("\r\n", $dernier_entete));
168
			}
191
			}
169
			$this->traiterEntete();
192
			$this->traiterEntete();
170
		}
193
		}
171
		$this->reinitialiser();
194
		$this->reinitialiser();
172
		return $contenu;
195
		return $contenu;
173
	}
196
	}
174
 
197
 
175
	private function traiterUrlParametres() {
198
	private function traiterUrlParametres() {
176
		$parametres = array();
199
		$parametres = array();
177
		if (count($this->parametres) > 0) {
200
		if (count($this->parametres) > 0) {
178
			foreach ($this->parametres as $cle => $valeur) {
201
			foreach ($this->parametres as $cle => $valeur) {
179
				$cle = rawurlencode($cle);
202
				$cle = rawurlencode($cle);
180
				$valeur = rawurlencode($valeur);
203
				$valeur = rawurlencode($valeur);
181
				$parametres[] = $cle.self::HTTP_URL_REQUETE_CLE_VALEUR_SEPARATEUR.$valeur;
204
				$parametres[] = $cle.self::HTTP_URL_REQUETE_CLE_VALEUR_SEPARATEUR.$valeur;
182
			}
205
			}
183
			$url_parametres = implode(self::HTTP_URL_REQUETE_SEPARATEUR, $parametres);
206
			$url_parametres = implode(self::HTTP_URL_REQUETE_SEPARATEUR, $parametres);
184
			$this->url = $this->url.'?'.$url_parametres;
207
			$this->url = $this->url.'?'.$url_parametres;
185
		}
208
		}
186
	}
209
	}
187
 
210
 
188
	private function traiterEntete() {
211
	private function traiterEntete() {
189
		$infos = $this->analyserEntete();
212
		$infos = $this->analyserEntete();
190
		$this->traiterEnteteDebogage($infos);
213
		$this->traiterEnteteDebogage($infos);
191
	}
214
	}
192
 
215
 
193
	private function analyserEntete() {
216
	private function analyserEntete() {
194
		$entetes = $this->reponse_entetes;
217
		$entetes = $this->reponse_entetes;
195
		$infos = array('date' => null, 'uri' => $this->url, 'debogages' => null);
218
		$infos = array('date' => null, 'uri' => $this->url, 'debogages' => null);
196
 
219
 
197
		if (isset($entetes['wrapper_data'])) {
220
		if (isset($entetes['wrapper_data'])) {
198
			$entetes = $entetes['wrapper_data'];
221
			$entetes = $entetes['wrapper_data'];
199
		}
222
		}
200
		foreach ($entetes as $entete) {
223
		foreach ($entetes as $entete) {
201
			if (preg_match('/^X_REST_DEBOGAGE_MESSAGES: (.+)$/', $entete, $match)) {
224
			if (preg_match('/^X_REST_DEBOGAGE_MESSAGES: (.+)$/', $entete, $match)) {
202
				$infos['debogages'] = json_decode($match[1]);
225
				$infos['debogages'] = json_decode($match[1]);
203
			}
226
			}
204
			if (preg_match('/^Date: .+ ([012][0-9]:[012345][0-9]:[012345][0-9]) .*$/', $entete, $match)) {
227
			if (preg_match('/^Date: .+ ([012][0-9]:[012345][0-9]:[012345][0-9]) .*$/', $entete, $match)) {
205
				$infos['date'] = $match[1];
228
				$infos['date'] = $match[1];
206
			}
229
			}
207
		}
230
		}
208
		return $infos;
231
		return $infos;
209
	}
232
	}
210
 
233
 
211
	private function traiterEnteteDebogage($entetes) {
234
	private function traiterEnteteDebogage($entetes) {
212
		if (isset($entetes['debogages'])) {
235
		if (isset($entetes['debogages'])) {
213
			$date = $entetes['date'];
236
			$date = $entetes['date'];
214
			$uri = $entetes['uri'];
237
			$uri = $entetes['uri'];
215
			$debogages = $entetes['debogages'];
238
			$debogages = $entetes['debogages'];
216
			foreach ($debogages as $debogage) {
239
			foreach ($debogages as $debogage) {
217
				$e = "DEBOGAGE : $date - $uri :\n$debogage";
240
				$e = "DEBOGAGE : $date - $uri :\n$debogage";
218
				trigger_error($e, E_USER_NOTICE);
241
				trigger_error($e, E_USER_NOTICE);
219
			}
242
			}
220
		}
243
		}
221
	}
244
	}
222
 
245
 
223
	private function reinitialiser() {
246
	private function reinitialiser() {
224
		$this->nettoyerParametres();
247
		$this->nettoyerParametres();
225
	}
248
	}
226
}
249
}