Subversion Repositories eFlore/Projets.eflore-projets

Rev

Rev 3 | Rev 88 | 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
* Classe Commun.php est une classe abstraite qui contient les méthodes de base communes à tous les
4
* sous-services des projets.
5
*
6
* Encodage en entrée : utf8
7
* Encodage en sortie : utf8
8
* @package eflore-projets
9
* @author Jennifer DHÉ <jennifer.dhe@tela-botanica.org>
10
* @author Delphine CAUQUIL <delphine@tela-botanica.org>
11
* @author Jean-Pascal MILCENT <jpm@tela-botanica.org>
12
* @license GPL v3 <http://www.gnu.org/licenses/gpl.txt>
13
* @license CECILL v2 <http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt>
14
* @version 1.0
15
* @copyright 1999-2011 Tela Botanica (accueil@tela-botanica.org)
16
*/
17
 
18
abstract class Commun {
19
 
20
	/** Objet Bdd. */
21
	private $Bdd = null;
22
	/** Objet Rest Client. */
23
	private $RestClient = null;
24
 
25
	/** Contients les paramètres. Doit remplacer table_param. */
26
	protected $parametres = array();
27
	/** Contients les ressources. Doit remplacer table_ressources. */
28
	protected $ressources = array();
29
	/** Le nom du service courrant. */
30
	protected $serviceNom = null;
31
 
32
	//Classe commune à tous les services web d'un projet. Contient par exemple les fonctions permettant de
33
	//renvoyer la réponse http...
34
	protected $entete_http; // Entete de la réponse correspondant au code de réponse de la requete http */
35
	protected $corps_http; // Tableau de résultat à retourner au format json ou la description de l'erreur si elle existe */
36
	protected $service; // Nom du service appelé
37
	/** Stocke la version du projet demandée dans la requete
38
	 *  - "*" : (/#projet/* /meta-donnees) Renvoi les meta-données de toutes les versions du projet
39
	 *  - "numero de la version" : (/#projet/2.00/meta-donnees) Renvoi les meta-données de la version 2.00 du projet */
40
	protected $version_projet = '+';
41
	protected $table_version; //Stocke les noms des tables de toutes les versions du projet disponibles
42
	/** tableau contenant tous les champs d'une table (est rempli par la fonction Commun::recupererNomChamp($table)) */
43
	protected $champs_table = array();
44
	private static $tri_multi_dimension = array();
45
	private static $tri_type = '';
46
 
47
	public function consulter($ressources, $parametres) {
48
			$this->ressources = $ressources;
49
			$this->parametres = $parametres;
50
			$this->chargerNomDuService();
51
 
52
			$this->traiterParametres();
53
			$this->traiterVersionProjet();
54
 
55
			$resultats = '';
56
			foreach ($this->table_version as $version) {
57
				$this->table = $version; //on stocke le nom de la table correspondant à la version du projet en cours
58
				$this->recupererNomChamp($this->table); //on récupère les noms des champs disponibles (Ds Commun.php)
59
				$this->traiterRessources(); //dans CommunNomsTaxons.php
60
				$requete = $this->assemblerLaRequete();
61
				$resultat = $this->getBdd()->recupererTous($requete);
62
				$versionResultat = $this->traiterResultat($resultat, $version, $requete);
63
				if (count($this->table_version) > 1) {
64
					$resultats[$version] = $versionResultat;
65
				} else {
66
					$resultats = $versionResultat;
67
				}
68
			}
69
 
70
		return $resultats;
71
	}
72
 
73
	private function chargerNomDuService() {
74
		$this->serviceNom = get_class($this);
75
	}
76
 
77
	public function traiterResultat($resultat, $version, $requete) {
78
		$versionResultat = null;
79
		if ($resultat == '') {
80
			//cas ou la requete comporte des erreurs
81
			$message = 'La requête SQL formée comporte une erreur!';
82
			$code = RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE;
83
			throw new Exception($message, $code);
84
		} elseif ($resultat) {
85
			$versionResultat = $this->retournerResultatFormate($resultat, $version);
86
		} else {
87
			$message = 'Les données recherchées sont introuvables.';
88
			$code = RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE;
89
			throw new Exception($message, $code);
90
		}
91
		return $versionResultat;
92
	}
93
 
94
	//+------------------------------------------------------------------------------------------------------+
95
	// Méthodes concernant les paramètres
96
	/**
97
	 *  Permet de récupérer une liste des noms des champs de la table passée en paramètre
98
	 *  @param $table : Nom de la table dont on souhaite connaitre les champs
99
	 */
100
	public function recupererNomChamp($table) {
101
		$requete = 'SHOW FIELDS FROM '.$table;
102
 
103
		$resultat = $this->getBdd()->recupererTous($requete);
104
		if ($resultat == '') {
105
			$e = 'La requête SQL formée comporte une erreur!';
106
			$this->renvoyerErreur(RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE, $e);
107
		} elseif ($resultat) {
108
			foreach ($resultat as $info) {
109
				$this->champs_table[] = $info['Field'];
110
			}
111
		} else {
112
			$m = "La table recherchée n'existe pas";
113
			$this->renvoyerErreur(RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE, $m);
114
		}
115
	}
116
 
117
	/**
118
	 * Fonction permettant de creer la table dont le nom est passé en paramètre (champs_api, champs_bdtfx,
119
	 * correspondance_champs...). Les données de chaque table sont présentes dans le fichier de configuration config.ini
120
	 * @param String $table : Peut contenir plusieurs nom de table dont on souhaite récupérer les données : table,table,table.
121
	 * 	Ex : recupererTableConfig('champs_api,champs_bdtfx')
122
	 */
123
	public function recupererTableConfig($table) {
124
		$tables = explode(',', $table);
125
		foreach ($tables as $tab) {
126
			$tableau = explode(',', Config::get($tab));
127
			$tableau = array_map('trim', $tableau);
128
			foreach ($tableau as $champ) {
129
				list($code, $rang) = explode('=', $champ);
130
				$tab_tampon[$code] = $rang;
131
			}
132
			$this->$tab = $tab_tampon;
133
			$tab_tampon = array();
134
		}
135
	}
136
 
137
	public function renvoyerErreur($entete, $message) {
138
		throw new Exception($message, $entete);
139
	}
140
 
141
	/**
142
	 * Permet de remplir la variable version_projet et de retirer cette donnée du tableau des ressources
143
	 * @param $ressources
144
	 */
145
	public function traiterVersionProjet() {
81 delphine 146
		if (isset($this->parametres['version.projet'])) {
147
			if (preg_match('/(?:v[0-9]+(?:(?:_|[.])[0-9]+)?|[*])/', $this->parametres['version.projet'])) {
148
				$this->version_projet = $this->parametres['version.projet'];
3 jpm 149
				$this->version_projet = str_replace('.', '_', $this->version_projet);
150
			}
151
		}
152
		//si la liste des noms est demandée pr toutes les versions, on affiche seulement la dernière version :
153
		if ($this->version_projet == '*' && $this->ressources == array()) {
154
			$this->version_projet = '+';
155
		}
156
		//on recupère les versions du projet disponible dans la table des meta-donnees (utilisation service MetaDonnees)
157
		$table_num_version = $this->recupererVersionDisponible();
158
		//on recupere la liste des noms des tables de la bdd correspondant aux differentes versions du projet en fct de la ou les versions demandées
159
		$this->recupererListeNomTablePrChaqueVersion($table_num_version);
160
	}
161
 
162
	/**
163
	 * Recupération des versions disponibles par appel du service metaDonnees
164
	 * Verification de l'existance du service recherché dans la requete (si précisé : hors *)
165
	 * @return array  : tableau contenant le numéro de chaque version disponible
166
	 */
167
	public function recupererVersionDisponible() {
168
		$versions_dispo = '';
169
		$req_version = 'SELECT version FROM '.Config::get('bdd_table_meta');
170
		$res_version = $this->getBdd()->recupererTous($req_version);
171
		if ($res_version == '') { //cas ou la requete comporte des erreurs
172
			$e = "La requête SQL de versionnage formée comporte une erreur : $req_version";
173
			$this->renvoyerErreur(RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE, $e);
174
		} elseif ($res_version) {
175
			foreach ($res_version as $version) {
176
				$versions_dispo[] = $version['version'];
177
			}
178
		} else {
179
			$m = 'Versions introuvables dans la table des méta-données';
180
			$this->renvoyerErreur(RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE, $m);
181
		}
182
		return $versions_dispo;
183
	}
184
 
185
	public function recupererListeNomTablePrChaqueVersion($table_num_version) {
186
		switch ($this->serviceNom) {
187
			case 'Ontologies' :
188
				$prefixe_table = 'bdd_table_ontologies';
189
				break;
190
			default:
191
				$prefixe_table = 'bdd_table';
192
		}
193
		switch ($this->version_projet) {
194
			case '+' :
195
				$derniere_version = $table_num_version[count($table_num_version) - 1];
196
				$this->table_version[] = Config::get($prefixe_table).'_v'.str_replace('.', '_', $derniere_version);
197
				break;
198
			case '*' :
199
				foreach ($table_num_version as $num_version) {
200
					$this->table_version[] = Config::get($prefixe_table).'_v'.str_replace('.', '_', $num_version);
201
				}
202
				break;
203
			default  :
204
				$this->table_version[] = Config::get($prefixe_table).'_'.$this->version_projet;
205
				break;
206
		}
207
	}
208
 
209
	/**
210
	 * Est appelée pour former l'url complete des resultats precedants ou suivants.
211
	 * @param int : Permet de connaitre le nombre de noms obtenus par la requete
212
	 * @return string Retourne l'url complete des resultats precedents ou suivant sous la forme d'un tableau
213
	 */
214
	public function formulerUrl($nb_resultat, $id = null) {
215
		$url = array();
216
		$debut_url = Config::get('url_service').$id.'?';
217
		//on recré l'url sans les parametres de navigation qui seront rajouter ci-apres. On les enlève dc de la table des parametres
218
		foreach($this->parametres as $cle => $val) {
219
			$param_url[str_replace('_', '.', $cle)] = $val;
220
		}
221
 
222
		$this->recupererLesLimitesSuivantes($nb_resultat, $param_url);
223
		if (isset($param_url['navigation.depart']) && isset($param_url['navigation.limite'])) {
224
			$url['suivant'] = $debut_url.http_build_query($param_url);
225
		}
226
 
227
		$this->recupererLesLimitesPrecedentes($param_url);
228
		if (isset($param_url['navigation.depart']) && isset($param_url['navigation.limite'])) {
229
			$url['precedent'] = $debut_url.http_build_query($param_url);
230
		}
231
		return $url;
232
	}
233
 
234
	public function supprimerNavigation(&$param_url) {
235
		unset($param_url['navigation.depart']);
236
		unset($param_url['navigation.limite']);
237
	}
238
 
239
	/**
240
	 * Description :
241
	 * Permet de former les limites de la requete retournant les résultats suivants.
242
	 * Cette url sera afficher dans l'entete de la reponse retournée en format JSON (retour.format=defaut).
243
	 * @param int : $nb_resultat : Permet de connaitre le nombre de résultats obtenus par la requete
244
	 * @return string : la fin de l'url decrivant les limites des resultats suivants. Si aucun résultats ne suient,
245
	 * une chaine de caractère vide est retournée
246
	 */
247
	public function recupererLesLimitesSuivantes($nb_resultat, &$param_url_suiv) {
248
		$this->supprimerNavigation($param_url);
249
		$depart = $this->limite_requete['depart'];
250
		$limite = $this->limite_requete['limite'];
251
		$depart_suivant = $depart + $limite;
252
		$limite_suivant = $limite;
253
		if ($nb_resultat > $depart_suivant) {
254
			$param_url_suiv['navigation.depart'] = $depart_suivant;
255
			$param_url_suiv['navigation.limite'] = $limite_suivant;
256
		} else {
257
			$param_url_suiv['navigation.depart'] = null;
258
			$param_url_suiv['navigation.limite'] = null;
259
		}
260
	}
261
 
262
	/**
263
	 * Description :
264
	 * Permet de former les limites de la requete retournant les résultats precedents.
265
	 * Cette url sera afficher dans l'entete de la taxons/105reponse retournée en format JSON (retour.format=defaut)
266
	 * @return string : la fin de l'url decrivant les limites des resultats precedents.
267
	 * Si aucun résultats ne precedent, une chaine de caractère vide est retournée
268
	 */
269
	public function recupererLesLimitesPrecedentes(&$param_url) {
270
		$this->supprimerNavigation($param_url);
271
		$depart = $this->limite_requete['depart'];
272
		$limite = $this->limite_requete['limite'];
273
		if ($depart == 0) {
274
			$url_precedente = '';
275
		} else {
276
			if (($depart - $limite) < 0) {
277
				$depart_precedent = 0;
278
			} else {
279
				$depart_precedent = $depart - $limite;
280
			}
281
			$param_url['navigation.depart'] = $depart_precedent;
282
			$param_url['navigation.limite'] = $limite;
283
		}
284
	}
285
 
286
	public function ajouterHref($service, $val) {
287
		// http://tela-botanica.org/service:eflore:0.1/[projet]/[version_projet]/[service]/[ressource]:[valeur]
288
		if ($this->version_projet == '+') {
289
			$url = Config::get('url_service_base').Config::get('nom_projet').'/'.$service.'/'.$val;
290
		} else {
81 delphine 291
			$url = Config::get('url_service_base').Config::get('nom_projet').'/'.$service.'/'.$val.'?version.projet='.$this->version_projet;
3 jpm 292
		}
293
		return $url;
294
	}
295
 
296
	public function ajouterHrefAutreProjet($service, $ressource, $valeur, $projet = null, $param = null) {
297
		//on enleve les GA et Co, les meta ou les "_"
298
		$this->transliterer($service, $valeur);
299
		//on définit les nom des projets, des services et des ressources de l'url (dans les méta-donnees)
300
		$tab = array(
301
			'langue' 			  => array('service' => 'langues', 'projet' => 'iso-639-1', 'ressource' => ''),
302
			'couverture_spatiale' => array('service' => 'zone-geo', 'projet' => 'iso-3166-1', 'ressource' => ''),
303
			'type' 				  => array('service' => 'ontologies', 'projet' => 'commun', 'ressource' => 'contactType:'),
304
			'datum' 			  => array('service' => 'ontologies', 'projet' => 'commun', 'ressource' => 'datum:')
305
		);
306
		if (array_key_exists($service, $tab)) {
307
			extract($tab[$service]);
308
		} else {
309
			if (strpos(Config::get('nom_projet'), 'bd') === 0 && $projet == null) {
310
				$projet 		= 'bdnt';
311
				$service 		= 'ontologies';
312
				$ressource 		= '';
313
			}
314
		}
81 delphine 315
		if (isset($this->parametres['version.projet'])) {
316
			$param = ($param) ? "?version.projet=".$this->parametres['version.projet']."&".$param : "?".$this->parametres['version.projet'];
317
		} else {
318
			$param = ($param) ? "?".$param : "";
319
		}
320
 
3 jpm 321
		$url = Config::get('url_service_base').$projet.'/'.$service.'/'.$ressource.$valeur.$param;
322
		return $url;
323
	}
324
 
325
	/**Permet de consulter une url et retourne le résultat ou une erreur
326
	 * @param $url	 */
327
	public function consulterHref($url) {
328
		$res = $this->getRestClient()->consulter($url);
329
		$entete = $this->getRestClient()->getReponseEntetes();
330
		//Si le service meta-donnees fonctionne correctement, l'entete comprend la clé wrapper_data
331
		if (isset($entete['wrapper_data'])) {
332
			$res = json_decode($res);
333
			return $res;
334
		} else {
335
			$u = 'L\'url <a href="'.$url.'">'.$url.'</a> lancée via RestClient renvoie une erreur';
336
			$this->renvoyerErreur(RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE, $u);
337
		}
338
	}
339
 
340
	public function transliterer(&$service, &$val) {
341
		if (preg_match('/^.+:(.+)$/', $val, $match)) {
342
			$val = $match[1];
343
		}
344
		$service = str_replace(array('_Ga','_Co','_meta'), '', $service);
345
		if ($service == 'rang') {
346
			$ressource = 'rangTaxo';
347
		} elseif (preg_match('/^(statut)(?:_|-)([^_-]+)$/', $service, $match)) {
348
			$service = $match[1].ucfirst($match[2]);
349
		} elseif (strrpos($service, 'datum') !== false) {
350
			$service = 'datum';
351
		}
352
	}
353
 
354
	// prend en valeur la valeur de la recherche, les résultats approchés, le paramétre recherche
355
	// retourne le tableau trié en fonction de la ressemble entre le résultat approché et la valeur recherchée
356
	public function trierRechercheFloue($nom_demande, $tab_approchee, $nom) {
357
		$trie = '';
358
		$resultat = array();
359
		foreach ($tab_approchee as $id => $tab) {
360
			$nom_demande_ss = strtolower(Chaine::supprimerAccents($nom_demande));
361
			$nom_flou_ss = strtolower(Chaine::supprimerAccents($tab[$nom]));
362
			$stat = array();
363
			// Prime pour la ressemblance globale :
364
			$score = 500 - levenshtein($nom_flou_ss, $nom_demande_ss);
365
			// On affine
366
			$score = $score + (similar_text($nom_demande_ss, $nom_flou_ss) * 3);
367
			$stat['score'] = $score;
368
			foreach ($tab as $key => $valeur) {
369
				$stat[$key] = $valeur;
370
			}
371
			$resultat[] = $stat;
372
		}
373
 
374
 
375
		// Vérification que nous avons bien trouvé un nom approché
376
		if (count($resultat) > 0) {
377
			$trie = Tableau::trierMD($resultat, array('score' => SORT_DESC));
378
		}
379
		return $trie;
380
	}
381
 
382
	protected function recupererTableauConfig($param) {
383
		$tableau = array();
384
		$tableauPartiel = explode(',', Config::get($param));
385
		$tableauPartiel = array_map('trim', $tableauPartiel);
386
		foreach ($tableauPartiel as $champ) {
387
			if (strpos($champ, '=') === false) {
388
				$tableau[] = $champ;
389
			} else {
390
				list($cle, $val) = explode('=', $champ);
391
				$tableau[$cle] = $val;
392
			}
393
		}
394
		return $tableau;
395
	}
396
 
397
	//+------------------------------------------------------------------------------------------------------+
398
	// Méthodes d'accès aux objets du Framework
399
	/**
400
	 * Méthode de connection à la base de données sur demande.
401
	 * Tous les services web n'ont pas besoin de s'y connecter.
402
	 */
403
	protected function getBdd() {
404
		if (! isset($this->Bdd)) {
405
			$this->Bdd = new Bdd();
406
		}
407
		return $this->Bdd;
408
	}
409
 
410
	/**
411
	 * Méthode permettant de faire appel à un client REST en fonction des besoins du service.
412
	 */
413
	protected function getRestClient() {
414
		if (! isset($this->RestClient)) {
415
			$this->RestClient = new RestClient();
416
		}
417
		return $this->RestClient;
418
	}
419
}
420
?>