Subversion Repositories eFlore/Projets.eflore-projets

Rev

Go to most recent revision | Details | Last modification | View Log | RSS feed

Rev Author Line No. Line
6 jpm 1
<?php
2
/**
3
* Description :
4
* Classe ZoneGeo.php fournit des informations sur ensemble structuré des termes et concepts représentant les éléments
5
* d'un domaine de connaissances .
6
* Le but étant de fournir un ensemble minimal d'information comprenant :
7
* un identifiant (numérique ou alphanumérique sous forme de ChatMot si possible), un nom, une region et
8
* éventuellement une relation hiérarchique avec un autre terme (=classe).
9
* Si l'url finit par /zone-geo on retourne une liste de termes (seulement les 100 premières par défaut).
10
* L'url peut contenir des paramètres optionnels passés après le ? : /observations?param1=val1&param2=val2&...
11
*
12
* Les paramètres de requête disponibles sont : masque, masque.code, masque.nom, masque.region , recherche,
13
* distinct, retour.format, navigation.depart et navigation.limite.
14
*
15
* Encodage en entrée : utf8
16
* Encodage en sortie : utf8
17
* @package framework-v3
18
* @author Delphine Cauquil <delphine@tela-botanica.org>
19
* @author Jennifer Dhé <jennifer.dhe@tela-botanica.org>
20
* @license GPL v3 <http://www.gnu.org/licenses/gpl.txt>
21
* @license CECILL v2 <http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt>
22
* @version 1.0
23
* @copyright 1999-${year} Tela Botanica (accueil@tela-botanica.org)
24
*/
25
 
26
class ZoneGeo extends Commun {
27
 
28
	protected $service = 'zone-geo';
29
 
30
	/**
31
	 * Permet de stocker la requete formulée : /zone-geo | /zone-geo/#id | /zone-geo/#id/champ | /zone-geo/#id/relations
32
	 * Est remplit au cours de l'analyse des ressources (traiterRessources()), par défaut, a la valeur du service.
33
	 * Est utilisée principalement pr déterminer le format du tableau à retourner.	 */
34
	protected $format_reponse = 'zone-geo';
35
 
36
	/** Variables constituant les parametres de la requete SQL (champ, condition, group by, limit) remplie
37
	 * selon ressources et paramètres	 */
38
	protected $requete_champ = ' * ';
39
	protected $requete_condition = '';
40
	protected $limite_requete = array(
41
		'depart' => 0,
42
		'limite' => 100
43
	);
44
 
45
	/** Stockage des ressources et paramétres */
46
	protected $table_ressources = array();
47
	protected $table_param = array();
48
	/**
49
	 * Precise la contenance plus ou moins précise du tableau à retourner :
50
	 *  - min = les données présentes dans la table
51
	 *  - max = les données de la table + les informations complémentaires (pour les identifiants et les codes)
52
	 *  - oss = la liste des nom_sci (uniquement pour noms et taxons)
53
	 */
54
	protected $retour_format = 'max';
55
	/** Valeur du paramètre de requete recherche :
56
	 *  - stricte : le masque est passé tel quel à l'opérateur LIKE.
57
	 *  - etendue : ajout automatique du signe % à la place des espaces et en fin de masque avec utilisation de LIKE.
58
	 *  - floue : recherche tolérante vis-à-vis d'approximations ou d'erreurs (fautes d'orthographe par exemple) */
59
	protected $recherche;
60
 
61
	/** Permet de stocker le tableau de résultat (non encodé en json) */
62
	protected $table_retour = array();
63
	/** Stocke le nombre total de résultats de la requete principale. Est calculée lors de l'assemblage de la requete */
64
	protected $total_resultat;
65
 
66
// +-------------------------------------------------------------------------------------------------------------------+
67
	public function consulter($ressources, $parametres) {
68
		$this->traiterParametres($parametres);
69
		$this->traiterVersionProjet($ressources);
70
		$this->traiterRessources($ressources);
71
		$resultat_formate = '';
72
 
73
		if ($this->corps_http == '' && $this->entete_http == '') {
74
			foreach ($this->table_version as $version) {
75
				$this->table = $version; //on stocke le nom de la table correspondant à la version du projet en cours
76
				$requete = $this->assemblerLaRequete(); //print_r($requete);
77
				$resultat = $this->getBdd()->recupererTous($requete);
78
				$res_version = $this->testerResultat($resultat, $requete);
79
			}
80
			if ($this->corps_http == '' && $this->entete_http == '') {
81
				if (isset($res_version)) {
82
					$resultat_formate = json_encode($res_version);
83
				}
84
			}
85
		}
86
		$this->formerReponseHTTP($resultat_formate);
87
	}
88
 
89
	public function testerResultat($resultat, $requete) {
90
		if ($resultat == '') { //cas ou la requete comporte des erreurs
91
			$s = 'La requête SQL formée comporte une erreur !!';
92
			Debug::printr($requete);
93
			$this->renvoyerErreur(RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE, $s);
94
		} elseif ($resultat) {
95
			if (count($this->table_version) > 1) {
96
				$res_version[$version] = $this->retournerResultatFormate($resultat);
97
			} else {
98
				$res_version = $this->retournerResultatFormate($resultat);
99
			}
100
		} else {
101
			if ($this->format_reponse == 'zone-geo/id/relations') {
102
				//si aucune relation n'existe, la valeur null est retournée
103
				$res_version = null;
104
			} else {
105
				$d = 'Données recherchées introuvables dans la base';
106
				$this->renvoyerErreur(RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE, $d);
107
				Debug::printr($requete);
108
			}
109
		}
110
		return $res_version;
111
	}
112
 
113
// +-------------------------------------------------------------------------------------------------------------------+
114
	public function traiterParametres($parametres) {
115
		if (isset($parametres) && !empty($parametres)) {
116
			$this->table_param = $parametres;
117
 
118
		//   masque : filtre la liste en fonction d'un masque de recherche portant sur le code, le nom ou la region.
119
        //   masque.code : filtre uniquement sur le code. masque.nom : filtre uniquement sur le nom.
120
        //   masque.region : filtre uniquement sur la region.
121
			if (isset($parametres['recherche']) && $parametres['recherche'] != '') {
122
				$this->recherche = $parametres['recherche'];
123
			}
124
 
125
			foreach ($parametres as $param => $valeur) {
126
				switch ($param) {
127
					case 'masque'				: $this->ajouterLeFiltreMasque('masque', $valeur);			break;
128
					case 'masque_code'			: $this->ajouterLeFiltreMasque('dep', $valeur);				break;
129
					case 'masque_nom'			: $this->ajouterLeFiltreMasque('nccenr', $valeur);			break;
130
					case 'masque_region'		: $this->ajouterLeFiltreMasque('region', $valeur);			break;
131
					case 'retour_format'		: $this->retour_format = $valeur;							break;
132
					case 'navigation_depart'	: $this->limite_requete['depart'] = $valeur;				break;
133
					case 'navigation_limite'	: $this->limite_requete['limite'] = $valeur;				break;
134
					case 'recherche'			:															break;
135
					default						:  $p = 'Erreur dans les paramètres de recherche de votre requête : '.
136
													'</br> Le paramètre " '.$param.' " n\'existe pas.';
137
												$this->renvoyerErreur(RestServeur::HTTP_CODE_MAUVAISE_REQUETE, $p);	break;
138
				}
139
			}
140
		}
141
	}
142
 
143
	public function ajouterLeFiltreMasque($nom_champ, $valeur) {
144
		if ($nom_champ == 'dep' || $nom_champ == 'region') {
145
			$this->requete_condition[] = $nom_champ.' = '.$this->getBdd()->proteger($valeur);
146
		} else {
147
			if ($this->recherche == 'floue') {
148
				if ($nom_champ == 'masque') {
149
					$this->requete_condition[] = '( dep = '.$this->getBdd()->proteger($valeur)
150
						.' OR region = '.$this->getBdd()->proteger($valeur)
151
						.' OR ( SOUNDEX(nccenr) = SOUNDEX(\''.$valeur.'\')'
152
						.' OR SOUNDEX(REVERSE(nccenr)) = SOUNDEX(REVERSE(\''.$valeur.'\')) '
153
						.')) ';
154
				} else {
155
					$this->requete_condition[] = '(SOUNDEX('.$nom_champ.') = SOUNDEX(\''.$valeur.'\')'
156
						.' OR SOUNDEX(REVERSE('.$nom_champ.')) = SOUNDEX(REVERSE(\''.$valeur.'\'))) ';
157
				}
158
			} else {
159
				if ($this->recherche == 'etendue') {
160
					$valeur = str_replace(' ','%', $valeur);
161
					$valeur .= '%';
162
				}
163
 
164
				if ($nom_champ == 'masque') {
165
					$this->requete_condition[] = ' (dep = '.$this->getBdd()->proteger($valeur)
166
						.' OR nccenr LIKE '.$this->getBdd()->proteger($valeur)
167
						.' OR region = '.$this->getBdd()->proteger($valeur).')';
168
				} else {
169
					$this->requete_condition[] = $nom_champ.' LIKE '.$this->getBdd()->proteger($valeur);
170
				}
171
			}
172
		}
173
	}
174
 
175
 
176
// +-------------------------------------------------------------------------------------------------------------------+
177
	public function traiterRessources(&$ressources) {
178
		if (isset($ressources) && !empty($ressources)) {
179
			$this->table_ressources = $ressources;
180
			if (isset($this->table_ressources[0]) && !empty($this->table_ressources[0])) {
181
				//requete = /zone-geo/#id
182
				$this->traiterRessourceId();
183
				if (isset($this->table_ressources[1]) && !empty($this->table_ressources[1])) {
184
					//dans le cas /zone-geo/#id/#champ ou /zone-geo/#id/relations
185
					$this->traiterRessourceChampOuRelations();
186
				}
187
			}
188
		}
189
	}
190
 
191
	//requete : /zone-geo/#id (ex : /zone-geo/7)
192
	public function traiterRessourceId() {
193
		if (is_numeric($this->table_ressources[0])) {
194
			$this->requete_condition[] = ' dep = '.$this->getBdd()->proteger($this->table_ressources[0]);
195
			$this->format_reponse .= '/id';
196
		} else {
197
			$r = 'Erreur dans les ressources de votre requête : </br> La ressource " '.$this->table_ressources[0].
198
				' " n\'existe pas.';
199
			$this->renvoyerErreur(RestServeur::HTTP_CODE_MAUVAISE_REQUETE, $r);
200
		}
201
	}
202
 
203
 
204
	public function traiterRessourceChampOuRelations() {
205
		//requete = /zone-geo/#id/relations :
206
		if ($this->table_ressources[1] == 'relations') {
207
			$this->format_reponse .= '/relations';
208
			$this->requete_condition[] = 'region = (SELECT region FROM '.$this->table.' WHERE '
209
										.implode(' AND ', $this->requete_condition).')';
210
		//requete = /zone-geo/#id/#champ :
211
		} else {
212
			$this->format_reponse .= '/champ';
213
		}
214
	}
215
 
216
// +-------------------------------------------------------------------------------------------------------------------+
217
	public function assemblerLaRequete() {
218
		//assemblage de la requete :
219
		$requete = ' SELECT '.$this->requete_champ.
220
					' FROM '.$this->table
221
					.$this->formerRequeteCondition()
222
					.$this->formerRequeteLimite();
223
		return $requete;
224
	}
225
 
226
	public  function formerRequeteCondition() {
227
		$condition = '';
228
		if ($this->requete_condition != null) {
229
			$condition = ' WHERE '.implode(' AND ', $this->requete_condition);
230
		}
231
		return $condition;
232
	}
233
 
234
 
235
	//ajout d'une limite seulement pour les listes (pas plus de 100 resultats retournés pr les requetes
236
	// suivantes : /zone-geo et /zone-geo/#id/relations)
237
	public function formerRequeteLimite() {
238
		if ($this->format_reponse != 'zone-geo' && $this->format_reponse != 'zone-geo/id/relations') {
239
			$this->requete_limite = '';
240
		} elseif (($depart = $this->limite_requete['depart']) > ($this->total_resultat = $this->recupererTotalResultat())) {
241
			//cas où la requete presente un navigation.depart supérieur au nb total de resultats.
242
			$this->limite_requete['depart'] =
243
				(($nb - $this->limite_requete['limite']) < 0) ? 0 : ($nb - $this->limite_requete['limite']);
244
			$this->requete_limite = ' LIMIT '.$this->limite_requete['depart'].', '.$this->limite_requete['limite'];
245
		} else {
246
			$this->requete_limite = ' LIMIT '.$this->limite_requete['depart'].', '.$this->limite_requete['limite'];
247
		}
248
		return $this->requete_limite;
249
	}
250
 
251
	public function recupererTotalResultat() {
252
		//on récupère le nombre total de résultats de la requete (ex : le nombre d'id contenu dans la liste /zone-geo)
253
		$requete = 'SELECT count(*) as nombre FROM '
254
			.$this->table
255
			.$this->formerRequeteCondition();
256
		$res = $this->getBdd()->recuperer($requete);
257
 
258
		if ($res) {
259
			$total = $res['nombre'];
260
		} else {
261
			$t = 'Fonction recupererTotalResultat() : <br/>Données introuvables dans la base';
262
			$this->renvoyerErreur(RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE, $t);
263
		}
264
		return $total;
265
	}
266
 
267
// +-------------------------------------------------------------------------------------------------------------------+
268
	// determine en fct du service appelé (/zone-geo | /zone-geo/#id | /zone-geo/#id/champ |
269
	// /zone-geo/#id/relations) le format du tableau à retourner.
270
	public function retournerResultatFormate($resultat) {
271
		$this->recupererTableConfig('correspondance_champs');
272
		switch ($this->format_reponse) {
273
			case 'zone-geo'					: $reponse = $this->formaterZoneGeo($resultat);				break;
274
			case 'zone-geo/id'				: $reponse = $this->formaterZoneGeoId($resultat[0]);		break;
275
			case 'zone-geo/id/champ'		: $reponse = $this->formaterZoneGeoIdChamp($resultat[0]);	break;
276
			case 'zone-geo/id/relations'	: $reponse = $this->formaterZoneGeoIdRelations($resultat);	break;
277
			default							:															break;
278
		}
279
		return $reponse;
280
	}
281
 
282
	public function formaterZoneGeo($resultat) {
283
		//on remplit la table $table_retour_json['entete']
284
		$this->table_retour['depart'] = $this->limite_requete['depart'];
285
		$this->table_retour['limite'] = $this->limite_requete['limite'];
286
		$this->table_retour['total']  = $this->total_resultat;
287
		$url = $this->formulerUrl($this->total_resultat, '/zone-geo');
288
		if ($url['precedent'] != '') { $this->table_retour['href.precedent'] = $url['precedent']; }
289
		if ($url['suivant']   != '') { $this->table_retour['href.suivant']   = $url['suivant']; }
290
		$table_retour_json['entete'] = $this->table_retour;
291
 
292
		//on remplit la table $table_retour_json['resultat']
293
		$this->table_retour = array();
294
		if (isset($this->table_param['masque_nom'])) $resultat = $this->trierRechercheFloue($this->table_param['masque_nom'], $resultat, 'nccenr');
295
		foreach ($resultat as $tab) {
296
			foreach ($tab as $key => $valeur) {
297
				if ($valeur != '') {
298
					switch ($key) {
299
						case 'dep'		: $num = $valeur; $this->table_retour['code'] = $valeur;	break;
300
						case 'nccenr'	: $this->table_retour['nom'] = $valeur;						break;
301
						default			:															break;
302
					}
303
				}
304
			}
305
			if ($this->retour_format == 'max') {
306
				$this->table_retour['href'] = $this->ajouterHref('zone-geo', $num);
307
			}
308
			$resultat_json[$num] = $this->table_retour;
309
			$this->table_retour = array();
310
		}
311
		$table_retour_json['resultat'] = $resultat_json;
312
		return $table_retour_json;
313
	}
314
 
315
	public function formaterZoneGeoId($resultat) {
316
		foreach ($resultat as $key => $valeur) {
317
			if ($valeur != '') {
318
				$this->afficherDonnees($key, $valeur);
319
			}
320
		}
321
		unset($this->table_retour['href']);
322
		return $this->table_retour;
323
	}
324
 
325
	public function formaterZoneGeoIdRelations($resultat) {
326
		if ($resultat == '') {
327
			$retour = null;
328
		} else {
329
			//on remplit la table $table_retour_json['entete']
330
			$this->table_retour['depart'] = $this->limite_requete['depart'];
331
			$this->table_retour['limite'] = $this->limite_requete['limite'];
332
			$this->table_retour['total']  = $this->total_resultat;
333
			//formuler les urls
334
			$url = $this->formulerUrl(count($resultat), '/zone-geo');
335
			if ($url['precedent'] != '') { $this->table_retour['href.precedent'] = $url['precedent']; }
336
			if ($url['suivant']   != '') { $this->table_retour['href.suivant']   = $url['suivant']; }
337
			$retour['entete'] = $this->table_retour;
338
			$this->table_retour = array();
339
 
340
			//on remplit la table $table_retour_json['resultat']
341
			foreach ($resultat as $tab) {
342
				foreach ($tab as $key => $valeur) {
343
					switch ($key) {
344
						case 'dep'		: $num = $valeur; $this->table_retour['code'] = $valeur;	break;
345
						case 'nccenr'	: $this->table_retour['nom'] = $valeur;						break;
346
						default			:					 										break;
347
					}
348
				}
349
				if ($this->retour_format == 'max') $this->table_retour['href'] = $this->ajouterHref('zone-geo', $num);
350
				$resultat_json[$num] = $this->table_retour;
351
				$this->table_retour = array();
352
			}
353
			$retour['resultat'] = $resultat_json;
354
		}
355
		return $retour;
356
	}
357
 
358
	public function formaterZoneGeoIdChamp($resultat) {
359
		//on recupère tous les resultats possibles
360
		$reponse = $this->formaterZoneGeoId($resultat);
361
		$this->table_retour = array();
362
		//on recupère les résultats demandés à partir du tableau de résultat complet
363
		$this->table_retour['id'] = $reponse['code'];
364
		$champs = explode(' ', $this->table_ressources[1]);
365
 
366
		foreach ($champs as $champ) {
367
			if ($this->verifierValiditeChamp($champ)) {
368
				if (strrpos($champ, '.*') !== false) {
369
					$this->afficherPointEtoile($champ, $reponse);
370
 
371
				} else {
372
					if (isset($reponse[$champ])) {
373
						$this->table_retour[$champ] = $reponse[$champ];
374
					} else {
375
						$this->table_retour[$champ] = null;
376
					}
377
				}
378
			}
379
		}
380
		return $this->table_retour;
381
	}
382
 
383
	public function verifierValiditeChamp($champ) {
384
		preg_match('/^([^.]+)(\.([^.]+))?$/', $champ, $match);
385
		$champs_possibles = $this->correspondance_champs;
386
		$champs_possibles[] = 'nom.*';
387
 
388
		if (in_array($match[1], $champs_possibles)) {
389
			$validite = true;
390
		} elseif (in_array($match[0], $champs_possibles)) {
391
			$validite = true;
392
		} else {
393
			$champs_possibles = implode('</li><li>', $champs_possibles);
394
			$c = 'Erreur dans votre requête : </br> Le champ "'.$champ_possibles.'" n\'existe pas. '.
395
				'Les champs disponibles sont : <li>'.$champs_possibles.'</li>';
396
			$this->renvoyerErreur(RestServeur::HTTP_CODE_MAUVAISE_REQUETE, $c);
397
		}
398
		return $validite;
399
	}
400
 
401
	public function afficherPointEtoile($champ, $reponse) {
402
		preg_match('/^([^.]+\.)\*$/', $champ, $match);
403
		foreach ($reponse as $chp => $valeur) {
404
			if (strrpos($chp, $match[1]) !== false) {
405
				if ($valeur != '') {
406
					$this->table_retour[$chp] = $valeur;
407
				} else {
408
					$this->table_retour[$chp] = null;
409
				}
410
			}
411
		}
412
	}
413
 
414
	public function afficherDonnees($champ, $valeur) {
415
		if ($this->retour_format == 'max') {
416
			if ($champ == 'region' || $champ == 'chef_lieu') {
417
				$projet = 'insee-'.substr($champ, 0, 1);
418
				$this->table_retour[$champ.'.code'] = $valeur;
419
				$this->table_retour[$champ.'.href'] = $this->ajouterHrefAutreProjet('zone-geo', '', $valeur, $projet);
420
			} elseif ($champ == 'tncc') {
421
				$url = $this->ajouterHref('ontologies', $valeur);
422
				$res = $this->consulterHref($url);
423
				$this->table_retour['type_nom'] = $res->nom;
424
				$this->table_retour['type_nom.code'] = $valeur;
425
				$this->table_retour['type_nom.href'] = $url;
426
			} else {
427
				$this->table_retour[$this->correspondance_champs[$champ]] = $valeur;
428
			}
429
		} else {
430
			$this->table_retour[$this->correspondance_champs[$champ]] = $valeur;
431
		}
432
	}
433
 
434
}
435
 
436
?>