Subversion Repositories eFlore/Projets.eflore-projets

Rev

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