UserController::actionPassword() - Code Metrics - Inspection of "add password commands." - rhosocial/yii2-user - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 12b291...43118d )

by vistart

created 2017-03-21 06:18 UTC

UserController::actionPassword() A

↳ Parent: UserController

Complexity

Conditions	2
Paths	2

Size

Total Lines	11
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	11
ccs	0
cts	8
cp	0
rs	9.4285
cc	2
eloc	8
nc	2
nop	2
crap	6

<?php

/**
 *  _   __ __ _____ _____ ___  ____  _____
 * | | / // // ___//_  _//   ||  __||_   _|
 * | |/ // /(__  )  / / / /| || |     | |
 * |___//_//____/  /_/ /_/ |_||_|     |_|
 * @link https://vistart.me/
 * @copyright Copyright (c) 2016 - 2017 vistart
 * @license https://vistart.me/license/
 */

namespace rhosocial\user\console\controllers;

use rhosocial\user\User;
use rhosocial\user\Profile;
use yii\console\Controller;
use yii\console\Exception;
use Yii;

/**
 * The simple operations associated with User.
 *
 * @version 1.0
 * @author vistart <[email protected]>
 */
class UserController extends Controller
{
    public $userClass;
    
    public $defaultAction = 'show';
    
    protected function checkUserClass()
    {
        $userClass = $this->userClass;
        if (!class_exists($userClass)) {
            throw new Exception('User Class Invalid.');
        }
        if (!((new $userClass()) instanceof User)) {
            throw new Exception('User Class(' . $userClass . ') does not inherited from `\rhosocial\user\User`.');
        }
        return $userClass;
    }
    
    /**
     * Get user from database.
     * @param User|string|integer $user
     * @return User
     */
    protected function getUser($user)
    {
        $userClass = $this->checkUserClass();
        if (is_numeric($user)) {
            $user = $userClass::find()->id($user)->one();
        } elseif (is_string($user) && strlen($user)) {
            $user = $userClass::find()->guid($user)->one();
        }
        if (!$user || $user->getIsNewRecord()) {
            throw new Exception('User Not Registered.');
        }
        return $user;
    }
    
    /**
     * Register new User.
     * @param string $password Password.
     * @param string $nickname If profile contains this property, this parameter is required.
     * @param string $firstName If profile contains this property, this parameter is required.
     * @param string $lastName If profile contains this propery, this parameter is required.
     */
    public function actionRegister($password, $nickname = null, $firstName = null, $lastName = null)
    {
        $userClass = $this->checkUserClass();
        
        $user = new $userClass(['password' => $password]);
        /* @var $user User */
        $profile = $user->createProfile([
            'nickname' => $nickname,
            'first_name' => $firstName,
            'last_name' => $lastName,
        ]);
        /* @var $profile Profile */
        try {
            is_null($profile) ? $user->register(): $user->register([$profile]);
        } catch (\Exception $ex) {
            throw new Exception($ex->getMessage());
        }
        echo "User Registered:\n";
        return $this->actionShow($user);
    }
    
    /**
     * Deregister user.
     * @param User|string|integer $user The user to be deregistered.
     * @return boolean
     */
    public function actionDeregister($user)
    {
        $user = $this->getUser($user);
        if ($user->deregister()) {
            echo "User (" . $user->getID() . ") Deregistered.\n";
            return true;
        }
        return false;
    }
    
    /**
     * Show User Information.
     * @param User|string|integer $user
     * @param boolean $guid
     * @param boolean $passHash
     * @param boolean $accessToken
     * @param boolean $authKey
     */
    public function actionShow($user, $guid = false, $passHash = false, $accessToken = false, $authKey = false)
    {
        $user = $this->getUser($user);
        echo Yii::t('app', 'User') . " (" . $user->getID() . "), " . Yii::t('app', 'registered at') . " (" . $user->getCreatedAt() . ")"
                . ($user->getCreatedAt() == $user->getUpdatedAt() ? "" : ", " . Yii::t('app', 'last updated at') . " (" . $user->getUpdatedAt() . ")") .".\n";
        if ($guid) {
            echo "GUID: " . $user->getGUID() . "\n";
        }
        if ($passHash) {
            echo "Password Hash: " . $user->{$user->passwordHashAttribute} . "\n";
        }
        if ($accessToken) {
            echo "Access Token: " . $user->getAccessToken() . "\n";
        }
        if ($authKey) {
            echo "Authentication Key: " . $user->getAuthKey() . "\n";
        }
        return true;
    }
    
    /**
     * Show statistics.
     * @param User|string|integer $user
     * @return boolean
     */
    public function actionStat($user = null)
    {
        if ($user === null) {
            $count = User::find()->count();
            echo "Total number of user(s): " . $count . "\n";
            if ($count == 0) {
                return true;
            }
            $last = User::find()->orderByCreatedAt(SORT_DESC)->one();
            /* @var $last User */
            echo "Latest user (" . $last->getID() . ") registered at " . $last->getCreatedAt() . "\n";
            return true;
        }
        $user = $this->getUser($user);
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        return true;
    }
    
    /**
     * Assign a role to user or revoke a role.
     * @param User|string|integer $user
     * @param string $operation Only `assign` and `revoke` are acceptable.
     * @param string $role
     */
    public function actionRole($user, $operation, $role)
    {
        $user = $this->getUser($user);
        $role = Yii::$app->authManager->getRole($role);
        if ($operation == 'assign') {
            try {
                $assignment = Yii::$app->authManager->assign($role, $user);
            } catch (\yii\db\IntegrityException $ex) {
                echo "Failed to assign `" . $role->name . "`.\n";
                echo "Maybe the role has been assigned.\n";
                return false;
            }
            if ($assignment) {
                echo "`$role->name`" . " assigned to User (" . $user->getID() . ") successfully.\n";
            } else {
                echo "Failed to assign `" . $role->name . "`.\n";
            }
            return true;
        }
        if ($operation == 'revoke') {
            $assignment = Yii::$app->authManager->revoke($role, $user);
            if ($assignment) {
                echo "`$role->name`" . " revoked from User (" . $user->getID() . ").\n";
            } else {
                echo "Failed to revoke `" . $role->name . "`.\n";
                echo "Maybe the role has not been assigned yet.\n";
            }
            return true;
        }
        echo "Unrecognized operation: $operation.\n";
        echo "The accepted operations are `assign` and `revoke`.\n";
        return false;
    }
    
    /**
     * Assign a permission to user or revoke a permission.
     * @param User|string|integer $user
     * @param string $operation Only `assign` and `revoke` are acceptable.
     * @param string $permission
     */
    public function actionPermission($user, $operation, $permission)
    {
        $user = $this->getUser($user);
        $permission = Yii::$app->authManager->getPermission($permission);
        if ($operation == 'assign') {
            try {
                $assignment = Yii::$app->authManager->assign($permission, $user);
            } catch (\yii\db\IntegrityException $ex) {
                echo "Failed to assign `" . $role->name . "`.\n";

                echo "Maybe the permission has been assigned.\n";
                return false;
            }
            if ($assignment) {
                echo "`$permission->name`" . " assigned to User (" . $user->getID() . ") successfully.\n";
            } else {
                echo "Failed to assign `" . $permission->name . "`.\n";
            }
            return true;
        }
        if ($operation == 'revoke') {
            $assignment = Yii::$app->authManager->revoke($permission, $user);
            if ($assignment) {
                echo "`$permission->name`" . " revoked from User (" . $user->getID() . ").\n";
            } else {
                echo "Failed to revoke `" . $permission->name . "`.\n";
                echo "Maybe the permission has not been assigned yet.\n";
            }
            return true;
        }
        echo "Unrecognized operation: $operation.\n";
        echo "The accepted operations are `assign` and `revoke`.\n";
        return false;
    }

    /**
     * Validate password.
     * @param User|string|integer $user
     * @param password $password
     */
    public function actionValidatePassword($user, $password)
    {
        $user = $this->getUser($user);
        $result = $user->validatePassword($password);
        if ($result) {
            echo "Correct.\n";
        } else {
            echo "Incorrect.\n";
        }
    }

    /**
     * Change password directly.
     * @param User|string|integer $user
     * @param string $password
     */
    public function actionPassword($user, $password)
    {
        $user = $this->getUser($user);
        $user->applyForNewPassword();
        $result = $user->resetPassword($password, $user->getPasswordResetToken());
        if ($result) {
            echo "Password changed.\n";
        } else {
            echo "Password not changed.\n";
        }
    }
}

1			<?php
2
3			/**
4			* _ __ __ _____ _____ ___ ____ _____
5			* \| \| / // // ___//_ _// \|\| __\|\|_ _\|
6			* \| \|/ // /(__ ) / / / /\| \|\| \| \| \|
7			* \|___//_//____/ /_/ /_/ \|_\|\|_\| \|_\|
8			* @link https://vistart.me/
9			* @copyright Copyright (c) 2016 - 2017 vistart
10			* @license https://vistart.me/license/
11			*/
12
13			namespace rhosocial\user\console\controllers;
14
15			use rhosocial\user\User;
16			use rhosocial\user\Profile;
17			use yii\console\Controller;
18			use yii\console\Exception;
19			use Yii;
20
21			/**
22			* The simple operations associated with User.
23			*
24			* @version 1.0
25			* @author vistart <[email protected]>
26			*/
27			class UserController extends Controller
28			{
29			public $userClass;
30
31			public $defaultAction = 'show';
32
33			protected function checkUserClass()
34			{
35			$userClass = $this->userClass;
36			if (!class_exists($userClass)) {
37			throw new Exception('User Class Invalid.');
38			}
39			if (!((new $userClass()) instanceof User)) {
40			throw new Exception('User Class(' . $userClass . ') does not inherited from `\rhosocial\user\User`.');
41			}
42			return $userClass;
43			}
44
45			/**
46			* Get user from database.
47			* @param User\|string\|integer $user
48			* @return User
49			*/
50			protected function getUser($user)
51			{
52			$userClass = $this->checkUserClass();
53			if (is_numeric($user)) {
54			$user = $userClass::find()->id($user)->one();
55			} elseif (is_string($user) && strlen($user)) {
56			$user = $userClass::find()->guid($user)->one();
57			}
58			if (!$user \|\| $user->getIsNewRecord()) {
59			throw new Exception('User Not Registered.');
60			}
61			return $user;
62			}
63
64			/**
65			* Register new User.
66			* @param string $password Password.
67			* @param string $nickname If profile contains this property, this parameter is required.
68			* @param string $firstName If profile contains this property, this parameter is required.
69			* @param string $lastName If profile contains this propery, this parameter is required.
70			*/
71			public function actionRegister($password, $nickname = null, $firstName = null, $lastName = null)
72			{
73			$userClass = $this->checkUserClass();
74
75			$user = new $userClass(['password' => $password]);
76			/* @var $user User */
77			$profile = $user->createProfile([
78			'nickname' => $nickname,
79			'first_name' => $firstName,
80			'last_name' => $lastName,
81			]);
82			/* @var $profile Profile */
83			try {
84			is_null($profile) ? $user->register(): $user->register([$profile]);
85			} catch (\Exception $ex) {
86			throw new Exception($ex->getMessage());
87			}
88			echo "User Registered:\n";
89			return $this->actionShow($user);
90			}
91
92			/**
93			* Deregister user.
94			* @param User\|string\|integer $user The user to be deregistered.
95			* @return boolean
96			*/
97			public function actionDeregister($user)
98			{
99			$user = $this->getUser($user);
100			if ($user->deregister()) {
101			echo "User (" . $user->getID() . ") Deregistered.\n";
102			return true;
103			}
104			return false;
105			}
106
107			/**
108			* Show User Information.
109			* @param User\|string\|integer $user
110			* @param boolean $guid
111			* @param boolean $passHash
112			* @param boolean $accessToken
113			* @param boolean $authKey
114			*/
115			public function actionShow($user, $guid = false, $passHash = false, $accessToken = false, $authKey = false)
116			{
117			$user = $this->getUser($user);
118			echo Yii::t('app', 'User') . " (" . $user->getID() . "), " . Yii::t('app', 'registered at') . " (" . $user->getCreatedAt() . ")"
119			. ($user->getCreatedAt() == $user->getUpdatedAt() ? "" : ", " . Yii::t('app', 'last updated at') . " (" . $user->getUpdatedAt() . ")") .".\n";
120			if ($guid) {
121			echo "GUID: " . $user->getGUID() . "\n";
122			}
123			if ($passHash) {
124			echo "Password Hash: " . $user->{$user->passwordHashAttribute} . "\n";
125			}
126			if ($accessToken) {
127			echo "Access Token: " . $user->getAccessToken() . "\n";
128			}
129			if ($authKey) {
130			echo "Authentication Key: " . $user->getAuthKey() . "\n";
131			}
132			return true;
133			}
134
135			/**
136			* Show statistics.
137			* @param User\|string\|integer $user
138			* @return boolean
139			*/
140			public function actionStat($user = null)
141			{
142			if ($user === null) {
143			$count = User::find()->count();
144			echo "Total number of user(s): " . $count . "\n";
145			if ($count == 0) {
146			return true;
147			}
148			$last = User::find()->orderByCreatedAt(SORT_DESC)->one();
149			/* @var $last User */
150			echo "Latest user (" . $last->getID() . ") registered at " . $last->getCreatedAt() . "\n";
151			return true;
152			}
153			$user = $this->getUser($user);
			0 ignored issues – show Unused Code introduced 2017-03-16 10:38 UTC by Report Bug Copy Issue Report `$user` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
154			return true;
155			}
156
157			/**
158			* Assign a role to user or revoke a role.
159			* @param User\|string\|integer $user
160			* @param string $operation Only `assign` and `revoke` are acceptable.
161			* @param string $role
162			*/
163			public function actionRole($user, $operation, $role)
164			{
165			$user = $this->getUser($user);
166			$role = Yii::$app->authManager->getRole($role);
167			if ($operation == 'assign') {
168			try {
169			$assignment = Yii::$app->authManager->assign($role, $user);
170			} catch (\yii\db\IntegrityException $ex) {
171			echo "Failed to assign `" . $role->name . "`.\n";
172			echo "Maybe the role has been assigned.\n";
173			return false;
174			}
175			if ($assignment) {
176			echo "`$role->name`" . " assigned to User (" . $user->getID() . ") successfully.\n";
177			} else {
178			echo "Failed to assign `" . $role->name . "`.\n";
179			}
180			return true;
181			}
182			if ($operation == 'revoke') {
183			$assignment = Yii::$app->authManager->revoke($role, $user);
184			if ($assignment) {
185			echo "`$role->name`" . " revoked from User (" . $user->getID() . ").\n";
186			} else {
187			echo "Failed to revoke `" . $role->name . "`.\n";
188			echo "Maybe the role has not been assigned yet.\n";
189			}
190			return true;
191			}
192			echo "Unrecognized operation: $operation.\n";
193			echo "The accepted operations are `assign` and `revoke`.\n";
194			return false;
195			}
196
197			/**
198			* Assign a permission to user or revoke a permission.
199			* @param User\|string\|integer $user
200			* @param string $operation Only `assign` and `revoke` are acceptable.
201			* @param string $permission
202			*/
203			public function actionPermission($user, $operation, $permission)
204			{
205			$user = $this->getUser($user);
206			$permission = Yii::$app->authManager->getPermission($permission);
207			if ($operation == 'assign') {
208			try {
209			$assignment = Yii::$app->authManager->assign($permission, $user);
210			} catch (\yii\db\IntegrityException $ex) {
211			echo "Failed to assign `" . $role->name . "`.\n";
			0 ignored issues – show Bug introduced 2017-03-17 11:01 UTC by Report Bug Copy Issue Report The variable `$role` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history...
212			echo "Maybe the permission has been assigned.\n";
213			return false;
214			}
215			if ($assignment) {
216			echo "`$permission->name`" . " assigned to User (" . $user->getID() . ") successfully.\n";
217			} else {
218			echo "Failed to assign `" . $permission->name . "`.\n";
219			}
220			return true;
221			}
222			if ($operation == 'revoke') {
223			$assignment = Yii::$app->authManager->revoke($permission, $user);
224			if ($assignment) {
225			echo "`$permission->name`" . " revoked from User (" . $user->getID() . ").\n";
226			} else {
227			echo "Failed to revoke `" . $permission->name . "`.\n";
228			echo "Maybe the permission has not been assigned yet.\n";
229			}
230			return true;
231			}
232			echo "Unrecognized operation: $operation.\n";
233			echo "The accepted operations are `assign` and `revoke`.\n";
234			return false;
235			}
236
237			/**
238			* Validate password.
239			* @param User\|string\|integer $user
240			* @param password $password
241			*/
242			public function actionValidatePassword($user, $password)
243			{
244			$user = $this->getUser($user);
245			$result = $user->validatePassword($password);
246			if ($result) {
247			echo "Correct.\n";
248			} else {
249			echo "Incorrect.\n";
250			}
251			}
252
253			/**
254			* Change password directly.
255			* @param User\|string\|integer $user
256			* @param string $password
257			*/
258			public function actionPassword($user, $password)
259			{
260			$user = $this->getUser($user);
261			$user->applyForNewPassword();
262			$result = $user->resetPassword($password, $user->getPasswordResetToken());
263			if ($result) {
264			echo "Password changed.\n";
265			} else {
266			echo "Password not changed.\n";
267			}
268			}
269			}

rhosocial / yii2-user

Push — master ( 12b291...43118d )

UserController::actionPassword() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like