ilFileUtils Class Reference

Class ilFileUtils. More...

Collaboration diagram for ilFileUtils:

Public Member Functions
	fastBase64Encode ($filein, $fileout)
	decodes base encoded file row by row to prevent memory exhaust More...
	fastGunzip ($in, $out)
	fast uncompressing the file with the zlib-extension without memory consumption More...

Static Public Member Functions
static	processZipFile ($a_directory, $a_file, $structure, $ref_id=null, $containerType=null, $tree=null, $access_handler=null)
	unzips in given directory and processes uploaded zip for use as single files More...
static	recursive_dirscan ($dir, &$arr)
	Recursively scans a given directory and writes path and filename into referenced array. More...
static	createObjects ($dir, $structure, $ref_id, $containerType, $tree=null, $access_handler=null)
	Recursively scans a given directory and creates file and folder/category objects. More...
static	createContainer ($name, $ref_id, $containerType, $tree=null, $access_handler=null)
	Creates and inserts container object (folder/category) into tree. More...
static	createFile ($filename, $path, $ref_id, $tree=null, $access_handler=null)
	Creates and inserts file object into tree. More...
static	getNewObjects ()
static	utf8_encode ($string)
	utf8-encodes string if it is not a valid utf8-string. More...
static	fastBase64Decode ($filein, $fileout)
	decodes base encoded file row by row to prevent memory exhaust More...
static	lookupContentMimeType ($content)
static	lookupFileMimeType ($a_file)
static	_lookupMimeType ($a_file)
static	getValidExtensions ()
	Valid extensions. More...
static	getDefaultValidExtensionWhiteList ()
	Valid extensions. More...
static	getValidFilename ($a_filename)
	Get valid filename. More...
static	hasValidExtension ($a_filename)
static	rename ($a_source, $a_target)
	Rename a file. More...

Static Protected Attributes
static	$new_files = array()

Private Member Functions
	fastGZip ($in, $out, $level="9")
	fast compressing the file with the zlib-extension without memory consumption More...

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.

Author

Jan Hippchen janhi.nosp@m.ppch.nosp@m.en@gm.nosp@m.x.de

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

Member Function Documentation

_lookupMimeType()

static ilFileUtils::_lookupMimeType (   $a_file )

static

Parameters

string

file absolute path to file

Returns

string $mimeType

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

    {
        return self::lookupFileMimeType($a_file);
    }

References lookupFileMimeType().

Referenced by ilFileXMLParser\handlerEndTag().

Here is the call graph for this function:

Here is the caller graph for this function:

createContainer()

static ilFileUtils::createContainer (   $name,   $ref_id,   $containerType,   $tree = null,   $access_handler = null  )

static

Creates and inserts container object (folder/category) into tree.

Parameters

string	$name	Name of the object
integer	$ref_id	ref_id of parent
string	$containerType	Fold or Cat

Returns

integer ref_id of containerobject

Author

Jan Hippchen

Version

1.6.9.07

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

    {
        switch ($containerType) {
            case "Category":
                include_once("./Modules/Category/classes/class.ilObjCategory.php");
                $newObj = new ilObjCategory();
                $newObj->setType("cat");
                break;
 
            case "Folder":
                include_once("./Modules/Folder/classes/class.ilObjFolder.php");
                $newObj = new ilObjFolder();
                $newObj->setType("fold");
                break;
 
            case "WorkspaceFolder":
                include_once("./Modules/WorkspaceFolder/classes/class.ilObjWorkspaceFolder.php");
                $newObj = new ilObjWorkspaceFolder();
                break;
        }
 
        $newObj->setTitle($name);
        $newObj->create();
 
        // repository
        if (!$access_handler) {
            $newObj->createReference();
            $newObj->putInTree($ref_id);
            $newObj->setPermissions($ref_id);
 
            if ($newObj->getType() == "cat") {
                global $DIC;
 
                $lng = $DIC->language();
                $newObj->addTranslation($name, "", $lng->getLangKey(), $lng->getLangKey());
            }
 
            self::$new_files[$ref_id][] = $newObj;
 
            return $newObj->getRefId();
        } // workspace
        else {
            $node_id = $tree->insertObject($ref_id, $newObj->getId());
            $access_handler->setPermissions($ref_id, $node_id);
 
            return $node_id;
        }
    }

References $DIC, $lng, $name, and $tree.

Referenced by createObjects().

Here is the caller graph for this function:

createFile()

static ilFileUtils::createFile (   $filename,   $path,   $ref_id,   $tree = null,   $access_handler = null  )

static

Creates and inserts file object into tree.

Parameters

string	$filename	Name of the object
string	$path	Path to file
integer	$ref_id	ref_id of parent

Version

1.6.9.07

Author

Jan Hippchen

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

    {
        global $DIC;
 
        $rbacsystem = $DIC->rbac()->system();
        $lng = $DIC->language();
        $ilErr = $DIC["ilErr"];
 
        if (!$access_handler) {
            $permission = $rbacsystem->checkAccess("create", $ref_id, "file");
        } else {
            $permission = $access_handler->checkAccess("create", "", $ref_id, "file");
        }
        if ($permission) {
 
            // create and insert file in grp_tree
            include_once("./Modules/File/classes/class.ilObjFile.php");
            $fileObj = new ilObjFile();
            $fileObj->setType('file');
            $fileObj->setTitle(ilFileUtils::utf8_encode(ilUtil::stripSlashes($filename)));
            $fileObj->setFileName(ilFileUtils::utf8_encode(ilUtil::stripSlashes($filename)));
 
            // better use this, mime_content_type is deprecated
            include_once("./Services/MediaObjects/classes/class.ilObjMediaObject.php");
            $fileObj->setFileType(ilObjMediaObject::getMimeType($path . "/" . $filename));
            $fileObj->setFileSize(filesize($path . "/" . $filename));
            $fileObj->create();
 
            // repository
            if (!$access_handler) {
                $fileObj->createReference();
                $fileObj->putInTree($ref_id);
                $fileObj->setPermissions($ref_id);
 
                self::$new_files[$ref_id][] = $fileObj;
            } else {
                $node_id = $tree->insertObject($ref_id, $fileObj->getId());
                $access_handler->setPermissions($ref_id, $node_id);
            }
 
            // upload file to filesystem
            $fileObj->createDirectory();
            $fileObj->storeUnzipedFile($path . "/" . $filename, ilFileUtils::utf8_encode(ilUtil::stripSlashes($filename)));
        } else {
            $ilErr->raiseError($lng->txt("permission_denied"), $ilErr->MESSAGE);
        }
    }

References $DIC, $filename, $ilErr, $lng, $path, $tree, ilObjMediaObject\getMimeType(), ilUtil\stripSlashes(), and utf8_encode().

Referenced by createObjects().

Here is the call graph for this function:

Here is the caller graph for this function:

createObjects()

static ilFileUtils::createObjects (   $dir,   $structure,   $ref_id,   $containerType,   $tree = null,   $access_handler = null  )

static

Recursively scans a given directory and creates file and folder/category objects.

Calls createContainer & createFile to store objects in tree

Parameters

string	$dir	Directory to start from
	boolean	structure True if archive structure is to be overtaken (otherwise flat inclusion)
integer	$ref_id	ref_id of parent object, if null, files won�t be included in system (just checked)
	string	containerType object type of created containerobjects (folder or category)

Returns

integer errorcode

Exceptions

ilFileUtilsException

Author

Jan Hippchen

Version

1.6.9.07

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

    {
        $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)) {
                    if ($structure) {
                        $new_ref_id = ilFileUtils::createContainer(ilFileUtils::utf8_encode($file), $ref_id, $containerType, $tree, $access_handler);
                        ilFileUtils::createObjects($newpath, $structure, $new_ref_id, $containerType, $tree, $access_handler);
                    } else {
                        ilFileUtils::createObjects($newpath, $structure, $ref_id, $containerType, $tree, $access_handler);
                    }
                } else {
                    ilFileUtils::createFile(end($level), $dir, $ref_id, $tree, $access_handler);
                }
            }
        }
        closedir($dirlist);
    }

References ilFileUtilsException\$BROKEN_FILE, $lng, $tree, createContainer(), createFile(), createObjects(), and utf8_encode().

Referenced by createObjects(), and processZipFile().

Here is the call graph for this function:

Here is the caller graph for this function:

fastBase64Decode()

static ilFileUtils::fastBase64Decode (   $filein,   $fileout  )

static

decodes base encoded file row by row to prevent memory exhaust

Parameters

string	$filename	name of file to read
string	$fileout	name where to put decoded file

Returns

bool

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

    {
        $fh = fopen($filein, 'rb');
        $fh2 = fopen($fileout, 'wb');
        stream_filter_append($fh2, 'convert.base64-decode');
 
        while (!feof($fh)) {
            $chunk = fgets($fh);
            if ($chunk === false) {
                break;
            }
            fwrite($fh2, $chunk);
        }
        fclose($fh);
        fclose($fh2);
 
        return true;
    }

Referenced by ilFileXMLParser\handlerEndTag().

Here is the caller graph for this function:

fastBase64Encode()

ilFileUtils::fastBase64Encode	(		$filein,
			$fileout
	)

decodes base encoded file row by row to prevent memory exhaust

Parameters

string

$filename

name of file to read

Returns

string base decoded content

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

    {
        $fh = fopen($filein, 'rb');
        $fh2 = fopen($fileout, 'wb');
        stream_filter_append($fh2, 'convert.base64-encode');
 
        while (feof($fh)) {
            $chunk = fgets($fh, 76);
            if ($chunk === false) {
                break;
            }
            fwrite($fh2, $chunk);
        }
        fclose($fh);
        fclose($fh2);
    }

fastGunzip()

ilFileUtils::fastGunzip	(		$in,
			$out
	)

fast uncompressing the file with the zlib-extension without memory consumption

Parameters

string	$in	filename
string	$out	filename

Returns

bool

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

    {
        if (!file_exists($in) || !is_readable($in)) {
            return false;
        }
        if ((!file_exists($out) && !is_writable(dirname($out)) || (file_exists($out) && !is_writable($out)))) {
            return false;
        }
 
        $in_file = gzopen($in, "rb");
        $out_file = fopen($out, "wb");
 
        while (!gzeof($in_file)) {
            $buffer = gzread($in_file, 4096);
            fwrite($out_file, $buffer, 4096);
        }
 
        gzclose($in_file);
        fclose($out_file);
 
        return true;
    }

References $in, and $out.

Referenced by ilFileXMLParser\handlerEndTag().

Here is the caller graph for this function:

fastGZip()

ilFileUtils::fastGZip (   $in,   $out,   $level = "9"  )

private

fast compressing the file with the zlib-extension without memory consumption

Parameters

string	$in	filename
string	$out	filename
string	$level	compression level from 1 to 9

Returns

bool

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

    {
        if (!file_exists($in) || !is_readable($in)) {
            return false;
        }
        if ((!file_exists($out) && !is_writable(dirname($out)) || (file_exists($out) && !is_writable($out)))) {
            return false;
        }
 
        $in_file = fopen($in, "rb");
        if (!$out_file = gzopen($out, "wb" . $param)) {
            return false;
        }
 
        while (!feof($in_file)) {
            $buffer = fgets($in_file, 4096);
            gzwrite($out_file, $buffer, 4096);
        }
 
        fclose($in_file);
        gzclose($out_file);
 
        return true;
    }

References $in, and $out.

getDefaultValidExtensionWhiteList()

static ilFileUtils::getDefaultValidExtensionWhiteList ( )

static

Valid extensions.

Returns

array valid file extensions

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

    {
        return array(
            '3gp',    // VIDEO__3_GPP
            '7z',                        // application/x-7z-compressed
            'ai',    // APPLICATION__POSTSCRIPT
            'aif',    // AUDIO__AIFF
            'aifc', // AUDIO__AIFF
            'aiff', // AUDIO__AIFF
            'au',    // AUDIO__BASIC
            'arw',  // IMAGE__X_SONY_ARW
            'avi',  // AUDIO__BASIC
            'backup', // scorm wbts
            'bak', // scorm wbts
            'bas',                        // SPSS script
            'bpmn', // bpmn
            'bpmn2', // bpmn2
            'bmp',    // IMAGE__BMP
            'bib',    // bibtex
            'bibtex',    // bibtex
            'bz',    // APPLICATION__X_BZIP
            'bz2',    // APPLICATION__X_BZIP2
            'c',    // TEXT__PLAIN
            'c++',    // TEXT__PLAIN
            'cc',    // TEXT__PLAIN
            'cct', // scorm wbts
            'cdf',                        // (Wolfram) Computable Document Format
            'cer',    // APPLICATION__X_X509_CA_CERT
            'class', // APPLICATION__X_JAVA_CLASS
            'cls',                        // SPSS script
            'conf',     // TEXT__PLAIN
            'cpp',    // TEXT__X_C
            'crt',    // APPLICATION__X_X509_CA_CERT
            'crs', // scorm wbts
            'crw', // IMAGE__X_CANON_CRW
            'cr2', // IMAGE__X_CANON_CR2
            'css',    // TEXT__CSS
            'cst', // scorm wbts
            'csv',
            'cur', // scorm wbts
            'db', // scorm wbts
            'dcr', // scorm wbts
            'des', // scorm wbts
            'dng', // IMAGE__X_ADOBE_DNG
            'doc',   // APPLICATION__MSWORD,
            'docx',   // APPLICATION__VND_OPENXMLFORMATS_OFFICEDOCUMENT_WORDPROCESSINGML_DOCUMENT,
            'dot',   // APPLICATION__MSWORD,
            'dotx',   // APPLICATION__VND_OPENXMLFORMATS_OFFICEDOCUMENT_WORDPROCESSINGML_TEMPLATE,
            'dtd',
            'dvi',   // APPLICATION__X_DVI,
            'el',   // TEXT__X_SCRIPT_ELISP,
            'eps',   // APPLICATION__POSTSCRIPT,
            'epub',   // APPLICATION__EPUB,
            'f',   // TEXT__X_FORTRAN,
            'f77',   // TEXT__X_FORTRAN,
            'f90',   // TEXT__X_FORTRAN,
            'flv',   // VIDEO__X_FLV,
            'for',   // TEXT__X_FORTRAN,
            'g3',   // IMAGE__G3FAX,
            'gif',   // IMAGE__GIF,
            'gl',   // VIDEO__GL,
            'gan',
            'ggb', // GEOGEBRA
            'gsd',   // AUDIO__X_GSM,
            'gsm',   // AUDIO__X_GSM,
            'gtar',   // APPLICATION__X_GTAR,
            'gz',   // APPLICATION__X_GZIP,
            'gzip',   // APPLICATION__X_GZIP,
            'h',    // TEXT__X_C
            'hpp',    // TEXT__X_C
            'htm',   // TEXT__HTML,
            'html',   // TEXT__HTML,
            'htmls',   // TEXT__HTML,
            'ibooks', // Apple IBook Format
            'ico',   // IMAGE__X_ICON,
            'ics',   // iCalendar, TEXT__CALENDAR
            'ini', // scorm wbts
            'ipynb',                        // iPython file for Jupyter Notebooks
            'java',   // TEXT__X_JAVA_SOURCE,
            'jbf', // scorm wbts
            'jpeg',   // IMAGE__PJPEG,
            'jpg',   // IMAGE__JPEG,
            'js',   // APPLICATION__X_JAVASCRIPT,
            'jsf', // scorm wbts
            'jso', // scorm wbts
            'json',        // APPLICATION__JSON
            'latex',   // APPLICATION__X_LATEX,
            'lang',   // lang files
            'less', // less
            'log',   // TEXT__PLAIN,
            'lsp',   // APPLICATION__X_LISP,
            'ltx',   // APPLICATION__X_LATEX,
            'm1v',   // VIDEO__MPEG,
            'm2a',   // AUDIO__MPEG,
            'm2v',   // VIDEO__MPEG,
            'm3u',   // AUDIO__X_MPEQURL,
            'm4a',   // AUDIO__MP4,
            'm4v',   // VIDEO__MP4,
            'markdown',    // TEXT__MARKDOWN,
            'm',     // MATLAB
            'mat',   // MATLAB
            'md',    // TEXT__MARKDOWN,
            'mdl',                // Vensim files
            'mdown',    // TEXT__MARKDOWN,
            'mid',   // AUDIO__MIDI,
            'min',        // scorm articulate?
            'midi',   // AUDIO__MIDI,
            'mobi',   // APPLICATION__X_MOBI,
            'mod',   // AUDIO__MOD,
            'mov',   // VIDEO__QUICKTIME,
            'movie',   // VIDEO__X_SGI_MOVIE,
            'mp2',   // AUDIO__X_MPEG,
            'mp3',   // AUDIO__X_MPEG3,
            'mp4',   // VIDEO__MP4,
            'mpa',   // AUDIO__MPEG,
            'mpeg',   // VIDEO__MPEG,
            'mpg',   // AUDIO__MPEG,
            'mph',   // COMSOL Multiphysics
            'mpga',   // AUDIO__MPEG,
            'mpp',   // APPLICATION__VND_MS_PROJECT,
            'mpt',   // APPLICATION__X_PROJECT,
            'mpv',   // APPLICATION__X_PROJECT,
            'mpx',   // APPLICATION__X_PROJECT,
            'mv',   // VIDEO__X_SGI_MOVIE,
            'mw',
            'mv4',   // VIDEO__MP4,
            'nb',                        // Wolfram Notebook files
            'nbp',                        // Wolfram Notebook Player files
            'nef',   // IMAGE__X_NIKON_NEF,
            'nif',   // IMAGE__X_NIFF,
            'niff',   // IMAGE__X_NIFF,
            'obj',                    // Wavefront .obj file
            'obm',                        // SPSS script
            'odt',   // Open document text,
            'ods',   // Open document spreadsheet,
            'odp',   // Open document presentation,
            'odg',   // Open document graphics,
            'odf',   // Open document formula,
            'oga',   // AUDIO__OGG,
            'ogg',   // AUDIO__OGG,
            'ogv',   //  VIDEO__OGG,
            'old',   //  no real file extension, but used in mail/forum components,
            'p',   //  TEXT__X_PASCAL,
            'pas',   //  TEXT__PASCAL,
            'pbm',   //  IMAGE__X_PORTABLE_BITMAP,
            'pcl',   //  APPLICATION__VND_HP_PCL,
            'pct',   //  IMAGE__X_PICT,
            'pcx',   // IMAGE__X_PCX,
            'pdf',   // APPLICATION__PDF,
            'pgm',   // IMAGE__X_PORTABLE_GRAYMAP,
            'pic',   // IMAGE__PICT,
            'pict',   // IMAGE__PICT,
            'png',   // IMAGE__PNG,
            'por',    // Portable SPSS file
            'pov',   // MODEL__X_POV,
            'project', // scorm wbts
            'properties', // scorm wbts
            'ppa',   // APPLICATION__VND_MS_POWERPOINT,
            'ppm',   // IMAGE__X_PORTABLE_PIXMAP,
            'pps',   // APPLICATION__VND_MS_POWERPOINT,
            'ppsx',   // APPLICATION__VND_OPENXMLFORMATS_OFFICEDOCUMENT_PRESENTATIONML_SLIDESHOW,
            'ppt',   // APPLICATION__POWERPOINT,
            'pptx',   // APPLICATION__VND_OPENXMLFORMATS_OFFICEDOCUMENT_PRESENTATIONML_PRESENTATION,
            'ppz',   // APPLICATION__MSPOWERPOINT,
            'ps',   // APPLICATION__POSTSCRIPT,
            'psd', // scorm wbts
            'pwz',   // APPLICATION__VND_MS_POWERPOINT,
            'qt',   // VIDEO__QUICKTIME,
            'qtc',   // VIDEO__X_QTC,
            'qti',   // IMAGE__X_QUICKTIME,
            'qtif',   // IMAGE__X_QUICKTIME,
            'r',    // R script file
            'ra',   // AUDIO__X_PN_REALAUDIO,
            'ram',   // AUDIO__X_PN_REALAUDIO,
            'rar',    // RAR (application/vnd.rar)
            'rast',   // IMAGE__CMU_RASTER,
            'rda',    // R data file
            'rev',    // RAR (application/vnd.rar)
            'rexx',   // TEXT__X_SCRIPT_REXX,
            'ris',    // ris
            'rf',   // IMAGE__VND_RN_REALFLASH,
            'rgb',   // IMAGE__X_RGB,
            'rm',   // APPLICATION__VND_RN_REALMEDIA,
            'rmd',    // R Markdown file
            'rmi',   // AUDIO__MID,
            'rmm',   // AUDIO__X_PN_REALAUDIO,
            'rmp',   // AUDIO__X_PN_REALAUDIO,
            'rt',   // TEXT__RICHTEXT,
            'rtf',   // TEXT__RICHTEXT,
            'rtx',   // TEXT__RICHTEXT,
            'rv',   // VIDEO__VND_RN_REALVIDEO,
            's',   // TEXT__X_ASM,
            's3m',   // AUDIO__S3M,
            'sav',   // SPSS data file
            'sbs',    // SPSS script
            'sec',   //
            'sdml',   // TEXT__PLAIN,
            'sgm',   // TEXT__SGML,
            'sgml',   // TEXT__SGML
            'smi',   // APPLICATION__SMIL,
            'smil',   // APPLICATION__SMIL,
            'sps',    // SPSS syntax file
            'spv',    // SPSS output file
            'stl',                // Stereolithography CAD file
            'svg',   // IMAGE__SVG_XML,
            'swa', // scorm wbts
            'swf',   // APPLICATION__X_SHOCKWAVE_FLASH,
            'swz', // scorm wbts
            'tar',                // application/x-tar
            'tex',   // APPLICATION__X_TEX,
            'texi',   // APPLICATION__X_TEXINFO,
            'texinfo',   // APPLICATION__X_TEXINFO,
            'text',   // TEXT__PLAIN,
            'tgz',   // APPLICATION__X_COMPRESSED,
            'tif',   // IMAGE__TIFF,
            'tiff',   // IMAGE__TIFF,
            'ttf', // scorm wbts
            'txt',   // TEXT__PLAIN,
            'tmp',
            'uvproj',
            'vdf',
            'vimeo',   // VIDEO__VIMEO,
            'viv',   // VIDEO__VIMEO,
            'vivo',   // VIDEO__VIVO,
            'vrml',   // APPLICATION__X_VRML,
            'vsdx',   // viseo
            'wav',        // wav
            'webm',   // VIDEO__WEBM,
            'wmv',   // VIDEO__X_MS_WMV,
            'wmx',   // VIDEO__X_MS_WMX,
            'wmz',   // VIDEO__X_MS_WMZ,
            'woff',   // web open font format,
            'wwd',                        // SPSS script
            'xhtml',   // APPLICATION__XHTML_XML,
            'xif',   // IMAGE__VND_XIFF,
            'xls',   // APPLICATION__EXCEL,
            'xlsx',   // APPLICATION__VND_OPENXMLFORMATS_OFFICEDOCUMENT_SPREADSHEETML_SHEET,
            'xmind',
            'xml',   // self::TEXT__XML,
            'xsl',   // APPLICATION__XML,
            'xsd',   // scorm
            'zip'    // APPLICATION__ZIP
        );
    }

Referenced by getValidExtensions(), and ilObjFileAccessSettingsGUI\initUploadSettingsForm().

Here is the caller graph for this function:

getNewObjects()

static ilFileUtils::getNewObjects ( )

static

Returns

array

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

    {
        return self::$new_files;
    }

References $new_files.

getValidExtensions()

static ilFileUtils::getValidExtensions ( )

static

Valid extensions.

Returns

array valid file extensions

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

    {
        global $DIC;
 
        $setting = $DIC->settings();
 
        // default white list
        $whitelist = self::getDefaultValidExtensionWhiteList();
 
        // remove custom black list values
        foreach (explode(",", $setting->get("suffix_repl_additional")) as $custom_black) {
            $custom_black = trim(strtolower($custom_black));
            if (($key = array_search($custom_black, $whitelist)) !== false) {
                unset($whitelist[$key]);
            }
        }
 
        // add custom white list values
        foreach (explode(",", $setting->get("suffix_custom_white_list")) as $custom_white) {
            $custom_white = trim(strtolower($custom_white));
            if (!in_array($custom_white, $whitelist)) {
                $whitelist[] = $custom_white;
            }
        }
 
        // bugfix mantis 25498: add an empty entry to ensure that files without extensions are still valid
        $whitelist[] = '';
 
        return $whitelist;
    }

References $DIC, $key, and getDefaultValidExtensionWhiteList().

Referenced by ILIAS\Filesystem\Security\Sanitizing\FilenameSanitizerImpl\__construct(), ILIAS\Filesystem\Decorator\FilesystemWhitelistDecorator\__construct(), and ilObjFileAccessSettingsGUI\initUploadSettingsForm().

Here is the call graph for this function:

Here is the caller graph for this function:

getValidFilename()

static ilFileUtils::getValidFilename (   $a_filename )

static

Get valid filename.

Parameters

string

filename

Returns

string valid upload filename

Exceptions

ilFileUtilsException

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

    {
        if (!self::hasValidExtension($a_filename)) {
            $pi = pathinfo($a_filename);
            // if extension is not in white list, remove all "." and add ".sec" extension
            $basename = str_replace(".", "", $pi["basename"]);
            if (trim($basename) == "") {
                include_once("./Services/Utilities/classes/class.ilFileUtilsException.php");
                throw new ilFileUtilsException("Invalid upload filename.");
            }
            $basename .= ".sec";
            if ($pi["dirname"] != "" && ($pi["dirname"] != "." || substr($a_filename, 0, 2) == "./")) {
                $a_filename = $pi["dirname"] . "/" . $basename;
            } else {
                $a_filename = $basename;
            }
        }
 
        return $a_filename;
    }

Referenced by ilFileDataMail\deliverAttachmentsAsZip(), ilPortfolioCertificateFileService\deliverCertificate(), ilFileVersionsTableGUI\fillRow(), ilWebDAVRepositoryHelper\getFilenameWithSanitizedFileExtension(), ilObjFileDAV\getName(), ilObjFileDAV\getPathToFile(), ilCertificateFileUtilsHelper\getValidFilename(), ilWebDAVObjDAVHelper\isValidFileNameWithValidFileExtension(), ILIAS\File\Sanitation\FilePathSanitizer\needsSanitation(), ILIAS\File\Sanitation\FilePathSanitizer\santitizeFilename(), assFileUpload\saveWorkingData(), ilObjFile\storeUnzipedFile(), ilFSStorageExercise\uploadFile(), ilExSubmission\uploadFile(), and ilBadgeImageTemplate\uploadImage().

Here is the caller graph for this function:

hasValidExtension()

static ilFileUtils::hasValidExtension (   $a_filename )

static

Parameters

string

$a_filename

Returns

bool

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

    {
        $pi = pathinfo($a_filename);
 
        return (in_array(strtolower($pi["extension"]), self::getValidExtensions()));
    }

Referenced by ilObjFileGUI\uploadFiles().

Here is the caller graph for this function:

lookupContentMimeType()

static ilFileUtils::lookupContentMimeType (   $content )

static

Parameters

string

$content

Returns

string $mimeType

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

    {
        $finfo = new finfo(FILEINFO_MIME);
 
        return $finfo->buffer($content);
    }

Referenced by ilQtiMatImageSecurity\determineMimeType(), and lookupFileMimeType().

Here is the caller graph for this function:

lookupFileMimeType()

static ilFileUtils::lookupFileMimeType (   $a_file )

static

Parameters

string

$a_file

Returns

string $mimeType

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

    {
        if (!file_exists($a_file) or !is_readable($a_file)) {
            return false;
        }
 
        return self::lookupContentMimeType(file_get_contents($a_file));
    }

References lookupContentMimeType().

Referenced by _lookupMimeType().

Here is the call graph for this function:

Here is the caller graph for this function:

processZipFile()

static ilFileUtils::processZipFile (   $a_directory,   $a_file,   $structure,   $ref_id = null,   $containerType = null,   $tree = null,   $access_handler = null  )

static

unzips in given directory and processes uploaded zip for use as single files

Parameters

string	$a_directory	Directory to unzip
string	$a_file	Filename of archive
	boolean	structure True if archive structure is to be overtaken
integer	$ref_id	ref_id of parent object, if null, files wont be included in system (just checked)
	string	containerType object type of created containerobjects (folder or category)

Exceptions

ilFileUtilsException
ilException

Author

Jan Hippchen

Version

1.6.9.07

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

    {
        global $DIC;
 
        $lng = $DIC->language();
 
        self::$new_files = array();
 
        $pathinfo = pathinfo($a_file);
        $file = $pathinfo["basename"];
 
        // see 22727
        if ($pathinfo["extension"] == "") {
            $file .= ".zip";
        }
 
        // Copy zip-file to new directory, unzip and remove it
        // TODO: check archive for broken file
        //copy ($a_file, $a_directory . "/" . $file);
        ilUtil::moveUploadedFile($a_file, $file, $a_directory . "/" . $file);
        ilUtil::unzip($a_directory . "/" . $file);
        unlink($a_directory . "/" . $file);
        //echo "-".$a_directory . "/" . $file."-";
        // Stores filename and paths into $filearray to check for viruses
        // Checks if filenames can be read, else -> throw exception and leave
        ilFileUtils::recursive_dirscan($a_directory, $filearray);
 
        // if there are no files unziped (->broken file!)
        if (empty($filearray)) {
            throw new ilFileUtilsException($lng->txt("archive_broken"), ilFileUtilsException::$BROKEN_FILE);
        }
 
        // virus handling
        foreach ($filearray["file"] as $key => $value) {
            // remove "invisible" files
            if (substr($value, 0, 1) == "." || stristr($filearray["path"][$key], "/__MACOSX/")) {
                unlink($filearray["path"][$key] . $value);
                unset($filearray["path"][$key]);
                unset($filearray["file"][$key]);
                continue;
            }
 
            $vir = ilUtil::virusHandling($filearray["path"][$key], $value);
            if (!$vir[0]) {
                // Unlink file and throw exception
                unlink($filearray[path][$key]);
                throw new ilFileUtilsException($lng->txt("file_is_infected") . "<br />" . $vir[1], ilFileUtilsException::$INFECTED_FILE);
                break;
            } else {
                if ($vir[1] != "") {
                    throw new ilFileUtilsException($vir[1], ilFileUtilsException::$INFECTED_FILE);
                    break;
                }
            }
        }
 
        // If archive is to be used "flat"
        if (!$structure) {
            foreach (array_count_values($filearray["file"]) as $key => $value) {
                // Archive contains same filenames in different directories
                if ($value != "1") {
                    $doublettes .= " '" . ilFileUtils::utf8_encode($key) . "'";
                }
            }
            if (isset($doublettes)) {
                throw new ilFileUtilsException(
                    $lng->txt("exc_upload_error") . "<br />" . $lng->txt("zip_structure_error") . $doublettes,
                    ilFileUtilsException::$DOUBLETTES_FOUND
                );
            }
        } else {
            $mac_dir = $a_directory . "/__MACOSX";
            if (file_exists($mac_dir)) {
                ilUtil::delDir($mac_dir);
            }
        }
 
        // Everything fine since we got here; so we can store files and folders into the system (if ref_id is given)
        if ($ref_id != null) {
            ilFileUtils::createObjects($a_directory, $structure, $ref_id, $containerType, $tree, $access_handler);
        }
    }

References ilFileUtilsException\$BROKEN_FILE, $DIC, ilFileUtilsException\$DOUBLETTES_FOUND, ilFileUtilsException\$INFECTED_FILE, $key, $lng, $tree, createObjects(), ilUtil\delDir(), recursive_dirscan(), ilUtil\unzip(), utf8_encode(), and ilUtil\virusHandling().

Referenced by ilCloudPluginUploadGUI\handleFileUpload(), ilExSubmission\processUploadedZipFile(), and ilObjFileGUI\saveUnzip().

Here is the call graph for this function:

Here is the caller graph for this function:

recursive_dirscan()

static ilFileUtils::recursive_dirscan (   $dir, &  $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

Version

1.6.9.07

Author

Jan Hippchen

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

    {
        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 ilObjFileBasedLMGUI\afterSave(), ilSCORM13Package\dbImportSco(), ilObjSCORM2004LearningModule\exportPDF(), ilSCORM2004Asset\exportPDF(), ilObjTest\getCustomStyles(), ilExSubmission\processUploadedZipFile(), processZipFile(), recursive_dirscan(), ilUtil\unzip(), and ilFileSystemGUI\unzipFile().

Here is the call graph for this function:

Here is the caller graph for this function:

rename()

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

static

Rename a file.

Parameters

$a_source
$a_target

Returns

bool

Exceptions

ilFileUtilsException

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

    {
        $pi = pathinfo($a_target);
        if (!in_array(strtolower($pi["extension"]), self::getValidExtensions())) {
            include_once("./Services/Utilities/classes/class.ilFileUtilsException.php");
            throw new ilFileUtilsException("Invalid target file");
        }
 
        return rename($a_source, $a_target);
    }

References rename().

Referenced by ilAssFileUploadUploadsExporter\createFileUploadCollectionZipFile(), ilScorm2004DataSet\getXmlRecord(), ilScorm2004DataSet\importRecord(), ilScormAiccImporter\importXmlRepresentation(), assFlashQuestion\moveAppletIfExists(), ilObjSCORMLearningModuleGUI\newModuleVersionUpload(), rename(), ilFileSystemGUI\renameFile(), ilFileXMLParser\setFileContents(), ilObjFile\storeUnzipedFile(), and ilObjSAHSLearningModuleGUI\uploadObject().

Here is the call graph for this function:

Here is the caller graph for this function:

utf8_encode()

static ilFileUtils::utf8_encode (   $string )

static

utf8-encodes string if it is not a valid utf8-string.

Parameters

string

$string

String to encode

Returns

string utf-8-encoded string

Author

Jan Hippchen

Version

1.12.3.08

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

    {
 
        // From http://w3.org/International/questions/qa-forms-utf-8.html
        return (preg_match('%^(?:
                        [\x09\x0A\x0D\x20-\x7E]            # ASCII
                        | [\xC2-\xDF][\x80-\xBF]             # non-overlong 2-byte
                        |  \xE0[\xA0-\xBF][\x80-\xBF]        # excluding overlongs
                        | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2}  # straight 3-byte
                        |  \xED[\x80-\x9F][\x80-\xBF]        # excluding surrogates
                        |  \xF0[\x90-\xBF][\x80-\xBF]{2}     # planes 1-3
                        | [\xF1-\xF3][\x80-\xBF]{3}          # planes 4-15
                        |  \xF4[\x80-\x8F][\x80-\xBF]{2}     # plane 16
                        )*$%xs', $string)) ? $string : utf8_encode($string);
    }

References utf8_encode().

Referenced by createFile(), createObjects(), ilSCORM13Package\dbImportSco(), ilExSubmission\processUploadedZipFile(), processZipFile(), and utf8_encode().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$new_files

ilFileUtils::$new_files = array()

staticprotected

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

Referenced by getNewObjects().

---

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

• Services/Utilities/classes/class.ilFileUtils.php