56b70b61af
Time wounds all heels. During the code review for the PSR-3 logging introduction, several people asked me why we needed a wrapper for Psr\Log\LoggerInterface if the point was to use the standard. At the time I was convinced that it would be better to introduce the dependency via a wrapper class so that we could use the wrapper to patch over any deficiencies that we might find in the PSR-3 API. After going on to work on a project to disentangle other MediaWiki components from internal project dependencies I have suddenly and clearly seen the error of my ways. We still need a logger factory as PSR-3 does not specify a standard mechanism for creating Psr\Log\LoggerInterface instances. My solution is to convert MWLogger into MWLoggerFactory to retain a static factory interface for creating PSR-3 loggers but remove the MWLogger wrapper class itself in favor of direct exposure of Psr\Log\LoggerInterface to the MediaWiki consumer classes. Change-Id: Ie47467657dcf341991ada00827dca5e8eff95438
115 lines
3.7 KiB
PHP
115 lines
3.7 KiB
PHP
<?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
|
|
*/
|
|
|
|
|
|
/**
|
|
* PSR-3 logger instance factory.
|
|
*
|
|
* Creation of \Psr\Log\LoggerInterface instances is managed via the
|
|
* MWLoggerFactory::getInstance() static method which in turn delegates to the
|
|
* currently registered service provider.
|
|
*
|
|
* A service provider is any class implementing the MWLoggerSpi interface.
|
|
* There are two possible methods of registering a service provider. The
|
|
* MWLoggerFactory::registerProvider() static method can be called at any time
|
|
* to change the service provider. If MWLoggerFactory::getInstance() is called
|
|
* before any service provider has been registered, it will attempt to use the
|
|
* $wgMWLoggerDefaultSpi global to bootstrap MWLoggerSpi registration.
|
|
* $wgMWLoggerDefaultSpi is expected to be an array usable by
|
|
* ObjectFactory::getObjectFromSpec() to create a class.
|
|
*
|
|
* @see MWLoggerSpi
|
|
* @since 1.25
|
|
* @author Bryan Davis <bd808@wikimedia.org>
|
|
* @copyright © 2014 Bryan Davis and Wikimedia Foundation.
|
|
*/
|
|
class MWLoggerFactory {
|
|
|
|
/**
|
|
* Service provider.
|
|
* @var MWLoggerSpi $spi
|
|
*/
|
|
private static $spi;
|
|
|
|
|
|
/**
|
|
* Register a service provider to create new \Psr\Log\LoggerInterface
|
|
* instances.
|
|
*
|
|
* @param MWLoggerSpi $provider Provider to register
|
|
*/
|
|
public static function registerProvider( MWLoggerSpi $provider ) {
|
|
self::$spi = $provider;
|
|
}
|
|
|
|
|
|
/**
|
|
* Get the registered service provider.
|
|
*
|
|
* If called before any service provider has been registered, it will
|
|
* attempt to use the $wgMWLoggerDefaultSpi global to bootstrap
|
|
* MWLoggerSpi registration. $wgMWLoggerDefaultSpi is expected to be an
|
|
* array usable by ObjectFactory::getObjectFromSpec() to create a class.
|
|
*
|
|
* @return MWLoggerSpi
|
|
* @see registerProvider()
|
|
* @see ObjectFactory::getObjectFromSpec()
|
|
*/
|
|
public static function getProvider() {
|
|
if ( self::$spi === null ) {
|
|
global $wgMWLoggerDefaultSpi;
|
|
$provider = ObjectFactory::getObjectFromSpec(
|
|
$wgMWLoggerDefaultSpi
|
|
);
|
|
self::registerProvider( $provider );
|
|
}
|
|
return self::$spi;
|
|
}
|
|
|
|
|
|
/**
|
|
* Get a named logger instance from the currently configured logger factory.
|
|
*
|
|
* @param string $channel Logger channel (name)
|
|
* @return \Psr\Log\LoggerInterface
|
|
*/
|
|
public static function getInstance( $channel ) {
|
|
if ( !interface_exists( '\Psr\Log\LoggerInterface' ) ) {
|
|
$message = <<<TXT
|
|
MediaWiki requires the <a href="https://github.com/php-fig/log">PSR-3 logging library</a> to be present. This library is not embedded directly in MediaWiki's git repository and must be installed separately by the end user.
|
|
|
|
Please see <a href="https://www.mediawiki.org/wiki/Download_from_Git#Fetch_external_libraries">mediawiki.org</a> for help on installing the required components.
|
|
TXT;
|
|
echo $message;
|
|
trigger_error( $message, E_USER_ERROR );
|
|
die( 1 );
|
|
}
|
|
|
|
return self::getProvider()->getLogger( $channel );
|
|
}
|
|
|
|
|
|
/**
|
|
* Construction of utility class is not allowed.
|
|
*/
|
|
private function __construct() {
|
|
// no-op
|
|
}
|
|
}
|