-
Notifications
You must be signed in to change notification settings - Fork 20
/
Log.php
251 lines (228 loc) · 8.28 KB
/
Log.php
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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
<?php
// $Id$
// $Horde: horde/lib/Log.php,v 1.15 2000/06/29 23:39:45 jon Exp $
require_once 'PEAR.php';
define('PEAR_LOG_EMERG', 0);
define('PEAR_LOG_ALERT', 1);
define('PEAR_LOG_CRIT', 2);
define('PEAR_LOG_ERR', 3);
define('PEAR_LOG_WARNING', 4);
define('PEAR_LOG_NOTICE', 5);
define('PEAR_LOG_INFO', 6);
define('PEAR_LOG_DEBUG', 7);
/**
* 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@php.net>
* @version $Revision$
* @since Horde 1.3
* @package Log
*/
class Log extends PEAR {
/**
* Indicates whether or not the log can been opened / connected.
*
* @var boolean
* @access private
*/
var $_opened = false;
/**
* The label that uniquely identifies this set of log messages.
*
* @var string
* @access private
*/
var $_ident = '';
/**
* The maximum priority level at which to log a message.
*
* @var int
* @access private
*/
var $_maxLevel = PEAR_LOG_DEBUG;
/**
* Holds all Log_observer objects that wish to be notified of new messages.
*
* @var array
* @access private
*/
var $_listeners = array();
/**
* Attempts to return a concrete Log instance of $type.
*
* @param string $type The type of concrete Log subclass to return.
* Attempt to dynamically include the code for
* this subclass. Currently, valid values are
* 'console', 'syslog', 'sql', 'file', and 'mcal'.
*
* @param string $name 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 string $ident The identity reported to the log system.
*
* @param array $conf A hash containing any additional configuration
* information that a subclass might need.
*
* @param int $maxLevel Maximum priority level at which to log.
*
* @return object Log The newly created concrete Log instance, or an
* false on an error.
* @access public
*/
function &factory($type, $name = '', $ident = '', $conf = array(),
$maxLevel = PEAR_LOG_DEBUG)
{
$type = strtolower($type);
$classfile = 'Log/' . $type . '.php';
if (@include_once $classfile) {
$class = 'Log_' . $type;
return new $class($name, $ident, $conf, $maxLevel);
} else {
return false;
}
}
/**
* Attempts to return a reference to a concrete Log instance of $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 string $type The type of concrete Log subclass to return.
* Attempt to dynamically include the code for
* this subclass. Currently, valid values are
* 'console', 'syslog', 'sql', 'file', and 'mcal'.
*
* @param string $name 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 string $ident The identity reported to the log system.
*
* @param array $conf A hash containing any additional configuration
* information that a subclass might need.
*
* @param int $maxLevel Minimum priority level at which to log.
*
* @return object Log The newly created concrete Log instance, or an
* false on an error.
* @access public
*/
function &singleton($type, $name = '', $ident = '', $conf = array(),
$maxLevel = PEAR_LOG_DEBUG)
{
static $instances;
if (!isset($instances)) $instances = array();
$signature = serialize(array($type, $name, $ident, $conf, $maxLevel));
if (!isset($instances[$signature])) {
$instances[$signature] = &Log::factory($type, $name, $ident, $conf,
$maxLevel);
}
return $instances[$signature];
}
/**
* Abstract implementation of the close() method.
*/
function close()
{
return false;
}
/**
* Abstract implementation of the log() method.
*/
function log($message, $priority = PEAR_LOG_INFO)
{
return false;
}
/**
* Returns the string representation of a PEAR_LOG_* integer constant.
*
* @param int $priority A PEAR_LOG_* integer constant.
*
* @return string The string representation of $priority.
*/
function priorityToString($priority)
{
$priorities = array(
PEAR_LOG_EMERG => 'emergency',
PEAR_LOG_ALERT => 'alert',
PEAR_LOG_CRIT => 'critical',
PEAR_LOG_ERR => 'error',
PEAR_LOG_WARNING => 'warning',
PEAR_LOG_NOTICE => 'notice',
PEAR_LOG_INFO => 'info',
PEAR_LOG_DEBUG => 'debug'
);
return $priorities[$priority];
}
/**
* Adds a Log_observer instance to the list of observers that are be
* notified when a message is logged.
*
* @param object Log_observer &$logObserver The Log_observer instance to
* be added to the $listeners
* array.
* @access public
*/
function attach(&$logObserver)
{
if (!is_object($logObserver)) {
return false;
}
$logObserver->_listenerID = uniqid(rand());
$this->_listeners[$logObserver->_listenerID] = &$logObserver;
}
/**
* Removes a Log_observer instance from the list of observers.
*
* @param object Log_observer $logObserver The Log_observer instance to
* be removed from the $listeners
* array.
* @access public
*/
function detach($logObserver)
{
if (isset($this->_listeners[$logObserver->_listenerID])) {
unset($this->_listeners[$logObserver->_listenerID]);
}
}
/**
* Sends any Log_observer objects listening to this Log the message that
* was just logged.
*
* @param array $msgObj The data structure holding all relevant log
* information - the message, the priority, what
* log this is, etc.
*/
function notifyAll($msgObj)
{
reset($this->_listeners);
foreach ($this->_listeners as $listener) {
if ($msgObj['priority'] <= $listener->priority) {
$listener->notify($msgObj);
}
}
}
/**
* Indicates whether this is a composite class.
*
* @return boolean True if this is a composite class.
*/
function isComposite()
{
return false;
}
}
?>