ilUploadFiles Class Reference

Collaboration diagram for ilUploadFiles:

Static Public Member Functions
static	_getUploadDirectory ()
	Get the directory with uploaded files. More...
static	_getUploadFiles ()
	Get a list of readable files in the upload directory. More...
static	_checkUploadFile ($a_file)
	Check if a file exists in the upload directory and is readable. More...
static	_copyUploadFile ($a_file, $a_target, $a_raise_errors=true)
	copy an uploaded file to the target directory (including virus check) More...

Detailed Description

Author

Fred Neumann fred..nosp@m.neum.nosp@m.ann@f.nosp@m.im.u.nosp@m.ni-er.nosp@m.lang.nosp@m.en.de

Version

$Id$

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

Member Function Documentation

_checkUploadFile()

static ilUploadFiles::_checkUploadFile (   $a_file )

static

Check if a file exists in the upload directory and is readable.

Parameters

string

file name

Returns

boolean true/false @access static

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

    {
        $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 (   $a_file,   $a_target,   $a_raise_errors = true  )

static

copy an uploaded file to the target directory (including virus check)

Parameters

string	file name
string	target path and name

Returns

boolean true/false @access static

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

    {
        global $DIC;
        $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 {
                ilUtil::sendFailure($lng->txt("upload_error_file_not_found"), true);
            }
            return false;
        }
 
        // virus handling
        $vir = ilUtil::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 {
                ilUtil::sendFailure($lng->txt("file_is_infected") . "<br />" .
                    $vir[1], true);
            }
            return false;
        } else {
            if ($vir[1] != "") {
                ilUtil::sendInfo($vir[1], true);
            }
            return copy($file, $a_target);
        }
    }

References $DIC, $lng, _getUploadDirectory(), ilUtil\sendFailure(), ilUtil\sendInfo(), and ilUtil\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

Get the directory with uploaded files.

The directory is configured as cont_upload_dir in the settings table. The directory must exist and have read permissions. Currently the user must have admin permissions in ILIAS. Later there may be different directories for different users/roles.

Returns

string full path of upload directory on the server or empty @access static

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

    {
        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");
        
        if (is_dir($upload_dir) and is_readable($upload_dir)) {
            return $upload_dir;
        } else {
            return '';
        }
    }

References $DIC, and $lm_set.

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

Here is the caller graph for this function:

_getUploadFiles()

static ilUploadFiles::_getUploadFiles ( )

static

Get a list of readable files in the upload directory.

Returns

array list of file names (without path) @access static

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

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

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

Here is the caller graph for this function:

---

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

• Services/FileSystem/classes/class.ilUploadFiles.php