Subversion Repositories eFlore/Projets.eflore-projets

Rev

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

Rev Author Line No. Line
322 delphine 1 
<?php
2 
/**
3 
* Description :
4 
* Classe Ontologies.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 description et
8 
* éventuellement une relation hiérarchique avec un autre terme (=classe).
9 
* Si l'url finit par /ontologies 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 ? : /ontologies?param1=val1&param2=val2&...
11 
*
12 
* Les paramètres de requête disponibles sont : masque, masque.code, masque.nom, masque.description , recherche,
13 
* distinct, retour.format, navigation.depart et navigation.limite.
14 
*
15 
* Encodage en entrée : utf8
16 
* Encodage en sortie : utf8
17 
* @package eflore-projets
18 
* @author Jennifer DHÉ <jennifer.dhe@tela-botanica.org>
19 
* @author Delphine CAUQUIL <delphine@tela-botanica.org>
20 
* @author Jean-Pascal MILCENT <jpm@tela-botanica.org>
21 
* @license GPL v3 <http://www.gnu.org/licenses/gpl.txt>
22 
* @license CECILL v2 <http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt>
23 
* @version 0.1
24 
* @copyright 1999-2011 Tela Botanica (accueil@tela-botanica.org)
25 
*/
791 raphael 26 
class EfloreOntologies extends Commun {
322 delphine 27 
 
28 
	protected $requete_condition = null; //Représente la partie de la requete SQL ajoutant une condition (WHERE ...)
29 
	/** Permet de stocker la requete formulée: /ontologies | /ontologies/#id | /ontologies/#id/champ | /ontologies/#id/relations */
30 
	protected $format_reponse = 'ontologies';
31 
	/**  Permet de stocker les limite de la requete SQL (par défaut seul les 100 premiers résultats seront retournés).
32 
	 * Stocke également les valeurs des paramètres navigation.depart et navigation.limite passés dans la requete*/
33 
	protected $limite_requete = array( 'depart' => 0, 'limite' => 100);
34 
	/** Stocke le nombre total de résultats de la requete principale. Est calculée lors de l'assemblage de la requete */
35 
	protected $total_resultat;
36 
	protected $retour_format = 'max';
37 
 
841 raphael 38 
 
39 
	// beaucoup plus flexible dans le cas de requêtes SQL complexes
40 
	protected $mesChamps = '';
41 
	protected $mesJoinsEtConditions = '';
42 
 
322 delphine 43 
	public function consulter($ressources, $parametres) {
44 
		$this->ressources = $ressources;
45 
		$this->parametres = $parametres;
46 
		$this->service = 'ontologies';
47 
 
48 
		$this->traiterParametres();
49 
 
50 
		$resultats = '';
51 
		$this->table = 'eflore_ontologies'; //on stocke le nom de la table correspondant à la version du projet en cours
52 
		$this->recupererNomChamp($this->table); //on récupère les noms des champs disponibles (Ds Commun.php)
53 
		$this->traiterRessources(); //dans CommunNomsTaxons.php
54 
		$requete = $this->assemblerLaRequete();
55 
		$resultat = $this->getBdd()->recupererTous($requete);
56 
		$versionResultat = $this->traiterResultat($resultat, '', $requete);
57 
		$resultats = $versionResultat;
58 
 
59 
		return $resultats;
60 
	}
61 
 
62 
	public function traiterParametres() {
63 
		if (isset($this->parametres) && !empty($this->parametres)) {
64 
			foreach ($this->parametres as $param => $valeur) {
65 
				switch ($param) {
66 
					case 'masque' 			  :  $this->ajouterLeFiltreMasque('masque', $valeur); 				break;
67 
					case 'masque.code' 		  :  $this->ajouterLeFiltreMasque('code', $valeur); 				break;
68 
					case 'masque.nom' 		  :  $this->ajouterLeFiltreMasque('nom', $valeur); 					break;
69 
					case 'masque.description' :  $this->ajouterLeFiltreMasque('description', $valeur); 			break;
70 
					case 'retour.format' 	  :  $this->retour_format = $valeur;								break;
841 raphael 71 
					case 'retour.champs' 	  :  $this->parametres['retour_champs'] = $valeur;					break;
322 delphine 72 
					case 'navigation.depart'  :  $this->limite_requete['depart'] = $valeur;	  					break;
73 
					case 'navigation.limite'  :  $this->limite_requete['limite'] = $valeur;	  					break;
74 
					case 'recherche' : 																			break;
75 
					case 'version.projet' : 																	break;
76 
					default :
77 
						$e = 'Erreur dans les parametres de recherche de votre requête : </br> Le paramètre " '
78 
							.$param.' " n\'existe pas.';
79 
						$this->renvoyerErreur(RestServeur::HTTP_CODE_MAUVAISE_REQUETE, $e);						break;
80 
				}
81 
			}
82 
		}
83 
	}
84 
 
85 
	public function ajouterLeFiltreMasque($nom_champ, $valeur) {
86 
		if ($nom_champ == 'code') {
87 
			$this->requete_condition[] = $nom_champ.' = '.$this->getBdd()->proteger($valeur);
88 
		} else {
89 
			if (isset($this->parametres['recherche']) && $this->parametres['recherche'] == 'floue') {
90 
				if ($nom_champ == 'masque') {
91 
					$this->requete_condition[] = '( code = '.$this->getBdd()->proteger($valeur)
92 
						.' OR ( SOUNDEX(nom) = SOUNDEX(\''.$valeur.'\')'
93 
						.' OR SOUNDEX(REVERSE(nom)) = SOUNDEX(REVERSE(\''.$valeur.'\')) '
94 
						.') OR ( SOUNDEX(description) = SOUNDEX(\''.$valeur.'\')'
95 
						.' OR SOUNDEX(REVERSE(description)) = SOUNDEX(REVERSE(\''.$valeur.'\')) ))';
96 
				} else {
97 
					$this->requete_condition[] = '(SOUNDEX('.$nom_champ.') = SOUNDEX(\''.$valeur.'\')'
98 
						.' OR SOUNDEX(REVERSE('.$nom_champ.')) = SOUNDEX(REVERSE(\''.$valeur.'\')))';
99 
				}
100 
			} else {
101 
					if (isset($this->parametres['recherche']) && $this->parametres['recherche'] == 'etendue') {
102 
					$valeur = str_replace(' ','%', $valeur);
103 
					$valeur .= '%';
104 
				}
105 
				if ($nom_champ == 'masque') {
106 
					$this->requete_condition[] = '(code = '.$this->getBdd()->proteger($valeur)
107 
						.' OR nom LIKE '.$this->getBdd()->proteger($valeur)
108 
						.' OR description LIKE '.$this->getBdd()->proteger($valeur).')';
109 
				} else {
110 
					$this->requete_condition[] = $nom_champ.' LIKE '.$this->getBdd()->proteger($valeur);
111 
				}
112 
			}
113 
		}
114 
	}
115 
 
116 
 
117 
	public function traiterRessources() {
118 
		if (isset($this->ressources) && !empty($this->ressources)) {
119 
			if (isset($this->ressources[0]) && !empty($this->ressources[0])) {
120 
				//requete = /ontologies/#id
121 
				$this->traiterRessourceId();
122 
				if (isset($this->ressources[1]) && !empty($this->ressources[1])) {
123 
					//requete = /ontologies/#id/relations
124 
					$this->traiterRessourceRelations();
125 
				}
126 
			}
127 
		}
128 
	}
129 
 
130 
 
131 
	public function traiterRessourceId() {
132 
		$this->requete_condition = array();
133 
		//requete : /ontologies/#id (ex : /ontologies/7)
134 
		if (is_numeric($this->ressources[0])) {
135 
			$this->requete_condition[] = ' id = '.$this->getBdd()->proteger($this->ressources[0]);
136 
			$this->format_reponse .= '/id';
137 
		//requete : /ontologies/#classe:#code (ex : /ontologies/rangTaxo:290)
138 
		} elseif (strrpos($this->ressources[0], ':') !== false) {
841 raphael 139 
			// plusieurs couples #classe:#code séparés par des virgules
140 
			if(strrpos($this->ressources[0], ',') !== false) {
141 
				$this->traiterMultipleRessourceId();
142 
				return;
143 
			}
144 
 
145 
			// ou un unique couple #classe:#code
322 delphine 146 
			$this->format_reponse .= '/id';
147 
			preg_match('/^([^:]+):([^:]+)$/', $this->ressources[0], $match);
148 
			$this->requete_condition[] =
841 raphael 149 
				' id IN (SELECT id FROM '.$this->table.' WHERE code = '.$this->getBdd()->proteger($match[2])
322 delphine 150 
				.' AND classe_id = (SELECT id FROM '.$this->table.' WHERE code = '.$this->getBdd()->proteger($match[1]).'))';
841 raphael 151 
			// TODO: optimiser, à voir: traiterMultipleRessourceId() ci-dessous
152 
			// SELECT a.*
153 
			// FROM $this->table a
154 
			// LEFT JOIN $this->table b ON a.id = b.id LEFT JOIN $this->table c ON b.classe_id = c.id
155 
			// WHERE b.code = $this->getBdd()->proteger($match[2])
156 
			// AND c.code = $this->getBdd()->proteger($match[1]);
322 delphine 157 
		} else {
158 
			$e = 'Erreur dans les paramètres de recherche de votre requête : </br> Le paramètre " '
159 
				.$this->ressources[0].' " n\'existe pas.';
160 
			$this->renvoyerErreur(RestServeur::HTTP_CODE_MAUVAISE_REQUETE, $e);
161 
		}
162 
	}
163 
 
841 raphael 164 
	// Requète : /ontologies/#classe:#code,[...] (ex : /ontologies/numStatus:2,numStatus:3,genreNombre:10)
165 
	public function traiterMultipleRessourceId() {
166 
		$this->format_reponse .= '/ids'; // noter le "s"
167 
		$this->mesChamps = Array(
168 
			// 'a.*' // pourquoi pas, mais alors des unset() seront nécessaire
169 
			'a.id',
170 
			'a.classe_id AS `classe.id`',
171 
			'a.nom',
172 
			'a.description',
173 
			'a.code',
174 
			'a.complements',
175 
			'c.nom AS classe', // évite très simplement (un très couteux) ajouterClasseCorrespondante()
176 
			'concat(c.code,":", b.code) AS requete'); // permet aux appelants de récupérer la valeur qu'ils recherchent
177 
		$this->mesChamps = implode(', ', $this->mesChamps);
322 delphine 178 
 
841 raphael 179 
		$this->mesJoinsEtConditions =
180 
			// alias de la table première
181 
			" a "
182 
			. " LEFT JOIN {$this->table} b ON a.id = b.id LEFT JOIN {$this->table} c ON b.classe_id = c.id"
183 
			. " WHERE ";
184 
 
185 
		$or_stack = false;
186 
		$tab = explode(',', $this->ressources[0]);
187 
		foreach($tab as $couple) {
188 
			preg_match('/^([^:]+):([^:]+)$/', $couple, $match);
189 
			if($or_stack) {
190 
				// une fois qu'un set de condition et présent,
191 
				// les autres sont `OR`-ed.
192 
				$this->mesJoinsEtConditions .= " OR ";
193 
			}
194 
			$this->mesJoinsEtConditions .=
195 
				sprintf("(b.code = %s AND c.code = %s)",
196 
						$this->getBdd()->proteger($match[2]),
197 
						$this->getBdd()->proteger($match[1]));
198 
			$or_stack = true;
199 
		}
200 
	}
201 
 
322 delphine 202 
	public function traiterRessourceRelations() {
203 
		//requete = /ontologies/#id/relations :
204 
		if ($this->ressources[1] == 'relations') {
205 
			$this->format_reponse .= '/relations';
206 
			$this->requete_condition = array('classe_id = (SELECT classe_id FROM '.$this->table.' WHERE '
207 
										.implode(' AND ', $this->requete_condition).')');
208 
		}
209 
	}
210 
 
211 
	//+--------------------------FONCTION ASSEMBLAGE DE LA REQUETE-------------------------------------------+
212 
 
213 
	public function assemblerLaRequete() {
214 
		$requete = 	' SELECT '.$this->formerRequeteChamp().
215 
						' FROM '.$this->table
216 
							.$this->retournerRequeteCondition()
217 
							.$this->formerRequeteLimite(); //print_r($requete);
218 
		return $requete;
219 
	}
220 
 
221 
	public  function formerRequeteChamp() {
841 raphael 222 
		if($this->mesChamps) return $this->mesChamps;
223 
 
322 delphine 224 
		$champ[] = 'id';
225 
		if ($this->format_reponse == 'ontologies') {
226 
				$champ[] = 'nom, code ';
227 
		}
228 
		if (isset($this->parametres['retour_champs']) || $this->format_reponse == 'ontologies/id/champs') {
229 
			$champs_recherches = explode(',', $this->parametres['retour_champs']);
230 
			$champs_possibles = $this->rechercherChampsPossibles();
231 
			foreach ($champs_recherches as $champ_recherche) {
841 raphael 232 
				if ($this->verifierValiditeChamp($champ_recherche, $champs_possibles)) {
322 delphine 233 
					$champ[] = (preg_match('/classe/', $champ_recherche)) ? 'classe_id' : $champ_recherche;
234 
				}
235 
			}
236 
		}
237 
		if (count($champ) == 1) {
238 
			$champ = array(' * ');
239 
		}
240 
		return implode(', ', $champ);
241 
	}
242 
 
243 
	public function rechercherChampsPossibles() {
244 
		$this->recupererNomChamp($this->table);
245 
		$champs_possibles = $this->champs_table;
246 
		$champs_possibles[] = 'classe.id';
247 
		$champs_possibles[] = 'classe';
248 
		$champs_possibles[] = 'classe.href';
249 
		return $champs_possibles;
250 
	}
251 
 
252 
	public function verifierValiditeChamp($champ, $champs_possibles) {
253 
		$validite = false;
254 
		preg_match('/^([^.]+)(:?\.([^.]+))?$/', $champ, $match);
255 
		if (in_array($match[1], $champs_possibles)) {
256 
			$validite = true;
257 
		} else {
258 
			$champs = implode('</li><li>', $champs_possibles);
259 
			$e = 'Erreur dans votre requête : </br> Le champ "'.$champ
260 
			.'" n\'existe pas. Les champs disponibles sont : <li>'.$champs.'</li>';
261 
			$this->renvoyerErreur(RestServeur::HTTP_CODE_MAUVAISE_REQUETE, $e);
262 
		}
263 
		return $validite;
264 
	}
265 
 
266 
	public  function retournerRequeteCondition() {
841 raphael 267 
		if($this->mesJoinsEtConditions) return $this->mesJoinsEtConditions;
268 
 
322 delphine 269 
		$condition = '';
270 
		if ($this->requete_condition !== null) {
271 
			$condition = ' WHERE '.implode(' AND ', $this->requete_condition);
272 
		}
273 
		return $condition;
274 
	}
275 
 
276 
	public function formerRequeteLimite() {
277 
		$this->total_resultat = $this->recupererTotalResultat();
278 
		if (in_array($this->format_reponse , array('textes/id', 'textes/id/relations'))) {
279 
			$this->requete_limite = '';
280 
		} elseif (($depart = $this->limite_requete['depart']) > ($this->total_resultat)) {
281 
			$this->limite_requete['depart'] =
282 
				(($this->total_resultat - $this->limite_requete['limite']) < 0) ? 0 : ($this->total_resultat - $this->limite_requete['limite']);
283 
			$this->requete_limite = ' LIMIT '.$this->limite_requete['depart'].', '.$this->limite_requete['limite'];
284 
		} else {
285 
			$this->requete_limite = ' LIMIT '.$this->limite_requete['depart'].', '.$this->limite_requete['limite'];
286 
		}
287 
		return $this->requete_limite;
288 
	}
289 
 
290 
 
291 
	public function recupererTotalResultat() {
292 
		//on récupère le nombre total de résultats de la requete (ex : le nombre d'id contenu dans la liste /ontologies)
293 
		$requete = 'SELECT count(*) as nombre FROM '.$this->table.' '
294 
			.$this->retournerRequeteCondition();
295 
		$res = $this->getBdd()->recuperer($requete);
296 
		if ($res) {
297 
			$total = $res['nombre'];
298 
		} else {
299 
			$e = 'Données introuvables dans la base';
300 
			$this->renvoyerErreur(RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE, $e);
301 
			Debug::printr($requete);
302 
		}
303 
		return $total;
304 
	}
305 
 
306 
	//+------------------------------------------------------------------------------------------------------+
307 
	public function retournerResultatFormate($resultat) {
308 
		// determine en fct du service appelé (/ontologies | /ontologies/#id | /ontologies/#id/champ |
309 
		// /ontologies/#id/relations) le format du tableau à retourner. Encode en json
310 
		switch ($this->format_reponse) {
311 
			case 'ontologies' 				: $reponse = $this->formaterOntologies($resultat); 			 break;
312 
			case 'ontologies/id' 			: $reponse = $this->formaterOntologiesId($resultat[0]); 	 break;
841 raphael 313 
			case 'ontologies/ids' 			: $reponse = $this->formaterMultipleOntologiesId($resultat);	break;
322 delphine 314 
			case 'ontologies/id/relations' 	: $reponse = $this->formaterOntologiesIdRelations($resultat); break;
315 
			default : break;
316 
		}
317 
		return $reponse;
318 
	}
319 
 
320 
 
321 
	public function formaterOntologies($resultat) {
322 
		$this->ajouterEnteteResultat($resultat);
323 
		$table_retour_json['entete'] = $this->ajouterEnteteResultat($resultat);
324 
		if (isset($this->parametres['masque_code']) || isset($this->parametres['masque'])) {
325 
			$resultat = $this->trierRechercheFloue($this->parametres['masque_code'], $resultat, 'code');
326 
		} elseif (isset($this->parametres['masque_nom'])) {
327 
			$resultat = $this->trierRechercheFloue($this->parametres['masque_nom'], $resultat, 'nom');
328 
		} elseif (isset($this->parametres['masque_description'])) {
329 
			$resultat = $this->trierRechercheFloue($this->parametres['masque_description'], $resultat, 'description');
330 
		}
331 
		//on remplit la table $table_retour_json['resultat']
332 
		foreach ($resultat as $tab) {
333 
			$num = $tab['id'];
334 
			unset($tab['id']);
335 
			foreach ($tab as $param => $valeur) {
336 
				$resultat_json[$num][$param] = $valeur;
337 
			}
338 
			if ($this->retour_format == 'max') $resultat_json[$num]['href'] = $this->ajouterHref('ontologies', $num);
339 
		}
340 
		$table_retour_json['resultat'] = $resultat_json;
341 
		return $table_retour_json;
342 
	}
343 
 
344 
	public function ajouterEnteteResultat($resultat) {
345 
		//on remplit la table $table_retour_json['entete']
346 
		$entete['depart'] = $this->limite_requete['depart'];
347 
		$entete['limite'] = $this->limite_requete['limite'];
348 
		$entete['total']  = $this->total_resultat;
349 
		//formuler les urls
350 
		$url = $this->formulerUrl($this->total_resultat, '/ontologies');
351 
		if (isset($url['precedent']) && $url['precedent'] != '') { $entete['href.precedent'] = $url['precedent']; }
352 
		if (isset($url['suivant']) && $url['suivant'] != '') { $entete['href.suivant']   = $url['suivant']; }
353 
		return $entete;
354 
	}
355 
 
841 raphael 356 
	public function __anonyme1($val) { return $val != ''; }
322 delphine 357 
 
358 
	public function formaterOntologiesId($resultat) {
841 raphael 359 
		$table_retour = array_filter($resultat, array($this, '__anonyme1'));
360 
		$this->calculerClassID($table_retour);
322 delphine 361 
		return $table_retour;
362 
	}
363 
 
841 raphael 364 
	public function formaterMultipleOntologiesId($resultats) {
365 
		$result = Array();
366 
		foreach($resultats as $k => $resultat) {
367 
			$id = $resultat['requete'];
368 
			$result[$id] = array_filter($resultat, array($this, '__anonyme1'));
369 
			unset($result[$id]['requete']);
370 
			$this->calculerClassID($result[$id]);
371 
		}
372 
		return $result;
373 
	}
374 
 
375 
	public function calculerClassID(&$resultat) {
376 
		// commenté: pourquoi restreindre le choix des champs au format "max",
377 
		// ça ne semble pas logique...
378 
		// if ($this->retour_format != 'max') return;
379 
 
380 
 		// question: pourquoi ne pas passer les infos relatives aux ontologies 0 ?
381 
		// et que signifie ce commentaire: "pas de parent"
382 
		if (@$resultat['classe_id'] == '0') return;
383 
 
384 
		$valeur = isset($resultat['classe_id']) ? $resultat['classe_id'] : $resultat['classe.id'];
385 
		if(! isset($resultat['classe.id'])) {
386 
			$resultat['classe.id'] = $resultat['classe_id'];
387 
			unset($resultat['classe_id']);
388 
		}
389 
 
390 
		// max-format et pas de champs spécifiques demandés ?
391 
		// Alors on rempli "classe" et "classe.href"
392 
		// Mais ne pas recalculer (surtout la classe) si ce n'est pas nécessaire
393 
		// (c'est le cas si l'on a demandé plusieurs critère [provenons de formaterMultipleOntologiesId()])
394 
		if (! isset($this->parametres['retour_champs'])) {
395 
			if(! isset($resultat['classe'])) {
396 
				$nom_classe = $this->ajouterClasseCorrespondante($valeur);
397 
				if (isset($nom_classe)) $resultat['classe'] = $nom_classe;
322 delphine 398 
			}
841 raphael 399 
			if(! isset($resultat['classe.href'])) {
400 
				$resultat['classe.href'] = $this->ajouterHref('ontologies', $valeur);
401 
			}
402 
			return;
322 delphine 403 
		}
841 raphael 404 
 
405 
		// cas où des champs sont demandés
406 
		$champs = explode(',', $this->parametres['retour_champs']);
407 
		if(in_array('classe', $champs) && ! isset($resultat['classe'])) {
408 
			$this->ajouterClasseCorrespondante($valeur);
409 
		}
410 
 
411 
		if(in_array('classe.id', $champs) && ! isset($resultat['classe.id'])) {
412 
			$resultat['classe.id'] = $valeur;
413 
		}
414 
 
415 
		if(in_array('classe.href', $champs) && ! isset($resultat['classe.href'])) {
416 
			$resultat['classe.href'] = $this->ajouterHref('ontologies', $valeur);
417 
		}
418 
 
419 
		if(in_array('classe.*', $champs) && (! isset($resultat['classe.href']) || ! isset($resultat['classe.id']))) {
420 
			$resultat['classe.id'] = $valeur;
421 
			$resultat['classe.href'] = $this->ajouterHref('ontologies', $valeur);
422 
		}
322 delphine 423 
	}
424 
 
425 
	/** Recherche par interrogation de la base, le nom de la classe à partir de son identifiant (classe.id)  */
426 
	public function ajouterClasseCorrespondante($classe_id) {
427 
		$nom = null;
428 
		if ($classe_id != 0) {
429 
			$nom = '';
430 
			$req = 'SELECT nom FROM '.$this->table.' WHERE id = '.$this->getBdd()->proteger($classe_id);
431 
			$res = $this->getBdd()->recuperer($req);
432 
			if ($res) {
433 
				$nom = $res['nom'];
434 
			} else {
435 
				$e = "Données introuvables dans la table $this->table";
436 
				$this->renvoyerErreur(RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE, $e);
437 
				Debug::printr($req);
438 
			}
439 
		}
440 
		return $nom;
441 
	}
442 
 
443 
	public function formaterOntologiesIdRelations($resultat) {
444 
		$retour = null;
445 
		if ($resultat != '') {
446 
			$retour['entete'] = $this->ajouterEnteteResultat($resultat);
447 
			//on remplit la table $table_retour_json['resultat']
448 
			foreach ($resultat as $tab) {
449 
				$num = $tab['id'];
450 
				$retour['resultat'][$num]['nom'] = $tab['nom'];
451 
				if ($this->retour_format == 'max') {
452 
					$retour['resultat'][$num]['href'] = $this->ajouterHref('ontologies', $num);
453 
				}
454 
			}
455 
		}
456 
		return $retour;
457 
	}
458 
}
459 
?>