Subversion Repositories Applications.framework

Rev

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