ilObjFileAccess Class Reference

Access class for file objects. More...

Inheritance diagram for ilObjFileAccess:

Collaboration diagram for ilObjFileAccess:

Public Member Functions
	canBeDelivered (ilWACPath $ilWACPath)
	_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)

Static Public Member Functions
static	_getCommands ()
	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"), ); More...
static	_checkGoto (string $a_target)
	check whether goto script will succeed More...
static	_shouldDownloadDirectly (int $obj_id)
static	_lookupFileSize (int $a_id, bool $by_reference=true)
static	_getFileExtension (string $a_file_name)
	Gets the file extension of the specified file name. More...
static	_isFileHidden (string $a_file_name)
	Returns true, if a file with the specified name, is usually hidden from the user. More...
static	_appendNumberOfCopyToFilename ($a_file_name, $nth_copy=null)
	Appends the text " - Copy" to a filename in the language of the current user. More...
static	_getPermanentDownloadLink (int $ref_id)
	Gets the permanent download link for the file. More...
static	_preloadData (array $obj_ids, array $ref_ids)
static	_lookupOnline (int $a_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 Protected Attributes
static array	$inline_file_extensions = []
	Contains an array of extensions separated by space. More...
static array	$preload_list_gui_data = []

Detailed Description

Access class for file objects.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Stefan Born stefa.nosp@m.n.bo.nosp@m.rn@ph.nosp@m.zh.c.nosp@m.h

Version

$Id$ \

Definition at line 30 of file class.ilObjFileAccess.php.

Member Function Documentation

_appendNumberOfCopyToFilename()

static ilObjFileAccess::_appendNumberOfCopyToFilename (   $a_file_name,   $nth_copy = null  )

static

Appends the text " - Copy" to a filename in the language of the current user.

If the provided $nth_copy parameter is greater than 1, then is appended in round brackets. If $nth_copy parameter is null, then the function determines the copy number on its own. If this function detects, that the filename already ends with " - Copy", or with "- Copy ($nth_copy), it only appends the number of the copy to the filename. This function retains the extension of the filename. Examples:

• Calling ilObjFileAccess::_appendCopyToTitle('Hello.txt', 1) returns: "Hello - Copy.txt".
• Calling ilObjFileAccess::_appendCopyToTitle('Hello.txt', 2) returns: "Hello - Copy (2).txt".
• Calling ilObjFileAccess::_appendCopyToTitle('Hello - Copy (3).txt', 2) returns: "Hello - Copy (2).txt".
• Calling ilObjFileAccess::_appendCopyToTitle('Hello - Copy (3).txt', null) returns: "Hello - Copy (4).txt".

Definition at line 284 of file class.ilObjFileAccess.php.

References $DIC, $lng, and null.

Referenced by ilContainerGUI\performPasteIntoMultipleObjectsObject().

                                                                                        : string
    {
        global $DIC;
        $lng = $DIC['lng'];

        $filenameWithoutExtension = $a_file_name;

        $extension = null;

        // create a regular expression from the language text copy_n_of_suffix, so that
        // we can match it against $filenameWithoutExtension, and retrieve the number of the copy.
        // for example, if copy_n_of_suffix is 'Copy (%1s)', this creates the regular
        // expression '/ Copy \\([0-9]+)\\)$/'.
        $nthCopyRegex = preg_replace(
            '/([\^$.\[\]|()?*+{}])/',
            '\\\\${1}',
            ' '
            . $lng->txt('copy_n_of_suffix')
        );
        $nthCopyRegex = '/' . preg_replace('/%1\\\\\$s/', '(\d+)', (string) $nthCopyRegex) . '$/';

        // Get the filename without any previously added number of copy.
        // Determine the number of copy, if it has not been specified.
        if (preg_match($nthCopyRegex, (string) $filenameWithoutExtension, $matches)) {
            // this is going to be at least the third copy of the filename
            $filenameWithoutCopy = substr((string) $filenameWithoutExtension, 0, -strlen($matches[0]));
            if ($nth_copy == null) {
                $nth_copy = $matches[1] + 1;
            }
        } elseif (str_ends_with((string) $filenameWithoutExtension, ' ' . $lng->txt('copy_of_suffix'))) {
            // this is going to be the second copy of the filename
            $filenameWithoutCopy = substr(
                (string) $filenameWithoutExtension,
                0,
                -strlen(
                    ' '
                    . $lng->txt('copy_of_suffix')
                )
            );
            if ($nth_copy == null) {
                $nth_copy = 2;
            }
        } else {
            // this is going to be the first copy of the filename
            $filenameWithoutCopy = $filenameWithoutExtension;
            if ($nth_copy == null) {
                $nth_copy = 1;
            }
        }

        // Construct the new filename
        if ($nth_copy > 1) {
            // this is at least the second copy of the filename, append " - Copy ($nth_copy)"
            return $filenameWithoutCopy . sprintf(
                ' '
                    . $lng->txt('copy_n_of_suffix'),
                $nth_copy
            )
                . $extension;
        }

        // this is the first copy of the filename, append " - Copy"
        return $filenameWithoutCopy . ' ' . $lng->txt('copy_of_suffix') . $extension;
    }

Here is the caller graph for this function:

_checkAccess()

ilObjFileAccess::_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)

Definition at line 127 of file class.ilObjFileAccess.php.

References $DIC, $lng, $user_id, ilAccessInfo\IL_NO_OBJECT_ACCESS, and ilAccessInfo\IL_STATUS_MESSAGE.

                                                                                                                 : bool
    {
        global $DIC;
        $ilUser = $DIC['ilUser'];
        $lng = $DIC['lng'];
        $rbacsystem = $DIC['rbacsystem'];
        $ilAccess = $DIC['ilAccess'];
        if (is_null($user_id)) {
            $user_id = $ilUser->getId();
        }

        switch ($cmd) {
            case "view":
                if (!self::_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 Capabilities::INFO_PAGE->value:
                if (!self::_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 (!self::_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;
    }

_checkGoto()

static ilObjFileAccess::_checkGoto ( string  $a_target )

static

check whether goto script will succeed

Definition at line 177 of file class.ilObjFileAccess.php.

References $DIC, and ilSharedResourceGUI\hasAccess().

                                                       : bool
    {
        global $DIC;
        $ilAccess = $DIC['ilAccess'];

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

        // personal workspace context: do not force normal login
        if (isset($t_arr[2]) && $t_arr[2] === "wsp") {
            return ilSharedResourceGUI::hasAccess($t_arr[1]);
        }
        if ($t_arr[0] !== "file") {
            return false;
        }
        if (((int) $t_arr[1]) <= 0) {
            return false;
        }
        if ($ilAccess->checkAccess("visible", "", $t_arr[1])) {
            return true;
        }
        return (bool) $ilAccess->checkAccess("read", "", $t_arr[1]);
    }

Here is the call graph for this function:

_getCommands()

static ilObjFileAccess::_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<int, mixed[]>

Definition at line 75 of file class.ilObjFileAccess.php.

Referenced by ilObjFileListGUI\init().

                                         : array
    {
        return [
            [
                "permission" => Permissions::READ->value,
                "cmd" => Capabilities::DOWNLOAD->value,
                "lang_var" => "download",
                // "default" => true, // we decide the best matching capability later in ListGUI
            ],
            [
                "permission" => Permissions::VISIBLE->value,
                "cmd" => Capabilities::INFO_PAGE->value,
                "lang_var" => "info",
            ],
            [
                "permission" => Permissions::VISIBLE->value,
                "cmd" => Capabilities::FORCED_INFO_PAGE->value,
                "lang_var" => "info",
            ],
            [
                "permission" => Permissions::WRITE->value,
                "cmd" => Capabilities::UNZIP->value,
                "lang_var" => "unzip",
            ],
            [
                "permission" => Permissions::EDIT_CONTENT->value,
                "cmd" => Capabilities::EDIT_EXTERNAL->value,
                "lang_var" => "open_external_editor",
            ],
            [
                "permission" => Permissions::VIEW_CONTENT->value,
                "cmd" => Capabilities::VIEW_EXTERNAL->value,
                "lang_var" => "open_external_viewer",
            ],
            [
                "permission" => Permissions::WRITE->value,
                "cmd" => Capabilities::MANAGE_VERSIONS->value,
                "lang_var" => "versions",
            ],
            [
                "permission" => Permissions::WRITE->value,
                "cmd" => Capabilities::EDIT_SETTINGS->value,
                "lang_var" => "settings"
            ]
        ];
    }

Here is the caller graph for this function:

_getFileExtension()

static ilObjFileAccess::_getFileExtension ( string  $a_file_name )

static

Gets the file extension of the specified file name.

The file name extension is converted to lower case before it is returned. For example, for the file name "HELLO.MP3", this function returns "mp3". A file name extension can have multiple parts. For the file name "hello.tar.gz", this function returns "gz".

Definition at line 241 of file class.ilObjFileAccess.php.

                                                                 : string
    {
        if (preg_match('/\.([a-z0-9]+)\z/i', $a_file_name, $matches) == 1) {
            return strtolower($matches[1]);
        }
        return '';
    }

_getPermanentDownloadLink()

static ilObjFileAccess::_getPermanentDownloadLink ( int  $ref_id )

static

Gets the permanent download link for the file.

Definition at line 352 of file class.ilObjFileAccess.php.

References ilLink\_getStaticLink().

Referenced by ilObjFileGUI\buildInfoScreen().

                                                                 : string
    {
        return ilLink::_getStaticLink($ref_id, "file", true, "download");
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_isFileHidden()

static ilObjFileAccess::_isFileHidden ( string  $a_file_name )

static

Returns true, if a file with the specified name, is usually hidden from the user.

• Filenames starting with '.' are hidden Unix files
• Filenames ending with '~' are temporary Unix files
• Filenames starting with '~$' are temporary Windows files
• The file "Thumbs.db" is a hidden Windows file

Definition at line 257 of file class.ilObjFileAccess.php.

Referenced by ilItemGroupItems\getAssignableItems(), ILIAS\Export\ExportHandler\Manager\Handler\getObjectIdCollectionBuilderFrom(), ilContainer\getSubItems(), ILIAS\UI\Component\Legacy\Content\ItemSetManager\groupItems(), ilObjFile\isHidden(), and ilExportSelectionTableGUI\parseContainer().

                                                             : bool
    {
        return str_starts_with($a_file_name, '.') || str_ends_with($a_file_name, '~')
            || str_starts_with($a_file_name, '~$')
            || $a_file_name === 'Thumbs.db';
    }

Here is the caller graph for this function:

_lookupFileSize()

static ilObjFileAccess::_lookupFileSize ( int  $a_id, bool  $by_reference = true  )

static

Deprecated:

Definition at line 222 of file class.ilObjFileAccess.php.

References $info.

Referenced by ilCheckSumOfWorkspaceFileSizesJob\calculateRecursive(), and ilCheckSumOfFileSizesJob\calculateRecursive().

                                                                                : int
    {
        try {
            $info_repo = new ilObjFileInfoRepository();
            $info = $by_reference ? $info_repo->getByRefId($a_id) : $info_repo->getByObjectId($a_id);

            return (int) $info->getFileSize()->inBytes();
        } catch (Throwable) {
            return 0;
        }
    }

Here is the caller graph for this function:

_lookupOnline()

static ilObjFileAccess::_lookupOnline ( int  $a_obj_id )

static

Definition at line 367 of file class.ilObjFileAccess.php.

                                                       : bool
    {
        // TODO: remove this call to LocalDIC, since this is an internal class, see https://mantis.ilias.de/view.php?id=45558
        return LocalDIC::dic()['properties.aggregator']->getFor($a_obj_id, 'file')->getPropertyIsOnline()->getIsOnline();
    }

_preloadData()

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

static

Parameters

int[]	$obj_ids
int[]	$ref_ids

Definition at line 361 of file class.ilObjFileAccess.php.

References $info.

                                                                       : void
    {
        $info = new ilObjFileInfoRepository();
        $info->preloadData($obj_ids);
    }

_shouldDownloadDirectly()

static ilObjFileAccess::_shouldDownloadDirectly ( int  $obj_id )

static

Definition at line 200 of file class.ilObjFileAccess.php.

References $DIC, and ilObjFile\CLICK_MODE_DOWNLOAD.

Referenced by ilObjFileListGUI\getCommandLink().

                                                               : bool
    {
        global $DIC;

        $result = $DIC->database()->fetchAssoc(
            $DIC->database()->queryF(
                "SELECT on_click_mode FROM file_data WHERE file_id = %s;",
                ['integer'],
                [$obj_id]
            )
        );

        if (empty($result)) {
            return false;
        }

        return (((int) $result['on_click_mode']) === ilObjFile::CLICK_MODE_DOWNLOAD);
    }

Here is the caller graph for this function:

canBeDelivered()

ilObjFileAccess::canBeDelivered

(

ilWACPath

$ilWACPath

)

Implements ilWACCheckingClass.

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

                                                        : bool
    {
        return false;
    }

Field Documentation

$inline_file_extensions

array ilObjFileAccess::$inline_file_extensions = []

staticprotected

Contains an array of extensions separated by space.

Since this array is needed for every file object displayed on a repository page, we only create it once, and cache it here.

Definition at line 37 of file class.ilObjFileAccess.php.

$preload_list_gui_data

array ilObjFileAccess::$preload_list_gui_data = []

staticprotected

Definition at line 39 of file class.ilObjFileAccess.php.

---

The documentation for this class was generated from the following file:

• components/ILIAS/File/classes/class.ilObjFileAccess.php