<?php
/**
- * @file
- * @ingroup upload
- *
* Implements uploading from previously stored file.
- *
+ *
+ * @ingroup Upload
* @author Bryan Tong Minh
*/
-
class UploadFromStash extends UploadBase {
- public static function isValidSessionKey( $key, $sessionData ) {
- return !empty( $key ) &&
- is_array( $sessionData ) &&
- isset( $sessionData[$key] ) &&
- isset( $sessionData[$key]['version'] ) &&
- $sessionData[$key]['version'] == self::SESSION_VERSION;
+ 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( $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 );
+ }
+
+ return true;
}
+ /**
+ * @param $key string
+ * @return bool
+ */
+ public static function isValidKey( $key ) {
+ // this is checked in more detail in UploadStash
+ return (bool)preg_match( UploadStash::KEY_FORMAT_REGEX, $key );
+ }
+
+ /**
+ * @param $request WebRequest
+ *
+ * @return Boolean
+ */
public static function isValidRequest( $request ) {
- $sessionData = $request->getSessionData( 'wsUploadData' );
- return self::isValidSessionKey(
- $request->getInt( 'wpSessionKey' ),
- $sessionData
- );
+ // 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' ) ) );
}
- /*
- * some $na vars for uploadBase method compatibility.
+
+ /**
+ * @param $key string
+ * @param $name string
*/
- public function initialize( $name, $sessionData, $na, $na2=false ) {
- /**
- * 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.
- */
- parent::initialize( $name,
- $sessionData['mTempPath'],
- $sessionData['mFileSize'],
- false
- );
-
- $this->mFileProps = $sessionData['mFileProps'];
+ 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'] ),
+ $metadata['us_size'],
+ false
+ );
+
+ $this->mFileKey = $key;
+ $this->mVirtualTempPath = $metadata['us_path'];
+ $this->mFileProps = $this->stash->getFileProps( $key );
+ $this->mSourceType = $metadata['us_source_type'];
}
+ /**
+ * @param $request WebRequest
+ */
public function initializeFromRequest( &$request ) {
- $sessionKey = $request->getInt( 'wpSessionKey' );
- $sessionData = $request->getSessionData('wsUploadData');
+ // 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 );
+ }
- $desiredDestName = $request->getText( 'wpDestFile' );
- if( !$desiredDestName )
- $desiredDestName = $request->getText( 'wpUploadFile' );
- return $this->initialize( $desiredDestName, $sessionData[$sessionKey], false );
+ /**
+ * @return string
+ */
+ public function getSourceType() {
+ return $this->mSourceType;
}
/**
* File has been previously verified so no need to do so again.
+ *
+ * @return bool
*/
protected function verifyFile() {
return true;
}
/**
- * We're here from "ignore warnings anyway" so return just OK
+ * Stash the file.
+ *
+ * @return UploadStashFile
*/
- public function checkWarnings() {
- return array();
+ 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;
}
-}
\ No newline at end of file
+ /**
+ * This should return the key instead of the UploadStashFile instance, for backward compatibility.
+ * @return String
+ */
+ public function stashSession() {
+ return $this->stashFile()->getFileKey();
+ }
+
+ /**
+ * Remove a temporarily kept file stashed by saveTempUploadedFile().
+ * @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;
+ }
+}
dépôts / lhc / web / wiklou.git / blobdiff