DbManager.php 20.6 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\InvalidCallException;
15
use yii\base\InvalidParamException;
16
use yii\di\Instance;
17 18

/**
19 20
 * DbManager represents an authorization manager that stores authorization information in database.
 *
21 22 23
 * The database connection is specified by [[db]]. The database schema could be initialized by applying migration:
 *
 * ```
24
 * yii migrate --migrationPath=@yii/rbac/migrations/
25 26
 * ```
 *
27 28
 * If you don't want to use migration and need SQL instead, files for all databases are in migrations directory.
 *
29
 * You may change the names of the three tables used to store the authorization data by setting [[itemTable]],
30 31
 * [[itemChildTable]] and [[assignmentTable]].
 *
32 33 34 35
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @author Alexander Kochetov <creocoder@gmail.com>
 * @since 2.0
 */
36
class DbManager extends BaseManager
37
{
38 39 40 41 42 43 44
    /**
     * @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';
    /**
45
     * @var string the name of the table storing authorization items. Defaults to "auth_item".
46 47 48
     */
    public $itemTable = '{{%auth_item}}';
    /**
49
     * @var string the name of the table storing authorization item hierarchy. Defaults to "auth_item_child".
50 51 52
     */
    public $itemChildTable = '{{%auth_item_child}}';
    /**
53
     * @var string the name of the table storing authorization item assignments. Defaults to "auth_assignment".
54 55
     */
    public $assignmentTable = '{{%auth_assignment}}';
56 57 58 59 60
    /**
     * @var string the name of the table storing rules. Defaults to "auth_rule".
     */
    public $ruleTable = '{{%auth_rule}}';

61 62 63 64 65 66 67 68

    /**
     * Initializes the application component.
     * This method overrides the parent implementation by establishing the database connection.
     */
    public function init()
    {
        parent::init();
69
        $this->db = Instance::ensure($this->db, Connection::className());
70 71 72
    }

    /**
73
     * @inheritdoc
74
     */
75
    public function checkAccess($userId, $permissionName, $params = [])
76 77
    {
        $assignments = $this->getAssignments($userId);
78
        return $this->checkAccessRecursive($userId, $permissionName, $params, $assignments);
79 80 81 82 83
    }

    /**
     * Performs access check for the specified user.
     * This method is internally called by [[checkAccess()]].
84
     * @param string|integer $user the user ID. This should can be either an integer or a string representing
85 86
     * the unique identifier of a user. See [[\yii\web\User::id]].
     * @param string $itemName the name of the operation that need access check
87
     * @param array $params name-value pairs that would be passed to rules associated
88
     * with the tasks and roles assigned to the user. A param with name 'user' is added to this array,
89 90 91
     * 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.
92
     */
93
    protected function checkAccessRecursive($user, $itemName, $params, $assignments)
94 95 96 97
    {
        if (($item = $this->getItem($itemName)) === null) {
            return false;
        }
98 99 100

        Yii::trace($item instanceof Role ? "Checking role: $itemName" : "Checking permission: $itemName", __METHOD__);

101
        if (!$this->executeRule($user, $item, $params)) {
102 103 104
            return false;
        }

105
        if (isset($assignments[$itemName]) || in_array($itemName, $this->defaultRoles)) {
106
            return true;
107
        }
108 109 110 111 112 113 114 115

        $query = new Query;
        $parents = $query->select(['parent'])
            ->from($this->itemChildTable)
            ->where(['child' => $itemName])
            ->column($this->db);
        foreach ($parents as $parent) {
            if ($this->checkAccessRecursive($user, $parent, $params, $assignments)) {
116 117 118 119 120 121 122 123
                return true;
            }
        }

        return false;
    }

    /**
124
     * @inheritdoc
125
     */
126
    protected function getItem($name)
127
    {
128 129 130 131 132 133
        $row = (new Query)->from($this->itemTable)
            ->where(['name' => $name])
            ->one($this->db);

        if ($row === false) {
            return null;
134 135
        }

136
        if (!isset($row['data']) || ($data = @unserialize($row['data'])) === false) {
Alexander Makarov committed
137
            $row['data'] = null;
138
        }
139 140

        return $this->populateItem($row);
141 142 143
    }

    /**
144 145 146
     * Returns a value indicating whether the database supports cascading update and delete.
     * The default implementation will return false for SQLite database and true for all other databases.
     * @return boolean whether the database supports cascading update and delete.
147
     */
148
    protected function supportsCascadeUpdate()
149
    {
150
        return strncmp($this->db->getDriverName(), 'sqlite', 6) !== 0;
151 152 153
    }

    /**
154
     * @inheritdoc
155
     */
156
    protected function addItem($item)
157
    {
158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174
        $time = time();
        if ($item->createdAt === null) {
            $item->createdAt = $time;
        }
        if ($item->updatedAt === null) {
            $item->updatedAt = $time;
        }
        $this->db->createCommand()
            ->insert($this->itemTable, [
                'name' => $item->name,
                'type' => $item->type,
                'description' => $item->description,
                'rule_name' => $item->ruleName,
                'data' => $item->data === null ? null : serialize($item->data),
                'created_at' => $item->createdAt,
                'updated_at' => $item->updatedAt,
            ])->execute();
175

176
        return true;
177 178 179
    }

    /**
180
     * @inheritdoc
181
     */
182
    protected function removeItem($item)
183
    {
184 185 186 187 188 189 190
        if (!$this->supportsCascadeUpdate()) {
            $this->db->createCommand()
                ->delete($this->itemChildTable, ['or', 'parent=:name', 'child=:name'], [':name' => $item->name])
                ->execute();
            $this->db->createCommand()
                ->delete($this->assignmentTable, ['item_name' => $item->name])
                ->execute();
191 192
        }

193 194 195 196 197
        $this->db->createCommand()
            ->delete($this->itemTable, ['name' => $item->name])
            ->execute();

        return true;
198 199 200
    }

    /**
201
     * @inheritdoc
202
     */
203
    protected function updateItem($name, $item)
204
    {
205 206 207 208 209 210 211 212 213 214
        if (!$this->supportsCascadeUpdate() && $item->name !== $name) {
            $this->db->createCommand()
                ->update($this->itemChildTable, ['parent' => $item->name], ['parent' => $name])
                ->execute();
            $this->db->createCommand()
                ->update($this->itemChildTable, ['child' => $item->name], ['child' => $name])
                ->execute();
            $this->db->createCommand()
                ->update($this->assignmentTable, ['item_name' => $item->name], ['item_name' => $name])
                ->execute();
215
        }
216 217 218

        $item->updatedAt = time();

219
        $this->db->createCommand()
220 221 222 223 224 225 226 227 228
            ->update($this->itemTable, [
                'name' => $item->name,
                'description' => $item->description,
                'rule_name' => $item->ruleName,
                'data' => $item->data === null ? null : serialize($item->data),
                'updated_at' => $item->updatedAt,
            ], [
                'name' => $name,
            ])->execute();
229

230
        return true;
231 232 233
    }

    /**
234
     * @inheritdoc
235
     */
236
    protected function addRule($rule)
237
    {
238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253
        $time = time();
        if ($rule->createdAt === null) {
            $rule->createdAt = $time;
        }
        if ($rule->updatedAt === null) {
            $rule->updatedAt = $time;
        }
        $this->db->createCommand()
            ->insert($this->ruleTable, [
                'name' => $rule->name,
                'data' => serialize($rule),
                'created_at' => $rule->createdAt,
                'updated_at' => $rule->updatedAt,
            ])->execute();

        return true;
254 255 256
    }

    /**
257
     * @inheritdoc
258
     */
259
    protected function updateRule($name, $rule)
260
    {
261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278
        if (!$this->supportsCascadeUpdate() && $rule->name !== $name) {
            $this->db->createCommand()
                ->update($this->itemTable, ['rule_name' => $rule->name], ['rule_name' => $name])
                ->execute();
        }

        $rule->updatedAt = time();

        $this->db->createCommand()
            ->update($this->ruleTable, [
                'name' => $rule->name,
                'data' => serialize($rule),
                'updated_at' => $rule->updatedAt,
            ], [
                'name' => $name,
            ])->execute();

        return true;
279 280 281
    }

    /**
282
     * @inheritdoc
283
     */
284
    protected function removeRule($rule)
285
    {
286 287 288 289 290
        if (!$this->supportsCascadeUpdate()) {
            $this->db->createCommand()
                ->delete($this->itemTable, ['rule_name' => $rule->name])
                ->execute();
        }
291

292 293 294 295 296
        $this->db->createCommand()
            ->delete($this->ruleTable, ['name' => $rule->name])
            ->execute();

        return true;
297 298 299
    }

    /**
300
     * @inheritdoc
301
     */
302
    protected function getItems($type)
303
    {
304 305 306
        $query = (new Query)
            ->from($this->itemTable)
            ->where(['type' => $type]);
307

308 309 310
        $items = [];
        foreach ($query->all($this->db) as $row) {
            $items[$row['name']] = $this->populateItem($row);
311
        }
312 313

        return $items;
314 315 316
    }

    /**
317 318 319
     * Populates an auth item with the data fetched from database
     * @param array $row the data from the auth item table
     * @return Item the populated auth item instance (either Role or Permission)
320
     */
321
    protected function populateItem($row)
322
    {
323 324 325 326
        $class = $row['type'] == Item::TYPE_PERMISSION ? Permission::className() : Role::className();

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

329 330 331 332 333 334 335 336 337
        return new $class([
            'name' => $row['name'],
            'type' => $row['type'],
            'description' => $row['description'],
            'ruleName' => $row['rule_name'],
            'data' => $data,
            'createdAt' => $row['created_at'],
            'updatedAt' => $row['updated_at'],
        ]);
338 339 340
    }

    /**
341
     * @inheritdoc
342
     */
343
    public function getRolesByUser($userId)
344
    {
345 346 347
        $query = (new Query)->select('b.*')
            ->from(['a' => $this->assignmentTable, 'b' => $this->itemTable])
            ->where('a.item_name=b.name')
348
            ->andWhere(['a.user_id' => (string)$userId]);
349 350 351 352 353 354

        $roles = [];
        foreach ($query->all($this->db) as $row) {
            $roles[$row['name']] = $this->populateItem($row);
        }
        return $roles;
355 356 357
    }

    /**
358
     * @inheritdoc
359
     */
360
    public function getPermissionsByRole($roleName)
361
    {
362 363 364 365 366
        $childrenList = $this->getChildrenList();
        $result = [];
        $this->getChildrenRecursive($roleName, $childrenList, $result);
        if (empty($result)) {
            return [];
367
        }
368
        $query = (new Query)->from($this->itemTable)->where([
369
            'type' => Item::TYPE_PERMISSION,
370 371 372 373 374 375 376 377
            'name' => array_keys($result),
        ]);
        $permissions = [];
        foreach ($query->all($this->db) as $row) {
            $permissions[$row['name']] = $this->populateItem($row);
        }
        return $permissions;
    }
378

379 380 381 382 383 384 385
    /**
     * @inheritdoc
     */
    public function getPermissionsByUser($userId)
    {
        $query = (new Query)->select('item_name')
            ->from($this->assignmentTable)
386
            ->where(['user_id' => (string)$userId]);
387 388 389 390 391 392

        $childrenList = $this->getChildrenList();
        $result = [];
        foreach ($query->column($this->db) as $roleName) {
            $this->getChildrenRecursive($roleName, $childrenList, $result);
        }
393

394 395 396
        if (empty($result)) {
            return [];
        }
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
        $query = (new Query)->from($this->itemTable)->where([
            'type' => Item::TYPE_PERMISSION,
            'name' => array_keys($result),
        ]);
        $permissions = [];
        foreach ($query->all($this->db) as $row) {
            $permissions[$row['name']] = $this->populateItem($row);
        }
        return $permissions;
    }

    /**
     * Returns the children for every parent.
     * @return array the children list. Each array key is a parent item name,
     * and the corresponding array value is a list of child item names.
     */
    protected function getChildrenList()
    {
        $query = (new Query)->from($this->itemChildTable);
        $parents = [];
        foreach ($query->all($this->db) as $row) {
            $parents[$row['parent']][] = $row['child'];
        }
        return $parents;
    }

    /**
     * Recursively finds all children and grand children of the specified item.
     * @param string $name the name of the item whose children are to be looked for.
     * @param array $childrenList the child list built via [[getChildrenList()]]
     * @param array $result the children and grand children (in array keys)
     */
    protected function getChildrenRecursive($name, $childrenList, &$result)
    {
        if (isset($childrenList[$name])) {
            foreach ($childrenList[$name] as $child) {
                $result[$child] = true;
                $this->getChildrenRecursive($child, $childrenList, $result);
436 437
            }
        }
438
    }
439

440 441 442 443 444 445 446 447 448 449
    /**
     * @inheritdoc
     */
    public function getRule($name)
    {
        $row = (new Query)->select(['data'])
            ->from($this->ruleTable)
            ->where(['name' => $name])
            ->one($this->db);
        return $row === false ? null : unserialize($row['data']);
450 451 452
    }

    /**
453 454 455
     * @inheritdoc
     */
    public function getRules()
456
    {
457
        $query = (new Query)->from($this->ruleTable);
458

459 460 461 462 463 464
        $rules = [];
        foreach ($query->all($this->db) as $row) {
            $rules[$row['name']] = unserialize($row['data']);
        }

        return $rules;
465 466 467
    }

    /**
468
     * @inheritdoc
469
     */
470
    public function getAssignment($roleName, $userId)
471
    {
472
        $row = (new Query)->from($this->assignmentTable)
473
            ->where(['user_id' => (string)$userId, 'item_name' => $roleName])
474 475 476 477
            ->one($this->db);

        if ($row === false) {
            return null;
478 479
        }

480 481 482 483 484
        return new Assignment([
            'userId' => $row['user_id'],
            'roleName' => $row['item_name'],
            'createdAt' => $row['created_at'],
        ]);
485 486 487
    }

    /**
488
     * @inheritdoc
489
     */
490
    public function getAssignments($userId)
491
    {
492 493
        $query = (new Query)
            ->from($this->assignmentTable)
494
            ->where(['user_id' => (string)$userId]);
495

496 497 498 499 500 501
        $assignments = [];
        foreach ($query->all($this->db) as $row) {
            $assignments[$row['item_name']] = new Assignment([
                'userId' => $row['user_id'],
                'roleName' => $row['item_name'],
                'createdAt' => $row['created_at'],
502 503
            ]);
        }
504 505

        return $assignments;
506 507 508
    }

    /**
509
     * @inheritdoc
510
     */
511
    public function addChild($parent, $child)
512
    {
513 514 515 516 517 518 519 520 521 522
        if ($parent->name === $child->name) {
            throw new InvalidParamException("Cannot add '{$parent->name}' as a child of itself.");
        }

        if ($parent instanceof Permission && $child instanceof Role) {
            throw new InvalidParamException("Cannot add a role as a child of a permission.");
        }

        if ($this->detectLoop($parent, $child)) {
            throw new InvalidCallException("Cannot add '{$child->name}' as a child of '{$parent->name}'. A loop has been detected.");
523 524 525
        }

        $this->db->createCommand()
526
            ->insert($this->itemChildTable, ['parent' => $parent->name, 'child' => $child->name])
527 528
            ->execute();

529
        return true;
530 531 532
    }

    /**
533
     * @inheritdoc
534
     */
535
    public function removeChild($parent, $child)
536
    {
537 538 539
        return $this->db->createCommand()
            ->delete($this->itemChildTable, ['parent' => $parent->name, 'child' => $child->name])
            ->execute() > 0;
540 541
    }

542 543 544 545 546 547 548
    /**
     * @inheritdoc
     */
    public function hasChild($parent, $child)
    {
        return (new Query)
            ->from($this->itemChildTable)
Qiang Xue committed
549
            ->where(['parent' => $parent->name, 'child' => $child->name])
550 551 552
            ->one($this->db) !== false;
    }

553
    /**
554
     * @inheritdoc
555
     */
556
    public function getChildren($name)
557
    {
558 559 560 561 562 563 564 565 566 567 568
        $query = (new Query)
            ->select(['name', 'type', 'description', 'rule_name', 'data', 'created_at', 'updated_at'])
            ->from([$this->itemTable, $this->itemChildTable])
            ->where(['parent' => $name, 'name' => new Expression('child')]);

        $children = [];
        foreach ($query->all($this->db) as $row) {
            $children[$row['name']] = $this->populateItem($row);
        }

        return $children;
569 570 571 572
    }

    /**
     * Checks whether there is a loop in the authorization item hierarchy.
573 574
     * @param Item $parent the parent item
     * @param Item $child the child item to be added to the hierarchy
575 576
     * @return boolean whether a loop exists
     */
577
    protected function detectLoop($parent, $child)
578
    {
579
        if ($child->name === $parent->name) {
580 581
            return true;
        }
582 583
        foreach ($this->getChildren($child->name) as $grandchild) {
            if ($this->detectLoop($parent, $grandchild)) {
584 585 586 587 588 589 590
                return true;
            }
        }
        return false;
    }

    /**
591
     * @inheritdoc
592
     */
593
    public function assign($role, $userId)
594
    {
595 596 597 598 599
        $assignment = new Assignment([
            'userId' => $userId,
            'roleName' => $role->name,
            'createdAt' => time(),
        ]);
600

601 602 603 604 605 606 607 608
        $this->db->createCommand()
            ->insert($this->assignmentTable, [
                'user_id' => $assignment->userId,
                'item_name' => $assignment->roleName,
                'created_at' => $assignment->createdAt,
            ])->execute();

        return $assignment;
609 610 611
    }

    /**
612
     * @inheritdoc
613
     */
614
    public function revoke($role, $userId)
615
    {
616
        return $this->db->createCommand()
617
            ->delete($this->assignmentTable, ['user_id' => (string)$userId, 'item_name' => $role->name])
618
            ->execute() > 0;
619 620 621
    }

    /**
622
     * @inheritdoc
623
     */
624
    public function revokeAll($userId)
625
    {
626
        return $this->db->createCommand()
627
            ->delete($this->assignmentTable, ['user_id' => (string)$userId])
628
            ->execute() > 0;
629 630 631
    }

    /**
632
     * @inheritdoc
633
     */
634
    public function removeAll()
635
    {
636
        $this->removeAllAssignments();
637 638 639
        $this->db->createCommand()->delete($this->itemChildTable)->execute();
        $this->db->createCommand()->delete($this->itemTable)->execute();
        $this->db->createCommand()->delete($this->ruleTable)->execute();
640 641 642
    }

    /**
643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701
     * @inheritdoc
     */
    public function removeAllPermissions()
    {
        $this->removeAllItems(Item::TYPE_PERMISSION);
    }

    /**
     * @inheritdoc
     */
    public function removeAllRoles()
    {
        $this->removeAllItems(Item::TYPE_ROLE);
    }

    /**
     * Removes all auth items of the specified type.
     * @param integer $type the auth item type (either Item::TYPE_PERMISSION or Item::TYPE_ROLE)
     */
    protected function removeAllItems($type)
    {
        if (!$this->supportsCascadeUpdate()) {
            $names = (new Query)
                ->select(['name'])
                ->from($this->itemTable)
                ->where(['type' => $type])
                ->column($this->db);
            if (empty($names)) {
                return;
            }
            $key = $type == Item::TYPE_PERMISSION ? 'child' : 'parent';
            $this->db->createCommand()
                ->delete($this->itemChildTable, [$key => $names])
                ->execute();
            $this->db->createCommand()
                ->delete($this->assignmentTable, ['item_name' => $names])
                ->execute();
        }
        $this->db->createCommand()
            ->delete($this->itemTable, ['type' => $type])
            ->execute();
    }

    /**
     * @inheritdoc
     */
    public function removeAllRules()
    {
        if (!$this->supportsCascadeUpdate()) {
            $this->db->createCommand()
                ->update($this->itemTable, ['ruleName' => null])
                ->execute();
        }

        $this->db->createCommand()->delete($this->ruleTable)->execute();
    }

    /**
     * @inheritdoc
702
     */
703
    public function removeAllAssignments()
704
    {
705
        $this->db->createCommand()->delete($this->assignmentTable)->execute();
706 707
    }
}