MarkpatrolledAction.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Actions;
 
use MediaWiki\Context\IContextSource;
use MediaWiki\Exception\ErrorPageError;
use MediaWiki\Exception\PermissionsError;
use MediaWiki\HTMLForm\HTMLForm;
use MediaWiki\Linker\LinkRenderer;
use MediaWiki\Message\Message;
use MediaWiki\Page\Article;
use MediaWiki\RecentChanges\PatrolManager;
use MediaWiki\RecentChanges\RecentChange;
use MediaWiki\RecentChanges\RecentChangeLookup;
use MediaWiki\SpecialPage\SpecialPage;
use StatusValue;
 
class MarkpatrolledAction extends FormAction {
 
    public function __construct(
        Article $article,
        IContextSource $context,
        private readonly LinkRenderer $linkRenderer,
        private readonly PatrolManager $patrolManager,
        private readonly RecentChangeLookup $recentChangeLookup,
    ) {
        parent::__construct( $article, $context );
    }
 
    public function getName() {
        return 'markpatrolled';
    }
 
    protected function getDescription() {
        // Disable default header "subtitle"
        return '';
    }
 
    public function getRestriction() {
        return 'patrol';
    }
 
    protected function usesOOUI() {
        return true;
    }
 
    protected function getRecentChange( $data = null ) {
        $rc = null;
        // Note: This works both on initial GET url and after submitting the form
        $rcId = $data ? intval( $data['rcid'] ) : $this->getRequest()->getInt( 'rcid' );
        if ( $rcId ) {
            $rc = $this->recentChangeLookup->getRecentChangeById( $rcId );
        }
        if ( !$rc ) {
            throw new ErrorPageError( 'markedaspatrollederror', 'markedaspatrollederrortext' );
        }
        return $rc;
    }
 
    protected function preText() {
        $rc = $this->getRecentChange();
        $title = $rc->getTitle();
 
        // Based on logentry-patrol-patrol (see PatrolLogFormatter)
        $revId = $rc->getAttribute( 'rc_this_oldid' );
        $query = [
            'curid' => $rc->getAttribute( 'rc_cur_id' ),
            'diff' => $revId,
            'oldid' => $rc->getAttribute( 'rc_last_oldid' )
        ];
        $revlink = $this->linkRenderer->makeLink( $title, $revId, [], $query );
        $pagelink = $this->linkRenderer->makeLink( $title, $title->getPrefixedText() );
 
        return $this->msg( 'confirm-markpatrolled-top' )->params(
            $title->getPrefixedText(),
            // Provide pre-rendered link as parser would render [[:$1]] as bold non-link
            Message::rawParam( $pagelink ),
            Message::rawParam( $revlink )
        )->parse();
    }
 
    protected function alterForm( HTMLForm $form ) {
        $form->addHiddenField( 'rcid', $this->getRequest()->getInt( 'rcid' ) );
        $form->setTokenSalt( 'patrol' );
        $form->setSubmitTextMsg( 'confirm-markpatrolled-button' );
    }
 
    public function onSubmit( $data ) {
        $rc = $this->getRecentChange( $data );
        $status = $this->patrolManager->markPatrolled( $rc, $this->getAuthority() );
 
        if ( $status->hasMessage( 'rcpatroldisabled' ) ) {
            throw new ErrorPageError( 'rcpatroldisabled', 'rcpatroldisabledtext' );
        }
 
        // Guess where the user came from
        // TODO: Would be nice to see where the user actually came from
        if ( $rc->getAttribute( 'rc_source' ) === RecentChange::SRC_NEW ) {
            $returnTo = 'Newpages';
        } elseif ( $rc->getAttribute( 'rc_log_type' ) == 'upload' ) {
            $returnTo = 'Newfiles';
        } else {
            $returnTo = 'Recentchanges';
        }
        $return = SpecialPage::getTitleFor( $returnTo );
 
        if ( $status->hasMessage( 'markedaspatrollederror-noautopatrol' ) ) {
            $this->getOutput()->setPageTitleMsg( $this->msg( 'markedaspatrollederror' ) );
            $this->getOutput()->addWikiMsg( 'markedaspatrollederror-noautopatrol' );
            $this->getOutput()->returnToMain( null, $return );
            return true;
        }
 
        if ( !$status->isGood() ) {
            if ( !$status->hasMessage( 'hookaborted' ) ) {
                throw new PermissionsError( 'patrol', $status );
            }
            // The MarkPatrolled hook itself has handled any output
            return $status;
        }
 
        $this->getOutput()->setPageTitleMsg( $this->msg( 'markedaspatrolled' ) );
        $this->getOutput()->addWikiMsg( 'markedaspatrolledtext', $rc->getTitle()->getPrefixedText() );
        $this->getOutput()->returnToMain( null, $return );
        return true;
    }
 
    public function onSuccess() {
        // Required by parent class. Redundant as our onSubmit handles output already.
    }
 
    public function doesWrites() {
        return true;
    }
}
 
class_alias( MarkpatrolledAction::class, 'MarkpatrolledAction' );