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

Collaboration diagram for ilECSEventQueueReader:

Public Member Functions
	__construct ($a_server_id)
	Constructor.
	getServer ()
	get server setting
	getEvents ()
	get all events
	deleteAll ()
	Delete all events.
	deleteAllEContentEvents (array $a_types)
	Delete all econtents.
	refresh ()
	Fetch events from fifo Using fifo public.
	shift ()
	get and delete the first event entry
	add ($a_type, $a_id, $a_op)
	add
	delete ($a_event_id)
	delete private
	read ()
	Read public.

Static Public Member Functions
static	handleImportReset (ilECSSetting $server)
	Reread all imported econtent.
static	handleExportReset (ilECSSetting $server)
	Handle export reset.
static	deleteServer ($a_server_id)
	Delete by server id ilDB $ilDB.
static	deleteByServerId ($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.

Static Protected Member Functions
static	getEventTypeFromObjectType ($a_obj_type)
	Convert object type to event type.
static	getAllEContentTypes ()
	All available content types.
static	getAllResourceIds (ilECSSetting $server, array $a_types, $a_sender_only=false)
	Get all resource ids by resource type.

Protected Attributes
	$log
	$db
	$events = array()
	$econtent_ids = array()

Private Member Functions
	writeEventToDB (ilECSEvent $ev)
	Write event to db.
	update ($a_type, $a_id, $a_operation)
	update one entry

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

Version: $Id$

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

Constructor & Destructor Documentation

ilECSEventQueueReader::__construct ( $a_server_id )

Constructor.

public

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

References $ilDB, $ilLog, ilECSSetting\getInstanceByServerId(), and read().

        {
                global $ilLog,$ilDB;
                
                include_once('Services/WebServices/ECS/classes/class.ilECSSetting.php');
                
                $this->settings = ilECSSetting::getInstanceByServerId($a_server_id);
                $this->log = $ilLog;
                $this->db = $ilDB;
                
                $this->read();
        }

Here is the call graph for this function:

Member Function Documentation

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

add

public

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

References $ilDB, $query, $res, and getServer().

        {
                global $ilDB;
                $next_id = $ilDB->nextId('ecs_events');
                $query = "INSERT INTO ecs_events (event_id,type,id,op,server_id) ".
                        "VALUES (".
                        $ilDB->quote($next_id,'integer').", ".
                        $this->db->quote($a_type,'text').", ".
                        $this->db->quote($a_id,'integer').", ".
                        $this->db->quote($a_op,'text').", ".
                        $ilDB->quote($this->getServer()->getServerId(),'integer').' '.
                        ")";
                $res = $ilDB->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:

ilECSEventQueueReader::delete ( $a_event_id )

delete private

Parameters

int event id

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

References $ilDB, $query, $res, and getServer().

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

Here is the call graph for this function:

ilECSEventQueueReader::deleteAll ( )

Delete all events.

public

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

References $ilDB, $query, $res, and getServer().

        {
                global $ilDB;
                
                $query = "DELETE FROM ecs_events ".
                        'WHERE server_id = '.$ilDB->quote($this->getServer()->getServerId(),'integer');
                $res = $ilDB->manipulate($query);
                return true;
        }

Here is the call graph for this function:

ilECSEventQueueReader::deleteAllEContentEvents ( array $a_types )

Delete all econtents.

public

Parameters

array $a_types

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

References $ilDB, $query, $res, and getServer().

Referenced by handleImportReset().

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

Here is the call graph for this function:

Here is the caller graph for this function:

ilECSEventQueueReader::deleteAllExportedEvents ( )

protected

Delete all exported events.

public

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

References $ilDB, $query, $res, and getServer().

Referenced by handleExportReset().

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

Here is the call graph for this function:

Here is the caller graph for this function:

static ilECSEventQueueReader::deleteByServerId ( $a_server_id )

static

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

References $ilDB, and $query.

Referenced by ilECSSetting\delete().

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

Here is the caller graph for this function:

static ilECSEventQueueReader::deleteServer ( $a_server_id )

static

Delete by server id ilDB $ilDB.

Parameters

int $a_server_id

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

References $ilDB, and $query.

Referenced by ilECSSettingsGUI\doDelete().

        {
                global $ilDB;
                $query = 'DELETE FROM ecs_events '.
                        'WHERE server_id = '.$ilDB->quote($a_server_id,'integer');
                $ilDB->manipulate($query);
        }

Here is the caller graph for this function:

static ilECSEventQueueReader::getAllEContentTypes ( )

staticprotected

All available content types.

Returns: array

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

Referenced by handleExportReset(), and handleImportReset().

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

Here is the caller graph for this function:

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

staticprotected

Get all resource ids by resource type.

Parameters

ilECSSetting	$server
array	$a_types
bool	$a_sender_only

Returns: array type => ids

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

References ilRemoteObjectBase\getInstanceByEventType().

Referenced by handleExportReset(), and handleImportReset().

        {
                include_once 'Services/WebServices/ECS/classes/class.ilRemoteObjectBase.php';
                $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:

Here is the caller graph for this function:

ilECSEventQueueReader::getEvents ( )

get all events

public

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

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

static ilECSEventQueueReader::getEventTypeFromObjectType ( $a_obj_type )

staticprotected

Convert object type to event type.

Parameters

string $a_obj_type

Returns: string

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

Referenced by handleImportReset().

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

Here is the caller graph for this function:

ilECSEventQueueReader::getServer ( )

get server setting

Returns: ilECSSetting

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

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

         {
                 return $this->settings;
         }

Here is the caller graph for this function:

static ilECSEventQueueReader::handleExportReset ( ilECSSetting $server )

static

Handle export reset.

Delete exported econtent and create it again

Returns: bool throws ilException, ilECSConnectorException

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

References $GLOBALS, ilECSExport\_deleteEContentIds(), ilECSExport\_getAllEContentIds(), deleteAllExportedEvents(), getAllEContentTypes(), getAllResourceIds(), and ilECSSetting\getServerId().

Referenced by ilECSSettingsGUI\readAll().

         {
                include_once('./Services/WebServices/ECS/classes/class.ilECSExport.php');
                // Delete all export events
                $queue = new ilECSEventQueueReader($server->getServerId());
                $queue->deleteAllExportedEvents();
                // Read all local export info
                $local_econtent_ids = ilECSExport::_getAllEContentIds($server->getServerId());
                $types = self::getAllEContentTypes();                                   
                $list = self::getAllResourceIds($server, $types, true);
                
                
                // merge in one array
                $all_remote_ids = array();
                foreach($list as $resource_type => $remote_ids)
                {
                        $all_remote_ids = array_merge($all_remote_ids,(array) $remote_ids);
                }
                $all_remote_ids = array_unique($all_remote_ids);
                
                $GLOBALS['ilLog']->write(__METHOD__.': Resources = ' . print_r($all_remote_ids,true));
                $GLOBALS['ilLog']->write(__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))
                        {
                                // Delete this deprecated info
                                $GLOBALS['ilLog']->write(__METHOD__.': Deleting deprecated econtent id '. $local_econtent_id);
                                ilECSExport::_deleteEContentIds($server->getServerId(),array($local_econtent_id));
                                
                        }
                }
                return true;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

static ilECSEventQueueReader::handleImportReset ( ilECSSetting $server )

static

Reread all imported econtent.

Returns: bool throws ilException, ilECSConnectorException

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

References $GLOBALS, $ilLog, ilObject\_lookupType(), ilECSEvent\CREATED, deleteAllEContentEvents(), ilECSEvent\DESTROYED, getAllEContentTypes(), ilECSImport\getAllImportedRemoteObjects(), getAllResourceIds(), getEventTypeFromObjectType(), ilECSUtils\getPossibleRemoteTypes(), ilECSSetting\getServerId(), and ilECSEvent\UPDATED.

Referenced by ilECSSettingsGUI\readAll().

         {
                global $ilLog;
                
                include_once('Services/WebServices/ECS/classes/class.ilECSConnector.php');
                include_once('Services/WebServices/ECS/classes/class.ilECSConnectorException.php');
                
                try
                {
                        include_once('./Services/WebServices/ECS/classes/class.ilECSEventQueueReader.php');
                        include_once('./Services/WebServices/ECS/classes/class.ilECSImport.php');
                        include_once('./Services/WebServices/ECS/classes/class.ilECSExport.php');
                        $types = self::getAllEContentTypes();
                        $event_queue = new ilECSEventQueueReader($server->getServerId());
                        $event_queue->deleteAllEContentEvents($types);
                        
                        $list = self::getAllResourceIds($server, $types);                                               
                        $imported = ilECSImport::getAllImportedRemoteObjects($server->getServerId());
                        
                        $GLOBALS['ilLog']->write(__METHOD__.': Imported = '.print_r($imported,true));
                        $GLOBALS['ilLog']->write(__METHOD__.': List = '.print_r($list,true));
                        
                        foreach($list as $resource_type => $link_ids)
                        {
                                if(!in_array($resource_type, ilECSUtils::getPossibleRemoteTypes()))
                                {
                                        $GLOBALS['ilLog']->write(__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
                                                $event_queue->add(
                                                        $resource_type,
                                                        $link_id,
                                                        ilECSEvent::CREATED
                                                );
                                        }
                                        else
                                        {
                                                // Add update event for already existing events
                                                $event_queue->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
                                include_once 'Services/WebServices/ECS/classes/class.ilECSObjectSettings.php';
                                foreach($imported as $econtent_id => $obj_id)
                                {
                                        $type = self::getEventTypeFromObjectType(ilObject::_lookupType($obj_id));
                                        if($type)
                                        {                                               
                                                $event_queue->add($type,
                                                        $econtent_id,
                                                        ilECSEvent::DESTROYED
                                                );
                                        }                                       
                                }
                        }
                }
                catch(ilECSConnectorException $e1)
                {
                        $ilLog->write('Cannot connect to ECS server: '.$e1->getMessage());
                        throw $e1;
                }
                catch(ilException $e2)
                {
                        $ilLog->write('Update failed: '.$e2->getMessage());
                        throw $e2;
                }
                return true;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

ilECSEventQueueReader::read ( )

Read public.

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

References $ilDB, $query, $res, $row, DB_FETCHMODE_OBJECT, and getServer().

Referenced by __construct().

        {
                global $ilDB;
                
                $query = "SELECT * FROM ecs_events  ".
                        'WHERE server_id = '.$ilDB->quote($this->getServer()->getServerId(),'integer').' '.
                        'ORDER BY event_id';
                
                $res = $this->db->query($query);
                $counter = 0;
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $this->events[$counter]['event_id'] = $row->event_id;
                        $this->events[$counter]['type'] = $row->type;
                        $this->events[$counter]['id'] = $row->id;
                        $this->events[$counter]['op'] = $row->op;
                        
                        $this->econtent_ids[$row->event_id] = $row->event_id;
                        ++$counter;
                }
                return true;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilECSEventQueueReader::refresh ( )

Fetch events from fifo Using fifo public.

Exceptions

ilECSConnectorException

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

References $GLOBALS, $res, $result, getServer(), and writeEventToDB().

        {
                try {
                        include_once('Services/WebServices/ECS/classes/class.ilECSConnector.php');
                        include_once('Services/WebServices/ECS/classes/class.ilECSConnectorException.php');
                        $connector = new ilECSConnector($this->getServer());
                        while(true)
                        {
                                $res = $connector->readEventFifo(false);
                                if(!count($res->getResult()))
                                {
                                        return true;
                                }
                                foreach($res->getResult() as $result)
                                {                                       
                                        include_once './Services/WebServices/ECS/classes/class.ilECSEvent.php';
                                        $event = new ilECSEvent($result);
                                        $GLOBALS['ilLog']->write(__METHOD__.' ---------------------------- Handling new event ');
                                        $GLOBALS['ilLog']->write(__METHOD__.print_r($event,true));
                                        $GLOBALS['ilLog']->write(__METHOD__.' ---------------------------- Done! ');
                                        // Fill command queue
                                        $this->writeEventToDB($event);
                                }
                                // Delete from fifo
                                $connector->readEventFifo(true);
                        }
                }
                catch(ilECSConnectorException $e)
                {
                        $GLOBALS['ilLog']->write(__METHOD__.': Cannot read event fifo. Aborting');
                }
        }

Here is the call graph for this function:

ilECSEventQueueReader::shift ( )

get and delete the first event entry

public

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

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

        {
                $event = array_shift($this->events);
                if($event == null)
                {
                        return array();
                }
                else
                {
                        
                        #$this->delete($event['event_id']);
                        return $event;
                }
        }

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

private

update one entry

private

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

References $ilDB, $query, $res, and getServer().

        {
                global $ilDB;
                
                $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 = '.$ilDB->quote($this->getServer()->getServerId(),'integer');
                $res = $ilDB->manipulate($query);
        }

Here is the call graph for this function:

ilECSEventQueueReader::writeEventToDB ( ilECSEvent $ev )

private

Write event to db.

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

References $ilDB, $query, $res, $row, ilECSEvent\CREATED, DB_FETCHMODE_OBJECT, ilECSEvent\DESTROYED, ilECSEvent\getRessourceId(), ilECSEvent\getRessourceType(), getServer(), ilECSEvent\getStatus(), TYPE_CMS_COURSE_MEMBERS, TYPE_CMS_COURSES, TYPE_COURSE_URLS, TYPE_DIRECTORY_TREES, TYPE_ENROLMENT_STATUS, TYPE_REMOTE_CATEGORY, TYPE_REMOTE_COURSE, TYPE_REMOTE_FILE, TYPE_REMOTE_GLOSSARY, TYPE_REMOTE_GROUP, TYPE_REMOTE_LEARNING_MODULE, TYPE_REMOTE_TEST, TYPE_REMOTE_WIKI, and ilECSEvent\UPDATED.

Referenced by refresh().

        {
                global $ilDB;
                // 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;
                }
                $query = "SELECT * FROM ecs_events ".
                        "WHERE type = ".$ilDB->quote($type,'integer')." ".
                        "AND id = ".$ilDB->quote($ev->getRessourceId(),'integer')." ".
                        'AND server_id = '.$ilDB->quote($this->getServer()->getServerId(),'integer');
                $res = $ilDB->query($query);
                $event_id = 0;
                while($row = $res->fetchRow(DB_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( ".
                                $ilDB->quote($ilDB->nextId('ecs_events'),'integer').','.
                                $ilDB->quote($type,'text').', '.
                                $ilDB->quote($ev->getRessourceId(),'integer').', '.
                                $ilDB->quote($ev->getStatus(),'text').', '.
                                $ilDB->quote($this->getServer()->getServerId(),'integer').' '.
                                ')';
                        $ilDB->manipulate($query);
                        return true;
                }
                // 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 true;
                }
                $query = "UPDATE ecs_events ".
                        "SET op = ".$ilDB->quote($ev->getStatus(),'text')." ".
                        "WHERE event_id = ".$ilDB->quote($event_id,'integer').' '.
                        'AND type = '.$ilDB->quote($type).' '.
                        'AND server_id = '.$ilDB->quote($this->getServer()->getServerId(),'integer');
                $ilDB->manipulate($query);
                return true;
        }