Subversion Repositories eFlore/Applications.cel

<?php
/**
 * Service fournissant des informations concernant les images du CEL au format RSS1, RSS2 ou ATOM.
 * Encodage en entrée : utf8
 * Encodage en sortie : utf8
 * 
 * @author Jean-Pascal MILCENT <jpm@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 CelSyndicationImage extends Cel {
        
        private $format = null;
        private $service = null;
        private $squelette = null;
        private $squelette_dossier = null;
        private $flux = array();
        
        private $format_image = 'L';
        
        /**
         * Méthode appelée avec une requête de type GET.
         */
        public function getElement($params = array()) {
                // Initialisation des variables
                $info = array();
                $contenu = '';
                
                if (! $this->etreFluxAdmin() || $this->authentifier()) {
                        // Pré traitement des paramêtres
                        $pour_bdd = false;
                        $p = $this->traiterParametres(array('service', 'format'), $params, $pour_bdd);
                        extract($p);
                        $this->parametres = $params;
                        $this->squelette_dossier = dirname(__FILE__).DIRECTORY_SEPARATOR.'squelettes'.DIRECTORY_SEPARATOR;
                        
                        // Récupération de la liste des flux
                        $this->chargerListeDesFlux();
                        
                        // Chargement du bon type de service demandé
                        if (isset($service)) {
                                $this->service = $this->traiterNomService($service);
                                $methode = $this->getNomMethodeService();
                                if (method_exists($this, $methode)) {
                                        if (isset($format) && preg_match('/^(?:rss1|rss2|atom)$/i', $format)) {
                                                // Mise en minuscule de l'indication du format
                                                $this->format = strtolower($format);
                                                // Définition du fichier squelette demandé
                                                $this->squelette = $this->squelette_dossier.$this->format.'.tpl.xml';
                                        } else if (isset($this->flux[$this->service])) {
                                                $this->format = '';
                                                $this->messages[] = "Le service CEL Syndication nécessite d'indiquer en second paramètre le format : rss1, rss2 ou atom.";
                                        }
                                        
                                        if (!isset($this->flux[$this->service]) || isset($this->format)) {
                                                // Suppression des paramêtres inutile pour le reste des méthodes
                                                array_shift($this->parametres);
                                                array_shift($this->parametres);
                                                
                                                // Récupération du contenu à renvoyer
                                                $contenu = $this->$methode();
                                        }
                                } else {
                                        $this->messages[] = "Le type d'information demandé '$this->service' n'est pas disponible.";
                                }
                        } else {
                                $this->messages[] = "Le service CEL Syndication Image nécessite d'indiquer en premier paramètre le type d'information demandé.";
                        }
                }
                
                // Envoie sur la sortie standard
                $encodage = 'utf-8';
                $mime = $this->getTypeMime();
                $formatage_json = $this->getFormatageJson();
                $this->envoyer($contenu, $mime, $encodage, $formatage_json);
        }
        
        private function chargerListeDesFlux() {
                $this->setFlux('simple', 'Nouvelles images liées à une observation dans le CEL', 
                        "Ce flux fournit l'url des nouvelles images du CEL liées à une observation.");
                $this->setFlux('complet', 'Nouvelles images liées à une observation dans le CEL (détails)', 
                        "Ce flux fournit les informations sur les nouvelles images du CEL liées à une observation.");
        }
        
        private function setFlux($nom, $titre, $description) {
                $url_base = $this->config['settings']['baseURLAbsoluDyn'].'CoelSyndicationImage/';
                $formats = array('atom', 'rss2', 'rss1');
                $flux = array();
                foreach ($formats as $format) {
                        $url = $url_base.$nom.'/'.$format;
                        $flux[$format] = $url;
                }
                $this->flux[$nom] = array('titre' => $titre, 'description' => $description, 'urls' => $flux);
        }

        private function getFlux($nom) {
                return isset($this->flux[$nom]) ? $this->flux[$nom] : array();
        }
        
        private function traiterNomService($nom) {
                $nom = strtolower($nom);
                return $nom;
        }
        
        private function getNomMethodeService() {
                $methode = '';
                $service_formate = str_replace(' ', '', ucwords(implode(' ', explode('-', $this->service))));
                $methode = 'getService'.$service_formate;
                return $methode;
        }
        
        private function getUrlBase() {
                $url_base = sprintf($this->config['settings']['baseURLAbsoluDyn'], get_class($this).'/');
                return $url_base;
        }
        
        private function getUrlServiceBase() {
                $url_service = $this->getUrlBase().$this->service.'/'.$this->format;
                return $url_service;
        }
        
        private function getTypeMime() {
                $mime = '';
                switch ($this->format) {
                        case 'atom' :
                                $mime = 'application/atom+xml';
                                break;
                        case 'rss1' :
                        case 'rss2' :
                                $mime = 'application/rss+xml';
                                break;
                        case 'opml' :
                                $mime = 'text/x-opml';
                                break;
                        default:
                                $mime = 'text/html';
                }
                return $mime;
        }
        
        private function getFormatageJson() {
                $json = false;
                switch ($this->service) {
                        case 'liste-des-flux' :
                                $json = true;
                                break;
                        default:
                                $json = false;
                }
                return $json;
        }
                
        private function etreFluxAdmin() {
                return ($_GET['admin'] == '1') ? true : false;
        }
        
        private function creerUrlService() {
                $url_service = $this->getUrlServiceBase();
                if (isset($this->start) || isset($this->limit)) {
                        $arguments = array();
                        if (isset($this->start) && isset($_GET['start'])) {
                                $arguments[] = 'start='.$this->start;
                        }
                        if (isset($this->limit) && isset($_GET['limit'])) {
                                $arguments[] = 'limit='.$this->limit;
                        }
                        if (count($arguments) > 0) {
                                $url_service .= '?'.implode('&', $arguments);
                        }
                }
                return $url_service;
        }
        
        protected function executerRequete($requete) {
                try {
                        $infos = $this->bdd->query($requete)->fetchAll(PDO::FETCH_ASSOC);
                        if ($infos === false) {
                                $this->messages[] = "La requête suivante a retourné aucun résultat :\n$requete";
                        }
                } catch (PDOException $e) {
                        $this->messages[] = sprintf($this->getTxt('sql_erreur'), $e->getFile(), $e->getLine(), $e->getMessage());
                }
                return $infos;
        }
        
        private function executerService($elements) {
                // Prétraitement des données
                $donnees = $this->construireDonneesCommunesAuFlux($elements);
                
                foreach ($elements as $element) {
                        $donnees['items'][] = $this->construireDonneesCommunesAuxItems($element);
                }
                
                // Création du contenu à partir d'un template PHP
                $contenu = Cel::traiterSquelettePhp($this->squelette, $donnees);
                
                return $contenu;
        }
        
        private function construireDonneesCommunesAuFlux($infos) {
                $donnees = $this->getFlux($this->service);
                $donnees['guid'] = $this->getUrlServiceBase();
                $donnees['lien_service'] = $this->creerUrlService();
                $donnees['lien_cel'] = sprintf($this->config['settings']['efloreUrlTpl'], $infos['num_nom_sel']);
                $donnees['editeur'] = $this->config['settings']['editeur'];
                $derniere_info_en_date = reset($infos);
                $date_modification_timestamp = strtotime($derniere_info_en_date['ci_meta_date_ajout']);
                $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'] = 'CEL - Jrest - CelSyndicationImage';
                preg_match('/([0-9]+)/', '$Revision$', $match);
                $donnees['generateur_version'] = $match[1];
                return $donnees; 
        }
        
        private function construireDonneesCommunesAuxItems($info) {
                $item = array();
                $date_modification_timestamp = strtotime($info['ci_meta_date_ajout']);
                $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['description'] = $this->creerDescription($info, $item);
                $item['description_encodee'] = htmlspecialchars($item['description']);
                return $item;
        }
        
        private function creerGuidItem($element) {
                $guid = sprintf($this->config['settings']['guidImgTpl'], $element['ci_id_image']);
                return $guid;
        }
        
        private function creerTitre($element) {
                $methode = 'creerTitre'.$this->service;
                $methode = (method_exists($this, $methode)) ? $methode : 'creerTitreSimple';
                $titre = $this->$methode($element);
                $titre = $this->nettoyerTexte($titre);
                return $titre;
        }
        
        private function creerDescription($donnees, $item) {
                $methode = 'creerDescription'.$this->service;
                $methode = (method_exists($this, $methode)) ? $methode : 'creerDescriptionSimple';
                $description = $this->$methode($donnees, $item);
                $description = $this->nettoyerTexte($description);
                return $description;
        }

        private function creerLienItem($element) {
                $lien = $this->getUrlImage($element['ci_id_image'], $this->format_image);
                return $lien;
        }
        
        private function getServiceListeDesFlux() {
                return $this->flux;
        }
        
        private function getServiceOpml() {
                $donnees = array();
                $id = 1;
                foreach ($this->flux as $flux_nom => $flux){
                        $info = array();
                        $info['type'] = 'atom';
                        $info['titre'] = $flux['titre'];
                        $info['texte'] = "CEL - Images - $flux_nom";
                        $info['description'] = $flux['description'];
                        $info['url_xml'] = $this->getUrlBase().$flux_nom.'/atom';
                        $info['url_html'] = $this->config['settings']['aideCelUrl'].'FluxSyndication';
                        $donnees['liste_flux'][] = $info;
                }
                
                $this->squelette = $this->squelette_dossier.'opml.tpl.xml';
                $contenu = Cel::traiterSquelettePhp($this->squelette, $donnees);
                return $contenu;
        }
        
        private function getServiceSimple() {
                if (isset($this->parametres[0])) {
                        $this->format_image = $this->parametres[0];
                }
                
                // Construction de la requête
                $requete =      (($this->distinct) ? 'SELECT DISTINCT' : 'SELECT').' ci.*, ci_id_image, ci_nom_original '.
                        'FROM cel_obs_images AS coi '.
                        'LEFT JOIN cel_inventory AS ci '.
                                'ON (coi.coi_ce_observation = ci.ordre AND coi.coi_ce_utilisateur = ci.identifiant) '.
                        'LEFT JOIN cel_images AS cim '.
                                'ON (coi.coi_ce_image = cim.ci_id_image AND coi.coi_ce_utilisateur = cim.ci_ce_utilisateur) '.  
                        'WHERE ci.transmission = 1 '.
                        '       AND ci.identifiant = cim.ci_ce_utilisateur '.
                        'ORDER BY '.((!is_null($this->orderby)) ? $this->orderby  : 'ci_meta_date_ajout DESC').' '.
                        "LIMIT $this->start, $this->limit ";
                
                $elements = $this->executerRequete($requete);
                
                // Création du contenu
                $contenu = $this->executerService($elements);
                return $contenu;
        }
        
        private function creerTitreSimple($element) {
                $titre = $element['nom_sel'].' [nn'.$element['num_nom_sel'].'] par '.$this->creerAuteur($element['identifiant'], $this->etreFluxAdmin());
                return $titre;
        }
        
        private function creerDescriptionSimple($donnees, $item) {
                $description = sprintf($this->config['settings']['efloreUrlTpl'], urlencode($donnees['num_nom_sel']));
                return $description;
        }
        
        private function getServiceComplet() {
                // Construction de la requête
                $requete =      (($this->distinct) ? 'SELECT DISTINCT' : 'SELECT').' ci.*, ci_id_image, ci_nom_original, ci_meta_date_ajout, ci_meta_user_comment, ci_note_image '.
                        'FROM cel_obs_images AS coi '.
                        'LEFT JOIN cel_inventory AS ci '.
                                'ON (coi.coi_ce_observation = ci.ordre AND coi.coi_ce_utilisateur = ci.identifiant) '.
                        'LEFT JOIN cel_images AS cim '.
                                'ON (coi.coi_ce_image = cim.ci_id_image AND coi.coi_ce_utilisateur = cim.ci_ce_utilisateur) '.  
                        'WHERE ci.transmission = 1 '.
                        '       AND ci.identifiant = cim.ci_ce_utilisateur '.
                        'ORDER BY '.((!is_null($this->orderby)) ? $this->orderby  : 'ci_meta_date_ajout DESC').' '.
                        "LIMIT $this->start, $this->limit ";
                
                $elements = $this->executerRequete($requete);
                
                // Création du contenu
                $contenu = $this->executerService($elements);
                return $contenu;
        }

        private function creerDescriptionComplet($donnees, $item) {
                $url_img = $this->getUrlImage($donnees['ci_id_image'], 'M');
                $description .= '<style>.champ{color:grey} img{float:left;padding:0 20px 0 0;}</style>';
                $description .= '<img src="'.$url_img.'" alt="'.$donnees['ci_nom_original'].'" />';
                $description .= '<ul>';
                $description .= '<li>'."Image liée à l'observation ".$donnees['id'].'</li>';
                $description .= '<li>'.'<span class="champ">Importée le :</span> '.$item['date_maj_simple'].'</li>';
                $description .= '<li>'.'<span class="champ">Nom du fichier :</span> '.$donnees['ci_nom_original'].'</li>';
                $description .= '<li>'.'<span class="champ">Note qualité image :</span> '.($donnees['ci_note_image'] +1).'/5</li>';
                // TODO :traiter le problème du champ commentaire.
                //$description .= '<li>'.'<span class="champ">Commentaire :</span> '.$donnees['ci_meta_user_comment'].'</li>';
                
                $description .= '<li>'.'<span class="champ">Nom saisi :</span> '.$donnees['nom_sel'].'</li>';
                $description .= '<li>'.'<span class="champ">Nom retenu :</span> '.$donnees['nom_ret'].'</li>';
                $description .= '<li>'.'<span class="champ">Observée le :</span> '.strftime('%A %d %B %Y', strtotime($donnees['date_observation'])).'</li>';
                $description .= '<li>'.'<span class="champ">Lieu :</span> '.$donnees['location'].' ('.$donnees['id_location'].') '.$donnees['station'].' '.$donnees['lieudit'].'</li>';
                $description .= '</ul>';
                $description = $this->nettoyerTexte($description);
                return $description;
        }
}