Synchronize member assignments. More...

Inheritance diagram for ilECSCmsCourseMemberCommandQueueHandler:

Collaboration diagram for ilECSCmsCourseMemberCommandQueueHandler:

Public Member Functions
	__construct (ilECSSetting $server)
	Constructor. More...

	getServer ()
	Get server. More...

	getMid ()
	get current mid More...

	checkAllocationActivation (ilECSSetting $server, $a_content_id)
	Check if course allocation is activated for one recipient of the. More...

	handleCreate (ilECSSetting $server, $a_content_id)
	Handle create. More...

	handleDelete (ilECSSetting $server, $a_content_id)
	Handle delete. More...

	handleUpdate (ilECSSetting $server, $a_content_id)
	Handle update. More...

Public Member Functions inherited from ilECSCommandQueueHandler
	handleCreate (ilECSSetting $server, int $a_content_id)
	Handle create event. More...

	handleUpdate (ilECSSetting $server, int $a_content_id)
	Handle update. More...

	handleDelete (ilECSSetting $server, int $a_content_id)
	Handle delete action. More...

Protected Member Functions
	doUpdate ($a_content_id, $course_member)
	Perform update. More...

	readAssignments ($course, $course_member)
	Read assignments for all parallel groups. More...

	refreshAssignmentStatus (object $course_member, int $obj_id, ?string $sub_id, $assigned)
	Refresh status of course member assignments. More...

	lookupRole (string $role_value, $a_obj_type)
	Lookup local role by assignment. More...

Protected Attributes
ilLogger	$log

Private Member Functions
	createMember ($a_person_id)
	Create user account. More...

	readCourseMember (ilECSSetting $server, $a_content_id)
	Read course from ecs. More...

	readCourse ($course_member)
	Read course from ecs. More...

Private Attributes
ilECSSetting	$server

int	$mid = 0

ilECSnodeMappingSettings	$mapping = null

Detailed Description

Synchronize member assignments.

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

Definition at line 25 of file class.ilECSCmsCourseMemberCommandQueueHandler.php.

Constructor & Destructor Documentation

◆ __construct()

ilECSCmsCourseMemberCommandQueueHandler::__construct ( ilECSSetting $server )

Constructor.

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

References $DIC, $server, and ILIAS\UI\examples\Progress\Bar\server().

     {
         global $DIC;
         $this->log = $DIC->logger()->wsrv();
         $this->server = $server;
     }

Here is the call graph for this function:

Member Function Documentation

◆ checkAllocationActivation()

ilECSCmsCourseMemberCommandQueueHandler::checkAllocationActivation	(	ilECSSetting	$server,
			$a_content_id
	)

Check if course allocation is activated for one recipient of the.

Definition at line 63 of file class.ilECSCmsCourseMemberCommandQueueHandler.php.

References Vendor\Package\$e, ilECSParticipantSetting\getInstance(), ilECSNodeMappingSettings\getInstanceByServerMid(), getMid(), and getServer().

Referenced by handleCreate(), and handleUpdate().

                                                                                   : bool
     {
         try {
             $crsm_reader = new ilECSCourseMemberConnector($server);
             $details = $crsm_reader->getCourseMember($a_content_id, true);
             $this->mid = $details->getMySender();
 
             // Check if import is enabled
             $part = ilECSParticipantSetting::getInstance($this->getServer()->getServerId(), $this->getMid());
             if (!$part->isImportEnabled()) {
                 $this->log->warning('Import disabled for mid ' . $this->getMid());
                 return false;
             }
             // Check course allocation setting
             $this->mapping = ilECSNodeMappingSettings::getInstanceByServerMid(
                 $this->getServer()->getServerId(),
                 $this->getMid()
             );
             return $this->mapping->isCourseAllocationEnabled();
         } catch (ilECSConnectorException $e) {
             $this->log->error('Reading course member details failed with message ' . $e->getMessage());
             return false;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createMember()

ilECSCmsCourseMemberCommandQueueHandler::createMember ( $a_person_id )

private

Create user account.

Definition at line 431 of file class.ilECSCmsCourseMemberCommandQueueHandler.php.

References ilAuthUtils\_getAuthModeName(), ilLDAPServer\_getFirstActiveServer(), ilAuthUtils\AUTH_SHIBBOLETH, ilUserCreationContext\CONTEXT_LDAP, ilUserCreationContext\getInstance(), ilLDAPServer\getInstanceByServerId(), and ilLDAPQuery\LDAP_BIND_DEFAULT.

Referenced by refreshAssignmentStatus().

                                                : void
     {
         if (!$this->mapping instanceof ilECSNodeMappingSettings) {
             $this->log->warning('Node mapping settings not initialized.');
         }
         $auth_mode = $this->mapping->getAuthMode();
 
         if (
             $this->mapping->getAuthMode() ===
             ilAuthUtils::_getAuthModeName(ilAuthUtils::AUTH_SHIBBOLETH)
         ) {
             $this->log->info('Not handling direct user creation for auth mode: ' . $auth_mode);
             return;
         }
         if (strpos($auth_mode, 'ldap') !== 0) {
             $this->log->info('Not handling direct user creation for auth mode: ' . $auth_mode);
             return;
         }
 
         try {
             $server = ilLDAPServer::getInstanceByServerId(ilLDAPServer::_getFirstActiveServer());
             $server->doConnectionCheck();
 
             $query = new ilLDAPQuery($server);
             $query->bind(ilLDAPQuery::LDAP_BIND_DEFAULT);
 
             $users = $query->fetchUser((string) $a_person_id);
             if ($users) {
                 ilUserCreationContext::getInstance()->addContext(ilUserCreationContext::CONTEXT_LDAP);
 
                 $xml = new ilLDAPAttributeToUser($server);
                 $xml->setNewUserAuthMode($server->getAuthenticationMappingKey());
                 $xml->setUserData($users);
                 $xml->refresh();
             }
         } catch (ilLDAPQueryException $exc) {
             $this->log->error($exc->getMessage());
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ doUpdate()

ilECSCmsCourseMemberCommandQueueHandler::doUpdate	(	$a_content_id,
		$course_member
	)

protected

Perform update.

Definition at line 142 of file class.ilECSCmsCourseMemberCommandQueueHandler.php.

References ilLogLevel\DEBUG, ilECSImportManager\getInstance(), getMid(), getServer(), if, ILIAS\Repository\int(), null, readAssignments(), readCourse(), and refreshAssignmentStatus().

Referenced by handleCreate(), and handleUpdate().

                                                               : bool
     {
         $this->log->debug('Starting ecs member update');
 
         if (is_array($course_member) && !isset($course_member["lectureID"])) {
             $this->log->warning('Missing course id in course_member');
             return false;
         }
 
         $course_id = (int) $course_member->lectureID;
         if (!$course_id) {
             $this->log->warning('Missing course id');
             return false;
         }
         $this->log->debug('sid: ' . $this->getServer()->getServerId() . ' course_id: ' . $course_id . ' mid: ' . $this->mid);
         //$crs_obj_id = ilECSImportManager::getInstance()->_lookupObjId($this->getServer()->getServerId(), $course_id, $this->mid);
         $crs_obj_id = ilECSImportManager::getInstance()->lookupObjIdByContentId($this->getServer()->getServerId(), $this->mid, $course_id);
 
         if (!$crs_obj_id) {
             $this->log->info('No main course created. Group scenario >= 3 ?');
         }
 
         $course = $this->readCourse($course_member);
         if (is_null($course)) {
             $this->log->info('No course found, skip processing' . print_r($course_member, true));
             return true;
         }
         // Lookup already imported users and update their status
         $assignments = $this->readAssignments($course, $course_member);
 
         $this->log->debug('Parallel group assignments');
         $this->log->dump($assignments, ilLogLevel::DEBUG);
         $this->log->debug('------------------ End assignemtns');
 
         // iterate through all parallel groups
         foreach ($assignments as $cms_id => $assigned) {
             $sub_id = ($cms_id === $course_id) ? null : (string) $cms_id;
 
             $this->log->debug('sub id is ' . is_null($sub_id) ? "<null>" : $sub_id . ' for ' . $cms_id);
 
             $obj_id = ilECSImportManager::getInstance()->lookupObjIdByContentId(
                 $this->getServer()->getServerId(),
                 $this->getMid(),
                 $course_id,
                 $sub_id
             );
 
             $this->refreshAssignmentStatus($course_member, $obj_id, $sub_id, $assigned);
         }
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMid()

ilECSCmsCourseMemberCommandQueueHandler::getMid ( )

get current mid

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

References $mid.

Referenced by checkAllocationActivation(), doUpdate(), and readCourse().

                             : int
     {
         return $this->mid;
     }

Here is the caller graph for this function:

◆ getServer()

ilECSCmsCourseMemberCommandQueueHandler::getServer ( )

Get server.

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

References $server.

Referenced by checkAllocationActivation(), doUpdate(), readCourse(), and refreshAssignmentStatus().

                                : \ilECSSetting
     {
         return $this->server;
     }

Here is the caller graph for this function:

◆ handleCreate()

ilECSCmsCourseMemberCommandQueueHandler::handleCreate	(	ilECSSetting	$server,
			$a_content_id
	)

Handle create.

Definition at line 92 of file class.ilECSCmsCourseMemberCommandQueueHandler.php.

References Vendor\Package\$e, checkAllocationActivation(), doUpdate(), and readCourseMember().

                                                                      : bool
     {
         if (!$this->checkAllocationActivation($server, $a_content_id)) {
             return true;
         }
         try {
             //$course = $this->readCourse($server, $a_content_id);
             $course_member = $this->readCourseMember($server, $a_content_id);
             $this->doUpdate($a_content_id, $course_member);
             return true;
         } catch (ilECSConnectorException $e) {
             $this->log->error('Course member creation failed  with mesage ' . $e->getMessage());
             return false;
         }
         return true;
     }

Here is the call graph for this function:

◆ handleDelete()

ilECSCmsCourseMemberCommandQueueHandler::handleDelete	(	ilECSSetting	$server,
			$a_content_id
	)

Handle delete.

Definition at line 112 of file class.ilECSCmsCourseMemberCommandQueueHandler.php.

                                                                      : bool
     {
         // nothing todo
         return true;
     }

◆ handleUpdate()

ilECSCmsCourseMemberCommandQueueHandler::handleUpdate	(	ilECSSetting	$server,
			$a_content_id
	)

Handle update.

Definition at line 121 of file class.ilECSCmsCourseMemberCommandQueueHandler.php.

References Vendor\Package\$e, checkAllocationActivation(), doUpdate(), and readCourseMember().

                                                                      : bool
     {
         if (!$this->checkAllocationActivation($server, $a_content_id)) {
             return true;
         }
 
         try {
             $course_member = $this->readCourseMember($server, $a_content_id);
             $this->doUpdate($a_content_id, $course_member);
             return true;
         } catch (ilECSConnectorException $e) {
             $this->log->error('Course member update failed  with mesage ' . $e->getMessage());
             return false;
         }
         return true;
     }

Here is the call graph for this function:

◆ lookupRole()

ilECSCmsCourseMemberCommandQueueHandler::lookupRole	(	string	$role_value,
			$a_obj_type
	)

protected

Lookup local role by assignment.

Definition at line 390 of file class.ilECSCmsCourseMemberCommandQueueHandler.php.

References ilParticipants\IL_CRS_ADMIN, ilParticipants\IL_CRS_MEMBER, ilParticipants\IL_CRS_TUTOR, ilParticipants\IL_GRP_ADMIN, and ilParticipants\IL_GRP_MEMBER.

Referenced by refreshAssignmentStatus().

                                                                   : int
     {
         $role_mappings = $this->mapping->getRoleMappings();
 
         /* Zero is an allowed value */
         if (!$role_value) {
             $this->log->debug('No role assignment attribute: role');
         }
         foreach ($role_mappings as $name => $map) {
             $this->log->debug('Role "name" is ' . $name);
 
             // map is a string of ids seperated by ","
             $exploded_map = (array) explode(',', $map);
             if (in_array($role_value, $exploded_map, true)) {
                 switch ($name) {
                     case ilParticipants::IL_CRS_ADMIN:
                     case ilParticipants::IL_CRS_TUTOR:
                     case ilParticipants::IL_CRS_MEMBER:
                         if ($a_obj_type === 'crs') {
                             $this->log->debug('Role: ' . $role_value . ' maps: ' . $map);
                             return $name;
                         }
                         break;
 
                     case ilParticipants::IL_GRP_ADMIN:
                     case ilParticipants::IL_GRP_MEMBER:
                         if ($a_obj_type === 'grp') {
                             $this->log->debug('Role: ' . $role_value . ' maps: ' . $map);
                             return $name;
                         }
                         break;
                 }
             }
         }
         $this->log->info('No role assignment mapping for role ' . $role_value);
         return 0;
     }

Here is the caller graph for this function:

◆ readAssignments()

ilECSCmsCourseMemberCommandQueueHandler::readAssignments	(	$course,
		$course_member
	)

protected

Read assignments for all parallel groups.

Definition at line 197 of file class.ilECSCmsCourseMemberCommandQueueHandler.php.

References if, ILIAS\Repository\int(), null, ilECSMappingUtils\PARALLEL_ALL_COURSES, ilECSMappingUtils\PARALLEL_GROUPS_IN_COURSE, and ilECSMappingUtils\PARALLEL_ONE_COURSE.

Referenced by doUpdate().

                                                                : array
     {
         //TODO check if this switch is still needed
         if (!property_exists($course, 'groupScenario')) {
             $course->groupScenario = ilECSMappingUtils::PARALLEL_ONE_COURSE;
         }
 
         switch ((int) $course->groupScenario) {
             case ilECSMappingUtils::PARALLEL_ONE_COURSE:
                 $this->log->debug('Parallel group scenario one course.');
                 break;
 
             case ilECSMappingUtils::PARALLEL_GROUPS_IN_COURSE:
                 $this->log->debug('Parallel group scenario groups in courses.');
                 break;
 
             case ilECSMappingUtils::PARALLEL_ALL_COURSES:
                 $this->log->debug('Parallel group scenario only courses.');
                 break;
 
             default:
                 $this->log->debug('Parallel group scenario undefined.');
                 break;
         }
 
         $course_id = $course_member->lectureID;
         $assigned = array();
         foreach ((array) $course_member->members as $member) {
             $assigned[$course_id][$member->personID] = array(
                 'id' => $member->personID,
                 'role' => $member->role
             );
             if ((int) $course->groupScenario === ilECSMappingUtils::PARALLEL_ONE_COURSE) {
                 $this->log->debug('Group scenarion "one course". Ignoring group assignments');
                 continue;
             }
 
             if (property_exists($member, 'groups')) {
                 foreach ((array) $member->groups as $pgroup) {
                     // the sequence number in the course ressource
                     $sequence_number = (int) $pgroup->num;
                     // find parallel group with by sequence number
                     if (property_exists($course, 'groups')) {
                         $tmp_pgroup = $course->groups[$sequence_number] ?? null;
 
                         if (is_object($tmp_pgroup) && $tmp_pgroup->id !== '') {
                             $this->log->debug('Found parallel group with id: ' . $tmp_pgroup->id . ': for sequence number: ' . $sequence_number);
 
                             // @todo check hierarchy of roles
                             $assigned[$tmp_pgroup->id][$member->personID] = array(
                                 'id' => $member->personID,
                                 'role' => $pgroup->role
                             );
                         } else {
                             $this->log->warning('Cannot find parallel group with sequence id: ' . $sequence_number);
                         }
                     } else {
                         $this->log->error('Invalid course/group-configuration found, ignoring}');
                     }
 
                 }
             }
         }
         $this->log->debug('ECS member assignments ' . print_r($assigned, true));
         return $assigned;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readCourse()

ilECSCmsCourseMemberCommandQueueHandler::readCourse ( $course_member )

private

Read course from ecs.

Definition at line 483 of file class.ilECSCmsCourseMemberCommandQueueHandler.php.

References ilECSImportManager\getInstance(), getMid(), getServer(), and null.

Referenced by doUpdate().

     {
         $ecs_id = ilECSImportManager::getInstance()->lookupEContentIdByContentId(
             $this->getServer()->getServerId(),
             $this->getMid(),
             $course_member->lectureID
         );
         if (0 === $ecs_id) {
             return null;
         }
         return (new ilECSCourseConnector($this->getServer()))->getCourse($ecs_id);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readCourseMember()

ilECSCmsCourseMemberCommandQueueHandler::readCourseMember	(	ilECSSetting	$server,
			$a_content_id
	)

private

Read course from ecs.

Definition at line 475 of file class.ilECSCmsCourseMemberCommandQueueHandler.php.

Referenced by handleCreate(), and handleUpdate().

     {
         return (new ilECSCourseMemberConnector($server))->getCourseMember($a_content_id);
     }

Here is the caller graph for this function:

◆ refreshAssignmentStatus()

ilECSCmsCourseMemberCommandQueueHandler::refreshAssignmentStatus	(	object	$course_member,
		int	$obj_id,
		?string	$sub_id,
			$assigned
	)

protected

Refresh status of course member assignments.

Definition at line 269 of file class.ilECSCmsCourseMemberCommandQueueHandler.php.

References ilObjUser\_checkExternalAuthAccount(), ilCourseParticipants\_getInstanceByObjId(), ilGroupParticipants\_getInstanceByObjId(), ilObjUser\_lookupId(), ilObject\_lookupTitle(), ilObject\_lookupType(), createMember(), ilLogLevel\DEBUG, ilECSMappingUtils\getRoleMappingInfo(), getServer(), ILIAS\Repository\int(), ilECSCourseMemberAssignment\lookupAssignment(), lookupRole(), ilECSCourseMemberAssignment\lookupUserIds(), and ilCourseMembershipMailNotification\TYPE_ADMISSION_MEMBER.

Referenced by doUpdate().

                                                                                                               : bool
     {
         $this->log->debug('Currrent sub_id = ' . $sub_id . ', obj_id = ' . $obj_id);
 
         $type = ilObject::_lookupType($obj_id);
         if ($type === 'crs') {
             $part = ilCourseParticipants::_getInstanceByObjId($obj_id);
         } elseif ($type === 'grp') {
             $part = ilGroupParticipants::_getInstanceByObjId($obj_id);
         } else {
             $this->log->warning('Invalid object type given for obj_id: ' . $obj_id);
             return false;
         }
 
         $course_id = (int) $course_member->lectureID;
         $usr_ids = ilECSCourseMemberAssignment::lookupUserIds(
             $course_id,
             is_null($sub_id) ? $sub_id : (int) $sub_id,
             $obj_id
         );
         $this->log->debug('Current coursemember assignments:');
         $this->log->dump($usr_ids, ilLogLevel::DEBUG);
 
         // Delete remote deleted
         foreach ($usr_ids as $usr_id) {
             if (!isset($assigned[$usr_id])) {
                 $ass = ilECSCourseMemberAssignment::lookupAssignment($course_id, is_null($sub_id) ? $sub_id : (int) $sub_id, $obj_id, $usr_id);
                 if ($ass instanceof ilECSCourseMemberAssignment) {
                     $login = ilObjUser::_checkExternalAuthAccount(
                         $this->mapping->getAuthMode(),
                         (string) $usr_id
                     );
 
                     $this->log->debug('Local user assignment: ' . $usr_id . ' <-> ' . $login);
 
                     if ($il_usr_id = ilObjUser::_lookupId($login)) {
                         // this removes also admin, tutor roles
                         $part->delete($il_usr_id);
                         $this->log->info('Deassigning user ' . $usr_id . ' ' . 'from course ' . ilObject::_lookupTitle($obj_id));
                     } else {
                         $this->log->notice('Deassigning unknown ILIAS user ' . $usr_id . ' ' . 'from course ' . ilObject::_lookupTitle($obj_id));
                     }
 
                     $ass->delete();
                 }
             }
         }
 
         $this->log->debug('Handled assignmnent...');
 
         // Assign new participants
         foreach ((array) $assigned as $person_id => $person) {
             $role = $this->lookupRole((string) $person['role'], $type);
             $role_info = ilECSMappingUtils::getRoleMappingInfo($role);
 
             $this->log->debug('Using role info...');
             $login = ilObjUser::_checkExternalAuthAccount(
                 $this->mapping->getAuthMode(),
                 (string) $person_id
             );
             $this->log->info('Handling user ' . $person_id);
 
             if (in_array($person_id, $usr_ids, true)) {
                 if ($il_usr_id = ilObjUser::_lookupId($login)) {
                     $this->log->info('Update user assignment for: ' . $person_id);
                     $part->updateRoleAssignments($il_usr_id, array($part->getAutoGeneratedRoleId($role)));
                 } elseif ($role_info['create']) {
                     $this->createMember($person_id);
                     $this->log->info('Added new user ' . $person_id);
                     $login = ilObjUser::_checkExternalAuthAccount(
                         $this->mapping->getAuthMode(),
                         (string) $person_id
                     );
                     if ($role && $il_usr_id = ilObjUser::_lookupId($login)) {
                         $part->add($il_usr_id, $role);
                         $part->sendNotification(ilCourseMembershipMailNotification::TYPE_ADMISSION_MEMBER, $il_usr_id);
                     }
                 }
             } else {
                 if ($il_usr_id = ilObjUser::_lookupId($login)) {
                     // user exists => assign to course/group
                     if ($role) {
                         // Assign user
                         $this->log->info('Assigning new user ' . $person_id . ' ' . 'to ' . ilObject::_lookupTitle($obj_id) . ' using role: ' . $role);
                         $part->add($il_usr_id, $role);
                         $part->sendNotification(ilCourseMembershipMailNotification::TYPE_ADMISSION_MEMBER, $il_usr_id);
                     }
                 } else {
                     // no local user exists
                     if ($role_info['create']) {
                         $this->createMember($person_id);
                         $this->log->info('Added new user ' . $person_id);
                         $login = ilObjUser::_checkExternalAuthAccount(
                             $this->mapping->getAuthMode(),
                             (string) $person_id
                         );
                     }
                     // Assign to role
                     if ($role && $il_usr_id = ilObjUser::_lookupId($login)) {
                         $this->log->info('Assigning new role to existing user ' . $person_id . ' ' . 'to ' . ilObject::_lookupTitle($obj_id) . ' using role: ' . $role);
                         $part->add($il_usr_id, $role);
                         $part->sendNotification(ilCourseMembershipMailNotification::TYPE_ADMISSION_MEMBER, $il_usr_id);
                     }
                 }
 
                 $assignment = new ilECSCourseMemberAssignment();
                 $assignment->setServer($this->getServer()->getServerId());
                 $assignment->setMid($this->mid);
                 $assignment->setCmsId($course_id);
                 $assignment->setCmsSubId(is_null($sub_id) ? $sub_id : (int) $sub_id);
                 $assignment->setObjId($obj_id);
                 $assignment->setUid((string) $person_id);
                 $assignment->save();
             }
         }
         return true;
     }