Subversion Repositories Applications.framework

Rev

Rev 123 | Rev 130 | Go to most recent revision | Show entire file | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 123 Rev 129
Line 1... Line 1...
1 
<?php
 1 
<?php
2 
//declare(encoding='UTF-8');
 2 
//declare(encoding='UTF-8');
3 
/**
 3 
/**
- 
 
 4 
 * Classe permettant de logger des messages dans les fichier situés dans le dossier de log
- 
 
 5 
 *
4 
* PHP Version 5
 6 
 * PHP Version 5
5 
*
 7 
 *
6 
* @category  PHP
 8 
 * @category  PHP
7 
* @package   framework
 9 
 * @package   framework
8 
* @author	aurelien <aurelien@tela-botanica.org>
 10 
 * @author	aurelien <aurelien@tela-botanica.org>
9 
* @copyright 2009 Tela-Botanica
 11 
 * @copyright 2009 Tela-Botanica
10 
* @license   http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt Licence CECILL
 12 
 * @license   http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt Licence CECILL
11 
* @version   SVN: <svn_id>
 13 
 * @version   SVN: <svn_id>
12 
* @link	  /doc/framework/
 14 
 * @link	  /doc/framework/
13 
*/
 15 
 */
Line 14... Line 16...
14 
 
 16 
 
Line 15... Line 17...
15 
class Log {
 17 
class Log {
16 
 
 18 
 
Line 33... Line 35...
33 
	 * Zone horaire (pour éviter des avertissements dans les dates)
 35 
	 * Zone horaire (pour éviter des avertissements dans les dates)
34 
	 */
 36 
	 */
35 
	private static $timeZone = '';
 37 
	private static $timeZone = '';
Line 36... Line 38...
36 
 
 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 
 
37 
	/**
 44 
	/**
38 
	 * séparateur de chemin
 45 
	 * séparateur de chemin
39 
	 */
 46 
	 */
Line 40... Line 47...
40 
	private static $sd = DIRECTORY_SEPARATOR;
 47 
	private static $sd = DIRECTORY_SEPARATOR;
- 
 
 48 
 
- 
 
 49 
	/**
- 
 
 50 
	 * Extension des fichiers de log
- 
 
 51 
	 */
- 
 
 52 
	private static $ext = '.log';
41 
 
 53 
 
42 
	/**
 54 
	/**
43 
	 * La classe registre se contient elle-même, (pour le pattern singleton)
 55 
	 * La classe registre se contient elle-même, (pour le pattern singleton)
Line 44... Line 56...
44 
	 */
 56 
	 */
45 
	private static $log;
 57 
	private static $log;
46 
 
 58 
 
47 
	/**
 59 
	/**
48 
	 * Constructeur par défaut, privé, car on accède à la classe par le getInstance
 60 
	 * Constructeur par défaut, privé, car on accède à la classe par le getInstance
49 
	 */
 61 
	 */
50 
	private function __construct() {
 62 
	private function __construct() {
- 
 
 63 
		self::$sd = Config::get('ds');
51 
	   self::$sd = Config::get('ds');
 64 
		self::$cheminLogs = Config::get('chemin_logs');
52 
	   self::$cheminLogs = Config::get('chemin_logs');
 65 
		self::$timeZone = Config::get('fw_timezone');
53 
	   self::$timeZone = Config::get('fw_timezone');
 66 
		self::$tailleMax = Config::get('fw_taille_max_logs');
54 
 
 67 
 
55 
	   // gestion de la timezone pour éviter des erreurs
 68 
		// gestion de la timezone pour éviter des erreurs
- 
 
 69 
		if(function_exists("date_default_timezone_set") and function_exists("date_default_timezone_get")) {
- 
 
 70 
			date_default_timezone_set(self::$timeZone);
- 
 
 71 
		}
- 
 
 72 
 
56 
	   if(function_exists("date_default_timezone_set") and function_exists("date_default_timezone_get")) {
 73 
		if(!is_dir(self::$cheminLogs) || !is_writable(self::$cheminLogs)) {
Line 57... Line 74...
57 
		   date_default_timezone_set(self::$timeZone);
 74 
			self::desactiverEcriture();
58 
	   }
 75 
		}
59 
	}
 76 
	}
- 
 
 77 
 
60 
 
 78 
	/**
61 
	/**
 79 
	 * Fonction qui renvoie l'instance de classe en assurant son unicité, c'est l'unique méthode qui doit être
62 
	 * 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
63 
	 * utilisée pour récupérer l'objet Registre
 81 
	 * @return Log	le gestionnaire de log en cours
64 
	 */
 82 
	 */
Line 77... Line 95...
77 
	public static function ajouterEntree($nomFichier,$entree,$mode='a+') {
 95 
	public static function ajouterEntree($nomFichier,$entree,$mode='a+') {
78 
		if(self::$droitLogger) {
 96 
		if(self::$droitLogger) {
79 
			$date = "\n"."\n".date('d m Y H:i')."\n" ;
 97 
			$date = "\n"."\n".date('d m Y H:i')."\n" ;
Line 80... Line 98...
80 
 
 98 
 
81 
			// si le fichier est déjà dans le tableau et qu'on peut y écrire
 99 
			// si le fichier est déjà dans le tableau et qu'on peut y écrire
82 
			if(in_array($nomFichier,self::$fichiersLog)) {
 100 
			if(self::verifierOuvrirFichier($nomFichier,$mode)) {
83 
				if(is_writable(self::$cheminLogs.$nomFichier)) {
 101 
					// on y écrit le message de log
84 
				   fwrite(self::$fichiersLog[$nomFichier],$date.$entree);
 102 
				   fwrite(self::$fichiersLog[$nomFichier],$date.$entree);
85 
				} else {
 103 
				   // on vérifie si le fichier ne dépasse pas la taille maximale
86 
					self::desactiverEcriture($nomFichier);
 - 
 
87 
				}
 104 
				   self::verifierTailleFichierOuArchiver($nomFichier);
88 
			} else {
 - 
 
89 
				$fp = fopen(self::$cheminLogs.$nomFichier,$mode);
 - 
 
90 
				if($fp) {
 - 
 
91 
					if(is_writable(self::$cheminLogs.$nomFichier)) {
 - 
 
92 
					   self::$fichiersLog[$nomFichier] = $fp;
 - 
 
93 
						fwrite(self::$fichiersLog[$nomFichier],$date.$entree);
 - 
 
94 
					} else {
 105 
			} else {
95 
						self::desactiverEcriture($nomFichier);
 - 
 
96 
					}
 - 
 
97 
				} else {
 106 
				// sinon on interdit l'écriture
98 
					self::desactiverEcriture($nomFichier);
 - 
 
99 
				}
 107 
				self::desactiverEcriture($nomFichier);
100 
			}
 108 
			}
101 
		}
 109 
		}
Line 102... Line 110...
102 
	}
 110 
	}
103 
 
 111 
 
104 
	/**
 112 
	/**
105 
	 * Vide un fichier log indiqué
 113 
	 * Vide un fichier log indiqué
106 
	 * @param string $nomFichier le nom du fichier à vider
 114 
	 * @param string $nomFichier le nom du fichier à vider
107 
	 */
 - 
 
108 
	public static function viderLog($nomFichier) {
 115 
	 */
109 
		if(self::verifierPresenceFichier($nomFichier)) {
 - 
 
110 
			ajouterEntree($nomFichier,'','w');
 116 
	public static function viderLog($nomFichier) {
Line 111... Line 117...
111 
		}
 117 
		ajouterEntree($nomFichier,'','w');
112 
	}
 118 
	}
113 
 
 119 
 
114 
	/**
 120 
	/**
115 
	 * Vérifie la présence d'un fichier dans le tableau (et bientot plein
 121 
	 * Vérifie la présence d'un fichier dans le tableau, ses droits d'écriture,
116 
	 * d'autres choses).
 122 
	 * l'ouvre si nécessaire
117 
	 * @param string $nomFichier le nom du fichier dont on doit vérifier la présence
 123 
	 * @param string $nomFichier le nom du fichier dont on doit vérifier la présence
- 
 
 124 
	 * @return boolean true si le fichier est ouvert ou maintenant accessible, false sinon
118 
	 * @return boolean vrai si le fichier est dans le tableau, faux sinon
 125 
	 */
- 
 
 126 
	public static function verifierOuvrirFichier($nomFichier,$mode) {
- 
 
 127 
		// le fichier est il déjà ouvert ?
- 
 
 128 
		if(in_array($nomFichier,self::$fichiersLog)) {
119 
	 */
 129 
			// si oui peut on y écrire ?
- 
 
 130 
			if(is_writable(self::$cheminLogs.$nomFichier.self::$ext)) {
- 
 
 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
- 
 
 139 
			if($fp && is_writable(self::$cheminLogs.$nomFichier.self::$ext)) {
- 
 
 140 
				// si oui on renvoie le descripteur qu'on ajoute au tableau
- 
 
 141 
				self::$fichiersLog[$nomFichier] = $fp;
- 
 
 142 
				return true;
- 
 
 143 
			}
- 
 
 144 
			return false;
- 
 
 145 
		}
- 
 
 146 
	}
- 
 
 147 
 
- 
 
 148 
	/**
- 
 
 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) {
120 
	public static function verifierPresenceFichier($nomFichier) {
 154 
		if(filesize(self::$cheminLogs.$nomFichier.self::$ext) > self::$tailleMax) {
121 
		if(in_array($nomFichier,self::$fichiersLog)) {
 - 
 
122 
			return true;
 155 
			rename(self::$cheminLogs.$nomFichier.self::$ext,self::$cheminLogs.$nomFichier.date('d_m_Y_H:i').self::$ext);
Line 123... Line 156...
123 
		}
 156 
			ajouterEntree($nomFichier,'');
124 
		return false;
 157 
		}
125 
	}
 158 
	}
126 
 
 159 
 
127 
	/**
 160 
	/**
128 
	 * Désactive l'écriture du log et envoie un message au gestionnaire d'erreurs
 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 
	 */
- 
 
 164 
	private static function desactiverEcriture($nomFichier = '') {
- 
 
 165 
		self::$droitLogger = false;
- 
 
 166 
		if($nomFichier != '') {
129 
	 * @param string $nomFichier le nom du fichier qui a causé l'erreur
 167 
			$fichierDossier = 'fichier '.$nomFichier ;
130 
	 */
 168 
		} else {
131 
	private static function desactiverEcriture($nomFichier) {
 169 
			$fichierDossier = 'dossier des logs';
132 
		self::$droitLogger = false;
 170 
		}
Line 133... Line 171...
133 
		$message = 'Ecriture impossible dans le fichier '.$nomFichier.', Assurez-vous des droits du dossier de logs et du fichier';
 171 
		$message = 'Ecriture impossible dans le '.$fichierDossier.', Assurez-vous des droits du dossier et des fichiers';