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

// TODO : voir conteneur, n'étendra plus rien, le conteneur viendra du constructeur 
class Images extends Commun {
        
        private $config;
        private $schemaBdd;
        private $depart = 0;
        private $limite = 10;
        private $total; // Le nombre total d'images
        private $masque = array(); //Enregistrer les paramètres du masque
        private $masquesPossibles = array('famille', 'genre', 'ns', 'nn', 'auteur', 'date', 'commune', 'departement', 'tag');
        private $imageIds = array();
        private $UrlNavigation;
        private $mappingFiltre;
        private $mappingObservation;
        
        
        /**
         * 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) {
                
                // Gestion des configuration du script
                // TODO : gérer les erreurs de config
                // voir les paramètres par défaut
                // vérifier les valeurs (voir try catch JP)
                $this->configurer();
                //$this->verifierConfiguration();
                $this->schemaBdd = $this->config['schemaBdd'];
                $this->UrlNavigation = new Url($this->config['url_service']);
                $this->UrlNavigation->setOption(Url::OPTION_ENCODER_VALEURS, true);
                $this->chargerParametres($parametres);
                
                // Lancement du service
                $liaisons = $this->chargerLiaisons();
                $this->total = $this->compterImages();
                $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->getEntete(), 'resultats' => $images);
                return $resultat;
        }
        
        /*-------------------------------------------------------------------------------
                                                                CONFIGURATION DU SERVICE
         --------------------------------------------------------------------------------*/
        /**
         * Configuration du service en fonction du fichier de config config_del.ini
         * */
        public function configurer() {
                $this->config = Config::get('images');
                $this->mappingFiltre = Config::get('mapping_masque');
                $this->mappingObservation = Config::get('mapping_observation');
        }
        
        /**
         * Vérifier que le service est bien configuré 
         * */
        public function verifierConfiguration() {
                
                $erreurs = array();
                
                if (empty($this->config)) {
                        $erreurs[] = '- le fichier de configuration ne contient pas le tableau [images] ou celui-ci est vide ;'; 
                } else {
                        if (!isset($this->config['url_service'])) {
                                $erreurs[] = '- paramètre "url_service" manquant ;';
                        }
                        
                        if (!isset($this->config['url_images'])) {
                                $erreurs[] = '- paramètre "url_images" manquant ;';
                        }
                        
                        if (!isset($this->config['schemaBdd'])) {
                                $erreurs[] = '- paramètre "schemaBdd" 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);
                        $this->renvoyerErreur(RestServeur::HTTP_CODE_ERREUR, $e);
                        
                }
        }
        
        /**
         * Gestion des paramètres de l'application pour stockage dans variable de classe
         * @param array $parametres les paramètres tels que passés à la méthode consulter
         * */
        public function chargerParametres($parametres) {
                $this->parametres = $parametres;
                
                if (isset($this->parametres['navigation.depart'])) {
                        $this->depart = $this->parametres['navigation.depart'];                 
                } 
                
                if (isset($this->parametres['navigation.limite'])) {
                        $this->limite = $this->parametres['navigation.limite'];
                }
                
                foreach ($parametres as $id => $parametre) {
                        if (strpos($id, 'masque.') === 0) {
                                $champ = substr($id, 7, strlen($id));
                                if (isset($masquesPossibles[$champ])) { 
                                        $this->masque[$champ] = $parametre;
                                }
                        }
                }
        }
        
        /**
        * Créer la chaine de limite de requête en fonction des paramètres donnés
        * */
        private function getLimite() {
                return ' LIMIT '.$this->depart.', '.$this->limite;
        }
        
        /**
         * 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->getBdd()->protegerTableau($nomPrenom);
                $chaineNomPrenom = implode(', ', $nomPrenom);
                return $chaineNomPrenom;
        }
        
        /**
        * Charger la clause WHERE en fonction des paramètres de masque
        * */
        private function chargerClauseWhere() {
                $where = array();
                
                // TODO : vérifier les communes et les communes avec une apostrophe
                foreach($this->masque as $idMasque => $valeurMasque) {
                                
                        switch ($idMasque) {
                                // nom du masque => nom BDD
                                case 'auteur' :
                                        $auteurId = $this->masque['auteur'];
                                        if (is_numeric($auteurId)) {
                                                $where[] = " ce_utilisateur = ".$this->masque['auteur'];
                                        } else {
                                                if (strpos($auteurId, '@') === false) {
                                                        $chaineNomPrenom = $this->getChaineNomPrenom($auteurId);
                                                        $where[] = '((nom IN ('.$chaineNomPrenom.')) OR (prenom IN ('.$chaineNomPrenom.')))';
                                                } else {
                                                        $where[] = " courriel LIKE ".$this->getBdd()->proteger($this->masque['auteur'].'%')." ";
                                                }
                                        }
                                break;
                                
                                //TODO : gérer le format de la date ?
                                // rechercher sur LIKE DATE % ?
                                // TODO : recherche sur JOUR MOIS ou ANNEE
                                case 'departement' :
                                        $dept = $this->masque['departement'];
                                        if (is_numeric($dept)) {
                                                $where[] = " ce_zone_geo LIKE ".$this->getBdd()->proteger('INSEE-C:'.$this->masque['departement'].'%');
                                        } else {
                                                //TODO : que faire si le département n'est pas numérique ?
                                                // TODO : modifier le modèle pour intégrer les zones geos !
                                        }
                                break;
                                case 'genre' :
                                                $where[] = ' '.$this->mappingFiltre['ns'].' LIKE '.$this->getBdd()->proteger($valeurMasque.' %');
                                break;
                                case 'tag' :
                                        $where[] = " di.mots_cles_texte LIKE ".$this->getBdd()->proteger($valeurMasque);
                                break;
                                default:
                                        $where[] = ' '.$this->mappingFiltre[$idMasque].' = '.$this->getBdd()->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->schemaBdd.'.del_obs_images doi '.
                                                   'INNER JOIN del_image di '.
                                                   'ON doi.ce_image = di.id_image '.
                                                   'INNER JOIN del_observation dob '.
                                                   'ON doi.ce_observation = dob.id_observation '.
                                                   'INNER JOIN del_utilisateur du '.
                                                   'ON du.id_utilisateur = doi.ce_utilisateur';
                $requeteLiaisons .= $this->chargerClauseWhere();
                $requeteLiaisons .= $this->getLimite();
                return $this->getBdd()->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->getBdd()->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['ce_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'], 'votes' => array(), 'observation' => $this->formaterObservation($liaison));
                }
                return $images;
        }
        
        /**
        * Charger les votes pour chaque image
        * */
        private function chargerVotes($images) {
                
                if (sizeof($this->imageIds) > 0) {
                        $chaineImageIds = implode(',', $this->imageIds);
                        
                        $requeteVotes = 'SELECT * FROM '.
                                        $this->schemaBdd.'.del_vote_image '.
                                        'WHERE ce_image IN ('.$chaineImageIds.')';
                        $resultatsVotes = $this->getBdd()->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]['votes'] = $votes[$image['id_image']];
                                }
                        }
                }
                
                return $images;
        }
        
        /*-------------------------------------------------------------------------------
                                                                FORMATER ET METTRE EN FORME
        --------------------------------------------------------------------------------*/
        
        //TODO : gérer les paramètres par défaut au cas où ça ne soit pas 
        /*
         * array(
                                        'id_observation' => 'id_observation',
                                        'date_observation' => 'date_observation',
                                        'date_transmission' => 'date_transmission', 
                                        'famille' => 'determination.famille',
                                        'nom_sel' => 'determination.ns',
                                        'nom_sel_nn' => 'determination.nn',
                                        'nt' => 'determination.nt',
                                        'ce_zone_geo' => 'id_zone_geo',
                                        'zone_geo' => 'zone_geo',
                                        'lieudit' => 'lieudit',
                                        'station' => 'station',
                                        'milieu' => 'milieu',
                                        'ce_utilisateur' => 'auteur.id',
                                        'nom' => 'auteur.nom',
                                        'prenom' => 'auteur.prenom' 
                                        );
         */
        /**
        *  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) {
                        $idImage = $vote['ce_image'];
                        $id = $vote['id_vote_image'];
                        $id_protocole = $vote['ce_protocole'];
                        $auteur_id = $vote['ce_utilisateur'];
                        $valeur = $vote['valeur_vote'];
                        $date = $vote['date_vote_image'];
                
                        $retour[$idImage]['valeur'] = $valeur;
                        $retour[$idImage]['protocole'] = $id_protocole;
                        $retour[$idImage]['auteur_id'] = $auteur_id;
                        $retour[$idImage]['date'] = $auteur_id;
                }
                
                return $retour;
        }
        
        /**
         * Créer l'entête en fonction des paramètres donnés
         * */
        private function getEntete() {
                $entete = array();
                $entete['masque'] = $this->recupererMasque();
                $entete['depart'] = $this->depart;
                $entete['limite'] = $this->limite;
                $entete['total'] = $this->total;
                $lienPrecedent = $this->recupererHrefPrecedent();
                
                if ($lienPrecedent != null) { 
                        $entete['entete.precedent'] = $lienPrecedent; 
                } 
                
                $lienSuivant = $this->recupererHrefSuivant();
                if ($lienSuivant) {
                        $entete['entete.suivant'] = $lienSuivant; 
                }
                return $entete;
        }
        
        /**
         * Récupérer le lien pour afficher les images précédentes en fonction des paramètres 
         * */
        private function recupererHrefPrecedent() {
                $departActuel = $this->depart;
                $limite = $this->limite;
                $departSuivant = $departActuel - $limite;
        
                $url = null;
                
                if ($departActuel > 0) {
                        $url = $this->obtenirUrlNavigation($departSuivant, $limite, $this->parametres);
                }
                return $url;
        }
        
        /**
        * Récupérer le lien pour afficher les images suivantes en fonction des paramètres
        * */
        private function recupererHrefSuivant() {
                $departActuel = $this->depart;
                $limite = $this->limite;
                $departSuivant = $departActuel + $limite;
                
        
                $url = null;
                if ($departSuivant < $this->total) {
                        $url = $this->obtenirUrlNavigation($departSuivant, $limite, $this->parametres);
                }
                return $url;
        }
        
        /**
        * Récupérer l'url de navigation en concaténant d'éventuels paramètres
        * @param $depart l'entier de départ de la recherche
        * @param $limite le nombre de résultats à retourner
        * @param $parametresAdditionnels le tableau contenant les parametres => valeurs additionnels
        * */
        private function obtenirUrlNavigation($depart, $limite, $parametresAdditionnels) {
        
                $parametres = array('navigation.depart' => $depart, 'navigation.limite' => $limite);
        
                if ($parametresAdditionnels != null) {
                        unset($parametresAdditionnels['navigation.depart']);
                        unset($parametresAdditionnels['navigation.limite']);
                        $parametres = array_merge($parametres, $parametresAdditionnels);
                }
        
                $this->UrlNavigation->setRequete($parametres);
                $url = $this->UrlNavigation->getURL();
                return $url;
        }
        
        /**
         * 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->config['url_images'];
                $urlImage = str_replace('%s', $idImage, $url);
                return $urlImage;
        }

        /**
         * Récupérer le masque depuis les paramètres
         * */
        private function recupererMasque() {
                $masqueEntete = '';
                foreach ($this->parametres as $param => $cle) {
                        if ($param == 'masque') {
                                $masqueEntete = 'masque='.$cle.',';
                        } elseif (substr($param, 0, 7) == 'masque.') {
                                $masqueEntete .= substr($param, 7).'='.$cle.',';
                        }
                }
                $masqueEntete = rtrim($masqueEntete,',');
                return $masqueEntete;
        }
}
?>