includes/debug/logger/monolog/LegacyHandler.php

   1 <?php
   2 /**
   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.
   7  *
   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.
  12  *
  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
  17  *
  18  * @file
  19  */
  20
  21 namespace MediaWiki\Logger\Monolog;
  22
  23 use LogicException;
  24 use MediaWiki\Logger\LegacyLogger;
  25 use Monolog\Handler\AbstractProcessingHandler;
  26 use Monolog\Logger;
  27 use UnexpectedValueException;
  28
  29 /**
  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.
  33  *
  34  * For udp2log output, the stream specification must have the form:
  35  * "udp://HOST:PORT[/PREFIX]"
  36  * where:
  37  * - HOST: IPv4, IPv6 or hostname
  38  * - PORT: server port
  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.
  42  *
  43  * When not targeting a udp2log stream this class will act as a drop-in
  44  * replacement for \Monolog\Handler\StreamHandler.
  45  *
  46  * @since 1.25
  47  * @author Bryan Davis <bd808@wikimedia.org>
  48  * @copyright © 2013 Bryan Davis and Wikimedia Foundation.
  49  */
  50 class LegacyHandler extends AbstractProcessingHandler {
  51
  52         /**
  53          * Log sink descriptor
  54          * @var string $uri
  55          */
  56         protected $uri;
  57
  58         /**
  59          * Filter log events using legacy rules
  60          * @var bool $useLegacyFilter
  61          */
  62         protected $useLegacyFilter;
  63
  64         /**
  65          * Log sink
  66          * @var resource $sink
  67          */
  68         protected $sink;
  69
  70         /**
  71          * @var string $error
  72          */
  73         protected $error;
  74
  75         /**
  76          * @var string $host
  77          */
  78         protected $host;
  79
  80         /**
  81          * @var int $port
  82          */
  83         protected $port;
  84
  85         /**
  86          * @var string $prefix
  87          */
  88         protected $prefix;
  89
  90         /**
  91          * @param string $stream Stream URI
  92          * @param bool $useLegacyFilter Filter log events using legacy rules
  93          * @param int $level Minimum logging level that will trigger handler
  94          * @param bool $bubble Can handled meesages bubble up the handler stack?
  95          */
  96         public function __construct(
  97                 $stream,
  98                 $useLegacyFilter = false,
  99                 $level = Logger::DEBUG,
 100                 $bubble = true
 101         ) {
 102                 parent::__construct( $level, $bubble );
 103                 $this->uri = $stream;
 104                 $this->useLegacyFilter = $useLegacyFilter;
 105         }
 106
 107         /**
 108          * Open the log sink described by our stream URI.
 109          */
 110         protected function openSink() {
 111                 if ( !$this->uri ) {
 112                         throw new LogicException(
 113                                 'Missing stream uri, the stream can not be opened.' );
 114                 }
 115                 $this->error = null;
 116                 set_error_handler( [ $this, 'errorTrap' ] );
 117
 118                 if ( substr( $this->uri, 0, 4 ) == 'udp:' ) {
 119                         $parsed = parse_url( $this->uri );
 120                         if ( !isset( $parsed['host'] ) ) {
 121                                 throw new UnexpectedValueException( sprintf(
 122                                         'Udp transport "%s" must specify a host', $this->uri
 123                                 ) );
 124                         }
 125                         if ( !isset( $parsed['port'] ) ) {
 126                                 throw new UnexpectedValueException( sprintf(
 127                                         'Udp transport "%s" must specify a port', $this->uri
 128                                 ) );
 129                         }
 130
 131                         $this->host = $parsed['host'];
 132                         $this->port = $parsed['port'];
 133                         $this->prefix = '';
 134
 135                         if ( isset( $parsed['path'] ) ) {
 136                                 $this->prefix = ltrim( $parsed['path'], '/' );
 137                         }
 138
 139                         if ( filter_var( $this->host, FILTER_VALIDATE_IP, FILTER_FLAG_IPV6 ) ) {
 140                                 $domain = AF_INET6;
 141
 142                         } else {
 143                                 $domain = AF_INET;
 144                         }
 145
 146                         $this->sink = socket_create( $domain, SOCK_DGRAM, SOL_UDP );
 147
 148                 } else {
 149                         $this->sink = fopen( $this->uri, 'a' );
 150                 }
 151                 restore_error_handler();
 152
 153                 if ( !is_resource( $this->sink ) ) {
 154                         $this->sink = null;
 155                         throw new UnexpectedValueException( sprintf(
 156                                 'The stream or file "%s" could not be opened: %s',
 157                                 $this->uri, $this->error
 158                         ) );
 159                 }
 160         }
 161
 162         /**
 163          * Custom error handler.
 164          * @param int $code Error number
 165          * @param string $msg Error message
 166          */
 167         protected function errorTrap( $code, $msg ) {
 168                 $this->error = $msg;
 169         }
 170
 171         /**
 172          * Should we use UDP to send messages to the sink?
 173          * @return bool
 174          */
 175         protected function useUdp() {
 176                 return $this->host !== null;
 177         }
 178
 179         protected function write( array $record ) {
 180                 if ( $this->useLegacyFilter &&
 181                         !LegacyLogger::shouldEmit(
 182                                 $record['channel'], $record['message'],
 183                                 $record['level'], $record
 184                 ) ) {
 185                         // Do not write record if we are enforcing legacy rules and they
 186                         // do not pass this message. This used to be done in isHandling(),
 187                         // but Monolog 1.12.0 made a breaking change that removed access
 188                         // to the needed channel and context information.
 189                         return;
 190                 }
 191
 192                 if ( $this->sink === null ) {
 193                         $this->openSink();
 194                 }
 195
 196                 $text = (string)$record['formatted'];
 197                 if ( $this->useUdp() ) {
 198
 199                         // Clean it up for the multiplexer
 200                         if ( $this->prefix !== '' ) {
 201                                 $leader = ( $this->prefix === '{channel}' ) ?
 202                                         $record['channel'] : $this->prefix;
 203                                 $text = preg_replace( '/^/m', "{$leader} ", $text );
 204
 205                                 // Limit to 64KB
 206                                 if ( strlen( $text ) > 65506 ) {
 207                                         $text = substr( $text, 0, 65506 );
 208                                 }
 209
 210                                 if ( substr( $text, -1 ) != "\n" ) {
 211                                         $text .= "\n";
 212                                 }
 213
 214                         } elseif ( strlen( $text ) > 65507 ) {
 215                                 $text = substr( $text, 0, 65507 );
 216                         }
 217
 218                         socket_sendto(
 219                                 $this->sink, $text, strlen( $text ), 0, $this->host, $this->port
 220                         );
 221
 222                 } else {
 223                         fwrite( $this->sink, $text );
 224                 }
 225         }
 226
 227         public function close() {
 228                 if ( is_resource( $this->sink ) ) {
 229                         if ( $this->useUdp() ) {
 230                                 socket_close( $this->sink );
 231
 232                         } else {
 233                                 fclose( $this->sink );
 234                         }
 235                 }
 236                 $this->sink = null;
 237         }
 238 }