Collaboration diagram for ilFileUtils:

Static Public Member Functions
static	recursive_dirscan (string $dir, array &$arr)
	Recursively scans a given directory and writes path and filename into referenced array. More...

static	utf8_encode (string $string)

static	getValidFilename (string $a_filename)

static	rename (string $a_source, string $a_target)

static	rCopy (string $a_sdir, string $a_tdir, bool $preserveTimeAttributes=false)
	Copies content of a directory $a_sdir recursively to a directory $a_tdir. More...

static	makeDirParents (string $a_dir)
	Create a new directory and all parent directories. More...

static	getDataDir ()
	get data directory (outside webspace) More...

static	dirsize (string $directory)
	get size of a directory or a file. More...

static	makeDir (string $a_dir)
	creates a new directory and inherits all filesystem permissions of the parent directory You may pass only the name of your new directory or with the entire path or relative path information. More...

static	moveUploadedFile (string $a_file, string $a_name, string $a_target, bool $a_raise_errors=true, string $a_mode="move_uploaded")
	move uploaded file More...

static	zip (string $a_dir, string $a_file, bool $compress_content=false)

static	delDir (string $a_dir, bool $a_clean_only=false)
	removes a dir and all its content (subdirs and files) recursively More...

static	getSafeFilename (string $a_initial_filename)

static	getDir (string $a_dir, bool $a_rec=false, ?string $a_sub_dir="")
	get directory More...

static	getWebspaceDir (string $mode="filesystem")
	get webspace directory More...

static	createDirectory (string $a_dir, int $a_mod=0755)
	create directory More...

static	getFileSizeInfo ()

static	getASCIIFilename (string $a_filename)

static	ilTempnam (?string $a_temp_path=null)
	Returns a unique and non existing Path for e temporary file or directory. More...

static	unzip (string $a_file, bool $overwrite=false, bool $a_flat=false)
	unzip file More...

static	renameExecutables (string $a_dir)

static	rRenameSuffix (string $a_dir, string $a_old_suffix, string $a_new_suffix)
	Renames all files with certain suffix and gives them a new suffix. More...

static	removeTrailingPathSeparators (string $path)

static	getPhpUploadSizeLimitInBytes ()

static	_sanitizeFilemame (string $a_filename)

Static Protected Member Functions
static	sanitateTargetPath (string $a_target)

Detailed Description

Class ilFileUtils.

Deprecated:: All Methods are widely used and there is currently no other service providing all of them, but please do not implement new methods in this class.

Definition at line 35 of file class.ilFileUtils.php.

Member Function Documentation

◆ _sanitizeFilemame()

static ilFileUtils::_sanitizeFilemame ( string $a_filename )

static

Definition at line 844 of file class.ilFileUtils.php.

                                                                : string
    {
        return strip_tags(ilUtil::stripSlashes($a_filename));
    }

References ilUtil\stripSlashes().

Referenced by ilFileDataMail\storeAsAttachment(), and ilFileDataMail\storeUploadedFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createDirectory()

static ilFileUtils::createDirectory	(	string	$a_dir,
		int	$a_mod = `0755`
	)

static

create directory

Parameters

string	$a_dir
int	$a_mod

Deprecated:: in favour of Filesystem::createDir() located at the filesystem service.

See also: \ILIAS\Filesystem\Filesystem::createDir()

Definition at line 644 of file class.ilFileUtils.php.

                                                                            : void
    {
        ilFileUtils::makeDir($a_dir);
    }

References makeDir().

Referenced by ilExerciseManagementCollectFilesJob\createSubmissionsDirectory(), ilObjTest\exportXMLMediaObjects(), ilObjQuestionPool\exportXMLMediaObjects(), and ilTempnam().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ delDir()

static ilFileUtils::delDir	(	string	$a_dir,
		bool	$a_clean_only = `false`
	)

static

removes a dir and all its content (subdirs and files) recursively

@access public

Parameters

string	$a_dir	dir to delete
bool	$a_clean_only

Author: Unknown flexe.nosp@m.r@cu.nosp@m.tephp.nosp@m..com (source: http://www.php.net/rmdir)

Deprecated:: in favour of Filesystem::deleteDir() located at the filesystem service.

See also: \ILIAS\Filesystem\Filesystem::deleteDir()

Definition at line 484 of file class.ilFileUtils.php.

                                                                            : void
    {
        if (!is_dir($a_dir) || is_int(strpos($a_dir, ".."))) {
            return;
        }
 
        $current_dir = opendir($a_dir);
 
        $files = [];
 
        // this extra loop has been necessary because of a strange bug
        // at least on MacOS X. A looped readdir() didn't work
        // correctly with larger directories
        // when an unlink happened inside the loop. Getting all files
        // into the memory first solved the problem.
        while ($entryname = readdir($current_dir)) {
            $files[] = $entryname;
        }
 
        foreach ($files as $file) {
            if (is_dir(
                $a_dir . "/" . $file
            ) && ($file !== "." && $file !== "..")) {
                ilFileUtils::delDir($a_dir . "/" . $file);
            } elseif ($file !== "." && $file !== "..") {
                unlink($a_dir . "/" . $file);
            }
        }
 
        closedir($current_dir);
        if (!$a_clean_only) {
            @rmdir($a_dir);
        }
    }

References delDir().

Referenced by ilObjTest\_createImportDirectory(), ilScorm2004DataSet\afterXmlRecordWriting(), ilUserDataSet\afterXmlRecordWriting(), ilSurveyExport\buildExportFileXML(), ILIAS\TestQuestionPool\Import\buildImportQuestionsSelectionForm(), ilObjStyleSheet\cleanExportDirectory(), assOrderingQuestion\cleanImagefiles(), ilObjQuestionPoolGUI\cleanupAfterImport(), assLongMenu\clearFolder(), ilObjMediaObject\clearMultiSrtDirectory(), ilMobMultiSrtUpload\clearMultiSrtDirectory(), delDir(), ilCertificateUtilHelper\delDir(), ilBadgeImageTemplate\delete(), ilObjFileBasedLM\delete(), ilObjSAHSLearningModule\delete(), ilObjSurvey\delete(), SurveyQuestion\delete(), assQuestion\delete(), ilObjSurveyQuestionPool\deleteAllData(), ilFileDataMail\deleteAttachmentDirectory(), ilFileDataCourse\deleteDirectory(), ILIAS\Mail\Cron\ExpiredOrOrphanedMails\MailDeletionHandler\deleteDirectory(), ilObjSurveyQuestionPoolGUI\deleteExportFileObject(), ilFileSystemGUI\deleteFile(), ilObjQuestionPool\deleteQuestionpool(), ilBadge\deleteStaticFiles(), assQuestion\deleteSuggestedSolutions(), ilObjSurvey\deleteSurveyRecord(), ilObjTest\deleteTest(), ilObjCmiXapi\doDelete(), ilObjFileBasedLMGUI\exportHTML(), ilExportContainer\exportObject(), ilObjSAHSLearningModuleGUI\importFile(), ilObjTestGUI\importFile(), ilObjQuestionPoolGUI\importFile(), ilObjSurveyQuestionPool\importObject(), ilObjQuestionPoolGUI\importQuestionsFile(), ILIAS\Blog\Export\BlogHtmlExport\initDirectories(), ILIAS\Notes\Export\NotesHtmlExport\initDirectories(), ilDataCollectionExportOptionsXLSX\onDeleteFiles(), ILIAS\Export\ExportHandler\Consumer\ExportOption\BasicLegacyHandler\onDeleteFiles(), ilMediaPoolExportOptionXMLMaster\onDeleteFiles(), ilMediaPoolExportOptionXMLMasterNoMedia\onDeleteFiles(), ilTestExportOptionARC\onDeleteFiles(), assKprimChoice\removeAnswerImage(), ilObjTest\removeTestResultsByActiveIds(), rRenameSuffix(), ILIAS\MediaCast\BackgroundTasks\DownloadAllZipJob\run(), ilZipJob\run(), ilCalendarZipJob\run(), assMultipleChoice\saveAdditionalQuestionDataToDb(), ilOrgUnitExporter\sendAndCreateSimpleExportFile(), ilUserCertificateZip\zipCertificatesInArchiveDirectory(), and ILIAS\Notes\Export\NotesHtmlExport\zipPackage().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ dirsize()

static ilFileUtils::dirsize ( string $directory )

static

get size of a directory or a file.

Parameters

string path to a directory or a file

Returns: integer. Returns -1, if the directory does not exist.

Definition at line 263 of file class.ilFileUtils.php.

                                                     : int
    {
        $size = 0;
        if (!is_dir($directory)) {
            //       dirsize of non-existing directory
            $size = @filesize($directory);
            return ($size === false) ? -1 : $size;
        }
        if ($DIR = opendir($directory)) {
            while (($dirfile = readdir($DIR)) !== false) {
                if (is_link(
                    $directory . DIRECTORY_SEPARATOR . $dirfile
                )) {
                    continue;
                }
                if ($dirfile === '.') {
                    continue;
                }
                if ($dirfile === '..') {
                    continue;
                }
                if (is_file($directory . DIRECTORY_SEPARATOR . $dirfile)) {
                    $size += filesize(
                        $directory . DIRECTORY_SEPARATOR . $dirfile
                    );
                } elseif (is_dir($directory . DIRECTORY_SEPARATOR . $dirfile)) {
                    $dirSize = ilFileUtils::dirsize(
                        $directory . DIRECTORY_SEPARATOR . $dirfile
                    );
                    if ($dirSize >= 0) {
                        $size += $dirSize;
                    } else {
                        return -1;
                    }
                }
            }
            closedir($DIR);
        }
        return $size;
    }

References dirsize().

Referenced by ilObjFileBasedLMAccess\_lookupDiskUsage(), ilObjMediaCastAccess\_lookupDiskUsage(), ilObjSAHSLearningModuleAccess\_lookupDiskUsage(), and dirsize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getASCIIFilename()

static ilFileUtils::getASCIIFilename ( string $a_filename )

static

Deprecated:

Definition at line 662 of file class.ilFileUtils.php.

                                                               : string
    {
        global $DIC;
        $policy = new ilFileServicesPolicy($DIC->fileServiceSettings());
        return $policy->ascii($a_filename);
    }

References $DIC.

Referenced by ILIAS\Wiki\Export\WikiHtmlExport\buildExportFile(), ilExerciseManagementCollectFilesJob\collectAssignmentData(), ilDownloadFilesBackgroundTask\collectFiles(), ilObjTest\deliverPDFfromFO(), ilSurveyParticipantsGUI\exportAllCodesObject(), ilSurveyParticipantsGUI\exportCodesObject(), ilSurveyEvaluationGUI\exportEvaluationUser(), ilObjExercise\exportGradesExcel(), ilContainerGUI\getBucketTitle(), ilObjWorkspaceFolderGUI\getBucketTitle(), ilExSubmission\getDirectoryNameFromUserData(), ilAssFileUploadUploadsExporter\getDispoZipFileName(), ilTestParticipantData\getFileSystemCompliantFullnameByActiveId(), ilVerificationObject\getOfflineFilename(), ilObjTest\getTitleFilenameCompliant(), assQuestion\getTitleFilenameCompliant(), ilAssFileUploadUploadsExporter\initFilenames(), ilDclMobRecordFieldModel\parseValue(), ilCollectFilesJob\recurseFolder(), ilDownloadFilesBackgroundTask\run(), ilDownloadContainerFilesBackgroundTask\run(), ilDownloadSubmissionsBackgroundTask\run(), ILIAS\MediaCast\BackgroundTasks\DownloadAllBackgroundTask\run(), ilDownloadWorkspaceFolderBackgroundTask\run(), ilQtiMatImageSecurity\sanitizeLabel(), and ILIAS\Test\ExportImport\CertificateExport\write().

Here is the caller graph for this function:

◆ getDataDir()

static ilFileUtils::getDataDir ( )

static

get data directory (outside webspace)

Deprecated:: in favour of the filesystem service which should be used to operate on the storage directory.

See also: \ILIAS\DI\Containerfilesystem(); \ILIAS\Filesystem\Filesystems::storage()

Definition at line 250 of file class.ilFileUtils.php.

                                       : string
    {
        return CLIENT_DATA_DIR;
    }

References CLIENT_DATA_DIR.

Here is the caller graph for this function:

◆ getDir()

static ilFileUtils::getDir	(	string	$a_dir,
		bool	$a_rec = `false`,
		?string	$a_sub_dir = `""`
	)

static

get directory

Parameters

string	$a_dir
bool	$a_rec
string \| null	$a_sub_dir

Returns: array

Deprecated:: in favour of Filesystem::listContents() located at the filesystem service.

See also: \ILIAS\Filesystem\Filesystem::listContents()

Definition at line 565 of file class.ilFileUtils.php.

     : array {
        $current_dir = opendir($a_dir . $a_sub_dir);
 
        $dirs = [];
        $files = [];
        $subitems = [];
        while ($entry = readdir($current_dir)) {
            if (is_dir($a_dir . "/" . $entry)) {
                $dirs[$entry] = [
                    "type" => "dir",
                    "entry" => $entry,
                    "subdir" => $a_sub_dir
                ];
                if ($a_rec && $entry !== "." && $entry !== "..") {
                    $si = ilFileUtils::getDir(
                        $a_dir,
                        true,
                        $a_sub_dir . "/" . $entry
                    );
                    $subitems = array_merge($subitems, $si);
                }
            } elseif ($entry !== "." && $entry !== "..") {
                $size = filesize($a_dir . $a_sub_dir . "/" . $entry);
                $files[$entry] = [
                    "type" => "file",
                    "entry" => $entry,
                    "size" => $size,
                    "subdir" => $a_sub_dir
                ];
            }
        }
        ksort($dirs);
        ksort($files);
 
        return array_merge($dirs, $files, $subitems);
    }

References getDir().

Referenced by assOrderingQuestion\cleanImagefiles(), ilFileDataMail\getAttachmentPathAndFilenameByMd5Hash(), getDir(), ilCertificateUtilHelper\getDir(), ilFileSystemGUI\getFileList(), ILIAS\AdvancedMetaData\Setup\RecordFilesMigration\getFiles(), ilUploadDirFilesTableGUI\getFiles(), ilObjMediaObject\getMultiSrtFiles(), ilMobMultiSrtUpload\getMultiSrtFiles(), ilObjUser\getPersonalDataExportFile(), and ilFileSystemGUI\unzipFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFileSizeInfo()

static ilFileUtils::getFileSizeInfo ( )

static

Definition at line 649 of file class.ilFileUtils.php.

                                            : string
    {
        global $DIC;
        $size = new DataSize(self::getPhpUploadSizeLimitInBytes(), DataSize::MB);
        $max_filesize = $size->__toString();
        $lng = $DIC->language();
 
        return $lng->txt("file_notice") . " $max_filesize.";
    }

References $DIC, and $lng.

Referenced by ilTinyMCE\addCustomRTESupport(), ilKprimChoiceWizardInputGUI\insert(), ilMatchingWizardInputGUI\insert(), ilMultipleChoiceWizardInputGUI\insert(), ilSingleChoiceWizardInputGUI\insert(), ilAssMultipleChoiceCorrectionsInputGUI\insert(), ilAssSingleChoiceCorrectionsInputGUI\insert(), and ilMultipleImagesInputGUI\render().

Here is the caller graph for this function:

◆ getPhpUploadSizeLimitInBytes()

static ilFileUtils::getPhpUploadSizeLimitInBytes ( )

static

Deprecated:: should use DataSize instead

Definition at line 805 of file class.ilFileUtils.php.

                                                         : string
    {
        $convertPhpIniSizeValueToBytes = function ($phpIniSizeValue) {
            if (is_numeric($phpIniSizeValue)) {
                return $phpIniSizeValue;
            }
 
            $suffix = substr($phpIniSizeValue, -1);
            $value = substr($phpIniSizeValue, 0, -1);
 
            switch (strtoupper($suffix)) {
                case 'P':
                    $value *= 1024;
                    // no break
                case 'T':
                    $value *= 1024;
                    // no break
                case 'G':
                    $value *= 1024;
                    // no break
                case 'M':
                    $value *= 1024;
                    // no break
                case 'K':
                    $value *= 1024;
                    break;
            }
 
            return $value;
        };
 
        $uploadSizeLimitBytes = min(
            $convertPhpIniSizeValueToBytes(ini_get('post_max_size')),
            $convertPhpIniSizeValueToBytes(ini_get('upload_max_filesize'))
        );
 
        return $uploadSizeLimitBytes;
    }

Referenced by ilDAVContainer\createFile(), ILIAS\FileServices\FileServicesLegacyInitialisationAdapter\getPhpUploadLimitInBytes(), ilDAVFile\put(), and ILIAS\FileUpload\FileUploadImpl\uploadSizeLimit().

Here is the caller graph for this function:

◆ getSafeFilename()

static ilFileUtils::getSafeFilename ( string $a_initial_filename )

static

Definition at line 519 of file class.ilFileUtils.php.

                                                                      : string
    {
        $file_peaces = explode('.', $a_initial_filename);
 
        $file_extension = array_pop($file_peaces);
 
        if (SUFFIX_REPL_ADDITIONAL) {
            $string_extensions = SUFFIX_REPL_DEFAULT . "," . SUFFIX_REPL_ADDITIONAL;
        } else {
            $string_extensions = SUFFIX_REPL_DEFAULT;
        }
 
        $sufixes = explode(",", $string_extensions);
 
        if (in_array($file_extension, $sufixes)) {
            $file_extension = "sec";
        }
 
        $file_peaces[] = $file_extension;
 
        $safe_filename = "";
        foreach ($file_peaces as $piece) {
            $safe_filename .= "$piece";
            if ($piece != end($file_peaces)) {
                $safe_filename .= ".";
            }
        }
 
        return $safe_filename;
    }

Referenced by ilExAssignment\instructionFileInsertOrder().

Here is the caller graph for this function:

◆ getValidFilename()

static ilFileUtils::getValidFilename ( string $a_filename )

static

Deprecated:

Definition at line 87 of file class.ilFileUtils.php.

                                                               : string
    {
        global $DIC;
        $sanitizer = new ilFileServicesFilenameSanitizer(
            $DIC->fileServiceSettings()
        );
 
        return $sanitizer->sanitize($a_filename);
    }

References $DIC.

Referenced by ilPortfolioCertificateFileService\deliverCertificate(), ilWebDAVRepositoryHelper\getFilenameWithSanitizedFileExtension(), ilCertificateFileUtilsHelper\getValidFilename(), ImportUploadHandlerGUI\moveUploadedFileToTemp(), ilObjCourseGUI\updateInfoObject(), ilIndividualAssessmentFileStorage\uploadFile(), and ilBadgeImageTemplate\uploadImage().

Here is the caller graph for this function:

◆ getWebspaceDir()

static ilFileUtils::getWebspaceDir ( string $mode = "filesystem" )

static

get webspace directory

Parameters

string $mode use "filesystem" for filesystem operations and "output" for output operations, e.g. images

Returns: string

Deprecated:: in favour of the filesystem service which should be used for operations on the web dir.

See also: \ILIAS\DI\Containerfilesystem(); Filesystems::web()

Definition at line 621 of file class.ilFileUtils.php.

                                                                      : string
    {
        if ($mode === "filesystem") {
            return "./" . ILIAS_WEB_DIR . "/" . CLIENT_ID;
        }
        if (defined("ILIAS_MODULE")) {
            return "../" . ILIAS_WEB_DIR . "/" . CLIENT_ID;
        }
        return "./" . ILIAS_WEB_DIR . "/" . CLIENT_ID;
    }

References CLIENT_ID, and ILIAS_WEB_DIR.

Referenced by ilObjFileBasedLMAccess\_determineStartUrl(), ilContainer\_getContainerDirectory(), ilObjStyleSheet\_getImagesDirectory(), ilObjFileBasedLMAccess\_lookupDiskUsage(), ilObjSAHSLearningModuleAccess\_lookupDiskUsage(), ilCmiXapiLaunchGUI\buildLaunchLink(), ilContainer\createContainerDirectory(), ilObjSAHSLearningModule\createDataDirectory(), ILIAS\ILIASObject\Properties\AdditionalProperties\Icon\Custom\createFromImportDir(), ilObjStyleSheet\delete(), ilPageObjectGUI\displayMedia(), ilObjCmiXapi\doCloneObject(), ilObjCmiXapi\doDelete(), ilCOPageHTMLExport\exportHTMLMOB(), ilCOPageHTMLExport\exportQuestionFiles(), ilStudyProgrammeTypeCustomIconsFormGUI\fillForm(), ilLTIConsumeProviderIcon\getAbsoluteFilePath(), ilCmiXapiContentUploadImporter\getAbsoluteObjectDirectory(), ilDidacticTemplateIconHandler\getAbsolutePath(), ilPCInteractiveImage\getBackgroundImage(), ilBadgeHandler\getBasePath(), ilObjMediaObject\getDataDirectory(), ilObjSAHSLearningModule\getDataDirectory(), ILIAS\ILIASObject\Properties\AdditionalProperties\Icon\Custom\getFullPath(), ilOpenIdConnectSettings\getImageFilePath(), ilFileDataCourse\getOnlineLink(), ilFSStorageMail\getRelativePathExMailDirectory(), ilLMPresentationGUI\ilMedia(), ilUserCertificateGUI\listCertificates(), ilGlossaryPresentationGUI\media(), ilCmiXapiImporter\prepareLocalSourceStorage(), ilObjUserGUI\removeUserPictureObject(), ilCmiXapiContentUploadImporter\sanitizeObjectDirectory(), ilObjMediaPoolGUI\showMedia(), ilPageObjectGUI\showMediaFullscreen(), ilPageObjectGUI\showPage(), and ilLMPresentationGUI\showPrintView().

Here is the caller graph for this function:

◆ ilTempnam()

static ilFileUtils::ilTempnam ( ?string $a_temp_path = null )

static

Returns a unique and non existing Path for e temporary file or directory.

Parameters

string | null $a_temp_path

Returns: string

Definition at line 676 of file class.ilFileUtils.php.

                                                                 : string
    {
        $temp_path = $a_temp_path ?? ilFileUtils::getDataDir() . "/temp";
 
        if (!is_dir($temp_path)) {
            ilFileUtils::createDirectory($temp_path);
        }
        $temp_name = $temp_path . "/" . uniqid("tmp");
 
        return $temp_name;
    }

References createDirectory(), and getDataDir().

Referenced by ilImagemapPreview\__construct(), ilObjUserFolder\buildExportFile(), ilTestArchiveService\buildOverviewFilename(), ilVirusScanner\createBufferFile(), ILIAS\MediaCast\BackgroundTasks\DownloadAllCollectFilesJob\createDirectory(), ilRestFileStorage\createFile(), ilAdvancedMDParser\createLocalRecord(), ilTestExportGUI\createTestArchiveExport(), ilCopyFilesToTempDirectoryJob\createUniqueTempDirectory(), ilCalendarCopyFilesToTempDirectoryJob\createUniqueTempDirectory(), ilExerciseManagementCollectFilesJob\createUniqueTempDirectory(), ilCopyWorkspaceFilesToTempDirectoryJob\createUniqueTempDirectory(), ilObjTest\deliverPDFfromFO(), ilMediaItem\determineDuration(), ilPageLayoutAdministrationGUI\exportLayout(), ILIAS\Test\ExportImport\ExportFilename\getPathname(), CustomIconUploadHandlerGUI\getUploadResult(), ilUserDataSet\getXmlRecord(), ilFileXMLParser\handlerEndTag(), assOrderingQuestionImport\handleUploadedFile(), ilObjSAHSLearningModuleGUI\importFile(), ilAssFileUploadUploadsExporter\initFilenames(), ilObjectCommonSettingFormAdapter\saveIcon(), ilExcel\sendToClient(), ilRestFileStorage\storeFileForRest(), ilECSConnector\updateResource(), ilCalendarCategoryGUI\uploadAppointments(), ilObjLanguageExtGUI\uploadObject(), ILIAS\Test\ExportImport\ResultsExportExcel\write(), and ilExcel\writeToTmpFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ makeDir()

static ilFileUtils::makeDir ( string $a_dir )

static

creates a new directory and inherits all filesystem permissions of the parent directory You may pass only the name of your new directory or with the entire path or relative path information.

examples: a_dir = /tmp/tests/your_dir a_dir = ../tests/your_dir a_dir = your_dir (--> creates your_dir in current directory)

@access public

Parameters

string [path] + directory name

Returns: boolean

Deprecated:: in favour of Filesystem::createDir() located at the filesystem service.

See also: \ILIAS\Filesystem\Filesystem::createDir()

Definition at line 322 of file class.ilFileUtils.php.

                                                 : bool
    {
        $a_dir = trim($a_dir);
 
        // remove trailing slash (bugfix for php 4.2.x)
        if (str_ends_with($a_dir, "/")) {
            $a_dir = substr($a_dir, 0, -1);
        }
 
        // check if a_dir comes with a path
        if (($path = substr(
            $a_dir,
            0,
            strrpos($a_dir, "/") - strlen($a_dir)
        )) === '' || ($path = substr(
            $a_dir,
            0,
            strrpos($a_dir, "/") - strlen($a_dir)
        )) === '0') {
            $path = ".";
        }
 
        // create directory with file permissions of parent directory
        if (is_dir($a_dir)) {
            return true;
        }
        $old_mask = umask(0000);
        $result = @mkdir($a_dir, fileperms($path));
        umask($old_mask);
 
        return $result;
    }

References $path.

Here is the caller graph for this function:

◆ makeDirParents()

static ilFileUtils::makeDirParents ( string $a_dir )

static

Create a new directory and all parent directories.

Creates a new directory and inherits all filesystem permissions of the parent directory If the parent directories doesn't exist, they will be created recursively. The directory name NEEDS TO BE an absolute path, because it seems that relative paths are not working with PHP's file_exists function.

Parameters

string $a_dir The directory name to be created @access public

Returns: bool

Author: Helmut Schottmüller hscho.nosp@m.ttm@.nosp@m.tzi.d.nosp@m.e

Deprecated:: in favour of Filesystem::createDir() located at the filesystem service.

See also: \ILIAS\Filesystem\Filesystem::createDir()

Definition at line 188 of file class.ilFileUtils.php.

                                                        : bool
    {
        $dirs = [$a_dir];
        $a_dir = dirname($a_dir);
        $last_dirname = '';
        while ($last_dirname !== $a_dir) {
            array_unshift($dirs, $a_dir);
            $last_dirname = $a_dir;
            $a_dir = dirname($a_dir);
        }
 
        // find the first existing dir
        $reverse_paths = array_reverse($dirs, true);
        $found_index = -1;
        foreach ($reverse_paths as $key => $value) {
            if ($found_index != -1) {
                continue;
            }
            if (!is_dir($value)) {
                continue;
            }
            $found_index = $key;
        }
 
        $old_mask = umask(0000);
        foreach ($dirs as $dirindex => $dir) {
            // starting with the longest existing path
            if ($dirindex >= $found_index) {
                if (!file_exists($dir)) {
                    if (strcmp(substr($dir, strlen($dir) - 1, 1), "/") == 0) {
                        // on some systems there is an error when there is a slash
                        // at the end of a directory in mkdir, see Mantis #2554
                        $dir = substr($dir, 0, strlen($dir) - 1);
                    }
                    if (!mkdir($dir)) {
                        error_log("Can't make directory: $dir");
                        return false;
                    }
                } elseif (!is_dir($dir)) {
                    error_log("$dir is not a directory");
                    return false;
                } else {
                    // get umask of the last existing parent directory
                    $umask = fileperms($dir);
                }
            }
        }
        umask($old_mask);
 
        return true;
    }

Referenced by ilHtmlPurifierAbstractLibWrapper\_getCacheDirectory(), ilExportContainer\addSubitems(), assLongMenu\assertDirExists(), ilQuestionpoolExport\buildExportFileXML(), ilCopyFilesToTempDirectoryJob\copyFiles(), ilCopyWorkspaceFilesToTempDirectoryJob\copyFiles(), ilExerciseManagementCollectFilesJob\copyFileToSubDirectory(), ilCalendarCopyFilesToTempDirectoryJob\copyWithAbsolutePath(), ilCalendarCopyFilesToTempDirectoryJob\copyWithRId(), ilIndividualAssessmentFileStorage\create(), ilUserCertificateZip\createArchiveDirectory(), ilTestArchiver\createArchiveForTest(), ilLoggingErrorFileStorage\createDir(), ilCOPageHTMLExport\createDirectories(), ilSystemStyleHTMLExport\createDirectories(), ILIAS\MediaCast\BackgroundTasks\DownloadAllCollectFilesJob\createDirectory(), ilObjMediaObject\createDirectory(), ilExplorerBaseGUI\createHTMLExportDirs(), ilExerciseManagementCollectFilesJob\createTargetDirectory(), ilCopyFilesToTempDirectoryJob\createTargetDirectory(), ilCalendarCopyFilesToTempDirectoryJob\createTargetDirectory(), ilCopyWorkspaceFilesToTempDirectoryJob\createTargetDirectory(), ilTestExportGUI\createTestArchiveExport(), ilCopyFilesToTempDirectoryJob\createUniqueTempDirectory(), ilCalendarCopyFilesToTempDirectoryJob\createUniqueTempDirectory(), ilExerciseManagementCollectFilesJob\createUniqueTempDirectory(), ilCopyWorkspaceFilesToTempDirectoryJob\createUniqueTempDirectory(), assQuestion\duplicateSuggestedSolutionFiles(), assOrderingQuestion\ensureImagePathExists(), assOrderingQuestionImport\ensureImagePathExists(), ilDclContentExporter\export(), ilBibliographicDataSet\exportLibraryFile(), ilExportContainer\exportObject(), ilTestResultsToXML\exportParticipantUploadedFiles(), ilCOPageHTMLExport\exportQuestionFiles(), ILIAS\components\Export\HTML\Util\exportResourceFile(), ilCOPageHTMLExport\exportStyles(), ILIAS\User\Export\UserHtmlExport\exportUserImages(), ilBadgeHandler\getBadgePath(), ilObjSurvey\getImportDirectory(), ilBadgeHandler\getInstancePath(), ilBibliographicExporter\getXmlRepresentation(), ilContentPageExporter\getXmlRepresentation(), ilDataCollectionExporter\getXmlRepresentation(), ilForumExporter\getXmlRepresentation(), ilIndividualAssessmentExporter\getXmlRepresentation(), ilStyleExporter\getXmlRepresentation(), ilSurveyExporter\getXmlRepresentation(), assKprimChoice\handleFileUpload(), ilAdvancedMDRecordImportFiles\init(), ilFSStorageCourse\initInfoDirectory(), ilFSStorageCourse\initMemberExportDirectory(), ilFSStorageGroup\initMemberExportDirectory(), ilFSStoragePRG\initMemberExportDirectory(), ilObjSurveyQuestionPool\pasteFromClipboard(), ilObjQuestionPool\pasteFromClipboard(), assMatchingQuestionImport\saveImage(), assFileUpload\savePreviewData(), ilOrgUnitExporter\sendAndCreateSimpleExportFile(), assMultipleChoice\setImageFile(), SurveyQuestion\setMaterialsfile(), ilForumXMLWriter\start(), and assQuestionGUI\suggestedsolution().

Here is the caller graph for this function:

◆ moveUploadedFile()

static ilFileUtils::moveUploadedFile	(	string	$a_file,
		string	$a_name,
		string	$a_target,
		bool	$a_raise_errors = `true`,
		string	$a_mode = `"move_uploaded"`
	)

static

move uploaded file

Parameters

string	$a_file
string	$a_name
string	$a_target
bool	$a_raise_errors
string	$a_mode

Returns: bool

Exceptions

ilException Thrown if no uploaded files are found and raise error is set to true.

Deprecated:: in favour of the FileUpload service.

See also: \ILIAS\DI\Containerupload()

Definition at line 398 of file class.ilFileUtils.php.

     : bool {
        global $DIC;
        $main_tpl = $DIC->ui()->mainTemplate();
        $target_filename = basename($a_target);
 
        $target_filename = ilFileUtils::getValidFilename($target_filename);
 
        // Make sure the target is in a valid subfolder. (e.g. no uploads to ilias/setup_/....)
        [$target_filesystem, $target_dir] = self::sanitateTargetPath($a_target);
 
        $upload = $DIC->upload();
 
        // If the upload has not yet been processed make sure he gets processed now.
        if (!$upload->hasBeenProcessed()) {
            $upload->process();
        }
 
        try {
            if (!$upload->hasUploads()) {
                throw new ilException(
                    $DIC->language()->txt("upload_error_file_not_found")
                );
            }
            $upload_result = $upload->getResults()[$a_file] ?? null;
            if ($upload_result instanceof UploadResult) {
                if (!$upload_result->isOK()) {
                    throw new ilException($upload_result->getStatus()->getMessage());
                }
            } else {
                return false;
            }
        } catch (ilException $e) {
            if (!$a_raise_errors) {
                $main_tpl->setOnScreenMessage('failure', $e->getMessage(), true);
            } else {
                throw $e;
            }
 
            return false;
        }
 
        $upload->moveOneFileTo(
            $upload_result,
            $target_dir,
            $target_filesystem,
            $target_filename,
            true
        );
 
        return true;
    }

Referenced by ilCourseFile\create(), assKprimChoice\handleFileUpload(), ilObjStyleSheet\import(), ilAdvancedMDRecordImportFiles\moveUploadedFile(), ilObjSCORMLearningModuleGUI\newModuleVersionUpload(), assFileUpload\savePreviewData(), assMultipleChoice\setImageFile(), SurveyQuestion\setMaterialsfile(), assOrderingQuestion\storeImageFile(), ilFileDataMail\storeUploadedFile(), assQuestionGUI\suggestedsolution(), ilPCInteractiveImageGUI\update(), ilCalendarCategoryGUI\uploadAppointments(), ilIndividualAssessmentFileStorage\uploadFile(), ilBadge\uploadImage(), ilBadgeImageTemplate\uploadImage(), ilObjSAHSLearningModuleGUI\uploadObject(), and ilObjSurveyQuestionPoolGUI\uploadQuestionsObject().

Here is the caller graph for this function:

◆ rCopy()

static ilFileUtils::rCopy	(	string	$a_sdir,
		string	$a_tdir,
		bool	$preserveTimeAttributes = `false`
	)

static

Copies content of a directory $a_sdir recursively to a directory $a_tdir.

Parameters

string	$a_sdir	source directory
string	$a_tdir	target directory
boolean	$preserveTimeAttributes	if true, ctime will be kept.

Returns: boolean TRUE for sucess, FALSE otherwise

Exceptions

DirectoryNotFoundException
FileNotFoundException
IOException	@access public

Deprecated:: in favour of Filesystem::copyDir() located at the filesystem service.

See also: Filesystem::copyDir()

Definition at line 132 of file class.ilFileUtils.php.

     : bool {
        $sourceFS = LegacyPathHelper::deriveFilesystemFrom($a_sdir);
        $targetFS = LegacyPathHelper::deriveFilesystemFrom($a_tdir);
 
        $sourceDir = LegacyPathHelper::createRelativePath($a_sdir);
        $targetDir = LegacyPathHelper::createRelativePath($a_tdir);
 
        // check if arguments are directories
        if (!$sourceFS->hasDir($sourceDir)) {
            return false;
        }
 
        $sourceList = $sourceFS->listContents($sourceDir, true);
 
        foreach ($sourceList as $item) {
            if ($item->isDir()) {
                continue;
            }
            try {
                $itemPath = $targetDir . '/' . substr(
                    $item->getPath(),
                    strlen($sourceDir)
                );
                $stream = $sourceFS->readStream($item->getPath());
                $targetFS->writeStream($itemPath, $stream);
            } catch (FileAlreadyExistsException) {
                // Do nothing with that type of exception
            }
        }
 
        return true;
    }

Referenced by ilObjStyleSheet\copyImagesToDir(), ILIAS\ILIASObject\Properties\AdditionalProperties\Icon\Custom\createFromImportDir(), ilFileDataCourse\createOnlineVersion(), ilObjCmiXapi\doCloneObject(), ilObjStyleSheet\export(), ilObjFileBasedLMGUI\exportHTML(), ilCOPageHTMLExport\exportHTMLMOB(), ilCOPageHTMLExport\exportQuestionFiles(), ilCOPageHTMLExport\exportStyles(), ilObjSAHSLearningModule\populateByDirectoy(), and ilFileDataCourse\rCopy().

Here is the caller graph for this function:

◆ recursive_dirscan()

static ilFileUtils::recursive_dirscan	(	string	$dir,
		array &	$arr
	)

static

Recursively scans a given directory and writes path and filename into referenced array.

Parameters

string	$dir	Directory to start from
array	&$arr	Referenced array which is filled with Filename and path

Exceptions

ilFileUtilsException

Deprecated:: Will be removed completely with ILIAS 9

Definition at line 46 of file class.ilFileUtils.php.

                                                                      : void
    {
        global $DIC;
 
        $lng = $DIC->language();
 
        $dirlist = opendir($dir);
        while (false !== ($file = readdir($dirlist))) {
            if (!is_file($dir . "/" . $file) && !is_dir($dir . "/" . $file)) {
                throw new ilFileUtilsException(
                    $lng->txt("filenames_not_supported"),
                    ilFileUtilsException::$BROKEN_FILE
                );
            }
 
            if ($file !== '.' && $file !== '..') {
                $newpath = $dir . '/' . $file;
                $level = explode('/', $newpath);
                if (is_dir($newpath)) {
                    ilFileUtils::recursive_dirscan($newpath, $arr);
                } else {
                    $arr["path"][] = $dir . "/";
                    $arr["file"][] = end($level);
                }
            }
        }
        closedir($dirlist);
    }

References ilFileUtilsException\$BROKEN_FILE, $DIC, $lng, and recursive_dirscan().

Referenced by recursive_dirscan(), and ilFileSystemGUI\unzipFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ removeTrailingPathSeparators()

static ilFileUtils::removeTrailingPathSeparators ( string $path )

static

Definition at line 796 of file class.ilFileUtils.php.

                                                                     : string
    {
        $path = preg_replace("/[\/\\\]+$/", "", $path);
        return (string) $path;
    }

References $path.

Referenced by SurveyQuestion\_getInternalLinkHref(), ILIAS\Init\Environment\HttpPathBuilder\build(), ilSoapFunctions\buildHTTPPath(), assQuestion\fixUnavailableSkinImageSources(), assFileUpload\getFileUploadPathWeb(), SurveyQuestion\getImagePathWeb(), ilObjTest\getImagePathWeb(), assQuestion\getImagePathWeb(), SurveyQuestion\getMaterialsPathWeb(), assFileUpload\getPreviewFileUploadPathWeb(), ilFSStorageMail\getRelativePathExMailDirectory(), assQuestion\getSuggestedSolutionPathWeb(), and ilObjCmiXapiAdministrationGUI\saveLrsTypeFormCmd().

Here is the caller graph for this function:

◆ rename()

static ilFileUtils::rename	(	string	$a_source,
		string	$a_target
	)

static

Deprecated:

Definition at line 100 of file class.ilFileUtils.php.

                                                                     : bool
    {
        $pi = pathinfo($a_target);
        global $DIC;
        $sanitizer = new ilFileServicesFilenameSanitizer(
            $DIC->fileServiceSettings()
        );
 
        if (!$sanitizer->isClean($a_target)) {
            throw new ilFileUtilsException("Invalid target file");
        }
 
        return rename($a_source, $a_target);
    }

References $DIC, and rename().

Referenced by ilAssFileUploadUploadsExporter\createFileUploadCollectionZipFile(), ilObjSAHSLearningModuleGUI\importFile(), ilObjSCORMLearningModuleGUI\newModuleVersionUpload(), ilDclMobRecordFieldModel\parseValue(), ilObjSurveyQuestionPool\pasteFromClipboard(), rename(), ilFileSystemGUI\renameFile(), ilFileDataMail\rotateFiles(), and assOrderingQuestion\updateImageFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renameExecutables()

static ilFileUtils::renameExecutables ( string $a_dir )

static

Deprecated:

Definition at line 715 of file class.ilFileUtils.php.

                                                           : void
    {
        $def_arr = explode(",", SUFFIX_REPL_DEFAULT);
        foreach ($def_arr as $def) {
            self::rRenameSuffix($a_dir, trim($def), "sec");
        }
 
        $def_arr = explode(",", SUFFIX_REPL_ADDITIONAL);
        foreach ($def_arr as $def) {
            self::rRenameSuffix($a_dir, trim($def), "sec");
        }
    }

Referenced by ilObjSAHSLearningModuleGUI\importFile(), ilObjSCORMLearningModuleGUI\newModuleVersionUpload(), ilDclMobRecordFieldModel\parseValue(), ilObjSAHSLearningModule\populateByDirectoy(), ilFileSystemGUI\renameFile(), ilCmiXapiContentUploadImporter\sanitizeObjectDirectory(), assQuestionGUI\suggestedsolution(), ilFileSystemGUI\unzipFile(), ilFileSystemGUI\uploadFile(), and ilObjSAHSLearningModuleGUI\uploadObject().

Here is the caller graph for this function:

◆ rRenameSuffix()

static ilFileUtils::rRenameSuffix	(	string	$a_dir,
		string	$a_old_suffix,
		string	$a_new_suffix
	)

static

Renames all files with certain suffix and gives them a new suffix.

This words recursively through a directory.

Deprecated:

Definition at line 734 of file class.ilFileUtils.php.

                                                                                                   : bool
    {
        if ($a_dir === "/" || $a_dir === "" || is_int(strpos($a_dir, ".."))
            || trim($a_old_suffix) === "") {
            return false;
        }
 
        // check if argument is directory
        if (!@is_dir($a_dir)) {
            return false;
        }
 
        // read a_dir
        $dir = opendir($a_dir);
 
        while ($file = readdir($dir)) {
            if ($file !== "." && $file !== "..") {
                // triple dot is not allowed in filenames
                if ($file === '...') {
                    unlink($a_dir . "/" . $file);
                    continue;
                }
                // directories
                if (@is_dir($a_dir . "/" . $file)) {
                    ilFileUtils::rRenameSuffix($a_dir . "/" . $file, $a_old_suffix, $a_new_suffix);
                }
 
                // files
                if (@is_file($a_dir . "/" . $file)) {
                    // first check for files with trailing dot
                    if (strrpos($file, '.') == (strlen($file) - 1)) {
                        try {
                            rename($a_dir . '/' . $file, substr($a_dir . '/' . $file, 0, -1));
                        } catch (Throwable) {
                            // to avoid exploits we do delete this file and continue renaming
                            unlink($a_dir . '/' . $file);
                            continue;
                        }
                        $file = substr($file, 0, -1);
                    }
 
                    $path_info = pathinfo($a_dir . "/" . $file);
 
                    if (strtolower($path_info["extension"] ?? '') === strtolower($a_old_suffix)) {
                        $pos = strrpos($a_dir . "/" . $file, ".");
                        $new_name = substr($a_dir . "/" . $file, 0, $pos) . "." . $a_new_suffix;
                        // check if file exists
                        if (file_exists($new_name)) {
                            if (is_dir($new_name)) {
                                ilFileUtils::delDir($new_name);
                            } else {
                                unlink($new_name);
                            }
                        }
                        rename($a_dir . "/" . $file, $new_name);
                    }
                }
            }
        }
        return true;
    }

References delDir(), and rRenameSuffix().

Referenced by ilObjMediaObject\renameExecutables(), and rRenameSuffix().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sanitateTargetPath()

static ilFileUtils::sanitateTargetPath ( string $a_target )

staticprotected

Definition at line 355 of file class.ilFileUtils.php.

                                                                  : array
    {
        $target_file_system = match (true) {
            str_starts_with($a_target, 'public/' . ILIAS_WEB_DIR . '/' . CLIENT_ID),
            str_starts_with($a_target, './public/' . ILIAS_WEB_DIR . '/' . CLIENT_ID),
            str_starts_with($a_target, '/' . ILIAS_WEB_DIR . '/' . CLIENT_ID),
            str_starts_with($a_target, './' . ILIAS_WEB_DIR . '/' . CLIENT_ID),
            str_starts_with($a_target, CLIENT_WEB_DIR) => Location::WEB,
 
            str_starts_with($a_target, CLIENT_DATA_DIR . "/temp") => Location::TEMPORARY,
            str_starts_with($a_target, CLIENT_DATA_DIR) => Location::STORAGE,
 
            str_starts_with($a_target, ILIAS_ABSOLUTE_PATH . '/public/Customizing') => Location::CUSTOMIZING,
            default => throw new InvalidArgumentException(
                "Can not move files to \"$a_target\" because path can not be mapped to web, storage or customizing location."
            ),
        };
 
        $absolute_target_dir = dirname($a_target);
        $target_dir = LegacyPathHelper::createRelativePath($absolute_target_dir);
 
        return [$target_file_system, $target_dir];
    }

References CLIENT_DATA_DIR, CLIENT_ID, CLIENT_WEB_DIR, and ILIAS_WEB_DIR.

◆ unzip()

static ilFileUtils::unzip	(	string	$a_file,
		bool	$overwrite = `false`,
		bool	$a_flat = `false`
	)

static

unzip file

Parameters

string	$a_file	full path/filename
boolean	$overwrite	pass true to overwrite existing files

Definition at line 696 of file class.ilFileUtils.php.

                                                                                               : bool
    {
        if (defined('DEVMODE') && DEVMODE) {
            trigger_error('Deprecated method called: ' . __METHOD__, E_USER_DEPRECATED);
        }
 
        global $DIC;
        return $DIC->legacyArchives()->unzip(
            $a_file,
            null,
            $overwrite,
            $a_flat,
            false
        );
    }

References $DIC.

◆ utf8_encode()

static ilFileUtils::utf8_encode ( string $string )

static

Deprecated:: in ILIAS 9 for ILIAS 10: Use Refinery\String\Encoding instead

Definition at line 78 of file class.ilFileUtils.php.

                                                      : string
    {
        global $DIC;
        return $DIC->refinery()->string()->encoding()->latin1ToUtf8()->transform($string);
    }

References $DIC.

◆ zip()

static ilFileUtils::zip	(	string	$a_dir,
		string	$a_file,
		bool	$compress_content = `false`
	)

static

Deprecated:: Please refactor your code using $DIC->archives()->zip() (recommended) or $DIC->legacyArchives()->zip() instead.

Definition at line 459 of file class.ilFileUtils.php.

     : bool {
        global $DIC;
        // ensure top directory should be the same behaviour as before, if you need it to be different, you should legacyArchives directly
        return $DIC->legacyArchives()->zip($a_dir, $a_file, true);
    }

Referenced by ilSurveyExport\buildExportFileXML(), ilQuestionpoolExport\buildExportFileXML(), ilTestArchiver\compressTestArchive(), ilAssFileUploadUploadsExporter\createFileUploadCollectionZipFile(), ilSkinStyleContainer\createTempZip(), ilObjStyleSheet\export(), ilObjFileBasedLMGUI\exportHTML(), ilExportContainer\exportObject(), ILIAS\MediaCast\BackgroundTasks\DownloadAllZipJob\run(), ilCalendarZipJob\run(), ilOrgUnitExporter\sendAndCreateSimpleExportFile(), ILIAS\Test\ExportImport\Export\write(), ilUserCertificateZip\zipCertificatesInArchiveDirectory(), ilFileDataCourse\zipFile(), and ILIAS\Notes\Export\NotesHtmlExport\zipPackage().

Here is the caller graph for this function:

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

components/ILIAS/FileServices/classes/class.ilFileUtils.php

Static Public Member Functions

Static Protected Member Functions

Detailed Description

Member Function Documentation

◆ _sanitizeFilemame()

◆ createDirectory()

◆ delDir()

◆ dirsize()

◆ getASCIIFilename()

◆ getDataDir()

◆ getDir()

◆ getFileSizeInfo()

◆ getPhpUploadSizeLimitInBytes()

◆ getSafeFilename()

◆ getValidFilename()

◆ getWebspaceDir()

◆ ilTempnam()

◆ makeDir()

◆ makeDirParents()

◆ moveUploadedFile()

◆ rCopy()

◆ recursive_dirscan()

◆ removeTrailingPathSeparators()

◆ rename()

◆ renameExecutables()

◆ rRenameSuffix()

◆ sanitateTargetPath()

◆ unzip()

◆ utf8_encode()

◆ zip()