60 private const MAX_US_PROPS_SIZE = 65535;
112 public function getFile( $key, $noAuth =
false ) {
113 if ( !preg_match( self::KEY_FORMAT_REGEX, $key ) ) {
115 wfMessage(
'uploadstash-bad-path-bad-format', $key )
119 if ( !$noAuth && !$this->user->isRegistered() ) {
125 if ( !isset( $this->fileMetadata[$key] ) ) {
132 if ( !isset( $this->fileMetadata[$key] ) ) {
134 wfMessage(
'uploadstash-file-not-found', $key )
143 isset( $this->fileMetadata[$key][
'us_props'] ) && strlen( $this->fileMetadata[$key][
'us_props'] )
145 $this->fileProps[$key] = unserialize( $this->fileMetadata[$key][
'us_props'] );
147 wfDebug( __METHOD__ .
" fetched props for $key from file" );
148 $path = $this->fileMetadata[$key][
'us_path'];
149 $this->fileProps[$key] = $this->repo->getFileProps(
$path );
153 if ( !$this->files[$key]->exists() ) {
154 wfDebug( __METHOD__ .
" tried to get file at $key, but it doesn't exist" );
161 if ( !$noAuth && $this->fileMetadata[$key][
'us_user'] != $this->user->getId() ) {
163 wfMessage(
'uploadstash-wrong-owner', $key )
167 return $this->files[$key];
179 return $this->fileMetadata[$key];
191 return $this->fileProps[$key];
207 if ( !is_file(
$path ) ) {
208 wfDebug( __METHOD__ .
" tried to stash file at '$path', but it doesn't exist" );
214 $mwProps =
new MWFileProps( MediaWikiServices::getInstance()->getMimeAnalyzer() );
216 wfDebug( __METHOD__ .
" stashing file at '$path'" );
221 if ( !preg_match(
"/\\.\\Q$extension\\E$/",
$path ) ) {
222 $pathWithGoodExtension =
"$path.$extension";
224 $pathWithGoodExtension =
$path;
232 [ $usec, $sec ] = explode(
' ', microtime() );
233 $usec = substr( $usec, 2 );
234 $key = Wikimedia\base_convert( $sec . $usec, 10, 36 ) .
'.' .
235 Wikimedia\base_convert( (
string)mt_rand(), 10, 36 ) .
'.' .
236 $this->user->getId() .
'.' .
241 if ( !preg_match( self::KEY_FORMAT_REGEX, $key ) ) {
243 wfMessage(
'uploadstash-bad-path-bad-format', $key )
247 wfDebug( __METHOD__ .
" key for '$path': $key" );
250 $storeStatus = $this->repo->storeTemp( basename( $pathWithGoodExtension ),
$path );
252 if ( !$storeStatus->isOK() ) {
261 $error = $storeStatus->getErrorsArray();
262 $error = reset( $error );
263 if ( !count( $error ) ) {
264 $error = $storeStatus->getWarningsArray();
265 $error = reset( $error );
266 if ( !count( $error ) ) {
267 $error = [
'unknown',
'no error recorded' ];
272 $errorMsg = array_shift( $error );
275 $stashPath = $storeStatus->value;
278 if ( !$this->user->isRegistered() ) {
285 wfDebug( __METHOD__ .
" inserting $stashPath under $key" );
286 $dbw = $this->repo->getPrimaryDB();
288 $serializedFileProps = serialize(
$fileProps );
289 if ( strlen( $serializedFileProps ) > self::MAX_US_PROPS_SIZE ) {
294 $serializedFileProps = serialize(
$fileProps );
298 'us_user' => $this->user->getId(),
300 'us_orig_path' =>
$path,
301 'us_path' => $stashPath,
302 'us_props' => $dbw->encodeBlob( $serializedFileProps ),
310 'us_source_type' => $sourceType,
311 'us_timestamp' => $dbw->timestamp(),
312 'us_status' =>
'finished'
323 $insertRow[
'us_id'] = $dbw->insertId();
325 $this->fileMetadata[$key] = $insertRow;
327 # create the UploadStashFile object for this file.
341 if ( !$this->user->isRegistered() ) {
347 wfDebug( __METHOD__ .
' clearing all rows for user ' . $this->user->getId() );
348 $dbw = $this->repo->getPrimaryDB();
351 [
'us_user' => $this->user->getId() ],
357 $this->fileMetadata = [];
371 if ( !$this->user->isRegistered() ) {
377 $dbw = $this->repo->getPrimaryDB();
381 $row = $dbw->newSelectQueryBuilder()
382 ->select(
'us_user' )
383 ->from(
'uploadstash' )
384 ->where( [
'us_key' => $key ] )
385 ->caller( __METHOD__ )->fetchRow();
389 wfMessage(
'uploadstash-no-such-key', $key )
393 if ( $row->us_user != $this->user->getId() ) {
395 wfMessage(
'uploadstash-wrong-owner', $key )
409 wfDebug( __METHOD__ .
" clearing row $key" );
414 $dbw = $this->repo->getPrimaryDB();
418 [
'us_key' => $key ],
425 $this->files[$key]->remove();
427 unset( $this->files[$key] );
428 unset( $this->fileMetadata[$key] );
440 if ( !$this->user->isRegistered() ) {
446 $res = $this->repo->getReplicaDB()->newSelectQueryBuilder()
448 ->from(
'uploadstash' )
449 ->where( [
'us_user' => $this->user->getId() ] )
450 ->caller( __METHOD__ )->fetchResultSet();
452 if ( !is_object(
$res ) ||
$res->numRows() == 0 ) {
459 foreach (
$res as $row ) {
460 array_push(
$keys, $row->us_key );
476 $prohibitedFileExtensions = MediaWikiServices::getInstance()
477 ->getMainConfig()->get( MainConfigNames::ProhibitedFileExtensions );
479 $n = strrpos(
$path,
'.' );
481 if ( $n !==
false ) {
482 $extension = $n ? substr(
$path, $n + 1 ) :
'';
485 $magic = MediaWikiServices::getInstance()->getMimeAnalyzer();
486 $mimeType = $magic->guessMimeType(
$path );
487 $extension = $magic->getExtensionFromMimeTypeOrNull( $mimeType ) ??
'';
491 if ( in_array( $extension, $prohibitedFileExtensions ) ) {
513 $dbr = $this->repo->getPrimaryDB();
515 $dbr = $this->repo->getReplicaDB();
518 $row =
$dbr->newSelectQueryBuilder()
520 'us_user',
'us_key',
'us_orig_path',
'us_path',
'us_props',
521 'us_size',
'us_sha1',
'us_mime',
'us_media_type',
522 'us_image_width',
'us_image_height',
'us_image_bits',
523 'us_source_type',
'us_timestamp',
'us_status',
525 ->from(
'uploadstash' )
526 ->where( [
'us_key' => $key ] )
527 ->caller( __METHOD__ )->fetchRow();
529 if ( !is_object( $row ) ) {
534 $this->fileMetadata[$key] = (array)$row;
535 $this->fileMetadata[$key][
'us_props'] =
$dbr->decodeBlob( $row->us_props );
549 if (
$file->getSize() === 0 ) {
554 $this->files[$key] =
$file;
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
wfMessage( $key,... $params)
This is the function for getting translated interface messages.
Base class for file repositories.
static normalizeExtension( $extension)
Normalize a file extension to the common form, making it lowercase and checking some synonyms,...
MimeMagic helper wrapper.
A class containing constants representing the names of configuration variables.
static getMain()
Get the RequestContext object associated with the main request.
UploadStash is intended to accomplish a few things:
static getExtensionForPath( $path)
Find or guess extension – ensuring that our extension matches our MIME type.
removeFile( $key)
Remove a particular file from the stash.
fetchFileMetadata( $key, $readFromDB=DB_REPLICA)
Helper function: do the actual database query to fetch file metadata.
getFileProps( $key)
Getter for fileProps.
stashFile( $path, $sourceType=null)
Stash a file in a temp directory and record that we did this in the database, along with other metada...
clear()
Remove all files from the stash.
array $fileMetadata
cache of the file metadata that's stored in the database
array $fileProps
fileprops cache
listFiles()
List all files in the stash.
__construct(FileRepo $repo, UserIdentity $user=null)
Represents a temporary filestore, with metadata in the database.
getMetadata( $key)
Getter for file metadata.
removeFileNoAuth( $key)
Remove a file (see removeFile), but doesn't check ownership first.
initFile( $key)
Helper function: Initialize the UploadStashFile for a given file.
getFile( $key, $noAuth=false)
Get a file and its metadata from the stash.
LocalRepo $repo
repository that this uses to store temp files public because we sometimes need to get a LocalFile wit...
array $files
array of initialized repo objects
if(PHP_SAPI !='cli-server') if(!isset( $_SERVER['SCRIPT_FILENAME'])) $file
Item class for a filearchive table row.