SiteController::actionRequestPasswordReset() - Code Metrics - Inspection of "Refactored for tests codeception - (#2)" - terabytesoft/app-basic - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 2191f6...abcfc0 )

by Wilmer

created 2019-01-12 01:38 UTC

SiteController::actionRequestPasswordReset() A

↳ Parent: SiteController

Complexity

Conditions	4
Paths	3

Size

Total Lines	20
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	4
eloc	12
nc	3
nop	0
dl	0
loc	20
rs	9.8666
c	0
b	0
f	0

<?php

namespace app\basic\controllers;

use app\basic\forms\ContactForm;
use app\basic\forms\LoginForm;
use app\basic\forms\PasswordResetRequestForm;
use app\basic\forms\ResetPasswordForm;
use app\basic\forms\SignupForm;
use app\basic\models\UserModels;
use yii\captcha\CaptchaAction;
use yii\exceptions\InvalidArgumentException;
use yii\base\Model;
use yii\mail\MailerInterface;
use yii\web\BadRequestHttpException;
use yii\web\Controller;
use yii\web\ErrorAction;
use yii\web\Response;
use yii\web\filters\AccessControl;
use yii\web\filters\VerbFilter;

/**
 * SiteController is the controller Web Application Basic.
 **/
class SiteController extends Controller
{
    private $_User;

	/**
     * behaviors
     *
	 * @return array behaviors config.
	 **/
	public function behaviors()
	{
		return [
			'access' => [
				'__class' => AccessControl::class,
				'only' => ['logout'],
				'rules' => [
					[
						'actions' => ['logout'],
						'allow' => true,
						'roles' => ['@'],
					],
				],
			],
			'verbs' => [
				'__class' => VerbFilter::class,
				'actions' => [
					'logout' => ['POST'],
				],
			],
		];
	}

	/**
     * actions
     *
	 * @return array actions config.
	 **/
	public function actions()
	{
		return [
			'error' => [
				'__class' => ErrorAction::class,
			],
			'captcha' => [
				'__class' => CaptchaAction::class,
				'fixedVerifyCode' => (YII_ENV === 'test') ? 'testme' : null,
			],
		];
	}

	/**
     * actionIndex
	 * Displays homepage.
	 *
	 * @return string
	 **/
	public function actionIndex()
	{
		return $this->render('index');
	}

	/**
     * actionAbout
	 * Displays about page.
	 *
	 * @return string
	 **/
	public function actionAbout()
	{
		return $this->render('about');
	}

	/**
     * actionContact
	 * Displays contact page.
	 *
	 * @return Response|string
	 **/
	public function actionContact()
	{
        $model = new ContactForm();

		if ($model->load($this->app->request->post()) && $model->validate()) {
            $this->sendContact($this->app->params['adminEmail'], $model);
			$this->app->session->setFlash('contactFormSubmitted');
			return $this->refresh();
		}

		return $this->render('contact', [
			'model' => $model,
		]);
	}

	/**
     * actionSignup
	 * Signs user up.
	 *
	 * @return mixed
	 **/
	public function actionSignup()
	{
		$model = new SignupForm();

		if ($model->load($this->app->request->post())) {
			if ($this->_User = $model->signup()) {
				if ($this->app->getUser()->login($this->_User)) {
					return $this->goHome();
				}
			}
		}

		return $this->render('signup', [
			'model' => $model,
		]);
	}

	/**
     * actionLogin
	 * Login action.
	 *
	 * @return Response|string
	 **/
	public function actionLogin()
	{
		if (!$this->app->user->isGuest) {
			return $this->goHome();
		}

		$model = new LoginForm();

		if ($model->load($this->app->request->post()) && $model->validate()) {
            $this->login($model);
			return $this->goBack();
		}

		$model->password = '';

		return $this->render('login', [
			'model' => $model,
		]);
	}

	/**
     * actionLogout
	 * Logout action.
	 *
	 * @return Response
	 **/
	public function actionLogout()
	{
		$this->app->user->logout();

		return $this->goHome();
	}

	/**
     * actionRequestPasswordReset
	 * Requests password reset.
	 *
	 * @return mixed
	 **/
	public function actionRequestPasswordReset()
	{
		$model = new PasswordResetRequestForm();

		if ($model->load($this->app->request->post()) && $model->validate()) {
			if ($this->sendResetPassword($model)) {
				$this->app->session->setFlash(
                    'success',
                    $this->app->t('basic', 'Check your email for further instructions.')
                );
				return $this->goHome();
			}
			$this->app->session->setFlash(
                'error',
                $this->app->t('basic', 'Sorry, we are unable to reset password for the provided email address.')
            );
		}

		return $this->render('requestPasswordResetToken', [
			'model' => $model,
		]);
	}

	/**
     * actionResetPassword
	 * Resets password.
	 *
	 * @param string $token
	 * @return mixed
	 * @throws BadRequestHttpException
	 **/
	public function actionResetPassword(string $token)
	{
        try {
			$model = new ResetPasswordForm();
		} catch (InvalidArgumentException $e) {
			throw new BadRequestHttpException($e->getMessage());
		}

        $user = new UserModels();

		if (empty($token) || !is_string($token)) {
			$this->app->session->setFlash('danger', $this->app->t('basic', 'Password reset token cannot be blank.'));
			return $this->goHome();
		}
          
		if (!$user->findByPasswordResetToken($token, $this->app->params['user.passwordResetTokenExpire'])) {
			$this->app->session->setFlash('danger', $this->app->t('basic', 'Wrong password reset token.'));
			return $this->goHome();
		}

		if ($model->load($this->app->request->post()) && $model->validate() && $this->resetPassword($token, $model)) {
			$this->app->session->setFlash('success', $this->app->t('basic', 'New password saved.'));
			return $this->goHome();
		}

		return $this->render('resetPassword', [
			'model' => $model,
		]);
    }

	/**
     * login
	 * Logs in a user using the provided username and password.
     *
     * @param Model $model.
	 * @return bool whether the user is logged in successfully.
	 **/
	public function login(Model $model)
	{
		return $this->app->user->login($model->getUser(), $model->rememberMe ? 3600 * 24 * 30 : 0);
	}

	/**
     * resetPassword
	 * Resets password.
	 *
     * @param string $token.
     * @param Model $model.
	 * @return bool if password was reset.
	 **/
	public function resetPassword(string $token, Model $model)
	{
        $this->_User = new UserModels();
        $this->_User = $this->_User->findByPasswordResetToken(
			$token, 
			$this->app->params['user.passwordResetTokenExpire']
		);
		$this->_User->setPassword($model->password);
		$this->_User->removePasswordResetToken();

		return $this->_User->save(false);
	}	

    /**
     * sendContactForm
	 * Sends an email to the specified email address using the information collected by this model.
     *
	 * @param string $email the target email address.
     * @param Model $model.
	 * @return bool whether the model passes validation.
	 **/
	public function sendContact(string $email, Model $model)
	{
		$this->app->mailer->compose()
		    ->setTo($email)
			->setFrom([$model->email => $model->name])
			->setSubject($model->subject)
			->setTextBody($model->body)
			->send();
    }
    
	/**
     * sendResetPassword
	 * Sends an email with a link, for resetting the password.
     *
     * @param Model $model.
	 * @return bool whether the email was send.
	 **/
	public function sendResetPassword(Model $model)
	{
        $this->_User = new UserModels();

		$this->_User = $this->_User->findOne([
			'status' => $this->_User::STATUS_ACTIVE,
			'email' => $model->email,
		]);

		if (!$this->_User) {
			return false;
		}

		if (!$this->_User->isPasswordResetTokenValid(
            $this->_User->password_reset_token,
            $this->app->params['user.passwordResetTokenExpire']
        )) {
			$this->_User->generatePasswordResetToken();
			if (!$this->_User->save()) {
				return false;
			}
		}

        return $this->app->mailer->compose(
			['html' => 'passwordResetToken-html', 'text' => 'passwordResetToken-text'],
			['user' => $this->_User]
		)
		->setFrom(
			[
				$this->app->params['adminEmail'] => 
				$this->app->name . ' - ' . $this->app->t('basic', 'Automatic')
			]
		)
		->setTo($model->email)
		->setSubject($this->app->t('basic', 'Password reset for ') . $this->app->name)
		->send();
	}
}


1			<?php
2
3			namespace app\basic\controllers;
4
5			use app\basic\forms\ContactForm;
6			use app\basic\forms\LoginForm;
7			use app\basic\forms\PasswordResetRequestForm;
8			use app\basic\forms\ResetPasswordForm;
9			use app\basic\forms\SignupForm;
10			use app\basic\models\UserModels;
11			use yii\captcha\CaptchaAction;
12			use yii\exceptions\InvalidArgumentException;
13			use yii\base\Model;
14			use yii\mail\MailerInterface;
15			use yii\web\BadRequestHttpException;
16			use yii\web\Controller;
17			use yii\web\ErrorAction;
18			use yii\web\Response;
19			use yii\web\filters\AccessControl;
20			use yii\web\filters\VerbFilter;
21
22			/**
23			* SiteController is the controller Web Application Basic.
24			**/
25			class SiteController extends Controller
26			{
27			private $_User;
28
29			/**
30			* behaviors
31			*
32			* @return array behaviors config.
33			**/
34			public function behaviors()
35			{
36			return [
37			'access' => [
38			'__class' => AccessControl::class,
39			'only' => ['logout'],
40			'rules' => [
41			[
42			'actions' => ['logout'],
43			'allow' => true,
44			'roles' => ['@'],
45			],
46			],
47			],
48			'verbs' => [
49			'__class' => VerbFilter::class,
50			'actions' => [
51			'logout' => ['POST'],
52			],
53			],
54			];
55			}
56
57			/**
58			* actions
59			*
60			* @return array actions config.
61			**/
62			public function actions()
63			{
64			return [
65			'error' => [
66			'__class' => ErrorAction::class,
67			],
68			'captcha' => [
69			'__class' => CaptchaAction::class,
70			'fixedVerifyCode' => (YII_ENV === 'test') ? 'testme' : null,
71			],
72			];
73			}
74
75			/**
76			* actionIndex
77			* Displays homepage.
78			*
79			* @return string
80			**/
81			public function actionIndex()
82			{
83			return $this->render('index');
84			}
85
86			/**
87			* actionAbout
88			* Displays about page.
89			*
90			* @return string
91			**/
92			public function actionAbout()
93			{
94			return $this->render('about');
95			}
96
97			/**
98			* actionContact
99			* Displays contact page.
100			*
101			* @return Response\|string
102			**/
103			public function actionContact()
104			{
105			$model = new ContactForm();
106
107			if ($model->load($this->app->request->post()) && $model->validate()) {
108			$this->sendContact($this->app->params['adminEmail'], $model);
109			$this->app->session->setFlash('contactFormSubmitted');
110			return $this->refresh();
111			}
112
113			return $this->render('contact', [
114			'model' => $model,
115			]);
116			}
117
118			/**
119			* actionSignup
120			* Signs user up.
121			*
122			* @return mixed
123			**/
124			public function actionSignup()
125			{
126			$model = new SignupForm();
127
128			if ($model->load($this->app->request->post())) {
129			if ($this->_User = $model->signup()) {
130			if ($this->app->getUser()->login($this->_User)) {
131			return $this->goHome();
132			}
133			}
134			}
135
136			return $this->render('signup', [
137			'model' => $model,
138			]);
139			}
140
141			/**
142			* actionLogin
143			* Login action.
144			*
145			* @return Response\|string
146			**/
147			public function actionLogin()
148			{
149			if (!$this->app->user->isGuest) {
150			return $this->goHome();
151			}
152
153			$model = new LoginForm();
154
155			if ($model->load($this->app->request->post()) && $model->validate()) {
156			$this->login($model);
157			return $this->goBack();
158			}
159
160			$model->password = '';
161
162			return $this->render('login', [
163			'model' => $model,
164			]);
165			}
166
167			/**
168			* actionLogout
169			* Logout action.
170			*
171			* @return Response
172			**/
173			public function actionLogout()
174			{
175			$this->app->user->logout();
176
177			return $this->goHome();
178			}
179
180			/**
181			* actionRequestPasswordReset
182			* Requests password reset.
183			*
184			* @return mixed
185			**/
186			public function actionRequestPasswordReset()
187			{
188			$model = new PasswordResetRequestForm();
189
190			if ($model->load($this->app->request->post()) && $model->validate()) {
191			if ($this->sendResetPassword($model)) {
192			$this->app->session->setFlash(
193			'success',
194			$this->app->t('basic', 'Check your email for further instructions.')
195			);
196			return $this->goHome();
197			}
198			$this->app->session->setFlash(
199			'error',
200			$this->app->t('basic', 'Sorry, we are unable to reset password for the provided email address.')
201			);
202			}
203
204			return $this->render('requestPasswordResetToken', [
205			'model' => $model,
206			]);
207			}
208
209			/**
210			* actionResetPassword
211			* Resets password.
212			*
213			* @param string $token
214			* @return mixed
215			* @throws BadRequestHttpException
216			**/
217			public function actionResetPassword(string $token)
218			{
219			try {
220			$model = new ResetPasswordForm();
221			} catch (InvalidArgumentException $e) {
222			throw new BadRequestHttpException($e->getMessage());
223			}
224
225			$user = new UserModels();
226
227			if (empty($token) \|\| !is_string($token)) {
228			$this->app->session->setFlash('danger', $this->app->t('basic', 'Password reset token cannot be blank.'));
229			return $this->goHome();
230			}
231
232			if (!$user->findByPasswordResetToken($token, $this->app->params['user.passwordResetTokenExpire'])) {
233			$this->app->session->setFlash('danger', $this->app->t('basic', 'Wrong password reset token.'));
234			return $this->goHome();
235			}
236
237			if ($model->load($this->app->request->post()) && $model->validate() && $this->resetPassword($token, $model)) {
238			$this->app->session->setFlash('success', $this->app->t('basic', 'New password saved.'));
239			return $this->goHome();
240			}
241
242			return $this->render('resetPassword', [
243			'model' => $model,
244			]);
245			}
246
247			/**
248			* login
249			* Logs in a user using the provided username and password.
250			*
251			* @param Model $model.
252			* @return bool whether the user is logged in successfully.
253			**/
254			public function login(Model $model)
255			{
256			return $this->app->user->login($model->getUser(), $model->rememberMe ? 3600 * 24 * 30 : 0);
257			}
258
259			/**
260			* resetPassword
261			* Resets password.
262			*
263			* @param string $token.
264			* @param Model $model.
265			* @return bool if password was reset.
266			**/
267			public function resetPassword(string $token, Model $model)
268			{
269			$this->_User = new UserModels();
270			$this->_User = $this->_User->findByPasswordResetToken(
271			$token,
272			$this->app->params['user.passwordResetTokenExpire']
273			);
274			$this->_User->setPassword($model->password);
275			$this->_User->removePasswordResetToken();
276
277			return $this->_User->save(false);
278			}
279
280			/**
281			* sendContactForm
282			* Sends an email to the specified email address using the information collected by this model.
283			*
284			* @param string $email the target email address.
285			* @param Model $model.
286			* @return bool whether the model passes validation.
287			**/
288			public function sendContact(string $email, Model $model)
289			{
290			$this->app->mailer->compose()
291			->setTo($email)
292			->setFrom([$model->email => $model->name])
293			->setSubject($model->subject)
294			->setTextBody($model->body)
295			->send();
296			}
297
298			/**
299			* sendResetPassword
300			* Sends an email with a link, for resetting the password.
301			*
302			* @param Model $model.
303			* @return bool whether the email was send.
304			**/
305			public function sendResetPassword(Model $model)
306			{
307			$this->_User = new UserModels();
308
309			$this->_User = $this->_User->findOne([
310			'status' => $this->_User::STATUS_ACTIVE,
311			'email' => $model->email,
312			]);
313
314			if (!$this->_User) {
315			return false;
316			}
317
318			if (!$this->_User->isPasswordResetTokenValid(
319			$this->_User->password_reset_token,
320			$this->app->params['user.passwordResetTokenExpire']
321			)) {
322			$this->_User->generatePasswordResetToken();
323			if (!$this->_User->save()) {
324			return false;
325			}
326			}
327
328			return $this->app->mailer->compose(
329			['html' => 'passwordResetToken-html', 'text' => 'passwordResetToken-text'],
330			['user' => $this->_User]
331			)
332			->setFrom(
333			[
334			$this->app->params['adminEmail'] =>
335			$this->app->name . ' - ' . $this->app->t('basic', 'Automatic')
336			]
337			)
338			->setTo($model->email)
339			->setSubject($this->app->t('basic', 'Password reset for ') . $this->app->name)
340			->send();
341			}
342			}
343

terabytesoft / app-basic

Push — master ( 2191f6...abcfc0 )

SiteController::actionRequestPasswordReset() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like