class.ilObjDataCollectionAccess.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilObjDataCollectionAccess extends ilObjectAccess
{
    public static function _getCommands(): array
    {
        $commands = [
            ["permission" => "read", "cmd" => "render", "lang_var" => "show", "default" => true],
            ["permission" => "write", "cmd" => "listRecords", "lang_var" => "edit_content"],
            ["permission" => "write", "cmd" => "edit", "lang_var" => "settings"],
        ];

        return $commands;
    }

    public static function _checkGoto(string $target): bool
    {
        global $DIC;
        $ilAccess = $DIC['ilAccess'];

        $t_arr = explode("_", $target);
        $ref_id = (int) $t_arr[1];

        if ($t_arr[0] != "dcl" || $ref_id <= 0) {
            return false;
        }

        if ($ilAccess->checkAccess("read", "", $ref_id) ||
            $ilAccess->checkAccess("visible", "", $ref_id)) {
            return true;
        }

        return false;
    }

    protected static function isTableInDataCollection(ilDclTable $table, int $ref_id): bool
    {
        if ($table->getObjId() !== null) {
            foreach (ilObjDataCollection::_getAllReferences($table->getObjId()) as $reference) {
                if ($reference == $ref_id) {
                    return true;
                }
            }
        }

        return false;
    }

    public function _checkAccess(string $cmd, string $permission, int $ref_id, int $obj_id, ?int $user_id = null): bool
    {
        global $DIC;
        $ilUser = $DIC['ilUser'];
        $lng = $DIC['lng'];
        $rbacsystem = $DIC['rbacsystem'];
        $ilAccess = $DIC['ilAccess'];

        if (is_null($user_id) === true) {
            $user_id = $ilUser->getId();
        }

        switch ($cmd) {
            case "view":

                if (!ilObjDataCollectionAccess::_lookupOnline($obj_id)
                    && !$rbacsystem->checkAccessOfUser($user_id, 'write', $ref_id)
                ) {
                    $ilAccess->addInfoItem(ilAccessInfo::IL_NO_OBJECT_ACCESS, $lng->txt("offline"));

                    return false;
                }
                break;

                // for permission query feature
            case "infoScreen":
                if (!ilObjDataCollectionAccess::_lookupOnline($obj_id)) {
                    $ilAccess->addInfoItem(ilAccessInfo::IL_NO_OBJECT_ACCESS, $lng->txt("offline"));
                } else {
                    $ilAccess->addInfoItem(ilAccessInfo::IL_STATUS_MESSAGE, $lng->txt("online"));
                }
                break;
        }
        switch ($permission) {
            case "read":
            case "visible":
                if (!ilObjDataCollectionAccess::_lookupOnline($obj_id)
                    && (!$rbacsystem->checkAccessOfUser($user_id, 'write', $ref_id))
                ) {
                    $ilAccess->addInfoItem(ilAccessInfo::IL_NO_OBJECT_ACCESS, $lng->txt("offline"));

                    return false;
                }
                break;
        }

        return true;
    }

    public static function _lookupOnline(int $a_id): bool
    {
        global $DIC;
        $ilDB = $DIC->database();

        $q = "SELECT * FROM il_dcl_data WHERE id = " . $ilDB->quote($a_id, "integer");
        $dcl_set = $ilDB->query($q);
        $dcl_rec = $ilDB->fetchAssoc($dcl_set);

        return !is_null($dcl_rec) && $dcl_rec["is_online"];
    }

    //
    // DataCollection specific Access-Checks
    //

    public static function checkAccessForDataCollectionId(int $data_collection_id): bool
    {
        global $DIC;
        $ilAccess = $DIC['ilAccess'];

        $perm = false;
        $references = ilObject2::_getAllReferences($data_collection_id);

        if ($ilAccess->checkAccess("add_entry", "", array_shift($references))) {
            $perm = true;
        }

        return $perm;
    }

    public static function checkActionForObjId(string $action, int $obj_id): bool
    {
        foreach (ilObject2::_getAllReferences($obj_id) as $ref_id) {
            if (self::checkActionForRefId($action, $ref_id)) {
                return true;
            }
        }

        return false;
    }

    public static function checkActionForRefId(string $action, int $ref_id): bool
    {
        global $DIC;
        $ilAccess = $DIC['ilAccess'];

        return $ilAccess->checkAccess($action, "", $ref_id);
    }

    public static function hasWriteAccess(int $ref, ?int $user_id = 0): bool
    {
        global $DIC;
        $ilAccess = $DIC['ilAccess'];

        if ($user_id) {
            return $ilAccess->checkAccessOfUser($user_id, "write", "", $ref);
        }

        return $ilAccess->checkAccess("write", "", $ref);
    }

    public static function hasEditAccess(int $ref, ?int $user_id = 0): bool
    {
        global $DIC;
        $ilAccess = $DIC['ilAccess'];

        if ($user_id) {
            return $ilAccess->checkAccessOfUser($user_id, "write", "", $ref);
        }

        return $ilAccess->checkAccess("edit_content", "", $ref);
    }

    public static function hasAddRecordAccess(int $ref, ?int $user_id = 0): bool
    {
        global $DIC;
        $ilAccess = $DIC['ilAccess'];

        if ($user_id) {
            return $ilAccess->checkAccessOfUser($user_id, "write", "", $ref);
        }

        return $ilAccess->checkAccess("add_entry", "", $ref);
    }

    public static function hasReadAccess(int $ref, ?int $user_id = 0): bool
    {
        global $DIC;
        $ilAccess = $DIC['ilAccess'];

        if ($user_id) {
            return $ilAccess->checkAccessOfUser($user_id, "write", "", $ref);
        }

        return $ilAccess->checkAccess("read", "", $ref);
    }

    public static function hasAccessToTableView(ilDclTableView $tableview, ?int $user_id = 0): bool
    {
        global $DIC;
        $rbacreview = $DIC['rbacreview'];
        $ilUser = $DIC['ilUser'];

        $assigned_roles = $rbacreview->assignedRoles($user_id ?: $ilUser->getId());
        $allowed_roles = $tableview->getRoles();

        return !empty(array_intersect($assigned_roles, $allowed_roles));
    }

    protected static function hasAccessToTable(int $table_id, int $ref_id): bool
    {
        $table = ilDclCache::getTableCache($table_id);
        return self::hasWriteAccess($ref_id) || $table->getIsVisible();
    }

    public static function hasAccessTo(int $ref_id, int $table_id, int $tableview_id): bool
    {
        $tableview = ilDclTableView::find($tableview_id);
        $table = ilDclCache::getTableCache($table_id);

        // is tableview in table and is table in datacollection
        if (($tableview->getTableId() !== $table_id)
            || !self::isTableInDataCollection($table, $ref_id)
        ) {
            return false;
        }

        // check access
        return self::hasWriteAccess($ref_id)
            || (
                self::hasReadAccess($ref_id) && self::hasAccessToTable($table_id, $ref_id) && self::hasAccessToTableView($tableview)
            );
    }

    public static function hasAccessToFields(int $ref_id, int $table_id): bool
    {
        return self::isTableInDataCollection(ilDclCache::getTableCache($table_id), $ref_id)
            && (self::hasWriteAccess($ref_id));
    }

    public static function hasAccessToEditTable(int $ref_id, int $table_id): bool
    {
        return self::hasAccessToFields($ref_id, $table_id);
    }

    public static function hasAccessToField(int $ref_id, int $table_id, int $field_id): bool
    {
        $table = ilDclCache::getTableCache($table_id);

        return in_array($field_id, $table->getFieldIds()) && self::hasAccessToFields($ref_id, $table_id);
    }

    public static function hasPermissionToAddRecord(int $ref_id, int $table_id): bool
    {
        $table = ilDclCache::getTableCache($table_id);
        if (!self::isTableInDataCollection($table, $ref_id)) {
            return false;
        }

        return ilObjDataCollectionAccess::hasWriteAccess($ref_id)
            || (ilObjDataCollectionAccess::hasAddRecordAccess($ref_id) && $table->getAddPerm() && $table->checkLimit());
    }
}