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 * @author Bryan Davis <bd808@wikimedia.org>
48 * @copyright © 2013 Bryan Davis and Wikimedia Foundation.
50 class LegacyHandler
extends AbstractProcessingHandler
{
59 * Filter log events using legacy rules
60 * @var bool $useLegacyFilter
62 protected $useLegacyFilter;
92 * @param string $stream Stream URI
93 * @param bool $useLegacyFilter Filter log events using legacy rules
94 * @param int $level Minimum logging level that will trigger handler
95 * @param bool $bubble Can handled meesages bubble up the handler stack?
97 public function __construct(
99 $useLegacyFilter = false,
100 $level = Logger
::DEBUG
,
103 parent
::__construct( $level, $bubble );
104 $this->uri
= $stream;
105 $this->useLegacyFilter
= $useLegacyFilter;
109 * Open the log sink described by our stream URI.
111 protected function openSink() {
113 throw new LogicException(
114 'Missing stream uri, the stream can not be opened.' );
117 set_error_handler( array( $this, 'errorTrap' ) );
119 if ( substr( $this->uri
, 0, 4 ) == 'udp:' ) {
120 $parsed = parse_url( $this->uri
);
121 if ( !isset( $parsed['host'] ) ) {
122 throw new UnexpectedValueException( sprintf(
123 'Udp transport "%s" must specify a host', $this->uri
126 if ( !isset( $parsed['port'] ) ) {
127 throw new UnexpectedValueException( sprintf(
128 'Udp transport "%s" must specify a port', $this->uri
132 $this->host
= $parsed['host'];
133 $this->port
= $parsed['port'];
136 if ( isset( $parsed['path'] ) ) {
137 $this->prefix
= ltrim( $parsed['path'], '/' );
140 if ( filter_var( $this->host
, FILTER_VALIDATE_IP
, FILTER_FLAG_IPV6
) ) {
147 $this->sink
= socket_create( $domain, SOCK_DGRAM
, SOL_UDP
);
150 $this->sink
= fopen( $this->uri
, 'a' );
152 restore_error_handler();
154 if ( !is_resource( $this->sink
) ) {
156 throw new UnexpectedValueException( sprintf(
157 'The stream or file "%s" could not be opened: %s',
158 $this->uri
, $this->error
165 * Custom error handler.
166 * @param int $code Error number
167 * @param string $msg Error message
169 protected function errorTrap( $code, $msg ) {
175 * Should we use UDP to send messages to the sink?
178 protected function useUdp() {
179 return $this->host
!== null;
183 protected function write( array $record ) {
184 if ( $this->useLegacyFilter
&&
185 !LegacyLogger
::shouldEmit(
186 $record['channel'], $record['message'],
187 $record['level'], $record
189 // Do not write record if we are enforcing legacy rules and they
190 // do not pass this message. This used to be done in isHandling(),
191 // but Monolog 1.12.0 made a breaking change that removed access
192 // to the needed channel and context information.
196 if ( $this->sink
=== null ) {
200 $text = (string)$record['formatted'];
201 if ( $this->useUdp() ) {
203 // Clean it up for the multiplexer
204 if ( $this->prefix
!== '' ) {
205 $leader = ( $this->prefix
=== '{channel}' ) ?
206 $record['channel'] : $this->prefix
;
207 $text = preg_replace( '/^/m', "{$leader} ", $text );
210 if ( strlen( $text ) > 65506 ) {
211 $text = substr( $text, 0, 65506 );
214 if ( substr( $text, -1 ) != "\n" ) {
218 } elseif ( strlen( $text ) > 65507 ) {
219 $text = substr( $text, 0, 65507 );
223 $this->sink
, $text, strlen( $text ), 0, $this->host
, $this->port
227 fwrite( $this->sink
, $text );
232 public function close() {
233 if ( is_resource( $this->sink
) ) {
234 if ( $this->useUdp() ) {
235 socket_close( $this->sink
);
238 fclose( $this->sink
);