File System Explorer GUI class. More...

Inheritance diagram for ilFileSystemGUI:

Collaboration diagram for ilFileSystemGUI:

Public Member Functions
	__construct ($a_main_directory)

	setAllowedSuffixes ($a_suffixes)
	Set allowed Suffixes. More...

	getAllowedSuffixes ()
	Get allowed Suffixes. More...

	setForbiddenSuffixes ($a_suffixes)
	Set forbidden Suffixes. More...

	getForbiddenSuffixes ()
	Get Accepted Suffixes. More...

	isValidSuffix ($a_suffix)
	Is suffix valid? More...

	setAllowDirectories ($a_val)
	Set allow directories. More...

	getAllowDirectories ()
	Get allow directories. More...

	setPostDirPath ($a_val)
	Set post dir path. More...

	getPostDirPath ()
	Get post dir path. More...

	setTableId ($a_val)
	Set table id. More...

	getTableId ()
	Get table id. More...

	setTitle ($a_val)
	Set title. More...

	getTitle ()
	Get title. More...

	setUseUploadDirectory ($a_val)
	Set use upload directory. More...

	getUseUploadDirectory ()
	Get use upload directory. More...

	getLastPerformedCommand ()
	Get performed command. More...

	executeCommand ()
	execute command More...

	addCommand (&$a_obj, $a_func, $a_name, $a_single=true, $a_allow_dir=false)
	Add command. More...

	clearCommands ()
	Clear commands. More...

	labelFile ($a_file, $a_label)
	label a file More...

	activateLabels ($a_act, $a_label_header)
	activate file labels More...

	extCommand ($a_nr)
	call external command More...

	setAllowDirectoryCreation ($a_val)
	Set allowed directory creation. More...

	getAllowDirectoryCreation ()
	Get allowed directory creation. More...

	setAllowFileCreation ($a_val)
	Set allowed file creation. More...

	getAllowFileCreation ()
	Get allowed file creation. More...

	listFiles ($a_table_gui=null)
	List files. More...

	getTable ($a_dir, $a_subdir)
	Get table. More...

	renameFileForm ($a_file)
	list files More...

	renameFile ()
	rename a file More...

	cancelRename ()
	cancel renaming a file More...

	createDirectory ()
	create directory More...

	uploadFile ()
	Upload file. More...

	confirmDeleteFile (array $a_files)
	Confirm file deletion. More...

	deleteFile ()
	delete object file More...

	unzipFile ($a_file=null)
	delete object file More...

	downloadFile ($a_file)
	delete object file More...

	getTabs (&$tabs_gui)
	get tabs More...

	getActionCommands ()

	defineCommands ()
	Define commands available. More...

Data Fields
	$ctrl

const	CDIR = "cdir"

Protected Member Functions
	setPerformedCommand ($command, $pars="")
	Set performed command. More...

	parseCurrentDirectory ()

	getFileList ($a_dir, $a_subdir=null)

	getIncomingFiles ()

Protected Attributes
	$use_upload_directory = false

	$allowed_suffixes = array()

	$forbidden_suffixes = array()

Private Member Functions
	sanitizeCurrentDirectory ()

Detailed Description

File System Explorer GUI class.

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilFileSystemGUI::__construct ( $a_main_directory )

Reimplemented in ilExAssignmentFileSystemGUI.

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

    {
        global $DIC;
        $lng = $DIC['lng'];
        $ilCtrl = $DIC['ilCtrl'];
        $tpl = $DIC['tpl'];
        $ilias = $DIC['ilias'];
 
        $this->ctrl = $ilCtrl;
        $this->lng = $lng;
        $this->ilias = $ilias;
        $this->tpl = $tpl;
        $this->main_dir = $a_main_directory;
        $this->post_dir_path = false;
 
        $this->defineCommands();
 
        $this->file_labels = array();
        $this->label_enable = false;
        $this->ctrl->saveParameter($this, self::CDIR);
        $lng->loadLanguageModule("content");
        $this->setAllowDirectories(true);
        $this->setAllowDirectoryCreation(true);
        $this->setAllowFileCreation(true);
        //echo "<br>main_dir:".$this->main_dir.":";
    }

References $DIC, $lng, $tpl, defineCommands(), setAllowDirectories(), setAllowDirectoryCreation(), and setAllowFileCreation().

Here is the call graph for this function:

Member Function Documentation

◆ activateLabels()

ilFileSystemGUI::activateLabels	(	$a_act,
		$a_label_header
	)

activate file labels

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

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

◆ addCommand()

ilFileSystemGUI::addCommand	(	&	$a_obj,
			$a_func,
			$a_name,
			$a_single = `true`,
			$a_allow_dir = `false`
	)

Add command.

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

      {
        $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;
 
        //$this->commands[] = $arr;
    }

References $i.

◆ cancelRename()

ilFileSystemGUI::cancelRename ( )

cancel renaming a file

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

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

◆ clearCommands()

ilFileSystemGUI::clearCommands ( )

Clear commands.

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

    {
        $this->commands = array();
    }

◆ confirmDeleteFile()

ilFileSystemGUI::confirmDeleteFile ( array $a_files )

Confirm file deletion.

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

    {
        global $DIC;
        $ilCtrl = $DIC['ilCtrl'];
        $tpl = $DIC['tpl'];
        $lng = $DIC['lng'];
 
        include_once("./Services/Utilities/classes/class.ilConfirmationGUI.php");
        $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, $i, $lng, and $tpl.

◆ createDirectory()

ilFileSystemGUI::createDirectory ( )

create directory

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

    {
        global $DIC;
        $lng = $DIC['lng'];
        
        // determine directory
        $cur_subdir = $this->sanitizeCurrentDirectory();
        $cur_dir = (!empty($cur_subdir))
            ? $this->main_dir . "/" . $cur_subdir
            : $this->main_dir;
 
        $new_dir = str_replace(".", "", ilUtil::stripSlashes($_POST["new_dir"]));
        $new_dir = str_replace("/", "", $new_dir);
 
        if (!empty($new_dir)) {
            ilUtil::makeDir($cur_dir . "/" . $new_dir);
            if (is_dir($cur_dir . "/" . $new_dir)) {
                ilUtil::sendSuccess($lng->txt("cont_dir_created"), true);
                $this->setPerformedCommand("create_dir", array("name" => $new_dir));
            }
        } else {
            ilUtil::sendFailure($lng->txt("cont_enter_a_dir_name"), true);
        }
        $this->ctrl->saveParameter($this, self::CDIR);
        $this->ctrl->redirect($this, 'listFiles');
    }

References $_POST, $DIC, $lng, ilUtil\makeDir(), sanitizeCurrentDirectory(), ilUtil\sendFailure(), setPerformedCommand(), and ilUtil\stripSlashes().

Here is the call graph for this function:

◆ defineCommands()

ilFileSystemGUI::defineCommands ( )

Define commands available.

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

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

Referenced by __construct().

Here is the caller graph for this function:

◆ deleteFile()

ilFileSystemGUI::deleteFile ( )

delete object file

Reimplemented in ilExAssignmentFileSystemGUI.

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

    {
        global $DIC;
        $lng = $DIC['lng'];
 
        if (!isset($_POST["file"])) {
            $this->ilias->raiseError($this->lng->txt("no_checkbox"), $this->ilias->error_obj->MESSAGE);
        }
        
        foreach ($_POST["file"] as $post_file) {
            if (ilUtil::stripSlashes($post_file) == "..") {
                $this->ilias->raiseError($this->lng->txt("no_checkbox"), $this->ilias->error_obj->MESSAGE);
                break;
            }
 
            $cur_subdir = $this->sanitizeCurrentDirectory();
            $cur_dir = (!empty($cur_subdir))
                ? $this->main_dir . "/" . $cur_subdir
                : $this->main_dir;
            $pi = pathinfo($post_file);
            $file = $cur_dir . "/" . ilUtil::stripSlashes($pi["basename"]);
 
            if (@is_file($file)) {
                unlink($file);
            }
 
            if (@is_dir($file)) {
                $is_dir = true;
                ilUtil::delDir($file);
            }
        }
 
        $this->ctrl->saveParameter($this, self::CDIR);
        if ($is_dir) {
            ilUtil::sendSuccess($lng->txt("cont_dir_deleted"), true);
            $this->setPerformedCommand(
                "delete_dir",
                array("name" => ilUtil::stripSlashes($post_file))
            );
        } else {
            ilUtil::sendSuccess($lng->txt("cont_file_deleted"), true);
            $this->setPerformedCommand(
                "delete_file",
                array("name" => ilUtil::stripSlashes($post_file))
            );
        }
        $this->ctrl->redirect($this, 'listFiles');
    }

References $_POST, $DIC, $lng, ilUtil\delDir(), sanitizeCurrentDirectory(), setPerformedCommand(), and ilUtil\stripSlashes().

Here is the call graph for this function:

◆ downloadFile()

ilFileSystemGUI::downloadFile ( $a_file )

delete object file

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

    {
        $file = $this->main_dir . "/" . $a_file;
    
        if (@is_file($file) && !(@is_dir($file))) {
            ilUtil::deliverFile($file, basename($a_file));
            exit;
        } else {
            $this->ctrl->saveParameter($this, self::CDIR);
            $this->ctrl->redirect($this, "listFiles");
        }
    }

References ilUtil\deliverFile(), and exit.

Here is the call graph for this function:

◆ executeCommand()

ilFileSystemGUI::executeCommand ( )

execute command

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

    {
        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd("listFiles");
 
        switch ($next_class) {
 
            default:
                if (substr($cmd, 0, 11) == "extCommand_") {
                    $ret = $this->extCommand(substr($cmd, 11, strlen($cmd) - 11));
                } else {
                    $ret = $this->$cmd();
                }
                break;
        }
 
        return $ret;
    }

References $ret, and extCommand().

Here is the call graph for this function:

◆ extCommand()

ilFileSystemGUI::extCommand ( $a_nr )

call external command

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

    {
        $selected = $this->getIncomingFiles();
 
        if (!count($selected)) {
            ilUtil::sendFailure($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"]) {
            ilUtil::sendFailure($this->lng->txt("cont_select_max_one_item"), true);
            $this->ctrl->redirect($this, "listFiles");
        }
 
        $cur_subdir = $this->sanitizeCurrentDirectory();
 
        // collect files and
        $files = array();
        foreach ($selected as $file) {
            $file = ilUtil::stripSlashes($file);
            $file = (!empty($cur_subdir))
                ? $cur_subdir . "/" . $file
                : $file;
            
            // check wether selected item is a directory
            if (@is_dir($this->main_dir . "/" . $file) &&
                !$this->commands[$a_nr]["allow_dir"]) {
                ilUtil::sendFailure($this->lng->txt("select_a_file"), true);
                $this->ctrl->redirect($this, "listFiles");
            }
                        
            $files[] = $file;
        }
        
        if ($this->commands[$a_nr]["single"]) {
            $files = array_shift($files);
        }
 
        $obj = $this->commands[$a_nr]["object"];
        $method = $this->commands[$a_nr]["method"];
 
        return $obj->$method($files);
    }

References getIncomingFiles(), sanitizeCurrentDirectory(), ilUtil\sendFailure(), 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: array of commands

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

    {
        return $this->commands;
    }

◆ getAllowDirectories()

ilFileSystemGUI::getAllowDirectories ( )

Get allow directories.

Returns: boolean allow directories

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

    {
        return $this->allow_directories;
    }

Referenced by listFiles(), and unzipFile().

Here is the caller graph for this function:

◆ getAllowDirectoryCreation()

ilFileSystemGUI::getAllowDirectoryCreation ( )

Get allowed directory creation.

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

    {
        return $this->directory_creation;
    }

Referenced by listFiles().

Here is the caller graph for this function:

◆ getAllowedSuffixes()

ilFileSystemGUI::getAllowedSuffixes ( )

Get allowed Suffixes.

Returns: array allowed Suffixes

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

    {
        return $this->allowed_suffixes;
    }

References $allowed_suffixes.

Referenced by isValidSuffix().

Here is the caller graph for this function:

◆ getAllowFileCreation()

ilFileSystemGUI::getAllowFileCreation ( )

Get allowed file creation.

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

    {
        return $this->file_creation;
    }

Referenced by listFiles().

Here is the caller graph for this function:

◆ getFileList()

ilFileSystemGUI::getFileList	(	$a_dir,
		$a_subdir = `null`
	)

protected

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

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

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

Referenced by getIncomingFiles().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getForbiddenSuffixes()

ilFileSystemGUI::getForbiddenSuffixes ( )

Get Accepted Suffixes.

Returns: array forbidden Suffixes

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

    {
        return $this->forbidden_suffixes;
    }

References $forbidden_suffixes.

Referenced by isValidSuffix().

Here is the caller graph for this function:

◆ getIncomingFiles()

ilFileSystemGUI::getIncomingFiles ( )

protected

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

    {
        $sel_files = $hashes = array();
        if (isset($_POST["file"])) {
            $hashes = $_POST["file"];
        } elseif (isset($_GET["fhsh"])) {
            $hashes = array($_GET["fhsh"]);
        }
        
        if (sizeof($hashes)) {
            $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["file"]
                            : $file["entry"];
                        break;
                    }
                }
            }
        }
        
        return $sel_files;
    }

References $_GET, $_POST, getFileList(), getPostDirPath(), and parseCurrentDirectory().

Referenced by extCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLastPerformedCommand()

ilFileSystemGUI::getLastPerformedCommand ( )

Get performed command.

Returns: array command array

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

    {
        $ret = $_SESSION["fsys"]["lastcomm"];
        $_SESSION["fsys"]["lastcomm"] = "none";
        return $ret;
    }

References $_SESSION, and $ret.

◆ getPostDirPath()

ilFileSystemGUI::getPostDirPath ( )

Get post dir path.

Returns: boolean post dir path

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

    {
        return $this->post_dir_path;
    }

Referenced by getIncomingFiles(), ilExAssignmentFileSystemGUI\getTable(), and getTable().

Here is the caller graph for this function:

◆ getTable()

ilFileSystemGUI::getTable	(	$a_dir,
		$a_subdir
	)

Get table.

Parameters

return

Reimplemented in ilExAssignmentFileSystemGUI.

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

    {
        include_once("./Services/FileSystem/classes/class.ilFileSystemTableGUI.php");
        return new ilFileSystemTableGUI(
            $this,
            "listFiles",
            $a_dir,
            $a_subdir,
            $this->label_enable,
            $this->file_labels,
            $this->label_header,
            $this->commands,
            $this->getPostDirPath(),
            $this->getTableId()
        );
    }

References getPostDirPath(), and getTableId().

Referenced by listFiles().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTableId()

ilFileSystemGUI::getTableId ( )

Get table id.

Returns: string table id

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

    {
        return $this->table_id;
    }

Referenced by ilExAssignmentFileSystemGUI\getTable(), and getTable().

Here is the caller graph for this function:

◆ getTabs()

ilFileSystemGUI::getTabs ( & $tabs_gui )

get tabs

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

    {
        global $DIC;
        $ilCtrl = $DIC['ilCtrl'];
        
        $ilCtrl->setParameter($this, "resetoffset", 1);
        $tabs_gui->addTarget(
            "cont_list_files",
            $this->ctrl->getLinkTarget($this, "listFiles"),
            "listFiles",
            get_class($this)
        );
        $ilCtrl->setParameter($this, "resetoffset", "");
    }

References $DIC.

◆ getTitle()

ilFileSystemGUI::getTitle ( )

Get title.

Returns: string title

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

    {
        return $this->title;
    }

Referenced by listFiles().

Here is the caller graph for this function:

◆ getUseUploadDirectory()

ilFileSystemGUI::getUseUploadDirectory ( )

Get use upload directory.

Returns: bool use upload directory

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

    {
        return $this->use_upload_directory;
    }

References $use_upload_directory.

Referenced by listFiles().

Here is the caller graph for this function:

◆ isValidSuffix()

ilFileSystemGUI::isValidSuffix ( $a_suffix )

Is suffix valid?

Parameters

string $a_suffix

Returns: bool

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

    {
        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;
        }
        if (!is_array($this->getAllowedSuffixes()) || count($this->getAllowedSuffixes()) == 0) {
            return true;
        }
        return false;
    }

References getAllowedSuffixes(), and getForbiddenSuffixes().

Referenced by renameFile(), unzipFile(), and uploadFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ labelFile()

ilFileSystemGUI::labelFile	(	$a_file,
		$a_label
	)

label a file

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

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

◆ listFiles()

ilFileSystemGUI::listFiles ( $a_table_gui = null )

List files.

Parameters

array $a_class_table_gui if we are here from a child class

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

    {
        global $DIC;
        $ilToolbar = $DIC['ilToolbar'];
        $lng = $DIC['lng'];
        $ilCtrl = $DIC['ilCtrl'];
        
        $dir = $this->parseCurrentDirectory();
        
        $this->ctrl->setParameter($this, self::CDIR, $dir["subdir"]);
        
        // toolbar for adding files/directories
        $ilToolbar->setFormAction($ilCtrl->getFormAction($this), true);
        include_once("./Services/Form/classes/class.ilTextInputGUI.php");
        
        if ($this->getAllowDirectories() && $this->getAllowDirectoryCreation()) {
            $ti = new ilTextInputGUI($this->lng->txt("cont_new_dir"), "new_dir");
            $ti->setMaxLength(80);
            $ti->setSize(10);
            $ilToolbar->addInputItem($ti, true);
            $ilToolbar->addFormButton($lng->txt("create"), "createDirectory");
            
            $ilToolbar->addSeparator();
        }
        
        include_once("./Services/Form/classes/class.ilFileInputGUI.php");
        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");
        }
        
        include_once 'Services/FileSystem/classes/class.ilUploadFiles.php';
        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;
            }
            include_once("./Services/Form/classes/class.ilSelectInputGUI.php");
            $si = new ilSelectInputGUI($this->lng->txt("cont_uploaded_file"), "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 ($_GET["resetoffset"] == 1) {
            $fs_table->resetOffset();
        }
        $this->tpl->setContent($fs_table->getHTML());
    }

References $_GET, $DIC, $lng, $si, ilUploadFiles\_getUploadDirectory(), ilUploadFiles\_getUploadFiles(), getAllowDirectories(), getAllowDirectoryCreation(), getAllowFileCreation(), getTable(), getTitle(), getUseUploadDirectory(), and parseCurrentDirectory().

Here is the call graph for this function:

◆ parseCurrentDirectory()

ilFileSystemGUI::parseCurrentDirectory ( )

protected

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

    {
        // 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 = ilUtil::stripSlashes(ilUtil::stripSlashes($_GET[self::CDIR]));
        $new_subdir = ilUtil::stripSlashes(ilUtil::stripSlashes($_GET["newdir"]));
 
        if ($new_subdir == "..") {
            $cur_subdir = substr($cur_subdir, 0, strrpos($cur_subdir, "/"));
        } else {
            if (!empty($new_subdir)) {
                if (!empty($cur_subdir)) {
                    $cur_subdir = $cur_subdir . "/" . $new_subdir;
                } else {
                    $cur_subdir = $new_subdir;
                }
            }
        }
 
        $cur_subdir = str_replace("..", "", $cur_subdir);
        $cur_dir = (!empty($cur_subdir))
            ? $this->main_dir . "/" . $cur_subdir
            : $this->main_dir;
        
        return array("dir" => $cur_dir, "subdir" => $cur_subdir);
    }

References $_GET, and ilUtil\stripSlashes().

Referenced by getIncomingFiles(), and listFiles().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renameFile()

ilFileSystemGUI::renameFile ( )

rename a file

Reimplemented in ilExAssignmentFileSystemGUI.

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

    {
        global $DIC;
        $lng = $DIC['lng'];
        
        $new_name = str_replace("..", "", ilUtil::stripSlashes($_POST["new_name"]));
        $new_name = str_replace("/", "", $new_name);
        if ($new_name == "") {
            $this->ilias->raiseError($this->lng->txt("enter_new_name"), $this->ilias->error_obj->MESSAGE);
        }
 
        $pi = pathinfo($new_name);
        $suffix = $pi["extension"];
        if ($suffix != "" && !$this->isValidSuffix($suffix)) {
            ilUtil::sendFailure($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_dir . "/" . $cur_subdir . "/"
            : $this->main_dir . "/";
 
        // check if this path is inside $dir
        $old_name = ilUtil::stripSlashes($_GET["old_name"]);
        $realpath = realpath($dir . $old_name);
        if (strpos($realpath, realpath($dir)) !== 0) {
            $this->ilias->raiseError($this->lng->txt("no_permission"), $this->ilias->error_obj->MESSAGE);
        }
 
        if (is_dir($dir . $old_name)) {
            rename($dir . $old_name, $dir . $new_name);
        } else {
            include_once("./Services/Utilities/classes/class.ilFileUtils.php");
 
            try {
                ilFileUtils::rename($dir . $old_name, $dir . $new_name);
            } catch (ilException $e) {
                ilUtil::sendFailure($e->getMessage(), true);
                $this->ctrl->redirect($this, "listFiles");
            }
        }
 
        ilUtil::renameExecutables($this->main_dir);
        if (@is_dir($dir . $new_name)) {
            ilUtil::sendSuccess($lng->txt("cont_dir_renamed"), true);
            $this->setPerformedCommand("rename_dir", array("old_name" => $_GET["old_name"],
                "new_name" => $new_name));
        } else {
            ilUtil::sendSuccess($lng->txt("cont_file_renamed"), true);
            $this->setPerformedCommand("rename_file", array("old_name" => $_GET["old_name"],
                "new_name" => $new_name));
        }
        $this->ctrl->redirect($this, "listFiles");
    }

References $_GET, $_POST, $DIC, Vendor\Package\$e, $lng, isValidSuffix(), ilFileUtils\rename(), ilUtil\renameExecutables(), sanitizeCurrentDirectory(), ilUtil\sendFailure(), setPerformedCommand(), and ilUtil\stripSlashes().

Here is the call graph for this function:

◆ renameFileForm()

ilFileSystemGUI::renameFileForm ( $a_file )

list files

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

    {
        global $DIC;
        $lng = $DIC['lng'];
        $ilCtrl = $DIC['ilCtrl'];
 
        $cur_subdir = $this->sanitizeCurrentDirectory();
        $file = $this->main_dir . "/" . $a_file;
 
        $this->ctrl->setParameter($this, "old_name", basename($a_file));
        $this->ctrl->setParameter($this, self::CDIR, ilUtil::stripSlashes($_GET[self::CDIR]));
            
        include_once("Services/Form/classes/class.ilPropertyFormGUI.php");
        $form = new ilPropertyFormGUI();
        
        // file/dir name
        $ti = new ilTextInputGUI($this->lng->txt("name"), "new_name");
        $ti->setMaxLength(200);
        $ti->setSize(40);
        $ti->setValue(basename($a_file));
        $form->addItem($ti);
        
        // save and cancel commands
        $form->addCommandButton("renameFile", $lng->txt("rename"));
        $form->addCommandButton("cancelRename", $lng->txt("cancel"));
        $form->setFormAction($ilCtrl->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 $_GET, $DIC, $lng, sanitizeCurrentDirectory(), and ilUtil\stripSlashes().

Here is the call graph for this function:

◆ sanitizeCurrentDirectory()

ilFileSystemGUI::sanitizeCurrentDirectory ( )

private

Returns: string

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

    {
        global $DIC;
 
        return  str_replace("..", "", ilUtil::stripSlashes($DIC->http()->request()->getQueryParams()[self::CDIR]));
    }

References $DIC, and ilUtil\stripSlashes().

Referenced by createDirectory(), deleteFile(), extCommand(), renameFile(), renameFileForm(), unzipFile(), and uploadFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setAllowDirectories()

ilFileSystemGUI::setAllowDirectories ( $a_val )

Set allow directories.

Parameters

boolean allow directories

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

    {
        $this->allow_directories = $a_val;
    }

Referenced by __construct().

Here is the caller graph for this function:

◆ setAllowDirectoryCreation()

ilFileSystemGUI::setAllowDirectoryCreation ( $a_val )

Set allowed directory creation.

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

    {
        $this->directory_creation = $a_val;
    }

Referenced by __construct().

Here is the caller graph for this function:

◆ setAllowedSuffixes()

ilFileSystemGUI::setAllowedSuffixes ( $a_suffixes )

Set allowed Suffixes.

Parameters

array $a_suffixes allowed Suffixes

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

    {
        $this->allowed_suffixes = $a_suffixes;
    }

◆ setAllowFileCreation()

ilFileSystemGUI::setAllowFileCreation ( $a_val )

Set allowed file creation.

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

    {
        $this->file_creation = $a_val;
    }

Referenced by __construct().

Here is the caller graph for this function:

◆ setForbiddenSuffixes()

ilFileSystemGUI::setForbiddenSuffixes ( $a_suffixes )

Set forbidden Suffixes.

Parameters

array $a_suffixes forbidden Suffixes

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

    {
        $this->forbidden_suffixes = $a_suffixes;
    }

◆ setPerformedCommand()

ilFileSystemGUI::setPerformedCommand	(	$command,
		$pars = `""`
	)

protected

Set performed command.

Parameters

string	command
array	parameter array

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

    {
        if (!is_array($pars)) {
            $pars = array();
        }
        $_SESSION["fsys"]["lastcomm"] = array_merge(
            array("cmd" => $command),
            $pars
        );
    }

References $_SESSION.

Referenced by createDirectory(), deleteFile(), renameFile(), unzipFile(), and uploadFile().

Here is the caller graph for this function:

◆ setPostDirPath()

ilFileSystemGUI::setPostDirPath ( $a_val )

Set post dir path.

Parameters

boolean post dir path

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

    {
        $this->post_dir_path = $a_val;
    }

◆ setTableId()

ilFileSystemGUI::setTableId ( $a_val )

Set table id.

Parameters

string table id

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

    {
        $this->table_id = $a_val;
    }

◆ setTitle()

ilFileSystemGUI::setTitle ( $a_val )

Set title.

Parameters

string title

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

    {
        $this->title = $a_val;
    }

◆ setUseUploadDirectory()

ilFileSystemGUI::setUseUploadDirectory ( $a_val )

Set use upload directory.

Parameters

bool $a_val use upload directory

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

    {
        $this->use_upload_directory = $a_val;
    }

◆ unzipFile()

ilFileSystemGUI::unzipFile ( $a_file = null )

delete object file

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

    {
        global $DIC;
        $lng = $DIC['lng'];
        
        // #17470 - direct unzip call (after upload)
        if (!$a_file &&
            isset($_GET["upfile"])) {
            $a_file = basename($_GET["upfile"]);
        }
 
        $cur_subdir = $this->sanitizeCurrentDirectory();
        $cur_dir = (!empty($cur_subdir))
            ? $this->main_dir . "/" . $cur_subdir
            : $this->main_dir;
        $a_file = $this->main_dir . "/" . $a_file;
        
        if (@is_file($a_file)) {
            include_once("./Services/Utilities/classes/class.ilFileUtils.php");
            $cur_files = array_keys(ilUtil::getDir($cur_dir));
            $cur_files_r = iterator_to_array(new RecursiveIteratorIterator(new RecursiveDirectoryIterator($cur_dir)));
            
            if ($this->getAllowDirectories()) {
                ilUtil::unzip($a_file, true);
            } else {
                ilUtil::unzip($a_file, true, true);
            }
            
            $new_files = array_keys(ilUtil::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 ($diff_r as $f => $d) {
                $pi = pathinfo($f);
                if (!is_dir($f) && !$this->isValidSuffix(strtolower($pi["extension"]))) {
                    ilUtil::sendFailure($lng->txt("file_some_invalid_file_types_removed") . " (" . $pi["extension"] . ")", true);
                    unlink($f);
                }
            }
 
            if (sizeof($diff)) {
                if ($this->getAllowDirectories()) {
                    include_once("./Services/Utilities/classes/class.ilFileUtils.php");
                    $new_files = array();
                    
                    foreach ($diff as $new_item) {
                        if (is_dir($cur_dir . "/" . $new_item)) {
                            ilFileUtils::recursive_dirscan($cur_dir . "/" . $new_item, $new_files);
                        }
                    }
                    
                    if (is_array($new_files["path"])) {
                        foreach ($new_files["path"] as $idx => $path) {
                            $path = substr($path, strlen($this->main_dir) + 1);
                            $diff[] = $path . $new_files["file"][$idx];
                        }
                    }
                }
                
                $this->setPerformedCommand(
                    "unzip_file",
                    array("name" => substr($file, strlen($this->main_dir) + 1),
                        "added" => $diff)
                );
            }
        }
 
        ilUtil::renameExecutables($this->main_dir);
 
        $this->ctrl->saveParameter($this, self::CDIR);
        ilUtil::sendSuccess($lng->txt("cont_file_unzipped"), true);
        $this->ctrl->redirect($this, "listFiles");
    }

References $_GET, $d, $DIC, Vendor\Package\$f, $lng, getAllowDirectories(), ilUtil\getDir(), isValidSuffix(), ilFileUtils\recursive_dirscan(), ilUtil\renameExecutables(), sanitizeCurrentDirectory(), ilUtil\sendFailure(), setPerformedCommand(), and ilUtil\unzip().

Here is the call graph for this function:

◆ uploadFile()

ilFileSystemGUI::uploadFile ( )

Upload file.

Reimplemented in ilExAssignmentFileSystemGUI.

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

    {
        global $DIC;
        $lng = $DIC['lng'];
        
        // determine directory
        $cur_subdir = $this->sanitizeCurrentDirectory();
        $cur_dir = (!empty($cur_subdir))
            ? $this->main_dir . "/" . $cur_subdir
            : $this->main_dir;
 
        $tgt_file = null;
 
        $pi = pathinfo($_FILES["new_file"]["name"]);
        $suffix = $pi["extension"];
        if (!$this->isValidSuffix($suffix)) {
            ilUtil::sendFailure($this->lng->txt("file_no_valid_file_type") . " ($suffix)", true);
            $this->ctrl->redirect($this, "listFiles");
        }
 
        if (is_file($_FILES["new_file"]["tmp_name"])) {
            $name = $this->secure(ilUtil::stripSlashes($_FILES["new_file"]["name"]));
            $tgt_file = $cur_dir . "/" . $name;
            try {
                ilUtil::moveUploadedFile($_FILES["new_file"]["tmp_name"], $name, $tgt_file);
            } catch (ilException $e) {
                ilUtil::sendFailure($e->getMessage(), true);
                $this->ctrl->redirect($this, "listFiles");
            }
        } elseif ($_POST["uploaded_file"]) {
            include_once 'Services/FileSystem/classes/class.ilUploadFiles.php';
 
            // check if the file is in the ftp directory and readable
            if (ilUploadFiles::_checkUploadFile($_POST["uploaded_file"])) {
                $tgt_file = $cur_dir . "/" . ilUtil::stripSlashes($_POST["uploaded_file"]);
                
                // copy uploaded file to data directory
                ilUploadFiles::_copyUploadFile($_POST["uploaded_file"], $tgt_file);
            }
        } elseif (trim($_FILES["new_file"]["name"]) == "") {
            ilUtil::sendFailure($lng->txt("cont_enter_a_file"), true);
        }
        
        if ($tgt_file && is_file($tgt_file)) {
            $unzip = null;
            
            // extract zip?
            include_once("./Services/Utilities/classes/class.ilMimeTypeUtil.php");
            if (ilMimeTypeUtil::getMimeType($tgt_file) == "application/zip") {
                $this->ctrl->setParameter($this, "upfile", basename($tgt_file));
                $url = $this->ctrl->getLinkTarget($this, "unzipFile");
                $this->ctrl->setParameter($this, "upfile", "");
                
                include_once "Services/UIComponent/Button/classes/class.ilLinkButton.php";
                $unzip = ilLinkButton::getInstance();
                $unzip->setCaption("unzip");
                $unzip->setUrl($url);
                $unzip = " " . $unzip->render();
            }
            
            ilUtil::sendSuccess($lng->txt("cont_file_created") . $unzip, true);
            
            $this->setPerformedCommand(
                "create_file",
                array("name" => substr($tgt_file, strlen($this->main_dir) + 1))
            );
        }
 
        $this->ctrl->saveParameter($this, self::CDIR);
 
        ilUtil::renameExecutables($this->main_dir);
 
        $this->ctrl->redirect($this, 'listFiles');
    }

References $_POST, $DIC, Vendor\Package\$e, $lng, $name, $url, ilUploadFiles\_checkUploadFile(), ilUploadFiles\_copyUploadFile(), ilLinkButton\getInstance(), ilMimeTypeUtil\getMimeType(), isValidSuffix(), ilUtil\moveUploadedFile(), ilUtil\renameExecutables(), sanitizeCurrentDirectory(), ilUtil\sendFailure(), setPerformedCommand(), and ilUtil\stripSlashes().

Here is the call graph for this function:

Field Documentation

◆ $allowed_suffixes

ilFileSystemGUI::$allowed_suffixes = array()

protected

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

Referenced by getAllowedSuffixes().

◆ $ctrl

ilFileSystemGUI::$ctrl

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

Referenced by ilExAssignmentFileSystemGUI\saveFilesOrder().

◆ $forbidden_suffixes

ilFileSystemGUI::$forbidden_suffixes = array()

protected

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

Referenced by getForbiddenSuffixes().

◆ $use_upload_directory

ilFileSystemGUI::$use_upload_directory = false

protected

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

Referenced by getUseUploadDirectory().

◆ CDIR

const ilFileSystemGUI::CDIR = "cdir"

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

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

Services/FileSystem/classes/class.ilFileSystemGUI.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ activateLabels()

◆ addCommand()

◆ cancelRename()

◆ clearCommands()

◆ confirmDeleteFile()

◆ createDirectory()

◆ defineCommands()

◆ deleteFile()

◆ downloadFile()

◆ executeCommand()

◆ extCommand()

◆ getActionCommands()

◆ getAllowDirectories()

◆ getAllowDirectoryCreation()

◆ getAllowedSuffixes()

◆ getAllowFileCreation()

◆ getFileList()

◆ getForbiddenSuffixes()

◆ getIncomingFiles()

◆ getLastPerformedCommand()

◆ getPostDirPath()

◆ getTable()

◆ getTableId()

◆ getTabs()

◆ getTitle()

◆ getUseUploadDirectory()

◆ isValidSuffix()

◆ labelFile()

◆ listFiles()

◆ parseCurrentDirectory()

◆ renameFile()

◆ renameFileForm()

◆ sanitizeCurrentDirectory()

◆ setAllowDirectories()

◆ setAllowDirectoryCreation()

◆ setAllowedSuffixes()

◆ setAllowFileCreation()

◆ setForbiddenSuffixes()

◆ setPerformedCommand()

◆ setPostDirPath()

◆ setTableId()

◆ setTitle()

◆ setUseUploadDirectory()

◆ unzipFile()

◆ uploadFile()

Field Documentation

◆ $allowed_suffixes

◆ $ctrl

◆ $forbidden_suffixes

◆ $use_upload_directory

◆ CDIR