ilECSAppEventListener Class Reference

ECS Event Handler. More...

Inheritance diagram for ilECSAppEventListener:

Collaboration diagram for ilECSAppEventListener:

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

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

Detailed Description

ECS Event Handler.

Author

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

Version

$Id$

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

Member Function Documentation

_sendNotification()

static ilECSAppEventListener::_sendNotification ( ilECSSetting  $server, ilObjUser  $user_obj  )

staticprotected

send notification about new user accounts

protected

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

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

    {
        if (!count($server->getUserRecipients())) {
            return true;
        }
        // If sub id is set => mail was send
        include_once './Services/WebServices/ECS/classes/class.ilECSImport.php';
        $import = new ilECSImport($server->getServerId(), $user_obj->getId());
        if ($import->getSubId()) {
            return false;
        }

        include_once('./Services/Language/classes/class.ilLanguageFactory.php');
        $lang = ilLanguageFactory::_getLanguage();
        $lang->loadLanguageModule('ecs');

        include_once('./Services/Mail/classes/class.ilMail.php');
        $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();
        
        return true;
    }

Here is the call graph for this function:

extendAccount()

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

staticprotected

Extend account.

Parameters

ilECSSetting	$server
ilObjUser	$user

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

References $GLOBALS, ilECSSetting\getDuration(), ilObjUser\getTimeLimitUntil(), IL_CAL_MONTH, IL_CAL_UNIX, ilObjUser\setTimeLimitUntil(), and ilObject\update().

    {
        $end = new ilDateTime(time(), IL_CAL_UNIX);
        $end->increment(IL_CAL_MONTH, $settings->getDuration());
        
        $GLOBALS['DIC']['ilLog']->write(__METHOD__ . ': account extension ' . (string) $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:

handleEvent()

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

static

Handle an event in a listener.

Parameters

string	$a_component	component, e.g. "Modules/Forum" or "Services/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 44 of file class.ilECSAppEventListener.php.

References $DIC, $GLOBALS, $ilLog, $log, ilObjUser\_lookupAuthMode(), ilObjectFactory\getInstanceByObjId(), ilECSEnrolmentStatus\STATUS_ACTIVE, ilECSEnrolmentStatus\STATUS_PENDING, and ilECSEnrolmentStatus\STATUS_UNSUBSCRIBED.

    {
        global $DIC;

        $ilLog = $DIC['ilLog'];
        
        $log = $GLOBALS['DIC']->logger()->wsrv();
        
        $log->debug('Listening to event from: ' . $a_component . ' ' . $a_event);
        
        switch ($a_component) {
            case 'Services/User':
                switch ($a_event) {
                    case 'afterCreate':
                        $user = $a_parameter['user_obj'];
                        self::handleMembership($user);
                        break;
                }
                break;
            
            case 'Modules/Group':

                $log->debug('New event from group: ' . $a_event);
                switch ($a_event) {
                    case 'addSubscriber':
                    case 'addToWaitingList':
                        if (ilObjUser::_lookupAuthMode($a_parameter['usr_id']) == 'ecs') {
                            if (!$user = ilObjectFactory::getInstanceByObjId($a_parameter['usr_id'])) {
                                $log->info('No valid user found for usr_id ' . $a_parameter['usr_id']);
                                return true;
                            }
                            
                            $settings = self::initServer($a_parameter['usr_id']);
                            self::extendAccount($settings, $user);
                            
                            include_once './Services/WebServices/ECS/classes/Connectors/class.ilECSEnrolmentStatus.php';
                            self::updateEnrolmentStatus($a_parameter['obj_id'], $user, ilECSEnrolmentStatus::STATUS_PENDING);
                        }
                        break;
                        
                    case 'deleteParticipant':
                        if (ilObjUser::_lookupAuthMode($a_parameter['usr_id']) == 'ecs') {
                            if (!$user = ilObjectFactory::getInstanceByObjId($a_parameter['usr_id'])) {
                                $log->info('No valid user found for usr_id ' . $a_parameter['usr_id']);
                                return true;
                            }
                            include_once './Services/WebServices/ECS/classes/Connectors/class.ilECSEnrolmentStatus.php';
                            self::updateEnrolmentStatus($a_parameter['obj_id'], $user, ilECSEnrolmentStatus::STATUS_UNSUBSCRIBED);
                        }
                        break;
                        
                    case 'addParticipant':
                        if ((ilObjUser::_lookupAuthMode($a_parameter['usr_id']) == 'ecs')) {
                            if (!$user = ilObjectFactory::getInstanceByObjId($a_parameter['usr_id'])) {
                                $log->info('No valid user found for usr_id ' . $a_parameter['usr_id']);
                                return true;
                            }
                            
                            $settings = self::initServer($user->getId());
                            
                            self::extendAccount($settings, $user);
                            #self::_sendNotification($settings,$user);
                            
                            include_once './Services/WebServices/ECS/classes/Connectors/class.ilECSEnrolmentStatus.php';
                            self::updateEnrolmentStatus($a_parameter['obj_id'], $user, ilECSEnrolmentStatus::STATUS_ACTIVE);
                            unset($user);
                        }
                        break;
                        
                        
                
                }
                break;
                
            case 'Modules/Course':
                
                $GLOBALS['DIC']['ilLog']->write(__METHOD__ . ': New event from course: ' . $a_event);
                switch ($a_event) {

                    case 'addSubscriber':
                    case 'addToWaitingList':
                        if (ilObjUser::_lookupAuthMode($a_parameter['usr_id']) == 'ecs') {
                            if (!$user = ilObjectFactory::getInstanceByObjId($a_parameter['usr_id'])) {
                                $log->info('No valid user found for usr_id ' . $a_parameter['usr_id']);
                                return true;
                            }
                            
                            $settings = self::initServer($a_parameter['usr_id']);
                            self::extendAccount($settings, $user);
                            
                            include_once './Services/WebServices/ECS/classes/Connectors/class.ilECSEnrolmentStatus.php';
                            self::updateEnrolmentStatus($a_parameter['obj_id'], $user, ilECSEnrolmentStatus::STATUS_PENDING);
                        }
                        break;
                        
                
                    case 'deleteParticipant':
                        if (ilObjUser::_lookupAuthMode($a_parameter['usr_id']) == 'ecs') {
                            if (!$user = ilObjectFactory::getInstanceByObjId($a_parameter['usr_id'])) {
                                $log->info('No valid user found for usr_id ' . $a_parameter['usr_id']);
                                return true;
                            }
                            include_once './Services/WebServices/ECS/classes/Connectors/class.ilECSEnrolmentStatus.php';
                            self::updateEnrolmentStatus($a_parameter['obj_id'], $user, ilECSEnrolmentStatus::STATUS_UNSUBSCRIBED);
                        }
                        break;
                        
                    case 'addParticipant':
                        
                        if ((ilObjUser::_lookupAuthMode($a_parameter['usr_id']) == 'ecs')) {
                            if (!$user = ilObjectFactory::getInstanceByObjId($a_parameter['usr_id'])) {
                                $log->info('No valid user found for usr_id ' . $a_parameter['usr_id']);
                                return true;
                            }
                            
                            $settings = self::initServer($user->getId());
                            
                            self::extendAccount($settings, $user);
                            self::_sendNotification($settings, $user);
                            
                            include_once './Services/WebServices/ECS/classes/Connectors/class.ilECSEnrolmentStatus.php';
                            self::updateEnrolmentStatus($a_parameter['obj_id'], $user, ilECSEnrolmentStatus::STATUS_ACTIVE);
                            unset($user);
                        }
                        break;
                }
                break;
        }
    }

Here is the call graph for this function:

handleMembership()

static ilECSAppEventListener::handleMembership ( ilObjUser  $user )

staticprotected

Assign missing course/groups to new user accounts.

Parameters

ilObjUser

$user

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

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

    {
        $log = $GLOBALS['DIC']->logger()->wsrv();
        $log->debug('Handling ECS assignments ');
        
        include_once './Services/WebServices/ECS/classes/Course/class.ilECSCourseMemberAssignment.php';
        $assignments = ilECSCourseMemberAssignment::lookupMissingAssignmentsOfUser($user->getExternalAccount());
        foreach ($assignments as $assignment) {
            include_once './Services/WebServices/ECS/classes/Mapping/class.ilECSNodeMappingSettings.php';
            $msettings = ilECSNodeMappingSettings::getInstanceByServerMid(
                $assignment->getServer(),
                $assignment->getMid()
            );
            if ($user->getAuthMode() == $msettings->getAuthMode()) {
                $log->info('Adding user ' . $assignment->getUid() . ' to course/group: ' . $assignment->getObjId());
                $obj_type = ilObject::_lookupType($assignment->getObjId());
                if ($obj_type !== 'crs' && $obj_type !== 'grp') {
                    $log->error('Invalid assignment type: ' . $obj_type);
                    $log->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(), IL_GRP_MEMBER);
                    }
                } catch (InvalidArgumentException $e) {
                    $log->error('Invalid ref_id given: ' . (int) $ref_id);
                    $log->logStack(ilLogLevel::ERROR);
                    continue;
                }
            } else {
                $log->notice('Auth mode of user: ' . $user->getAuthMode() . ' conflicts ' . $msettings->getAuthMode());
            }
        }
    }

Here is the call graph for this function:

initServer()

static ilECSAppEventListener::initServer (   $a_usr_id )

staticprotected

Init server settings.

Parameters

type

$a_usr_id

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

References ilECSSetting\getInstanceByServerId(), and ilECSImport\lookupServerId().

    {
        include_once './Services/WebServices/ECS/classes/class.ilECSImport.php';
        $server_id = ilECSImport::lookupServerId($a_usr_id);

        include_once('Services/WebServices/ECS/classes/class.ilECSSetting.php');
        $settings = ilECSSetting::getInstanceByServerId($server_id);
        
        return $settings;
    }

Here is the call graph for this function:

updateEnrolmentStatus()

static ilECSAppEventListener::updateEnrolmentStatus (   $a_obj_id, ilObjUser  $user,   $a_status  )

staticprotected

Update enrolment status.

Parameters

type	$a_obj_id
ilObjUser	$user
type	$a_status

Returns

boolean

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

References Vendor\Package\$e, $GLOBALS, ilObject\_lookupType(), ilECSRemoteUser\factory(), ilObject\getId(), ilECSSetting\getInstanceByServerId(), and ilECSEnrolmentStatus\ID_UID.

    {
        include_once './Services/WebServices/ECS/classes/class.ilECSRemoteUser.php';
        $remote = ilECSRemoteUser::factory($user->getId());
        if (!$remote instanceof ilECSRemoteUser) {
            return false;
        }
        
        include_once './Services/WebServices/ECS/classes/Connectors/class.ilECSEnrolmentStatus.php';
        $enrol = new ilECSEnrolmentStatus();
        $enrol->setId('il_' . $GLOBALS['DIC']['ilSetting']->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 {
            include_once './Services/WebServices/ECS/classes/Connectors/class.ilECSEnrolmentStatusConnector.php';
            $con = new ilECSEnrolmentStatusConnector(ilECSSetting::getInstanceByServerId(1));
            $con->addEnrolmentStatus($enrol, $remote->getMid());
        } catch (ilECSConnectorException $e) {
            $GLOBALS['DIC']['ilLog']->write(__METHOD__ . ': update enrolment status faild with message: ' . $e->getMessage());
            return false;
        }
    }

Here is the call graph for this function:

---

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

• Services/WebServices/ECS/classes/class.ilECSAppEventListener.php