1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
|
<?php
/**
* Backend for uploading files from previously stored file.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Upload
*/
use MediaWiki\MediaWikiServices;
use MediaWiki\Request\WebRequest;
use MediaWiki\User\UserIdentity;
/**
* Implements uploading from previously stored file.
*
* @ingroup Upload
* @author Bryan Tong Minh
*/
class UploadFromStash extends UploadBase {
/** @var string */
protected $mFileKey;
/** @var string */
protected $mVirtualTempPath;
/** @var string */
protected $mSourceType;
/** @var UploadStash */
private $stash;
/** @var FileRepo */
private $repo;
/**
* @param UserIdentity|null $user Default: null Sometimes this won't exist, as when running from cron.
* @param UploadStash|false $stash Default: false
* @param FileRepo|false $repo Default: false
*/
public function __construct( ?UserIdentity $user = null, $stash = false, $repo = false ) {
if ( $repo ) {
$this->repo = $repo;
} else {
$this->repo = MediaWikiServices::getInstance()->getRepoGroup()->getLocalRepo();
}
if ( $stash ) {
$this->stash = $stash;
} else {
if ( $user ) {
wfDebug( __METHOD__ . " creating new UploadStash instance for " . $user->getId() );
} else {
wfDebug( __METHOD__ . " creating new UploadStash instance with no user" );
}
$this->stash = new UploadStash( $this->repo, $user );
}
}
/**
* @param string $key
* @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 WebRequest $request
* @return bool
*/
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' ) ) );
}
/**
* @param string $key
* @param string $name
* @param bool $initTempFile
*/
public function initialize( $key, $name = 'upload_file', $initTempFile = true ) {
/**
* 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,
$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'];
}
/**
* @param WebRequest &$request
*/
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 );
}
/**
* @return string
*/
public function getSourceType() {
return $this->mSourceType;
}
/**
* Get the base 36 SHA1 of the file
* @return string
*/
public function getTempFileSha1Base36() {
// phan doesn't like us accessing this directly since in
// parent class this can be null, however we always set this in
// this class so it is safe. Add a check to keep phan happy.
if ( !is_array( $this->mFileProps ) ) {
throw new LogicException( "mFileProps should never be null" );
} else {
return $this->mFileProps['sha1'];
}
}
/**
* Remove a temporarily kept file stashed by saveTempUploadedFile().
* @return bool Success
*/
public function unsaveUploadedFile() {
return $this->stash->removeFile( $this->mFileKey );
}
/**
* Remove the database record after a successful upload.
*/
public function postProcessUpload() {
parent::postProcessUpload();
$this->unsaveUploadedFile();
}
}
|
