Subversion Repositories eFlore/Projets.eflore-projets

Rev

Go to most recent revision | Details | 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;
47
					case 'retour.champs' 	  : break;
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]).'))';
120
		} else {
121
			$e = 'Erreur dans les paramètres de recherche de votre requête : </br> Le paramètre " '
122
				.$this->ressources[0].' " n\'existe pas.';
123
			$this->renvoyerErreur(RestServeur::HTTP_CODE_MAUVAISE_REQUETE, $e);
124
		}
125
	}
126
 
127
 
128
	public function traiterRessourceRelations() {
129
		//requete = /ontologies/#id/relations :
130
		if ($this->ressources[1] == 'relations') {
131
			$this->format_reponse .= '/relations';
132
			$this->requete_condition = array('classe_id = (SELECT classe_id FROM '.$this->table.' WHERE '
133
										.implode(' AND ', $this->requete_condition).')');
134
		}
135
	}
136
 
137
	//+--------------------------FONCTION ASSEMBLAGE DE LA REQUETE-------------------------------------------+
138
 
139
	public function assemblerLaRequete() {
140
		$requete = 	' SELECT '.$this->formerRequeteChamp().
141
						' FROM '.$this->table
142
							.$this->retournerRequeteCondition()
143
							.$this->formerRequeteLimite(); //print_r($requete);
144
		return $requete;
145
	}
146
 
147
	public  function formerRequeteChamp() {
148
		$champ[] = 'id';
149
		if ($this->format_reponse == 'ontologies') {
150
				$champ[] = 'nom, code ';
151
		}
152
		if (isset($this->parametres['retour_champs']) || $this->format_reponse == 'ontologies/id/champs') {
153
			$champs_recherches = explode(',', $this->parametres['retour_champs']);
154
			$champs_possibles = $this->rechercherChampsPossibles();
155
			foreach ($champs_recherches as $champ_recherche) {
156
				if ($this->verifierValiditeChamp($champ_recherche)) {
157
					$champ[] = (preg_match('/classe/', $champ_recherche)) ? 'classe_id' : $champ_recherche;
158
				}
159
			}
160
		}
161
		if (count($champ) == 1) {
162
			$champ = array(' * ');
163
		}
164
		return implode(', ', $champ);
165
	}
166
 
167
	public function rechercherChampsPossibles() {
168
		$this->recupererNomChamp($this->table);
169
		$champs_possibles = $this->champs_table;
170
		$champs_possibles[] = 'classe.id';
171
		$champs_possibles[] = 'classe';
172
		$champs_possibles[] = 'classe.href';
173
		return $champs_possibles;
174
	}
175
 
176
	public function verifierValiditeChamp($champ, $champs_possibles) {
177
		$validite = false;
178
		preg_match('/^([^.]+)(:?\.([^.]+))?$/', $champ, $match);
179
		if (in_array($match[1], $champs_possibles)) {
180
			$validite = true;
181
		} else {
182
			$champs = implode('</li><li>', $champs_possibles);
183
			$e = 'Erreur dans votre requête : </br> Le champ "'.$champ
184
			.'" n\'existe pas. Les champs disponibles sont : <li>'.$champs.'</li>';
185
			$this->renvoyerErreur(RestServeur::HTTP_CODE_MAUVAISE_REQUETE, $e);
186
		}
187
		return $validite;
188
	}
189
 
190
	public  function retournerRequeteCondition() {
191
		$condition = '';
192
		if ($this->requete_condition !== null) {
193
			$condition = ' WHERE '.implode(' AND ', $this->requete_condition);
194
		}
195
		return $condition;
196
	}
197
 
198
	public function formerRequeteLimite() {
199
		$this->total_resultat = $this->recupererTotalResultat();
200
		if (in_array($this->format_reponse , array('textes/id', 'textes/id/relations'))) {
201
			$this->requete_limite = '';
202
		} elseif (($depart = $this->limite_requete['depart']) > ($this->total_resultat)) {
203
			$this->limite_requete['depart'] =
204
				(($this->total_resultat - $this->limite_requete['limite']) < 0) ? 0 : ($this->total_resultat - $this->limite_requete['limite']);
205
			$this->requete_limite = ' LIMIT '.$this->limite_requete['depart'].', '.$this->limite_requete['limite'];
206
		} else {
207
			$this->requete_limite = ' LIMIT '.$this->limite_requete['depart'].', '.$this->limite_requete['limite'];
208
		}
209
		return $this->requete_limite;
210
	}
211
 
212
 
213
	public function recupererTotalResultat() {
214
		//on récupère le nombre total de résultats de la requete (ex : le nombre d'id contenu dans la liste /ontologies)
215
		$requete = 'SELECT count(*) as nombre FROM '
216
			.$this->table
217
			.$this->retournerRequeteCondition();
218
		$res = $this->getBdd()->recuperer($requete);
219
		if ($res) {
220
			$total = $res['nombre'];
221
		} else {
222
			$e = 'Données introuvables dans la base';
223
			$this->renvoyerErreur(RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE, $e);
224
			Debug::printr($requete);
225
		}
226
		return $total;
227
	}
228
 
229
	//+------------------------------------------------------------------------------------------------------+
230
	public function retournerResultatFormate($resultat) {
231
		// determine en fct du service appelé (/ontologies | /ontologies/#id | /ontologies/#id/champ |
232
		// /ontologies/#id/relations) le format du tableau à retourner. Encode en json
233
		switch ($this->format_reponse) {
234
			case 'ontologies' 				: $reponse = $this->formaterOntologies($resultat); 			 break;
235
			case 'ontologies/id' 			: $reponse = $this->formaterOntologiesId($resultat[0]); 	 break;
236
			case 'ontologies/id/relations' 	: $reponse = $this->formaterOntologiesIdRelations($resultat); break;
237
			default : break;
238
		}
239
		return $reponse;
240
	}
241
 
242
 
243
	public function formaterOntologies($resultat) {
244
		$this->ajouterEnteteResultat($resultat);
245
		$table_retour_json['entete'] = $this->ajouterEnteteResultat($resultat);
246
		if (isset($this->parametres['masque_code']) || isset($this->parametres['masque'])) {
247
			$resultat = $this->trierRechercheFloue($this->parametres['masque_code'], $resultat, 'code');
248
		} elseif (isset($this->parametres['masque_nom'])) {
249
			$resultat = $this->trierRechercheFloue($this->parametres['masque_nom'], $resultat, 'nom');
250
		} elseif (isset($this->parametres['masque_description'])) {
251
			$resultat = $this->trierRechercheFloue($this->parametres['masque_description'], $resultat, 'description');
252
		}
253
		//on remplit la table $table_retour_json['resultat']
254
		foreach ($resultat as $tab) {
255
			$num = $tab['id'];
256
			unset($tab['id']);
257
			foreach ($tab as $param => $valeur) {
258
				$resultat_json[$num][$param] = $valeur;
259
			}
260
			if ($this->retour_format == 'max') $resultat_json[$num]['href'] = $this->ajouterHref('ontologies', $num);
261
		}
262
		$table_retour_json['resultat'] = $resultat_json;
263
		return $table_retour_json;
264
	}
265
 
266
	public function ajouterEnteteResultat($resultat) {
267
		//on remplit la table $table_retour_json['entete']
268
		$entete['depart'] = $this->limite_requete['depart'];
269
		$entete['limite'] = $this->limite_requete['limite'];
270
		$entete['total']  = $this->total_resultat;
271
		//formuler les urls
272
		$url = $this->formulerUrl($this->total_resultat, '/ontologies');
273
		if (isset($url['precedent']) && $url['precedent'] != '') { $entete['href.precedent'] = $url['precedent']; }
274
		if (isset($url['suivant']) && $url['suivant'] != '') { $entete['href.suivant']   = $url['suivant']; }
275
		return $entete;
276
	}
277
 
278
 
279
	public function formaterOntologiesId($resultat) {
280
		$table_retour = array();
281
		foreach ($resultat as $key => $valeur) {
282
			if ($valeur != '') {
283
				$table_retour = array_merge($table_retour, $this->afficherDonnees($key, $valeur));
284
			}
285
		}
286
		return $table_retour;
287
	}
288
 
289
	public function afficherDonnees($champ, $valeur) {
290
		$retour[$champ] = $valeur;
291
		if ($this->retour_format == 'max') {
292
			if ($champ == 'classe_id') {
293
				unset($retour[$champ]); // remplacer par classe.id
294
				if ($valeur != "0") { // pas de parent
295
					if (isset($this->parametres['retour_champs'])) {
296
						switch ($this->parametres['retour_champs']) {
297
							case 'classe' : $retour['classe'] = $this->ajouterClasseCorrespondante($valeur); break;
298
							case 'classe.id' : $retour['classe.id'] = $valeur; break;
299
							case 'classe.href' : $retour['classe.href'] = $this->ajouterHref('ontologies', $valeur); break;
300
							case 'classe.*' : $retour['classe.id'] = $valeur; $retour['classe.href'] = $this->ajouterHref('ontologies', $valeur); break;
301
						}
302
					} else {
303
						$nom_classe = $this->ajouterClasseCorrespondante($valeur);
304
						if (isset($nom_classe)) $retour['classe'] = $nom_classe;
305
						$retour['classe.id'] = $valeur;
306
						$retour['classe.href'] = $this->ajouterHref('ontologies', $valeur);
307
					}
308
				}
309
			}
310
		}
311
		return $retour;
312
	}
313
 
314
	/** Recherche par interrogation de la base, le nom de la classe à partir de son identifiant (classe.id)  */
315
	public function ajouterClasseCorrespondante($classe_id) {
316
		$nom = null;
317
		if ($classe_id != 0) {
318
			$nom = '';
319
			$req = 'SELECT nom FROM '.$this->table.' WHERE id = '.$this->getBdd()->proteger($classe_id);
320
			$res = $this->getBdd()->recuperer($req);
321
			if ($res) {
322
				$nom = $res['nom'];
323
			} else {
324
				$e = "Données introuvables dans la table $this->table";
325
				$this->renvoyerErreur(RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE, $e);
326
				Debug::printr($req);
327
			}
328
		}
329
		return $nom;
330
	}
331
 
332
	public function formaterOntologiesIdRelations($resultat) {
333
		$retour = null;
334
		if ($resultat != '') {
335
			$retour['entete'] = $this->ajouterEnteteResultat($resultat);
336
			//on remplit la table $table_retour_json['resultat']
337
			foreach ($resultat as $tab) {
338
				$num = $tab['id'];
339
				$retour['resultat'][$num]['nom'] = $tab['nom'];
340
				if ($this->retour_format == 'max') {
341
					$retour['resultat'][$num]['href'] = $this->ajouterHref('ontologies', $num);
342
				}
343
			}
344
		}
345
		return $retour;
346
	}
347
}
348
?>