UploadStashFile.php

Go to the documentation of this file.

<?php
class UploadStashFile extends UnregisteredLocalFile {
    private $fileKey;
    private $urlName;
    protected $url;

    public function __construct( $repo, $path, $key ) {
        $this->fileKey = $key;

        // resolve mwrepo:// urls
        if ( FileRepo::isVirtualUrl( $path ) ) {
            $path = $repo->resolveVirtualUrl( $path );
        } else {
            // check if path appears to be sane, no parent traversals,
            // and is in this repo's temp zone.
            $repoTempPath = $repo->getZonePath( 'temp' );
            if ( ( !$repo->validateFilename( $path ) ) ||
                ( strpos( $path, $repoTempPath ) !== 0 )
            ) {
                wfDebug( "UploadStash: tried to construct an UploadStashFile "
                    . "from a file that should already exist at '$path', but path is not valid\n" );
                throw new UploadStashBadPathException(
                    wfMessage( 'uploadstash-bad-path-invalid' )
                );
            }

            // check if path exists! and is a plain file.
            if ( !$repo->fileExists( $path ) ) {
                wfDebug( "UploadStash: tried to construct an UploadStashFile from "
                    . "a file that should already exist at '$path', but path is not found\n" );
                throw new UploadStashFileNotFoundException(
                    wfMessage( 'uploadstash-file-not-found-not-exists' )
                );
            }
        }

        parent::__construct( false, $repo, $path, false );

        $this->name = basename( $this->path );
    }

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

    public function getThumbPath( $thumbName = false ) {
        $path = dirname( $this->path );
        if ( $thumbName !== false ) {
            $path .= "/$thumbName";
        }

        return $path;
    }

    function thumbName( $params, $flags = 0 ) {
        return $this->generateThumbName( $this->getUrlName(), $params );
    }

    private function getSpecialUrl( $subPage ) {
        return SpecialPage::getTitleFor( 'UploadStash', $subPage )->getLocalURL();
    }

    public function getThumbUrl( $thumbName = false ) {
        wfDebug( __METHOD__ . " getting for $thumbName \n" );

        return $this->getSpecialUrl( 'thumb/' . $this->getUrlName() . '/' . $thumbName );
    }

    public function getUrlName() {
        if ( !$this->urlName ) {
            $this->urlName = $this->fileKey;
        }

        return $this->urlName;
    }

    public function getUrl() {
        if ( !isset( $this->url ) ) {
            $this->url = $this->getSpecialUrl( 'file/' . $this->getUrlName() );
        }

        return $this->url;
    }

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

    public function getFileKey() {
        return $this->fileKey;
    }

    public function remove() {
        if ( !$this->repo->fileExists( $this->path ) ) {
            // Maybe the file's already been removed? This could totally happen in UploadBase.
            return true;
        }

        return $this->repo->freeTemp( $this->path );
    }

    public function exists() {
        return $this->repo->fileExists( $this->path );
    }
}