MediaWiki  master
PublishStashedFileJob.php
Go to the documentation of this file.
1 <?php
23 use Wikimedia\ScopedCallback;
24 
31 class PublishStashedFileJob extends Job {
32  public function __construct( Title $title, array $params ) {
33  parent::__construct( 'PublishStashedFile', $title, $params );
34  $this->removeDuplicates = true;
35  }
36 
37  public function run() {
38  $scope = RequestContext::importScopedSession( $this->params['session'] );
39  $this->addTeardownCallback( static function () use ( &$scope ) {
40  ScopedCallback::consume( $scope ); // T126450
41  } );
42 
43  $context = RequestContext::getMain();
44  $user = $context->getUser();
45  try {
46  if ( !$user->isRegistered() ) {
47  $this->setLastError( "Could not load the author user from session." );
48 
49  return false;
50  }
51 
53  $user,
54  $this->params['filekey'],
55  [ 'result' => 'Poll', 'stage' => 'publish', 'status' => Status::newGood() ]
56  );
57 
58  $upload = new UploadFromStash( $user );
59  // @todo initialize() causes a GET, ideally we could frontload the antivirus
60  // checks and anything else to the stash stage (which includes concatenation and
61  // the local file is thus already there). That way, instead of GET+PUT, there could
62  // just be a COPY operation from the stash to the public zone.
63  $upload->initialize( $this->params['filekey'], $this->params['filename'] );
64 
65  // Check if the local file checks out (this is generally a no-op)
66  $verification = $upload->verifyUpload();
67  if ( $verification['status'] !== UploadBase::OK ) {
68  $status = Status::newFatal( 'verification-error' );
69  $status->value = [ 'verification' => $verification ];
71  $user,
72  $this->params['filekey'],
73  [ 'result' => 'Failure', 'stage' => 'publish', 'status' => $status ]
74  );
75  $this->setLastError( "Could not verify upload." );
76 
77  return false;
78  }
79 
80  // Upload the stashed file to a permanent location
81  $status = $upload->performUpload(
82  $this->params['comment'],
83  $this->params['text'],
84  $this->params['watch'],
85  $user,
86  $this->params['tags'] ?? [],
87  $this->params['watchlistexpiry'] ?? null
88  );
89  if ( !$status->isGood() ) {
91  $user,
92  $this->params['filekey'],
93  [ 'result' => 'Failure', 'stage' => 'publish', 'status' => $status ]
94  );
95  $this->setLastError( $status->getWikiText( false, false, 'en' ) );
96 
97  return false;
98  }
99 
100  // Build the image info array while we have the local reference handy
101  $apiMain = new ApiMain(); // dummy object (XXX)
102  $imageInfo = $upload->getImageInfo( $apiMain->getResult() );
103 
104  // Cleanup any temporary local file
105  $upload->cleanupTempFile();
106 
107  // Cache the info so the user doesn't have to wait forever to get the final info
109  $user,
110  $this->params['filekey'],
111  [
112  'result' => 'Success',
113  'stage' => 'publish',
114  'filename' => $upload->getLocalFile()->getName(),
115  'imageinfo' => $imageInfo,
116  'status' => Status::newGood()
117  ]
118  );
119  } catch ( Exception $e ) {
121  $user,
122  $this->params['filekey'],
123  [
124  'result' => 'Failure',
125  'stage' => 'publish',
126  'status' => Status::newFatal( 'api-error-publishfailed' )
127  ]
128  );
129  $this->setLastError( get_class( $e ) . ": " . $e->getMessage() );
130  // To prevent potential database referential integrity issues.
131  // See T34551.
133 
134  return false;
135  }
136 
137  return true;
138  }
139 
140  public function getDeduplicationInfo() {
141  $info = parent::getDeduplicationInfo();
142  if ( is_array( $info['params'] ) ) {
143  $info['params'] = [ 'filekey' => $info['params']['filekey'] ];
144  }
145 
146  return $info;
147  }
148 
149  public function allowRetries() {
150  return false;
151  }
152 }
This is the main API class, used for both external and internal processing.
Definition: ApiMain.php:64
Class to both describe a background job and handle jobs.
Definition: Job.php:40
Title $title
Definition: Job.php:51
setLastError( $error)
Definition: Job.php:432
addTeardownCallback( $callback)
Definition: Job.php:354
array $params
Array of job parameters.
Definition: Job.php:45
static rollbackPrimaryChangesAndLog(Throwable $e, $catcher=self::CAUGHT_BY_OTHER)
Roll back any open database transactions and log the stack trace of the throwable.
Generic operation result class Has warning/error list, boolean status and arbitrary value.
Definition: Status.php:58
Represents a title within MediaWiki.
Definition: Title.php:76
Upload a file from the upload stash into the local file repo.
allowRetries()
bool Whether this job can be retried on failure by job runners 1.21Stability: stableto override
getDeduplicationInfo()
Subclasses may need to override this to make duplication detection work.
__construct(Title $title, array $params)
static importScopedSession(array $params)
Import a client IP address, HTTP headers, user ID, and session ID.
static getMain()
Get the RequestContext object associated with the main request.
static setSessionStatus(UserIdentity $user, $statusKey, $value)
Set the current status of a chunked upload (used for polling).
Implements uploading from previously stored file.