Subversion Repositories Applications.framework

Rev

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

Rev 353 Rev 428
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 353 2011-08-01 16:02:32Z jpm $
 12 
* @version		$Id: RestClient.php 428 2013-06-28 13:12:36Z 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
- 
 
 69 
	public function envoyerCurlRequete($url, $mode, Array $donnees = array()) {
- 
 
 70 
		$this->url = $url;
- 
 
 71 
		$contenu = false;
- 
 
 72 
		if (! in_array($mode, $this->http_methodes)) {
- 
 
 73 
			$e = "Le mode de requête '$mode' n'est pas accepté!";
- 
 
 74 
			trigger_error($e, E_USER_WARNING);
- 
 
 75 
		} else {
- 
 
 76 
			if ($mode == 'GET') {
- 
 
 77 
				$this->traiterUrlParametres();
- 
 
 78 
			}
- 
 
 79 
 
- 
 
 80 
			$ch = curl_init($this->url);
- 
 
 81 
			curl_setopt($ch, CURLOPT_HEADER, TRUE);
- 
 
 82 
			curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
- 
 
 83 
 
- 
 
 84 
			if($mode == 'POST') curl_setopt($ch, CURLOPT_POST, TRUE);
- 
 
 85 
			elseif($mode == 'PUT') curl_setopt($ch, CURLOPT_PUT, TRUE);
- 
 
 86 
			elseif($mode == 'DELETE') curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "DELETE");
- 
 
 87 
 
- 
 
 88 
			if($donnees) curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($donnees, null, self::HTTP_URL_REQUETE_SEPARATEUR));
- 
 
 89 
 
- 
 
 90 
			// curl_setopt($ch, CURLOPT_COOKIE, "XDEBUG_PROFILE"); // debug
- 
 
 91 
			$flux = curl_exec($ch);
- 
 
 92 
			curl_close($ch);
- 
 
 93 
 
- 
 
 94 
			if (!$flux) {
- 
 
 95 
				$this->reponse_entetes = $http_response_header;
- 
 
 96 
				$e = "L'ouverture de l'url '{$this->url}' par la méthode HTTP '$mode' a échoué!";
- 
 
 97 
				trigger_error($e, E_USER_WARNING);
- 
 
 98 
			} else {
- 
 
 99 
				list($this->reponse_entetes, $contenu) = explode("\r\n\r\n", $flux, 2);
- 
 
 100 
				// 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));
- 
 
 102 
			}
- 
 
 103 
			$this->traiterEntete();
- 
 
 104 
		}
- 
 
 105 
		$this->reinitialiser();
- 
 
 106 
		return $contenu;
- 
 
 107 
	}
68
108 
 
- 
 
 109 
	public function envoyerRequete($url, $mode, Array $donnees = array()) {
- 
 
 110 
		// debug: error_log("$mode {$this->url}");
- 
 
 111 
 
- 
 
 112 
		// nous n'activons le wrapper que pour GET pour l'instant
- 
 
 113 
		// car l'utilisation de curl pour les autres modes pourrait
- 
 
 114 
		// vraisemblablement induire des comportements différents. (test-suite needed)
- 
 
 115 
		if(function_exists('curl_init') && $mode == 'GET') {
- 
 
 116 
			return $this->envoyerCurlRequete($url, $mode, $donnees);
- 
 
 117 
		}
69 
	public function envoyerRequete($url, $mode, Array $donnees = array()) {
 118 
 
70 
		$this->url = $url;
 119 
		$this->url = $url;
71 
		$contenu = false;
 120 
		$contenu = false;
72 
		if (! in_array($mode, $this->http_methodes)) {
 121 
		if (! in_array($mode, $this->http_methodes)) {
73 
			$e = "Le mode de requête '$mode' n'est pas accepté!";
 122 
			$e = "Le mode de requête '$mode' n'est pas accepté!";
74 
			trigger_error($e, E_USER_WARNING);
 123 
			trigger_error($e, E_USER_WARNING);
75 
		} else {
 124 
		} else {
76 
			if ($mode == 'GET') {
 125 
			if ($mode == 'GET') {
77 
				$this->traiterUrlParametres();
 126 
				$this->traiterUrlParametres();
78 
			}
 127 
			}
79 
			$contexte = stream_context_create(array(
 128 
			$contexte = stream_context_create(array(
80 
				'http' => array(
 129 
				'http' => array(
81 
      				'method' => $mode,
 130 
      				'method' => $mode,
82 
					'header' => "Content-type: application/x-www-form-urlencoded\r\n",
 131 
					'header' => "Content-type: application/x-www-form-urlencoded\r\n",
83 
      				'content' => http_build_query($donnees, null, self::HTTP_URL_REQUETE_SEPARATEUR))));
 132 
      				'content' => http_build_query($donnees, null, self::HTTP_URL_REQUETE_SEPARATEUR))));
84 
			$flux = @fopen($this->url, 'r', false, $contexte);
 133 
			$flux = @fopen($this->url, 'r', false, $contexte);
85 
			if (!$flux) {
 134 
			if (!$flux) {
86 
				$this->reponse_entetes = $http_response_header;
 135 
				$this->reponse_entetes = $http_response_header;
87 
				$e = "L'ouverture de l'url '{$this->url}' par la méthode HTTP '$mode' a échoué!";
 136 
				$e = "L'ouverture de l'url '{$this->url}' par la méthode HTTP '$mode' a échoué!";
88 
				trigger_error($e, E_USER_WARNING);
 137 
				trigger_error($e, E_USER_WARNING);
89 
			} else {
 138 
			} else {
90 
				// Informations sur les en-têtes et métadonnées du flux
 139 
				// Informations sur les en-têtes et métadonnées du flux
91 
				$this->reponse_entetes = stream_get_meta_data($flux);
 140 
				$this->reponse_entetes = stream_get_meta_data($flux);
92
141
93 
				// Contenu actuel de $url
 142 
				// Contenu actuel de $url
94 
				$contenu = stream_get_contents($flux);
 143 
				$contenu = stream_get_contents($flux);
95
144
96 
				fclose($flux);
 145 
				fclose($flux);
97 
			}
 146 
			}
98 
			$this->traiterEntete();
 147 
			$this->traiterEntete();
99 
		}
 148 
		}
100 
		$this->reinitialiser();
 149 
		$this->reinitialiser();
101 
		return $contenu;
 150 
		return $contenu;
102 
	}
 151 
	}
103
152
104 
	private function traiterUrlParametres() {
 153 
	private function traiterUrlParametres() {
105 
		$parametres = array();
 154 
		$parametres = array();
106 
		if (count($this->parametres) > 0) {
 155 
		if (count($this->parametres) > 0) {
107 
			foreach ($this->parametres as $cle => $valeur) {
 156 
			foreach ($this->parametres as $cle => $valeur) {
108 
				$cle = rawurlencode($cle);
 157 
				$cle = rawurlencode($cle);
109 
				$valeur = rawurlencode($valeur);
 158 
				$valeur = rawurlencode($valeur);
110 
				$parametres[] = $cle.self::HTTP_URL_REQUETE_CLE_VALEUR_SEPARATEUR.$valeur;
 159 
				$parametres[] = $cle.self::HTTP_URL_REQUETE_CLE_VALEUR_SEPARATEUR.$valeur;
111 
			}
 160 
			}
112 
			$url_parametres = implode(self::HTTP_URL_REQUETE_SEPARATEUR, $parametres);
 161 
			$url_parametres = implode(self::HTTP_URL_REQUETE_SEPARATEUR, $parametres);
113 
			$this->url = $this->url.'?'.$url_parametres;
 162 
			$this->url = $this->url.'?'.$url_parametres;
114 
		}
 163 
		}
115 
	}
 164 
	}
116
165
117 
	private function traiterEntete() {
 166 
	private function traiterEntete() {
118 
		$infos = $this->analyserEntete();
 167 
		$infos = $this->analyserEntete();
119 
		$this->traiterEnteteDebogage($infos);
 168 
		$this->traiterEnteteDebogage($infos);
120 
	}
 169 
	}
121
170
122 
	private function analyserEntete() {
 171 
	private function analyserEntete() {
123 
		$entetes = $this->reponse_entetes;
172 
		$entetes = $this->reponse_entetes;
124 
		$infos = array('date' => null, 'uri' => $this->url, 'debogages' => null);
 173 
		$infos = array('date' => null, 'uri' => $this->url, 'debogages' => null);
125
174
126 
		if (isset($entetes['wrapper_data'])) {
 175 
		if (isset($entetes['wrapper_data'])) {
127 
			$entetes = $entetes['wrapper_data'];
 176 
			$entetes = $entetes['wrapper_data'];
128 
		}
 177 
		}
129 
		foreach ($entetes as $entete) {
 178 
		foreach ($entetes as $entete) {
130 
			if (preg_match('/^X_REST_DEBOGAGE_MESSAGES: (.+)$/', $entete, $match)) {
 179 
			if (preg_match('/^X_REST_DEBOGAGE_MESSAGES: (.+)$/', $entete, $match)) {
131 
				$infos['debogages'] = json_decode($match[1]);
 180 
				$infos['debogages'] = json_decode($match[1]);
132 
			}
 181 
			}
133 
			if (preg_match('/^Date: .+ ([012][0-9]:[012345][0-9]:[012345][0-9]) .*$/', $entete, $match)) {
 182 
			if (preg_match('/^Date: .+ ([012][0-9]:[012345][0-9]:[012345][0-9]) .*$/', $entete, $match)) {
134 
				$infos['date'] = $match[1];
 183 
				$infos['date'] = $match[1];
135 
			}
 184 
			}
136 
		}
 185 
		}
137 
		return $infos;
 186 
		return $infos;
138 
	}
 187 
	}
139
188
140 
	private function traiterEnteteDebogage($entetes_analyses) {
 189 
	private function traiterEnteteDebogage($entetes_analyses) {
141 
		if (isset($entetes['debogages'])) {
 190 
		if (isset($entetes['debogages'])) {
142 
			$date = $entetes['date'];
 191 
			$date = $entetes['date'];
143 
			$uri = $entetes['uri'];
 192 
			$uri = $entetes['uri'];
144 
			$debogages = $entetes['debogages'];
 193 
			$debogages = $entetes['debogages'];
145 
			foreach ($debogages as $debogage) {
 194 
			foreach ($debogages as $debogage) {
146 
				$e = "DEBOGAGE : $date - $uri :\n$debogage";
 195 
				$e = "DEBOGAGE : $date - $uri :\n$debogage";
147 
				trigger_error($e, E_USER_NOTICE);
 196 
				trigger_error($e, E_USER_NOTICE);
148 
			}
 197 
			}
149 
		}
 198 
		}
150 
	}
 199 
	}
151
200
152 
	private function reinitialiser() {
 201 
	private function reinitialiser() {
153 
		$this->nettoyerParametres();
 202 
		$this->nettoyerParametres();
154 
	}
 203 
	}
155 
}
 204 
}