AuthPlugin::initUser() - Code Metrics - wikimedia/mediawiki - Measure and Improve Code Quality continuously with Scrutinizer

AuthPlugin::initUser() A
last analyzed 2016-11-13 17:42 UTC

↳ Parent: AuthPlugin

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	2
dl	0
loc	3
rs	10
c	0
b	0
f	0

<?php
/**
 * Authentication plugin interface
 *
 * Copyright © 2004 Brion Vibber <[email protected]>
 * https://www.mediawiki.org/
 *
 * 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
 */

/**
 * Authentication plugin interface. Instantiate a subclass of AuthPlugin
 * and set $wgAuth to it to authenticate against some external tool.
 *
 * The default behavior is not to do anything, and use the local user
 * database for all authentication. A subclass can require that all
 * accounts authenticate externally, or use it only as a fallback; also
 * you can transparently create internal wiki accounts the first time
 * someone logs in who can be authenticated externally.
 *
 * @deprecated since 1.27
 */
class AuthPlugin {
	/**
	 * @var string
	 */
	protected $domain;

	/**
	 * Check whether there exists a user account with the given name.
	 * The name will be normalized to MediaWiki's requirements, so
	 * you might need to munge it (for instance, for lowercase initial
	 * letters).
	 *
	 * @param string $username Username.
	 * @return bool
	 */
	public function userExists( $username ) {
		# Override this!
		return false;
	}

	/**
	 * Check if a username+password pair is a valid login.
	 * The name will be normalized to MediaWiki's requirements, so
	 * you might need to munge it (for instance, for lowercase initial
	 * letters).
	 *
	 * @param string $username Username.
	 * @param string $password User password.
	 * @return bool
	 */
	public function authenticate( $username, $password ) {
		# Override this!
		return false;
	}

	/**
	 * Modify options in the login template.
	 *
	 * @param UserLoginTemplate $template
	 * @param string $type 'signup' or 'login'. Added in 1.16.
	 */
	public function modifyUITemplate( &$template, &$type ) {
		# Override this!
		$template->set( 'usedomain', false );
	}

	/**
	 * Set the domain this plugin is supposed to use when authenticating.
	 *
	 * @param string $domain Authentication domain.
	 */
	public function setDomain( $domain ) {
		$this->domain = $domain;
	}

	/**
	 * Get the user's domain
	 *
	 * @return string
	 */
	public function getDomain() {
		if ( isset( $this->domain ) ) {
			return $this->domain;
		} else {
			return 'invaliddomain';
		}
	}

	/**
	 * Check to see if the specific domain is a valid domain.
	 *
	 * @param string $domain Authentication domain.
	 * @return bool
	 */
	public function validDomain( $domain ) {
		# Override this!
		return true;
	}

	/**
	 * When a user logs in, optionally fill in preferences and such.
	 * For instance, you might pull the email address or real name from the
	 * external user database.
	 *
	 * The User object is passed by reference so it can be modified; don't
	 * forget the & on your function declaration.
	 *
	 * @deprecated since 1.26, use the UserLoggedIn hook instead. And assigning
	 *  a different User object to $user is no longer supported.
	 * @param User $user
	 * @return bool
	 */
	public function updateUser( &$user ) {
		# Override this and do something
		return true;
	}

	/**
	 * Return true if the wiki should create a new local account automatically
	 * when asked to login a user who doesn't exist locally but does in the
	 * external auth database.
	 *
	 * If you don't automatically create accounts, you must still create
	 * accounts in some way. It's not possible to authenticate without
	 * a local account.
	 *
	 * This is just a question, and shouldn't perform any actions.
	 *
	 * @return bool
	 */
	public function autoCreate() {
		return false;
	}

	/**
	 * Allow a property change? Properties are the same as preferences
	 * and use the same keys. 'Realname' 'Emailaddress' and 'Nickname'
	 * all reference this.
	 *
	 * @param string $prop
	 *
	 * @return bool
	 */
	public function allowPropChange( $prop = '' ) {
		if ( $prop == 'realname' && is_callable( [ $this, 'allowRealNameChange' ] ) ) {
			return $this->allowRealNameChange();

		} elseif ( $prop == 'emailaddress' && is_callable( [ $this, 'allowEmailChange' ] ) ) {
			return $this->allowEmailChange();

		} elseif ( $prop == 'nickname' && is_callable( [ $this, 'allowNickChange' ] ) ) {
			return $this->allowNickChange();

		} else {
			return true;
		}
	}

	/**
	 * Can users change their passwords?
	 *
	 * @return bool
	 */
	public function allowPasswordChange() {
		return true;
	}

	/**
	 * Should MediaWiki store passwords in its local database?
	 *
	 * @return bool
	 */
	public function allowSetLocalPassword() {
		return true;
	}

	/**
	 * Set the given password in the authentication database.
	 * As a special case, the password may be set to null to request
	 * locking the password to an unusable value, with the expectation
	 * that it will be set later through a mail reset or other method.
	 *
	 * Return true if successful.
	 *
	 * @param User $user
	 * @param string $password Password.
	 * @return bool
	 */
	public function setPassword( $user, $password ) {
		return true;
	}

	/**
	 * Update user information in the external authentication database.
	 * Return true if successful.
	 *
	 * @deprecated since 1.26, use the UserSaveSettings hook instead.
	 * @param User $user
	 * @return bool
	 */
	public function updateExternalDB( $user ) {
		return true;
	}

	/**
	 * Update user groups in the external authentication database.
	 * Return true if successful.
	 *
	 * @deprecated since 1.26, use the UserGroupsChanged hook instead.
	 * @param User $user
	 * @param array $addgroups Groups to add.
	 * @param array $delgroups Groups to remove.
	 * @return bool
	 */
	public function updateExternalDBGroups( $user, $addgroups, $delgroups = [] ) {
		return true;
	}

	/**
	 * Check to see if external accounts can be created.
	 * Return true if external accounts can be created.
	 * @return bool
	 */
	public function canCreateAccounts() {
		return false;
	}

	/**
	 * Add a user to the external authentication database.
	 * Return true if successful.
	 *
	 * @param User $user Only the name should be assumed valid at this point
	 * @param string $password
	 * @param string $email
	 * @param string $realname
	 * @return bool
	 */
	public function addUser( $user, $password, $email = '', $realname = '' ) {
		return true;
	}

	/**
	 * Return true to prevent logins that don't authenticate here from being
	 * checked against the local database's password fields.
	 *
	 * This is just a question, and shouldn't perform any actions.
	 *
	 * @return bool
	 */
	public function strict() {
		return false;
	}

	/**
	 * Check if a user should authenticate locally if the global authentication fails.
	 * If either this or strict() returns true, local authentication is not used.
	 *
	 * @param string $username Username.
	 * @return bool
	 */
	public function strictUserAuth( $username ) {
		return false;
	}

	/**
	 * When creating a user account, optionally fill in preferences and such.
	 * For instance, you might pull the email address or real name from the
	 * external user database.
	 *
	 * The User object is passed by reference so it can be modified; don't
	 * forget the & on your function declaration.
	 *
	 * @deprecated since 1.26, use the UserLoggedIn hook instead. And assigning
	 *  a different User object to $user is no longer supported.
	 * @param User $user
	 * @param bool $autocreate True if user is being autocreated on login
	 */
	public function initUser( &$user, $autocreate = false ) {
		# Override this to do something.
	}

	/**
	 * If you want to munge the case of an account name before the final
	 * check, now is your chance.
	 * @param string $username
	 * @return string
	 */
	public function getCanonicalName( $username ) {
		return $username;
	}

	/**
	 * Get an instance of a User object
	 *
	 * @param User $user
	 *
	 * @return AuthPluginUser
	 */
	public function getUserInstance( User &$user ) {
		return new AuthPluginUser( $user );

	}

	/**
	 * Get a list of domains (in HTMLForm options format) used.
	 *
	 * @return array
	 */
	public function domainList() {
		return [];
	}
}

/**
 * @deprecated since 1.27
 */
class AuthPluginUser {
	function __construct( $user ) {
		# Override this!
	}

	public function getId() {
		# Override this!
		return -1;
	}

	/**
	 * Indicate whether the user is locked
	 * @deprecated since 1.26, use the UserIsLocked hook instead.
	 * @return bool
	 */
	public function isLocked() {
		# Override this!
		return false;
	}

	/**
	 * Indicate whether the user is hidden
	 * @deprecated since 1.26, use the UserIsHidden hook instead.
	 * @return bool
	 */
	public function isHidden() {
		# Override this!
		return false;
	}

	/**
	 * @deprecated since 1.28, use SessionManager::invalidateSessionForUser() instead.
	 */
	public function resetAuthToken() {
		# Override this!
		return true;
	}
}


1			<?php
2			/**
3			* Authentication plugin interface
4			*
5			* Copyright © 2004 Brion Vibber <[email protected]>
6			* https://www.mediawiki.org/
7			*
8			* This program is free software; you can redistribute it and/or modify
9			* it under the terms of the GNU General Public License as published by
10			* the Free Software Foundation; either version 2 of the License, or
11			* (at your option) any later version.
12			*
13			* This program is distributed in the hope that it will be useful,
14			* but WITHOUT ANY WARRANTY; without even the implied warranty of
15			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16			* GNU General Public License for more details.
17			*
18			* You should have received a copy of the GNU General Public License along
19			* with this program; if not, write to the Free Software Foundation, Inc.,
20			* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21			* http://www.gnu.org/copyleft/gpl.html
22			*
23			* @file
24			*/
25
26			/**
27			* Authentication plugin interface. Instantiate a subclass of AuthPlugin
28			* and set $wgAuth to it to authenticate against some external tool.
29			*
30			* The default behavior is not to do anything, and use the local user
31			* database for all authentication. A subclass can require that all
32			* accounts authenticate externally, or use it only as a fallback; also
33			* you can transparently create internal wiki accounts the first time
34			* someone logs in who can be authenticated externally.
35			*
36			* @deprecated since 1.27
37			*/
38			class AuthPlugin {
39			/**
40			* @var string
41			*/
42			protected $domain;
43
44			/**
45			* Check whether there exists a user account with the given name.
46			* The name will be normalized to MediaWiki's requirements, so
47			* you might need to munge it (for instance, for lowercase initial
48			* letters).
49			*
50			* @param string $username Username.
51			* @return bool
52			*/
53			public function userExists( $username ) {
54			# Override this!
55			return false;
56			}
57
58			/**
59			* Check if a username+password pair is a valid login.
60			* The name will be normalized to MediaWiki's requirements, so
61			* you might need to munge it (for instance, for lowercase initial
62			* letters).
63			*
64			* @param string $username Username.
65			* @param string $password User password.
66			* @return bool
67			*/
68			public function authenticate( $username, $password ) {
69			# Override this!
70			return false;
71			}
72
73			/**
74			* Modify options in the login template.
75			*
76			* @param UserLoginTemplate $template
77			* @param string $type 'signup' or 'login'. Added in 1.16.
78			*/
79			public function modifyUITemplate( &$template, &$type ) {
80			# Override this!
81			$template->set( 'usedomain', false );
82			}
83
84			/**
85			* Set the domain this plugin is supposed to use when authenticating.
86			*
87			* @param string $domain Authentication domain.
88			*/
89			public function setDomain( $domain ) {
90			$this->domain = $domain;
91			}
92
93			/**
94			* Get the user's domain
95			*
96			* @return string
97			*/
98			public function getDomain() {
99			if ( isset( $this->domain ) ) {
100			return $this->domain;
101			} else {
102			return 'invaliddomain';
103			}
104			}
105
106			/**
107			* Check to see if the specific domain is a valid domain.
108			*
109			* @param string $domain Authentication domain.
110			* @return bool
111			*/
112			public function validDomain( $domain ) {
113			# Override this!
114			return true;
115			}
116
117			/**
118			* When a user logs in, optionally fill in preferences and such.
119			* For instance, you might pull the email address or real name from the
120			* external user database.
121			*
122			* The User object is passed by reference so it can be modified; don't
123			* forget the & on your function declaration.
124			*
125			* @deprecated since 1.26, use the UserLoggedIn hook instead. And assigning
126			* a different User object to $user is no longer supported.
127			* @param User $user
128			* @return bool
129			*/
130			public function updateUser( &$user ) {
131			# Override this and do something
132			return true;
133			}
134
135			/**
136			* Return true if the wiki should create a new local account automatically
137			* when asked to login a user who doesn't exist locally but does in the
138			* external auth database.
139			*
140			* If you don't automatically create accounts, you must still create
141			* accounts in some way. It's not possible to authenticate without
142			* a local account.
143			*
144			* This is just a question, and shouldn't perform any actions.
145			*
146			* @return bool
147			*/
148			public function autoCreate() {
149			return false;
150			}
151
152			/**
153			* Allow a property change? Properties are the same as preferences
154			* and use the same keys. 'Realname' 'Emailaddress' and 'Nickname'
155			* all reference this.
156			*
157			* @param string $prop
158			*
159			* @return bool
160			*/
161			public function allowPropChange( $prop = '' ) {
162			if ( $prop == 'realname' && is_callable( [ $this, 'allowRealNameChange' ] ) ) {
163			return $this->allowRealNameChange();
			0 ignored issues – show Bug introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report The method `allowRealNameChange()` does not seem to exist on `object<AuthPlugin>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
164			} elseif ( $prop == 'emailaddress' && is_callable( [ $this, 'allowEmailChange' ] ) ) {
165			return $this->allowEmailChange();
			0 ignored issues – show Bug introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report The method `allowEmailChange()` does not seem to exist on `object<AuthPlugin>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
166			} elseif ( $prop == 'nickname' && is_callable( [ $this, 'allowNickChange' ] ) ) {
167			return $this->allowNickChange();
			0 ignored issues – show Bug introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report The method `allowNickChange()` does not seem to exist on `object<AuthPlugin>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
168			} else {
169			return true;
170			}
171			}
172
173			/**
174			* Can users change their passwords?
175			*
176			* @return bool
177			*/
178			public function allowPasswordChange() {
179			return true;
180			}
181
182			/**
183			* Should MediaWiki store passwords in its local database?
184			*
185			* @return bool
186			*/
187			public function allowSetLocalPassword() {
188			return true;
189			}
190
191			/**
192			* Set the given password in the authentication database.
193			* As a special case, the password may be set to null to request
194			* locking the password to an unusable value, with the expectation
195			* that it will be set later through a mail reset or other method.
196			*
197			* Return true if successful.
198			*
199			* @param User $user
200			* @param string $password Password.
201			* @return bool
202			*/
203			public function setPassword( $user, $password ) {
204			return true;
205			}
206
207			/**
208			* Update user information in the external authentication database.
209			* Return true if successful.
210			*
211			* @deprecated since 1.26, use the UserSaveSettings hook instead.
212			* @param User $user
213			* @return bool
214			*/
215			public function updateExternalDB( $user ) {
216			return true;
217			}
218
219			/**
220			* Update user groups in the external authentication database.
221			* Return true if successful.
222			*
223			* @deprecated since 1.26, use the UserGroupsChanged hook instead.
224			* @param User $user
225			* @param array $addgroups Groups to add.
226			* @param array $delgroups Groups to remove.
227			* @return bool
228			*/
229			public function updateExternalDBGroups( $user, $addgroups, $delgroups = [] ) {
230			return true;
231			}
232
233			/**
234			* Check to see if external accounts can be created.
235			* Return true if external accounts can be created.
236			* @return bool
237			*/
238			public function canCreateAccounts() {
239			return false;
240			}
241
242			/**
243			* Add a user to the external authentication database.
244			* Return true if successful.
245			*
246			* @param User $user Only the name should be assumed valid at this point
247			* @param string $password
248			* @param string $email
249			* @param string $realname
250			* @return bool
251			*/
252			public function addUser( $user, $password, $email = '', $realname = '' ) {
253			return true;
254			}
255
256			/**
257			* Return true to prevent logins that don't authenticate here from being
258			* checked against the local database's password fields.
259			*
260			* This is just a question, and shouldn't perform any actions.
261			*
262			* @return bool
263			*/
264			public function strict() {
265			return false;
266			}
267
268			/**
269			* Check if a user should authenticate locally if the global authentication fails.
270			* If either this or strict() returns true, local authentication is not used.
271			*
272			* @param string $username Username.
273			* @return bool
274			*/
275			public function strictUserAuth( $username ) {
276			return false;
277			}
278
279			/**
280			* When creating a user account, optionally fill in preferences and such.
281			* For instance, you might pull the email address or real name from the
282			* external user database.
283			*
284			* The User object is passed by reference so it can be modified; don't
285			* forget the & on your function declaration.
286			*
287			* @deprecated since 1.26, use the UserLoggedIn hook instead. And assigning
288			* a different User object to $user is no longer supported.
289			* @param User $user
290			* @param bool $autocreate True if user is being autocreated on login
291			*/
292			public function initUser( &$user, $autocreate = false ) {
293			# Override this to do something.
294			}
295
296			/**
297			* If you want to munge the case of an account name before the final
298			* check, now is your chance.
299			* @param string $username
300			* @return string
301			*/
302			public function getCanonicalName( $username ) {
303			return $username;
304			}
305
306			/**
307			* Get an instance of a User object
308			*
309			* @param User $user
310			*
311			* @return AuthPluginUser
312			*/
313			public function getUserInstance( User &$user ) {
314			return new AuthPluginUser( $user );
			0 ignored issues – show Deprecated Code introduced 2016-05-16 17:54 UTC by Report Bug Copy Issue Report The class `AuthPluginUser` has been deprecated with message: since 1.27 This class, trait or interface has been deprecated. The supplier of the file has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the type will be removed from the class and what other constant to use instead. Loading history...
315			}
316
317			/**
318			* Get a list of domains (in HTMLForm options format) used.
319			*
320			* @return array
321			*/
322			public function domainList() {
323			return [];
324			}
325			}
326
327			/**
328			* @deprecated since 1.27
329			*/
330			class AuthPluginUser {
331			function __construct( $user ) {
332			# Override this!
333			}
334
335			public function getId() {
336			# Override this!
337			return -1;
338			}
339
340			/**
341			* Indicate whether the user is locked
342			* @deprecated since 1.26, use the UserIsLocked hook instead.
343			* @return bool
344			*/
345			public function isLocked() {
346			# Override this!
347			return false;
348			}
349
350			/**
351			* Indicate whether the user is hidden
352			* @deprecated since 1.26, use the UserIsHidden hook instead.
353			* @return bool
354			*/
355			public function isHidden() {
356			# Override this!
357			return false;
358			}
359
360			/**
361			* @deprecated since 1.28, use SessionManager::invalidateSessionForUser() instead.
362			*/
363			public function resetAuthToken() {
364			# Override this!
365			return true;
366			}
367			}
368

wikimedia / mediawiki

AuthPlugin::initUser() A last analyzed 2016-11-13 17:42 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

AuthPlugin::initUser() A
last analyzed 2016-11-13 17:42 UTC