mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/DiscussionTools
synced 2024-09-24 10:58:20 +00:00
bcd92a5d33
For automatic topic subscriptions, I plan to introduce a third subscription state to indicate them. This patch includes minor tweaks I wanted to add while working on that: * Introduce constants instead of numbers * Remove a TODO that doesn't seem like a good idea any more * Remove a `"length": 1` on sub_state that did not do anything (but it might have been meant to indicate that it was supposed to be a boolean, which would be wrong) Bug: T284836 Change-Id: I6e6096968ad38510102287bccd349090b6ca4280
131 lines
3 KiB
PHP
131 lines
3 KiB
PHP
<?php
|
|
|
|
namespace MediaWiki\Extension\DiscussionTools;
|
|
|
|
use ApiBase;
|
|
use ApiMain;
|
|
use MediaWiki\MediaWikiServices;
|
|
use Title;
|
|
use User;
|
|
use Wikimedia\ParamValidator\ParamValidator;
|
|
|
|
class ApiDiscussionToolsSubscribe extends ApiBase {
|
|
|
|
/** @var SubscriptionStore */
|
|
protected $subscriptionStore;
|
|
|
|
/**
|
|
* @param ApiMain $main
|
|
* @param string $name
|
|
* @param SubscriptionStore $subscriptionStore
|
|
*/
|
|
public function __construct( ApiMain $main, $name, SubscriptionStore $subscriptionStore ) {
|
|
parent::__construct( $main, $name );
|
|
|
|
$this->subscriptionStore = $subscriptionStore;
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
public function execute() {
|
|
// This should probably use dependency injection, but the check is only temporary
|
|
$services = MediaWikiServices::getInstance();
|
|
$dtConfig = $services->getConfigFactory()->makeConfig( 'discussiontools' );
|
|
if ( !$dtConfig->get( 'DiscussionToolsEnableTopicSubscriptionBackend' ) ) {
|
|
$this->dieWithError( [ 'apierror-moduledisabled', $this->getModuleName() ] );
|
|
}
|
|
|
|
$user = $this->getUser();
|
|
if ( !$user || $user->isAnon() ) {
|
|
// TODO: More specific error message
|
|
$this->dieWithError(
|
|
'apierror-mustbeloggedin-generic', 'notloggedin'
|
|
);
|
|
}
|
|
'@phan-var User $user';
|
|
|
|
$params = $this->extractRequestParams();
|
|
$title = Title::newFromText( $params['page'] );
|
|
$result = null;
|
|
|
|
if ( !$title ) {
|
|
$this->dieWithError( [ 'apierror-invalidtitle', wfEscapeWikiText( $params['page'] ) ] );
|
|
return;
|
|
}
|
|
$commentName = $params['commentname'];
|
|
$subscribe = $params['subscribe'];
|
|
|
|
if ( $subscribe ) {
|
|
$success = $this->subscriptionStore->addSubscriptionForUser(
|
|
$user,
|
|
$title,
|
|
$commentName
|
|
);
|
|
if ( !$success ) {
|
|
$this->dieWithError( 'apierror-discussiontools-subscription-failed-add', 'subscription-failed' );
|
|
}
|
|
} else {
|
|
$success = $this->subscriptionStore->removeSubscriptionForUser(
|
|
$user,
|
|
$commentName
|
|
);
|
|
if ( !$success ) {
|
|
$this->dieWithError( 'apierror-discussiontools-subscription-failed-remove', 'subscription-failed' );
|
|
}
|
|
}
|
|
|
|
$result = [
|
|
'page' => $title,
|
|
'commentname' => $commentName,
|
|
'subscribe' => $subscribe,
|
|
];
|
|
|
|
$this->getResult()->addValue( null, $this->getModuleName(), $result );
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
public function getAllowedParams() {
|
|
return [
|
|
'page' => [
|
|
ParamValidator::PARAM_REQUIRED => true,
|
|
ApiBase::PARAM_HELP_MSG => 'apihelp-visualeditoredit-param-page',
|
|
],
|
|
'token' => [
|
|
ParamValidator::PARAM_REQUIRED => true,
|
|
],
|
|
'commentname' => [
|
|
ParamValidator::PARAM_REQUIRED => true,
|
|
ApiBase::PARAM_HELP_MSG => 'apihelp-discussiontoolsedit-param-commentname',
|
|
],
|
|
'subscribe' => [
|
|
ParamValidator::PARAM_TYPE => 'boolean',
|
|
ParamValidator::PARAM_REQUIRED => true,
|
|
],
|
|
];
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
public function needsToken() {
|
|
return 'csrf';
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
public function isInternal() {
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
public function isWriteMode() {
|
|
return true;
|
|
}
|
|
}
|