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();
        }

        /**
         * 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'] = 'pictoFlora : tags';
                $donnees['description'] = 'Ce flux regroupe les derniers tags des 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->formaterNomTagueur($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) {
                $tag = $element['tag'];
                $nomSel = htmlspecialchars($element['nom_sel']);
                $tagueur = htmlspecialchars($this->creerTagueur($element));
                $titre = "Tag «{$tag}» ($nomSel) par $tagueur";
                return $titre;
        }

        private function creerDescription($donnees, $item) {
                $idImg = htmlspecialchars($donnees['id_image']);
                $urlImg = $this->getUrlImage($donnees['id_image']);
                $miniatureUrl = $this->getUrlImage($donnees['id_image'], 'CRX2S');
                $proposition = htmlspecialchars($donnees['nom_sel']);
                //$protocole = htmlspecialchars($donnees['intitule']);
                $tag = $donnees['tag'];
                $auteur = htmlspecialchars($this->creerAuteurImg($donnees));
                $tagueur = htmlspecialchars($this->creerTagueur($donnees));

                $description =
                        '<ul>'.
                                '<li>'.
                                '       <a href="'.$urlImg.'">'.
                                '               <img src="'.$miniatureUrl.'" alt="Img #'.$idImg.'"/>'.
                                '               Image #'.$idImg.
                                '       </a>'.
                                '</li>'.
                                "<li>Auteur de l'image : $auteur</li>".
                                "<li>Proposition : <em>$proposition</em></li>".
                                // TODO : ajouter le protocole ? "<li>Protocole : $protocole</li>".
                                "<li>Tag : $tag</li>".
                                "<li>Auteur du tag : $tagueur</li>".
                        '</ul>';
                return $description;
        }

        private function getUrlImage($id, $format = 'L') {
                $url_tpl = $this->conteneur->getParametre('celImgUrlTpl');
                $id = sprintf('%09s', $id).$format;
                $url = sprintf($url_tpl, $id);
                return $url;
        }

        private function creerAuteurImg($info) {
                $auteur = 'Anonyme';
                if ($info['auteur_prenom'] != '' && $info['auteur_nom'] != '') {
                        $auteur = $info['auteur_prenom'].' '.$info['auteur_nom'].
                                ($this->fluxAdminDemande() ? ' ('.$donnees['auteur_courriel'].')' : '');
                }
                return $auteur;
        }

        private function creerTagueur($info) {
                $tagueur = $this->formaterNomTagueur($info).
                        ($this->fluxAdminDemande() ? ' ('.$donnees['tagueur_courriel'].')' : '');
                return $tagueur;
        }

        private function formaterNomTagueur($info) {
                $tagueur = 'Anonyme';
                if ($info['tagueur_prenom'] != '' && $info['tagueur_nom'] != '') {
                        $tagueur = $info['tagueur_prenom'].' '.$info['tagueur_nom'];
                }
                return $tagueur;
        }

        /**
         * Retrouver les derniers votes image
         * */
        private function getDerniersVotesImage() {
                $requete =  'SELECT DISTINCT id_tag, tag, date, nom_sel, id_image, '.
                                '       duo.prenom AS tagueur_prenom, duo.nom AS tagueur_nom, duo.courriel AS tagueur_courriel, '.
                                '       du.prenom AS auteur_prenom, du.nom AS auteur_nom, du.courriel AS auteur_courriel '.
                                'FROM del_image_tag AS dit '.
                                '       INNER JOIN del_obs_image AS doi '.
                                '               ON ce_image = id_image '.
                                '       INNER JOIN del_observation AS do '.
                                '                       ON doi.id_observation = do.id_observation '.
                                '       LEFT JOIN del_utilisateur AS duo '.
                                '               ON do.ce_utilisateur = duo.id_utilisateur '.
                                '       LEFT JOIN del_utilisateur AS du '.
                                '               ON dit.ce_utilisateur = du.id_utilisateur '.
                                'WHERE actif = 1 '.
                                $this->chargerClauseWhere().' '.
                                'ORDER BY date DESC '.
                                'LIMIT '.$this->navigation->getDepart().','.$this->navigation->getLimite();
                $elements = $this->gestionBdd->getBdd()->recupererTous($requete);
                return $elements;
        }

        /**
        * 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);
                                $champMasque = $this->mappingFiltre[$idMasque];
                                $masqueMotif = $this->gestionBdd->getBdd()->proteger($valeurMasque);

                                switch ($idMasque) {
                                        case 'image':
                                        //TODO : ajouter le protocole ? case 'protocole':
                                        default:
                                                $where[] = " $champMasque = $masqueMotif ";
                                }
                        }
                }

                $conditionsTxt = (!empty($where)) ? ' AND '.implode('AND', $where) : '';
                return $conditionsTxt;
        }
}
?>