MediaWiki  1.29.1
AssembleUploadChunksJob.php
Go to the documentation of this file.
1 <?php
23 use Wikimedia\ScopedCallback;
24 
31  public function __construct( Title $title, array $params ) {
32  parent::__construct( 'AssembleUploadChunks', $title, $params );
33  $this->removeDuplicates = true;
34  }
35 
36  public function run() {
37  $scope = RequestContext::importScopedSession( $this->params['session'] );
38  $this->addTeardownCallback( function () use ( &$scope ) {
39  ScopedCallback::consume( $scope ); // T126450
40  } );
41 
43  $user = $context->getUser();
44  try {
45  if ( !$user->isLoggedIn() ) {
46  $this->setLastError( "Could not load the author user from session." );
47 
48  return false;
49  }
50 
51  UploadBase::setSessionStatus(
52  $user,
53  $this->params['filekey'],
54  [ 'result' => 'Poll', 'stage' => 'assembling', 'status' => Status::newGood() ]
55  );
56 
57  $upload = new UploadFromChunks( $user );
58  $upload->continueChunks(
59  $this->params['filename'],
60  $this->params['filekey'],
61  new WebRequestUpload( $context->getRequest(), 'null' )
62  );
63 
64  // Combine all of the chunks into a local file and upload that to a new stash file
65  $status = $upload->concatenateChunks();
66  if ( !$status->isGood() ) {
67  UploadBase::setSessionStatus(
68  $user,
69  $this->params['filekey'],
70  [ 'result' => 'Failure', 'stage' => 'assembling', 'status' => $status ]
71  );
72  $this->setLastError( $status->getWikiText( false, false, 'en' ) );
73 
74  return false;
75  }
76 
77  // We can only get warnings like 'duplicate' after concatenating the chunks
79  $status->value = [ 'warnings' => $upload->checkWarnings() ];
80 
81  // We have a new filekey for the fully concatenated file
82  $newFileKey = $upload->getStashFile()->getFileKey();
83 
84  // Remove the old stash file row and first chunk file
85  $upload->stash->removeFileNoAuth( $this->params['filekey'] );
86 
87  // Build the image info array while we have the local reference handy
88  $apiMain = new ApiMain(); // dummy object (XXX)
89  $imageInfo = $upload->getImageInfo( $apiMain->getResult() );
90 
91  // Cleanup any temporary local file
92  $upload->cleanupTempFile();
93 
94  // Cache the info so the user doesn't have to wait forever to get the final info
95  UploadBase::setSessionStatus(
96  $user,
97  $this->params['filekey'],
98  [
99  'result' => 'Success',
100  'stage' => 'assembling',
101  'filekey' => $newFileKey,
102  'imageinfo' => $imageInfo,
103  'status' => $status
104  ]
105  );
106  } catch ( Exception $e ) {
107  UploadBase::setSessionStatus(
108  $user,
109  $this->params['filekey'],
110  [
111  'result' => 'Failure',
112  'stage' => 'assembling',
113  'status' => Status::newFatal( 'api-error-stashfailed' )
114  ]
115  );
116  $this->setLastError( get_class( $e ) . ": " . $e->getMessage() );
117  // To be extra robust.
119 
120  return false;
121  }
122 
123  return true;
124  }
125 
126  public function getDeduplicationInfo() {
127  $info = parent::getDeduplicationInfo();
128  if ( is_array( $info['params'] ) ) {
129  $info['params'] = [ 'filekey' => $info['params']['filekey'] ];
130  }
131 
132  return $info;
133  }
134 
135  public function allowRetries() {
136  return false;
137  }
138 }
ApiMain
This is the main API class, used for both external and internal processing.
Definition: ApiMain.php:45
$context
error also a ContextSource you ll probably need to make sure the header is varied on and they can depend only on the ResourceLoaderContext $context
Definition: hooks.txt:2612
AssembleUploadChunksJob\run
run()
Run the job.
Definition: AssembleUploadChunksJob.php:36
AssembleUploadChunksJob\getDeduplicationInfo
getDeduplicationInfo()
Subclasses may need to override this to make duplication detection work.
Definition: AssembleUploadChunksJob.php:126
Job\$title
Title $title
Definition: Job.php:42
$status
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup 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:1049
use
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
Definition: MIT-LICENSE.txt:10
$user
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 account $user
Definition: hooks.txt:246
StatusValue\newFatal
static newFatal( $message)
Factory function for fatal errors.
Definition: StatusValue.php:63
Job\addTeardownCallback
addTeardownCallback( $callback)
Definition: Job.php:309
ContextSource\getRequest
getRequest()
Get the WebRequest object.
Definition: ContextSource.php:78
ContextSource\getUser
getUser()
Get the User object.
Definition: ContextSource.php:133
Job\$params
array $params
Array of job parameters.
Definition: Job.php:36
Job\setLastError
setLastError( $error)
Definition: Job.php:393
php
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
Job
Class to both describe a background job and handle jobs.
Definition: Job.php:31
AssembleUploadChunksJob\allowRetries
allowRetries()
Definition: AssembleUploadChunksJob.php:135
MWExceptionHandler\rollbackMasterChangesAndLog
static rollbackMasterChangesAndLog( $e)
Roll back any open database transactions and log the stack trace of the exception.
Definition: MWExceptionHandler.php:93
WebRequestUpload
Object to access the $_FILES array.
Definition: WebRequestUpload.php:28
$e
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2122
StatusValue\newGood
static newGood( $value=null)
Factory function for good results.
Definition: StatusValue.php:76
AssembleUploadChunksJob\__construct
__construct(Title $title, array $params)
Definition: AssembleUploadChunksJob.php:31
AssembleUploadChunksJob
Assemble the segments of a chunked upload.
Definition: AssembleUploadChunksJob.php:30
RequestContext\getMain
static getMain()
Static methods.
Definition: RequestContext.php:468
RequestContext\importScopedSession
static importScopedSession(array $params)
Import an client IP address, HTTP headers, user ID, and session ID.
Definition: RequestContext.php:540
Title
Represents a title within MediaWiki.
Definition: Title.php:39
UploadFromChunks
Implements uploading from chunks.
Definition: UploadFromChunks.php:30
array
the array() calling protocol came about after MediaWiki 1.4rc1.