diff options
Diffstat (limited to 'includes/gallery/TraditionalImageGallery.php')
| -rw-r--r-- | includes/gallery/TraditionalImageGallery.php | 328 |
1 files changed, 328 insertions, 0 deletions
diff --git a/includes/gallery/TraditionalImageGallery.php b/includes/gallery/TraditionalImageGallery.php new file mode 100644 index 00000000..1f60fa69 --- /dev/null +++ b/includes/gallery/TraditionalImageGallery.php @@ -0,0 +1,328 @@ +<?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 + */ + +class TraditionalImageGallery extends ImageGalleryBase { + + + /** + * Return a HTML representation of the image gallery + * + * For each image in the gallery, display + * - a thumbnail + * - the image name + * - the additional text provided when adding the image + * - the size of the image + * + * @return string + */ + function toHTML() { + if ( $this->mPerRow > 0 ) { + $maxwidth = $this->mPerRow * ( $this->mWidths + $this->getAllPadding() ); + $oldStyle = isset( $this->mAttribs['style'] ) ? $this->mAttribs['style'] : ''; + # _width is ignored by any sane browser. IE6 doesn't know max-width so it uses _width instead + $this->mAttribs['style'] = "max-width: {$maxwidth}px;_width: {$maxwidth}px;" . $oldStyle; + } + + $attribs = Sanitizer::mergeAttributes( + array( 'class' => 'gallery mw-gallery-' . $this->mMode ), $this->mAttribs ); + + $modules = $this->getModules(); + + if ( $this->mParser ) { + $this->mParser->getOutput()->addModules( $modules ); + } else { + $this->getOutput()->addModules( $modules ); + } + $output = Xml::openElement( 'ul', $attribs ); + if ( $this->mCaption ) { + $output .= "\n\t<li class='gallerycaption'>{$this->mCaption}</li>"; + } + + $lang = $this->getRenderLang(); + # Output each image... + foreach ( $this->mImages as $pair ) { + $nt = $pair[0]; + $text = $pair[1]; # "text" means "caption" here + $alt = $pair[2]; + $link = $pair[3]; + + $descQuery = false; + if ( $nt->getNamespace() === NS_FILE ) { + # Get the file... + if ( $this->mParser instanceof Parser ) { + # Give extensions a chance to select the file revision for us + $options = array(); + wfRunHooks( 'BeforeParserFetchFileAndTitle', + array( $this->mParser, $nt, &$options, &$descQuery ) ); + # Fetch and register the file (file title may be different via hooks) + list( $img, $nt ) = $this->mParser->fetchFileAndTitle( $nt, $options ); + } else { + $img = wfFindFile( $nt ); + } + } else { + $img = false; + } + + $params = $this->getThumbParams( $img ); + // $pair[4] is per image handler options + $transformOptions = $params + $pair[4]; + + $thumb = false; + + if ( !$img ) { + # We're dealing with a non-image, spit out the name and be done with it. + $thumbhtml = "\n\t\t\t" . '<div class="thumb" style="height: ' . ( $this->getThumbPadding() + $this->mHeights ) . 'px;">' + . htmlspecialchars( $nt->getText() ) . '</div>'; + + if ( $this->mParser instanceof Parser ) { + $this->mParser->addTrackingCategory( 'broken-file-category' ); + } + } elseif ( $this->mHideBadImages && wfIsBadImage( $nt->getDBkey(), $this->getContextTitle() ) ) { + # The image is blacklisted, just show it as a text link. + $thumbhtml = "\n\t\t\t" . '<div class="thumb" style="height: ' . ( $this->getThumbPadding() + $this->mHeights ) . 'px;">' . + Linker::link( + $nt, + htmlspecialchars( $nt->getText() ), + array(), + array(), + array( 'known', 'noclasses' ) + ) . + '</div>'; + } elseif ( !( $thumb = $img->transform( $transformOptions ) ) ) { + # Error generating thumbnail. + $thumbhtml = "\n\t\t\t" . '<div class="thumb" style="height: ' . ( $this->getThumbPadding() + $this->mHeights ) . 'px;">' + . htmlspecialchars( $img->getLastError() ) . '</div>'; + } else { + $vpad = $this->getVPad( $this->mHeights, $thumb->getHeight() ); + + $imageParameters = array( + 'desc-link' => true, + 'desc-query' => $descQuery, + 'alt' => $alt, + 'custom-url-link' => $link + ); + # In the absence of both alt text and caption, fall back on providing screen readers with the filename as alt text + if ( $alt == '' && $text == '' ) { + $imageParameters['alt'] = $nt->getText(); + } + + $this->adjustImageParameters( $thumb, $imageParameters ); + + # Set both fixed width and min-height. + $thumbhtml = "\n\t\t\t" . + '<div class="thumb" style="width: ' . $this->getThumbDivWidth( $thumb->getWidth() ) . 'px;">' + # Auto-margin centering for block-level elements. Needed now that we have video + # handlers since they may emit block-level elements as opposed to simple <img> tags. + # ref http://css-discuss.incutio.com/?page=CenteringBlockElement + . '<div style="margin:' . $vpad . 'px auto;">' + . $thumb->toHtml( $imageParameters ) . '</div></div>'; + + // Call parser transform hook + if ( $this->mParser && $img->getHandler() ) { + $img->getHandler()->parserTransformHook( $this->mParser, $img ); + } + } + + //TODO + // $linkTarget = Title::newFromText( $wgContLang->getNsText( MWNamespace::getUser() ) . ":{$ut}" ); + // $ul = Linker::link( $linkTarget, $ut ); + + if ( $this->mShowBytes ) { + if ( $img ) { + $fileSize = htmlspecialchars( $lang->formatSize( $img->getSize() ) ); + } else { + $fileSize = $this->msg( 'filemissing' )->escaped(); + } + $fileSize = "$fileSize<br />\n"; + } else { + $fileSize = ''; + } + + $textlink = $this->mShowFilename ? + Linker::link( + $nt, + htmlspecialchars( $lang->truncate( $nt->getText(), $this->mCaptionLength ) ), + array(), + array(), + array( 'known', 'noclasses' ) + ) . "<br />\n" : + ''; + + + $galleryText = $textlink . $text . $fileSize; + $galleryText = $this->wrapGalleryText( $galleryText, $thumb ); + + # Weird double wrapping (the extra div inside the li) needed due to FF2 bug + # Can be safely removed if FF2 falls completely out of existence + $output .= + "\n\t\t" . '<li class="gallerybox" style="width: ' . $this->getGBWidth( $thumb ) . 'px">' + . '<div style="width: ' . $this->getGBWidth( $thumb ) . 'px">' + . $thumbhtml + . $galleryText + . "\n\t\t</div></li>"; + } + $output .= "\n</ul>"; + + 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 <div class="gallerytext"> 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" . '<div class="gallerytext">' . "\n" + . $galleryText + . "\n\t\t\t</div>"; + } + + /** + * 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 <li class="gallerybox"> 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 <li>. + * + * 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 ); + } +} |