MediaWiki  master
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 }
requireAtLeastOneParameter( $params,... $required)
Die if none of a certain set of parameters is set and not false.
Definition: ApiBase.php:953
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking, formatting, etc.
getResult()
Get the result object.
Definition: ApiBase.php:640
wfParseUrl( $url)
parse_url() work-alike, but non-broken.
__construct(ApiMain $main, $action)
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition: ApiBase.php:2006
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user...
Definition: ApiBase.php:761
static makeMessage( $msg, IContextSource $context, array $params=null)
Create a Message from a string or array.
Definition: ApiBase.php:1792
getModulePath()
Get the path to this module.
Definition: ApiBase.php:584
getContext()
Get the base IContextSource object.
This is the main API class, used for both external and internal processing.
Definition: ApiMain.php:42
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:520
static getStandardParams( $action,... $wantedParams)
Fetch the standard parameters this helper recognizes.
encodeParamName( $paramName)
This method mangles parameter name based on the prefix supplied to the constructor.
Definition: ApiBase.php:739
getModulePrefix()
Get parameter prefix (usually two letters or an empty string).
Definition: ApiBase.php:528
Link an account with AuthManager.
This abstract class implements many basic API functions, and is the base of all API classes...
Definition: ApiBase.php:42
Helper class for AuthManager-using API modules.