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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
|
<?php
/**
* 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
*/
use MediaWiki\Context\RequestContext;
use MediaWiki\Logger\LoggerFactory;
use MediaWiki\Request\WebRequestUpload;
use MediaWiki\Status\Status;
use Wikimedia\ScopedCallback;
/**
* Assemble the segments of a chunked upload.
*
* @ingroup Upload
* @ingroup JobQueue
*/
class AssembleUploadChunksJob extends Job implements GenericParameterJob {
public function __construct( array $params ) {
parent::__construct( 'AssembleUploadChunks', $params );
$this->removeDuplicates = true;
}
public function run() {
$scope = RequestContext::importScopedSession( $this->params['session'] );
$this->addTeardownCallback( static function () use ( &$scope ) {
ScopedCallback::consume( $scope ); // T126450
} );
$logger = LoggerFactory::getInstance( 'upload' );
$context = RequestContext::getMain();
$user = $context->getUser();
try {
if ( !$user->isRegistered() ) {
$this->setLastError( "Could not load the author user from session." );
return false;
}
// TODO add some sort of proper locking maybe
$startingStatus = UploadBase::getSessionStatus( $user, $this->params['filekey'] );
if (
!$startingStatus ||
( $startingStatus['result'] ?? '' ) !== 'Poll' ||
( $startingStatus['stage'] ?? '' ) !== 'queued'
) {
$logger->warning( "Tried to assemble upload that is in stage {stage}/{result}",
[
'stage' => $startingStatus['stage'] ?? '-',
'result' => $startingStatus['result'] ?? '-',
'status' => (string)( $startingStatus['status'] ?? '-' ),
'filekey' => $this->params['filekey'],
'filename' => $this->params['filename'],
'user' => $user->getName(),
]
);
// If it is marked as currently in progress, abort. Otherwise
// assume it is some sort of replag issue or maybe a retry even
// though retries are impossible and just warn.
if (
$startingStatus &&
$startingStatus['stage'] === 'assembling' &&
$startingStatus['result'] !== 'Failure'
) {
$this->setLastError( __METHOD__ . " already in progress" );
return false;
}
}
UploadBase::setSessionStatus(
$user,
$this->params['filekey'],
[ 'result' => 'Poll', 'stage' => 'assembling', 'status' => Status::newGood() ]
);
$upload = new UploadFromChunks( $user );
$upload->continueChunks(
$this->params['filename'],
$this->params['filekey'],
new WebRequestUpload( $context->getRequest(), 'null' )
);
if (
isset( $this->params['filesize'] ) &&
$this->params['filesize'] !== (int)$upload->getOffset()
) {
// Check to make sure we are not executing prior to the API's
// transaction being committed. (T350917)
throw new UnexpectedValueException(
"UploadStash file size does not match job's. Potential mis-nested transaction?"
);
}
// Combine all of the chunks into a local file and upload that to a new stash file
$status = $upload->concatenateChunks();
if ( !$status->isGood() ) {
UploadBase::setSessionStatus(
$user,
$this->params['filekey'],
[ 'result' => 'Failure', 'stage' => 'assembling', 'status' => $status ]
);
$logger->info( "Chunked upload assembly job failed for {filekey} because {status}",
[
'filekey' => $this->params['filekey'],
'filename' => $this->params['filename'],
'user' => $user->getName(),
'status' => (string)$status
]
);
// the chunks did not get assembled, but this should not be considered a job
// failure - they simply didn't pass verification for some reason, and that
// reason is stored in above session to inform the clients
return true;
}
// We can only get warnings like 'duplicate' after concatenating the chunks
$status = Status::newGood();
$status->value = [
'warnings' => UploadBase::makeWarningsSerializable(
$upload->checkWarnings( $user )
)
];
// We have a new filekey for the fully concatenated file
$newFileKey = $upload->getStashFile()->getFileKey();
// Remove the old stash file row and first chunk file
// Note: This does not delete the chunks, only the stash file
// which is same as first chunk but with a different name.
$upload->stash->removeFileNoAuth( $this->params['filekey'] );
// Build the image info array while we have the local reference handy
$apiUpload = ApiUpload::getDummyInstance();
$imageInfo = $apiUpload->getUploadImageInfo( $upload );
// Cleanup any temporary local file
$upload->cleanupTempFile();
// Cache the info so the user doesn't have to wait forever to get the final info
UploadBase::setSessionStatus(
$user,
$this->params['filekey'],
[
'result' => 'Success',
'stage' => 'assembling',
'filekey' => $newFileKey,
'imageinfo' => $imageInfo,
'status' => $status
]
);
$logger->info( "{filekey} successfully assembled into {newkey}",
[
'filekey' => $this->params['filekey'],
'newkey' => $newFileKey,
'filename' => $this->params['filename'],
'user' => $user->getName(),
'status' => (string)$status
]
);
} catch ( Exception $e ) {
UploadBase::setSessionStatus(
$user,
$this->params['filekey'],
[
'result' => 'Failure',
'stage' => 'assembling',
'status' => Status::newFatal( 'api-error-stashfailed' )
]
);
$this->setLastError( get_class( $e ) . ": " . $e->getMessage() );
// To be extra robust.
MWExceptionHandler::rollbackPrimaryChangesAndLog( $e );
return false;
}
return true;
}
public function getDeduplicationInfo() {
$info = parent::getDeduplicationInfo();
if ( is_array( $info['params'] ) ) {
$info['params'] = [ 'filekey' => $info['params']['filekey'] ];
}
return $info;
}
public function allowRetries() {
return false;
}
}
|
