Subversion Repositories eFlore/Projets.eflore-projets

Rev

Rev 291 | Rev 733 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

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