Subversion Repositories Applications.framework

Rev

Rev 188 | Rev 255 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

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