/**
* Implements uploading from previously stored file.
*
- * @file
- * @ingroup upload
+ * @ingroup Upload
* @author Bryan Tong Minh
*/
-
class UploadFromStash extends UploadBase {
protected $mFileKey, $mVirtualTempPath, $mFileProps, $mSourceType;
-
+
// an instance of UploadStash
private $stash;
-
+
//LocalFile repo
private $repo;
-
+
+ /**
+ * @param $user User
+ * @param $stash UploadStash
+ * @param $repo FileRepo
+ */
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( $stash ) {
$this->stash = $stash;
} else {
- wfDebug( __METHOD__ . " creating new UploadStash instance for " . $user->getId() . "\n" );
+ 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 );
}
return true;
}
-
+
+ /**
+ * @param $key string
+ * @return bool
+ */
public static function isValidKey( $key ) {
// this is checked in more detail in UploadStash
- return preg_match( UploadStash::KEY_FORMAT_REGEX, $key );
+ return (bool)preg_match( UploadStash::KEY_FORMAT_REGEX, $key );
}
/**
* @return Boolean
*/
public static function isValidRequest( $request ) {
- return self::isValidKey( $request->getText( 'wpFileKey' ) || $request->getText( 'wpSessionKey' ) );
+ // 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' ) ) );
}
+ /**
+ * @param $key string
+ * @param $name string
+ */
public function initialize( $key, $name = 'upload_file' ) {
/**
* Confirming a temporarily stashed upload.
* We don't want path names to be forged, so we keep
* them in the session on the server and just give
* an opaque key to the user agent.
- */
+ */
$metadata = $this->stash->getMetadata( $key );
$this->initializePathInfo( $name,
$this->getRealPath ( $metadata['us_path'] ),
* @param $request WebRequest
*/
public function initializeFromRequest( &$request ) {
- $fileKey = $request->getText( 'wpFileKey' ) || $request->getText( 'wpSessionKey' );
+ // sends wpSessionKey as a default when wpFileKey is missing
+ $fileKey = $request->getText( 'wpFileKey', $request->getText( 'wpSessionKey' ) );
- $desiredDestName = $request->getText( 'wpDestFile' );
- if( !$desiredDestName ) {
- $desiredDestName = $request->getText( 'wpUploadFile' ) || $request->getText( 'filename' );
- }
- return $this->initialize( $fileKey, $desiredDestName );
+ // 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;
+ /**
+ * @return string
+ */
+ public function getSourceType() {
+ return $this->mSourceType;
}
/**
}
/**
- * There is no need to stash the image twice
+ * Stash the file.
+ *
+ * @return UploadStashFile
*/
- public function stashFile( $key = null ) {
- if ( !empty( $this->mLocalFile ) ) {
- return $this->mLocalFile;
- }
- return parent::stashFile( $key );
+ public function stashFile() {
+ // replace mLocalFile with an instance of UploadStashFile, which adds some methods
+ // that are useful for stashed files.
+ $this->mLocalFile = parent::stashFile();
+ return $this->mLocalFile;
}
/**
- * Alias for stashFile
+ * This should return the key instead of the UploadStashFile instance, for backward compatibility.
+ * @return String
*/
- public function stashSession( $key = null ) {
- return $this->stashFile( $key );
+ public function stashSession() {
+ return $this->stashFile()->getFileKey();
}
/**
* Remove a temporarily kept file stashed by saveTempUploadedFile().
- * @return success
+ * @return bool success
*/
public function unsaveUploadedFile() {
return $this->stash->removeFile( $this->mFileKey );
/**
* Perform the upload, then remove the database record afterward.
+ * @param $comment string
+ * @param $pageText string
+ * @param $watch bool
+ * @param $user User
+ * @return Status
*/
public function performUpload( $comment, $pageText, $watch, $user ) {
$rv = parent::performUpload( $comment, $pageText, $watch, $user );
$this->unsaveUploadedFile();
return $rv;
}
-
- /**
- * Append a chunk to the temporary file.
- *
- * @return void
- */
- public function appendChunk($chunk, $chunkSize, $offset) {
- //to use $this->getFileSize() here, db needs to be updated
- //in appendToUploadFile for that
- $fileSize = $this->stash->getFile( $this->mFileKey )->getSize();
- if ( $fileSize + $chunkSize > $this->getMaxUploadSize()) {
- $status = Status::newFatal( 'file-too-large' );
- } else {
- //append chunk
- if ( $fileSize == $offset ) {
- $status = $this->appendToUploadFile( $chunk,
- $this->mVirtualTempPath );
- } else {
- $status = Status::newFatal( 'invalid-chunk-offset' );
- }
- }
- return $status;
- }
-
- /**
- * Append the final chunk and ready file for parent::performUpload()
- * @return void
- */
- public function finalizeFile() {
- $this->appendFinish ( $this->mVirtualTempPath );
- $this->cleanupTempFile();
- $this->mTempPath = $this->getRealPath( $this->mVirtualTempPath );
- }
}
dépôts / lhc / web / wiklou.git / blobdiff