ilFileSystemGUI Class Reference

File System Explorer GUI class. More...

Collaboration diagram for ilFileSystemGUI:

Public Member Functions
	__construct (string $main_absolute_directory)
	setAllowedSuffixes (array $a_suffixes)
	getAllowedSuffixes ()
	setForbiddenSuffixes (array $a_suffixes)
	getForbiddenSuffixes ()
	isValidSuffix (string $a_suffix)
	setAllowDirectories (bool $a_val)
	getAllowDirectories ()
	setPostDirPath (bool $a_val)
	getPostDirPath ()
	setTableId (string $a_val)
	getTableId ()
	setTitle (string $a_val)
	getTitle ()
	setUseUploadDirectory (bool $a_val)
	getUseUploadDirectory ()
	getLastPerformedCommand ()
	executeCommand ()
	addCommand (object $a_obj, string $a_func, string $a_name, bool $a_single=true, bool $a_allow_dir=false)
	clearCommands ()
	labelFile (string $a_file, string $a_label)
	activateLabels (bool $a_act, string $a_label_header)
	setAllowDirectoryCreation (bool $a_val)
	getAllowDirectoryCreation ()
	setAllowFileCreation (bool $a_val)
	Set allowed file creation. More...
	getAllowFileCreation ()
	listFiles (?ilTable2GUI $a_table_gui=null)
	getTable (string $a_dir, string $a_subdir)
	renameFileForm (string $a_file)
	renameFile ()
	cancelRename ()
	createDirectory ()
	uploadFile ()
	confirmDeleteFile (array $a_files)
	deleteFile ()
	unzipFile (?string $a_file=null)
	downloadFile (string $a_file)
	getActionCommands ()
	defineCommands ()

Data Fields
const	PARAMETER_CDIR = "cdir"
const	SESSION_LAST_COMMAND = "fsys_lastcomm"
const	PARAMETER_NEWDIR = "newdir"
const	PARAMETER_FHSH = "fhsh"
const	POST_PARAM_FILE = "file"
const	PARAM_RESETOFFSET = "resetoffset"
const	PARAM_OLD_NAME = "old_name"
const	PARAM_UPFILE = "upfile"
const	POST_PARAM_NEW_NAME = "new_name"
const	POST_PARAM_NEW_DIR = "new_dir"
const	POST_PARAM_UPLOADED_FILE = "uploaded_file"
const	CMD_UNZIP_FILE = "unzipFile"

Protected Member Functions
	setPerformedCommand ($command, array $pars=[])
	parseCurrentDirectory ()
	getFileList (string $a_dir, ?string $a_subdir=null)
	getIncomingFiles ()

Protected Attributes
LegacyArchives	$unzip
ilCtrlInterface	$ctrl
bool	$use_upload_directory = false
array	$allowed_suffixes = []
array	$forbidden_suffixes = []
ilLanguage	$lng
string	$main_absolute_dir
bool	$post_dir_path = false
ilGlobalTemplateInterface	$tpl
array	$file_labels = []
bool	$label_enable = false
bool	$allow_directories = true
string	$table_id = ''
string	$title = ''
array	$commands = []
string	$label_header = ''
bool	$directory_creation = false
bool	$file_creation = false
WrapperFactory	$wrapper
ILIAS Refinery Factory	$refinery

Private Member Functions
	extCommand (int $a_nr)
	sanitizeCurrentDirectory ()

Private Attributes
Factory	$ui_factory
Renderer	$ui_renderer

Detailed Description

File System Explorer GUI class.

Deprecated:

Will be removed in ILIAS 10. Use ILIAS ResourceStorageService as replacement.

Definition at line 34 of file class.ilFileSystemGUI.php.

Constructor & Destructor Documentation

__construct()

ilFileSystemGUI::__construct

(

string

$main_absolute_directory

)

Parameters

string

$main_absolute_directory

Definition at line 75 of file class.ilFileSystemGUI.php.

    {
        global $DIC;
 
        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->tpl = $DIC->ui()->mainTemplate();
        $this->wrapper = $DIC->http()->wrapper();
        $this->refinery = $DIC->refinery();
        $this->main_absolute_dir = realpath($main_absolute_directory);
        $this->ui_factory = $DIC->ui()->factory();
        $this->ui_renderer = $DIC->ui()->renderer();
        $this->unzip = $DIC->legacyArchives();
 
        $this->defineCommands();
 
        $this->ctrl->saveParameter($this, self::PARAMETER_CDIR);
        $this->lng->loadLanguageModule("content");
        $this->setAllowDirectories(true);
        $this->setAllowDirectoryCreation(true);
        $this->setAllowFileCreation(true);
    }

References $DIC, ILIAS\Repository\ctrl(), defineCommands(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), setAllowDirectories(), setAllowDirectoryCreation(), and setAllowFileCreation().

Here is the call graph for this function:

Member Function Documentation

activateLabels()

ilFileSystemGUI::activateLabels	(	bool	$a_act,
		string	$a_label_header
	)

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

                                                                       : void
    {
        $this->label_enable = $a_act;
        $this->label_header = $a_label_header;
    }

addCommand()

ilFileSystemGUI::addCommand	(	object	$a_obj,
		string	$a_func,
		string	$a_name,
		bool	$a_single = true,
		bool	$a_allow_dir = false
	)

Definition at line 237 of file class.ilFileSystemGUI.php.

     : void {
        $i = count($this->commands);
 
        $this->commands[$i]["object"] = $a_obj;
        $this->commands[$i]["method"] = $a_func;
        $this->commands[$i]["name"] = $a_name;
        $this->commands[$i]["single"] = $a_single;
        $this->commands[$i]["allow_dir"] = $a_allow_dir;
    }

cancelRename()

ilFileSystemGUI::cancelRename

(

)

Definition at line 623 of file class.ilFileSystemGUI.php.

                                  : void
    {
        $this->ctrl->redirect($this, "listFiles");
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

clearCommands()

ilFileSystemGUI::clearCommands

(

)

Definition at line 253 of file class.ilFileSystemGUI.php.

                                   : void
    {
        $this->commands = [];
    }

confirmDeleteFile()

ilFileSystemGUI::confirmDeleteFile

(

array

$a_files

)

Definition at line 764 of file class.ilFileSystemGUI.php.

                                                     : void
    {
        global $DIC;
        $ilCtrl = $DIC['ilCtrl'];
        $tpl = $DIC['tpl'];
        $lng = $DIC['lng'];
 
        $cgui = new ilConfirmationGUI();
        $cgui->setFormAction($ilCtrl->getFormAction($this));
        $cgui->setHeaderText($lng->txt("info_delete_sure"));
        $cgui->setCancel($lng->txt("cancel"), "listFiles");
        $cgui->setConfirm($lng->txt("delete"), "deleteFile");
 
        foreach ($a_files as $i) {
            $cgui->addItem("file[]", $i, $i);
        }
 
        $tpl->setContent($cgui->getHTML());
    }

References $DIC, $lng, and ILIAS\UICore\GlobalTemplate\setContent().

Here is the call graph for this function:

createDirectory()

ilFileSystemGUI::createDirectory

(

)

Definition at line 628 of file class.ilFileSystemGUI.php.

                                     : void
    {
        global $DIC;
        $lng = $DIC['lng'];
 
        // determine directory
        $cur_subdir = $this->sanitizeCurrentDirectory();
        $cur_dir = (empty($cur_subdir))
            ? $this->main_absolute_dir
            : $this->main_absolute_dir . "/" . $cur_subdir;
 
        $new_dir = $this->wrapper->post()->has(self::POST_PARAM_NEW_DIR)
            ? $this->wrapper->post()->retrieve(self::POST_PARAM_NEW_DIR, $this->refinery->to()->string())
            : '';
 
        $new_dir = str_replace(".", "", ilUtil::stripSlashes($new_dir));
        $new_dir = str_replace("/", "", $new_dir);
 
        if (!empty($new_dir)) {
            ilFileUtils::makeDir($cur_dir . "/" . $new_dir);
            if (is_dir($cur_dir . "/" . $new_dir)) {
                $this->tpl->setOnScreenMessage('success', $lng->txt("cont_dir_created"), true);
                $this->setPerformedCommand("create_dir", ["name" => $new_dir]);
            }
        } else {
            $this->tpl->setOnScreenMessage('failure', $lng->txt("cont_enter_a_dir_name"), true);
        }
        $this->ctrl->saveParameter($this, self::PARAMETER_CDIR);
        $this->ctrl->redirect($this, 'listFiles');
    }

References $DIC, $lng, ILIAS\Repository\ctrl(), ilFileUtils\makeDir(), ILIAS\Repository\refinery(), and ilUtil\stripSlashes().

Here is the call graph for this function:

defineCommands()

ilFileSystemGUI::defineCommands

(

)

Definition at line 934 of file class.ilFileSystemGUI.php.

                                    : void
    {
        $this->commands = [
            0 => [
                "object" => $this,
                "method" => "downloadFile",
                "name" => $this->lng->txt("download"),
                "int" => true,
                "single" => true
            ],
            1 => [
                "object" => $this,
                "method" => "confirmDeleteFile",
                "name" => $this->lng->txt("delete"),
                "allow_dir" => true,
                "int" => true
            ],
            2 => [
                "object" => $this,
                "method" => self::CMD_UNZIP_FILE,
                "name" => $this->lng->txt("unzip"),
                "allow_dir" => true,
                "int" => true,
                "single" => true
            ],
            3 => [
                "object" => $this,
                "method" => "renameFileForm",
                "name" => $this->lng->txt("rename"),
                "allow_dir" => true,
                "int" => true,
                "single" => true
            ],
        ];
    }

References ILIAS\Repository\lng(), and true.

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

deleteFile()

ilFileSystemGUI::deleteFile

(

)

Definition at line 784 of file class.ilFileSystemGUI.php.

                                : void
    {
        if (!$this->wrapper->post()->has(self::POST_PARAM_FILE)) {
            throw new LogicException($this->lng->txt("no_checkbox"));
        }
        $is_dir = false;
        $post_file = null;
 
        $postfiles = $this->wrapper->post()->retrieve(
            self::POST_PARAM_FILE,
            $this->refinery->to()->listOf(
                $this->refinery->to()->string()
            )
        );
        foreach ($postfiles as $post_file) {
            if (ilUtil::stripSlashes($post_file) === "..") {
                throw new LogicException($this->lng->txt("no_checkbox"));
                break;
            }
 
            $cur_subdir = $this->sanitizeCurrentDirectory();
            $cur_dir = (empty($cur_subdir))
                ? $this->main_absolute_dir
                : $this->main_absolute_dir . "/" . $cur_subdir;
            $pi = pathinfo((string) $post_file);
            $file = $cur_dir . "/" . ilUtil::stripSlashes($pi["basename"]);
 
            if (is_file($file)) {
                unlink($file);
            }
 
            if (is_dir($file)) {
                $is_dir = true;
                ilFileUtils::delDir($file);
            }
        }
 
        $this->ctrl->saveParameter($this, self::PARAMETER_CDIR);
        if ($is_dir) {
            $this->tpl->setOnScreenMessage('success', $this->lng->txt("cont_dir_deleted"), true);
            $this->setPerformedCommand(
                "delete_dir",
                ["name" => ilUtil::stripSlashes($post_file)]
            );
        } else {
            $this->tpl->setOnScreenMessage('success', $this->lng->txt("cont_file_deleted"), true);
            $this->setPerformedCommand(
                "delete_file",
                ["name" => ilUtil::stripSlashes($post_file)]
            );
        }
        $this->ctrl->redirect($this, 'listFiles');
    }

References ILIAS\Repository\ctrl(), ilFileUtils\delDir(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and ilUtil\stripSlashes().

Here is the call graph for this function:

downloadFile()

ilFileSystemGUI::downloadFile

(

string

$a_file

)

Definition at line 914 of file class.ilFileSystemGUI.php.

                                                : void
    {
        $file = $this->main_absolute_dir . "/" . $a_file;
 
        if (is_file($file) && !(is_dir($file))) {
            ilFileDelivery::deliverFileLegacy($file, basename($a_file));
            exit;
        }
        $this->ctrl->saveParameter($this, self::PARAMETER_CDIR);
        $this->ctrl->redirect($this, "listFiles");
    }

References ILIAS\Repository\ctrl(), ilFileDelivery\deliverFileLegacy(), and exit.

Here is the call graph for this function:

executeCommand()

ilFileSystemGUI::executeCommand

(

)

Definition at line 224 of file class.ilFileSystemGUI.php.

                                    : string
    {
        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd("listFiles");
        if (str_starts_with((string) $cmd, "extCommand_")) {
            $ret = $this->extCommand(substr((string) $cmd, 11, strlen((string) $cmd) - 11));
        } else {
            $ret = $this->$cmd();
        }
 
        return $ret ?? '';
    }

References ILIAS\Repository\ctrl(), and extCommand().

Here is the call graph for this function:

extCommand()

ilFileSystemGUI::extCommand ( int  $a_nr )

private

Definition at line 381 of file class.ilFileSystemGUI.php.

                                          : string
    {
        $selected = $this->getIncomingFiles();
 
        if ($selected === []) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt("no_checkbox"), true);
            $this->ctrl->redirect($this, "listFiles");
        }
 
        // check if only one item is select, if command does not allow multiple selection
        if (count($selected) > 1 && ($this->commands[$a_nr]["single"] ?? false)) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt("cont_select_max_one_item"), true);
            $this->ctrl->redirect($this, "listFiles");
        }
 
        $cur_subdir = $this->sanitizeCurrentDirectory();
 
        // collect files and
        $files = [];
        foreach ($selected as $file) {
            $file = ilUtil::stripSlashes($file);
            $file = (empty($cur_subdir))
                ? $file
                : $cur_subdir . "/" . $file;
 
            // check wether selected item is a directory
            if (is_dir($this->main_absolute_dir . "/" . $file) &&
                !$this->commands[$a_nr]["allow_dir"]) {
                $this->tpl->setOnScreenMessage('failure', $this->lng->txt("select_a_file"), true);
                $this->ctrl->redirect($this, "listFiles");
            }
 
            $files[] = $file;
        }
 
        if ($this->commands[$a_nr]["single"] ?? false) {
            $files = array_shift($files);
        }
 
        $obj = $this->commands[$a_nr]["object"];
        $method = $this->commands[$a_nr]["method"];
 
        return (string) $obj->$method($files);
    }

References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ilUtil\stripSlashes().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

getActionCommands()

ilFileSystemGUI::getActionCommands

(

)

Returns

string[]

Definition at line 929 of file class.ilFileSystemGUI.php.

                                       : array
    {
        return $this->commands;
    }

getAllowDirectories()

ilFileSystemGUI::getAllowDirectories

(

)

Definition at line 150 of file class.ilFileSystemGUI.php.

                                         : bool
    {
        return $this->allow_directories;
    }

References $allow_directories.

getAllowDirectoryCreation()

ilFileSystemGUI::getAllowDirectoryCreation

(

)

Definition at line 431 of file class.ilFileSystemGUI.php.

                                               : bool
    {
        return $this->directory_creation;
    }

getAllowedSuffixes()

ilFileSystemGUI::getAllowedSuffixes

(

)

Returns

string[]

Definition at line 109 of file class.ilFileSystemGUI.php.

                                        : array
    {
        return $this->allowed_suffixes;
    }

References $allowed_suffixes.

Referenced by isValidSuffix().

Here is the caller graph for this function:

getAllowFileCreation()

ilFileSystemGUI::getAllowFileCreation

(

)

Definition at line 444 of file class.ilFileSystemGUI.php.

                                          : bool
    {
        return $this->file_creation;
    }

getFileList()

ilFileSystemGUI::getFileList ( string  $a_dir, ?string  $a_subdir = null  )

protected

Returns

array<int, array<string, mixed>>

Definition at line 310 of file class.ilFileSystemGUI.php.

                                                                           : array
    {
        $items = [];
 
        $entries = (is_dir($a_dir))
            ? ilFileUtils::getDir($a_dir)
            : [["type" => "dir", "entry" => ".."]];
 
        $items = [];
        foreach ($entries as $e) {
            if ($e["entry"] == ".") {
                continue;
            }
            if ($e["entry"] == ".." && empty($a_subdir)) {
                continue;
            }
            $cfile = (empty($a_subdir))
                ? $e["entry"]
                : $a_subdir . "/" . $e["entry"];
 
            $items[] = [
                self::POST_PARAM_FILE => $cfile,
                "entry" => $e["entry"],
                "type" => $e["type"],
                "size" => $e["size"] ?? 0,
                "hash" => md5((string) $e["entry"])
            ];
        }
 
        return $items;
    }

References Vendor\Package\$e, and ilFileUtils\getDir().

Here is the call graph for this function:

getForbiddenSuffixes()

ilFileSystemGUI::getForbiddenSuffixes

(

)

Returns

string[]

Definition at line 125 of file class.ilFileSystemGUI.php.

                                          : array
    {
        return $this->forbidden_suffixes;
    }

References $forbidden_suffixes.

Referenced by isValidSuffix().

Here is the caller graph for this function:

getIncomingFiles()

ilFileSystemGUI::getIncomingFiles ( )

protected

Returns

string[]

Definition at line 345 of file class.ilFileSystemGUI.php.

                                         : array
    {
        $sel_files = $hashes = [];
        if ($this->wrapper->post()->has(self::POST_PARAM_FILE)) {
            $hashes = $this->wrapper->post()->retrieve(
                self::POST_PARAM_FILE,
                $this->refinery->to()->listOf(
                    $this->refinery->to()->string()
                )
            );
        } elseif ($this->wrapper->query()->has(self::PARAMETER_FHSH)) {
            $hashes = [$this->wrapper->query()->retrieve(
                self::PARAMETER_FHSH,
                $this->refinery->to()->string()
            )
            ];
        }
 
        if (count($hashes) > 0) {
            $dir = $this->parseCurrentDirectory();
            $all_files = $this->getFileList($dir["dir"], $dir["subdir"]);
            foreach ($hashes as $hash) {
                foreach ($all_files as $file) {
                    if ($file["hash"] == $hash) {
                        $sel_files[] = $this->getPostDirPath()
                            ? $file[self::POST_PARAM_FILE]
                            : $file["entry"];
                        break;
                    }
                }
            }
        }
 
        return $sel_files;
    }

References ILIAS\Repository\refinery().

Here is the call graph for this function:

getLastPerformedCommand()

ilFileSystemGUI::getLastPerformedCommand

(

)

Returns

string[]

Definition at line 214 of file class.ilFileSystemGUI.php.

                                             : array
    {
        if (!ilSession::has(self::SESSION_LAST_COMMAND)) {
            return [];
        }
        $ret = ilSession::get(self::SESSION_LAST_COMMAND);
        ilSession::set(self::SESSION_LAST_COMMAND, null);
        return (array) $ret;
    }

References ilSession\get(), ilSession\has(), and ilSession\set().

Here is the call graph for this function:

getPostDirPath()

ilFileSystemGUI::getPostDirPath

(

)

Definition at line 160 of file class.ilFileSystemGUI.php.

                                    : bool
    {
        return $this->post_dir_path;
    }

References $post_dir_path.

getTable()

ilFileSystemGUI::getTable	(	string	$a_dir,
		string	$a_subdir
	)

Definition at line 508 of file class.ilFileSystemGUI.php.

                                                             : \ilFileSystemTableGUI
    {
        return new ilFileSystemTableGUI(
            $this,
            "listFiles",
            $a_dir,
            $a_subdir,
            $this->label_enable,
            $this->file_labels,
            $this->label_header,
            $this->commands,
            $this->getPostDirPath(),
            $this->getTableId()
        );
    }

getTableId()

ilFileSystemGUI::getTableId

(

)

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

                                : string
    {
        return $this->table_id;
    }

References $table_id.

getTitle()

ilFileSystemGUI::getTitle

(

)

Definition at line 180 of file class.ilFileSystemGUI.php.

                              : string
    {
        return $this->title;
    }

References $title.

getUseUploadDirectory()

ilFileSystemGUI::getUseUploadDirectory

(

)

Definition at line 190 of file class.ilFileSystemGUI.php.

                                           : bool
    {
        return $this->use_upload_directory;
    }

References $use_upload_directory.

isValidSuffix()

ilFileSystemGUI::isValidSuffix

(

string

$a_suffix

)

Definition at line 130 of file class.ilFileSystemGUI.php.

                                                   : bool
    {
        if (empty($a_suffix)) {
            return true;
        }
 
        if (is_array($this->getForbiddenSuffixes()) && in_array($a_suffix, $this->getForbiddenSuffixes())) {
            return false;
        }
        if (is_array($this->getAllowedSuffixes()) && in_array($a_suffix, $this->getAllowedSuffixes())) {
            return true;
        }
        return !is_array($this->getAllowedSuffixes()) || count($this->getAllowedSuffixes()) == 0;
    }

References getAllowedSuffixes(), and getForbiddenSuffixes().

Here is the call graph for this function:

labelFile()

ilFileSystemGUI::labelFile	(	string	$a_file,
		string	$a_label
	)

Definition at line 258 of file class.ilFileSystemGUI.php.

                                                              : void
    {
        $this->file_labels[$a_file][] = $a_label;
    }

listFiles()

ilFileSystemGUI::listFiles

(

?ilTable2GUI

$a_table_gui = null

)

Definition at line 449 of file class.ilFileSystemGUI.php.

                                                               : void
    {
        global $DIC;
        $ilToolbar = $DIC['ilToolbar'];
        $lng = $DIC['lng'];
        $ilCtrl = $DIC['ilCtrl'];
 
        $dir = $this->parseCurrentDirectory();
 
        $this->ctrl->setParameter($this, self::PARAMETER_CDIR, $dir["subdir"]);
 
        // toolbar for adding files/directories
        $ilToolbar->setFormAction($ilCtrl->getFormAction($this), true);
 
        if ($this->getAllowDirectories() && $this->getAllowDirectoryCreation()) {
            $ti = new ilTextInputGUI($this->lng->txt("cont_new_dir"), self::POST_PARAM_NEW_DIR);
            $ti->setMaxLength(80);
            $ti->setSize(10);
            $ilToolbar->addInputItem($ti, true);
            $ilToolbar->addFormButton($lng->txt("create"), "createDirectory");
 
            $ilToolbar->addSeparator();
        }
        if ($this->getAllowFileCreation()) {
            $fi = new ilFileInputGUI($this->lng->txt("cont_new_file"), "new_file");
            $fi->setSize(10);
            $ilToolbar->addInputItem($fi, true);
            $ilToolbar->addFormButton($lng->txt("upload"), "uploadFile");
        }
        if (ilUploadFiles::_getUploadDirectory() && $this->getAllowFileCreation() && $this->getUseUploadDirectory()) {
            $ilToolbar->addSeparator();
            $files = ilUploadFiles::_getUploadFiles();
            $options[""] = $lng->txt("cont_select_from_upload_dir");
            foreach ($files as $file) {
                $file = htmlspecialchars($file, ENT_QUOTES, "utf-8");
                $options[$file] = $file;
            }
            $si = new ilSelectInputGUI($this->lng->txt("cont_uploaded_file"), self::POST_PARAM_UPLOADED_FILE);
            $si->setOptions($options);
            $ilToolbar->addInputItem($si, true);
            $ilToolbar->addFormButton($lng->txt("copy"), "uploadFile");
        }
 
        $fs_table = $this->getTable($dir["dir"], $dir["subdir"]);
 
        if ($this->getTitle() !== "") {
            $fs_table->setTitle($this->getTitle());
        }
        if (
            $this->wrapper->query()->has(self::PARAM_RESETOFFSET)
            && $this->wrapper->query()->retrieve(
                self::PARAM_RESETOFFSET,
                $this->refinery->kindlyTo()->int()
            ) == 1) {
            $fs_table->resetOffset();
        }
        $this->tpl->setContent($fs_table->getHTML());
    }

References $DIC, $lng, ilUploadFiles\_getUploadDirectory(), ilUploadFiles\_getUploadFiles(), ILIAS\Repository\ctrl(), ILIAS\GlobalScreen\Scope\Footer\Factory\getTitle(), and ILIAS\Repository\lng().

Here is the call graph for this function:

parseCurrentDirectory()

ilFileSystemGUI::parseCurrentDirectory ( )

protected

Returns

array<string, mixed>

Definition at line 272 of file class.ilFileSystemGUI.php.

                                              : array
    {
        // determine directory
        // FIXME: I have to call stripSlashes here twice, because I could not
        //        determine where the second layer of slashes is added to the
        //        URL Parameter
 
        $cur_subdir = $this->wrapper->query()->has(self::PARAMETER_CDIR)
            ? $this->wrapper->query()->retrieve(self::PARAMETER_CDIR, $this->refinery->to()->string())
            : '';
 
        $new_subdir = $this->wrapper->query()->has(self::PARAMETER_NEWDIR)
            ? $this->wrapper->query()->retrieve(self::PARAMETER_NEWDIR, $this->refinery->to()->string())
            : '';
 
        $cur_subdir = ilUtil::stripSlashes(ilUtil::stripSlashes($cur_subdir));
        $new_subdir = ilUtil::stripSlashes(ilUtil::stripSlashes($new_subdir));
 
        if ($new_subdir === "..") {
            $cur_subdir = substr($cur_subdir, 0, strrpos($cur_subdir, "/"));
        } elseif (!empty($new_subdir)) {
            $cur_subdir = empty($cur_subdir) ? $new_subdir : $cur_subdir . "/" . $new_subdir;
        }
 
        $cur_subdir = str_replace("..", "", $cur_subdir);
        $cur_dir = (empty($cur_subdir))
            ? $this->main_absolute_dir
            : $this->main_absolute_dir . "/" . $cur_subdir;
 
        return [
            "dir" => realpath($cur_dir),
            "subdir" => $cur_subdir
        ];
    }

References ILIAS\Repository\refinery(), and ilUtil\stripSlashes().

Here is the call graph for this function:

renameFile()

ilFileSystemGUI::renameFile

(

)

Definition at line 554 of file class.ilFileSystemGUI.php.

                                : void
    {
        $new_name = $this->wrapper->post()->has(self::POST_PARAM_NEW_NAME)
            ? $this->wrapper->post()->retrieve(self::POST_PARAM_NEW_NAME, $this->refinery->to()->string())
            : '';
 
        $new_name = str_replace("..", "", ilUtil::stripSlashes($new_name));
        $new_name = str_replace("/", "", $new_name);
        if ($new_name === "") {
            throw new LogicException($this->lng->txt("enter_new_name"));
        }
 
        $pi = pathinfo($new_name);
        $suffix = $pi["extension"] ?? "";
        if ($suffix != "" && !$this->isValidSuffix($suffix)) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt("file_no_valid_file_type") . " ($suffix)", true);
            $this->ctrl->redirect($this, "listFiles");
        }
 
        $cur_subdir = $this->sanitizeCurrentDirectory();
        $dir = (empty($cur_subdir))
            ? $this->main_absolute_dir . "/"
            : $this->main_absolute_dir . "/" . $cur_subdir . "/";
 
        $old_name = $this->wrapper->query()->has(self::PARAM_OLD_NAME)
            ? $this->wrapper->query()->retrieve(self::PARAM_OLD_NAME, $this->refinery->to()->string())
            : null;
 
        // check if this path is inside $dir
        $old_name = ilUtil::stripSlashes($old_name);
        $realpath = realpath($dir . $old_name);
        if (!str_starts_with($realpath, realpath($dir))) {
            throw new ilException($this->lng->txt("no_permission"));
        }
 
        if (is_dir($dir . $old_name)) {
            rename($dir . $old_name, $dir . $new_name);
        } else {
            try {
                ilFileUtils::rename($dir . $old_name, $dir . $new_name);
            } catch (ilException $e) {
                $this->tpl->setOnScreenMessage('failure', $e->getMessage(), true);
                $this->ctrl->redirect($this, "listFiles");
            }
        }
 
        ilFileUtils::renameExecutables($this->main_absolute_dir);
        if (is_dir($dir . $new_name)) {
            $this->tpl->setOnScreenMessage(
                'success',
                $this->lng->txt("cont_dir_renamed"),
                true
            );
            $this->setPerformedCommand("rename_dir", [self::PARAM_OLD_NAME => $old_name,
                                                      self::POST_PARAM_NEW_NAME => $new_name
            ]);
        } else {
            $this->tpl->setOnScreenMessage(
                'success',
                $this->lng->txt("cont_file_renamed"),
                true
            );
            $this->setPerformedCommand("rename_file", [self::PARAM_OLD_NAME => $old_name,
                                                            self::POST_PARAM_NEW_NAME => $new_name
            ]);
        }
        $this->ctrl->redirect($this, "listFiles");
    }

References Vendor\Package\$e, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ilFileUtils\rename(), ilFileUtils\renameExecutables(), and ilUtil\stripSlashes().

Here is the call graph for this function:

renameFileForm()

ilFileSystemGUI::renameFileForm

(

string

$a_file

)

Definition at line 524 of file class.ilFileSystemGUI.php.

                                                  : void
    {
        $cur_subdir = $this->sanitizeCurrentDirectory();
        $file = $this->main_absolute_dir . "/" . $a_file;
 
        $this->ctrl->setParameter($this, self::PARAM_OLD_NAME, basename($a_file));
        $this->ctrl->saveParameter($this, self::PARAMETER_CDIR);
        $form = new ilPropertyFormGUI();
 
        // file/dir name
        $ti = new ilTextInputGUI($this->lng->txt("name"), self::POST_PARAM_NEW_NAME);
        $ti->setMaxLength(200);
        $ti->setSize(40);
        $ti->setValue(basename($a_file));
        $form->addItem($ti);
 
        // save and cancel commands
        $form->addCommandButton("renameFile", $this->lng->txt("rename"));
        $form->addCommandButton("cancelRename", $this->lng->txt("cancel"));
        $form->setFormAction($this->ctrl->getFormAction($this, "renameFile"));
 
        if (is_dir($file)) {
            $form->setTitle($this->lng->txt("cont_rename_dir"));
        } else {
            $form->setTitle($this->lng->txt("rename_file"));
        }
 
        $this->tpl->setContent($form->getHTML());
    }

References ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Here is the call graph for this function:

sanitizeCurrentDirectory()

ilFileSystemGUI::sanitizeCurrentDirectory ( )

private

Definition at line 970 of file class.ilFileSystemGUI.php.

                                               : string
    {
        $cur_subdir = $this->wrapper->query()->has(self::PARAMETER_CDIR)
            ? $this->wrapper->query()->retrieve(self::PARAMETER_CDIR, $this->refinery->to()->string())
            : '';
 
        return str_replace(
            "..",
            "",
            ilUtil::stripSlashes($cur_subdir)
        );
    }

References ILIAS\Repository\refinery(), and ilUtil\stripSlashes().

Here is the call graph for this function:

setAllowDirectories()

ilFileSystemGUI::setAllowDirectories

(

bool

$a_val

)

Definition at line 145 of file class.ilFileSystemGUI.php.

                                                    : void
    {
        $this->allow_directories = $a_val;
    }

Referenced by __construct().

Here is the caller graph for this function:

setAllowDirectoryCreation()

ilFileSystemGUI::setAllowDirectoryCreation

(

bool

$a_val

)

Definition at line 426 of file class.ilFileSystemGUI.php.

                                                          : void
    {
        $this->directory_creation = $a_val;
    }

Referenced by __construct().

Here is the caller graph for this function:

setAllowedSuffixes()

ilFileSystemGUI::setAllowedSuffixes

(

array

$a_suffixes

)

Parameters

string[]

$a_suffixes

Definition at line 101 of file class.ilFileSystemGUI.php.

                                                         : void
    {
        $this->allowed_suffixes = $a_suffixes;
    }

setAllowFileCreation()

ilFileSystemGUI::setAllowFileCreation

(

bool

$a_val

)

Set allowed file creation.

Definition at line 439 of file class.ilFileSystemGUI.php.

                                                     : void
    {
        $this->file_creation = $a_val;
    }

Referenced by __construct().

Here is the caller graph for this function:

setForbiddenSuffixes()

ilFileSystemGUI::setForbiddenSuffixes

(

array

$a_suffixes

)

Parameters

string[]

$a_suffixes

Definition at line 117 of file class.ilFileSystemGUI.php.

                                                           : void
    {
        $this->forbidden_suffixes = $a_suffixes;
    }

setPerformedCommand()

ilFileSystemGUI::setPerformedCommand (   $command, array  $pars = []  )

protected

Parameters

array | string	$command
array	$pars

Returns

void

Definition at line 200 of file class.ilFileSystemGUI.php.

                                                                      : void
    {
        if (!is_array($pars)) {
            $pars = [];
        }
        ilSession::set(self::SESSION_LAST_COMMAND, array_merge(
            ["cmd" => $command],
            $pars
        ));
    }

References ilSession\set().

Here is the call graph for this function:

setPostDirPath()

ilFileSystemGUI::setPostDirPath

(

bool

$a_val

)

Definition at line 155 of file class.ilFileSystemGUI.php.

                                               : void
    {
        $this->post_dir_path = $a_val;
    }

setTableId()

ilFileSystemGUI::setTableId

(

string

$a_val

)

Definition at line 165 of file class.ilFileSystemGUI.php.

                                             : void
    {
        $this->table_id = $a_val;
    }

setTitle()

ilFileSystemGUI::setTitle

(

string

$a_val

)

Definition at line 175 of file class.ilFileSystemGUI.php.

                                           : void
    {
        $this->title = $a_val;
    }

setUseUploadDirectory()

ilFileSystemGUI::setUseUploadDirectory

(

bool

$a_val

)

Definition at line 185 of file class.ilFileSystemGUI.php.

                                                      : void
    {
        $this->use_upload_directory = $a_val;
    }

unzipFile()

ilFileSystemGUI::unzipFile

(

?string

$a_file = null

)

Definition at line 838 of file class.ilFileSystemGUI.php.

                                                     : void
    {
        // #17470 - direct unzip call (after upload)
        $upname = $this->wrapper->query()->has(self::PARAM_UPFILE)
            ? $this->wrapper->query()->retrieve(self::PARAM_UPFILE, $this->refinery->to()->string())
            : null;
        if (is_null($a_file) && $upname !== null) {
            $a_file = basename((string) $upname);
        }
 
        $cur_subdir = $this->sanitizeCurrentDirectory();
        $cur_dir = (empty($cur_subdir))
            ? $this->main_absolute_dir
            : $this->main_absolute_dir . "/" . $cur_subdir;
        $a_file = $this->main_absolute_dir . "/" . $a_file;
 
        if (is_file($a_file)) {
            $cur_files = array_keys(ilFileUtils::getDir($cur_dir));
            $cur_files_r = iterator_to_array(new RecursiveIteratorIterator(new RecursiveDirectoryIterator($cur_dir)));
 
            $this->unzip->unzip(
                $a_file,
                null,
                true,
                !$this->getAllowDirectories(),
                false
            );
 
            $new_files = array_keys(ilFileUtils::getDir($cur_dir));
            $new_files_r = iterator_to_array(new RecursiveIteratorIterator(new RecursiveDirectoryIterator($cur_dir)));
 
            $diff = array_diff($new_files, $cur_files);
            $diff_r = array_diff($new_files_r, $cur_files_r);
 
            // unlink forbidden file types
            foreach (array_keys($diff_r) as $f) {
                $pi = pathinfo($f);
                if (!is_dir($f) && !$this->isValidSuffix(strtolower($pi["extension"] ?? ''))) {
                    $this->tpl->setOnScreenMessage('failure', $this->lng->txt("file_some_invalid_file_types_removed") . " (" . $pi["extension"] . ")", true);
                    unlink($f);
                }
            }
 
            if ($diff !== []) {
                if ($this->getAllowDirectories()) {
                    $new_files = [];
 
                    foreach ($diff as $new_item) {
                        if (is_dir($cur_dir . "/" . $new_item)) {
                            ilFileUtils::recursive_dirscan($cur_dir . "/" . $new_item, $new_files);
                        }
                    }
 
                    if (isset($new_files["path"])) {
                        foreach ($new_files["path"] as $idx => $path) {
                            $path = substr((string) $path, strlen($this->main_absolute_dir) + 1);
                            $diff[] = $path . $new_files[self::POST_PARAM_FILE][$idx];
                        }
                    }
                }
 
                $this->setPerformedCommand(
                    "unzip_file",
                    ["added" => $diff
                    ]
                );
            }
        }
 
        ilFileUtils::renameExecutables($this->main_absolute_dir);
 
        $this->ctrl->saveParameter($this, self::PARAMETER_CDIR);
        $this->tpl->setOnScreenMessage('success', $this->lng->txt("cont_file_unzipped"), true);
        $this->ctrl->redirect($this, "listFiles");
    }

References Vendor\Package\$f, $path, ILIAS\Repository\ctrl(), ilFileUtils\getDir(), ILIAS\Repository\lng(), ilFileUtils\recursive_dirscan(), ILIAS\Repository\refinery(), and ilFileUtils\renameExecutables().

Here is the call graph for this function:

uploadFile()

ilFileSystemGUI::uploadFile

(

)

Definition at line 659 of file class.ilFileSystemGUI.php.

                                : void
    {
        global $DIC;
        $lng = $DIC['lng'];
 
        // determine directory
        $cur_subdir = $this->sanitizeCurrentDirectory();
        $cur_dir = (empty($cur_subdir))
            ? $this->main_absolute_dir
            : $this->main_absolute_dir . "/" . $cur_subdir;
 
        $tgt_file = null;
 
        $pi = pathinfo((string) $_FILES["new_file"]["name"]);
        $suffix = $pi["extension"] ?? "";
        if (!$this->isValidSuffix($suffix)) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt("file_no_valid_file_type") . " ($suffix)", true);
            $this->ctrl->redirect($this, "listFiles");
        }
 
        $uploaded_file = $this->wrapper->post()->has(self::POST_PARAM_UPLOADED_FILE)
            ? $this->wrapper->post()->retrieve(self::POST_PARAM_UPLOADED_FILE, $this->refinery->to()->string())
            : '';
        if (is_file($_FILES["new_file"]["tmp_name"])) {
            $name = $this->secure(ilUtil::stripSlashes($_FILES["new_file"]["name"]));
            $tgt_file = $cur_dir . "/" . $name;
 
            // use filesystem directly
            //ilFileUtils::moveUploadedFile(, $name, $tgt_file);
            $upload = $DIC->upload();
 
            // If the upload has not yet been processed make sure he gets processed now.
            if (!$upload->hasBeenProcessed()) {
                $upload->process();
            }
 
 
            if (!$upload->hasUploads()) {
                throw new ilException(
                    $DIC->language()->txt("upload_error_file_not_found")
                );
            }
            $upload_result = $upload->getResults()[$_FILES["new_file"]["tmp_name"]];
            if ($upload_result instanceof UploadResult) {
                $processing_status = $upload_result->getStatus();
                if ($processing_status->getCode() === ProcessingStatus::REJECTED) {
                    $this->tpl->setOnScreenMessage(
                        'failure',
                        $processing_status->getMessage(),
                        true
                    );
                    $this->ctrl->redirect($this, "listFiles");
                }
            }
 
            $upload->moveOneFileTo(
                $upload_result,
                LegacyPathHelper::createRelativePath($cur_dir . "/"),
                LegacyPathHelper::deriveLocationFrom($cur_dir),
                $name,
                true
            );
            // end upload
        } elseif ($uploaded_file) {
            // check if the file is in the ftp directory and readable
            if (ilUploadFiles::_checkUploadFile($uploaded_file)) {
                $tgt_file = $cur_dir . "/" . ilUtil::stripSlashes($uploaded_file);
 
                // copy uploaded file to data directory
                ilUploadFiles::_copyUploadFile($uploaded_file, $tgt_file);
            }
        } elseif (trim((string) $_FILES["new_file"]["name"]) === "") {
            $this->tpl->setOnScreenMessage('failure', $lng->txt("cont_enter_a_file"), true);
        }
 
        if ($tgt_file && is_file($tgt_file)) {
            $unzip = null;
            if (MimeType::getMimeType($tgt_file) === "application/zip") {
                $this->ctrl->setParameter($this, self::PARAM_UPFILE, basename($tgt_file));
                $url = $this->ctrl->getLinkTarget($this, self::CMD_UNZIP_FILE);
                $this->ctrl->setParameter($this, self::PARAM_UPFILE, "");
 
                $unzip_link = $this->ui_factory->link()->standard(
                    $this->lng->txt("unzip"),
                    $url
                );
 
                $unzip = " " . $this->ui_renderer->render($unzip_link);
            }
 
            $this->tpl->setOnScreenMessage('success', $lng->txt("cont_file_created") . $unzip, true);
 
            $this->setPerformedCommand(
                "create_file",
                ["name" => substr($tgt_file, strlen($this->main_absolute_dir) + 1)]
            );
        }
 
        $this->ctrl->saveParameter($this, self::PARAMETER_CDIR);
 
        ilFileUtils::renameExecutables($this->main_absolute_dir);
 
        $this->ctrl->redirect($this, 'listFiles');
    }

References $DIC, $lng, $url, ilUploadFiles\_checkUploadFile(), ilUploadFiles\_copyUploadFile(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ilFileUtils\renameExecutables(), and ilUtil\stripSlashes().

Here is the call graph for this function:

Field Documentation

$allow_directories

bool ilFileSystemGUI::$allow_directories = true

protected

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

Referenced by getAllowDirectories().

$allowed_suffixes

array ilFileSystemGUI::$allowed_suffixes = []

protected

Definition at line 54 of file class.ilFileSystemGUI.php.

Referenced by getAllowedSuffixes().

$commands

array ilFileSystemGUI::$commands = []

protected

Definition at line 65 of file class.ilFileSystemGUI.php.

$ctrl

ilCtrlInterface ilFileSystemGUI::$ctrl

protected

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

$directory_creation

bool ilFileSystemGUI::$directory_creation = false

protected

Definition at line 67 of file class.ilFileSystemGUI.php.

$file_creation

bool ilFileSystemGUI::$file_creation = false

protected

Definition at line 68 of file class.ilFileSystemGUI.php.

$file_labels

array ilFileSystemGUI::$file_labels = []

protected

Definition at line 60 of file class.ilFileSystemGUI.php.

$forbidden_suffixes

array ilFileSystemGUI::$forbidden_suffixes = []

protected

Definition at line 55 of file class.ilFileSystemGUI.php.

Referenced by getForbiddenSuffixes().

$label_enable

bool ilFileSystemGUI::$label_enable = false

protected

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

$label_header

string ilFileSystemGUI::$label_header = ''

protected

Definition at line 66 of file class.ilFileSystemGUI.php.

$lng

ilLanguage ilFileSystemGUI::$lng

protected

Definition at line 56 of file class.ilFileSystemGUI.php.

$main_absolute_dir

string ilFileSystemGUI::$main_absolute_dir

protected

Definition at line 57 of file class.ilFileSystemGUI.php.

$post_dir_path

bool ilFileSystemGUI::$post_dir_path = false

protected

Definition at line 58 of file class.ilFileSystemGUI.php.

Referenced by getPostDirPath().

$refinery

ILIAS Refinery Factory ilFileSystemGUI::$refinery

protected

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

$table_id

string ilFileSystemGUI::$table_id = ''

protected

Definition at line 63 of file class.ilFileSystemGUI.php.

Referenced by getTableId().

$title

string ilFileSystemGUI::$title = ''

protected

Definition at line 64 of file class.ilFileSystemGUI.php.

Referenced by getTitle().

$tpl

ilGlobalTemplateInterface ilFileSystemGUI::$tpl

protected

Definition at line 59 of file class.ilFileSystemGUI.php.

$ui_factory

Factory ilFileSystemGUI::$ui_factory

private

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

$ui_renderer

Renderer ilFileSystemGUI::$ui_renderer

private

Definition at line 50 of file class.ilFileSystemGUI.php.

$unzip

LegacyArchives ilFileSystemGUI::$unzip

protected

Definition at line 51 of file class.ilFileSystemGUI.php.

$use_upload_directory

bool ilFileSystemGUI::$use_upload_directory = false

protected

Definition at line 53 of file class.ilFileSystemGUI.php.

Referenced by getUseUploadDirectory().

$wrapper

WrapperFactory ilFileSystemGUI::$wrapper

protected

Definition at line 69 of file class.ilFileSystemGUI.php.

CMD_UNZIP_FILE

const ilFileSystemGUI::CMD_UNZIP_FILE = "unzipFile"

Definition at line 48 of file class.ilFileSystemGUI.php.

Referenced by ilFileSystemTableGUI\fillRow().

PARAM_OLD_NAME

const ilFileSystemGUI::PARAM_OLD_NAME = "old_name"

Definition at line 43 of file class.ilFileSystemGUI.php.

PARAM_RESETOFFSET

const ilFileSystemGUI::PARAM_RESETOFFSET = "resetoffset"

Definition at line 42 of file class.ilFileSystemGUI.php.

PARAM_UPFILE

const ilFileSystemGUI::PARAM_UPFILE = "upfile"

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

PARAMETER_CDIR

const ilFileSystemGUI::PARAMETER_CDIR = "cdir"

Definition at line 37 of file class.ilFileSystemGUI.php.

PARAMETER_FHSH

const ilFileSystemGUI::PARAMETER_FHSH = "fhsh"

Definition at line 40 of file class.ilFileSystemGUI.php.

PARAMETER_NEWDIR

const ilFileSystemGUI::PARAMETER_NEWDIR = "newdir"

Definition at line 39 of file class.ilFileSystemGUI.php.

POST_PARAM_FILE

const ilFileSystemGUI::POST_PARAM_FILE = "file"

Definition at line 41 of file class.ilFileSystemGUI.php.

POST_PARAM_NEW_DIR

const ilFileSystemGUI::POST_PARAM_NEW_DIR = "new_dir"

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

POST_PARAM_NEW_NAME

const ilFileSystemGUI::POST_PARAM_NEW_NAME = "new_name"

Definition at line 45 of file class.ilFileSystemGUI.php.

POST_PARAM_UPLOADED_FILE

const ilFileSystemGUI::POST_PARAM_UPLOADED_FILE = "uploaded_file"

Definition at line 47 of file class.ilFileSystemGUI.php.

SESSION_LAST_COMMAND

const ilFileSystemGUI::SESSION_LAST_COMMAND = "fsys_lastcomm"

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

---

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

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