wiki.techinc.nl/includes/auth/AbstractPrimaryAuthenticationProvider.php
Brad Jorsch d245bd25ae Add AuthManager
This implements the AuthManager class and its needed interfaces and
subclasses, and integrates them into the backend portion of MediaWiki.
Integration with frontend portions of MediaWiki (e.g. ApiLogin,
Special:Login) is left for a followup.

Bug: T91699
Bug: T71589
Bug: T111299
Co-Authored-By: Gergő Tisza <gtisza@wikimedia.org>
Change-Id: If89d24838e326fe25fe867d02181eebcfbb0e196
2016-05-16 15:11:02 +00:00

118 lines
3.5 KiB
PHP

<?php
/**
* 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
* @ingroup Auth
*/
namespace MediaWiki\Auth;
use User;
/**
* A base class that implements some of the boilerplate for a PrimaryAuthenticationProvider
*
* @ingroup Auth
* @since 1.27
*/
abstract class AbstractPrimaryAuthenticationProvider extends AbstractAuthenticationProvider
implements PrimaryAuthenticationProvider
{
public function continuePrimaryAuthentication( array $reqs ) {
throw new \BadMethodCallException( __METHOD__ . ' is not implemented.' );
}
public function postAuthentication( $user, AuthenticationResponse $response ) {
}
public function testUserCanAuthenticate( $username ) {
// Assume it can authenticate if it exists
return $this->testUserExists( $username );
}
/**
* @inheritdoc
* @note Reimplement this if you do anything other than
* User::getCanonicalName( $req->username ) to determine the user being
* authenticated.
*/
public function providerNormalizeUsername( $username ) {
$name = User::getCanonicalName( $username );
return $name === false ? null : $name;
}
/**
* @inheritdoc
* @note Reimplement this if self::getAuthenticationRequests( AuthManager::ACTION_REMOVE )
* doesn't return requests that will revoke all access for the user.
*/
public function providerRevokeAccessForUser( $username ) {
$reqs = $this->getAuthenticationRequests(
AuthManager::ACTION_REMOVE, [ 'username' => $username ]
);
foreach ( $reqs as $req ) {
$req->username = $username;
$req->action = AuthManager::ACTION_REMOVE;
$this->providerChangeAuthenticationData( $req );
}
}
public function providerAllowsPropertyChange( $property ) {
return true;
}
public function testForAccountCreation( $user, $creator, array $reqs ) {
return \StatusValue::newGood();
}
public function continuePrimaryAccountCreation( $user, $creator, array $reqs ) {
throw new \BadMethodCallException( __METHOD__ . ' is not implemented.' );
}
public function finishAccountCreation( $user, $creator, AuthenticationResponse $response ) {
return null;
}
public function postAccountCreation( $user, $creator, AuthenticationResponse $response ) {
}
public function testUserForCreation( $user, $autocreate ) {
return \StatusValue::newGood();
}
public function autoCreatedAccount( $user, $source ) {
}
public function beginPrimaryAccountLink( $user, array $reqs ) {
if ( $this->accountCreationType() === self::TYPE_LINK ) {
throw new \BadMethodCallException( __METHOD__ . ' is not implemented.' );
} else {
throw new \BadMethodCallException(
__METHOD__ . ' should not be called on a non-link provider.'
);
}
}
public function continuePrimaryAccountLink( $user, array $reqs ) {
throw new \BadMethodCallException( __METHOD__ . ' is not implemented.' );
}
public function postAccountLink( $user, AuthenticationResponse $response ) {
}
}