wiki.techinc.nl/includes/media/MediaHandlerFactory.php
Tim Starling 47a1619027 Remove terminating line breaks from debug messages
A terminating line break has not been required in wfDebug() since 2014,
however no migration was done. Some of these line breaks found their way
into LoggerInterface::debug() calls, where they mess up the formatting
of the debug log.

So, remove terminating line breaks from wfDebug() and
LoggerInterface::debug() calls.

Also:
* Fix the stripping of leading line breaks from the log header emitted
  by Setup.php. This feature, accidentally broken in 2014, allows
  requests to be distinguished in the log file.
* Avoid using the global variable $self.
* Move the logging of the client IP back to Setup.php. It was moved to
  WebRequest in the hopes that it would not always be needed, however
  $wgRequest->getIP() is now called unconditionally a few lines up in
  Setup.php. This means that it is put in its proper place after the
  "start request" message.
* Wrap the log header code in a closure so that variables like $name do
  not leak into global scope.
* In Linker.php, remove a few instances of an unnecessary second
  parameter to wfDebug().

Change-Id: I96651d3044a95b9d210b51cb8368edc76bebbb9e
2020-06-03 12:01:16 +10:00

97 lines
2.5 KiB
PHP

<?php
/**
* Media-handling base classes and generic functionality.
*
* 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
* @ingroup Media
*/
/**
* Class to construct MediaHandler objects
*
* @since 1.28
*/
class MediaHandlerFactory {
/**
* Default, MediaWiki core media handlers
*
* @var array
*/
private const CORE_HANDLERS = [
'image/jpeg' => JpegHandler::class,
'image/png' => PNGHandler::class,
'image/gif' => GIFHandler::class,
'image/tiff' => TiffHandler::class,
'image/webp' => WebPHandler::class,
'image/x-ms-bmp' => BmpHandler::class,
'image/x-bmp' => BmpHandler::class,
'image/x-xcf' => XCFHandler::class,
'image/svg+xml' => SvgHandler::class, // official
'image/svg' => SvgHandler::class, // compat
'image/vnd.djvu' => DjVuHandler::class, // official
'image/x.djvu' => DjVuHandler::class, // compat
'image/x-djvu' => DjVuHandler::class, // compat
];
/**
* @var array
*/
private $registry;
/**
* Instance cache of MediaHandler objects by mimetype
*
* @var MediaHandler[]
*/
private $handlers;
public function __construct( array $registry ) {
$this->registry = $registry + self::CORE_HANDLERS;
}
protected function getHandlerClass( $type ) {
return $this->registry[$type] ?? false;
}
/**
* @param string $type mimetype
* @return bool|MediaHandler
*/
public function getHandler( $type ) {
if ( isset( $this->handlers[$type] ) ) {
return $this->handlers[$type];
}
$class = $this->getHandlerClass( $type );
if ( $class !== false ) {
/** @var MediaHandler $handler */
$handler = new $class;
if ( !$handler->isEnabled() ) {
wfDebug( __METHOD__ . ": $class is not enabled" );
$handler = false;
}
} else {
wfDebug( __METHOD__ . ": no handler found for $type." );
$handler = false;
}
$this->handlers[$type] = $handler;
return $handler;
}
}