ilAuthProviderLTI Class Reference

OAuth based lti authentication. More...

Inheritance diagram for ilAuthProviderLTI:

Collaboration diagram for ilAuthProviderLTI:

Public Member Functions
	__construct (ilAuthCredentials $credentials)
	Constructor. More...
Public Member Functions inherited from ilAuthProvider
	__construct (ilAuthCredentials $credentials)
	getLogger ()
	getCredentials ()
Public Member Functions inherited from ilAuthProviderInterface
	doAuthentication (ilAuthStatus $status)

Static Public Member Functions
static	getAuthModeByKey (string $a_auth_key)
	Get auth mode by key. More...
static	getKeyByAuthMode (string $a_auth_mode)
	Get auth id by auth mode. More...
static	getActiveAuthModes ()
	get all active authmode server ids More...
static	getAuthModes ()
static	lookupConsumer (int $a_sid)
	Lookup consumer title. More...
static	getServerIdByAuthMode (string $a_auth_mode)
	Get auth id by auth mode. More...
static	isAuthModeLTI (string $a_auth_mode)
	Check if user auth mode is LTI. More...

Data Fields
const	AUTH_MODE_PREFIX = 'lti'

Protected Member Functions
	findAuthKeyId (string $a_oauth_consumer_key)
	find consumer key id More...
	findAuthPrefix (int $a_lti_id)
	find lti id More...
	findGlobalRole (int $a_lti_id)
	find global role of consumer More...
	findUserId (string $a_oauth_user, string $a_oauth_id, string $a_user_prefix)
	Find user by auth mode and lti id. More...
	updateUser (int $a_local_user_id, ilLTIPlatform $consumer)
	update existing user @access protected More...
	createUser (ilLTIPlatform $consumer)
	create new user @access protected More...
	handleLocalRoleAssignments (int $user_id, ilLTIPlatform $consumer, int $target_ref_id, ?int $default_rol_id=null)
	mapLTIRoleToLocalRole (string $lti_role, ilLTIProviderObjectSetting $settings)
	Maps an LTI role (URI or simple name) to a local ILIAS role ID. More...
Protected Member Functions inherited from ilAuthProvider
	handleAuthenticationFail (ilAuthStatus $status, string $a_reason)

Protected Attributes
string	$launchReturnUrl = ""

Private Attributes
ilLTIDataConnector	$dataConnector = null
string	$lti_context_id = ""
int	$ref_id = 0
ilLTITool	$provider = null
array	$messageParameters = null
ilLogger	$logger = null

Detailed Description

OAuth based lti authentication.

Author

Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Uwe Kohnle kohnl.nosp@m.e@in.nosp@m.terne.nosp@m.tleh.nosp@m.rer-g.nosp@m.mbh..nosp@m.de

Stefan Schneider

Definition at line 27 of file class.ilAuthProviderLTI.php.

Constructor & Destructor Documentation

__construct()

ilAuthProviderLTI::__construct

(

ilAuthCredentials

$credentials

)

Constructor.

Reimplemented from ilAuthProvider.

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

    {
        parent::__construct($credentials);
        $this->logger = ilLoggerFactory::getLogger('ltis');
    }

References ilAuthProvider\$credentials, ILIAS\GlobalScreen\Provider\__construct(), ilLoggerFactory\getLogger(), and ILIAS\Repository\logger().

Here is the call graph for this function:

Member Function Documentation

createUser()

ilAuthProviderLTI::createUser ( ilLTIPlatform  $consumer )

protected

create new user @access protected

Parameters

ilLTIPlatform

$consumer

Returns

int

Exceptions

ilPasswordException
ilUserException

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

                                                          : int
    {
        global $ilClientIniFile, $DIC;
        //        if (empty($this->messageParameters)) {
        //            $status->setReason('empty_lti_message_parameters');
        //            $status->setStatus(ilAuthStatus::STATUS_AUTHENTICATION_FAILED);
        //            return false;
        //        }
        $userObj = new ilObjUser();
        $local_user = ilAuthUtils::_generateLogin($consumer->getPrefix() . '_' . $this->getCredentials()->getUsername());
 
        $newUser["login"] = $local_user;
        if (isset($this->messageParameters['lis_person_name_given'])) {
            $newUser["firstname"] = $this->messageParameters['lis_person_name_given'];
        } else {
            $newUser["firstname"] = '-';
        }
        if (isset($this->messageParameters['lis_person_name_family'])) {
            $newUser["lastname"] = $this->messageParameters['lis_person_name_family'];
        } else {
            $newUser["lastname"] = '-';
        }
        $newUser['email'] = $this->messageParameters['lis_person_contact_email_primary'];
 
        // set "plain md5" password (= no valid password)
        //        $newUser["passwd"] = "";
        $newUser["passwd_type"] = ilObjUser::PASSWD_CRYPTED;
 
        $newUser["auth_mode"] = 'lti_' . $consumer->getExtConsumerId();
        $newUser['ext_account'] = $this->getCredentials()->getUsername();
        $newUser["profile_incomplete"] = 0;
 
        // ILIAS 8
        //check
        $newUser["gender"] = 'n';
        $newUser["title"] = null;
        $newUser["birthday"] = null;
        $newUser["institution"] = null;
        $newUser["department"] = null;
        $newUser["street"] = null;
        $newUser["city"] = null;
        $newUser["zipcode"] = null;
        $newUser["country"] = null;
        $newUser["sel_country"] = null;
        $newUser["phone_office"] = null;
        $newUser["phone_home"] = null;
        $newUser["phone_mobile"] = null;
        $newUser["fax"] = null;
        $newUser["matriculation"] = null;
        $newUser["second_email"] = null;
        $newUser["hobby"] = null;
        $newUser["client_ip"] = null;
        $newUser["passwd_salt"] = null;//$newUser->getPasswordSalt();
        $newUser["latitude"] = null;
        $newUser["longitude"] = null;
        $newUser["loc_zoom"] = null;
        $newUser["last_login"] = null;
        $newUser["first_login"] = null;
        $newUser["last_profile_prompt"] = null;
        $newUser["last_update"] = ilUtil::now();
        $newUser["create_date"] = ilUtil::now();
        $newUser["referral_comment"] = null;
        $newUser["approve_date"] = null;
        $newUser["agree_date"] = null;
        $newUser["inactivation_date"] = null;
        $newUser["time_limit_from"] = null;
        $newUser["time_limit_until"] = null;
        $newUser["is_self_registered"] = null;
        //end to check
 
        $newUser["passwd_enc_type"] = "";
        $newUser["active"] = true;
        $newUser["time_limit_owner"] = 7;
        $newUser["time_limit_unlimited"] = 0;
        $newUser["time_limit_message"] = 0;
        $newUser["passwd"] = " ";
        //        $newUser["last_update"]
 
        // system data
        $userObj->assignData($newUser);
        $userObj->setTitle($userObj->getFullname());
        $userObj->setDescription($userObj->getEmail());
 
        // set user language
        $userObj->setLanguage($consumer->getLanguage());
 
        // Time limit
        $userObj->setTimeLimitOwner(7);
        $userObj->setTimeLimitUnlimited(false);
        $userObj->setTimeLimitFrom(time() - 5);
        //        todo ?
        $userObj->setTimeLimitUntil(time() + (int) $ilClientIniFile->readVariable("session", "expire"));
 
        // Create user in DB
        $userObj->setOwner(6);
        $userObj->create();
        $userObj->setActive(true);
        //        $userObj->updateOwner();
        $userObj->setLastPasswordChangeTS(time());
        $userObj->saveAsNew();
        $userObj->writePrefs();
 
        $GLOBALS['DIC']->rbac()->admin()->assignUser($consumer->getRole(), $userObj->getId());
 
        $this->getLogger()->info('Created new lti user with uid: ' . $userObj->getId() . ' and login: ' . $userObj->getLogin());
        return $userObj->getId();
    }

References $DIC, $GLOBALS, ilAuthUtils\_generateLogin(), ilAuthProvider\getCredentials(), ilLTIPlatform\getExtConsumerId(), ilLTIPlatform\getLanguage(), ilAuthProvider\getLogger(), ilLTIPlatform\getPrefix(), ilLTIPlatform\getRole(), ilUtil\now(), and ilObjUser\PASSWD_CRYPTED.

Here is the call graph for this function:

findAuthKeyId()

ilAuthProviderLTI::findAuthKeyId ( string  $a_oauth_consumer_key )

protected

find consumer key id

Parameters

string

$a_oauth_consumer_key

Returns

int

Definition at line 163 of file class.ilAuthProviderLTI.php.

                                                                  : int
    {
        global $ilDB;
 
        $query = 'SELECT consumer_pk from lti2_consumer where consumer_key = ' . $ilDB->quote(
            $a_oauth_consumer_key,
            'text'
        );
        // $query = 'SELECT id from lti_ext_consumer where consumer_key = '.$ilDB->quote($a_oauth_consumer_key,'text');
        $this->getLogger()->debug($query);
        $res = $ilDB->query($query);
 
        $lti_id = 0;
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $lti_id = $row->consumer_pk;
            // $lti_id = $row->id;
        }
        $this->getLogger()->debug('External consumer key is: ' . (int) $lti_id);
        return $lti_id;
    }

References $ilDB, $res, ilDBConstants\FETCHMODE_OBJECT, and ilAuthProvider\getLogger().

Here is the call graph for this function:

findAuthPrefix()

ilAuthProviderLTI::findAuthPrefix ( int  $a_lti_id )

protected

find lti id

Parameters

int

$a_lti_id

Returns

string

Definition at line 189 of file class.ilAuthProviderLTI.php.

                                                    : string
    {
        global $ilDB;
 
        $query = 'SELECT prefix from lti_ext_consumer where id = ' . $ilDB->quote($a_lti_id, 'integer');
        $this->getLogger()->debug($query);
        $res = $ilDB->query($query);
 
        // $prefix = 'lti'.$a_lti_id.'_';
        $prefix = '';
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $prefix = $row->prefix;
        }
        $this->getLogger()->debug('LTI prefix: ' . $prefix);
        return $prefix;
    }

References $ilDB, $res, ilDBConstants\FETCHMODE_OBJECT, and ilAuthProvider\getLogger().

Here is the call graph for this function:

findGlobalRole()

ilAuthProviderLTI::findGlobalRole ( int  $a_lti_id )

protected

find global role of consumer

Parameters

int

$a_lti_id

Returns

int|null

Definition at line 211 of file class.ilAuthProviderLTI.php.

                                                    : ?int
    {
        global $ilDB;
 
        $query = 'SELECT role from lti_ext_consumer where id = ' . $ilDB->quote($a_lti_id, 'integer');
        $this->getLogger()->debug($query);
        $res = $ilDB->query($query);
 
        $role = null;
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $role = (int) $row->role;
        }
        $this->getLogger()->debug('LTI role: ' . $role);
        return $role;
    }

References $ilDB, $res, ilDBConstants\FETCHMODE_OBJECT, ilAuthProvider\getLogger(), and ILIAS\Repository\int().

Here is the call graph for this function:

findUserId()

ilAuthProviderLTI::findUserId ( string  $a_oauth_user, string  $a_oauth_id, string  $a_user_prefix  )

protected

Find user by auth mode and lti id.

Parameters

string	$a_oauth_user
string	$a_oauth_id
string	$a_user_prefix

Returns

int

Definition at line 359 of file class.ilAuthProviderLTI.php.

                                                                                                  : int
    {
        $user_name = ilObjUser::_checkExternalAuthAccount(
            self::AUTH_MODE_PREFIX . '_' . $a_oauth_id,
            $a_oauth_user
        );
        $user_id = 0;
        if ($user_name) {
            $user_id = ilObjUser::_lookupId($user_name);
        }
        $this->getLogger()->debug('Found user with auth mode lti_' . $a_oauth_id . ' with user_id: ' . $user_id);
        return $user_id;
    }

References $user_id, ilObjUser\_checkExternalAuthAccount(), ilObjUser\_lookupId(), and ilAuthProvider\getLogger().

Here is the call graph for this function:

getActiveAuthModes()

static ilAuthProviderLTI::getActiveAuthModes ( )

static

get all active authmode server ids

Returns

array

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

                                               : array
    {
        global $ilDB;
 
        // move to connector
        $query = 'SELECT consumer_pk from lti2_consumer where enabled = ' . $ilDB->quote(1, 'integer');
        $res = $ilDB->query($query);
 
        $sids = array();
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $sids[] = $row->consumer_pk;
        }
        return $sids;
    }

References $ilDB, $res, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by ilAuthUtils\_isExternalAccountEnabled().

Here is the caller graph for this function:

getAuthModeByKey()

static ilAuthProviderLTI::getAuthModeByKey ( string  $a_auth_key )

static

Get auth mode by key.

Parameters

string

$a_auth_mode

Returns

string auth_mode

Definition at line 54 of file class.ilAuthProviderLTI.php.

                                                               : string
    {
        $auth_arr = explode('_', $a_auth_key);
        if (count($auth_arr) > 1) {
            return 'lti_' . $auth_arr[1];
        }
        return 'lti';
    }

Referenced by ilAuthUtils\_getAuthModeName().

Here is the caller graph for this function:

getAuthModes()

static ilAuthProviderLTI::getAuthModes ( )

static

Returns

array

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

                                         : array
    {
        global $ilDB;
 
        // move to connector
        $query = 'SELECT distinct(consumer_pk) consumer_pk from lti2_consumer';
        $res = $ilDB->query($query);
 
        $sids = array();
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $sids[] = $row->consumer_pk;
        }
        return $sids;
    }

References $ilDB, $res, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by ilAuthUtils\_getActiveAuthModes(), and ilAuthUtils\_getAllAuthModes().

Here is the caller graph for this function:

getKeyByAuthMode()

static ilAuthProviderLTI::getKeyByAuthMode ( string  $a_auth_mode )

static

Get auth id by auth mode.

Parameters

string

$a_auth_mode

Returns

int|string auth_mode

Definition at line 68 of file class.ilAuthProviderLTI.php.

    {
        $auth_arr = explode('_', $a_auth_mode);
        if (count($auth_arr) > 1) {
            return ilAuthUtils::AUTH_PROVIDER_LTI . '_' . $auth_arr[1];
        }
        return ilAuthUtils::AUTH_PROVIDER_LTI;
    }

References ilAuthUtils\AUTH_PROVIDER_LTI.

Referenced by ilAuthUtils\_getAuthMode().

Here is the caller graph for this function:

getServerIdByAuthMode()

static ilAuthProviderLTI::getServerIdByAuthMode ( string  $a_auth_mode )

static

Get auth id by auth mode.

Parameters

string

$a_auth_mode

Returns

int|null

Definition at line 134 of file class.ilAuthProviderLTI.php.

                                                                     : ?int
    {
        if (self::isAuthModeLTI($a_auth_mode)) {
            $auth_arr = explode('_', $a_auth_mode);
            return (int) $auth_arr[1];
        }
        return null;
    }

Referenced by ilAuthUtils\getAuthModeTranslation().

Here is the caller graph for this function:

handleLocalRoleAssignments()

ilAuthProviderLTI::handleLocalRoleAssignments ( int  $user_id, ilLTIPlatform  $consumer, int  $target_ref_id, ?int  $default_rol_id = null  )

protected

Definition at line 535 of file class.ilAuthProviderLTI.php.

                                                                                                                                         : bool
    {
        global $DIC;
        $this->getLogger()->info('$target_ref_id: ' . $target_ref_id);
        if (!$target_ref_id) {
            $this->getLogger()->warning('No target id given');
            return false;
        }
 
        $obj_settings = new ilLTIProviderObjectSetting($target_ref_id, $consumer->getExtConsumerId());
 
        $roles = $this->messageParameters['roles'] ?? '';
 
        if (!is_string($roles) || empty($roles)) {
            $this->getLogger()->warning('No role information given or invalid role format.');
            return false;
        }
 
        $this->getLogger()->info("Deassigning all roles for user: " . $user_id);
        $DIC->rbac()->admin()->deassignUser($obj_settings->getTutorRole(), $user_id);
        $DIC->rbac()->admin()->deassignUser($obj_settings->getMemberRole(), $user_id);
        $DIC->rbac()->admin()->deassignUser($obj_settings->getAdminRole(), $user_id);
 
        $role_arr = is_array($roles) ? $roles : explode(',', $roles);
 
        $this->getLogger()->info('Recieved roles: ' . implode(', ', $role_arr));
 
        $tree = $DIC->repositoryTree();
        $parent = $tree->getParentId($target_ref_id);
        if ($parent != 1) {
            $this->handleLocalRoleAssignments($user_id, $consumer, $parent, $obj_settings->getMemberRole());
        }
        foreach ($role_arr as $role) {
            $role = trim($role);
            $local_role_id = $this->mapLTIRoleToLocalRole($role, $obj_settings) == 0 && $default_rol_id != null ? $default_rol_id : $this->mapLTIRoleToLocalRole($role, $obj_settings);
            if (isset($local_role_id)) {
                $this->getLogger()->info('Assigning local role ID: ' . $local_role_id . ' for LTI role: ' . $role . ' to user ID: ' . $user_id);
                $DIC->rbac()->admin()->assignUser($local_role_id, $user_id);
            } else {
                $this->getLogger()->info('No local role mapping found for LTI role: ' . $role);
            }
        }
 
        return true;
    }

References $DIC, $user_id, ilLTIPlatform\getExtConsumerId(), ilAuthProvider\getLogger(), handleLocalRoleAssignments(), and mapLTIRoleToLocalRole().

Referenced by handleLocalRoleAssignments().

Here is the call graph for this function:

Here is the caller graph for this function:

isAuthModeLTI()

static ilAuthProviderLTI::isAuthModeLTI ( string  $a_auth_mode )

static

Check if user auth mode is LTI.

Parameters

string

$a_auth_mode

Returns

bool

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

                                                             : bool
    {
        if (!$a_auth_mode) {
            ilLoggerFactory::getLogger('ltis')->warning('No auth mode given.');
            return false;
        }
        $auth_arr = explode('_', $a_auth_mode);
        return ($auth_arr[0] == ilAuthUtils::AUTH_PROVIDER_LTI) and $auth_arr[1];
    }

References ilAuthUtils\AUTH_PROVIDER_LTI, and ilLoggerFactory\getLogger().

Here is the call graph for this function:

lookupConsumer()

static ilAuthProviderLTI::lookupConsumer ( int  $a_sid )

static

Lookup consumer title.

Parameters

int

$a_sid

Returns

string

Definition at line 119 of file class.ilAuthProviderLTI.php.

                                                     : string
    {
        $connector = new ilLTIDataConnector();
        $consumer = ilLTIPlatform::fromRecordId($a_sid, $connector);
 
        $object_ref = $consumer->getRefId();
        $object_title = ilObject2::_lookupTitle(ilObject2::_lookupObjectId($object_ref));
        return $consumer->getTitle() . " / " . $object_title;
    }

References ilObject\_lookupObjectId(), ilObject\_lookupTitle(), and ilLTIPlatform\fromRecordId().

Referenced by ilAuthUtils\getAuthModeTranslation().

Here is the call graph for this function:

Here is the caller graph for this function:

mapLTIRoleToLocalRole()

ilAuthProviderLTI::mapLTIRoleToLocalRole ( string  $lti_role, ilLTIProviderObjectSetting  $settings  )

protected

Maps an LTI role (URI or simple name) to a local ILIAS role ID.

Parameters

string	$lti_role
ilLTIProviderObjectSetting	$settings

Returns

int|null The ILIAS role ID, or null if no mapping is found.

Definition at line 588 of file class.ilAuthProviderLTI.php.

                                                                                                    : ?int
    {
        // Prioritize more specific roles (sub-roles)
        $role_map = [
            // System Roles
            'http://purl.imsglobal.org/vocab/lti/system/person#TestUser' => null, // Example: No mapping for TestUser
            'http://purl.imsglobal.org/vocab/lis/v2/system/person#Administrator' => $settings->getAdminRole(),
            'http://purl.imsglobal.org/vocab/lis/v2/system/person#None' => null,
            'http://purl.imsglobal.org/vocab/lis/v2/system/person#AccountAdmin' => null, // No direct mapping
            'http://purl.imsglobal.org/vocab/lis/v2/system/person#Creator' => null, // No direct mapping
            'http://purl.imsglobal.org/vocab/lis/v2/system/person#SysAdmin' => null,  // No direct mapping
            'http://purl.imsglobal.org/vocab/lis/v2/system/person#SysSupport' => null, // No direct mapping
            'http://purl.imsglobal.org/vocab/lis/v2/system/person#User' => null, // No direct mapping
 
            // Institution Roles
            'http://purl.imsglobal.org/vocab/lis/v2/institution/person#Administrator' => $settings->getAdminRole(),
            'http://purl.imsglobal.org/vocab/lis/v2/institution/person#Faculty' => $settings->getTutorRole(),
            'http://purl.imsglobal.org/vocab/lis/v2/institution/person#Guest' => null, // No direct mapping
            'http://purl.imsglobal.org/vocab/lis/v2/institution/person#None' => null,
            'http://purl.imsglobal.org/vocab/lis/v2/institution/person#Other' => null, // No direct mapping
            'http://purl.imsglobal.org/vocab/lis/v2/institution/person#Staff' => null,  // No direct mapping
            'http://purl.imsglobal.org/vocab/lis/v2/institution/person#Student' => $settings->getMemberRole(),
            'http://purl.imsglobal.org/vocab/lis/v2/institution/person#Alumni' => null, // No direct mapping
            'http://purl.imsglobal.org/vocab/lis/v2/institution/person#Instructor' => $settings->getTutorRole(),
            'http://purl.imsglobal.org/vocab/lis/v2/institution/person#Learner' => $settings->getMemberRole(),
            'http://purl.imsglobal.org/vocab/lis/v2/institution/person#Member' => $settings->getMemberRole(),
            'http://purl.imsglobal.org/vocab/lis/v2/institution/person#Mentor' => null, // No direct mapping
            'http://purl.imsglobal.org/vocab/lis/v2/institution/person#Observer' => null, // No direct mapping
            'http://purl.imsglobal.org/vocab/lis/v2/institution/person#ProspectiveStudent' => null, // No direct mapping
 
            // Context Roles (Main)
            'http://purl.imsglobal.org/vocab/lis/v2/membership#Administrator' => $settings->getAdminRole(),
            'http://purl.imsglobal.org/vocab/lis/v2/membership#ContentDeveloper' => null, // No direct mapping
            'http://purl.imsglobal.org/vocab/lis/v2/membership#Instructor' => $settings->getTutorRole(),
            'http://purl.imsglobal.org/vocab/lis/v2/membership#Learner' => $settings->getMemberRole(),
            'http://purl.imsglobal.org/vocab/lis/v2/membership#Mentor' => null, // No direct mapping
            'http://purl.imsglobal.org/vocab/lis/v2/membership#Manager' => $settings->getAdminRole(), // Potentially map to admin
            'http://purl.imsglobal.org/vocab/lis/v2/membership#Member' => $settings->getMemberRole(),
            'http://purl.imsglobal.org/vocab/lis/v2/membership#Officer' => null, // No direct mapping
 
            // Context Sub-Roles (TeachingAssistant)
            'http://purl.imsglobal.org/vocab/lis/v2/membership/Instructor#TeachingAssistant' => $settings->getTutorRole(),
            'http://purl.imsglobal.org/vocab/lis/v2/membership/Instructor#TeachingAssistantGroup' => $settings->getTutorRole(),
            'http://purl.imsglobal.org/vocab/lis/v2/membership/Instructor#TeachingAssistantOffering' => $settings->getTutorRole(),
            'http://purl.imsglobal.org/vocab/lis/v2/membership/Instructor#TeachingAssistantSection' => $settings->getTutorRole(),
            'http://purl.imsglobal.org/vocab/lis/v2/membership/Instructor#TeachingAssistantSectionAssociation' => $settings->getTutorRole(),
            'http://purl.imsglobal.org/vocab/lis/v2/membership/Instructor#TeachingAssistantTemplate' => $settings->getTutorRole(),
            // Context Sub-Roles (Grader)
            'http://purl.imsglobal.org/vocab/lis/v2/membership/Instructor#Grader' => $settings->getTutorRole(), // Map Grader to Tutor
            // Context Sub-Roles (GuestInstructor, Lecturer, PrimaryInstructor, SecondaryInstructor)
            'http://purl.imsglobal.org/vocab/lis/v2/membership/Instructor#GuestInstructor' => $settings->getTutorRole(),
            'http://purl.imsglobal.org/vocab/lis/v2/membership/Instructor#Lecturer' => $settings->getTutorRole(),
            'http://purl.imsglobal.org/vocab/lis/v2/membership/Instructor#PrimaryInstructor' => $settings->getTutorRole(),
            'http://purl.imsglobal.org/vocab/lis/v2/membership/Instructor#SecondaryInstructor' => $settings->getTutorRole(),
            // Context Sub-Roles (ExternalInstructor)
            'http://purl.imsglobal.org/vocab/lis/v2/membership/Instructor#ExternalInstructor' => $settings->getTutorRole(),
 
            // Context Sub-Roles (ExternalLearner, GuestLearner, Learner, NonCreditLearner)
            'http://purl.imsglobal.org/vocab/lis/v2/membership/Learner#ExternalLearner' => $settings->getMemberRole(),
            'http://purl.imsglobal.org/vocab/lis/v2/membership/Learner#GuestLearner' => $settings->getMemberRole(),
            'http://purl.imsglobal.org/vocab/lis/v2/membership/Learner#Learner' => $settings->getMemberRole(),
            'http://purl.imsglobal.org/vocab/lis/v2/membership/Learner#NonCreditLearner' => $settings->getMemberRole(),
 
            // Context Sub-Roles (AreaManager, CourseCoordinator, ExternalObserver, Manager, Observer)
            'http://purl.imsglobal.org/vocab/lis/v2/membership/Manager#AreaManager' => $settings->getAdminRole(),
            'http://purl.imsglobal.org/vocab/lis/v2/membership/Manager#CourseCoordinator' => null,
            'http://purl.imsglobal.org/vocab/lis/v2/membership/Manager#ExternalObserver' => null,
            'http://purl.imsglobal.org/vocab/lis/v2/membership/Manager#Manager' => $settings->getAdminRole(),
            'http://purl.imsglobal.org/vocab/lis/v2/membership/Manager#Observer' => null,
 
            // Context Sub-Roles (Advisor, Auditor, ExternalAdvisor, ExternalAuditor, ExternalLearningFacilitator, ExternalMentor, ExternalReviewer, ExternalTutor, LearningFacilitator, Mentor, Reviewer, Tutor)
            'http://purl.imsglobal.org/vocab/lis/v2/membership/Mentor#Advisor' => null,
            'http://purl.imsglobal.org/vocab/lis/v2/membership/Mentor#Auditor' => null,
            'http://purl.imsglobal.org/vocab/lis/v2/membership/Mentor#ExternalAdvisor' => null,
            'http://purl.imsglobal.org/vocab/lis/v2/membership/Mentor#ExternalAuditor' => null,
            'http://purl.imsglobal.org/vocab/lis/v2/membership/Mentor#ExternalLearningFacilitator' => null,
            'http://purl.imsglobal.org/vocab/lis/v2/membership/Mentor#ExternalMentor' => null,
            'http://purl.imsglobal.org/vocab/lis/v2/membership/Mentor#ExternalReviewer' => null,
            'http://purl.imsglobal.org/vocab/lis/v2/membership/Mentor#ExternalTutor' => null,
            'http://purl.imsglobal.org/vocab/lis/v2/membership/Mentor#LearningFacilitator' => null,
            'http://purl.imsglobal.org/vocab/lis/v2/membership/Mentor#Mentor' => null,
            'http://purl.imsglobal.org/vocab/lis/v2/membership/Mentor#Reviewer' => null,
            'http://purl.imsglobal.org/vocab/lis/v2/membership/Mentor#Tutor' => $settings->getTutorRole(), // Map Tutor to Tutor
 
            // Context Sub-Roles (Chair, Communications, Secretary, Treasurer, Vice-Chair)
            'http://purl.imsglobal.org/vocab/lis/v2/membership/Officer#Chair' => null,
            'http://purl.imsglobal.org/vocab/lis/v2/membership/Officer#Communications' => null,
            'http://purl.imsglobal.org/vocab/lis/v2/membership/Officer#Secretary' => null,
            'http://purl.imsglobal.org/vocab/lis/v2/membership/Officer#Treasurer' => null,
            'http://purl.imsglobal.org/vocab/lis/v2/membership/Officer#Vice-Chair' => null,
 
            // Context Sub-Roles (ContentDeveloper, ContentExpert, ExternalContentExpert, Librarian)
            'http://purl.imsglobal.org/vocab/lis/v2/membership/ContentDeveloper#ContentDeveloper' => null,
            'http://purl.imsglobal.org/vocab/lis/v2/membership/ContentDeveloper#ContentExpert' => null,
            'http://purl.imsglobal.org/vocab/lis/v2/membership/ContentDeveloper#ExternalContentExpert' => null,
            'http://purl.imsglobal.org/vocab/lis/v2/membership/ContentDeveloper#Librarian' => null,
 
            // Context Sub-Roles (Member)
            'http://purl.imsglobal.org/vocab/lis/v2/membership/Member#Member' => $settings->getMemberRole(),
 
            // Context Sub-Roles (Administrator, Developer, ExternalDeveloper, ExternalSupport, ExternalSystemAdministrator, Support, SystemAdministrator)
            'http://purl.imsglobal.org/vocab/lis/v2/membership/Administrator#Administrator' => $settings->getAdminRole(),
            'http://purl.imsglobal.org/vocab/lis/v2/membership/Administrator#Developer' => null,
            'http://purl.imsglobal.org/vocab/lis/v2/membership/Administrator#ExternalDeveloper' => null,
            'http://purl.imsglobal.org/vocab/lis/v2/membership/Administrator#ExternalSupport' => null,
            'http://purl.imsglobal.org/vocab/lis/v2/membership/Administrator#ExternalSystemAdministrator' => null,
            'http://purl.imsglobal.org/vocab/lis/v2/membership/Administrator#Support' => null,
            'http://purl.imsglobal.org/vocab/lis/v2/membership/Administrator#SystemAdministrator' => null,
        ];
 
        // LTI 1.0/1.1 simple names (supported for backward compatibility)
        $simple_name_map = [
            'Instructor' => $settings->getTutorRole(),
            'Learner' => $settings->getMemberRole(),
            'ContentDeveloper' => null,
            'Administrator' => $settings->getAdminRole(),
            'Mentor' => null,
            'Manager' => $settings->getAdminRole(),
            'Member' => $settings->getMemberRole(),
            'Officer' => null,
        ];
 
 
        if (isset($role_map[$lti_role])) {
            return $role_map[$lti_role];
        } elseif (isset($simple_name_map[$lti_role])) {
            // Check for simple names
            return $simple_name_map[$lti_role];
        }
 
        return null;
    }

References ilLTIProviderObjectSetting\getAdminRole(), ilLTIProviderObjectSetting\getMemberRole(), and ilLTIProviderObjectSetting\getTutorRole().

Referenced by handleLocalRoleAssignments().

Here is the call graph for this function:

Here is the caller graph for this function:

updateUser()

ilAuthProviderLTI::updateUser ( int  $a_local_user_id, ilLTIPlatform  $consumer  )

protected

update existing user @access protected

Parameters

int	$a_local_user_id
ilLTIPlatform	$consumer

Returns

int

Definition at line 380 of file class.ilAuthProviderLTI.php.

                                                                                : int
    {
        global $ilClientIniFile, $DIC;
        //        if (empty($this->messageParameters)) {
        //            $status->setReason('empty_lti_message_parameters');
        //            $status->setStatus(ilAuthStatus::STATUS_AUTHENTICATION_FAILED);
        //            return false;
        //        }
        $user_obj = new ilObjUser($a_local_user_id);
        if (isset($this->messageParameters['lis_person_name_given'])) {
            $user_obj->setFirstname($this->messageParameters['lis_person_name_given']);
        } else {
            $user_obj->setFirstname('-');
        }
        if (isset($this->messageParameters['lis_person_name_family'])) {
            $user_obj->setLastname($this->messageParameters['lis_person_name_family']);
        } else {
            $user_obj->setLastname('-');
        }
        $user_obj->setEmail($this->messageParameters['lis_person_contact_email_primary']);
 
        $user_obj->setActive(true);
 
        $until = $user_obj->getTimeLimitUntil();
 
        if ($until < (time() + (int) $ilClientIniFile->readVariable('session', 'expire'))) {
            $user_obj->setTimeLimitFrom(time() - 60);
            $user_obj->setTimeLimitUntil(time() + (int) $ilClientIniFile->readVariable("session", "expire"));
        }
        $user_obj->refreshLogin();
        $user_obj->update();
 
        $GLOBALS['DIC']->rbac()->admin()->assignUser($consumer->getRole(), $user_obj->getId());
        $this->getLogger()->debug('Assigned user to: ' . $consumer->getRole());
 
        $this->getLogger()->info('Update of lti user with uid: ' . $user_obj->getId() . ' and login: ' . $user_obj->getLogin());
        return $user_obj->getId();
    }

References $DIC, $GLOBALS, ilAuthProvider\getLogger(), and ilLTIPlatform\getRole().

Here is the call graph for this function:

Field Documentation

$dataConnector

ilLTIDataConnector ilAuthProviderLTI::$dataConnector = null

private

Definition at line 30 of file class.ilAuthProviderLTI.php.

$launchReturnUrl

string ilAuthProviderLTI::$launchReturnUrl = ""

protected

Definition at line 36 of file class.ilAuthProviderLTI.php.

$logger

ilLogger ilAuthProviderLTI::$logger = null

private

Definition at line 38 of file class.ilAuthProviderLTI.php.

$lti_context_id

string ilAuthProviderLTI::$lti_context_id = ""

private

Definition at line 31 of file class.ilAuthProviderLTI.php.

$messageParameters

array ilAuthProviderLTI::$messageParameters = null

private

Definition at line 34 of file class.ilAuthProviderLTI.php.

$provider

ilLTITool ilAuthProviderLTI::$provider = null

private

Definition at line 33 of file class.ilAuthProviderLTI.php.

$ref_id

int ilAuthProviderLTI::$ref_id = 0

private

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

AUTH_MODE_PREFIX

const ilAuthProviderLTI::AUTH_MODE_PREFIX = 'lti'

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

---

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

• components/ILIAS/LTIProvider/classes/InternalProvider/class.ilAuthProviderLTI.php