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