PublishStashedFileJob.php

Go to the documentation of this file.

<?php
namespace MediaWiki\JobQueue\Jobs;
 
use MediaWiki\JobQueue\GenericParameterJob;
use MediaWiki\JobQueue\Job;
use MediaWiki\Status\Status;
use UploadBase;
use UploadFromStash;
 
class PublishStashedFileJob extends Job implements GenericParameterJob {
    use UploadJobTrait;
 
    public function __construct( array $params ) {
        parent::__construct( 'PublishStashedFile', $params );
        $this->removeDuplicates = true;
        $this->initialiseUploadJob( $this->params['filekey'] );
    }
 
    public function getDeduplicationInfo() {
        $info = parent::getDeduplicationInfo();
        if ( is_array( $info['params'] ) ) {
            $info['params'] = [ 'filekey' => $info['params']['filekey'] ];
        }
 
        return $info;
    }
 
    public function logJobParams( $status ): array {
        return [
            'stage' => $status['stage'] ?? '-',
            'result' => $status['result'] ?? '-',
            'status' => (string)( $status['status'] ?? '-' ),
            'filekey' => $this->params['filekey'],
            'filename' => $this->params['filename'],
            'user' => $this->user->getName(),
        ];
    }
 
    protected function getUpload(): UploadBase {
        if ( $this->upload === null ) {
            $this->upload = new UploadFromStash( $this->user );
            // @todo initialize() causes a GET, ideally we could frontload the antivirus
            // checks and anything else to the stash stage (which includes concatenation and
            // the local file is thus already there). That way, instead of GET+PUT, there could
            // just be a COPY operation from the stash to the public zone.
            $this->upload->initialize( $this->params['filekey'], $this->params['filename'] );
        }
        return $this->upload;
    }
}
 
class_alias( PublishStashedFileJob::class, 'PublishStashedFileJob' );