org.netfrag.glib/Class/Logger.php

<?
/**
 * This file contains the Class::Logger class.
 *
 * @author Andreas Motl <andreas.motl@ilo.de>
 * @package org.netfrag.glib
 * @name Class::Logger
 *
 */


/**
 * <b>Cvs-Log:</b>
 *
 * <pre>
 *
 *  $Id: Logger.php,v 1.10 2003/03/28 03:04:26 joko Exp $
 *
 *  $Log: Logger.php,v $
 *  Revision 1.10  2003/03/28 03:04:26  joko
 *  enhanced conditions for debugging
 *
 *  Revision 1.9  2003/03/27 15:59:55  joko
 *  enhanced 'function log'
 *
 *  Revision 1.8  2003/03/11 02:23:02  joko
 *  + fixed metadata for phpDocumentor
 *
 *  Revision 1.7  2003/03/11 02:14:23  joko
 *  + fixed metadata for phpDocumentor
 *
 *  Revision 1.6  2003/03/11 02:04:36  joko
 *  + fixed metadata for phpDocumentor
 *
 *  Revision 1.5  2003/03/11 01:42:59  joko
 *  + fixed metadata for phpDocumentor
 *
 *  Revision 1.4  2003/03/11 01:22:24  joko
 *  + fixed metadata for phpDocumentor
 *
 *  Revision 1.3  2003/03/11 01:12:53  joko
 *  + fixed metadata for phpDocumentor
 *
 *  Revision 1.2  2003/03/05 18:54:43  joko
 *  updated docu - phpDocumentor is very strict about its 'blocks'...
 *
 *  Revision 1.1  2003/03/03 21:26:43  joko
 *  refactored from DesignPattern::Logger
 *
 *  Revision 1.4  2003/02/13 00:43:41  joko
 *  + logfile name now can get passed via defined constant
 *
 *  Revision 1.3  2003/02/09 17:14:49  joko
 *  + now able to redirect errors raised by PEAR to logfile
 *
 *  Revision 1.2  2003/02/03 14:47:49  joko
 *  + some code from DesignPattern::Bridge
 *
 *  Revision 1.1  2003/02/03 03:33:48  joko
 *  + initial commit
 *
 * </pre>
 *
 */


/**
 * This requires Class::Abstract as a base class
 *
 */
php::loadModule('Class::Abstract');


/**
 * --- Class::Inner
 *
 * @author Andreas Motl <andreas.motl@ilo.de>
 * @copyright (c) 2003 - All Rights reserved.
 * @license GNU LGPL (GNU Lesser General Public License)
 *
 * @link http://www.netfrag.org/~joko/
 * @link http://www.gnu.org/licenses/lgpl.txt
 *
 * @package org.netfrag.glib
 * @subpackage Class
 * @name Class::Logger
 *
 *
 */
class Class_Logger extends Class_Abstract {

  var $logger;
  var $logfile;
  var $enabled;

  function Class_Logger() {
    $this->constructor();
  }

  function constructor() {
    // FIXME: this is hardcoded!
    $logfile = 'logfile.txt';
    if (defined('LOGFILE')) {
      $logfile = LOGFILE;
    }
    $this->_init_logger($logfile, 1);
  }


  // TODO: split by loglevel here to make seperated logfiles possible (debug, normal, errors)
  // TODO: optional: transmit logging messages via tcp - don't write them to disk (a handler for PEAR::Log)
  function log($msg, $level = PEAR_LOG_DEBUG) {
    //print "log: $msg<br>";
    if ($this->logger) {
      $this->logger->log($msg, $level);
    } else {
      // TODO: how are these type of errors handled?
      //print "error-message: $msg<br>";
    }
    
    // TODO: modify this condition: make it more flexible: introduce '$this->ERRORS_STDOUT' or s.th.l.th.
    //$debug_condition = $this->DEBUG || $level <= PEAR_LOG_WARNING;
    $debug_condition = $this->DEBUG;
    //$error_condition = $level <= PEAR_LOG_ERR;
    $error_condition = $level <= PEAR_LOG_WARNING;
    
    $label = 'Unknown'; $color = 'black';
    if ($debug_condition) { $label = 'Debug'; $color = 'darkgreen'; }
    if ($error_condition) { $label = 'Error'; $color = 'red'; }
    
    $stdout_condition = constants::get('VERBOSE') && $level && ($debug_condition || $error_condition);
    if ($stdout_condition) {
      // TODO: what now?
      //user_error($msg);
      //print "<div><span style=\"color: $color;\"><b>$label</b></span>[$level]: <i>$msg</i></div>";
      $style = html_style("text/css", '.boxlabel_red { color: red; font-weight:bold; }');
      $box = html_span();
      //$box->set_style("border-bottom: 1px solid black;");
      $box->add( html_span('boxlabel_red', $label), "[$level]: $msg", html_br() );
      print $style->render();
      print $box->render();
    }
    
  }

  function _init_logger($logfile, $enable = 0) {
    $this->logfile = $logfile;
    $this->enabled = $enable;
    //print Dumper($this);
    $this->_call_PEAR_Log_singleton();
    $this->_pear_errors_redirect();
  }

  function _call_PEAR_Log_singleton() {

//      $logfile = 'log.txt';
//      $logfile = $this->config[path][base] . "core/var/log/logfile.txt";

      // TODO: maybe include userid here?
      //$log_ident = substr(session_id(), 10, 6);
      $log_ident = session_id();
      $outkey = 'dummy';
      if ($this->enabled) {
        $outkey = 'file';
      }

      if (class_exists('Log')) {
        $this->logger = &Log::singleton($outkey, $this->logfile, $log_ident, array( timestampFormat => "%Y-%m-%d %H:%M:%S" ));
      }
      //$this->log( get_class($this) . "->_init_logger: ready\t\t--------------------", LOG_DEBUG );
      
  }

  function _pear_errors_redirect() {
    // 1. use PEAR::setErrorHandling
      //PEAR::setErrorHandling(PEAR_ERROR_CALLBACK, "my_function_handler");
      // ... this doesn't work since the method thinks it's called oo-style,
      // which is *not* the case here

    // 2. use $GLOBALS to set global PEAR variables
      $GLOBALS['_PEAR_default_error_mode'] = PEAR_ERROR_CALLBACK;
      $GLOBALS['_PEAR_default_error_options'] = array($this, "_pear_error_receive");
  }
  
  function _pear_error_receive($errorObject) {
    // trace
    //print Dumper($errorObject);
    $this->log( "PEAR_Error->message: " . $errorObject->message, PEAR_LOG_ERR);
  }

}

?>
1	joko	1.1	<?
2	joko	1.2	/**
3			* This file contains the Class::Logger class.
4			*
5			* @author Andreas Motl <andreas.motl@ilo.de>
6	joko	1.3	* @package org.netfrag.glib
7	joko	1.2	* @name Class::Logger
8			*
9			*/
10
11
12	joko	1.5	/**
13	joko	1.8	* <b>Cvs-Log:</b>
14			*
15	joko	1.5	* <pre>
16	joko	1.7	*
17	joko	1.11	* $Id: Logger.php,v 1.10 2003/03/28 03:04:26 joko Exp $
18	joko	1.6	*
19	joko	1.5	* $Log: Logger.php,v $
20	joko	1.11	* Revision 1.10 2003/03/28 03:04:26 joko
21			* enhanced conditions for debugging
22			*
23	joko	1.10	* Revision 1.9 2003/03/27 15:59:55 joko
24			* enhanced 'function log'
25			*
26	joko	1.9	* Revision 1.8 2003/03/11 02:23:02 joko
27			* + fixed metadata for phpDocumentor
28			*
29	joko	1.8	* Revision 1.7 2003/03/11 02:14:23 joko
30			* + fixed metadata for phpDocumentor
31			*
32	joko	1.7	* Revision 1.6 2003/03/11 02:04:36 joko
33			* + fixed metadata for phpDocumentor
34			*
35	joko	1.6	* Revision 1.5 2003/03/11 01:42:59 joko
36			* + fixed metadata for phpDocumentor
37			*
38	joko	1.5	* Revision 1.4 2003/03/11 01:22:24 joko
39			* + fixed metadata for phpDocumentor
40			*
41			* Revision 1.3 2003/03/11 01:12:53 joko
42			* + fixed metadata for phpDocumentor
43			*
44			* Revision 1.2 2003/03/05 18:54:43 joko
45			* updated docu - phpDocumentor is very strict about its 'blocks'...
46			*
47			* Revision 1.1 2003/03/03 21:26:43 joko
48			* refactored from DesignPattern::Logger
49			*
50			* Revision 1.4 2003/02/13 00:43:41 joko
51			* + logfile name now can get passed via defined constant
52			*
53			* Revision 1.3 2003/02/09 17:14:49 joko
54			* + now able to redirect errors raised by PEAR to logfile
55			*
56			* Revision 1.2 2003/02/03 14:47:49 joko
57			* + some code from DesignPattern::Bridge
58			*
59			* Revision 1.1 2003/02/03 03:33:48 joko
60			* + initial commit
61	joko	1.7	*
62	joko	1.6	* </pre>
63	joko	1.5	*
64			*/
65	joko	1.1
66
67	joko	1.2	/**
68			* This requires Class::Abstract as a base class
69			*
70			*/
71	joko	1.1	php::loadModule('Class::Abstract');
72	joko	1.2
73
74			/**
75	joko	1.4	* --- Class::Inner
76	joko	1.2	*
77			* @author Andreas Motl <andreas.motl@ilo.de>
78			* @copyright (c) 2003 - All Rights reserved.
79			* @license GNU LGPL (GNU Lesser General Public License)
80			*
81			* @link http://www.netfrag.org/~joko/
82			* @link http://www.gnu.org/licenses/lgpl.txt
83			*
84	joko	1.7	* @package org.netfrag.glib
85	joko	1.2	* @subpackage Class
86			* @name Class::Logger
87	joko	1.8	*
88	joko	1.2	*
89			*/
90	joko	1.1	class Class_Logger extends Class_Abstract {
91
92			var $logger;
93			var $logfile;
94			var $enabled;
95
96			function Class_Logger() {
97			$this->constructor();
98			}
99
100			function constructor() {
101			// FIXME: this is hardcoded!
102			$logfile = 'logfile.txt';
103			if (defined('LOGFILE')) {
104			$logfile = LOGFILE;
105			}
106			$this->_init_logger($logfile, 1);
107			}
108
109	joko	1.11
110	joko	1.1	// TODO: split by loglevel here to make seperated logfiles possible (debug, normal, errors)
111			// TODO: optional: transmit logging messages via tcp - don't write them to disk (a handler for PEAR::Log)
112			function log($msg, $level = PEAR_LOG_DEBUG) {
113			//print "log: $msg<br>";
114			if ($this->logger) {
115			$this->logger->log($msg, $level);
116			} else {
117			// TODO: how are these type of errors handled?
118			//print "error-message: $msg<br>";
119			}
120	joko	1.9
121	joko	1.10	// TODO: modify this condition: make it more flexible: introduce '$this->ERRORS_STDOUT' or s.th.l.th.
122			//$debug_condition = $this->DEBUG \|\| $level <= PEAR_LOG_WARNING;
123			$debug_condition = $this->DEBUG;
124			//$error_condition = $level <= PEAR_LOG_ERR;
125			$error_condition = $level <= PEAR_LOG_WARNING;
126
127			$label = 'Unknown'; $color = 'black';
128			if ($debug_condition) { $label = 'Debug'; $color = 'darkgreen'; }
129			if ($error_condition) { $label = 'Error'; $color = 'red'; }
130
131	joko	1.11	$stdout_condition = constants::get('VERBOSE') && $level && ($debug_condition \|\| $error_condition);
132	joko	1.10	if ($stdout_condition) {
133			// TODO: what now?
134	joko	1.9	//user_error($msg);
135	joko	1.10	//print "<div><span style=\"color: $color;\"><b>$label</b></span>[$level]: <i>$msg</i></div>";
136	joko	1.11	$style = html_style("text/css", '.boxlabel_red { color: red; font-weight:bold; }');
137			$box = html_span();
138			//$box->set_style("border-bottom: 1px solid black;");
139			$box->add( html_span('boxlabel_red', $label), "[$level]: $msg", html_br() );
140			print $style->render();
141			print $box->render();
142	joko	1.9	}
143
144	joko	1.1	}
145
146			function _init_logger($logfile, $enable = 0) {
147			$this->logfile = $logfile;
148			$this->enabled = $enable;
149			//print Dumper($this);
150			$this->_call_PEAR_Log_singleton();
151			$this->_pear_errors_redirect();
152			}
153
154			function _call_PEAR_Log_singleton() {
155
156			// $logfile = 'log.txt';
157			// $logfile = $this->config[path][base] . "core/var/log/logfile.txt";
158
159			// TODO: maybe include userid here?
160			//$log_ident = substr(session_id(), 10, 6);
161			$log_ident = session_id();
162			$outkey = 'dummy';
163			if ($this->enabled) {
164			$outkey = 'file';
165			}
166
167			if (class_exists('Log')) {
168			$this->logger = &Log::singleton($outkey, $this->logfile, $log_ident, array( timestampFormat => "%Y-%m-%d %H:%M:%S" ));
169			}
170			//$this->log( get_class($this) . "->_init_logger: ready\t\t--------------------", LOG_DEBUG );
171
172			}
173
174			function _pear_errors_redirect() {
175			// 1. use PEAR::setErrorHandling
176			//PEAR::setErrorHandling(PEAR_ERROR_CALLBACK, "my_function_handler");
177			// ... this doesn't work since the method thinks it's called oo-style,
178			// which is not the case here
179
180			// 2. use $GLOBALS to set global PEAR variables
181			$GLOBALS['_PEAR_default_error_mode'] = PEAR_ERROR_CALLBACK;
182			$GLOBALS['_PEAR_default_error_options'] = array($this, "_pear_error_receive");
183			}
184
185			function _pear_error_receive($errorObject) {
186			// trace
187			//print Dumper($errorObject);
188			$this->log( "PEAR_Error->message: " . $errorObject->message, PEAR_LOG_ERR);
189			}
190
191			}
192
193			?>
MailToCvsAdmin">MailToCvsAdmin	ViewVC Help
Powered by ViewVC 1.1.26