MediaWiki  1.28.0
UploadFromUrl.php
Go to the documentation of this file.
1 <?php
31 class UploadFromUrl extends UploadBase {
32  protected $mUrl;
33 
34  protected $mTempPath, $mTmpHandle;
35 
36  protected static $allowedUrls = [];
37 
47  public static function isAllowed( $user ) {
48  if ( !$user->isAllowed( 'upload_by_url' ) ) {
49  return 'upload_by_url';
50  }
51 
52  return parent::isAllowed( $user );
53  }
54 
59  public static function isEnabled() {
61 
62  return $wgAllowCopyUploads && parent::isEnabled();
63  }
64 
73  public static function isAllowedHost( $url ) {
75  if ( !count( $wgCopyUploadsDomains ) ) {
76  return true;
77  }
78  $parsedUrl = wfParseUrl( $url );
79  if ( !$parsedUrl ) {
80  return false;
81  }
82  $valid = false;
83  foreach ( $wgCopyUploadsDomains as $domain ) {
84  // See if the domain for the upload matches this whitelisted domain
85  $whitelistedDomainPieces = explode( '.', $domain );
86  $uploadDomainPieces = explode( '.', $parsedUrl['host'] );
87  if ( count( $whitelistedDomainPieces ) === count( $uploadDomainPieces ) ) {
88  $valid = true;
89  // See if all the pieces match or not (excluding wildcards)
90  foreach ( $whitelistedDomainPieces as $index => $piece ) {
91  if ( $piece !== '*' && $piece !== $uploadDomainPieces[$index] ) {
92  $valid = false;
93  }
94  }
95  if ( $valid ) {
96  // We found a match, so quit comparing against the list
97  break;
98  }
99  }
100  /* Non-wildcard test
101  if ( $parsedUrl['host'] === $domain ) {
102  $valid = true;
103  break;
104  }
105  */
106  }
107 
108  return $valid;
109  }
110 
117  public static function isAllowedUrl( $url ) {
118  if ( !isset( self::$allowedUrls[$url] ) ) {
119  $allowed = true;
120  Hooks::run( 'IsUploadAllowedFromUrl', [ $url, &$allowed ] );
121  self::$allowedUrls[$url] = $allowed;
122  }
123 
124  return self::$allowedUrls[$url];
125  }
126 
134  public function initialize( $name, $url ) {
135  $this->mUrl = $url;
136 
137  $tempPath = $this->makeTemporaryFile();
138  # File size and removeTempFile will be filled in later
139  $this->initializePathInfo( $name, $tempPath, 0, false );
140  }
141 
146  public function initializeFromRequest( &$request ) {
147  $desiredDestName = $request->getText( 'wpDestFile' );
148  if ( !$desiredDestName ) {
149  $desiredDestName = $request->getText( 'wpUploadFileURL' );
150  }
151  $this->initialize(
152  $desiredDestName,
153  trim( $request->getVal( 'wpUploadFileURL' ) ),
154  false
155  );
156  }
157 
162  public static function isValidRequest( $request ) {
163  global $wgUser;
164 
165  $url = $request->getVal( 'wpUploadFileURL' );
166 
167  return !empty( $url )
168  && $wgUser->isAllowed( 'upload_by_url' );
169  }
170 
174  public function getSourceType() {
175  return 'url';
176  }
177 
185  public function fetchFile( $httpOptions = [] ) {
186  if ( !Http::isValidURI( $this->mUrl ) ) {
187  return Status::newFatal( 'http-invalid-url', $this->mUrl );
188  }
189 
190  if ( !self::isAllowedHost( $this->mUrl ) ) {
191  return Status::newFatal( 'upload-copy-upload-invalid-domain' );
192  }
193  if ( !self::isAllowedUrl( $this->mUrl ) ) {
194  return Status::newFatal( 'upload-copy-upload-invalid-url' );
195  }
196  return $this->reallyFetchFile( $httpOptions );
197  }
198 
204  protected function makeTemporaryFile() {
205  $tmpFile = TempFSFile::factory( 'URL', 'urlupload_', wfTempDir() );
206  $tmpFile->bind( $this );
207 
208  return $tmpFile->getPath();
209  }
210 
218  public function saveTempFileChunk( $req, $buffer ) {
219  wfDebugLog( 'fileupload', 'Received chunk of ' . strlen( $buffer ) . ' bytes' );
220  $nbytes = fwrite( $this->mTmpHandle, $buffer );
221 
222  if ( $nbytes == strlen( $buffer ) ) {
223  $this->mFileSize += $nbytes;
224  } else {
225  // Well... that's not good!
226  wfDebugLog(
227  'fileupload',
228  'Short write ' . $this->nbytes . '/' . strlen( $buffer ) .
229  ' bytes, aborting with ' . $this->mFileSize . ' uploaded so far'
230  );
231  fclose( $this->mTmpHandle );
232  $this->mTmpHandle = false;
233  }
234 
235  return $nbytes;
236  }
237 
245  protected function reallyFetchFile( $httpOptions = [] ) {
247  if ( $this->mTempPath === false ) {
248  return Status::newFatal( 'tmp-create-error' );
249  }
250 
251  // Note the temporary file should already be created by makeTemporaryFile()
252  $this->mTmpHandle = fopen( $this->mTempPath, 'wb' );
253  if ( !$this->mTmpHandle ) {
254  return Status::newFatal( 'tmp-create-error' );
255  }
256  wfDebugLog( 'fileupload', 'Temporary file created "' . $this->mTempPath . '"' );
257 
258  $this->mRemoveTempFile = true;
259  $this->mFileSize = 0;
260 
261  $options = $httpOptions + [ 'followRedirects' => true ];
262 
263  if ( $wgCopyUploadProxy !== false ) {
264  $options['proxy'] = $wgCopyUploadProxy;
265  }
266 
267  if ( $wgCopyUploadTimeout && !isset( $options['timeout'] ) ) {
268  $options['timeout'] = $wgCopyUploadTimeout;
269  }
270  wfDebugLog(
271  'fileupload',
272  'Starting download from "' . $this->mUrl . '" ' .
273  '<' . implode( ',', array_keys( array_filter( $options ) ) ) . '>'
274  );
275  $req = MWHttpRequest::factory( $this->mUrl, $options, __METHOD__ );
276  $req->setCallback( [ $this, 'saveTempFileChunk' ] );
277  $status = $req->execute();
278 
279  if ( $this->mTmpHandle ) {
280  // File got written ok...
281  fclose( $this->mTmpHandle );
282  $this->mTmpHandle = null;
283  } else {
284  // We encountered a write error during the download...
285  return Status::newFatal( 'tmp-write-error' );
286  }
287 
288  wfDebugLog( 'fileupload', $status );
289  if ( $status->isOK() ) {
290  wfDebugLog( 'fileupload', 'Download by URL completed successfuly.' );
291  } else {
292  wfDebugLog(
293  'fileupload',
294  'Download by URL completed with HTTP status ' . $req->getStatus()
295  );
296  }
297 
298  return $status;
299  }
300 }
makeTemporaryFile()
Create a new temporary file in the URL subdirectory of wfTempDir().
initialize($name, $url)
Entry point for API upload.
$wgCopyUploadsDomains
A list of domains copy uploads can come from.
static $allowedUrls
static newFatal($message)
Factory function for fatal errors.
Definition: StatusValue.php:63
initializeFromRequest(&$request)
Entry point for SpecialUpload.
when a variable name is used in a it is silently declared as a new local masking the global
Definition: design.txt:93
$wgAllowCopyUploads
Allow for upload to be copied from an URL.
static factory($prefix, $extension= '', $tmpDirectory=null)
Make a new temporary file on the file system.
Definition: TempFSFile.php:55
Implements uploading from a HTTP resource.
static isAllowedHost($url)
Checks whether the URL is for an allowed host The domains in the whitelist can include wildcard chara...
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return true
Definition: hooks.txt:1936
wfDebugLog($logGroup, $text, $dest= 'all', array $context=[])
Send a line to a supplementary debug log file, if configured, or main debug log if not...
static isEnabled()
Checks if the upload from URL feature is enabled.
wfTempDir()
Tries to get the system directory for temporary files.
UploadBase and subclasses are the backend of MediaWiki's file uploads.
Definition: UploadBase.php:38
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context $options
Definition: hooks.txt:1046
$buffer
fetchFile($httpOptions=[])
Download the file.
static run($event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:131
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 as
Definition: distributors.txt:9
$wgCopyUploadTimeout
Different timeout for upload by url This could be useful since when fetching large files...
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account $user
Definition: hooks.txt:242
static isAllowed($user)
Checks if the user is allowed to use the upload-by-URL feature.
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
this hook is for auditing only $req
Definition: hooks.txt:1007
error also a ContextSource you ll probably need to make sure the header is varied on $request
Definition: hooks.txt:2573
static isAllowedUrl($url)
Checks whether the URL is not allowed.
saveTempFileChunk($req, $buffer)
Callback: save a chunk of the result of a HTTP request to the temporary file.
static isValidRequest($request)
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set $status
Definition: hooks.txt:1046
static factory($url, $options=null, $caller=__METHOD__)
Generate a new request object.
$wgCopyUploadProxy
Proxy to use for copy upload requests.
wfParseUrl($url)
parse_url() work-alike, but non-broken.
reallyFetchFile($httpOptions=[])
Download the file, save it to the temporary file and update the file size and set $mRemoveTempFile to...
static isValidURI($uri)
Checks that the given URI is a valid one.
Definition: Http.php:142
initializePathInfo($name, $tempPath, $fileSize, $removeTempFile=false)
Initialize the path information.
Definition: UploadBase.php:230
$wgUser
Definition: Setup.php:806
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:300