ilLTIViewGUI Class Reference

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 ()
	getContextId ()
	getPostData ()
	getExternalCss ()
	getTitle ()
	getTitleForExitPage ()
	getShortTitle ()
	exitLti ()
	exit LTI session and if defined redirecting to returnUrl ToDo: Standard Template with delos ... More...
	logout ($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...
	$lng = null
	public variables More...

Private Member Functions
	isLTIUser ()
	get LTI Mode from Users->getAuthMode More...
	getSessionValue (String $sess_key)
	getCookieValue (String $cookie_key)
	removeContextFromSession ($context_id)
	findEffectiveRefId ($url=null)
	Find effective ref_id for request. More...

Private Attributes
	$dic = null
	private variables More...
	$user = null
	$log = null
	$link_dir = ""

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 35 of file class.ilLTIViewGUI.php.

Constructor & Destructor Documentation

__construct()

ilLTIViewGUI::__construct

(

)

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

References $DIC.

    {
        global $DIC;
        $this->dic = $DIC;
        $this->log = $this->dic->logger()->lti();
        $this->lng = $this->dic->language();
        $this->lng->loadLanguageModule('lti');
    }

Member Function Documentation

executeCommand()

ilLTIViewGUI::executeCommand

(

)

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

References $ilCtrl, and exitLti().

    {
        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 266 of file class.ilLTIViewGUI.php.

References $_SESSION, $tpl, getContextId(), getPostData(), logout(), and removeContextFromSession().

Referenced by executeCommand().

    {
        $this->dic->logger()->lti()->info("exitLTI");
        $force_ilias_logout = false;
        $context_id = $this->getContextId();
        if ($context_id == '') {
            $this->log->warning("could not find any valid context_id!");
            $force_ilias_logout = true;
        }
                $post_data = $this->getPostData();
                $return_url = ($post_data !== null) ? $post_data['launch_presentation_return_url'] : '';
        $this->removeContextFromSession($context_id);
       
                if (isset($_SESSION['lti_' . $context_id . '_post_data'])) {
                        unset($_SESSION['lti_' . $context_id . '_post_data']);
                        $this->dic->logger()->lti()->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 (   $url = null )

private

Find effective ref_id for request.

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

References $_GET, $query, $target_arr, and $url.

Referenced by getContextId().

    {
        if ($url === null) {
            $query = $_GET;
        }
        else {
            parse_str(parse_url($url, PHP_URL_QUERY),$query);
        } 
        if ((int) $query['ref_id']) {
            return (int) $query['ref_id'];
        }
        $target_arr = explode('_', (string) $query['target']);
        if (isset($target_arr[1]) and (int) $target_arr[1]) {
            return (int) $target_arr[1];
        }
        return '';
    }

Here is the caller graph for this function:

getCmdLink()

ilLTIViewGUI::getCmdLink

(

String

$cmd

)

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

References $ilCtrl, and getContextId().

                                            : String
    {
        global $ilCtrl;
                $lti_context_id = $this->getContextId();
                $lti_context_id_param = ($lti_context_id  != '') ? "&lti_context_id=".$lti_context_id : '';
        $targetScript = ($ilCtrl->getTargetScript() !== 'ilias.php') ? "ilias.php" : "";
                return $this->link_dir.$targetScript.$ilCtrl->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

(

)

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

References $_GET, $_SERVER, $_SESSION, $i, ilObject\_lookupType(), CHECK_HTTP_REFERER, findEffectiveRefId(), ilUtil\redirect(), and ilUtil\sendFailure().

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

                                       {
        global $ilLocator;

        // forced lti_context_id for example request command in exitLTI
        if (isset($_GET['lti_context_id']) && $_GET['lti_context_id'] !== '') {
            $this->log->debug("find context_id by GET param: " . $_GET['lti_context_id']);
                        return $_GET['lti_context_id'];
        }
        
        $ref_id = $this->findEffectiveRefId();
        $this->log->debug("Effective ref_id: ". $ref_id);
        // context_id = ref_id in request
        if (isset($_SESSION['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 = $ilLocator->getItems();
                if (is_array($locator_items) && count($locator_items) > 0) {
            for ($i = count($locator_items)-1;$i>=0;$i--) {
                if (isset($_SESSION['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 = '';
            $obj_type = '';
            $context_id = '';
            $referer = '';

            // first try to get real http referer
            if (isset($_SERVER['HTTP_REFERER'])) {
                $referer = $this->findEffectiveRefId($_SERVER['HTTP_REFERER']);
            }
            else { // only fallback and not reliable on multiple browser LTi contexts
                if (isset($_SESSION['referer_ref_id'])) {
                    $referer = $_SESSION['referer_ref_id'];
                }
            }

            if ($referer != '') {
                if (isset($_SESSION['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 (isset($_SESSION['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 != '' && $obj_type != '') {
                if ((isset($_GET['baseClass']) && $_GET['baseClass'] === 'ilDashboardGUI')
                    && (isset($_GET['cmdClass']) && $_GET['cmdClass'] === 'ilpersonalprofilegui')) {
                    return $context_id;
                }
                ilUtil::sendFailure($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 = $_SESSION['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 '';
    }

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 345 of file class.ilLTIViewGUI.php.

References $_COOKIE.

                                                            : String
        {
                if (isset($_COOKIE[$cookie_key]) && $_COOKIE[$cookie_key] != '') {
                        return $_COOKIE[$cookie_key];
                }
                else {
                        return '';
                }
        }

getExternalCss()

ilLTIViewGUI::getExternalCss

(

)

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

References getPostData().

                                         {
                $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

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

References $DIC.

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

getPostData()

ilLTIViewGUI::getPostData

(

)

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

References $_SESSION, and getContextId().

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

                                      {
        $context_id = $this->getContextId();
        if ($context_id == '') {
            $this->log->warning("could not find any valid context_id!");
            return null;
        }
                $post_data = $_SESSION['lti_' . $this->getContextId() . '_post_data'];
                if (!is_array($post_data)) {
                        $this->log->warning("no session post_data: " . "lti_" . $this->getContextId() . "_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 336 of file class.ilLTIViewGUI.php.

References $_SESSION.

                                                       : String
    {
        if (isset($_SESSION[$sess_key]) && $_SESSION[$sess_key] != '') {
            return $_SESSION[$sess_key];
        } else {
            return '';
        }
    }

getShortTitle()

ilLTIViewGUI::getShortTitle

(

)

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

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

getTitle()

ilLTIViewGUI::getTitle

(

)

Definition at line 243 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

(

)

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

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

init()

ilLTIViewGUI::init

(

)

Init LTI mode for lti authenticated users.

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

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

    {
        $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

(

)

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

References $_GET.

Referenced by init().

    {
        $this->log->debug("initGUI");
        $baseclass = strtolower($_GET['baseClass']);
        $cmdclass = strtolower($_GET['cmdClass']);
                switch ($baseclass)
                {
                        case 'illtiroutergui' :
                                return;
                                break;
                }
        }

Here is the caller graph for this function:

isActive()

ilLTIViewGUI::isActive

(

)

Definition at line 110 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

boolean

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

Referenced by init(), and isActive().

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

Here is the caller graph for this function:

logout()

ilLTIViewGUI::logout

(

$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 304 of file class.ilLTIViewGUI.php.

References $_COOKIE, $_SESSION, $auth, $client_id, $GLOBALS, AUTH_LOCAL, ilUtil\setCookie(), and ilAuthStatus\STATUS_UNDEFINED.

Referenced by exitLti().

    {
        if ($force_ilias_logout) {
            $this->log->warning("forcing logout ilias session, maybe a broken LTI context");
        }
        else {
            if (is_array($_SESSION['lti_context_ids']) && count($_SESSION['lti_context_ids']) > 0) {
                            $this->log->debug("there is another valid consumer session: ilias session logout refused.");
                return;
            }
        }
        $this->dic->logger()->lti()->info("logout");
        $GLOBALS['DIC']->user()->setAuthMode(AUTH_LOCAL);
        //ilSession::setClosingContext(ilSession::SESSION_CLOSE_USER); // needed?
        $auth = $GLOBALS['DIC']['ilAuthSession'];
        //$auth->logout(); // needed?
        $auth->setExpired($auth::SESSION_AUTH_EXPIRED,ilAuthStatus::STATUS_UNDEFINED);
        session_destroy();
        $client_id = $_COOKIE["ilClientId"];
        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 (   $context_id )

private

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

References $_SESSION.

Referenced by exitLti().

                                                               {
                $lti_context_ids = $_SESSION['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);
                        $_SESSION['lti_context_ids'] = $lti_context_ids;
                }
    }

Here is the caller graph for this function:

Field Documentation

$dic

ilLTIViewGUI::$dic = null

private

private variables

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

$link_dir

ilLTIViewGUI::$link_dir = ""

private

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

$lng

ilLTIViewGUI::$lng = null

public variables

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

$log

ilLTIViewGUI::$log = null

private

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

$user

ilLTIViewGUI::$user = null

private

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

CHECK_HTTP_REFERER

const ilLTIViewGUI::CHECK_HTTP_REFERER = true

contstants

Definition at line 40 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