mediawiki-extensions-Thanks/includes/SpecialThanks.php
libraryupgrader cb63494eed build: Updating mediawiki/mediawiki-codesniffer to 33.0.0
Additional changes:
* Dropped .inc files from .phpcs.xml (T200956).

Change-Id: Ie0082065db3abe1f740a0b983ece371ea2d3cfd0
2020-11-04 14:30:29 +00:00

198 lines
4.4 KiB
PHP

<?php
class SpecialThanks extends FormSpecialPage {
/**
* API result
* @var array
*/
protected $result;
/**
* 'rev' for revision, 'log' for log entry, or 'flow' for Flow comment,
* null if no ID is specified
* @var string|null
*/
protected $type;
/**
* Revision or Log ID ('0' = invalid) or Flow UUID
* @var string
*/
protected $id;
public function __construct() {
parent::__construct( 'Thanks' );
}
public function doesWrites() {
return true;
}
/**
* Set the type and ID or UUID of the request.
* @param string $par The subpage name.
*/
protected function setParameter( $par ) {
if ( $par === null || $par === '' ) {
$this->type = null;
return;
}
$tokens = explode( '/', $par );
if ( $tokens[0] === 'Flow' ) {
if ( count( $tokens ) === 1 || $tokens[1] === '' ) {
$this->type = null;
} else {
$this->type = 'flow';
$this->id = $tokens[1];
}
} elseif ( strtolower( $tokens[0] ) === 'log' ) {
$this->type = 'log';
// Make sure there's a numeric ID specified as the subpage.
if ( count( $tokens ) === 1 || $tokens[1] === '' || !( ctype_digit( $tokens[1] ) ) ) {
$this->id = '0';
} else {
$this->id = $tokens[1];
}
} else {
$this->type = 'rev';
if ( !( ctype_digit( $par ) ) ) { // Revision ID is not an integer.
$this->id = '0';
} else {
$this->id = $par;
}
}
}
/**
* HTMLForm fields
* @return string[][]
*/
protected function getFormFields() {
return [
'id' => [
'id' => 'mw-thanks-form-id',
'name' => 'id',
'type' => 'hidden',
'default' => $this->id,
],
'type' => [
'id' => 'mw-thanks-form-type',
'name' => 'type',
'type' => 'hidden',
'default' => $this->type,
],
];
}
/**
* Return the confirmation or error message.
* @return string
*/
protected function preText() {
if ( $this->type === null ) {
$msgKey = 'thanks-error-no-id-specified';
} elseif ( $this->type === 'rev' && $this->id === '0' ) {
$msgKey = 'thanks-error-invalidrevision';
} elseif ( $this->type === 'log' && $this->id === '0' ) {
$msgKey = 'thanks-error-invalid-log-id';
} elseif ( $this->type === 'flow' ) {
$msgKey = 'flow-thanks-confirmation-special';
} else {
$msgKey = 'thanks-confirmation-special-' . $this->type;
}
return '<p>' . $this->msg( $msgKey )->escaped() . '</p>';
}
/**
* Format the submission form.
* @param HTMLForm $form The form object to modify.
*/
protected function alterForm( HTMLForm $form ) {
if ( $this->type === null
|| ( in_array( $this->type, [ 'rev', 'log', ] ) && $this->id === '0' )
) {
$form->suppressDefaultSubmit( true );
} else {
$form->setSubmitText( $this->msg( 'thanks-submit' )->escaped() );
}
}
/**
* @return string
*/
protected function getDisplayFormat() {
return 'ooui';
}
/**
* Call the API internally.
* @param string[] $data The form data.
* @return Status
*/
public function onSubmit( array $data ) {
if ( !isset( $data['id'] ) ) {
return Status::newFatal( 'thanks-error-invalidrevision' );
}
if ( in_array( $this->type, [ 'rev', 'log' ] ) ) {
$requestData = [
'action' => 'thank',
$this->type => (int)$data['id'],
'source' => 'specialpage',
'token' => $this->getUser()->getEditToken(),
];
} else {
$requestData = [
'action' => 'flowthank',
'postid' => $data['id'],
'token' => $this->getUser()->getEditToken(),
];
}
$request = new DerivativeRequest(
$this->getRequest(),
$requestData,
true // posted
);
$api = new ApiMain(
$request,
true // enable write mode
);
try {
$api->execute();
} catch ( ApiUsageException $e ) {
return Status::wrap( $e->getStatusValue() );
}
$this->result = $api->getResult()->getResultData( [ 'result' ] );
return Status::newGood();
}
/**
* Display a message to the user.
*/
public function onSuccess() {
$sender = $this->getUser();
$recipient = User::newFromName( $this->result['recipient'] );
$link = Linker::userLink( $recipient->getId(), $recipient->getName() );
if ( in_array( $this->type, [ 'rev', 'log' ] ) ) {
$msgKey = 'thanks-thanked-notice';
} else {
$msgKey = 'flow-thanks-thanked-notice';
}
$msg = $this->msg( $msgKey )
->rawParams( $link )
->params( $recipient->getName(), $sender->getName() );
$this->getOutput()->addHTML( $msg->parse() );
}
public function isListed() {
return false;
}
}