3 * Backend for uploading files from previously stored file.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
25 * Implements uploading from previously stored file.
28 * @author Bryan Tong Minh
30 class UploadFromStash
extends UploadBase
{
31 protected $mFileKey, $mVirtualTempPath, $mFileProps, $mSourceType;
33 // an instance of UploadStash
41 * @param $stash UploadStash
42 * @param $repo FileRepo
44 public function __construct( $user = false, $stash = false, $repo = false ) {
45 // user object. sometimes this won't exist, as when running from cron.
51 $this->repo
= RepoGroup
::singleton()->getLocalRepo();
55 $this->stash
= $stash;
58 wfDebug( __METHOD__
. " creating new UploadStash instance for " . $user->getId() . "\n" );
60 wfDebug( __METHOD__
. " creating new UploadStash instance with no user\n" );
63 $this->stash
= new UploadStash( $this->repo
, $this->user
);
73 public static function isValidKey( $key ) {
74 // this is checked in more detail in UploadStash
75 return (bool)preg_match( UploadStash
::KEY_FORMAT_REGEX
, $key );
79 * @param $request WebRequest
83 public static function isValidRequest( $request ) {
84 // this passes wpSessionKey to getText() as a default when wpFileKey isn't set.
85 // wpSessionKey has no default which guarantees failure if both are missing
86 // (though that should have been caught earlier)
87 return self
::isValidKey( $request->getText( 'wpFileKey', $request->getText( 'wpSessionKey' ) ) );
94 public function initialize( $key, $name = 'upload_file' ) {
96 * Confirming a temporarily stashed upload.
97 * We don't want path names to be forged, so we keep
98 * them in the session on the server and just give
99 * an opaque key to the user agent.
101 $metadata = $this->stash
->getMetadata( $key );
102 $this->initializePathInfo( $name,
103 $this->getRealPath ( $metadata['us_path'] ),
104 $metadata['us_size'],
108 $this->mFileKey
= $key;
109 $this->mVirtualTempPath
= $metadata['us_path'];
110 $this->mFileProps
= $this->stash
->getFileProps( $key );
111 $this->mSourceType
= $metadata['us_source_type'];
115 * @param $request WebRequest
117 public function initializeFromRequest( &$request ) {
118 // sends wpSessionKey as a default when wpFileKey is missing
119 $fileKey = $request->getText( 'wpFileKey', $request->getText( 'wpSessionKey' ) );
121 // chooses one of wpDestFile, wpUploadFile, filename in that order.
122 $desiredDestName = $request->getText( 'wpDestFile', $request->getText( 'wpUploadFile', $request->getText( 'filename' ) ) );
124 $this->initialize( $fileKey, $desiredDestName );
130 public function getSourceType() {
131 return $this->mSourceType
;
135 * File has been previously verified so no need to do so again.
139 protected function verifyFile() {
146 * @return UploadStashFile
148 public function stashFile() {
149 // replace mLocalFile with an instance of UploadStashFile, which adds some methods
150 // that are useful for stashed files.
151 $this->mLocalFile
= parent
::stashFile();
152 return $this->mLocalFile
;
156 * This should return the key instead of the UploadStashFile instance, for backward compatibility.
159 public function stashSession() {
160 return $this->stashFile()->getFileKey();
164 * Remove a temporarily kept file stashed by saveTempUploadedFile().
165 * @return bool success
167 public function unsaveUploadedFile() {
168 return $this->stash
->removeFile( $this->mFileKey
);
172 * Perform the upload, then remove the database record afterward.
173 * @param $comment string
174 * @param $pageText string
179 public function performUpload( $comment, $pageText, $watch, $user ) {
180 $rv = parent
::performUpload( $comment, $pageText, $watch, $user );
181 $this->unsaveUploadedFile();