UploadFromChunks.php

Go to the documentation of this file.

<?php
class UploadFromChunks extends UploadFromFile {
    protected $mOffset;
    protected $mChunkIndex;
    protected $mFileKey;
    protected $mVirtualTempPath;
    private $repo;

    public function __construct( $user = null, $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 UploadFromChunks instance for " . $user->getId() . "\n" );
            } else {
                wfDebug( __METHOD__ . " creating new UploadFromChunks instance with no user\n" );
            }
            $this->stash = new UploadStash( $this->repo, $this->user );
        }
    }

    public function stashFile( User $user = null ) {
        // Stash file is the called on creating a new chunk session:
        $this->mChunkIndex = 0;
        $this->mOffset = 0;

        $this->verifyChunk();
        // Create a local stash target
        $this->mLocalFile = parent::stashFile( $user );
        // Update the initial file offset (based on file size)
        $this->mOffset = $this->mLocalFile->getSize();
        $this->mFileKey = $this->mLocalFile->getFileKey();

        // Output a copy of this first to chunk 0 location:
        $this->outputChunk( $this->mLocalFile->getPath() );

        // Update db table to reflect initial "chunk" state
        $this->updateChunkStatus();

        return $this->mLocalFile;
    }

    public function continueChunks( $name, $key, $webRequestUpload ) {
        $this->mFileKey = $key;
        $this->mUpload = $webRequestUpload;
        // Get the chunk status form the db:
        $this->getChunkStatus();

        $metadata = $this->stash->getMetadata( $key );
        $this->initializePathInfo( $name,
            $this->getRealPath( $metadata['us_path'] ),
            $metadata['us_size'],
            false
        );
    }

    public function concatenateChunks() {
        $chunkIndex = $this->getChunkIndex();
        wfDebug( __METHOD__ . " concatenate {$this->mChunkIndex} chunks:" .
            $this->getOffset() . ' inx:' . $chunkIndex . "\n" );

        // Concatenate all the chunks to mVirtualTempPath
        $fileList = [];
        // The first chunk is stored at the mVirtualTempPath path so we start on "chunk 1"
        for ( $i = 0; $i <= $chunkIndex; $i++ ) {
            $fileList[] = $this->getVirtualChunkLocation( $i );
        }

        // Get the file extension from the last chunk
        $ext = FileBackend::extensionFromPath( $this->mVirtualTempPath );
        // Get a 0-byte temp file to perform the concatenation at
        $tmpFile = TempFSFile::factory( 'chunkedupload_', $ext );
        $tmpPath = false; // fail in concatenate()
        if ( $tmpFile ) {
            // keep alive with $this
            $tmpPath = $tmpFile->bind( $this )->getPath();
        }

        // Concatenate the chunks at the temp file
        $tStart = microtime( true );
        $status = $this->repo->concatenate( $fileList, $tmpPath, FileRepo::DELETE_SOURCE );
        $tAmount = microtime( true ) - $tStart;
        if ( !$status->isOK() ) {
            return $status;
        }

        wfDebugLog( 'fileconcatenate', "Combined $i chunks in $tAmount seconds." );

        // File system path of the actual full temp file
        $this->setTempFile( $tmpPath );

        $ret = $this->verifyUpload();
        if ( $ret['status'] !== UploadBase::OK ) {
            wfDebugLog( 'fileconcatenate', "Verification failed for chunked upload" );
            $status->fatal( $this->getVerificationErrorCode( $ret['status'] ) );

            return $status;
        }

        // Update the mTempPath and mLocalFile
        // (for FileUpload or normal Stash to take over)
        $tStart = microtime( true );
        $this->mLocalFile = parent::stashFile( $this->user );
        $tAmount = microtime( true ) - $tStart;
        $this->mLocalFile->setLocalReference( $tmpFile ); // reuse (e.g. for getImageInfo())
        wfDebugLog( 'fileconcatenate', "Stashed combined file ($i chunks) in $tAmount seconds." );

        return $status;
    }

    function getVirtualChunkLocation( $index ) {
        return $this->repo->getVirtualUrl( 'temp' ) .
            '/' .
            $this->repo->getHashPath(
                $this->getChunkFileKey( $index )
            ) .
            $this->getChunkFileKey( $index );
    }

    public function addChunk( $chunkPath, $chunkSize, $offset ) {
        // Get the offset before we add the chunk to the file system
        $preAppendOffset = $this->getOffset();

        if ( $preAppendOffset + $chunkSize > $this->getMaxUploadSize() ) {
            $status = Status::newFatal( 'file-too-large' );
        } else {
            // Make sure the client is uploading the correct chunk with a matching offset.
            if ( $preAppendOffset == $offset ) {
                // Update local chunk index for the current chunk
                $this->mChunkIndex++;
                try {
                    # For some reason mTempPath is set to first part
                    $oldTemp = $this->mTempPath;
                    $this->mTempPath = $chunkPath;
                    $this->verifyChunk();
                    $this->mTempPath = $oldTemp;
                } catch ( UploadChunkVerificationException $e ) {
                    return Status::newFatal( $e->getMessage() );
                }
                $status = $this->outputChunk( $chunkPath );
                if ( $status->isGood() ) {
                    // Update local offset:
                    $this->mOffset = $preAppendOffset + $chunkSize;
                    // Update chunk table status db
                    $this->updateChunkStatus();
                }
            } else {
                $status = Status::newFatal( 'invalid-chunk-offset' );
            }
        }

        return $status;
    }

    private function updateChunkStatus() {
        wfDebug( __METHOD__ . " update chunk status for {$this->mFileKey} offset:" .
            $this->getOffset() . ' inx:' . $this->getChunkIndex() . "\n" );

        $dbw = $this->repo->getMasterDB();
        // Use a quick transaction since we will upload the full temp file into shared
        // storage, which takes time for large files. We don't want to hold locks then.
        $dbw->update(
            'uploadstash',
            [
                'us_status' => 'chunks',
                'us_chunk_inx' => $this->getChunkIndex(),
                'us_size' => $this->getOffset()
            ],
            [ 'us_key' => $this->mFileKey ],
            __METHOD__
        );
        $dbw->commit( __METHOD__, 'flush' );
    }

    private function getChunkStatus() {
        // get Master db to avoid race conditions.
        // Otherwise, if chunk upload time < replag there will be spurious errors
        $dbw = $this->repo->getMasterDB();
        $row = $dbw->selectRow(
            'uploadstash',
            [
                'us_chunk_inx',
                'us_size',
                'us_path',
            ],
            [ 'us_key' => $this->mFileKey ],
            __METHOD__
        );
        // Handle result:
        if ( $row ) {
            $this->mChunkIndex = $row->us_chunk_inx;
            $this->mOffset = $row->us_size;
            $this->mVirtualTempPath = $row->us_path;
        }
    }

    private function getChunkIndex() {
        if ( $this->mChunkIndex !== null ) {
            return $this->mChunkIndex;
        }

        return 0;
    }

    public function getOffset() {
        if ( $this->mOffset !== null ) {
            return $this->mOffset;
        }

        return 0;
    }

    private function outputChunk( $chunkPath ) {
        // Key is fileKey + chunk index
        $fileKey = $this->getChunkFileKey();

        // Store the chunk per its indexed fileKey:
        $hashPath = $this->repo->getHashPath( $fileKey );
        $storeStatus = $this->repo->quickImport( $chunkPath,
            $this->repo->getZonePath( 'temp' ) . "/{$hashPath}{$fileKey}" );

        // Check for error in stashing the chunk:
        if ( !$storeStatus->isOK() ) {
            $error = $storeStatus->getErrorsArray();
            $error = reset( $error );
            if ( !count( $error ) ) {
                $error = $storeStatus->getWarningsArray();
                $error = reset( $error );
                if ( !count( $error ) ) {
                    $error = [ 'unknown', 'no error recorded' ];
                }
            }
            throw new UploadChunkFileException( "Error storing file in '$chunkPath': " .
                implode( '; ', $error ) );
        }

        return $storeStatus;
    }

    private function getChunkFileKey( $index = null ) {
        if ( $index === null ) {
            $index = $this->getChunkIndex();
        }

        return $this->mFileKey . '.' . $index;
    }

    private function verifyChunk() {
        // Rest mDesiredDestName here so we verify the name as if it were mFileKey
        $oldDesiredDestName = $this->mDesiredDestName;
        $this->mDesiredDestName = $this->mFileKey;
        $this->mTitle = false;
        $res = $this->verifyPartialFile();
        $this->mDesiredDestName = $oldDesiredDestName;
        $this->mTitle = false;
        if ( is_array( $res ) ) {
            throw new UploadChunkVerificationException( $res[0] );
        }
    }
}

class UploadChunkZeroLengthFileException extends MWException {
}

class UploadChunkFileException extends MWException {
}

class UploadChunkVerificationException extends MWException {
}