Subversion Repositories eFlore/Projets.eflore-projets

Rev

Rev 143 | Rev 330 | 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);
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 {
162 jpm 93 
			if ($this->verifierMasqueNnAutorisePourRetourJPEG() == 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 
 
162 jpm 125 
	private function verifierMasqueNnAutorisePourRetourJPEG() {
138 jpm 126 
		$ok = true;
127 
		$masque = $this->parametres['masque.nn'];
128 
		$retour = $this->parametres['retour'];
162 jpm 129 
 
138 jpm 130 
		if ($retour == self::MIME_JPEG) {
131 
			$ok = is_numeric($masque) ? true : false;
132 
		}
133 
		return $ok;
134 
	}
135 
 
136 
	private function verifierValeurParametreMasqueNn() {
137 
		$nn = $this->parametres['masque.nn'];
138 
		$projetPattern = '(?:(?:[A-Z0-9]+:)?(?:[0-9]+,)*[0-9]+)';
162 jpm 139 
		$patternComplet = "/^$projetPattern(?:;$projetPattern)*$/i";
138 jpm 140 
		$ok = preg_match($patternComplet, $nn) ? true : false;
141 
		return $ok;
142 
	}
143 
 
116 jpm 144 
	private function verifierValeurParametreRetour() {
145 
		return in_array($this->parametres['retour'], $this->formats_supportes);
106 aurelien 146 
	}
116 jpm 147 
 
148 
	private function verifierValeurParametreFormat() {
118 jpm 149 
		$formats = Outils::recupererTableauConfig('Images.formats');
116 jpm 150 
		$ok = array_key_exists($this->parametres['retour.format'], $formats);
151 
		return $ok;
106 aurelien 152 
	}
116 jpm 153 
 
138 jpm 154 
	private function verifierValeurParametreNavigationDepart() {
155 
		$depart = $this->parametres['navigation.depart'];
156 
		$ok = is_numeric($depart) ? true : false;
116 jpm 157 
		return $ok;
106 aurelien 158 
	}
116 jpm 159 
 
138 jpm 160 
	private function verifierValeurParametreNavigationLimite() {
161 
		$limite = $this->parametres['navigation.limite'];
162 
		$ok = (is_numeric($limite) && $limite != 0) ? true : false;
116 jpm 163 
		return $ok;
106 aurelien 164 
	}
116 jpm 165 
 
166 
	private function analyserMasqueNn() {
167 
		$nn = $this->parametres['masque.nn'];
142 jpm 168 
		if (preg_match('/^[0-9]+$/', $nn)) {
169 
			$this->ref_tax_demande[self::CODE_REFTAX_DEFAUT][] = $nn;
106 aurelien 170 
		} else {
116 jpm 171 
			// ceci contient potentiellement des formes ref_tax1:nn1,nn2;ref_tax2:nn3,nn4
172 
			$projetsListeEtNumNoms = explode(';', $nn);
173 
			if (count($projetsListeEtNumNoms) > 0) {
174 
				foreach ($projetsListeEtNumNoms as $projetEtNumNoms) {
140 jpm 175 
					$projetEtNumNoms = (strpos($projetEtNumNoms, ':')) ? $projetEtNumNoms : self::CODE_REFTAX_DEFAUT.':'.$projetEtNumNoms;
116 jpm 176 
					list($projet, $numNoms) = explode(':', $projetEtNumNoms);
177 
					$this->ref_tax_demande[$projet] = explode(',', $numNoms);
106 aurelien 178 
				}
179 
			}
180 
		}
181 
	}
116 jpm 182 
 
138 jpm 183 
	private function obtenirIdImageAuHasard() {
184 
		$refTax = self::CODE_REFTAX_DEFAUT;
142 jpm 185 
		$numNom = $this->Bdd->proteger($this->ref_tax_demande[$refTax][0]);
116 jpm 186 
 
106 aurelien 187 
		//TODO: modifier la requete lors du passage à la nouvelle base de données pour faire quelque chose
188 
		// du numéro nomenclatural + modifier les champs appelés pour le nouveau format
126 jpm 189 
		$requete = 	'SELECT  coi.coi_ce_image AS id_image '.
116 jpm 190 
			'FROM cel_obs_images AS coi '.
126 jpm 191 
			'	LEFT JOIN cel_inventory AS ci '.
192 
					'ON (coi.coi_ce_observation = ci.ordre AND coi.coi_ce_utilisateur = ci.identifiant) '.
116 jpm 193 
			'WHERE ci.transmission = 1 '.
126 jpm 194 
			"	AND ci.num_nom_ret IN ($numNom) ";
116 jpm 195 
 
196 
		$resultat = $this->Bdd->recupererTous($requete);
197 
 
198 
		if (!is_array($resultat) || count($resultat) <= 0) {
126 jpm 199 
			$message = "Aucune image ne correspond au numéro numenclatural $refTax:$numNom";
116 jpm 200 
			$code = RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE;
201 
			throw new Exception($message, $code);
106 aurelien 202 
		}
116 jpm 203 
 
204 
		$id_image_hasard = $resultat[array_rand($resultat)]['id_image'];
106 aurelien 205 
		return $id_image_hasard;
206 
	}
116 jpm 207 
 
208 
	private function recupererImageBinaire($id_image) {
209 
		$image = '';
210 
		$chemin = $this->obtenirCheminImage($id_image);
118 jpm 211 
		$image = file_get_contents($chemin);
212 
		if ($image === false) {
116 jpm 213 
			$message = "L'image demandée est introuvable sur le serveur : $chemin";
214 
			$code = RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE;
215 
			throw new Exception($message, $code);
106 aurelien 216 
		}
116 jpm 217 
		return $image;
106 aurelien 218 
	}
116 jpm 219 
 
127 jpm 220 
	private function obtenirCheminImage($idImage) {
116 jpm 221 
		$nom = $this->convertirIdImageVersNomFichier($idImage);
222 
		$dossier = $this->convertirIdImageVersChemin($idImage);
106 aurelien 223 
		return $dossier.'/'.$nom;
224 
	}
116 jpm 225 
 
127 jpm 226 
	private function convertirIdImageVersNomFichier($idImage) {
116 jpm 227 
		$codeImage = $this->construireCodeImage($idImage);
228 
		$nom_fichier = $codeImage.'.jpg';
106 aurelien 229 
		return $nom_fichier;
230 
	}
116 jpm 231 
 
232 
	private function convertirIdImageVersChemin($idImage) {
233 
		$codeImage = $this->construireCodeImage($idImage);
234 
		list($dossierNiveau1, $dossierNiveau2, $idFichier, $format) = explode('_', $codeImage);
140 jpm 235 
		$chemin_sur_serveur = $this->cheminImagesBase.'/'.$dossierNiveau1.'/'.$dossierNiveau2.'/'.$format;
116 jpm 236 
		return $chemin_sur_serveur;
106 aurelien 237 
	}
116 jpm 238 
 
239 
	private function construireCodeImage($idImage) {
240 
		$codeImage = sprintf('%09s', $idImage);
241 
		$codeImage = wordwrap($codeImage, 3, '_', true);
242 
		$format = $this->parametres['retour.format'];
243 
		$codeImage .= '_'.$format;
244 
		return $codeImage;
106 aurelien 245 
	}
138 jpm 246 
 
247 
	private function chargerListeImages() {
248 
		$refTax = self::CODE_REFTAX_DEFAUT;
249 
		$numNomListe = implode(',', $this->ref_tax_demande[$refTax]);
250 
		$depart = $this->parametres['navigation.depart'];
251 
		$limite = $this->parametres['navigation.limite'];
252 
 
253 
		//TODO: modifier la requete lors du passage à la nouvelle base de données pour faire quelque chose
254 
		// du numéro nomenclatural + modifier les champs appelés pour le nouveau format
255 
		$requete = 	'SELECT SQL_CALC_FOUND_ROWS '.
256 
			' ci.ci_id_image AS id_img, co.id AS id_obs, '.
257 
			' identifiant AS utilisateur_courriel, '.
258 
			' nom_sel, num_nom_sel, '.
259 
			' location, id_location, lieudit, station, milieu, '.
260 
		    ' ci.ci_meta_date AS date '.
261 
			'FROM cel_images AS ci'.
262 
			'	LEFT JOIN cel_obs_images AS coi  '.
263 
			'		ON (coi.coi_ce_image = ci.ci_id_image) '.
264 
			'	LEFT JOIN cel_inventory AS co '.
265 
			'		ON (coi.coi_ce_observation = co.ordre AND coi.coi_ce_utilisateur = co.identifiant) '.
266 
			'WHERE co.transmission = 1 '.
267 
			"	AND co.num_nom_ret IN ($numNomListe) ".
268 
			'GROUP BY id_img '.
269 
			"LIMIT $depart,$limite ";
270 
 
271 
		$this->infosImages = $this->Bdd->recupererTous($requete);
272 
	}
273 
 
274 
	private function chargerNbreImagesTotal() {
275 
		$requete = 'SELECT FOUND_ROWS() AS nbre ';
276 
		$resultats = $this->Bdd->recuperer($requete);
277 
		$this->nbreImages = (int) $resultats['nbre'];
278 
	}
279 
 
280 
	private function formaterListeImages() {
281 
		$entete = $this->construireEntete();
282 
		$resultats = $this->construireResultats();
283 
 
284 
		$resultat = array('entete' => $entete, 'resultats' => $resultats);
285 
		return $resultat;
286 
	}
287 
 
288 
	private function construireEntete() {
289 
		$entete = array('masque' => '', 'depart' => 0, 'limite' => 100, 'total' => 0);
290 
 
291 
		$entete['masque'] = $this->recupererMasque();
292 
		$entete['depart'] = (int) $this->parametres['navigation.depart'];
293 
		$entete['limite'] = (int) $this->parametres['navigation.limite'];
294 
		$entete['total'] = $this->nbreImages;
295 
		if ($hrefPrecedent = $this->recupererHrefPrecedent()) {
296 
			$entete['href.precedent'] = $hrefPrecedent;
297 
		}
298 
		if ($hrefSuivant = $this->recupererHrefSuivant()) {
299 
			$entete['href.suivant'] = $hrefSuivant;
300 
		}
301 
		return $entete;
302 
	}
303 
 
304 
	private function recupererMasque() {
305 
		$masqueEntete = '';
306 
		if ($masqueNn = $this->parametres['masque.nn']) {
307 
			$masqueEntete = "nn=$masqueNn";
308 
		}
309 
		return $masqueEntete;
310 
	}
311 
 
312 
	private function recupererHrefPrecedent() {
313 
		$departActuel = $this->parametres['navigation.depart'];
314 
		$limite = $this->parametres['navigation.limite'];
315 
		$departPrecedent = $departActuel - $limite;
316 
		$url = null;
317 
		if ($departPrecedent >= 0) {
318 
			$url = $this->obtenirUrlNavigation($departPrecedent, $limite);
319 
		}
320 
		return $url;
321 
	}
322 
 
323 
	private function recupererHrefSuivant() {
324 
		$departActuel = $this->parametres['navigation.depart'];
325 
		$limite = $this->parametres['navigation.limite'];
326 
		$departSuivant = $departActuel + $limite;
327 
		$url = null;
328 
		if ($departSuivant < $this->nbreImages) {
329 
			$url = $this->obtenirUrlNavigation($departSuivant, $limite);
330 
		}
331 
		return $url;
332 
	}
333 
 
334 
	private function obtenirUrlNavigation($depart, $limite) {
335 
		$parametres = array(
336 
			'navigation.depart' => $depart,
337 
			'navigation.limite' => $limite);
338 
		if (isset($this->parametres['masque.nn'])) {
339 
			$parametres['masque.nn'] = $this->parametres['masque.nn'];
340 
		}
140 jpm 341 
		$this->UrlNavigation->setRequete($parametres);
342 
		$url = $this->UrlNavigation->getURL();
138 jpm 343 
		return $url;
344 
	}
345 
 
346 
	private function construireResultats() {
347 
		$resultats = array();
348 
		$this->extraireIntitulesAuteurs();
349 
		foreach ($this->infosImages as $img) {
350 
			$info = array();
351 
			$info['date'] = $img['date'];
352 
			$info['mime'] = self::MIME_JPEG;
353 
			$info['auteur'] = $this->formaterAuteur($img);
142 jpm 354 
			$info['binaire.href'] = $this->formaterUrlImage($img);
138 jpm 355 
			$info['determination'] = $this->formaterDetermination($img);
356 
			$info['determination.nom_sci'] = $img['nom_sel'];
357 
			$info['determination.nom_sci.code'] = $this->formaterNomSciCode($img);
358 
			$info['station'] = $this->formaterStation($img);
359 
 
142 jpm 360 
			$id = $img['id_img'];
138 jpm 361 
			if (!isset($resultats[$id])) {
362 
				$resultats[$id] = $info;
363 
			} else {
364 
				throw new Exception("Double : $id");
365 
			}
366 
		}
367 
		return $resultats;
368 
	}
369 
 
370 
	private function extraireIntitulesAuteurs() {
371 
		$courriels = array();
372 
		foreach ($this->infosImages as $img) {
373 
			$courriels[] = $img['utilisateur_courriel'];
374 
		}
375 
		$utilisateurs = new Utilisateurs($courriels);
376 
		$this->intitulesAuteurs = $utilisateurs->getIntitules();
377 
	}
378 
 
379 
	private function formaterUrlImage($infos) {
143 jpm 380 
		$format = $this->parametres['retour.format'];
138 jpm 381 
		$id = sprintf('%09s', $infos['id_img']).$format;
382 
		$url = sprintf(self::TPL_URL_IMG, $id);
383 
		return $url;
384 
	}
385 
 
386 
	private function formaterDetermination($infos) {
387 
		return $infos['nom_sel'].'[Dét. : '.$this->intitulesAuteurs[$infos['utilisateur_courriel']].']';
388 
	}
389 
 
390 
	private function formaterNomSciCode($infos) {
391 
		return self::CODE_REFTAX_DEFAUT.'.'.$infos['num_nom_sel'];
392 
	}
393 
 
394 
	private function formaterStation($infos) {
395 
		$station = array();
396 
		if ($commune = $this->formaterCommune($infos)) {
397 
			$station[] = $commune;
398 
		}
399 
		if ($this->avoirContenu($infos['lieudit'])) {
400 
			$station[] = $infos['lieudit'];
401 
		}
402 
		if ($this->avoirContenu($infos['station'])) {
403 
			$station[] = $infos['station'];
404 
		}
405 
 
406 
		if ($this->avoirContenu($infos['milieu'])) {
407 
			$station[] = $infos['milieu'];
408 
		}
409 
		return implode(' > ', $station);
410 
	}
411 
 
412 
	private function formaterCommune($infos) {
413 
		$commune = array();
414 
		if ($this->avoirContenu($infos['location'])) {
415 
			$commune[] = $infos['location'];
416 
		}
417 
		if ($this->avoirContenu($infos['id_location'])) {
418 
			$commune[] = '('.$infos['id_location'].')';
419 
		}
420 
		return implode(' ', $commune);
421 
	}
422 
 
423 
	private function formaterAuteur($infos) {
424 
		$auteur = $this->intitulesAuteurs[$infos['utilisateur_courriel']];
425 
		return $auteur;
426 
	}
427 
 
428 
	private function avoirContenu($info) {
429 
		$vide = true;
430 
		if ($info == null || $info == '' || $info == '000null') {
431 
			$vide = false;
432 
		}
433 
		return $vide;
434 
	}
106 aurelien 435 
}
436 
?>