ilUploadFiles Class Reference

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

Collaboration diagram for ilUploadFiles:

Static Public Member Functions
static	_getUploadDirectory ()
static	_getUploadFiles ()
static	_checkUploadFile (string $a_file)
static	_copyUploadFile (string $a_file, string $a_target, bool $a_raise_errors=true)

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

Deprecated:

Will be removed in ILIAS 10. No replacement suggested. This feature is only used in CmiXApi and SCORM and must be implemented there

Definition at line 23 of file class.ilUploadFiles.php.

Member Function Documentation

_checkUploadFile()

static ilUploadFiles::_checkUploadFile ( string  $a_file )

static

Definition at line 70 of file class.ilUploadFiles.php.

                                                           : bool
    {
        $files = self::_getUploadFiles();
 
        return in_array($a_file, $files);
    }

References _getUploadFiles().

Referenced by ilObjCmiXapiGUI\afterSave(), ilObjSCORMLearningModuleGUI\newModuleVersionUpload(), ilFileSystemGUI\uploadFile(), and ilObjSAHSLearningModuleGUI\uploadObject().

Here is the call graph for this function:

Here is the caller graph for this function:

_copyUploadFile()

static ilUploadFiles::_copyUploadFile ( string  $a_file, string  $a_target, bool  $a_raise_errors = true  )

static

Definition at line 77 of file class.ilUploadFiles.php.

                                                                                                         : bool
    {
        global $DIC;
        $main_tpl = $DIC->ui()->mainTemplate();
        $lng = $DIC['lng'];
        $ilias = $DIC['ilias'];
 
        $file = self::_getUploadDirectory() . "/" . $a_file;
 
        // check if file exists
        if (!is_file($file)) {
            if ($a_raise_errors) {
                $ilias->raiseError($lng->txt("upload_error_file_not_found"), $ilias->error_obj->MESSAGE);
            } else {
                $main_tpl->setOnScreenMessage('failure', $lng->txt("upload_error_file_not_found"), true);
            }
            return false;
        }
 
        // virus handling
        $vir = ilVirusScanner::virusHandling($file, $a_file);
        if (!$vir[0]) {
            if ($a_raise_errors) {
                $ilias->raiseError(
                    $lng->txt("file_is_infected") . "<br />" .
                    $vir[1],
                    $ilias->error_obj->MESSAGE
                );
            } else {
                $main_tpl->setOnScreenMessage('failure', $lng->txt("file_is_infected") . "<br />" .
                    $vir[1], true);
            }
            return false;
        }
        if ($vir[1] != "") {
            $main_tpl->setOnScreenMessage('info', $vir[1], true);
        }
        return copy($file, $a_target);
    }

References $DIC, $lng, _getUploadDirectory(), and ilVirusScanner\virusHandling().

Referenced by ilObjSCORMLearningModuleGUI\newModuleVersionUpload(), ilFileSystemGUI\uploadFile(), and ilObjSAHSLearningModuleGUI\uploadObject().

Here is the call graph for this function:

Here is the caller graph for this function:

_getUploadDirectory()

static ilUploadFiles::_getUploadDirectory ( )

static

Definition at line 25 of file class.ilUploadFiles.php.

                                                : string
    {
        global $DIC;
        $rbacsystem = $DIC['rbacsystem'];
 
        if (!$rbacsystem->checkAccess('write', SYSTEM_FOLDER_ID)) {
            return '';
        }
 
        $lm_set = new ilSetting("lm");
        $upload_dir = $lm_set->get("cont_upload_dir");
 
        $import_file_factory = new ilImportDirectoryFactory();
        try {
            $scorm_import_directory = $import_file_factory->getInstanceForComponent(ilImportDirectoryFactory::TYPE_SAHS);
        } catch (InvalidArgumentException) {
            return '';
        }
        return $scorm_import_directory->getAbsolutePath();
    }

References $DIC, $lm_set, SYSTEM_FOLDER_ID, and ilImportDirectoryFactory\TYPE_SAHS.

Referenced by _copyUploadFile(), ilObjCmiXapiGUI\afterSave(), ilObjCmiXapiGUI\initCreateForm(), ilObjSAHSLearningModuleGUI\initCreateForm(), ilFileSystemGUI\listFiles(), and ilObjSCORMLearningModuleGUI\newModuleVersion().

Here is the caller graph for this function:

_getUploadFiles()

static ilUploadFiles::_getUploadFiles ( )

static

Returns

string[]

Definition at line 49 of file class.ilUploadFiles.php.

                                            : array
    {
        if ($upload_dir = self::_getUploadDirectory() === '' || $upload_dir = self::_getUploadDirectory() === '0') {
            return [];
        }
 
        // get the sorted content of the upload directory
        $handle = opendir($upload_dir);
        $files = [];
        while (false !== ($file = readdir($handle))) {
            $full_path = $upload_dir . "/" . $file;
            if (is_file($full_path) && is_readable($full_path)) {
                $files[] = $file;
            }
        }
        closedir($handle);
        sort($files);
 
        return $files;
    }

References ILIAS\UI\examples\Symbol\Glyph\Sort\sort().

Referenced by _checkUploadFile(), ilObjCmiXapiGUI\initCreateForm(), ilObjSAHSLearningModuleGUI\initCreateForm(), ilFileSystemGUI\listFiles(), and ilObjSCORMLearningModuleGUI\newModuleVersion().

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• components/ILIAS/Filesystem/classes/class.ilUploadFiles.php