Subversion Repositories Applications.annuaire

Rev

Rev 437 | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
69 aurelien 1
<?php
2
/**
3
 * Classe mère abstraite contenant les méthodes génériques des services.
4
 * Encodage en entrée : utf8
5
 * Encodage en sortie : utf8
6
 *
7
 * @author Jean-Pascal MILCENT <jpm@tela-botanica.org>
8
 * @license GPL v3 <http://www.gnu.org/licenses/gpl.txt>
9
 * @license CECILL v2 <http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt>
10
 * @version $Id$
11
 * @copyright 2009
12
 */
13
abstract class JRestService {
14
 
15
	public $config;
16
	protected $bdd;
331 jpm 17
	protected $ressources;
69 aurelien 18
	protected $log = array();
19
	protected $messages = array();
20
	protected $debug = array();
21
	protected $distinct = false;
22
	protected $orderby = null;
23
	protected $formatRetour = 'objet';
24
	protected $start = 0;
25
	protected $limit = 150;
26
 
27
	public function __construct($config, $demarrer_session = true) {
28
		// Tableau contenant la config de Jrest
29
		$this->config = $config;
30
 
31
		// Connection à la base de données
32
		$this->bdd = $this->connecterPDO($this->config, 'appli');
33
 
34
		// Nettoyage du $_GET (sécurité)
35
		if (isset($_GET)) {
36
			$get_params = array('orderby', 'distinct', 'start', 'limit', 'formatRetour');
37
			foreach ($get_params as $get) {
38
				$verifier = array('NULL', "\n", "\r", "\\", "'", '"', "\x00", "\x1a", ';');
39
				$_GET[$get] = str_replace($verifier, '', $_GET[$get]);
40
				if (isset($_GET[$get]) && $_GET[$get] != '') {
41
					$this->$get = $_GET[$get];
42
				} else {
43
					$_GET[$get] = null;
44
				}
45
			}
46
		}
47
	}
48
 
49
	/**
50
	 * Méthode appelée quand aucun paramètre n'est passé dans l'url et avec une requête de type GET.
51
	 */
52
	public function getRessource() {
53
		$this->getElement(array());
54
	}
55
 
331 jpm 56
	//+----------------------------------------------------------------------------------------------------------------+
57
	// GESTION de l'ENVOIE au NAVIGATEUR
58
 
59
	protected function envoyerJson($donnees, $encodage = 'utf-8') {
60
		$contenu = json_encode($donnees);
61
		$this->envoyer($contenu, 'application/json', $encodage, false);
62
	}
390 jpm 63
 
331 jpm 64
	protected function envoyerJsonVar($variable, $donnees = null, $encodage = 'utf-8') {
65
		$contenu = "var $variable = ".json_encode($donnees);
66
		$this->envoyer($contenu, 'text/html', $encodage, false);
67
	}
390 jpm 68
 
331 jpm 69
	protected function envoyerJsonp($donnees = null, $encodage = 'utf-8') {
70
		$contenu = $_GET['callback'].'('.json_encode($donnees).');';
71
		$this->envoyer($contenu, 'text/html', $encodage, false);
72
	}
390 jpm 73
 
331 jpm 74
	protected function envoyerTxt($donnees, $encodage = 'utf-8') {
75
		$this->envoyer($contenu, 'text/html', $encodage, false);
76
	}
77
 
69 aurelien 78
	protected function envoyer($donnees = null, $mime = 'text/html', $encodage = 'utf-8', $json = true) {
79
		// Traitements des messages d'erreurs et données
80
		if (count($this->messages) != 0) {
81
			header('HTTP/1.1 500 Internal Server Error');
82
			$mime = 'text/html';
83
			$encodage = 'utf-8';
84
			$json = true;
85
			$sortie = $this->messages;
86
		} else {
87
			$sortie = $donnees;
88
			if (is_null($donnees)) {
89
				$sortie = 'OK';
90
			}
91
		}
92
 
93
		// Gestion de l'envoie du déboguage
94
		$this->envoyerDebogage();
95
 
96
		// Encodage au format et JSON et envoie sur la sortie standard
97
		$contenu = $json ? json_encode($sortie) : $sortie;
98
		$this->envoyerContenu($encodage, $mime, $contenu);
99
	}
100
 
331 jpm 101
	private function envoyerDebogage() {
69 aurelien 102
		if (!is_array($this->debug)) {
103
			$this->debug[] = $this->debug;
104
		}
105
		if (count($this->debug) != 0) {
106
			foreach ($this->debug as $cle => $val) {
107
				if (is_array($val)) {
108
					$this->debug[$cle] = print_r($val, true);
109
				}
110
			}
111
			header('X-DebugJrest-Data:'.json_encode($this->debug));
112
		}
113
	}
114
 
331 jpm 115
	private function envoyerContenu($encodage, $mime, $contenu) {
116
		if (!is_null($mime) && !is_null($encodage)) {
117
			header("Content-Type: $mime; charset=$encodage");
118
		} else if (!is_null($mime) && is_null($encodage)) {
119
			header("Content-Type: $mime");
120
		}
69 aurelien 121
		print $contenu;
122
	}
390 jpm 123
 
331 jpm 124
	private function envoyerAuth($message_accueil, $message_echec) {
125
		header('HTTP/1.0 401 Unauthorized');
126
		header('WWW-Authenticate: Basic realm="'.mb_convert_encoding($message_accueil, 'ISO-8859-1', 'UTF-8').'"');
127
		header('Content-type: text/plain; charset=UTF-8');
128
		print $message_echec;
129
		exit(0);
130
	}
390 jpm 131
 
450 jpm 132
	protected function envoyerMessageErreur($msg, $code) {
133
		$textHttp = $this->getCodeHttpText($code);
134
		header("HTTP/1.0 $code $textHttp");
135
		header("Content-Type: text/plain; charset=utf-8");
136
		die($msg);
137
	}
138
 
139
	private function getCodeHttpText($code) {
140
		$text = '';
141
		switch ($code) {
142
			case 100: $text = 'Continue'; break;
143
			case 101: $text = 'Switching Protocols'; break;
144
			case 200: $text = 'OK'; break;
145
			case 201: $text = 'Created'; break;
146
			case 202: $text = 'Accepted'; break;
147
			case 203: $text = 'Non-Authoritative Information'; break;
148
			case 204: $text = 'No Content'; break;
149
			case 205: $text = 'Reset Content'; break;
150
			case 206: $text = 'Partial Content'; break;
151
			case 300: $text = 'Multiple Choices'; break;
152
			case 301: $text = 'Moved Permanently'; break;
153
			case 302: $text = 'Moved Temporarily'; break;
154
			case 303: $text = 'See Other'; break;
155
			case 304: $text = 'Not Modified'; break;
156
			case 305: $text = 'Use Proxy'; break;
157
			case 400: $text = 'Bad Request'; break;
158
			case 401: $text = 'Unauthorized'; break;
159
			case 402: $text = 'Payment Required'; break;
160
			case 403: $text = 'Forbidden'; break;
161
			case 404: $text = 'Not Found'; break;
162
			case 405: $text = 'Method Not Allowed'; break;
163
			case 406: $text = 'Not Acceptable'; break;
164
			case 407: $text = 'Proxy Authentication Required'; break;
165
			case 408: $text = 'Request Time-out'; break;
166
			case 409: $text = 'Conflict'; break;
167
			case 410: $text = 'Gone'; break;
168
			case 411: $text = 'Length Required'; break;
169
			case 412: $text = 'Precondition Failed'; break;
170
			case 413: $text = 'Request Entity Too Large'; break;
171
			case 414: $text = 'Request-URI Too Large'; break;
172
			case 415: $text = 'Unsupported Media Type'; break;
173
			case 500: $text = 'Internal Server Error'; break;
174
			case 501: $text = 'Not Implemented'; break;
175
			case 502: $text = 'Bad Gateway'; break;
176
			case 503: $text = 'Service Unavailable'; break;
177
			case 504: $text = 'Gateway Time-out'; break;
178
			case 505: $text = 'HTTP Version not supported'; break;
179
			default:
180
				exit('Unknown http status code "' . htmlentities($code) . '"');
181
			break;
182
		}
183
		return $text;
184
	}
185
 
331 jpm 186
	//+----------------------------------------------------------------------------------------------------------------+
187
	// GESTION de la BASE de DONNÉES
390 jpm 188
 
69 aurelien 189
	private function connecterPDO($config, $base = 'database') {
390 jpm 190
  		$cfg = $config[$base];
450 jpm 191
		// ATTENTION : la connexin à la bdd peut échouer si l'host vaut localhost. Utiliser 127.0.0.1 à la place.
69 aurelien 192
		$dsn = $cfg['phptype'].':dbname='.$cfg['database'].';host='.$cfg['hostspec'];
193
		try {
450 jpm 194
		// Création de la connexion en UTF-8 à la BDD
390 jpm 195
			$PDO = new PDO($dsn, $cfg['username'], $cfg['password'], array(PDO::MYSQL_ATTR_INIT_COMMAND => "SET NAMES 'UTF8'"));
69 aurelien 196
		} catch (PDOException $e) {
450 jpm 197
			echo 'La connexion à la base de donnée via PDO a échouée : ' .$dsn. $e->getMessage();
69 aurelien 198
		}
199
		// Affiche les erreurs détectées par PDO (sinon mode silencieux => aucune erreur affiché)
200
		$PDO->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
450 jpm 201
		return $PDO;
69 aurelien 202
	}
203
 
204
	protected function getTxt($id) {
205
		$sortie = '';
206
		switch ($id) {
207
			case 'sql_erreur' : $sortie = 'Requête echec. Fichier : "%s". Ligne : "%s". Message : %s'; break;
208
			default : $sortie = $id;
209
		}
210
		return $sortie;
211
	}
212
 
331 jpm 213
	//+----------------------------------------------------------------------------------------------------------------+
214
	// TRAITEMENT des URLs et des PARAMÊTRES
390 jpm 215
 
331 jpm 216
	protected function traiterNomMethodeGet($nom) {
217
		$methode = 'get';
218
		$methode .= str_replace(' ', '', ucwords(str_replace('-', ' ', strtolower($nom))));
219
		return $methode;
220
	}
390 jpm 221
 
347 jpm 222
	protected function traiterNomMethodePost($nom) {
223
		$methode = 'update';
224
		$methode .= str_replace(' ', '', ucwords(str_replace('-', ' ', strtolower($nom))));
225
		return $methode;
226
	}
390 jpm 227
 
430 aurelien 228
	protected function traiterNomMethodePut($nom) {
229
		$methode = 'create';
230
		$methode .= str_replace(' ', '', ucwords(str_replace('-', ' ', strtolower($nom))));
231
		return $methode;
394 jpm 232
	}
233
 
69 aurelien 234
	protected function traiterParametresUrl($params_attendu, $params, $pourBDD = true) {
235
		$sortie = array();
236
		foreach ($params_attendu as $num => $nom) {
237
			if (isset($params[$num]) && $params[$num] != '*') {
238
				if ($pourBDD) {
239
					$params[$num] = $this->bdd->quote($params[$num]);
240
				}
241
				$sortie[$nom] = $params[$num];
242
			}
243
		}
244
		return $sortie;
245
	}
246
 
247
	protected function traiterParametresPost($params) {
248
		$sortie = array();
249
		foreach ($params as $cle => $valeur) {
250
			$sortie[$cle] = $this->bdd->quote($valeur);
251
		}
252
		return $sortie;
253
	}
254
 
331 jpm 255
	//+----------------------------------------------------------------------------------------------------------------+
256
	// GESTION DE L'IDENTIFICATION
390 jpm 257
 
450 jpm 258
	public function controlerIpAutorisees() {
259
		$ipsAutorisees = $this->config['jrest_admin']['ip_autorisees'];
260
 
261
		$remoteIp = filter_input(INPUT_SERVER, 'REMOTE_ADDR', FILTER_VALIDATE_IP);
262
		$serverIp = filter_input(INPUT_SERVER, 'SERVER_ADDR', FILTER_VALIDATE_IP);
263
		if (in_array($remoteIp, $ipsAutorisees) == false) {
264
			if ($remoteIp != $serverIp) {// ATTENTION : maintenir ce test à l'intérieur du précédent
265
				$message = "Accès interdit. \n".
266
					"Vous n'êtes pas autorisé à accéder à ce service depuis '$remoteIp' !\n";
267
				$this->envoyerMessageErreur($message, 401);
268
			}
269
		}
270
		return true;
271
	}
272
 
430 aurelien 273
	protected function getIdentification(&$params) {
274
		// Initialisation des variables
275
		$utilisateur = array(0, session_id());
276
 
277
		// L'id utilisateur est soit passé par le POST soit dans l'url
278
		if (is_array($params) && isset($params['cmhl_ce_modifier_par'])) {
279
		   	$utilisateur[0] = $params['cmhl_ce_modifier_par'];
280
			unset($params['cmhl_ce_modifier_par']);
281
		} else if (is_string($params)) {
282
			$utilisateur[0] = $params;
283
		}
284
 
285
		return $utilisateur;
286
	}
287
 
288
	protected function etreAutorise($id_utilisateur) {
289
		$autorisation = false;
290
		if (($_SESSION['coel_utilisateur'] != '') && $_SESSION['coel_utilisateur']['id'] != $id_utilisateur) {
291
			$this->messages[] = 'Accès interdit.';
292
		} else if ($_SESSION['coel_utilisateur'] == '') {
293
			$this->messages[] = 'Veuillez vous identifiez pour accéder à cette fonction.';
294
		} else {
295
			$autorisation = true;
296
		}
297
		return $autorisation;
298
	}
299
 
300
	private function gererIdentificationPermanente() {
301
		// Pour maintenir l'utilisateur tjrs réellement identifié nous sommes obligé de recréer une SESSION et de le recharger depuis la bdd
302
		if ($this->getUtilisateur() == ''
303
				&& isset($_COOKIE['coel_login'])
304
				&& ($utilisateur = $this->chargerUtilisateur($_COOKIE['coel_login'], $_COOKIE['coel_mot_de_passe']))) {
305
			$this->setUtilisateur($utilisateur, $_COOKIE['coel_permanence']);
306
		}
307
	}
308
 
309
	protected function getUtilisateur() {
310
		return (isset($_SESSION['coel_utilisateur']) ? $_SESSION['coel_utilisateur'] : '');
311
	}
312
 
331 jpm 313
	protected function authentifier() {
314
		if (!isset($_SERVER['PHP_AUTH_USER'])) {
315
			header('WWW-Authenticate: Basic realm="www.tela-botanica.org"');
316
			header('HTTP/1.0 401 Unauthorized');
317
			header('Content-type: text/html; charset=UTF-8');
318
			echo 'Accès interdit';
319
			exit;
320
		} else {
394 jpm 321
			if ($this->verifierAcces()) {
331 jpm 322
				return ;
323
			} else {
324
				header('WWW-Authenticate: Basic realm="www.tela-botanica.org"');
325
				header('HTTP/1.0 401 Unauthorized');
326
				header('Content-type: text/html; charset=UTF-8');
327
				echo 'Accès interdit';
328
				exit ;
329
			}
330
		}
331
	}
69 aurelien 332
 
394 jpm 333
	protected function verifierAcces($id = null, $mdp = null) {
334
		$id = is_null($id) ? $_SERVER['PHP_AUTH_USER'] : $id;
335
		$mdp = is_null($mdp) ? $_SERVER['PHP_AUTH_PW'] : $mdp;
336
 
337
		$requete = 'SELECT '.$this->config['database_ident']['ann_id'].' AS courriel '.
331 jpm 338
			'FROM '.$this->config['database_ident']['database'].'.'.$this->config['database_ident']['annuaire'].' '.
339
			'WHERE '.$this->config['database_ident']['ann_id'].' = '.$this->bdd->quote($id).' '.
394 jpm 340
			'	AND '.$this->config['database_ident']['ann_pwd'].' = '.$this->config['database_ident']['pass_crypt_funct'].'('.$this->bdd->quote($mdp).')' ;
341
		$resultat = $this->bdd->query($requete)->fetch();
390 jpm 342
 
394 jpm 343
		$identifie = false;
344
		if (isset($resultat['courriel'])) {
345
			$identifie = true;
331 jpm 346
		}
394 jpm 347
		return $identifie;
348
	}
331 jpm 349
 
396 jpm 350
	protected function creerCookiePersistant($duree = null, $id = null, $mdp = null) {
430 aurelien 351
		$id = is_null($id) ? $_SERVER['PHP_AUTH_USER'] : $id;
394 jpm 352
		$mdp = is_null($mdp) ? $_SERVER['PHP_AUTH_PW'] : $mdp;
396 jpm 353
		$duree = (int) is_null($duree) ? time()+3600*24*30 : $duree;
331 jpm 354
 
394 jpm 355
		$nomCookie = $this->config['database_ident']['nom_cookie_persistant'];
430 aurelien 356
		$valeurCookie = md5($mdp).$id;
357
 
396 jpm 358
		setcookie($nomCookie, $valeurCookie, $duree, '/');
331 jpm 359
	}
390 jpm 360
 
430 aurelien 361
	protected function creerCookieUtilisateur($duree = null, $id = null, $mdp = null) {
400 jpm 362
		$id = is_null($id) ? $_SERVER['PHP_AUTH_USER'] : $id;
430 aurelien 363
		$mdp = is_null($mdp) ? $_SERVER['PHP_AUTH_PW'] : $mdp;
396 jpm 364
		$duree = (int) is_null($duree) ? 0 : $duree;
430 aurelien 365
 
366
		$nomCookie = $this->config['database_ident']['nom_cookie_utilisateur'];
400 jpm 367
		$valeurCookie = md5($mdp).$id;
430 aurelien 368
 
369
		setcookie($nomCookie, $valeurCookie, $duree, '/');
394 jpm 370
	}
371
 
388 aurelien 372
	protected function estAutoriseMessagerie($adresse) {
373
		$utilisateurs_messagerie = explode(',', $this->config['messagerie']['utilisateurs_autorises']);
374
		return in_array($adresse, $utilisateurs_messagerie);
375
	}
394 jpm 376
 
331 jpm 377
	//+----------------------------------------------------------------------------------------------------------------+
378
	// GESTION DES SQUELETTES PHP
390 jpm 379
 
69 aurelien 380
	/**
381
	 * Méthode prenant en paramètre un chemin de fichier squelette et un tableau associatif de données,
382
	 * en extrait les variables, charge le squelette et retourne le résultat des deux combinés.
383
	 *
384
	 * @param String $fichier	le chemin du fichier du squelette
385
	 * @param Array  $donnees	un tableau associatif contenant les variables a injecter dans le squelette.
386
	 *
387
	 * @return boolean false si le squelette n'existe pas, sinon la chaine résultat.
388
	 */
389
	public static function traiterSquelettePhp($fichier, Array $donnees = array()) {
390
		$sortie = false;
391
		if (file_exists($fichier)) {
392
			// Extraction des variables du tableau de données
393
			extract($donnees);
394
			// Démarage de la bufferisation de sortie
395
			ob_start();
396
			// Si les tags courts sont activés
397
			if ((bool) @ini_get('short_open_tag') === true) {
398
				// Simple inclusion du squelette
399
				include $fichier;
400
			} else {
401
				// Sinon, remplacement des tags courts par la syntaxe classique avec echo
402
				$html_et_code_php = self::traiterTagsCourts($fichier);
403
				// Pour évaluer du php mélangé dans du html il est nécessaire de fermer la balise php ouverte par eval
404
				$html_et_code_php = '?>'.$html_et_code_php;
405
				// Interprétation du html et du php dans le buffer
406
				echo eval($html_et_code_php);
407
			}
408
			// Récupèration du contenu du buffer
409
			$sortie = ob_get_contents();
410
			// Suppression du buffer
411
			@ob_end_clean();
412
		} else {
413
			$msg = "Le fichier du squelette '$fichier' n'existe pas.";
414
			trigger_error($msg, E_USER_WARNING);
415
		}
416
		// Retourne le contenu
417
		return $sortie;
418
	}
419
 
420
	/**
421
	 * Fonction chargeant le contenu du squelette et remplaçant les tags court php (<?= ...) par un tag long avec echo.
422
	 *
423
	 * @param String $chemin_squelette le chemin du fichier du squelette
424
	 *
425
	 * @return string le contenu du fichier du squelette php avec les tags courts remplacés.
426
	 */
427
	private static function traiterTagsCourts($chemin_squelette) {
428
		$contenu = file_get_contents($chemin_squelette);
429
		// Remplacement de tags courts par un tag long avec echo
430
		$contenu = str_replace('<?=', '<?php echo ',  $contenu);
431
		// Ajout systématique d'un point virgule avant la fermeture php
432
		$contenu = preg_replace("/;*\s*\?>/", "; ?>", $contenu);
433
		return $contenu;
434
	}
435
}
436
?>