Workspace deep link handler GUI. More...

Inheritance diagram for ilSharedResourceGUI:

Collaboration diagram for ilSharedResourceGUI:

Public Member Functions
	__construct ()

	executeCommand ()

Static Public Member Functions
static	hasAccess (int $a_node_id, bool $a_is_portfolio=false)

Protected Member Functions
	process ()

	redirectToResource (int $a_node_id, bool $a_is_portfolio=false)

	passwordForm (?ilPropertyFormGUI $form=null)

	initPasswordForm ()

	cancelPassword ()

	checkPassword ()

Protected Attributes
ilCtrl	$ctrl

ilGlobalTemplateInterface	$tpl

ilLocatorGUI	$locator

ilObjUser	$user

ilLanguage	$lng

ilObjectDefinition	$obj_definition

ilTabsGUI	$tabs

int	$node_id

int	$portfolio_id

StandardGUIRequest	$request

Detailed Description

Workspace deep link handler GUI.

Author: Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om ilSharedResourceGUI: ilObjBlogGUI, ilObjFileGUI, ilObjTestVerificationGUI ilSharedResourceGUI: ilObjExerciseVerificationGUI, ilObjLinkResourceGUI ilSharedResourceGUI: ilObjPortfolioGUI

Definition at line 29 of file class.ilSharedResourceGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilSharedResourceGUI::__construct ( )

Definition at line 42 of file class.ilSharedResourceGUI.php.

References $DIC, ILIAS\Repository\ctrl(), ILIAS\PersonalWorkspace\StandardGUIRequest\getWspId(), ILIAS\Repository\lng(), ILIAS\Repository\locator(), ILIAS\Repository\tabs(), and ILIAS\Repository\user().

     {
         global $DIC;
 
         $this->ctrl = $DIC->ctrl();
         $this->tpl = $DIC->ui()->mainTemplate();
         $this->locator = $DIC["ilLocator"];
         $this->user = $DIC->user();
         $this->lng = $DIC->language();
         $this->obj_definition = $DIC["objDefinition"];
         $this->tabs = $DIC->tabs();
         $ilCtrl = $DIC->ctrl();
 
         $this->request = new StandardGUIRequest(
             $DIC->http(),
             $DIC->refinery()
         );
 
         $ilCtrl->saveParameter($this, "wsp_id");
         $ilCtrl->saveParameter($this, "prt_id");
         $this->node_id = $this->request->getWspId();
         $this->portfolio_id = $this->request->getPrtId();
     }

Here is the call graph for this function:

Member Function Documentation

◆ cancelPassword()

ilSharedResourceGUI::cancelPassword ( )

protected

Definition at line 335 of file class.ilSharedResourceGUI.php.

References $ilUser, $user, ANONYMOUS_USER_ID, ilWorkspaceTree\lookupOwner(), and ilUtil\redirect().

                                        : void
     {
         $ilUser = $this->user;
 
         if ($ilUser->getId() && $ilUser->getId() != ANONYMOUS_USER_ID) {
             if ($this->node_id) {
                 $tree = new ilWorkspaceTree($ilUser->getId());
                 $owner = $tree->lookupOwner($this->node_id);
                 ilUtil::redirect("ilias.php?baseClass=ilDashboardGUI&cmd=jumpToWorkspace&dsh=" . $owner);
             } else {
                 $prtf = new ilObjPortfolio($this->portfolio_id, false);
                 $owner = $prtf->getOwner();
                 ilUtil::redirect("ilias.php?baseClass=ilDashboardGUI&cmd=jumpToPortfolio&dsh=" . $owner);
             }
         }
     }

Here is the call graph for this function:

◆ checkPassword()

ilSharedResourceGUI::checkPassword ( )

protected

Definition at line 352 of file class.ilSharedResourceGUI.php.

References $lng, ilWorkspaceAccessHandler\getSharedNodePassword(), ilPortfolioAccessHandler\getSharedNodePassword(), initPasswordForm(), ilWorkspaceAccessHandler\keepSharedSessionPassword(), ilPortfolioAccessHandler\keepSharedSessionPassword(), ilLanguage\loadLanguageModule(), passwordForm(), redirectToResource(), and ilLanguage\txt().

                                       : void
     {
         $lng = $this->lng;
 
         $lng->loadLanguageModule("wsp");
 
         $form = $this->initPasswordForm();
         if ($form->checkInput()) {
             $input = md5($form->getInput("password"));
             if ($this->node_id) {
                 $password = ilWorkspaceAccessHandler::getSharedNodePassword($this->node_id);
             } else {
                 $password = ilPortfolioAccessHandler::getSharedNodePassword($this->portfolio_id);
             }
             if ($input == $password) {
                 if ($this->node_id) {
                     ilWorkspaceAccessHandler::keepSharedSessionPassword($this->node_id, $input);
                     $this->redirectToResource($this->node_id);
                 } else {
                     ilPortfolioAccessHandler::keepSharedSessionPassword($this->portfolio_id, $input);
                     $this->redirectToResource($this->portfolio_id, true);
                 }
             } else {
                 $item = $form->getItemByPostVar("password");
                 $item->setAlert($lng->txt("wsp_invalid_password"));
                 $this->tpl->setOnScreenMessage('failure', $lng->txt("form_input_not_valid"));
             }
         }
 
         $form->setValuesByPost();
         $this->passwordForm($form);
     }

Here is the call graph for this function:

◆ executeCommand()

ilSharedResourceGUI::executeCommand ( )

Definition at line 66 of file class.ilSharedResourceGUI.php.

References $ctrl, $ilUser, $lng, $locator, $tpl, $user, ilObject\_lookupTitle(), ANONYMOUS_USER_ID, ilUserUtil\getNamePresentation(), ilLanguage\loadLanguageModule(), ilGlobalTemplateInterface\loadStandardTemplate(), ilGlobalTemplateInterface\printToStdout(), ilGlobalTemplateInterface\setLocator(), ilLanguage\txt(), and ilObject2GUI\WORKSPACE_NODE_ID.

                                     : void
     {
         $ilCtrl = $this->ctrl;
         $tpl = $this->tpl;
         $ilLocator = $this->locator;
         $ilUser = $this->user;
         $lng = $this->lng;
 
         $next_class = $ilCtrl->getNextClass($this);
         $cmd = $ilCtrl->getCmd();
 
         $tpl->loadStandardTemplate();
 
         // #12096
         if ($ilUser->getId() != ANONYMOUS_USER_ID &&
             $next_class &&
             !in_array($next_class, array("ilobjbloggui", "ilobjportfoliogui"))) {
             $tree = new ilWorkspaceTree($ilUser->getId());
             $access_handler = new ilWorkspaceAccessHandler($tree);
             $owner_id = $tree->lookupOwner($this->node_id);
             $obj_id = $tree->lookupObjectId($this->node_id);
 
             $lng->loadLanguageModule("wsp");
 
             // see ilPersonalWorkspaceGUI
             if ($owner_id != $ilUser->getId()) {
                 $ilCtrl->setParameterByClass("ildashboardgui", "dsh", $owner_id);
                 $link = $ilCtrl->getLinkTargetByClass("ildashboardgui", "jumptoworkspace");
                 $ilLocator->addItem($lng->txt("wsp_tab_shared"), $link);
 
                 $ilLocator->addItem(ilUserUtil::getNamePresentation($owner_id), $link);
             } else {
                 $link = $ilCtrl->getLinkTargetByClass("ildashboardgui", "jumptoworkspace");
                 $ilLocator->addItem($lng->txt("wsp_tab_personal"), $link);
             }
 
             $link = $access_handler->getGotoLink($this->node_id, $obj_id);
             $ilLocator->addItem(ilObject::_lookupTitle($obj_id), $link);
             $tpl->setLocator();
         }
 
         switch ($next_class) {
             case "ilobjbloggui":
                 $bgui = new ilObjBlogGUI($this->node_id, ilObject2GUI::WORKSPACE_NODE_ID);
                 $ilCtrl->forwardCommand($bgui);
                 break;
 
             case "ilobjfilegui":
                 $fgui = new ilObjFileGUI($this->node_id, ilObject2GUI::WORKSPACE_NODE_ID);
                 $ilCtrl->forwardCommand($fgui);
                 break;
 
             case "ilobjtestverificationgui":
                 $tgui = new ilObjTestVerificationGUI($this->node_id, ilObject2GUI::WORKSPACE_NODE_ID);
                 $ilCtrl->forwardCommand($tgui);
                 break;
 
             case "ilobjexerciseverificationgui":
                 $egui = new ilObjExerciseVerificationGUI($this->node_id, ilObject2GUI::WORKSPACE_NODE_ID);
                 $ilCtrl->forwardCommand($egui);
                 break;
 
             case "ilobjlinkresourcegui":
                 $lgui = new ilObjLinkResourceGUI($this->node_id, ilObject2GUI::WORKSPACE_NODE_ID);
                 $ilCtrl->forwardCommand($lgui);
                 break;
 
             case "ilobjportfoliogui":
                 $pgui = new ilObjPortfolioGUI($this->portfolio_id);
                 $ilCtrl->forwardCommand($pgui);
                 break;
 
             default:
                 if (!$cmd) {
                     $cmd = "process";
                 }
                 $this->$cmd();
         }
 
         $tpl->printToStdout();
     }

Here is the call graph for this function:

◆ hasAccess()

static ilSharedResourceGUI::hasAccess	(	int	$a_node_id,
		bool	$a_is_portfolio = `false`
	)

static

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

References $DIC, $ilSetting, $ilUser, ilWorkspaceAccessHandler\_getPermissions(), ilPortfolioAccessHandler\_getPermissions(), ANONYMOUS_USER_ID, ilWorkspaceAccessGUI\PERMISSION_ALL, ilWorkspaceAccessGUI\PERMISSION_ALL_PASSWORD, and ilUtil\redirect().

Referenced by ilObjPortfolioAccess\_checkGoto(), ilObjExerciseVerificationAccess\_checkGoto(), ilObjTestVerificationAccess\_checkGoto(), ilObjCourseVerificationAccess\_checkGoto(), ilObjSCORMVerificationAccess\_checkGoto(), ilObjLTIConsumerVerificationAccess\_checkGoto(), ilObjCmiXapiVerificationAccess\_checkGoto(), ilObjBlogAccess\_checkGoto(), and ilObjFileAccess\_checkGoto().

      : bool {
         global $DIC;
 
         $ilUser = $DIC->user();
         $ilSetting = $DIC->settings();
 
         // if we have current user - check with normal access handler
         if ($ilUser->getId() != ANONYMOUS_USER_ID) {
             if (!$a_is_portfolio) {
                 $tree = new ilWorkspaceTree($ilUser->getId());
                 $access_handler = new ilWorkspaceAccessHandler($tree);
             } else {
                 $access_handler = new ilPortfolioAccessHandler();
             }
             if ($access_handler->checkAccess("read", "", $a_node_id)) {
                 return true;
             }
         }
 
         if (!$a_is_portfolio) {
             $shared = ilWorkspaceAccessHandler::_getPermissions($a_node_id);
         } else {
             // #12059
             if (!$ilSetting->get('user_portfolios')) {
                 return false;
             }
 
             // #12039
             $prtf = new ilObjPortfolio($a_node_id, false);
             if (!$prtf->isOnline()) {
                 return false;
             }
 
             $shared = ilPortfolioAccessHandler::_getPermissions($a_node_id);
         }
 
         // object is "public"
         if (in_array(ilWorkspaceAccessGUI::PERMISSION_ALL, $shared)) {
             return true;
         }
 
         // password protected
         if (in_array(ilWorkspaceAccessGUI::PERMISSION_ALL_PASSWORD, $shared)) {
             if (!$a_is_portfolio) {
                 ilUtil::redirect("ilias.php?baseClass=ilSharedResourceGUI&cmd=passwordForm&wsp_id=" . $a_node_id);
             } else {
                 ilUtil::redirect("ilias.php?baseClass=ilSharedResourceGUI&cmd=passwordForm&prt_id=" . $a_node_id);
             }
         }
 
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initPasswordForm()

ilSharedResourceGUI::initPasswordForm ( )

protected

Definition at line 302 of file class.ilSharedResourceGUI.php.

References $ctrl, $ilUser, $lng, $tabs, $user, ilObject\_lookupTitle(), ANONYMOUS_USER_ID, ilWorkspaceAccessHandler\getObjectDataFromNode(), ilPasswordInputGUI\setRetype(), and ilLanguage\txt().

Referenced by checkPassword(), and passwordForm().

                                          : ilPropertyFormGUI
     {
         $ilCtrl = $this->ctrl;
         $lng = $this->lng;
         $ilUser = $this->user;
         $ilTabs = $this->tabs;
 
         if ($this->node_id) {
             $object_data = ilWorkspaceAccessHandler::getObjectDataFromNode($this->node_id);
         } else {
             $object_data["title"] = ilObject::_lookupTitle($this->portfolio_id);
         }
 
         $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); // #17757
         $form->addItem($password);
 
         $form->addCommandButton("checkPassword", $lng->txt("submit"));
 
         if ($ilUser->getId() && $ilUser->getId() != ANONYMOUS_USER_ID) {
             $ilTabs->setBackTarget($lng->txt("back"), $ilCtrl->getLinkTarget($this, "cancelPassword"));
             $form->addCommandButton("cancelPassword", $lng->txt("cancel"));
         }
 
         return $form;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ passwordForm()

ilSharedResourceGUI::passwordForm ( ?ilPropertyFormGUI $form = null )

protected

Definition at line 285 of file class.ilSharedResourceGUI.php.

References $lng, $tpl, initPasswordForm(), ilLanguage\loadLanguageModule(), ilGlobalTemplateInterface\setContent(), ilGlobalTemplateInterface\setDescription(), ilGlobalTemplateInterface\setTitle(), and ilLanguage\txt().

Referenced by checkPassword().

                                                                     : void
     {
         $tpl = $this->tpl;
         $lng = $this->lng;
 
         $lng->loadLanguageModule("wsp");
 
         $tpl->setTitle($lng->txt("wsp_password_protected_resource"));
         $tpl->setDescription($lng->txt("wsp_password_protected_resource_info"));
 
         if (!$form) {
             $form = $this->initPasswordForm();
         }
 
         $tpl->setContent($form->getHTML());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ process()

ilSharedResourceGUI::process ( )

protected

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

References redirectToResource().

                                 : void
     {
         if (!$this->node_id && !$this->portfolio_id) {
             throw new ilPermissionException("invalid call");
         }
 
         // if already logged in, we need to re-check for public password
         if ($this->node_id) {
             if (!self::hasAccess($this->node_id)) {
                 throw new ilPermissionException("no permission");
             }
             $this->redirectToResource($this->node_id);
         } else {
             if (!self::hasAccess($this->portfolio_id, true)) {
                 throw new ilPermissionException("no permission");
             }
             $this->redirectToResource($this->portfolio_id, true);
         }
     }

Here is the call graph for this function:

◆ redirectToResource()

ilSharedResourceGUI::redirectToResource	(	int	$a_node_id,
		bool	$a_is_portfolio = `false`
	)

protected

Definition at line 224 of file class.ilSharedResourceGUI.php.

References $ctrl, $obj_definition, ilObject\_lookupType(), exit, and ilWorkspaceAccessHandler\getObjectDataFromNode().

Referenced by checkPassword(), and process().

      : void {
         $ilCtrl = $this->ctrl;
         $objDefinition = $this->obj_definition;
 
         if (!$a_is_portfolio) {
             $object_data = ilWorkspaceAccessHandler::getObjectDataFromNode($a_node_id);
             if (!$object_data["obj_id"]) {
                 throw new ilPermissionException("invalid object");
             }
         } else {
             if (!ilObject::_lookupType($a_node_id, false)) {
                 throw new ilPermissionException("invalid object");
             }
             $object_data["obj_id"] = $a_node_id;
             $object_data["type"] = "prtf";
         }
 
         $class = $objDefinition->getClassName($object_data["type"]);
         $gui = "ilobj" . $class . "gui";
 
         switch ($object_data["type"]) {
             case "blog":
                 $ilCtrl->setParameterByClass($gui, "wsp_id", $a_node_id);
                 $ilCtrl->setParameterByClass($gui, "gtp", $this->request->getBlogGtp());
                 $ilCtrl->setParameterByClass($gui, "edt", $this->request->getBlogEdt());
                 $ilCtrl->redirectByClass($gui, "preview");
                 break;
 
             case "tstv":
             case "excv":
             case "crsv":
             case "scov":
             case "cmxv":
             case "ltiv":
                 $ilCtrl->setParameterByClass($gui, "wsp_id", $a_node_id);
                 $ilCtrl->redirectByClass($gui, "deliver");
                 break;
 
             case "file":
             case "webr":
                 $ilCtrl->setParameterByClass($gui, "wsp_id", $a_node_id);
                 $ilCtrl->redirectByClass($gui);
                 break;
 
             case "prtf":
                 $ilCtrl->setParameterByClass($gui, "prt_id", $a_node_id);
                 $ilCtrl->setParameterByClass($gui, "gtp", $this->request->getBlogGtp());
                 if ($this->request->getBackUrl()) {
                     $ilCtrl->setParameterByClass($gui, "back_url", rawurlencode($this->request->getBackUrl()));
                 }
                 $ilCtrl->redirectByClass($gui, "preview");
                 break;
 
             default:
                 exit("invalid object type");
         }
     }