ilECSTaskScheduler Class Reference

Collaboration diagram for ilECSTaskScheduler:

Public Member Functions
	getServer ()
	Get server setting. More...
	startTaskExecution ()
	Start Tasks. More...
	checkNextExecution ()
	Start. More...

Static Public Member Functions
static	_getInstanceByServerId ($a_server_id)
	get singleton instance Private access use ilECSTaskScheduler::start() or ilECSTaskScheduler::startTaskExecution More...
static	start ()
	Start task scheduler for each server instance. More...
static	startExecution ()
	Static version iterates over all active instances. More...

Data Fields
const	MAX_TASKS = 30

Protected Member Functions
	initNextExecution ()
	Call next task scheduler run. More...

Protected Attributes
	$log
	$settings = null
	$db

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
	$event_reader = null
	$mids = array()

Static Private Attributes
static	$instances = array()

Detailed Description

Author

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

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilECSTaskScheduler::__construct ( ilECSSetting  $setting )

private

Singleton constructor.

public

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

References $DIC, $GLOBALS, $ilDB, $ilLog, and settings().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        $ilLog = $DIC['ilLog'];
        
        $this->db = $ilDB;
        
        $this->log = $GLOBALS['DIC']->logger()->wsrv();
        
        include_once('./Services/WebServices/ECS/classes/class.ilECSSetting.php');
        $this->settings = $setting;
    }

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

private

Returns

ilECSTaskScheduler

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

References ilECSSetting\getInstanceByServerId().

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

    {
        if (self::$instances[$a_server_id]) {
            return self::$instances[$a_server_id];
        }
        include_once './Services/WebServices/ECS/classes/class.ilECSSetting.php';
        return self::$instances[$a_server_id] =
            new ilECSTaskScheduler(
                ilECSSetting::getInstanceByServerId($a_server_id)
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

checkNextExecution()

ilECSTaskScheduler::checkNextExecution

(

)

Start.

public

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

References $DIC, $ilDB, $query, and settings().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        
        if (!$this->settings->isEnabled()) {
            return false;
        }
        
        if (!$this->settings->checkImportId()) {
            $this->log->warning('Import ID is deleted or not of type "category". Aborting');
            return false;
        }

        // check next task excecution time:
        // If it's greater than time() directly increase this value with the polling time
        /* synchronized { */
        $query = 'UPDATE settings SET ' .
            'value = ' . $ilDB->quote(time() + $this->settings->getPollingTime(), 'text') . ' ' .
            'WHERE module = ' . $ilDB->quote('ecs', 'text') . ' ' .
            'AND keyword = ' . $ilDB->quote('next_execution_' . $this->settings->getServerId(), 'text') . ' ' .
            'AND value < ' . $ilDB->quote(time(), 'text');
        $affected_rows = $ilDB->manipulate($query);
        /* } */


        if (!$affected_rows) {
            // Nothing to do
            return false;
        }
        return true;
    }

Here is the call graph for this function:

getServer()

ilECSTaskScheduler::getServer

(

)

Get server setting.

Returns

ilECSSetting

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

References $settings.

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

    {
        return $this->settings;
    }

Here is the caller graph for this function:

handleDeprecatedAccounts()

ilECSTaskScheduler::handleDeprecatedAccounts ( )

private

Delete deprecate ECS accounts.

private

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

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

Referenced by startTaskExecution().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $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 = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            if ($user_obj = ilObjectFactory::getInstanceByObjId($row->usr_id, false)) {
                $this->log->write(__METHOD__ . ': Deleting deprecated ECS user account ' . $user_obj->getLogin());
                $user_obj->delete();
            }
            // only one user
            break;
        }
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

handleEvents()

ilECSTaskScheduler::handleEvents ( )

private

Handle events.

private

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

References $GLOBALS, $i, $res, ilECSEvent\CREATED, ilECSEvent\DESTROYED, ilRemoteObjectBase\getInstanceByEventType(), getServer(), ilECSEvent\NEW_EXPORT, ilECSEventQueueReader\TYPE_CMS_COURSE_MEMBERS, ilECSEventQueueReader\TYPE_CMS_COURSES, ilECSEventQueueReader\TYPE_COURSE_URLS, ilECSEventQueueReader\TYPE_DIRECTORY_TREES, ilECSEventQueueReader\TYPE_ENROLMENT_STATUS, ilECSEventQueueReader\TYPE_REMOTE_CATEGORY, ilECSEventQueueReader\TYPE_REMOTE_COURSE, ilECSEventQueueReader\TYPE_REMOTE_FILE, ilECSEventQueueReader\TYPE_REMOTE_GLOSSARY, ilECSEventQueueReader\TYPE_REMOTE_GROUP, ilECSEventQueueReader\TYPE_REMOTE_LEARNING_MODULE, ilECSEventQueueReader\TYPE_REMOTE_TEST, ilECSEventQueueReader\TYPE_REMOTE_WIKI, and ilECSEvent\UPDATED.

Referenced by startTaskExecution().

    {
        include_once './Services/WebServices/ECS/classes/class.ilECSEvent.php';

        for ($i = 0;$i < self::MAX_TASKS;$i++) {
            if (!$event = $this->event_reader->shift()) {
                $this->log->write(__METHOD__ . ': No more pending events found. DONE');
                break;
            }
            
            $this->log->write(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:
                    include_once 'Services/WebServices/ECS/classes/class.ilRemoteObjectBase.php';
                    $handler = ilRemoteObjectBase::getInstanceByEventType($event['type']);
                    $this->log->write("got handler " . get_class($handler));
                    break;
                
                case ilECSEventQueueReader::TYPE_DIRECTORY_TREES:
                    $this->log->debug('Handling new cms tree event.');
                    include_once './Services/WebServices/ECS/classes/Tree/class.ilECSCmsTreeCommandQueueHandler.php';
                    $handler = new ilECSCmsTreeCommandQueueHandler($this->getServer());
                    break;
                
                case ilECSEventQueueReader::TYPE_CMS_COURSES:
                    include_once './Services/WebServices/ECS/classes/Course/class.ilECSCmsCourseCommandQueueHandler.php';
                    $handler = new ilECSCmsCourseCommandQueueHandler($this->getServer());
                    break;
                
                case ilECSEventQueueReader::TYPE_CMS_COURSE_MEMBERS:
                    include_once './Services/WebServices/ECS/classes/Course/class.ilECSCmsCourseMemberCommandQueueHandler.php';
                    $handler = new ilECSCmsCourseMemberCommandQueueHandler($this->getServer());
                    break;
                
                case ilECSEventQueueReader::TYPE_COURSE_URLS:
                    $this->log->write(__METHOD__ . ': Ignoring event type in queue ' . $event['type']);
                    $event_ignored = true;
                    break;
                
                case ilECSEventQueueReader::TYPE_ENROLMENT_STATUS:
                    include_once './Services/WebServices/ECS/classes/Connectors/class.ilECSEnrolmentStatusCommandQueueHandler.php';
                    $handler = new ilECSEnrolmentStatusCommandQueueHandler($this->getServer());
                    break;

                default:
                    
                    $this->log->warning('Unknown type in queue, raising new event handling event: ' . $event['type']);
                    $event_ignored = true;
                    
                    $GLOBALS['DIC']['ilAppEventHandler']->raise(
                        'Services/WebServices/ECS',
                        'newEcsEvent',
                        array('event' => $event)
                    );
                    break;
            }
            
            if ($event_ignored) {
                $this->event_reader->delete($event['event_id']);
                continue;
            }
            
            $res = false;
            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->write(__METHOD__ . ': Handling delete. DONE');
                    break;
                        
                case ilECSEvent::CREATED:
                    $res = $handler->handleCreate($this->getServer(), $event['id'], $this->mids);
                    $this->log->write(__METHOD__ . ': Handling create. DONE');
                    break;
                
                case ilECSEvent::UPDATED:
                    $res = $handler->handleUpdate($this->getServer(), $event['id'], $this->mids);
                    $this->log->write(__METHOD__ . ': Handling update. DONE');
                    break;
                
                default:
                    $this->log->write(__METHOD__ . ': Unknown event operation in queue ' . $event['op']);
                    break;
            }
            if ($res) {
                $this->log->write(__METHOD__ . ': Processing of event done ' . $event['event_id']);
                $this->event_reader->delete($event['event_id']);
            } else {
                $this->log->write(__METHOD__ . ': Processing of event failed ' . $event['event_id']);
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initNextExecution()

ilECSTaskScheduler::initNextExecution ( )

protected

Call next task scheduler run.

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

References $_COOKIE, $client_id, $DIC, $ilLog, $res, ilSession\_duplicate(), ilSoapFunctions\handleECSTasks(), and settings().

    {
        global $DIC;

        $ilLog = $DIC['ilLog'];

        // Start task execution as backend process
        include_once 'Services/WebServices/SOAP/classes/class.ilSoapClient.php';

        $soap_client = new ilSoapClient();
        $soap_client->setResponseTimeout(1);
        $soap_client->enableWSDL(true);

        $new_session_id = ilSession::_duplicate($_COOKIE[session_name()]);
        $client_id = $_COOKIE['ilClientId'];

        if ($soap_client->init() and 0) {
            $this->log->info('Calling soap handleECSTasks method...');
            $res = $soap_client->call('handleECSTasks', array($new_session_id . '::' . $client_id,$this->settings->getServerId()));
        } else {
            $this->log->info('SOAP call failed. Calling clone method manually. ');
            include_once('./webservice/soap/include/inc.soap_functions.php');
            $res = ilSoapFunctions::handleECSTasks($new_session_id . '::' . $client_id, $this->settings->getServerId());
        }
    }

Here is the call graph for this function:

readEvents()

ilECSTaskScheduler::readEvents ( )

private

Read EContent.

private

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

References getServer().

Referenced by startTaskExecution().

    {
        try {
            include_once('./Services/WebServices/ECS/classes/class.ilECSEventQueueReader.php');
            $this->event_reader = new ilECSEventQueueReader($this->getServer()->getServerId());
            $this->event_reader->refresh();
        } catch (ilException $exc) {
            throw $exc;
        }
    }

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.

private

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

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

Referenced by startTaskExecution().

    {
        try {
            $this->mids = array();
            
            include_once('./Services/WebServices/ECS/classes/class.ilECSCommunityReader.php');
            $reader = ilECSCommunityReader::getInstanceByServerId($this->getServer()->getServerId());
            foreach ($reader->getCommunities() as $com) {
                foreach ($com->getParticipants() as $part) {
                    if ($part->isSelf()) {
                        $this->mids[] = $part->getMID();
                    }
                }
            }
        } catch (ilException $exc) {
            throw $exc;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

start()

static ilECSTaskScheduler::start ( )

static

Start task scheduler for each server instance.

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

References $server, ilContext\CONTEXT_WEB, ilECSServerSettings\getInstance(), and ilContext\getType().

    {
        include_once './Services/Context/classes/class.ilContext.php';
        if (ilContext::getType() != ilContext::CONTEXT_WEB) {
            return;
        }
        
        include_once './Services/WebServices/ECS/classes/class.ilECSServerSettings.php';
        $servers = ilECSServerSettings::getInstance();
        foreach ($servers->getServers() as $server) {
            $sched = new ilECSTaskScheduler($server);
            if ($sched->checkNextExecution()) {
                $sched->initNextExecution();
            }
        }
    }

Here is the call graph for this function:

startExecution()

static ilECSTaskScheduler::startExecution ( )

static

Static version iterates over all active instances.

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

References $server, and ilECSServerSettings\getInstance().

    {
        include_once './Services/WebServices/ECS/classes/class.ilECSServerSettings.php';
        $server = ilECSServerSettings::getInstance();
        foreach ($server->getServers() as $server) {
            $sched = new ilECSTaskScheduler($server);
            $sched->startTaskExecution();
        }
    }

Here is the call graph for this function:

startTaskExecution()

ilECSTaskScheduler::startTaskExecution

(

)

Start Tasks.

private

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

References $DIC, $ilLog, handleDeprecatedAccounts(), handleEvents(), readEvents(), and readMIDs().

    {
        global $DIC;

        $ilLog = $DIC['ilLog'];

        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;
    }

Here is the call graph for this function:

Field Documentation

$db

ilECSTaskScheduler::$db

protected

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

$event_reader

ilECSTaskScheduler::$event_reader = null

private

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

$instances

ilECSTaskScheduler::$instances = array()

staticprivate

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

$log

ilECSTaskScheduler::$log

protected

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

$mids

ilECSTaskScheduler::$mids = array()

private

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

$settings

ilECSTaskScheduler::$settings = null

protected

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

Referenced by getServer().

MAX_TASKS

const ilECSTaskScheduler::MAX_TASKS = 30

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

---

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

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