Subversion Repositories eFlore/Applications.cel

<?php
/**
 * Classe mère abstraite contenant les méthodes génériques des services.
 * Encodage en entrée : utf8
 * Encodage en sortie : utf8
 *
 * @author Jean-Pascal MILCENT <jpm@clapas.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, Jean-Pascal MILCENT
 */
abstract class Cel {
        const TYPE_OBS = 'observation';
        const TYPE_IMG = 'image';
        
        public $config;
        public $parametres;
        protected $bdd;
        protected $messages = array();
        protected $debug = array();

        public function __construct($config) {
                // Tableau contenant la config de Jrest
                $this->config = $config;

                // Réglages de PHP
                setlocale(LC_ALL, $this->config['settings']['locale']);
                date_default_timezone_set($this->config['settings']['fuseauHoraire']);

                // Connection à la base de données
                $this->bdd = $this->connecterPDO($this->config, 'database_cel');
                
                // Nettoyage du _GET (sécurité)
                $this->recupererParametresUrl();
                $this->definirParametresUrlParDefaut();
                
                // Définition de variable générale dans la config
                $this->config['settings']['baseURLAbsoluDyn'] = 'http://'.$_SERVER['SERVER_NAME'].$this->config['settings']['baseURL'].'%s';
        }

        //+----------------------------------------------------------------------------------------------------------------+
        // GESTION de la BASE de DONNÉES

        private function connecterPDO($config, $base = 'database') {
        $cfg = $config[$base];
        // ATTENTION : la connexin à la bdd peut échouer si l'host vaut localhost. Utiliser 127.0.0.1 à la place.
                $dsn = $cfg['phptype'].':dbname='.$cfg['database'].';host='.$cfg['hostspec'];
                try {
                // Création de la connexion en UTF-8 à la BDD
                        $PDO = new PDO($dsn, $cfg['username'], $cfg['password'], array(PDO::MYSQL_ATTR_INIT_COMMAND => "SET NAMES 'UTF8'"));
                } catch (PDOException $e) {
                echo 'La connexion à la base de donnée via PDO a échouée : ' . $e->getMessage();
                }
                // Affiche les erreurs détectées par PDO (sinon mode silencieux => aucune erreur affiché)
                $PDO->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
        return $PDO;
        }
        
        protected function executerRequete($requete, $retour = 'All', $mode = PDO::FETCH_ASSOC) {
                try {
                        switch ($retour) {
                                case 'All' :
                                        $resultat = $this->bdd->query($requete)->fetchAll($mode);
                                        break;
                                case 'Column' :
                                        $resultat = $this->bdd->query($requete)->fetchColumn();
                                        break;
                                default:
                                        $resultat = false;
                                        $this->messages[] = "Le type de retour '$retour' est inconnu.";
                        }
                        if ($resultat === false) {
                                $this->messages[] = "La requête a retourné aucun résultat.";
                        }
                } catch (PDOException $e) {
                        $this->messages[] = sprintf($this->getTxt('sql_erreur_requete'), $e->getFile(), $e->getLine(), $e->getMessage(), $requete);
                }
                return $resultat;
        }

        protected function getTxt($id) {
                $sortie = '';
                switch ($id) {
                        case 'sql_erreur' : $sortie = 'Requête echec. Fichier : "%s". Ligne : "%s". Message : %s'; break;
                        case 'sql_erreur_requete' : $sortie = "Requête echec.\nFichier : %s.\nLigne : %s.\nMessage : %s.\nRequête : %s"; break;
                        default : $sortie = $id;
                }
                return $sortie;
        }

        //+----------------------------------------------------------------------------------------------------------------+
        // TRAITEMENT des URLs et des PARAMÊTRES
        
        private function recupererParametresUrl() {
                if (isset($_GET)) {
                        $get_params = array('orderby', 'distinct', 'start', 'limit', 'formatRetour');
                        foreach ($get_params as $get) {
                                if (isset($_GET[$get])) {
                                        $verifier = array('NULL', "\n", "\r", "\\", "'", '"', "\x00", "\x1a", ';');
                                        $_GET[$get] = strip_tags(str_replace($verifier, '', $_GET[$get]));
                                        if ($_GET[$get] != '') {
                                                if (!isset($this->$get)) {
                                                        $this->$get = $_GET[$get];
                                                } else {
                                                        $e = "Impossible d'ajouter l'attribut $get à la classe du service car elle possède déjà un attribut nommé : $get";
                                                        trigger_error($e, E_USER_WARNING);
                                                }
                                        } else {
                                                $_GET[$get] = null;
                                        }
                                }
                        }
                }
        }
        
        private function definirParametresUrlParDefaut() {
                if (!isset($this->start)) {
                        $this->start = 0;
                }
                if (!isset($this->limit)) {
                        $this->limit = 150;
                }
        }
        
        protected function traiterParametres($params_attendu, $params, $pourBDD = true) {
                $sortie = array();
                foreach ($params_attendu as $num => $nom) {
                        if (isset($params[$num]) && $params[$num] != '*') {
                                if ($pourBDD) {
                                        $params[$num] = $this->bdd->quote($params[$num]);
                                }
                                $sortie[$nom] = $params[$num];
                        }
                }
                return $sortie;
        }

        protected function traiterNomMethodeGet($nom) {
                $methode = 'get';
                $methode .= str_replace(' ', '', ucwords(str_replace('-', ' ', strtolower($nom))));
                return $methode;
        }

        //+----------------------------------------------------------------------------------------------------------------+
        // GESTION de l'ENVOIE au NAVIGATEUR

        protected function envoyerJson($variable, $donnees = null, $encodage = 'utf-8') {
                $contenu = "var $variable = ".json_encode($donnees);
                $this->envoyer($contenu, 'text/html', $encodage);
        }
        
        protected function envoyerJsonp($variable, $donnees = null, $encodage = 'utf-8') {
                $contenu = $_GET['callback'].'('.json_encode($donnees).');';
                $this->envoyer($contenu, 'text/html', $encodage);
        }

        protected function envoyer($donnees = null, $mime = 'text/html', $encodage = 'utf-8', $json = false) {
                // Traitements des messages d'erreurs et données
                if (count($this->messages) != 0) {
                        header('HTTP/1.1 500 Internal Server Error');
                        $mime = 'text/html';
                        $encodage = 'utf-8';
                        $json = true;
                        $sortie = $this->messages;
                } else {
                        $sortie = $donnees;
                        if (is_null($donnees)) {
                                $sortie = 'OK';
                        }
                }

                // Gestion de l'envoie du déboguage
                $this->envoyerDebogage();

                // Encodage au format et JSON et envoie sur la sortie standard
                $contenu = $json ? json_encode($sortie) : $sortie;
                $this->envoyerContenu($encodage, $mime, $contenu);
        }

        private function envoyerDebogage() {
                if (!is_array($this->debug)) {
                        $this->debug[] = $this->debug;
                }
                if (count($this->debug) != 0) {
                        foreach ($this->debug as $cle => $val) {
                                if (is_array($val)) {
                                        $this->debug[$cle] = print_r($val, true);
                                }
                        }
                        header('X-DebugJrest-Data:'.json_encode($this->debug));
                }
        }

        private function envoyerContenu($encodage, $mime, $contenu) {
                if (!is_null($mime) && !is_null($encodage)) {
                        header("Content-Type: $mime; charset=$encodage");
                } else if (!is_null($mime) && is_null($encodage)) {
                        header("Content-Type: $mime");
                }
                print $contenu;
        }
        
        private function envoyerAuth($message_accueil, $message_echec) {
                header('HTTP/1.0 401 Unauthorized');
                header('WWW-Authenticate: Basic realm="'.mb_convert_encoding($message_accueil, 'ISO-8859-1', 'UTF-8').'"');
                header('Content-type: text/plain; charset=UTF-8');
                print $message_echec;
                exit(0);
        }
        
        //+----------------------------------------------------------------------------------------------------------------+
        // GESTION DU DAO
        
        protected function getDao() {
                if (isset($this->dao)) {
                        return $this->dao;      
                } else {
                        $e = "Le DAO n'a pas été initialisé. Utiliser la méthode initialiserDao().";
                        trigger_error($e, E_USER_WARNING);
                }
        }
        
        protected function initialiserDao($url_services_distant) {
                if (is_null($this->dao)) {
                        $this->dao = new CelDao($url_services_distant);
                } else {
                        $this->dao->url_jrest = $url_services_distant;
                }
        }
        
        //+----------------------------------------------------------------------------------------------------------------+
        // GESTION DE L'IDENTIFICATION
        
        public function authentifier() { 
                $message_accueil = "Veuillez vous identifier avec votre compte Tela Botanica.";
                $message_echec = "Accès limité aux administrateurs du CEL.\n".
                        "Votre tentative d'identification a échouée.\n".
                        "Actualiser la page pour essayer à nouveau.";
                if (!isset($_SERVER['PHP_AUTH_USER'])) {
                        $this->envoyerAuth($message_accueil, $message_echec);
                } else {
                        if ($this->etreAutorise($_SERVER['PHP_AUTH_USER']) == false) {
                                $this->envoyerAuth($message_accueil, $message_echec);
                        }
                }
                return true;
        }
    
        public function etreAutorise($identifiant) {
                $this->initialiserDao('http://www.tela-botanica.org/client/annuaire_nouveau/actuelle/jrest/');
                $mdp = md5($_SERVER['PHP_AUTH_PW']);
                $url = $this->getDao()->url_jrest."TestLoginMdp/$identifiant/$mdp";
                $json = $this->getDao()->envoyerRequeteConsultation($url);
                $existe = json_decode($json);
                $autorisation = false; 
                if ($existe == true && $this->etreAdminCel($identifiant)) {
                        $autorisation = true;
                }
                return $autorisation;
        }
        
        public function etreAdminCel($courriel) {
                $admins = $this->config['jrest_admin']['admin'];
                $courriels_autorises = explode(',', $admins);

                $autorisation = (in_array($courriel, $courriels_autorises)) ? true : false ;
                return $autorisation;
        }

        //+----------------------------------------------------------------------------------------------------------------+
        // GESTION DE MÉTHODES COMMUNES ENTRE LES SERVICES
        
        protected function getUrlImage($id, $format = 'L') {
                $url_tpl = $this->config['settings']['celImgUrlTpl'];
                $id = sprintf('%09s', $id).$format;
                $url = sprintf($url_tpl, $id); 
                return $url;
        }
        
        protected function creerAuteur($courriel, $pourAdmin = false) {
                $auteur = ($pourAdmin) ? $courriel : $this->tronquerCourriel($courriel);
                return $auteur;
        }
        
        protected function tronquerCourriel($courriel) {
                $courriel = preg_replace('/[^@]+$/i', '...', $courriel);
                return $courriel;
        }
        
        protected function nettoyerTableau(Array $tableau) {
                foreach ($tableau as $cle => $valeur) {
                        if (is_array($valeur)) {
                                $valeur = $this->nettoyerTableau($valeur);
                        } else {
                                $valeur = $this->nettoyerTexte($valeur);
                        }
                        $tableau[$cle] = $valeur;
                }
                return $tableau;
        }
        
        /**
         * Fonction nettoyant les caractères spéciaux (&,<) et les valeurs nulles du CEL dans un texte comprenant du HTML.
         */
        protected function nettoyerTexte($txt) {
                $txt = preg_replace('/&(?!([a-z]+|#[0-9]+|#x[0-9][a-f]+);)/i', '&amp;', $txt);
                // TODO : trouver une regexp qui permet de remplacer les symboles < et > isolés
                //$txt = preg_replace('/<(?!([a-z][a-z0-9]*)\b[^>]*>(.*?)<\/\1>|\/\s*([a-z][a-z0-9]*)\s*>)/i', '&lt;', $txt);
                //$txt = preg_replace('/(?!<([a-z][a-z0-9]*)\b[^>]*)>(?!(.*?)<\/\1>)/i', '&gt;', $txt);
                $txt = preg_replace('/(?:000null|null)/i', '', $txt);
                return $txt;
        }
        
        /**
         * Fonction nettoyant les caractères spéciaux HTML pour les champs de saisie libre du CEL.
         */
        protected function protegerCaracteresHtmlDansChamps($donnees) {
                $champs = array('ci_meta_mots_cles', 'ci_meta_comment', 
                        'mots_cles', 'location', 'lieudit', 'station', 'milieu', 'commentaire', 'nom_sel');
                foreach ($champs as $champ) {
                        if (isset($donnees[$champ])) {
                                $donnees[$champ] = htmlspecialchars($donnees[$champ]);
                        }
                }
                return $donnees;
        }
        
        protected function convertirDateHeureMysqlEnTimestamp($date_heure_mysql){
       $val = explode(' ', $date_heure_mysql);
       $date = explode('-', $val[0]);
       $heure = explode(':', $val[1]);
       return mktime($heure[0], $heure[1], $heure[2], $date[1], $date[2], $date[0]);
        }
        
        protected function etreNull($valeur) {
                $etre_null = false;
                if ($valeur == '' || $valeur == null || $valeur == '000null' || $valeur == 'null') {
                        $etre_null = true;
                }
                return $etre_null;
        }
        
        protected function formaterDate($date, $format = '%A %d %B %Y à %H:%M') {
                return strftime($format, strtotime($date));
        }
        
        protected function encoderMotCle($mot_cle) {
                return md5(mb_strtolower($mot_cle));
        }
        
        protected function decoderMotsClesObs($utilisateur_id, $mots_cles) {
                return $this->decoderMotsCles($utilisateur_id, $mots_cles, self::TYPE_OBS);
        }
        
        protected function decoderMotsClesImg($utilisateur_id, $mots_cles) {
                return $this->decoderMotsCles($utilisateur_id, $mots_cles, self::TYPE_IMG);
        }
        
        private function decoderMotsCles($utilisateur_id, $mots_cles, $type) {
                $mots = array();
                if (! $this->etreNull($mots_cles)) {
                        $utilisateur_id = $this->bdd->quote($utilisateur_id);
                        
                        $mots_cles = $this->protegerMotsCles($mots_cles, $type);
                        
                        $table = ($type == self::TYPE_IMG) ? 'cel_mots_cles_images' : 'cel_mots_cles_obs' ;
                        
                        $requete = 'SELECT cmc_mot_cle '.
                                "FROM $table ".
                                "WHERE cmc_id_mot_cle_utilisateur IN ($mots_cles) ".
                                "AND cmc_id_proprietaire = $utilisateur_id ";
                        
                        $elements = $this->executerRequete($requete);
                        
                        foreach ($elements as $mot) {
                                $mots[] = $mot['cmc_mot_cle'];
                        }
                }
                return $mots;
        }
        
        private function protegerMotsCles($mots_cles, $type) {
                $separateur = ($type == self::TYPE_IMG) ? ',' : ';' ;
                $mots_cles_a_proteger = explode($separateur,rtrim(trim($mots_cles), $separateur));
                foreach ($mots_cles_a_proteger as $mot) {
                        $mots_cles_proteges[] = $this->bdd->quote($mot);
                }
                $mots_cles = implode(',', $mots_cles_proteges);
                return $mots_cles;
        }
        
        //+----------------------------------------------------------------------------------------------------------------+
        // GESTION DES SQUELETTES PHP

        /**
         * Méthode prenant en paramètre un chemin de fichier squelette et un tableau associatif de données,
         * en extrait les variables, charge le squelette et retourne le résultat des deux combinés.
         *
         * @param String $fichier       le chemin du fichier du squelette
         * @param Array  $donnees       un tableau associatif contenant les variables a injecter dans le squelette.
         *
         * @return boolean false si le squelette n'existe pas, sinon la chaine résultat.
         */
        public static function traiterSquelettePhp($fichier, Array $donnees = array()) {
                $sortie = false;
                if (file_exists($fichier)) {
                        // Extraction des variables du tableau de données
                        extract($donnees);
                        // Démarage de la bufferisation de sortie
                        ob_start();
                        // Si les tags courts sont activés
                        if ((bool) @ini_get('short_open_tag') === true) {
                                // Simple inclusion du squelette
                                include $fichier;
                        } else {
                                // Sinon, remplacement des tags courts par la syntaxe classique avec echo
                                $html_et_code_php = self::traiterTagsCourts($fichier);
                                // Pour évaluer du php mélangé dans du html il est nécessaire de fermer la balise php ouverte par eval
                                $html_et_code_php = '?>'.$html_et_code_php;
                                // Interprétation du html et du php dans le buffer
                                echo eval($html_et_code_php);
                        }
                        // Récupèration du contenu du buffer
                        $sortie = ob_get_contents();
                        // Suppression du buffer
                        @ob_end_clean();
                } else {
                        $msg = "Le fichier du squelette '$fichier' n'existe pas.";
                        trigger_error($msg, E_USER_WARNING);
                }
                // Retourne le contenu
                return $sortie;
        }

        /**
         * Fonction chargeant le contenu du squelette et remplaçant les tags court php (<?= ...) par un tag long avec echo.
         *
         * @param String $chemin_squelette le chemin du fichier du squelette
         *
         * @return string le contenu du fichier du squelette php avec les tags courts remplacés.
         */
        private static function traiterTagsCourts($chemin_squelette) {
                $contenu = file_get_contents($chemin_squelette);
                // Remplacement de tags courts par un tag long avec echo
                $contenu = str_replace('<?=', '<?php echo ',  $contenu);
                // Ajout systématique d'un point virgule avant la fermeture php
                $contenu = preg_replace("/;*\s*\?>/", "; ?>", $contenu);
                return $contenu;
        }
}