Subversion Repositories Applications.framework

Rev

Rev 274 | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
122 aurelien 1 
<?php
2 
//declare(encoding='UTF-8');
3 
/**
189 jpm 4 
 * Classe permettant de logger des messages dans les fichier situés dans le dossier de log.
129 aurelien 5 
 *
189 jpm 6 
 * @category	PHP 5.2
241 jpm 7 
 * @package	Framework
8 
 * @author		Aurélien PERONNET <aurelien@tela-botanica.org>
9 
 * @author		Jean-Pascal MILCENT <jpm@tela-botanica.org>
10 
 * @copyright	Copyright (c) 2009, Tela Botanica (accueil@tela-botanica.org)
11 
 * @license	http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt Licence CECILL
12 
 * @license	http://www.gnu.org/licenses/gpl.html Licence GNU-GPL
13 
 * @version	$Id: Log.php 274 2010-12-28 15:37:22Z jpm $
14 
 * @link		/doc/framework/
129 aurelien 15 
 */
122 aurelien 16 
class Log {
17 
 
241 jpm 18 
	/** Boolean indiquant si l'on doit utiliser les logs ou pas. */
175 aurelien 19 
	private static $logger = false;
20 
 
241 jpm 21 
	/** Tableau associatif stockant les descripteurs de fichiers. */
123 aurelien 22 
	private static $fichiersLog = array();
122 aurelien 23 
 
241 jpm 24 
	/** Chemin de base du dossier log de l'application. */
123 aurelien 25 
	private static $cheminLogs = '';
122 aurelien 26 
 
241 jpm 27 
	/** Booleen indiquant si l'on peut correctement écrire dans les fichiers de logs. */
123 aurelien 28 
	 private static $droitLogger = true;
122 aurelien 29 
 
241 jpm 30 
	/** Zone horaire (pour éviter des avertissements dans les dates). */
189 jpm 31 
	private static $timeZone = 'Europe/Paris';
122 aurelien 32 
 
241 jpm 33 
	/** Taille maximum d'un fichier de log avant que celui ne soit archivé (en octets). */
129 aurelien 34 
	private static $tailleMax = 10000;
35 
 
241 jpm 36 
	/** séparateur de dossier dans un chemin. */
123 aurelien 37 
	private static $sd = DIRECTORY_SEPARATOR;
122 aurelien 38 
 
241 jpm 39 
	/** Extension des fichiers de log. */
129 aurelien 40 
	private static $ext = '.log';
241 jpm 41 
 
42 
	/** Tableau des noms des paramètres à définir dans le fichier de config car obligatoirement nécessaire à cette classe.*/
274 jpm 43 
	private static $parametres_obligatoires = array('chemin_logs', 'i18n_timezone', 'log_taille_max', 'log_debogage');
129 aurelien 44 
 
241 jpm 45 
	/** Initialiser les logs par défaut, sans tenir comptes des paramêtres de config. */
189 jpm 46 
	public static function initialiser() {
129 aurelien 47 
		// gestion de la timezone pour éviter des erreurs
138 jpm 48 
		if (function_exists('date_default_timezone_set') && function_exists('date_default_timezone_get')) {
129 aurelien 49 
			date_default_timezone_set(self::$timeZone);
50 
		}
51 
 
175 aurelien 52 
		if (self::$logger && (!is_dir(self::$cheminLogs) || !is_writable(self::$cheminLogs))) {
129 aurelien 53 
			self::desactiverEcriture();
54 
		}
123 aurelien 55 
	}
189 jpm 56 
 
241 jpm 57 
	/** Configure le Log à partir des paramêtres de config. */
189 jpm 58 
	public static function configurer() {
241 jpm 59 
		Config::verifierPresenceParametres(self::$parametres_obligatoires);
189 jpm 60 
		self::$cheminLogs = Config::get('chemin_logs');
255 jpm 61 
		self::$timeZone = (Config::get('i18n_timezone') != '') ? Config::get('i18n_timezone') : self::$timeZone;
274 jpm 62 
		self::$tailleMax = (Config::get('log_taille_max') != '') ? Config::get('log_taille_max') : self::$tailleMax;
63 
		self::$logger = (Config::get('log_debogage') != '') ? Config::get('log_debogage') : self::$logger;
189 jpm 64 
		self::initialiser();
123 aurelien 65 
	}
122 aurelien 66 
 
123 aurelien 67 
	/**
68 
	 * Ajoute une entrée au log spécifié par le paramètre $nomFichier
69 
	 * @param string $nomFichier le nom du fichier dans lequel écrire
70 
	 */
189 jpm 71 
	public static function ajouterEntree($nomFichier, $entree, $mode = 'a+') {
72 
		if (self::$droitLogger) {
241 jpm 73 
			$date = "\n\n".date('d m Y H:i')."\n" ;
122 aurelien 74 
 
210 jpm 75 
			if (self::verifierOuvrirFichier($nomFichier, $mode)) {
76 
			   fwrite(self::$fichiersLog[$nomFichier], $date.$entree);
138 jpm 77 
			   self::verifierTailleFichierOuArchiver($nomFichier);
123 aurelien 78 
			} else {
129 aurelien 79 
				self::desactiverEcriture($nomFichier);
123 aurelien 80 
			}
81 
		}
82 
	}
122 aurelien 83 
 
123 aurelien 84 
	/**
85 
	 * Vide un fichier log indiqué
86 
	 * @param string $nomFichier le nom du fichier à vider
87 
	 */
88 
	public static function viderLog($nomFichier) {
163 aurelien 89 
		self::ajouterEntree($nomFichier, '', 'w');
123 aurelien 90 
	}
122 aurelien 91 
 
123 aurelien 92 
	/**
189 jpm 93 
	 * Vérifie la présence d'un fichier dans le tableau, ses droits d'écriture, l'ouvre si nécessaire.
94 
	 *
123 aurelien 95 
	 * @param string $nomFichier le nom du fichier dont on doit vérifier la présence
129 aurelien 96 
	 * @return boolean true si le fichier est ouvert ou maintenant accessible, false sinon
123 aurelien 97 
	 */
129 aurelien 98 
	public static function verifierOuvrirFichier($nomFichier,$mode) {
138 jpm 99 
		if (in_array($nomFichier, self::$fichiersLog)) {
100 
			if (is_writable(self::$cheminLogs.$nomFichier.self::$ext)) {
129 aurelien 101 
				return true;
102 
			}
103 
			return false;
104 
		} else {
105 
			$fp = @fopen(self::$cheminLogs.$nomFichier.self::$ext,$mode);
138 jpm 106 
			if ($fp && is_writable(self::$cheminLogs.$nomFichier.self::$ext)) {
129 aurelien 107 
				self::$fichiersLog[$nomFichier] = $fp;
108 
				return true;
109 
			}
110 
			return false;
123 aurelien 111 
		}
112 
	}
122 aurelien 113 
 
123 aurelien 114 
	/**
129 aurelien 115 
	 * Vérifie la taille d'un fichier donné et si celle ci est trop importante
116 
	 * archive le fichier de log
117 
	 * @param string $nomFichier nom du fichier à vérifier
118 
	 */
119 
	private static function verifierTailleFichierOuArchiver($nomFichier) {
120 
		if(filesize(self::$cheminLogs.$nomFichier.self::$ext) > self::$tailleMax) {
121 
			rename(self::$cheminLogs.$nomFichier.self::$ext,self::$cheminLogs.$nomFichier.date('d_m_Y_H:i').self::$ext);
163 aurelien 122 
			self::ajouterEntree($nomFichier,'');
129 aurelien 123 
		}
124 
	}
125 
 
126 
	/**
123 aurelien 127 
	 * Désactive l'écriture du log et envoie un message au gestionnaire d'erreurs
128 
	 * @param string $nomFichier le nom du fichier qui a causé l'erreur
129 
	 */
129 aurelien 130 
	private static function desactiverEcriture($nomFichier = '') {
123 aurelien 131 
		self::$droitLogger = false;
138 jpm 132 
		if ($nomFichier != '') {
129 aurelien 133 
			$fichierDossier = 'fichier '.$nomFichier ;
134 
		} else {
135 
			$fichierDossier = 'dossier des logs';
136 
		}
138 jpm 137 
		$message = 'Écriture impossible dans le '.$fichierDossier.', Assurez-vous des droits du dossier et des fichiers';
138 
		$e = new ErrorException($message, 0, E_USER_WARNING, __FILE__, __LINE__);
123 aurelien 139 
		GestionnaireException::gererException($e);
140 
	}
122 aurelien 141 
 
241 jpm 142 
	/** Destructeur de classe, ferme les descripteurs ouverts. */
123 aurelien 143 
	public function __destruct() {
144 
		foreach(self::$fichiersLog as $nomFichier => $fp) {
145 
			fclose($fp);
146 
		}
147 
	}
122 aurelien 148 
}
230 jpm 149 
?>