DbManager.php 20.8 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 24 25 26 27
 * The database connection is specified by [[db]]. The database schema could be initialized by applying migration:
 *
 * ```
 *  yii migrate --migrationPath=/vendor/yiisoft/yii2/rbac/migrations/
 * ```
 *
 * You may change the names of the three tables used to store the authorization data by setting [[itemTable]],
28 29
 * [[itemChildTable]] and [[assignmentTable]].
 *
30 31 32 33
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @author Alexander Kochetov <creocoder@gmail.com>
 * @since 2.0
 */
34
class DbManager extends BaseManager
35
{
36 37 38 39 40 41
    /**
     * @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';
42

43
    /**
44
     * @var string the name of the table storing authorization items. Defaults to "auth_item".
45 46
     */
    public $itemTable = '{{%auth_item}}';
47

48
    /**
49
     * @var string the name of the table storing authorization item hierarchy. Defaults to "auth_item_child".
50 51
     */
    public $itemChildTable = '{{%auth_item_child}}';
52

53
    /**
54
     * @var string the name of the table storing authorization item assignments. Defaults to "auth_assignment".
55 56 57
     */
    public $assignmentTable = '{{%auth_assignment}}';

58 59 60 61 62
    /**
     * @var string the name of the table storing rules. Defaults to "auth_rule".
     */
    public $ruleTable = '{{%auth_rule}}';

63 64 65 66 67 68 69 70

    /**
     * Initializes the application component.
     * This method overrides the parent implementation by establishing the database connection.
     */
    public function init()
    {
        parent::init();
71

72
        $this->db = Instance::ensure($this->db, Connection::className());
73 74 75
    }

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

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

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

104
        if (!$this->executeRule($user, $item, $params)) {
105 106 107
            return false;
        }

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

        $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)) {
119 120 121 122 123 124 125 126
                return true;
            }
        }

        return false;
    }

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

        if ($row === false) {
            return null;
137 138
        }

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

        return $this->populateItem($row);
144 145 146
    }

    /**
147 148 149
     * 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.
150
     */
151
    protected function supportsCascadeUpdate()
152
    {
153
        return strncmp($this->db->getDriverName(), 'sqlite', 6) !== 0;
154 155 156
    }

    /**
157
     * @inheritdoc
158
     */
159
    protected function addItem($item)
160
    {
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177
        $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();
178

179
        return true;
180 181 182
    }

    /**
183
     * @inheritdoc
184
     */
185
    protected function removeItem($item)
186
    {
187 188 189 190 191 192 193
        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();
194 195
        }

196 197 198 199 200
        $this->db->createCommand()
            ->delete($this->itemTable, ['name' => $item->name])
            ->execute();

        return true;
201 202 203
    }

    /**
204
     * @inheritdoc
205
     */
206
    protected function updateItem($name, $item)
207
    {
208 209 210 211 212 213 214 215 216 217
        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();
218
        }
219 220 221

        $item->updatedAt = time();

222
        $this->db->createCommand()
223 224 225 226 227 228 229 230 231
            ->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();
232

233
        return true;
234 235 236
    }

    /**
237
     * @inheritdoc
238
     */
239
    protected function addRule($rule)
240
    {
241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256
        $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;
257 258 259
    }

    /**
260
     * @inheritdoc
261
     */
262
    protected function updateRule($name, $rule)
263
    {
264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281
        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;
282 283 284
    }

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

295 296 297 298 299
        $this->db->createCommand()
            ->delete($this->ruleTable, ['name' => $rule->name])
            ->execute();

        return true;
300 301 302
    }

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

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

        return $items;
317 318 319
    }

    /**
320 321 322
     * 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)
323
     */
324
    protected function populateItem($row)
325
    {
326 327 328 329
        $class = $row['type'] == Item::TYPE_PERMISSION ? Permission::className() : Role::className();

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

332 333 334 335 336 337 338 339 340
        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'],
        ]);
341 342 343
    }

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

        $roles = [];
        foreach ($query->all($this->db) as $row) {
            $roles[$row['name']] = $this->populateItem($row);
        }
        return $roles;
358 359 360
    }

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

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

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

397 398 399
        if (empty($result)) {
            return [];
        }
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
        $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);
439 440
            }
        }
441
    }
442

443 444 445 446 447 448 449 450 451 452
    /**
     * @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']);
453 454 455
    }

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

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

        return $rules;
468 469 470
    }

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

        if ($row === false) {
            return null;
481 482
        }

483 484 485 486 487 488 489 490 491
        if (!isset($row['data']) || ($data = @unserialize($row['data'])) === false) {
            $data = null;
        }

        return new Assignment([
            'userId' => $row['user_id'],
            'roleName' => $row['item_name'],
            'createdAt' => $row['created_at'],
        ]);
492 493 494
    }

    /**
495
     * @inheritdoc
496
     */
497
    public function getAssignments($userId)
498
    {
499 500 501
        $query = (new Query)
            ->from($this->assignmentTable)
            ->where(['user_id' => $userId]);
502

503 504
        $assignments = [];
        foreach ($query->all($this->db) as $row) {
505 506 507
            if (!isset($row['data']) || ($data = @unserialize($row['data'])) === false) {
                $data = null;
            }
508 509 510 511
            $assignments[$row['item_name']] = new Assignment([
                'userId' => $row['user_id'],
                'roleName' => $row['item_name'],
                'createdAt' => $row['created_at'],
512 513
            ]);
        }
514 515

        return $assignments;
516 517 518
    }

    /**
519
     * @inheritdoc
520
     */
521
    public function addChild($parent, $child)
522
    {
523 524 525 526 527 528 529 530 531 532
        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.");
533 534 535
        }

        $this->db->createCommand()
536
            ->insert($this->itemChildTable, ['parent' => $parent->name, 'child' => $child->name])
537 538
            ->execute();

539
        return true;
540 541 542
    }

    /**
543
     * @inheritdoc
544
     */
545
    public function removeChild($parent, $child)
546
    {
547 548 549
        return $this->db->createCommand()
            ->delete($this->itemChildTable, ['parent' => $parent->name, 'child' => $child->name])
            ->execute() > 0;
550 551
    }

552 553 554 555 556 557 558
    /**
     * @inheritdoc
     */
    public function hasChild($parent, $child)
    {
        return (new Query)
            ->from($this->itemChildTable)
Qiang Xue committed
559
            ->where(['parent' => $parent->name, 'child' => $child->name])
560 561 562
            ->one($this->db) !== false;
    }

563
    /**
564
     * @inheritdoc
565
     */
566
    public function getChildren($name)
567
    {
568 569 570 571 572 573 574 575 576 577 578
        $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;
579 580 581 582
    }

    /**
     * Checks whether there is a loop in the authorization item hierarchy.
583 584
     * @param Item $parent the parent item
     * @param Item $child the child item to be added to the hierarchy
585 586
     * @return boolean whether a loop exists
     */
587
    protected function detectLoop($parent, $child)
588
    {
589
        if ($child->name === $parent->name) {
590 591
            return true;
        }
592 593
        foreach ($this->getChildren($child->name) as $grandchild) {
            if ($this->detectLoop($parent, $grandchild)) {
594 595 596 597 598 599 600
                return true;
            }
        }
        return false;
    }

    /**
601
     * @inheritdoc
602
     */
603
    public function assign($role, $userId, $rule = null, $data = null)
604
    {
605 606 607 608 609
        $assignment = new Assignment([
            'userId' => $userId,
            'roleName' => $role->name,
            'createdAt' => time(),
        ]);
610

611 612 613 614 615 616 617 618
        $this->db->createCommand()
            ->insert($this->assignmentTable, [
                'user_id' => $assignment->userId,
                'item_name' => $assignment->roleName,
                'created_at' => $assignment->createdAt,
            ])->execute();

        return $assignment;
619 620 621
    }

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

    /**
632
     * @inheritdoc
633
     */
634
    public function revokeAll($userId)
635
    {
636 637 638
        return $this->db->createCommand()
            ->delete($this->assignmentTable, ['user_id' => $userId])
            ->execute() > 0;
639 640 641
    }

    /**
642
     * @inheritdoc
643
     */
644
    public function removeAll()
645
    {
646
        $this->removeAllAssignments();
647 648 649
        $this->db->createCommand()->delete($this->itemChildTable)->execute();
        $this->db->createCommand()->delete($this->itemTable)->execute();
        $this->db->createCommand()->delete($this->ruleTable)->execute();
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 702 703 704 705 706 707 708 709 710 711
     * @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
712
     */
713
    public function removeAllAssignments()
714
    {
715
        $this->db->createCommand()->delete($this->assignmentTable)->execute();
716 717
    }
}