UploadFromStash.php

Go to the documentation of this file.

<?php
class UploadFromStash extends UploadBase {
    protected $mFileKey;
    protected $mVirtualTempPath;
    protected $mFileProps;
    protected $mSourceType;

    // an instance of UploadStash
    private $stash;

    // LocalFile repo
    private $repo;

    public function __construct( $user = false, $stash = false, $repo = false ) {
        // user object. sometimes this won't exist, as when running from cron.
        $this->user = $user;

        if ( $repo ) {
            $this->repo = $repo;
        } else {
            $this->repo = RepoGroup::singleton()->getLocalRepo();
        }

        if ( $stash ) {
            $this->stash = $stash;
        } else {
            if ( $user ) {
                wfDebug( __METHOD__ . " creating new UploadStash instance for " . $user->getId() . "\n" );
            } else {
                wfDebug( __METHOD__ . " creating new UploadStash instance with no user\n" );
            }

            $this->stash = new UploadStash( $this->repo, $this->user );
        }
    }

    public static function isValidKey( $key ) {
        // this is checked in more detail in UploadStash
        return (bool)preg_match( UploadStash::KEY_FORMAT_REGEX, $key );
    }

    public static function isValidRequest( $request ) {
        // this passes wpSessionKey to getText() as a default when wpFileKey isn't set.
        // wpSessionKey has no default which guarantees failure if both are missing
        // (though that should have been caught earlier)
        return self::isValidKey( $request->getText( 'wpFileKey', $request->getText( 'wpSessionKey' ) ) );
    }

    public function initialize( $key, $name = 'upload_file', $initTempFile = true ) {
        $metadata = $this->stash->getMetadata( $key );
        $this->initializePathInfo( $name,
            $initTempFile ? $this->getRealPath( $metadata['us_path'] ) : false,
            $metadata['us_size'],
            false
        );

        $this->mFileKey = $key;
        $this->mVirtualTempPath = $metadata['us_path'];
        $this->mFileProps = $this->stash->getFileProps( $key );
        $this->mSourceType = $metadata['us_source_type'];
    }

    public function initializeFromRequest( &$request ) {
        // sends wpSessionKey as a default when wpFileKey is missing
        $fileKey = $request->getText( 'wpFileKey', $request->getText( 'wpSessionKey' ) );

        // chooses one of wpDestFile, wpUploadFile, filename in that order.
        $desiredDestName = $request->getText(
            'wpDestFile',
            $request->getText( 'wpUploadFile', $request->getText( 'filename' ) )
        );

        $this->initialize( $fileKey, $desiredDestName );
    }

    public function getSourceType() {
        return $this->mSourceType;
    }

    public function getTempFileSha1Base36() {
        return $this->mFileProps['sha1'];
    }

    /*
     * protected function verifyFile() inherited
     */

    public function stashFile( User $user = null ) {
        // replace mLocalFile with an instance of UploadStashFile, which adds some methods
        // that are useful for stashed files.
        $this->mLocalFile = parent::stashFile( $user );

        return $this->mLocalFile;
    }

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

    public function unsaveUploadedFile() {
        return $this->stash->removeFile( $this->mFileKey );
    }

    public function postProcessUpload() {
        parent::postProcessUpload();
        $this->unsaveUploadedFile();
    }
}