ChangePasswordHandler::changepassword() - Code Metrics - Inspection of "[FIX] CMSSecurity doesn't have Authenticators assi..." - silverstripe/silverstripe-framework - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#7007)

by Simon

created 2017-06-10 02:49 UTC

ChangePasswordHandler::changepassword() C

↳ Parent: ChangePasswordHandler

Complexity

Conditions	10
Paths	10

Size

Total Lines	83
Code Lines	47

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	10
eloc	47
nc	10
nop	0
dl	0
loc	83
rs	5.4243
c	0
b	0
f	0

How to fix Long Method Complexity

<?php


namespace SilverStripe\Security\MemberAuthenticator;

use SilverStripe\Control\Controller;
use SilverStripe\Control\HTTPResponse;
use SilverStripe\Control\RequestHandler;
use SilverStripe\Control\Session;
use SilverStripe\Core\Injector\Injector;
use SilverStripe\ORM\FieldType\DBDatetime;
use SilverStripe\ORM\FieldType\DBField;
use SilverStripe\Security\Authenticator;
use SilverStripe\Security\IdentityStore;
use SilverStripe\Security\Member;
use SilverStripe\Security\Security;

class ChangePasswordHandler extends RequestHandler
{
    /**
     * @var Authenticator
     */
    protected $authenticator;

    /**
     * @var string
     */
    protected $link;

    /**
     * @var array Allowed Actions
     */
    private static $allowed_actions = [
        'changepassword',
        'changePasswordForm',
    ];

    /**
     * @var array URL Handlers. All should point to changepassword
     */
    private static $url_handlers = [
        '' => 'changepassword',
    ];

    /**
     * @param string $link The URL to recreate this request handler
     * @param MemberAuthenticator $authenticator
     */
    public function __construct($link, MemberAuthenticator $authenticator)
    {
        $this->link = $link;
        $this->authenticator = $authenticator;
        parent::__construct();
    }

    /**
     * Handle the change password request
     * @todo this could use some spring cleaning
     *
     * @return array|HTTPResponse
     */
    public function changepassword()
    {
        $request = $this->getRequest();

        // Extract the member from the URL.
        /** @var Member $member */
        $member = null;
        if ($request->getVar('m') !== null) {
            $member = Member::get()->filter(['ID' => (int)$request->getVar('m')])->first();
        }
        $token = $request->getVar('t');

        // Check whether we are merely changin password, or resetting.
        if ($token !== null && $member && $member->validateAutoLoginToken($token)) {
            $this->setSessionToken($member, $token);


            // Redirect to myself, but without the hash in the URL
            return $this->redirect($this->link);
        }

        if (Session::get('AutoLoginHash')) {
            $message = DBField::create_field(
                'HTMLFragment',
                '<p>' . _t(
                    'SilverStripe\\Security\\Security.ENTERNEWPASSWORD',
                    'Please enter a new password.'
                ) . '</p>'
            );

            // Subsequent request after the "first load with hash" (see previous if clause).
            return [
                'Content' => $message,
                'Form'    => $this->changePasswordForm()
            ];
        }

        if (Security::getCurrentUser()) {
            // Logged in user requested a password change form.
            $message = DBField::create_field(
                'HTMLFragment',
                '<p>' . _t(
                    'SilverStripe\\Security\\Security.CHANGEPASSWORDBELOW',
                    'You can change your password below.'
                ) . '</p>'
            );

            return [
                'Content' => $message,
                'Form'    => $this->changePasswordForm()
            ];
        }
        // Show a friendly message saying the login token has expired
        if ($token !== null && $member && !$member->validateAutoLoginToken($token)) {
            $message = [
                'Content' => DBField::create_field(
                    'HTMLFragment',
                    _t(
                        'SilverStripe\\Security\\Security.NOTERESETLINKINVALID',
                        '<p>The password reset link is invalid or expired.</p>'
                        . '<p>You can request a new one <a href="{link1}">here</a> or change your password after'
                        . ' you <a href="{link2}">logged in</a>.</p>',
                        [
                            'link1' => $this->link('lostpassword'),
                            'link2' => $this->link('login')
                        ]
                    )
                )
            ];

            return [
                'Content' => $message,
            ];
        }

        // Someone attempted to go to changepassword without token or being logged in
        return Security::permissionFailure(
            Controller::curr(),
            _t(
                'SilverStripe\\Security\\Security.ERRORPASSWORDPERMISSION',
                'You must be logged in in order to change your password!'
            )
        );
    }


    /**
     * @param Member $member
     * @param string $token
     */
    protected function setSessionToken($member, $token)
    {
        // if there is a current member, they should be logged out
        if ($curMember = Security::getCurrentUser()) {
            /** @var LogoutHandler $handler */
            Injector::inst()->get(IdentityStore::class)->logOut();
        }

        // Store the hash for the change password form. Will be unset after reload within the ChangePasswordForm.
        Session::set('AutoLoginHash', $member->encryptWithUserSettings($token));
    }

    /**
     * Return a link to this request handler.
     * The link returned is supplied in the constructor
     * @param null $action
     * @return string
     */
    public function link($action = null)
    {
        if ($action) {
            return Controller::join_links($this->link, $action);
        }

        return $this->link;
    }

    /**
     * Factory method for the lost password form
     *
     * @skipUpgrade
     * @return ChangePasswordForm Returns the lost password form
     */
    public function changePasswordForm()
    {
        return ChangePasswordForm::create(
            $this,
            'ChangePasswordForm'
        );
    }

    /**
     * Change the password
     *
     * @param array $data The user submitted data
     * @param ChangePasswordForm $form
     * @return HTTPResponse
     */
    public function doChangePassword(array $data, $form)
    {
        $member = Security::getCurrentUser();
        // The user was logged in, check the current password
        if ($member && (
                empty($data['OldPassword']) ||
                !$member->checkPassword($data['OldPassword'])->isValid()
            )
        ) {
            $form->sessionMessage(
                _t(
                    'SilverStripe\\Security\\Member.ERRORPASSWORDNOTMATCH',
                    'Your current password does not match, please try again'
                ),
                'bad'
            );

            // redirect back to the form, instead of using redirectBack() which could send the user elsewhere.
            return $this->redirectBackToForm();
        }

        if (!$member) {
            if (Session::get('AutoLoginHash')) {
                $member = Member::member_from_autologinhash(Session::get('AutoLoginHash'));
            }

            // The user is not logged in and no valid auto login hash is available
            if (!$member) {
                Session::clear('AutoLoginHash');

                return $this->redirect($this->addBackURLParam(Security::singleton()->Link('login')));
            }
        }

        // Check the new password
        if (empty($data['NewPassword1'])) {
            $form->sessionMessage(
                _t(
                    'SilverStripe\\Security\\Member.EMPTYNEWPASSWORD',
                    "The new password can't be empty, please try again"
                ),
                'bad'
            );

            // redirect back to the form, instead of using redirectBack() which could send the user elsewhere.
            return $this->redirectBackToForm();
        }

        // Fail if passwords do not match
        if ($data['NewPassword1'] !== $data['NewPassword2']) {
            $form->sessionMessage(
                _t(
                    'SilverStripe\\Security\\Member.ERRORNEWPASSWORD',
                    'You have entered your new password differently, try again'
                ),
                'bad'
            );

            // redirect back to the form, instead of using redirectBack() which could send the user elsewhere.
            return $this->redirectBackToForm();
        }

        // Check if the new password is accepted
        $validationResult = $member->changePassword($data['NewPassword1']);
        if (!$validationResult->isValid()) {
            $form->setSessionValidationResult($validationResult);

            return $this->redirectBackToForm();
        }

        // Clear locked out status
        $member->LockedOutUntil = null;
        $member->FailedLoginCount = null;
        // Clear the members login hashes
        $member->AutoLoginHash = null;
        $member->AutoLoginExpired = DBDatetime::create()->now();
        $member->write();

        if ($member->canLogIn()->isValid()) {
            Injector::inst()->get(IdentityStore::class)->logIn($member, false, $this->getRequest());
        }

        // TODO Add confirmation message to login redirect
        Session::clear('AutoLoginHash');

        // Redirect to backurl
        $backURL = $this->getBackURL();
        if ($backURL) {
            return $this->redirect($backURL);
        }

        // Redirect to default location - the login form saying "You are logged in as..."
        $url = Security::singleton()->Link('login');

        return $this->redirect($url);
    }

    /**
     * Something went wrong, go back to the changepassword
     *
     * @return HTTPResponse
     */
    public function redirectBackToForm()
    {
        // Redirect back to form
        $url = $this->addBackURLParam(Security::singleton()->Link('changepassword'));

        return $this->redirect($url);
    }
}


1			<?php
2
3
4			namespace SilverStripe\Security\MemberAuthenticator;
5
6			use SilverStripe\Control\Controller;
7			use SilverStripe\Control\HTTPResponse;
8			use SilverStripe\Control\RequestHandler;
9			use SilverStripe\Control\Session;
10			use SilverStripe\Core\Injector\Injector;
11			use SilverStripe\ORM\FieldType\DBDatetime;
12			use SilverStripe\ORM\FieldType\DBField;
13			use SilverStripe\Security\Authenticator;
14			use SilverStripe\Security\IdentityStore;
15			use SilverStripe\Security\Member;
16			use SilverStripe\Security\Security;
17
18			class ChangePasswordHandler extends RequestHandler
19			{
20			/**
21			* @var Authenticator
22			*/
23			protected $authenticator;
24
25			/**
26			* @var string
27			*/
28			protected $link;
29
30			/**
31			* @var array Allowed Actions
32			*/
33			private static $allowed_actions = [
34			'changepassword',
35			'changePasswordForm',
36			];
37
38			/**
39			* @var array URL Handlers. All should point to changepassword
40			*/
41			private static $url_handlers = [
42			'' => 'changepassword',
43			];
44
45			/**
46			* @param string $link The URL to recreate this request handler
47			* @param MemberAuthenticator $authenticator
48			*/
49			public function __construct($link, MemberAuthenticator $authenticator)
50			{
51			$this->link = $link;
52			$this->authenticator = $authenticator;
53			parent::__construct();
54			}
55
56			/**
57			* Handle the change password request
58			* @todo this could use some spring cleaning
59			*
60			* @return array\|HTTPResponse
61			*/
62			public function changepassword()
63			{
64			$request = $this->getRequest();
65
66			// Extract the member from the URL.
67			/** @var Member $member */
68			$member = null;
69			if ($request->getVar('m') !== null) {
70			$member = Member::get()->filter(['ID' => (int)$request->getVar('m')])->first();
71			}
72			$token = $request->getVar('t');
73
74			// Check whether we are merely changin password, or resetting.
75			if ($token !== null && $member && $member->validateAutoLoginToken($token)) {
76			$this->setSessionToken($member, $token);
			0 ignored issues – show Compatibility introduced 2017-06-05 03:15 UTC by Report Bug Copy Issue Report `$member` of type `object<SilverStripe\ORM\DataObject>` is not a sub-type of `object<SilverStripe\Security\Member>`. It seems like you assume a child class of the class `SilverStripe\ORM\DataObject` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
77
78			// Redirect to myself, but without the hash in the URL
79			return $this->redirect($this->link);
80			}
81
82			if (Session::get('AutoLoginHash')) {
83			$message = DBField::create_field(
84			'HTMLFragment',
85			'<p>' . _t(
86			'SilverStripe\\Security\\Security.ENTERNEWPASSWORD',
87			'Please enter a new password.'
88			) . '</p>'
89			);
90
91			// Subsequent request after the "first load with hash" (see previous if clause).
92			return [
93			'Content' => $message,
94			'Form' => $this->changePasswordForm()
95			];
96			}
97
98			if (Security::getCurrentUser()) {
99			// Logged in user requested a password change form.
100			$message = DBField::create_field(
101			'HTMLFragment',
102			'<p>' . _t(
103			'SilverStripe\\Security\\Security.CHANGEPASSWORDBELOW',
104			'You can change your password below.'
105			) . '</p>'
106			);
107
108			return [
109			'Content' => $message,
110			'Form' => $this->changePasswordForm()
111			];
112			}
113			// Show a friendly message saying the login token has expired
114			if ($token !== null && $member && !$member->validateAutoLoginToken($token)) {
115			$message = [
116			'Content' => DBField::create_field(
117			'HTMLFragment',
118			_t(
119			'SilverStripe\\Security\\Security.NOTERESETLINKINVALID',
120			'<p>The password reset link is invalid or expired.</p>'
121			. '<p>You can request a new one <a href="{link1}">here</a> or change your password after'
122			. ' you <a href="{link2}">logged in</a>.</p>',
123			[
124			'link1' => $this->link('lostpassword'),
125			'link2' => $this->link('login')
126			]
127			)
128			)
129			];
130
131			return [
132			'Content' => $message,
133			];
134			}
135
136			// Someone attempted to go to changepassword without token or being logged in
137			return Security::permissionFailure(
138			Controller::curr(),
139			_t(
140			'SilverStripe\\Security\\Security.ERRORPASSWORDPERMISSION',
141			'You must be logged in in order to change your password!'
142			)
143			);
144			}
145
146
147			/**
148			* @param Member $member
149			* @param string $token
150			*/
151			protected function setSessionToken($member, $token)
152			{
153			// if there is a current member, they should be logged out
154			if ($curMember = Security::getCurrentUser()) {
155			/** @var LogoutHandler $handler */
156			Injector::inst()->get(IdentityStore::class)->logOut();
157			}
158
159			// Store the hash for the change password form. Will be unset after reload within the ChangePasswordForm.
160			Session::set('AutoLoginHash', $member->encryptWithUserSettings($token));
161			}
162
163			/**
164			* Return a link to this request handler.
165			* The link returned is supplied in the constructor
166			* @param null $action
167			* @return string
168			*/
169			public function link($action = null)
170			{
171			if ($action) {
172			return Controller::join_links($this->link, $action);
173			}
174
175			return $this->link;
176			}
177
178			/**
179			* Factory method for the lost password form
180			*
181			* @skipUpgrade
182			* @return ChangePasswordForm Returns the lost password form
183			*/
184			public function changePasswordForm()
185			{
186			return ChangePasswordForm::create(
187			$this,
188			'ChangePasswordForm'
189			);
190			}
191
192			/**
193			* Change the password
194			*
195			* @param array $data The user submitted data
196			* @param ChangePasswordForm $form
197			* @return HTTPResponse
198			*/
199			public function doChangePassword(array $data, $form)
200			{
201			$member = Security::getCurrentUser();
202			// The user was logged in, check the current password
203			if ($member && (
204			empty($data['OldPassword']) \|\|
205			!$member->checkPassword($data['OldPassword'])->isValid()
206			)
207			) {
208			$form->sessionMessage(
209			_t(
210			'SilverStripe\\Security\\Member.ERRORPASSWORDNOTMATCH',
211			'Your current password does not match, please try again'
212			),
213			'bad'
214			);
215
216			// redirect back to the form, instead of using redirectBack() which could send the user elsewhere.
217			return $this->redirectBackToForm();
218			}
219
220			if (!$member) {
221			if (Session::get('AutoLoginHash')) {
222			$member = Member::member_from_autologinhash(Session::get('AutoLoginHash'));
223			}
224
225			// The user is not logged in and no valid auto login hash is available
226			if (!$member) {
227			Session::clear('AutoLoginHash');
228
229			return $this->redirect($this->addBackURLParam(Security::singleton()->Link('login')));
230			}
231			}
232
233			// Check the new password
234			if (empty($data['NewPassword1'])) {
235			$form->sessionMessage(
236			_t(
237			'SilverStripe\\Security\\Member.EMPTYNEWPASSWORD',
238			"The new password can't be empty, please try again"
239			),
240			'bad'
241			);
242
243			// redirect back to the form, instead of using redirectBack() which could send the user elsewhere.
244			return $this->redirectBackToForm();
245			}
246
247			// Fail if passwords do not match
248			if ($data['NewPassword1'] !== $data['NewPassword2']) {
249			$form->sessionMessage(
250			_t(
251			'SilverStripe\\Security\\Member.ERRORNEWPASSWORD',
252			'You have entered your new password differently, try again'
253			),
254			'bad'
255			);
256
257			// redirect back to the form, instead of using redirectBack() which could send the user elsewhere.
258			return $this->redirectBackToForm();
259			}
260
261			// Check if the new password is accepted
262			$validationResult = $member->changePassword($data['NewPassword1']);
263			if (!$validationResult->isValid()) {
264			$form->setSessionValidationResult($validationResult);
265
266			return $this->redirectBackToForm();
267			}
268
269			// Clear locked out status
270			$member->LockedOutUntil = null;
271			$member->FailedLoginCount = null;
272			// Clear the members login hashes
273			$member->AutoLoginHash = null;
274			$member->AutoLoginExpired = DBDatetime::create()->now();
275			$member->write();
276
277			if ($member->canLogIn()->isValid()) {
278			Injector::inst()->get(IdentityStore::class)->logIn($member, false, $this->getRequest());
279			}
280
281			// TODO Add confirmation message to login redirect
282			Session::clear('AutoLoginHash');
283
284			// Redirect to backurl
285			$backURL = $this->getBackURL();
286			if ($backURL) {
287			return $this->redirect($backURL);
288			}
289
290			// Redirect to default location - the login form saying "You are logged in as..."
291			$url = Security::singleton()->Link('login');
292
293			return $this->redirect($url);
294			}
295
296			/**
297			* Something went wrong, go back to the changepassword
298			*
299			* @return HTTPResponse
300			*/
301			public function redirectBackToForm()
302			{
303			// Redirect back to form
304			$url = $this->addBackURLParam(Security::singleton()->Link('changepassword'));
305
306			return $this->redirect($url);
307			}
308			}
309

silverstripe / silverstripe-framework

Pull Request — master (#7007)

ChangePasswordHandler::changepassword() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like