Subversion Repositories eFlore/Projets.eflore-projets

Rev

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

Rev Author Line No. Line
246 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 ChorodepOntologies extends Commun {
246 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 
 
38 
	public function consulter($ressources, $parametres) {
39 
		$this->ressources = $ressources;
40 
		$this->parametres = $parametres;
41 
		$this->service = 'ontologies';
42 
 
43 
		$this->traiterParametres();
44 
 
45 
		$resultats = '';
46 
		$this->table = 'chorodep_ontologies'; //on stocke le nom de la table correspondant à la version du projet en cours
47 
		$this->recupererNomChamp($this->table); //on récupère les noms des champs disponibles (Ds Commun.php)
48 
		$this->traiterRessources(); //dans CommunNomsTaxons.php
49 
		$requete = $this->assemblerLaRequete();
50 
		$resultat = $this->getBdd()->recupererTous($requete);
51 
		$versionResultat = $this->traiterResultat($resultat, '', $requete);
52 
		$resultats = $versionResultat;
53 
 
54 
		return $resultats;
55 
	}
56 
 
57 
	public function traiterParametres() {
58 
		if (isset($this->parametres) && !empty($this->parametres)) {
59 
			foreach ($this->parametres as $param => $valeur) {
60 
				switch ($param) {
61 
					case 'masque' 			  :  $this->ajouterLeFiltreMasque('masque', $valeur); 				break;
62 
					case 'masque.code' 		  :  $this->ajouterLeFiltreMasque('code', $valeur); 				break;
63 
					case 'masque.nom' 		  :  $this->ajouterLeFiltreMasque('nom', $valeur); 					break;
64 
					case 'masque.description' :  $this->ajouterLeFiltreMasque('description', $valeur); 			break;
65 
					case 'retour.format' 	  :  $this->retour_format = $valeur;								break;
66 
					case 'retour.champs' 	  : break;
67 
					case 'navigation.depart'  :  $this->limite_requete['depart'] = $valeur;	  					break;
68 
					case 'navigation.limite'  :  $this->limite_requete['limite'] = $valeur;	  					break;
69 
					case 'recherche' : 																			break;
70 
					case 'version.projet' : 																	break;
71 
					default :
72 
						$e = 'Erreur dans les parametres de recherche de votre requête : </br> Le paramètre " '
73 
							.$param.' " n\'existe pas.';
74 
						$this->renvoyerErreur(RestServeur::HTTP_CODE_MAUVAISE_REQUETE, $e);						break;
75 
				}
76 
			}
77 
		}
78 
	}
79 
 
80 
	public function ajouterLeFiltreMasque($nom_champ, $valeur) {
81 
		if ($nom_champ == 'code') {
82 
			$this->requete_condition[] = $nom_champ.' = '.$this->getBdd()->proteger($valeur);
83 
		} else {
84 
			if (isset($this->parametres['recherche']) && $this->parametres['recherche'] == 'floue') {
85 
				if ($nom_champ == 'masque') {
86 
					$this->requete_condition[] = '( code = '.$this->getBdd()->proteger($valeur)
87 
						.' OR ( SOUNDEX(nom) = SOUNDEX(\''.$valeur.'\')'
88 
						.' OR SOUNDEX(REVERSE(nom)) = SOUNDEX(REVERSE(\''.$valeur.'\')) '
89 
						.') OR ( SOUNDEX(description) = SOUNDEX(\''.$valeur.'\')'
90 
						.' OR SOUNDEX(REVERSE(description)) = SOUNDEX(REVERSE(\''.$valeur.'\')) ))';
91 
				} else {
92 
					$this->requete_condition[] = '(SOUNDEX('.$nom_champ.') = SOUNDEX(\''.$valeur.'\')'
93 
						.' OR SOUNDEX(REVERSE('.$nom_champ.')) = SOUNDEX(REVERSE(\''.$valeur.'\')))';
94 
				}
95 
			} else {
96 
					if (isset($this->parametres['recherche']) && $this->parametres['recherche'] == 'etendue') {
97 
					$valeur = str_replace(' ','%', $valeur);
98 
					$valeur .= '%';
99 
				}
100 
				if ($nom_champ == 'masque') {
101 
					$this->requete_condition[] = '(code = '.$this->getBdd()->proteger($valeur)
102 
						.' OR nom LIKE '.$this->getBdd()->proteger($valeur)
103 
						.' OR description LIKE '.$this->getBdd()->proteger($valeur).')';
104 
				} else {
105 
					$this->requete_condition[] = $nom_champ.' LIKE '.$this->getBdd()->proteger($valeur);
106 
				}
107 
			}
108 
		}
109 
	}
110 
 
111 
 
112 
	public function traiterRessources() {
113 
		if (isset($this->ressources) && !empty($this->ressources)) {
114 
			if (isset($this->ressources[0]) && !empty($this->ressources[0])) {
115 
				//requete = /ontologies/#id
116 
				$this->traiterRessourceId();
117 
				if (isset($this->ressources[1]) && !empty($this->ressources[1])) {
118 
					//requete = /ontologies/#id/relations
119 
					$this->traiterRessourceRelations();
120 
				}
121 
			}
122 
		}
123 
	}
124 
 
125 
 
126 
	public function traiterRessourceId() {
127 
		$this->requete_condition = array();
128 
		//requete : /ontologies/#id (ex : /ontologies/7)
129 
		if (is_numeric($this->ressources[0])) {
130 
			$this->requete_condition[] = ' id = '.$this->getBdd()->proteger($this->ressources[0]);
131 
			$this->format_reponse .= '/id';
132 
		//requete : /ontologies/#classe:#code (ex : /ontologies/rangTaxo:290)
133 
		} elseif (strrpos($this->ressources[0], ':') !== false) {
134 
			$this->format_reponse .= '/id';
135 
			preg_match('/^([^:]+):([^:]+)$/', $this->ressources[0], $match);
136 
			$this->requete_condition[] =
137 
				' id = (SELECT id FROM '.$this->table.' WHERE code = '.$this->getBdd()->proteger($match[2])
138 
				.' AND classe_id = (SELECT id FROM '.$this->table.' WHERE code = '.$this->getBdd()->proteger($match[1]).'))';
139 
		} else {
140 
			$e = 'Erreur dans les paramètres de recherche de votre requête : </br> Le paramètre " '
141 
				.$this->ressources[0].' " n\'existe pas.';
142 
			$this->renvoyerErreur(RestServeur::HTTP_CODE_MAUVAISE_REQUETE, $e);
143 
		}
144 
	}
145 
 
146 
 
147 
	public function traiterRessourceRelations() {
148 
		//requete = /ontologies/#id/relations :
149 
		if ($this->ressources[1] == 'relations') {
150 
			$this->format_reponse .= '/relations';
151 
			$this->requete_condition = array('classe_id = (SELECT classe_id FROM '.$this->table.' WHERE '
152 
										.implode(' AND ', $this->requete_condition).')');
153 
		}
154 
	}
155 
 
156 
	//+--------------------------FONCTION ASSEMBLAGE DE LA REQUETE-------------------------------------------+
157 
 
158 
	public function assemblerLaRequete() {
159 
		$requete = 	' SELECT '.$this->formerRequeteChamp().
160 
						' FROM '.$this->table
161 
							.$this->retournerRequeteCondition()
162 
							.$this->formerRequeteLimite(); //print_r($requete);
163 
		return $requete;
164 
	}
165 
 
166 
	public  function formerRequeteChamp() {
167 
		$champ[] = 'id';
168 
		if ($this->format_reponse == 'ontologies') {
169 
				$champ[] = 'nom, code ';
170 
		}
171 
		if (isset($this->parametres['retour_champs']) || $this->format_reponse == 'ontologies/id/champs') {
172 
			$champs_recherches = explode(',', $this->parametres['retour_champs']);
173 
			$champs_possibles = $this->rechercherChampsPossibles();
174 
			foreach ($champs_recherches as $champ_recherche) {
175 
				if ($this->verifierValiditeChamp($champ_recherche)) {
176 
					$champ[] = (preg_match('/classe/', $champ_recherche)) ? 'classe_id' : $champ_recherche;
177 
				}
178 
			}
179 
		}
180 
		if (count($champ) == 1) {
181 
			$champ = array(' * ');
182 
		}
183 
		return implode(', ', $champ);
184 
	}
185 
 
186 
	public function rechercherChampsPossibles() {
187 
		$this->recupererNomChamp($this->table);
188 
		$champs_possibles = $this->champs_table;
189 
		$champs_possibles[] = 'classe.id';
190 
		$champs_possibles[] = 'classe';
191 
		$champs_possibles[] = 'classe.href';
192 
		return $champs_possibles;
193 
	}
194 
 
195 
	public function verifierValiditeChamp($champ, $champs_possibles) {
196 
		$validite = false;
197 
		preg_match('/^([^.]+)(:?\.([^.]+))?$/', $champ, $match);
198 
		if (in_array($match[1], $champs_possibles)) {
199 
			$validite = true;
200 
		} else {
201 
			$champs = implode('</li><li>', $champs_possibles);
202 
			$e = 'Erreur dans votre requête : </br> Le champ "'.$champ
203 
			.'" n\'existe pas. Les champs disponibles sont : <li>'.$champs.'</li>';
204 
			$this->renvoyerErreur(RestServeur::HTTP_CODE_MAUVAISE_REQUETE, $e);
205 
		}
206 
		return $validite;
207 
	}
208 
 
209 
	public  function retournerRequeteCondition() {
210 
		$condition = '';
211 
		if ($this->requete_condition !== null) {
212 
			$condition = ' WHERE '.implode(' AND ', $this->requete_condition);
213 
		}
214 
		return $condition;
215 
	}
216 
 
217 
	public function formerRequeteLimite() {
218 
		$this->total_resultat = $this->recupererTotalResultat();
219 
		if (in_array($this->format_reponse , array('textes/id', 'textes/id/relations'))) {
220 
			$this->requete_limite = '';
221 
		} elseif (($depart = $this->limite_requete['depart']) > ($this->total_resultat)) {
222 
			$this->limite_requete['depart'] =
223 
				(($this->total_resultat - $this->limite_requete['limite']) < 0) ? 0 : ($this->total_resultat - $this->limite_requete['limite']);
224 
			$this->requete_limite = ' LIMIT '.$this->limite_requete['depart'].', '.$this->limite_requete['limite'];
225 
		} else {
226 
			$this->requete_limite = ' LIMIT '.$this->limite_requete['depart'].', '.$this->limite_requete['limite'];
227 
		}
228 
		return $this->requete_limite;
229 
	}
230 
 
231 
 
232 
	public function recupererTotalResultat() {
233 
		//on récupère le nombre total de résultats de la requete (ex : le nombre d'id contenu dans la liste /ontologies)
234 
		$requete = 'SELECT count(*) as nombre FROM '.$this->table.' '
235 
			.$this->retournerRequeteCondition();
236 
		$res = $this->getBdd()->recuperer($requete);
237 
		if ($res) {
238 
			$total = $res['nombre'];
239 
		} else {
240 
			$e = 'Données introuvables dans la base';
241 
			$this->renvoyerErreur(RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE, $e);
242 
			Debug::printr($requete);
243 
		}
244 
		return $total;
245 
	}
246 
 
247 
	//+------------------------------------------------------------------------------------------------------+
248 
	public function retournerResultatFormate($resultat) {
249 
		// determine en fct du service appelé (/ontologies | /ontologies/#id | /ontologies/#id/champ |
250 
		// /ontologies/#id/relations) le format du tableau à retourner. Encode en json
251 
		switch ($this->format_reponse) {
252 
			case 'ontologies' 				: $reponse = $this->formaterOntologies($resultat); 			 break;
253 
			case 'ontologies/id' 			: $reponse = $this->formaterOntologiesId($resultat[0]); 	 break;
254 
			case 'ontologies/id/relations' 	: $reponse = $this->formaterOntologiesIdRelations($resultat); break;
255 
			default : break;
256 
		}
257 
		return $reponse;
258 
	}
259 
 
260 
 
261 
	public function formaterOntologies($resultat) {
262 
		$this->ajouterEnteteResultat($resultat);
263 
		$table_retour_json['entete'] = $this->ajouterEnteteResultat($resultat);
264 
		if (isset($this->parametres['masque_code']) || isset($this->parametres['masque'])) {
265 
			$resultat = $this->trierRechercheFloue($this->parametres['masque_code'], $resultat, 'code');
266 
		} elseif (isset($this->parametres['masque_nom'])) {
267 
			$resultat = $this->trierRechercheFloue($this->parametres['masque_nom'], $resultat, 'nom');
268 
		} elseif (isset($this->parametres['masque_description'])) {
269 
			$resultat = $this->trierRechercheFloue($this->parametres['masque_description'], $resultat, 'description');
270 
		}
271 
		//on remplit la table $table_retour_json['resultat']
272 
		foreach ($resultat as $tab) {
273 
			$num = $tab['id'];
274 
			unset($tab['id']);
275 
			foreach ($tab as $param => $valeur) {
276 
				$resultat_json[$num][$param] = $valeur;
277 
			}
278 
			if ($this->retour_format == 'max') $resultat_json[$num]['href'] = $this->ajouterHref('ontologies', $num);
279 
		}
280 
		$table_retour_json['resultat'] = $resultat_json;
281 
		return $table_retour_json;
282 
	}
283 
 
284 
	public function ajouterEnteteResultat($resultat) {
285 
		//on remplit la table $table_retour_json['entete']
286 
		$entete['depart'] = $this->limite_requete['depart'];
287 
		$entete['limite'] = $this->limite_requete['limite'];
288 
		$entete['total']  = $this->total_resultat;
289 
		//formuler les urls
290 
		$url = $this->formulerUrl($this->total_resultat, '/ontologies');
291 
		if (isset($url['precedent']) && $url['precedent'] != '') { $entete['href.precedent'] = $url['precedent']; }
292 
		if (isset($url['suivant']) && $url['suivant'] != '') { $entete['href.suivant']   = $url['suivant']; }
293 
		return $entete;
294 
	}
295 
 
296 
 
297 
	public function formaterOntologiesId($resultat) {
298 
		$table_retour = array();
299 
		foreach ($resultat as $key => $valeur) {
300 
			if ($valeur != '') {
301 
				$table_retour = array_merge($table_retour, $this->afficherDonnees($key, $valeur));
302 
			}
303 
		}
304 
		return $table_retour;
305 
	}
306 
 
307 
	public function afficherDonnees($champ, $valeur) {
308 
		$retour[$champ] = $valeur;
309 
		if ($this->retour_format == 'max') {
310 
			if ($champ == 'classe_id') {
311 
				unset($retour[$champ]); // remplacer par classe.id
312 
				if ($valeur != "0") { // pas de parent
313 
					if (isset($this->parametres['retour_champs'])) {
314 
						switch ($this->parametres['retour_champs']) {
315 
							case 'classe' : $retour['classe'] = $this->ajouterClasseCorrespondante($valeur); break;
316 
							case 'classe.id' : $retour['classe.id'] = $valeur; break;
317 
							case 'classe.href' : $retour['classe.href'] = $this->ajouterHref('ontologies', $valeur); break;
318 
							case 'classe.*' : $retour['classe.id'] = $valeur; $retour['classe.href'] = $this->ajouterHref('ontologies', $valeur); break;
319 
						}
320 
					} else {
321 
						$nom_classe = $this->ajouterClasseCorrespondante($valeur);
322 
						if (isset($nom_classe)) $retour['classe'] = $nom_classe;
323 
						$retour['classe.id'] = $valeur;
324 
						$retour['classe.href'] = $this->ajouterHref('ontologies', $valeur);
325 
					}
326 
				}
327 
			}
328 
		}
329 
		return $retour;
330 
	}
331 
 
332 
	/** Recherche par interrogation de la base, le nom de la classe à partir de son identifiant (classe.id)  */
333 
	public function ajouterClasseCorrespondante($classe_id) {
334 
		$nom = null;
335 
		if ($classe_id != 0) {
336 
			$nom = '';
337 
			$req = 'SELECT nom FROM '.$this->table.' WHERE id = '.$this->getBdd()->proteger($classe_id);
338 
			$res = $this->getBdd()->recuperer($req);
339 
			if ($res) {
340 
				$nom = $res['nom'];
341 
			} else {
342 
				$e = "Données introuvables dans la table $this->table";
343 
				$this->renvoyerErreur(RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE, $e);
344 
				Debug::printr($req);
345 
			}
346 
		}
347 
		return $nom;
348 
	}
349 
 
350 
	public function formaterOntologiesIdRelations($resultat) {
351 
		$retour = null;
352 
		if ($resultat != '') {
353 
			$retour['entete'] = $this->ajouterEnteteResultat($resultat);
354 
			//on remplit la table $table_retour_json['resultat']
355 
			foreach ($resultat as $tab) {
356 
				$num = $tab['id'];
357 
				$retour['resultat'][$num]['nom'] = $tab['nom'];
358 
				if ($this->retour_format == 'max') {
359 
					$retour['resultat'][$num]['href'] = $this->ajouterHref('ontologies', $num);
360 
				}
361 
			}
362 
		}
363 
		return $retour;
364 
	}
365 
}
366 
?>