WebSVN – eFlore/Applications.del – Diff – /trunk/services/modules/0.1/images/ListeImages.php


<?php
// declare(encoding='UTF-8');
/**
	* Le web service image récupère toutes les données de la table del_obs_images
 * pour retourner une liste d'images associée à une observation
 *
 * @category	php 5.2
 * @package	del
 * @subpackage images
 * @author		Jean-Pascal MILCENT <jpm@tela-botanica.org>
 * @copyright	Copyright (c) 2012, Tela Botanica (accueil@tela-botanica.org)
 * @license	http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt Licence CECILL
 * @license	http://www.gnu.org/licenses/gpl.html Licence GNU-GPL
 * @version	$Id: Bdd.php 403 2012-02-22 14:35:20Z gduche $
 * @see http://www.tela-botanica.org/wikini/eflore/wakka.php?wiki=ApiIdentiplante01Images
 */
 
class ListeImages {
	
	private $imageIds = array();
	private $conteneur;
	private $navigation;
	private $masque;
	private $gestionBdd;
	private $bdd;
	private $parametres = array();
	private $ressources = array();
	
	public function __construct(Conteneur $conteneur = null) {
		$this->conteneur = $conteneur == null ? new Conteneur() : $conteneur;
		$this->conteneur->chargerConfiguration('config_departements_bruts.ini');
		$this->conteneur->chargerConfiguration('config_mapping_votes.ini');
		$this->conteneur->chargerConfiguration('config_images.ini');
		$this->navigation = $conteneur->getNavigation();
		$this->masque = $conteneur->getMasque();
		$this->gestionBdd = $conteneur->getGestionBdd();
		$this->bdd = $this->gestionBdd->getBdd();	
	}
	
	/**
	 * Méthode principale de la classe.
	 * Lance la récupération des images dans la base et les place dans un objet ResultatService 
	 * pour l'afficher.
	 * @param array $ressources les ressources situées après l'url de base (ex : http://url/ressource1/ressource2)
	 * @param array $parametres les paramètres situés après le ? dans l'url
	 * */
	public function consulter($ressources, $parametres) {
		$this->initialiserRessourcesEtParametres($ressources, $parametres);
		
		// Gestion des configuration du script
		$this->configurer();
		$this->verifierConfiguration();
		
		// Lancement du service
		$liaisons = $this->chargerLiaisons();
		$total = $this->compterImages();
		$this->navigation->setTotal($total);
		$images = $this->chargerImage($liaisons);
		$images = $this->chargerVotes($images);
		
		// Mettre en forme le résultat et l'envoyer pour affichage
		$resultat = new ResultatService();
		$resultat->corps = array('entete' => $this->conteneur->getEntete(), 'resultats' => $images);
		return $resultat;
	}
	
	private function initialiserRessourcesEtParametres($ressources, $parametres) {
		$this->ressources = $ressources;
		$this->parametres = $parametres;
	}
	/*-------------------------------------------------------------------------------
	 							CONFIGURATION DU SERVICE
	 --------------------------------------------------------------------------------*/
	/**
	 * Configuration du service en fonction du fichier de config config_del.ini
	 * */
	public function configurer() {
		$this->mappingFiltre = $this->conteneur->getParametre('mapping_masque');
		$this->mappingObservation = $this->conteneur->getParametre('mapping_observation');
		$this->mappingVotes = $this->conteneur->getParametre('mapping_votes');
	}
	
	/**
	 * Vérifier que le service est bien configuré 
	 * */
	public function verifierConfiguration() {
	
		$erreurs = array();
		$tableauImages = $this->conteneur->getParametre('images');
		if (empty($tableauImages)) {
			$erreurs[] = '- le fichier de configuration ne contient pas le tableau [images] ou celui-ci est vide ;'; 
		} else {
			if ($this->conteneur->getParametre('url_service') == null) {
				$erreurs[] = '- paramètre "url_service" manquant ;';
			}
			
			if ($this->conteneur->getParametre('url_images') == null) {
				$erreurs[] = '- paramètre "url_images" manquant ;';
			}
			
		}
 
		if (empty($this->mappingObservation)) {
			$erreurs[] = '- le fichier de configuration ne contient pas le tableau [mapping_observation] ou celui-ci est vide ;';
		} else {
			$champsMappingObs = array('id_observation', 'date_observation', 'date_transmission', 'famille', 'nom_sel', 'nom_sel_nn', 'nt',
								'ce_zone_geo', 'lieudit', 'station', 'milieu', 'ce_utilisateur', 'nom', 'prenom');
			foreach ($champsMappingObs as $champ) {
				if (!isset($this->mappingObservation[$champ])) {
					$erreurs[] = '- le mapping du champ "'.$champ.'" pour l\'observation est manquant ;';
				}				
			}
		}
		
		if (empty($this->mappingFiltre)) {
			$erreurs[] = '- le fichier de configuration ne contient pas le tableau [mapping_masque] ou celui-ci est vide ;';
		} else {
			$champsMappingFiltre = array('famille', 'ns', 'nn', 'date', 'tag', 'commune');
			foreach ($champsMappingFiltre as $champ) {
				if (!isset($this->mappingFiltre[$champ])) {
					$erreurs[] = '- le mapping du champ "'.$champ.'" pour l\'observation est manquant ;';
				}				
			}
		}
		
		if (!empty($erreurs)) {
			$e = 'Erreur lors de la configuration : '."\n";
			$e .= implode("\n", $erreurs);
			throw new Exception($e, RestServeur::HTTP_CODE_ERREUR);
		}
	}
	
	
	
	/**
	 * Obtenir une chaine de caractère concaténant nom et prénom séparé par une virgule
	 * @param String $auteurId l'identifiant de l'auteur
	 * @return String la chaine de concaténation
	 * */
	private function getChaineNomPrenom($auteurId) {
		$nomPrenom = explode(' ', $auteurId);
		$nomPrenom = $this->proteger($nomPrenom);
		$chaineNomPrenom = implode(', ', $nomPrenom);
		return $chaineNomPrenom;
	}
	
	/**
	* Charger la clause WHERE en fonction des paramètres de masque
	* */
	private function chargerClauseWhere() {
		// TODO: factoriser cette fonction qui est quasiment identique dans liste image et dans liste observation
		// faire une classe mère, une classe utilitaire ?
		$where = array();
		$tableauMasque = $this->masque->getMasque();
		if (!empty($tableauMasque)) {
			foreach($tableauMasque as $idMasque => $valeurMasque) {
				//TODO: scinder ceci en fonctions réutilisables ? 
				// voir si c'est interessant par rapport à la recherche générale	
				$idMasque = str_replace('masque.', '', $idMasque);
				switch ($idMasque) {
					// nom du masque => nom BDD
					case 'auteur' :
						$whereAuteur = ' '.$this->creerFiltreAuteur($this->masque->getMasque('auteur'));
						if($whereAuteur != '') {
							$where[] = $whereAuteur;
						}
						break;
					case 'date' :
						$whereDate = ' '.$this->creerFiltreDate($valeurMasque);
						if($whereDate != '') {
							$where[] = $whereDate;
						}
						break;
					case 'departement' :
						$where[] = ' '.$this->creerFiltreIdZoneGeo($valeurMasque);
						break;
					case 'genre' :
						$where[] = ' '.$this->mappingFiltre['ns'].' LIKE '.$this->proteger($valeurMasque.' %');
						break;
					case 'tag' :
						$where[] = ' '.$this->creerFiltreMotsCles($valeurMasque);
						break;
					case 'ns' :
						$where[] = ' nom_sel LIKE '.$this->proteger($valeurMasque.'%');
						break;	
					case 'commune' :
						$where[] = ' '.$this->mappingFiltre[$idMasque].' LIKE '.$this->proteger(str_replace(array('-',' '), '_', $valeurMasque).'%');
					break;
					case 'masque' :
						$where[] = ' '.$this->creerFiltreMasqueGeneral($valeurMasque);
						break;
					default:
						$where[] = ' '.$this->mappingFiltre[$idMasque].' = '.$this->proteger($valeurMasque);
					break;
				}
			}	
		}
		
		if (!empty($where)) {
			return ' WHERE '.implode('AND', $where);
		} else {
			return;
		}
	}
	
	private function creerFiltreMasqueGeneral($valeurMasque) {
		//TODO: affecter d'aborder les variables, puis les tester pour les 
		// ajouter à la chaine
		$whereAuteur = $this->creerFiltreAuteur($valeurMasque);
		$whereIdZoneGeo = $this->creerFiltreIdZoneGeo($valeurMasque);		
		
		$masqueGeneral = '( '.
                   	(($whereAuteur != '') ? $whereAuteur.' OR ' : '' ).
				   	(($whereIdZoneGeo != '') ? $whereIdZoneGeo.' OR ' : '' ).
					'zone_geo LIKE '.$this->proteger($this->remplacerParJokerCaractere($valeurMasque).'%').' OR '.
					$this->creerFiltreMotsCles($valeurMasque).' OR '.
					'nom_sel LIKE '.$this->proteger($valeurMasque.'%').' OR '.
					'famille LIKE '.$this->proteger($valeurMasque.'%').' OR '.
					'milieu LIKE '.$this->proteger($valeurMasque).' OR '.
					$this->mappingFiltre['ns'].' LIKE '.$this->proteger('%'.$valeurMasque.'% %').' OR '.
					$this->creerFiltreDate($valeurMasque).
					') ';
	
		return $masqueGeneral;
	}
	
	private function creerFiltreAuteur($valeurMasque) {
		$masque = '';
		$auteurId = $valeurMasque;
		if (is_numeric($auteurId)) {
			$masque = ' ce_utilisateur = '.$auteurId;
		} else {
			if (strpos($auteurId, '@') === false) {
				$tableauNomPrenom = explode(' ',$auteurId, 2);
				if(count($tableauNomPrenom) == 2) {
					// on teste potentiellement un nom prenom ou bien un prénom nom
					$masque = '('.
						          	'(nom LIKE '.$this->proteger($tableauNomPrenom[0].'%').' AND '.
								  	'prenom LIKE '.$this->proteger($tableauNomPrenom[1].'%').') OR '.
								 	'(nom LIKE '.$this->proteger($tableauNomPrenom[1].'%').' AND '.
								  	'prenom LIKE '.$this->proteger($tableauNomPrenom[0].'%').')'.
								  ')';
				} else {
					$masque = '(
						            (nom LIKE '.$this->proteger($auteurId.'%').' OR '.
									'prenom LIKE '.$this->proteger($auteurId.'%').')'.
								  ')';
				}
			} else {
				$masque = " courriel LIKE ".$this->proteger($valeurMasque.'%')." ";
			}
		}
		return $masque;
	}
	
	private function remplacerParJokerCaractere($valeurMasque) {
		return str_replace(array('-',' '), '_', $valeurMasque);
	}
	//TODO: déplacer les fonctions ci dessus et dessous dans une classe
	// utilitaire
	function supprimerAccents($str, $charset='utf-8')
	{
		$str = htmlentities($str, ENT_NOQUOTES, $charset);
	
		$str = preg_replace('#&([A-za-z])(?:acute|cedil|circ|grave|orn|ring|slash|th|tilde|uml);#', '\1', $str);
		$str = preg_replace('#&([A-za-z]{2})(?:lig);#', '\1', $str); // pour les ligatures e.g. '&oelig;'
		$str = preg_replace('#&[^;]+;#', '', $str); // supprime les autres caractères
	
		return $str;
	}
	
	private function obtenirIdDepartement($nomDpt) {
		
		$nomDpt = $this->supprimerAccents($nomDpt);
		$nomDpt = strtolower(str_replace(' ','-',$nomDpt));
		
		$idDpt = $this->conteneur->getParametre($nomDpt);
		if($idDpt == null || $idDpt == ' ') {
			$idDpt = ' ';
		}
		return $idDpt;
	}
	
	private function creerFiltreIdZoneGeo($valeurMasque) {
		$masque = '';
		$dept = $valeurMasque;
		if (is_numeric($dept)) {
			$dept = sprintf('%02s', $dept);
			$dept = sprintf("%-'_5s", $dept);
			$masque = " ce_zone_geo LIKE ".$this->proteger('INSEE-C:'.$dept);
		} else {
			$deptId = $this->conteneur->getParametre($dept);
			if ($deptId != null) {
				$masque = " ce_zone_geo LIKE ".$this->proteger('INSEE-C:'.$deptId.'%');
			} else {
				$id = $this->obtenirIdDepartement($valeurMasque);
				$masque = " ce_zone_geo LIKE ".$this->proteger('INSEE-C:'.$id.'%');
			}
		}
		return $masque;
	}
	
	private function creerFiltreDate($valeurMasque) {
		//TODO: définir dans le fichier de config un tableau contenant plusieurs format de date
		// autorisés pour la recherche, qui seraient ajoutés au OR
		$masque = '(';
		$masque .= (is_numeric($valeurMasque)) ? ' YEAR(date_observation) = '.$this->proteger($valeurMasque).' OR ' : '';
		$masque .= " DATE_FORMAT(date_observation, '%d/%m/%Y') = ".$this->proteger($valeurMasque).' '.
		           ')';
		return $masque;
	}
	
	private function creerFiltreMotsCles($valeurMasque) {
		$masque = '(di.mots_cles_texte LIKE '.$this->proteger('%'.$valeurMasque.'%').' OR '.
		                 ' dob.mots_cles_texte LIKE '.$this->proteger('%'.$valeurMasque.'%').') ';  
		return $masque;                                                  			
	}
	
	/*-------------------------------------------------------------------------------
								CHARGEMENT DES IMAGES 
	--------------------------------------------------------------------------------*/
	/**
	* Chargement depuis la bdd de toutes les liaisons entre images et observations
	* */
	private function chargerLiaisons() {
	
		$requeteLiaisons = 'SELECT SQL_CALC_FOUND_ROWS * '.
						   'FROM '.$this->gestionBdd->formaterTable('del_obs_image', 'doi').
						   'INNER JOIN del_image di '.
						   'ON doi.id_image = di.id_image '.
						   'INNER JOIN del_observation dob '.
						   'ON doi.id_observation = dob.id_observation '.
						   'INNER JOIN del_utilisateur du '.
						   'ON du.id_utilisateur = doi.id_utilisateur';
		$requeteLiaisons .= $this->chargerClauseWhere();
		$requeteLiaisons .= ' ORDER BY date_transmission DESC';
		$requeteLiaisons .= $this->gestionBdd->getLimitSql();
 
		return $this->bdd->recupererTous($requeteLiaisons);
	}
	
	/**
	* Compter le nombre total d'images dans la base pour affichage dans entete.
	* */
	private function compterImages() {
		$requete = 'SELECT FOUND_ROWS() AS nbre ';
		$resultats = $this->bdd->recuperer($requete);
		return (int) $resultats['nbre'];
	}
	
	/**
	* Retourner un tableau d'images formaté en fonction des liaisons trouvées
	* @param $liaisons les liaisons de la table del_obs_images
	* */
	private function chargerImage($liaisons) {
	
		$images = array();
		foreach ($liaisons as $liaison) {
			$idImage = $liaison['id_image'];
			
			// On enregistre l'ID de l'image pour n'effectuer qu'une seule requête par la suite
			$this->imageIds[] = $idImage;
			$images[$idImage] = array('id_image' => $idImage, 'date' => $liaison['date_prise_de_vue'], 'binaire.href' => $this->formaterLienImage($idImage),
						'hauteur' => $liaison['hauteur'], 'largeur' => $liaison['largeur'], 'protocoles_votes' => array(), 'observation' => $this->formaterObservation($liaison));
		}
		return $images;
	}
	
	/**
	* Charger les votes pour chaque image
	* */
	private function chargerVotes($images) {
			$requeteVotes = 'SELECT v.*, p.* FROM '.
								$this->gestionBdd->formaterTable('del_image_vote', 'v').
								' INNER JOIN del_image_protocole p '.
									'ON v.ce_protocole = p.id_protocole '.
									$this->chargerClauseWhereVotes();
			$resultatsVotes = $this->bdd->recupererTous($requeteVotes);
			
			
			//TODO : faire une méthode formater vote
			$votes = $this->formaterVotes($resultatsVotes);
	
			foreach ($images as $id => $image) {
				if (isset($votes[$image['id_image']])) {
					$images[$id]['protocoles_votes'] = $votes[$image['id_image']];
				}
			}
		
		return $images;
	}
	
	private function chargerClauseWhereVotes() {
		if (sizeof($this->imageIds) > 0) {
			$chaineImageIds = implode(',', $this->imageIds);
			$where[] = 'v.ce_image  IN ('.$chaineImageIds.')';
		}
		if (isset($this->parametres['protocole'])) {
			$where[] = 'v.ce_protocole = '.$this->proteger($this->parametres['protocole']);
		}
		
		$where = (!empty($where)) ? 'WHERE '.implode(' AND ', $where) : '';
		return $where;
	}
	
	/*-------------------------------------------------------------------------------
								FORMATER ET METTRE EN FORME
	--------------------------------------------------------------------------------*/
	
	/**
	*  Formater une observation depuis une ligne liaison
	*  @param $liaison liaison issue de la recherche
	*  @return $observation l'observation mise en forme
	* */
	private function formaterObservation($liaison) {
		$observation = array();
		
		foreach ($this->mappingObservation as $nomOriginal => $nomFinal) {
			$observation[$nomFinal] = $liaison[$nomOriginal];
		}
 
		return $observation;
	}
	
	/**
	*  Formater une observation depuis une ligne liaison
	*  @param $liaison liaison issue de la recherche
	*  @return $observation l'observation mise en forme
	* */
	private function formaterVotes($votes) {
		$retour = array();
		foreach ($votes as $vote) {
			$retour_vote = array();
			foreach ($vote as $param=>$valeur) {
				if (strpos($this->mappingVotes[$param], 'protocole.') === 0) {
					$retour_protocole[$this->mappingVotes[$param]] = $valeur;
				} else {
					$retour_vote[$this->mappingVotes[$param]] = $valeur;
				}
			}
			if (!isset($retour[$vote['ce_image']][$vote['ce_protocole']])) {
				$retour[$vote['ce_image']][$vote['ce_protocole']] = $retour_protocole;
			}
			$retour[$vote['ce_image']][$vote['ce_protocole']]['votes'][$vote['id_vote']] = $retour_vote;
		}
		
		return $retour;
	}
	
	/**
	 * Formater le lien de l'image en fonction du fichier de config et de l'identifiant de l'image
	 * */
	private function formaterLienImage($idImage) {
		$idImage = sprintf('%09s', $idImage);
		$url = $this->conteneur->getParametre('url_images');
		$urlImage = str_replace('%s', $idImage, $url);
		return $urlImage;
	}
	
	private function proteger($valeur) {
		if (is_array($valeur)) {
			return $this->bdd->protegerTableau($valeur);
		} else {
			return $this->bdd->proteger($valeur);
		}
	}
}
?>

Subversion Repositories eFlore/Applications.del

(root)/trunk/services/modules/0.1/images/ListeImages.php @ 1448 – Rev 791 → 798

Rev 791		Rev 798
1	`<?php`	1	`<?php`
2	`// declare(encoding='UTF-8');`	2	`// declare(encoding='UTF-8');`
3	`/**`	3	`/**`
4	`* Le web service image récupère toutes les données de la table del_obs_images`	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 à une observation`	5	`* pour retourner une liste d'images associée à une observation`
6	`*`	6	`*`
7	`* @category php 5.2`	7	`* @category php 5.2`
8	`* @package del`	8	`* @package del`
9	`* @subpackage images`	9	`* @subpackage images`
10	`* @author Jean-Pascal MILCENT <jpm@tela-botanica.org>`	10	`* @author Jean-Pascal MILCENT <jpm@tela-botanica.org>`
11	`* @copyright Copyright (c) 2012, Tela Botanica (accueil@tela-botanica.org)`	11	`* @copyright Copyright (c) 2012, Tela Botanica (accueil@tela-botanica.org)`
12	`* @license http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt Licence CECILL`	12	`* @license http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt Licence CECILL`
13	`* @license http://www.gnu.org/licenses/gpl.html Licence GNU-GPL`	13	`* @license http://www.gnu.org/licenses/gpl.html Licence GNU-GPL`
14	`* @version $Id: Bdd.php 403 2012-02-22 14:35:20Z gduche $`	14	`* @version $Id: Bdd.php 403 2012-02-22 14:35:20Z gduche $`
15	`* @see http://www.tela-botanica.org/wikini/eflore/wakka.php?wiki=ApiIdentiplante01Images`	15	`* @see http://www.tela-botanica.org/wikini/eflore/wakka.php?wiki=ApiIdentiplante01Images`
16	`*/`	16	`*/`
17		17
18	`class ListeImages {`	18	`class ListeImages {`
19		19
20	`private $imageIds = array();`	20	`private $imageIds = array();`
21	`private $conteneur;`	21	`private $conteneur;`
22	`private $navigation;`	22	`private $navigation;`
23	`private $masque;`	23	`private $masque;`
24	`private $gestionBdd;`	24	`private $gestionBdd;`
25	`private $bdd;`	25	`private $bdd;`
26	`private $parametres = array();`	26	`private $parametres = array();`
27	`private $ressources = array();`	27	`private $ressources = array();`
28		28
29	`public function __construct(Conteneur $conteneur = null) {`	29	`public function __construct(Conteneur $conteneur = null) {`
30	`$this->conteneur = $conteneur == null ? new Conteneur() : $conteneur;`	30	`$this->conteneur = $conteneur == null ? new Conteneur() : $conteneur;`
31	`$this->conteneur->chargerConfiguration('config_departements_bruts.ini');`	31	`$this->conteneur->chargerConfiguration('config_departements_bruts.ini');`
32	`$this->conteneur->chargerConfiguration('config_votes.ini');`	32	`$this->conteneur->chargerConfiguration('config_mapping_votes.ini');`
33	`$this->conteneur->chargerConfiguration('config_images.ini');`	33	`$this->conteneur->chargerConfiguration('config_images.ini');`
34	`$this->navigation = $conteneur->getNavigation();`	34	`$this->navigation = $conteneur->getNavigation();`
35	`$this->masque = $conteneur->getMasque();`	35	`$this->masque = $conteneur->getMasque();`
36	`$this->gestionBdd = $conteneur->getGestionBdd();`	36	`$this->gestionBdd = $conteneur->getGestionBdd();`
37	`$this->bdd = $this->gestionBdd->getBdd();`	37	`$this->bdd = $this->gestionBdd->getBdd();`
38	`}`	38	`}`
39		39
40	`/**`	40	`/**`