MediaWiki  master
UploadFromStash.php
Go to the documentation of this file.
1 <?php
30 class UploadFromStash extends UploadBase {
31  protected $mFileKey;
32  protected $mVirtualTempPath;
33  protected $mFileProps;
34  protected $mSourceType;
35 
36  // an instance of UploadStash
37  private $stash;
38 
39  // LocalFile repo
40  private $repo;
41 
47  public function __construct( $user = false, $stash = false, $repo = false ) {
48  // user object. sometimes this won't exist, as when running from cron.
49  $this->user = $user;
50 
51  if ( $repo ) {
52  $this->repo = $repo;
53  } else {
54  $this->repo = RepoGroup::singleton()->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() . "\n" );
62  } else {
63  wfDebug( __METHOD__ . " creating new UploadStash instance with no user\n" );
64  }
65 
66  $this->stash = new UploadStash( $this->repo, $this->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  return $this->mFileProps['sha1'];
144  }
145 
150  public function unsaveUploadedFile() {
151  return $this->stash->removeFile( $this->mFileKey );
152  }
153 
157  public function postProcessUpload() {
158  parent::postProcessUpload();
159  $this->unsaveUploadedFile();
160  }
161 }
initialize( $key, $name='upload_file', $initTempFile=true)
const KEY_FORMAT_REGEX
Definition: UploadStash.php:55
Implements uploading from previously stored file.
initializePathInfo( $name, $tempPath, $fileSize, $removeTempFile=false)
Initialize the path information.
Definition: UploadBase.php:228
getTempFileSha1Base36()
Get the base 36 SHA1 of the file.
static isValidRequest( $request)
UploadBase and subclasses are the backend of MediaWiki&#39;s file uploads.
Definition: UploadBase.php:40
static singleton()
Get a RepoGroup instance.
Definition: RepoGroup.php:61
__construct( $user=false, $stash=false, $repo=false)
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
static isValidKey( $key)
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such and we might be restricted by PHP settings such as safe mode or open_basedir We cannot assume that the software even has read access anywhere useful Many shared hosts run all users web applications under the same user
Wikitext formatted, in the key only.
Definition: distributors.txt:9
postProcessUpload()
Remove the database record after a successful upload.
unsaveUploadedFile()
Remove a temporarily kept file stashed by saveTempUploadedFile().
getRealPath( $srcPath)
Definition: UploadBase.php:298
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
UploadStash is intended to accomplish a few things:
Definition: UploadStash.php:53
initializeFromRequest(&$request)
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on $request
Definition: hooks.txt:2633
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1473