Reads ECS events and stores them in the database. More...

Collaboration diagram for ilECSEventQueueReader:

Public Member Functions
	__construct (ilECSSetting $settings)
	Constructor. More...

	handleImportReset ()
	Reread all imported econtent. More...

	handleExportReset ()
	Handle export reset. More...

	getServer ()
	get server settings More...

	getEvents ()
	get all events More...

	deleteAll ()
	Delete all events. More...

	deleteAllEContentEvents (array $a_types)
	Delete all econtents. More...

	refresh ()
	Fetch events from fifo Using fifo. More...

	delete ()
	Delete by server id. More...

	shift ()
	get and delete the first event entry More...

	add (string $a_type, int $a_id, string $a_op)
	add More...

	deleteEvent (int $a_event_id)
	delete More...

Static Public Member Functions
static	getAllEContentTypes ()
	All available content types. More...

static	deleteByServerId (int $a_server_id)

Data Fields
const	TYPE_EXPORTED = 'exported'

const	TYPE_DIRECTORY_TREES = 'directory_trees'

const	TYPE_CMS_COURSES = 'courses'

const	TYPE_CMS_COURSE_MEMBERS = 'course_members'

const	TYPE_REMOTE_COURSE = 'rcrs'

const	TYPE_REMOTE_CATEGORY = 'rcat'

const	TYPE_REMOTE_FILE = 'rfil'

const	TYPE_REMOTE_GLOSSARY = 'rglo'

const	TYPE_REMOTE_GROUP = 'rgrp'

const	TYPE_REMOTE_LEARNING_MODULE = 'rlm'

const	TYPE_REMOTE_WIKI = 'rwik'

const	TYPE_REMOTE_TEST = 'rtst'

const	TYPE_COURSE_URLS = 'course_urls'

const	TYPE_ENROLMENT_STATUS = 'member_status'

Protected Member Functions
	deleteAllExportedEvents ()
	Delete all exported events. More...

Static Protected Member Functions
static	getEventTypeFromObjectType (string $a_obj_type)
	Convert object type to event type. More...

static	getAllResourceIds (ilECSSetting $server, array $a_types, bool $a_sender_only=false)
	Get all resource ids by resource type. More...

Protected Attributes
array	$events = array()

array	$econtent_ids = array()

Private Member Functions
	writeEventToDB (ilECSEvent $ev)
	Write event to db. More...

	update (string $a_type, int $a_id, string $a_operation)
	update one entry More...

	read ()
	Read. More...

Private Attributes
ilLogger	$logger

ilDBInterface	$db

ilECSSetting	$settings

Detailed Description

Reads ECS events and stores them in the database.

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

Definition at line 26 of file class.ilECSEventQueueReader.php.

Constructor & Destructor Documentation

◆ __construct()

ilECSEventQueueReader::__construct ( ilECSSetting $settings )

Constructor.

public

Definition at line 55 of file class.ilECSEventQueueReader.php.

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

     {
         global $DIC;
 
         $this->logger = $DIC->logger()->wsrv();
         $this->db = $DIC->database();
 
         $this->settings = $settings;
         $this->read();
     }

Here is the call graph for this function:

Member Function Documentation

◆ add()

ilECSEventQueueReader::add	(	string	$a_type,
		int	$a_id,
		string	$a_op
	)

add

Definition at line 445 of file class.ilECSEventQueueReader.php.

References getServer().

Referenced by handleImportReset().

                                                                 : bool
     {
         $next_id = $this->db->nextId('ecs_events');
         $query = "INSERT INTO ecs_events (event_id,type,id,op,server_id) " .
             "VALUES (" .
             $this->db->quote($next_id, 'integer') . ", " .
             $this->db->quote($a_type, 'text') . ", " .
             $this->db->quote($a_id, 'integer') . ", " .
             $this->db->quote($a_op, 'text') . ", " .
             $this->db->quote($this->getServer()->getServerId(), 'integer') . ' ' .
             ")";
         $this->db->manipulate($query);
 
         $new_event['event_id'] = $next_id;
         $new_event['type'] = $a_type;
         $new_event['id'] = $a_id;
         $new_event['op'] = $a_op;
 
         $this->events[] = $new_event;
         $this->econtent_ids[$a_id] = $a_id;
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ delete()

ilECSEventQueueReader::delete ( )

Delete by server id.

Definition at line 306 of file class.ilECSEventQueueReader.php.

References getServer().

                             : void
     {
         $query = 'DELETE FROM ecs_events ' .
             'WHERE server_id = ' . $this->db->quote($this->getServer()->getServerId(), 'integer');
         $this->db->manipulate($query);
     }

Here is the call graph for this function:

◆ deleteAll()

ilECSEventQueueReader::deleteAll ( )

Delete all events.

Definition at line 237 of file class.ilECSEventQueueReader.php.

References ILIAS\Repository\settings().

                                : bool
     {
         $query = "DELETE FROM ecs_events " .
             'WHERE server_id = ' . $this->db->quote($this->settings->getServerId(), 'integer');
         $this->db->manipulate($query);
         return true;
     }

Here is the call graph for this function:

◆ deleteAllEContentEvents()

ilECSEventQueueReader::deleteAllEContentEvents ( array $a_types )

Delete all econtents.

Definition at line 248 of file class.ilECSEventQueueReader.php.

References getServer().

Referenced by handleImportReset().

                                                            : bool
     {
         $query = "DELETE FROM ecs_events " .
             "WHERE " . $this->db->in("type", $a_types, false, "text") . ' ' .
             'AND server_id = ' . $this->db->quote($this->getServer()->getServerId(), 'integer');
         $this->db->manipulate($query);
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteAllExportedEvents()

ilECSEventQueueReader::deleteAllExportedEvents ( )

protected

Delete all exported events.

Definition at line 260 of file class.ilECSEventQueueReader.php.

References getServer().

Referenced by handleExportReset().

                                                 : bool
     {
         $query = "DELETE FROM ecs_events " .
             "WHERE type = " . $this->db->quote(self::TYPE_EXPORTED, 'text') . ' ' .
             'AND server_id = ' . $this->db->quote($this->getServer()->getServerId(), 'integer');
         $this->db->manipulate($query);
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteByServerId()

static ilECSEventQueueReader::deleteByServerId ( int $a_server_id )

static

Definition at line 517 of file class.ilECSEventQueueReader.php.

References $DIC, and $ilDB.

                                                              : bool
     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         $query = 'DELETE FROM ecs_events' .
             ' WHERE server_id = ' . $ilDB->quote($a_server_id, 'integer');
         $ilDB->manipulate($query);
         return true;
     }

◆ deleteEvent()

ilECSEventQueueReader::deleteEvent ( int $a_event_id )

delete

Definition at line 484 of file class.ilECSEventQueueReader.php.

References getServer().

                                                 : bool
     {
         $query = "DELETE FROM ecs_events " .
             "WHERE event_id = " . $this->db->quote($a_event_id, 'integer') . " " .
             'AND server_id = ' . $this->db->quote($this->getServer()->getServerId(), 'integer');
         $this->db->manipulate($query);
         unset($this->econtent_ids[$a_event_id]);
         return true;
     }

Here is the call graph for this function:

◆ getAllEContentTypes()

static ilECSEventQueueReader::getAllEContentTypes ( )

static

All available content types.

Definition at line 78 of file class.ilECSEventQueueReader.php.

                                                 : array
     {
         return array(self::TYPE_REMOTE_COURSE, self::TYPE_REMOTE_CATEGORY,
             self::TYPE_REMOTE_FILE, self::TYPE_REMOTE_GLOSSARY, self::TYPE_REMOTE_GROUP,
             self::TYPE_REMOTE_LEARNING_MODULE, self::TYPE_REMOTE_WIKI, self::TYPE_REMOTE_TEST);
     }

◆ getAllResourceIds()

static ilECSEventQueueReader::getAllResourceIds	(	ilECSSetting	$server,
		array	$a_types,
		bool	$a_sender_only = `false`
	)

staticprotected

Get all resource ids by resource type.

Parameters

ilECSSetting	$server
	string[]	$a_types
bool	$a_sender_only

Returns: array{int,int[]} type => ids

Definition at line 93 of file class.ilECSEventQueueReader.php.

References ilRemoteObjectBase\getInstanceByEventType().

                                                                                                                   : array
     {
         $list = array();
         foreach ($a_types as $type) {
             $robj = ilRemoteObjectBase::getInstanceByEventType($type);
             if ($robj) {
                 $list[$type] = $robj->getAllResourceIds($server, $a_sender_only);
             }
         }
 
         return $list;
     }

Here is the call graph for this function:

◆ getEvents()

ilECSEventQueueReader::getEvents ( )

get all events

Definition at line 229 of file class.ilECSEventQueueReader.php.

                                : array
     {
         return $this->events ?: array();
     }

◆ getEventTypeFromObjectType()

static ilECSEventQueueReader::getEventTypeFromObjectType ( string $a_obj_type )

staticprotected

Convert object type to event type.

Definition at line 69 of file class.ilECSEventQueueReader.php.

                                                                             : string
     {
         // currently they are the same for all resource types
         return $a_obj_type;
     }

◆ getServer()

ilECSEventQueueReader::getServer ( )

get server settings

Definition at line 220 of file class.ilECSEventQueueReader.php.

References $settings.

Referenced by add(), delete(), deleteAllEContentEvents(), deleteAllExportedEvents(), deleteEvent(), read(), refresh(), and writeEventToDB().

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

Here is the caller graph for this function:

◆ handleExportReset()

ilECSEventQueueReader::handleExportReset ( )

Handle export reset.

Delete exported econtent and create it again

Exceptions

ilException,ilECSConnectorException

Definition at line 183 of file class.ilECSEventQueueReader.php.

References deleteAllExportedEvents(), ilECSExportManager\getInstance(), ILIAS\Repository\logger(), and ILIAS\Repository\settings().

                                        : bool
     {
         // Delete all export events
 
         $this->deleteAllExportedEvents();
 
         // Read all local export info
         $exportManager = ilECSExportManager::getInstance();
         $local_econtent_ids = $exportManager->_getAllEContentIds($this->settings->getServerId());
 
         $types = self::getAllEContentTypes();
         $list = self::getAllResourceIds($this->settings, $types, true);
 
 
         // merge in one array
         $all_remote_ids = [];
         foreach ($list as $resource_type => $remote_ids) {
             $all_remote_ids += (array) $remote_ids;
         }
         $all_remote_ids = array_unique($all_remote_ids);
 
         $this->logger->info(__METHOD__ . ': Resources = ' . print_r($all_remote_ids, true));
         $this->logger->info(__METHOD__ . ': Local = ' . print_r($local_econtent_ids, true));
         foreach ($local_econtent_ids as $local_econtent_id => $local_obj_id) {
             if (!in_array($local_econtent_id, $all_remote_ids, true)) {
                 // Delete this deprecated info
                 $this->logger->info(__METHOD__ . ': Deleting deprecated econtent id ' . $local_econtent_id);
                 $exportManager->_deleteEContentIds($this->settings->getServerId(), array($local_econtent_id));
             }
         }
         return true;
     }

Here is the call graph for this function:

◆ handleImportReset()

ilECSEventQueueReader::handleImportReset ( )

Reread all imported econtent.

Exceptions

ilException,ilECSConnectorException

Definition at line 111 of file class.ilECSEventQueueReader.php.

References ilObject\_lookupType(), add(), ilECSEvent\CREATED, deleteAllEContentEvents(), ilECSEvent\DESTROYED, ilECSImportManager\getInstance(), ilECSUtils\getPossibleRemoteTypes(), ILIAS\Repository\logger(), ILIAS\Repository\settings(), and ilECSEvent\UPDATED.

                                        : bool
     {
         try {
             $types = self::getAllEContentTypes();
 
             $this->deleteAllEContentEvents($types);
 
             $list = self::getAllResourceIds($this->settings, $types);
             $imported = ilECSImportManager::getInstance()->getAllImportedRemoteObjects($this->settings->getServerId());
 
             $this->logger->info(__METHOD__ . ': Imported = ' . print_r($imported, true));
             $this->logger->info(__METHOD__ . ': List = ' . print_r($list, true));
 
             foreach ($list as $resource_type => $link_ids) {
                 if (!in_array($resource_type, ilECSUtils::getPossibleRemoteTypes(), true)) {
                     $this->logger->info(__METHOD__ . ': Ignoring resource type ' . $resource_type);
                     continue;
                 }
 
 
                 foreach ((array) $link_ids as $link_id) {
                     if (!isset($imported[$link_id])) {
                         // Add create event for not imported econtent
                         $this->add(
                             $resource_type,
                             $link_id,
                             ilECSEvent::CREATED
                         );
                     } else {
                         // Add update event for already existing events
                         $this->add(
                             $resource_type,
                             $link_id,
                             ilECSEvent::UPDATED
                         );
                     }
 
                     if (isset($imported[$link_id])) {
                         unset($imported[$link_id]);
                     }
                 }
             }
 
             if (is_array($imported)) {
                 // Delete event for deprecated econtent
                 foreach ($imported as $econtent_id => $obj_id) {
                     $type = self::getEventTypeFromObjectType(ilObject::_lookupType($obj_id));
                     if ($type) {
                         $this->add(
                             $type,
                             $econtent_id,
                             ilECSEvent::DESTROYED
                         );
                     }
                 }
             }
         } catch (ilECSConnectorException $e1) {
             $this->logger->info('Cannot connect to ECS server: ' . $e1->getMessage());
             throw $e1;
         } catch (ilException $e2) {
             $this->logger->info('Update failed: ' . $e2->getMessage());
             throw $e2;
         }
         return true;
     }

Here is the call graph for this function:

◆ read()

ilECSEventQueueReader::read ( )

private

Read.

Definition at line 497 of file class.ilECSEventQueueReader.php.

References $res, ilDBConstants\FETCHMODE_OBJECT, getServer(), and ILIAS\Repository\int().

Referenced by __construct().

                            : bool
     {
         $query = "SELECT * FROM ecs_events  " .
             'WHERE server_id = ' . $this->db->quote($this->getServer()->getServerId(), 'integer') . ' ' .
             'ORDER BY event_id';
 
         $res = $this->db->query($query);
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             $event = [];
             $event['event_id'] = (int) $row->event_id;
             $event['type'] = $row->type;
             $event['id'] = (int) $row->id;
             $event['op'] = $row->op;
             $this->events[] = $event;
 
             $this->econtent_ids[(int) $row->event_id] = (int) $row->event_id;
         }
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ refresh()

ilECSEventQueueReader::refresh ( )

Fetch events from fifo Using fifo.

Exceptions

ilECSConnectorException

Definition at line 274 of file class.ilECSEventQueueReader.php.

References Vendor\Package\$e, $res, getServer(), ILIAS\Repository\logger(), and writeEventToDB().

                              : void
     {
         try {
             $connector = new ilECSConnector($this->getServer());
             while (true) {
                 $res = $connector->readEventFifo(false);
 
                 if (!count($res->getResult())) {
                     return;
                 }
 
                 foreach ($res->getResult() as $result) {
                     $event = new ilECSEvent($result);
 
                     $this->logger->info(__METHOD__ . ' ---------------------------- Handling new event ');
                     $this->logger->info(__METHOD__ . print_r($event, true));
                     $this->logger->info(__METHOD__ . ' ---------------------------- Done! ');
 
                     // Fill command queue
                     $this->writeEventToDB($event);
                 }
                 // Delete from fifo
                 $connector->readEventFifo(true);
             }
         } catch (ilECSConnectorException $e) {
             $this->logger->error(__METHOD__ . ': Cannot read event fifo. Aborting');
         }
     }

Here is the call graph for this function:

◆ shift()

ilECSEventQueueReader::shift ( )

get and delete the first event entry

Returns: array event data or an empty array if the queue is empty

Definition at line 435 of file class.ilECSEventQueueReader.php.

                            : array
     {
         $event = array_shift($this->events);
         return $event ?? [];
     }

◆ update()

ilECSEventQueueReader::update	(	string	$a_type,
		int	$a_id,
		string	$a_operation
	)

private

update one entry

Definition at line 471 of file class.ilECSEventQueueReader.php.

References ILIAS\Repository\settings().

                                                                            : void
     {
         $query = "UPDATE ecs_events " .
             "SET op = " . $this->db->quote($a_operation, 'text') . " " .
             "WHERE type = " . $this->db->quote($a_type, 'text') . " " .
             "AND id = " . $this->db->quote($a_id, 'integer') . " " .
             'AND server_id = ' . $this->db->quote($this->settings->getServerId(), 'integer');
         $this->db->manipulate($query);
     }

Here is the call graph for this function:

◆ writeEventToDB()

ilECSEventQueueReader::writeEventToDB ( ilECSEvent $ev )

private

Write event to db.

Definition at line 316 of file class.ilECSEventQueueReader.php.

References $res, ilECSEvent\CREATED, ilECSEvent\DESTROYED, ilDBConstants\FETCHMODE_OBJECT, ilECSEvent\getRessourceId(), ilECSEvent\getRessourceType(), getServer(), ilECSEvent\getStatus(), and ilECSEvent\UPDATED.

Referenced by refresh().

                                                    : void
     {
         // this should probably be moved elsewhere
         switch ($ev->getRessourceType()) {
             case 'directory_trees':
                 $type = self::TYPE_DIRECTORY_TREES;
                 break;
 
             case 'course_members':
                 $type = self::TYPE_CMS_COURSE_MEMBERS;
                 break;
 
             case 'courses':
                 $type = self::TYPE_CMS_COURSES;
                 break;
 
             case 'courselinks':
                 $type = self::TYPE_REMOTE_COURSE;
                 break;
 
             case 'categories':
                 $type = self::TYPE_REMOTE_CATEGORY;
                 break;
 
             case 'files':
                 $type = self::TYPE_REMOTE_FILE;
                 break;
 
             case 'glossaries':
                 $type = self::TYPE_REMOTE_GLOSSARY;
                 break;
 
             case 'groups':
                 $type = self::TYPE_REMOTE_GROUP;
                 break;
 
             case 'learningmodules':
                 $type = self::TYPE_REMOTE_LEARNING_MODULE;
                 break;
 
             case 'wikis':
                 $type = self::TYPE_REMOTE_WIKI;
                 break;
 
             case 'tests':
                 $type = self::TYPE_REMOTE_TEST;
                 break;
 
             case 'course_urls':
                 $type = self::TYPE_COURSE_URLS;
                 break;
 
             case 'member_status':
                 $type = self::TYPE_ENROLMENT_STATUS;
                 break;
 
             default:
                 // write custom event type
                 $type = $ev->getRessourceType();
                 break;
         }
 
         $query = "SELECT * FROM ecs_events " .
             "WHERE type = " . $this->db->quote($type, 'text') . " " .
             "AND id = " . $this->db->quote($ev->getRessourceId(), 'integer') . " " .
             'AND server_id = ' . $this->db->quote($this->getServer()->getServerId(), 'integer');
         $res = $this->db->query($query);
 
         $event_id = 0;
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             $event_id = $row->event_id;
         }
 
         if (!$event_id) {
             // No previous entry exists => perform insert
             $query = "INSERT ecs_events (event_id,type,id,op,server_id) " .
                 "VALUES( " .
                 $this->db->quote($this->db->nextId('ecs_events'), 'integer') . ',' .
                 $this->db->quote($type, 'text') . ', ' .
                 $this->db->quote($ev->getRessourceId(), 'integer') . ', ' .
                 $this->db->quote($ev->getStatus(), 'text') . ', ' .
                 $this->db->quote($this->getServer()->getServerId(), 'integer') . ' ' .
                 ')';
             $this->db->manipulate($query);
             return;
         }
         // Do update
         $do_update = false;
         switch ($ev->getStatus()) {
             case ilECSEvent::CREATED:
                 // Do update, although impossible
                 $do_update = true;
                 break;
 
             case ilECSEvent::DESTROYED:
                 $do_update = true;
                 break;
 
             case ilECSEvent::UPDATED:
                 // Do nothing. Old status is ok.
                 break;
         }
 
         if (!$do_update) {
             return;
         }
         $query = "UPDATE ecs_events " .
             "SET op = " . $this->db->quote($ev->getStatus(), 'text') . " " .
             "WHERE event_id = " . $this->db->quote($event_id, 'integer') . ' ' .
             'AND type = ' . $this->db->quote($type, 'text') . ' ' .
             'AND server_id = ' . $this->db->quote($this->getServer()->getServerId(), 'integer');
         $this->db->manipulate($query);
     }