3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2 of the License, or
6 * (at your option) any later version.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 * http://www.gnu.org/copyleft/gpl.html
21 namespace MediaWiki\Logger\Monolog
;
24 use MediaWiki\Logger\LegacyLogger
;
25 use Monolog\Handler\AbstractProcessingHandler
;
27 use UnexpectedValueException
;
30 * Log handler that replicates the behavior of MediaWiki's wfErrorLog()
31 * logging service. Log output can be directed to a local file, a PHP stream,
32 * or a udp2log server.
34 * For udp2log output, the stream specification must have the form:
35 * "udp://HOST:PORT[/PREFIX]"
37 * - HOST: IPv4, IPv6 or hostname
39 * - PREFIX: optional (but recommended) prefix telling udp2log how to route
40 * the log event. The special prefix "{channel}" will use the log event's
41 * channel as the prefix value.
43 * When not targeting a udp2log stream this class will act as a drop-in
44 * replacement for \Monolog\Handler\StreamHandler.
47 * @copyright © 2013 Wikimedia Foundation and contributors
49 class LegacyHandler
extends AbstractProcessingHandler
{
58 * Filter log events using legacy rules
59 * @var bool $useLegacyFilter
61 protected $useLegacyFilter;
90 * @param string $stream Stream URI
91 * @param bool $useLegacyFilter Filter log events using legacy rules
92 * @param int $level Minimum logging level that will trigger handler
93 * @param bool $bubble Can handled meesages bubble up the handler stack?
95 public function __construct(
97 $useLegacyFilter = false,
98 $level = Logger
::DEBUG
,
101 parent
::__construct( $level, $bubble );
102 $this->uri
= $stream;
103 $this->useLegacyFilter
= $useLegacyFilter;
107 * Open the log sink described by our stream URI.
109 protected function openSink() {
111 throw new LogicException(
112 'Missing stream uri, the stream can not be opened.' );
115 set_error_handler( [ $this, 'errorTrap' ] );
117 if ( substr( $this->uri
, 0, 4 ) == 'udp:' ) {
118 $parsed = parse_url( $this->uri
);
119 if ( !isset( $parsed['host'] ) ) {
120 throw new UnexpectedValueException( sprintf(
121 'Udp transport "%s" must specify a host', $this->uri
124 if ( !isset( $parsed['port'] ) ) {
125 throw new UnexpectedValueException( sprintf(
126 'Udp transport "%s" must specify a port', $this->uri
130 $this->host
= $parsed['host'];
131 $this->port
= $parsed['port'];
134 if ( isset( $parsed['path'] ) ) {
135 $this->prefix
= ltrim( $parsed['path'], '/' );
138 if ( filter_var( $this->host
, FILTER_VALIDATE_IP
, FILTER_FLAG_IPV6
) ) {
145 $this->sink
= socket_create( $domain, SOCK_DGRAM
, SOL_UDP
);
148 $this->sink
= fopen( $this->uri
, 'a' );
150 restore_error_handler();
152 if ( !is_resource( $this->sink
) ) {
154 throw new UnexpectedValueException( sprintf(
155 'The stream or file "%s" could not be opened: %s',
156 $this->uri
, $this->error
162 * Custom error handler.
163 * @param int $code Error number
164 * @param string $msg Error message
166 protected function errorTrap( $code, $msg ) {
171 * Should we use UDP to send messages to the sink?
174 protected function useUdp() {
175 return $this->host
!== null;
178 protected function write( array $record ) {
179 if ( $this->useLegacyFilter
&&
180 !LegacyLogger
::shouldEmit(
181 $record['channel'], $record['message'],
182 $record['level'], $record
184 // Do not write record if we are enforcing legacy rules and they
185 // do not pass this message. This used to be done in isHandling(),
186 // but Monolog 1.12.0 made a breaking change that removed access
187 // to the needed channel and context information.
191 if ( $this->sink
=== null ) {
195 $text = (string)$record['formatted'];
196 if ( $this->useUdp() ) {
197 // Clean it up for the multiplexer
198 if ( $this->prefix
!== '' ) {
199 $leader = ( $this->prefix
=== '{channel}' ) ?
200 $record['channel'] : $this->prefix
;
201 $text = preg_replace( '/^/m', "{$leader} ", $text );
204 if ( strlen( $text ) > 65506 ) {
205 $text = substr( $text, 0, 65506 );
208 if ( substr( $text, -1 ) != "\n" ) {
212 } elseif ( strlen( $text ) > 65507 ) {
213 $text = substr( $text, 0, 65507 );
217 $this->sink
, $text, strlen( $text ), 0, $this->host
, $this->port
221 fwrite( $this->sink
, $text );
225 public function close() {
226 if ( is_resource( $this->sink
) ) {
227 if ( $this->useUdp() ) {
228 socket_close( $this->sink
);
231 fclose( $this->sink
);