PhpManager.php 16.7 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 26
 * 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.
 *
 * @property array $authItems The authorization items of the specific type.
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
	 * If not set, it will be using 'protected/data/rbac.php' as the data file.
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67
	 * Make sure this file is writable by the Web server process if the authorization
	 * needs to be changed.
	 * @see loadFromFile
	 * @see saveToFile
	 */
	public $authFile;

	private $_items = array(); // itemName => item
	private $_children = array(); // itemName, childName => child
	private $_assignments = array(); // userId, itemName => assignment

	/**
	 * Initializes the application component.
	 * This method overrides parent implementation by loading the authorization data
	 * from PHP script.
	 */
	public function init()
	{
		parent::init();
		if ($this->authFile === null) {
			$this->authFile = Yii::getAlias('@app/data/rbac') . '.php';
		}
		$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
	 * the unique identifier of a user. See [[User::id]].
	 * @param array $params name-value pairs that would be passed to biz rules associated
68 69
	 * 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`.
70 71 72 73 74 75 76
	 * @return boolean whether the operations can be performed by the user.
	 */
	public function checkAccess($userId, $itemName, $params = array())
	{
		if (!isset($this->_items[$itemName])) {
			return false;
		}
77
		/** @var $item Item */
78 79 80 81 82
		$item = $this->_items[$itemName];
		Yii::trace('Checking permission: ' . $item->getName(), __METHOD__);
		if (!isset($params['userId'])) {
			$params['userId'] = $userId;
		}
Qiang Xue committed
83
		if ($this->executeBizRule($item->bizRule, $params, $item->data)) {
84 85 86 87
			if (in_array($itemName, $this->defaultRoles)) {
				return true;
			}
			if (isset($this->_assignments[$userId][$itemName])) {
88
				/** @var $assignment Assignment */
89
				$assignment = $this->_assignments[$userId][$itemName];
Qiang Xue committed
90
				if ($this->executeBizRule($assignment->bizRule, $params, $assignment->data)) {
91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107
					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
108 109
	 * @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.
110 111 112 113 114 115
	 */
	public function addItemChild($itemName, $childName)
	{
		if (!isset($this->_items[$childName], $this->_items[$itemName])) {
			throw new Exception("Either '$itemName' or '$childName' does not exist.");
		}
116
		/** @var $child Item */
117
		$child = $this->_items[$childName];
118
		/** @var $item Item */
119
		$item = $this->_items[$itemName];
Qiang Xue committed
120
		$this->checkItemChildType($item->type, $child->type);
121
		if ($this->detectLoop($itemName, $childName)) {
122
			throw new InvalidCallException("Cannot add '$childName' as a child of '$itemName'. A loop has been detected.");
123 124
		}
		if (isset($this->_children[$itemName][$childName])) {
125
			throw new InvalidCallException("The item '$itemName' already has a child '$childName'.");
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 160 161 162
		}
		$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.
163
	 * @return Item[] all child items of the parent
164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187
	 */
	public function getItemChildren($names)
	{
		if (is_string($names)) {
			return isset($this->_children[$names]) ? $this->_children[$names] : array();
		}

		$children = array();
		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.
	 * @param mixed $userId the user ID (see [[User::id]])
	 * @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.
188
	 * @throws InvalidParamException if the item does not exist or if the item has already been assigned to the user
189 190 191 192
	 */
	public function assign($userId, $itemName, $bizRule = null, $data = null)
	{
		if (!isset($this->_items[$itemName])) {
193
			throw new InvalidParamException("Unknown authorization item '$itemName'.");
194
		} elseif (isset($this->_assignments[$userId][$itemName])) {
195
			throw new InvalidParamException("Authorization item '$itemName' has already been assigned to user '$userId'.");
196
		} else {
Qiang Xue committed
197 198 199 200 201 202 203
			return $this->_assignments[$userId][$itemName] = new Assignment(array(
				'manager' => $this,
				'userId' => $userId,
				'itemName' => $itemName,
				'bizRule' => $bizRule,
				'data' => $data,
			));
204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248
		}
	}

	/**
	 * Revokes an authorization assignment from a user.
	 * @param mixed $userId the user ID (see [[User::id]])
	 * @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;
		}
	}

	/**
	 * Returns a value indicating whether the item has been assigned to the user.
	 * @param mixed $userId the user ID (see [[User::id]])
	 * @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.
	 * @param mixed $userId the user ID (see [[User::id]])
	 * @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.
	 * @param mixed $userId the user ID (see [[User::id]])
249
	 * @return Assignment[] the item assignment information for the user. An empty array will be
250 251 252 253 254 255 256 257 258 259 260 261 262
	 * returned if there is no item assigned to the user.
	 */
	public function getAssignments($userId)
	{
		return isset($this->_assignments[$userId]) ? $this->_assignments[$userId] : array();
	}

	/**
	 * 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.
263
	 * @return Item[] the authorization items of the specific type.
264 265 266
	 */
	public function getItems($userId = null, $type = null)
	{
267
		if ($userId === null && $type === null) {
268 269 270 271 272
			return $this->_items;
		}
		$items = array();
		if ($userId === null) {
			foreach ($this->_items as $name => $item) {
273
				/** @var $item Item */
Qiang Xue committed
274
				if ($item->type == $type) {
275 276 277 278 279
					$items[$name] = $item;
				}
			}
		} elseif (isset($this->_assignments[$userId])) {
			foreach ($this->_assignments[$userId] as $assignment) {
280
				/** @var $assignment Assignment */
Qiang Xue committed
281 282
				$name = $assignment->itemName;
				if (isset($this->_items[$name]) && ($type === null || $this->_items[$name]->type == $type)) {
283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309
					$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.');
		}
Qiang Xue committed
310 311 312 313 314 315 316 317
		return $this->_items[$name] = new Item(array(
			'manager' => $this,
			'name' => $name,
			'type' => $type,
			'description' => $description,
			'bizRule' => $bizRule,
			'data' => $data,
		));
318 319 320 321 322 323 324 325 326 327 328 329 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
	}

	/**
	 * 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.
355
	 * @throws InvalidParamException if an item with the same name already taken
356 357 358
	 */
	public function saveItem($item, $oldName = null)
	{
Alexander Makarov committed
359
		if ($oldName !== null && ($newName = $item->getName()) !== $oldName) { // name changed
360
			if (isset($this->_items[$newName])) {
361
				throw new InvalidParamException("Unable to change the item name. The name '$newName' is already used by another item.");
362 363 364 365 366 367 368 369 370 371 372 373 374 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
			}
			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()
	{
		$items = array();
		foreach ($this->_items as $name => $item) {
403
			/** @var $item Item */
404
			$items[$name] = array(
Qiang Xue committed
405 406 407 408
				'type' => $item->type,
				'description' => $item->description,
				'bizRule' => $item->bizRule,
				'data' => $item->data,
409 410 411
			);
			if (isset($this->_children[$name])) {
				foreach ($this->_children[$name] as $child) {
412
					/** @var $child Item */
413 414 415 416 417 418 419
					$items[$name]['children'][] = $child->getName();
				}
			}
		}

		foreach ($this->_assignments as $userId => $assignments) {
			foreach ($assignments as $name => $assignment) {
420
				/** @var $assignment Assignment */
421 422
				if (isset($items[$name])) {
					$items[$name]['assignments'][$userId] = array(
Qiang Xue committed
423 424
						'bizRule' => $assignment->bizRule,
						'data' => $assignment->data,
425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442
					);
				}
			}
		}

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

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

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

		foreach ($items as $name => $item) {
Qiang Xue committed
443 444 445 446 447 448 449 450
			$this->_items[$name] = new Item(array(
				'manager' => $this,
				'name' => $name,
				'type' => $item['type'],
				'description' => $item['description'],
				'bizRule' => $item['bizRule'],
				'data' => $item['data'],
			));
451 452 453 454 455 456 457 458 459 460 461 462
		}

		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) {
Qiang Xue committed
463 464 465 466 467 468 469
					$this->_assignments[$userId][$name] = new Assignment(array(
						'manager' => $this,
						'userId' => $userId,
						'itemName' => $name,
						'bizRule' => $assignment['bizRule'],
						'data' => $assignment['data'],
					));
resurtm committed
470
				}
471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507
			}
		}
	}

	/**
	 * Removes all authorization data.
	 */
	public function clearAll()
	{
		$this->clearAssignments();
		$this->_children = array();
		$this->_items = array();
	}

	/**
	 * Removes all authorization assignments.
	 */
	public function clearAssignments()
	{
		$this->_assignments = array();
	}

	/**
	 * 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) {
508
			/** @var $child Item */
509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538
			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
	 * @see saveToFile
	 */
	protected function loadFromFile($file)
	{
		if (is_file($file)) {
			return require($file);
		} else {
			return array();
		}
	}

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