Collaboration diagram for ilFileServicesSettings:

Public Member Functions
	__construct (private ilSetting $settings, ilIniFile $client_ini, private ilDBInterface $db)

	isByPassAllowedForCurrentUser ()

	isASCIIConvertionEnabled ()

	getWhiteListedSuffixes ()

	getBlackListedSuffixes ()

	getDefaultWhitelist ()

	getWhiteListNegative ()

	getWhiteListPositive ()

	getProhibited ()

Protected Attributes
int	$file_admin_ref_id

Private Member Functions
	determineFileAdminRefId ()

	determineByPass ()

	read ()

	readWhiteList ()

	readBlackList ()

	getCleaner ()

Private Attributes
array	$white_list_default = []

array	$white_list_negative = []

array	$white_list_positive = []

array	$white_list_overall = []

array	$black_list_prohibited = []

array	$black_list_overall = []

bool	$convert_to_ascii = true

bool	$bypass = null

Detailed Description

Class ilObjFileServices.

Definition at line 26 of file class.ilFileServicesSettings.php.

Constructor & Destructor Documentation

◆ __construct()

ilFileServicesSettings::__construct	(	private ilSetting	$settings,
		ilIniFile	$client_ini,
		private ilDBInterface	$db
	)

@noRector

Definition at line 38 of file class.ilFileServicesSettings.php.

      {
        $general_settings = new General();
        $this->convert_to_ascii = $general_settings->isDownloadWithAsciiFileName();
        $this->white_list_default = include __DIR__ . "/../defaults/default_whitelist.php";
        $this->file_admin_ref_id = $this->determineFileAdminRefId();
        $this->read();
    }

References determineFileAdminRefId(), and read().

Here is the call graph for this function:

Member Function Documentation

◆ determineByPass()

ilFileServicesSettings::determineByPass ( )

private

Definition at line 60 of file class.ilFileServicesSettings.php.

                                      : bool
    {
        global $DIC;
        return $DIC->isDependencyAvailable('rbac')
            && isset($DIC["rbacsystem"])
            && $DIC->rbac()->system()->checkAccess(
                'upload_blacklisted_files',
                $this->file_admin_ref_id
            );
    }

References $DIC.

Referenced by isByPassAllowedForCurrentUser().

Here is the caller graph for this function:

◆ determineFileAdminRefId()

ilFileServicesSettings::determineFileAdminRefId ( )

private

Definition at line 51 of file class.ilFileServicesSettings.php.

                                              : int
    {
        $r = $this->db->query(
            "SELECT ref_id FROM object_reference JOIN object_data ON object_reference.obj_id = object_data.obj_id WHERE object_data.type = 'facs';"
        );
        $r = $this->db->fetchObject($r);
        return (int) ($r->ref_id ?? 0);
    }

Referenced by __construct().

Here is the caller graph for this function:

◆ getBlackListedSuffixes()

ilFileServicesSettings::getBlackListedSuffixes ( )

Definition at line 135 of file class.ilFileServicesSettings.php.

                                            : array
    {
        return $this->black_list_overall;
    }

References $black_list_overall.

Referenced by ilFileServicesFilenameSanitizer\__construct().

Here is the caller graph for this function:

◆ getCleaner()

ilFileServicesSettings::getCleaner ( )

private

Definition at line 125 of file class.ilFileServicesSettings.php.

                                 : Closure
    {
        return fn(string $suffix): string => trim(strtolower($suffix));
    }

Referenced by readBlackList(), and readWhiteList().

Here is the caller graph for this function:

◆ getDefaultWhitelist()

ilFileServicesSettings::getDefaultWhitelist ( )

Definition at line 143 of file class.ilFileServicesSettings.php.

                                         : array
    {
        return $this->white_list_default;
    }

References $white_list_default.

◆ getProhibited()

ilFileServicesSettings::getProhibited ( )

Definition at line 167 of file class.ilFileServicesSettings.php.

                                   : array
    {
        return $this->black_list_prohibited;
    }

References $black_list_prohibited.

◆ getWhiteListedSuffixes()

ilFileServicesSettings::getWhiteListedSuffixes ( )

Definition at line 130 of file class.ilFileServicesSettings.php.

                                            : array
    {
        return $this->white_list_overall;
    }

References $white_list_overall.

Referenced by ilFileServicesFilenameSanitizer\__construct().

Here is the caller graph for this function:

◆ getWhiteListNegative()

ilFileServicesSettings::getWhiteListNegative ( )

Definition at line 151 of file class.ilFileServicesSettings.php.

                                          : array
    {
        return $this->white_list_negative;
    }

References $white_list_negative.

◆ getWhiteListPositive()

ilFileServicesSettings::getWhiteListPositive ( )

Definition at line 159 of file class.ilFileServicesSettings.php.

                                          : array
    {
        return $this->white_list_positive;
    }

References $white_list_positive.

◆ isASCIIConvertionEnabled()

ilFileServicesSettings::isASCIIConvertionEnabled ( )

Definition at line 85 of file class.ilFileServicesSettings.php.

                                              : bool
    {
        return $this->convert_to_ascii;
    }

References $convert_to_ascii.

◆ isByPassAllowedForCurrentUser()

ilFileServicesSettings::isByPassAllowedForCurrentUser ( )

Definition at line 71 of file class.ilFileServicesSettings.php.

                                                   : bool
    {
        if ($this->bypass !== null) {
            return $this->bypass;
        }
        return $this->bypass = $this->determineByPass();
    }

References $bypass, and determineByPass().

Here is the call graph for this function:

◆ read()

ilFileServicesSettings::read ( )

private

Definition at line 79 of file class.ilFileServicesSettings.php.

                           : void
    {
        $this->readBlackList();
        $this->readWhiteList();
    }

References readBlackList(), and readWhiteList().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readBlackList()

ilFileServicesSettings::readBlackList ( )

private

Definition at line 112 of file class.ilFileServicesSettings.php.

                                    : void
    {
        $cleaner = $this->getCleaner();
 
        $this->black_list_prohibited = array_map(
            $cleaner,
            explode(",", $this->settings->get("suffix_custom_expl_black") ?? '')
        );
 
        $this->black_list_prohibited = array_filter($this->black_list_prohibited, fn($item): bool => $item !== '');
        $this->black_list_overall = $this->black_list_prohibited;
    }

References $black_list_prohibited, getCleaner(), and ILIAS\Repository\settings().

Referenced by read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readWhiteList()

ilFileServicesSettings::readWhiteList ( )

private

Definition at line 90 of file class.ilFileServicesSettings.php.

                                    : void
    {
        $cleaner = $this->getCleaner();
 
        $this->white_list_negative = array_map(
            $cleaner,
            explode(",", $this->settings->get("suffix_repl_additional") ?? '')
        );
 
        $this->white_list_positive = array_map(
            $cleaner,
            explode(",", $this->settings->get("suffix_custom_white_list") ?? '')
        );
 
        $this->white_list_overall = array_merge($this->white_list_default, $this->white_list_positive);
        $this->white_list_overall = array_diff($this->white_list_overall, $this->white_list_negative);
        $this->white_list_overall = array_diff($this->white_list_overall, $this->black_list_overall);
        $this->white_list_overall[] = '';
        $this->white_list_overall = array_unique($this->white_list_overall);
        $this->white_list_overall = array_diff($this->white_list_overall, $this->black_list_prohibited);
    }