Subversion Repositories Applications.framework

Rev

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

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