MediaWiki  REL1_31
ApiLinkAccount.php
Go to the documentation of this file.
1 <?php
25 
31 class ApiLinkAccount extends ApiBase {
32 
33  public function __construct( ApiMain $main, $action ) {
34  parent::__construct( $main, $action, 'link' );
35  }
36 
37  public function getFinalDescription() {
38  // A bit of a hack to append 'api-help-authmanager-general-usage'
39  $msgs = parent::getFinalDescription();
40  $msgs[] = ApiBase::makeMessage( 'api-help-authmanager-general-usage', $this->getContext(), [
41  $this->getModulePrefix(),
42  $this->getModuleName(),
43  $this->getModulePath(),
44  AuthManager::ACTION_LINK,
45  self::needsToken(),
46  ] );
47  return $msgs;
48  }
49 
50  public function execute() {
51  if ( !$this->getUser()->isLoggedIn() ) {
52  $this->dieWithError( 'apierror-mustbeloggedin-linkaccounts', 'notloggedin' );
53  }
54 
55  $params = $this->extractRequestParams();
56 
57  $this->requireAtLeastOneParameter( $params, 'continue', 'returnurl' );
58 
59  if ( $params['returnurl'] !== null ) {
60  $bits = wfParseUrl( $params['returnurl'] );
61  if ( !$bits || $bits['scheme'] === '' ) {
62  $encParamName = $this->encodeParamName( 'returnurl' );
63  $this->dieWithError(
64  [ 'apierror-badurl', $encParamName, wfEscapeWikiText( $params['returnurl'] ) ],
65  "badurl_{$encParamName}"
66  );
67  }
68  }
69 
70  $helper = new ApiAuthManagerHelper( $this );
71  $manager = AuthManager::singleton();
72 
73  // Check security-sensitive operation status
74  $helper->securitySensitiveOperation( 'LinkAccounts' );
75 
76  // Make sure it's possible to link accounts
77  if ( !$manager->canLinkAccounts() ) {
78  $this->getResult()->addValue( null, 'linkaccount', $helper->formatAuthenticationResponse(
79  AuthenticationResponse::newFail( $this->msg( 'userlogin-cannot-' . AuthManager::ACTION_LINK ) )
80  ) );
81  return;
82  }
83 
84  // Perform the link step
85  if ( $params['continue'] ) {
86  $reqs = $helper->loadAuthenticationRequests( AuthManager::ACTION_LINK_CONTINUE );
87  $res = $manager->continueAccountLink( $reqs );
88  } else {
89  $reqs = $helper->loadAuthenticationRequests( AuthManager::ACTION_LINK );
90  $res = $manager->beginAccountLink( $this->getUser(), $reqs, $params['returnurl'] );
91  }
92 
93  $this->getResult()->addValue( null, 'linkaccount',
94  $helper->formatAuthenticationResponse( $res ) );
95  }
96 
97  public function isReadMode() {
98  return false;
99  }
100 
101  public function isWriteMode() {
102  return true;
103  }
104 
105  public function needsToken() {
106  return 'csrf';
107  }
108 
109  public function getAllowedParams() {
110  return ApiAuthManagerHelper::getStandardParams( AuthManager::ACTION_LINK,
111  'requests', 'messageformat', 'mergerequestfields', 'returnurl', 'continue'
112  );
113  }
114 
115  public function dynamicParameterDocumentation() {
116  return [ 'api-help-authmanagerhelper-additional-params', AuthManager::ACTION_LINK ];
117  }
118 
119  protected function getExamplesMessages() {
120  return [
121  'action=linkaccount&provider=Example&linkreturnurl=http://example.org/&linktoken=123ABC'
122  => 'apihelp-linkaccount-example-link',
123  ];
124  }
125 
126  public function getHelpUrls() {
127  return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Linkaccount';
128  }
129 }
ApiLinkAccount\isReadMode
isReadMode()
Indicates whether this module requires read rights.
Definition: ApiLinkAccount.php:97
ApiMain
This is the main API class, used for both external and internal processing.
Definition: ApiMain.php:43
ApiLinkAccount\__construct
__construct(ApiMain $main, $action)
Definition: ApiLinkAccount.php:33
ContextSource\getContext
getContext()
Get the base IContextSource object.
Definition: ContextSource.php:40
ApiLinkAccount\getExamplesMessages
getExamplesMessages()
Returns usage examples for this module.
Definition: ApiLinkAccount.php:119
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
ApiLinkAccount\needsToken
needsToken()
Returns the token type this module requires in order to execute.
Definition: ApiLinkAccount.php:105
ApiBase\dieWithError
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition: ApiBase.php:1895
ApiLinkAccount\getHelpUrls
getHelpUrls()
Return links to more detailed help pages about the module.
Definition: ApiLinkAccount.php:126
ApiBase\getResult
getResult()
Get the result object.
Definition: ApiBase.php:641
$params
$params
Definition: styleTest.css.php:40
ApiBase\makeMessage
static makeMessage( $msg, IContextSource $context, array $params=null)
Create a Message from a string or array.
Definition: ApiBase.php:1741
$res
$res
Definition: database.txt:21
ApiLinkAccount
Link an account with AuthManager.
Definition: ApiLinkAccount.php:31
ContextSource\getUser
getUser()
Definition: ContextSource.php:120
ApiAuthManagerHelper\getStandardParams
static getStandardParams( $action, $param)
Fetch the standard parameters this helper recognizes.
Definition: ApiAuthManagerHelper.php:351
php
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:37
ApiBase
This abstract class implements many basic API functions, and is the base of all API classes.
Definition: ApiBase.php:37
wfParseUrl
wfParseUrl( $url)
parse_url() work-alike, but non-broken.
Definition: GlobalFunctions.php:801
ApiBase\getModulePath
getModulePath()
Get the path to this module.
Definition: ApiBase.php:585
MediaWiki\Auth\AuthenticationResponse
This is a value object to hold authentication response data.
Definition: AuthenticationResponse.php:37
ApiAuthManagerHelper
Helper class for AuthManager-using API modules.
Definition: ApiAuthManagerHelper.php:36
ApiLinkAccount\dynamicParameterDocumentation
dynamicParameterDocumentation()
Indicate if the module supports dynamically-determined parameters that cannot be included in self::ge...
Definition: ApiLinkAccount.php:115
ApiBase\getModulePrefix
getModulePrefix()
Get parameter prefix (usually two letters or an empty string).
Definition: ApiBase.php:529
ApiBase\extractRequestParams
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition: ApiBase.php:749
ApiBase\encodeParamName
encodeParamName( $paramName)
This method mangles parameter name based on the prefix supplied to the constructor.
Definition: ApiBase.php:730
ApiLinkAccount\getFinalDescription
getFinalDescription()
Get final module description, after hooks have had a chance to tweak it as needed.
Definition: ApiLinkAccount.php:37
wfEscapeWikiText
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking,...
Definition: GlobalFunctions.php:1643
MediaWiki\Auth\AuthManager
This serves as the entry point to the authentication system.
Definition: AuthManager.php:83
ApiBase\requireAtLeastOneParameter
requireAtLeastOneParameter( $params, $required)
Die if none of a certain set of parameters is set and not false.
Definition: ApiBase.php:851
ApiLinkAccount\execute
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
Definition: ApiLinkAccount.php:50
ApiLinkAccount\isWriteMode
isWriteMode()
Indicates whether this module requires write mode.
Definition: ApiLinkAccount.php:101
ApiBase\getModuleName
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:521
ApiLinkAccount\getAllowedParams
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
Definition: ApiLinkAccount.php:109