MediaWiki master
UploadFromStash.php
Go to the documentation of this file.
1<?php
27
35 protected $mFileKey;
37 protected $mSourceType;
38
40 private $stash;
41
43 private $repo;
44
50 public function __construct( UserIdentity $user = null, $stash = false, $repo = false ) {
51 if ( $repo ) {
52 $this->repo = $repo;
53 } else {
54 $this->repo = MediaWikiServices::getInstance()->getRepoGroup()->getLocalRepo();
55 }
56
57 if ( $stash ) {
58 $this->stash = $stash;
59 } else {
60 if ( $user ) {
61 wfDebug( __METHOD__ . " creating new UploadStash instance for " . $user->getId() );
62 } else {
63 wfDebug( __METHOD__ . " creating new UploadStash instance with no user" );
64 }
65
66 $this->stash = new UploadStash( $this->repo, $user );
67 }
68 }
69
74 public static function isValidKey( $key ) {
75 // this is checked in more detail in UploadStash
76 return (bool)preg_match( UploadStash::KEY_FORMAT_REGEX, $key );
77 }
78
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' ) ) );
88 }
89
95 public function initialize( $key, $name = 'upload_file', $initTempFile = true ) {
102 $metadata = $this->stash->getMetadata( $key );
103 $this->initializePathInfo( $name,
104 $initTempFile ? $this->getRealPath( $metadata['us_path'] ) : false,
105 $metadata['us_size'],
106 false
107 );
108
109 $this->mFileKey = $key;
110 $this->mVirtualTempPath = $metadata['us_path'];
111 $this->mFileProps = $this->stash->getFileProps( $key );
112 $this->mSourceType = $metadata['us_source_type'];
113 }
114
118 public function initializeFromRequest( &$request ) {
119 // sends wpSessionKey as a default when wpFileKey is missing
120 $fileKey = $request->getText( 'wpFileKey', $request->getText( 'wpSessionKey' ) );
121
122 // chooses one of wpDestFile, wpUploadFile, filename in that order.
123 $desiredDestName = $request->getText(
124 'wpDestFile',
125 $request->getText( 'wpUploadFile', $request->getText( 'filename' ) )
126 );
127
128 $this->initialize( $fileKey, $desiredDestName );
129 }
130
134 public function getSourceType() {
135 return $this->mSourceType;
136 }
137
142 public function getTempFileSha1Base36() {
143 // phan doesn't like us accessing this directly since in
144 // parent class this can be null, however we always set this in
145 // this class so it is safe. Add a check to keep phan happy.
146 if ( !is_array( $this->mFileProps ) ) {
147 throw new LogicException( "mFileProps should never be null" );
148 } else {
149 return $this->mFileProps['sha1'];
150 }
151 }
152
157 public function unsaveUploadedFile() {
158 return $this->stash->removeFile( $this->mFileKey );
159 }
160
164 public function postProcessUpload() {
165 parent::postProcessUpload();
166 $this->unsaveUploadedFile();
167 }
168}
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:51
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.