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

Collaboration diagram for ilFileServicesSettings:

Public Member Functions
	__construct (ilSetting $settings, ilIniFile $client_ini, 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
ilSetting	$settings

ilDBInterface	$db

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

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 Class ilObjFileServices

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

Constructor & Destructor Documentation

◆ __construct()

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

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

References $db, $settings, determineFileAdminRefId(), read(), ilIniFile\readVariable(), and ILIAS\Repository\settings().

       {
         $this->db = $db;
         $this->convert_to_ascii = (bool) !$client_ini->readVariable('file_access', 'disable_ascii');
         $this->settings = $settings;
         $this->white_list_default = include "./Services/FileServices/defaults/default_whitelist.php";
         $this->file_admin_ref_id = $this->determineFileAdminRefId();
         $this->read();
     }

Here is the call graph for this function:

Member Function Documentation

◆ determineByPass()

ilFileServicesSettings::determineByPass ( )

private

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

References $DIC.

Referenced by isByPassAllowedForCurrentUser().

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

Here is the caller graph for this function:

◆ determineFileAdminRefId()

ilFileServicesSettings::determineFileAdminRefId ( )

private

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

Referenced by __construct().

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

Here is the caller graph for this function:

◆ getBlackListedSuffixes()

ilFileServicesSettings::getBlackListedSuffixes ( )

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

References $black_list_overall.

Referenced by ilFileServicesFilenameSanitizer\__construct(), and ilFileServicesPreProcessor\__construct().

                                             : array
     {
         return $this->black_list_overall;
     }

Here is the caller graph for this function:

◆ getCleaner()

ilFileServicesSettings::getCleaner ( )

private

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

Referenced by readBlackList(), and readWhiteList().

                                  : Closure
     {
         return function (string $suffix): string {
             return trim(strtolower($suffix));
         };
     }

Here is the caller graph for this function:

◆ getDefaultWhitelist()

ilFileServicesSettings::getDefaultWhitelist ( )

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

References $white_list_default.

     {
         return $this->white_list_default;
     }

◆ getProhibited()

ilFileServicesSettings::getProhibited ( )

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

References $black_list_prohibited.

                                    : array
     {
         return $this->black_list_prohibited;
     }

◆ getWhiteListedSuffixes()

ilFileServicesSettings::getWhiteListedSuffixes ( )

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

References $white_list_overall.

Referenced by ilFileServicesFilenameSanitizer\__construct().

                                             : array
     {
         return $this->white_list_overall;
     }

Here is the caller graph for this function:

◆ getWhiteListNegative()

ilFileServicesSettings::getWhiteListNegative ( )

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

References $white_list_negative.

                                           : array
     {
         return $this->white_list_negative;
     }

◆ getWhiteListPositive()

ilFileServicesSettings::getWhiteListPositive ( )

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

References $white_list_positive.

                                           : array
     {
         return $this->white_list_positive;
     }

◆ isASCIIConvertionEnabled()

ilFileServicesSettings::isASCIIConvertionEnabled ( )

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

References $convert_to_ascii.

                                               : bool
     {
         return $this->convert_to_ascii;
     }

◆ isByPassAllowedForCurrentUser()

ilFileServicesSettings::isByPassAllowedForCurrentUser ( )

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

References $bypass, and determineByPass().

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

Here is the call graph for this function:

◆ read()

ilFileServicesSettings::read ( )

private

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

References readBlackList(), and readWhiteList().

Referenced by __construct().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readBlackList()

ilFileServicesSettings::readBlackList ( )

private

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

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

Referenced by read().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readWhiteList()

ilFileServicesSettings::readWhiteList ( )

private

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

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

Referenced by read().

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