MediaTransformOutput.php

Go to the documentation of this file.

<?php
abstract class MediaTransformOutput {
    public $responsiveUrls = [];

    protected $file;

    protected $width;

    protected $height;

    protected $url;

    protected $page;

    protected $path;

    protected $lang;

    protected $storagePath = false;

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

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

    public function getFile() {
        return $this->file;
    }

    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;
        if ( $this->path === false ) {
            $this->path = $storagePath;
        }
    }

    abstract public function toHtml( $options = [] );

    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(); // assume thumb was not scaled
        } elseif ( FileBackend::isStoragePath( $this->path ) ) {
            $be = $this->file->getRepo()->getBackend();
            // The temp file will be process cached by FileBackend
            $fsFile = $be->getLocalReference( [ 'src' => $this->path ] );

            return $fsFile ? $fsFile->getPath() : false;
        } else {
            return $this->path; // may return false
        }
    }

    public function streamFileWithStatus( $headers = [] ) {
        if ( !$this->path ) {
            return Status::newFatal( 'backend-fail-stream', '<no path>' );
        } elseif ( FileBackend::isStoragePath( $this->path ) ) {
            $be = $this->file->getRepo()->getBackend();
            return $be->streamFile( [ 'src' => $this->path, 'headers' => $headers ] );
        } else { // FS-file
            $success = StreamFile::stream( $this->getLocalCopyPath(), $headers );
            return $success ? Status::newGood() : Status::newFatal( 'backend-fail-stream', $this->path );
        }
    }

    public function streamFile( $headers = [] ) {
        return $this->streamFileWithStatus( $headers )->isOK();
    }

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

    public function getDescLinkAttribs( $title = null, $params = [] ) {
        if ( is_array( $params ) ) {
            $query = $params;
        } else {
            $query = [];
        }
        if ( $this->page && $this->page !== 1 ) {
            $query['page'] = $this->page;
        }
        if ( $this->lang ) {
            $query['lang'] = $this->lang;
        }

        if ( is_string( $params ) && $params !== '' ) {
            $query = $params . '&' . wfArrayToCgi( $query );
        }

        $attribs = [
            '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 = [] ) {
        # Previous parameters:
        #   $file, $url, $width, $height, $path = false, $page = false

        $defaults = [
            'page' => false,
            'lang' => false
        ];

        if ( is_array( $parameters ) ) {
            $actualParams = $parameters + $defaults;
        } else {
            # Using old format, should convert. Later a warning could be added here.
            $numArgs = func_num_args();
            $actualParams = [
                'width' => $path,
                'height' => $parameters,
                'page' => ( $numArgs > 5 ) ? func_get_arg( 5 ) : false
            ] + $defaults;
            $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'];
        $this->lang = $actualParams['lang'];
    }

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

        $alt = $options['alt'] ?? '';

        $query = $options['desc-query'] ?? '';

        $attribs = [
            'alt' => $alt,
            'src' => $this->url,
            'decoding' => 'async',
        ];

        if ( !empty( $options['custom-url-link'] ) ) {
            $linkAttribs = [ '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 = [
                '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 = [ 'href' => $this->file->getUrl() ];
        } else {
            $linkAttribs = false;
            if ( !empty( $options['title'] ) ) {
                $attribs['title'] = $options['title'];
            }
        }

        if ( empty( $options['no-dimensions'] ) ) {
            $attribs['width'] = $this->width;
            $attribs['height'] = $this->height;
        }
        if ( !empty( $options['valign'] ) ) {
            $attribs['style'] = "vertical-align: {$options['valign']}";
        }
        if ( !empty( $options['img-class'] ) ) {
            $attribs['class'] = $options['img-class'];
        }
        if ( isset( $options['override-height'] ) ) {
            $attribs['height'] = $options['override-height'];
        }
        if ( isset( $options['override-width'] ) ) {
            $attribs['width'] = $options['override-width'];
        }

        // Additional densities for responsive images, if specified.
        // If any of these urls is the same as src url, it'll be excluded.
        $responsiveUrls = array_diff( $this->responsiveUrls, [ $this->url ] );
        if ( !empty( $responsiveUrls ) ) {
            $attribs['srcset'] = Html::srcSet( $responsiveUrls );
        }

        Hooks::run( 'ThumbnailBeforeProduceHTML', [ $this, &$attribs, &$linkAttribs ] );

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

class MediaTransformError extends MediaTransformOutput {
    private $msg;

    function __construct( $msg, $width, $height /*, ... */ ) {
        $args = array_slice( func_get_args(), 3 );
        $this->msg = wfMessage( $msg )->params( $args );
        $this->width = intval( $width );
        $this->height = intval( $height );
        $this->url = false;
        $this->path = false;
    }

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

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

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

    function getMsg() {
        return $this->msg;
    }

    function isError() {
        return true;
    }

    function getHttpStatusCode() {
        return 500;
    }
}

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

    function getHttpStatusCode() {
        return 400;
    }
}

class TransformTooBigImageAreaError extends MediaTransformError {
    function __construct( $params, $maxImageArea ) {
        $msg = wfMessage( 'thumbnail_toobigimagearea' );
        $msg->params(
            $msg->getLanguage()->formatComputingNumbers( $maxImageArea, 1000, "size-$1pixel" )
        );

        parent::__construct( 'thumbnail_error',
            max( $params['width'] ?? 0, 120 ),
            max( $params['height'] ?? 0, 120 ),
            $msg
        );
    }

    function getHttpStatusCode() {
        return 400;
    }
}