Collaboration diagram for ilECSTaskScheduler:

Public Member Functions
	getServer ()
	Get server setting. More...

	startTaskExecution ()
	Start Tasks. More...

Static Public Member Functions
static	_getInstanceByServerId ($a_server_id)
	get singleton instance Private access use ilECSTaskScheduler::start() or ilECSTaskScheduler::startTaskExecution More...

Data Fields
const	MAX_TASKS = 30

Private Member Functions
	__construct (ilECSSetting $setting)
	Singleton constructor. More...

	readEvents ()
	Read EContent. More...

	handleEvents ()
	Handle events. More...

	handleDeprecatedAccounts ()
	Delete deprecate ECS accounts. More...

	readMIDs ()
	Read MID's of this installation. More...

Private Attributes
ilLogger	$log

ilDBInterface	$db

ilAppEventHandler	$eventHandler

ilECSSetting	$settings

ilECSEventQueueReader	$event_reader = null

array	$mids = array()

Static Private Attributes
static array	$instances = array()

Detailed Description

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

Definition at line 24 of file class.ilECSTaskScheduler.php.

Constructor & Destructor Documentation

◆ __construct()

ilECSTaskScheduler::__construct ( ilECSSetting $setting )

private

Singleton constructor.

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

    {
        global $DIC;
 
        $this->db = $DIC->database();
        $this->log = $DIC->logger()->wsrv();
        $this->eventHandler = $DIC->event();
 
        $this->settings = $setting;
    }

References $DIC, and ILIAS\Repository\settings().

Here is the call graph for this function:

Member Function Documentation

◆ _getInstanceByServerId()

static ilECSTaskScheduler::_getInstanceByServerId ( $a_server_id )

static

get singleton instance Private access use ilECSTaskScheduler::start() or ilECSTaskScheduler::startTaskExecution

Definition at line 60 of file class.ilECSTaskScheduler.php.

                                                               : \ilECSTaskScheduler
    {
        return self::$instances[$a_server_id] ?? (self::$instances[$a_server_id] =
                new ilECSTaskScheduler(
                    ilECSSetting::getInstanceByServerId($a_server_id)
                ));
    }

References ilECSSetting\getInstanceByServerId().

Referenced by ilECSSettingsGUI\readAll(), and ilCronEcsTaskScheduler\run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getServer()

ilECSTaskScheduler::getServer ( )

Get server setting.

Returns: ilECSSetting

Definition at line 72 of file class.ilECSTaskScheduler.php.

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

References $settings.

Referenced by handleEvents(), readEvents(), and readMIDs().

Here is the caller graph for this function:

◆ handleDeprecatedAccounts()

ilECSTaskScheduler::handleDeprecatedAccounts ( )

private

Delete deprecate ECS accounts.

Definition at line 219 of file class.ilECSTaskScheduler.php.

                                               : void
    {
        $query = "SELECT usr_id FROM usr_data WHERE auth_mode = 'ecs' " .
            "AND time_limit_until < " . time() . " " .
            "AND time_limit_unlimited = 0 " .
            "AND (time_limit_until - time_limit_from) < 7200";
        $res = $this->db->query($query);
        if (($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) &&
            $user_obj = ilObjectFactory::getInstanceByObjId((int) $row->usr_id, false)) {
            $this->log->info(__METHOD__ . ': Deleting deprecated ECS user account ' . $user_obj->getLogin());
            $user_obj->delete();
        }
    }

References $res, ilDBConstants\FETCHMODE_OBJECT, and ilObjectFactory\getInstanceByObjId().

Referenced by startTaskExecution().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ handleEvents()

ilECSTaskScheduler::handleEvents ( )

private

Handle events.

Definition at line 108 of file class.ilECSTaskScheduler.php.

                                   : void
    {
        for ($i = 0;$i < self::MAX_TASKS;$i++) {
            if (!$event = $this->event_reader->shift()) {
                $this->log->info(__METHOD__ . ': No more pending events found. DONE');
                break;
            }
 
            $this->log->info("Eventdump" . print_r($event, true));
 
            // determine event handler
 
            $event_ignored = false;
            switch ($event['type']) {
                case ilECSEventQueueReader::TYPE_REMOTE_COURSE:
                case ilECSEventQueueReader::TYPE_REMOTE_CATEGORY:
                case ilECSEventQueueReader::TYPE_REMOTE_FILE:
                case ilECSEventQueueReader::TYPE_REMOTE_GLOSSARY:
                case ilECSEventQueueReader::TYPE_REMOTE_GROUP:
                case ilECSEventQueueReader::TYPE_REMOTE_LEARNING_MODULE:
                case ilECSEventQueueReader::TYPE_REMOTE_WIKI:
                case ilECSEventQueueReader::TYPE_REMOTE_TEST:
                    $handler = ilRemoteObjectBase::getInstanceByEventType($event['type']);
                    if ($handler) {
                        $this->log->debug("got handler " . get_class($handler));
                    } else {
                        $this->log->error("Could not get handler for :" . $event['type']);
                    }
                    break;
 
                case ilECSEventQueueReader::TYPE_DIRECTORY_TREES:
                    $this->log->debug('Handling new cms tree event.');
                    $handler = new ilECSCmsTreeCommandQueueHandler($this->getServer());
                    break;
 
                case ilECSEventQueueReader::TYPE_CMS_COURSES:
                    $handler = new ilECSCmsCourseCommandQueueHandler($this->getServer());
                    break;
 
                case ilECSEventQueueReader::TYPE_CMS_COURSE_MEMBERS:
                    $handler = new ilECSCmsCourseMemberCommandQueueHandler($this->getServer());
                    break;
 
                case ilECSEventQueueReader::TYPE_COURSE_URLS:
                    $this->log->info(__METHOD__ . ': Ignoring event type in queue ' . $event['type']);
                    $event_ignored = true;
                    break;
 
                case ilECSEventQueueReader::TYPE_ENROLMENT_STATUS:
                    $handler = new ilECSEnrolmentStatusCommandQueueHandler($this->getServer());
                    break;
 
                default:
 
                    $this->log->warning('Unknown type in queue, raising new event handling event: ' . $event['type']);
                    $event_ignored = true;
 
                    $this->eventHandler->raise(
                        'components/ILIAS/WebServices/ECS',
                        'newEcsEvent',
                        array('event' => $event)
                    );
                    break;
            }
 
            if ($event_ignored) {
                $this->event_reader->deleteEvent($event['event_id']);
                continue;
            }
 
            $res = false;
            if (isset($handler)) {
                switch ($event['op']) {
                    case ilECSEvent::NEW_EXPORT:
                        // DEPRECATED?
                        // $this->handleNewlyCreate($event['id']);
                        // $this->log->write(__METHOD__.': Handling new creation. DONE');
                        break;
 
                    case ilECSEvent::DESTROYED:
                        $res = $handler->handleDelete($this->getServer(), $event['id'], $this->mids);
                        $this->log->info(__METHOD__ . ': Handling delete. DONE');
                        break;
 
                    case ilECSEvent::CREATED:
                        $res = $handler->handleCreate($this->getServer(), $event['id'], $this->mids);
                        $this->log->info(__METHOD__ . ': Handling create. DONE');
                        break;
 
                    case ilECSEvent::UPDATED:
                        $res = $handler->handleUpdate($this->getServer(), $event['id'], $this->mids);
                        $this->log->info(__METHOD__ . ': Handling update. DONE');
                        break;
 
                    default:
                        $this->log->info(__METHOD__ . ': Unknown event operation in queue ' . $event['op']);
                        break;
                }
            }
            if ($res) {
                $this->log->info(__METHOD__ . ': Processing of event done ' . $event['event_id']);
                $this->event_reader->deleteEvent($event['event_id']);
            } else {
                $this->log->info(__METHOD__ . ': Processing of event failed ' . $event['event_id']);
            }
        }
    }

Referenced by startTaskExecution().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readEvents()

ilECSTaskScheduler::readEvents ( )

private

Read EContent.

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

                                 : void
    {
        $this->event_reader = new ilECSEventQueueReader($this->getServer());
        $this->event_reader->refresh();
    }

References getServer().

Referenced by startTaskExecution().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readMIDs()

ilECSTaskScheduler::readMIDs ( )

private

Read MID's of this installation.

Definition at line 236 of file class.ilECSTaskScheduler.php.

                               : void
    {
        $this->mids = array();
 
        $reader = ilECSCommunityReader::getInstanceByServerId($this->getServer()->getServerId());
        foreach ($reader->getCommunities() as $com) {
            foreach ($com->getParticipants() as $part) {
                if ($part->isSelf()) {
                    $this->mids[] = $part->getMID();
                }
            }
        }
    }

References ilECSCommunityReader\getInstanceByServerId(), and getServer().

Referenced by startTaskExecution().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ startTaskExecution()

ilECSTaskScheduler::startTaskExecution ( )

Start Tasks.

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

                                        : bool
    {
        try {
            $this->readMIDs();
            $this->readEvents();
            $this->handleEvents();
 
            $this->handleDeprecatedAccounts();
        } catch (ilException $exc) {
            $this->log->warning('Cannot start ecs task execution: ' . $exc->getMessage());
            return false;
        }
        return true;
    }