class.ilObjWorkspaceFolderGUI.php

Go to the documentation of this file.

<?php

/* Copyright (c) 1998-2009 ILIAS open source, Extended GPL, see docs/LICENSE */

require_once "./Services/Object/classes/class.ilObject2GUI.php";

class ilObjWorkspaceFolderGUI extends ilObject2GUI
{
    protected $help;

    protected $tabs;


    public function __construct($a_id = 0, $a_id_type = self::REPOSITORY_NODE_ID, $a_parent_node_id = 0)
    {
        global $DIC;
        parent::__construct($a_id, $a_id_type, $a_parent_node_id);

        $this->lng = $DIC->language();
        $this->help = $DIC["ilHelp"];
        $this->tpl = $DIC["tpl"];
        $this->user = $DIC->user();
        $this->tabs = $DIC->tabs();
        $this->ctrl = $DIC->ctrl();
    }

    public function getType()
    {
        return "wfld";
    }

    public function setTabs($a_show_settings = true)
    {
        $lng = $this->lng;
        $ilHelp = $this->help;

        $ilHelp->setScreenIdComponent("wfld");
        
        $this->ctrl->setParameter($this, "wsp_id", $this->node_id);
        
        $this->tabs_gui->addTab(
            "wsp",
            $lng->txt("wsp_tab_personal"),
            $this->ctrl->getLinkTarget($this, "")
        );
        
        $this->ctrl->setParameterByClass(
            "ilObjWorkspaceRootFolderGUI",
            "wsp_id",
            $this->getAccessHandler()->getTree()->getRootId()
        );
        
        $this->tabs_gui->addTab(
            "share",
            $lng->txt("wsp_tab_shared"),
            $this->ctrl->getLinkTargetByClass("ilObjWorkspaceRootFolderGUI", "shareFilter")
        );
        
        $this->tabs_gui->addTab(
            "ownership",
            $lng->txt("wsp_tab_ownership"),
            $this->ctrl->getLinkTargetByClass(array("ilObjWorkspaceRootFolderGUI", "ilObjectOwnershipManagementGUI"), "listObjects")
        );
        
        if (!$this->ctrl->getNextClass($this)) {
            if (stristr($this->ctrl->getCmd(), "share")) {
                $this->tabs_gui->activateTab("share");
            } else {
                $this->tabs_gui->activateTab("wsp");

                if ($a_show_settings) {
                    if ($this->checkPermissionBool("read")) {
                        $this->tabs_gui->addSubTab(
                            "content",
                            $lng->txt("content"),
                            $this->ctrl->getLinkTarget($this, "")
                        );
                    }

                    if ($this->checkPermissionBool("write")) {
                        $this->tabs_gui->addSubTab(
                            "settings",
                            $lng->txt("settings"),
                            $this->ctrl->getLinkTarget($this, "edit")
                        );
                    }
                }
            }
        }
    }

    public function executeCommand()
    {
        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd();

        switch ($next_class) {
            case "ilcommonactiondispatchergui":
                include_once("Services/Object/classes/class.ilCommonActionDispatcherGUI.php");
                $gui = ilCommonActionDispatcherGUI::getInstanceFromAjaxCall();
                $this->ctrl->forwardCommand($gui);
                break;
            
            case "ilobjectownershipmanagementgui":
                $this->prepareOutput();
                $this->tabs_gui->activateTab("ownership");
                include_once("Services/Object/classes/class.ilObjectOwnershipManagementGUI.php");
                $gui = new ilObjectOwnershipManagementGUI();
                $this->ctrl->forwardCommand($gui);
                break;
            
            default:
                $this->prepareOutput();
                if ($this->type != "wsrt") {
                    $this->addHeaderAction();
                }
                if (!$cmd) {
                    $cmd = "render";
                }
                $this->$cmd();
                break;
        }
        
        return true;
    }
    
    protected function initCreationForms($a_new_type)
    {
        $forms = array(
            self::CFORM_NEW => $this->initCreateForm($a_new_type)
            );

        return $forms;
    }

    public function render()
    {
        $tpl = $this->tpl;
        $ilUser = $this->user;
        $ilTabs = $this->tabs;
        $ilCtrl = $this->ctrl;
        
        unset($_SESSION['clipboard']['wsp2repo']);
        
        // add new item
        include_once "Services/Object/classes/class.ilObjectAddNewItemGUI.php";
        $gui = new ilObjectAddNewItemGUI($this->node_id);
        $gui->setMode(ilObjectDefinition::MODE_WORKSPACE);
        $gui->setCreationUrl($ilCtrl->getLinkTarget($this, "create"));
        $gui->render();
    
        include_once "Services/Object/classes/class.ilObjectListGUI.php";
        ilObjectListGUI::prepareJsLinks(
            "",
            $this->ctrl->getLinkTargetByClass(array("ilcommonactiondispatchergui", "ilnotegui"), "", "", true, false),
            $this->ctrl->getLinkTargetByClass(array("ilcommonactiondispatchergui", "iltagginggui"), "", "", true, false)
        );
        
        include_once "Modules/WorkspaceFolder/classes/class.ilObjWorkspaceFolderTableGUI.php";
        $table = new ilObjWorkspaceFolderTableGUI($this, "render", $this->node_id, $this->getAccessHandler());
        $tpl->setContent($table->getHTML());

        include_once("./Services/PersonalWorkspace/classes/class.ilWorkspaceExplorerGUI.php");
        $exp = new ilWorkspaceExplorerGUI($ilUser->getId(), $this, "render", $this, "", "wsp_id");
        $exp->setTypeWhiteList(array("wsrt", "wfld"));
        $exp->setSelectableTypes(array("wsrt", "wfld"));
        $exp->setLinkToNodeClass(true);
        $exp->setActivateHighlighting(true);
        if ($exp->handleCommand()) {
            return;
        }
        $left = $exp->getHTML();

        $tpl->setLeftNavContent($left);
    }
    
    public function edit()
    {
        parent::edit();
      
        $this->tabs_gui->activateTab("wsp");
        $this->tabs_gui->activateSubTab("settings");
    }
    
    public function update()
    {
        parent::update();
        
        $this->tabs_gui->activateTab("wsp");
        $this->tabs_gui->activateSubTab("settings");
    }

    public function cut()
    {
        if (!$_REQUEST["item_ref_id"]) {
            ilUtil::sendFailure($this->lng->txt("no_checkbox"), true);
            $this->ctrl->redirect($this);
        }

        $current_node = $_REQUEST["item_ref_id"];
        $parent_node = $this->tree->getParentId($current_node);

        // on cancel or fail we return to parent node
        $this->ctrl->setParameter($this, "wsp_id", $parent_node);

        // check permission
        $no_cut = array();
        foreach ($this->tree->getSubTree($this->tree->getNodeData($current_node)) as $node) {
            if (!$this->checkPermissionBool("delete", "", "", $node["wsp_id"])) {
                $obj = ilObjectFactory::getInstanceByObjId($node["obj_id"]);
                $no_cut[$node["wsp_id"]] = $obj->getTitle();
                unset($obj);
            }
        }
        if (count($no_cut)) {
            ilUtil::sendFailure($this->lng->txt("msg_no_perm_cut") . " " . implode(',', $no_cut), true);
            $this->ctrl->redirect($this);
        }

        // open current position
        // using the explorer session storage directly is basically a hack
        // as we do not use setExpanded() [see below]
        $_SESSION['paste_cut_wspexpand'] = array();
        foreach ((array) $this->tree->getPathId($parent_node) as $node_id) {
            $_SESSION['paste_cut_wspexpand'][] = $node_id;
        }

        // remember source node
        $_SESSION['clipboard']['source_id'] = $current_node;
        $_SESSION['clipboard']['cmd'] = 'cut';

        return $this->showMoveIntoObjectTree();
    }
        
    public function cut_for_repository()
    {
        $_SESSION['clipboard']['wsp2repo'] = true;
        $this->cut();
    }
    
    public function copy()
    {
        $ilUser = $this->user;
        
        if (!$_REQUEST["item_ref_id"]) {
            ilUtil::sendFailure($this->lng->txt("no_checkbox"), true);
            $this->ctrl->redirect($this);
        }

        $current_node = $_REQUEST["item_ref_id"];
        $owner = $this->tree->lookupOwner($current_node);
        if ($owner == $ilUser->getId()) {
            $parent_node = $this->tree->getParentId($current_node);

            // on cancel or fail we return to parent node
            $this->ctrl->setParameter($this, "wsp_id", $parent_node);

            // open current position
            // using the explorer session storage directly is basically a hack
            // as we do not use setExpanded() [see below]
            $_SESSION['paste_copy_wspexpand'] = array();
            foreach ((array) $this->tree->getPathId($parent_node) as $node_id) {
                $_SESSION['paste_copy_wspexpand'][] = $node_id;
            }
        } else {
            // see copyShared()
            ilUtil::sendFailure($this->lng->txt('permission_denied'), true);
            $this->ctrl->redirect($this);
        }

        // remember source node
        $_SESSION['clipboard']['source_id'] = $current_node;
        $_SESSION['clipboard']['cmd'] = 'copy';

        return $this->showMoveIntoObjectTree();
    }
    
    public function copyShared()
    {
        if (!$_REQUEST["item_ref_id"]) {
            $this->ctrl->redirect($this, "share");
        }
        
        $current_node = $_REQUEST["item_ref_id"];
        $handler = $this->getAccessHandler();
        
        // see ilSharedRessourceGUI::hasAccess()
        if ($handler->checkAccess("read", "", $current_node)) {
            // remember source node
            $_SESSION['clipboard']['source_id'] = $current_node;
            $_SESSION['clipboard']['cmd'] = 'copy';
            $_SESSION['clipboard']['shared'] = true;

            return $this->showMoveIntoObjectTree();
        } else {
            $perms = $handler->getPermissions($current_node);
            if (in_array(ilWorkspaceAccessGUI::PERMISSION_ALL_PASSWORD, $perms)) {
                return $this->passwordForm($current_node);
            }
        }
        
        ilUtil::sendFailure($this->lng->txt('permission_denied'), true);
        $this->ctrl->redirect($this, "share");
    }
        
    public function copy_to_repository()
    {
        $_SESSION['clipboard']['wsp2repo'] = true;
        $this->copy();
    }

    public function showMoveIntoObjectTree()
    {
        $ilTabs = $this->tabs;
        $tree = $this->tree;
        
        $ilTabs->clearTargets();

        if (!$_SESSION['clipboard']['shared']) {
            $ilTabs->setBackTarget(
                $this->lng->txt('back'),
                $this->ctrl->getLinkTarget($this)
            );
        } else {
            $ilTabs->setBackTarget(
                $this->lng->txt('back'),
                $this->ctrl->getLinkTarget($this, 'share')
            );
        }
        
        $mode = $_SESSION['clipboard']['cmd'];

        ilUtil::sendInfo($this->lng->txt('msg_' . $mode . '_clipboard'));
        
        $this->tpl->addBlockfile(
            'ADM_CONTENT',
            'adm_content',
            'tpl.paste_into_multiple_objects.html',
            "Services/Object"
        );
        
        // move/copy in personal workspace
        if (!$_SESSION['clipboard']['wsp2repo']) {
            include_once("./Services/PersonalWorkspace/classes/class.ilWorkspaceExplorerGUI.php");
            $exp = new ilWorkspaceExplorerGUI($this->user->getId(), $this, "showMoveIntoObjectTree", $this, "");
            $exp->setTypeWhiteList(array("wsrt", "wfld"));
            $exp->setSelectableTypes(array("wsrt", "wfld"));
            $exp->setSelectMode("node", false);
            if ($exp->handleCommand()) {
                return;
            }
            $this->tpl->setVariable('OBJECT_TREE', $exp->getHTML());
        }
        // move/copy to repository
        else {
            require_once './Services/Object/classes/class.ilPasteIntoMultipleItemsExplorer.php';
            $exp = new ilPasteIntoMultipleItemsExplorer(
                ilPasteIntoMultipleItemsExplorer::SEL_TYPE_RADIO,
                '',
                'paste_' . $mode . '_repexpand'
            );
            $exp->setTargetGet('ref_id');
            
            if ($_GET['paste_' . $mode . '_repexpand'] == '') {
                $expanded = $tree->readRootId();
            } else {
                $expanded = $_GET['paste_' . $mode . '_repexpand'];
            }
            $exp->setCheckedItems(array((int) $_POST['node']));
            $exp->setExpandTarget($this->ctrl->getLinkTarget($this, 'showMoveIntoObjectTree'));
            $exp->setPostVar('node');
            $exp->setExpand($expanded);
            $exp->setOutput(0);
            $this->tpl->setVariable('OBJECT_TREE', $exp->getOutput());
        }
        

        unset($exp);

        $this->tpl->setVariable('FORM_TARGET', '_top');
        $this->tpl->setVariable(
            'FORM_ACTION',
            $this->ctrl->getFormAction($this, 'performPasteIntoMultipleObjects')
        );

        $this->tpl->setVariable('CMD_SUBMIT', 'performPasteIntoMultipleObjects');
        $this->tpl->setVariable('TXT_SUBMIT', $this->lng->txt('paste'));
    }

    public function performPasteIntoMultipleObjects()
    {
        $ilUser = $this->user;
        
        $mode = $_SESSION['clipboard']['cmd'];
        $source_node_id = $_SESSION['clipboard']['source_id'];
        $target_node_id = $_REQUEST['node'];

        if (!$source_node_id) {
            ilUtil::sendFailure($this->lng->txt('select_at_least_one_object'), true);
            $this->ctrl->redirect($this);
        }
        if (!$target_node_id) {
            ilUtil::sendFailure($this->lng->txt('select_at_least_one_object'), true);
            $this->ctrl->redirect($this, "showMoveIntoObjectTree");
        }

        // object instances
        $source_obj_id = $this->tree->lookupObjectId($source_node_id);
        $source_object = ilObjectFactory::getInstanceByObjId($source_obj_id);
        
        if (!$_SESSION['clipboard']['wsp2repo']) {
            $target_obj_id = $this->tree->lookupObjectId($target_node_id);
        } else {
            $target_obj_id = ilObject::_lookupObjId($target_node_id);
        }
        $target_object = ilObjectFactory::getInstanceByObjId($target_obj_id);


        // sanity checks

        $fail = array();

        if ($source_node_id == $target_node_id) {
            $fail[] = sprintf(
                $this->lng->txt('msg_obj_exists_in_folder'),
                $source_object->getTitle(),
                $target_object->getTitle()
            );
        }

        if (!in_array($source_object->getType(), array_keys($target_object->getPossibleSubObjects()))) {
            $fail[] = sprintf(
                $this->lng->txt('msg_obj_may_not_contain_objects_of_type'),
                $target_object->getTitle(),
                $source_object->getType()
            );
        }
                
        // if object is shared permission to copy has been checked above
        $owner = $this->tree->lookupOwner($source_node_id);
        if ($mode == "copy" && $ilUser->getId() == $owner && !$this->checkPermissionBool('copy', '', '', $source_node_id)) {
            $fail[] = $this->lng->txt('permission_denied');
        }

        if (!$_SESSION['clipboard']['wsp2repo']) {
            if ($mode == "cut" && $this->tree->isGrandChild($source_node_id, $target_node_id)) {
                $fail[] = sprintf(
                    $this->lng->txt('msg_paste_object_not_in_itself'),
                    $source_object->getTitle()
                );
            }
        }

        if ($_SESSION['clipboard']['wsp2repo'] == true) {               // see #22959
            global $ilAccess;
            if (!$ilAccess->checkAccess("create", "", $target_node_id, $source_object->getType())) {
                $fail[] = sprintf(
                    $this->lng->txt('msg_no_perm_paste_object_in_folder'),
                    $source_object->getTitle(),
                    $target_object->getTitle()
                );
            }
        } else {
            if (!$this->checkPermissionBool('create', '', $source_object->getType(), $target_node_id)) {
                $fail[] = sprintf(
                    $this->lng->txt('msg_no_perm_paste_object_in_folder'),
                    $source_object->getTitle(),
                    $target_object->getTitle()
                );
            }
        }

        if (sizeof($fail)) {
            ilUtil::sendFailure(implode("<br />", $fail), true);
            $this->ctrl->redirect($this);
        }


        // move the node
        if ($mode == "cut") {
            if (!$_SESSION['clipboard']['wsp2repo']) {
                $this->tree->moveTree($source_node_id, $target_node_id);
            } else {
                $parent_id = $this->tree->getParentId($source_node_id);

                // remove from personal workspace
                $this->getAccessHandler()->removePermission($source_node_id);
                $this->tree->deleteReference($source_node_id);
                $source_node = $this->tree->getNodeData($source_node_id);
                $this->tree->deleteTree($source_node);

                // add to repository
                $source_object->createReference();
                $source_object->putInTree($target_node_id);
                $source_object->setPermissions($target_node_id);

                $source_node_id = $parent_id;
            }
        }
        // copy the node
        elseif ($mode == "copy") {
            include_once('Services/CopyWizard/classes/class.ilCopyWizardOptions.php');
            $copy_id = ilCopyWizardOptions::_allocateCopyId();
            $wizard_options = ilCopyWizardOptions::_getInstance($copy_id);
            
            if (!$_SESSION['clipboard']['wsp2repo']) {
                $wizard_options->disableTreeCopy();
            }
            $wizard_options->saveOwner($ilUser->getId());
            $wizard_options->saveRoot($source_node_id);
            $wizard_options->read();
            
            $new_obj = $source_object->cloneObject($target_node_id, $copy_id);
            
            // insert into workspace tree
            if ($new_obj && !$_SESSION['clipboard']['wsp2repo']) {
                $new_obj_node_id = $this->tree->insertObject($target_node_id, $new_obj->getId());
                $this->getAccessHandler()->setPermissions($target_node_id, $new_obj_node_id);
            }
 
            $wizard_options->deleteAll();
        }
        
        // redirect to target if not repository
        if (!$_SESSION['clipboard']['wsp2repo']) {
            $redirect_node = $target_node_id;
        } else {
            // reload current folder
            $redirect_node = $this->node_id;
        }
        
        unset($_SESSION['clipboard']['cmd']);
        unset($_SESSION['clipboard']['source_id']);
        unset($_SESSION['clipboard']['wsp2repo']);
        unset($_SESSION['clipboard']['shared']);
        
        // #17746
        if ($mode == 'cut') {
            ilUtil::sendSuccess($this->lng->txt('msg_cut_copied'), true);
        } else {
            ilUtil::sendSuccess($this->lng->txt('msg_cloned'), true);
        }
        
        $this->ctrl->setParameter($this, "wsp_id", $redirect_node);
        $this->ctrl->redirect($this);
    }
    
    public function shareFilter()
    {
        $this->share(false);
    }
    
    public function share($a_load_data = true)
    {
        $tpl = $this->tpl;
    
        include_once "Services/PersonalWorkspace/classes/class.ilWorkspaceShareTableGUI.php";
        $tbl = new ilWorkspaceShareTableGUI($this, "share", $this->getAccessHandler(), $this->node_id, $a_load_data);
        $tpl->setContent($tbl->getHTML());
    }
    
    public function applyShareFilter()
    {
        include_once "Services/PersonalWorkspace/classes/class.ilWorkspaceShareTableGUI.php";
        $tbl = new ilWorkspaceShareTableGUI($this, "share", $this->getAccessHandler(), $this->node_id);
        $tbl->resetOffset();
        $tbl->writeFilterToSession();
        
        $this->share();
    }
    
    public function resetShareFilter()
    {
        include_once "Services/PersonalWorkspace/classes/class.ilWorkspaceShareTableGUI.php";
        $tbl = new ilWorkspaceShareTableGUI($this, "share", $this->getAccessHandler(), $this->node_id);
        $tbl->resetOffset();
        $tbl->resetFilter();
        
        $this->shareFilter();
    }
    
    protected function passwordForm($a_node_id, $form = null)
    {
        $tpl = $this->tpl;
        $lng = $this->lng;
        $ilTabs = $this->tabs;
        
        $tpl->setTitle($lng->txt("wsp_password_protected_resource"));
        $tpl->setDescription($lng->txt("wsp_password_protected_resource_info"));
        
        $ilTabs->clearTargets();
        $ilTabs->setBackTarget(
            $lng->txt("back"),
            $this->ctrl->getLinkTarget($this, "share")
        );
        
        if (!$form) {
            $form = $this->initPasswordForm($a_node_id);
        }
    
        $tpl->setContent($form->getHTML());
    }
    
    protected function initPasswordForm($a_node_id)
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
                        
        $this->ctrl->setParameter($this, "item_ref_id", $a_node_id);
        
        $object_data = $this->getAccessHandler()->getObjectDataFromNode($a_node_id);
        
        include_once "Services/Form/classes/class.ilPropertyFormGUI.php";
        $form = new ilPropertyFormGUI();
        $form->setFormAction($ilCtrl->getFormAction($this, "checkPassword"));
        $form->setTitle($lng->txt("wsp_password_for") . ": " . $object_data["title"]);
        
        $password = new ilPasswordInputGUI($lng->txt("password"), "password");
        $password->setRetype(false);
        $password->setRequired(true);
        $password->setSkipSyntaxCheck(true);
        $form->addItem($password);
        
        $form->addCommandButton("checkPassword", $lng->txt("submit"));
        $form->addCommandButton("share", $lng->txt("cancel"));
        
        return $form;
    }
    
    protected function checkPassword()
    {
        $lng = $this->lng;
        
        $node_id = $_REQUEST["item_ref_id"];
        if (!$node_id) {
            $this->ctrl->redirect($this, "share");
        }
         
        $form = $this->initPasswordForm($node_id);
        if ($form->checkInput()) {
            include_once "Services/PersonalWorkspace/classes/class.ilWorkspaceAccessHandler.php";
            $password = ilWorkspaceAccessHandler::getSharedNodePassword($node_id);
            $input = md5($form->getInput("password"));
            if ($input == $password) {
                // we save password and start over
                ilWorkspaceAccessHandler::keepSharedSessionPassword($node_id, $input);
                
                $this->ctrl->setParameter($this, "item_ref_id", $node_id);
                $this->ctrl->redirect($this, "copyShared");
            } else {
                $item = $form->getItemByPostVar("password");
                $item->setAlert($lng->txt("wsp_invalid_password"));
                ilUtil::sendFailure($lng->txt("form_input_not_valid"));
            }
        }
        
        $form->setValuesByPost();
        $this->passwordForm($node_id, $form);
    }
    
    public static function _goto($a_target)
    {
        $id = explode("_", $a_target);
        
        $_GET["baseClass"] = "ilsharedresourceGUI";
        $_GET["wsp_id"] = $id[0];
        include("ilias.php");
        exit;
    }

    public function listSharedResourcesOfOtherUser()
    {
        $ilCtrl = $this->ctrl;

        include_once "Services/PersonalWorkspace/classes/class.ilWorkspaceShareTableGUI.php";
        $tbl = new ilWorkspaceShareTableGUI($this, "share", $this->getAccessHandler(), $this->node_id);
        $tbl->resetOffset();
        $tbl->resetFilter();
        $_POST["user"] = $_GET["user"];
        $tbl->writeFilterToSession();
        $this->share();
    }
}