DbManager.php 22.3 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12
<?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\db\Connection;
use yii\db\Query;
13
use yii\db\Expression;
14
use yii\base\Exception;
15
use yii\base\InvalidCallException;
16
use yii\base\InvalidParamException;
17
use yii\di\Instance;
18 19

/**
20 21 22 23 24 25 26
 * DbManager represents an authorization manager that stores authorization information in database.
 *
 * The database connection is specified by [[db]]. And the database schema
 * should be as described in "framework/rbac/*.sql". You may change the names of
 * the three tables used to store the authorization data by setting [[itemTable]],
 * [[itemChildTable]] and [[assignmentTable]].
 *
27 28
 * @property Item[] $items The authorization items of the specific type. This property is read-only.
 *
29 30 31 32 33 34
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @author Alexander Kochetov <creocoder@gmail.com>
 * @since 2.0
 */
class DbManager extends Manager
{
35 36 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
    /**
     * @var Connection|string the DB connection object or the application component ID of the DB connection.
     * After the DbManager object is created, if you want to change this property, you should only assign it
     * with a DB connection object.
     */
    public $db = 'db';
    /**
     * @var string the name of the table storing authorization items. Defaults to 'tbl_auth_item'.
     */
    public $itemTable = '{{%auth_item}}';
    /**
     * @var string the name of the table storing authorization item hierarchy. Defaults to 'tbl_auth_item_child'.
     */
    public $itemChildTable = '{{%auth_item_child}}';
    /**
     * @var string the name of the table storing authorization item assignments. Defaults to 'tbl_auth_assignment'.
     */
    public $assignmentTable = '{{%auth_assignment}}';

    private $_usingSqlite;

    /**
     * Initializes the application component.
     * This method overrides the parent implementation by establishing the database connection.
     */
    public function init()
    {
        parent::init();
63 64
        $this->db = Instance::ensure($this->db, Connection::className());
        $this->_usingSqlite = !strncmp($this->db->getDriverName(), 'sqlite', 6);
65 66 67 68
    }

    /**
     * Performs access check for the specified user.
69 70 71 72 73 74
     * @param mixed $userId the user ID. This should can be either an integer or a string representing
     * the unique identifier of a user. See [[\yii\web\User::id]].
     * @param string $itemName the name of the operation that need access check
     * @param array $params name-value pairs that would be passed to biz rules associated
     * 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`.
75 76 77 78 79 80 81 82 83 84 85 86
     * @return boolean whether the operations can be performed by the user.
     */
    public function checkAccess($userId, $itemName, $params = [])
    {
        $assignments = $this->getAssignments($userId);

        return $this->checkAccessRecursive($userId, $itemName, $params, $assignments);
    }

    /**
     * Performs access check for the specified user.
     * This method is internally called by [[checkAccess()]].
87 88 89 90 91 92 93 94
     * @param mixed $userId the user ID. This should can be either an integer or a string representing
     * the unique identifier of a user. See [[\yii\web\User::id]].
     * @param string $itemName the name of the operation that need access check
     * @param array $params name-value pairs that would be passed to biz rules associated
     * 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`.
     * @param Assignment[] $assignments the assignments to the specified user
     * @return boolean whether the operations can be performed by the user.
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132
     */
    protected function checkAccessRecursive($userId, $itemName, $params, $assignments)
    {
        if (($item = $this->getItem($itemName)) === null) {
            return false;
        }
        Yii::trace('Checking permission: ' . $item->getName(), __METHOD__);
        if (!isset($params['userId'])) {
            $params['userId'] = $userId;
        }
        if ($this->executeBizRule($item->bizRule, $params, $item->data)) {
            if (in_array($itemName, $this->defaultRoles)) {
                return true;
            }
            if (isset($assignments[$itemName])) {
                $assignment = $assignments[$itemName];
                if ($this->executeBizRule($assignment->bizRule, $params, $assignment->data)) {
                    return true;
                }
            }
            $query = new Query;
            $parents = $query->select(['parent'])
                ->from($this->itemChildTable)
                ->where(['child' => $itemName])
                ->createCommand($this->db)
                ->queryColumn();
            foreach ($parents as $parent) {
                if ($this->checkAccessRecursive($userId, $parent, $params, $assignments)) {
                    return true;
                }
            }
        }

        return false;
    }

    /**
     * Adds an item as a child of another item.
133 134 135 136
     * @param string $itemName the parent item name
     * @param string $childName the child item name
     * @return boolean whether the item is added successfully
     * @throws Exception if either parent or child doesn't exist.
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 163 164 165 166 167 168 169 170 171 172 173
     * @throws InvalidCallException if a loop has been detected.
     */
    public function addItemChild($itemName, $childName)
    {
        if ($itemName === $childName) {
            throw new Exception("Cannot add '$itemName' as a child of itself.");
        }
        $query = new Query;
        $rows = $query->from($this->itemTable)
            ->where(['or', 'name=:name1', 'name=:name2'], [':name1' => $itemName, ':name2' => $childName])
            ->createCommand($this->db)
            ->queryAll();
        if (count($rows) == 2) {
            if ($rows[0]['name'] === $itemName) {
                $parentType = $rows[0]['type'];
                $childType = $rows[1]['type'];
            } else {
                $childType = $rows[0]['type'];
                $parentType = $rows[1]['type'];
            }
            $this->checkItemChildType($parentType, $childType);
            if ($this->detectLoop($itemName, $childName)) {
                throw new InvalidCallException("Cannot add '$childName' as a child of '$itemName'. A loop has been detected.");
            }
            $this->db->createCommand()
                ->insert($this->itemChildTable, ['parent' => $itemName, 'child' => $childName])
                ->execute();

            return true;
        } else {
            throw new Exception("Either '$itemName' or '$childName' does not exist.");
        }
    }

    /**
     * Removes a child from its parent.
     * Note, the child item is not deleted. Only the parent-child relationship is removed.
174 175
     * @param string $itemName the parent item name
     * @param string $childName the child item name
176 177 178 179 180 181 182 183 184 185 186
     * @return boolean whether the removal is successful
     */
    public function removeItemChild($itemName, $childName)
    {
        return $this->db->createCommand()
            ->delete($this->itemChildTable, ['parent' => $itemName, 'child' => $childName])
            ->execute() > 0;
    }

    /**
     * Returns a value indicating whether a child exists within a parent.
187 188
     * @param string $itemName the parent item name
     * @param string $childName the child item name
189 190 191 192 193 194 195 196 197 198 199 200 201 202 203
     * @return boolean whether the child exists
     */
    public function hasItemChild($itemName, $childName)
    {
        $query = new Query;

        return $query->select(['parent'])
            ->from($this->itemChildTable)
            ->where(['parent' => $itemName, 'child' => $childName])
            ->createCommand($this->db)
            ->queryScalar() !== false;
    }

    /**
     * Returns the children of the specified item.
204 205
     * @param mixed $names the parent item name. This can be either a string or an array.
     * The latter represents a list of item names.
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
     * @return Item[] all child items of the parent
     */
    public function getItemChildren($names)
    {
        $query = new Query;
        $rows = $query->select(['name', 'type', 'description', 'biz_rule', 'data'])
            ->from([$this->itemTable, $this->itemChildTable])
            ->where(['parent' => $names, 'name' => new Expression('child')])
            ->createCommand($this->db)
            ->queryAll();
        $children = [];
        foreach ($rows as $row) {
            if (!isset($row['data']) || ($data = @unserialize($row['data'])) === false) {
                $data = null;
            }
            $children[$row['name']] = new Item([
                'manager' => $this,
                'name' => $row['name'],
                'type' => $row['type'],
                'description' => $row['description'],
                'bizRule' => $row['biz_rule'],
                'data' => $data,
            ]);
        }

        return $children;
    }

    /**
     * Assigns an authorization item to a user.
236 237 238 239 240 241
     * @param mixed $userId the user ID (see [[\yii\web\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.
242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268
     * @throws InvalidParamException if the item does not exist or if the item has already been assigned to the user
     */
    public function assign($userId, $itemName, $bizRule = null, $data = null)
    {
        if ($this->usingSqlite() && $this->getItem($itemName) === null) {
            throw new InvalidParamException("The item '$itemName' does not exist.");
        }
        $this->db->createCommand()
            ->insert($this->assignmentTable, [
                'user_id' => $userId,
                'item_name' => $itemName,
                'biz_rule' => $bizRule,
                'data' => $data === null ? null : serialize($data),
            ])
            ->execute();

        return new Assignment([
            'manager' => $this,
            'userId' => $userId,
            'itemName' => $itemName,
            'bizRule' => $bizRule,
            'data' => $data,
        ]);
    }

    /**
     * Revokes an authorization assignment from a user.
269 270
     * @param mixed $userId the user ID (see [[\yii\web\User::id]])
     * @param string $itemName the item name
271 272 273 274 275 276 277 278 279 280 281
     * @return boolean whether removal is successful
     */
    public function revoke($userId, $itemName)
    {
        return $this->db->createCommand()
            ->delete($this->assignmentTable, ['user_id' => $userId, 'item_name' => $itemName])
            ->execute() > 0;
    }

    /**
     * Revokes all authorization assignments from a user.
282
     * @param mixed $userId the user ID (see [[\yii\web\User::id]])
283 284 285 286 287 288 289 290 291 292 293
     * @return boolean whether removal is successful
     */
    public function revokeAll($userId)
    {
        return $this->db->createCommand()
                        ->delete($this->assignmentTable, ['user_id' => $userId])
                        ->execute() > 0;
    }

    /**
     * Returns a value indicating whether the item has been assigned to the user.
294 295
     * @param mixed $userId the user ID (see [[\yii\web\User::id]])
     * @param string $itemName the item name
296 297 298 299 300 301 302 303 304 305 306 307 308 309 310
     * @return boolean whether the item has been assigned to the user.
     */
    public function isAssigned($userId, $itemName)
    {
        $query = new Query;

        return $query->select(['item_name'])
            ->from($this->assignmentTable)
            ->where(['user_id' => $userId, 'item_name' => $itemName])
            ->createCommand($this->db)
            ->queryScalar() !== false;
    }

    /**
     * Returns the item assignment information.
311 312
     * @param mixed $userId the user ID (see [[\yii\web\User::id]])
     * @param string $itemName the item name
313
     * @return Assignment the item assignment information. Null is returned if
314
     * the item is not assigned to the user.
315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341
     */
    public function getAssignment($userId, $itemName)
    {
        $query = new Query;
        $row = $query->from($this->assignmentTable)
            ->where(['user_id' => $userId, 'item_name' => $itemName])
            ->createCommand($this->db)
            ->queryOne();
        if ($row !== false) {
            if (!isset($row['data']) || ($data = @unserialize($row['data'])) === false) {
                $data = null;
            }

            return new Assignment([
                'manager' => $this,
                'userId' => $row['user_id'],
                'itemName' => $row['item_name'],
                'bizRule' => $row['biz_rule'],
                'data' => $data,
            ]);
        } else {
            return null;
        }
    }

    /**
     * Returns the item assignments for the specified user.
342
     * @param mixed $userId the user ID (see [[\yii\web\User::id]])
343
     * @return Assignment[] the item assignment information for the user. An empty array will be
344
     * returned if there is no item assigned to the user.
345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 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
     */
    public function getAssignments($userId)
    {
        $query = new Query;
        $rows = $query->from($this->assignmentTable)
            ->where(['user_id' => $userId])
            ->createCommand($this->db)
            ->queryAll();
        $assignments = [];
        foreach ($rows as $row) {
            if (!isset($row['data']) || ($data = @unserialize($row['data'])) === false) {
                $data = null;
            }
            $assignments[$row['item_name']] = new Assignment([
                'manager' => $this,
                'userId' => $row['user_id'],
                'itemName' => $row['item_name'],
                'bizRule' => $row['biz_rule'],
                'data' => $data,
            ]);
        }

        return $assignments;
    }

    /**
     * Saves the changes to an authorization assignment.
     * @param Assignment $assignment the assignment that has been changed.
     */
    public function saveAssignment($assignment)
    {
        $this->db->createCommand()
            ->update($this->assignmentTable, [
                'biz_rule' => $assignment->bizRule,
                'data' => $assignment->data === null ? null : serialize($assignment->data),
            ], [
                'user_id' => $assignment->userId,
                'item_name' => $assignment->itemName,
            ])
            ->execute();
    }

    /**
     * Returns the authorization items of the specific type and user.
389 390 391 392 393
     * @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.
     * @return Item[] the authorization items of the specific type.
394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439
     */
    public function getItems($userId = null, $type = null)
    {
        $query = new Query;
        if ($userId === null && $type === null) {
            $command = $query->from($this->itemTable)
                ->createCommand($this->db);
        } elseif ($userId === null) {
            $command = $query->from($this->itemTable)
                ->where(['type' => $type])
                ->createCommand($this->db);
        } elseif ($type === null) {
            $command = $query->select(['name', 'type', 'description', 't1.biz_rule', 't1.data'])
                ->from([$this->itemTable . ' t1', $this->assignmentTable . ' t2'])
                ->where(['user_id' => $userId, 'name' => new Expression('item_name')])
                ->createCommand($this->db);
        } else {
            $command = $query->select(['name', 'type', 'description', 't1.biz_rule', 't1.data'])
                ->from([$this->itemTable . ' t1', $this->assignmentTable . ' t2'])
                ->where(['user_id' => $userId, 'type' => $type, 'name' => new Expression('item_name')])
                ->createCommand($this->db);
        }
        $items = [];
        foreach ($command->queryAll() as $row) {
            if (!isset($row['data']) || ($data = @unserialize($row['data'])) === false) {
                $data = null;
            }
            $items[$row['name']] = new Item([
                'manager' => $this,
                'name' => $row['name'],
                'type' => $row['type'],
                'description' => $row['description'],
                'bizRule' => $row['biz_rule'],
                'data' => $data,
            ]);
        }

        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.
440 441 442 443 444 445 446
     * @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
447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472
     * @throws Exception if an item with the same name already exists
     */
    public function createItem($name, $type, $description = '', $bizRule = null, $data = null)
    {
        $this->db->createCommand()
            ->insert($this->itemTable, [
                'name' => $name,
                'type' => $type,
                'description' => $description,
                'biz_rule' => $bizRule,
                'data' => $data === null ? null : serialize($data),
            ])
            ->execute();

        return new Item([
            'manager' => $this,
            'name' => $name,
            'type' => $type,
            'description' => $description,
            'bizRule' => $bizRule,
            'data' => $data,
        ]);
    }

    /**
     * Removes the specified authorization item.
473
     * @param string $name the name of the item to be removed
474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493
     * @return boolean whether the item exists in the storage and has been removed
     */
    public function removeItem($name)
    {
        if ($this->usingSqlite()) {
            $this->db->createCommand()
                ->delete($this->itemChildTable, ['or', 'parent=:name', 'child=:name'], [':name' => $name])
                ->execute();
            $this->db->createCommand()
                ->delete($this->assignmentTable, ['item_name' => $name])
                ->execute();
        }

        return $this->db->createCommand()
            ->delete($this->itemTable, ['name' => $name])
            ->execute() > 0;
    }

    /**
     * Returns the authorization item with the specified name.
494 495
     * @param string $name the name of the item
     * @return Item the authorization item. Null if the item cannot be found.
496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524
     */
    public function getItem($name)
    {
        $query = new Query;
        $row = $query->from($this->itemTable)
            ->where(['name' => $name])
            ->createCommand($this->db)
            ->queryOne();

        if ($row !== false) {
            if (!isset($row['data']) || ($data = @unserialize($row['data'])) === false) {
                $data = null;
            }

            return new Item([
                'manager' => $this,
                'name' => $row['name'],
                'type' => $row['type'],
                'description' => $row['description'],
                'bizRule' => $row['biz_rule'],
                'data' => $data,
            ]);
        } else {
            return null;
        }
    }

    /**
     * Saves an authorization item to persistent storage.
525
     * @param Item $item the item to be saved.
526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581
     * @param string $oldName the old item name. If null, it means the item name is not changed.
     */
    public function saveItem($item, $oldName = null)
    {
        if ($this->usingSqlite() && $oldName !== null && $item->getName() !== $oldName) {
            $this->db->createCommand()
                ->update($this->itemChildTable, ['parent' => $item->getName()], ['parent' => $oldName])
                ->execute();
            $this->db->createCommand()
                ->update($this->itemChildTable, ['child' => $item->getName()], ['child' => $oldName])
                ->execute();
            $this->db->createCommand()
                ->update($this->assignmentTable, ['item_name' => $item->getName()], ['item_name' => $oldName])
                ->execute();
        }

        $this->db->createCommand()
            ->update($this->itemTable, [
                'name' => $item->getName(),
                'type' => $item->type,
                'description' => $item->description,
                'biz_rule' => $item->bizRule,
                'data' => $item->data === null ? null : serialize($item->data),
            ], [
                'name' => $oldName === null ? $item->getName() : $oldName,
            ])
            ->execute();
    }

    /**
     * Saves the authorization data to persistent storage.
     */
    public function save()
    {
    }

    /**
     * Removes all authorization data.
     */
    public function clearAll()
    {
        $this->clearAssignments();
        $this->db->createCommand()->delete($this->itemChildTable)->execute();
        $this->db->createCommand()->delete($this->itemTable)->execute();
    }

    /**
     * Removes all authorization assignments.
     */
    public function clearAssignments()
    {
        $this->db->createCommand()->delete($this->assignmentTable)->execute();
    }

    /**
     * Checks whether there is a loop in the authorization item hierarchy.
582 583
     * @param string $itemName parent item name
     * @param string $childName the name of the child item that is to be added to the hierarchy
584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606
     * @return boolean whether a loop exists
     */
    protected function detectLoop($itemName, $childName)
    {
        if ($childName === $itemName) {
            return true;
        }
        foreach ($this->getItemChildren($childName) as $child) {
            if ($this->detectLoop($itemName, $child->getName())) {
                return true;
            }
        }

        return false;
    }

    /**
     * @return boolean whether the database is a SQLite database
     */
    protected function usingSqlite()
    {
        return $this->_usingSqlite;
    }
607
}