class.ilPCFileItemGUI.php

Go to the documentation of this file.

<?php
/*
    +-----------------------------------------------------------------------------+
    | ILIAS open source                                                           |
    +-----------------------------------------------------------------------------+
    | Copyright (c) 1998-2001 ILIAS open source, University of Cologne            |
    |                                                                             |
    | This program is free software; you can redistribute it and/or               |
    | modify it under the terms of the GNU General Public License                 |
    | as published by the Free Software Foundation; either version 2              |
    | of the License, or (at your option) any later version.                      |
    |                                                                             |
    | This program is distributed in the hope that it will be useful,             |
    | but WITHOUT ANY WARRANTY; without even the implied warranty of              |
    | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               |
    | GNU General Public License for more details.                                |
    |                                                                             |
    | You should have received a copy of the GNU General Public License           |
    | along with this program; if not, write to the Free Software                 |
    | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA. |
    +-----------------------------------------------------------------------------+
*/

require_once("./Services/COPage/classes/class.ilPCListItem.php");
require_once("./Services/COPage/classes/class.ilPageContentGUI.php");

class ilPCFileItemGUI extends ilPageContentGUI
{
    protected $tabs;

    protected $user;

    protected $tree;

    protected $settings;


    public function __construct(&$a_pg_obj, &$a_content_obj, $a_hier_id, $a_pc_id = "")
    {
        global $DIC;

        $this->lng = $DIC->language();
        $this->tabs = $DIC->tabs();
        $this->ctrl = $DIC->ctrl();
        $this->user = $DIC->user();
        $this->tpl = $DIC["tpl"];
        $this->tree = $DIC->repositoryTree();
        $this->settings = $DIC->settings();
        parent::__construct($a_pg_obj, $a_content_obj, $a_hier_id, $a_pc_id);
    }

    public function executeCommand()
    {
        // get next class that processes or forwards current command
        $next_class = $this->ctrl->getNextClass($this);

        // get current command
        $cmd = $this->ctrl->getCmd();
        switch ($next_class) {
            default:
                $ret = $this->$cmd();
                break;
        }

        return $ret;
    }

    public function newFileItem()
    {
        $lng = $this->lng;
        
        if ($_FILES["file"]["name"] == "") {
            $_GET["subCmd"] = "-";
            ilUtil::sendFailure($lng->txt("upload_error_file_not_found"));
            return false;
        }

        $form = $this->initAddFileForm();
        $form->checkInput();

        include_once("./Modules/File/classes/class.ilObjFile.php");
        $fileObj = new ilObjFile();
        $fileObj->setType("file");
        $fileObj->setTitle($_FILES["file"]["name"]);
        $fileObj->setDescription("");
        $fileObj->setFileName($_FILES["file"]["name"]);
        $fileObj->setFileType($_FILES["file"]["type"]);
        $fileObj->setFileSize($_FILES["file"]["size"]);
        $fileObj->setMode("filelist");
        $fileObj->create();
        $fileObj->raiseUploadError(false);
        // upload file to filesystem
        $fileObj->createDirectory();
        global $DIC;
        $upload = $DIC->upload();
        if ($upload->hasBeenProcessed() !== true) {
            $upload->process();
        }
        $fileObj->getUploadFile(
            $_FILES["file"]["tmp_name"],
            $_FILES["file"]["name"]
        );

        $this->file_object = $fileObj;
        return true;
    }


    public function newItemAfter()
    {
        $ilTabs = $this->tabs;
        
        if ($_GET["subCmd"] == "insertNew") {
            $_SESSION["cont_file_insert"] = "insertNew";
        }
        if ($_GET["subCmd"] == "insertFromRepository") {
            $_SESSION["cont_file_insert"] = "insertFromRepository";
        }
        if ($_GET["subCmd"] == "insertFromWorkspace") {
            $_SESSION["cont_file_insert"] = "insertFromWorkspace";
        }
        if (($_GET["subCmd"] == "") && $_SESSION["cont_file_insert"] != "") {
            $_GET["subCmd"] = $_SESSION["cont_file_insert"];
        }

        switch ($_GET["subCmd"]) {
            case "insertFromWorkspace":
                $this->insertFromWorkspace("newItemAfter");
                break;
            
            case "insertFromRepository":
                $this->insertFromRepository("newItemAfter");
                break;
                
            case "selectFile":
                $this->insertNewItemAfter($_GET["file_ref_id"]);
                break;
                
            default:
                $this->setTabs("newItemAfter");
                $ilTabs->setSubTabActive("cont_new_file");
        
                $this->displayValidationError();
                $form = $this->initAddFileForm(false);
                $this->tpl->setContent($form->getHTML());
break;

                // new file list form
                $this->tpl->addBlockFile("ADM_CONTENT", "adm_content", "tpl.file_item_edit.html", "Services/COPage");
                $this->tpl->setVariable("TXT_ACTION", $this->lng->txt("cont_insert_file_item"));
                $this->tpl->setVariable("FORMACTION", $this->ctrl->getFormAction($this));
        
                $this->displayValidationError();
        
                // file
                $this->tpl->setVariable("TXT_FILE", $this->lng->txt("file"));
        
                $this->tpl->parseCurrentBlock();
        
                // operations
                $this->tpl->setCurrentBlock("commands");
                $this->tpl->setVariable("BTN_NAME", "insertNewItemAfter");
                $this->tpl->setVariable("BTN_TEXT", $this->lng->txt("save"));
                $this->tpl->parseCurrentBlock();
                break;
        }
    }

    public function initAddFileForm($a_before = true)
    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        $ilUser = $this->user;
    
        include_once("Services/Form/classes/class.ilPropertyFormGUI.php");
        $form = new ilPropertyFormGUI();
        
        // file
        $fi = new ilFileInputGUI($lng->txt("file"), "file");
        $fi->setRequired(true);
        $form->addItem($fi);
        
        if ($a_before) {
            $form->addCommandButton("insertNewItemBefore", $lng->txt("save"));
        } else {
            $form->addCommandButton("insertNewItemAfter", $lng->txt("save"));
        }
        $form->addCommandButton("cancelAddFile", $lng->txt("cancel"));
        
        $form->setTitle($lng->txt("cont_insert_file_item"));

        $form->setFormAction($ilCtrl->getFormAction($this));
     
        return $form;
    }

    
    public function insertFromRepository($a_cmd)
    {
        $ilTabs = $this->tabs;
        $ilCtrl = $this->ctrl;
        $tpl = $this->tpl;

        $this->setTabs($a_cmd);
        $ilTabs->setSubTabActive("cont_file_from_repository");
        $ilCtrl->setParameter($this, "subCmd", "insertFromRepository");

        include_once("./Services/COPage/classes/class.ilPCFileItemFileSelectorGUI.php");
        $exp = new ilPCFileItemFileSelectorGUI(
            $this,
            $a_cmd,
            $this,
            $a_cmd,
            "file_ref_id"
        );
        if (!$exp->handleCommand()) {
            $tpl->setContent($exp->getHTML());
        }
    }
    
    public function insertFromWorkspace($a_cmd = "insert")
    {
        $ilTabs = $this->tabs;
        $tree = $this->tree;
        $ilCtrl = $this->ctrl;
        $tpl = $this->tpl;
        $ilUser = $this->user;

        $this->setTabs($a_cmd);
        $ilTabs->setSubTabActive("cont_file_from_workspace");
        
        include_once("./Services/PersonalWorkspace/classes/class.ilWorkspaceExplorerGUI.php");
        $exp = new ilWorkspaceExplorerGUI($this->user->getId(), $this, $a_cmd, $this, $a_cmd, "fl_wsp_id");
        $ilCtrl->setParameter($this, "subCmd", "selectFile");
        $exp->setCustomLinkTarget($ilCtrl->getLinkTarget($this, $a_cmd));
        $ilCtrl->setParameter($this, "subCmd", "insertFromWorkspace");
        $exp->setTypeWhiteList(array("wsrt", "wfld", "file"));
        $exp->setSelectableTypes(array("file"));
        if ($exp->handleCommand()) {
            return;
        }
        $tpl->setContent($exp->getHTML());
    }

    public function insertNewItemAfter($a_file_ref_id = 0)
    {
        $ilUser = $this->user;
        
        $res = true;
        if (isset($_GET["fl_wsp_id"])) {
            // we need the object id for the instance
            include_once "Services/PersonalWorkspace/classes/class.ilWorkspaceTree.php";
            $tree = new ilWorkspaceTree($ilUser->getId());
            $node = $tree->getNodeData($_GET["fl_wsp_id"]);
            
            include_once("./Modules/File/classes/class.ilObjFile.php");
            $this->file_object = new ilObjFile($node["obj_id"], false);
        } elseif ($a_file_ref_id == 0) {
            $res = $this->newFileItem();
        } else {
            include_once("./Modules/File/classes/class.ilObjFile.php");
            $this->file_object = new ilObjFile($a_file_ref_id);
        }
        if ($res) {
            $this->content_obj->newItemAfter(
                $this->file_object->getId(),
                $this->file_object->getTitle(),
                $this->file_object->getFileType()
            );
            $this->updated = $this->pg_obj->update();
            if ($this->updated === true) {
                $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
            }
        }
        
        $_GET["subCmd"] = "-";
        $this->newItemAfter();
    }

    public function newItemBefore()
    {
        $ilTabs = $this->tabs;
        
        if ($_GET["subCmd"] == "insertNew") {
            $_SESSION["cont_file_insert"] = "insertNew";
        }
        if ($_GET["subCmd"] == "insertFromRepository") {
            $_SESSION["cont_file_insert"] = "insertFromRepository";
        }
        if ($_GET["subCmd"] == "insertFromWorkspace") {
            $_SESSION["cont_file_insert"] = "insertFromWorkspace";
        }
        if (($_GET["subCmd"] == "") && $_SESSION["cont_file_insert"] != "") {
            $_GET["subCmd"] = $_SESSION["cont_file_insert"];
        }

        switch ($_GET["subCmd"]) {
            case "insertFromWorkspace":
                $this->insertFromWorkspace("newItemBefore");
                break;
            
            case "insertFromRepository":
                $this->insertFromRepository("newItemBefore");
                break;
                
            case "selectFile":
                $this->insertNewItemBefore($_GET["file_ref_id"]);
                break;
                
            default:
                $this->setTabs("newItemBefore");
                $ilTabs->setSubTabActive("cont_new_file");
        
                $this->displayValidationError();
                $form = $this->initAddFileForm(true);
                $this->tpl->setContent($form->getHTML());
break;
                
                // new file list form
                $this->tpl->addBlockFile("ADM_CONTENT", "adm_content", "tpl.file_item_edit.html", "Services/COPage");
                $this->tpl->setVariable("TXT_ACTION", $this->lng->txt("cont_insert_file_item"));
                $this->tpl->setVariable("FORMACTION", $this->ctrl->getFormAction($this));
        
                $this->displayValidationError();
        
                // file
                $this->tpl->setVariable("TXT_FILE", $this->lng->txt("file"));
        
                $this->tpl->parseCurrentBlock();
        
                // operations
                $this->tpl->setCurrentBlock("commands");
                $this->tpl->setVariable("BTN_NAME", "insertNewItemBefore");
                $this->tpl->setVariable("BTN_TEXT", $this->lng->txt("save"));
                $this->tpl->parseCurrentBlock();
                break;
        }
    }

    public function insertNewItemBefore($a_file_ref_id = 0)
    {
        $ilUser = $this->user;
        
        $res = true;
        if (isset($_GET["fl_wsp_id"])) {
            // we need the object id for the instance
            include_once "Services/PersonalWorkspace/classes/class.ilWorkspaceTree.php";
            $tree = new ilWorkspaceTree($ilUser->getId());
            $node = $tree->getNodeData($_GET["fl_wsp_id"]);
            
            include_once("./Modules/File/classes/class.ilObjFile.php");
            $this->file_object = new ilObjFile($node["obj_id"], false);
        } elseif ($a_file_ref_id == 0) {
            $res = $this->newFileItem();
        } else {
            include_once("./Modules/File/classes/class.ilObjFile.php");
            $this->file_object = new ilObjFile($a_file_ref_id);
        }
        if ($res) {
            $this->content_obj->newItemBefore(
                $this->file_object->getId(),
                $this->file_object->getTitle(),
                $this->file_object->getFileType()
            );
            $this->updated = $this->pg_obj->update();
            if ($this->updated === true) {
                $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
            }
        }

        $_GET["subCmd"] = "-";
        $this->newItemBefore();
    }

    public function deleteItem()
    {
        $this->content_obj->deleteItem();
        $_SESSION["il_pg_error"] = $this->pg_obj->update();
        $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
    }

    public function setTabs($a_cmd = "")
    {
        $ilTabs = $this->tabs;
        $ilCtrl = $this->ctrl;
        $ilSetting = $this->settings;

        $ilTabs->addTarget(
            "cont_back",
            $this->ctrl->getParentReturn($this),
            "",
            ""
        );
            
        if ($a_cmd != "") {
            $ilCtrl->setParameter($this, "subCmd", "insertNew");
            $ilTabs->addSubTabTarget(
                "cont_new_file",
                $ilCtrl->getLinkTarget($this, $a_cmd),
                $a_cmd
            );
    
            $ilCtrl->setParameter($this, "subCmd", "insertFromRepository");
            $ilTabs->addSubTabTarget(
                "cont_file_from_repository",
                $ilCtrl->getLinkTarget($this, $a_cmd),
                $a_cmd
            );
            $ilCtrl->setParameter($this, "subCmd", "");
            
            if (!$ilSetting->get("disable_personal_workspace") &&
                !$ilSetting->get("disable_wsp_files")) {
                $ilCtrl->setParameter($this, "subCmd", "insertFromWorkspace");
                $ilTabs->addSubTabTarget(
                    "cont_file_from_workspace",
                    $ilCtrl->getLinkTarget($this, $a_cmd),
                    $a_cmd
                );
                $ilCtrl->setParameter($this, "subCmd", "");
            }
        }
    }

    public function moveItemDown()
    {
        $this->content_obj->moveItemDown();
        $_SESSION["il_pg_error"] = $this->pg_obj->update();
        $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
    }

    public function moveItemUp()
    {
        $this->content_obj->moveItemUp();
        $_SESSION["il_pg_error"] = $this->pg_obj->update();
        $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
    }

    public function cancelAddFile()
    {
        $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
    }
}