TraditionalImageGallery.php

Go to the documentation of this file.

<?php

use MediaWiki\MediaWikiServices;

class TraditionalImageGallery extends ImageGalleryBase {
    function toHTML() {
        if ( $this->mPerRow > 0 ) {
            $maxwidth = $this->mPerRow * ( $this->mWidths + $this->getAllPadding() );
            $oldStyle = $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(
            [ 'class' => 'gallery mw-gallery-' . $this->mMode ], $this->mAttribs );

        $modules = $this->getModules();

        if ( $this->mParser ) {
            $this->mParser->getOutput()->addModules( $modules );
            $this->mParser->getOutput()->addModuleStyles( 'mediawiki.page.gallery.styles' );
        } else {
            $this->getOutput()->addModules( $modules );
            $this->getOutput()->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
            $lb = new LinkBatch();
            foreach ( $this->mImages as $img ) {
                $lb->addObj( $img[0] );
            }
            $lb->execute();
        }

        $lang = $this->getRenderLang();
        # Output each image...
        foreach ( $this->mImages as $pair ) {
            // "text" means "caption" here
            list( $nt, $text, $alt, $link ) = $pair;

            $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 = [];
                    Hooks::run( 'BeforeParserFetchFileAndTitle',
                        [ $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 = MediaWikiServices::getInstance()->getRepoGroup()->findFile( $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::linkKnown(
                        $nt,
                        htmlspecialchars( $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();
                    }

                    $this->adjustImageParameters( $thumb, $imageParameters );

                    Linker::processResponsiveImages( $img, $thumb, $transformOptions );

                    # 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
                    $handler = $img->getHandler();
                    if ( $this->mParser && $handler ) {
                        $handler->parserTransformHook( $this->mParser, $img );
                    }
                }
            }

            // @todo Code is incomplete.
            // $linkTarget = Title::newFromText( MediaWikiServices::getInstance()->
            // getContentLanguage()->getNsText( MediaWikiServices::getInstance()->
            // getNamespaceInfo()->getUser() ) . ":{$ut}" );
            // $ul = Linker::link( $linkTarget, $ut );

            $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 ) :
                '';

            $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 ) {
        // Preloaded into LinkCache in toHTML
        return Linker::linkKnown(
            $nt,
            htmlspecialchars(
                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 ) {
    }
}