Subversion Repositories eFlore/Applications.del

Rev

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