mediawiki-extensions-DiscussionTools/includes/Actions/UnsubscribeAction.php

<?php

namespace MediaWiki\Extension\DiscussionTools\Actions;

use ErrorPageError;
use FormAction;
use Html;
use HTMLForm;
use IContextSource;
use MediaWiki\Extension\DiscussionTools\SubscriptionItem;
use MediaWiki\Extension\DiscussionTools\SubscriptionStore;
use Page;
use Title;
use User;
use UserNotLoggedIn;

class UnsubscribeAction extends FormAction {

	/** @var SubscriptionStore */
	protected $subscriptionStore;

	/** @var Subscriptionitem */
	protected $subscriptionItem = null;

	/**
	 * @param Page $page
	 * @param IContextSource $context
	 * @param SubscriptionStore $subscriptionStore
	 */
	public function __construct(
		Page $page,
		IContextSource $context,
		SubscriptionStore $subscriptionStore
	) {
		parent::__construct( $page, $context );
		$this->subscriptionStore = $subscriptionStore;
	}

	/**
	 * @inheritDoc
	 */
	protected function getPageTitle() {
		if ( $this->subscriptionItem ) {
			$title = Title::newFromLinkTarget( $this->subscriptionItem->getLinkTarget() );
			return htmlspecialchars( $title->getPrefixedText() ) .
				$this->msg( 'pipe-separator' )->escaped() .
				htmlspecialchars( $title->getFragment() );
		} else {
			return parent::getPageTitle();
		}
	}

	/**
	 * @inheritDoc
	 */
	public function show() {
		$commentName = $this->getRequest()->getVal( 'commentname' );

		if ( $commentName ) {
			$subscriptionItems = $this->subscriptionStore->getSubscriptionItemsForUser(
				$this->getUser(),
				[ $commentName ]
				// We could check the user is still subscribed, but then we'd need more error messages
			);

			if ( count( $subscriptionItems ) > 0 ) {
				$this->subscriptionItem = $subscriptionItems[ 0 ];
			}
		}

		parent::show();
	}

	/**
	 * @inheritDoc
	 */
	public function getName() {
		return 'dtunsubscribe';
	}

	/**
	 * @inheritDoc
	 */
	public function requiresUnblock() {
		return false;
	}

	/**
	 * @inheritDoc
	 */
	protected function getDescription() {
		return '';
	}

	/**
	 * @inheritDoc
	 */
	protected function getFormFields() {
		if ( $this->subscriptionItem ) {
			return [
				'commentname' => [
					'name' => 'commentname',
					'type' => 'hidden',
					'default' => $this->getRequest()->getVal( 'commentname' ),
				],
				'intro' => [
					'type' => 'info',
					'raw' => true,
					'default' => $this->msg( 'discussiontools-topicsubscription-action-unsubscribe-prompt' )->parse(),
				],
			];
		} else {
			return [];
		}
	}

	/**
	 * @inheritDoc
	 */
	protected function alterForm( HTMLForm $form ) {
		$form->setSubmitTextMsg( 'discussiontools-topicsubscription-action-unsubscribe-button' );
	}

	/**
	 * @inheritDoc
	 */
	public function onSubmit( $data ) {
		$commentName = $this->getRequest()->getVal( 'commentname' );

		return $this->subscriptionStore->removeSubscriptionForUser(
			$this->getUser(),
			$commentName
		);
	}

	/**
	 * @inheritDoc
	 */
	public function onSuccess() {
		$this->getOutput()->addHTML(
			Html::element(
				'p',
				[],
				$this->msg( 'discussiontools-topicsubscription-notify-unsubscribed-body' )->text()
			)
		);
	}

	/**
	 * @inheritDoc
	 */
	protected function usesOOUI() {
		return true;
	}

	/**
	 * @inheritDoc
	 */
	protected function checkCanExecute( User $user ) {
		// Must be logged in
		if ( $user->isAnon() ) {
			throw new UserNotLoggedIn();
		}

		if ( !$this->subscriptionItem ) {
			throw new ErrorPageError(
				'discussiontools-topicsubscription-error-not-found-title',
				'discussiontools-topicsubscription-error-not-found-body'
			);
		}

		parent::checkCanExecute( $user );
	}
}