MediaTransformOutput.php

Go to the documentation of this file.

<?php
abstract class MediaTransformOutput {
        var $file;

        var $width, $height, $url, $page, $path;

        public $responsiveUrls = array();

        protected $storagePath = false;

        public function getWidth() {
                return $this->width;
        }

        public function getHeight() {
                return $this->height;
        }

        public function getExtension() {
                return $this->path ? FileBackend::extensionFromPath( $this->path ) : false;
        }

        public function getUrl() {
                return $this->url;
        }

        public function getStoragePath() {
                return $this->storagePath;
        }

        public function setStoragePath( $storagePath ) {
                $this->storagePath = $storagePath;
        }

        abstract public function toHtml( $options = array() );

        public function isError() {
                return false;
        }

        public function hasFile() {
                // If TRANSFORM_LATER, $this->path will be false.
                // Note: a null path means "use the source file".
                return ( !$this->isError() && ( $this->path || $this->path === null ) );
        }

        public function fileIsSource() {
                return ( !$this->isError() && $this->path === null );
        }

        public function getLocalCopyPath() {
                if ( $this->isError() ) {
                        return false;
                } elseif ( $this->path === null ) {
                        return $this->file->getLocalRefPath();
                } else {
                        return $this->path; // may return false
                }
        }

        public function streamFile( $headers = array() ) {
                if ( !$this->path ) {
                        return false;
                } elseif ( FileBackend::isStoragePath( $this->path ) ) {
                        $be = $this->file->getRepo()->getBackend();
                        return $be->streamFile( array( 'src' => $this->path, 'headers' => $headers ) )->isOK();
                } else { // FS-file
                        return StreamFile::stream( $this->getLocalCopyPath(), $headers );
                }
        }

        protected function linkWrap( $linkAttribs, $contents ) {
                if ( $linkAttribs ) {
                        return Xml::tags( 'a', $linkAttribs, $contents );
                } else {
                        return $contents;
                }
        }

        public function getDescLinkAttribs( $title = null, $params = '' ) {
                $query = '';
                if ( $this->page && $this->page !== 1 ) {
                        $query = 'page=' . urlencode( $this->page );
                }
                if( $params ) {
                        $query .= $query ? '&' . $params : $params;
                }
                $attribs = array(
                        'href' => $this->file->getTitle()->getLocalURL( $query ),
                        'class' => 'image',
                );
                if ( $title ) {
                        $attribs['title'] = $title;
                }
                return $attribs;
        }
}

class ThumbnailImage extends MediaTransformOutput {
        function __construct( $file, $url, $path = false, $parameters = array() ) {
                # Previous parameters:
                #   $file, $url, $width, $height, $path = false, $page = false

                if( is_array( $parameters ) ) {
                        $defaults = array(
                                'page' => false
                        );
                        $actualParams = $parameters + $defaults;
                } else {
                        # Using old format, should convert. Later a warning could be added here.
                        $numArgs = func_num_args();
                        $actualParams = array(
                                'width' => $path,
                                'height' => $parameters,
                                'page' => ( $numArgs > 5 ) ? func_get_arg( 5 ) : false
                        );
                        $path = ( $numArgs > 4 ) ? func_get_arg( 4 ) : false;
                }

                $this->file = $file;
                $this->url = $url;
                $this->path = $path;

                # These should be integers when they get here.
                # If not, there's a bug somewhere.  But let's at
                # least produce valid HTML code regardless.
                $this->width = round( $actualParams['width'] );
                $this->height = round( $actualParams['height'] );

                $this->page = $actualParams['page'];
        }

        function toHtml( $options = array() ) {
                if ( count( func_get_args() ) == 2 ) {
                        throw new MWException( __METHOD__ .' called in the old style' );
                }

                $alt = empty( $options['alt'] ) ? '' : $options['alt'];

                $query = empty( $options['desc-query'] ) ? '' : $options['desc-query'];

                if ( !empty( $options['custom-url-link'] ) ) {
                        $linkAttribs = array( 'href' => $options['custom-url-link'] );
                        if ( !empty( $options['title'] ) ) {
                                $linkAttribs['title'] = $options['title'];
                        }
                        if ( !empty( $options['custom-target-link'] ) ) {
                                $linkAttribs['target'] = $options['custom-target-link'];
                        } elseif ( !empty( $options['parser-extlink-target'] ) ) {
                                $linkAttribs['target'] = $options['parser-extlink-target'];
                        }
                        if ( !empty( $options['parser-extlink-rel'] ) ) {
                                $linkAttribs['rel'] = $options['parser-extlink-rel'];
                        }
                } elseif ( !empty( $options['custom-title-link'] ) ) {
                        $title = $options['custom-title-link'];
                        $linkAttribs = array(
                                'href' => $title->getLinkURL(),
                                'title' => empty( $options['title'] ) ? $title->getFullText() : $options['title']
                        );
                } elseif ( !empty( $options['desc-link'] ) ) {
                        $linkAttribs = $this->getDescLinkAttribs( empty( $options['title'] ) ? null : $options['title'], $query );
                } elseif ( !empty( $options['file-link'] ) ) {
                        $linkAttribs = array( 'href' => $this->file->getURL() );
                } else {
                        $linkAttribs = false;
                }

                $attribs = array(
                        'alt' => $alt,
                        'src' => $this->url,
                        'width' => $this->width,
                        'height' => $this->height
                );
                if ( !empty( $options['valign'] ) ) {
                        $attribs['style'] = "vertical-align: {$options['valign']}";
                }
                if ( !empty( $options['img-class'] ) ) {
                        $attribs['class'] = $options['img-class'];
                }

                // Additional densities for responsive images, if specified.
                if ( !empty( $this->responsiveUrls ) ) {
                        $attribs['srcset'] = Html::srcSet( $this->responsiveUrls );
                }

                wfRunHooks( 'ThumbnailBeforeProduceHTML', array( $this, &$attribs, &$linkAttribs ) );

                return $this->linkWrap( $linkAttribs, Xml::element( 'img', $attribs ) );
        }

}

class MediaTransformError extends MediaTransformOutput {
        var $htmlMsg, $textMsg, $width, $height, $url, $path;

        function __construct( $msg, $width, $height /*, ... */ ) {
                $args = array_slice( func_get_args(), 3 );
                $htmlArgs = array_map( 'htmlspecialchars', $args );
                $htmlArgs = array_map( 'nl2br', $htmlArgs );

                $this->htmlMsg = wfMessage( $msg )->rawParams( $htmlArgs )->escaped();
                $this->textMsg = wfMessage( $msg )->rawParams( $htmlArgs )->text();
                $this->width = intval( $width );
                $this->height = intval( $height );
                $this->url = false;
                $this->path = false;
        }

        function toHtml( $options = array() ) {
                return "<div class=\"MediaTransformError\" style=\"" .
                        "width: {$this->width}px; height: {$this->height}px; display:inline-block;\">" .
                        $this->htmlMsg .
                        "</div>";
        }

        function toText() {
                return $this->textMsg;
        }

        function getHtmlMsg() {
                return $this->htmlMsg;
        }

        function isError() {
                return true;
        }
}

class TransformParameterError extends MediaTransformError {
        function __construct( $params ) {
                parent::__construct( 'thumbnail_error',
                        max( isset( $params['width'] ) ? $params['width'] : 0, 120 ),
                        max( isset( $params['height'] ) ? $params['height'] : 0, 120 ),
                        wfMessage( 'thumbnail_invalid_params' )->text() );
        }
}