Subversion Repositories eFlore/Applications.del

Rev

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

Rev Author Line No. Line
700 gduche 1
<?php
1815 jpm 2
// declare(encoding='UTF-8');
1793 jpm 3
/**
1840 jpm 4
 * Classe contenant des méthodes de filtrage/formatage des paramètres de recherche passés dans l'URL.
1793 jpm 5
 *
1840 jpm 6
 * Cette classe filtre et formate les parametres passées dans l'URL et construit un tableau associatif contenant
7
 * le résultat des filtrages/formatages et les infos nécessaires à la construction d'une requête SQL.
1793 jpm 8
 *
1815 jpm 9
 * @category  DEL
10
 * @package   Services
11
 * @package   Bibliotheque
12
 * @version   0.1
13
 * @author    Mathias CHOUET <mathias@tela-botanica.org>
14
 * @author    Jean-Pascal MILCENT <jpm@tela-botanica.org>
15
 * @author    Aurelien PERONNET <aurelien@tela-botanica.org>
16
 * @license   GPL v3 <http://www.gnu.org/licenses/gpl.txt>
17
 * @license   CECILL v2 <http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt>
1793 jpm 18
 * @copyright 1999-2014 Tela Botanica <accueil@tela-botanica.org>
19
 */
1840 jpm 20
class ParametresFiltrage {
700 gduche 21
 
1871 jpm 22
	const APPLI_IMG = 'IMG';
23
	const APPLI_OBS = 'OBS';
24
 
1840 jpm 25
	const LISTE_OBS_MAX_RESULT_LIMIT = 1000;
26
	const LISTE_OBS_MAX_ID_OBS = 10e7;
27
	const LISTE_OBS_MAX_BDTFX_NT = 1000000; // SELECT MAX(num_taxonomique) FROM bdtfx_v2_00; // 44378 + 1000
28
	const LISTE_OBS_MAX_BDTFX_NN = 1000000; // SELECT MAX(num_nom) FROM bdtfx_v2_00;// 120816 + 10000
29
 
30
	private $conteneur;
31
	private $contexte;
32
	private $parametres = array();
33
	private $parametresFiltres = array();
1871 jpm 34
	private $appli;
1840 jpm 35
 
36
	public function __construct($conteneur) {
37
		$this->conteneur = $conteneur;
38
		$this->contexte = $this->conteneur->getContexte();
39
		$this->parametres = $this->contexte->getQS();
40
	}
41
 
1871 jpm 42
	private function etreAppliImg() {
43
		return $this->appli === 'IMG' ? true : false;
44
	}
45
 
46
	private function etreAppliObs() {
47
		return $this->appli === 'OBS' ? true : false;
48
	}
49
 
1840 jpm 50
	public function filtrerUrlParamsAppliImg() {
1871 jpm 51
		$this->appli = self::APPLI_IMG;
1840 jpm 52
		$this->maintenirCompatibilitesParametres();
53
 
54
		$parametresAutorises = $this->conteneur->getParametreTableau('images.masques_possibles');
55
		$this->eliminerParametresInconnus($parametresAutorises);
56
 
57
		$this->repartirMasqueGeneral();
58
 
59
		$paramsParDefaut = $this->conteneur->getParametreTableau('images.parametres_valeurs_defaut');
60
		$this->definirParametresDefauts($paramsParDefaut);
61
 
62
		$this->filtrerUrlParamsGeneraux();
63
 
64
		$trisPossibles = $this->conteneur->getParametreTableau('appli_img.tris_possibles');
65
		$this->detruireParametreInvalide('tri', $trisPossibles);
66
		$formatsImgPossibles = $this->conteneur->getParametreTableau('appli_img.img_formats_possibles');
67
		$this->detruireParametreInvalide('format', $formatsImgPossibles);
68
		$this->filtrerProtocole();
69
 
70
		$this->supprimerParametresFiltresInvalides();
71
		return $this->parametresFiltres;
72
	}
73
 
74
	public function filtrerUrlParamsAppliObs() {
1871 jpm 75
		$this->appli = self::APPLI_OBS;
1840 jpm 76
		$this->maintenirCompatibilitesParametres();
77
 
78
		$parametresAutorises = $this->conteneur->getParametreTableau(('observations.masques_possibles'));
79
		$this->eliminerParametresInconnus($parametresAutorises);
80
 
81
		$this->repartirMasqueGeneral();
82
 
83
		$paramsParDefaut = $this->conteneur->getParametreTableau('observations.parametres_valeurs_defaut');
84
		$this->definirParametresDefauts($paramsParDefaut);
85
 
86
		$this->filtrerUrlParamsGeneraux();
87
 
1845 jpm 88
		$trisPossibles = $this->conteneur->getParametreTableau('appli_obs.tris_possibles');
1840 jpm 89
		$this->detruireParametreInvalide('tri', $trisPossibles);
1853 jpm 90
 
1840 jpm 91
		$this->supprimerParametresFiltresInvalides();
92
		return $this->parametresFiltres;
93
	}
94
 
95
	private function maintenirCompatibilitesParametres() {
96
		$this->renommerParametres();
97
 
1871 jpm 98
		if ($this->etreAppliImg() && !isset($this->parametres['masque.tag_del']) && isset($this->parametres['masque.tag'])) {
1840 jpm 99
			$this->parametres['masque.tag_del'] = $this->parametres['masque.tag'];
1871 jpm 100
			unset($this->parametres['masque.tag']);
1840 jpm 101
		}
1871 jpm 102
		if ($this->etreAppliobs() && !isset($this->parametres['masque.tag_cel']) && isset($this->parametres['masque.tag'])) {
103
			$this->parametres['masque.tag_cel'] = $this->parametres['masque.tag'];
104
			unset($this->parametres['masque.tag']);
105
		}
1840 jpm 106
	}
107
 
108
	private function renommerParametres() {
109
		$renomages = array('masque.tag_pictoflora' => 'masque.tag_del');
110
		foreach ($renomages as $ancienNom => $nouveauNom) {
111
			if (isset($this->parametres[$ancienNom])) {
112
				$this->parametres[$nouveauNom] = $this->parametres[$ancienNom];
113
				unset($this->parametres[$ancienNom]);
114
			}
115
		}
116
	}
117
 
118
	/**
119
	 * Suppression de toutes les clefs NON présentes dans le paramètre de config : images|observations.masques_possibles
120
	 * @param array $parametresAutorises tableau des paramètres pouvant être utilisé dans l'url.
121
	 */
122
	private function eliminerParametresInconnus(Array $parametresAutorises = null) {
123
		if ($parametresAutorises) {
124
			$this->parametres = array_intersect_key($this->parametres, array_flip($parametresAutorises));
125
		}
126
	}
127
 
128
	/**
129
	 * Les paramètres par défaut sont écrasés par ceux passés dans l'url.
130
	 *
131
	 * @param array $paramsParDefaut tableau associatif des paramètres d'url par défaut
132
	 */
133
	private function definirParametresDefauts(Array $paramsParDefaut) {
134
		$this->parametres = array_merge($paramsParDefaut, $this->parametres);
135
	}
136
 
137
	/**
138
	 * "masque" ne fait jamais que faire une requête sur la plupart des champs, (presque) tous traités
139
	 * de manière identique à la seule différence que:
140
	 * 1) ils sont combinés par des "OU" logiques plutôt que des "ET".
141
	 * 2) les tags sont traités différemment pour conserver la compatibilité avec l'utilisation historique:
142
	 * Tous les mots-clefs doivent matcher et sont séparés par des espaces.
143
	 */
144
	private function repartirMasqueGeneral() {
145
		if (isset($this->parametres['masque']) && !empty(trim($this->parametres['masque']))) {
146
			$masqueGeneral = trim($this->parametres['masque']);
147
			$masquesDetailCles = array('masque.auteur', 'masque.departement', 'masque.commune', 'masque.id_zone_geo',
148
				'masque.ns', 'masque.famille', 'masque.date', 'masque.genre', 'masque.milieu');
149
 
150
			// Suppression de la génération de SQL du masque général sur les champ spécifiques qui sont traités avec leur valeur propre.
151
			foreach ($masquesDetailCles as $cle) {
152
				if (isset($this->parametres[$cle]) === false) {
153
					$this->parametres[$cle] = $masqueGeneral;
154
					$this->parametresFiltres['_parametres_condition_or_'][] = $cle;
155
				}
156
			}
157
		}
158
	}
159
 
160
	/**
161
	 * Filtre et valide les paramètres reconnus. Effectue *toute* la sanitization *sauf* l'escape-string
162
	 * Cette fonction est appelée:
163
	 * - une fois sur les champs de recherche avancées
164
	 * - une fois sur le masque général si celui-ci à été spécifié. Dans ce cas,
165
	 * la chaîne générale saisie est utilisée comme valeur pour chacun des champs particuliers
166
	 * avec les traitements particuliers qui s'imposent
167
	 * Par exemple: si l'on cherche "Languedoc", cela impliquera:
168
	 * WHERE (nom_sel like "Languedoc" OR nom_ret ... OR ...) mais pas masque.date ou masque.departement
169
	 * qui s'assure d'un pattern particulier
170
	 *
171
	 * masque.genre est un alias pour masque.ns (nom_sel), mais permet de rajouter une clause supplémentaire
172
	 * sur nom_sel. Précédemment: WHERE nom_sel LIKE '%<masque.genre>% %'.
173
	 * Désormais masque.genre doit être intégralement spécifié, les caractères '%' et '_' seront interprétés.
174
	 * Attention toutefois car la table del_observation intègre des nom_sel contenant '_'
175
	 */
176
	// TODO: ajouter un filtre sur le masque (général)
177
	private function filtrerUrlParamsGeneraux() {
178
		$this->detruireParametreInvalide('ordre', $this->conteneur->getParametreTableau('valeurs_ordre'));
179
		$this->detruireParametreInvalide('masque.referentiel', $this->conteneur->getParametreTableau('valeurs_referentiel'));
180
 
181
		$this->filtrerNavigationLimite();
182
		$this->filtrerNavigationDepart();
183
		$this->filtrerDepartement();
184
		$this->filtrerDate();
185
		$this->filtrerNn();
186
		$this->filtrerNt();
187
 
188
		$parametresATrimer = array('masque', 'masque.ns', 'masque.genre', 'masque.espece', 'masque.auteur', 'masque.milieu');
189
		$this->supprimerCaracteresInvisibles($parametresATrimer);
190
 
191
		$this->filtrerFamille();
192
		$this->filtrerIdZoneGeo();
193
		$this->filtrerCommune();
194
		$this->filtrerType();
195
 
196
		$this->filtrerTagCel();
197
		$this->filtrerTagDel();
198
	}
199
 
200
 
201
	/**
202
	 * Supprime l'index du tableau des paramètres si sa valeur ne correspond pas
203
	 * au spectre passé par $values.
204
	 */
205
	private function detruireParametreInvalide($index, Array $valeursAutorisees) {
206
		if (array_key_exists($index, $this->parametres)) {
207
			if (!in_array($this->parametres[$index], $valeursAutorisees)) {
208
				unset($this->parametres[$index]);
700 gduche 209
			} else {
1840 jpm 210
				$this->parametresFiltres[$index] = $this->parametres[$index];
700 gduche 211
			}
212
		}
213
	}
1840 jpm 214
 
215
	private function filtrerNavigationLimite() {
216
		if (isset($this->parametres['navigation.limite'])) {
217
			$options = array(
218
				'options' => array(
219
					'default' => null,
220
					'min_range' => 1,
221
					'max_range' => self::LISTE_OBS_MAX_RESULT_LIMIT));
222
			$paramFiltre = filter_var($this->parametres['navigation.limite'], FILTER_VALIDATE_INT, $options);
223
			$this->parametresFiltres['navigation.limite'] = $paramFiltre;
224
		}
225
	}
226
 
227
	private function filtrerNavigationDepart() {
228
		if (isset($this->parametres['navigation.depart'])) {
229
			$options = array(
230
				'options' => array(
231
					'default' => null,
232
					'min_range' => 0,
233
					'max_range' => self::LISTE_OBS_MAX_ID_OBS));
234
			$paramFiltre = filter_var($this->parametres['navigation.depart'], FILTER_VALIDATE_INT, $options);
235
			$this->parametresFiltres['navigation.depart'] = $paramFiltre;
236
		}
237
	}
238
 
239
	/**
240
	 * STRING: 0 -> 95, 971 -> 976, 2A + 2B (./services/configurations/config_departements_bruts.ini)
241
	 * accept leading 0 ?
242
	 * TODO; filter patterns like 555.
243
	 *
244
	 * @return type
245
	 */
246
	private function filtrerDepartement() {
247
		if (isset($this->parametres['masque.departement'])) {
248
			$dept = $this->parametres['masque.departement'];
249
			$paramFiltre = null;
250
			if (preg_match('/^(\d{2}|\d{3}|2a|2b)$/i', $dept) != 0) {
251
				$paramFiltre = is_numeric($dept) ? str_pad($dept, 5, '_') : $dept;
252
			} else {
253
				$dept_translit = iconv('UTF-8', 'ASCII//TRANSLIT', $dept);
254
				$dpt_chaine = strtolower(str_replace(' ', '-', $dept_translit));
255
				$this->conteneur->chargerConfiguration('config_departements_bruts.ini');
256
				$dpt_numero = $this->conteneur->getParametre($dpt_chaine);
257
				if (!empty($dpt_numero)) {
258
					$paramFiltre = str_pad($dpt_numero, 5, '_');
259
				}
260
			}
261
			$this->parametresFiltres['masque.departement'] = $paramFiltre;
262
		}
263
	}
264
 
265
	private function filtrerDate() {
266
		if (isset($this->parametres['masque.date'])) {
267
			$date = $this->parametres['masque.date'];
268
			$paramFiltre = null;
1871 jpm 269
			if (preg_match('/^\d{4}$/', $date)) {
1840 jpm 270
				$paramFiltre = $date;
1871 jpm 271
			} else if (strpos($date, '/') !== false) {
272
				// Format d'entrée DEL : jj/mm/yyyy
273
				list($jour, $mois, $annee) = explode('/', $date);
274
				$paramFiltre = "$annee-$mois-$jour";
275
			} else if (preg_match('/^\d{4}-\d{2}-\d{2}$/', $date)) {
276
				$paramFiltre = $date;
1840 jpm 277
			}
278
			$this->parametresFiltres['masque.date'] = $paramFiltre;
279
		}
280
	}
281
 
282
	private function filtrerNn() {
283
		if (isset($this->parametres['masque.nn'])) {
284
			$options = array(
285
				'options' => array(
286
					'default' => null,
287
					'min_range' => 0,
288
					'max_range' => self::LISTE_OBS_MAX_BDTFX_NN));
289
			$paramFiltre = filter_var($this->parametres['masque.nn'], FILTER_VALIDATE_INT, $options);
290
			$this->parametresFiltres['masque.nn'] = $paramFiltre;
291
		}
292
	}
293
 
294
	private function filtrerNt() {
295
		if (isset($this->parametres['masque.nt'])) {
296
			$options = array(
297
				'options' => array(
298
					'default' => null,
299
					'min_range' => 0,
300
					'max_range' => self::LISTE_OBS_MAX_BDTFX_NT));
301
			$paramFiltre = filter_var($this->parametres['masque.nt'], FILTER_VALIDATE_INT, $options);
302
			$this->parametresFiltres['masque.nt'] = $paramFiltre;
303
		}
304
	}
305
 
306
	private function supprimerCaracteresInvisibles(Array $liste_params) {
307
		foreach ($liste_params as $param) {
308
			if (isset($this->parametres[$param])) {
309
				$this->parametresFiltres[$param] = trim($this->parametres[$param]);
310
			}
311
		}
312
	}
313
 
314
	private function filtrerFamille() {
315
		if (isset($this->parametres['masque.famille'])) {
316
			// mysql -N<<<"SELECT DISTINCT famille FROM bdtfx_v1_02;"|sed -r "s/(.)/\1\n/g"|sort -u|tr -d "\n"
317
			$familleTranslit = iconv('UTF-8', 'ASCII//TRANSLIT',$this->parametres['masque.famille']);
318
			$paramFiltre = preg_replace('/[^a-zA-Z %_]/', '', $familleTranslit);
319
			$this->parametresFiltres['masque.famille'] = $paramFiltre;
320
		}
321
	}
322
 
323
	// Idem pour id_zone_geo qui mappait à ce_zone_geo:
324
	private function filtrerIdZoneGeo() {
325
		if (isset($this->parametres['masque.id_zone_geo'])) {
326
			if (preg_match('/^(INSEE-C:\d{5}|\d{2})$/', $this->parametres['masque.id_zone_geo'])) {
327
				$paramFiltre = $this->parametres['masque.id_zone_geo'];
328
				$this->parametresFiltres['masque.id_zone_geo'] = $paramFiltre;
329
			}
330
		}
331
	}
332
 
333
	/** masque.commune (zone_geo)
334
	 * TODO: que faire avec des '%' en INPUT ?
335
	 * Le masque doit *permettre* une regexp et non l'imposer. Charge au client de faire son travail.
336
	 */
337
	private function filtrerCommune() {
338
		if (isset($this->parametres['masque.commune'])) {
339
			$paramFiltre = str_replace(array('-',' '), '_', $this->parametres['masque.commune']);
340
			$this->parametresFiltres['masque.commune'] = $paramFiltre;
341
		}
342
	}
343
 
344
	private function filtrerTagCel() {
345
		if (isset($this->parametres['masque.tag_cel'])) {
346
			$this->parametresFiltres['masque.tag_cel'] = $this->construireTableauTags($this->parametres['masque.tag_cel'], 'OR', ',');
347
		} else if (isset($this->parametres['masque'])) {
348
			$this->parametresFiltres['masque.tag_cel'] = $this->construireTableauTags($this->parametres['masque'], 'AND', ' ');
349
			$this->parametresFiltres['_parametres_condition_or_'][] = 'masque.tag_cel';
350
		}
351
	}
352
 
353
	private function filtrerTagDel() {
354
		if (isset($this->parametres['masque.tag_del'])) {
355
			$this->parametresFiltres['masque.tag_del'] = $this->construireTableauTags($this->parametres['masque.tag_del'], 'OR', ',');
356
		} else if (isset($this->parametres['masque'])) {
357
			$this->parametresFiltres['masque.tag_del'] = $this->construireTableauTags($this->parametres['masque'], 'AND', ' ');
358
			$this->parametresFiltres['_parametres_condition_or_'][] = 'masque.tag_del';
359
		}
360
	}
361
 
1845 jpm 362
 
363
	/**
364
	 * Construit un (vulgaire) abstract syntax tree:
365
	 * "AND" => [ "tag1", "tag2" ]
366
	 * Idéalement (avec un parser simple comme proposé par http://hoa-project.net/Literature/Hack/Compiler.html#Langage_PP)
367
	 * nous aurions:
368
	 * "AND" => [ "tag1", "tag2", "OR" => [ "tag3", "tag4" ] ]
369
	 *
370
	 * Ici nous devons traiter les cas suivants:
371
	 * tags séparés par des "ET/AND OU/OR", séparés par des espaces ou des virgules.
372
	 * Mais la chaîne peut aussi avoir été issue du "masque général" (la barre de recherche générique).
373
	 * ce qui implique des comportement par défaut différents afin de préserver la compatibilité.
374
	 *
375
	 * Théorie:
376
	 * 1) tags passés par "champ tag":
377
	 * - support du ET/OU, et explode par virgule.
378
	 * - si pas d'opérande détectée: "OU"
379
	 *
380
	 * 2) tags passés par "recherche générale":
381
	 * - support du ET/OU, et explode par whitespace.
382
	 * - si pas d'opérande détectée: "ET"
383
	 *
384
	 * La présence de $additional_sep s'explique car ET/OU sous-entendent une séparation par des espaces.
385
	 * Mais ce n'est pas toujours pertinent car: 1) la compatibilité suggère de considérer parfois
386
	 * la virgule comme séparateur et 2) les tags *peuvent* contenir des espaces. Par conséquent:
387
	 * * a,b,c => "a" $default_op "b" $default_op "c"
388
	 * * a,b AND c => "a" AND "b" AND "c"
389
	 * * a OR b AND c,d => "a" AND "b" AND "c" AND "d"
390
	 * C'est à dire par ordre décroissant de priorité:
391
	 * 1) opérande contenu dans la chaîne
392
	 * 2) opérande par défaut
393
	 * 3) les séparateurs présents sont substitués par l'opérande déterminée par 1) ou 2)
394
	 *
395
	 * // TODO: support des parenthèses, imbrications & co: "(", ")"
396
	 * // http://codehackit.blogspot.fr/2011/08/expression-parser-in-php.html
397
	 * // http://blog.angeloff.name/post/2012/08/05/php-recursive-patterns/
398
	 *
399
	 * @param $str: la chaîne à "parser"
400
	 * @param $operateur_par_defaut: "AND" ou "OR"
401
	 * @param $separateur_additionnel: séparateur de mots:
402
	 */
403
	public function construireTableauTags($str = null, $operateur_par_defaut, $separateur_additionnel = ',') {
404
		if (!$str) return;
405
		$op = $this->definirOperateurParDefaut($str, $operateur_par_defaut);
406
 
407
		$mots = preg_split('/ (OR|AND|ET|OU) /', $str, -1, PREG_SPLIT_NO_EMPTY);
408
		if ($separateur_additionnel) {
409
			foreach ($mots as $index => $mot) {
410
				$mot = trim($mot);
411
				$mots_separes = preg_split("/$separateur_additionnel/", $mot, -1, PREG_SPLIT_NO_EMPTY);
412
				$mots[$index] = array_shift($mots_separes);
413
				$mots = array_merge($mots, $mots_separes);
414
			}
415
		}
416
		$mots = array_filter($mots);
417
		return array($op => $mots);
418
	}
419
 
420
	private function definirOperateurParDefaut($str, $operateur_par_defaut) {
421
		$op = $operateur_par_defaut;
422
		if (preg_match('/\b(ET|AND)\b/', $str)) {
423
			$op = 'AND';
424
		} else if(preg_match('/\b(OU|OR)\b/', $str)) {
425
			$op = 'OR';
426
		}
427
		return $op;
428
	}
429
 
1840 jpm 430
	// masque.type: ['adeterminer', 'aconfirmer', 'endiscussion', 'validees']
431
	private function filtrerType() {
1852 jpm 432
		if (isset($this->parametres['masque.type'])) {
1840 jpm 433
			$typesArray = explode(';', $this->parametres['masque.type']);
434
			$typesFiltres = array_filter($typesArray);
1853 jpm 435
			$typesAutorises = $this->conteneur->getParametreTableau('valeurs_type');
1840 jpm 436
			$typesValides = array_intersect($typesFiltres, $typesAutorises);
437
			$paramFiltre = array_flip($typesValides);
438
			$this->parametresFiltres['masque.type'] = $paramFiltre;
439
		}
440
	}
441
 
442
	private function filtrerProtocole() {
443
		// ces critère de tri des image à privilégier ne s'applique qu'à un protocole donné
444
		if (!isset($this->parametres['protocole']) || !is_numeric($this->parametres['protocole'])) {
445
			$this->parametresFiltres['protocole'] = $this->conteneur->getParametre('appli_img.protocole_defaut');
446
		} else {
447
			$this->parametresFiltres['protocole'] = intval($this->parametres['protocole']);
448
		}
449
	}
450
 
451
	private function supprimerParametresFiltresInvalides() {
452
		// Suppression des NULL, FALSE et '', mais pas des 0, d'où l'utilisation de 'strlen'.
453
		// La fonction 'strlen' permet de supprimer les NULL, FALSE et chaines vides mais gardent les valeurs 0 (zéro).
454
		// Les valeurs spéciales contenant des tableaux (tag, _parametres_condition_or_) ne sont pas prise en compte
455
		foreach ($this->parametresFiltres as $cle => $valeur) {
456
			if (is_array($valeur) || strlen($valeur) !== 0) {
457
				$this->parametresFiltres[$cle] = $valeur;
458
			}
459
		}
460
	}
1793 jpm 461
}