MediaWiki  master
UploadFromStash.php
Go to the documentation of this file.
1 <?php
26 
33 class UploadFromStash extends UploadBase {
34  protected $mFileKey;
35  protected $mVirtualTempPath;
36  protected $mFileProps;
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  // @phan-suppress-next-line SecurityCheck-PathTraversal
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 }
UploadBase
UploadBase and subclasses are the backend of MediaWiki's file uploads.
Definition: UploadBase.php:47
UploadBase\getRealPath
getRealPath( $srcPath)
Definition: UploadBase.php:332
UploadFromStash\$mSourceType
$mSourceType
Definition: UploadFromStash.php:37
MediaWiki\MediaWikiServices
MediaWikiServices is the service locator for the application scope of MediaWiki.
Definition: MediaWikiServices.php:203
UploadStash\KEY_FORMAT_REGEX
const KEY_FORMAT_REGEX
Definition: UploadStash.php:58
UploadFromStash\initializeFromRequest
initializeFromRequest(&$request)
Definition: UploadFromStash.php:119
UploadFromStash\getSourceType
getSourceType()
Definition: UploadFromStash.php:135
UploadFromStash\getTempFileSha1Base36
getTempFileSha1Base36()
Get the base 36 SHA1 of the file.
Definition: UploadFromStash.php:143
UploadStash
UploadStash is intended to accomplish a few things:
Definition: UploadStash.php:56
UploadFromStash
Implements uploading from previously stored file.
Definition: UploadFromStash.php:33
UploadFromStash\$stash
UploadStash $stash
Definition: UploadFromStash.php:40
UploadFromStash\$mVirtualTempPath
$mVirtualTempPath
Definition: UploadFromStash.php:35
MediaWiki\User\UserIdentity
Interface for objects representing user identity.
Definition: UserIdentity.php:39
FileRepo
Base class for file repositories.
Definition: FileRepo.php:45
wfDebug
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
Definition: GlobalFunctions.php:894
UploadFromStash\postProcessUpload
postProcessUpload()
Remove the database record after a successful upload.
Definition: UploadFromStash.php:158
UploadFromStash\unsaveUploadedFile
unsaveUploadedFile()
Remove a temporarily kept file stashed by saveTempUploadedFile().
Definition: UploadFromStash.php:151
UploadFromStash\$repo
FileRepo $repo
Definition: UploadFromStash.php:43
UploadFromStash\isValidKey
static isValidKey( $key)
Definition: UploadFromStash.php:74
UploadFromStash\isValidRequest
static isValidRequest( $request)
Definition: UploadFromStash.php:83
UploadFromStash\__construct
__construct(UserIdentity $user=null, $stash=false, $repo=false)
Definition: UploadFromStash.php:50
UploadBase\initializePathInfo
initializePathInfo( $name, $tempPath, $fileSize, $removeTempFile=false)
Definition: UploadBase.php:260
UploadFromStash\$mFileProps
$mFileProps
Definition: UploadFromStash.php:36
UploadFromStash\$mFileKey
$mFileKey
Definition: UploadFromStash.php:34
UploadFromStash\initialize
initialize( $key, $name='upload_file', $initTempFile=true)
Definition: UploadFromStash.php:95