class.ilFileSystemGUI.php

Go to the documentation of this file.

<?php
 
use ILIAS\UI\Factory;
use ILIAS\UI\Renderer;
use ILIAS\Filesystem\Util\Archive\LegacyArchives;
use ILIAS\HTTP\Wrapper\WrapperFactory;
use ILIAS\FileUpload\DTO\ProcessingStatus;
use ILIAS\FileUpload\DTO\UploadResult;
use ILIAS\FileUpload\MimeType;
use ILIAS\Filesystem\Util\LegacyPathHelper;
use ILIAS\ResourceStorage\Preloader\SecureString;
 
class ilFileSystemGUI
{
    use SecureString; // This is just for those legacy classes which will be removed soon anyway.
    public const PARAMETER_CDIR = "cdir";
    public const SESSION_LAST_COMMAND = "fsys_lastcomm";
    public const PARAMETER_NEWDIR = "newdir";
    public const PARAMETER_FHSH = "fhsh";
    public const POST_PARAM_FILE = "file";
    public const PARAM_RESETOFFSET = "resetoffset";
    public const PARAM_OLD_NAME = "old_name";
    public const PARAM_UPFILE = "upfile";
    public const POST_PARAM_NEW_NAME = "new_name";
    public const POST_PARAM_NEW_DIR = "new_dir";
    public const POST_PARAM_UPLOADED_FILE = "uploaded_file";
    public const CMD_UNZIP_FILE = "unzipFile";
    private Factory $ui_factory;
    private Renderer $ui_renderer;
    protected LegacyArchives $unzip;
    protected ilCtrlInterface $ctrl;
    protected bool $use_upload_directory = false;
    protected array $allowed_suffixes = [];
    protected array $forbidden_suffixes = [];
    protected ilLanguage $lng;
    protected string $main_absolute_dir;
    protected bool $post_dir_path = false;
    protected ilGlobalTemplateInterface $tpl;
    protected array $file_labels = [];
    protected bool $label_enable = false;
    protected bool $allow_directories = true;
    protected string $table_id = '';
    protected string $title = '';
    protected array $commands = [];
    protected string $label_header = '';
    protected bool $directory_creation = false;
    protected bool $file_creation = false;
    protected WrapperFactory $wrapper;
    protected \ILIAS\Refinery\Factory $refinery;
 
    public function __construct(string $main_absolute_directory)
    {
        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);
    }
 
    public function setAllowedSuffixes(array $a_suffixes): void
    {
        $this->allowed_suffixes = $a_suffixes;
    }
 
    public function getAllowedSuffixes(): array
    {
        return $this->allowed_suffixes;
    }
 
    public function setForbiddenSuffixes(array $a_suffixes): void
    {
        $this->forbidden_suffixes = $a_suffixes;
    }
 
    public function getForbiddenSuffixes(): array
    {
        return $this->forbidden_suffixes;
    }
 
    public function isValidSuffix(string $a_suffix): 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;
    }
 
    public function setAllowDirectories(bool $a_val): void
    {
        $this->allow_directories = $a_val;
    }
 
    public function getAllowDirectories(): bool
    {
        return $this->allow_directories;
    }
 
    public function setPostDirPath(bool $a_val): void
    {
        $this->post_dir_path = $a_val;
    }
 
    public function getPostDirPath(): bool
    {
        return $this->post_dir_path;
    }
 
    public function setTableId(string $a_val): void
    {
        $this->table_id = $a_val;
    }
 
    public function getTableId(): string
    {
        return $this->table_id;
    }
 
    public function getMainAbsoluteDir(): string
    {
        return $this->main_absolute_dir;
    }
 
    public function setTitle(string $a_val): void
    {
        $this->title = $a_val;
    }
 
    public function getTitle(): string
    {
        return $this->title;
    }
 
    public function setUseUploadDirectory(bool $a_val): void
    {
        $this->use_upload_directory = $a_val;
    }
 
    public function getUseUploadDirectory(): bool
    {
        return $this->use_upload_directory;
    }
 
    protected function setPerformedCommand($command, array $pars = []): void
    {
        if (!is_array($pars)) {
            $pars = [];
        }
        ilSession::set(self::SESSION_LAST_COMMAND, array_merge(
            ["cmd" => $command],
            $pars
        ));
    }
 
    public function getLastPerformedCommand(): 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;
    }
 
    public function executeCommand(): 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 ?? '';
    }
 
    public function addCommand(
        object $a_obj,
        string $a_func,
        string $a_name,
        bool $a_single = true,
        bool $a_allow_dir = false
    ): 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;
    }
 
    public function clearCommands(): void
    {
        $this->commands = [];
    }
 
    public function labelFile(string $a_file, string $a_label): void
    {
        $this->file_labels[$a_file][] = $a_label;
    }
 
    public function activateLabels(bool $a_act, string $a_label_header): void
    {
        $this->label_enable = $a_act;
        $this->label_header = $a_label_header;
    }
 
    protected function parseCurrentDirectory(): 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;
 
        $resolved_dir = realpath($cur_dir);
        if ($resolved_dir === false) {
            // The requested directory cannot be resolved, e.g. because its
            // name contains non-UTF-8/special characters created by an older
            // ILIAS version (Mantis 45045). Fall back to the managed base
            // directory instead of crashing the whole page.
            return [
                "dir" => $this->main_absolute_dir,
                "subdir" => ''
            ];
        }
 
        return [
            "dir" => $resolved_dir,
            "subdir" => $cur_subdir
        ];
    }
 
    protected function getFileList(string $a_dir, ?string $a_subdir = null): 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;
    }
 
    protected function getIncomingFiles(): 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;
    }
 
    private function extCommand(int $a_nr): 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);
    }
 
    public function setAllowDirectoryCreation(bool $a_val): void
    {
        $this->directory_creation = $a_val;
    }
 
    public function getAllowDirectoryCreation(): bool
    {
        return $this->directory_creation;
    }
 
    public function setAllowFileCreation(bool $a_val): void
    {
        $this->file_creation = $a_val;
    }
 
    public function getAllowFileCreation(): bool
    {
        return $this->file_creation;
    }
 
    public function listFiles(?ilTable2GUI $a_table_gui = null): 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());
    }
 
    public function getTable(string $a_dir, string $a_subdir): \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()
        );
    }
 
    public function renameFileForm(string $a_file): 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());
    }
 
    public function renameFile(): 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");
    }
 
    public function cancelRename(): void
    {
        $this->ctrl->redirect($this, "listFiles");
    }
 
    public function createDirectory(): 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');
    }
 
    public function uploadFile(): 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');
    }
 
    public function confirmDeleteFile(array $a_files): 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());
    }
 
    public function deleteFile(): 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');
    }
 
    public function unzipFile(?string $a_file = null): 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");
    }
 
    public function downloadFile(string $a_file): 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");
    }
 
    public function getActionCommands(): array
    {
        return $this->commands;
    }
 
    public function defineCommands(): 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
            ],
        ];
    }
 
    private function sanitizeCurrentDirectory(): 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)
        );
    }
}