Subversion Repositories Applications.framework

Rev

Rev 467 | Only display areas with differences | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

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