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.
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.
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
23 class TraditionalImageGallery
extends ImageGalleryBase
{
25 * Return a HTML representation of the image gallery
27 * For each image in the gallery, display
30 * - the additional text provided when adding the image
31 * - the size of the image
36 if ( $this->mPerRow
> 0 ) {
37 $maxwidth = $this->mPerRow
* ( $this->mWidths +
$this->getAllPadding() );
38 $oldStyle = $this->mAttribs
['style'] ??
'';
39 # _width is ignored by any sane browser. IE6 doesn't know max-width
40 # so it uses _width instead
41 $this->mAttribs
['style'] = "max-width: {$maxwidth}px;_width: {$maxwidth}px;" .
45 $attribs = Sanitizer
::mergeAttributes(
46 [ 'class' => 'gallery mw-gallery-' . $this->mMode
], $this->mAttribs
);
48 $modules = $this->getModules();
50 if ( $this->mParser
) {
51 $this->mParser
->getOutput()->addModules( $modules );
52 $this->mParser
->getOutput()->addModuleStyles( 'mediawiki.page.gallery.styles' );
54 $this->getOutput()->addModules( $modules );
55 $this->getOutput()->addModuleStyles( 'mediawiki.page.gallery.styles' );
57 $output = Xml
::openElement( 'ul', $attribs );
58 if ( $this->mCaption
) {
59 $output .= "\n\t<li class='gallerycaption'>{$this->mCaption}</li>";
62 if ( $this->mShowFilename
) {
63 // Preload LinkCache info for when generating links
64 // of the filename below
65 $lb = new LinkBatch();
66 foreach ( $this->mImages
as $img ) {
67 $lb->addObj( $img[0] );
72 $lang = $this->getRenderLang();
73 # Output each image...
74 foreach ( $this->mImages
as $pair ) {
75 // "text" means "caption" here
77 list( $nt, $text, $alt, $link ) = $pair;
80 if ( $nt->getNamespace() === NS_FILE
) {
82 if ( $this->mParser
instanceof Parser
) {
83 # Give extensions a chance to select the file revision for us
85 Hooks
::run( 'BeforeParserFetchFileAndTitle',
86 [ $this->mParser
, $nt, &$options, &$descQuery ] );
87 # Fetch and register the file (file title may be different via hooks)
88 list( $img, $nt ) = $this->mParser
->fetchFileAndTitle( $nt, $options );
90 $img = wfFindFile( $nt );
96 $params = $this->getThumbParams( $img );
97 // $pair[4] is per image handler options
98 $transformOptions = $params +
$pair[4];
103 # We're dealing with a non-image, spit out the name and be done with it.
104 $thumbhtml = "\n\t\t\t" . '<div class="thumb" style="height: '
105 . ( $this->getThumbPadding() +
$this->mHeights
) . 'px;">'
106 . htmlspecialchars( $nt->getText() ) . '</div>';
108 if ( $this->mParser
instanceof Parser
) {
109 $this->mParser
->addTrackingCategory( 'broken-file-category' );
111 } elseif ( $this->mHideBadImages
112 && wfIsBadImage( $nt->getDBkey(), $this->getContextTitle() )
114 # The image is blacklisted, just show it as a text link.
115 $thumbhtml = "\n\t\t\t" . '<div class="thumb" style="height: ' .
116 ( $this->getThumbPadding() +
$this->mHeights
) . 'px;">' .
119 htmlspecialchars( $nt->getText() )
123 $thumb = $img->transform( $transformOptions );
125 # Error generating thumbnail.
126 $thumbhtml = "\n\t\t\t" . '<div class="thumb" style="height: '
127 . ( $this->getThumbPadding() +
$this->mHeights
) . 'px;">'
128 . htmlspecialchars( $img->getLastError() ) . '</div>';
130 /** @var MediaTransformOutput $thumb */
131 $vpad = $this->getVPad( $this->mHeights
, $thumb->getHeight() );
135 'desc-query' => $descQuery,
137 'custom-url-link' => $link
140 // In the absence of both alt text and caption, fall back on
141 // providing screen readers with the filename as alt text
142 if ( $alt == '' && $text == '' ) {
143 $imageParameters['alt'] = $nt->getText();
146 $this->adjustImageParameters( $thumb, $imageParameters );
148 Linker
::processResponsiveImages( $img, $thumb, $transformOptions );
150 # Set both fixed width and min-height.
151 $thumbhtml = "\n\t\t\t"
152 . '<div class="thumb" style="width: '
153 . $this->getThumbDivWidth( $thumb->getWidth() ) . 'px;">'
154 # Auto-margin centering for block-level elements. Needed
155 # now that we have video handlers since they may emit block-
156 # level elements as opposed to simple <img> tags. ref
157 # http://css-discuss.incutio.com/?page=CenteringBlockElement
158 . '<div style="margin:' . $vpad . 'px auto;">'
159 . $thumb->toHtml( $imageParameters ) . '</div></div>';
161 // Call parser transform hook
162 /** @var MediaHandler $handler */
163 $handler = $img->getHandler();
164 if ( $this->mParser
&& $handler ) {
165 $handler->parserTransformHook( $this->mParser
, $img );
170 // @todo Code is incomplete.
171 // $linkTarget = Title::newFromText( MediaWikiServices::getInstance()->
172 // getContentLanguage()->getNsText( MWNamespace::getUser() ) . ":{$ut}" );
173 // $ul = Linker::link( $linkTarget, $ut );
177 if ( $this->mShowDimensions
) {
178 $meta[] = $img->getDimensionsString();
180 if ( $this->mShowBytes
) {
181 $meta[] = htmlspecialchars( $lang->formatSize( $img->getSize() ) );
183 } elseif ( $this->mShowDimensions ||
$this->mShowBytes
) {
184 $meta[] = $this->msg( 'filemissing' )->escaped();
186 $meta = $lang->semicolonList( $meta );
191 $textlink = $this->mShowFilename ?
192 $this->getCaptionHtml( $nt, $lang ) :
195 $galleryText = $textlink . $text . $meta;
196 $galleryText = $this->wrapGalleryText( $galleryText, $thumb );
198 $gbWidth = $this->getGBWidth( $thumb ) . 'px';
199 if ( $this->getGBWidthOverwrite( $thumb ) ) {
200 $gbWidth = $this->getGBWidthOverwrite( $thumb );
202 # Weird double wrapping (the extra div inside the li) needed due to FF2 bug
203 # Can be safely removed if FF2 falls completely out of existence
204 $output .= "\n\t\t" . '<li class="gallerybox" style="width: '
206 . '<div style="width: ' . $gbWidth . '">'
209 . "\n\t\t</div></li>";
211 $output .= "\n</ul>";
218 * @param Language $lang
219 * @return string HTML
221 protected function getCaptionHtml( Title
$nt, Language
$lang ) {
222 // Preloaded into LinkCache in toHTML
223 return Linker
::linkKnown(
226 is_int( $this->getCaptionLength() ) ?
227 $lang->truncateForVisual( $nt->getText(), $this->getCaptionLength() ) :
231 'class' => 'galleryfilename' .
232 ( $this->getCaptionLength() === true ?
' galleryfilename-truncate' : '' )
238 * Add the wrapper html around the thumb's caption
240 * @param string $galleryText The caption
241 * @param MediaTransformOutput|bool $thumb The thumb this caption is for
242 * or false for bad image.
245 protected function wrapGalleryText( $galleryText, $thumb ) {
246 # ATTENTION: The newline after <div class="gallerytext"> is needed to
247 # accommodate htmltidy which in version 4.8.6 generated crackpot html in
248 # its absence, see: https://phabricator.wikimedia.org/T3765
251 return "\n\t\t\t" . '<div class="gallerytext">' . "\n"
257 * How much padding the thumb has between the image and the inner div
258 * that contains the border. This is for both vertical and horizontal
259 * padding. (However, it is cut in half in the vertical direction).
262 protected function getThumbPadding() {
267 * @note GB stands for gallerybox (as in the <li class="gallerybox"> element)
271 protected function getGBPadding() {
276 * Get how much extra space the borders around the image takes up.
278 * For this mode, it is 2px borders on each side + 2px implied padding on
279 * each side from the stylesheet, giving us 2*2+2*2 = 8.
282 protected function getGBBorders() {
287 * Length (in characters) to truncate filename to in caption when using "showfilename" (if int).
288 * A value of 'true' will truncate the filename to one line using CSS, while
289 * 'false' will disable truncating.
293 protected function getCaptionLength() {
294 return $this->mCaptionLength
;
300 * @return int Number of pixels of whitespace surrounding the thumbnail.
302 protected function getAllPadding() {
303 return $this->getThumbPadding() +
$this->getGBPadding() +
$this->getGBBorders();
307 * Get vertical padding for a thumbnail
309 * Generally this is the total height minus how high the thumb is.
311 * @param int $boxHeight How high we want the box to be.
312 * @param int $thumbHeight How high the thumbnail is.
313 * @return int Vertical padding to add on each side.
315 protected function getVPad( $boxHeight, $thumbHeight ) {
316 return ( $this->getThumbPadding() +
$boxHeight - $thumbHeight ) / 2;
320 * Get the transform parameters for a thumbnail.
322 * @param File $img The file in question. May be false for invalid image
325 protected function getThumbParams( $img ) {
327 'width' => $this->mWidths
,
328 'height' => $this->mHeights
333 * Get the width of the inner div that contains the thumbnail in
334 * question. This is the div with the class of "thumb".
336 * @param int $thumbWidth The width of the thumbnail.
337 * @return int Width of inner thumb div.
339 protected function getThumbDivWidth( $thumbWidth ) {
340 return $this->mWidths +
$this->getThumbPadding();
344 * Computed width of gallerybox <li>.
346 * Generally is the width of the image, plus padding on image
347 * plus padding on gallerybox.
349 * @note Important: parameter will be false if no thumb used.
350 * @param MediaTransformOutput|bool $thumb MediaTransformObject object or false.
351 * @return int Width of gallerybox element
353 protected function getGBWidth( $thumb ) {
354 return $this->mWidths +
$this->getThumbPadding() +
$this->getGBPadding();
358 * Allows overwriting the computed width of the gallerybox <li> with a string,
361 * Generally is the width of the image, plus padding on image
362 * plus padding on gallerybox.
364 * @note Important: parameter will be false if no thumb used.
365 * @param MediaTransformOutput|bool $thumb MediaTransformObject object or false.
366 * @return bool|string Ignored if false.
368 protected function getGBWidthOverwrite( $thumb ) {
373 * Get a list of modules to include in the page.
375 * Primarily intended for subclasses.
377 * @return array Modules to include
379 protected function getModules() {
384 * Adjust the image parameters for a thumbnail.
386 * Used by a subclass to insert extra high resolution images.
387 * @param MediaTransformOutput $thumb The thumbnail
388 * @param array &$imageParameters Array of options
390 protected function adjustImageParameters( $thumb, &$imageParameters ) {