class.ilObjFileAccess.php

Go to the documentation of this file.

<?php

use ILIAS\DI\Container;
use ILIAS\FileUpload\MimeType;

class ilObjFileAccess extends ilObjectAccess implements ilWACCheckingClass
{
    protected static array $inline_file_extensions = [];

    protected static array $preload_list_gui_data = [];


    protected function checkAccessToObjectId(int $obj_id): bool
    {
        global $DIC;
        $ilAccess = $DIC['ilAccess'];
        foreach (ilObject::_getAllReferences($obj_id) as $ref_id) {
            if ($ilAccess->checkAccess('read', '', $ref_id)) {
                return true;
            }
        }

        return false;
    }

    public function canBeDelivered(ilWACPath $ilWACPath): bool
    {
        switch ($ilWACPath->getSecurePathId()) {
            case 'previews':
                preg_match('/\/previews\/[\d\/]{0,}\/preview_([\d]{0,})\//uU', $ilWACPath->getPath(), $matches);
                $obj_id = (int) $matches[1];
                break;
            default:
                $obj_id = -1;
                break;
        }

        return $this->checkAccessToObjectId($obj_id);
    }



    public static function _getCommands(): array
    {
        $commands = array();
        $commands[] = array(
            "permission" => "read",
            "cmd" => "sendfile",
            "lang_var" => "download",
            "default" => true,
        );
        $commands[] = array(
            "permission" => "write",
            "cmd" => ilFileVersionsGUI::CMD_UNZIP_CURRENT_REVISION,
            "lang_var" => "unzip",
        );
        $commands[] = array(
            "permission" => "write",
            "cmd" => "versions",
            "lang_var" => "versions",
        );
        $commands[] = array(
            "permission" => "write",
            "cmd" => "edit",
            "lang_var" => "settings",
        );

        return $commands;
    }

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

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

        // personal workspace context: do not force normal login
        if (isset($target_parts[2]) && $target_parts[2] === "wsp") {
            return ilSharedResourceGUI::hasAccess($target_parts[1]);
        }

        $type = $target_parts[0]??null;
        $ref_id = (int) ($target_parts[1] ?? 0);
        if ($type !== "file" || $ref_id <= 0) {
            return false;
        }
        return $access->checkAccess("visible", "", $ref_id)
            || $access->checkAccess("read", "", $ref_id);
    }

    public static function _lookupFileSize(int $a_id, bool $by_reference = true): int
    {
        try {
            $info_repo = new ilObjFileInfoRepository();
            if ($by_reference) {
                $info = $info_repo->getByRefId($a_id);
            } else {
                $info = $info_repo->getByObjectId($a_id);
            }

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


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

    public static function _isFileHidden(string $a_file_name): bool
    {
        return substr($a_file_name, 0, 1) == '.' || substr($a_file_name, -1, 1) == '~'
            || substr($a_file_name, 0, 2) == '~$'
            || $a_file_name == 'Thumbs.db';
    }

    public static function _appendNumberOfCopyToFilename($a_file_name, $nth_copy = null, $a_handle_extension = false): string
    {
        global $DIC;
        $lng = $DIC['lng'];

        $filenameWithoutExtension = $a_file_name;

        $extension = null;
        if ($a_handle_extension) {
            // Get the extension and the filename without the extension
            $extension = ilObjFileAccess::_getFileExtension($a_file_name);
            if (strlen($extension) > 0) {
                $extension = '.' . $extension;
                $filenameWithoutExtension = substr($a_file_name, 0, -strlen($extension));
            }
        }

        // 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/', '([0-9]+)', $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, $filenameWithoutExtension, $matches)) {
            // this is going to be at least the third copy of the filename
            $filenameWithoutCopy = substr($filenameWithoutExtension, 0, -strlen($matches[0]));
            if ($nth_copy == null) {
                $nth_copy = $matches[1] + 1;
            }
        } else {
            if (substr($filenameWithoutExtension, -strlen(' ' . $lng->txt('copy_of_suffix')))
                == ' ' . $lng->txt('copy_of_suffix')
            ) {
                // this is going to be the second copy of the filename
                $filenameWithoutCopy = substr($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)"
            $newFilename = $filenameWithoutCopy . sprintf(' '
                    . $lng->txt('copy_n_of_suffix'), $nth_copy)
                . $extension;
        } else {
            // this is the first copy of the filename, append " - Copy"
            $newFilename = $filenameWithoutCopy . ' ' . $lng->txt('copy_of_suffix') . $extension;
        }

        return $newFilename;
    }

    public static function _getPermanentDownloadLink(int $ref_id): string
    {
        return ilLink::_getStaticLink($ref_id, "file", true, "_download");
    }

    public static function _preloadData(array $obj_ids, array $ref_ids): void
    {
        $info = new ilObjFileInfoRepository();
        $info->preloadData($obj_ids);
    }

}