TraditionalImageGallery.php

Go to the documentation of this file.

<?php
 
use MediaWiki\Linker\LinkRenderer;
use MediaWiki\MediaWikiServices;
 
class TraditionalImageGallery extends ImageGalleryBase {
    public function toHTML() {
        $resolveFilesViaParser = $this->mParser instanceof Parser;
        if ( $resolveFilesViaParser ) {
            $out = $this->mParser->getOutput();
            $repoGroup = null;
            $linkRenderer = $this->mParser->getLinkRenderer();
            $badFileLookup = $this->mParser->getBadFileLookup();
        } else {
            $out = $this->getOutput();
            $services = MediaWikiServices::getInstance();
            $repoGroup = $services->getRepoGroup();
            $linkRenderer = $services->getLinkRenderer();
            $badFileLookup = $services->getBadFileLookup();
        }
 
        if ( $this->mPerRow > 0 ) {
            $maxwidth = $this->mPerRow * ( $this->mWidths + $this->getAllPadding() );
            $oldStyle = $this->mAttribs['style'] ?? '';
            $this->mAttribs['style'] = "max-width: {$maxwidth}px;" . $oldStyle;
        }
 
        $attribs = Sanitizer::mergeAttributes(
            [ 'class' => 'gallery mw-gallery-' . $this->mMode ], $this->mAttribs );
 
        $out->addModules( $this->getModules() );
        $out->addModuleStyles( 'mediawiki.page.gallery.styles' );
        $output = Xml::openElement( 'ul', $attribs );
        if ( $this->mCaption ) {
            $output .= "\n\t<li class='gallerycaption'>{$this->mCaption}</li>";
        }
 
        if ( $this->mShowFilename ) {
            // Preload LinkCache info for when generating links
            // of the filename below
            $linkBatchFactory = MediaWikiServices::getInstance()->getLinkBatchFactory();
            $lb = $linkBatchFactory->newLinkBatch();
            foreach ( $this->mImages as [ $title, /* see below */ ] ) {
                $lb->addObj( $title );
            }
            $lb->execute();
        }
 
        $lang = $this->getRenderLang();
        $enableLegacyMediaDOM = $this->getConfig()->get( 'ParserEnableLegacyMediaDOM' );
 
        # Output each image...
        foreach ( $this->mImages as [ $nt, $text, $alt, $link, $handlerOpts, $loading ] ) {
            // "text" means "caption" here
            $descQuery = false;
            if ( $nt->getNamespace() === NS_FILE ) {
                # Get the file...
                if ( $resolveFilesViaParser ) {
                    # Give extensions a chance to select the file revision for us
                    $options = [];
                    Hooks::runner()->onBeforeParserFetchFileAndTitle(
                        $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 = $repoGroup->findFile( $nt );
                }
            } else {
                $img = false;
            }
 
            $params = $this->getThumbParams( $img );
            $transformOptions = $params + $handlerOpts;
 
            $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 ( $resolveFilesViaParser ) {
                    $this->mParser->addTrackingCategory( 'broken-file-category' );
                }
            } elseif ( $this->mHideBadImages &&
                $badFileLookup->isBadFile( $nt->getDBkey(), $this->getContextTitle() )
            ) {
                # The image is bad, so just show it as a text link.
                $thumbhtml = "\n\t\t\t" . '<div class="thumb" style="height: ' .
                    ( $this->getThumbPadding() + $this->mHeights ) . 'px;">' .
                    $linkRenderer->makeKnownLink( $nt, $nt->getText() ) .
                    '</div>';
            } else {
                $thumb = $img->transform( $transformOptions );
                if ( !$thumb ) {
                    # 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 = [
                        '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();
                    }
 
                    if ( $loading === ImageGalleryBase::LOADING_LAZY ) {
                        $imageParameters['loading'] = 'lazy';
                    }
 
                    $this->adjustImageParameters( $thumb, $imageParameters );
 
                    Linker::processResponsiveImages( $img, $thumb, $transformOptions );
 
                    switch ( $img->getMediaType() ) {
                        case 'AUDIO':
                            $rdfaType = 'mw:Audio';
                            break;
                        case 'VIDEO':
                            $rdfaType = 'mw:Video';
                            break;
                        default:
                            $rdfaType = 'mw:Image';
                    }
 
                    $thumbhtml = $thumb->toHtml( $imageParameters );
 
                    if ( !$enableLegacyMediaDOM ) {
                        $thumbhtml = Html::rawElement(
                            'span', [ 'typeof' => $rdfaType ], $thumbhtml
                        );
                    }
 
                    $thumbhtml = Html::rawElement( 'div', [
                        # 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
                        'style' => "margin:{$vpad}px auto;",
                    ], $thumbhtml );
 
                    # Set both fixed width and min-height.
                    $width = $this->getThumbDivWidth( $thumb->getWidth() );
                    $thumbhtml = "\n\t\t\t" . Html::rawElement( 'div', [
                        'class' => 'thumb',
                        'style' => "width: {$width}px;",
                    ], $thumbhtml );
 
                    // Call parser transform hook
                    $handler = $img->getHandler();
                    if ( $resolveFilesViaParser && $handler ) {
                        $handler->parserTransformHook( $this->mParser, $img );
                    }
                }
            }
 
            $meta = [];
            if ( $img ) {
                if ( $this->mShowDimensions ) {
                    $meta[] = $img->getDimensionsString();
                }
                if ( $this->mShowBytes ) {
                    $meta[] = htmlspecialchars( $lang->formatSize( $img->getSize() ) );
                }
            } elseif ( $this->mShowDimensions || $this->mShowBytes ) {
                $meta[] = $this->msg( 'filemissing' )->escaped();
            }
            $meta = $lang->semicolonList( $meta );
            if ( $meta ) {
                $meta .= "<br />\n";
            }
 
            $textlink = $this->mShowFilename ?
                $this->getCaptionHtml( $nt, $lang, $linkRenderer ) :
                '';
 
            $galleryText = $textlink . $text . $meta;
            $galleryText = $this->wrapGalleryText( $galleryText, $thumb );
 
            $gbWidth = $this->getGBWidth( $thumb ) . 'px';
            if ( $this->getGBWidthOverwrite( $thumb ) ) {
                $gbWidth = $this->getGBWidthOverwrite( $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: '
                . $gbWidth . '">'
                . '<div style="width: ' . $gbWidth . '">'
                . $thumbhtml
                . $galleryText
                . "\n\t\t</div></li>";
        }
        $output .= "\n</ul>";
 
        return $output;
    }
 
    protected function getCaptionHtml( Title $nt, Language $lang, LinkRenderer $linkRenderer ) {
        // Preloaded into LinkCache in toHTML
        return $linkRenderer->makeKnownLink(
            $nt,
            // @phan-suppress-next-line SecurityCheck-DoubleEscaped Triggered by Language::truncateForVisual
            is_int( $this->getCaptionLength() ) ?
                $lang->truncateForVisual( $nt->getText(), $this->getCaptionLength() ) :
                $nt->getText(),
            [
                'class' => 'galleryfilename' .
                    ( $this->getCaptionLength() === true ? ' galleryfilename-truncate' : '' )
            ]
        ) . "\n";
    }
 
    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: https://phabricator.wikimedia.org/T3765
        # -Ævar
 
        return "\n\t\t\t" . '<div class="gallerytext">' . "\n"
            . $galleryText
            . "\n\t\t\t</div>";
    }
 
    protected function getThumbPadding() {
        return 30;
    }
 
    protected function getGBPadding() {
        return 5;
    }
 
    protected function getGBBorders() {
        return 8;
    }
 
    protected function getCaptionLength() {
        return $this->mCaptionLength;
    }
 
    protected function getAllPadding() {
        return $this->getThumbPadding() + $this->getGBPadding() + $this->getGBBorders();
    }
 
    protected function getVPad( $boxHeight, $thumbHeight ) {
        return ( $this->getThumbPadding() + $boxHeight - $thumbHeight ) / 2;
    }
 
    protected function getThumbParams( $img ) {
        return [
            'width' => $this->mWidths,
            'height' => $this->mHeights
        ];
    }
 
    protected function getThumbDivWidth( $thumbWidth ) {
        return $this->mWidths + $this->getThumbPadding();
    }
 
    protected function getGBWidth( $thumb ) {
        return $this->mWidths + $this->getThumbPadding() + $this->getGBPadding();
    }
 
    protected function getGBWidthOverwrite( $thumb ) {
        return false;
    }
 
    protected function getModules() {
        return [];
    }
 
    protected function adjustImageParameters( $thumb, &$imageParameters ) {
    }
}