includes/specials/SpecialLinkAccounts.php

   1 <?php
   2
   3 namespace MediaWiki\Specials;
   4
   5 use ErrorPageError;
   6 use LogicException;
   7 use MediaWiki\Auth\AuthenticationRequest;
   8 use MediaWiki\Auth\AuthenticationResponse;
   9 use MediaWiki\Auth\AuthManager;
  10 use MediaWiki\HTMLForm\HTMLForm;
  11 use MediaWiki\MainConfigNames;
  12 use MediaWiki\SpecialPage\AuthManagerSpecialPage;
  13 use StatusValue;
  14
  15 /**
  16  * Link/unlink external accounts to the current user.
  17  *
  18  * To interact with this page, account providers need to register themselves with AuthManager.
  19  *
  20  * @ingroup SpecialPage
  21  * @ingroup Auth
  22  */
  23 class SpecialLinkAccounts extends AuthManagerSpecialPage {
  24         /** @inheritDoc */
  25         protected static $allowedActions = [
  26                 AuthManager::ACTION_LINK, AuthManager::ACTION_LINK_CONTINUE,
  27         ];
  28
  29         public function __construct( AuthManager $authManager ) {
  30                 parent::__construct( 'LinkAccounts' );
  31                 $this->setAuthManager( $authManager );
  32         }
  33
  34         protected function getGroupName() {
  35                 return 'login';
  36         }
  37
  38         public function isListed() {
  39                 return $this->getAuthManager()->canLinkAccounts();
  40         }
  41
  42         protected function getRequestBlacklist() {
  43                 return $this->getConfig()->get( MainConfigNames::ChangeCredentialsBlacklist );
  44         }
  45
  46         /**
  47          * @param null|string $subPage
  48          * @throws ErrorPageError
  49          */
  50         public function execute( $subPage ) {
  51                 $this->setHeaders();
  52                 $this->loadAuth( $subPage );
  53
  54                 if ( !$this->isActionAllowed( $this->authAction ) ) {
  55                         if ( $this->authAction === AuthManager::ACTION_LINK ) {
  56                                 // looks like no linking provider is installed or willing to take this user
  57                                 $titleMessage = $this->msg( 'cannotlink-no-provider-title' );
  58                                 $errorMessage = $this->msg( 'cannotlink-no-provider' );
  59                                 throw new ErrorPageError( $titleMessage, $errorMessage );
  60                         } else {
  61                                 // user probably back-button-navigated into an auth session that no longer exists
  62                                 // FIXME would be nice to show a message
  63                                 $this->getOutput()->redirect( $this->getPageTitle()->getFullURL( '', false,
  64                                         PROTO_HTTPS ) );
  65                                 return;
  66                         }
  67                 }
  68
  69                 $this->outputHeader();
  70
  71                 $status = $this->trySubmit();
  72
  73                 if ( $status === false || !$status->isOK() ) {
  74                         $this->displayForm( $status );
  75                         return;
  76                 }
  77
  78                 $response = $status->getValue();
  79
  80                 switch ( $response->status ) {
  81                         case AuthenticationResponse::PASS:
  82                                 $this->success();
  83                                 break;
  84                         case AuthenticationResponse::FAIL:
  85                                 $this->loadAuth( '', AuthManager::ACTION_LINK, true );
  86                                 $this->displayForm( StatusValue::newFatal( $response->message ) );
  87                                 break;
  88                         case AuthenticationResponse::REDIRECT:
  89                                 $this->getOutput()->redirect( $response->redirectTarget );
  90                                 break;
  91                         case AuthenticationResponse::UI:
  92                                 $this->authAction = AuthManager::ACTION_LINK_CONTINUE;
  93                                 $this->authRequests = $response->neededRequests;
  94                                 $this->displayForm( StatusValue::newFatal( $response->message ) );
  95                                 break;
  96                         default:
  97                                 throw new LogicException( 'invalid AuthenticationResponse' );
  98                 }
  99         }
 100
 101         protected function getDefaultAction( $subPage ) {
 102                 return AuthManager::ACTION_LINK;
 103         }
 104
 105         /**
 106          * @param AuthenticationRequest[] $requests
 107          * @param string $action AuthManager action name, should be ACTION_LINK or ACTION_LINK_CONTINUE
 108          * @return HTMLForm
 109          */
 110         protected function getAuthForm( array $requests, $action ) {
 111                 $form = parent::getAuthForm( $requests, $action );
 112                 $form->setSubmitTextMsg( 'linkaccounts-submit' );
 113                 return $form;
 114         }
 115
 116         /**
 117          * Show a success message.
 118          */
 119         protected function success() {
 120                 $this->loadAuth( '', AuthManager::ACTION_LINK, true );
 121                 $this->displayForm( StatusValue::newFatal( $this->msg( 'linkaccounts-success-text' ) ) );
 122         }
 123 }
 124
 125 /** @deprecated class alias since 1.41 */
 126 class_alias( SpecialLinkAccounts::class, 'SpecialLinkAccounts' );