MediaWiki  1.27.2
SpecialLinkAccounts.php
Go to the documentation of this file.
1 <?php
2 
6 
13  protected static $allowedActions = [
14  AuthManager::ACTION_LINK, AuthManager::ACTION_LINK_CONTINUE,
15  ];
16 
17  public function __construct() {
18  parent::__construct( 'LinkAccounts' );
19  }
20 
21  protected function getGroupName() {
22  return 'users';
23  }
24 
25  public function isListed() {
26  return AuthManager::singleton()->canLinkAccounts();
27  }
28 
29  protected function getRequestBlacklist() {
30  return $this->getConfig()->get( 'ChangeCredentialsBlacklist' );
31  }
32 
38  public function execute( $subPage ) {
39  $this->setHeaders();
40  $this->loadAuth( $subPage );
41 
42  if ( !$this->isActionAllowed( $this->authAction ) ) {
43  if ( $this->authAction === AuthManager::ACTION_LINK ) {
44  // looks like no linking provider is installed or willing to take this user
45  $titleMessage = wfMessage( 'cannotlink-no-provider-title' );
46  $errorMessage = wfMessage( 'cannotlink-no-provider' );
47  throw new ErrorPageError( $titleMessage, $errorMessage );
48  } else {
49  // user probably back-button-navigated into an auth session that no longer exists
50  // FIXME would be nice to show a message
51  $this->getOutput()->redirect( $this->getPageTitle()->getFullURL( '', false,
52  PROTO_HTTPS ) );
53  return;
54  }
55  }
56 
57  $this->outputHeader();
58 
59  $status = $this->trySubmit();
60 
61  if ( $status === false || !$status->isOK() ) {
62  $this->displayForm( $status );
63  return;
64  }
65 
66  $response = $status->getValue();
67 
68  switch ( $response->status ) {
69  case AuthenticationResponse::PASS:
70  $this->success();
71  break;
72  case AuthenticationResponse::FAIL:
73  $this->loadAuth( '', AuthManager::ACTION_LINK, true );
74  $this->displayForm( StatusValue::newFatal( $response->message ) );
75  break;
76  case AuthenticationResponse::REDIRECT:
77  $this->getOutput()->redirect( $response->redirectTarget );
78  break;
79  case AuthenticationResponse::UI:
80  $this->authAction = AuthManager::ACTION_LINK_CONTINUE;
81  $this->authRequests = $response->neededRequests;
82  $this->displayForm( StatusValue::newFatal( $response->message ) );
83  break;
84  default:
85  throw new LogicException( 'invalid AuthenticationResponse' );
86  }
87  }
88 
89  protected function getDefaultAction( $subPage ) {
90  return AuthManager::ACTION_LINK;
91  }
92 
98  protected function getAuthForm( array $requests, $action ) {
99  $form = parent::getAuthForm( $requests, $action );
100  $form->setSubmitTextMsg( 'linkaccounts-submit' );
101  return $form;
102  }
103 
107  protected function success() {
108  $this->loadAuth( '', AuthManager::ACTION_LINK, true );
109  $this->displayForm( StatusValue::newFatal( $this->msg( 'linkaccounts-success-text' ) ) );
110  }
111 }
success()
Show a success message.
the array() calling protocol came about after MediaWiki 1.4rc1.
A special page subclass for authentication-related special pages.
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
static newFatal($message)
Factory function for fatal errors.
Definition: StatusValue.php:63
msg()
Wrapper around wfMessage that sets the current context.
getOutput()
Get the OutputPage being used for this instance.
this hook is for auditing only $response
Definition: hooks.txt:762
displayForm($status)
Display the form.
outputHeader($summaryMessageKey= '')
Outputs a summary message on top of special pages Per default the message key is the canonical name o...
isActionAllowed($action)
Checks whether AuthManager is ready to perform the action.
const PROTO_HTTPS
Definition: Defines.php:262
An error page which can definitely be safely rendered using the OutputPage.
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock()-offset Set to overwrite offset parameter in $wgRequest set to ''to unsetoffset-wrap String Wrap the message in html(usually something like"&lt
setHeaders()
Sets headers - this should be called from the execute() method of all derived classes! ...
Allows to change the fields on the form that will be generated are created Can be used to omit specific feeds from being outputted You must not use this hook to add use OutputPage::addFeedLink() instead.&$feedLinks hooks can tweak the array to change how login etc forms should look $requests
Definition: hooks.txt:312
loadAuth($subPage, $authAction=null, $reset=false)
Load or initialize $authAction, $authRequests and $subPage.
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
getConfig()
Shortcut to get main config object.
getAuthForm(array $requests, $action)
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set $status
Definition: hooks.txt:1004
Links/unlinks external accounts to the current user.
string $subPage
Subpage of the special page.
getPageTitle($subpage=false)
Get a self-referential title object.
trySubmit()
Attempts to do an authentication step with the submitted data.