Subversion Repositories eFlore/Projets.eflore-projets

Rev

Go to most recent revision | Details | Last modification | View Log | RSS feed

Rev Author Line No. Line
106 aurelien 1
<?php
118 jpm 2
// declare(encoding='UTF-8');
3
/**
4
* Classe implémentant l'API d'eFlore Images pour le projet CEL.
5
*
6
* @see http://www.tela-botanica.org/wikini/eflore/wakka.php?wiki=EfloreApi01Images
7
*
8
* @package eFlore/services
9
* @author Jean-Pascal MILCENT <jpm@tela-botanica.org>
10
* @author Aurélien PERONNET <aurelien@tela-botanica.org>
11
* @license GPL v3 <http://www.gnu.org/licenses/gpl.txt>
12
* @license CECILL v2 <http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt>
13
* @version 1.0
14
* @copyright 1999-2011 Tela Botanica (accueil@tela-botanica.org)
15
*/
16
// TODO : Config et Outils sont des classes statiques qui doivent poser des pb pour les tests...
106 aurelien 17
class Images {
116 jpm 18
 
19
	private $parametres = array();
20
	private $ressources = array();
106 aurelien 21
	private $Bdd;
116 jpm 22
 
138 jpm 23
	const CODE_REFTAX_DEFAUT = 'bdtfx';
24
	const TPL_URL_IMG = 'http://www.tela-botanica.org/appli:cel-img:%s.jpg';
25
	const TAILLE_IMG_DEFAUT = 'M';
26
	const MIME_JPEG = 'image/jpeg';
27
	const MIME_JSON = 'application/json';
140 jpm 28
 
29
	private $config = array();
30
	private $cheminImagesBase = '';
138 jpm 31
	private $formats_supportes = array(self::MIME_JPEG, self::MIME_JSON);
116 jpm 32
	private $ref_tax_demande = array();
138 jpm 33
	private $infosImages = array();
34
	private $nbreImages = 0;
35
	private $Utilisateurs = null;
36
	private $intitulesAuteurs = array();
140 jpm 37
	private $UrlNavigation = null;
116 jpm 38
 
140 jpm 39
	public function __construct(Bdd $bdd = null, Array $config = null, Utilisateurs $utilisateurs = null, Url $url = null) {
40
		$this->config = is_null($config) ? Config::get('Images') : $config;
138 jpm 41
		$this->Bdd = is_null($bdd) ? new Bdd() : $bdd;
42
		$this->Utilisateurs = is_null($utilisateurs) ? new Utilisateurs() : $utilisateurs;
140 jpm 43
		$this->UrlNavigation = is_null($url) ? new Url($this->config['urlService']) : $url;
44
		$this->cheminImagesBase = $this->config['chemin'];
116 jpm 45
	}
46
 
106 aurelien 47
	public function consulter($ressources, $parametres) {
140 jpm 48
		//$tpsDebut = microtime(true);
116 jpm 49
		$this->parametres = $parametres;
50
		$this->ressources = $ressources;
51
 
52
		$this->definirValeurParDefautDesParametres();
53
		$this->verifierParametres();
54
		$this->analyserMasqueNn();
55
 
56
		$resultat = new ResultatService();
138 jpm 57
		if ($this->parametres['retour'] == self::MIME_JPEG) {
58
			$id_image_a_renvoyer = $this->obtenirIdImageAuHasard();
59
			$resultat->corps = $this->recupererImageBinaire($id_image_a_renvoyer);
60
		} else if ($this->parametres['retour'] == self::MIME_JSON) {
61
			$this->chargerListeImages();
62
			$this->chargerNbreImagesTotal();
63
			$resultat->corps = $infos = $this->formaterListeImages();
140 jpm 64
			//$tpsFin = microtime(true);
65
			//$resultat->corps['entete']['execution.tps'] = $tpsFin - $tpsDebut;
138 jpm 66
		}
67
		$resultat->mime = $this->parametres['retour'];
68
 
116 jpm 69
		return $resultat;
106 aurelien 70
	}
116 jpm 71
 
72
	private function definirValeurParDefautDesParametres() {
73
		if (isset($this->parametres['retour']) == false) {
138 jpm 74
			$this->parametres['retour'] = self::MIME_JSON;
106 aurelien 75
		}
116 jpm 76
		if (isset($this->parametres['retour.format']) == false) {
77
			$this->parametres['retour.format'] = 'M';
106 aurelien 78
		}
138 jpm 79
		if (isset($this->parametres['navigation.depart']) == false) {
80
			$this->parametres['navigation.depart'] = 0;
81
		}
82
		if (isset($this->parametres['navigation.limite']) == false) {
83
			$this->parametres['navigation.limite'] = 100;
84
		}
106 aurelien 85
	}
116 jpm 86
 
87
	private function verifierParametres() {
88
		$erreurs = array();
89
 
90
		if (isset($this->parametres['masque.nn']) == false) {
91
			$erreurs[] = "Le paramètre masque.nn est obligatoire.";
106 aurelien 92
		} else {
116 jpm 93
			if ($this->verifierMasqueNnAutoriseActuellement() == false) {
138 jpm 94
				$erreurs[] = "Le paramètre masque.nn peut contenir une seule valeur numérique pour l'instant pour le format de retour image/jpeg.";
116 jpm 95
			} else if ($this->verifierValeurParametreMasqueNn() == false) {
96
				$erreurs[] = "Le paramètre masque.nn est mal formé.";
106 aurelien 97
			}
98
		}
116 jpm 99
		if (isset($this->parametres['retour']) == false) {
100
			$erreurs[] = "Le paramètre type de retour 'retour' est obligatoire.";
106 aurelien 101
		}
116 jpm 102
		if ($this->verifierValeurParametreRetour() == false) {
103
			$erreurs[] = "Le type de retour '{$this->parametres['retour']}' n'est pas supporté";
106 aurelien 104
		}
116 jpm 105
		if (isset($this->parametres['retour.format']) == false) {
106
			$erreurs[] = "Le paramètre de format de retour 'retour.format' est obligatoire.";
106 aurelien 107
		}
116 jpm 108
		if ($this->verifierValeurParametreFormat() == false) {
109
			$erreurs[] = "Le type de format '{$this->parametres['retour.format']}' n'est pas supporté";
110
		}
138 jpm 111
		if ($this->verifierValeurParametreNavigationDepart() == false) {
112
			$erreurs[] = "Le paramètre 'navigation.depart' doit possèder un valeur numérique.";
113
		}
114
		if ($this->verifierValeurParametreNavigationLimite() == false) {
115
			$erreurs[] = "Le paramètre 'navigation.limite' doit possèder un valeur numérique supérieure à 0.";
116
		}
116 jpm 117
 
118
		if (count($erreurs) > 0) {
119
			$message = implode('<br />', $erreurs);
120
			$code = RestServeur::HTTP_CODE_MAUVAISE_REQUETE;
121
			throw new Exception($message, $code);
122
		}
106 aurelien 123
	}
116 jpm 124
 
138 jpm 125
	private function verifierMasqueNnAutoriseActuellement() {
126
		$ok = true;
127
		$masque = $this->parametres['masque.nn'];
128
		$retour = $this->parametres['retour'];
129
		if ($retour == self::MIME_JPEG) {
130
			$ok = is_numeric($masque) ? true : false;
131
		} else if ($retour == self::MIME_JSON) {
132
			$listeNn = explode(',', $masque);
133
			if ($listeNn == false || count($listeNn) == 0) {
134
				$ok = false;
135
			} else {
136
				foreach ($listeNn as $nn) {
137
					if (is_numeric($nn) == false) {
138
						$ok = false;
139
						break;
140
					}
141
				}
142
			}
143
		}
144
		return $ok;
145
	}
146
 
147
	private function verifierValeurParametreMasqueNn() {
148
		$nn = $this->parametres['masque.nn'];
149
		$projetPattern = '(?:(?:[A-Z0-9]+:)?(?:[0-9]+,)*[0-9]+)';
150
		$patternComplet = "/$projetPattern(?:;$projetPattern)*/i";
151
		$ok = preg_match($patternComplet, $nn) ? true : false;
152
		return $ok;
153
	}
154
 
116 jpm 155
	private function verifierValeurParametreRetour() {
156
		return in_array($this->parametres['retour'], $this->formats_supportes);
106 aurelien 157
	}
116 jpm 158
 
159
	private function verifierValeurParametreFormat() {
118 jpm 160
		$formats = Outils::recupererTableauConfig('Images.formats');
116 jpm 161
		$ok = array_key_exists($this->parametres['retour.format'], $formats);
162
		return $ok;
106 aurelien 163
	}
116 jpm 164
 
138 jpm 165
	private function verifierValeurParametreNavigationDepart() {
166
		$depart = $this->parametres['navigation.depart'];
167
		$ok = is_numeric($depart) ? true : false;
116 jpm 168
		return $ok;
106 aurelien 169
	}
116 jpm 170
 
138 jpm 171
	private function verifierValeurParametreNavigationLimite() {
172
		$limite = $this->parametres['navigation.limite'];
173
		$ok = (is_numeric($limite) && $limite != 0) ? true : false;
116 jpm 174
		return $ok;
106 aurelien 175
	}
116 jpm 176
 
177
	private function analyserMasqueNn() {
178
		$nn = $this->parametres['masque.nn'];
140 jpm 179
		if (is_int($nn)) {
180
			$this->ref_tax_demande[self::CODE_REFTAX_DEFAUT] = $nn;
106 aurelien 181
		} else {
116 jpm 182
			// ceci contient potentiellement des formes ref_tax1:nn1,nn2;ref_tax2:nn3,nn4
183
			$projetsListeEtNumNoms = explode(';', $nn);
184
			if (count($projetsListeEtNumNoms) > 0) {
185
				foreach ($projetsListeEtNumNoms as $projetEtNumNoms) {
140 jpm 186
					$projetEtNumNoms = (strpos($projetEtNumNoms, ':')) ? $projetEtNumNoms : self::CODE_REFTAX_DEFAUT.':'.$projetEtNumNoms;
116 jpm 187
					list($projet, $numNoms) = explode(':', $projetEtNumNoms);
188
					$this->ref_tax_demande[$projet] = explode(',', $numNoms);
106 aurelien 189
				}
190
			}
191
		}
192
	}
116 jpm 193
 
138 jpm 194
	private function obtenirIdImageAuHasard() {
195
		$refTax = self::CODE_REFTAX_DEFAUT;
196
		$numNom = $this->Bdd->proteger($this->ref_tax_demande[$refTax]);
116 jpm 197
 
106 aurelien 198
		//TODO: modifier la requete lors du passage à la nouvelle base de données pour faire quelque chose
199
		// du numéro nomenclatural + modifier les champs appelés pour le nouveau format
126 jpm 200
		$requete = 	'SELECT  coi.coi_ce_image AS id_image '.
116 jpm 201
			'FROM cel_obs_images AS coi '.
126 jpm 202
			'	LEFT JOIN cel_inventory AS ci '.
203
					'ON (coi.coi_ce_observation = ci.ordre AND coi.coi_ce_utilisateur = ci.identifiant) '.
116 jpm 204
			'WHERE ci.transmission = 1 '.
126 jpm 205
			"	AND ci.num_nom_ret IN ($numNom) ";
116 jpm 206
 
207
		$resultat = $this->Bdd->recupererTous($requete);
208
 
209
		if (!is_array($resultat) || count($resultat) <= 0) {
126 jpm 210
			$message = "Aucune image ne correspond au numéro numenclatural $refTax:$numNom";
116 jpm 211
			$code = RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE;
212
			throw new Exception($message, $code);
106 aurelien 213
		}
116 jpm 214
 
215
		$id_image_hasard = $resultat[array_rand($resultat)]['id_image'];
106 aurelien 216
		return $id_image_hasard;
217
	}
116 jpm 218
 
219
	private function recupererImageBinaire($id_image) {
220
		$image = '';
221
		$chemin = $this->obtenirCheminImage($id_image);
118 jpm 222
		$image = file_get_contents($chemin);
223
		if ($image === false) {
116 jpm 224
			$message = "L'image demandée est introuvable sur le serveur : $chemin";
225
			$code = RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE;
226
			throw new Exception($message, $code);
106 aurelien 227
		}
116 jpm 228
		return $image;
106 aurelien 229
	}
116 jpm 230
 
127 jpm 231
	private function obtenirCheminImage($idImage) {
116 jpm 232
		$nom = $this->convertirIdImageVersNomFichier($idImage);
233
		$dossier = $this->convertirIdImageVersChemin($idImage);
106 aurelien 234
		return $dossier.'/'.$nom;
235
	}
116 jpm 236
 
127 jpm 237
	private function convertirIdImageVersNomFichier($idImage) {
116 jpm 238
		$codeImage = $this->construireCodeImage($idImage);
239
		$nom_fichier = $codeImage.'.jpg';
106 aurelien 240
		return $nom_fichier;
241
	}
116 jpm 242
 
243
	private function convertirIdImageVersChemin($idImage) {
244
		$codeImage = $this->construireCodeImage($idImage);
245
		list($dossierNiveau1, $dossierNiveau2, $idFichier, $format) = explode('_', $codeImage);
140 jpm 246
		$chemin_sur_serveur = $this->cheminImagesBase.'/'.$dossierNiveau1.'/'.$dossierNiveau2.'/'.$format;
116 jpm 247
		return $chemin_sur_serveur;
106 aurelien 248
	}
116 jpm 249
 
250
	private function construireCodeImage($idImage) {
251
		$codeImage = sprintf('%09s', $idImage);
252
		$codeImage = wordwrap($codeImage, 3, '_', true);
253
		$format = $this->parametres['retour.format'];
254
		$codeImage .= '_'.$format;
255
		return $codeImage;
106 aurelien 256
	}
138 jpm 257
 
258
	private function chargerListeImages() {
259
		$refTax = self::CODE_REFTAX_DEFAUT;
260
		$numNomListe = implode(',', $this->ref_tax_demande[$refTax]);
261
		$depart = $this->parametres['navigation.depart'];
262
		$limite = $this->parametres['navigation.limite'];
263
 
264
		//TODO: modifier la requete lors du passage à la nouvelle base de données pour faire quelque chose
265
		// du numéro nomenclatural + modifier les champs appelés pour le nouveau format
266
		$requete = 	'SELECT SQL_CALC_FOUND_ROWS '.
267
			' ci.ci_id_image AS id_img, co.id AS id_obs, '.
268
			' identifiant AS utilisateur_courriel, '.
269
			' nom_sel, num_nom_sel, '.
270
			' location, id_location, lieudit, station, milieu, '.
271
		    ' ci.ci_meta_date AS date '.
272
			'FROM cel_images AS ci'.
273
			'	LEFT JOIN cel_obs_images AS coi  '.
274
			'		ON (coi.coi_ce_image = ci.ci_id_image) '.
275
			'	LEFT JOIN cel_inventory AS co '.
276
			'		ON (coi.coi_ce_observation = co.ordre AND coi.coi_ce_utilisateur = co.identifiant) '.
277
			'WHERE co.transmission = 1 '.
278
			"	AND co.num_nom_ret IN ($numNomListe) ".
279
			'GROUP BY id_img '.
280
			"LIMIT $depart,$limite ";
281
 
282
		$this->infosImages = $this->Bdd->recupererTous($requete);
283
	}
284
 
285
	private function chargerNbreImagesTotal() {
286
		$requete = 'SELECT FOUND_ROWS() AS nbre ';
287
		$resultats = $this->Bdd->recuperer($requete);
288
		$this->nbreImages = (int) $resultats['nbre'];
289
	}
290
 
291
	private function formaterListeImages() {
292
		$entete = $this->construireEntete();
293
		$resultats = $this->construireResultats();
294
 
295
		$resultat = array('entete' => $entete, 'resultats' => $resultats);
296
		return $resultat;
297
	}
298
 
299
	private function construireEntete() {
300
		$entete = array('masque' => '', 'depart' => 0, 'limite' => 100, 'total' => 0);
301
 
302
		$entete['masque'] = $this->recupererMasque();
303
		$entete['depart'] = (int) $this->parametres['navigation.depart'];
304
		$entete['limite'] = (int) $this->parametres['navigation.limite'];
305
		$entete['total'] = $this->nbreImages;
306
		if ($hrefPrecedent = $this->recupererHrefPrecedent()) {
307
			$entete['href.precedent'] = $hrefPrecedent;
308
		}
309
		if ($hrefSuivant = $this->recupererHrefSuivant()) {
310
			$entete['href.suivant'] = $hrefSuivant;
311
		}
312
		return $entete;
313
	}
314
 
315
	private function recupererMasque() {
316
		$masqueEntete = '';
317
		if ($masqueNn = $this->parametres['masque.nn']) {
318
			$masqueEntete = "nn=$masqueNn";
319
		}
320
		return $masqueEntete;
321
	}
322
 
323
	private function recupererHrefPrecedent() {
324
		$departActuel = $this->parametres['navigation.depart'];
325
		$limite = $this->parametres['navigation.limite'];
326
		$departPrecedent = $departActuel - $limite;
327
		$url = null;
328
		if ($departPrecedent >= 0) {
329
			$url = $this->obtenirUrlNavigation($departPrecedent, $limite);
330
		}
331
		return $url;
332
	}
333
 
334
	private function recupererHrefSuivant() {
335
		$departActuel = $this->parametres['navigation.depart'];
336
		$limite = $this->parametres['navigation.limite'];
337
		$departSuivant = $departActuel + $limite;
338
		$url = null;
339
		if ($departSuivant < $this->nbreImages) {
340
			$url = $this->obtenirUrlNavigation($departSuivant, $limite);
341
		}
342
		return $url;
343
	}
344
 
345
	private function obtenirUrlNavigation($depart, $limite) {
346
		$parametres = array(
347
			'navigation.depart' => $depart,
348
			'navigation.limite' => $limite);
349
		if (isset($this->parametres['masque.nn'])) {
350
			$parametres['masque.nn'] = $this->parametres['masque.nn'];
351
		}
140 jpm 352
		$this->UrlNavigation->setRequete($parametres);
353
		$url = $this->UrlNavigation->getURL();
138 jpm 354
		return $url;
355
	}
356
 
357
	private function construireResultats() {
358
		$resultats = array();
359
		$this->extraireIntitulesAuteurs();
360
		foreach ($this->infosImages as $img) {
361
			$id = $img['id_img'];
362
 
363
			$info = array();
364
			$info['date'] = $img['date'];
365
			$info['mime'] = self::MIME_JPEG;
366
			$info['auteur'] = $this->formaterAuteur($img);
367
			$info['binaire.href'] = $this->formaterUrlImage($id);
368
			$info['determination'] = $this->formaterDetermination($img);
369
			$info['determination.nom_sci'] = $img['nom_sel'];
370
			$info['determination.nom_sci.code'] = $this->formaterNomSciCode($img);
371
			$info['station'] = $this->formaterStation($img);
372
 
373
			if (!isset($resultats[$id])) {
374
				$resultats[$id] = $info;
375
			} else {
376
				throw new Exception("Double : $id");
377
			}
378
		}
379
		return $resultats;
380
	}
381
 
382
	private function extraireIntitulesAuteurs() {
383
		$courriels = array();
384
		foreach ($this->infosImages as $img) {
385
			$courriels[] = $img['utilisateur_courriel'];
386
		}
387
		$utilisateurs = new Utilisateurs($courriels);
388
		$this->intitulesAuteurs = $utilisateurs->getIntitules();
389
	}
390
 
391
	private function formaterUrlImage($infos) {
392
		$format = self::TAILLE_IMG_DEFAUT;
393
		$id = sprintf('%09s', $infos['id_img']).$format;
394
		$url = sprintf(self::TPL_URL_IMG, $id);
395
		return $url;
396
	}
397
 
398
	private function formaterDetermination($infos) {
399
		return $infos['nom_sel'].'[Dét. : '.$this->intitulesAuteurs[$infos['utilisateur_courriel']].']';
400
	}
401
 
402
	private function formaterNomSciCode($infos) {
403
		return self::CODE_REFTAX_DEFAUT.'.'.$infos['num_nom_sel'];
404
	}
405
 
406
	private function formaterStation($infos) {
407
		$station = array();
408
		if ($commune = $this->formaterCommune($infos)) {
409
			$station[] = $commune;
410
		}
411
		if ($this->avoirContenu($infos['lieudit'])) {
412
			$station[] = $infos['lieudit'];
413
		}
414
		if ($this->avoirContenu($infos['station'])) {
415
			$station[] = $infos['station'];
416
		}
417
 
418
		if ($this->avoirContenu($infos['milieu'])) {
419
			$station[] = $infos['milieu'];
420
		}
421
		return implode(' > ', $station);
422
	}
423
 
424
	private function formaterCommune($infos) {
425
		$commune = array();
426
		if ($this->avoirContenu($infos['location'])) {
427
			$commune[] = $infos['location'];
428
		}
429
		if ($this->avoirContenu($infos['id_location'])) {
430
			$commune[] = '('.$infos['id_location'].')';
431
		}
432
		return implode(' ', $commune);
433
	}
434
 
435
	private function formaterAuteur($infos) {
436
		$auteur = $this->intitulesAuteurs[$infos['utilisateur_courriel']];
437
		return $auteur;
438
	}
439
 
440
	private function avoirContenu($info) {
441
		$vide = true;
442
		if ($info == null || $info == '' || $info == '000null') {
443
			$vide = false;
444
		}
445
		return $vide;
446
	}
106 aurelien 447
}
448
?>