ImageGallery.php

Go to the documentation of this file.

<?php
class ImageGallery {
        var $mImages, $mShowBytes, $mShowFilename;
        var $mCaption = false;

        var $mHideBadImages;

        var $mParser;

        protected $contextTitle = false;

        protected $mAttribs = array();

        const THUMB_PADDING = 30;
        const GB_PADDING = 5;
        // 2px borders on each side + 2px implied padding on each side
        const GB_BORDERS = 8;

        function __construct() {
                global $wgGalleryOptions;
                $this->mImages = array();
                $this->mShowBytes = $wgGalleryOptions['showBytes'];
                $this->mShowFilename = true;
                $this->mParser = false;
                $this->mHideBadImages = false;
                $this->mPerRow = $wgGalleryOptions['imagesPerRow'];
                $this->mWidths = $wgGalleryOptions['imageWidth'];
                $this->mHeights = $wgGalleryOptions['imageHeight'];
                $this->mCaptionLength = $wgGalleryOptions['captionLength'];
        }

        function setParser( $parser ) {
                $this->mParser = $parser;
        }

        function setHideBadImages( $flag = true ) {
                $this->mHideBadImages = $flag;
        }

        function setCaption( $caption ) {
                $this->mCaption = htmlspecialchars( $caption );
        }

        public function setCaptionHtml( $caption ) {
                $this->mCaption = $caption;
        }

        public function setPerRow( $num ) {
                if ( $num >= 0 ) {
                        $this->mPerRow = (int)$num;
                }
        }

        public function setWidths( $num ) {
                if ( $num > 0 ) {
                        $this->mWidths = (int)$num;
                }
        }

        public function setHeights( $num ) {
                if ( $num > 0 ) {
                        $this->mHeights = (int)$num;
                }
        }

        function useSkin( $skin ) {
                wfDeprecated( __METHOD__, '1.18' );
                /* no op */
        }

        function add( $title, $html = '', $alt = '', $link = '' ) {
                if ( $title instanceof File ) {
                        // Old calling convention
                        $title = $title->getTitle();
                }
                $this->mImages[] = array( $title, $html, $alt, $link );
                wfDebug( 'ImageGallery::add ' . $title->getText() . "\n" );
        }

        function insert( $title, $html = '', $alt = '' ) {
                if ( $title instanceof File ) {
                        // Old calling convention
                        $title = $title->getTitle();
                }
                array_unshift( $this->mImages, array( &$title, $html, $alt ) );
        }

        function isEmpty() {
                return empty( $this->mImages );
        }

        function setShowBytes( $f ) {
                $this->mShowBytes = (bool)$f;
        }

        function setShowFilename( $f ) {
                $this->mShowFilename = (bool)$f;
        }

        function setAttributes( $attribs ) {
                $this->mAttribs = $attribs;
        }

        function toHTML() {
                if ( $this->mPerRow > 0 ) {
                        $maxwidth = $this->mPerRow * ( $this->mWidths + self::THUMB_PADDING + self::GB_PADDING + self::GB_BORDERS );
                        $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' ), $this->mAttribs );

                $output = Xml::openElement( 'ul', $attribs );
                if ( $this->mCaption ) {
                        $output .= "\n\t<li class='gallerycaption'>{$this->mCaption}</li>";
                }

                $lang = $this->getLang();
                $params = array(
                        'width' => $this->mWidths,
                        'height' => $this->mHeights
                );
                # 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;
                        }

                        if( !$img ) {
                                # We're dealing with a non-image, spit out the name and be done with it.
                                $thumbhtml = "\n\t\t\t" . '<div style="height: ' . ( self::THUMB_PADDING + $this->mHeights ) . 'px;">'
                                        . htmlspecialchars( $nt->getText() ) . '</div>';
                        } 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 style="height: ' . ( self::THUMB_PADDING + $this->mHeights ) . 'px;">' .
                                        Linker::link(
                                                $nt,
                                                htmlspecialchars( $nt->getText() ),
                                                array(),
                                                array(),
                                                array( 'known', 'noclasses' )
                                        ) .
                                        '</div>';
                        } elseif( !( $thumb = $img->transform( $params ) ) ) {
                                # Error generating thumbnail.
                                $thumbhtml = "\n\t\t\t" . '<div style="height: ' . ( self::THUMB_PADDING + $this->mHeights ) . 'px;">'
                                        . htmlspecialchars( $img->getLastError() ) . '</div>';
                        } else {
                                $vpad = ( self::THUMB_PADDING + $this->mHeights - $thumb->height ) /2;

                                $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();
                                }

                                # Set both fixed width and min-height.
                                $thumbhtml = "\n\t\t\t" .
                                        '<div class="thumb" style="width: ' . ( $this->mWidths + self::THUMB_PADDING ) . '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 = wfMessage( '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" :
                                '';

                        # 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

                        # 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->mWidths + self::THUMB_PADDING + self::GB_PADDING ) . 'px">'
                                        . '<div style="width: ' . ( $this->mWidths + self::THUMB_PADDING + self::GB_PADDING ) . 'px">'
                                        . $thumbhtml
                                        . "\n\t\t\t" . '<div class="gallerytext">' . "\n"
                                        . $textlink . $text . $fileSize
                                        . "\n\t\t\t</div>"
                                        . "\n\t\t</div></li>";
                }
                $output .= "\n</ul>";

                return $output;
        }

        public function count() {
                return count( $this->mImages );
        }

        public function setContextTitle( $title ) {
                $this->contextTitle = $title;
        }

        public function getContextTitle() {
                return is_object( $this->contextTitle ) && $this->contextTitle instanceof Title
                        ? $this->contextTitle
                        : false;
        }

        private function getLang() {
                global $wgLang;
                return $this->mParser
                        ? $this->mParser->getTargetLanguage()
                        : $wgLang;
        }

} //class