includes/specials/SpecialChangeCredentials.php

   1 <?php
   2
   3 use MediaWiki\Auth\AuthenticationRequest;
   4 use MediaWiki\Auth\AuthenticationResponse;
   5 use MediaWiki\Auth\AuthManager;
   6 use MediaWiki\Session\SessionManager;
   7
   8 /**
   9  * Special change to change credentials (such as the password).
  10  *
  11  * Also does most of the work for SpecialRemoveCredentials.
  12  */
  13 class SpecialChangeCredentials extends AuthManagerSpecialPage {
  14         protected static $allowedActions = [ AuthManager::ACTION_CHANGE ];
  15
  16         protected static $messagePrefix = 'changecredentials';
  17
  18         /** Change action needs user data; remove action does not */
  19         protected static $loadUserData = true;
  20
  21         public function __construct( $name = 'ChangeCredentials' ) {
  22                 parent::__construct( $name, 'editmyprivateinfo' );
  23         }
  24
  25         protected function getGroupName() {
  26                 return 'users';
  27         }
  28
  29         public function isListed() {
  30                 $this->loadAuth( '' );
  31                 return (bool)$this->authRequests;
  32         }
  33
  34         public function doesWrites() {
  35                 return true;
  36         }
  37
  38         protected function getDefaultAction( $subPage ) {
  39                 return AuthManager::ACTION_CHANGE;
  40         }
  41
  42         protected function getPreservedParams( $withToken = false ) {
  43                 $request = $this->getRequest();
  44                 $params = parent::getPreservedParams( $withToken );
  45                 $params += [
  46                         'returnto' => $request->getVal( 'returnto' ),
  47                         'returntoquery' => $request->getVal( 'returntoquery' ),
  48                 ];
  49                 return $params;
  50         }
  51
  52         public function onAuthChangeFormFields(
  53                 array $requests, array $fieldInfo, array &$formDescriptor, $action
  54         ) {
  55                 // This method is never called for remove actions.
  56
  57                 $extraFields = [];
  58                 Hooks::run( 'ChangePasswordForm', [ &$extraFields ], '1.27' );
  59                 foreach ( $extraFields as $extra ) {
  60                         list( $name, $label, $type, $default ) = $extra;
  61                         $formDescriptor[$name] = [
  62                                 'type' => $type,
  63                                 'name' => $name,
  64                                 'label-message' => $label,
  65                                 'default' => $default,
  66                         ];
  67
  68                 }
  69
  70                 return parent::onAuthChangeFormFields( $requests, $fieldInfo, $formDescriptor, $action );
  71         }
  72
  73         public function execute( $subPage ) {
  74                 $this->setHeaders();
  75                 $this->outputHeader();
  76
  77                 $this->loadAuth( $subPage );
  78
  79                 if ( !$subPage ) {
  80                         $this->showSubpageList();
  81                         return;
  82                 }
  83
  84                 if ( !$this->authRequests ) {
  85                         // messages used: changecredentials-invalidsubpage, removecredentials-invalidsubpage
  86                         $this->showSubpageList( $this->msg( static::$messagePrefix . '-invalidsubpage', $subPage ) );
  87                         return;
  88                 }
  89
  90                 $this->getOutput()->addBacklinkSubtitle( $this->getPageTitle() );
  91
  92                 $status = $this->trySubmit();
  93
  94                 if ( $status === false || !$status->isOK() ) {
  95                         $this->displayForm( $status );
  96                         return;
  97                 }
  98
  99                 $response = $status->getValue();
 100
 101                 switch ( $response->status ) {
 102                         case AuthenticationResponse::PASS:
 103                                 $this->success();
 104                                 break;
 105                         case AuthenticationResponse::FAIL:
 106                                 $this->displayForm( Status::newFatal( $response->message ) );
 107                                 break;
 108                         default:
 109                                 throw new LogicException( 'invalid AuthenticationResponse' );
 110                 }
 111         }
 112
 113         protected function loadAuth( $subPage, $authAction = null, $reset = false ) {
 114                 parent::loadAuth( $subPage, $authAction );
 115                 if ( $subPage ) {
 116                         $this->authRequests = array_filter( $this->authRequests, function ( $req ) use ( $subPage ) {
 117                                 return $req->getUniqueId() === $subPage;
 118                         } );
 119                         if ( count( $this->authRequests ) > 1 ) {
 120                                 throw new LogicException( 'Multiple AuthenticationRequest objects with same ID!' );
 121                         }
 122                 }
 123         }
 124
 125         protected function getAuthFormDescriptor( $requests, $action ) {
 126                 if ( !static::$loadUserData ) {
 127                         return [];
 128                 } else {
 129                         return parent::getAuthFormDescriptor( $requests, $action );
 130                 }
 131         }
 132
 133         protected function getAuthForm( array $requests, $action ) {
 134                 $form = parent::getAuthForm( $requests, $action );
 135                 $req = reset( $requests );
 136                 $info = $req->describeCredentials();
 137
 138                 $form->addPreText(
 139                         Html::openElement( 'dl' )
 140                         . Html::element( 'dt', [], wfMessage( 'credentialsform-provider' )->text() )
 141                         . Html::element( 'dd', [], $info['provider'] )
 142                         . Html::element( 'dt', [], wfMessage( 'credentialsform-account' )->text() )
 143                         . Html::element( 'dd', [], $info['account'] )
 144                         . Html::closeElement( 'dl' )
 145                 );
 146
 147                 // messages used: changecredentials-submit removecredentials-submit
 148                 $form->setSubmitTextMsg( static::$messagePrefix . '-submit' );
 149                 $form->showCancel()->setCancelTarget( $this->getReturnUrl() ?: Title::newMainPage() );
 150
 151                 return $form;
 152         }
 153
 154         protected function needsSubmitButton( array $requests ) {
 155                 // Change/remove forms show are built from a single AuthenticationRequest and do not allow
 156                 // for redirect flow; they always need a submit button.
 157                 return true;
 158         }
 159
 160         public function handleFormSubmit( $data ) {
 161                 // remove requests do not accept user input
 162                 $requests = $this->authRequests;
 163                 if ( static::$loadUserData ) {
 164                         $requests = AuthenticationRequest::loadRequestsFromSubmission( $this->authRequests, $data );
 165                 }
 166
 167                 $response = $this->performAuthenticationStep( $this->authAction, $requests );
 168
 169                 // we can't handle FAIL or similar as failure here since it might require changing the form
 170                 return Status::newGood( $response );
 171         }
 172
 173         /**
 174          * @param Message|null $error
 175          */
 176         protected function showSubpageList( $error = null ) {
 177                 $out = $this->getOutput();
 178
 179                 if ( $error ) {
 180                         $out->addHTML( $error->parse() );
 181                 }
 182
 183                 $groupedRequests = [];
 184                 foreach ( $this->authRequests as $req ) {
 185                         $info = $req->describeCredentials();
 186                         $groupedRequests[(string)$info['provider']][] = $req;
 187                 }
 188
 189                 $linkRenderer = $this->getLinkRenderer();
 190                 $out->addHTML( Html::openElement( 'dl' ) );
 191                 foreach ( $groupedRequests as $group => $members ) {
 192                         $out->addHTML( Html::element( 'dt', [], $group ) );
 193                         foreach ( $members as $req ) {
 194                                 /** @var AuthenticationRequest $req */
 195                                 $info = $req->describeCredentials();
 196                                 $out->addHTML( Html::rawElement( 'dd', [],
 197                                         $linkRenderer->makeLink(
 198                                                 $this->getPageTitle( $req->getUniqueId() ),
 199                                                 $info['account']
 200                                         )
 201                                 ) );
 202                         }
 203                 }
 204                 $out->addHTML( Html::closeElement( 'dl' ) );
 205         }
 206
 207         protected function success() {
 208                 $session = $this->getRequest()->getSession();
 209                 $user = $this->getUser();
 210                 $out = $this->getOutput();
 211                 $returnUrl = $this->getReturnUrl();
 212
 213                 // change user token and update the session
 214                 SessionManager::singleton()->invalidateSessionsForUser( $user );
 215                 $session->setUser( $user );
 216                 $session->resetId();
 217
 218                 if ( $returnUrl ) {
 219                         $out->redirect( $returnUrl );
 220                 } else {
 221                         // messages used: changecredentials-success removecredentials-success
 222                         $out->wrapWikiMsg( "<div class=\"successbox\">\n$1\n</div>", static::$messagePrefix
 223                                 . '-success' );
 224                         $out->returnToMain();
 225                 }
 226         }
 227
 228         /**
 229          * @return string|null
 230          */
 231         protected function getReturnUrl() {
 232                 $request = $this->getRequest();
 233                 $returnTo = $request->getText( 'returnto' );
 234                 $returnToQuery = $request->getText( 'returntoquery', '' );
 235
 236                 if ( !$returnTo ) {
 237                         return null;
 238                 }
 239
 240                 $title = Title::newFromText( $returnTo );
 241                 return $title->getFullURL( $returnToQuery );
 242         }
 243
 244         protected function getRequestBlacklist() {
 245                 return $this->getConfig()->get( 'ChangeCredentialsBlacklist' );
 246         }
 247 }