Subversion Repositories Applications.annuaire

Rev

Rev 594 | Rev 605 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
559 aurelien 1
<?php
2
 
3
// composer
4
require_once '../vendor/autoload.php';
5
 
6
/**
7
 * Tentative de service d'authentification / SSO bien organisé
566 mathias 8
 * SSO - Mettez un tigre dans votre annuaire !
559 aurelien 9
 * @author mathias
10
 * © Tela Botanica 2015
11
 *
12
 * @TODO se baser sur autre chose que JRest qui est obsolète
13
 */
14
class Auth extends JRestService {
15
 
16
	/** Clef utilisée pour signer les jetons JWT */
17
	private $clef;
18
 
19
	/** Si true, refusera une connexion non-HTTPS */
20
	protected $forcerSSL = true;
21
 
22
	/** Durée en secondes du jeton (doit être faible en l'absence de mécanisme d'invalidation) */
23
	protected $dureeJeton = 900;
24
 
25
	/** Durée en secondes du cookie */
26
	protected $dureeCookie = 31536000; // 3600 * 24 * 365
27
 
28
	/** Nom du cookie */
29
	protected $nomCookie = "this_is_not_a_good_cookie_name";
30
 
594 mathias 31
	/** Domaine du cookie - lire la doc de set_cookie() */
32
	protected $domaineCookie = null;
33
 
580 mathias 34
	/** Bibliothèque de gestion des utilisateurs */
35
	protected $utilisateur;
36
 
559 aurelien 37
	public function __construct($config, $demarrer_session = true) {
38
		parent::__construct($config, $demarrer_session);
39
		$this->clef = file_get_contents("clef-auth.ini");
40
		if (strlen($this->clef) < 16) {
41
			throw new Exception("Clef trop courte - placez une clef d'au moins 16 caractères dans configurations/clef-auth.ini");
42
		}
43
		$this->forcerSSL = ($this->config['auth']['forcer_ssl'] == "1");
44
		$this->dureeJeton = $this->config['auth']['duree_jeton'];
45
		$this->dureeCookie = $this->config['auth']['duree_cookie'];
46
		$this->nomCookie = $this->config['auth']['nom_cookie'];
594 mathias 47
		if (! empty($this->config['auth']['domaine_cookie'])) {
48
			$this->domaineCookie = $this->config['auth']['domaine_cookie'];
49
		}
580 mathias 50
		// gestion des utilisateurs @WARNING on utilise un service comme une lib, c'est
51
		// mal !!  @TODO séparer service et lib (ou réécrire tout ce foutoir)
52
		$this->utilisateur = new Utilisateur($config);
559 aurelien 53
	}
54
 
55
	/**
580 mathias 56
	 * Retourne la bobliothèque de gestion des utilisateurs (pour utilisation
57
	 * par les classes partenaires)
58
	 */
59
	public function getUtilisateur() {
60
		return $this->utilisateur;
61
	}
62
 
63
	/**
559 aurelien 64
	 * Notice d'utilisation succincte
65
	 * @TODO essayer de choisir entre anglais et français
66
	 */
67
	protected function infosService() {
68
		$uri = $this->config['settings']['baseAlternativeURL'];
69
		if ($uri == '') {
70
			$uri = $this->config['settings']['baseURL'];
71
		}
72
		$uri = $uri . "auth/";
73
 
74
		$infos = array(
75
			'service' => 'TelaBotanica/annuaire/auth',
76
			'methodes' => array(
77
				'connexion' => array(
78
					"uri" => $uri . "connexion",
79
					"parametres" => array(
80
						"login" => "adresse email (ex: name@domain.com)",
592 mathias 81
						"password" => "mot de passe",
82
						"partner" => "nom du partenaire (ex: plantnet)"
559 aurelien 83
					),
84
					"alias" => $uri . "login",
85
					"description" => "connexion avec login et mot de passe; renvoie un jeton et un cookie " . $this->nomCookie
86
				),
87
				'deconnexion' => array(
88
					"uri" => $uri . "deconnexion",
89
					"parametres" => null,
90
					"alias" => $uri . "logout",
91
					"description" => "déconnexion; renvoie un jeton null et supprime le cookie " . $this->nomCookie
92
				),
93
				'identite' => array(
94
					"uri" => $uri . "identite",
95
					"parametres" => array(
96
						"token" => "jeton JWT (facultatif)",
97
					),
98
					"alias" => array(
99
						$uri . "identity",
100
						$uri . "rafraichir",
101
						$uri . "refresh"
102
					),
103
					"description" => "confirme l'authentification et la session; rafraîchit le jeton fourni (dans le cookie " . $this->nomCookie . ", le header Authorization ou en paramètre)"
104
				),
105
				'verifierjeton' => array(
106
					"uri" => $uri . "verifierjeton",
107
					"parametres" => array(
108
						"token" => "jeton JWT",
109
					),
110
					"alias" => $uri . "verifytoken",
111
					"description" => "retourne true si le jeton fourni en paramètre ou dans le header Authorization est valide, une erreur sinon"
112
				)
113
			)
114
		);
115
		$this->envoyerJson($infos);
116
	}
117
 
118
	/**
119
	 * Lorsqu'appelé sans éléments d'URL (service:annuaire:auth);
120
	 * les paramètres GET sont ignorés
121
	 */
122
	public function getRessource() {
123
		//echo "get ressource\n";
124
		$this->infosService();
125
	}
126
 
127
	/**
128
	 * Lorsqu'appelé avec des éléments d'URL (service:annuaire:auth/machin/chose);
129
	 * les paramètres GET sont ignorés
130
	 *
131
	 * @param array $ressources les éléments d'URL
132
	 */
133
	public function getElement($ressources) {
134
		// Achtétépéèch portouguech lolch
135
		$this->verifierSSL();
136
		// le premier paramètre d'URL définit la méthode (non-magique)
137
		if (count($ressources) > 0) {
138
			switch ($ressources[0]) {
139
				case 'login':
140
				case 'connexion':
141
					$this->connexion($ressources);
142
					break;
143
				case 'logout':
144
				case 'deconnexion':
145
					$this->deconnexion();
146
					break;
147
				case 'identity':
148
				case 'identite':
149
				case 'rafraichir':
150
				case 'refresh':
151
					$this->identite();
152
					break;
153
				case 'verifytoken':
154
				case 'verifierjeton':
155
					$this->verifierJeton();
156
					break;
157
				case 'info':
158
				default:
159
					$this->infosService();
160
			}
161
		}
162
	}
163
 
164
	/**
165
	 * Lors d'un POST avec au moins une donnée dans le body (data);
166
	 * les paramètres GET sont ignorés
167
	 * @TODO faire un point d'entrée POST qui renvoie vers les méthodes GET
168
	 *
169
	 * @param array $ressources les éléments d'URL
170
	 * @param array $pairs les paramètres POST
171
	 */
172
	public function updateElement($ressources, $pairs) {
173
		//echo "update element\n";
174
		$this->nonImplemente();
175
	}
176
 
177
	/**
178
	 * Lors d'un PUT (les éléments d'URL sont ignorés) ou d'un POST avec au moins
179
	 * un élément d'URL; dans tous les cas les paramètres GET sont ignorés
180
	 *
181
	 * @param array $pairs les paramètres POST
182
	 */
183
	public function createElement($pairs) {
184
		//echo "create element\n";
185
		$this->nonImplemente();
186
	}
187
 
188
	/**
189
	 * Lors d'un DELETE avec au moins un élément d'URL
190
	 * @TODO utiliser pour invalider un jeton (nécessite stockage)
191
	 *
192
	 * @param array $ressources les éléments d'URL
193
	 */
194
	public function deleteElement($ressources) {
195
		//echo "delete element\n";
196
		$this->nonImplemente();
197
	}
198
 
199
	/**
200
	 * Vérifie l'identité d'un utilisateur à partir de son courriel et son
201
	 * mot de passe ou d'un cookie; lui accorde un jeton et un cookie si
202
	 * tout va bien, sinon renvoie une erreur et détruit le cookie
203
	 * @WARNING si vous n'utilisez pas urlencode() pour fournir le mot de passe,
204
	 * le caractère "&" posera problème en GET
205
	 *
206
	 * @param array $ressources non utilisé
207
	 */
208
	protected function connexion($ressources) {
209
		$login = $this->getParam('login');
210
		$password = $this->getParam('password', null);
579 mathias 211
		$partenaire = $this->getParam('partner');
559 aurelien 212
		if ($login == '' || $password == '') {
213
			$this->erreur("parameters <login> and <password> required");
214
		}
579 mathias 215
		$acces = false;
216
		// connexion à un partenaire ?
580 mathias 217
		$infosPartenaire = array();
579 mathias 218
		if ($partenaire != '') {
219
			$classeAuth = "AuthPartner" . ucfirst(strtolower($partenaire));
220
			try {
580 mathias 221
				$fichierClasse = getcwd() . "/services/auth/$classeAuth.php"; // @TODO vérifier si getcwd() est fiable dans ce cas
222
				if (! file_exists($fichierClasse)) {
223
					$this->erreur("unknown partner '$partenaire'");
224
				}
579 mathias 225
				require $fichierClasse;
580 mathias 226
				$authPartenaire = new $classeAuth($this);
579 mathias 227
				// authentification par le partenaire
580 mathias 228
				$acces = $authPartenaire->verifierAcces($login, $password);
229
				if ($acces === true) {
230
					// copie des infos dans l'annuaire si besoin
231
					$authPartenaire->synchroniser();
232
				}
233
				// détails à ajouter au jeton local
234
				$infosPartenaire['partenaire'] = $partenaire;
235
				$infosPartenaire['jetonPartenaire'] = $authPartenaire->getJetonPartenaire();
583 mathias 236
				// remplacement du login par le courriel (chez certains partenaires,
237
				// le login peut ne pas être un courriel
238
				$login = $authPartenaire->getCourriel();
579 mathias 239
			} catch(Exception $e) {
240
				$this->erreur($e->getMessage(), 500);
241
			}
242
		} else {
243
			// authentification locale
244
			$acces = $this->verifierAcces($login, $password);
245
		}
559 aurelien 246
		if ($acces === false) {
247
			$this->detruireCookie();
563 mathias 248
			// redirection si demandée - se charge de sortir du script en cas de succès
249
			$this->rediriger();
250
			// si la redirection n'a pas eu lieu
251
			$this->erreur("authentication failed", 401);
559 aurelien 252
		}
253
		// infos utilisateur
580 mathias 254
		$infos = $this->utilisateur->getIdentiteParCourriel($login);
255
		//var_dump($infos); exit;
576 mathias 256
		// getIdentiteParCourriel retourne toujours le courriel comme clef de tableau en lowercase
257
		$login = strtolower($login);
559 aurelien 258
		if (count($infos) == 0 || empty($infos[$login])) {
563 mathias 259
			// redirection si demandée - se charge de sortir du script en cas de succès
260
			$this->rediriger();
261
			// si la redirection n'a pas eu lieu
262
			$this->erreur("could not get user info");
559 aurelien 263
		}
580 mathias 264
		$infos = $infos[$login];
579 mathias 265
		// date de dernière modification du profil
580 mathias 266
		$dateDerniereModif = $this->utilisateur->getDateDerniereModifProfil($infos['id'], true);
267
		$infos['dateDerniereModif'] = $dateDerniereModif;
268
		// infos partenaire
269
		$infos = array_merge($infos, $infosPartenaire);
559 aurelien 270
		// création du jeton
580 mathias 271
		$jwt = $this->creerJeton($login, $infos);
559 aurelien 272
		// création du cookie
273
		$this->creerCookie($jwt);
563 mathias 274
		// redirection si demandée - se charge de sortir du script en cas de succès
275
		$this->rediriger($jwt);
276
		// envoi
277
		$this->envoyerJson(array(
278
			"session" => true,
279
			"token" => $jwt,
280
			"duration" => intval($this->dureeJeton),
281
			"token_id" => $this->nomCookie,
580 mathias 282
			"last_modif" => $infos['dateDerniereModif']
563 mathias 283
		));
559 aurelien 284
	}
285
 
286
	/**
287
	 * Détruit le cookie et renvoie un jeton vide ou NULL - le client
288
	 * devrait toujours remplacer son jeton par celui renvoyé par les
289
	 * méthodes de l'annuaire
290
	 */
291
	protected function deconnexion() {
292
		// suppression du cookie
293
		$this->detruireCookie();
294
		// envoi d'un jeton null
295
		$jwt = null;
563 mathias 296
		// redirection si demandée - se charge de sortir du script en cas de succès
297
		$this->rediriger();
298
		// si la redirection n'a pas eu lieu
299
		$this->envoyerJson(array(
300
				"session" => false,
301
				"token" => $jwt,
302
				"token_id" => $this->nomCookie
303
		));
559 aurelien 304
	}
305
 
306
	/**
307
	 * Renvoie un jeton rafraîchi (durée de validité augmentée de $this->dureeJeton
308
	 * si l'utilisateur est reconnu comme détenteur d'une session active (cookie valide,
309
	 * header HTTP "Authorization" ou jeton valide); renvoie une erreur si le cookie
310
	 * et/ou le jeton sont expirés;
311
	 * cela permet en théorie de forger des cookies avec des jetons expirés pour se les
312
	 * faire rafraîchir frauduleusement, mais le canal HTTPS fait qu'un client ne peut
313
	 * être en possession que de ses propres jetons... au pire on peut se faire prolonger
314
	 * à l'infini même si on n'est plus inscrit à l'annuaire... @TODO faire mieux un jour
315
	 * Priorité : cookie > header "Authorization" > paramètre "token" @TODO vérifier cette
316
	 * stratégie, l'inverse est peut-être plus malin
317
	 */
318
	protected function identite() {
319
		$cookieAvecJetonValide = false;
320
		$jetonRetour = null;
321
		$erreur = '';
322
		// lire cookie
323
		if (isset($_COOKIE[$this->nomCookie])) {
324
			$jwt = $_COOKIE[$this->nomCookie];
325
			try {
326
				// rafraîchir jeton quelque soit son état - "true" permet
327
				// d'ignorer les ExpiredException (on rafraîchit le jeton
328
				// expiré car le cookie est encore valide)
329
				$jetonRetour = $this->rafraichirJeton($jwt, true);
330
				// on ne tentera pas de lire un jeton fourni en paramètre
331
				$cookieAvecJetonValide = true;
332
			} catch (Exception $e) {
333
				// si le rafraîchissement a échoué (jeton invalide - hors expiration - ou vide)
334
				// on ne fait rien et on tente la suite (jeton fourni hors cookie ?)
335
				$erreur = "invalid token in cookie";
336
			}
337
		}
338
		// si le cookie n'existait pas ou ne contenait pas un jeton
339
		if (! $cookieAvecJetonValide) {
340
			// lire jeton depuis header ou paramètre
341
			$jwt = $this->lireJetonDansHeader();
342
			if ($jwt == null) {
343
				// dernière chance
344
				$jwt = $this->getParam('token');
345
			}
346
			// toutes les possibilités ont été essayées
347
			if ($jwt != null) {
348
				try {
349
					// rafraîchir jeton si non expiré
350
					$jetonRetour = $this->rafraichirJeton($jwt);
351
				} catch (Exception $e) {
352
					// si le rafraîchissement a échoué (jeton invalide, expiré ou vide)
353
					$erreur = "invalid or expired token in Authorization header or parameter <token>";
354
				}
355
			} else {
356
				// pas de jeton valide passé en paramètre
357
				$erreur = ($erreur == "" ? "no token or cookie" : "invalid token in cookie / invalid or expired token in Authorization header or parameter <token>");
358
			}
563 mathias 359
		}
360
		// redirection si demandée - se charge de sortir du script en cas de succès
361
		$this->rediriger($jetonRetour);
362
		// renvoi jeton
363
		if ($jetonRetour === null) {
364
			$this->erreur($erreur);
559 aurelien 365
		} else {
563 mathias 366
			$this->envoyerJson(array(
367
					"session" => true,
368
					"token" => $jetonRetour,
369
					"duration" => intval($this->dureeJeton),
370
					"token_id" => $this->nomCookie
371
			));
559 aurelien 372
		}
373
	}
563 mathias 374
 
375
	/**
376
	 * Si $_GET['redirect_url'] est non-vide, redirige vers l'URL qu'il contient et sort du programme;
377
	 * sinon, ne fait rien et passe la main
378
	 *
574 mathias 379
	 * @param string $jetonRetour jeton JWT à passer à l'URL de destination
380
	 * en GET; par défaut null
563 mathias 381
	 */
382
	protected function rediriger($jetonRetour=null) {
383
		if (!empty($_GET['redirect_url'])) {
384
			// dans le cas où une url de redirection est précisée,
574 mathias 385
			// on précise le jeton dans le get
559 aurelien 386
			$url_redirection = $_GET['redirect_url'];
574 mathias 387
 
388
			// même si le jeton est vide, on ajoute un paramètre GET Authorization
389
			// pour spécifier à la cible qu'on a bien traité sa requête - permet
390
			// aussi de gérer les déconnexions en renvoyant un jeton vide
391
			$separateur = (parse_url($url_redirection, PHP_URL_QUERY) == NULL) ? '?' : '&';
392
			$url_redirection .= $separateur.'Authorization='.$jetonRetour;
393
 
394
			// retour à l'envoyeur !
563 mathias 395
			header('Location: '.$url_redirection);
396
			exit;
559 aurelien 397
		}
398
	}
399
 
400
	/**
401
	 * Vérifie si un jeton est valide; retourne true si oui, une erreur avec
402
	 * des détails si non;
403
	 * Priorité : header "Authorization" > paramètre "token"
404
	 */
405
	protected function verifierJeton() {
406
		// vérifie que le jeton provient bien d'ici,
407
		// et qu'il est encore valide (date)
408
		$jwt = $this->lireJetonDansHeader();
409
		if ($jwt == null) {
410
			$jwt = $this->getParam('token');
411
			if ($jwt == '') {
412
				$this->erreur("parameter <token> or Authorization header required");
413
			}
414
		}
415
		try {
416
			$jeton = JWT::decode($jwt, $this->clef, array('HS256'));
417
			$jeton = (array) $jeton;
418
		} catch (Exception $e) {
419
			$this->erreur($e->getMessage());
420
			exit;
421
		}
422
		$this->envoyerJson(true);
423
	}
424
 
425
	/**
426
	 * Reçoit un jeton JWT, et s'il est non-vide ("sub" != null), lui redonne
427
	 * une période de validité de $this->dureeJeton; si $ignorerExpiration
428
	 * vaut true, rafraîchira le jeton même s'il a expiré
429
	 * (attention à ne pas appeler cette méthode n'importe comment !);
430
	 * jette une exception si le jeton est vide, mal signé ou autre erreur,
431
	 * ou s'il a expiré et que $ignorerExpiration est différent de true
432
	 *
433
	 * @param string $jwt le jeton JWT
434
	 * @return string le jeton rafraîchi
435
	 */
436
	protected function rafraichirJeton($jwt, $ignorerExpiration=false) /* throws Exception */ {
437
		$infos = array();
438
		// vérification avec lib JWT
439
		try {
440
			$infos = JWT::decode($jwt, $this->clef, array('HS256'));
441
			$infos = (array) $infos;
442
		} catch (ExpiredException $e) {
443
			if ($ignorerExpiration === true) {
444
				// on se fiche qu'il soit expiré
445
				// décodage d'un jeton expiré
446
				// @WARNING considère que la lib JWT jette ExpiredException en dernier (vrai 12/05/2015),
447
				// ce qui signifie que la signature et le domaine sont tout de même valides - à surveiller !
579 mathias 448
				$infos = $this->decoderJetonManuellement($jwt);
559 aurelien 449
			} else {
450
				// on renvoie l'exception plus haut
451
				throw $e;
452
			}
453
		}
454
		// vérification des infos
455
		if (empty($infos['sub'])) {
456
			// jeton vide (wtf?)
457
			throw new Exception("empty token (no <sub>)");
458
		}
459
		// rafraîchissement
460
		$infos['exp'] = time() + $this->dureeJeton;
461
		$jwtSortie = JWT::encode($infos, $this->clef);
462
 
463
		return $jwtSortie;
464
	}
465
 
466
	/**
467
	 * Décode manuellement un jeton JWT, SANS VÉRIFIER SA SIGNATURE OU
468
	 * SON DOMAINE ! @WARNING ne pas utiliser hors du cas d'un jeton
469
	 * correct (vérifié avec la lib JWT) mais expiré !
579 mathias 470
	 * Public car utilisé par les classes AuthPartner (@TODO stratégie à valider)
559 aurelien 471
	 * @param string $jwt un jeton vérifié comme valide, mais expiré
472
	 */
579 mathias 473
	public function decoderJetonManuellement($jwt) {
559 aurelien 474
		$parts = explode('.', $jwt);
475
		$payload = $parts[1];
476
		$payload = base64_decode($payload);
477
		$payload = json_decode($payload, true);
478
 
479
		return $payload;
480
	}
481
 
482
	/**
483
	 * Crée un jeton JWT signé avec la clef
484
	 *
485
	 * @param mixed $sub subject: l'id utilisateur du détenteur du jeton si authentifié, null sinon
486
	 * @param string $exp la date d'expiration du jeton, par défaut la date actuelle plus $this->dureeJeton
487
	 * @param array $donnees les données à ajouter au jeton (infos utilisateur)
488
	 *
489
	 * @return string un jeton JWT signé
490
	 */
491
	protected function creerJeton($sub, $donnees=array(), $exp=null) {
492
		if ($exp === null) {
493
			$exp = time() + $this->dureeJeton;
494
		}
495
		$jeton = array(
496
			"iss" => "https://www.tela-botanica.org",
497
			"token_id" => $this->nomCookie,
498
			//"aud" => "http://example.com",
499
			"sub" => $sub,
500
			"iat" => time(),
501
			"exp" => $exp,
502
			//"nbf" => time() + 60,
503
			"scopes" => array("tela-botanica.org")
504
		);
505
		if (! empty($donnees)) {
506
			$jeton = array_merge($jeton, $donnees);
507
		}
508
		$jwt = JWT::encode($jeton, $this->clef);
509
 
510
		return $jwt;
511
	}
512
 
513
	/**
514
	 * Essaye de trouver un jeton JWT non vide dans l'entête HTTP $nomHeader (par
515
	 * défaut "Authorization")
516
	 *
517
	 * @param string $nomHeader nom de l'entête dans lequel chercher le jeton
518
	 * @return String un jeton JWT ou null
519
	 */
520
	protected function lireJetonDansHeader($nomHeader="Authorization") {
521
		$jwt = null;
522
		$headers = apache_request_headers();
523
		if (isset($headers[$nomHeader]) && ($headers[$nomHeader] != "")) {
524
			$jwt = $headers[$nomHeader];
525
		}
526
		return $jwt;
527
	}
528
 
529
	/**
530
	 * Crée un cookie de durée $this->dureeCookie, nommé $this->nomCookie et
531
	 * contenant $valeur
532
	 *
533
	 * @param string $valeur le contenu du cookie (de préférence un jeton JWT)
534
	 */
535
	protected function creerCookie($valeur) {
594 mathias 536
		setcookie($this->nomCookie, $valeur, time() + $this->dureeCookie, '/', $this->domaineCookie, true);
559 aurelien 537
	}
538
 
539
	/**
540
	 * Renvoie le cookie avec une valeur vide et une date d'expiration dans le
541
	 * passé, afin que le navigateur le détruise au prochain appel
542
	 * @TODO envisager l'envoi d'un jeton vide plutôt que la suppression du cookie
543
	 *
544
	 * @param string $valeur la valeur du cookie, par défaut ""
545
	 */
546
	protected function detruireCookie() {
594 mathias 547
		setcookie($this->nomCookie, "", -1, '/', $this->domaineCookie, true);
598 mathias 548
		// mode transition: supprime l'ancien cookie posé sur "www.tela-botanica.org" sans quoi on ne peut plus se déconnecter!
549
		// @TODO supprimer au bout d'un moment
550
		setcookie($this->nomCookie, "", -1, '/', null, true);
559 aurelien 551
	}
552
 
553
	// ---------------- Méthodes à génériciser ci-dessous ----------------------------------
554
 
555
	/**
556
	 * Message succinct pour méthodes / actions non implémentées
557
	 */
558
	protected function nonImplemente() {
559
		$this->erreur("not implemented");
560
	}
561
 
562
	/**
563
	 * Si $this->forcerSSL vaut true, envoie une erreur et termine le programme si SSL n'est pas utilisé
564
	 */
565
	protected function verifierSSL() {
566
		if ($this->forcerSSL === true) {
567
			if (empty($_SERVER['HTTPS']) || $_SERVER['HTTPS'] == 'off') {
568
				$this->erreur("HTTPS required");
569
				exit;
570
			}
571
		}
572
	}
573
 
574
	protected function getParamChain($names) {
575
		if (! is_array($names)) {
576
			// Hou ? (cri de chouette solitaire)
577
		}
578
	}
579
 
580
	/**
581
	 * Capture un paramètre de requête ($_REQUEST)
582
	 *
583
	 * @param string $name nom du paramètre à capturer
584
	 * @param string $default valeur par défaut si le paramètre n'est pas défini (ou vide, voir ci-dessous)
585
	 * @param bool $traiterVideCommeDefaut si le paramètre est défini mais vide (''), le considèrera comme non défini
586
	 *
587
	 * @return string la valeur du paramètre si défini, sinon la valeur par défaut
588
	 */
589
	protected function getParam($name, $default=null, $traiterVideCommeDefaut=false) {
590
		$ret = $default;
591
		if (isset($_REQUEST[$name])) {
592
			if ($traiterVideCommeDefaut === false || $_REQUEST[$name] !== '') {
593
				$ret = $_REQUEST[$name];
594
			}
595
		}
596
		return $ret;
597
	}
598
 
599
	/**
600
	 * Capture un paramètre GET
601
	 *
602
	 * @param string $name nom du paramètre GET à capturer
603
	 * @param string $default valeur par défaut si le paramètre n'est pas défini (ou vide, voir ci-dessous)
604
	 * @param bool $traiterVideCommeDefaut si le paramètre est défini mais vide (''), le considèrera comme non défini
605
	 *
606
	 * @return string la valeur du paramètre si défini, sinon la valeur par défaut
607
	 */
608
	protected function getGetParam($name, $default=null, $traiterVideCommeDefaut=false) {
609
		$ret = $default;
610
		if (isset($_GET[$name])) {
611
			if ($traiterVideCommeDefaut === false || $_GET[$name] !== '') {
612
				$ret = $_GET[$name];
613
			}
614
		}
615
		return $ret;
616
	}
617
 
618
	/**
619
	 * Capture un paramètre POST
620
	 *
621
	 * @param string $name nom du paramètre POST à capturer
622
	 * @param string $default valeur par défaut si le paramètre n'est pas défini (ou vide, voir ci-dessous)
623
	 * @param bool $traiterVideCommeDefaut si le paramètre est défini mais vide (''), le considèrera comme non défini
624
	 *
625
	 * @return string la valeur du paramètre si défini, sinon la valeur par défaut
626
	 */
627
	protected function getPostParam($name, $default=null, $traiterVideCommeDefaut=false) {
628
		$ret = $default;
629
		if (isset($_POST[$name])) {
630
			if ($traiterVideCommeDefaut === false || $_POST[$name] !== '') {
631
				$ret = $_POST[$name];
632
			}
633
		}
634
		return $ret;
635
	}
636
 
637
	/**
638
	 * Envoie une erreur HTTP $code (400 par défaut) avec les données $data en JSON
639
	 *
640
	 * @param mixed $data données JSON de l'erreur - généralement array("error" => "raison de l'erreur") - si
641
	 * 		seule une chaîne est transmise, sera convertie en array("error" => $data)
642
	 * @param number $code code HTTP de l'erreur, par défaut 400 (bad request)
643
	 * @param boolean $exit si true (par défaut), termine le script après avoir envoyé l'erreur
644
	 */
645
	protected function erreur($data, $code=400, $exit=true) {
646
		if (! is_array($data)) {
647
			$data = array(
648
				"error" => $data
649
			);
650
		}
651
		http_response_code($code);
652
		$this->envoyerJson($data);
653
		if ($exit === true) {
654
			exit;
655
		}
656
	}
657
}
658
 
659
/**
660
 * Mode moderne pour PHP < 5.4
661
 */
662
if (!function_exists('http_response_code')) {
663
	function http_response_code($code = NULL) {
664
		if ($code !== NULL) {
665
			switch ($code) {
666
				case 100: $text = 'Continue'; break;
667
				case 101: $text = 'Switching Protocols'; break;
668
				case 200: $text = 'OK'; break;
669
				case 201: $text = 'Created'; break;
670
				case 202: $text = 'Accepted'; break;
671
				case 203: $text = 'Non-Authoritative Information'; break;
672
				case 204: $text = 'No Content'; break;
673
				case 205: $text = 'Reset Content'; break;
674
				case 206: $text = 'Partial Content'; break;
675
				case 300: $text = 'Multiple Choices'; break;
676
				case 301: $text = 'Moved Permanently'; break;
677
				case 302: $text = 'Moved Temporarily'; break;
678
				case 303: $text = 'See Other'; break;
679
				case 304: $text = 'Not Modified'; break;
680
				case 305: $text = 'Use Proxy'; break;
681
				case 400: $text = 'Bad Request'; break;
682
				case 401: $text = 'Unauthorized'; break;
683
				case 402: $text = 'Payment Required'; break;
684
				case 403: $text = 'Forbidden'; break;
685
				case 404: $text = 'Not Found'; break;
686
				case 405: $text = 'Method Not Allowed'; break;
687
				case 406: $text = 'Not Acceptable'; break;
688
				case 407: $text = 'Proxy Authentication Required'; break;
689
				case 408: $text = 'Request Time-out'; break;
690
				case 409: $text = 'Conflict'; break;
691
				case 410: $text = 'Gone'; break;
692
				case 411: $text = 'Length Required'; break;
693
				case 412: $text = 'Precondition Failed'; break;
694
				case 413: $text = 'Request Entity Too Large'; break;
695
				case 414: $text = 'Request-URI Too Large'; break;
696
				case 415: $text = 'Unsupported Media Type'; break;
697
				case 500: $text = 'Internal Server Error'; break;
698
				case 501: $text = 'Not Implemented'; break;
699
				case 502: $text = 'Bad Gateway'; break;
700
				case 503: $text = 'Service Unavailable'; break;
701
				case 504: $text = 'Gateway Time-out'; break;
702
				case 505: $text = 'HTTP Version not supported'; break;
703
				case 666: $text = 'Couscous overheat'; break;
704
				default:
705
					exit('Unknown http status code "' . htmlentities($code) . '"');
706
					break;
707
			}
708
 
709
			$protocol = (isset($_SERVER['SERVER_PROTOCOL']) ? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.0');
710
			header($protocol . ' ' . $code . ' ' . $text);
711
			$GLOBALS['http_response_code'] = $code;
712
		} else {
713
			$code = (isset($GLOBALS['http_response_code']) ? $GLOBALS['http_response_code'] : 200);
714
		}
715
		return $code;
716
	}
576 mathias 717
}