class.ilObjectPermissionStatusGUI.php

Go to the documentation of this file.

<?php

declare(strict_types=1);
class ilObjectPermissionStatusGUI
{
    public ilObjUser $user;
    protected ilLanguage $lng;
    protected ilCtrlInterface $ctrl;
    protected ilGlobalTemplateInterface $tpl;
    protected ilObject $object;
    protected ilRbacReview $rbacreview;
    protected ilToolbarGUI $toolbar;

    protected array $user_roles;
    protected array $global_roles;
    protected array $valid_roles;
    protected array $assigned_valid_roles;

    public const IMG_OK = 0;
    public const IMG_NOT_OK = 1;

    public function __construct(ilObject $a_obj)
    {
        global $DIC;

        $this->lng = $DIC->language();
        $this->ctrl = $DIC->ctrl();
        $this->tpl = $DIC->ui()->mainTemplate();
        $this->object = $a_obj;
        $this->rbacreview = $DIC->rbac()->review();
        $this->toolbar = $DIC->toolbar();

        $this->user = $this->getUser();
        $this->user_roles = $this->rbacreview->assignedRoles($this->user->getId());
        $this->global_roles = $this->rbacreview->getGlobalRoles();
        $this->valid_roles = $this->rbacreview->getParentRoleIds($this->object->getRefId());
        $this->assigned_valid_roles = $this->getAssignedValidRoles();
    }

    public function executeCommand(): void
    {
        // determine next class in the call structure
        $next_class = $this->ctrl->getNextClass($this);

        switch ($next_class) {
            case 'ilrepositorysearchgui':
                $rep_search = new ilRepositorySearchGUI();
                $this->ctrl->setReturn($this, 'perminfo');
                $this->ctrl->forwardCommand($rep_search);
                break;

            default:
                $cmd = $this->ctrl->getCmd();
                $this->$cmd();
                break;
        }
    }

    public function perminfo(): void
    {
        $tpl = new ilTemplate("tpl.info_layout.html", false, false, "components/ILIAS/AccessControl");

        $tpl->setVariable("INFO_SUMMARY", $this->accessStatusInfo());
        $tpl->setVariable("INFO_PERMISSIONS", $this->accessPermissionsTable());
        $tpl->setVariable("INFO_ROLES", $this->availableRolesTable());
        $tpl->setVariable("INFO_REMARK_INTERRUPTED", $this->lng->txt('info_remark_interrupted'));
        $this->tpl->setVariable("ADM_CONTENT", $tpl->get());
        $this->addToolbar();
    }

    public function addToolbar(): void
    {
        $this->toolbar->setFormAction($this->ctrl->getFormAction($this, "perminfo"));
        $this->toolbar->addText($this->lng->txt('user'));

        $login = new ilTextInputGUI($this->lng->txt("username"), "user_login");
        $login->setDataSource($this->ctrl->getLinkTargetByClass([get_class($this),
                                                                      'ilRepositorySearchGUI'
        ], 'doUserAutoComplete', '', true));
        $login->setSize(15);
        $login->setValue($this->user->getLogin());
        $this->toolbar->addInputItem($login);
        $this->toolbar->addFormButton($this->lng->txt("info_change_user_view"), "perminfo");
    }

    public function accessStatusInfo(): string
    {
        $info = new ilInfoScreenGUI(new stdClass());
        $info->setFormAction($this->ctrl->getFormAction($this));

        $info->addSection($this->lng->txt("info_access_and_status_info"));

        foreach ($this->getAccessStatusInfoData() as $data) {
            $info->addProperty($data[0], $data[1]);
        }

        return $info->getHTML();
    }

    public function accessPermissionsTable(): string
    {
        $table = new ilAccessPermissionsStatusTableGUI($this, "perminfo");

        $table->setData($this->getAccessPermissionTableData());
        $table->setTitle($this->lng->txt("info_access_permissions"));

        return $table->getHTML();
    }

    private function availableRolesTable(): string
    {
        $table = new ilAvailableRolesStatusTableGUI($this, "perminfo");

        $table->setData($this->getAvailableRolesTableData());
        $table->setTitle($this->lng->txt("info_available_roles"));

        return $table->getHTML();
    }

    public function getAssignedValidRoles(): array
    {
        $assigned_valid_roles = [];

        $ops = [];
        foreach ($this->valid_roles as $role) {
            $role_id = (int) $role["obj_id"];
            if (in_array($role_id, $this->user_roles)) {
                if ($role_id === SYSTEM_ROLE_ID) {
                    // get all possible operation of current object
                    $ops_list = ilRbacReview::_getOperationList($this->object->getType());

                    foreach ($ops_list as $ops_data) {
                        $ops[] = (int) $ops_data['ops_id'];
                    }

                    $role['ops'] = $ops;
                } else {
                    $role['ops'] = $this->rbacreview->getRoleOperationsOnObject(
                        $role_id,
                        $this->object->getRefId()
                    );
                }

                $role['translation'] = str_replace(" ", "&nbsp;", ilObjRole::_getTranslation($role["title"]));
                $assigned_valid_roles[] = $role;
            }
        }
        $this->assigned_valid_roles = $assigned_valid_roles;
        return $assigned_valid_roles;
    }

    public function getCommands(string $a_type): array
    {
        global $DIC;

        $objDefinition = $DIC['objDefinition'];

        $class = $objDefinition->getClassName($a_type);
        $location = $objDefinition->getLocation($a_type);
        $full_class = "ilObj" . $class . "Access";

        $cmds = call_user_func([$full_class, "_getCommands"]);

        $cmds[] = ['permission' => 'visible', 'cmd' => 'info'];

        return $cmds;
    }

    public function getUser(): ilObjUser
    {
        global $DIC;

        $user_login = '';
        if ($DIC->http()->wrapper()->post()->has('user_login')) {
            $user_login = $DIC->http()->wrapper()->post()->retrieve(
                'user_login',
                $DIC->refinery()->kindlyTo()->string()
            );
        }
        if (!strlen($user_login)) {
            return $DIC->user();
        }
        $user_id = ilObjUser::_lookupId($user_login);
        $user = ilObjectFactory::getInstanceByObjId($user_id, false);
        if (!$user instanceof ilObjUser || $user->getType() != 'usr') {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('info_err_user_not_exist'));
            return $DIC->user();
        }
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('info_user_view_changed'));
        return $user;
    }

    public function getAccessStatusInfoData(): array
    {
        global $DIC;

        $ilAccess = $DIC['ilAccess'];
        $infos = [];

        $result_set[0][] = $this->lng->txt('user');
        $result_set[0][] = $this->user->getFullname() . " (#" . $this->user->getId() . ")";

        $assigned_valid_roles = [];

        foreach ($this->getAssignedValidRoles() as $role) {
            $assigned_valid_roles[] = $role["translation"];
        }

        $roles_str = implode(", ", $assigned_valid_roles);

        $result_set[1][] = $this->lng->txt("roles");
        $result_set[1][] = $roles_str;

        $result_set[2][] = $this->lng->txt("status");

        $ilAccess->clear();
        $ilAccess->checkAccessOfUser(
            $this->user->getId(),
            'read',
            '',
            $this->object->getRefId(),
            $this->object->getType(),
            $this->object->getId()
        );

        $infos = array_merge($infos, $ilAccess->getInfo());

        $cmds = $this->getCommands($this->object->getType());

        foreach ($cmds as $cmd) {
            if (count($cmd) === 0) {
                continue;
            }
            $ilAccess->clear();
            $ilAccess->doStatusCheck(
                $cmd['permission'],
                $cmd['cmd'],
                $this->object->getRefId(),
                $this->user->getId(),
                $this->object->getId(),
                $this->object->getType()
            );
            $infos = array_merge($infos, $ilAccess->getInfo());
        }

        $alert = "il_ItemAlertProperty";
        $okay = "il_ItemOkayProperty";
        $text = "";

        if ($infos === []) {
            $text = "<span class=\"" . $okay . "\">" . $this->lng->txt("access") . "</span><br/> ";
        } else {
            foreach ($infos as $info) {
                switch ($info['type']) {
                    case ilAccessInfo::IL_STATUS_MESSAGE:
                        $text .= "<span class=\"" . $okay . "\">" . $info['text'] . "</span><br/> ";
                        break;

                    case ilAccessInfo::IL_NO_PARENT_ACCESS:
                        $factory = new ilObjectFactory();
                        $obj = $factory->getInstanceByRefId((int) $info['data']);
                        $text .= "<span class=\"" . $alert . "\">" . $info['text'] . " (" . $this->lng->txt("obj_" . $obj->getType()) . " #" . $obj->getId() . ": " . $obj->getTitle() . ")</span><br/> ";
                        break;

                    default:
                        $text .= "<span class=\"" . $alert . "\">" . $info['text'] . "</span><br/> ";
                        break;
                }
            }
        }

        $result_set[2][] = $text;

        return $result_set;
    }

    public function getAccessPermissionTableData(): array
    {
        global $DIC;

        $ilAccess = $DIC['ilAccess'];
        $ilObjDataCache = $DIC['ilObjDataCache'];
        $objDefinition = $DIC['objDefinition'];

        // get all possible operation of current object
        $ops_list = ilRbacReview::_getOperationList($this->object->getType());

        $counter = 0;
        $result_set = [];

        // check permissions of user
        foreach ($ops_list as $ops) {
            $access = $ilAccess->doRBACCheck(
                $ops['operation'],
                "info",
                $this->object->getRefId(),
                $this->user->getId(),
                $this->object->getType()
            );

            $result_set[$counter]["img"] = $access ? self::IMG_OK : self::IMG_NOT_OK;

            if (substr($ops['operation'], 0, 7) == "create_" &&
                $objDefinition->isPlugin(substr($ops['operation'], 7))) {
                $result_set[$counter]["operation"] = ilObjectPlugin::lookupTxtById(
                    substr($ops['operation'], 7),
                    'obj_' . substr($ops['operation'], 7)
                );
            } elseif ($objDefinition->isPlugin($this->object->getType())) {
                $result_set[$counter]["operation"] = ilObjectPlugin::lookupTxtById(
                    $this->object->getType(),
                    $this->object->getType() . "_" . $ops['operation']
                );
            } elseif (substr($ops['operation'], 0, 7) == 'create_') {
                $result_set[$counter]["operation"] = $this->lng->txt('rbac_' . $ops['operation']);
            } else {
                $result_set[$counter]["operation"] = $this->lng->txt($this->object->getType() . "_" . $ops['operation']);
            }

            $list_role = [];

            // Check ownership
            if ($this->user->getId() == $ilObjDataCache->lookupOwner($this->object->getId())) {
                if (
                    (substr($ops['operation'], 0, 7) !== 'create_') and
                    ($ops['operation'] !== 'edit_permission') and
                    ($ops['operation'] !== 'edit_learning_progress')
                ) {
                    $list_role[] = $this->lng->txt('info_owner_of_object');
                }
            }
            // get operations on object for each assigned role to user
            foreach ($this->getAssignedValidRoles() as $role) {
                if (in_array($ops['ops_id'], $role['ops'])) {
                    $list_role[] = $role['translation'];
                }
            }

            if (empty($list_role)) {
                $list_role[] = $this->lng->txt('none');
            }

            $result_set[$counter]["role_ownership"] = $list_role;

            ++$counter;
        }

        return $result_set;
    }

    private function getAvailableRolesTableData(): array
    {
        global $DIC;

        $tree = $DIC['tree'];

        $path = array_reverse($tree->getPathId($this->object->getRefId()));

        $counter = 0;

        $result_set = [];
        foreach ($this->valid_roles as $role) {
            $role_id = (int) $role["obj_id"];
            $result_set[$counter]["img"] = in_array(
                $role_id,
                $this->user_roles
            ) ? self::IMG_OK : self::IMG_NOT_OK;

            if (is_subclass_of($this->object, ilObjectPlugin::class) && $role["parent"] == $this->object->getRefId()) {
                $result_set[$counter][] = ilObjectPlugin::lookupTxtById(
                    $this->object->getType(),
                    ilObjRole::_removeObjectId($role["title"])
                );
            } else {
                $result_set[$counter][] = str_replace(" ", "&nbsp;", ilObjRole::_getTranslation($role["title"]));
            }

            $result_set[$counter]["role"] = str_replace(" ", "&nbsp;", ilObjRole::_getTranslation($role["title"]));


            if ($role['role_type'] != "linked") {
                $result_set[$counter]["effective_from"] = "";
            } else {
                $rolfs = $this->rbacreview->getFoldersAssignedToRole($role_id);

                // ok, try to match the next rolf in path
                foreach ($path as $node) {
                    if ($node == 1) {
                        break;
                    }

                    if (in_array($node, $rolfs)) {
                        $nodedata = $tree->getNodeData($node);
                        $result_set[$counter]["effective_from"] = $nodedata["title"];
                        $result_set[$counter]["effective_from_ref_id"] = $node;
                        break;
                    }
                }
            }

            if (in_array($role['obj_id'], $this->global_roles)) {
                $result_set[$counter]["original_position"] = $this->lng->txt("global");
                $result_set[$counter]["original_position_ref_id"] = false;
            } else {
                $rolf = $this->rbacreview->getFoldersAssignedToRole($role_id, true);
                $parent_node = $tree->getNodeData($rolf[0]);
                if (!array_key_exists('ref_id', $parent_node)) {
                    unset($result_set[$counter]);
                    continue;
                }
                $result_set[$counter]['original_position'] = $parent_node['title'];
                $result_set[$counter]['original_position_ref_id'] = $parent_node['ref_id'];
            }

            ++$counter;
        }
        return $result_set;
    }
}