ResetPasswordSecondaryAuthenticationProvider::tryReset() - Code Metrics - Inspection of "Daily Inspection: Merge "Password change request s..." - wikimedia/mediawiki - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — master (5f0cc1)

unknown

created 2016-06-06 17:38 UTC

tryReset() D

↳ Parent: ResetPasswordSecondaryAuthenticationProvider

Complexity

Conditions	20
Paths	269

Size

Total Lines	68
Code Lines	46

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
cc	20
eloc	46
c	2
b	0
f	0
nc	269
nop	2
dl	0
loc	68
rs	4.2686

How to fix Long Method Complexity

<?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;

/**
 * Reset the local password, if signalled via $this->manager->setAuthenticationSessionData()
 *
 * The authentication data key is 'reset-pass'; the data is an object with the
 * following properties:
 * - msg: Message object to display to the user
 * - hard: Boolean, if true the reset cannot be skipped.
 * - req: Optional PasswordAuthenticationRequest to use to actually reset the
 *   password. Won't be displayed to the user.
 *
 * @ingroup Auth
 * @since 1.27
 */
class ResetPasswordSecondaryAuthenticationProvider extends AbstractSecondaryAuthenticationProvider {

	public function getAuthenticationRequests( $action, array $options ) {
		return [];
	}

	public function beginSecondaryAuthentication( $user, array $reqs ) {
		return $this->tryReset( $user, $reqs );
	}

	public function continueSecondaryAuthentication( $user, array $reqs ) {
		return $this->tryReset( $user, $reqs );
	}

	public function beginSecondaryAccountCreation( $user, $creator, array $reqs ) {
		return $this->tryReset( $user, $reqs );
	}

	public function continueSecondaryAccountCreation( $user, $creator, array $reqs ) {
		return $this->tryReset( $user, $reqs );
	}

	/**
	 * Try to reset the password
	 * @param AuthenticationRequest[] $reqs
	 * @return AuthenticationResponse
	 */
	protected function tryReset( \User $user, array $reqs ) {
		$data = $this->manager->getAuthenticationSessionData( 'reset-pass' );
		if ( !$data ) {
			return AuthenticationResponse::newAbstain();
		}

		if ( is_array( $data ) ) {
			$data = (object)$data;
		}
		if ( !is_object( $data ) ) {
			throw new \UnexpectedValueException( 'reset-pass is not valid' );
		}

		if ( !isset( $data->msg ) ) {
			throw new \UnexpectedValueException( 'reset-pass msg is missing' );
		} elseif ( !$data->msg instanceof \Message ) {
			throw new \UnexpectedValueException( 'reset-pass msg is not valid' );
		} elseif ( !isset( $data->hard ) ) {
			throw new \UnexpectedValueException( 'reset-pass hard is missing' );
		} elseif ( isset( $data->req ) && (
			!$data->req instanceof PasswordAuthenticationRequest ||
			!array_key_exists( 'retype', $data->req->getFieldInfo() )
		) ) {
			throw new \UnexpectedValueException( 'reset-pass req is not valid' );
		}

		if ( !$data->hard ) {
			$req = ButtonAuthenticationRequest::getRequestByName( $reqs, 'skipReset' );
			if ( $req ) {
				$this->manager->removeAuthenticationSessionData( 'reset-pass' );
				return AuthenticationResponse::newPass();
			}
		}

		$needReq = isset( $data->req ) ? $data->req : new PasswordAuthenticationRequest();
		if ( !$needReq->action ) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
			$needReq->action = AuthManager::ACTION_CHANGE;
		}
		$needReq->required = $data->hard ? AuthenticationRequest::REQUIRED
			: AuthenticationRequest::OPTIONAL;
		$needReqs = [ $needReq ];
		if ( !$data->hard ) {
			$needReqs[] = new ButtonAuthenticationRequest(
				'skipReset',
				wfMessage( 'authprovider-resetpass-skip-label' ),
				wfMessage( 'authprovider-resetpass-skip-help' )
			);
		}

		$req = AuthenticationRequest::getRequestByClass( $reqs, get_class( $needReq ) );
		if ( !$req || !array_key_exists( 'retype', $req->getFieldInfo() ) ) {
			return AuthenticationResponse::newUI( $needReqs, $data->msg );
		}

		if ( $req->password !== $req->retype ) {

			return AuthenticationResponse::newUI( $needReqs, new \Message( 'badretype' ) );
		}

		$req->username = $user->getName();
		$status = $this->manager->allowsAuthenticationDataChange( $req );
		if ( !$status->isGood() ) {
			return AuthenticationResponse::newUI( $needReqs, $status->getMessage() );
		}
		$this->manager->changeAuthenticationData( $req );

		$this->manager->removeAuthenticationSessionData( 'reset-pass' );
		return AuthenticationResponse::newPass();
	}
}


1			<?php
2			/**
3			* This program is free software; you can redistribute it and/or modify
4			* it under the terms of the GNU General Public License as published by
5			* the Free Software Foundation; either version 2 of the License, or
6			* (at your option) any later version.
7			*
8			* This program is distributed in the hope that it will be useful,
9			* but WITHOUT ANY WARRANTY; without even the implied warranty of
10			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11			* GNU General Public License for more details.
12			*
13			* You should have received a copy of the GNU General Public License along
14			* with this program; if not, write to the Free Software Foundation, Inc.,
15			* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16			* http://www.gnu.org/copyleft/gpl.html
17			*
18			* @file
19			* @ingroup Auth
20			*/
21
22			namespace MediaWiki\Auth;
23
24			/**
25			* Reset the local password, if signalled via $this->manager->setAuthenticationSessionData()
26			*
27			* The authentication data key is 'reset-pass'; the data is an object with the
28			* following properties:
29			* - msg: Message object to display to the user
30			* - hard: Boolean, if true the reset cannot be skipped.
31			* - req: Optional PasswordAuthenticationRequest to use to actually reset the
32			* password. Won't be displayed to the user.
33			*
34			* @ingroup Auth
35			* @since 1.27
36			*/
37			class ResetPasswordSecondaryAuthenticationProvider extends AbstractSecondaryAuthenticationProvider {
38
39			public function getAuthenticationRequests( $action, array $options ) {
40			return [];
41			}
42
43			public function beginSecondaryAuthentication( $user, array $reqs ) {
44			return $this->tryReset( $user, $reqs );
45			}
46
47			public function continueSecondaryAuthentication( $user, array $reqs ) {
48			return $this->tryReset( $user, $reqs );
49			}
50
51			public function beginSecondaryAccountCreation( $user, $creator, array $reqs ) {
52			return $this->tryReset( $user, $reqs );
53			}
54
55			public function continueSecondaryAccountCreation( $user, $creator, array $reqs ) {
56			return $this->tryReset( $user, $reqs );
57			}
58
59			/**
60			* Try to reset the password
61			* @param AuthenticationRequest[] $reqs
62			* @return AuthenticationResponse
63			*/
64			protected function tryReset( \User $user, array $reqs ) {
65			$data = $this->manager->getAuthenticationSessionData( 'reset-pass' );
66			if ( !$data ) {
67			return AuthenticationResponse::newAbstain();
68			}
69
70			if ( is_array( $data ) ) {
71			$data = (object)$data;
72			}
73			if ( !is_object( $data ) ) {
74			throw new \UnexpectedValueException( 'reset-pass is not valid' );
75			}
76
77			if ( !isset( $data->msg ) ) {
78			throw new \UnexpectedValueException( 'reset-pass msg is missing' );
79			} elseif ( !$data->msg instanceof \Message ) {
80			throw new \UnexpectedValueException( 'reset-pass msg is not valid' );
81			} elseif ( !isset( $data->hard ) ) {
82			throw new \UnexpectedValueException( 'reset-pass hard is missing' );
83			} elseif ( isset( $data->req ) && (
84			!$data->req instanceof PasswordAuthenticationRequest \|\|
85			!array_key_exists( 'retype', $data->req->getFieldInfo() )
86			) ) {
87			throw new \UnexpectedValueException( 'reset-pass req is not valid' );
88			}
89
90			if ( !$data->hard ) {
91			$req = ButtonAuthenticationRequest::getRequestByName( $reqs, 'skipReset' );
92			if ( $req ) {
93			$this->manager->removeAuthenticationSessionData( 'reset-pass' );
94			return AuthenticationResponse::newPass();
95			}
96			}
97
98			$needReq = isset( $data->req ) ? $data->req : new PasswordAuthenticationRequest();
99			if ( !$needReq->action ) {
			0 ignored issues – show Bug Best Practice introduced 2016-06-06 18:04 UTC by Report Bug Copy Issue Report The expression `$needReq->action` of type `string\|null` is loosely compared to `false`; this is ambiguous if the string can be empty. You might want to explicitly use `=== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
100			$needReq->action = AuthManager::ACTION_CHANGE;
101			}
102			$needReq->required = $data->hard ? AuthenticationRequest::REQUIRED
103			: AuthenticationRequest::OPTIONAL;
104			$needReqs = [ $needReq ];
105			if ( !$data->hard ) {
106			$needReqs[] = new ButtonAuthenticationRequest(
107			'skipReset',
108			wfMessage( 'authprovider-resetpass-skip-label' ),
109			wfMessage( 'authprovider-resetpass-skip-help' )
110			);
111			}
112
113			$req = AuthenticationRequest::getRequestByClass( $reqs, get_class( $needReq ) );
114			if ( !$req \|\| !array_key_exists( 'retype', $req->getFieldInfo() ) ) {
115			return AuthenticationResponse::newUI( $needReqs, $data->msg );
116			}
117
118			if ( $req->password !== $req->retype ) {
			0 ignored issues – show Bug introduced 2016-05-16 17:54 UTC by Report Bug Copy Issue Report The property `password` does not seem to exist in `MediaWiki\Auth\AuthenticationRequest`. An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history... Bug introduced 2016-05-16 17:54 UTC by Report Bug Copy Issue Report The property `retype` does not seem to exist in `MediaWiki\Auth\AuthenticationRequest`. An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
119			return AuthenticationResponse::newUI( $needReqs, new \Message( 'badretype' ) );
120			}
121
122			$req->username = $user->getName();
123			$status = $this->manager->allowsAuthenticationDataChange( $req );
124			if ( !$status->isGood() ) {
125			return AuthenticationResponse::newUI( $needReqs, $status->getMessage() );
126			}
127			$this->manager->changeAuthenticationData( $req );
128
129			$this->manager->removeAuthenticationSessionData( 'reset-pass' );
130			return AuthenticationResponse::newPass();
131			}
132			}
133

wikimedia / mediawiki

Branch — master (5f0cc1)

tryReset() D

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like