class.ilObjFileBasedLMAccess.php

Go to the documentation of this file.

<?php

class ilObjFileBasedLMAccess extends ilObjectAccess
{
    protected ilObjUser $user;
    protected ilLanguage $lng;
    protected ilRbacSystem $rbacsystem;
    protected ilAccessHandler $access;
    public static array $startfile = [];

    public function __construct()
    {
        global $DIC;

        $this->user = $DIC->user();
        $this->lng = $DIC->language();
        $this->rbacsystem = $DIC->rbac()->system();
        $this->access = $DIC->access();
    }

    public function _checkAccess(string $cmd, string $permission, int $ref_id, int $obj_id, ?int $user_id = null): bool
    {
        $lng = $this->lng;
        $ilAccess = $this->access;

        switch ($permission) {
            case "read":

                if (self::_determineStartUrl($obj_id) === "") {
                    $ilAccess->addInfoItem(ilAccessInfo::IL_NO_OBJECT_ACCESS, $lng->txt("offline"));
                    return false;
                }
                break;
        }
        return true;
    }

    public static function _getCommands(): array
    {
        return [
            [
                "permission" => "read", "cmd" => "view", "lang_var" => "show",
                "default" => true
            ],
            ["permission" => "write", "cmd" => "edit", "lang_var" => "edit_content"],
            ["permission" => "write", "cmd" => "properties", "lang_var" => "settings"]
        ];
    }

    //
    // access relevant methods
    //

    public static function _determineStartUrl(int $a_id): string
    {
        global $DIC;

        static $startfile = [];
        if (isset($startfile[$a_id])) {
            return $startfile[$a_id];
        }

        $ilDB = $DIC->database();

        $q = "SELECT startfile, rid FROM file_based_lm WHERE id = " . $ilDB->quote($a_id, "integer");
        $set = $ilDB->query($q);
        $rec = $ilDB->fetchAssoc($set);
        $start_file = $rec["startfile"] ?? '';

        // Migrated learning module
        if (!empty($rec['rid'])) {
            // check if the file is available in the container
            $rid = $DIC->resourceStorage()->manageContainer()->find($rec['rid']);
            if (!$rid) {
                return $startfile[$a_id] = "";
            }
            $zip = $DIC->resourceStorage()->consume()->containerZIP($rid)->getZIP();
            foreach ($zip->getFiles() as $file) {
                if ($file === $start_file) {
                    return $startfile[$a_id] = $start_file;
                }
            }
            return $startfile[$a_id] = "";
        }

        // Old learning module
        $dir = realpath(__DIR__ . '/../../../../public/' . ilFileUtils::getWebspaceDir() . "/lm_data/lm_" . $a_id);

        if (($start_file !== "") && (is_file($dir . "/" . $start_file))) {
            return $startfile[$a_id] = str_replace(
                realpath(__DIR__ . '/../../../../public/'),
                "",
                $dir . "/" . $start_file
            );
        }

        if (is_file($dir . "/index.html")) {
            return $startfile[$a_id] = str_replace(
                realpath(__DIR__ . '/../../../../public/'),
                "",
                $dir . "/index.html"
            );
        }

        if (is_file($dir . "/index.htm")) {
            return $startfile[$a_id] = str_replace(realpath(__DIR__ . '/../../../../public/'), "", $dir . "/index.htm");
        }

        return $startfile[$a_id] = "";
    }

    public static function _checkGoto(string $target): bool
    {
        global $DIC;

        $ilAccess = $DIC->access();

        $t_arr = explode("_", $target);

        if ($t_arr[0] !== "htlm" || ((int) $t_arr[1]) <= 0) {
            return false;
        }

        if ($ilAccess->checkAccess("visible", "", $t_arr[1]) ||
            $ilAccess->checkAccess("read", "", $t_arr[1])) {
            return true;
        }
        return false;
    }

    public static function _lookupDiskUsage(int $a_id): int
    {
        $lm_data_dir = ilFileUtils::getWebspaceDir('filesystem') . "/lm_data";
        $lm_dir = $lm_data_dir . DIRECTORY_SEPARATOR . "lm_" . $a_id;

        return file_exists($lm_dir) ? ilFileUtils::dirsize($lm_dir) : 0;
    }

    public static function _preloadData(array $obj_ids, array $ref_ids): void
    {
        global $DIC;

        $ilDB = $DIC->database();

        $q = "SELECT id, startfile FROM file_based_lm WHERE " .
            $ilDB->in("id", $obj_ids, false, "integer");

        $lm_set = $ilDB->query($q);
        while ($rec = $ilDB->fetchAssoc($lm_set)) {
            self::$startfile[$rec["id"]] = $rec["startfile"] . "";
        }
    }

    public static function isInfoEnabled(int $obj_id): bool
    {
        return ilContainer::_lookupContainerSetting(
            $obj_id,
            ilObjectServiceSettingsGUI::INFO_TAB_VISIBILITY,
            true
        );
    }
}