WebSVN – Applications.framework – Diff – /trunk/framework/Log.php


<?php
//declare(encoding='UTF-8');
/**
 * Classe permettant de logger des messages dans les fichier situés dans le dossier de log
 *
 * PHP Version 5
 *
 * @category  PHP
 * @package   Framework
 * @author	aurelien <aurelien@tela-botanica.org>
 * @copyright 2009 Tela-Botanica
 * @license   http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt Licence CECILL
 * @version   SVN: <svn_id>
 * @link	  /doc/framework/
 */
 
class Log {
 
	/**
	 * Boolean indiquant si l'on doit utiliser les logs ou pas
	 */
	private static $logger = false;
 
 
	/**
	 * Tableau associatif stockant les descripteurs de fichiers
	 */
	private static $fichiersLog = array();
 
	/**
	 * Chemin de base du dossier log de l'application
	 */
	private static $cheminLogs = '';
 
	/**
	 * Booleen indiquant si l'on peut correctement écrire dans les fichiers de logs
	 */
	 private static $droitLogger = true;
 
	/**
	 * Zone horaire (pour éviter des avertissements dans les dates)
	 */
	private static $timeZone = '';
 
	/**
	 * Taille maximum d'un fichier de log avant que celui ne soit archivé (en octets)
	 */
	private static $tailleMax = 10000;
 
	/**
	 * séparateur de chemin
	 */
	private static $sd = DIRECTORY_SEPARATOR;
 
	/**
	 * Extension des fichiers de log
	 */
	private static $ext = '.log';
 
	/**
	 * La classe registre se contient elle-même, (pour le pattern singleton)
	 */
	private static $log;
 
	/**
	 * Constructeur par défaut, privé, car on accède à la classe par le getInstance
	 */
	private function __construct() {
		self::$sd = Config::get('ds');
		self::$cheminLogs = Config::get('chemin_logs');
		self::$timeZone = Config::get('fw_timezone');
		self::$tailleMax = Config::get('fw_taille_max_logs');
		self::$logger = Config::get('fw_log_debogage');
 
		// gestion de la timezone pour éviter des erreurs
		if (function_exists('date_default_timezone_set') && function_exists('date_default_timezone_get')) {
			date_default_timezone_set(self::$timeZone);
		}
 
		if (self::$logger && (!is_dir(self::$cheminLogs) || !is_writable(self::$cheminLogs))) {
			self::desactiverEcriture();
		}
	}
 
	/**
	 * Fonction qui renvoie l'instance de classe en assurant son unicité, c'est l'unique méthode qui doit être
	 * utilisée pour récupérer l'objet Registre
	 * @return Log	le gestionnaire de log en cours
	 */
	public static function getInstance() {
		if (self::$log instanceof Log) {
			return self::$log;
		}
		self::$log = new Log();
		return self::$log;
	}
 
	/**
	 * Ajoute une entrée au log spécifié par le paramètre $nomFichier
	 * @param string $nomFichier le nom du fichier dans lequel écrire
	 */
	public static function ajouterEntree($nomFichier,$entree,$mode='a+') {
		if(self::$droitLogger) {
			$date = "\n"."\n".date('d m Y H:i')."\n" ;
 
			// si le fichier est déjà dans le tableau et qu'on peut y écrire
			if(self::verifierOuvrirFichier($nomFichier,$mode)) {
				// on y écrit le message de log
			   fwrite(self::$fichiersLog[$nomFichier],$date.$entree);
			   // on vérifie si le fichier ne dépasse pas la taille maximale
			   self::verifierTailleFichierOuArchiver($nomFichier);
			} else {
				// sinon on interdit l'écriture
				self::desactiverEcriture($nomFichier);
			}
		}
	}
 
	/**
	 * Vide un fichier log indiqué
	 * @param string $nomFichier le nom du fichier à vider
	 */
	public static function viderLog($nomFichier) {
		self::ajouterEntree($nomFichier, '', 'w');
	}
 
	/**
	 * Vérifie la présence d'un fichier dans le tableau, ses droits d'écriture,
	 * l'ouvre si nécessaire
	 * @param string $nomFichier le nom du fichier dont on doit vérifier la présence
	 * @return boolean true si le fichier est ouvert ou maintenant accessible, false sinon
	 */
	public static function verifierOuvrirFichier($nomFichier,$mode) {
		// le fichier est il déjà ouvert ?
		if (in_array($nomFichier, self::$fichiersLog)) {
			// si oui peut on y écrire ?
			if (is_writable(self::$cheminLogs.$nomFichier.self::$ext)) {
				// si oui on renvoie le descripteur
				return true;
			}
			return false;
		} else {
			// sinon on l'ouvre
			$fp = @fopen(self::$cheminLogs.$nomFichier.self::$ext,$mode);
			// si l'ouverture a réussi et si le fichier a les droits d'écriture
			if ($fp && is_writable(self::$cheminLogs.$nomFichier.self::$ext)) {
				// si oui on renvoie le descripteur qu'on ajoute au tableau
				self::$fichiersLog[$nomFichier] = $fp;
				return true;
			}
			return false;
		}
	}
 
	/**
	 * Vérifie la taille d'un fichier donné et si celle ci est trop importante
	 * archive le fichier de log
	 * @param string $nomFichier nom du fichier à vérifier
	 */
	private static function verifierTailleFichierOuArchiver($nomFichier) {
		if(filesize(self::$cheminLogs.$nomFichier.self::$ext) > self::$tailleMax) {
			rename(self::$cheminLogs.$nomFichier.self::$ext,self::$cheminLogs.$nomFichier.date('d_m_Y_H:i').self::$ext);
			self::ajouterEntree($nomFichier,'');
		}
	}
 
	/**
	 * Désactive l'écriture du log et envoie un message au gestionnaire d'erreurs
	 * @param string $nomFichier le nom du fichier qui a causé l'erreur
	 */
	private static function desactiverEcriture($nomFichier = '') {
		self::$droitLogger = false;
		if ($nomFichier != '') {
			$fichierDossier = 'fichier '.$nomFichier ;
		} else {
			$fichierDossier = 'dossier des logs';
		}
		$message = 'Écriture impossible dans le '.$fichierDossier.', Assurez-vous des droits du dossier et des fichiers';
		$e = new ErrorException($message, 0, E_USER_WARNING, __FILE__, __LINE__);
		GestionnaireException::gererException($e);
	}
 
	/**
	 * destructeur de classe, ferme les descripteurs ouverts
	 */
	public function __destruct() {
		foreach(self::$fichiersLog as $nomFichier => $fp) {
			fclose($fp);
		}
	}
}
?>

Subversion Repositories Applications.framework

(root)/trunk/framework/Log.php @ 163 – Rev 163 → 175

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