LegacyHandler.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Logger\Monolog;
 
use LogicException;
use MediaWiki\Logger\LegacyLogger;
use Monolog\Handler\AbstractProcessingHandler;
use Monolog\Logger;
use Socket;
use UnexpectedValueException;
 
class LegacyHandler extends AbstractProcessingHandler {
 
    protected $uri;
 
    protected $useLegacyFilter;
 
    protected $sink;
 
    protected $error;
 
    protected $host;
 
    protected $port;
 
    protected $prefix;
 
    public function __construct(
        $stream,
        $useLegacyFilter = false,
        $level = Logger::DEBUG,
        $bubble = true
    ) {
        parent::__construct( $level, $bubble );
        $this->uri = $stream;
        $this->useLegacyFilter = $useLegacyFilter;
    }
 
    protected function openSink() {
        if ( !$this->uri ) {
            throw new LogicException(
                'Missing stream uri, the stream can not be opened.' );
        }
        $this->error = null;
        set_error_handler( [ $this, 'errorTrap' ] );
 
        if ( str_starts_with( $this->uri, '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 ( !$this->sink ) {
            $this->sink = null;
            throw new UnexpectedValueException( sprintf(
                'The stream or file "%s" could not be opened: %s',
                // @phan-suppress-next-line PhanTypeMismatchArgumentInternalProbablyReal Set by error handler
                $this->uri, $this->error
            ) );
        }
    }
 
    protected function errorTrap( $code, $msg ) {
        $this->error = $msg;
    }
 
    protected function useUdp() {
        return $this->host !== null;
    }
 
    protected function write( array $record ): void {
        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 64 KiB
                if ( strlen( $text ) > 65506 ) {
                    $text = substr( $text, 0, 65506 );
                }
 
                if ( !str_ends_with( $text, "\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(): void {
        if ( $this->sink ) {
            if ( $this->useUdp() ) {
                socket_close( $this->sink );
            } else {
                fclose( $this->sink );
            }
        }
        $this->sink = null;
    }
}