SaveOperation::control_permission() - Code Metrics - Inspection of "Brickrouge v3" - Icybee/module-users - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — brickrouge3 ( 23d6f2...241af5 )

by Olivier

created 2016-06-21 20:14 UTC

SaveOperation::control_permission() A

↳ Parent: SaveOperation

Complexity

Conditions	3
Paths	2

Size

Total Lines	11
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	11
rs	9.4285
cc	3
eloc	5
nc	2
nop	1

<?php

/*
 * This file is part of the Icybee package.
 *
 * (c) Olivier Laviale <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Icybee\Modules\Users\Operation;

use Brickrouge\Form;
use ICanBoogie\ErrorCollection;
use ICanBoogie\HTTP\Request;

use Icybee\Modules\Users\Module;
use Icybee\Modules\Users\User;
use Icybee\Modules\Users\UserModel;

/**
 * Create or update a user profile.
 *
 * @property-read UserModel $model
 * @property User $record User
 */
class SaveOperation extends \ICanBoogie\Module\Operation\SaveOperation
{
	protected function get_model()
	{
		return $this->module->model;
	}

	protected function lazy_get_properties()
	{
		$properties = parent::lazy_get_properties();
		$request = $this->request;

		unset($properties[User::PASSWORD_HASH]);

		if ($request[User::PASSWORD])
		{
			$properties[User::PASSWORD] = $request[User::PASSWORD];
		}

		if ($this->app->user->has_permission(Module::PERMISSION_ADMINISTER, $this->module))
		{
			#
			# roles - because roles are not in the properties we need to prepare them for the
			# model using the params.
			#

			$roles = [];

			if ($request[User::ROLES])
			{
				foreach ($request[User::ROLES] as $rid => $value)
				{
					$value = filter_var($value, FILTER_VALIDATE_BOOLEAN);

					if (!$value)
					{
						continue;
					}

					$roles[] = (int) $rid;
				}
			}

			$properties[User::ROLES] = $roles;

			#
			# restricted sites - because restricted sites are not in the properties we need to
			# prepare them for the model using the params.
			#

			$sites = [];

			if ($request[User::RESTRICTED_SITES])
			{
				foreach ($request[User::RESTRICTED_SITES] as $site_id => $value)
				{
					$value = filter_var($value, FILTER_VALIDATE_BOOLEAN);

					if (!$value)
					{
						continue;
					}

					$sites[] = (int) $site_id;
				}
			}

			$properties[User::RESTRICTED_SITES] = $sites;
		}
		else
		{
			unset($properties[User::IS_ACTIVATED]);
		}

		return $properties;
	}

	/**
	 * Returns the form from the `edit` block if the getter wasn't able to retrieve the form. This
	 * is currently used to create records using XHR.
	 */
	protected function lazy_get_form()
	{
		$form = parent::lazy_get_form();

		if ($form)
		{
			return $form;
		}

		$block = $this->module->getBlock('edit', $this->key);
		$block->render(); // FIXME-20160327: because form is populated on render

		return $block->element;
	}

	/**
	 * Permission is granted if the user is modifying its own profile, and has permission to.
	 *
	 * @inheritdoc
	 */
	protected function control_permission($permission = Module::PERMISSION_CREATE)
	{
		$user = $this->app->user;

		if ($user->uid == $this->key && $user->has_permission('modify own profile'))
		{
			return true;
		}

		return parent::control_permission($permission);
	}

	protected function control_ownership()
	{
		$user = $this->app->user;

		if ($user->uid == $this->key && $user->has_permission('modify own profile'))
		{
			// TODO-20110105: it this ok to set the user as a record here ?

			$this->record = $user;

			return true;
		}

		return parent::control_ownership();
	}

	/**
	 * The 'User' role (rid 2) is mandatory for every user.
	 *
	 * @inheritdoc
	 */
	protected function action(Request $request)
	{
		$request->params[User::ROLES][2] = 'on';

		return parent::action($request);
	}

	/**
	 * Validates the `password`, `username`, and `email` properties.
	 *
	 * @inheritdoc
	 */
	protected function validate(ErrorCollection $errors)
	{
		$request = $this->request;

		$this->validate_password($request, $errors);
		$this->validate_username($request, $errors);
		$this->validate_email($request, $errors);

		return parent::validate($errors);
	}

	/**
	 * Checks that the password matches password-verify.
	 *
	 * @param Request $request
	 * @param ErrorCollection $errors
	 */
	protected function validate_password(Request $request, ErrorCollection $errors)
	{
		$password = $request[User::PASSWORD];

		if (!$password)
		{
			return;
		}

		$password_verify = $request[User::PASSWORD_VERIFY];

		if (!$password_verify)
		{
			$errors->add(User::PASSWORD_VERIFY, "Password verify is empty.");

			return;
		}

		if ($password === $password_verify)
		{
			return;
		}

		$errors->add(User::PASSWORD_VERIFY, "Password and password verify don't match.");
	}

	/**
	 * Checks that the username is unique.
	 *
	 * @param Request $request
	 * @param ErrorCollection $errors
	 */
	protected function validate_username(Request $request, ErrorCollection $errors)
	{
		$username = $request[User::USERNAME];

		if (!$username)
		{
			return;
		}

		$uid = $this->key ?: 0;
		$used = $this->model->where('username = ? AND uid != ?', $username, $uid)->exists;

		if (!$used)
		{
			return;
		}

		$errors->add(User::USERNAME, "The user name %username is already used.", [

			'%username' => $username

		]);
	}

	/**
	 * Checks that the email is email.
	 *
	 * @param Request $request
	 * @param ErrorCollection $errors
	 */
	protected function validate_email(Request $request, ErrorCollection $errors)
	{
		$email = $request[User::EMAIL];

		if (!$email)
		{
			return;
		}

		$uid = $this->key ?: 0;
		$used = $this->model->where('email = ? AND uid != ?', $email, $uid)->exists;

		if (!$used)
		{
			return;
		}

		$errors->add(User::EMAIL, "The email address %email is already used.", [

			'%email' => $email

		]);
	}

	protected function process()
	{
		$previous_uid = $this->app->user_id;

		$rc = parent::process();

		if (!$previous_uid)
		{
			$this->response->message = $this->format("Your profile has been created.");
		}
		else if ($previous_uid == $rc['key'])
		{
			$this->response->message = $this->format($rc['mode'] == 'update' ? "Your profile has been updated." : "Your profile has been created.");
		}
		else
		{
			$record = $this->record;

			$this->response->message = $this->format($rc['mode'] == 'update' ? "%name's profile has been updated." : "%name's profile has been created.", [ 'name' => $record->name ]);
		}

		return $rc;
	}
}


1		<?php
2
3		/*
4		* This file is part of the Icybee package.
5		*
6		* (c) Olivier Laviale <[email protected]>
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*/
11
12		namespace Icybee\Modules\Users\Operation;
13
14		use Brickrouge\Form;
15		use ICanBoogie\ErrorCollection;
16		use ICanBoogie\HTTP\Request;
17
18		use Icybee\Modules\Users\Module;
19		use Icybee\Modules\Users\User;
20		use Icybee\Modules\Users\UserModel;
21
22		/**
23		* Create or update a user profile.
24		*
25		* @property-read UserModel $model
26		* @property User $record User
27		*/
28		class SaveOperation extends \ICanBoogie\Module\Operation\SaveOperation
29		{
30		protected function get_model()
31		{
32		return $this->module->model;
33		}
34
35		protected function lazy_get_properties()
36		{
37		$properties = parent::lazy_get_properties();
38		$request = $this->request;
39
40		unset($properties[User::PASSWORD_HASH]);
41
42		if ($request[User::PASSWORD])
43		{
44		$properties[User::PASSWORD] = $request[User::PASSWORD];
45		}
46
47		if ($this->app->user->has_permission(Module::PERMISSION_ADMINISTER, $this->module))
48		{
49		#
50		# roles - because roles are not in the properties we need to prepare them for the
51		# model using the params.
52		#
53
54		$roles = [];
55
56	View Code Duplication	if ($request[User::ROLES])
57		{
58		foreach ($request[User::ROLES] as $rid => $value)
59		{
60		$value = filter_var($value, FILTER_VALIDATE_BOOLEAN);
61
62		if (!$value)
63		{
64		continue;
65		}
66
67		$roles[] = (int) $rid;
68		}
69		}
70
71		$properties[User::ROLES] = $roles;
72
73		#
74		# restricted sites - because restricted sites are not in the properties we need to
75		# prepare them for the model using the params.
76		#
77
78		$sites = [];
79
80	View Code Duplication	if ($request[User::RESTRICTED_SITES])
81		{
82		foreach ($request[User::RESTRICTED_SITES] as $site_id => $value)
83		{
84		$value = filter_var($value, FILTER_VALIDATE_BOOLEAN);
85
86		if (!$value)
87		{
88		continue;
89		}
90
91		$sites[] = (int) $site_id;
92		}
93		}
94
95		$properties[User::RESTRICTED_SITES] = $sites;
96		}
97		else
98		{
99		unset($properties[User::IS_ACTIVATED]);
100		}
101
102		return $properties;
103		}
104
105		/**
106		* Returns the form from the `edit` block if the getter wasn't able to retrieve the form. This
107		* is currently used to create records using XHR.
108		*/
109		protected function lazy_get_form()
110		{
111		$form = parent::lazy_get_form();
112
113		if ($form)
114		{
115		return $form;
116		}
117
118		$block = $this->module->getBlock('edit', $this->key);
119		$block->render(); // FIXME-20160327: because form is populated on render
120
121		return $block->element;
122		}
123
124		/**
125		* Permission is granted if the user is modifying its own profile, and has permission to.
126		*
127		* @inheritdoc
128		*/
129		protected function control_permission($permission = Module::PERMISSION_CREATE)
130		{
131		$user = $this->app->user;
132
133		if ($user->uid == $this->key && $user->has_permission('modify own profile'))
134		{
135		return true;
136		}
137
138		return parent::control_permission($permission);
139		}
140
141		protected function control_ownership()
142		{
143		$user = $this->app->user;
144
145		if ($user->uid == $this->key && $user->has_permission('modify own profile'))
146		{
147		// TODO-20110105: it this ok to set the user as a record here ?
148
149		$this->record = $user;
150
151		return true;
152		}
153
154		return parent::control_ownership();
155		}
156
157		/**
158		* The 'User' role (rid 2) is mandatory for every user.
159		*
160		* @inheritdoc
161		*/
162		protected function action(Request $request)
163		{
164		$request->params[User::ROLES][2] = 'on';
165
166		return parent::action($request);
167		}
168
169		/**
170		* Validates the `password`, `username`, and `email` properties.
171		*
172		* @inheritdoc
173		*/
174		protected function validate(ErrorCollection $errors)
175		{
176		$request = $this->request;
177
178		$this->validate_password($request, $errors);
179		$this->validate_username($request, $errors);
180		$this->validate_email($request, $errors);
181
182		return parent::validate($errors);
183		}
184
185		/**
186		* Checks that the password matches password-verify.
187		*
188		* @param Request $request
189		* @param ErrorCollection $errors
190		*/
191		protected function validate_password(Request $request, ErrorCollection $errors)
192		{
193		$password = $request[User::PASSWORD];
194
195		if (!$password)
196		{
197		return;
198		}
199
200		$password_verify = $request[User::PASSWORD_VERIFY];
201
202		if (!$password_verify)
203		{
204		$errors->add(User::PASSWORD_VERIFY, "Password verify is empty.");
205
206		return;
207		}
208
209		if ($password === $password_verify)
210		{
211		return;
212		}
213
214		$errors->add(User::PASSWORD_VERIFY, "Password and password verify don't match.");
215		}
216
217		/**
218		* Checks that the username is unique.
219		*
220		* @param Request $request
221		* @param ErrorCollection $errors
222		*/
223	View Code Duplication	protected function validate_username(Request $request, ErrorCollection $errors)
224		{
225		$username = $request[User::USERNAME];
226
227		if (!$username)
228		{
229		return;
230		}
231
232		$uid = $this->key ?: 0;
233		$used = $this->model->where('username = ? AND uid != ?', $username, $uid)->exists;
234
235		if (!$used)
236		{
237		return;
238		}
239
240		$errors->add(User::USERNAME, "The user name %username is already used.", [
241
242		'%username' => $username
243
244		]);
245		}
246
247		/**
248		* Checks that the email is email.
249		*
250		* @param Request $request
251		* @param ErrorCollection $errors
252		*/
253	View Code Duplication	protected function validate_email(Request $request, ErrorCollection $errors)
254		{
255		$email = $request[User::EMAIL];
256
257		if (!$email)
258		{
259		return;
260		}
261
262		$uid = $this->key ?: 0;
263		$used = $this->model->where('email = ? AND uid != ?', $email, $uid)->exists;
264
265		if (!$used)
266		{
267		return;
268		}
269
270		$errors->add(User::EMAIL, "The email address %email is already used.", [
271
272		'%email' => $email
273
274		]);
275		}
276
277		protected function process()
278		{
279		$previous_uid = $this->app->user_id;
280
281		$rc = parent::process();
282
283		if (!$previous_uid)
284		{
285		$this->response->message = $this->format("Your profile has been created.");
286		}
287		else if ($previous_uid == $rc['key'])
288		{
289		$this->response->message = $this->format($rc['mode'] == 'update' ? "Your profile has been updated." : "Your profile has been created.");
290		}
291		else
292		{
293		$record = $this->record;
294
295		$this->response->message = $this->format($rc['mode'] == 'update' ? "%name's profile has been updated." : "%name's profile has been created.", [ 'name' => $record->name ]);
296		}
297
298		return $rc;
299		}
300		}
301

Icybee / module-users

Push — brickrouge3 ( 23d6f2...241af5 )

SaveOperation::control_permission() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like