class for ILIAS ViewLTI More...

Collaboration diagram for ilLTIViewGUI:

Public Member Functions
	__construct ()

	init ()
	Init LTI mode for lti authenticated users. More...

	executeCommand ()

	isActive ()

	initGUI ()

	getPostData ()

	getExternalCss ()

	getTitle ()

	getTitleForExitPage ()

	getShortTitle ()

	exitLti ()
	exit LTI session and if defined redirecting to returnUrl ToDo: Standard Template with delos ... More...

	logout (bool $force_ilias_logout=false)
	logout ILIAS and destroys Session and ilClientId cookie if no consumer is still open in the LTI User Session More...

	getCmdLink (String $cmd)

Static Public Member Functions
static	getInstance ()
	for compatiblity with ilLTIRouterGUI More...

Data Fields
const	CHECK_HTTP_REFERER = true
	contstants More...

ilLanguage	$lng = null
	public variables More...

Protected Member Functions
	getContextId ()

Private Member Functions
	isLTIUser ()
	get LTI Mode from Users->getAuthMode More...

	getSessionValue (string $sess_key)

	getCookieValue (string $cookie_key)

	removeContextFromSession (string $context_id)

	findEffectiveRefId (?string $url=null)
	Find effective ref_id for request. More...

Private Attributes
ILIAS DI Container	$dic = null
	private variables More...

int	$user = null

ilLogger	$log = null

string	$link_dir = ""

int	$effectiveRefId = null

ILIAS HTTP Wrapper WrapperFactory	$wrapper

ILIAS Refinery KindlyTo Group	$kindlyTo

ilLocatorGUI	$locator

Detailed Description

class for ILIAS ViewLTI

Author: Stefan Schneider <schne.nosp@m.ider.nosp@m.@hrz..nosp@m.uni-.nosp@m.marbu.nosp@m.rg.d.nosp@m.e

Version: $id$

ilLTIViewGUI: ilLTIRouterGUI

Definition at line 32 of file class.ilLTIViewGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilLTIViewGUI::__construct ( )

Definition at line 60 of file class.ilLTIViewGUI.php.

References $DIC, ilLoggerFactory\getLogger(), ILIAS\Repository\lng(), and ILIAS\Repository\locator().

     {
         global $DIC;
         $this->dic = $DIC;
         $this->log = ilLoggerFactory::getLogger('ltis');
         $this->lng = $this->dic->language();
         $this->lng->loadLanguageModule('lti');
         $this->wrapper = $DIC->http()->wrapper();
         $this->kindlyTo = $DIC->refinery()->kindlyTo();
         $this->locator = $DIC['ilLocator'];
     }

Here is the call graph for this function:

Member Function Documentation

◆ executeCommand()

ilLTIViewGUI::executeCommand ( )

Returns: void

Definition at line 113 of file class.ilLTIViewGUI.php.

References exitLti().

                                     : void
     {
         global $ilCtrl;
         $cmd = $ilCtrl->getCmd();
         switch ($cmd) {
             case 'exit':
                 $this->exitLti();
                 break;
         }
     }

Here is the call graph for this function:

◆ exitLti()

ilLTIViewGUI::exitLti ( )

exit LTI session and if defined redirecting to returnUrl ToDo: Standard Template with delos ...

Definition at line 348 of file class.ilLTIViewGUI.php.

References ilSession\clear(), getContextId(), getPostData(), ilSession\has(), ILIAS\UI\examples\Symbol\Glyph\Header\header(), ILIAS\Repository\lng(), logout(), and removeContextFromSession().

Referenced by executeCommand().

                              : void
     {
         $this->log->info("exitLTI");
         $force_ilias_logout = false;
         $context_id = $this->getContextId();
         if ($context_id == 0) {
             $this->log->warning("could not find any valid context_id!");
             $force_ilias_logout = true;
         }
         $post_data = $this->getPostData();
 
         $return_url = '';
         if (isset($post_data['launch_presentation_return_url'])) {
             $return_url = $post_data['launch_presentation_return_url'];
         }
         $this->removeContextFromSession((string) $context_id);
 
         if (ilSession::has('lti_' . $context_id . '_post_data')) {
             ilSession::clear('lti_' . $context_id . '_post_data');
             $this->log->debug('unset SESSION["' . 'lti_' . $context_id . '_post_data"]');
         }
 
         if (!isset($return_url) || $return_url === '') {
             $cc = $this->dic->globalScreen()->tool()->context()->current();
             $cc->addAdditionalData(LtiViewLayoutProvider::GS_EXIT_LTI, true);
             $ui_factory = $this->dic->ui()->factory();
             $renderer = $this->dic->ui()->renderer();
             $content = [
                 $ui_factory->messageBox()->info($this->lng->txt('lti_exited_info'))
             ];
             $tpl = $this->dic["tpl"];
             $tpl->setContent($renderer->render($content));
             $this->logout($force_ilias_logout);
             $tpl->printToStdout();
         } else {
             $this->logout($force_ilias_logout);
             header('Location: ' . $return_url);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ findEffectiveRefId()

ilLTIViewGUI::findEffectiveRefId ( ?string $url = null )

private

Find effective ref_id for request.

Parameters

string | null $url

Definition at line 458 of file class.ilLTIViewGUI.php.

References $url, ilSession\get(), ilSession\has(), ILIAS\Repository\int(), and ilSession\set().

Referenced by getContextId().

                                                             : void
     {
         $query = [];
         if ($url === null) {
             if ($this->wrapper->query()->has('ref_id')) {
                 $query['ref_id'] = $this->wrapper->query()->retrieve('ref_id', $this->kindlyTo->string());
             }
             if ($this->wrapper->query()->has('target')) {
                 $query['target'] = $this->wrapper->query()->retrieve('target', $this->kindlyTo->string());
             }
         } else {
             parse_str((string) parse_url($url, PHP_URL_QUERY), $query);
         }
         if (isset($query['ref_id']) && (int) $query['ref_id']) {
             $this->effectiveRefId = (int) $query['ref_id'];
             return;
         }
         if (ilSession::has('lti_init_target') && ilSession::get('lti_init_target') != "") {
             $target_arr = explode('_', ilSession::get('lti_init_target'));
             ilSession::set('lti_init_target', "");
         } else {
             if (isset($query['target'])) {
                 $target_arr = explode('_', (string) $query['target']);
             }
         }
         if (isset($target_arr[1]) and (int) $target_arr[1]) {
             $this->effectiveRefId = (int) $target_arr[1];
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCmdLink()

ilLTIViewGUI::getCmdLink ( String $cmd )

Parameters

String $cmd

Returns: String

Exceptions

ilCtrlException

Definition at line 418 of file class.ilLTIViewGUI.php.

References getContextId().

                                            : String
     {
         global $ilCtrl;
         $lti_context_id = $this->getContextId();
         $lti_context_id_param = ($lti_context_id != '') ? "&lti_context_id=" . $lti_context_id : '';
         $targetScript = "";
         return $this->link_dir . $targetScript . $this->dic->ctrl()->getLinkTargetByClass(array('illtiroutergui',strtolower(get_class($this))), $cmd) . "&baseClass=illtiroutergui" . $lti_context_id_param;
     }

Here is the call graph for this function:

◆ getContextId()

ilLTIViewGUI::getContextId ( )

protected

Returns: int|null

Definition at line 153 of file class.ilLTIViewGUI.php.

References $_SERVER, $DIC, $effectiveRefId, $path, $ref_id, ilObject\_lookupType(), CHECK_HTTP_REFERER, findEffectiveRefId(), ilSession\get(), ilSession\has(), ILIAS\Repository\int(), ILIAS\Repository\locator(), ilUtil\redirect(), and ilSession\set().

Referenced by exitLti(), getCmdLink(), and getPostData().

                                      : ?int
     {
         global $DIC;
 
         // forced lti_context_id for example request command in exitLTI
         if ($this->wrapper->query()->has('lti_context_id') &&
             $this->wrapper->query()->retrieve('lti_context_id', $this->kindlyTo->string()) !== '') {
             $contextId = (int) $this->wrapper->query()->retrieve('lti_context_id', $this->kindlyTo->int());
             $this->log->debug("find context_id by GET param: " . (string) $contextId);
             return $contextId;
         }
 
         $this->findEffectiveRefId();
         // ???
         if (
             (
                 $this->wrapper->query()->has('baseClass') &&
                 $this->wrapper->query()->retrieve('baseClass', $this->kindlyTo->string()) === 'ilDashboardGUI'
             )
             &&
             (
                 $this->wrapper->query()->has('cmd') &&
                 $this->wrapper->query()->retrieve('cmd', $this->kindlyTo->string()) === 'jumpToSelectedItems'
             )
         ) {
             $this->log->debug("jumpToSelectedItems");
             if (ilSession::get('lti_ref_id_at_init') != "") {
                 $this->effectiveRefId = (int) ilSession::get('lti_ref_id_at_init');
                 ilSession::set('lti_ref_id_at_init', "");
             }
         }
 
         $ref_id = $this->effectiveRefId;
         if (empty($ref_id)) {
             $this->log->debug("empty ref_id");
             return 0;
         }
 
         $this->log->debug("Effective ref_id: " . $ref_id);
         //check
         ilSession::set('lti_ref_id_at_init', (string) $ref_id);
 
 
         // context_id = ref_id in request
         if (ilSession::has('lti_' . $ref_id . '_post_data')) {
             $this->log->debug("lti context session exists for " . $ref_id);
             //            return $ref_id;
         }
         // sub item request
         $this->log->debug("ref_id not exists as context_id, walking tree backwards to find a valid context_id");
         $locator_items = $this->locator->getItems();
         if (is_array($locator_items) && count($locator_items) > 0) {
             for ($i = count($locator_items) - 1;$i >= 0;$i--) {
                 if (ilSession::has('lti_' . $locator_items[$i]['ref_id'] . '_post_data')) {
                     $this->log->debug("found valid ref_id in locator: " . $locator_items[$i]['ref_id']);
                     return $locator_items[$i]['ref_id'];
                 }
             }
         }
         $this->log->warning("no valid context_id found for ref_id request: " . $ref_id);
 
         if (ilLTIViewGUI::CHECK_HTTP_REFERER) {
             $ref_id = $this->effectiveRefId;
             $obj_type = ilObject::_lookupType($ref_id, true);
             $context_id = 0;
             $referer = 0;
 
             // first try to get real http referer
             if (isset($_SERVER['HTTP_REFERER'])) {
                 $this->findEffectiveRefId($_SERVER['HTTP_REFERER']);
             } else { // only fallback and not reliable on multiple browser LTi contexts
                 if (ilSession::has('referer_ref_id')) {
                     $this->effectiveRefId = ilSession::get('referer_ref_id');
                 }
             }
 
             $referer = (int) $this->effectiveRefId;
 
             if ($referer > 0) {
                 if (ilSession::has('lti_' . $referer . '_post_data')) {
                     $ref_id = $referer;
                     $context_id = $referer;
                     $obj_type = ilObject::_lookupType($ref_id, true);
                     $this->log->debug("referer obj_type: " . $obj_type);
                 } else {
                     $this->log->debug("search tree of referer...");
                     if ($this->dic->repositoryTree()->isInTree($referer)) {
                         $path = $this->dic->repositoryTree()->getPathId($referer);
                         for ($i = count($path) - 1;$i >= 0;$i--) {
                             if (ilSession::has('lti_' . $path[$i] . '_post_data')) {
                                 // redirect to referer, because it is valid
                                 $ref_id = $referer;
                                 $context_id = $path[$i];
                                 $obj_type = ilObject::_lookupType($ref_id, true);
                                 break;
                             }
                         }
                     }
                 }
             }
 
             if ($ref_id > 0 && $obj_type != '') {
                 if (
                     (
                         $this->wrapper->query()->has('baseClass') &&
                         $this->wrapper->query()->retrieve('baseClass', $this->kindlyTo->string()) === 'ilDashboardGUI'
                     )
                     &&
                     (
                         $this->wrapper->query()->has('cmdClass') &&
                         $this->wrapper->query()->retrieve('cmdClass', $this->kindlyTo->string()) === 'ilpersonalprofilegui'
                     )
                 ) {
                     return $context_id;
                 }
                 //                $this->dic->ui()->mainTemplate()->setOnScreenMessage('failure', $this->lng->txt('permission_denied'), true);
                 $redirect = $this->link_dir . "goto.php?target=" . $obj_type . "_" . $ref_id . "&lti_context_id=" . $context_id;
                 $this->log->debug("redirect: " . $redirect);
                 ilUtil::redirect($redirect);
             }
         }
         $lti_context_ids = ilSession::get('lti_context_ids');
         if (is_array($lti_context_ids) && count($lti_context_ids) > 0) {
             if (count($lti_context_ids) == 1) {
                 $this->log->debug("using context_id from only LTI session");
                 return $lti_context_ids[0];
             } else {
                 $this->log->warning("Multiple LTI sessions exists. The context_id can not be clearly detected");
             }
         }
         return null;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCookieValue()

ilLTIViewGUI::getCookieValue ( string $cookie_key )

private

Definition at line 436 of file class.ilLTIViewGUI.php.

                                                        : string
     {
         if ($this->dic->wrapper->cookie()->has($cookie_key) && $this->dic->wrapper->cookie()->retrieve($cookie_key, $this->dic->refinery()->kindlyTo()->string() != '')) {
             return $this->dic->wrapper->cookie()->retrieve($cookie_key, $this->dic->refinery()->kindlyTo()->string());
         } else {
             return '';
         }
     }

◆ getExternalCss()

ilLTIViewGUI::getExternalCss ( )

Returns: string

Definition at line 307 of file class.ilLTIViewGUI.php.

References getPostData().

                                     : string
     {
         $post_data = $this->getPostData();
         if ($post_data !== null) {
             return (isset($post_data['launch_presentation_css_url'])) ? $post_data['launch_presentation_css_url'] : '';
         }
         return '';
     }

Here is the call graph for this function:

◆ getInstance()

static ilLTIViewGUI::getInstance ( )

static

for compatiblity with ilLTIRouterGUI

Returns: mixed

Definition at line 89 of file class.ilLTIViewGUI.php.

References $DIC.

     {
         global $DIC;
         return $DIC["lti"];
     }

◆ getPostData()

ilLTIViewGUI::getPostData ( )

Returns: array|null

Definition at line 289 of file class.ilLTIViewGUI.php.

References ilSession\get(), and getContextId().

Referenced by exitLti(), getExternalCss(), and getTitle().

                                  : ?array
     {
         $context_id = $this->getContextId();
         if ($context_id == 0) {
             $this->log->warning("could not find any valid context_id!");
             return null;
         }
         $post_data = ilSession::get('lti_' . $context_id . '_post_data');
         if (!is_array($post_data)) {
             $this->log->warning("no session post_data: " . "lti_" . $context_id . "_post_data");
             return null;
         }
         return $post_data;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSessionValue()

ilLTIViewGUI::getSessionValue ( string $sess_key )

private

Definition at line 427 of file class.ilLTIViewGUI.php.

References ilSession\get(), and ilSession\has().

                                                       : string
     {
         if (ilSession::has($sess_key) && ilSession::get($sess_key) != '') {
             return ilSession::get($sess_key);
         } else {
             return '';
         }
     }

Here is the call graph for this function:

◆ getShortTitle()

ilLTIViewGUI::getShortTitle ( )

Returns: string

Definition at line 339 of file class.ilLTIViewGUI.php.

References ILIAS\Repository\lng().

                                    : string
     {
         return $this->lng->txt('lti_mode');
     }

Here is the call graph for this function:

◆ getTitle()

ilLTIViewGUI::getTitle ( )

Returns: string

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

References getPostData().

                               : string
     {
         $post_data = $this->getPostData();
         if ($post_data !== null) {
             return (isset($post_data['resource_link_title'])) ? "LTI - " . $post_data['resource_link_title'] : "LTI";
         }
         return "LTI";
     }

Here is the call graph for this function:

◆ getTitleForExitPage()

ilLTIViewGUI::getTitleForExitPage ( )

Returns: string

Definition at line 331 of file class.ilLTIViewGUI.php.

References ILIAS\Repository\lng().

                                          : string
     {
         return $this->lng->txt('lti_exited');
     }

Here is the call graph for this function:

◆ init()

ilLTIViewGUI::init ( )

Init LTI mode for lti authenticated users.

Definition at line 75 of file class.ilLTIViewGUI.php.

References $context, initGUI(), and isLTIUser().

                           : void
     {
         $this->link_dir = (defined("ILIAS_MODULE")) ? "../" : "";
         if ($this->isLTIUser()) {
             $context = $this->dic->globalScreen()->tool()->context();
             $context->claim()->lti();
             $this->initGUI();
         }
     }

Here is the call graph for this function:

◆ initGUI()

ilLTIViewGUI::initGUI ( )

Returns: void

Definition at line 135 of file class.ilLTIViewGUI.php.

Referenced by init().

                              : void
     {
         $this->log->debug("initGUI");
         $baseclass = '';
         if ($this->wrapper->query()->has('baseClass')) {
             $baseclass = strtolower($this->wrapper->query()->retrieve('baseClass', $this->kindlyTo->string()));
         }
         if ($this->wrapper->query()->has('cmdClass')) {
             $cmdclass = strtolower($this->wrapper->query()->retrieve('cmdClass', $this->kindlyTo->string()));
         }
         if ($baseclass == 'illtiroutergui') {
             return;
         }
     }

Here is the caller graph for this function:

◆ isActive()

ilLTIViewGUI::isActive ( )

Returns: bool

Definition at line 127 of file class.ilLTIViewGUI.php.

References isLTIUser().

                               : bool
     {
         return $this->isLTIUser();
     }

Here is the call graph for this function:

◆ isLTIUser()

ilLTIViewGUI::isLTIUser ( )

private

get LTI Mode from Users->getAuthMode

Returns: bool

Definition at line 99 of file class.ilLTIViewGUI.php.

Referenced by init(), and isActive().

                                 : bool
     {
         if (!$this->dic->user() instanceof ilObjUser) {
             return false;
         }
         if ($this->dic->user()->getAuthMode() == null) {
             return false;
         }
         return (strpos($this->dic->user()->getAuthMode(), 'lti_') === 0);
     }

Here is the caller graph for this function:

◆ logout()

ilLTIViewGUI::logout ( bool $force_ilias_logout = false )

logout ILIAS and destroys Session and ilClientId cookie if no consumer is still open in the LTI User Session

Definition at line 391 of file class.ilLTIViewGUI.php.

References ilAuthUtils\AUTH_LOCAL, ilSession\get(), and ilUtil\setCookie().

Referenced by exitLti().

                                                             : void
     {
         if ($force_ilias_logout) {
             $this->log->warning("forcing logout ilias session, maybe a broken LTI context");
         } else {
             if (is_array(ilSession::get('lti_context_ids')) && count(ilSession::get('lti_context_ids')) > 0) {
                 $this->log->debug("there is another valid consumer session: ilias session logout refused.");
                 return;
             }
         }
         $this->log->info("logout");
         $this->dic->user()->setAuthMode((string) ilAuthUtils::AUTH_LOCAL);
         //ilSession::setClosingContext(ilSession::SESSION_CLOSE_USER); // needed?
         $auth = $this->dic['ilAuthSession'];
         //$auth->logout(); // needed?
         //        $auth->setExpired($auth::SESSION_AUTH_EXPIRED, ilAuthStatus::STATUS_UNDEFINED);
         $auth->setExpired(true);
         session_destroy();
         ilUtil::setCookie("ilClientId", "");
         ilUtil::setCookie("PHPSESSID", "");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ removeContextFromSession()

ilLTIViewGUI::removeContextFromSession ( string $context_id )

private

Definition at line 445 of file class.ilLTIViewGUI.php.

References ilSession\get(), and ilSession\set().

Referenced by exitLti().

                                                                  : void
     {
         $lti_context_ids = ilSession::get('lti_context_ids');
         if (is_array($lti_context_ids) && in_array($context_id, $lti_context_ids)) {
             array_splice($lti_context_ids, array_search($context_id, $lti_context_ids), 1);
             ilSession::set('lti_context_ids', $lti_context_ids);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $dic

ILIAS DI Container ilLTIViewGUI::$dic = null

private

private variables

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

◆ $effectiveRefId

int ilLTIViewGUI::$effectiveRefId = null

private

Definition at line 47 of file class.ilLTIViewGUI.php.

Referenced by getContextId().

◆ $kindlyTo

ILIAS Refinery KindlyTo Group ilLTIViewGUI::$kindlyTo

private

Definition at line 49 of file class.ilLTIViewGUI.php.

◆ $link_dir

string ilLTIViewGUI::$link_dir = ""

private

Definition at line 45 of file class.ilLTIViewGUI.php.

◆ $lng

ilLanguage ilLTIViewGUI::$lng = null

public variables

Definition at line 55 of file class.ilLTIViewGUI.php.

◆ $locator

ilLocatorGUI ilLTIViewGUI::$locator

private

Definition at line 50 of file class.ilLTIViewGUI.php.

◆ $log

ilLogger ilLTIViewGUI::$log = null

private

Definition at line 44 of file class.ilLTIViewGUI.php.

◆ $user

int ilLTIViewGUI::$user = null

private

Definition at line 43 of file class.ilLTIViewGUI.php.

◆ $wrapper

ILIAS HTTP Wrapper WrapperFactory ilLTIViewGUI::$wrapper

private

Definition at line 48 of file class.ilLTIViewGUI.php.

◆ CHECK_HTTP_REFERER

const ilLTIViewGUI::CHECK_HTTP_REFERER = true

contstants

Definition at line 37 of file class.ilLTIViewGUI.php.

Referenced by getContextId().

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

Services/LTI/classes/class.ilLTIViewGUI.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ executeCommand()

◆ exitLti()

◆ findEffectiveRefId()

◆ getCmdLink()

◆ getContextId()

◆ getCookieValue()

◆ getExternalCss()

◆ getInstance()

◆ getPostData()

◆ getSessionValue()

◆ getShortTitle()

◆ getTitle()

◆ getTitleForExitPage()

◆ init()

◆ initGUI()

◆ isActive()

◆ isLTIUser()

◆ logout()

◆ removeContextFromSession()

Field Documentation

◆ $dic

◆ $effectiveRefId

◆ $kindlyTo

◆ $link_dir

◆ $lng

◆ $locator

◆ $log

◆ $user

◆ $wrapper

◆ CHECK_HTTP_REFERER