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
|
<?php
/**
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
namespace MediaWiki\Logger\Monolog;
use LogicException;
use MediaWiki\Logger\LegacyLogger;
use Monolog\Handler\AbstractProcessingHandler;
use Monolog\Logger;
use UnexpectedValueException;
/**
* Log handler that replicates the behavior of MediaWiki's wfErrorLog()
* logging service. Log output can be directed to a local file, a PHP stream,
* or a udp2log server.
*
* For udp2log output, the stream specification must have the form:
* "udp://HOST:PORT[/PREFIX]"
* where:
* - HOST: IPv4, IPv6 or hostname
* - PORT: server port
* - PREFIX: optional (but recommended) prefix telling udp2log how to route
* the log event. The special prefix "{channel}" will use the log event's
* channel as the prefix value.
*
* When not targeting a udp2log stream this class will act as a drop-in
* replacement for Monolog's StreamHandler.
*
* @since 1.25
* @author Bryan Davis <bd808@wikimedia.org>
* @copyright © 2013 Bryan Davis and Wikimedia Foundation.
*/
class LegacyHandler extends AbstractProcessingHandler {
/**
* Log sink descriptor
* @var string $uri
*/
protected $uri;
/**
* Filter log events using legacy rules
* @var bool $useLegacyFilter
*/
protected $useLegacyFilter;
/**
* Log sink
* @var resource $sink
*/
protected $sink;
/**
* @var string $error
*/
protected $error;
/**
* @var string $host
*/
protected $host;
/**
* @var int $port
*/
protected $port;
/**
* @var string $prefix
*/
protected $prefix;
/**
* @param string $stream Stream URI
* @param bool $useLegacyFilter Filter log events using legacy rules
* @param int $level Minimum logging level that will trigger handler
* @param bool $bubble Can handled meesages bubble up the handler stack?
*/
public function __construct(
$stream,
$useLegacyFilter = false,
$level = Logger::DEBUG,
$bubble = true
) {
parent::__construct( $level, $bubble );
$this->uri = $stream;
$this->useLegacyFilter = $useLegacyFilter;
}
/**
* Open the log sink described by our stream URI.
*/
protected function openSink() {
if ( !$this->uri ) {
throw new LogicException(
'Missing stream uri, the stream can not be opened.' );
}
$this->error = null;
set_error_handler( array( $this, 'errorTrap' ) );
if ( substr( $this->uri, 0, 4 ) == 'udp:' ) {
$parsed = parse_url( $this->uri );
if ( !isset( $parsed['host'] ) ) {
throw new UnexpectedValueException( sprintf(
'Udp transport "%s" must specify a host', $this->uri
) );
}
if ( !isset( $parsed['port'] ) ) {
throw new UnexpectedValueException( sprintf(
'Udp transport "%s" must specify a port', $this->uri
) );
}
$this->host = $parsed['host'];
$this->port = $parsed['port'];
$this->prefix = '';
if ( isset( $parsed['path'] ) ) {
$this->prefix = ltrim( $parsed['path'], '/' );
}
if ( filter_var( $this->host, FILTER_VALIDATE_IP, FILTER_FLAG_IPV6 ) ) {
$domain = AF_INET6;
} else {
$domain = AF_INET;
}
$this->sink = socket_create( $domain, SOCK_DGRAM, SOL_UDP );
} else {
$this->sink = fopen( $this->uri, 'a' );
}
restore_error_handler();
if ( !is_resource( $this->sink ) ) {
$this->sink = null;
throw new UnexpectedValueException( sprintf(
'The stream or file "%s" could not be opened: %s',
$this->uri, $this->error
) );
}
}
/**
* Custom error handler.
* @param int $code Error number
* @param string $msg Error message
*/
protected function errorTrap( $code, $msg ) {
$this->error = $msg;
}
/**
* Should we use UDP to send messages to the sink?
* @return bool
*/
protected function useUdp() {
return $this->host !== null;
}
protected function write( array $record ) {
if ( $this->useLegacyFilter &&
!LegacyLogger::shouldEmit(
$record['channel'], $record['message'],
$record['level'], $record
) ) {
// Do not write record if we are enforcing legacy rules and they
// do not pass this message. This used to be done in isHandling(),
// but Monolog 1.12.0 made a breaking change that removed access
// to the needed channel and context information.
return;
}
if ( $this->sink === null ) {
$this->openSink();
}
$text = (string)$record['formatted'];
if ( $this->useUdp() ) {
// Clean it up for the multiplexer
if ( $this->prefix !== '' ) {
$leader = ( $this->prefix === '{channel}' ) ?
$record['channel'] : $this->prefix;
$text = preg_replace( '/^/m', "{$leader} ", $text );
// Limit to 64KB
if ( strlen( $text ) > 65506 ) {
$text = substr( $text, 0, 65506 );
}
if ( substr( $text, -1 ) != "\n" ) {
$text .= "\n";
}
} elseif ( strlen( $text ) > 65507 ) {
$text = substr( $text, 0, 65507 );
}
socket_sendto(
$this->sink, $text, strlen( $text ), 0, $this->host, $this->port
);
} else {
fwrite( $this->sink, $text );
}
}
public function close() {
if ( is_resource( $this->sink ) ) {
if ( $this->useUdp() ) {
socket_close( $this->sink );
} else {
fclose( $this->sink );
}
}
$this->sink = null;
}
}
|
