PhpManager.php 17.1 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11
<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

namespace yii\rbac;

use Yii;
use yii\base\Exception;
12 13
use yii\base\InvalidCallException;
use yii\base\InvalidParamException;
14 15

/**
16 17 18 19 20 21 22 23 24 25
 * PhpManager represents an authorization manager that stores authorization
 * information in terms of a PHP script file.
 *
 * The authorization data will be saved to and loaded from a file
 * specified by [[authFile]], which defaults to 'protected/data/rbac.php'.
 *
 * PhpManager is mainly suitable for authorization data that is not too big
 * (for example, the authorization data for a personal blog system).
 * Use [[DbManager]] for more complex authorization data.
 *
26
 * @property Item[] $items The authorization items of the specific type. This property is read-only.
27 28 29 30 31 32 33 34 35
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @author Alexander Kochetov <creocoder@gmail.com>
 * @since 2.0
 */
class PhpManager extends Manager
{
	/**
	 * @var string the path of the PHP script that contains the authorization data.
36 37
	 * This can be either a file path or a path alias to the file.
	 * Make sure this file is writable by the Web server process if the authorization needs to be changed online.
38 39
	 * @see loadFromFile()
	 * @see saveToFile()
40
	 */
41
	public $authFile = '@app/data/rbac.php';
42

Alexander Makarov committed
43 44 45
	private $_items = []; // itemName => item
	private $_children = []; // itemName, childName => child
	private $_assignments = []; // userId, itemName => assignment
46 47 48 49 50 51 52 53 54

	/**
	 * Initializes the application component.
	 * This method overrides parent implementation by loading the authorization data
	 * from PHP script.
	 */
	public function init()
	{
		parent::init();
55
		$this->authFile = Yii::getAlias($this->authFile);
56 57 58 59 60 61 62
		$this->load();
	}

	/**
	 * Performs access check for the specified user.
	 * @param mixed $userId the user ID. This can be either an integer or a string representing
	 * @param string $itemName the name of the operation that need access check
63
	 * the unique identifier of a user. See [[\yii\web\User::id]].
64
	 * @param array $params name-value pairs that would be passed to biz rules associated
65 66
	 * with the tasks and roles assigned to the user. A param with name 'userId' is added to
	 * this array, which holds the value of `$userId`.
67 68
	 * @return boolean whether the operations can be performed by the user.
	 */
Alexander Makarov committed
69
	public function checkAccess($userId, $itemName, $params = [])
70 71 72 73
	{
		if (!isset($this->_items[$itemName])) {
			return false;
		}
slavcodev committed
74
		/** @var Item $item */
75 76 77 78 79
		$item = $this->_items[$itemName];
		Yii::trace('Checking permission: ' . $item->getName(), __METHOD__);
		if (!isset($params['userId'])) {
			$params['userId'] = $userId;
		}
Qiang Xue committed
80
		if ($this->executeBizRule($item->bizRule, $params, $item->data)) {
81 82 83 84
			if (in_array($itemName, $this->defaultRoles)) {
				return true;
			}
			if (isset($this->_assignments[$userId][$itemName])) {
slavcodev committed
85
				/** @var Assignment $assignment */
86
				$assignment = $this->_assignments[$userId][$itemName];
Qiang Xue committed
87
				if ($this->executeBizRule($assignment->bizRule, $params, $assignment->data)) {
88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104
					return true;
				}
			}
			foreach ($this->_children as $parentName => $children) {
				if (isset($children[$itemName]) && $this->checkAccess($userId, $parentName, $params)) {
					return true;
				}
			}
		}
		return false;
	}

	/**
	 * Adds an item as a child of another item.
	 * @param string $itemName the parent item name
	 * @param string $childName the child item name
	 * @return boolean whether the item is added successfully
105 106
	 * @throws Exception if either parent or child doesn't exist.
	 * @throws InvalidCallException if item already has a child with $itemName or if a loop has been detected.
107 108 109 110 111 112
	 */
	public function addItemChild($itemName, $childName)
	{
		if (!isset($this->_items[$childName], $this->_items[$itemName])) {
			throw new Exception("Either '$itemName' or '$childName' does not exist.");
		}
slavcodev committed
113
		/** @var Item $child */
114
		$child = $this->_items[$childName];
slavcodev committed
115
		/** @var Item $item */
116
		$item = $this->_items[$itemName];
Qiang Xue committed
117
		$this->checkItemChildType($item->type, $child->type);
118
		if ($this->detectLoop($itemName, $childName)) {
119
			throw new InvalidCallException("Cannot add '$childName' as a child of '$itemName'. A loop has been detected.");
120 121
		}
		if (isset($this->_children[$itemName][$childName])) {
122
			throw new InvalidCallException("The item '$itemName' already has a child '$childName'.");
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159
		}
		$this->_children[$itemName][$childName] = $this->_items[$childName];
		return true;
	}

	/**
	 * Removes a child from its parent.
	 * Note, the child item is not deleted. Only the parent-child relationship is removed.
	 * @param string $itemName the parent item name
	 * @param string $childName the child item name
	 * @return boolean whether the removal is successful
	 */
	public function removeItemChild($itemName, $childName)
	{
		if (isset($this->_children[$itemName][$childName])) {
			unset($this->_children[$itemName][$childName]);
			return true;
		} else {
			return false;
		}
	}

	/**
	 * Returns a value indicating whether a child exists within a parent.
	 * @param string $itemName the parent item name
	 * @param string $childName the child item name
	 * @return boolean whether the child exists
	 */
	public function hasItemChild($itemName, $childName)
	{
		return isset($this->_children[$itemName][$childName]);
	}

	/**
	 * Returns the children of the specified item.
	 * @param mixed $names the parent item name. This can be either a string or an array.
	 * The latter represents a list of item names.
160
	 * @return Item[] all child items of the parent
161 162 163 164
	 */
	public function getItemChildren($names)
	{
		if (is_string($names)) {
Alexander Makarov committed
165
			return isset($this->_children[$names]) ? $this->_children[$names] : [];
166 167
		}

Alexander Makarov committed
168
		$children = [];
169 170 171 172 173 174 175 176 177 178
		foreach ($names as $name) {
			if (isset($this->_children[$name])) {
				$children = array_merge($children, $this->_children[$name]);
			}
		}
		return $children;
	}

	/**
	 * Assigns an authorization item to a user.
179
	 * @param mixed $userId the user ID (see [[\yii\web\User::id]])
180 181 182 183 184
	 * @param string $itemName the item name
	 * @param string $bizRule the business rule to be executed when [[checkAccess()]] is called
	 * for this particular authorization item.
	 * @param mixed $data additional data associated with this assignment
	 * @return Assignment the authorization assignment information.
185
	 * @throws InvalidParamException if the item does not exist or if the item has already been assigned to the user
186 187 188 189
	 */
	public function assign($userId, $itemName, $bizRule = null, $data = null)
	{
		if (!isset($this->_items[$itemName])) {
190
			throw new InvalidParamException("Unknown authorization item '$itemName'.");
191
		} elseif (isset($this->_assignments[$userId][$itemName])) {
192
			throw new InvalidParamException("Authorization item '$itemName' has already been assigned to user '$userId'.");
193
		} else {
Alexander Makarov committed
194
			return $this->_assignments[$userId][$itemName] = new Assignment([
Qiang Xue committed
195 196 197 198 199
				'manager' => $this,
				'userId' => $userId,
				'itemName' => $itemName,
				'bizRule' => $bizRule,
				'data' => $data,
Alexander Makarov committed
200
			]);
201 202 203 204 205
		}
	}

	/**
	 * Revokes an authorization assignment from a user.
206
	 * @param mixed $userId the user ID (see [[\yii\web\User::id]])
207 208 209 210 211 212 213 214 215 216 217 218 219
	 * @param string $itemName the item name
	 * @return boolean whether removal is successful
	 */
	public function revoke($userId, $itemName)
	{
		if (isset($this->_assignments[$userId][$itemName])) {
			unset($this->_assignments[$userId][$itemName]);
			return true;
		} else {
			return false;
		}
	}

220 221
	/**
	 * Revokes all authorization assignments from a user.
222
	 * @param mixed $userId the user ID (see [[\yii\web\User::id]])
223 224 225 226 227 228 229 230 231 232 233 234 235
	 * @return boolean whether removal is successful
	 */
	public function revokeAll($userId)
	{
		if (isset($this->_assignments[$userId]) && is_array($this->_assignments[$userId])) {
			foreach ($this->_assignments[$userId] as $itemName => $value)
				unset($this->_assignments[$userId][$itemName]);
			return true;
		} else {
			return false;
		}
	}

236 237
	/**
	 * Returns a value indicating whether the item has been assigned to the user.
238
	 * @param mixed $userId the user ID (see [[\yii\web\User::id]])
239 240 241 242 243 244 245 246 247 248
	 * @param string $itemName the item name
	 * @return boolean whether the item has been assigned to the user.
	 */
	public function isAssigned($userId, $itemName)
	{
		return isset($this->_assignments[$userId][$itemName]);
	}

	/**
	 * Returns the item assignment information.
249
	 * @param mixed $userId the user ID (see [[\yii\web\User::id]])
250 251 252 253 254 255 256 257 258 259 260
	 * @param string $itemName the item name
	 * @return Assignment the item assignment information. Null is returned if
	 * the item is not assigned to the user.
	 */
	public function getAssignment($userId, $itemName)
	{
		return isset($this->_assignments[$userId][$itemName]) ? $this->_assignments[$userId][$itemName] : null;
	}

	/**
	 * Returns the item assignments for the specified user.
261
	 * @param mixed $userId the user ID (see [[\yii\web\User::id]])
262
	 * @return Assignment[] the item assignment information for the user. An empty array will be
263 264 265 266
	 * returned if there is no item assigned to the user.
	 */
	public function getAssignments($userId)
	{
Alexander Makarov committed
267
		return isset($this->_assignments[$userId]) ? $this->_assignments[$userId] : [];
268 269 270 271 272 273 274 275
	}

	/**
	 * Returns the authorization items of the specific type and user.
	 * @param mixed $userId the user ID. Defaults to null, meaning returning all items even if
	 * they are not assigned to a user.
	 * @param integer $type the item type (0: operation, 1: task, 2: role). Defaults to null,
	 * meaning returning all items regardless of their type.
276
	 * @return Item[] the authorization items of the specific type.
277 278 279
	 */
	public function getItems($userId = null, $type = null)
	{
280
		if ($userId === null && $type === null) {
281 282
			return $this->_items;
		}
Alexander Makarov committed
283
		$items = [];
284 285
		if ($userId === null) {
			foreach ($this->_items as $name => $item) {
slavcodev committed
286
				/** @var Item $item */
Qiang Xue committed
287
				if ($item->type == $type) {
288 289 290 291 292
					$items[$name] = $item;
				}
			}
		} elseif (isset($this->_assignments[$userId])) {
			foreach ($this->_assignments[$userId] as $assignment) {
slavcodev committed
293
				/** @var Assignment $assignment */
Qiang Xue committed
294 295
				$name = $assignment->itemName;
				if (isset($this->_items[$name]) && ($type === null || $this->_items[$name]->type == $type)) {
296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322
					$items[$name] = $this->_items[$name];
				}
			}
		}
		return $items;
	}

	/**
	 * Creates an authorization item.
	 * An authorization item represents an action permission (e.g. creating a post).
	 * It has three types: operation, task and role.
	 * Authorization items form a hierarchy. Higher level items inheirt permissions representing
	 * by lower level items.
	 * @param string $name the item name. This must be a unique identifier.
	 * @param integer $type the item type (0: operation, 1: task, 2: role).
	 * @param string $description description of the item
	 * @param string $bizRule business rule associated with the item. This is a piece of
	 * PHP code that will be executed when [[checkAccess()]] is called for the item.
	 * @param mixed $data additional data associated with the item.
	 * @return Item the authorization item
	 * @throws Exception if an item with the same name already exists
	 */
	public function createItem($name, $type, $description = '', $bizRule = null, $data = null)
	{
		if (isset($this->_items[$name])) {
			throw new Exception('Unable to add an item whose name is the same as an existing item.');
		}
Alexander Makarov committed
323
		return $this->_items[$name] = new Item([
Qiang Xue committed
324 325 326 327 328 329
			'manager' => $this,
			'name' => $name,
			'type' => $type,
			'description' => $description,
			'bizRule' => $bizRule,
			'data' => $data,
Alexander Makarov committed
330
		]);
331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367
	}

	/**
	 * Removes the specified authorization item.
	 * @param string $name the name of the item to be removed
	 * @return boolean whether the item exists in the storage and has been removed
	 */
	public function removeItem($name)
	{
		if (isset($this->_items[$name])) {
			foreach ($this->_children as &$children) {
				unset($children[$name]);
			}
			foreach ($this->_assignments as &$assignments) {
				unset($assignments[$name]);
			}
			unset($this->_items[$name]);
			return true;
		} else {
			return false;
		}
	}

	/**
	 * Returns the authorization item with the specified name.
	 * @param string $name the name of the item
	 * @return Item the authorization item. Null if the item cannot be found.
	 */
	public function getItem($name)
	{
		return isset($this->_items[$name]) ? $this->_items[$name] : null;
	}

	/**
	 * Saves an authorization item to persistent storage.
	 * @param Item $item the item to be saved.
	 * @param string $oldName the old item name. If null, it means the item name is not changed.
368
	 * @throws InvalidParamException if an item with the same name already taken
369 370 371
	 */
	public function saveItem($item, $oldName = null)
	{
Alexander Makarov committed
372
		if ($oldName !== null && ($newName = $item->getName()) !== $oldName) { // name changed
373
			if (isset($this->_items[$newName])) {
374
				throw new InvalidParamException("Unable to change the item name. The name '$newName' is already used by another item.");
375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413
			}
			if (isset($this->_items[$oldName]) && $this->_items[$oldName] === $item) {
				unset($this->_items[$oldName]);
				$this->_items[$newName] = $item;
				if (isset($this->_children[$oldName])) {
					$this->_children[$newName] = $this->_children[$oldName];
					unset($this->_children[$oldName]);
				}
				foreach ($this->_children as &$children) {
					if (isset($children[$oldName])) {
						$children[$newName] = $children[$oldName];
						unset($children[$oldName]);
					}
				}
				foreach ($this->_assignments as &$assignments) {
					if (isset($assignments[$oldName])) {
						$assignments[$newName] = $assignments[$oldName];
						unset($assignments[$oldName]);
					}
				}
			}
		}
	}

	/**
	 * Saves the changes to an authorization assignment.
	 * @param Assignment $assignment the assignment that has been changed.
	 */
	public function saveAssignment($assignment)
	{
	}

	/**
	 * Saves authorization data into persistent storage.
	 * If any change is made to the authorization data, please make
	 * sure you call this method to save the changed data into persistent storage.
	 */
	public function save()
	{
Alexander Makarov committed
414
		$items = [];
415
		foreach ($this->_items as $name => $item) {
slavcodev committed
416
			/** @var Item $item */
Alexander Makarov committed
417
			$items[$name] = [
Qiang Xue committed
418 419 420 421
				'type' => $item->type,
				'description' => $item->description,
				'bizRule' => $item->bizRule,
				'data' => $item->data,
Alexander Makarov committed
422
			];
423 424
			if (isset($this->_children[$name])) {
				foreach ($this->_children[$name] as $child) {
slavcodev committed
425
					/** @var Item $child */
426 427 428 429 430 431 432
					$items[$name]['children'][] = $child->getName();
				}
			}
		}

		foreach ($this->_assignments as $userId => $assignments) {
			foreach ($assignments as $name => $assignment) {
slavcodev committed
433
				/** @var Assignment $assignment */
434
				if (isset($items[$name])) {
Alexander Makarov committed
435
					$items[$name]['assignments'][$userId] = [
Qiang Xue committed
436 437
						'bizRule' => $assignment->bizRule,
						'data' => $assignment->data,
Alexander Makarov committed
438
					];
439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455
				}
			}
		}

		$this->saveToFile($items, $this->authFile);
	}

	/**
	 * Loads authorization data.
	 */
	public function load()
	{
		$this->clearAll();

		$items = $this->loadFromFile($this->authFile);

		foreach ($items as $name => $item) {
Alexander Makarov committed
456
			$this->_items[$name] = new Item([
Qiang Xue committed
457 458 459 460 461 462
				'manager' => $this,
				'name' => $name,
				'type' => $item['type'],
				'description' => $item['description'],
				'bizRule' => $item['bizRule'],
				'data' => $item['data'],
Alexander Makarov committed
463
			]);
464 465 466 467 468 469 470 471 472 473 474 475
		}

		foreach ($items as $name => $item) {
			if (isset($item['children'])) {
				foreach ($item['children'] as $childName) {
					if (isset($this->_items[$childName])) {
						$this->_children[$name][$childName] = $this->_items[$childName];
					}
				}
			}
			if (isset($item['assignments'])) {
				foreach ($item['assignments'] as $userId => $assignment) {
Alexander Makarov committed
476
					$this->_assignments[$userId][$name] = new Assignment([
Qiang Xue committed
477 478 479 480 481
						'manager' => $this,
						'userId' => $userId,
						'itemName' => $name,
						'bizRule' => $assignment['bizRule'],
						'data' => $assignment['data'],
Alexander Makarov committed
482
					]);
resurtm committed
483
				}
484 485 486 487 488 489 490 491 492 493
			}
		}
	}

	/**
	 * Removes all authorization data.
	 */
	public function clearAll()
	{
		$this->clearAssignments();
Alexander Makarov committed
494 495
		$this->_children = [];
		$this->_items = [];
496 497 498 499 500 501 502
	}

	/**
	 * Removes all authorization assignments.
	 */
	public function clearAssignments()
	{
Alexander Makarov committed
503
		$this->_assignments = [];
504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520
	}

	/**
	 * Checks whether there is a loop in the authorization item hierarchy.
	 * @param string $itemName parent item name
	 * @param string $childName the name of the child item that is to be added to the hierarchy
	 * @return boolean whether a loop exists
	 */
	protected function detectLoop($itemName, $childName)
	{
		if ($childName === $itemName) {
			return true;
		}
		if (!isset($this->_children[$childName], $this->_items[$itemName])) {
			return false;
		}
		foreach ($this->_children[$childName] as $child) {
slavcodev committed
521
			/** @var Item $child */
522 523 524 525 526 527 528 529 530 531 532
			if ($this->detectLoop($itemName, $child->getName())) {
				return true;
			}
		}
		return false;
	}

	/**
	 * Loads the authorization data from a PHP script file.
	 * @param string $file the file path.
	 * @return array the authorization data
533
	 * @see saveToFile()
534 535 536 537 538 539
	 */
	protected function loadFromFile($file)
	{
		if (is_file($file)) {
			return require($file);
		} else {
Alexander Makarov committed
540
			return [];
541 542 543 544 545 546 547
		}
	}

	/**
	 * Saves the authorization data to a PHP script file.
	 * @param array $data the authorization data
	 * @param string $file the file path.
548
	 * @see loadFromFile()
549 550 551
	 */
	protected function saveToFile($data, $file)
	{
552
		file_put_contents($file, "<?php\nreturn " . var_export($data, true) . ";\n", LOCK_EX);
553 554
	}
}