From 4ac9fa081a7c045f6a9f1cfc529d82423f485b2e Mon Sep 17 00:00:00 2001 From: Pierre Schmitz Date: Sun, 8 Dec 2013 09:55:49 +0100 Subject: Update to MediaWiki 1.22.0 --- includes/gallery/ImageGalleryBase.php | 331 +++++++++++++++++++++++++ includes/gallery/NolinesImageGallery.php | 38 +++ includes/gallery/PackedImageGallery.php | 105 ++++++++ includes/gallery/PackedOverlayImageGallery.php | 60 +++++ includes/gallery/TraditionalImageGallery.php | 328 ++++++++++++++++++++++++ 5 files changed, 862 insertions(+) create mode 100644 includes/gallery/ImageGalleryBase.php create mode 100644 includes/gallery/NolinesImageGallery.php create mode 100644 includes/gallery/PackedImageGallery.php create mode 100644 includes/gallery/PackedOverlayImageGallery.php create mode 100644 includes/gallery/TraditionalImageGallery.php (limited to 'includes/gallery') diff --git a/includes/gallery/ImageGalleryBase.php b/includes/gallery/ImageGalleryBase.php new file mode 100644 index 00000000..f8b8c505 --- /dev/null +++ b/includes/gallery/ImageGalleryBase.php @@ -0,0 +1,331 @@ +lc( $mode ); + + if ( isset( self::$modeMapping[$mode] ) ) { + return new self::$modeMapping[$mode]( $mode ); + } else { + throw new MWException( "No gallery class registered for mode $mode" ); + } + } + + static private function loadModes() { + if ( self::$modeMapping === false ) { + self::$modeMapping = array( + 'traditional' => 'TraditionalImageGallery', + 'nolines' => 'NolinesImageGallery', + 'packed' => 'PackedImageGallery', + 'packed-hover' => 'PackedHoverImageGallery', + 'packed-overlay' => 'PackedOverlayImageGallery', + ); + // Allow extensions to make a new gallery format. + wfRunHooks( 'GalleryGetModes', self::$modeMapping ); + } + } + + /** + * Create a new image gallery object. + * + * You should not call this directly, but instead use + * ImageGalleryBase::factory(). + */ + function __construct( $mode = 'traditional' ) { + global $wgGalleryOptions; + $this->mImages = array(); + $this->mShowBytes = $wgGalleryOptions['showBytes']; + $this->mShowFilename = true; + $this->mParser = false; + $this->mHideBadImages = false; + $this->mPerRow = $wgGalleryOptions['imagesPerRow']; + $this->mWidths = $wgGalleryOptions['imageWidth']; + $this->mHeights = $wgGalleryOptions['imageHeight']; + $this->mCaptionLength = $wgGalleryOptions['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 + */ + function setParser( $parser ) { + $this->mParser = $parser; + } + + /** + * Set bad image flag + */ + function setHideBadImages( $flag = true ) { + $this->mHideBadImages = $flag; + } + + /** + * Set the caption (as plain text) + * + * @param string $caption Caption + */ + function setCaption( $caption ) { + $this->mCaption = htmlspecialchars( $caption ); + } + + /** + * Set the caption (as HTML) + * + * @param string $caption Caption + */ + public function setCaptionHtml( $caption ) { + $this->mCaption = $caption; + } + + /** + * Set how many images will be displayed per row. + * + * @param $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 $num Integer > 0; invalid numbers will be ignored + */ + public function setWidths( $num ) { + if ( $num > 0 ) { + $this->mWidths = (int)$num; + } + } + + /** + * Set how high each image will be, in pixels. + * + * @param $num Integer > 0; invalid numbers will be ignored + */ + public function setHeights( $num ) { + if ( $num > 0 ) { + $this->mHeights = (int)$num; + } + } + + /** + * Allow setting additional options. This is meant + * to allow extensions to add additional parameters to + * parser tag. + * + * @param Array $options Attributes of gallery tag. + */ + public function setAdditionalOptions( $options ) { } + + /** + * Instruct the class to use a specific skin for rendering + * + * @param $skin Skin object + * @deprecated since 1.18 Not used anymore + */ + function useSkin( $skin ) { + wfDeprecated( __METHOD__, '1.18' ); + /* no op */ + } + + /** + * Add an image to the gallery. + * + * @param $title Title object of the image that is added to the gallery + * @param $html String: Additional HTML text to be shown. The name and size of the image are always shown. + * @param $alt String: Alt text for the image + * @param $link String: Override image link (optional) + * @param $handlerOpts Array: Array of options for image handler (aka page number) + */ + function add( $title, $html = '', $alt = '', $link = '', $handlerOpts = array() ) { + if ( $title instanceof File ) { + // Old calling convention + $title = $title->getTitle(); + } + $this->mImages[] = array( $title, $html, $alt, $link, $handlerOpts ); + wfDebug( 'ImageGallery::add ' . $title->getText() . "\n" ); + } + + /** + * Add an image at the beginning of the gallery. + * + * @param $title Title object of the image that is added to the gallery + * @param $html String: Additional HTML text to be shown. The name and size of the image are always shown. + * @param $alt String: Alt text for the image + * @param $link String: Override image link (optional) + * @param $handlerOpts Array: Array of options for image handler (aka page number) + */ + function insert( $title, $html = '', $alt = '', $link = '', $handlerOpts = array() ) { + if ( $title instanceof File ) { + // Old calling convention + $title = $title->getTitle(); + } + array_unshift( $this->mImages, array( &$title, $html, $alt, $link, $handlerOpts ) ); + } + + /** + * isEmpty() returns true if the gallery contains no images + * @return bool + */ + function isEmpty() { + return empty( $this->mImages ); + } + + /** + * Enable/Disable showing of the file size of an image in the gallery. + * Enabled by default. + * + * @param $f Boolean: set to false to disable. + */ + function setShowBytes( $f ) { + $this->mShowBytes = (bool)$f; + } + + /** + * Enable/Disable showing of the filename of an image in the gallery. + * Enabled by default. + * + * @param $f Boolean: set to false to disable. + */ + function setShowFilename( $f ) { + $this->mShowFilename = (bool)$f; + } + + /** + * Set arbitrary attributes to go on the HTML gallery output element. + * Should be suitable for a "; + + return $output; + } + + + /** + * Add the wrapper html around the thumb's caption + * + * @param String $galleryText The caption + * @param MediaTransformOutput|boolean $thumb The thumb this caption is for or false for bad image. + */ + protected function wrapGalleryText( $galleryText, $thumb ) { + # ATTENTION: The newline after
is needed to accommodate htmltidy which + # in version 4.8.6 generated crackpot html in its absence, see: + # http://bugzilla.wikimedia.org/show_bug.cgi?id=1765 -Ævar + + return "\n\t\t\t" . '
' . "\n" + . $galleryText + . "\n\t\t\t
"; + } + + /** + * How much padding such the thumb have between image and inner div that + * that contains the border. This is both for verical and horizontal + * padding. (However, it is cut in half in the vertical direction). + * @return int + */ + protected function getThumbPadding() { + return 30; + } + + /** + * + * @note GB stands for gallerybox (as in the
  • element) + * + * @return int + */ + protected function getGBPadding() { + return 5; + } + + /** + * Get how much extra space the borders around the image takes up. + * + * For this mode, it is 2px borders on each side + 2px implied padding on + * each side from the stylesheet, giving us 2*2+2*2 = 8. + * @return int + */ + protected function getGBBorders() { + return 8; + } + + /** + * Get total padding. + * + * @return int How many pixels of whitespace surround the thumbnail. + */ + protected function getAllPadding() { + return $this->getThumbPadding() + $this->getGBPadding() + $this->getGBBorders(); + } + + /** + * Get vertical padding for a thumbnail + * + * Generally this is the total height minus how high the thumb is. + * + * @param int $boxHeight How high we want the box to be. + * @param int $thumbHeight How high the thumbnail is. + * @return int How many vertical padding to add on each side. + */ + protected function getVPad( $boxHeight, $thumbHeight ) { + return ( $this->getThumbPadding() + $boxHeight - $thumbHeight ) / 2; + } + + /** + * Get the transform parameters for a thumbnail. + * + * @param File $img The file in question. May be false for invalid image + */ + protected function getThumbParams( $img ) { + return array( + 'width' => $this->mWidths, + 'height' => $this->mHeights + ); + } + + /** + * Get the width of the inner div that contains the thumbnail in + * question. This is the div with the class of "thumb". + * + * @param int $thumbWidth The width of the thumbnail. + * @return int Width of inner thumb div. + */ + protected function getThumbDivWidth( $thumbWidth ) { + return $this->mWidths + $this->getThumbPadding(); + } + + /** + * Width of gallerybox
  • . + * + * Generally is the width of the image, plus padding on image + * plus padding on gallerybox. + * + * @note Important: parameter will be false if no thumb used. + * @param Mixed $thumb MediaTransformObject object or false. + * @return int width of gallerybox element + */ + protected function getGBWidth( $thumb ) { + return $this->mWidths + $this->getThumbPadding() + $this->getGBPadding(); + } + + /** + * Get a list of modules to include in the page. + * + * Primarily intended for subclasses. + * + * @return Array modules to include + */ + protected function getModules() { + return array(); + } + + /** + * Adjust the image parameters for a thumbnail. + * + * Used by a subclass to insert extra high resolution images. + * @param MediaTransformOutput $thumb The thumbnail + * @param Array $imageParameters Array of options + */ + protected function adjustImageParameters( $thumb, &$imageParameters ) { } +} + +/** + * Backwards compatibility. This always uses traditional mode + * if called the old way, for extensions that may expect traditional + * mode. + * + * @deprecated 1.22 Use ImageGalleryBase::factory instead. + */ +class ImageGallery extends TraditionalImageGallery { + function __construct( $mode = 'traditional' ) { + wfDeprecated( __METHOD__, '1.22' ); + parent::__construct( $mode ); + } +} -- cgit v1.2.2