Subversion Repositories eFlore/Applications.del

<?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>

 * @author AUrélien PERONNET <aurelien@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, Jean-Pascal MILCENT

 */

abstract class Del {

	const SQL_MODE_ASSOC = PDO::FETCH_ASSOC;

	const SQL_RETOUR_COMPLET = 'All';

	const SQL_RETOUR_LIGNE = 'Row';

	const SQL_RETOUR_COLONNE = 'Column';

	const SQL_RETOUR_BRUT = 'Raw';

	public $config;

	private $ressources;

	protected $parametres = array();

	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']);

		// Nettoyage du _GET (sécurité)

		$this->collecterParametres();// Récupération de tous les parametres de _GET, nettoyage et mise dans $this->parametres

		$this->recupererParametresUrl();// Vidage de _GET et création d'attribut de la classe

		$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 connecterPDOSiNecessaire() {

		if($this->bdd == null) {

			// Connection à la base de données

			$this->bdd = $this->connecterPDO($this->config, 'database');

		}

	}

	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'"));

			// Affiche les erreurs détectées par PDO (sinon mode silencieux => aucune erreur affiché)

			$PDO->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);

		} catch (PDOException $e) {

    		echo 'La connexion à la base de donnée via PDO a échouée : ' .$dsn. $e->getMessage();

		}

        return $PDO;

	}

	/**

	 * Protège automatiquement toutes les chaines comprises entre deux caractères '|'.

	 * Puis execute la requete.

	 * @see protegerRequete()

	 * @param unknown_type $requete

	 */

	protected function requeter($requete, $retour = self::SQL_RETOUR_COMPLET, $mode = PDO::FETCH_ASSOC) {

		$requete = $this->protegerRequete($requete);

		return $this->executerRequete($requete, $retour, $mode);

	}

	/**

	 * Protège automatiquement toutes les chaines comprises entre deux caractères '|'.

	 * @see protegerRequete()

	 * @param unknown_type $requete

	 */

	protected function executer($requete) {

		$requete = $this->protegerRequete($requete);

		return $this->executerRequeteSimple($requete);

	}

	/**

	 * Méthode permettant de rechercher dans une requete SQL sous forme de chaine (String) les chaines

	 * à protéger. Cela évite de protéger chaque variable avant de l'insérer dans une requete SQL.

	 * Par contre, il est important que les chaine à protéger ne contiennent pas le caractère '|'.

	 *

	 * @param $requete

	 */

	protected function protegerRequete($requete) {

		$this->connecterPDOSiNecessaire();

		if (substr_count($requete, '|') % 2 === 0) {

			if (preg_match_all('/\|([^|]*)\|/', $requete, $correspondances, PREG_SET_ORDER)) {

				foreach ($correspondances as $chaine) {

					$chaine_protegee = $this->bdd->quote($chaine[1]);

					$requete = str_replace($chaine[0], $chaine_protegee, $requete);

				}

			}

		} else {

			$this->messages[] = "La requête a protéger contient un nombre impair de caractère de protection '|'.";

			$requete = false;

		}

		return $requete;

	}

	protected function proteger($chaine) {

		$this->connecterPDOSiNecessaire();

		return $this->bdd->quote($chaine);

	}

	protected function protegerTableau(Array $tableau) {

		foreach ($tableau as $id => $val) {

			$tableau[$id] = $this->proteger($val);

		}

		return $tableau;

	}

	/**

	 * @deprecated utiliser executer() à la place

	 * @see executer()

	 */

	protected function executerRequeteSimple($requete) {

		$this->connecterPDOSiNecessaire();

		$resultat = false;

		try {

			$resultat = $this->bdd->exec($requete);

			if ($resultat === false) {

				$this->debug[] = "La requête a échoué : $requete";

			}

		} catch (PDOException $e) {

			$this->debug[] = sprintf($this->getTxt('sql_erreur_requete'), $e->getFile(), $e->getLine(), $e->getMessage(), $requete);

		}

		return $resultat;

	}

	/**

	 * @deprecated utiliser requeter() à la place

	 * @see requeter()

	 */

	protected function executerRequete($requete, $retour = self::SQL_RETOUR_COMPLET, $mode = PDO::FETCH_ASSOC) {

		$this->connecterPDOSiNecessaire();

		$resultat = false;

		try {

			switch ($retour) {

				case self::SQL_RETOUR_COMPLET :

					$resultat = $this->bdd->query($requete)->fetchAll($mode);// Retourne toutes les lignes

					break;

				case self::SQL_RETOUR_LIGNE :

					$resultat = $this->bdd->query($requete)->fetch($mode);// Retourne la première ligne

					break;

				case self::SQL_RETOUR_COLONNE :

					$resultat = $this->bdd->query($requete)->fetchColumn();// Retourne la première colonne de la première ligne

					break;

				case self::SQL_RETOUR_BRUT :

					$resultat = $this->bdd->query($requete);// Retourne l'objet brut pour être utilisé dans une boucle de type foreach

					break;

				default:

					$this->debug[] = "Le type de retour '$retour' est inconnu.";

			}

			if ($resultat === false) {

				$this->debug[] = "La requête a retourné aucun résultat : $requete";

			}

		} catch (PDOException $e) {

			$this->debug[] = 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 collecterParametres() {

		if (isset($_GET) && $_GET != '') {

			foreach ($_GET as $cle => $valeur) {

				$this->parametres[$cle] = $this->verifierSecuriteParametreUrl($valeur);

			}

		}

	}

	private function recupererParametresUrl() {

		if (isset($_GET)) {

			$get_params = array('orderby', 'distinct', 'start', 'limit', 'formatRetour');

			foreach ($get_params as $get) {

				if (isset($_GET[$get])) {

					$_GET[$get] = $this->verifierSecuriteParametreUrl($_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;

					}

				}

			}

		}

	}

	protected function verifierSecuriteParametreUrl($param) {

		$verifier = array('NULL', "\n", "\r", "\\", "'", '"', "\x00", "\x1a", ';');

		$param = strip_tags(str_replace($verifier, '', $param));

		return $param;

	}

	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'ENVOI au NAVIGATEUR

	protected function envoyerJson($donnees, $encodage = 'utf-8') {

		$encodage_json = true;

		$this->envoyer($donnees, 'application/json', $encodage, $encodage_json);

	}

	protected function envoyerJsonVar($variable, $donnees = null, $encodage = 'utf-8') {

		$contenu = "var $variable = ".json_encode($donnees);

		$this->envoyer($contenu, 'text/html', $encodage);

	}

	protected function envoyerJsonp($donnees = null, $encodage = 'utf-8') {

		$contenu = $this->parametres['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');

			$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 (!isset($this->dao)) {

			$this->dao = new Dao($url_services_distant);

		} else {

			$this->dao->url_jrest = $url_services_distant;

		}

	}

	//+----------------------------------------------------------------------------------------------------------------+

	// GESTION DU LOG

	public function logger($index,$chaine) {

		Log::getInstance();

		Log::setCheminLog($this->config['log']['cheminlog']);

		Log::setTimeZone($this->config['log']['timezone']);

		Log::setTailleMax($this->config['log']['taillemax']);

		Log::ajouterEntree($index,$chaine);

	}

	//+----------------------------------------------------------------------------------------------------------------+

	// GESTION DE MÉTHODES COMMUNES ENTRE LES SERVICES

	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', '&', $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;

	}

	protected function convertirDateHeureMysqlEnTimestamp($date_heure_mysql){

       $val = explode(' ', $date_heure_mysql);

       $date = explode('-', $val[0]);

       $heure = explode(':', $val[1]);

       return mktime((int) $heure[0], (int) $heure[1], (int) $heure[2], (int) $date[1], (int) $date[2], (int) $date[0]);

	}

	protected function formaterChaineMinusculeSansAccents($chaine) {

		$chaine = $this->supprimerAccents($chaine);

		$chaine = str_replace(' ','_',$chaine);

		$chaine = str_replace('-','_',$chaine);

		return mb_strtolower($chaine);

	}

	protected function supprimerAccents($str, $charset='utf-8') {

		$str = htmlentities($str, ENT_NOQUOTES, $charset);

		$str = preg_replace('#&([A-za-z])(?:acute|cedil|circ|grave|orn|ring|slash|th|tilde|uml);#', '\1', $str);

		$str = preg_replace('#&([A-za-z]{2})(?:lig);#', '\1', $str); // pour les ligatures e.g. 'œ'

		$str = preg_replace('#&[^;]+;#', '', $str); // supprime les autres caractères

		return $str;

	}

	protected function etreNull($valeur) {

		$etre_null = false;

		if ($valeur == '' || $valeur == null || $valeur == '000null' || $valeur == 'null' || $valeur == '*') {

			$etre_null = true;

		}

		return $etre_null;

	}

	protected function formaterDate($date_heure_mysql, $format = '%A %d %B %Y à %H:%M') {

		$date_formatee = '';

		if (!$this->etreNull($date_heure_mysql)) {

			$timestamp = $this->convertirDateHeureMysqlEnTimestamp($date_heure_mysql);

			$date_formatee = strftime($format, $timestamp);

		}

		return $date_formatee;

	}

	protected function traiterValeursMultiples($valeurs, $separateur_entree = ',' , $separateur_sortie = ',') {

		if (! $this->etreNull($valeurs)) {

			$valeurs_a_proteger = explode($separateur_entree,trim(trim($valeurs), $separateur_entree));

			foreach ($valeurs_a_proteger as $valeur) {

				$valeurs_protegees[] = $this->bdd->quote($valeur);

			}

			$valeurs = implode($separateur_sortie, $valeurs_protegees);

		}

		return ($this->etreNull($valeurs)) ? null : $valeurs;

	}

	//+----------------------------------------------------------------------------------------------------------------+

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

	}

}

?>