class.ilCmiXapiStatementsReportLinkBuilder.php

Go to the documentation of this file.

<?php

/* Copyright (c) 1998-2019 ILIAS open source, Extended GPL, see docs/LICENSE */


class ilCmiXapiStatementsReportLinkBuilder extends ilCmiXapiAbstractReportLinkBuilder
{
    protected function buildPipeline() : array
    {
        $pipeline = array();
        
        $pipeline[] = $this->buildFilterStage();

        $pipeline[] = $this->buildOrderingStage();
        
        $pipeline[] = array('$facet' => array(
            'stage1' => array(
                array('$group' => array('_id' => null, 'count' => array('$sum' => 1) ))
            ),
            'stage2' => $this->buildLimitStage()
        ));
        
        $pipeline[] = array('$unwind' => '$stage1');
        
        $pipeline[] = array('$project' => array(
                'maxcount' => '$stage1.count',
                'statements' => '$stage2.statement'
        ));
        
        $log = ilLoggerFactory::getLogger('cmix');
        //$log->debug("aggregation pipeline:\n" . json_encode($pipeline, JSON_PRETTY_PRINT));
        
        return $pipeline;
    }
    
    protected function buildLimitStage()
    {
        $stage = array(
            array('$skip' => (int) $this->filter->getOffset())
        );
        
        if ($this->filter->getLimit()) {
            $stage[] = array('$limit' => (int) $this->filter->getLimit());
        }
        return $stage;
    }
    
    protected function buildFilterStage()
    {
        $cmi5_extensions_query = false;

        $stage = array();
        $stage['statement.object.objectType'] = 'Activity';
        $stage['statement.actor.objectType'] = 'Agent';
        if ($this->filter->getVerb()) {
            $stage['statement.verb.id'] = $this->filter->getVerb();
        }
        
        if ($this->filter->getStartDate() || $this->filter->getEndDate()) {
            $stage['statement.timestamp'] = array();
            
            if ($this->filter->getStartDate()) {
                $stage['statement.timestamp']['$gt'] = $this->filter->getStartDate()->toXapiTimestamp();
            }
            
            if ($this->filter->getEndDate()) {
                $stage['statement.timestamp']['$lt'] = $this->filter->getEndDate()->toXapiTimestamp();
            }
        }

        $obj = $this->getObj();
        $activityId = array();

        if ($cmi5_extensions_query == true && $obj->getContentType() == ilObjCmiXapi::CONT_TYPE_CMI5 && !$obj->isMixedContentType())
        {
            // https://github.com/AICC/CMI-5_Spec_Current/blob/quartz/cmi5_spec.md#963-extensions
            $activityId['statement.context.extensions.https://ilias&46;de/cmi5/activityid'] = $obj->getActivityId();
        }
        else
        {
            // for case-insensive: '$regex' => '(?i)^' . preg_quote($this->filter->getActivityId()) . ''
            $activityQuery = [
                '$regex' => '^' . preg_quote($this->filter->getActivityId()) . ''
            ];
            $activityId['$or'] = [];
            // ToDo : restriction to exact activityId?
            // query existing activityId in grouping? we have not enough control over acticityId in xapi statements  
            // another way put the obj_id into a generated registration, but we are not sure that content will put this into statement context 
            // $activityId['$or'][] = ['statement.object.id' => "{$this->filter->getActivityId()}"];
            $activityId['$or'][] = ['statement.object.id' => $activityQuery];
            $activityId['$or'][] = ['statement.context.contextActivities.parent.id' => $activityQuery];
            $activityId['$or'][] = ['statement.context.contextActivities.grouping.id' => $activityQuery];
        }

        $actor = array();
        
        // mixed
        if ($obj instanceof ilObjCmiXapi && $obj->isMixedContentType())
        {
            if ($this->filter->getActor())
            {
                // could be registration query but so what...
                foreach (ilCmiXapiUser::getUserIdents($this->getObjId(), $this->filter->getActor()->getUsrId()) as $usrIdent)
                {
                    $actor['$or'][] = ['statement.actor.mbox' => "mailto:{$usrIdent}"]; // older statements
                    $actor['$or'][] = ['statement.actor.account.name' => "{$usrIdent}"];   
                }
                // not launched yet?
                if (count($actor) == 0)
                {
                    $actor['$or'][] = ['statement.actor.mbox' => "mailto:{$this->filter->getActor()->getUsrIdent()}"]; // older statements
                    $actor['$or'][] = ['statement.actor.account.name' => "{$this->filter->getActor()->getUsrIdent()}"];
                }
            }
            else
            {
                $actor['$or'] = [];
                foreach (ilCmiXapiUser::getUsersForObject($this->getObjId()) as $cmixUser) {
                    $actor['$or'][] = ['statement.actor.mbox' => "mailto:{$cmixUser->getUsrIdent()}"];
                    $actor['$or'][] = ['statement.actor.account.name' => "{$cmixUser->getUsrIdent()}"];
                }
            }
        }
        elseif ($obj instanceof ilObjCmiXapi && $obj->getContentType() == ilObjCmiXapi::CONT_TYPE_CMI5)
        {
            if ($this->filter->getActor())
            {
                $cmixUser = $this->filter->getActor();
                $actor['statement.context.registration'] = $cmixUser->getRegistration();
            }
        }
        else
        {
            if ($this->filter->getActor())
            {
                foreach (ilCmiXapiUser::getUserIdents($this->getObjId(), $this->filter->getActor()->getUsrId()) as $usrIdent)
                {
                    $actor['$or'][] = ['statement.actor.mbox' => "mailto:{$usrIdent}"];   
                }
                // not launched yet?
                if (count($actor) == 0)
                {
                    $actor['statement.actor.mbox'] = $this->filter->getActor()->getUsrIdent();
                }
            }
            else
            {
                $actor['$or'] = [];
                foreach (ilCmiXapiUser::getUsersForObject($this->getObjId()) as $cmixUser) {
                    $actor['$or'][] = ['statement.actor.mbox' => "mailto:{$cmixUser->getUsrIdent()}"];
                }
            }
        }
        $stage['$and'] = [];
        $stage['$and'][] = $activityId;
        if (count($actor) > 0) {
            $stage['$and'][] = $actor;
        }
        return array('$match' => $stage);
    }
    
    protected function buildOrderingStage()
    {
        $obj = $this->getObj();
        $actor = '';
        if ($obj instanceof ilObjLTIConsumer) {
            if ($obj->getProvider()->getPrivacyName() != ilObjCmiXapi::PRIVACY_NAME_NONE) {
                $actor = 'statement.actor.name';
            }
        } else {
            if ($obj->getPrivacyName() != ilObjCmiXapi::PRIVACY_NAME_NONE) {
                $actor = 'statement.actor.name';
            } else {
                if ($obj->getContentType() == ilObjCmiXapi::CONT_TYPE_CMI5) {
                    if ($obj->getPublisherId() == '') // old
                    {
                        $actor = 'statement.actor.mbox';
                    } else {
                        $actor = 'statement.actor.account.name';
                    }

                } else {
                    $actor = 'statement.actor.mbox';
                }
            }
        }
        switch ($this->filter->getOrderField()) {
            case 'object': // definition/description are displayed in the Table if not empty => sorting not alphabetical on displayed fields
                $field = 'statement.object.id';
                break;
                
            case 'verb':
                $field = 'statement.verb.id';
                break;
                
            case 'actor':
                $field = $actor;
                break;
                
            case 'date':
            default:
                $field = 'statement.timestamp';
                break;
        }
        
        $orderingFields = array(
            $field => $this->filter->getOrderDirection() == 'desc' ? -1 : 1
        );
        
        return array('$sort' => $orderingFields);
    }
}