Rev 1180 | Blame | Last modification | View Log | RSS feed
<?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();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_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();$this->verifierParametresTri();$this->initialiserTri();// 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;}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.' ;';}if(isset($this->parametres['tri']) && $this->parametres['tri'] == "votes") {if(!isset($this->parametres['protocole']) || !is_numeric($this->parametres['protocole'])) {$erreurs[] = '- Le paramètre protocole est obligatoire en cas de tri par vote et doit être un entier ;';}}$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* */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 ;';}}}$tris_possibles = $this->conteneur->getParametre('tris_possibles');if (empty($tris_possibles)) {$erreurs[] = '- le fichier de configuration ne contient pas le parametre tris_possibles ou celui-ci est vide ;';}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) {//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 BDDcase '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// utilitairefunction 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èresreturn $str;}private function normaliserMotCle($mot_cle) {return mb_strtolower($this->supprimerAccents(trim($mot_cle)));}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 = array();$requeteMotsClesObs = array();$requeteMotsClesImgPublic = array();foreach($mots_cles as $mot_cle) {//TODO: rechercher sur les mots clés normalisés dans tous les cas ?$requeteMotsCles = $this->proteger('%'.$mot_cle.'%');$motsCleProtege = $this->proteger($this->normaliserMotCle('%'.$mot_cle.'%'));$requeteMotsClesImgPublic[] = 'di.id_image IN (SELECT ce_image FROM del_image_tag WHERE tag_normalise LIKE '.$motsCleProtege.' AND actif = 1)';$requeteMotsClesImg[] = 'di.mots_cles_texte LIKE '.$requeteMotsCles;$requeteMotsClesObs[] = 'dob.mots_cles_texte LIKE '.$requeteMotsCles;}$requeteMotsClesImgPublic = implode(' AND ', $requeteMotsClesImgPublic);$requeteMotsClesImg = implode(' AND ', $requeteMotsClesImg);$requeteMotsClesObs = implode(' AND ', $requeteMotsClesObs);$masque = '('.'('.$requeteMotsClesImgPublic.') OR '.'('.$requeteMotsClesImg.') OR '.'('.$requeteMotsClesObs.') '.')';return $masque;}/*-------------------------------------------------------------------------------CHARGEMENT DES IMAGES--------------------------------------------------------------------------------*//*** Chargement depuis la bdd de toutes les liaisons entre images et observations* */private function chargerLiaisons() {$champs = array('dob.id_observation as id_observation', 'nom_sel', 'nom_sel_nn', 'nt', 'famille', 'ce_zone_geo', 'zone_geo','lieudit', 'station', 'milieu', 'date_observation', 'dob.mots_cles_texte as mots_cles_texte', 'dob.commentaire as commentaire','di.mots_cles_texte as mots_cles_texte_image ', 'date_transmission', 'di.id_image as id_image', 'di.ce_utilisateur as ce_utilisateur','prenom', 'nom', 'courriel', 'nom_original');// Attention le LEFT JOIN est indispensable pour ramener les images n'ayant pas de votes// en cas de tri par votes$requeteLiaisons = 'SELECT DISTINCT SQL_CALC_FOUND_ROWS '.implode(', ',$champs).' '.($this->doitJoindreTableVotes() ?', IF(dvote.ce_protocole = '.$this->parametres['protocole'].', AVG(dvote.valeur), 0) as total_votes ' :'').($this->doitJoindreTableTags() ?// attention le DISTINCT est indispensable !', (COUNT(DISTINCT dtag.id_tag) + '.$this->assemblercomptageOccurencesMotsClesCel().') as total_tags ' :'').'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 '.'LEFT JOIN del_utilisateur du '.'ON du.id_utilisateur = di.ce_utilisateur '.($this->doitJoindreTableTags() ?'LEFT JOIN del_image_tag dtag '.'ON doi.id_image = dtag.ce_image AND dtag.actif = 1 ' :'').($this->doitJoindreTableVotes() ?'LEFT JOIN del_image_vote dvote '.'ON doi.id_image = dvote.ce_image AND dvote.ce_protocole = '.$this->parametres['protocole'] :'');$requeteLiaisons .= $this->chargerClauseWhere();$requeteLiaisons .= $this->getTri();$requeteLiaisons .= $this->gestionBdd->getLimitSql();return $this->bdd->recupererTous($requeteLiaisons);}private function assemblercomptageOccurencesMotsClesCel() {$chaineMotsClesAffiches = $this->conteneur->getParametre('mots_cles_cel_affiches');$tabMotsClesAffiches = explode(',',$chaineMotsClesAffiches);$chaineSql = '';// Comptage du nombre de mots clés officiels présents dans la chaine mots clés texteforeach ($tabMotsClesAffiches as $motCle) {if($chaineSql != '') {$chaineSql .= ' + ';}$chaineSql .= 'IF(FIND_IN_SET('.$this->proteger($motCle).',di.mots_cles_texte) != 0, 1, 0)';}return '('.$chaineSql.')';}private function doitJoindreTableVotes() {return ($this->tri == 'votes');}private function doitJoindreTableTags() {return ($this->tri == 'tags');}private function getTri() {$order = '';if($this->doitJoindreTableVotes()) {$order = ' GROUP BY dvote.ce_image, dob.id_observation ORDER BY total_votes '.$this->directionTri.', date_transmission desc ';} else if($this->doitJoindreTableTags()) {$order = ' GROUP BY doi.id_image ORDER BY total_tags '.$this->directionTri.', date_transmission desc ';} else {$order = ' ORDER BY '.$this->tri.' '.$this->directionTri.' ';}return $order;}/*** 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;$index = $liaison['id_image'].'-'.$liaison['id_observation'];$images[$index] = array('id_image' => $idImage, 'binaire.href' => $this->formaterLienImage($idImage),'protocoles_votes' => array(),'mots_cles_texte' => $liaison['mots_cles_texte_image'], '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);}}}?>