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