MediaTransformOutput.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\Media;
 
use MediaWiki\FileRepo\File\File;
use MediaWiki\Html\Html;
use MediaWiki\Status\Status;
use Wikimedia\FileBackend\FileBackend;
use Wikimedia\FileBackend\HTTPFileStreamer;
 
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() {
        if ( $this->url === false ) {
            return false;
        }
 
        return $this->getFile()->appendRequestProvenance( $this->url, [
            'format' => 'thumbnail',
        ] );
    }
 
    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;
        }
 
        if ( $this->path === null ) {
            // assume thumb was not scaled
            return $this->file->getLocalRefPath();
        }
        if ( FileBackend::isStoragePath( $this->path ) ) {
            $be = $this->file->getRepo()->getBackend();
            // The temp file is process-cached by FileBackend
            $fsFile = $be->getLocalReference( [ 'src' => $this->path ] );
 
            return $fsFile ? $fsFile->getPath() : false;
        }
        // may return false
        return $this->path;
    }
 
    public function streamFileWithStatus( $headers = [] ) {
        if ( !$this->path ) {
            return Status::newFatal( 'backend-fail-stream', '<no path>' );
        }
 
        $repo = $this->file->getRepo();
 
        if ( $repo && FileBackend::isStoragePath( $this->path ) ) {
            return Status::wrap(
                $repo->getBackend()->streamFile(
                    [ 'src' => $this->path, 'headers' => $headers, ]
                )
            );
        }
 
        $streamer = new HTTPFileStreamer(
            $this->getLocalCopyPath(),
            $repo ? $repo->getBackend()->getStreamerOptions() : []
        );
 
        $success = $streamer->stream( $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 ( isset( $linkAttribs['href'] ) ) {
            return Html::rawElement( 'a', $linkAttribs, $contents );
        }
        return Html::rawElement( 'span', $linkAttribs ?: [], $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' => 'mw-file-description',
        ];
 
        if ( $title ) {
            $attribs['title'] = $title;
        }
 
        return $attribs;
    }
}
 
class_alias( MediaTransformOutput::class, 'MediaTransformOutput' );