ilFileSystemGUI Class Reference

File System Explorer GUI class. More...

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 ()
	list files 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...

Data Fields
	$ctrl

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()

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 12 of file class.ilFileSystemGUI.php.

Constructor & Destructor Documentation

__construct()

ilFileSystemGUI::__construct

(

$a_main_directory

)

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

References $ilCtrl, $lng, $tpl, array, setAllowDirectories(), setAllowDirectoryCreation(), and setAllowFileCreation().

        {
                global $lng, $ilCtrl, $tpl, $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->commands = array(
                        0 => array(
                                "object" => $this,
                                "method" => "downloadFile",
                                "name" => $lng->txt("download"),
                                "int" => true,
                                "single" => true
                        ),
                        1 => array(
                                "object" => $this,
                                "method" => "confirmDeleteFile",
                                "name" => $lng->txt("delete"),
                                "allow_dir" => true,
                                "int" => true                           
                        ),
                        2 => array(
                                "object" => $this,
                                "method" => "unzipFile",
                                "name" => $lng->txt("unzip"),
                                "int" => true,
                                "single" => true
                        ),
                        3 => array(
                                "object" => $this,
                                "method" => "renameFileForm",
                                "name" => $lng->txt("rename"),
                                "allow_dir" => true,
                                "int" => true,
                                "single" => true
                        ),
                );

                $this->file_labels = array();
                $this->label_enable = false;
                $this->ctrl->saveParameter($this, "cdir");
                $lng->loadLanguageModule("content");
                $this->setAllowDirectories(true);
                $this->setAllowDirectoryCreation(true);
                $this->setAllowFileCreation(true);
//echo "<br>main_dir:".$this->main_dir.":";
        }

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 335 of file class.ilFileSystemGUI.php.

Referenced by ilObjFileBasedLMGUI\executeCommand().

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

Here is the caller graph for this function:

addCommand()

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

Add command.

Definition at line 302 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;
        }

cancelRename()

ilFileSystemGUI::cancelRename

(

)

cancel renaming a file

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

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

clearCommands()

ilFileSystemGUI::clearCommands

(

)

Clear commands.

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

References array.

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

confirmDeleteFile()

ilFileSystemGUI::confirmDeleteFile

(

array

$a_files

)

Confirm file deletion.

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

References $ilCtrl, $lng, and $tpl.

        {
                global $ilCtrl, $tpl, $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());             
        }

createDirectory()

ilFileSystemGUI::createDirectory

(

)

create directory

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

References $_GET, $_POST, $lng, array, ilUtil\makeDir(), ilUtil\sendFailure(), ilUtil\sendSuccess(), setPerformedCommand(), and ilUtil\stripSlashes().

        {
                global $lng;
                
                // determine directory
                $cur_subdir = str_replace(".", "", ilUtil::stripSlashes($_GET["cdir"]));
                $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, "cdir");
                $this->ctrl->redirect($this, "listFiles");
        }

Here is the call graph for this function:

deleteFile()

ilFileSystemGUI::deleteFile

(

)

delete object file

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

References $_GET, $_POST, $file, $lng, array, ilUtil\delDir(), ilUtil\sendSuccess(), setPerformedCommand(), and ilUtil\stripSlashes().

        {
                global $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 = str_replace(".", "", ilUtil::stripSlashes($_GET["cdir"]));
                        $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, "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");
        }

Here is the call graph for this function:

downloadFile()

ilFileSystemGUI::downloadFile

(

$a_file

)

delete object file

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

References $file, ilUtil\deliverFile(), and exit.

        {               
                $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, "cdir");
                        $this->ctrl->redirect($this, "listFiles");
                }
        }

Here is the call graph for this function:

executeCommand()

ilFileSystemGUI::executeCommand

(

)

execute command

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

References $cmd, $ret, and extCommand().

        {
                $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;
        }

Here is the call graph for this function:

extCommand()

ilFileSystemGUI::extCommand

(

$a_nr

)

call external command

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

References $_GET, $file, $files, array, getIncomingFiles(), ilUtil\sendFailure(), and ilUtil\stripSlashes().

Referenced by executeCommand().

        {
                $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 = str_replace(".", "", ilUtil::stripSlashes($_GET["cdir"]));

                // 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);
        }

Here is the call graph for this function:

Here is the caller graph for this function:

getAllowDirectories()

ilFileSystemGUI::getAllowDirectories

(

)

Get allow directories.

Returns

boolean allow directories

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

Referenced by listFiles(), and unzipFile().

        {
                return $this->allow_directories;
        }

Here is the caller graph for this function:

getAllowDirectoryCreation()

ilFileSystemGUI::getAllowDirectoryCreation

(

)

Get allowed directory creation.

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

Referenced by listFiles().

        {
                return $this->directory_creation;
        }

Here is the caller graph for this function:

getAllowedSuffixes()

ilFileSystemGUI::getAllowedSuffixes

(

)

Get allowed Suffixes.

Returns

array allowed Suffixes

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

References $allowed_suffixes.

Referenced by isValidSuffix().

        {
                return $this->allowed_suffixes;
        }

Here is the caller graph for this function:

getAllowFileCreation()

ilFileSystemGUI::getAllowFileCreation

(

)

Get allowed file creation.

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

Referenced by listFiles().

        {
                return $this->file_creation;
        }

Here is the caller graph for this function:

getFileList()

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

protected

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

References array, and ilUtil\getDir().

Referenced by getIncomingFiles().

        {
                $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;
        }

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 115 of file class.ilFileSystemGUI.php.

References $forbidden_suffixes.

Referenced by isValidSuffix().

        {
                return $this->forbidden_suffixes;
        }

Here is the caller graph for this function:

getIncomingFiles()

ilFileSystemGUI::getIncomingFiles ( )

protected

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

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

Referenced by extCommand().

        {                                               
                $sel_files = $hashes = array();                         
                if (isset($_POST["file"]))
                {
                        $hashes = $_POST["file"];
                }
                else if(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;
        }

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 265 of file class.ilFileSystemGUI.php.

References $_SESSION, and $ret.

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

getPostDirPath()

ilFileSystemGUI::getPostDirPath

(

)

Get post dir path.

Returns

boolean post dir path

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

Referenced by getIncomingFiles(), and listFiles().

        {
                return $this->post_dir_path;
        }

Here is the caller graph for this function:

getTableId()

ilFileSystemGUI::getTableId

(

)

Get table id.

Returns

string table id

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

Referenced by listFiles().

        {
                return $this->table_id;
        }

Here is the caller graph for this function:

getTabs()

ilFileSystemGUI::getTabs

(

&

$tabs_gui

)

get tabs

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

References $ilCtrl.

        {
                global $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", "");
        }

getTitle()

ilFileSystemGUI::getTitle

(

)

Get title.

Returns

string title

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

References $title.

Referenced by listFiles().

        {
                return $this->title;
        }

Here is the caller graph for this function:

getUseUploadDirectory()

ilFileSystemGUI::getUseUploadDirectory

(

)

Get use upload directory.

Returns

bool use upload directory

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

References $use_upload_directory.

Referenced by listFiles().

        {
                return $this->use_upload_directory;
        }

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 126 of file class.ilFileSystemGUI.php.

References getAllowedSuffixes(), and getForbiddenSuffixes().

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

        {
                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;
        }

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 327 of file class.ilFileSystemGUI.php.

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

listFiles()

ilFileSystemGUI::listFiles

(

)

list files

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

References $_GET, $file, $files, $ilCtrl, $lng, $options, $si, ilUploadFiles\_getUploadDirectory(), ilUploadFiles\_getUploadFiles(), getAllowDirectories(), getAllowDirectoryCreation(), getAllowFileCreation(), getPostDirPath(), getTableId(), getTitle(), getUseUploadDirectory(), parseCurrentDirectory(), ilTextInputGUI\setMaxLength(), and ilFileInputGUI\setSize().

        {
                global $ilToolbar, $lng, $ilCtrl;
                
                $dir = $this->parseCurrentDirectory();
                
                $this->ctrl->setParameter($this, "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");
                }
                        
                // load files templates
                include_once("./Services/FileSystem/classes/class.ilFileSystemTableGUI.php");
                $fs_table = new ilFileSystemTableGUI($this, "listFiles", $dir["dir"], $dir["subdir"],
                        $this->label_enable, $this->file_labels, $this->label_header, $this->commands,
                        $this->getPostDirPath(), $this->getTableId());
                if ($this->getTitle() != "")
                {
                        $fs_table->setTitle($this->getTitle());
                }
                if ($_GET["resetoffset"] == 1)
                {
                        $fs_table->resetOffset();
                }
                $this->tpl->setContent($fs_table->getHTML());
        }

Here is the call graph for this function:

parseCurrentDirectory()

ilFileSystemGUI::parseCurrentDirectory ( )

protected

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

References $_GET, array, and ilUtil\stripSlashes().

Referenced by getIncomingFiles(), and listFiles().

        {               
                // 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["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);
        }

Here is the call graph for this function:

Here is the caller graph for this function:

renameFile()

ilFileSystemGUI::renameFile

(

)

rename a file

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

References $_GET, $_POST, $lng, array, isValidSuffix(), ilFileUtils\rename(), ilUtil\renameExecutables(), ilUtil\sendFailure(), ilUtil\sendSuccess(), setPerformedCommand(), and ilUtil\stripSlashes().

        {
                global $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 = str_replace(".", "", ilUtil::stripSlashes($_GET["cdir"]));
                $dir = (!empty($cur_subdir))
                        ? $this->main_dir."/".$cur_subdir."/"
                        : $this->main_dir."/";


                if (is_dir($dir.ilUtil::stripSlashes($_GET["old_name"])))
                {
                        rename($dir.ilUtil::stripSlashes($_GET["old_name"]), $dir.$new_name);
                }
                else
                {
                        include_once("./Services/Utilities/classes/class.ilFileUtils.php");

                        try
                        {
                                ilFileUtils::rename($dir . ilUtil::stripSlashes($_GET["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");
        }

Here is the call graph for this function:

renameFileForm()

ilFileSystemGUI::renameFileForm

(

$a_file

)

list files

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

References $_GET, $file, $ilCtrl, $lng, ilTextInputGUI\setMaxLength(), and ilUtil\stripSlashes().

        {
                global $lng, $ilCtrl;
                
                $cur_subdir = str_replace(".", "", ilUtil::stripSlashes($_GET["cdir"]));
                $file = $this->main_dir."/".$a_file;

                $this->ctrl->setParameter($this, "old_name", basename($a_file));
                $this->ctrl->setParameter($this, "cdir", ilUtil::stripSlashes($_GET["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());
        }

Here is the call graph for this function:

setAllowDirectories()

ilFileSystemGUI::setAllowDirectories

(

$a_val

)

Set allow directories.

Parameters

boolean

allow directories

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

Referenced by __construct().

        {
                $this->allow_directories = $a_val;
        }

Here is the caller graph for this function:

setAllowDirectoryCreation()

ilFileSystemGUI::setAllowDirectoryCreation

(

$a_val

)

Set allowed directory creation.

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

Referenced by __construct().

        {
                $this->directory_creation = $a_val;
        }

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 85 of file class.ilFileSystemGUI.php.

Referenced by ilObjMediaObjectGUI\executeCommand().

        {
                $this->allowed_suffixes = $a_suffixes;
        }

Here is the caller graph for this function:

setAllowFileCreation()

ilFileSystemGUI::setAllowFileCreation

(

$a_val

)

Set allowed file creation.

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

Referenced by __construct().

        {
                $this->file_creation = $a_val;
        }

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 105 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 250 of file class.ilFileSystemGUI.php.

References $_SESSION, and array.

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

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

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 169 of file class.ilFileSystemGUI.php.

Referenced by ilObjMediaPoolGUI\executeCommand().

        {
                $this->post_dir_path = $a_val;
        }

Here is the caller graph for this function:

setTableId()

ilFileSystemGUI::setTableId

(

$a_val

)

Set table id.

Parameters

string

table id

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

Referenced by ilExPeerReviewGUI\executeCommand(), and ilExerciseManagementGUI\executeCommand().

        {
                $this->table_id = $a_val;
        }

Here is the caller graph for this function:

setTitle()

ilFileSystemGUI::setTitle

(

$a_val

)

Set title.

Parameters

string

title

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

Referenced by ilExAssignmentEditorGUI\executeCommand().

        {
                $this->title = $a_val;
        }

Here is the caller graph for this function:

setUseUploadDirectory()

ilFileSystemGUI::setUseUploadDirectory

(

$a_val

)

Set use upload directory.

Parameters

bool

$a_val

use upload directory

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

Referenced by ilObjSAHSLearningModuleGUI\executeCommand().

        {
                $this->use_upload_directory = $a_val;
        }

Here is the caller graph for this function:

unzipFile()

ilFileSystemGUI::unzipFile

(

$a_file = null

)

delete object file

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

References $_GET, $d, $file, $lng, $path, array, getAllowDirectories(), ilUtil\getDir(), isValidSuffix(), ilFileUtils\recursive_dirscan(), ilUtil\renameExecutables(), ilUtil\sendFailure(), ilUtil\sendSuccess(), setPerformedCommand(), ilUtil\stripSlashes(), and ilUtil\unzip().

        {
                global $lng;
                
                // #17470 - direct unzip call (after upload)
                if(!$a_file &&
                        isset($_GET["upfile"]))
                {
                        $a_file = basename($_GET["upfile"]);
                }               
                
                $cur_subdir = str_replace(".", "", ilUtil::stripSlashes($_GET["cdir"]));
                $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, "cdir");
                ilUtil::sendSuccess($lng->txt("cont_file_unzipped"), true);
                $this->ctrl->redirect($this, "listFiles");
        }

Here is the call graph for this function:

uploadFile()

ilFileSystemGUI::uploadFile

(

)

upload file

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

References $_GET, $_POST, $lng, $url, ilUploadFiles\_checkUploadFile(), ilUploadFiles\_copyUploadFile(), array, ilLinkButton\getInstance(), ilMimeTypeUtil\getMimeType(), isValidSuffix(), ilUtil\moveUploadedFile(), ilUtil\renameExecutables(), ilUtil\sendFailure(), ilUtil\sendSuccess(), setPerformedCommand(), and ilUtil\stripSlashes().

        {
                global $lng;
                
                // determine directory
                $cur_subdir = str_replace(".", "", ilUtil::stripSlashes($_GET["cdir"]));
                $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 = ilUtil::stripSlashes($_FILES["new_file"]["name"]);
                        $tgt_file = $cur_dir."/".$name;

                        ilUtil::moveUploadedFile($_FILES["new_file"]["tmp_name"], $name, $tgt_file);

                }
                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);
                        }                       
                }
                else if (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, "cdir");

                ilUtil::renameExecutables($this->main_dir);

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

Here is the call graph for this function:

Field Documentation

$allowed_suffixes

ilFileSystemGUI::$allowed_suffixes = array()

protected

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

Referenced by getAllowedSuffixes().

$ctrl

ilFileSystemGUI::$ctrl

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

$forbidden_suffixes

ilFileSystemGUI::$forbidden_suffixes = array()

protected

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

Referenced by getForbiddenSuffixes().

$use_upload_directory

ilFileSystemGUI::$use_upload_directory = false

protected

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

Referenced by getUseUploadDirectory().

---

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

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