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