Subversion Repositories eFlore/Applications.del

<?php
/**
 * Service fournissant des informations concernant les tags sur les images de DEL en fonction d'un protocole 
 * au format RSS1, RSS2 ou ATOM.
 * Encodage en entrée : utf8
 * Encodage en sortie : utf8
 * 
 * @author Grégoire DUCHE <gregoire@tela-botanica.org>
 * @license GPL v3 <http://www.gnu.org/licenses/gpl.txt>
 * @license CECILL v2 <http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt>
 * @version $Id$
 * @copyright 2010
 */
class SyndicationTagsParProtocole {
        
        
        /**
         * Paramètres du service
         * */
        private $ressources = null;
        private $parametres = null;
        private $format = null;
        private $service = null;
        private $squelette = null;
        private $squelette_dossier = null;
        private $masque = array();
        private $mappingFiltre = array();
        private $conteneur = null;
        private $gestionBdd = null;
        private $navigation = null;
        private $type_rss = null;
        
        /**
         * Constructeur
         * Initialiser les configurations
         * */
        public function __construct(Conteneur $conteneur = null) {
                $this->conteneur = $conteneur == null ? new Conteneur() : $conteneur;
                $this->conteneur->chargerConfiguration('config_syndication_tagsparprotocole.ini');
                $this->mappingFiltre = $this->conteneur->getParametre('mapping_masque');
                $this->masque = $conteneur->getMasque();
                $this->gestionBdd = $conteneur->getGestionBdd();
                $this->navigation = $conteneur->getNavigation();
        }
        
        /**
         * Consulter 
         * Méthode par défaut pour récupérer l'ensemble des tags.
         * Vérifie la configuration et retourne les derniers tags formatés
         * */
        public function consulter($params = array()) {  
                $this->verifierConfiguration(); 
                $this->type_rss = $params[1];
                if ($this->fluxAdminDemande()) {
                        $this->demanderAutorisationAdmin();
                } 
                
                $donnees_brutes = $this->getDerniersVotesImage();
                $commentaires_formates = $this->formaterPourRss($donnees_brutes) ; 
                return $commentaires_formates;
        }
        
        /**
        * Vérifier que le service est bien configuré
        * */
        public function verifierConfiguration() {
        
                $erreurs = array();
                $tableauImages = $this->conteneur->getParametre('mapping_masque');
        
                if (empty($this->mappingFiltre)) {
                        $erreurs[] = '- le fichier de configuration ne contient pas le tableau [mapping_masque] ou celui-ci est vide ;';
                } else {
                        $champsMappingFiltre = array('image', 'protocole');
                        foreach ($champsMappingFiltre as $champ) {
                                if (!isset($this->mappingFiltre[$champ])) {
                                        $erreurs[] = '- le mapping du champ "'.$champ.'" pour le commentaire est manquant ;';
                                }
                        }
                }
        
                if (!empty($erreurs)) {
                        $e = 'Erreur lors de la configuration : '."\n";
                        $e .= implode("\n", $erreurs);
                        throw new Exception($e, RestServeur::HTTP_CODE_ERREUR);
                }
        }
        
        /**
         * Verifier si le flux admin est demandé
         */
        private function fluxAdminDemande() {
                return $this->conteneur->getParametre('admin') != null && $this->conteneur->getParametre('admin') == 1; 
        }
        
        /**
         * Si le flux est un flux admin, demander un mot de passe
         * */
        private function demanderAutorisationAdmin() {
                $verification = new ControleAcces($this->conteneur);
                $verification->demanderAuthentificationAdmin();
        }
        
        
        /**
         * Retrouver les derniers votes image
         * */
        private function getDerniersVotesImage() {
                
                $requete =  'SELECT DISTINCT id_tag, tag, date, nom, prenom, nom_sel, id_image '.
                                        'FROM del_image_tag '.
                                        'LEFT JOIN del_utilisateur ON ce_utilisateur = id_utilisateur '.
                                        'INNER JOIN del_obs_image doi ON ce_image = id_image '.
                                        'INNER JOIN del_observation do ON doi.id_observation = do.id_observation '.
                                        'WHERE actif = 1 '.
                                        $this->chargerClauseWhere()." ".
                                        ' ORDER BY date DESC '.
                                        ' LIMIT '.$this->navigation->getDepart().','.$this->navigation->getLimite();
                $elements = $this->gestionBdd->getBdd()->recupererTous($requete);
                return $elements;
        }
        
        
        /**
         * Formater les données pour mettre en page le RSS
         * */
        private function formaterPourRss($elements) {
                $donnees = $this->construireDonneesCommunesAuFlux($elements);
                foreach ($elements as $element) {
                        $identifiants[$element['id_tag']] = $element['id_tag'];
                }
                foreach ($elements as $element) {
                        $donnees['items'][] = $this->construireDonneesCommunesAuxItems($element);
                }
                return $donnees;
        }
                
        /**
         * Générer les métadonnées du flux (titre, dates, editeur etc.)
         * */
        private function construireDonneesCommunesAuFlux($infos) {
                $donnees = array();
                $donnees['guid'] = '';
                $donnees['titre'] = 'Derniers tags sur les images de l\'application PictoFlora';
                $donnees['description'] = 'Ce flux regroupe les derniers tags sur les images de Pictoflora';
                $donnees['lien_service'] = $this->creerUrlService();
                $donnees['lien_del'] = $this->conteneur->getParametre('pictoAppliLien');
                $donnees['editeur'] = $this->conteneur->getParametre('editeur');
                $derniere_info_en_date = reset($infos);
                $date_modification_timestamp = strtotime($derniere_info_en_date['date']);
                $donnees['date_maj_RSS'] = date(DATE_RSS, $date_modification_timestamp);
                $donnees['date_maj_ATOM'] = date(DATE_ATOM, $date_modification_timestamp);
                $donnees['date_maj_W3C'] = date(DATE_W3C, $date_modification_timestamp);
                $donnees['annee_courante'] = date('Y');
                $donnees['generateur'] = 'DEL - SyndicationCommentaire';
                $donnees['generateur_version'] = (preg_match('/([0-9]+)/', '$Revision$', $match)) ?  $match[1] : '0';
                return $donnees; 
        }
        
        /**
         * Générer le lien du flux RSS
         * */
        private function creerUrlService() {
                $url_service = $this->conteneur->getParametre('url_service');
                $url_service .= '/'.$this->type_rss;
                //$url_service = '';
                if (count($_GET) > 0) {
                        $parametres_get = array();
                        foreach ($_GET as $cle => $valeur) {
                                $parametres_get[] = $cle.'='.$valeur;
                        }
                        $url_service .= '?'.implode('&amp;', $parametres_get);
                }
                return $url_service;
        }
        
        /**
         * Générer les données communes & spécifiques à chaque item
         * */
        private function construireDonneesCommunesAuxItems($info) {
                $item = array();
                $date_modification_timestamp = strtotime($info['date']);
                $item['date_maj_simple'] = strftime('%A %d %B %Y à %H:%M', $date_modification_timestamp);
                $item['date_maj_RSS'] = date(DATE_RSS, $date_modification_timestamp);
                $item['date_maj_ATOM'] = date(DATE_ATOM, $date_modification_timestamp);
                $item['date_maj_W3C'] = date(DATE_W3C, $date_modification_timestamp);
                $item['titre'] = $this->creerTitre($info);
                $item['guid'] = $this->creerGuidItem($info);
                $item['lien'] = $this->creerLienItem($info);
                $item['categorie'] = $this->creerCategorie($item);
                $item['description'] = $this->creerDescription($info, $item);
                $item['description_encodee'] = htmlspecialchars($this->creerDescription($info, $item));
                $item['modifie_par'] = $this->creerAuteur($info);
                return $item;
        }
        
        
        private function creerCategorie($element) {
                $categorie = 'Tag protocole';
                $categorie = htmlentities($categorie);
                return $categorie;
        }
        
        private function creerGuidItem($element) {
                $guid = sprintf($this->conteneur->getParametre('tagParProtocole'), $element['id_tag']);
                return $guid;
        }

        private function creerLienItem($element) {
                // TODO : ajouter un lien vers la plateforme validation de picto lorsqu'elle sera dispo
                $lien = $this->conteneur->getParametre('pictofloraFicheObsTpl');
                return $lien;
        }
        
        private function creerTitre($element) {
                $intitule = 'Tag';
                $titre = $intitule.' "'.$element['tag'].'" - ('.htmlspecialchars($element['nom_sel']).', par '.htmlspecialchars($this->creerAuteur($element)).')';
                return $titre;
        }
        
        private function creerDescription($donnees, $item) {
                $description = '<ul>';
                $description .= '<li>Image : '.htmlspecialchars($donnees['id_image']).'</li>';
                $description .= '<li>Proposition : <em>'.htmlspecialchars($donnees['nom_sel']).'</em></li>';
                // TODO : ajouter le protocole ? $description .= '<li>Protocole : '.htmlspecialchars($donnees['intitule']).'</li>';
                $description .= '<li>Tag : '.$donnees['tag'].'</li>';
                
                $auteur = htmlspecialchars($this->creerAuteur($donnees));
                $auteur .= $this->fluxAdminDemande() ? ' ('.$donnees['utilisateur_courriel'].')' : '';
                
                $description .= '<li>Auteur : '.$auteur.'</li>'.
                                '</ul>';
                return $description;
        }
        
        private function creerAuteur($info) {
                if ($info['prenom'] != '' && $info['nom'] != '') {
                        return $info['prenom'].' '.$info['nom'];
                } else {
                        return 'Anonyme';
                }
        }
        
        
        
        /**
        * 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) {
                                        case 'image':
                                                $where[] = ' '.$this->mappingFiltre[$idMasque].' = '.$this->gestionBdd->getBdd()->proteger($valeurMasque);                                                                                                             
                                        break;
                                        case 'protocole':
                                                //TODO : ajouter le protocole ? $where[] = ' '.$this->mappingFiltre[$idMasque].' = '.$this->gestionBdd->getBdd()->proteger($valeurMasque).' ';                                                                                                        
                                        break;
                                        default:
                                                $where[] = ' '.$this->mappingFiltre[$idMasque].' = '.$this->gestionBdd->getBdd()->proteger($valeurMasque);
                                        break;
                                }
                        }       
                }
                if (!empty($where)) {
                        return ' AND '.implode('AND', $where);
                } else {
                        return;
                }
        }
        
}