includes/media/MediaHandlerFactory.php

   1 <?php
   2 /**
   3  * Media-handling base classes and generic functionality.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @ingroup Media
  22  */
  23
  24 /**
  25  * Class to construct MediaHandler objects
  26  *
  27  * @since 1.28
  28  */
  29 class MediaHandlerFactory {
  30
  31         /**
  32          * Default, MediaWiki core media handlers
  33          *
  34          * @var array
  35          */
  36         private static $coreHandlers = [
  37                 'image/jpeg' => JpegHandler::class,
  38                 'image/png' => PNGHandler::class,
  39                 'image/gif' => GIFHandler::class,
  40                 'image/tiff' => TiffHandler::class,
  41                 'image/webp' => WebPHandler::class,
  42                 'image/x-ms-bmp' => BmpHandler::class,
  43                 'image/x-bmp' => BmpHandler::class,
  44                 'image/x-xcf' => XCFHandler::class,
  45                 'image/svg+xml' => SvgHandler::class, // official
  46                 'image/svg' => SvgHandler::class, // compat
  47                 'image/vnd.djvu' => DjVuHandler::class, // official
  48                 'image/x.djvu' => DjVuHandler::class, // compat
  49                 'image/x-djvu' => DjVuHandler::class, // compat
  50         ];
  51
  52         /**
  53          * @var array
  54          */
  55         private $registry;
  56
  57         /**
  58          * Instance cache of MediaHandler objects by mimetype
  59          *
  60          * @var MediaHandler[]
  61          */
  62         private $handlers;
  63
  64         public function __construct( array $registry ) {
  65                 $this->registry = $registry + self::$coreHandlers;
  66         }
  67
  68         protected function getHandlerClass( $type ) {
  69                 return $this->registry[$type] ?? false;
  70         }
  71
  72         /**
  73          * @param string $type mimetype
  74          * @return bool|MediaHandler
  75          */
  76         public function getHandler( $type ) {
  77                 if ( isset( $this->handlers[$type] ) ) {
  78                         return $this->handlers[$type];
  79                 }
  80
  81                 $class = $this->getHandlerClass( $type );
  82                 if ( $class !== false ) {
  83                         /** @var MediaHandler $handler */
  84                         $handler = new $class;
  85                         if ( !$handler->isEnabled() ) {
  86                                 wfDebug( __METHOD__ . ": $class is not enabled\n" );
  87                                 $handler = false;
  88                         }
  89                 } else {
  90                         wfDebug( __METHOD__ . ": no handler found for $type.\n" );
  91                         $handler = false;
  92                 }
  93
  94                 $this->handlers[$type] = $handler;
  95                 return $handler;
  96         }
  97 }