TraditionalImageGallery.php

Go to the documentation of this file.

<?php
 
use MediaWiki\HookContainer\HookRunner;
use MediaWiki\Html\Html;
use MediaWiki\Linker\Linker;
use MediaWiki\Linker\LinkRenderer;
use MediaWiki\MainConfigNames;
use MediaWiki\MediaWikiServices;
use MediaWiki\Parser\Sanitizer;
use MediaWiki\Title\Title;
use Wikimedia\Assert\Assert;
 
class TraditionalImageGallery extends ImageGalleryBase {
    public function toHTML() {
        $resolveFilesViaParser = $this->mParser instanceof Parser;
        if ( $resolveFilesViaParser ) {
            $parserOutput = $this->mParser->getOutput();
            $repoGroup = null;
            $linkRenderer = $this->mParser->getLinkRenderer();
            $badFileLookup = $this->mParser->getBadFileLookup();
        } else {
            $parserOutput = $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 );
 
        $parserOutput->addModules( $this->getModules() );
        $parserOutput->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( MainConfigNames::ParserEnableLegacyMediaDOM );
        $hookRunner = new HookRunner( MediaWikiServices::getInstance()->getHookContainer() );
 
        # Output each image...
        foreach ( $this->mImages as [ $nt, $text, $alt, $link, $handlerOpts, $loading, $imageOptions ] ) {
            // "text" means "caption" here
            $descQuery = false;
            if ( $nt->inNamespace( NS_FILE ) && !$nt->isExternal() ) {
                # Get the file...
                if ( $resolveFilesViaParser ) {
                    # Give extensions a chance to select the file revision for us
                    $options = [];
                    $hookRunner->onBeforeParserFetchFileAndTitle(
                        // @phan-suppress-next-line PhanTypeMismatchArgument Type mismatch on pass-by-ref args
                        $this->mParser, $nt, $options, $descQuery );
                    # Fetch and register the file (file title may be different via hooks)
                    [ $img, $nt ] = $this->mParser->fetchFileAndTitle( $nt, $options );
                } else {
                    $img = $repoGroup->findFile( $nt );
                }
            } else {
                $img = false;
            }
 
            $transformOptions = $this->getThumbParams( $img ) + $handlerOpts;
            $thumb = $img ? $img->transform( $transformOptions ) : false;
 
            $rdfaType = 'mw:File';
 
            $isBadFile = $img && $thumb && $this->mHideBadImages &&
                $badFileLookup->isBadFile( $nt->getDBkey(), $this->getContextTitle() );
 
            if ( !$img || !$thumb || ( !$enableLegacyMediaDOM && $thumb->isError() ) || $isBadFile ) {
                $rdfaType = 'mw:Error ' . $rdfaType;
 
                if ( $enableLegacyMediaDOM ) {
                    if ( $isBadFile ) {
                        $thumbhtml = $linkRenderer->makeKnownLink( $nt, $nt->getText() );
                    } else {
                        $thumbhtml = htmlspecialchars( $img ? $img->getLastError() : $nt->getText() );
                    }
                } else {
                    $currentExists = $img && $img->exists();
                    if ( $currentExists && !$thumb ) {
                        $label = wfMessage( 'thumbnail_error', '' )->text();
                    } elseif ( $thumb && $thumb->isError() ) {
                        Assert::invariant(
                            $thumb instanceof MediaTransformError,
                            'Unknown MediaTransformOutput: ' . get_class( $thumb )
                        );
                        $label = $thumb->toText();
                    } else {
                        $label = $alt ?? '';
                    }
                    $thumbhtml = Linker::makeBrokenImageLinkObj(
                        $nt, $label, '', '', '', false, $transformOptions, $currentExists
                    );
                    $thumbhtml = Html::rawElement( 'span', [ 'typeof' => $rdfaType ], $thumbhtml );
                }
 
                $thumbhtml = "\n\t\t\t" . '<div class="thumb" style="height: '
                    . ( $this->getThumbPadding() + $this->mHeights ) . 'px;">'
                    . $thumbhtml . '</div>';
 
                if ( !$img && $resolveFilesViaParser ) {
                    $this->mParser->addTrackingCategory( 'broken-file-category' );
                }
            } else {
                $vpad = $this->getVPad( $this->mHeights, $thumb->getHeight() );
 
                // Backwards compat before the $imageOptions existed
                if ( $imageOptions === null ) {
                    $imageParameters = [
                        'desc-link' => true,
                        'desc-query' => $descQuery,
                        'alt' => $alt ?? '',
                        'custom-url-link' => $link
                    ];
                } else {
                    $params = [];
                    // An empty alt indicates an image is not a key part of the
                    // content and that non-visual browsers may omit it from
                    // rendering.  Only set the parameter if it's explicitly
                    // requested.
                    if ( $alt !== null ) {
                        $params['alt'] = $alt;
                    }
                    $params['title'] = $imageOptions['title'];
                    if ( !$enableLegacyMediaDOM ) {
                        $params['img-class'] = 'mw-file-element';
                    }
                    $imageParameters = Linker::getImageLinkMTOParams(
                        $imageOptions, $descQuery, $this->mParser
                    ) + $params;
                }
 
                if ( $loading === ImageGalleryBase::LOADING_LAZY ) {
                    $imageParameters['loading'] = 'lazy';
                }
 
                $this->adjustImageParameters( $thumb, $imageParameters );
 
                Linker::processResponsiveImages( $img, $thumb, $transformOptions );
 
                $thumbhtml = $thumb->toHtml( $imageParameters );
 
                if ( !$enableLegacyMediaDOM ) {
                    $thumbhtml = Html::rawElement(
                        'span', [ 'typeof' => $rdfaType ], $thumbhtml
                    );
                } else {
                    $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() );
                $height = $this->getThumbPadding() + $this->mHeights;
                $thumbhtml = "\n\t\t\t" . Html::rawElement( 'div', [
                    'class' => 'thumb',
                    'style' => "width: {$width}px;" .
                        ( !$enableLegacyMediaDOM && $this->mMode === 'traditional' ?
                            " height: {$height}px;" : '' ),
                ], $thumbhtml );
 
                // Call parser transform hook
                if ( $resolveFilesViaParser ) {
                    $handler = $img->getHandler();
                    if ( $handler ) {
                        $handler->parserTransformHook( $this->mParser, $img );
                    }
                    $this->mParser->modifyImageHtml(
                        $img, [ 'handler' => $imageParameters ], $thumbhtml );
                }
            }
 
            $meta = [];
            if ( $img ) {
                if ( $this->mShowDimensions ) {
                    $meta[] = htmlspecialchars( $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 = $this->wrapGalleryText( $textlink . $text . $meta, $thumb );
 
            $gbWidth = $this->getGBWidthOverwrite( $thumb ) ?: $this->getGBWidth( $thumb ) . 'px';
            # 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 . '">'
                . ( $enableLegacyMediaDOM ? '<div style="width: ' . $gbWidth . '">' : '' )
                . $thumbhtml
                . $galleryText
                . "\n\t\t"
                . ( $enableLegacyMediaDOM ? '</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,
            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 ) {
    }
}