GatewayController::profile() - Code Metrics - Inspection of "Fixed profile page and routing" - quickapps/cms - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — 2.0 (#159)

unknown

created 2016-08-23 06:37 UTC

GatewayController::profile() B

↳ Parent: GatewayController

Complexity

Conditions	4
Paths	8

Size

Total Lines	24
Code Lines	15

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	1	Features	0

Metric	Value
cc	4
eloc	15
c	2
b	1
f	0
nc	8
nop	1
dl	0
loc	24
rs	8.6845

<?php
/**
 * Licensed under The GPL-3.0 License
 * For full copyright and license information, please see the LICENSE.txt
 * Redistributions of files must retain the above copyright notice.
 *
 * @since    2.0.0
 * @author   Christopher Castro <[email protected]>
 * @link     http://www.quickappscms.org
 * @license  http://opensource.org/licenses/gpl-3.0.html GPL-3.0 License
 */
namespace User\Controller;

use Locale\Utility\LocaleToolbox;
use User\Controller\AppController;
use User\Controller\UserSignTrait;
use User\Notification\NotificationManager;

/**
 * Gateway controller.
 *
 * Provides login and logout methods.
 *
 * @property \User\Model\Table\UsersTable $Users
 * @method bool touch(\Cake\ORM\Entity $entity, string $eventName)
 * @method void unbindFieldable()
 */
class GatewayController extends AppController
{

    use UserSignTrait;

    /**
     * Starts the password recovery process.
     *
     * @return void
     */
    public function forgot()
    {
        if (!empty($this->request->data['username'])) {
            $this->loadModel('User.Users');
            $user = $this->Users
                ->find()
                ->where(['Users.username' => $this->request->data['username']])
                ->orWhere(['Users.email' => $this->request->data['username']])
                ->first();

            if ($user) {
                $emailSent = NotificationManager::passwordRequest($user)->send();
                if ($emailSent) {
                    $this->Flash->success(__d('user', 'Further instructions have been sent to your e-mail address.'));
                } else {
                    $this->Flash->warning(__d('user', 'Instructions could not been sent to your e-mail address, please try again later.'));
                }
            } else {
                $this->Flash->danger(__d('user', 'Sorry, "{0}" is not recognized as a user name or an e-mail address.', $this->request->data['username']));
            }
        }

        $this->title(__d('user', 'Password Recovery'));
    }

    /**
     * Here is where users can request to remove their accounts.
     *
     * Only non-administrator users can be canceled this way. User may request to
     * cancel their accounts by using the form rendered by this action, an e-mail
     * will be send with a especial link which will remove the account.
     *
     * @return void Redirects to previous page
     */
    public function cancelRequest()
    {
        $user = user();

        $this->loadModel('User.Users');
        $user = $this->Users->get($user->id);
        $emailSent = NotificationManager::cancelRequest($user)->send();
        if ($emailSent) {
            $this->Flash->success(__d('user', 'Further instructions have been sent to your e-mail address.'));
        } else {
            $this->Flash->warning(__d('user', 'Instructions could not been sent to your e-mail address, please try again later.'));
        }

        $this->title(__d('user', 'Account Cancellation'));
        $this->redirect($this->referer());
    }

    /**
     * Here is where user's account is actually removed.
     *
     * @param int $userId The ID of the user whose account is being canceled
     * @param string $code Cancellation code, code is a MD5 hash of user's encrypted
     *  password + site's salt
     * @return void Redirects to previous page
     */
    public function cancel($userId, $code)
    {
        $this->loadModel('User.Users');
        $user = $this->Users
            ->find()
            ->where(['id' => $userId])
            ->contain(['Roles'])
            ->limit(1)
            ->first();

        if (in_array(ROLE_ID_ADMINISTRATOR, $user->role_ids) &&
            $this->Users->countAdministrators() === 1
        ) {
            $this->Flash->warning(__d('user', 'You are the last administrator in the system, your account cannot be canceled.'));
            $this->redirect($this->referer());
        }

        if ($user && $code == $user->cancel_code) {
            if ($this->Users->delete($user)) {
                NotificationManager::canceled($user)->send();
                $this->Flash->success(__d('user', 'Account successfully canceled'));
            } else {
                $this->Flash->danger(__d('user', 'Account could not be canceled due to an internal error, please try again later.'));
            }
        } else {
            $this->Flash->warning(__d('user', 'Not user was found, invalid cancellation URL.'));
        }

        $this->title(__d('user', 'Account Cancellation'));
        $this->redirect($this->referer());
    }

    /**
     * Registers a new user.
     *
     * @return void
     */
    public function register()
    {
        $this->loadModel('User.Users');
        $this->Users->unbindFieldable();
        $user = $this->Users->newEntity();
        $registered = false;
        $languages = LocaleToolbox::languagesList();

        if ($this->request->data()) {
            $user->set('status', 0);
            $user->accessible(['id', 'token', 'status', 'last_login', 'created', 'roles'], false);
            $user = $this->Users->patchEntity($user, $this->request->data);

            if ($this->Users->save($user)) {
                NotificationManager::welcome($user)->send();
                $this->Flash->success(__d('user', 'Account successfully created, further instructions have been sent to your e-mail address.', ['key' => 'register']));
                $registered = true;
            } else {
                $this->Flash->danger(__d('user', 'Account could not be created, please check your information.'), ['key' => 'register']);
            }
        }

        $this->title(__d('user', 'Registration'));
        $this->set(compact('registered', 'user', 'languages'));
    }

    /**
     * Users can request to re-send activation instructions to their email address.
     *
     * @return void
     */
    public function activationEmail()
    {
        $this->loadModel('User.Users');
        $sent = false;

        if (!empty($this->request->data['username'])) {
            $user = $this->Users
                ->find()
                ->where([
                    'OR' => [
                        'username' => $this->request->data['username'],
                        'email' => $this->request->data['username'],
                    ],
                    'status' => 0
                ])
                ->limit(1)
                ->first();

            if ($user) {
                NotificationManager::welcome($user)->send();
                $this->Flash->success(__d('user', 'Instructions have been sent to your e-mail address.'), ['key' => 'activation_email']);
                $sent = true;
            } else {
                $this->Flash->danger(__d('user', 'No account was found matching the given username/email.'), ['key' => 'activation_email']);
            }
        }

        $this->title(__d('user', 'Activation Request'));
        $this->set(compact('sent'));
    }

    /**
     * Activates a registered user.
     *
     * @param string $token A valid user token
     * @return void
     */
    public function activate($token = null)
    {
        $activated = false;
        if ($token === null) {
            $this->redirect('/');
        }

        $this->loadModel('User.Users');
        $user = $this->Users
            ->find()
            ->select(['id', 'name', 'token'])
            ->where(['status' => 0, 'token' => $token])
            ->limit(1)
            ->first();

        if ($user) {
            if ($this->Users->updateAll(['status' => 1], ['id' => $user->id])) {
                NotificationManager::activated($user)->send();
                $activated = true;
                $this->Flash->success(__d('user', 'Account successfully activated.'), ['key' => 'activate']);
            } else {
                $this->Flash->danger(__d('user', 'Account could not be activated, please try again later.'), ['key' => 'activate']);
            }
        } else {
            $this->Flash->warning(__d('user', 'Account not found or is already active.'), ['key' => 'activate']);
        }

        $this->title(__d('user', 'Account Activation'));
        $this->set(compact('activated', 'token'));
    }

    /**
     * Renders the "unauthorized" screen, when an user attempts to access
     * to a restricted area.
     *
     * @return \Cake\Network\Response|null
     */
    public function unauthorized()
    {
        $this->loadModel('User.Users');
        if ($this->request->is('post')) {
            $user = $this->Auth->identify();
            if ($user) {
                $this->Auth->setUser($user);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

                return $this->redirect($this->Auth->redirectUrl());
            } else {
                $this->Flash->danger(__d('user', 'Username or password is incorrect'));
            }
        }
    }

    /**
     * Renders user's "my profile" form.
     *
     * Here is where user can change their information.
     *
     * @return void
     */
    public function me()
    {
        $this->loadModel('User.Users');
        $user = $this->Users->get(user()->id, ['conditions' => ['status' => 1]]);
        $languages = LocaleToolbox::languagesList();

        if ($this->request->data()) {
            $user->accessible(['id', 'username', 'roles', 'status'], false);
            $user = $this->Users->patchEntity($user, $this->request->data);
            if ($this->Users->save($user)) {
                $this->Flash->success(__d('user', 'User information successfully updated!'), ['key' => 'user_profile']);
                $this->redirect($this->referer());
            } else {
                $this->Flash->danger(__d('user', 'User information could not be saved, please check your information.'), ['key' => 'user_profile']);
            }
        }

        $this->title(__d('user', 'Account'));
        $this->set(compact('user', 'languages'));
        $this->viewMode('full');
    }

    /**
     * Shows profile information for the given user.
     *
     * @param int $id User's ID
     * @return void
     * @throws \Cake\ORM\Exception\RecordNotFoundException When user not found, or
     *  users has marked profile as private
     */
    public function profile($id)
    {
        $this->loadModel('User.Users');

        if (!$id) {
            $id = user()->id;
        }
        $conditions = [];
        if ($id != user()->id) {
            $conditions = ['status' => 1, 'public_profile' => true];
        }
        //include user id in condition
        $conditions['id'] = $id;

        $user = $this->Users->find('all')->where($conditions)->first();

        if (empty($user)) {
            $this->Flash->danger(__d('account', 'Sorry profile doesn\'t exist or not available for public.'));
            $this->redirect($this->referer());
        }
        $this->title(__d('user', 'User’s Profile'));
        $this->viewMode('full');
        $this->set(compact('user'));
    }
}


1		<?php
2		/**
3		* Licensed under The GPL-3.0 License
4		* For full copyright and license information, please see the LICENSE.txt
5		* Redistributions of files must retain the above copyright notice.
6		*
7		* @since 2.0.0
8		* @author Christopher Castro <[email protected]>
9		* @link http://www.quickappscms.org
10		* @license http://opensource.org/licenses/gpl-3.0.html GPL-3.0 License
11		*/
12		namespace User\Controller;
13
14		use Locale\Utility\LocaleToolbox;
15		use User\Controller\AppController;
16		use User\Controller\UserSignTrait;
17		use User\Notification\NotificationManager;
18
19		/**
20		* Gateway controller.
21		*
22		* Provides login and logout methods.
23		*
24		* @property \User\Model\Table\UsersTable $Users
25		* @method bool touch(\Cake\ORM\Entity $entity, string $eventName)
26		* @method void unbindFieldable()
27		*/
28		class GatewayController extends AppController
29		{
30
31		use UserSignTrait;
32
33		/**
34		* Starts the password recovery process.
35		*
36		* @return void
37		*/
38		public function forgot()
39		{
40		if (!empty($this->request->data['username'])) {
41		$this->loadModel('User.Users');
42		$user = $this->Users
43		->find()
44		->where(['Users.username' => $this->request->data['username']])
45		->orWhere(['Users.email' => $this->request->data['username']])
46		->first();
47
48	View Code Duplication	if ($user) {
49		$emailSent = NotificationManager::passwordRequest($user)->send();
50		if ($emailSent) {
51		$this->Flash->success(__d('user', 'Further instructions have been sent to your e-mail address.'));
52		} else {
53		$this->Flash->warning(__d('user', 'Instructions could not been sent to your e-mail address, please try again later.'));
54		}
55		} else {
56		$this->Flash->danger(__d('user', 'Sorry, "{0}" is not recognized as a user name or an e-mail address.', $this->request->data['username']));
57		}
58		}
59
60		$this->title(__d('user', 'Password Recovery'));
61		}
62
63		/**
64		* Here is where users can request to remove their accounts.
65		*
66		* Only non-administrator users can be canceled this way. User may request to
67		* cancel their accounts by using the form rendered by this action, an e-mail
68		* will be send with a especial link which will remove the account.
69		*
70		* @return void Redirects to previous page
71		*/
72		public function cancelRequest()
73		{
74		$user = user();
75
76		$this->loadModel('User.Users');
77		$user = $this->Users->get($user->id);
78		$emailSent = NotificationManager::cancelRequest($user)->send();
79		if ($emailSent) {
80		$this->Flash->success(__d('user', 'Further instructions have been sent to your e-mail address.'));
81		} else {
82		$this->Flash->warning(__d('user', 'Instructions could not been sent to your e-mail address, please try again later.'));
83		}
84
85		$this->title(__d('user', 'Account Cancellation'));
86		$this->redirect($this->referer());
87		}
88
89		/**
90		* Here is where user's account is actually removed.
91		*
92		* @param int $userId The ID of the user whose account is being canceled
93		* @param string $code Cancellation code, code is a MD5 hash of user's encrypted
94		* password + site's salt
95		* @return void Redirects to previous page
96		*/
97		public function cancel($userId, $code)
98		{
99		$this->loadModel('User.Users');
100		$user = $this->Users
101		->find()
102		->where(['id' => $userId])
103		->contain(['Roles'])
104		->limit(1)
105		->first();
106
107		if (in_array(ROLE_ID_ADMINISTRATOR, $user->role_ids) &&
108		$this->Users->countAdministrators() === 1
109		) {
110		$this->Flash->warning(__d('user', 'You are the last administrator in the system, your account cannot be canceled.'));
111		$this->redirect($this->referer());
112		}
113
114	View Code Duplication	if ($user && $code == $user->cancel_code) {
115		if ($this->Users->delete($user)) {
116		NotificationManager::canceled($user)->send();
117		$this->Flash->success(__d('user', 'Account successfully canceled'));
118		} else {
119		$this->Flash->danger(__d('user', 'Account could not be canceled due to an internal error, please try again later.'));
120		}
121		} else {
122		$this->Flash->warning(__d('user', 'Not user was found, invalid cancellation URL.'));
123		}
124
125		$this->title(__d('user', 'Account Cancellation'));
126		$this->redirect($this->referer());
127		}
128
129		/**
130		* Registers a new user.
131		*
132		* @return void
133		*/
134		public function register()
135		{
136		$this->loadModel('User.Users');
137		$this->Users->unbindFieldable();
138		$user = $this->Users->newEntity();
139		$registered = false;
140		$languages = LocaleToolbox::languagesList();
141
142		if ($this->request->data()) {
143		$user->set('status', 0);
144		$user->accessible(['id', 'token', 'status', 'last_login', 'created', 'roles'], false);
145		$user = $this->Users->patchEntity($user, $this->request->data);
146
147	View Code Duplication	if ($this->Users->save($user)) {
148		NotificationManager::welcome($user)->send();
149		$this->Flash->success(__d('user', 'Account successfully created, further instructions have been sent to your e-mail address.', ['key' => 'register']));
150		$registered = true;
151		} else {
152		$this->Flash->danger(__d('user', 'Account could not be created, please check your information.'), ['key' => 'register']);
153		}
154		}
155
156		$this->title(__d('user', 'Registration'));
157		$this->set(compact('registered', 'user', 'languages'));
158		}
159
160		/**
161		* Users can request to re-send activation instructions to their email address.
162		*
163		* @return void
164		*/
165		public function activationEmail()
166		{
167		$this->loadModel('User.Users');
168		$sent = false;
169
170		if (!empty($this->request->data['username'])) {
171		$user = $this->Users
172		->find()
173		->where([
174		'OR' => [
175		'username' => $this->request->data['username'],
176		'email' => $this->request->data['username'],
177		],
178		'status' => 0
179		])
180		->limit(1)
181		->first();
182
183	View Code Duplication	if ($user) {
184		NotificationManager::welcome($user)->send();
185		$this->Flash->success(__d('user', 'Instructions have been sent to your e-mail address.'), ['key' => 'activation_email']);
186		$sent = true;
187		} else {
188		$this->Flash->danger(__d('user', 'No account was found matching the given username/email.'), ['key' => 'activation_email']);
189		}
190		}
191
192		$this->title(__d('user', 'Activation Request'));
193		$this->set(compact('sent'));
194		}
195
196		/**
197		* Activates a registered user.
198		*
199		* @param string $token A valid user token
200		* @return void
201		*/
202		public function activate($token = null)
203		{
204		$activated = false;
205		if ($token === null) {
206		$this->redirect('/');
207		}
208
209		$this->loadModel('User.Users');
210		$user = $this->Users
211		->find()
212		->select(['id', 'name', 'token'])
213		->where(['status' => 0, 'token' => $token])
214		->limit(1)
215		->first();
216
217		if ($user) {
218		if ($this->Users->updateAll(['status' => 1], ['id' => $user->id])) {
219		NotificationManager::activated($user)->send();
220		$activated = true;
221		$this->Flash->success(__d('user', 'Account successfully activated.'), ['key' => 'activate']);
222		} else {
223		$this->Flash->danger(__d('user', 'Account could not be activated, please try again later.'), ['key' => 'activate']);
224		}
225		} else {
226		$this->Flash->warning(__d('user', 'Account not found or is already active.'), ['key' => 'activate']);
227		}
228
229		$this->title(__d('user', 'Account Activation'));
230		$this->set(compact('activated', 'token'));
231		}
232
233		/**
234		* Renders the "unauthorized" screen, when an user attempts to access
235		* to a restricted area.
236		*
237		* @return \Cake\Network\Response\|null
238		*/
239		public function unauthorized()
240		{
241		$this->loadModel('User.Users');
242		if ($this->request->is('post')) {
243		$user = $this->Auth->identify();
244		if ($user) {
245		$this->Auth->setUser($user);
		0 ignored issues – show Bug introduced 2016-08-21 19:45 UTC by Report Bug Copy Issue Report It seems like `$user` defined by `$this->Auth->identify()` on line `243` can also be of type `boolean`; however, `Cake\Controller\Component\AuthComponent::setUser()` does only seem to accept `array\|object<ArrayAccess>`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
246
247		return $this->redirect($this->Auth->redirectUrl());
248		} else {
249		$this->Flash->danger(__d('user', 'Username or password is incorrect'));
250		}
251		}
252		}
253
254		/**
255		* Renders user's "my profile" form.
256		*
257		* Here is where user can change their information.
258		*
259		* @return void
260		*/
261		public function me()
262		{
263		$this->loadModel('User.Users');
264		$user = $this->Users->get(user()->id, ['conditions' => ['status' => 1]]);
265		$languages = LocaleToolbox::languagesList();
266
267	View Code Duplication	if ($this->request->data()) {
268		$user->accessible(['id', 'username', 'roles', 'status'], false);
269		$user = $this->Users->patchEntity($user, $this->request->data);
270		if ($this->Users->save($user)) {
271		$this->Flash->success(__d('user', 'User information successfully updated!'), ['key' => 'user_profile']);
272		$this->redirect($this->referer());
273		} else {
274		$this->Flash->danger(__d('user', 'User information could not be saved, please check your information.'), ['key' => 'user_profile']);
275		}
276		}
277
278		$this->title(__d('user', 'Account'));
279		$this->set(compact('user', 'languages'));
280		$this->viewMode('full');
281		}
282
283		/**
284		* Shows profile information for the given user.
285		*
286		* @param int $id User's ID
287		* @return void
288		* @throws \Cake\ORM\Exception\RecordNotFoundException When user not found, or
289		* users has marked profile as private
290		*/
291		public function profile($id)
292		{
293		$this->loadModel('User.Users');
294
295		if (!$id) {
296		$id = user()->id;
297		}
298		$conditions = [];
299		if ($id != user()->id) {
300		$conditions = ['status' => 1, 'public_profile' => true];
301		}
302		//include user id in condition
303		$conditions['id'] = $id;
304
305		$user = $this->Users->find('all')->where($conditions)->first();
306
307		if (empty($user)) {
308		$this->Flash->danger(__d('account', 'Sorry profile doesn\'t exist or not available for public.'));
309		$this->redirect($this->referer());
310		}
311		$this->title(__d('user', 'User’s Profile'));
312		$this->viewMode('full');
313		$this->set(compact('user'));
314		}
315		}
316

quickapps / cms

Pull Request — 2.0 (#159)

GatewayController::profile() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like