OATHManage.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\Extension\OATHAuth\Special;
 
use MediaWiki\Extension\OATHAuth\HTMLForm\IManageForm;
use MediaWiki\Extension\OATHAuth\IModule;
use MediaWiki\Extension\OATHAuth\OATHAuth;
use MediaWiki\Extension\OATHAuth\OATHUser;
use MediaWiki\Extension\OATHAuth\OATHUserRepository;
use MediaWiki\MediaWikiServices;
use OOUI\ButtonWidget;
use OOUI\HorizontalLayout;
use Message;
use Html;
use OOUI\HtmlSnippet;
use OOUI\PanelLayout;
use SpecialPage;
use OOUI\LabelWidget;
use HTMLForm;
use ConfigException;
use MWException;
use PermissionsError;
use UserNotLoggedIn;
 
class OATHManage extends SpecialPage {
    const ACTION_ENABLE = 'enable';
    const ACTION_DISABLE = 'disable';
 
    protected $auth;
    protected $userRepo;
    protected $authUser;
    protected $action;
    protected $requestedModule;
 
    public function __construct() {
        parent::__construct( 'OATHManage', 'oathauth-enable' );
 
        $services = MediaWikiServices::getInstance();
        $this->auth = $services->getService( 'OATHAuth' );
        $this->userRepo = $services->getService( 'OATHUserRepository' );
        $this->authUser = $this->userRepo->findByUser( $this->getUser() );
    }
 
    public function execute( $subPage ) {
        $this->getOutput()->enableOOUI();
        $this->getOutput()->disallowUserJs();
        $this->setAction();
        $this->setModule();
 
        parent::execute( $subPage );
 
        if ( $this->requestedModule instanceof IModule ) {
            // Performing an action on a requested module
            $this->clearPage();
            if ( $this->shouldShowDisableWarning() ) {
                return $this->showDisableWarning();
            }
            return $this->addModuleHTML( $this->requestedModule );
        }
 
        $this->addGeneralHelp();
        if ( $this->hasEnabled() ) {
            $this->addEnabledHTML();
            if ( $this->hasAlternativeModules() ) {
                $this->addAlternativesHTML();
            }
            return;
        }
        $this->nothingEnabled();
    }
 
    public function checkPermissions() {
        $this->requireLogin();
 
        $canEnable = $this->getUser()->isAllowed( 'oathauth-enable' );
 
        if ( $this->action === static::ACTION_ENABLE && !$canEnable ) {
            $this->displayRestrictionError();
        }
 
        if ( !$this->hasEnabled() && !$canEnable ) {
            // No enabled module and cannot enable - nothing to do
            $this->displayRestrictionError();
        }
 
        if ( $this->action === static::ACTION_ENABLE && !$this->getRequest()->wasPosted() ) {
            // Trying to change the 2FA method (one is already enabled)
            $this->checkLoginSecurityLevel( 'oathauth-enable' );
        }
    }
 
    private function setAction() {
        $this->action = $this->getRequest()->getVal( 'action', '' );
    }
 
    private function setModule() {
        $moduleKey = $this->getRequest()->getVal( 'module', '' );
        $this->requestedModule = $this->auth->getModuleByKey( $moduleKey );
    }
 
    private function hasEnabled() {
        return $this->authUser->getModule() instanceof IModule;
    }
 
    private function getEnabled() {
        return $this->hasEnabled() ? $this->authUser->getModule() : null;
    }
 
    private function addEnabledHTML() {
        $this->addHeading( wfMessage( 'oathauth-ui-enabled-module' ) );
        $this->addModuleHTML( $this->getEnabled() );
    }
 
    private function addAlternativesHTML() {
        $this->addHeading( wfMessage( 'oathauth-ui-not-enabled-modules' ) );
        $this->addInactiveHTML();
    }
 
    private function nothingEnabled() {
        $this->addHeading( wfMessage( 'oathauth-ui-available-modules' ) );
        $this->addInactiveHTML();
    }
 
    private function addInactiveHTML() {
        foreach ( $this->auth->getAllModules() as $key => $module ) {
            if ( $this->isModuleEnabled( $module ) ) {
                continue;
            }
            $this->addModuleHTML( $module );
        }
    }
 
    private function addGeneralHelp() {
        $this->getOutput()->addHTML( wfMessage(
            'oathauth-ui-general-help'
        )->parseAsBlock() );
    }
 
    private function addModuleHTML( IModule $module ) {
        if ( $this->isModuleRequested( $module ) ) {
            return $this->addCustomContent( $module );
        }
 
        $panel = $this->getGenericContent( $module );
        if ( $this->isModuleEnabled( $module ) ) {
            $this->addCustomContent( $module, $panel );
        }
 
        return $this->getOutput()->addHTML( (string)$panel );
    }
 
    private function getGenericContent( IModule $module ) {
        $modulePanel = new PanelLayout( [
            'framed' => true,
            'expanded' => false,
            'padded' => true
        ] );
        $headerLayout = new HorizontalLayout();
 
        $label = new LabelWidget( [
            'label' => $module->getDisplayName()->text()
        ] );
        if ( $this->shouldShowGenericButtons() ) {
            $button = new ButtonWidget( [
                'label' => $this->isModuleEnabled( $module ) ?
                    wfMessage( 'oathauth-disable-generic' )->text() :
                    wfMessage( 'oathauth-enable-generic' )->text(),
                'href' => $this->getOutput()->getTitle()->getLocalURL( [
                    'action' => $this->isModuleEnabled( $module ) ?
                        static::ACTION_DISABLE : static::ACTION_ENABLE,
                    'module' => $module->getName(),
                    'warn' => 1
                ] )
            ] );
            $headerLayout->addItems( [ $button ] );
        }
        $headerLayout->addItems( [ $label ] );
 
        $modulePanel->appendContent( $headerLayout );
        $modulePanel->appendContent( new HtmlSnippet(
            $module->getDescriptionMessage()->parseAsBlock()
        ) );
        return $modulePanel;
    }
 
    private function addCustomContent( IModule $module, $panel = null ) {
        $form = $module->getManageForm( $this->action, $this->authUser, $this->userRepo );
        if ( $form === null || !$this->isValidFormType( $form ) ) {
            return;
        }
        $form->setTitle( $this->getOutput()->getTitle() );
        $this->ensureRequiredFormFields( $form, $module );
        $form->setSubmitCallback( [ $form, 'onSubmit' ] );
        if ( $form->show( $panel ) ) {
            $form->onSuccess();
        }
    }
 
    private function addHeading( Message $message ) {
        $this->getOutput()->addHTML( Html::element( 'h2', [], $message->text() ) );
    }
 
    private function shouldShowGenericButtons() {
        if ( !$this->requestedModule instanceof IModule ) {
            return true;
        }
        if ( !$this->isGenericAction() ) {
            return true;
        }
        return false;
    }
 
    private function isModuleRequested( IModule $module ) {
        if ( $this->requestedModule instanceof IModule ) {
            if ( $this->requestedModule->getName() === $module->getName() ) {
                return true;
            }
        }
        return false;
    }
 
    private function isModuleEnabled( IModule $module ) {
        if ( $this->getEnabled() instanceof IModule ) {
            return $this->getEnabled()->getName() === $module->getName();
        }
        return false;
    }
 
    private function isValidFormType( $form ) {
        if ( !( $form instanceof HTMLForm ) ) {
            return false;
        }
        $implements = class_implements( $form );
        if ( !isset( $implements[IManageForm::class] ) ) {
            return false;
        }
 
        return true;
    }
 
    private function ensureRequiredFormFields( IManageForm &$form, IModule $module ) {
        if ( !$form->hasField( 'module' ) ) {
            $form->addHiddenField( 'module', $module->getName() );
        }
        if ( !$form->hasField( 'action' ) ) {
            $form->addHiddenField( 'action', $this->action );
        }
    }
 
    private function clearPage() {
        if ( $this->isGenericAction() ) {
            $displayName = $this->requestedModule->getDisplayName();
            $pageTitle = $this->isModuleEnabled( $this->requestedModule ) ?
                wfMessage( 'oathauth-disable-page-title', $displayName )->text() :
                wfMessage( 'oathauth-enable-page-title', $displayName )->text();
            $this->getOutput()->setPageTitle( $pageTitle );
        }
 
        $this->getOutput()->clearHTML();
        $this->getOutput()->addBacklinkSubtitle( $this->getOutput()->getTitle() );
    }
 
    private function isGenericAction() {
        return in_array( $this->action, [ static::ACTION_ENABLE, static::ACTION_DISABLE ] );
    }
 
    private function hasAlternativeModules() {
        foreach ( $this->auth->getAllModules() as $key => $module ) {
            if ( !$this->isModuleEnabled( $module ) ) {
                return true;
            }
        }
        return false;
    }
 
    private function shouldShowDisableWarning() {
        return (bool)$this->getRequest()->getVal( 'warn', false ) &&
            $this->requestedModule instanceof IModule &&
            $this->getEnabled() instanceof IModule;
    }
 
    private function showDisableWarning() {
        $panel = new PanelLayout( [
            'padded' => true,
            'framed' => true,
            'expanded' => false
        ] );
        $headerMessage = $this->isSwitch() ?
            wfMessage( 'oathauth-switch-method-warning-header' ) :
            wfMessage( 'oathauth-disable-method-warning-header' );
        $genericMessage = $this->isSwitch() ?
            wfMessage(
                'oathauth-switch-method-warning',
                $this->getEnabled()->getDisplayName(),
                $this->requestedModule->getDisplayName()
            ) :
            wfMessage( 'oathauth-disable-method-warning', $this->getEnabled()->getDisplayName() );
 
        $panel->appendContent( new HtmlSnippet(
            $genericMessage->parseAsBlock()
        ) );
 
        $customMessage = $this->getEnabled()->getDisableWarningMessage();
        if ( $customMessage instanceof Message ) {
            $panel->appendContent( new HtmlSnippet(
                $customMessage->parseAsBlock()
            ) );
        }
 
        $button = new ButtonWidget( [
            'label' => wfMessage( 'oathauth-disable-method-warning-button-label' )->plain(),
            'href' => $this->getOutput()->getTitle()->getLocalURL( [
                'action' => $this->action,
                'module' => $this->requestedModule->getName()
            ] ),
            'flags' => [ 'primary', 'progressive' ]
        ] );
        $panel->appendContent( $button );
 
        $this->getOutput()->setPageTitle( $headerMessage );
        $this->getOutput()->addHTML( $panel->toString() );
    }
 
    private function isSwitch() {
        return $this->requestedModule instanceof IModule &&
            $this->action === static::ACTION_ENABLE &&
            $this->getEnabled() instanceof IModule;
    }
 
}