This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilObjFileBasedLMAccess:

Collaboration diagram for ilObjFileBasedLMAccess:

Public Member Functions
	__construct ()

	_checkAccess (string $cmd, string $permission, int $ref_id, int $obj_id, ?int $user_id=null)
	Checks whether a user may invoke a command or not (this method is called by ilAccessHandler::checkAccess) More...

Public Member Functions inherited from ilObjectAccess
	_checkAccess (string $cmd, string $permission, int $ref_id, int $obj_id, ?int $user_id=null)
	Checks whether a user may invoke a command or not (this method is called by ilAccessHandler::checkAccess) More...

	canBeDelivered (ilWACPath $ilWACPath)

	canBeDelivered (ilWACPath $ilWACPath)

Static Public Member Functions
static	_getCommands ()
	get commands More...

static	_determineStartUrl (int $a_id)

static	locateStartFileInArchive (\ZipArchive $archive, string $start_file)
	Returns the stored start file if the archive contains it, otherwise falls back to index.html and index.htm in the root of the archive, as for learning modules which have not been migrated yet. More...

static	_checkGoto (string $target)
	check whether goto script will succeed More...

static	_lookupDiskUsage (int $a_id)
	Returns the number of bytes used on the harddisk by the learning module with the specified object id. More...

static	_preloadData (array $obj_ids, array $ref_ids)
	Preload data. More...

static	isInfoEnabled (int $obj_id)

Static Public Member Functions inherited from ilObjectAccess
static	_getCommands ()
	get commands More...

static	_checkGoto (string $target)
	check whether goto script will succeed More...

static	_isOffline (int $obj_id)
	Type-specific implementation of general status, has to be overwritten if object type does not support centralized offline handling. More...

static	_preloadData (array $obj_ids, array $ref_ids)
	Preload data. More...

Static Public Attributes
static array	$startfile = []

Protected Attributes
ilObjUser	$user

ilLanguage	$lng

ilRbacSystem	$rbacsystem

ilAccessHandler	$access

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 22 of file class.ilObjFileBasedLMAccess.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjFileBasedLMAccess::__construct ( )

Definition at line 31 of file class.ilObjFileBasedLMAccess.php.

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

References $DIC, ILIAS\Repository\access(), ILIAS\Repository\lng(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

◆ _checkAccess()

ilObjFileBasedLMAccess::_checkAccess	(	string	$cmd,
		string	$permission,
		int	$ref_id,
		int	$obj_id,
		?int	$user_id = `null`
	)

Checks whether a user may invoke a command or not (this method is called by ilAccessHandler::checkAccess)

Please do not check any preconditions handled by ilConditionHandler here. Also don't do any RBAC checks.

Reimplemented from ilObjectAccess.

Definition at line 41 of file class.ilObjFileBasedLMAccess.php.

                                                                                                                 : 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;
    }

References $access, $lng, ilRBACAccessHandler\addInfoItem(), ilAccessInfo\IL_NO_OBJECT_ACCESS, and ilLanguage\txt().

Here is the call graph for this function:

◆ _checkGoto()

static ilObjFileBasedLMAccess::_checkGoto ( string $target )

static

check whether goto script will succeed

Reimplemented from ilObjectAccess.

Definition at line 152 of file class.ilObjFileBasedLMAccess.php.

                                                     : 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;
    }

References $DIC, and ILIAS\Scripts\PHPStan\$target.

◆ _determineStartUrl()

static ilObjFileBasedLMAccess::_determineStartUrl ( int $a_id )

static

Definition at line 74 of file class.ilObjFileBasedLMAccess.php.

                                                        : 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] = "";
            }
            // Locate the single stored path. Unzip::getFiles() yields nothing when the
            // archive exceeds the decompression-bomb limits, which hides a valid start file.
            $stream = $DIC->resourceStorage()->consume()->stream($rid)->getStream();
            $uri = $stream->getMetadata()['uri'] ?? '';
            $archive = new \ZipArchive();
            $found = "";
            if (is_string($uri) && $uri !== '' && $archive->open($uri, \ZipArchive::RDONLY) === true) {
                $found = self::locateStartFileInArchive($archive, $start_file);
                $archive->close();
            }
            return $startfile[$a_id] = $found;
        }
 
        // 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] = "";
    }

References $DIC, $ilDB, $startfile, ilFileUtils\getWebspaceDir(), and locateStartFileInArchive().

Referenced by ilObjFileBasedLMListGUI\getProperties(), ilObjFileBasedLMGUI\getSettingsFormValues(), ilObjFileBasedLMGUI\getTabs(), and ilObjFileBasedLMGUI\initSettingsForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getCommands()

static ilObjFileBasedLMAccess::_getCommands ( )

static

get commands

this method returns an array of all possible commands/permission combinations

example: $commands = array ( array("permission" => "read", "cmd" => "view", "lang_var" => "show"), array("permission" => "write", "cmd" => "edit", "lang_var" => "edit"), );

Returns: array{permission?:string, cmd?:string, lang_var?:string, default?:bool}[]

Reimplemented from ilObjectAccess.

Definition at line 58 of file class.ilObjFileBasedLMAccess.php.

                                         : 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"]
        ];
    }

Referenced by ilObjFileBasedLMListGUI\init().

Here is the caller graph for this function:

◆ _lookupDiskUsage()

static ilObjFileBasedLMAccess::_lookupDiskUsage ( int $a_id )

static

Returns the number of bytes used on the harddisk by the learning module with the specified object id.

Definition at line 175 of file class.ilObjFileBasedLMAccess.php.

                                                      : 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;
    }

References ilFileUtils\dirsize(), and ilFileUtils\getWebspaceDir().

Here is the call graph for this function:

◆ _preloadData()

static ilObjFileBasedLMAccess::_preloadData	(	array	$obj_ids,
		array	$ref_ids
	)

static

Preload data.

Reimplemented from ilObjectAccess.

Definition at line 183 of file class.ilObjFileBasedLMAccess.php.

                                                                       : 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"] . "";
        }
    }

References $DIC, $ilDB, and $lm_set.

◆ isInfoEnabled()

static ilObjFileBasedLMAccess::isInfoEnabled ( int $obj_id )

static

Definition at line 198 of file class.ilObjFileBasedLMAccess.php.

                                                     : bool
    {
        return ilContainer::_lookupContainerSetting(
            $obj_id,
            ilObjectServiceSettingsGUI::INFO_TAB_VISIBILITY,
            true
        );
    }

References ilContainer\_lookupContainerSetting(), and ilObjectServiceSettingsGUI\INFO_TAB_VISIBILITY.

Referenced by ilObjFileBasedLMListGUI\getInfoScreenStatus().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ locateStartFileInArchive()

static ilObjFileBasedLMAccess::locateStartFileInArchive	(	\ZipArchive	$archive,
		string	$start_file
	)

static

Returns the stored start file if the archive contains it, otherwise falls back to index.html and index.htm in the root of the archive, as for learning modules which have not been migrated yet.

Many learning modules have no start file stored at all.

Definition at line 141 of file class.ilObjFileBasedLMAccess.php.

                                                                                             : string
    {
        $candidates = array_filter([$start_file, 'index.html', 'index.htm'], static fn(string $c): bool => $c !== '');
        foreach ($candidates as $candidate) {
            if ($archive->locateName($candidate) !== false) {
                return $candidate;
            }
        }
        return "";
    }