Subversion Repositories eFlore/Applications.del

<?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.ini');
                $this->conteneur->chargerConfiguration('config_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() {
                $where = array();
                $tableauMasque = $this->masque->getMasque();
                // FIXME : Les communes avec une apostrophe (ex: saint michel d'euzet) arrivent dans les paramètres sans l'apostrophe
                if (!empty($tableauMasque)) {
                        foreach($tableauMasque as $idMasque => $valeurMasque) {
                                        
                                $idMasque = str_replace('masque.', '', $idMasque);
                                switch ($idMasque) {
                                        // nom du masque => nom BDD
                                        case 'auteur' :
                                                $auteurId = $this->masque->getMasque('auteur');
                                                if (is_numeric($auteurId)) {
                                                        $where[] = ' ce_utilisateur = '.$auteurId;
                                                } else {
                                                        if (strpos($auteurId, '@') === false) {
                                                                $chaineNomPrenom = $this->getChaineNomPrenom($auteurId);
                                                                $where[] = '((nom IN ('.$chaineNomPrenom.')) OR (prenom IN ('.$chaineNomPrenom.')))';
                                                        } else {
                                                                $where[] = " courriel LIKE ".$this->proteger($this->masque->getMasque('auteur').'%')." ";
                                                        }
                                                }
                                                break;
                        
                                                //TODO : gérer le format de la date ?
                                                // rechercher sur LIKE DATE % ?
                                                // TODO : recherche sur JOUR MOIS ou ANNEE
                                        case 'departement' :
                                                $dept = $valeurMasque;
                                                if (is_numeric($dept)) {
                                                        $where[] = " ce_zone_geo LIKE ".$this->proteger('INSEE-C:'.$dept.'%');
                                                } else {
                                                        
                                                        //FIXME : et les apostrophes dans les départements ?
                                                        
                                                        $deptId = $this->conteneur->getParametre($dept);
                                                        if ($deptId != null) {
                                                                $where[] = " ce_zone_geo LIKE ".$this->proteger('INSEE-C:'.$deptId.'%');
                                                        }
                                                }
                                                break;
                                        case 'genre' :
                                                $where[] = ' '.$this->mappingFiltre['ns'].' LIKE '.$this->proteger($valeurMasque.' %');
                                                break;
                                        case 'tag' :
                                                $where[] = " di.mots_cles_texte LIKE ".$this->proteger($valeurMasque);
                                                break;
                                        case 'ns' :
                                                $where[] = " nom_sel LIKE ".$this->proteger($valeurMasque.'%');
                                                break;
                                        default:
                                                $where[] = ' '.$this->mappingFiltre[$idMasque].' = '.$this->proteger($valeurMasque);
                                        break;
                                }
                        }       
                }
                
                if (!empty($where)) {
                        return ' WHERE '.implode('AND', $where);
                } else {
                        return;
                }
        }
        
        /*-------------------------------------------------------------------------------
                                                                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);
                }
        }
}
?>