MediaWiki  1.28.0
ConfirmLinkSecondaryAuthenticationProvider.php
Go to the documentation of this file.
1 <?php
2 
3 namespace MediaWiki\Auth;
4 
5 use User;
6 
19 
21  return [];
22  }
23 
24  public function beginSecondaryAuthentication( $user, array $reqs ) {
25  return $this->beginLinkAttempt( $user, 'AuthManager::authnState' );
26  }
27 
28  public function continueSecondaryAuthentication( $user, array $reqs ) {
29  return $this->continueLinkAttempt( $user, 'AuthManager::authnState', $reqs );
30  }
31 
32  public function beginSecondaryAccountCreation( $user, $creator, array $reqs ) {
33  return $this->beginLinkAttempt( $user, 'AuthManager::accountCreationState' );
34  }
35 
36  public function continueSecondaryAccountCreation( $user, $creator, array $reqs ) {
37  return $this->continueLinkAttempt( $user, 'AuthManager::accountCreationState', $reqs );
38  }
39 
46  protected function beginLinkAttempt( $user, $key ) {
47  $session = $this->manager->getRequest()->getSession();
48  $state = $session->getSecret( $key );
49  if ( !is_array( $state ) ) {
51  }
52 
53  $maybeLink = array_filter( $state['maybeLink'], function ( $req ) use ( $user ) {
54  if ( !$req->action ) {
55  $req->action = AuthManager::ACTION_CHANGE;
56  }
57  $req->username = $user->getName();
58  return $this->manager->allowsAuthenticationDataChange( $req )->isGood();
59  } );
60  if ( !$maybeLink ) {
62  }
63 
64  $req = new ConfirmLinkAuthenticationRequest( $maybeLink );
66  [ $req ],
67  wfMessage( 'authprovider-confirmlink-message' ),
68  'warning'
69  );
70  }
71 
79  protected function continueLinkAttempt( $user, $key, array $reqs ) {
81  if ( $req ) {
83  }
84 
86  if ( !$req ) {
87  // WTF? Retry.
88  return $this->beginLinkAttempt( $user, $key );
89  }
90 
91  $session = $this->manager->getRequest()->getSession();
92  $state = $session->getSecret( $key );
93  if ( !is_array( $state ) ) {
95  }
96 
97  $maybeLink = [];
98  foreach ( $state['maybeLink'] as $linkReq ) {
99  $maybeLink[$linkReq->getUniqueId()] = $linkReq;
100  }
101  if ( !$maybeLink ) {
103  }
104 
105  $state['maybeLink'] = [];
106  $session->setSecret( $key, $state );
107 
108  $statuses = [];
109  $anyFailed = false;
110  foreach ( $req->confirmedLinkIDs as $id ) {
111  if ( isset( $maybeLink[$id] ) ) {
112  $req = $maybeLink[$id];
113  $req->username = $user->getName();
114  if ( !$req->action ) {
115  // Make sure the action is set, but don't override it if
116  // the provider filled it in.
118  }
119  $status = $this->manager->allowsAuthenticationDataChange( $req );
120  $statuses[] = [ $req, $status ];
121  if ( $status->isGood() ) {
122  $this->manager->changeAuthenticationData( $req );
123  } else {
124  $anyFailed = true;
125  }
126  }
127  }
128  if ( !$anyFailed ) {
130  }
131 
132  $combinedStatus = \Status::newGood();
133  foreach ( $statuses as $data ) {
134  list( $req, $status ) = $data;
135  $descriptionInfo = $req->describeCredentials();
136  $description = wfMessage(
137  'authprovider-confirmlink-option',
138  $descriptionInfo['provider']->text(), $descriptionInfo['account']->text()
139  )->text();
140  if ( $status->isGood() ) {
141  $combinedStatus->error( wfMessage( 'authprovider-confirmlink-success-line', $description ) );
142  } else {
143  $combinedStatus->error( wfMessage(
144  'authprovider-confirmlink-failed-line', $description, $status->getMessage()->text()
145  ) );
146  }
147  }
149  [
151  'linkOk', wfMessage( 'ok' ), wfMessage( 'authprovider-confirmlink-ok-help' )
152  )
153  ],
154  $combinedStatus->getMessage( 'authprovider-confirmlink-failed' ),
155  'error'
156  );
157  }
158 }
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition: deferred.txt:11
static getRequestByName(array $reqs, $name)
Fetch a ButtonAuthenticationRequest or subclass by name.
the array() calling protocol came about after MediaWiki 1.4rc1.
continueSecondaryAccountCreation($user, $creator, array $reqs)
Continue an authentication flow.
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
getAuthenticationRequests($action, array $options)
Return the applicable list of AuthenticationRequests.
continueLinkAttempt($user, $key, array $reqs)
Continue the link attempt.
beginSecondaryAccountCreation($user, $creator, array $reqs)
Start an account creation flow.
either a unescaped string or a HtmlArmor object 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
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 and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context $options
Definition: hooks.txt:1046
continueSecondaryAuthentication($user, array $reqs)
Continue an authentication flow.
beginSecondaryAuthentication($user, array $reqs)
Start an authentication flow.
const ACTION_CHANGE
Change a user's credentials.
Definition: AuthManager.php:98
A base class that implements some of the boilerplate for a SecondaryAuthenticationProvider.
static newGood($value=null)
Factory function for good results.
Definition: StatusValue.php:76
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add text
Definition: design.txt:12
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account $user
Definition: hooks.txt:242
String $action
Cache what action this request is.
Definition: MediaWiki.php:43
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
this hook is for auditing only $req
Definition: hooks.txt:1007
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:52
static newUI(array $reqs, Message $msg, $msgtype= 'warning')
static getRequestByClass(array $reqs, $class, $allowSubclasses=false)
Select a request by class name.
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:1046
This is an authentication request that just implements a simple button.