Subversion Repositories eFlore/Applications.del

<?php

// declare(encoding='UTF-8');

/**

	* Le web service observations récupère toutes les observations et, pour chacune d'elle, les

	* images qui lui sont associées.

 *

 * @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=ApiIdentiplante01Observations

 */

class ListeObservations {

	private $conteneur;

	private $navigation;

	private $masque;

	private $gestionBdd;

	private $bdd;

	private $parametres = array();

	private $ressources = array();

	private $tri = 'date_transmission';

	private $directionTri = 'desc';

	public function __construct(Conteneur $conteneur = null) {

		$this->conteneur = $conteneur == null ? new Conteneur() : $conteneur;

		$this->conteneur->chargerConfiguration('config_departements_bruts.ini');

		$this->conteneur->chargerConfiguration('config_observations.ini');

		$this->conteneur->chargerConfiguration('config_mapping_votes.ini');

		$this->conteneur->chargerConfiguration('config_mapping_commentaires.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();

		$this->verifierParametresTri();

		$this->initialiserTri();

		// Lancement du service

		$liaisons = $this->chargerLiaisons();

		$total = $this->compterObservations();

		$this->navigation->setTotal($total);

		$observations = $this->chargerObservations($liaisons);

		$observations = $this->chargerImages($observations);

		$observations = $this->chargerDeterminations($observations);

		// Mettre en forme le résultat et l'envoyer pour affichage

		$resultat = new ResultatService();

		$resultat->corps = array('entete' => $this->conteneur->getEntete(), 'resultats' => $observations);

		return $resultat;

	}

	private function initialiserRessourcesEtParametres($ressources, $parametres) {

		$this->ressources = $ressources;

		$this->parametres = $parametres;

	}

	private function verifierParametresTri() {

		$erreurs = array();

		$tris_possibles = $this->conteneur->getParametre('tris_possibles');

		$tris_possibles_tableau = explode(',', $tris_possibles);

		if(isset($this->parametres['tri']) && !in_array($this->parametres['tri'], $tris_possibles_tableau)) {

			$erreurs[] = '- le type de tri demandé est incorrect, les valeurs possibles sont '.$tris_possibles.' ;';

		}

		$directions_tri = array('asc', 'desc');

		if(isset($this->parametres['ordre']) && !in_array($this->parametres['ordre'], $directions_tri)) {

			$erreurs[] = '- la direction du tri demandé est incorrecte, les valeurs supportées sont asc ou desc ;';

		}

		if (!empty($erreurs)) {

			$e = 'Erreur lors de l\'analyse des parametres du tri : '."\n";

			$e .= implode("\n", $erreurs);

			throw new Exception($e, RestServeur::HTTP_CODE_ERREUR);

		}

	}

	private function initialiserTri() {

		$this->tri = isset($this->parametres['tri']) ? $this->parametres['tri'] : $this->tri;

		$this->directionTri = isset($this->parametres['ordre']) ? $this->parametres['ordre'] : $this->directionTri;

	}

	/*-------------------------------------------------------------------------------

	 							CONFIGURATION DU SERVICE

	 --------------------------------------------------------------------------------*/

	/**

	 * Configuration du service en fonction du fichier de config config_del.ini

	 * */

	private function configurer() {

		$this->mappingFiltre = $this->conteneur->getParametre('mapping_masque');

		$this->mappingObservation = $this->conteneur->getParametre('mapping_observation');

		$this->mappingVotes = $this->conteneur->getParametre('mapping_votes');

		$this->mappingCommentaire = $this->conteneur->getParametre('mapping_commentaire');

	}

	/**

	 * Vérifier que le service est bien configuré

	 * */

	private function verifierConfiguration() {

		$erreurs = array();

		$tableauObservations = $this->conteneur->getParametre('observations');

		if (empty($tableauObservations)) {

			$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', 'zone_geo', 'lieudit', 'station', 'courriel', '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->mappingCommentaire)) {

			$erreurs[] = '- le fichier de configuration ne contient pas le tableau [mapping_commentaire] ou celui-ci est vide ;';

		} else {

			$champsMappingCom = array('id_commentaire', 'texte', 'ce_utilisateur', 'utilisateur_nom', 'utilisateur_prenom', 'utilisateur_courriel', 'date');

			foreach ($champsMappingCom as $champ) {

				if (!isset($this->mappingCommentaire[$champ])) {

					$erreurs[] = '- le mapping du champ "'.$champ.'" pour le commentaire 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() {

		$where = array();

		$tableauMasque = $this->masque->getMasque();

		if (!empty($tableauMasque)) {

			foreach($tableauMasque as $idMasque => $valeurMasque) {

				$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. 'œ'

		$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) {

		$mots_cles = explode(' ', $valeurMasque);

		$requeteMotsClesImg = '';

		$requeteMotsClesObs = '';

		//TODO voir s'il existe un moyen plus simple que le foreach + rtrim

		// comme avec implode (attention au fait que l'on concatène des % au début et à la fin)

		foreach($mots_cles as $mot_cle) {

			$requeteMotsCles = $this->proteger('%'.$mot_cle.'%');

			$requeteMotsClesImg .= 'di.mots_cles_texte LIKE '.$requeteMotsCles.' AND ';

			$requeteMotsClesObs .= 'dob.mots_cles_texte LIKE '.$requeteMotsCles.' AND ';

		}

		$requeteMotsClesImg = rtrim($requeteMotsClesImg, ' AND ');

		$requeteMotsClesObs = rtrim($requeteMotsClesObs, ' AND ');

		$masque = '('.

		          	'('.$requeteMotsClesImg.') OR '.

		          	'('.$requeteMotsClesObs.') '.

				  ') ';

		return $masque;

	}

	/*-------------------------------------------------------------------------------

								CHARGEMENT DES OBSERVATIONS

	--------------------------------------------------------------------------------*/

	/**

	* Chargement depuis la bdd de toutes les liaisons entre images et observations

	* */

	private function chargerLiaisons() {

		$requeteLiaisons = 'SELECT SQL_CALC_FOUND_ROWS dob.id_observation, nom_sel, famille, ce_zone_geo, zone_geo, lieudit, station, milieu, date_observation, dob.mots_cles_texte, date_transmission, di.id_image, dob.ce_utilisateur, prenom, nom, courriel, nom_original, dob.commentaire as dob_commentaire, dob.nt, dob.nom_sel_nn '.

						   'FROM '.$this->gestionBdd->formaterTable('del_observation', 'dob').

						   'INNER JOIN '.$this->gestionBdd->formaterTable('del_obs_image', 'doi').

						   'ON doi.id_observation = dob.id_observation '.

						   'INNER JOIN del_utilisateur du '.

						   'ON du.id_utilisateur = dob.ce_utilisateur '.

						   'INNER JOIN del_image di '.

						   'ON di.id_image = doi.id_image ';

		$requeteLiaisons .= $this->chargerClauseWhere();

		$requeteLiaisons .= ' GROUP BY doi.id_observation';

		$requeteLiaisons .= ' ORDER BY '.$this->tri.' '.$this->directionTri.' ';

		$requeteLiaisons .= $this->gestionBdd->getLimitSql();

		return $this->bdd->recupererTous($requeteLiaisons);

	}

	/**

	* Compter le nombre total d'images dans la base pour affichage dans entete.

	* */

	private function compterObservations() {

		$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 chargerObservations($liaisons) {

		$observations = array();

		foreach ($liaisons as $liaison) {

			$idObs = $liaison[$this->mappingObservation['id_observation']];

			$observation = $this->formaterObservation($liaison);

			$observations[$idObs] = $observation;

		}

		return $observations;

	}

	/**

	 * Sélectionner toutes les images de chaque observation

	 * @param array $observations la liste des observations

	 * */

	private function chargerImages($observations) {

		foreach ($observations as $id => $observation) {

			$requeteImages = 'SELECT * FROM '. $this->gestionBdd->formaterTable('del_obs_image', 'doi').

							 'INNER JOIN '.$this->gestionBdd->formaterTable('del_image', 'di').

							 'ON doi.id_image = di.id_image '.

							 'WHERE doi.id_observation = '.$observation['id_observation'];

			$images = $this->bdd->recupererTous($requeteImages);

			$images = $this->formaterImages($images);

			$observations[$id]['images'] = $images;

		}

		return $observations;

	}

	/**

	* Récupérer toutes les déterminations et le nombre de commentaire au total

	* @param array $observations la liste des observations à mettre à jour

	* */

	private function chargerDeterminations($observations) {

		foreach ($observations as $id => $observation) {

			$requetePropositions = 'SELECT * FROM '.$this->gestionBdd->formaterTable('del_commentaire', 'dc').

									   'WHERE dc.nom_sel IS NOT NULL AND ce_observation = '.$observation['id_observation'];

			$propositions = $this->bdd->recupererTous($requetePropositions);

			$observations[$id]['commentaires'] = $this->formaterDeterminations($propositions);

		}

		return $observations;

	}

	/**

	 * Charger les votes sur les déterminations

	 * @param Array $observations le tableau des observations à mettre à jour

	* */

	private function chargerVotes($ids_proposition, $propositions) {

		$requeteVotes = 'SELECT * FROM '.

			$this->gestionBdd->formaterTable('del_commentaire_vote').

			'WHERE ce_proposition IN ('.implode(', ', $ids_proposition).')';

		$resultatsVotes = $this->bdd->recupererTous($requeteVotes);

		foreach ($resultatsVotes as $vote) {

			$propositions[$vote['ce_proposition']]['votes'][$vote['id_vote']] = $this->formaterVote($vote);

		}

		return $propositions;

	}

	/**

	 * Charger le nombre de commentaires (sans détermination) associé à l'observation

	 * @param Array $observations le tableau des observatins à mettre à jour

	 * */

	private function chargerNombreCommentaire($ids_proposition, $propositions) {

		$requeteNbCommentaires = 'SELECT ce_commentaire_parent, COUNT(id_commentaire) as nb '.

									'FROM del_commentaire '.

									'WHERE ce_commentaire_parent IN ('.implode(', ', $ids_proposition).')';

		$listeCommentaires = $this->bdd->recuperer($requeteNbCommentaires);

		// ce test sert à exclure les proposition de 1er niveau qui sont elles aussi des commentaires

		if($listeCommentaires['ce_commentaire_parent'] != null && $listeCommentaires['ce_commentaire_parent'] != 0) {

			$propositions[$listeCommentaires['ce_commentaire_parent']]['nb_commentaires'] = $listeCommentaires['nb'];

		}

		return $propositions;

	}

	/*-------------------------------------------------------------------------------

								FORMATER ET METTRE EN FORME

	--------------------------------------------------------------------------------*/

	/**

	 * Formater les images d'une observation

	 * @param array $images les images de l'observation

	 * */

	private function formaterImages($images) {

		$imagesRetour = array();

		foreach ($images as $image) {

			$imageCourante = array();

			$imageCourante['id_image'] = $image['id_image'];

			$imageCourante['date'] = $image['date_prise_de_vue'];

			$imageCourante['binaire.href'] = $this->formaterLienImage($image['id_image']);

			$imageCourante['hauteur'] = $image['hauteur'];

			$imageRetour['largeur'] = $image['largeur'];

			$imagesRetour[] = $imageCourante;

		}

		return $imagesRetour;

	}

	/**

	*  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];

		}

		$observation['images'] = array();

		return $observation;

	}

	/**

	 * 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;

	}

	/**

	 *

	 * Formate une liste de proposition en fonction du fichier de configuration

	 */

	private function formaterDeterminations($listePropositions) {

		$propositions_format = array();

		if ($listePropositions != array()) {

			foreach ($listePropositions as $id => $proposition) {

				$ids_proposition[] = $proposition['id_commentaire'];

				$proposition_formatee = array('nb_commentaires' => "0");

				foreach ($this->mappingCommentaire as $nomOriginal => $nomFinal) {

					if (isset($proposition[$nomOriginal])) {

						$proposition_formatee[$nomFinal] = $proposition[$nomOriginal];

					}

				}

				$propositions_format[$proposition['id_commentaire']] = $proposition_formatee;

			}

			$propositions_format = $this->chargerVotes($ids_proposition, $propositions_format);

			$propositions_format = $this->chargerNombreCommentaire($ids_proposition, $propositions_format);

		}

		return $propositions_format;

	}

	/**

	*  Formater un vote en fonction du fichier de configuration config_votes.ini

	*  @param $votes array()

	* */

	private function formaterVote($vote) {

		$retour = array();

		foreach ($vote as $param=>$valeur) {

			$retour[$this->mappingVotes[$param]] = $valeur;

		}

		return $retour;

	}

	private function proteger($valeur) {

		if (is_array($valeur)) {

			return $this->bdd->protegerTableau($valeur);

		} else {

			return $this->bdd->proteger($valeur);

		}

	}

}

?>