diff options
Diffstat (limited to 'www/wiki/includes/auth/AbstractPrimaryAuthenticationProvider.php')
-rw-r--r-- | www/wiki/includes/auth/AbstractPrimaryAuthenticationProvider.php | 118 |
1 files changed, 118 insertions, 0 deletions
diff --git a/www/wiki/includes/auth/AbstractPrimaryAuthenticationProvider.php b/www/wiki/includes/auth/AbstractPrimaryAuthenticationProvider.php new file mode 100644 index 00000000..ca947b61 --- /dev/null +++ b/www/wiki/includes/auth/AbstractPrimaryAuthenticationProvider.php @@ -0,0 +1,118 @@ +<?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, array $options = [] ) { + 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 ) { + } + +} |