ilECSAppEventListener Class Reference

ECS Event Handler. More...

Inheritance diagram for ilECSAppEventListener:

Collaboration diagram for ilECSAppEventListener:

Public Member Functions
	__construct (\ilLogger $logger, ilSetting $settings, ilRbacAdmin $rbac_admin)

Static Public Member Functions
static	handleEvent (string $a_component, string $a_event, array $a_parameter)
	Handle an event in a listener. More...

Protected Member Functions
	handleNewAccountCreation (string $username)

Private Member Functions
	initServer (int $a_usr_id)
	Init server settings. More...
	sendNotification (ilECSSetting $server, ilObjUser $user_obj)
	send notification about new user accounts More...
	handleMembership (ilObjUser $user)
	Assign missing course/groups to new user accounts. More...
	extendAccount (ilECSSetting $settings, ilObjUser $user)
	Extend account. More...
	updateEnrolmentStatus (int $a_obj_id, ilObjUser $user, string $a_status)
	Update enrolment status. More...

Private Attributes
ilLogger	$logger
ilSetting	$settings
ilRbacAdmin	$rbac_admin

Detailed Description

ECS Event Handler.

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

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

Constructor & Destructor Documentation

__construct()

ilECSAppEventListener::__construct	(	\ilLogger	$logger,
		ilSetting	$settings,
		ilRbacAdmin	$rbac_admin
	)

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

References $logger, $rbac_admin, $settings, ILIAS\Repository\logger(), and ILIAS\Repository\settings().

      {
        $this->logger = $logger;
        $this->settings = $settings;
        $this->rbac_admin = $rbac_admin;
    }

Here is the call graph for this function:

Member Function Documentation

extendAccount()

ilECSAppEventListener::extendAccount ( ilECSSetting  $settings, ilObjUser  $user  )

private

Extend account.

Definition at line 310 of file class.ilECSAppEventListener.php.

References ilECSSetting\getDuration(), ilObjUser\getTimeLimitUntil(), IL_CAL_MONTH, IL_CAL_UNIX, ILIAS\Repository\logger(), ilObjUser\setTimeLimitUntil(), and ilObjUser\update().

Referenced by handleEvent().

                                                                           : void
    {
        $end = new ilDateTime(time(), IL_CAL_UNIX);
        $end->increment(IL_CAL_MONTH, $settings->getDuration());

        $this->logger->info(__METHOD__ . ': account extension ' . $end);

        if ($user->getTimeLimitUntil() < $end->get(IL_CAL_UNIX)) {
            $user->setTimeLimitUntil($end->get(IL_CAL_UNIX));
            $user->update();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

handleEvent()

static ilECSAppEventListener::handleEvent ( string  $a_component, string  $a_event, array  $a_parameter  )

static

Handle an event in a listener.

Parameters

string	$a_component	component, e.g. "components/ILIAS/Forum" or "components/ILIAS/User"
string	$a_event	event e.g. "createUser", "updateUser", "deleteUser", ...
array	$a_parameter	parameter array (assoc), array("name" => ..., "phone_office" => ...)

Implements ilAppEventListener.

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

References $DIC, ilObjUser\_lookupAuthMode(), extendAccount(), ilObjectFactory\getInstanceByObjId(), handleMembership(), handleNewAccountCreation(), initServer(), ILIAS\Repository\logger(), sendNotification(), ilECSEnrolmentStatus\STATUS_ACTIVE, ilECSEnrolmentStatus\STATUS_PENDING, ilECSEnrolmentStatus\STATUS_UNSUBSCRIBED, and updateEnrolmentStatus().

                                                                                                : void
    {
        global $DIC;

        $eventHandler = new static(
            $DIC->logger()->wsrv(),
            $DIC->settings(),
            $DIC->rbac()->admin(),
        );
        $eventHandler->handle($a_component, $a_event, $a_parameter);
    }

Here is the call graph for this function:

handleMembership()

ilECSAppEventListener::handleMembership ( ilObjUser  $user )

private

Assign missing course/groups to new user accounts.

Definition at line 268 of file class.ilECSAppEventListener.php.

References Vendor\Package\$e, $ref_id, ilObject\_getAllReferences(), ilObject\_lookupType(), ilCourseConstants\CRS_MEMBER, ilLogLevel\ERROR, ilObjUser\getAuthMode(), ilObjUser\getExternalAccount(), ilObject\getId(), ilParticipants\getInstance(), ilECSNodeMappingSettings\getInstanceByServerMid(), ilParticipants\IL_GRP_MEMBER, ILIAS\Repository\logger(), and ilECSCourseMemberAssignment\lookupMissingAssignmentsOfUser().

Referenced by handleEvent().

                                                      : void
    {
        $this->logger->debug('Handling ECS assignments ');

        $assignments = ilECSCourseMemberAssignment::lookupMissingAssignmentsOfUser($user->getExternalAccount());
        foreach ($assignments as $assignment) {
            $msettings = ilECSNodeMappingSettings::getInstanceByServerMid(
                $assignment->getServer(),
                $assignment->getMid()
            );
            if ($user->getAuthMode() === $msettings->getAuthMode()) {
                $this->logger->info('Adding user ' . $assignment->getUid() . ' to course/group: ' . $assignment->getObjId());
                $obj_type = ilObject::_lookupType($assignment->getObjId());
                if ($obj_type !== 'crs' && $obj_type !== 'grp') {
                    $this->logger->error('Invalid assignment type: ' . $obj_type);
                    $this->logger->logStack(ilLogLevel::ERROR);
                    continue;
                }
                $refs = ilObject::_getAllReferences($assignment->getObjId());
                $ref_id = end($refs);

                try {
                    $part = ilParticipants::getInstance((int) $ref_id);
                    if ($obj_type === 'crs') {
                        $part->add($user->getId(), ilCourseConstants::CRS_MEMBER);
                    } elseif ($obj_type === 'grp') {
                        $part->add($user->getId(), ilParticipants::IL_GRP_MEMBER);
                    }
                } catch (InvalidArgumentException $e) {
                    $this->logger->error('Invalid ref_id given: ' . (int) $ref_id);
                    $this->logger->logStack(ilLogLevel::ERROR);
                    continue;
                }
            } else {
                $this->logger->notice('Auth mode of user: ' . $user->getAuthMode() . ' conflicts ' . $msettings->getAuthMode());
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

handleNewAccountCreation()

ilECSAppEventListener::handleNewAccountCreation ( string  $username )

protected

Definition at line 227 of file class.ilECSAppEventListener.php.

References $server, $user_id, ilObjUser\_loginExists(), ilObjUser\_lookupExternalAccount(), ilECSParticipantSetting\getInstance(), ilECSSetting\getInstanceByServerId(), ilECSParticipantSetting\INCOMING_AUTH_TYPE_LOGIN_PAGE, ilECSParticipantSetting\INCOMING_AUTH_TYPE_SHIBBOLETH, ILIAS\Repository\logger(), and null.

Referenced by handleEvent().

                                                                 : void
    {
        $user_id = ilObjUser::_loginExists($username);
        if (!$user_id) {
            $this->logger->warning('Invalid username given: ' . $username);
        }

        $external_account = ilObjUser::_lookupExternalAccount($user_id);
        if ($external_account == '') {
            return;
        }
        $remote_user_repo = new ilECSRemoteUserRepository();
        $remote_user = $remote_user_repo->getECSRemoteUserByRemoteId($external_account);
        if ($remote_user === null) {
            return;
        }
        if ($remote_user->getServerId() === 0) {
            $this->logger->warning('Found remote user without server id: ' . $external_account);
            return;
        }
        if ($remote_user->getMid() === 0) {
            $this->logger->warning('Found remote user without mid id: ' . $external_account);
            return;
        }
        $part = ilECSParticipantSetting::getInstance(
            $remote_user->getServerId(),
            $remote_user->getMid()
        );
        $server = ilECSSetting::getInstanceByServerId($remote_user->getServerId());
        if (
            $part->getIncomingAuthType() === ilECSParticipantSetting::INCOMING_AUTH_TYPE_LOGIN_PAGE ||
            $part->getIncomingAuthType() === ilECSParticipantSetting::INCOMING_AUTH_TYPE_SHIBBOLETH
        ) {
            $this->logger->info('Assigning ' . $username . ' to global ecs role');
            $this->rbac_admin->assignUser($server->getGlobalRole(), $user_id);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initServer()

ilECSAppEventListener::initServer ( int  $a_usr_id )

private

Init server settings.

Definition at line 187 of file class.ilECSAppEventListener.php.

References ilECSImportManager\getInstance(), and ilECSSetting\getInstanceByServerId().

Referenced by handleEvent().

                                              : ilECSSetting
    {
        $server_id = ilECSImportManager::getInstance()->lookupServerId($a_usr_id);

        return ilECSSetting::getInstanceByServerId($server_id);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

sendNotification()

ilECSAppEventListener::sendNotification ( ilECSSetting  $server, ilObjUser  $user_obj  )

private

send notification about new user accounts

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

References $lang, ilMail\_getAutoGeneratedMessageString(), ilLanguageFactory\_getLanguage(), ANONYMOUS_USER_ID, ilObject\getId(), ilECSSetting\getServerId(), ilECSSetting\getUserRecipients(), and ilECSSetting\getUserRecipientsAsString().

Referenced by handleEvent().

                                                                                : void
    {
        if (!count($server->getUserRecipients())) {
            return;
        }
        // If sub id is set => mail was send
        $import = new ilECSImport($server->getServerId(), $user_obj->getId());
        if ($import->getSubId()) {
            return;
        }

        $lang = ilLanguageFactory::_getLanguage();
        $lang->loadLanguageModule('ecs');

        $mail = new ilMail(ANONYMOUS_USER_ID);
        $subject = $lang->txt('ecs_new_user_subject');

        // build body
        $body = $lang->txt('ecs_new_user_body') . "\n\n";
        $body .= $lang->txt('ecs_new_user_profile') . "\n\n";
        $body .= $user_obj->getProfileAsString($lang) . "\n\n";
        $body .= ilMail::_getAutoGeneratedMessageString($lang);

        $mail->enqueue($server->getUserRecipientsAsString(), "", "", $subject, $body, array());

        // Store sub_id = 1 in ecs import which means mail is send
        $import->setSubId("1");
        $import->save();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

updateEnrolmentStatus()

ilECSAppEventListener::updateEnrolmentStatus ( int  $a_obj_id, ilObjUser  $user, string  $a_status  )

private

Update enrolment status.

Definition at line 326 of file class.ilECSAppEventListener.php.

References Vendor\Package\$e, ilObject\_lookupType(), ilObject\getId(), ilECSSetting\getInstanceByServerId(), ilECSEnrolmentStatus\ID_UID, ILIAS\Repository\logger(), and ILIAS\Repository\settings().

Referenced by handleEvent().

                                                                                            : void
    {
        $remote = (new ilECSRemoteUserRepository())->getECSRemoteUserByUsrId($user->getId());
        if (!$remote instanceof ilECSRemoteUser) {
            return;
        }

        $enrol = new ilECSEnrolmentStatus();
        $enrol->setId('il_' . $this->settings->get('inst_id', "0") . '_' . ilObject::_lookupType($a_obj_id) . '_' . $a_obj_id);
        $enrol->setPersonId($remote->getRemoteUserId());
        $enrol->setPersonIdType(ilECSEnrolmentStatus::ID_UID);
        $enrol->setStatus($a_status);

        try {
            $con = new ilECSEnrolmentStatusConnector(ilECSSetting::getInstanceByServerId(1));
            $con->addEnrolmentStatus($enrol, $remote->getMid());
        } catch (ilECSConnectorException $e) {
            $this->logger->info(__METHOD__ . ': update enrolment status faild with message: ' . $e->getMessage());
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$logger

ilLogger ilECSAppEventListener::$logger

private

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

Referenced by __construct().

$rbac_admin

ilRbacAdmin ilECSAppEventListener::$rbac_admin

private

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

Referenced by __construct().

$settings

ilSetting ilECSAppEventListener::$settings

private

Definition at line 28 of file class.ilECSAppEventListener.php.

Referenced by __construct().

---

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

• components/ILIAS/WebServices/ECS/classes/class.ilECSAppEventListener.php