Subversion Repositories Applications.framework

Rev

Rev 179 | Rev 254 | Go to most recent revision | Only display areas with differences | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

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