Subversion Repositories Applications.framework

Rev

Details | Last modification | View Log | RSS feed

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