kosmosafive/kosmos.access

Kosmos: Права доступа

Maintainers

Details

github.com/kosmosafive/kosmos.access

Homepage

Source

Issues

Installs: 6

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 0

Language:JavaScript

Type:bitrix-d7-module

1.1.1 2024-10-02 07:27 UTC

Requires

Requires (Dev)

Apache-2.0 13bc7431d6683302f33e97120b666bc2e05dc86e

apiaccessbitrixkosmos

This package is auto-updated.

Last update: 2025-03-30 08:27:54 UTC

README

Введение

Концепция прав доступа описана в документации. Модуль предоставляет инструментарий для упрощения создания интерфейсов конфигурации, расширяет заложенный функционал.

Установка

  • Установить модуль
  • (опционально) При использовании страницы настроек из модульного решения необходимо убедиться, что установлены модули ядра "Поиск" и "Социальная сеть"

Установка через composer

В composer.json (пример для директории local) проекта добавьте

{
  "require": {
    "wikimedia/composer-merge-plugin": "dev-master"
  },
  "config": {
    "allow-plugins": {
      "wikimedia/composer-merge-plugin": true
    }
  },
  "extra": {
    "merge-plugin": {
      "require": [
        "../bitrix/composer-bx.json",
        "modules/*/composer.json"
      ],
      "recurse": true,
      "replace": true,
      "ignore-duplicates": false,
      "merge-dev": true,
      "merge-extra": false,
      "merge-extra-deep": false,
      "merge-scripts": false
    },
    "installer-paths": {
      "modules/{$name}/": [
        "type:bitrix-d7-module"
      ]
    }
  }
}

Использование

На уровне модульного решения необходимо создать набор классов, описывающих права доступа.

В примере модульное решение созвучно со своей ключевой сущностью. Наследование, предлагаемое в примерах, не является обязательным.

Модели

Каждый модуль должен хранить роли и права доступа в своих таблицах.

local/modules/kosmos.example/lib/Infrastructure/Model/ExamplePermissionTable.php

<?php

namespace Kosmos\Example\Infrastructure\Model;

use Bitrix\Main\Access\Permission\AccessPermissionTable;

class ExamplePermissionTable extends AccessPermissionTable
{
    public static function getTableName(): string
    {
        return 'kosmos_example_permission';
    }
}

local/modules/kosmos.example/lib/Infrastructure/Model/ExampleRoleTable.php

<?php

namespace Kosmos\Example\Infrastructure\Model;

use Bitrix\Main\Access\Role\AccessRoleTable;

class ExampleRoleTable extends AccessRoleTable
{
    public static function getTableName(): string
    {
        return 'kosmos_example_role';
    }
}

local/modules/kosmos.example/lib/Infrastructure/Model/ExampleRoleRelationTable.php

<?php

namespace Kosmos\Example\Infrastructure\Model;

use Bitrix\Main\Access\Role\AccessRoleRelationTable;

class ExampleRoleRelationTable extends AccessRoleRelationTable
{
    public static function getTableName(): string
    {
        return 'kosmos_example_role_relation';
    }
}

Контроллер

Предполагается, что будет существовать хотя бы один контроллер — контроллер модуля. В примере контроллер модуля отвечает и за ключевую сущность этого модуля.

local/modules/kosmos.example/lib/Domain/Access/ExampleAccessController.php

<?php

namespace Kosmos\Example\Domain\Access;

use Bitrix\Main\Access\User\AccessibleUser;
use Bitrix\Main\Access\AccessibleItem;
use Kosmos\Example\Domain\Entity\Example;
use Kosmos\Example\Domain\Entity\UserModel;
use Kosmos\Access\AccessController;

class ExampleAccessController extends AccessController
{
    protected function loadItem(int $itemId = null): ?AccessibleItem
    {
        return ($itemId) ? Example::createFromId($itemId) : null;
    }

    protected function loadUser(int $userId): AccessibleUser
    {
        return UserModel::createFromId($userId);
    }
}

Словарь действий

В словаре перечисляются все возможные действия.

local/modules/kosmos.example/lib/Domain/Access/ActionDictionary.php

<?php

namespace Kosmos\Example\Domain\Access;

use Kosmos\Access\ActionDictionary as Base;

class ActionDictionary extends Base
{
    public const
        ACTION_CREATE = 'create',
        ACTION_EDIT = 'edit'
    ;
}

Словарь прав доступа

local/modules/kosmos.example/lib/Domain/Access/Permission/PermissionDictionary.php

<?php

namespace Kosmos\Example\Domain\Access\Permission;

use Kosmos\Access\Permission\PermissionDictionary as Base;

class PermissionDictionary extends Base
{
    public const
        EXAMPLE_CREATE = 'example_create',
        EXAMPLE_EDIT_OWN = 'example_edit_own',
        EXAMPLE_EDIT_ALL = 'example_edit_all'
    ;
}

Словарь ролей

local/modules/kosmos.example/lib/Domain/Access/Role/RoleDictionary.php

<?php

namespace Kosmos\Example\Domain\Access\Role;

use Bitrix\Main\Access\Role\RoleDictionary as Base;

class RoleDictionary extends Base
{
	public const
		EXAMPLE_ROLE_ADMIN = 'EXAMPLE_ROLE_ADMIN'
    ;
}

Утилиты прав доступа

local/modules/kosmos.example/lib/Domain/Access/Role/RoleUtil.php

<?php

namespace Kosmos\Example\Domain\Access\Role;

use Kosmos\Core\ORM\Model\UserGroupTable;
use Kosmos\Example\Infrastructure\Model;
use Kosmos\Access\Role\RoleUtil as Base;

class RoleUtil extends Base
{
    /**
     * @return string
     */
	protected static function getRoleTableClass(): string
	{
		return Model\ExampleRoleTable::class;
	}

    /**
     * @return string
     */
	protected static function getRoleRelationTableClass(): string
	{
		return Model\ExampleRoleRelationTable::class;
	}

    /**
     * @return string
     */
	protected static function getPermissionTableClass(): string
	{
		return Model\ExamplePermissionTable::class;
	}

    /**
     * @return string|null
     */
	public static function getRoleDictionaryClass(): ?string
	{
		return RoleDictionary::class;
	}

    /**
     * @return string
     */
    protected static function getUserGroupTableClass(): string
    {
        return UserGroupTable::class;
    }
}

Правила

Каждое правило описывается в отдельном файле.

local/modules/kosmos.example/lib/Domain/Access/Rule/CreateRule.php

<?php

namespace Kosmos\Example\Domain\Access\Rule;

use Bitrix\Main\Access\AccessibleItem;
use Bitrix\Main\Access\Rule\AbstractRule;
use Kosmos\Example\Domain\Access\Permission\PermissionDictionary;

class CreateRule extends AbstractRule
{
    public function execute(AccessibleItem $item = null, $params = null): bool
    {
        if ($this->user->isAdmin()){
            return true;
        }

        if ($this->user->getPermission(PermissionDictionary::EXAMPLE_CREATE)){
            return true;
        }

        return false;
    }
}

Конфигурация для вывода интерфейса

local/modules/kosmos.example/lib/Domain/Access/Component/ExampleConfigPermissions.php

<?php

namespace Kosmos\Example\Domain\Access\Component;

use Kosmos\Example\Domain\Access\ActionDictionary;
use Kosmos\Example\Domain\Access\Permission\PermissionDictionary;
use Kosmos\Example\Domain\Access\Role\RoleUtil;
use Kosmos\Example\Domain\Access\ExampleAccessController;
use Kosmos\Access\Component\ConfigPermissions;

class ExampleConfigPermissions extends ConfigPermissions
{
    /**
     * @return array[]
     */
	protected function getSections(): array
	{
		return [
            'SECTION_ADMIN' => [
                PermissionDictionary::ADMIN
            ],
            'SECTION_EXAMPLE' => [
                PermissionDictionary::EXAMPLE_CREATE,
                PermissionDictionary::EXAMPLE_EDIT_OWN,
                PermissionDictionary::EXAMPLE_EDIT_ALL
            ]
		];
	}

    /**
     * @return string
     */
    protected function getPermissionDictionaryClass(): string
    {
        return PermissionDictionary::class;
    }

    /**
     * @return string
     */
    public function getRoleUtilClass(): string
    {
        return RoleUtil::class;
    }

    /**
     * @return string
     */
    public static function getModuleId(): string
    {
        return 'kosmos.example';
    }

    /**
     * @return string
     */
    public function getAccessControllerClass(): string
    {
        return ExampleAccessController::class;
    }

    /**
     * @return string
     */
    public function getActionDictionaryClass(): string
    {
        return ActionDictionary::class;
    }
}

Модель пользователя

local/modules/kosmos.example/lib/Domain/Entity/UserModel.php

<?php

namespace Kosmos\Example\Domain\Entity;

use Kosmos\Example\Infrastructure\Model\ExamplePermissionTable;
use Kosmos\Example\Infrastructure\Model\ExampleRoleRelationTable;
use Kosmos\Access\Entity\UserModel as Base;

class UserModel extends Base
{
    protected function getPermissionTableClass(): string
    {
        return ExamplePermissionTable::class;
    }

    protected function getRoleRelationTableClass(): string
    {
        return ExampleRoleRelationTable::class;
    }
}

Модель сущности

Модель сущности может отсутствовать.

local/modules/kosmos.example/lib/Domain/Entity/Example.php

<?php

namespace Kosmos\Example\Domain\Entity;

use Bitrix\Main\Access\AccessibleItem;
use Kosmos\Example\Infrastructure\Model;

class Example extends Model\EO_Example implements AccessibleItem
{
    public static function createFromId(int $itemId): AccessibleItem
    {
        ...
    }

    public function getId(): int
    {
        return (int) parent::getId();
    }
}

Страница настроек

Для добавления пункта меню, ссылающегося на страницу, можно воспользоваться файлом local/modules/kosmos.example/admin/menu.php. Заголовок и ссылка могут быть получены программно.

'text' => ExampleConfigPermissions::getTitle(),
'url' => ExampleConfigPermissions::getUri()

Использование

Больше примеров использования можно найти в документации.

Проверка возможности совершения действия

use Kosmos\Example\Domain\Access\ActionDictionary;
use Kosmos\Example\Domain\Access\ExampleAccessController;

ExampleAccessController::can(
    $userId,
    ActionDictionary::ACTION_CREATE,
    $this->example->getId()
)

При необходимости можно явно передать сущность в контроллер.

use Kosmos\Example\Domain\Access\ActionDictionary;
use Kosmos\Example\Domain\Access\ExampleAccessController;

ExampleAccessController::can(
    $userId,
    ActionDictionary::ACTION_CREATE,
    $this->example->getId(),
    ['entity' => $this->example]
)

Список идентификаторов пользователей, имеющих определенное право

use Kosmos\Example\Domain\Access\Role\RoleUtil;
use Kosmos\Example\Domain\Access\Permission\PermissionDictionary;

$userIdList = RoleUtil::getMembersByPermission(PermissionDictionary::EXAMPLE_CREATE)