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