ILIAS  release_5-2 Revision v5.2.25-18-g3f80b828510
Public Member Functions | Static Public Member Functions | Data Fields | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | Static Private Attributes
ilECSTaskScheduler Class Reference
Services/WebServices/ECS
+ 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.

@access public

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

57 {
58 global $ilDB,$ilLog;
59
60 $this->db = $ilDB;
61
62 $this->log = $GLOBALS['DIC']->logger()->wsrv();
63
64 include_once('./Services/WebServices/ECS/classes/class.ilECSSetting.php');
65 $this->settings = $setting;
66 }
$GLOBALS
$GLOBALS['loaded']
Global hash that tracks already loaded includes.
Definition: generate-standalone.php:18
$ilLog
$ilLog
Definition: inc.setup_header.php:130
settings
settings()
Definition: settings.php:2
$ilDB
global $ilDB
Definition: storeScorm2004.php:19

References $GLOBALS, $ilDB, $ilLog, and 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

@access private

Returns
ilECSTaskScheduler

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

81 {
82 if(self::$instances[$a_server_id])
83 {
84 return self::$instances[$a_server_id];
85 }
86 include_once './Services/WebServices/ECS/classes/class.ilECSSetting.php';
87 return self::$instances[$a_server_id] =
88 new ilECSTaskScheduler(
89 ilECSSetting::getInstanceByServerId($a_server_id)
90 );
91 }
ilECSSetting\getInstanceByServerId
static getInstanceByServerId($a_server_id)
Get singleton instance per server.
Definition: class.ilECSSetting.php:109

References ilECSSetting\getInstanceByServerId().

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

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ checkNextExecution()

ilECSTaskScheduler::checkNextExecution ( )

Start.

@access public

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

376 {
377 global $ilDB;
378
379
380 if(!$this->settings->isEnabled())
381 {
382 return false;
383 }
384
385 if(!$this->settings->checkImportId())
386 {
387 $this->log->warning('Import ID is deleted or not of type "category". Aborting');
388 return false;
389 }
390
391 // check next task excecution time:
392 // If it's greater than time() directly increase this value with the polling time
393 /* synchronized { */
394 $query = 'UPDATE settings SET '.
395 'value = '.$ilDB->quote(time() + $this->settings->getPollingTime(),'text').' '.
396 'WHERE module = '.$ilDB->quote('ecs','text').' '.
397 'AND keyword = '.$ilDB->quote('next_execution_'.$this->settings->getServerId(),'text').' '.
398 'AND value < '.$ilDB->quote(time(),'text');
399 $affected_rows = $ilDB->manipulate($query);
400 /* } */
401
402
403 if(!$affected_rows)
404 {
405 // Nothing to do
406 return false;
407 }
408 return true;
409 }

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

+ Here is the call graph for this function:

◆ getServer()

ilECSTaskScheduler::getServer ( )

Get server setting.

Returns
ilECSSetting

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

135 {
136 return $this->settings;
137 }

References $settings.

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

+ Here is the caller graph for this function:

◆ handleDeprecatedAccounts()

ilECSTaskScheduler::handleDeprecatedAccounts ( )
private

Delete deprecate ECS accounts.

@access private

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

316 {
317 global $ilDB;
318
319 $query = "SELECT usr_id FROM usr_data WHERE auth_mode = 'ecs' ".
320 "AND time_limit_until < ".time()." ".
321 "AND time_limit_unlimited = 0 ".
322 "AND (time_limit_until - time_limit_from) < 7200";
323 $res = $ilDB->query($query);
324 while($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT))
325 {
326 if($user_obj = ilObjectFactory::getInstanceByObjId($row->usr_id,false))
327 {
328 $this->log->write(__METHOD__.': Deleting deprecated ECS user account '.$user_obj->getLogin());
329 $user_obj->delete();
330 }
331 // only one user
332 break;
333 }
334 return true;
335 }
ilObjectFactory\getInstanceByObjId
static getInstanceByObjId($a_obj_id, $stop_on_error=true)
get an instance of an Ilias object by object id
Definition: class.ilObjectFactory.php:72

References $ilDB, $query, $res, $row, 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.

@access private

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

193 {
194 include_once './Services/WebServices/ECS/classes/class.ilECSEvent.php';
195
196 for($i = 0;$i < self::MAX_TASKS;$i++)
197 {
198 if(!$event = $this->event_reader->shift())
199 {
200 $this->log->write(__METHOD__.': No more pending events found. DONE');
201 break;
202 }
203
204 $this->log->write(print_r($event, true));
205
206 // determine event handler
207
208 $event_ignored = false;
209 switch($event['type'])
210 {
211 case ilECSEventQueueReader::TYPE_REMOTE_COURSE:
212 case ilECSEventQueueReader::TYPE_REMOTE_CATEGORY:
213 case ilECSEventQueueReader::TYPE_REMOTE_FILE:
214 case ilECSEventQueueReader::TYPE_REMOTE_GLOSSARY:
215 case ilECSEventQueueReader::TYPE_REMOTE_GROUP:
216 case ilECSEventQueueReader::TYPE_REMOTE_LEARNING_MODULE:
217 case ilECSEventQueueReader::TYPE_REMOTE_WIKI:
218 case ilECSEventQueueReader::TYPE_REMOTE_TEST:
219 include_once 'Services/WebServices/ECS/classes/class.ilRemoteObjectBase.php';
220 $handler = ilRemoteObjectBase::getInstanceByEventType($event['type']);
221 $this->log->write("got handler ".get_class($handler));
222 break;
223
224 case ilECSEventQueueReader::TYPE_DIRECTORY_TREES:
225 $this->log->debug('Handling new cms tree event.');
226 include_once './Services/WebServices/ECS/classes/Tree/class.ilECSCmsTreeCommandQueueHandler.php';
227 $handler = new ilECSCmsTreeCommandQueueHandler($this->getServer());
228 break;
229
230 case ilECSEventQueueReader::TYPE_CMS_COURSES:
231 include_once './Services/WebServices/ECS/classes/Course/class.ilECSCmsCourseCommandQueueHandler.php';
232 $handler = new ilECSCmsCourseCommandQueueHandler($this->getServer());
233 break;
234
235 case ilECSEventQueueReader::TYPE_CMS_COURSE_MEMBERS:
236 include_once './Services/WebServices/ECS/classes/Course/class.ilECSCmsCourseMemberCommandQueueHandler.php';
237 $handler = new ilECSCmsCourseMemberCommandQueueHandler($this->getServer());
238 break;
239
240 case ilECSEventQueueReader::TYPE_COURSE_URLS:
241 $this->log->write(__METHOD__.': Ignoring event type in queue '.$event['type']);
242 $event_ignored = true;
243 break;
244
245 case ilECSEventQueueReader::TYPE_ENROLMENT_STATUS:
246 include_once './Services/WebServices/ECS/classes/Connectors/class.ilECSEnrolmentStatusCommandQueueHandler.php';
247 $handler = new ilECSEnrolmentStatusCommandQueueHandler($this->getServer());
248 break;
249
250 default:
251
252 $this->log->warning('Unknown type in queue, raising new event handling event: '. $event['type']);
253 $event_ignored = true;
254
255 $GLOBALS['ilAppEventHandler']->raise(
256 'Services/WebServices/ECS',
257 'newEcsEvent',
258 array('event' => $event)
259 );
260 break;
261 }
262
263 if($event_ignored)
264 {
265 $this->event_reader->delete($event['event_id']);
266 continue;
267 }
268
269 $res = false;
270 switch($event['op'])
271 {
272 case ilECSEvent::NEW_EXPORT:
273 // DEPRECATED?
274 // $this->handleNewlyCreate($event['id']);
275 // $this->log->write(__METHOD__.': Handling new creation. DONE');
276 break;
277
278 case ilECSEvent::DESTROYED;
279 $res = $handler->handleDelete($this->getServer(), $event['id'],$this->mids);
280 $this->log->write(__METHOD__.': Handling delete. DONE');
281 break;
282
283 case ilECSEvent::CREATED:
284 $res = $handler->handleCreate($this->getServer(), $event['id'], $this->mids);
285 $this->log->write(__METHOD__.': Handling create. DONE');
286 break;
287
288 case ilECSEvent::UPDATED:
289 $res = $handler->handleUpdate($this->getServer(), $event['id'], $this->mids);
290 $this->log->write(__METHOD__.': Handling update. DONE');
291 break;
292
293 default:
294 $this->log->write(__METHOD__.': Unknown event operation in queue '.$event['op']);
295 break;
296 }
297 if($res)
298 {
299 $this->log->write(__METHOD__.': Processing of event done '.$event['event_id']);
300 $this->event_reader->delete($event['event_id']);
301 }
302 else
303 {
304 $this->log->write(__METHOD__.': Processing of event failed '.$event['event_id']);
305 }
306 }
307 }
ilECSTaskScheduler\getServer
getServer()
Get server setting.
Definition: class.ilECSTaskScheduler.php:134
ilRemoteObjectBase\getInstanceByEventType
static getInstanceByEventType($a_type)
Get instance by ilECSEvent(QueueReader) type.
Definition: class.ilRemoteObjectBase.php:49

References $GLOBALS, $res, ilECSEvent\CREATED, ilECSEvent\DESTROYED, ilRemoteObjectBase\getInstanceByEventType(), getServer(), MAX_TASKS, 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().

+ 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 415 of file class.ilECSTaskScheduler.php.

416 {
417 global $ilLog;
418
419 // Start task execution as backend process
420 include_once 'Services/WebServices/SOAP/classes/class.ilSoapClient.php';
421
422 $soap_client = new ilSoapClient();
423 $soap_client->setResponseTimeout(1);
424 $soap_client->enableWSDL(true);
425
426 $new_session_id = ilSession::_duplicate($_COOKIE['PHPSESSID']);
427 $client_id = $_COOKIE['ilClientId'];
428
429 if($soap_client->init() and 0)
430 {
431 $this->log->info('Calling soap handleECSTasks method...');
432 $res = $soap_client->call('handleECSTasks',array($new_session_id.'::'.$client_id,$this->settings->getServerId()));
433 }
434 else
435 {
436 $this->log->info('SOAP call failed. Calling clone method manually. ');
437 include_once('./webservice/soap/include/inc.soap_functions.php');
438 $res = ilSoapFunctions::handleECSTasks($new_session_id.'::'.$client_id,$this->settings->getServerId());
439 }
440 }
$_COOKIE
$_COOKIE['ilClientId']
Definition: BPMN2Parser.php:15
ilSession\_duplicate
static _duplicate($a_session_id)
Duplicate session.
Definition: class.ilSession.php:280
ilSoapFunctions\handleECSTasks
static handleECSTasks($sid, $a_server_id)
Definition: inc.soap_functions.php:490
$client_id
$client_id
Definition: inc.client_tabs.php:19

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

+ Here is the call graph for this function:

◆ readEvents()

ilECSTaskScheduler::readEvents ( )
private

Read EContent.

@access private

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

173 {
174 try
175 {
176 include_once('./Services/WebServices/ECS/classes/class.ilECSEventQueueReader.php');
177 $this->event_reader = new ilECSEventQueueReader($this->getServer()->getServerId());
178 $this->event_reader->refresh();
179 }
180 catch(ilException $exc)
181 {
182 throw $exc;
183 }
184 }
ilECSEventQueueReader
Reads ECS events and stores them in the database.
Definition: class.ilECSEventQueueReader.php:37
ilException
Base class for ILIAS Exception handling.
Definition: class.ilException.php:35

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.

@access private

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

344 {
345 try
346 {
347 $this->mids = array();
348
349 include_once('./Services/WebServices/ECS/classes/class.ilECSCommunityReader.php');
350 $reader = ilECSCommunityReader::getInstanceByServerId($this->getServer()->getServerId());
351 foreach($reader->getCommunities() as $com)
352 {
353 foreach($com->getParticipants() as $part)
354 {
355 if($part->isSelf())
356 {
357 $this->mids[] = $part->getMID();
358 }
359 }
360 }
361 }
362 catch(ilException $exc)
363 {
364 throw $exc;
365 }
366 }
ilECSCommunityReader\getInstanceByServerId
static getInstanceByServerId($a_server_id)
Get instance by server id.
Definition: class.ilECSCommunityReader.php:98

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

Referenced by startTaskExecution().

+ 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 96 of file class.ilECSTaskScheduler.php.

97 {
98 include_once './Services/Context/classes/class.ilContext.php';
99 if(ilContext::getType() != ilContext::CONTEXT_WEB)
100 {
101 return;
102 }
103
104 include_once './Services/WebServices/ECS/classes/class.ilECSServerSettings.php';
105 $servers = ilECSServerSettings::getInstance();
106 foreach($servers->getServers() as $server)
107 {
108 $sched = new ilECSTaskScheduler($server);
109 if($sched->checkNextExecution())
110 {
111 $sched->initNextExecution();
112 }
113 }
114 }
ilContext\CONTEXT_WEB
const CONTEXT_WEB
Definition: class.ilContext.php:19
ilContext\getType
static getType()
Get context type.
Definition: class.ilContext.php:149
ilECSServerSettings\getInstance
static getInstance()
Get singleton instance.
Definition: class.ilECSServerSettings.php:54
$server
$server
Definition: dummy_client.php:12

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

Referenced by ilInitialisation\initILIAS().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ startExecution()

static ilECSTaskScheduler::startExecution ( )
static

Static version iterates over all active instances.

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

120 {
121 include_once './Services/WebServices/ECS/classes/class.ilECSServerSettings.php';
122 $server = ilECSServerSettings::getInstance();
123 foreach($server->getServers() as $server)
124 {
125 $sched = new ilECSTaskScheduler($server);
126 $sched->startTaskExecution();
127 }
128 }

References $server, and ilECSServerSettings\getInstance().

+ Here is the call graph for this function:

◆ startTaskExecution()

ilECSTaskScheduler::startTaskExecution ( )

Start Tasks.

@access private

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

147 {
148 global $ilLog;
149
150 try
151 {
152 $this->readMIDs();
153 $this->readEvents();
154 $this->handleEvents();
155
156 $this->handleDeprecatedAccounts();
157 }
158 catch(ilException $exc)
159 {
160 $this->log->warning('Cannot start ecs task execution: ' . $exc->getMessage());
161 return false;
162 }
163 return true;
164 }
ilECSTaskScheduler\handleDeprecatedAccounts
handleDeprecatedAccounts()
Delete deprecate ECS accounts.
Definition: class.ilECSTaskScheduler.php:315
ilECSTaskScheduler\readMIDs
readMIDs()
Read MID's of this installation.
Definition: class.ilECSTaskScheduler.php:343

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

+ 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.

Referenced by handleEvents().

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