Subversion Repositories eFlore/Applications.del

Rev

Details | Last modification | View Log | RSS feed

Rev Author Line No. Line
2212 arthur 1
<?php
2
// declare(encoding='UTF-8');
3
/**
4
 * Classe contenant des méthodes de filtrage/formatage des paramètres de recherche passés dans l'URL.
5
 *
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.
8
 *
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>
18
 * @copyright 1999-2014 Tela Botanica <accueil@tela-botanica.org>
19
 */
20
class ParametresFiltrage {
21
 
22
	const APPLI_IMG = 'IMG';
23
	const APPLI_OBS = 'OBS';
24
 
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();
34
	private $appli;
35
 
36
	public function __construct($conteneur) {
37
		$this->conteneur = $conteneur;
38
		$this->contexte = $this->conteneur->getContexte();
39
		$this->parametres = $this->contexte->getQS();
40
	}
41
 
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
 
50
	public function filtrerUrlParamsAppliImg() {
51
		$this->appli = self::APPLI_IMG;
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() {
75
		$this->appli = self::APPLI_OBS;
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
 
88
		$trisPossibles = $this->conteneur->getParametreTableau('appli_obs.tris_possibles');
89
		$this->detruireParametreInvalide('tri', $trisPossibles);
90
 
91
		$this->supprimerParametresFiltresInvalides();
92
		return $this->parametresFiltres;
93
	}
94
 
95
	private function maintenirCompatibilitesParametres() {
96
		$this->renommerParametres();
97
 
98
		if ($this->etreAppliImg() && !isset($this->parametres['masque.tag_del']) && isset($this->parametres['masque.tag'])) {
99
			$this->parametres['masque.tag_del'] = $this->parametres['masque.tag'];
100
			unset($this->parametres['masque.tag']);
101
		}
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
		}
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
 
149
				'masque.standard','masque.ns', 'masque.famille', 'masque.date', 'masque.genre', 'masque.milieu');
150
 
151
			// 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.
152
			foreach ($masquesDetailCles as $cle) {
153
				if (isset($this->parametres[$cle]) === false) {
154
					$this->parametres[$cle] = $masqueGeneral;
155
					$this->parametresFiltres['_parametres_condition_or_'][] = $cle;
156
				}
157
			}
158
		}
159
	}
160
 
161
	/**
162
	 * Filtre et valide les paramètres reconnus. Effectue *toute* la sanitization *sauf* l'escape-string
163
	 * Cette fonction est appelée:
164
	 * - une fois sur les champs de recherche avancées
165
	 * - une fois sur le masque général si celui-ci à été spécifié. Dans ce cas,
166
	 * la chaîne générale saisie est utilisée comme valeur pour chacun des champs particuliers
167
	 * avec les traitements particuliers qui s'imposent
168
	 * Par exemple: si l'on cherche "Languedoc", cela impliquera:
169
	 * WHERE (nom_sel like "Languedoc" OR nom_ret ... OR ...) mais pas masque.date ou masque.departement
170
	 * qui s'assure d'un pattern particulier
171
	 *
172
	 * masque.genre est un alias pour masque.ns (nom_sel), mais permet de rajouter une clause supplémentaire
173
	 * sur nom_sel. Précédemment: WHERE nom_sel LIKE '%<masque.genre>% %'.
174
	 * Désormais masque.genre doit être intégralement spécifié, les caractères '%' et '_' seront interprétés.
175
	 * Attention toutefois car la table del_observation intègre des nom_sel contenant '_'
176
	 */
177
	// TODO: ajouter un filtre sur le masque (général)
178
	private function filtrerUrlParamsGeneraux() {
179
		$this->detruireParametreInvalide('ordre', $this->conteneur->getParametreTableau('valeurs_ordre'));
180
		$this->detruireParametreInvalide('masque.referentiel', $this->conteneur->getParametreTableau('valeurs_referentiel'));
181
 
182
		$this->filtrerNavigationLimite();
183
		$this->filtrerNavigationDepart();
184
		$this->filtrerDepartement();
185
		$this->filtrerDate();
186
		$this->filtrerNn();
187
		$this->filtrerNt();
188
 
189
		$parametresATrimer = array('masque', 'masque.ns', 'masque.genre', 'masque.espece', 'masque.auteur', 'masque.milieu');
190
		$this->supprimerCaracteresInvisibles($parametresATrimer);
191
 
192
		$this->filtrerFamille();
193
		$this->filtrerPays();
194
		$this->filtrerIdZoneGeo();
195
		$this->filtrerCommune();
196
		$this->filtrerType();
197
		$this->filtrerStandard();
198
		$this->filtrerPnInscrits();
199
 
200
		$this->filtrerTagCel();
201
		$this->filtrerTagDel();
202
	}
203
 
204
 
205
	/**
206
	 * Supprime l'index du tableau des paramètres si sa valeur ne correspond pas
207
	 * au spectre passé par $values.
208
	 */
209
	private function detruireParametreInvalide($index, Array $valeursAutorisees) {
210
		if (array_key_exists($index, $this->parametres)) {
211
			if (!in_array($this->parametres[$index], $valeursAutorisees)) {
212
				unset($this->parametres[$index]);
213
			} else {
214
				$this->parametresFiltres[$index] = $this->parametres[$index];
215
			}
216
		}
217
	}
218
 
219
	private function filtrerNavigationLimite() {
220
		if (isset($this->parametres['navigation.limite'])) {
221
			$options = array(
222
				'options' => array(
223
					'default' => null,
224
					'min_range' => 1,
225
					'max_range' => self::LISTE_OBS_MAX_RESULT_LIMIT));
226
			$paramFiltre = filter_var($this->parametres['navigation.limite'], FILTER_VALIDATE_INT, $options);
227
			$this->parametresFiltres['navigation.limite'] = $paramFiltre;
228
		}
229
	}
230
 
231
	private function filtrerNavigationDepart() {
232
		if (isset($this->parametres['navigation.depart'])) {
233
			$options = array(
234
				'options' => array(
235
					'default' => null,
236
					'min_range' => 0,
237
					'max_range' => self::LISTE_OBS_MAX_ID_OBS));
238
			$paramFiltre = filter_var($this->parametres['navigation.depart'], FILTER_VALIDATE_INT, $options);
239
			$this->parametresFiltres['navigation.depart'] = $paramFiltre;
240
		}
241
	}
242
 
243
	/**
244
	 * STRING: 0 -> 95, 971 -> 976, 2A + 2B (./services/configurations/config_departements_bruts.ini)
245
	 * accept leading 0 ?
246
	 * TODO; filter patterns like 555.
247
	 *
248
	 * @return type
249
	 */
250
	private function filtrerDepartement() {
251
		if (isset($this->parametres['masque.departement'])) {
252
			$dept = $this->parametres['masque.departement'];
253
			$paramFiltre = null;
254
			if (preg_match('/^(\d{2}|\d{3}|2a|2b)$/i', $dept) != 0) {
255
				$paramFiltre = is_numeric($dept) ? str_pad($dept, 5, '_') : $dept;
256
			} else {
257
				$dept_translit = iconv('UTF-8', 'ASCII//TRANSLIT', $dept);
258
				$dpt_chaine = strtolower(str_replace(' ', '-', $dept_translit));
259
				$this->conteneur->chargerConfiguration('config_departements_bruts.ini');
260
				$dpt_numero = $this->conteneur->getParametre($dpt_chaine);
261
				if (!empty($dpt_numero)) {
262
					$paramFiltre = str_pad($dpt_numero, 5, '_');
263
				}
264
			}
265
			$this->parametresFiltres['masque.departement'] = $paramFiltre;
266
		}
267
	}
268
 
269
	private function filtrerDate() {
270
		if (isset($this->parametres['masque.date'])) {
271
			$date = $this->parametres['masque.date'];
272
			$paramFiltre = null;
273
			if (preg_match('/^\d{4}$/', $date)) {
274
				$paramFiltre = $date;
275
			} else if (strpos($date, '/') !== false) {
276
				// Format d'entrée DEL : jj/mm/yyyy
277
				list($jour, $mois, $annee) = explode('/', $date);
278
				$paramFiltre = "$annee-$mois-$jour";
279
			} else if (preg_match('/^\d{4}-\d{2}-\d{2}$/', $date)) {
280
				$paramFiltre = $date;
281
			}
282
			$this->parametresFiltres['masque.date'] = $paramFiltre;
283
		}
284
	}
285
 
286
	private function filtrerNn() {
287
		if (isset($this->parametres['masque.nn'])) {
288
			$options = array(
289
				'options' => array(
290
					'default' => null,
291
					'min_range' => 0,
292
					'max_range' => self::LISTE_OBS_MAX_BDTFX_NN));
293
			$paramFiltre = filter_var($this->parametres['masque.nn'], FILTER_VALIDATE_INT, $options);
294
			$this->parametresFiltres['masque.nn'] = $paramFiltre;
295
		}
296
	}
297
 
298
	private function filtrerNt() {
299
		if (isset($this->parametres['masque.nt'])) {
300
			$options = array(
301
				'options' => array(
302
					'default' => null,
303
					'min_range' => 0,
304
					'max_range' => self::LISTE_OBS_MAX_BDTFX_NT));
305
			$paramFiltre = filter_var($this->parametres['masque.nt'], FILTER_VALIDATE_INT, $options);
306
			$this->parametresFiltres['masque.nt'] = $paramFiltre;
307
		}
308
	}
309
 
310
	private function supprimerCaracteresInvisibles(Array $liste_params) {
311
		foreach ($liste_params as $param) {
312
			if (isset($this->parametres[$param])) {
313
				$this->parametresFiltres[$param] = trim($this->parametres[$param]);
314
			}
315
		}
316
	}
317
 
318
	private function filtrerFamille() {
319
		if (isset($this->parametres['masque.famille'])) {
320
			// mysql -N<<<"SELECT DISTINCT famille FROM bdtfx_v1_02;"|sed -r "s/(.)/\1\n/g"|sort -u|tr -d "\n"
321
			$familleTranslit = iconv('UTF-8', 'ASCII//TRANSLIT',$this->parametres['masque.famille']);
322
			$paramFiltre = preg_replace('/[^a-zA-Z %_]/', '', $familleTranslit);
323
			$this->parametresFiltres['masque.famille'] = $paramFiltre;
324
		}
325
	}
326
 
327
	// Idem pour id_zone_geo qui mappait à ce_zone_geo:
328
	private function filtrerIdZoneGeo() {
329
		if (isset($this->parametres['masque.id_zone_geo'])) {
330
			if (preg_match('/^(INSEE-C:\d{5}|\d{2})$/', $this->parametres['masque.id_zone_geo'])) {
331
				$paramFiltre = $this->parametres['masque.id_zone_geo'];
332
				$this->parametresFiltres['masque.id_zone_geo'] = $paramFiltre;
333
			}
334
		}
335
	}
336
 
337
	// Idem pour id_zone_geo qui mappait à ce_zone_geo:
338
	private function filtrerPays() {
339
		if (isset($this->parametres['masque.pays'])) {
340
			// une liste de pays séparés par des virgules est acceptable
341
			if (preg_match('/^([a-zA-Z]{2},)*[a-zA-Z]{2}$/', $this->parametres['masque.pays'])) {
342
				// Nettoyage d'une virgule terminale au cas ou
343
				$this->parametres['masque.pays'] = rtrim($this->parametres['masque.pays'], ',');
344
				$paramFiltre = $this->parametres['masque.pays'];
345
				$this->parametresFiltres['masque.pays'] = $paramFiltre;
346
			}
347
		}
348
	}
349
 
350
	protected function filtrerPnInscrits() {
351
		if (isset($this->parametres['masque.pninscritsseulement'])) {
352
			if ($this->parametres['masque.pninscritsseulement'] == 1) {
353
				$this->parametresFiltres['masque.pninscritsseulement'] = 1;
354
			}
355
		}
356
	}
357
 
358
	/** masque.commune (zone_geo)
359
	 * TODO: que faire avec des '%' en INPUT ?
360
	 * Le masque doit *permettre* une regexp et non l'imposer. Charge au client de faire son travail.
361
	 */
362
	private function filtrerCommune() {
363
		if (isset($this->parametres['masque.commune'])) {
364
			$paramFiltre = str_replace(array('-',' '), '_', $this->parametres['masque.commune']);
365
			$this->parametresFiltres['masque.commune'] = $paramFiltre;
366
		}
367
	}
368
 
369
	private function filtrerStandard() {
370
		if (isset($this->parametres['masque.standard']) & $this->parametres['masque.standard'] == 1) {
371
			$this->parametresFiltres['masque.standard'] = 1;
372
		}
373
	}
374
 
375
	private function filtrerTagCel() {
376
		if (isset($this->parametres['masque.tag_cel'])) {
377
			$this->parametresFiltres['masque.tag_cel'] = $this->construireTableauTags($this->parametres['masque.tag_cel'], 'OR', ',');
378
		} else if (isset($this->parametres['masque'])) {
379
			$this->parametresFiltres['masque.tag_cel'] = $this->construireTableauTags($this->parametres['masque'], 'AND', ' ');
380
			$this->parametresFiltres['_parametres_condition_or_'][] = 'masque.tag_cel';
381
		}
382
	}
383
 
384
	private function filtrerTagDel() {
385
		if (isset($this->parametres['masque.tag_del'])) {
386
			$this->parametresFiltres['masque.tag_del'] = $this->construireTableauTags($this->parametres['masque.tag_del'], 'OR', ',');
387
		} else if (isset($this->parametres['masque'])) {
388
			$this->parametresFiltres['masque.tag_del'] = $this->construireTableauTags($this->parametres['masque'], 'AND', ' ');
389
			$this->parametresFiltres['_parametres_condition_or_'][] = 'masque.tag_del';
390
		}
391
	}
392
 
393
 
394
	/**
395
	 * Construit un (vulgaire) abstract syntax tree:
396
	 * "AND" => [ "tag1", "tag2" ]
397
	 * Idéalement (avec un parser simple comme proposé par http://hoa-project.net/Literature/Hack/Compiler.html#Langage_PP)
398
	 * nous aurions:
399
	 * "AND" => [ "tag1", "tag2", "OR" => [ "tag3", "tag4" ] ]
400
	 *
401
	 * Ici nous devons traiter les cas suivants:
402
	 * tags séparés par des "ET/AND OU/OR", séparés par des espaces ou des virgules.
403
	 * Mais la chaîne peut aussi avoir été issue du "masque général" (la barre de recherche générique).
404
	 * ce qui implique des comportement par défaut différents afin de préserver la compatibilité.
405
	 *
406
	 * Théorie:
407
	 * 1) tags passés par "champ tag":
408
	 * - support du ET/OU, et explode par virgule.
409
	 * - si pas d'opérande détectée: "OU"
410
	 *
411
	 * 2) tags passés par "recherche générale":
412
	 * - support du ET/OU, et explode par whitespace.
413
	 * - si pas d'opérande détectée: "ET"
414
	 *
415
	 * La présence de $additional_sep s'explique car ET/OU sous-entendent une séparation par des espaces.
416
	 * Mais ce n'est pas toujours pertinent car: 1) la compatibilité suggère de considérer parfois
417
	 * la virgule comme séparateur et 2) les tags *peuvent* contenir des espaces. Par conséquent:
418
	 * * a,b,c => "a" $default_op "b" $default_op "c"
419
	 * * a,b AND c => "a" AND "b" AND "c"
420
	 * * a OR b AND c,d => "a" AND "b" AND "c" AND "d"
421
	 * C'est à dire par ordre décroissant de priorité:
422
	 * 1) opérande contenu dans la chaîne
423
	 * 2) opérande par défaut
424
	 * 3) les séparateurs présents sont substitués par l'opérande déterminée par 1) ou 2)
425
	 *
426
	 * // TODO: support des parenthèses, imbrications & co: "(", ")"
427
	 * // http://codehackit.blogspot.fr/2011/08/expression-parser-in-php.html
428
	 * // http://blog.angeloff.name/post/2012/08/05/php-recursive-patterns/
429
	 *
430
	 * @param $str: la chaîne à "parser"
431
	 * @param $operateur_par_defaut: "AND" ou "OR"
432
	 * @param $separateur_additionnel: séparateur de mots:
433
	 */
434
	public function construireTableauTags($str = null, $operateur_par_defaut, $separateur_additionnel = ',') {
435
		if (!$str) return;
436
		$op = $this->definirOperateurParDefaut($str, $operateur_par_defaut);
437
 
438
		$mots = preg_split('/ (OR|AND|ET|OU) /', $str, -1, PREG_SPLIT_NO_EMPTY);
439
		if ($separateur_additionnel) {
440
			foreach ($mots as $index => $mot) {
441
				$mot = trim($mot);
442
				$mots_separes = preg_split("/$separateur_additionnel/", $mot, -1, PREG_SPLIT_NO_EMPTY);
443
				$mots[$index] = array_shift($mots_separes);
444
				$mots = array_merge($mots, $mots_separes);
445
			}
446
		}
447
		$mots = array_filter($mots);
448
		return array($op => $mots);
449
	}
450
 
451
	private function definirOperateurParDefaut($str, $operateur_par_defaut) {
452
		$op = $operateur_par_defaut;
453
		if (preg_match('/\b(ET|AND)\b/', $str)) {
454
			$op = 'AND';
455
		} else if(preg_match('/\b(OU|OR)\b/', $str)) {
456
			$op = 'OR';
457
		}
458
		return $op;
459
	}
460
 
461
	// masque.type: ['adeterminer', 'aconfirmer', 'endiscussion', 'validees', 'monactivite']
462
	private function filtrerType() {
463
		if (isset($this->parametres['masque.type'])) {
464
			$typesArray = explode(';', $this->parametres['masque.type']);
465
			$typesFiltres = array_filter($typesArray);
466
			$typesAutorises = $this->conteneur->getParametreTableau('valeurs_type');
467
			$typesValides = array_intersect($typesFiltres, $typesAutorises);
468
			$paramFiltre = array_flip($typesValides);
469
			$this->parametresFiltres['masque.type'] = $paramFiltre;
470
		}
471
	}
472
 
473
	private function filtrerProtocole() {
474
		// ces critère de tri des image à privilégier ne s'applique qu'à un protocole donné
475
		if (!isset($this->parametres['protocole']) || !is_numeric($this->parametres['protocole'])) {
476
			$this->parametresFiltres['protocole'] = $this->conteneur->getParametre('appli_img.protocole_defaut');
477
		} else {
478
			$this->parametresFiltres['protocole'] = intval($this->parametres['protocole']);
479
		}
480
	}
481
 
482
	private function supprimerParametresFiltresInvalides() {
483
		// Suppression des NULL, FALSE et '', mais pas des 0, d'où l'utilisation de 'strlen'.
484
		// La fonction 'strlen' permet de supprimer les NULL, FALSE et chaines vides mais gardent les valeurs 0 (zéro).
485
		// Les valeurs spéciales contenant des tableaux (tag, _parametres_condition_or_) ne sont pas prise en compte
486
		foreach ($this->parametresFiltres as $cle => $valeur) {
487
			if (is_array($valeur) || strlen($valeur) !== 0) {
488
				$this->parametresFiltres[$cle] = $valeur;
489
			}
490
		}
491
	}
492
}