MediaWiki master
UploadFromStash.php
Go to the documentation of this file.
1<?php
27
35 protected $mFileKey;
37 protected $mFileProps;
38 protected $mSourceType;
39
41 private $stash;
42
44 private $repo;
45
51 public function __construct( UserIdentity $user = null, $stash = false, $repo = false ) {
52 if ( $repo ) {
53 $this->repo = $repo;
54 } else {
55 $this->repo = MediaWikiServices::getInstance()->getRepoGroup()->getLocalRepo();
56 }
57
58 if ( $stash ) {
59 $this->stash = $stash;
60 } else {
61 if ( $user ) {
62 wfDebug( __METHOD__ . " creating new UploadStash instance for " . $user->getId() );
63 } else {
64 wfDebug( __METHOD__ . " creating new UploadStash instance with no user" );
65 }
66
67 $this->stash = new UploadStash( $this->repo, $user );
68 }
69 }
70
75 public static function isValidKey( $key ) {
76 // this is checked in more detail in UploadStash
77 return (bool)preg_match( UploadStash::KEY_FORMAT_REGEX, $key );
78 }
79
84 public static function isValidRequest( $request ) {
85 // this passes wpSessionKey to getText() as a default when wpFileKey isn't set.
86 // wpSessionKey has no default which guarantees failure if both are missing
87 // (though that should have been caught earlier)
88 return self::isValidKey( $request->getText( 'wpFileKey', $request->getText( 'wpSessionKey' ) ) );
89 }
90
96 public function initialize( $key, $name = 'upload_file', $initTempFile = true ) {
103 $metadata = $this->stash->getMetadata( $key );
104 $this->initializePathInfo( $name,
105 $initTempFile ? $this->getRealPath( $metadata['us_path'] ) : false,
106 $metadata['us_size'],
107 false
108 );
109
110 $this->mFileKey = $key;
111 $this->mVirtualTempPath = $metadata['us_path'];
112 $this->mFileProps = $this->stash->getFileProps( $key );
113 $this->mSourceType = $metadata['us_source_type'];
114 }
115
119 public function initializeFromRequest( &$request ) {
120 // sends wpSessionKey as a default when wpFileKey is missing
121 $fileKey = $request->getText( 'wpFileKey', $request->getText( 'wpSessionKey' ) );
122
123 // chooses one of wpDestFile, wpUploadFile, filename in that order.
124 $desiredDestName = $request->getText(
125 'wpDestFile',
126 $request->getText( 'wpUploadFile', $request->getText( 'filename' ) )
127 );
128
129 $this->initialize( $fileKey, $desiredDestName );
130 }
131
135 public function getSourceType() {
136 return $this->mSourceType;
137 }
138
143 public function getTempFileSha1Base36() {
144 return $this->mFileProps['sha1'];
145 }
146
151 public function unsaveUploadedFile() {
152 return $this->stash->removeFile( $this->mFileKey );
153 }
154
158 public function postProcessUpload() {
159 parent::postProcessUpload();
160 $this->unsaveUploadedFile();
161 }
162}
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
Base class for file repositories.
Definition FileRepo.php:50
Service locator for MediaWiki core services.
The WebRequest class encapsulates getting at data passed in the URL or via a POSTed form stripping il...
UploadBase and subclasses are the backend of MediaWiki's file uploads.
getRealPath( $srcPath)
initializePathInfo( $name, $tempPath, $fileSize, $removeTempFile=false)
Implements uploading from previously stored file.
__construct(UserIdentity $user=null, $stash=false, $repo=false)
getTempFileSha1Base36()
Get the base 36 SHA1 of the file.
static isValidKey( $key)
static isValidRequest( $request)
initializeFromRequest(&$request)
unsaveUploadedFile()
Remove a temporarily kept file stashed by saveTempUploadedFile().
postProcessUpload()
Remove the database record after a successful upload.
initialize( $key, $name='upload_file', $initTempFile=true)
UploadStash is intended to accomplish a few things:
Interface for objects representing user identity.