From 867ec0704035708b91a3003275732a25e0f55644 Mon Sep 17 00:00:00 2001 From: Thiemo Kreuz Date: Mon, 25 Feb 2019 10:16:30 +0100 Subject: [PATCH] media: Mark public MediaHandler/ImageHandler methods as such Note I'm intentionally not touching the entire file, but only methods I'm absolutely sure are already called from outside, e.g. from MediaHandlerFactory, and must be public because of this. I'm intentionally not doing anything with private or protected in this patch, as such changes are much more fragile. This is a direct follow up for the changes proposed in Iaa4f60d. Change-Id: Ida817b289ddd5e9a8c162cc1fa3335c639a0bbe5 --- includes/media/BitmapHandler.php | 2 +- includes/media/BitmapHandler_ClientOnly.php | 2 +- includes/media/BmpHandler.php | 2 +- includes/media/DjVuHandler.php | 12 +++++------ includes/media/ExifBitmapHandler.php | 4 ++-- includes/media/GIFHandler.php | 8 ++++---- includes/media/ImageHandler.php | 2 +- includes/media/JpegHandler.php | 4 ++-- includes/media/MediaHandler.php | 20 +++++++++---------- includes/media/PNGHandler.php | 8 ++++---- includes/media/SvgHandler.php | 12 +++++------ includes/media/TiffHandler.php | 4 ++-- .../media/TransformationalImageHandler.php | 2 +- includes/media/XCFHandler.php | 2 +- tests/phpunit/mocks/media/MockDjVuHandler.php | 2 +- 15 files changed, 43 insertions(+), 43 deletions(-) diff --git a/includes/media/BitmapHandler.php b/includes/media/BitmapHandler.php index e2d32cfbe1..b8b706d488 100644 --- a/includes/media/BitmapHandler.php +++ b/includes/media/BitmapHandler.php @@ -91,7 +91,7 @@ class BitmapHandler extends TransformationalImageHandler { * @param array &$params * @return bool */ - function normaliseParams( $image, &$params ) { + public function normaliseParams( $image, &$params ) { global $wgMaxInterlacingAreas; if ( !parent::normaliseParams( $image, $params ) ) { return false; diff --git a/includes/media/BitmapHandler_ClientOnly.php b/includes/media/BitmapHandler_ClientOnly.php index fa5b0a61c6..8e7998e92e 100644 --- a/includes/media/BitmapHandler_ClientOnly.php +++ b/includes/media/BitmapHandler_ClientOnly.php @@ -37,7 +37,7 @@ class BitmapHandler_ClientOnly extends BitmapHandler { * @param array &$params * @return bool */ - function normaliseParams( $image, &$params ) { + public function normaliseParams( $image, &$params ) { return ImageHandler::normaliseParams( $image, $params ); } diff --git a/includes/media/BmpHandler.php b/includes/media/BmpHandler.php index ed6e76fb36..09cbdac23f 100644 --- a/includes/media/BmpHandler.php +++ b/includes/media/BmpHandler.php @@ -44,7 +44,7 @@ class BmpHandler extends BitmapHandler { * @param array|null $params * @return array */ - function getThumbType( $text, $mime, $params = null ) { + public function getThumbType( $text, $mime, $params = null ) { return [ 'png', 'image/png' ]; } diff --git a/includes/media/DjVuHandler.php b/includes/media/DjVuHandler.php index 00dfb724e5..44135251c7 100644 --- a/includes/media/DjVuHandler.php +++ b/includes/media/DjVuHandler.php @@ -32,7 +32,7 @@ class DjVuHandler extends ImageHandler { /** * @return bool */ - function isEnabled() { + public function isEnabled() { global $wgDjvuRenderer, $wgDjvuDump, $wgDjvuToXML; if ( !$wgDjvuRenderer || ( !$wgDjvuDump && !$wgDjvuToXML ) ) { wfDebug( "DjVu is disabled, please set \$wgDjvuRenderer and \$wgDjvuDump\n" ); @@ -353,7 +353,7 @@ class DjVuHandler extends ImageHandler { return $this->getDjVuImage( $image, $path )->getImageSize(); } - function getThumbType( $ext, $mime, $params = null ) { + public function getThumbType( $ext, $mime, $params = null ) { global $wgDjvuOutputExtension; static $mime; if ( !isset( $mime ) ) { @@ -364,7 +364,7 @@ class DjVuHandler extends ImageHandler { return [ $wgDjvuOutputExtension, $mime ]; } - function getMetadata( $image, $path ) { + public function getMetadata( $image, $path ) { wfDebug( "Getting DjVu metadata for $path\n" ); $xml = $this->getDjVuImage( $image, $path )->retrieveMetaData(); @@ -380,17 +380,17 @@ class DjVuHandler extends ImageHandler { return 'djvuxml'; } - function isMetadataValid( $image, $metadata ) { + public function isMetadataValid( $image, $metadata ) { return !empty( $metadata ) && $metadata != serialize( [] ); } - function pageCount( File $image ) { + public function pageCount( File $image ) { $info = $this->getDimensionInfo( $image ); return $info ? $info['pageCount'] : false; } - function getPageDimensions( File $image, $page ) { + public function getPageDimensions( File $image, $page ) { $index = $page - 1; // MW starts pages at 1 $info = $this->getDimensionInfo( $image ); diff --git a/includes/media/ExifBitmapHandler.php b/includes/media/ExifBitmapHandler.php index 426721095c..1760eb8fff 100644 --- a/includes/media/ExifBitmapHandler.php +++ b/includes/media/ExifBitmapHandler.php @@ -83,7 +83,7 @@ class ExifBitmapHandler extends BitmapHandler { * @param array $metadata * @return bool|int */ - function isMetadataValid( $image, $metadata ) { + public function isMetadataValid( $image, $metadata ) { global $wgShowEXIF; if ( !$wgShowEXIF ) { # Metadata disabled and so an empty field is expected @@ -127,7 +127,7 @@ class ExifBitmapHandler extends BitmapHandler { * @param bool|IContextSource $context Context to use (optional) * @return array|bool */ - function formatMetadata( $image, $context = false ) { + public function formatMetadata( $image, $context = false ) { $meta = $this->getCommonMetaArray( $image ); if ( count( $meta ) === 0 ) { return false; diff --git a/includes/media/GIFHandler.php b/includes/media/GIFHandler.php index d65f872634..556e83c960 100644 --- a/includes/media/GIFHandler.php +++ b/includes/media/GIFHandler.php @@ -29,7 +29,7 @@ class GIFHandler extends BitmapHandler { const BROKEN_FILE = '0'; // value to store in img_metadata if error extracting metadata. - function getMetadata( $image, $filename ) { + public function getMetadata( $image, $filename ) { try { $parsedGIFMetadata = BitmapMetadataHandler::GIF( $filename ); } catch ( Exception $e ) { @@ -47,7 +47,7 @@ class GIFHandler extends BitmapHandler { * @param bool|IContextSource $context Context to use (optional) * @return array|bool */ - function formatMetadata( $image, $context = false ) { + public function formatMetadata( $image, $context = false ) { $meta = $this->getCommonMetaArray( $image ); if ( count( $meta ) === 0 ) { return false; @@ -125,7 +125,7 @@ class GIFHandler extends BitmapHandler { return 'parsed-gif'; } - function isMetadataValid( $image, $metadata ) { + public function isMetadataValid( $image, $metadata ) { if ( $metadata === self::BROKEN_FILE ) { // Do not repetitivly regenerate metadata on broken file. return self::METADATA_GOOD; @@ -156,7 +156,7 @@ class GIFHandler extends BitmapHandler { * @param File $image * @return string */ - function getLongDesc( $image ) { + public function getLongDesc( $image ) { global $wgLang; $original = parent::getLongDesc( $image ); diff --git a/includes/media/ImageHandler.php b/includes/media/ImageHandler.php index e88c1b0a3f..b7042dc76b 100644 --- a/includes/media/ImageHandler.php +++ b/includes/media/ImageHandler.php @@ -238,7 +238,7 @@ abstract class ImageHandler extends MediaHandler { * @param File $file * @return string */ - function getLongDesc( $file ) { + public function getLongDesc( $file ) { global $wgLang; $pages = $file->pageCount(); $size = htmlspecialchars( $wgLang->formatSize( $file->getSize() ) ); diff --git a/includes/media/JpegHandler.php b/includes/media/JpegHandler.php index f7de5f5a0f..eaf842eb04 100644 --- a/includes/media/JpegHandler.php +++ b/includes/media/JpegHandler.php @@ -34,7 +34,7 @@ class JpegHandler extends ExifBitmapHandler { const SRGB_EXIF_COLOR_SPACE = 'sRGB'; const SRGB_ICC_PROFILE_DESCRIPTION = 'sRGB IEC61966-2.1'; - function normaliseParams( $image, &$params ) { + public function normaliseParams( $image, &$params ) { if ( !parent::normaliseParams( $image, $params ) ) { return false; } @@ -98,7 +98,7 @@ class JpegHandler extends ExifBitmapHandler { return $res; } - function getMetadata( $image, $filename ) { + public function getMetadata( $image, $filename ) { try { $meta = BitmapMetadataHandler::Jpeg( $filename ); if ( !is_array( $meta ) ) { diff --git a/includes/media/MediaHandler.php b/includes/media/MediaHandler.php index 66a4291286..a54da7d2aa 100644 --- a/includes/media/MediaHandler.php +++ b/includes/media/MediaHandler.php @@ -87,7 +87,7 @@ abstract class MediaHandler { * @param File $image * @param array &$params */ - abstract function normaliseParams( $image, &$params ); + abstract public function normaliseParams( $image, &$params ); /** * Get an image size array like that returned by getimagesize(), or false if it @@ -119,7 +119,7 @@ abstract class MediaHandler { * @param string $path The filename * @return string A string of metadata in php serialized form (Run through serialize()) */ - function getMetadata( $image, $path ) { + public function getMetadata( $image, $path ) { return ''; } @@ -195,7 +195,7 @@ abstract class MediaHandler { * @param string $metadata The metadata in serialized form * @return bool */ - function isMetadataValid( $image, $metadata ) { + public function isMetadataValid( $image, $metadata ) { return self::METADATA_GOOD; } @@ -287,7 +287,7 @@ abstract class MediaHandler { * @param array|null $params Handler specific rendering parameters * @return array Thumbnail extension and MIME type */ - function getThumbType( $ext, $mime, $params = null ) { + public function getThumbType( $ext, $mime, $params = null ) { $magic = MediaWiki\MediaWikiServices::getInstance()->getMimeAnalyzer(); if ( !$ext || $magic->isMatchingExtension( $ext, $mime ) === false ) { // The extension is not valid for this MIME type and we do @@ -340,7 +340,7 @@ abstract class MediaHandler { * @param File $file * @return bool */ - function pageCount( File $file ) { + public function pageCount( File $file ) { return false; } @@ -381,7 +381,7 @@ abstract class MediaHandler { * False if the handler is disabled for all files * @return bool */ - function isEnabled() { + public function isEnabled() { return true; } @@ -401,7 +401,7 @@ abstract class MediaHandler { * @param int $page What page to get dimensions of * @return array|bool */ - function getPageDimensions( File $image, $page ) { + public function getPageDimensions( File $image, $page ) { $gis = $this->getImageSize( $image, $image->getLocalRefPath() ); if ( $gis ) { return [ @@ -477,7 +477,7 @@ abstract class MediaHandler { * @param bool|IContextSource $context Context to use (optional) * @return array|bool */ - function formatMetadata( $image, $context = false ) { + public function formatMetadata( $image, $context = false ) { return false; } @@ -582,7 +582,7 @@ abstract class MediaHandler { * @param File $file * @return string */ - function getLongDesc( $file ) { + public function getLongDesc( $file ) { return self::getGeneralLongDesc( $file ); } @@ -660,7 +660,7 @@ abstract class MediaHandler { * @param string $fileName The local path to the file. * @return Status */ - function verifyUpload( $fileName ) { + public function verifyUpload( $fileName ) { return Status::newGood(); } diff --git a/includes/media/PNGHandler.php b/includes/media/PNGHandler.php index 6748b26b09..a4b4dc53a0 100644 --- a/includes/media/PNGHandler.php +++ b/includes/media/PNGHandler.php @@ -34,7 +34,7 @@ class PNGHandler extends BitmapHandler { * @param string $filename * @return string */ - function getMetadata( $image, $filename ) { + public function getMetadata( $image, $filename ) { try { $metadata = BitmapMetadataHandler::PNG( $filename ); } catch ( Exception $e ) { @@ -52,7 +52,7 @@ class PNGHandler extends BitmapHandler { * @param bool|IContextSource $context Context to use (optional) * @return array|bool */ - function formatMetadata( $image, $context = false ) { + public function formatMetadata( $image, $context = false ) { $meta = $this->getCommonMetaArray( $image ); if ( count( $meta ) === 0 ) { return false; @@ -111,7 +111,7 @@ class PNGHandler extends BitmapHandler { return 'parsed-png'; } - function isMetadataValid( $image, $metadata ) { + public function isMetadataValid( $image, $metadata ) { if ( $metadata === self::BROKEN_FILE ) { // Do not repetitivly regenerate metadata on broken file. return self::METADATA_GOOD; @@ -142,7 +142,7 @@ class PNGHandler extends BitmapHandler { * @param File $image * @return string */ - function getLongDesc( $image ) { + public function getLongDesc( $image ) { global $wgLang; $original = parent::getLongDesc( $image ); diff --git a/includes/media/SvgHandler.php b/includes/media/SvgHandler.php index e3057f4537..436483b23c 100644 --- a/includes/media/SvgHandler.php +++ b/includes/media/SvgHandler.php @@ -41,7 +41,7 @@ class SvgHandler extends ImageHandler { 'title' => 'ObjectName', ]; - function isEnabled() { + public function isEnabled() { global $wgSVGConverters, $wgSVGConverter; if ( !isset( $wgSVGConverters[$wgSVGConverter] ) ) { wfDebug( "\$wgSVGConverter is invalid, disabling SVG rendering.\n" ); @@ -399,7 +399,7 @@ class SvgHandler extends ImageHandler { } } - function getThumbType( $ext, $mime, $params = null ) { + public function getThumbType( $ext, $mime, $params = null ) { return [ 'png', 'image/png' ]; } @@ -412,7 +412,7 @@ class SvgHandler extends ImageHandler { * @param File $file * @return string */ - function getLongDesc( $file ) { + public function getLongDesc( $file ) { global $wgLang; $metadata = $this->unpackMetadata( $file->getMetadata() ); @@ -438,7 +438,7 @@ class SvgHandler extends ImageHandler { * @param string $filename * @return string Serialised metadata */ - function getMetadata( $file, $filename ) { + public function getMetadata( $file, $filename ) { $metadata = [ 'version' => self::SVG_METADATA_VERSION ]; try { $metadata += SVGMetadataExtractor::getMetadata( $filename ); @@ -469,7 +469,7 @@ class SvgHandler extends ImageHandler { return 'parsed-svg'; } - function isMetadataValid( $image, $metadata ) { + public function isMetadataValid( $image, $metadata ) { $meta = $this->unpackMetadata( $metadata ); if ( $meta === false ) { return self::METADATA_BAD; @@ -493,7 +493,7 @@ class SvgHandler extends ImageHandler { * @param bool|IContextSource $context Context to use (optional) * @return array|bool */ - function formatMetadata( $file, $context = false ) { + public function formatMetadata( $file, $context = false ) { $result = [ 'visible' => [], 'collapsed' => [] diff --git a/includes/media/TiffHandler.php b/includes/media/TiffHandler.php index 441513ee86..15c4dbf1e6 100644 --- a/includes/media/TiffHandler.php +++ b/includes/media/TiffHandler.php @@ -64,7 +64,7 @@ class TiffHandler extends ExifBitmapHandler { * @param array|null $params * @return bool */ - function getThumbType( $ext, $mime, $params = null ) { + public function getThumbType( $ext, $mime, $params = null ) { global $wgTiffThumbnailType; return $wgTiffThumbnailType; @@ -76,7 +76,7 @@ class TiffHandler extends ExifBitmapHandler { * @throws MWException * @return string */ - function getMetadata( $image, $filename ) { + public function getMetadata( $image, $filename ) { global $wgShowEXIF; if ( $wgShowEXIF ) { diff --git a/includes/media/TransformationalImageHandler.php b/includes/media/TransformationalImageHandler.php index ea0d61bf1a..38dc3905b9 100644 --- a/includes/media/TransformationalImageHandler.php +++ b/includes/media/TransformationalImageHandler.php @@ -41,7 +41,7 @@ abstract class TransformationalImageHandler extends ImageHandler { * 'physicalWidth' and 'physicalHeight' indicate the thumbnail dimensions. * @return bool */ - function normaliseParams( $image, &$params ) { + public function normaliseParams( $image, &$params ) { if ( !parent::normaliseParams( $image, $params ) ) { return false; } diff --git a/includes/media/XCFHandler.php b/includes/media/XCFHandler.php index 0cb618ffd8..33f33bd527 100644 --- a/includes/media/XCFHandler.php +++ b/includes/media/XCFHandler.php @@ -49,7 +49,7 @@ class XCFHandler extends BitmapHandler { * @param array|null $params * @return array */ - function getThumbType( $ext, $mime, $params = null ) { + public function getThumbType( $ext, $mime, $params = null ) { return [ 'png', 'image/png' ]; } diff --git a/tests/phpunit/mocks/media/MockDjVuHandler.php b/tests/phpunit/mocks/media/MockDjVuHandler.php index 0e0b9435cd..29cc6b3c07 100644 --- a/tests/phpunit/mocks/media/MockDjVuHandler.php +++ b/tests/phpunit/mocks/media/MockDjVuHandler.php @@ -22,7 +22,7 @@ */ class MockDjVuHandler extends DjVuHandler { - function isEnabled() { + public function isEnabled() { return true; } -- 2.20.1