Subversion Repositories eFlore/Applications.del

Rev

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

Rev Author Line No. Line
1142 aurelien 1
<?php
2
// declare(encoding='UTF-8');
3
/**
4
 * Le web service image récupère toutes les données de la table del_obs_images
5
 * pour retourner une liste d'images associée à la détermination la plus probable
6
 * avec la possibilité de ne renvoyer que les images les mieux notées pour un protocole donné
7
 *
8
 * @category	php 5.2
9
 * @package	del
10
 * @subpackage images
11
 * @author		Aurélien Peronnet <aurelien@tela-botanica.org>
12
 * @copyright	Copyright (c) 2012, Tela Botanica (accueil@tela-botanica.org)
13
 * @license	http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt Licence CECILL
14
 * @license	http://www.gnu.org/licenses/gpl.html Licence GNU-GPL
15
 * @version	$Id: Bdd.php 403 2012-02-22 14:35:20Z aperonnet $
16
 * @see http://www.tela-botanica.org/wikini/eflore/wakka.php?wiki=ApiIdentiplante01Images
17
 */
18
 
19
class ListeImagesDeterminationsProbables {
20
 
1168 aurelien 21
	private $indexImagesIds = array();
1142 aurelien 22
	private $conteneur;
23
	private $navigation;
24
	private $masque;
25
	private $gestionBdd;
26
	private $bdd;
27
	private $parametres = array();
28
	private $ressources = array();
29
	private $tri = 'date_transmission';
30
	private $directionTri = 'desc';
1144 aurelien 31
	private $protocole_defaut = null;
32
	private $valeur_vote_min_defaut = null;
1142 aurelien 33
 
34
	public function __construct(Conteneur $conteneur = null) {
35
		$this->conteneur = $conteneur == null ? new Conteneur() : $conteneur;
1144 aurelien 36
		$this->conteneur->chargerConfiguration('config_determinations.ini');
1142 aurelien 37
		$this->navigation = $conteneur->getNavigation();
38
		$this->masque = $conteneur->getMasque();
39
		$this->gestionBdd = $conteneur->getGestionBdd();
40
		$this->bdd = $this->gestionBdd->getBdd();
41
	}
42
 
43
	/**
44
	 * Méthode principale de la classe.
45
	 * Lance la récupération des images dans la base et les place dans un objet ResultatService
46
	 * pour l'afficher.
47
	 * @param array $ressources les ressources situées après l'url de base (ex : http://url/ressource1/ressource2)
48
	 * @param array $parametres les paramètres situés après le ? dans l'url
49
	 * */
50
	public function consulter($ressources, $parametres) {
51
		$this->initialiserRessourcesEtParametres($ressources, $parametres);
52
 
53
		// Gestion des configuration du script
54
		$this->configurer();
55
		$this->verifierConfiguration();
1143 aurelien 56
 
57
		$this->verifierParametres();
1142 aurelien 58
 
59
		$this->initialiserTri();
1143 aurelien 60
 
1142 aurelien 61
		// Lancement du service
62
		$liaisons = $this->chargerLiaisons();
1144 aurelien 63
		$total = 0;
64
		if(!empty($liaisons)) {
65
			$total = $this->compterImages();
66
			$images = $this->chargerImage($liaisons);
67
			$images = $this->chargerPropositionPlusProbable($images);
68
		} else {
69
			$images = $liaisons;
70
		}
71
 
1142 aurelien 72
		$this->navigation->setTotal($total);
73
 
74
		// Mettre en forme le résultat et l'envoyer pour affichage
75
		$resultat = new ResultatService();
76
		$resultat->corps = array('entete' => $this->conteneur->getEntete(), 'resultats' => $images);
1144 aurelien 77
 
1142 aurelien 78
		return $resultat;
79
	}
80
 
81
	private function initialiserRessourcesEtParametres($ressources, $parametres) {
82
		$this->ressources = $ressources;
83
		$this->parametres = $parametres;
1144 aurelien 84
 
85
		if(!isset($parametres['masque.protocole'])) {
86
			$this->parametres['masque.protocole'] = $this->protocole_defaut;
1143 aurelien 87
		}
1144 aurelien 88
		if(!isset($parametres['masque.valeur_vote_min'])) {
89
			$this->parametres['masque.valeur_vote_min'] = $this->valeur_vote_min_defaut;
1143 aurelien 90
		}
1142 aurelien 91
	}
92
 
1143 aurelien 93
	private function verifierParametres() {
1142 aurelien 94
		$erreurs = array();
1144 aurelien 95
		$tableau_protocoles = explode(',',$this->conteneur->getParametre('protocoles_possibles'));
96
 
97
		if(isset($this->parametres['masque.protocole']) &&
98
			(!is_numeric($this->parametres['masque.protocole']) ||
99
			 !in_array($this->parametres['masque.protocole'], $tableau_protocoles)
100
			)) {
101
			$erreurs[] = '- la valeur pour le protocole doit être un entier compris dans les numéros de protocole existants '.$this->conteneur->getParametre('protocoles_possibles');
1142 aurelien 102
		}
103
 
1144 aurelien 104
		if(isset($this->parametres['masque.valeur_min_vote']) &&
105
				 (!is_numeric($this->parametres['masque.valeur_min_vote']) ||
106
				  $this->parametres['masque.valeur_min_vote'] < 0 ||
107
				  $this->parametres['masque.valeur_min_vote'] > 5
108
				 )) {
109
			$erreurs[] = '- la valeur minimum de valeur des votes doit être un entier compris entre 0 et 5 ';
1142 aurelien 110
		}
111
 
112
		if (!empty($erreurs)) {
1143 aurelien 113
			$e = 'Erreur lors de l\'analyse des parametres du service : '."\n";
1142 aurelien 114
			$e .= implode("\n", $erreurs);
115
			throw new Exception($e, RestServeur::HTTP_CODE_ERREUR);
116
		}
117
	}
118
 
119
	private function initialiserTri() {
120
		$this->tri = isset($this->parametres['tri']) ? $this->parametres['tri'] : $this->tri;
121
		$this->directionTri = isset($this->parametres['ordre']) ? $this->parametres['ordre'] : $this->directionTri;
122
	}
123
	/*-------------------------------------------------------------------------------
124
	 							CONFIGURATION DU SERVICE
125
	 --------------------------------------------------------------------------------*/
126
	/**
127
	 * Configuration du service en fonction du fichier de config config_del.ini
128
	 * */
129
	public function configurer() {
130
		$this->mappingFiltre = $this->conteneur->getParametre('mapping_masque');
131
		$this->mappingObservation = $this->conteneur->getParametre('mapping_observation');
132
		$this->mappingVotes = $this->conteneur->getParametre('mapping_votes');
133
	}
134
 
135
	/**
136
	 * Vérifier que le service est bien configuré
137
	 * */
138
	public function verifierConfiguration() {
139
 
140
		$erreurs = array();
1144 aurelien 141
		$tris_possibles = $this->conteneur->getParametre('protocoles_possibles');
1142 aurelien 142
		if (empty($tris_possibles)) {
1144 aurelien 143
			$erreurs[] = '- le fichier de configuration ne contient pas le parametre protocoles_possibles ou celui-ci est vide ;';
1142 aurelien 144
		}
1144 aurelien 145
		//TODO: ajouter des vérifications si le web service s'étoffe
1142 aurelien 146
 
147
		if (!empty($erreurs)) {
148
			$e = 'Erreur lors de la configuration : '."\n";
149
			$e .= implode("\n", $erreurs);
150
			throw new Exception($e, RestServeur::HTTP_CODE_ERREUR);
151
		}
152
	}
153
 
154
	private function remplacerParJokerCaractere($valeurMasque) {
155
		return str_replace(array('-',' '), '_', $valeurMasque);
156
	}
157
	//TODO: déplacer les fonctions ci dessus et dessous dans une classe
158
	// utilitaire
159
	function supprimerAccents($str, $charset='utf-8')
160
	{
161
		$str = htmlentities($str, ENT_NOQUOTES, $charset);
162
 
163
		$str = preg_replace('#&([A-za-z])(?:acute|cedil|circ|grave|orn|ring|slash|th|tilde|uml);#', '\1', $str);
164
		$str = preg_replace('#&([A-za-z]{2})(?:lig);#', '\1', $str); // pour les ligatures e.g. '&oelig;'
165
		$str = preg_replace('#&[^;]+;#', '', $str); // supprime les autres caractères
166
 
167
		return $str;
168
	}
169
 
170
	/*-------------------------------------------------------------------------------
171
								CHARGEMENT DES IMAGES
172
	--------------------------------------------------------------------------------*/
173
	/**
174
	* Chargement depuis la bdd de toutes les liaisons entre images et observations
175
	* */
176
	private function chargerLiaisons() {
177
 
178
		$champs = array('dob.id_observation as id_observation', 'nom_ret', 'nom_ret_nn', 'nt', 'famille', 'ce_zone_geo', 'zone_geo',
179
						'lieudit', 'station', 'milieu', 'date_observation', 'dob.mots_cles_texte as mots_cles_texte', 'dob.commentaire as commentaire',
180
						'di.mots_cles_texte as mots_cles_texte_image ', 'date_transmission', 'di.id_image as id_image', 'di.ce_utilisateur as ce_utilisateur',
1274 aurelien 181
						'prenom', 'nom', 'courriel', 'dob.nom_utilisateur', 'dob.prenom_utilisateur', 'dob.courriel_utilisateur', 'nom_original');
1144 aurelien 182
 
1171 aurelien 183
		$requeteLiaisons = 'SELECT SQL_CALC_FOUND_ROWS '.implode(', ',$champs).', '.
1142 aurelien 184
						   'AVG(dvote.valeur) as moyenne_votes '.
185
						   'FROM '.$this->gestionBdd->formaterTable('del_obs_image', 'doi').
186
						   'INNER JOIN del_image di '.
187
						   'ON doi.id_image = di.id_image '.
188
						   'INNER JOIN del_observation dob '.
189
						   'ON doi.id_observation = dob.id_observation '.
1246 gduche 190
						   'LEFT JOIN del_utilisateur du '.
1142 aurelien 191
						   'ON du.id_utilisateur = di.ce_utilisateur '.
192
						   'LEFT JOIN del_image_vote dvote '.
1144 aurelien 193
						   'ON doi.id_image = dvote.ce_image '.
194
							($this->parametres['masque.protocole'] != null ? 'AND dvote.ce_protocole = '.$this->parametres['masque.protocole'].' ' : ' ');
195
		$requeteLiaisons .= 'GROUP BY dvote.ce_image '.
1173 aurelien 196
							($this->parametres['masque.valeur_vote_min'] != null && $this->parametres['masque.valeur_vote_min'] != 0 ? 'HAVING AVG(dvote.valeur) >= '.$this->parametres['masque.valeur_vote_min'].' ' : ' ').
1144 aurelien 197
							'ORDER BY moyenne_votes';
1142 aurelien 198
		$requeteLiaisons .= $this->gestionBdd->getLimitSql();
1168 aurelien 199
 
1142 aurelien 200
		return $this->bdd->recupererTous($requeteLiaisons);
201
	}
202
 
203
	private function doitJoindreTableVotes() {
204
		return ($this->tri == 'votes');
205
	}
206
 
207
	private function getTri() {
208
		$order = '';
209
		if($this->doitJoindreTableVotes()) {
210
			$order = ' GROUP BY dvote.ce_image, dob.id_observation ORDER BY total_votes '.$this->directionTri.', date_transmission desc ';
211
		} else {
212
			$order = ' ORDER BY '.$this->tri.' '.$this->directionTri.' ';
213
		}
214
		return $order;
215
	}
216
 
217
	/**
218
	* Compter le nombre total d'images dans la base pour affichage dans entete.
219
	* */
220
	private function compterImages() {
221
		$requete = 'SELECT FOUND_ROWS() AS nbre ';
222
		$resultats = $this->bdd->recuperer($requete);
223
		return (int) $resultats['nbre'];
224
	}
225
 
226
	/**
227
	* Retourner un tableau d'images formaté en fonction des liaisons trouvées
228
	* @param $liaisons les liaisons de la table del_obs_images
229
	* */
230
	private function chargerImage($liaisons) {
1168 aurelien 231
 
1142 aurelien 232
		$images = array();
233
		foreach ($liaisons as $liaison) {
1274 aurelien 234
 
1277 aurelien 235
			if($liaison['ce_utilisateur'] == 0) {
1274 aurelien 236
				$liaison['prenom'] = $liaison['prenom_utilisateur'];
237
				$liaison['nom'] = $liaison['nom_utilisateur'];
238
			}
239
 
1142 aurelien 240
			$idObs = $liaison['id_observation'];
241
			$idImage = $liaison['id_image'];
242
			// On enregistre l'ID de l'obs pour n'effectuer qu'une seule requête par la suite
243
			$this->obsIds[] = $idObs;
244
			$index = $liaison['id_image'].'-'.$liaison['id_observation'];
1168 aurelien 245
			$this->indexImagesIds[$idImage] = $index;
1142 aurelien 246
			$images[$index] = array(
247
						'id_image' => $idImage,
248
						'id_observation' => $idObs,
249
						'auteur.intitule' => $liaison['prenom'].' '.$liaison['nom'],
250
						'binaire.href' => $this->formaterLienImage($idImage),
251
						'determination.famille' => $liaison['famille'],
252
						'determination.ns' => $liaison['nom_ret'],
253
						'determination.nn' => $liaison['nom_ret_nn'],
254
						'determination.nt' => $liaison['nt'],
255
						'date_observation' => $liaison['date_observation'],
1168 aurelien 256
						'localite' => $this->formaterLieu($liaison),
257
						'mots_cles_image_cel' => $this->formaterMotsClesCel($liaison['mots_cles_texte_image']),
258
						'mots_cles_image_del' => ""
1142 aurelien 259
			);
260
		}
261
		return $images;
262
	}
263
 
264
	/**
265
	* Charger les votes pour chaque image
266
	* */
267
	private function chargerPropositionPlusProbable($images) {
1325 aurelien 268
			$this->obsIds = array(368594);
1142 aurelien 269
 
270
			$requetePropositions = 'SELECT * FROM '.
271
								'del_commentaire '.
272
								'WHERE ce_observation IN ('.implode(',', $this->obsIds).') '.
273
								'AND nom_sel IS NOT NULL ';
274
 
275
			$requeteVotes = 'SELECT ce_proposition, valeur, ce_utilisateur '.
276
			  		'FROM del_commentaire_vote '.
277
			  		'WHERE ce_proposition IN ('.
278
			  		'SELECT id_commentaire FROM '.
279
								'del_commentaire '.
280
								'WHERE ce_observation IN ('.implode(',', $this->obsIds).') '.
281
								'AND nom_sel IS NOT NULL'.
282
			  		') '.
283
			  		'ORDER BY ce_proposition';
284
 
1168 aurelien 285
			$requeteMotsCles = 'SELECT tag, ce_image '.
286
							   'FROM del_image_tag '.
287
							   'WHERE ce_image IN ('.implode(',', array_keys($this->indexImagesIds)).') '.
288
							   'AND actif = 1 ';
289
 
1142 aurelien 290
			$resultatsPropositions = $this->bdd->recupererTous($requetePropositions);
291
			$resultatsVotes = $this->bdd->recupererTous($requeteVotes);
1168 aurelien 292
			$resultatsMotsCles = $this->bdd->recupererTous($requeteMotsCles);
1142 aurelien 293
 
294
			$propositions = array();
295
			$votes = array();
296
 
297
			foreach($resultatsVotes as $vote) {
298
				if(!isset($votes[$vote['ce_proposition']])) {
299
					$votes[$vote['ce_proposition']] = 0;
300
				}
301
				$valeur = ($vote['valeur'] == 1) ? 1 : -1;
302
				$votes[$vote['ce_proposition']] += is_numeric($vote['ce_utilisateur']) ? 3*$valeur : $valeur;
303
			}
1325 aurelien 304
 
1142 aurelien 305
			foreach($resultatsPropositions as $proposition) {
306
				$id_proposition = $proposition['id_commentaire'];
307
				$id_obs = $proposition['ce_observation'];
308
 
309
				if(isset($votes[$id_proposition])) {
310
					$score = $votes[$id_proposition];
311
				} else {
312
					$score = -1;
313
				}
1325 aurelien 314
 
1142 aurelien 315
				$proposition['valeur'] = $score;
316
				if(!isset($propositions[$id_obs])) {
317
					$propositions[$id_obs] = $proposition;
318
				} else {
319
					$score_ancienne_proposition = $propositions[$id_obs]['valeur'];
320
					$propositions[$id_obs] = ($score >= $score_ancienne_proposition) ?
321
													$proposition : $propositions[$id_obs];
322
				}
323
			}
1168 aurelien 324
 
325
			foreach ($resultatsMotsCles as $motCle) {
326
				$tag = $motCle['tag'];
327
				$index = $this->indexImagesIds[$motCle['ce_image']];
328
				if($images[$index]['mots_cles_image_del'] != "") {
329
					$tag = ",".$tag;
330
				}
331
				$images[$index]['mots_cles_image_del'] .= $tag ;
332
			}
333
 
1142 aurelien 334
			foreach ($images as $id => $image) {
335
				if ($this->doitRemplacerObservationParProposition($propositions, $image)) {
336
					$id_obs = $image['id_observation'];
337
					$images[$id]['determination.famille'] = $propositions[$id_obs]['famille'];
1325 aurelien 338
					$images[$id]['determination.ns'] = $propositions[$id_obs]['nom_sel'];
339
					$images[$id]['determination.nn'] = $propositions[$id_obs]['nom_sel_nn'];
1142 aurelien 340
					$images[$id]['determination.nt'] = $propositions[$id_obs]['nt'];
341
				}
1144 aurelien 342
 
1168 aurelien 343
				if(isset($images[$id]['determination.nn'])) {
344
					$images[$id]['url_fiche_eflore'] = $this->formaterUrlFicheEflore($images[$id]['determination.nn']);
345
				}
1142 aurelien 346
			}
347
 
348
		return $images;
349
	}
350
 
1325 aurelien 351
	private function doitRemplacerObservationParProposition($propositions, $image) {
1142 aurelien 352
		return ((isset($propositions[$image['id_observation']]) &&
353
			$propositions[$image['id_observation']] != null &&
1325 aurelien 354
			$propositions[$image['id_observation']]['nom_sel_nn'] != 0) &&
1142 aurelien 355
			($propositions[$image['id_observation']]['valeur'] > 0 ||
356
			$image['determination.nn'] == 0)
357
		);
358
	}
359
 
360
	/*-------------------------------------------------------------------------------
361
								FORMATER ET METTRE EN FORME
362
	--------------------------------------------------------------------------------*/
1168 aurelien 363
	/**
364
	*  Formater les mots clés du cel en n'affichant que ceux faisant partie
365
	*  d'une liste définie dans le fichier de configuration
366
	*  @param $chaineMotCleCel la chaine de mots clés du cel
367
	*  @return string la chaine filtrée
368
	* */
369
	private function formaterMotsClesCel($chaineMotCleCel) {
370
		$tabMotsClesCel = explode(',', $chaineMotCleCel);
371
		$chaineMotsClesAffiches = $this->conteneur->getParametre('mots_cles_cel_affiches');
372
		$tabMotsClesAffiches = explode(',',$chaineMotsClesAffiches);
373
 
374
		return implode(',', array_intersect($tabMotsClesAffiches, $tabMotsClesCel));
375
	}
1142 aurelien 376
 
377
	/**
378
	*  Formater une observation depuis une ligne liaison
379
	*  @param $liaison liaison issue de la recherche
380
	*  @return $observation l'observation mise en forme
381
	* */
382
	private function formaterObservation($liaison) {
383
		$observation = array();
384
 
385
		foreach ($this->mappingObservation as $nomOriginal => $nomFinal) {
386
			$observation[$nomFinal] = $liaison[$nomOriginal];
387
		}
388
 
389
		return $observation;
390
	}
391
 
392
	/**
393
	 * Formater le lien de l'image en fonction du fichier de config et de l'identifiant de l'image
394
	 * */
395
	private function formaterLienImage($idImage) {
396
		$idImage = sprintf('%09s', $idImage);
397
		$url = $this->conteneur->getParametre('url_images');
398
		$urlImage = str_replace('%s', $idImage, $url);
399
		return $urlImage;
400
	}
401
 
1144 aurelien 402
	private function formaterLieu($image) {
403
		$lieu = $image['zone_geo'];
404
		if($image['ce_zone_geo'] != '') {
405
			$id_zone_geo = $image['ce_zone_geo'];
406
			if(strpos($image['ce_zone_geo'], 'INSEE-C:') === 0) {
407
				$id_zone_geo = str_replace('INSEE-C:', '', $image['ce_zone_geo']);
408
				$id_zone_geo = (strlen($id_zone_geo) >= 5) ? substr($id_zone_geo, 0, 2) : $id_zone_geo;
409
			}
410
 
411
			$lieu .= ' ('.$id_zone_geo.')';
412
		}
413
		return $lieu;
414
	}
415
 
416
	private function formaterUrlFicheEflore($num_nom) {
417
		$url = $this->conteneur->getParametre('url_fiche_eflore');
418
		return sprintf($url, $num_nom);
419
	}
420
 
1142 aurelien 421
	private function proteger($valeur) {
422
		if (is_array($valeur)) {
423
			return $this->bdd->protegerTableau($valeur);
424
		} else {
425
			return $this->bdd->proteger($valeur);
426
		}
427
	}
428
}
429
?>