1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
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 ) {
}
}
|
