Page MenuHomeWickedGov Phorge
Files F1427612

ApiLinkAccount.php
No OneTemporary
Actions

Size
4 KB
Referenced Files
None
Subscribers
None

ApiLinkAccount.php
View Options

<?php
/**
* Copyright © 2016 Wikimedia Foundation and contributors
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
namespace MediaWiki\Api;
use MediaWiki\Auth\AuthenticationResponse;
use MediaWiki\Auth\AuthManager;
use MediaWiki\Utils\UrlUtils;
/**
* Link an account with AuthManager
*
* @ingroup API
*/
class ApiLinkAccount extends ApiBase {
private AuthManager $authManager;
private UrlUtils $urlUtils;
public function __construct(
ApiMain $main,
string $action,
AuthManager $authManager,
UrlUtils $urlUtils
) {
parent::__construct( $main, $action, 'link' );
$this->authManager = $authManager;
$this->urlUtils = $urlUtils;
}
public function getFinalDescription() {
// A bit of a hack to append 'api-help-authmanager-general-usage'
$msgs = parent::getFinalDescription();
$msgs[] = $this->msg( 'api-help-authmanager-general-usage',
$this->getModulePrefix(),
$this->getModuleName(),
$this->getModulePath(),
AuthManager::ACTION_LINK,
$this->needsToken(),
);
return $msgs;
}
public function execute() {
if ( !$this->getUser()->isNamed() ) {
$this->dieWithError( 'apierror-mustbeloggedin-linkaccounts', 'notloggedin' );
}
$params = $this->extractRequestParams();
$this->requireAtLeastOneParameter( $params, 'continue', 'returnurl' );
if ( $params['returnurl'] !== null ) {
$bits = $this->urlUtils->parse( $params['returnurl'] );
if ( !$bits || $bits['scheme'] === '' ) {
$encParamName = $this->encodeParamName( 'returnurl' );
$this->dieWithError(
[ 'apierror-badurl', $encParamName, wfEscapeWikiText( $params['returnurl'] ) ],
"badurl_{$encParamName}"
);
}
}
$helper = new ApiAuthManagerHelper( $this, $this->authManager );
// Check security-sensitive operation status
$helper->securitySensitiveOperation( 'LinkAccounts' );
// Make sure it's possible to link accounts
if ( !$this->authManager->canLinkAccounts() ) {
$this->getResult()->addValue( null, 'linkaccount', $helper->formatAuthenticationResponse(
AuthenticationResponse::newFail( $this->msg( 'userlogin-cannot-' . AuthManager::ACTION_LINK ) )
) );
return;
}
// Perform the link step
if ( $params['continue'] ) {
$reqs = $helper->loadAuthenticationRequests( AuthManager::ACTION_LINK_CONTINUE );
$res = $this->authManager->continueAccountLink( $reqs );
} else {
$reqs = $helper->loadAuthenticationRequests( AuthManager::ACTION_LINK );
$res = $this->authManager->beginAccountLink( $this->getUser(), $reqs, $params['returnurl'] );
}
$this->getResult()->addValue( null, 'linkaccount',
$helper->formatAuthenticationResponse( $res ) );
}
public function isReadMode() {
return false;
}
public function isWriteMode() {
return true;
}
public function needsToken() {
return 'csrf';
}
public function getAllowedParams() {
return ApiAuthManagerHelper::getStandardParams( AuthManager::ACTION_LINK,
'requests', 'messageformat', 'mergerequestfields', 'returnurl', 'continue'
);
}
public function dynamicParameterDocumentation() {
return [ 'api-help-authmanagerhelper-additional-params', AuthManager::ACTION_LINK ];
}
protected function getExamplesMessages() {
return [
'action=linkaccount&provider=Example&linkreturnurl=http://example.org/&linktoken=123ABC'
=> 'apihelp-linkaccount-example-link',
];
}
public function getHelpUrls() {
return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Linkaccount';
}
}
/** @deprecated class alias since 1.43 */
class_alias( ApiLinkAccount::class, 'ApiLinkAccount' );

File Metadata

Mime Type
text/x-php
Expires
Sat, May 16, 14:52 (22 h, 58 m)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
b9/7b/2f9d543ee6b03552390818391029
Default Alt Text
ApiLinkAccount.php (4 KB)

Event Timeline