1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
|
<?php
// $Id$
// $Horde: horde/lib/Log.php,v 1.15 2000/06/29 23:39:45 jon Exp $
/**
* The Log:: class implements both an abstraction for various logging
* mechanisms and the Subject end of a Subject-Observer pattern.
*
* @author Chuck Hagenbuch <chuck@horde.org>
* @author Jon Parise <jon@csh.rit.edu>
* @version $Revision$
* @since Horde 1.3
*/
class Log {
// {{{ properties
/** Boolean indicating whether or not the log connection is
currently open. */
var $opened = false;
/** String holding the identifier that will be stored along with
each logged message. */
var $ident = '';
/** Array holding all Log_observer objects that wish to be notified
of any messages that we handle. */
var $listeners = array();
// }}}
// {{{ factory()
/**
* Attempts to return a concrete Log instance of $log_type.
*
* @param $log_type The type of concrete Log subclass to return.
* Attempt to dynamically include the code for this
* subclass. Currently, valid values are 'syslog',
* 'sql', 'file', and 'mcal'.
*
* @param $log_name (optional) The name of the actually log file,
* table, or other specific store to use. Defaults
* to an empty string, with which the subclass will
* attempt to do something intelligent.
*
* @param $ident (optional) The indentity reported to the log system.
*
* @param $conf (optional) A hash containing any additional
* configuration information that a subclass might need.
*
* @return The newly created concrete Log instance, or an
* false on an error.
*/
function &factory($log_type, $log_name = '', $ident = '', $conf = array())
{
$log_type = strtolower($log_type);
$classfile = 'Log/' . $log_type . '.php';
@include_once $classfile;
$class = 'Log_' . $log_type;
if (class_exists($class)) {
return new $class($log_name, $ident, $conf);
} else {
return false;
}
}
// }}}
// {{{ singleton()
/**
* Attempts to return a reference to a concrete Log instance of
* $log_type, only creating a new instance if no log instance with
* the same parameters currently exists.
*
* You should use this if there are multiple places you might
* create a logger, you don't want to create multiple loggers, and
* you don't want to check for the existance of one each time. The
* singleton pattern does all the checking work for you.
*
* <b>You MUST call this method with the $var = &Log::singleton()
* syntax. Without the ampersand (&) in front of the method name,
* you will not get a reference, you will get a copy.</b>
*
* @param $log_type The type of concrete Log subclass to return.
* Attempt to dynamically include the code for
* this subclass. Currently, valid values are
* 'syslog', 'sql', 'file', and 'mcal'.
*
* @param $log_name (optional) The name of the actually log file,
* table, or other specific store to use. Defaults
* to an empty string, with which the subclass will
* attempt to do something intelligent.
*
* @param $ident (optional) The identity reported to the log system.
*
* @param $conf (optional) A hash containing any additional
* configuration information that a subclass might need.
*
* @return The concrete Log reference, or false on an error.
*/
function &singleton ($log_type, $log_name = '', $ident = '', $conf = array()) {
static $instances;
if (!isset($instances)) $instances = array();
$signature = md5($log_type . '][' . $log_name . '][' . $ident . '][' . implode('][', $conf));
if (!isset($instances[$signature])) {
$instances[$signature] = &Log::factory($log_type, $log_name, $ident, $conf);
}
return $instances[$signature];
}
// }}}
// {{{ priorityToString()
/**
* Returns the string representation of a LOG_* integer constant.
*
* @param $priority The LOG_* integer constant.
*
* @return The string representation of $priority.
*/
function priorityToString ($priority) {
$priorities = array(
LOG_EMERG => 'emergency',
LOG_ALERT => 'alert',
LOG_CRIT => 'critical',
LOG_ERR => 'error',
LOG_WARNING => 'warning',
LOG_NOTICE => 'notice',
LOG_INFO => 'info',
LOG_DEBUG => 'debug'
);
return $priorities[$priority];
}
// }}}
// {{{ attach()
/**
* Adds a Log_observer instance to the list of observers that are
* be notified when a message is logged.
*
* @param $logObserver The Log_observer instance to be added to
* the $listeners array.
*/
function attach (&$logObserver) {
if (!is_object($logObserver))
return false;
$logObserver->_listenerID = uniqid(rand());
$this->listeners[$logObserver->_listenerID] = &$logObserver;
}
// }}}
// {{{ detach()
/**
* Removes a Log_observer instance from the list of observers.
*
* @param $logObserver The Log_observer instance to be removed
* from the $listeners array.
*/
function detach ($logObserver) {
if (isset($this->listeners[$logObserver->_listenerID]))
unset($this->listeners[$logObserver->_listenerID]);
}
// }}}
// {{{ notifyAll()
/**
* Sends any Log_observer objects listening to this Log the message
* that was just logged.
*
* @param $messageOb The data structure holding all relevant log
* information - the message, the priority, what
* log this is, etc.
*/
function notifyAll ($messageOb) {
reset($this->listeners);
foreach ($this->listeners as $listener) {
if ($messageOb['priority'] <= $listener->priority)
$listener->notify($messageOb);
}
}
// }}}
// {{{ isComposite()
/**
* @return a Boolean: true if this is a composite class, false
* otherwise. The composite subclass overrides this to return
* true.
*/
function isComposite () {
return false;
}
// }}}
}
?>
|
