Subversion Repositories eFlore/Projets.eflore-projets

Rev

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

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