class.ilParticipants.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2010 ILIAS open source, Extended GPL, see docs/LICENSE */
 
define("IL_CRS_ADMIN", 1);
define("IL_CRS_TUTOR", 3);
define("IL_CRS_MEMBER", 2);
 
define('IL_GRP_ADMIN', 4);
define('IL_GRP_MEMBER', 5);
 
define('IL_SESS_MEMBER', 6);
 
define('IL_LSO_ADMIN', 7);
define('IL_LSO_MEMBER', 8);
 
define("IL_ROLE_POSITION_ADMIN", 1);
define("IL_ROLE_POSITION_TUTOR", 2);
define("IL_ROLE_POSITION_MEMBER", 3);
 
 
abstract class ilParticipants
{
    protected $component = '';
    
    protected $obj_id = 0;
    protected $type = '';
    protected $ref_id = 0;
    
    protected $roles = array();
    protected $role_data = array();
    protected $roles_sorted = [];
    protected $role_assignments = [];
    
    protected $participants = array();
    protected $participants_status = array();
    protected $members = array();
    protected $tutors = array();
    protected $admins = array();
    
    protected $subscribers = array();
    
    protected $ilDB;
    
    protected $lng;
    
    protected $logger = null;
 
    protected $recommended_content_manager;
 
    public function __construct($a_component_name, $a_ref_id)
    {
        $this->ilDB = $GLOBALS['DIC']->database();
        $this->lng = $GLOBALS['DIC']->language();
        $this->logger = $GLOBALS['DIC']->logger()->mem();
     
        $this->component = $a_component_name;
        
        $this->ref_id = $a_ref_id;
        $this->obj_id = ilObject::_lookupObjId($a_ref_id);
        $this->type = ilObject::_lookupType($this->obj_id);
        
        $this->readParticipants();
        $this->readParticipantsStatus();
        $this->recommended_content_manager = new ilRecommendedContentManager();
    }
    
    public static function getInstance($a_ref_id)
    {
        $obj_id = ilObject::_lookupObjId($a_ref_id);
        $type = ilObject::_lookupType($obj_id);
        
        switch ($type) {
            case 'crs':
            case 'grp':
            case 'lso':
                return self::getInstanceByObjId($obj_id);
            case 'sess':
                include_once './Modules/Session/classes/class.ilSessionParticipants.php';
                return ilSessionParticipants::getInstance($a_ref_id);
            default:
                $GLOBALS['DIC']->logger()->mem()->logStack();
                $GLOBALS['DIC']->logger()->mem()->warning('Invalid ref_id -> obj_id given: ' . $a_ref_id . ' -> ' . $obj_id);
                throw new \InvalidArgumentException('Invalid obj_id given.');
        }
    }
    
    public static function getInstanceByObjId($a_obj_id)
    {
        $type = ilObject::_lookupType($a_obj_id);
        switch ($type) {
            case 'crs':
                include_once './Modules/Course/classes/class.ilCourseParticipants.php';
                return ilCourseParticipants::_getInstanceByObjId($a_obj_id);
                
            case 'grp':
                include_once './Modules/Group/classes/class.ilGroupParticipants.php';
                return ilGroupParticipants::_getInstanceByObjId($a_obj_id);
                
            case 'sess':
                include_once './Modules/Session/classes/class.ilSessionParticipants.php';
                return ilSessionParticipants::_getInstanceByObjId($a_obj_id);
            case 'lso':
                return ilLearningSequenceParticipants::_getInstanceByObjId($a_obj_id);
            default:
                $GLOBALS['DIC']->logger()->mmbr()->logStack(ilLogLevel::WARNING);
                $GLOBALS['DIC']->logger()->mmbr()->warning(': Invalid obj_id given: ' . $a_obj_id);
                throw new InvalidArgumentException('Invalid obj id given');
        }
    }
    
    protected function getComponent()
    {
        return $this->component;
    }
    
 
    
    public static function hasParticipantListAccess($a_obj_id, $a_usr_id = null)
    {
        global $DIC;
 
        $access = $DIC->access();
 
        if (!$a_usr_id) {
            $a_usr_id = $GLOBALS['DIC']['ilUser']->getId();
        }
 
        // if write access granted => return true
        $refs = ilObject::_getAllReferences($a_obj_id);
        $ref_id = end($refs);
 
        if ($access->checkAccess('manage_members', '', $ref_id)) {
            return true;
        }
        $part = self::getInstance($ref_id);
        if ($part->isAssigned($a_usr_id)) {
            if ($part->getType() == 'crs') {
                if (!ilObjCourse::lookupShowMembersEnabled($a_obj_id)) {
                    return false;
                }
            }
            if ($part->getType() == 'grp') {
                if (!ilObjGroup::lookupShowMembersEnabled($a_obj_id)) {
                    return false;
                }
            }
            return true;
        }
        // User is not assigned to course/group => no read access
        return false;
    }
 
    public static function canSendMailToMembers(
        $ref_id_or_instance,
        ?int $usr_id = null,
        ?int $mail_obj_ref_id = null
    ) : bool {
        global $DIC;
 
        $access = $DIC->access();
        $rbacsystem = $DIC->rbac()->system();
 
        if (is_null($usr_id)) {
            $usr_id = $DIC->user()->getId();
        }
        if (is_null($mail_obj_ref_id)) {
            $mail_obj_ref_id = (new ilMail($usr_id))->getMailObjectReferenceId();
        }
        if (is_int($ref_id_or_instance)) {
            $ref_id = $ref_id_or_instance;
        } elseif ($ref_id_or_instance instanceof ilObject) {
            $ref_id = (int) $ref_id_or_instance->getRefId();
            if ($ref_id === 0) {
                $ref_id = array_keys(ilObject::_getAllReferences($ref_id_or_instance->getId()))[0];
            }
        } else {
            return false;
        }
 
        if (
            $access->checkAccess('manage_members', '', $ref_id) &&
            $rbacsystem->checkAccess('internal_mail', $mail_obj_ref_id)
        ) {
            return true;
        }
 
        $part = self::getInstance($ref_id);
        if (!$part->isAssigned($usr_id)) {
            return false;
        }
 
        $object = $ref_id_or_instance;
        if (is_int($ref_id_or_instance)) {
            $object = ilObjectFactory::getInstanceByRefId($ref_id_or_instance);
        }
 
        if ($object instanceof ilObjCourse) {
            return $object->getMailToMembersType() == ilCourseConstants::MAIL_ALLOWED_ALL;
        } elseif ($object instanceof ilObjGroup) {
            return $object->getMailToMembersType() == ilObjGroup::MAIL_ALLOWED_ALL;
        } elseif ($object instanceof ilObjSession) {
            return $object->getMailToMembersType() == ilObjSession::MAIL_ALLOWED_ALL;
        }
 
        return false;
    }
 
 
    public static function getUserMembershipAssignmentsByType($a_user_ids, $a_type, $a_only_member_roles)
    {
        global $DIC;
 
        $logger = $DIC->logger()->mmbr();
        $ilDB = $DIC->database();
 
        if ($a_only_member_roles) {
            $j2 = "JOIN object_data obd2 ON (ua.rol_id = obd2.obj_id) ";
            $a2 = 'AND obd2.title = ' . $ilDB->concat(
                array(
                        array($ilDB->quote('il_', 'text')),
                        array('obd.type'),
                        array($ilDB->quote('_member_', 'text')),
                        array('obr.ref_id'),
                    ),
                false
            );
        }
 
        $query = "SELECT DISTINCT obd.obj_id,obr.ref_id,ua.usr_id FROM rbac_ua ua " .
            "JOIN rbac_fa fa ON ua.rol_id = fa.rol_id " .
            "JOIN object_reference obr ON fa.parent = obr.ref_id " .
            "JOIN object_data obd ON obr.obj_id = obd.obj_id " .
            $j2 .
            "WHERE " . $ilDB->in("obd.type", $a_type, false, "text") .
            "AND fa.assign = 'y' " .
            'AND ' . $ilDB->in('ua.usr_id', $a_user_ids, false, 'integer') . ' ' .
            $a2;
        
        $obj_ids = [];
        $res = $ilDB->query($query);
        while ($row = $ilDB->fetchObject($res)) {
            $obj_ids[$row->obj_id][] = $row->usr_id;
        }
 
        $logger->dump($obj_ids, \ilLogLevel::DEBUG);
 
        return $obj_ids;
    }
 
    public static function _getMembershipByType($a_usr_id, $a_type, $a_only_member_role = false)
    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        if (!is_array($a_type)) {
            $a_type = array($a_type);
        }
 
        // this will also dismiss local roles!
        if ($a_only_member_role) {
            $j2 = "JOIN object_data obd2 ON (ua.rol_id = obd2.obj_id) ";
            $a2 = 'AND obd2.title = ' . $ilDB->concat(
                array(
                    array($ilDB->quote('il_', 'text')),
                    array('obd.type'),
                    array($ilDB->quote('_member_', 'text')),
                    array('obr.ref_id'),
                ),
                false
            );
        }
 
        // #14290 - no role folder anymore
        $query = "SELECT DISTINCT obd.obj_id,obr.ref_id FROM rbac_ua ua " .
            "JOIN rbac_fa fa ON ua.rol_id = fa.rol_id " .
            "JOIN object_reference obr ON fa.parent = obr.ref_id " .
            "JOIN object_data obd ON obr.obj_id = obd.obj_id " .
            $j2 .
            "WHERE " . $ilDB->in("obd.type", $a_type, false, "text") . ' ' .
            "AND fa.assign = 'y' " .
            "AND ua.usr_id = " . $ilDB->quote($a_usr_id, 'integer') . " " .
            'AND obr.deleted IS NULL ' .
            $a2;
        $res = $ilDB->query($query);
        while ($row = $ilDB->fetchObject($res)) {
            $ref_ids[] = $row->obj_id;
        }
        
        return $ref_ids ? $ref_ids : array();
    }
    
    
    
    public static function _isParticipant($a_ref_id, $a_usr_id)
    {
        global $DIC;
 
        $rbacreview = $DIC['rbacreview'];
 
        $local_roles = $rbacreview->getRolesOfRoleFolder($a_ref_id, false);
        
        return $rbacreview->isAssignedToAtLeastOneGivenRole($a_usr_id, $local_roles);
    }
 
    public static function lookupNumberOfParticipants($a_ref_id)
    {
        global $DIC;
 
        $rbacreview = $DIC['rbacreview'];
 
        $lroles = $rbacreview->getRolesOfRoleFolder($a_ref_id, false);
        return $rbacreview->getNumberOfAssignedUsers($lroles);
    }
 
    public static function lookupNumberOfMembers($a_ref_id)
    {
        global $DIC;
 
        $rbacreview = $DIC->rbac()->review();
        $ilObjDataCache = $DIC['ilObjDataCache'];
 
        $has_policies = $rbacreview->getLocalPolicies($a_ref_id);
 
        if (!$has_policies) {
            return 0;
        }
        $lroles = $rbacreview->getRolesOfRoleFolder($a_ref_id, false);
 
        $memberRoles = array();
        foreach ($lroles as $role_id) {
            $title = $ilObjDataCache->lookupTitle($role_id);
            switch (substr($title, 0, 8)) {
                case 'il_crs_a':
                case 'il_crs_t':
                case 'il_grp_a':
                    break;
 
                default:
                    $memberRoles[] = $role_id;
                    break;
            }
        }
        return $rbacreview->getNumberOfAssignedUsers($memberRoles);
    }
 
 
    public static function _isBlocked($a_obj_id, $a_usr_id)
    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        $query = "SELECT * FROM obj_members " .
            "WHERE obj_id = " . $ilDB->quote($a_obj_id, 'integer') . " " .
            "AND usr_id = " . $ilDB->quote($a_usr_id, 'integer') . " " .
            "AND blocked = " . $ilDB->quote(1, 'integer');
        $res = $ilDB->query($query);
        return $res->numRows() ? true : false;
    }
    
    public static function _hasPassed($a_obj_id, $a_usr_id)
    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        $query = "SELECT * FROM obj_members " .
            "WHERE obj_id = " . $ilDB->quote($a_obj_id, 'integer') . " " .
            "AND usr_id = " . $ilDB->quote($a_usr_id, 'integer') . " " .
            "AND passed = '1'";
        $res = $ilDB->query($query);
        return $res->numRows() ? true : false;
    }
    
    public static function _deleteAllEntries($a_obj_id)
    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        $query = "DELETE FROM obj_members " .
            "WHERE obj_id = " . $ilDB->quote($a_obj_id, 'integer') . " ";
        $res = $ilDB->manipulate($query);
 
        $query = "DELETE FROM il_subscribers " .
            "WHERE obj_id = " . $ilDB->quote($a_obj_id, 'integer') . "";
        $res = $ilDB->manipulate($query);
        
        $query = 'DELETE FROM crs_waiting_list ' .
                'WHERE obj_id = ' . $ilDB->quote($a_obj_id, 'integer');
        $ilDB->manipulate($query);
 
        return true;
    }
    
    public static function _deleteUser($a_usr_id)
    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        $query = "DELETE FROM obj_members WHERE usr_id = " . $ilDB->quote($a_usr_id, 'integer') . "";
        $res = $ilDB->manipulate($query);
 
        $query = "DELETE FROM il_subscribers WHERE usr_id = " . $ilDB->quote($a_usr_id, 'integer') . "";
        $res = $ilDB->manipulate($query);
 
        include_once './Modules/Course/classes/class.ilCourseWaitingList.php';
        ilCourseWaitingList::_deleteUser($a_usr_id);
    }
    
    public static function getDefaultMemberRole($a_ref_id)
    {
        global $DIC;
 
        $ilCtrl = $DIC['ilCtrl'];
        
        $obj_id = ilObject::_lookupObjId($a_ref_id);
        $type = ilObject::_lookupType($obj_id);
        
        if (!in_array($type, array('crs','grp'))) {
            return 0;
        }
        
        global $DIC;
 
        $rbacreview = $DIC['rbacreview'];
        
 
        $roles = $rbacreview->getRolesOfRoleFolder($a_ref_id, false);
        
        foreach ($roles as $role) {
            $title = ilObject::_lookupTitle($role);
            if (substr($title, 0, 13) == ('il_' . $type . '_member')) {
                return $role;
            }
        }
        return 0;
    }
        
    public function getObjId()
    {
        return $this->obj_id;
    }
    
    public function getType()
    {
        return $this->type;
    }
    
    public function getNotificationRecipients()
    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
        
        $query = "SELECT * FROM obj_members " .
            "WHERE notification = 1 " .
            "AND obj_id = " . $ilDB->quote($this->obj_id) . " ";
        $res = $ilDB->query($query);
        $recp = [];
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            if ($this->isAdmin($row->usr_id) or $this->isTutor($row->usr_id)) {
                $recp[] = $row->usr_id;
            }
        }
        return $recp;
    }
    
    public function getCountMembers()
    {
        return count($this->members);
    }
    
    public function getCountParticipants()
    {
        return count($this->participants);
    }
    
    
    
    
    public function getParticipants()
    {
        return $this->participants ? $this->participants : array();
    }
    
    public function getMembers()
    {
        return $this->members ? $this->members : array();
    }
    public function getAdmins()
    {
        return $this->admins ? $this->admins : array();
    }
    
    public function getCountAdmins()
    {
        return count($this->getAdmins());
    }
    
    
    public function getTutors()
    {
        return $this->tutors ? $this->tutors : array();
    }
    
    public function isAdmin($a_usr_id)
    {
        return in_array($a_usr_id, $this->admins) ? true : false;
    }
    
    public function isTutor($a_usr_id)
    {
        return in_array($a_usr_id, $this->tutors) ? true : false;
    }
    
    public function isMember($a_usr_id)
    {
        return in_array($a_usr_id, $this->members) ? true : false;
    }
    
    
    
    
    public function isAssigned($a_usr_id)
    {
        return in_array($a_usr_id, $this->participants);
    }
    
    public function isLastAdmin($a_usr_id)
    {
        return in_array($a_usr_id, $this->getAdmins()) and count($this->getAdmins()) == 1;
    }
    
    
    public function getRoles()
    {
        return $this->roles ? $this->roles : array();
    }
    
    public function getAssignedRoles($a_usr_id)
    {
        global $DIC;
 
        $rbacreview = $DIC['rbacreview'];
        
        foreach ($this->roles as $role) {
            if ($rbacreview->isAssigned($a_usr_id, $role)) {
                $assigned[] = $role;
            }
        }
        return $assigned ? $assigned : array();
    }
    
    public function updateRoleAssignments($a_usr_id, $a_roles)
    {
        global $DIC;
 
        $rbacreview = $DIC['rbacreview'];
        $rbacadmin = $DIC['rbacadmin'];
        
        $roles = $a_roles ? $a_roles : array();
        
        foreach ($this->getRoles() as $role_id) {
            if ($rbacreview->isAssigned($a_usr_id, $role_id)) {
                if (!in_array($role_id, $roles)) {
                    $rbacadmin->deassignUser($role_id, $a_usr_id);
                }
            } else {
                if (in_array($role_id, $roles)) {
                    $rbacadmin->assignUser($role_id, $a_usr_id);
                }
            }
        }
        $rbacreview->clearCaches();
        $this->readParticipants();
        $this->readParticipantsStatus();
    }
    
    public function checkLastAdmin($a_usr_ids)
    {
        foreach ($this->getAdmins() as $admin_id) {
            if (!in_array($admin_id, $a_usr_ids)) {
                return true;
            }
        }
        return false;
    }
    
    public function isBlocked($a_usr_id)
    {
        if (isset($this->participants_status[$a_usr_id])) {
            return $this->participants_status[$a_usr_id]['blocked'] ? true : false;
        }
        return false;
    }
    
    public function hasPassed($a_usr_id)
    {
        if (isset($this->participants_status[$a_usr_id])) {
            return $this->participants_status[$a_usr_id]['passed'] ? true : false;
        }
        return false;
    }
    
    public function delete($a_usr_id)
    {
        global $DIC;
 
        $rbacadmin = $DIC['rbacadmin'];
        $ilDB = $DIC['ilDB'];
 
        $this->recommended_content_manager->removeObjectRecommendation($a_usr_id, $this->ref_id);
 
        foreach ($this->roles as $role_id) {
            $rbacadmin->deassignUser($role_id, $a_usr_id);
        }
        
        $query = "DELETE FROM obj_members " .
            "WHERE usr_id = " . $ilDB->quote($a_usr_id, 'integer') . " " .
            "AND obj_id = " . $ilDB->quote($this->obj_id, 'integer');
        $res = $ilDB->manipulate($query);
        
        $this->readParticipants();
        $this->readParticipantsStatus();
        
        $GLOBALS['DIC']['ilAppEventHandler']->raise(
            $this->getComponent(),
            "deleteParticipant",
            array(
                    'obj_id' => $this->obj_id,
                    'usr_id' => $a_usr_id)
        );
        
        return true;
    }
 
    public function updateBlocked($a_usr_id, $a_blocked)
    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
        
        $this->participants_status[$a_usr_id]['blocked'] = (int) $a_blocked;
 
        $query = "SELECT * FROM obj_members " .
        "WHERE obj_id = " . $ilDB->quote($this->obj_id, 'integer') . " " .
        "AND usr_id = " . $ilDB->quote($a_usr_id, 'integer');
        $res = $ilDB->query($query);
        if ($res->numRows()) {
            $query = "UPDATE obj_members SET " .
                "blocked = " . $ilDB->quote((int) $a_blocked, 'integer') . " " .
                "WHERE obj_id = " . $ilDB->quote($this->obj_id, 'integer') . " " .
                "AND usr_id = " . $ilDB->quote($a_usr_id, 'integer');
        } else {
            $query = "INSERT INTO obj_members (blocked,obj_id,usr_id,notification,passed) " .
                "VALUES ( " .
                $ilDB->quote((int) $a_blocked, 'integer') . ", " .
                $ilDB->quote($this->obj_id, 'integer') . ", " .
                $ilDB->quote($a_usr_id, 'integer') . ", " .
                $ilDB->quote(0, 'integer') . ", " .
                $ilDB->quote(0, 'integer') .
                ")";
        }
        $res = $ilDB->manipulate($query);
        return true;
    }
    
    // cognos-blu-patch: begin
    public function updateContact($a_usr_id, $a_contact)
    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
        
        $ilDB->manipulate(
            'UPDATE obj_members SET ' .
                'contact = ' . $ilDB->quote($a_contact, 'integer') . ' ' .
                'WHERE obj_id = ' . $ilDB->quote($this->obj_id, 'integer') . ' ' .
                'AND usr_id = ' . $ilDB->quote($a_usr_id, 'integer')
        );
        
        $this->participants_status[$a_usr_id]['contact'] = $a_contact;
        return true;
    }
    
    public function getContacts()
    {
        $contacts = array();
        foreach ((array) $this->participants_status as $usr_id => $status) {
            if ($status['contact']) {
                $contacts[] = $usr_id;
            }
        }
        return $contacts;
    }
    
    
    // cognos-blu-patch: end
 
    public function updateNotification($a_usr_id, $a_notification)
    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
        
        $this->participants_status[$a_usr_id]['notification'] = (int) $a_notification;
 
        $query = "SELECT * FROM obj_members " .
        "WHERE obj_id = " . $ilDB->quote($this->obj_id, 'integer') . " " .
        "AND usr_id = " . $ilDB->quote($a_usr_id, 'integer');
        $res = $ilDB->query($query);
        if ($res->numRows()) {
            $query = "UPDATE obj_members SET " .
                "notification = " . $ilDB->quote((int) $a_notification, 'integer') . " " .
                "WHERE obj_id = " . $ilDB->quote($this->obj_id, 'integer') . " " .
                "AND usr_id = " . $ilDB->quote($a_usr_id, 'integer');
        } else {
            $query = "INSERT INTO obj_members (notification,obj_id,usr_id,passed,blocked) " .
                "VALUES ( " .
                $ilDB->quote((int) $a_notification, 'integer') . ", " .
                $ilDB->quote($this->obj_id, 'integer') . ", " .
                $ilDB->quote($a_usr_id, 'integer') . ", " .
                $ilDB->quote(0, 'integer') . ", " .
                $ilDB->quote(0, 'integer') .
                ")";
        }
        $res = $ilDB->manipulate($query);
        return true;
    }
    
 
    
    
    public function add($a_usr_id, $a_role)
    {
        global $DIC;
 
        $rbacadmin = $DIC['rbacadmin'];
        $ilAppEventHandler = $DIC['ilAppEventHandler'];
 
        if ($this->isAssigned($a_usr_id)) {
            return false;
        }
 
        switch ($a_role) {
            case IL_CRS_ADMIN:
                $this->admins[] = $a_usr_id;
                break;
 
            case IL_CRS_TUTOR:
                $this->tutors[] = $a_usr_id;
                break;
 
            case IL_CRS_MEMBER:
                $this->members[] = $a_usr_id;
                break;
 
            case IL_GRP_ADMIN:
                $this->admins[] = $a_usr_id;
                break;
 
            case IL_GRP_MEMBER:
                $this->members[] = $a_usr_id;
                break;
 
            case IL_LSO_ADMIN:
                $this->admins[] = $a_usr_id;
                break;
 
            case IL_LSO_MEMBER:
                $this->members[] = $a_usr_id;
                break;
 
            case IL_SESS_MEMBER:
                $this->members[] = $a_usr_id;
                break;
        }
        
        $this->participants[] = $a_usr_id;
        $rbacadmin->assignUser($this->role_data[$a_role], $a_usr_id);
        
        // Delete subscription request
        $this->deleteSubscriber($a_usr_id);
        
        include_once './Services/Membership/classes/class.ilWaitingList.php';
        ilWaitingList::deleteUserEntry($a_usr_id, $this->obj_id);
 
        $ilAppEventHandler->raise(
            $this->getComponent(),
            "addParticipant",
            array(
                    'obj_id' => $this->obj_id,
                    'usr_id' => $a_usr_id,
                    'role_id' => $a_role)
        );
        return true;
    }
    
 
    public function deleteParticipants($a_user_ids)
    {
        foreach ($a_user_ids as $user_id) {
            $this->delete($user_id);
        }
        return true;
    }
    
    public function addRecommendation($a_usr_id)
    {
        // deactivated for now, see discussion at
        // https://docu.ilias.de/goto_docu_wiki_wpage_5620_1357.html
        // $this->recommended_content_manager->addObjectRecommendation($a_usr_id, $this->ref_id);
        return true;
    }
    
 
    
    public function isNotificationEnabled($a_usr_id)
    {
        if (isset($this->participants_status[$a_usr_id])) {
            return $this->participants_status[$a_usr_id]['notification'] ? true : false;
        }
        return false;
    }
    
    // cognos-blu-patch: begin
    public function isContact($a_usr_id)
    {
        if (isset($this->participants_status[$a_usr_id])) {
            return (bool) $this->participants_status[$a_usr_id]['contact'];
        }
        return false;
    }
    // cognos-blu-patch: end
    
    
    public function getAutoGeneratedRoleId($a_role_type)
    {
        if (array_key_exists($a_role_type, $this->role_data)) {
            return $this->role_data[$a_role_type];
        }
        
        return 0;
    }
    
    
    protected function readParticipants()
    {
        global $DIC;
 
        $rbacreview = $DIC['rbacreview'];
        $ilObjDataCache = $DIC['ilObjDataCache'];
        $ilLog = $DIC['ilLog'];
        
        $GLOBALS['DIC']['rbacreview']->clearCaches();
        $this->roles = $rbacreview->getRolesOfRoleFolder($this->ref_id, false);
 
        $users = array();
        $this->participants = array();
        $this->members = $this->admins = $this->tutors = array();
 
        $additional_roles = [];
        $auto_generated_roles = [];
        foreach ($this->roles as $role_id) {
            $title = $ilObjDataCache->lookupTitle($role_id);
            switch (substr($title, 0, 8)) {
                case 'il_crs_m':
                    $auto_generated_roles[$role_id] = IL_ROLE_POSITION_MEMBER;
                    $this->role_data[IL_CRS_MEMBER] = $role_id;
                    $this->participants = array_unique(array_merge($assigned = $rbacreview->assignedUsers($role_id), $this->participants));
                    $this->members = array_unique(array_merge($assigned, $this->members));
                    $this->role_assignments[$role_id] = $assigned;
                    break;
 
                case 'il_crs_a':
                    $auto_generated_roles[$role_id] = IL_ROLE_POSITION_ADMIN;
                    $this->role_data[IL_CRS_ADMIN] = $role_id;
                    $this->participants = array_unique(array_merge($assigned = $rbacreview->assignedUsers($role_id), $this->participants));
                    $this->admins = $rbacreview->assignedUsers($role_id);
                    $this->role_assignments[$role_id] = $assigned;
                    break;
        
                case 'il_crs_t':
                    $auto_generated_roles[$role_id] = IL_ROLE_POSITION_TUTOR;
                    $this->role_data[IL_CRS_TUTOR] = $role_id;
                    $this->participants = array_unique(array_merge($assigned = $rbacreview->assignedUsers($role_id), $this->participants));
                    $this->tutors = $rbacreview->assignedUsers($role_id);
                    $this->role_assignments[$role_id] = $assigned;
                    break;
                    
                case 'il_grp_a':
                    $auto_generated_roles[$role_id] = IL_ROLE_POSITION_ADMIN;
                    $this->role_data[IL_GRP_ADMIN] = $role_id;
                    $this->participants = array_unique(array_merge($assigned = $rbacreview->assignedUsers($role_id), $this->participants));
                    $this->admins = $rbacreview->assignedUsers($role_id);
                    $this->role_assignments[$role_id] = $assigned;
                    break;
                    
                case 'il_grp_m':
                    $auto_generated_roles[$role_id] = IL_ROLE_POSITION_MEMBER;
                    $this->role_data[IL_GRP_MEMBER] = $role_id;
                    $this->participants = array_unique(array_merge($assigned = $rbacreview->assignedUsers($role_id), $this->participants));
                    $this->members = $rbacreview->assignedUsers($role_id);
                    $this->role_assignments[$role_id] = $assigned;
                    break;
                
                case 'il_sess_':
                    $this->role_data[IL_SESS_MEMBER] = $role_id;
                    $this->participants = array_unique(array_merge($assigned = $rbacreview->assignedUsers($role_id), $this->participants));
                    $this->members = $rbacreview->assignedUsers($role_id);
                    break;
 
                case 'il_lso_m':
                    $auto_generated_roles[$role_id] = IL_ROLE_POSITION_MEMBER;
                    $this->role_data[IL_LSO_MEMBER] = $role_id;
                    $this->participants = array_unique(array_merge($assigned = $rbacreview->assignedUsers($role_id), $this->participants));
                    $this->members = $rbacreview->assignedUsers($role_id);
                    $this->role_assignments[$role_id] = $assigned;
                    break;
 
                case 'il_lso_a':
                    $auto_generated_roles[$role_id] = IL_ROLE_POSITION_ADMIN;
                    $this->role_data[IL_LSO_ADMIN] = $role_id;
                    $this->participants = array_unique(array_merge($assigned = $rbacreview->assignedUsers($role_id), $this->participants));
                    $this->admins = $rbacreview->assignedUsers($role_id);
                    $this->role_assignments[$role_id] = $assigned;
                    break;
 
                default:
                    $additional_roles[$role_id] = $title;
                    $this->participants = array_unique(array_merge($assigned = $rbacreview->assignedUsers($role_id), $this->participants));
                    $this->members = array_unique(array_merge($assigned, $this->members));
                    $this->role_assignments[$role_id] = $assigned;
                    break;
            }
        }
        asort($auto_generated_roles);
        asort($additional_roles);
        $this->roles_sorted = $auto_generated_roles + $additional_roles;
    }
    
    protected function readParticipantsStatus()
    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
        
        $query = "SELECT * FROM obj_members " .
            "WHERE obj_id = " . $ilDB->quote($this->obj_id, 'integer') . " ";
        $res = $ilDB->query($query);
        $this->participants_status = array();
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $this->participants_status[$row->usr_id]['blocked'] = $row->blocked;
            $this->participants_status[$row->usr_id]['notification'] = $row->notification;
            $this->participants_status[$row->usr_id]['passed'] = $row->passed;
            // cognos-blu-patch: begin
            $this->participants_status[$row->usr_id]['contact'] = $row->contact;
            // cognos-blu-patch: end
        }
    }
    
    public function isGroupingMember($a_usr_id, $a_field = '')
    {
        global $DIC;
 
        $rbacreview = $DIC['rbacreview'];
        $ilObjDataCache = $DIC['ilObjDataCache'];
        $ilDB = $DIC['ilDB'];
 
        // Used for membership limitations -> check membership by given field
        if ($a_field) {
            include_once './Services/User/classes/class.ilObjUser.php';
 
            $tmp_user = &ilObjectFactory::getInstanceByObjId($a_usr_id);
            switch ($a_field) {
                case 'login':
                    $and = "AND login = " . $ilDB->quote($tmp_user->getLogin(), 'text') . " ";
                    break;
                case 'email':
                    $and = "AND email = " . $ilDB->quote($tmp_user->getEmail(), 'text') . " ";
                    break;
                case 'matriculation':
                    $and = "AND matriculation = " . $ilDB->quote($tmp_user->getMatriculation(), 'text') . " ";
                    break;
 
                default:
                    $and = "AND usr_id = " . $ilDB->quote($a_usr_id, 'integer') . " ";
                    break;
            }
            
            if (!$this->getParticipants()) {
                return false;
            }
 
            $query = "SELECT * FROM usr_data ud " .
                "WHERE " . $ilDB->in('usr_id', $this->getParticipants(), false, 'integer') . " " .
                $and;
 
            $res = $ilDB->query($query);
            return $res->numRows() ? true : false;
        }
    }
 
    public static function lookupSubscribers($a_obj_id)
    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        $subscribers = array();
        $query = "SELECT usr_id FROM il_subscribers " .
            "WHERE obj_id = " . $ilDB->quote($a_obj_id, 'integer') . " " .
            "ORDER BY sub_time ";
 
        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $subscribers[] = $row->usr_id;
        }
        return $subscribers;
    }
    
    public function getSubscribers()
    {
        $this->readSubscribers();
 
        return $this->subscribers;
    }
 
    
    public function getCountSubscribers()
    {
        return count($this->getSubscribers());
    }
 
    public function getSubscriberData($a_usr_id)
    {
        return $this->readSubscriberData($a_usr_id);
    }
 
 
 
    public function assignSubscribers($a_usr_ids)
    {
        if (!is_array($a_usr_ids) or !count($a_usr_ids)) {
            return false;
        }
        foreach ($a_usr_ids as $id) {
            if (!$this->assignSubscriber($id)) {
                return false;
            }
        }
        return true;
    }
 
    public function assignSubscriber($a_usr_id)
    {
        global $DIC;
 
        $ilErr = $DIC['ilErr'];
        
        $ilErr->setMessage("");
        if (!$this->isSubscriber($a_usr_id)) {
            $ilErr->appendMessage($this->lng->txt("crs_user_notsubscribed"));
 
            return false;
        }
        if ($this->isAssigned($a_usr_id)) {
            $tmp_obj = ilObjectFactory::getInstanceByObjId($a_usr_id);
            $ilErr->appendMessage($tmp_obj->getLogin() . ": " . $this->lng->txt("crs_user_already_assigned"));
 
            return false;
        }
 
        if (!$tmp_obj = &ilObjectFactory::getInstanceByObjId($a_usr_id)) {
            $ilErr->appendMessage($this->lng->txt("crs_user_not_exists"));
 
            return false;
        }
 
        // TODO: must be group or course member role
        if ($this instanceof ilCourseParticipants) {
            $this->add($tmp_obj->getId(), IL_CRS_MEMBER);
        }
        if ($this instanceof ilGroupParticipants) {
            $this->add($tmp_obj->getId(), IL_GRP_MEMBER);
        }
        if ($this instanceof ilLearningSequenceParticipants) {
            $this->add($tmp_obj->getId(), IL_LSO_MEMBER);
        }
        if ($this instanceof ilSessionParticipants) {
            $this->register($tmp_obj->getId());
        }
        $this->deleteSubscriber($a_usr_id);
        return true;
    }
 
    public function autoFillSubscribers()
    {
        $this->readSubscribers();
 
        $counter = 0;
        foreach ($this->subscribers as $subscriber) {
            if (!$this->assignSubscriber($subscriber)) {
                continue;
            } else {
                // TODO: notification
                #$this->sendNotification($this->NOTIFY_ACCEPT_SUBSCRIBER,$subscriber);
            }
            ++$counter;
        }
 
        return $counter;
    }
 
    public function addSubscriber($a_usr_id)
    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        $query = "INSERT INTO il_subscribers (usr_id,obj_id,subject,sub_time) " .
            " VALUES (" .
            $ilDB->quote($a_usr_id, 'integer') . "," .
            $ilDB->quote($this->obj_id, 'integer') . ", " .
            $ilDB->quote('', 'text') . ", " .
            $ilDB->quote(time(), 'integer') .
            ")";
        $res = $ilDB->manipulate($query);
 
        return true;
    }
 
 
    public function updateSubscriptionTime($a_usr_id, $a_subtime)
    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        $query = "UPDATE il_subscribers " .
            "SET sub_time = " . $ilDB->quote($a_subtime, 'integer') . " " .
            "WHERE usr_id = " . $ilDB->quote($a_usr_id, 'integer') . " " .
            "AND obj_id = " . $ilDB->quote($this->obj_id, 'integer') . " ";
        $res = $ilDB->manipulate($query);
 
        return true;
    }
    
    public function updateSubject($a_usr_id, $a_subject)
    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
        
        $query = "UPDATE il_subscribers " .
            "SET subject = " . $ilDB->quote($a_subject, 'text') . " " .
            "WHERE usr_id = " . $ilDB->quote($a_usr_id, 'integer') . " " .
            "AND obj_id = " . $ilDB->quote($this->obj_id, 'integer') . " ";
        $res = $ilDB->manipulate($query);
        return true;
    }
 
    
    public function deleteSubscriber($a_usr_id)
    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        $query = "DELETE FROM il_subscribers " .
            "WHERE usr_id = " . $ilDB->quote($a_usr_id, 'integer') . " " .
            "AND obj_id = " . $ilDB->quote($this->obj_id, 'integer') . " ";
        $res = $ilDB->manipulate($query);
 
        return true;
    }
 
    
    public function deleteSubscribers($a_usr_ids)
    {
        global $DIC;
 
        $ilErr = $DIC['ilErr'];
        $ilDB = $DIC['ilDB'];
        
        if (!is_array($a_usr_ids) or !count($a_usr_ids)) {
            $ilErr->setMessage('');
            $ilErr->appendMessage($this->lng->txt("no_usr_ids_given"));
 
            return false;
        }
        $query = "DELETE FROM il_subscribers " .
            "WHERE " . $ilDB->in('usr_id', (array) $a_usr_ids, false, 'integer') . " " .
            "AND obj_id = " . $ilDB->quote($this->obj_id, 'integer');
        $res = $ilDB->query($query);
        return true;
    }
    
    
    public function isSubscriber($a_usr_id)
    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        $query = "SELECT * FROM il_subscribers " .
            "WHERE usr_id = " . $ilDB->quote($a_usr_id, 'integer') . " " .
            "AND obj_id = " . $ilDB->quote($this->obj_id, 'integer') . "";
 
        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            return true;
        }
        return false;
    }
 
    public static function _isSubscriber($a_obj_id, $a_usr_id)
    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        $query = "SELECT * FROM il_subscribers " .
            "WHERE usr_id = " . $ilDB->quote($a_usr_id, 'integer') . " " .
            "AND obj_id = " . $ilDB->quote($a_obj_id, 'integer') . "";
 
        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            return true;
        }
        return false;
    }
    
    protected function readSubscribers()
    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        $this->subscribers = array();
 
        $query = "SELECT usr_id FROM il_subscribers " .
            "WHERE obj_id = " . $ilDB->quote($this->obj_id, 'integer') . " " .
            "ORDER BY sub_time ";
 
        $res = $this->ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            // DELETE SUBSCRIPTION IF USER HAS BEEN DELETED
            if (!ilObjectFactory::getInstanceByObjId($row->usr_id, false)) {
                $this->deleteSubscriber($row->usr_id);
            }
            $this->subscribers[] = $row->usr_id;
        }
        return true;
    }
 
    protected function readSubscriberData($a_usr_id)
    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        $query = "SELECT * FROM il_subscribers " .
            "WHERE obj_id = " . $ilDB->quote($this->obj_id, 'integer') . " " .
            "AND usr_id = " . $ilDB->quote($a_usr_id, 'integer') . "";
 
        $res = $this->ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $data["time"] = $row->sub_time;
            $data["usr_id"] = $row->usr_id;
            $data['subject'] = $row->subject;
        }
        return $data ? $data : array();
    }
 
    public static function lookupSubscribersData($a_obj_id)
    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        $query = 'SELECT * FROM il_subscribers ' .
            'WHERE obj_id = ' . $ilDB->quote($a_obj_id, 'integer');
        $res = $ilDB->query($query);
 
        $data = array();
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $data[$row->usr_id]['time'] = $row->sub_time;
            $data[$row->usr_id]['usr_id'] = $row->usr_id;
            $data[$row->usr_id]['subject'] = $row->subject;
        }
        return $data;
    }
 
    public static function _getAllSupportContactsOfUser($a_usr_id, $a_type)
    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        // todo: join the two queries or alternatively reuse _getMembershipByType
        // for the first part
 
        // this will also dismiss local roles!
        $j2 = "JOIN object_data obd2 ON (ua.rol_id = obd2.obj_id) ";
        $a2 = "AND obd2.title LIKE 'il_" . $a_type . "_mem%' ";
 
        // #14290 - no role folder anymore
        $query = "SELECT DISTINCT obd.obj_id,obr.ref_id FROM rbac_ua ua " .
            "JOIN rbac_fa fa ON ua.rol_id = fa.rol_id " .
            "JOIN object_reference obr ON fa.parent = obr.ref_id " .
            "JOIN object_data obd ON obr.obj_id = obd.obj_id " .
            $j2 .
            "WHERE obd.type = " . $ilDB->quote($a_type, 'text') . " " .
            "AND fa.assign = 'y' " .
            "AND ua.usr_id = " . $ilDB->quote($a_usr_id, 'integer') . " " .
            $a2;
 
        $res = $ilDB->query($query);
        $obj_ids = array();
        while ($row = $ilDB->fetchObject($res)) {
            $obj_ids[] = $row->obj_id;
        }
 
        $set = $ilDB->query("SELECT obj_id, usr_id FROM obj_members " .
            " WHERE " . $ilDB->in("obj_id", $obj_ids, false, "integer") .
            " AND contact = " . $ilDB->quote(1, "integer"));
        $res = array();
        while ($rec = $ilDB->fetchAssoc($set)) {
            $res[] = $rec;
        }
 
        return $res;
    }
 
    public function setRoleOrderPosition($a_user_id)
    {
        $counter = 0;
        $sortable_assignments = '9999999999';
        foreach ($this->roles_sorted as $role_id => $trash) {
            if (in_array($a_user_id, (array) $this->role_assignments[$role_id])) {
                $sortable_assignments = substr_replace($sortable_assignments, '1', $counter, 1);
            }
            ++$counter;
        }
        return $sortable_assignments;
    }
}