includes/gallery/ImageGalleryBase.php
<?php
/**
* Image gallery.
*
* 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
*/
use MediaWiki\Context\ContextSource;
use MediaWiki\Context\IContextSource;
use MediaWiki\Context\RequestContext;
use MediaWiki\HookContainer\HookRunner;
use MediaWiki\MainConfigNames;
use MediaWiki\MediaWikiServices;
use MediaWiki\Parser\Parser;
use MediaWiki\Title\Title;
/**
* Image gallery
*
* Add images to the gallery using add(), then render that list to HTML using toHTML().
* @stable to extend
* @ingroup Media
*/
abstract class ImageGalleryBase extends ContextSource {
public const LOADING_DEFAULT = 1;
public const LOADING_LAZY = 2;
/**
* @var array[] Gallery images
* @phan-var array<int,array{0:Title,1:string,2:string,3:string,4:array,5:int}>
*/
protected $mImages;
/**
* @var bool Whether to show the filesize in bytes in categories
*/
protected $mShowBytes;
/**
* @var bool Whether to show the dimensions in categories
*/
protected $mShowDimensions;
/**
* @var bool Whether to show the filename. Default: true
*/
protected $mShowFilename;
/**
* @var string Gallery mode. Default: traditional
*/
protected $mMode;
/**
* @var string|false Gallery caption. Default: false
*/
protected $mCaption = false;
/**
* Length to truncate filename to in caption when using "showfilename".
* A value of 'true' will truncate the filename to one line using CSS
* and will be the behaviour after deprecation.
*
* @var bool|int
*/
protected $mCaptionLength = true;
/**
* @var bool Hide bad images?
*/
protected $mHideBadImages;
/**
* @var Parser|false Registered parser object for output callbacks
*/
public $mParser;
/**
* @var Title|null Contextual title, used when images are being screened against
* the bad image list
*/
protected $contextTitle = null;
/** @var array */
protected $mAttribs = [];
/** @var int */
protected $mPerRow;
/** @var int */
protected $mWidths;
/** @var int */
protected $mHeights;
/** @var array */
private static $modeMapping;
/**
* Get a new image gallery. This is the method other callers
* should use to get a gallery.
*
* @param string|false $mode Mode to use. False to use the default
* @param IContextSource|null $context
* @return ImageGalleryBase
* @throws ImageGalleryClassNotFoundException
*/
public static function factory( $mode = false, IContextSource $context = null ) {
self::loadModes();
if ( !$context ) {
$context = RequestContext::getMainAndWarn( __METHOD__ );
}
if ( !$mode ) {
$galleryOptions = $context->getConfig()->get( MainConfigNames::GalleryOptions );
$mode = $galleryOptions['mode'];
}
$mode = MediaWikiServices::getInstance()->getContentLanguage()->lc( $mode );
if ( isset( self::$modeMapping[$mode] ) ) {
$class = self::$modeMapping[$mode];
return new $class( $mode, $context );
} else {
throw new ImageGalleryClassNotFoundException( "No gallery class registered for mode $mode" );
}
}
private static function loadModes() {
if ( self::$modeMapping === null ) {
self::$modeMapping = [
'traditional' => TraditionalImageGallery::class,
'nolines' => NolinesImageGallery::class,
'packed' => PackedImageGallery::class,
'packed-hover' => PackedHoverImageGallery::class,
'packed-overlay' => PackedOverlayImageGallery::class,
'slideshow' => SlideshowImageGallery::class,
];
// Allow extensions to make a new gallery format.
( new HookRunner( MediaWikiServices::getInstance()->getHookContainer() ) )
->onGalleryGetModes( self::$modeMapping );
}
}
/**
* Create a new image gallery object.
*
* You should not call this directly, but instead use
* ImageGalleryBase::factory().
*
* @stable to call
* @note constructors of subclasses must have a compatible signature
* for use by the factory() method.
*
* @param string $mode
* @param IContextSource|null $context
*/
public function __construct( $mode = 'traditional', IContextSource $context = null ) {
if ( $context ) {
$this->setContext( $context );
}
$galleryOptions = $this->getConfig()->get( MainConfigNames::GalleryOptions );
$this->mImages = [];
$this->mShowBytes = $galleryOptions['showBytes'];
$this->mShowDimensions = $galleryOptions['showDimensions'];
$this->mShowFilename = true;
$this->mParser = false;
$this->mHideBadImages = false;
$this->mPerRow = $galleryOptions['imagesPerRow'];
$this->mWidths = $galleryOptions['imageWidth'];
$this->mHeights = $galleryOptions['imageHeight'];
$this->mCaptionLength = $galleryOptions['captionLength'];
$this->mMode = $mode;
}
/**
* Register a parser object. If you do not set this
* and the output of this gallery ends up in parser
* cache, the javascript will break!
*
* @note This also triggers using the page's target
* language instead of the user language.
*
* @param Parser $parser
*/
public function setParser( $parser ) {
$this->mParser = $parser;
}
/**
* @param bool $flag
*/
public function setHideBadImages( $flag = true ) {
$this->mHideBadImages = $flag;
}
/**
* Set the caption (as plain text)
*
* @param string $caption
*/
public function setCaption( $caption ) {
$this->mCaption = htmlspecialchars( $caption );
}
/**
* Set the caption (as HTML)
*
* @param string $caption
*/
public function setCaptionHtml( $caption ) {
$this->mCaption = $caption;
}
/**
* Set how many images will be displayed per row.
*
* @param int $num Integer >= 0; If perrow=0 the gallery layout will adapt
* to screensize invalid numbers will be rejected
*/
public function setPerRow( $num ) {
if ( $num >= 0 ) {
$this->mPerRow = (int)$num;
}
}
/**
* Set how wide each image will be, in pixels.
*
* @param string $num Number. Unit other than 'px is invalid. Invalid numbers
* and those below 0 are ignored.
*/
public function setWidths( $num ) {
$parsed = Parser::parseWidthParam( $num, false );
if ( isset( $parsed['width'] ) && $parsed['width'] > 0 ) {
$this->mWidths = $parsed['width'];
}
}
/**
* Set how high each image will be, in pixels.
*
* @param string $num Number. Unit other than 'px is invalid. Invalid numbers
* and those below 0 are ignored.
*/
public function setHeights( $num ) {
$parsed = Parser::parseWidthParam( $num, false );
if ( isset( $parsed['width'] ) && $parsed['width'] > 0 ) {
$this->mHeights = $parsed['width'];
}
}
/**
* Allow setting additional options. This is meant
* to allow extensions to add additional parameters to
* <gallery> parser tag.
*
* @stable to override
*
* @param array $options Attributes of gallery tag
*/
public function setAdditionalOptions( $options ) {
}
/**
* Add an image to the gallery.
*
* @param Title $title Title object of the image that is added to the gallery
* @param string $html Additional HTML text to be shown. The name and size
* of the image are always shown.
* @param string|null $alt Alt text for the image, or null to omit
* @param string $link Override image link (optional)
* @param array $handlerOpts Array of options for image handler (aka page number)
* @param int $loading Sets loading attribute of the underlying <img> (optional)
* @param ?array $imageOptions To supercede the $link param
*/
public function add(
$title,
$html = '',
$alt = '',
$link = '',
$handlerOpts = [],
$loading = self::LOADING_DEFAULT,
?array $imageOptions = null
) {
if ( $title instanceof File ) {
// Old calling convention
$title = $title->getTitle();
}
$this->mImages[] = [ $title, $html, $alt, $link, $handlerOpts, $loading, $imageOptions ];
wfDebug( 'ImageGallery::add ' . $title->getText() );
}
/**
* Add an image at the beginning of the gallery.
*
* @param Title $title Title object of the image that is added to the gallery
* @param string $html Additional HTML text to be shown. The name and size
* of the image are always shown.
* @param string $alt Alt text for the image
* @param string $link Override image link (optional)
* @param array $handlerOpts Array of options for image handler (aka page number)
* @param int $loading Sets loading attribute of the underlying <img> (optional)
* @param ?array $imageOptions To supercede the $link param
*/
public function insert(
$title,
$html = '',
$alt = '',
$link = '',
$handlerOpts = [],
$loading = self::LOADING_DEFAULT,
?array $imageOptions = null
) {
if ( $title instanceof File ) {
// Old calling convention
$title = $title->getTitle();
}
array_unshift( $this->mImages, [ &$title, $html, $alt, $link, $handlerOpts, $loading, $imageOptions ] );
}
/**
* Returns the list of images this gallery contains
* @return array[]
* @phan-return array<int,array{0:Title,1:string,2:string,3:string,4:array}>
*/
public function getImages() {
return $this->mImages;
}
/**
* isEmpty() returns true if the gallery contains no images
* @return bool
*/
public function isEmpty() {
return $this->mImages === [];
}
/**
* Enable/Disable showing of the dimensions of an image in the gallery.
* Enabled by default.
*
* @param bool $f Set to false to disable
*/
public function setShowDimensions( $f ) {
$this->mShowDimensions = (bool)$f;
}
/**
* Enable/Disable showing of the file size of an image in the gallery.
* Enabled by default.
*
* @param bool $f Set to false to disable
*/
public function setShowBytes( $f ) {
$this->mShowBytes = (bool)$f;
}
/**
* Enable/Disable showing of the filename of an image in the gallery.
* Enabled by default.
*
* @param bool $f Set to false to disable
*/
public function setShowFilename( $f ) {
$this->mShowFilename = (bool)$f;
}
/**
* Set arbitrary attributes to go on the HTML gallery output element.
* Should be suitable for a <ul> element.
*
* Note -- if taking from user input, you should probably run through
* Sanitizer::validateAttributes() first.
*
* @param array $attribs Array of HTML attribute pairs
*/
public function setAttributes( $attribs ) {
$this->mAttribs = $attribs;
}
/**
* Display an html representation of the gallery
*
* @return string The html
*/
abstract public function toHTML();
/**
* @return int Number of images in the gallery
*/
public function count() {
return count( $this->mImages );
}
/**
* Set the contextual title
*
* @param Title|null $title Contextual title
*/
public function setContextTitle( $title ) {
$this->contextTitle = $title;
}
/**
* Get the contextual title, if applicable
*
* @return Title|null
*/
public function getContextTitle() {
return $this->contextTitle;
}
/**
* Determines the correct language to be used for this image gallery
* @return Language
*/
protected function getRenderLang() {
return $this->mParser
? $this->mParser->getTargetLanguage()
: $this->getLanguage();
}
}