class.ilObjGroup.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2010 ILIAS open source, Extended GPL, see docs/LICENSE */

//TODO: function getRoleId($groupRole) returns the object-id of grouprole

require_once "./Services/Container/classes/class.ilContainer.php";
include_once('./Services/Calendar/classes/class.ilDateTime.php');
include_once './Services/Membership/interfaces/interface.ilMembershipRegistrationCodes.php';

define('GRP_REGISTRATION_DEACTIVATED',-1);
define('GRP_REGISTRATION_DIRECT',0);
define('GRP_REGISTRATION_REQUEST',1);
define('GRP_REGISTRATION_PASSWORD',2);

define('GRP_REGISTRATION_LIMITED',1);
define('GRP_REGISTRATION_UNLIMITED',2);

define('GRP_TYPE_UNKNOWN',0);
define('GRP_TYPE_CLOSED',1);
define('GRP_TYPE_OPEN',2);
define('GRP_TYPE_PUBLIC',3);

class ilObjGroup extends ilContainer implements ilMembershipRegistrationCodes
{
        const CAL_REG_START = 1;
        const CAL_REG_END       = 2;
        
        const GRP_MEMBER = 1;
        const GRP_ADMIN = 2;
        
        const ERR_MISSING_TITLE = 'msg_no_title';
        const ERR_MISSING_GROUP_TYPE = 'grp_missing_grp_type';
        const ERR_MISSING_PASSWORD = 'grp_missing_password';
        const ERR_WRONG_MAX_MEMBERS = 'grp_wrong_max_members';
        const ERR_WRONG_REG_TIME_LIMIT = 'grp_wrong_reg_time_limit';
        
        const MAIL_ALLOWED_ALL = 1;
        const MAIL_ALLOWED_TUTORS = 2;
        
        protected $information;
        protected $group_type = null;
        protected $reg_type = GRP_REGISTRATION_DIRECT;
        protected $reg_enabled = true;
        protected $reg_unlimited = true;
        protected $reg_start = null;
        protected $reg_end = null;
        protected $reg_password = '';
        protected $reg_membership_limitation = false;
        protected $reg_max_members = 0;
        protected $waiting_list = false;
        
        
        // Map
        private $latitude = '';
        private $longitude = '';
        private $locationzoom = 0;
        private $enablemap = 0;
        
        private $reg_access_code = '';
        private $reg_access_code_enabled = false;

        private $view_mode = NULL;
        
        private $mail_members = self::MAIL_ALLOWED_ALL;
        
        
        public $members_obj;


        var $file_obj = null;

        var $m_grpStatus;

        var $m_roleMemberId;

        var $m_roleAdminId;

        public function __construct($a_id = 0,$a_call_by_reference = true)
        {
                global $tree;

                $this->tree =& $tree;

                $this->type = "grp";
                $this->ilObject($a_id,$a_call_by_reference);
                $this->setRegisterMode(true); // ???
        }
        
        public static function lookupGroupTye($a_id)
        {
                global $ilDB;
                
                $query = "SELECT grp_type FROM grp_settings ".
                        "WHERE obj_id = ".$ilDB->quote($a_id,'integer');
                $res = $ilDB->query($query);
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        return $row->grp_type;
                }
                return GRP_TYPE_UNKNOWN;
        }
        
        // Setter/Getter
        public function setInformation($a_information)
        {
                $this->information = $a_information;
        }
        
        public function getInformation()
        {
                return $this->information;
        }
        
        public function setGroupType($a_type)
        {
                $this->group_type = $a_type;
        }
        
        public function getGroupType()
        {
                return $this->group_type;
        }
        
        public function isGroupTypeModified($a_old_type)
        {
                if($a_old_type == GRP_TYPE_UNKNOWN)
                {
                        $group_type = $this->readGroupStatus();
                }
                else
                {
                        $group_type = $a_old_type;
                }
                return $group_type != $this->getGroupType(); 
        }
        
        public function setRegistrationType($a_type)
        {
                $this->reg_type = $a_type;
        }
        
        public function getRegistrationType()
        {
                return $this->reg_type;
        }
        
        public function isRegistrationEnabled()
        {
                return $this->getRegistrationType() != GRP_REGISTRATION_DEACTIVATED;
        }
        
        public function enableUnlimitedRegistration($a_status)
        {
                $this->reg_unlimited = $a_status;
        }
        
        public function isRegistrationUnlimited()
        {
                return $this->reg_unlimited;
        }
        
        public function setRegistrationStart($a_start)
        {
                $this->reg_start = $a_start;
        }
        
        public function getRegistrationStart()
        {
                return $this->reg_start ? $this->reg_start : $this->reg_start = new ilDateTime(date('Y-m-d').' 08:00:00',IL_CAL_DATETIME);
        }
        

        public function setRegistrationEnd($a_end)
        {
                $this->reg_end = $a_end;
        }
        
        public function getRegistrationEnd()
        {
                return $this->reg_end ? $this->reg_end : $this->reg_end = new ilDateTime(date('Y-m-d').' 16:00:00',IL_CAL_DATETIME);
        }

        public function setPassword($a_pass)
        {
                $this->reg_password = $a_pass;
        }
        
        public function getPassword()
        {
                return $this->reg_password;
        }
        
        public function enableMembershipLimitation($a_status)
        {
                $this->reg_membership_limitation = $a_status;
        }
        
        public function isMembershipLimited()
        {
                return (bool) $this->reg_membership_limitation;
        }

        public function setMaxMembers($a_max)
        {
                $this->reg_max_members = $a_max;
        }
        
        public function getMaxMembers()
        {
                return $this->reg_max_members;
        }
        
        public function enableWaitingList($a_status)
        {
                $this->waiting_list = $a_status;
        }
        
        public function isWaitingListEnabled()
        {
                return $this->waiting_list;
        }
        
        function setLatitude($a_latitude)
        {
                $this->latitude = $a_latitude;
        }

        function getLatitude()
        {
                return $this->latitude;
        }

        function setLongitude($a_longitude)
        {
                $this->longitude = $a_longitude;
        }

        function getLongitude()
        {
                return $this->longitude;
        }

        function setLocationZoom($a_locationzoom)
        {
                $this->locationzoom = $a_locationzoom;
        }

        function getLocationZoom()
        {
                return $this->locationzoom;
        }

        function setEnableGroupMap($a_enablemap)
        {
                $this->enablemap = $a_enablemap;
        }

        function getEnableGroupMap()
        {
                return (bool) $this->enablemap;
        }
        
        public function getRegistrationAccessCode()
        {
                return $this->reg_access_code;
        }
        
        public function setRegistrationAccessCode($a_code)
        {
                $this->reg_access_code = $a_code;
        }
        
        public function isRegistrationAccessCodeEnabled()
        {
                return (bool) $this->reg_access_code_enabled;
        }
        
        public function enableRegistrationAccessCode($a_status)
        {
                $this->reg_access_code_enabled = $a_status;
        }
        
        public function setMailToMembersType($a_type)
        {
                $this->mail_members = $a_type;
        }
        
        public function getMailToMembersType()
        {
                return $this->mail_members;
        }
        

        
        
        public function validate()
        {
                global $ilErr;
                
                if(!$this->getTitle())
                {
                        $this->title = '';
                        $ilErr->appendMessage($this->lng->txt(self::ERR_MISSING_TITLE));
                }
                if(!$this->getGroupType())
                {
                        $ilErr->appendMessage($this->lng->txt(self::ERR_MISSING_GROUP_TYPE));
                }
                if($this->getRegistrationType() == GRP_REGISTRATION_PASSWORD and !strlen($this->getPassword()))
                {
                        $ilErr->appendMessage($this->lng->txt(self::ERR_MISSING_PASSWORD));
                }
                if(ilDateTime::_before($this->getRegistrationEnd(),$this->getRegistrationStart()))
                {
                        $ilErr->appendMessage($this->lng->txt(self::ERR_WRONG_REG_TIME_LIMIT));
                }
                if($this->isMembershipLimited() and (!is_numeric($this->getMaxMembers()) or $this->getMaxMembers() <= 0))
                {
                        $ilErr->appendMessage($this->lng->txt(self::ERR_WRONG_MAX_MEMBERS));
                }
                return strlen($ilErr->getMessage()) == 0;
        }
        
        
        

        function create()
        {
                global $ilDB,$ilAppEventHandler;

                if(!parent::create())
                {
                        return false;
                }

                $query = "INSERT INTO grp_settings (obj_id,information,grp_type,registration_type,registration_enabled,".
                        "registration_unlimited,registration_start,registration_end,registration_password,registration_mem_limit,".
                        "registration_max_members,waiting_list,latitude,longitude,location_zoom,enablemap,reg_ac_enabled,reg_ac,view_mode,mail_members_type) ".
                        "VALUES(".
                        $ilDB->quote($this->getId() ,'integer').", ".
                        $ilDB->quote($this->getInformation() ,'text').", ".
                        $ilDB->quote((int) $this->getGroupType() ,'integer').", ".
                        $ilDB->quote($this->getRegistrationType() ,'integer').", ".
                        $ilDB->quote(($this->isRegistrationEnabled() ? 1 : 0) ,'integer').", ".
                        $ilDB->quote(($this->isRegistrationUnlimited() ? 1 : 0) ,'integer').", ".
                        $ilDB->quote($this->getRegistrationStart()->get(IL_CAL_DATETIME,'') ,'timestamp').", ".
                        $ilDB->quote($this->getRegistrationEnd()->get(IL_CAL_DATETIME,'') ,'timestamp').", ".
                        $ilDB->quote($this->getPassword() ,'text').", ".
                        $ilDB->quote((int) $this->isMembershipLimited() ,'integer').", ".
                        $ilDB->quote($this->getMaxMembers() ,'integer').", ".
                        $ilDB->quote($this->isWaitingListEnabled() ? 1 : 0 ,'integer').", ".
                        $ilDB->quote($this->getLatitude() ,'text').", ".
                        $ilDB->quote($this->getLongitude() ,'text').", ".
                        $ilDB->quote($this->getLocationZoom() ,'integer').", ".
                        $ilDB->quote((int) $this->getEnableGroupMap() ,'integer').", ".
                        $ilDB->quote($this->isRegistrationAccessCodeEnabled(),'integer').', '.
                        $ilDB->quote($this->getRegistrationAccessCode(),'text').', '.
                        $ilDB->quote($this->getViewMode(false),'integer').', '.
                        $ilDB->quote($this->getMailToMembersType(),'integer').' '.
                        ")";
                $res = $ilDB->manipulate($query);

                $ilAppEventHandler->raise('Modules/Group',
                        'create',
                        array('object' => $this,
                                'obj_id' => $this->getId(),
                                'appointments' => $this->prepareAppointments('create')));
                
                return $this->getId();
        }

        function update()
        {
                global $ilDB,$ilAppEventHandler;

                if (!parent::update())
                {
                        return false;
                }

                $query = "UPDATE grp_settings ".
                        "SET information = ".$ilDB->quote($this->getInformation() ,'text').", ".
                        "grp_type = ".$ilDB->quote((int) $this->getGroupType() ,'integer').", ".
                        "registration_type = ".$ilDB->quote($this->getRegistrationType() ,'integer').", ".
                        "registration_enabled = ".$ilDB->quote($this->isRegistrationEnabled() ? 1 : 0 ,'integer').", ".
                        "registration_unlimited = ".$ilDB->quote($this->isRegistrationUnlimited() ? 1 : 0 ,'integer').", ".
                        "registration_start = ".$ilDB->quote($this->getRegistrationStart()->get(IL_CAL_DATETIME,'') ,'timestamp').", ".
                        "registration_end = ".$ilDB->quote($this->getRegistrationEnd()->get(IL_CAL_DATETIME,'') ,'timestamp').", ".
                        "registration_password = ".$ilDB->quote($this->getPassword() ,'text').", ".
//                      "registration_membership_limited = ".$ilDB->quote((int) $this->isMembershipLimited() ,'integer').", ".
                        "registration_mem_limit = ".$ilDB->quote((int) $this->isMembershipLimited() ,'integer').", ".
                        "registration_max_members = ".$ilDB->quote($this->getMaxMembers() ,'integer').", ".
                        "waiting_list = ".$ilDB->quote($this->isWaitingListEnabled() ? 1 : 0 ,'integer').", ".
                        "latitude = ".$ilDB->quote($this->getLatitude() ,'text').", ".
                        "longitude = ".$ilDB->quote($this->getLongitude() ,'text').", ".
                        "location_zoom = ".$ilDB->quote($this->getLocationZoom() ,'integer').", ".
                        "enablemap = ".$ilDB->quote((int) $this->getEnableGroupMap() ,'integer').", ".
                        'reg_ac_enabled = '.$ilDB->quote($this->isRegistrationAccessCodeEnabled(),'integer').', '.
                        'reg_ac = '.$ilDB->quote($this->getRegistrationAccessCode(),'text').', '.
                        'view_mode = '.$ilDB->quote($this->getViewMode(false),'integer').', '.
                        'mail_members_type = '.$ilDB->quote($this->getMailToMembersType(),'integer').' '.
                        "WHERE obj_id = ".$ilDB->quote($this->getId() ,'integer')." ";
                $res = $ilDB->manipulate($query);
                
                $ilAppEventHandler->raise('Modules/Group',
                        'update',
                        array('object' => $this,
                                'obj_id' => $this->getId(),
                                'appointments' => $this->prepareAppointments('update')));
                                
                
                return true;
        }
        
        public function delete()
        {
                global $ilDB,$ilAppEventHandler;

                // always call parent delete function first!!
                if (!parent::delete())
                {
                        return false;
                }

                $query = "DELETE FROM grp_settings ".
                        "WHERE obj_id = ".$ilDB->quote($this->getId() ,'integer');
                $res = $ilDB->manipulate($query);
                
                include_once('./Modules/Group/classes/class.ilGroupParticipants.php');
                ilGroupParticipants::_deleteAllEntries($this->getId());
                
                $ilAppEventHandler->raise('Modules/Group',
                        'delete',
                        array('object' => $this,
                                'obj_id' => $this->getId(),
                                'appointments' => $this->prepareAppointments('delete')));
                
                
                return true;
        }
        

        function read()
        {
                global $ilDB;

                parent::read();

                $query = "SELECT * FROM grp_settings ".
                        "WHERE obj_id = ".$ilDB->quote($this->getId() ,'integer');
                
                $res = $ilDB->query($query);
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $this->setInformation($row->information);
                        $this->setGroupType($row->grp_type);
                        $this->setRegistrationType($row->registration_type);
                        $this->enableUnlimitedRegistration($row->registration_unlimited);
                        $this->setRegistrationStart(new ilDateTime($row->registration_start,IL_CAL_DATETIME));
                        $this->setRegistrationEnd(new ilDateTime($row->registration_end,IL_CAL_DATETIME));
                        $this->setPassword($row->registration_password);
                        $this->enableMembershipLimitation((bool) $row->registration_mem_limit);
                        $this->setMaxMembers($row->registration_max_members);
                        $this->enableWaitingList($row->waiting_list);
                        $this->setLatitude($row->latitude);
                        $this->setLongitude($row->longitude);
                        $this->setLocationZoom($row->location_zoom);
                        $this->setEnableGroupMap($row->enablemap);
                        $this->enableRegistrationAccessCode($row->reg_ac_enabled);
                        $this->setRegistrationAccessCode($row->reg_ac);
                        $this->setViewMode($row->view_mode);
                        $this->setMailToMembersType($row->mail_members_type);
                }
                $this->initParticipants();
                
                // Inherit order type from parent course (if exists)
                include_once('./Services/Container/classes/class.ilContainerSortingSettings.php');
                $this->setOrderType(ilContainerSortingSettings::_lookupSortMode($this->getId()));
        }

        public function cloneObject($a_target_id,$a_copy_id = 0)
        {
                global $ilDB,$ilUser;

                $new_obj = parent::cloneObject($a_target_id,$a_copy_id);
                $new_obj->setGroupType($this->getGroupType());
                $new_obj->initGroupStatus($this->getGroupType() ? $this->getGroupType() : $this->readGroupStatus());

                $this->cloneAutoGeneratedRoles($new_obj);

                $new_obj->setRegistrationType($this->getRegistrationType());
                $new_obj->setInformation($this->getInformation());
                $new_obj->setRegistrationStart($this->getRegistrationStart());
                $new_obj->setRegistrationEnd($this->getRegistrationEnd());
                $new_obj->enableUnlimitedRegistration($this->isRegistrationUnlimited());
                $new_obj->setPassword($this->getPassword());
                $new_obj->enableMembershipLimitation($this->isMembershipLimited());
                $new_obj->setMaxMembers($this->getMaxMembers());
                $new_obj->enableWaitingList($this->isWaitingListEnabled());
                
                // map
                $new_obj->setLatitude($this->getLatitude());
                $new_obj->setLongitude($this->getLongitude());
                $new_obj->setLocationZoom($this->getLocationZoom());
                $new_obj->setEnableGroupMap($this->getEnableGroupMap());
                $new_obj->enableRegistrationAccessCode($this->isRegistrationAccessCodeEnabled());
                include_once './Services/Membership/classes/class.ilMembershipRegistrationCodeUtils.php';
                $new_obj->setRegistrationAccessCode(ilMembershipRegistrationCodeUtils::generateCode());

                $new_obj->setViewMode($this->getViewMode());
                $new_obj->setMailToMembersType($this->getMailToMembersType());
                
                $new_obj->update();
                
                // #13008 - Group Defined Fields
                include_once('Modules/Course/classes/Export/class.ilCourseDefinedFieldDefinition.php');
                ilCourseDefinedFieldDefinition::_clone($this->getId(),$new_obj->getId());
                
                global $ilLog;
                $ilLog->write(__METHOD__.': Starting add user');
                
                // Assign user as admin
                include_once('./Modules/Group/classes/class.ilGroupParticipants.php');
                $part = ilGroupParticipants::_getInstanceByObjId($new_obj->getId());
                $part->add($ilUser->getId(),IL_GRP_ADMIN);
                $part->updateNotification($ilUser->getId(),1);

                // Copy learning progress settings
                include_once('Services/Tracking/classes/class.ilLPObjSettings.php');
                $obj_settings = new ilLPObjSettings($this->getId());
                $obj_settings->cloneSettings($new_obj->getId());
                unset($obj_settings);
                
                // clone icons
                $new_obj->saveIcons($this->getBigIconPath(),
                        $this->getSmallIconPath(),
                        $this->getTinyIconPath());

                return $new_obj;
        }

        public function cloneDependencies($a_target_id,$a_copy_id)
        {
                global $tree;

                parent::cloneDependencies($a_target_id,$a_copy_id);

                include_once('Services/Object/classes/class.ilObjectActivation.php');
                ilObjectActivation::cloneDependencies($this->getRefId(), $a_target_id, $a_copy_id);

                return true;
        }

        public function cloneAutoGeneratedRoles($new_obj)
        {
                global $ilLog,$rbacadmin,$rbacreview;

                $admin = $this->getDefaultAdminRole();
                $new_admin = $new_obj->getDefaultAdminRole();
                if(!$admin || !$new_admin || !$this->getRefId() || !$new_obj->getRefId())
                {
                        $ilLog->write(__METHOD__.' : Error cloning auto generated role: il_grp_admin');
                }
                $rbacadmin->copyRolePermissions($admin,$this->getRefId(),$new_obj->getRefId(),$new_admin,true);
                $ilLog->write(__METHOD__.' : Finished copying of role il_grp_admin.');

                $member = $this->getDefaultMemberRole();
                $new_member = $new_obj->getDefaultMemberRole();
                if(!$member || !$new_member)
                {
                        $ilLog->write(__METHOD__.' : Error cloning auto generated role: il_grp_member');
                }
                $rbacadmin->copyRolePermissions($member,$this->getRefId(),$new_obj->getRefId(),$new_member,true);
                $ilLog->write(__METHOD__.' : Finished copying of role grp_member.');
        }


        function join($a_user_id, $a_mem_role="")
        {
                global $rbacadmin;

                if (is_array($a_mem_role))
                {
                        foreach ($a_mem_role as $role)
                        {
                                $rbacadmin->assignUser($role,$a_user_id, false);
                        }
                }
                else
                {
                        $rbacadmin->assignUser($a_mem_role,$a_user_id, false);
                }

                return true;
        }

        function getDefaultMemberRole()
        {
                $local_group_Roles = $this->getLocalGroupRoles();

                return $local_group_Roles["il_grp_member_".$this->getRefId()];
        }

        function getDefaultAdminRole()
        {
                $local_group_Roles = $this->getLocalGroupRoles();

                return $local_group_Roles["il_grp_admin_".$this->getRefId()];
        }

        function addMember($a_user_id, $a_mem_role)
        {
                global $rbacadmin;

                if (isset($a_user_id) && isset($a_mem_role) )
                {
                        $this->join($a_user_id,$a_mem_role);
                        return true;
                }
                else
                {
                        $this->ilias->raiseError(get_class($this)."::addMember(): Missing parameters !",$this->ilias->error_obj->WARNING);
                        return false;
                }
        }


        function leaveGroup()
        {
                global $rbacadmin, $rbacreview;

                $member_ids = $this->getGroupMemberIds();

                if (count($member_ids) <= 1 || !in_array($this->ilias->account->getId(), $member_ids))
                {
                        return 2;
                }
                else
                {
                        if (!$this->isAdmin($this->ilias->account->getId()))
                        {
                                $this->leave($this->ilias->account->getId());
                                $member = new ilObjUser($this->ilias->account->getId());
                                $member->dropDesktopItem($this->getRefId(), "grp");

                                return 0;
                        }
                        else if (count($this->getGroupAdminIds()) == 1)
                        {
                                return 1;
                        }
                }
        }

        function leave($a_user_id)
        {
                global $rbacadmin;

                $arr_groupRoles = $this->getMemberRoles($a_user_id);

                if (is_array($arr_groupRoles))
                {
                        foreach ($arr_groupRoles as $groupRole)
                        {
                                $rbacadmin->deassignUser($groupRole, $a_user_id);
                        }
                }
                else
                {
                        $rbacadmin->deassignUser($arr_groupRoles, $a_user_id);
                }

                return true;
        }

        function getGroupMemberIds()
        {
                global $rbacadmin, $rbacreview;

                $usr_arr= array();

                $rol  = $this->getLocalGroupRoles();

                foreach ($rol as $value)
                {
                        foreach ($rbacreview->assignedUsers($value) as $member_id)
                        {
                                array_push($usr_arr,$member_id);
                        }
                }

                $mem_arr = array_unique($usr_arr);

                return $mem_arr ? $mem_arr : array();
        }

        function getGroupMemberData($a_mem_ids, $active = 1)
        {
                global $rbacadmin, $rbacreview, $ilBench, $ilDB;

                $usr_arr= array();

                $q = "SELECT login,firstname,lastname,title,usr_id,last_login ".
                         "FROM usr_data ".
                         "WHERE usr_id IN (".implode(',',ilUtil::quoteArray($a_mem_ids)).") ";

                if (is_numeric($active) && $active > -1)
                        $q .= "AND active = '$active'";
                        
                $q .= 'ORDER BY lastname,firstname';

                $r = $ilDB->query($q);
                
                while($row = $r->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $mem_arr[] = array("id" => $row->usr_id,
                                                                "login" => $row->login,
                                                                "firstname" => $row->firstname,
                                                                "lastname" => $row->lastname,
                                                                "last_login" => $row->last_login
                                                                );
                }

                return $mem_arr ? $mem_arr : array();
        }

        function getCountMembers()
        {
                return count($this->getGroupMemberIds());
        }

        function getGroupAdminIds($a_grpId = "")
        {
                global $rbacreview;

                if (!empty($a_grpId))
                {
                        $grp_id = $a_grpId;
                }
                else
                {
                        $grp_id = $this->getRefId();
                }

                $usr_arr = array();
                $roles = $this->getDefaultGroupRoles($this->getRefId());

                foreach ($rbacreview->assignedUsers($this->getDefaultAdminRole()) as $member_id)
                {
                        array_push($usr_arr,$member_id);
                }

                return $usr_arr;
        }

        function getDefaultGroupRoles($a_grp_id="")
        {
                global $rbacadmin, $rbacreview;

                if (strlen($a_grp_id) > 0)
                {
                        $grp_id = $a_grp_id;
                }
                else
                {
                        $grp_id = $this->getRefId();
                }

                $role_arr  = $rbacreview->getRolesOfRoleFolder($grp_id);

                foreach ($role_arr as $role_id)
                {
                        $role_Obj =& $this->ilias->obj_factory->getInstanceByObjId($role_id);

                        $grp_Member ="il_grp_member_".$grp_id;
                        $grp_Admin  ="il_grp_admin_".$grp_id;

                        if (strcmp($role_Obj->getTitle(), $grp_Member) == 0 )
                        {
                                $arr_grpDefaultRoles["grp_member_role"] = $role_Obj->getId();
                        }

                        if (strcmp($role_Obj->getTitle(), $grp_Admin) == 0)
                        {
                                $arr_grpDefaultRoles["grp_admin_role"] = $role_Obj->getId();
                        }
                }

                return $arr_grpDefaultRoles;
        }

        function getLocalGroupRoles($a_translate = false)
        {
                global $rbacadmin,$rbacreview;

                if (empty($this->local_roles))
                {
                        $this->local_roles = array();
                        $role_arr  = $rbacreview->getRolesOfRoleFolder($this->getRefId());

                        foreach ($role_arr as $role_id)
                        {
                                if ($rbacreview->isAssignable($role_id,$this->getRefId()) == true)
                                {
                                        $role_Obj =& $this->ilias->obj_factory->getInstanceByObjId($role_id);

                                        if ($a_translate)
                                        {
                                                $role_name = ilObjRole::_getTranslation($role_Obj->getTitle());
                                        }
                                        else
                                        {
                                                $role_name = $role_Obj->getTitle();
                                        }

                                        $this->local_roles[$role_name] = $role_Obj->getId();
                                }
                        }
                }

                return $this->local_roles;
        }

        function getGrpStatusClosedTemplateId()
        {
                $q = "SELECT obj_id FROM object_data WHERE type='rolt' AND title='il_grp_status_closed'";
                $res = $this->ilias->db->query($q);
                $row = $res->fetchRow(DB_FETCHMODE_ASSOC);

                return $row["obj_id"];
        }

        function getGrpStatusOpenTemplateId()
        {
                $q = "SELECT obj_id FROM object_data WHERE type='rolt' AND title='il_grp_status_open'";
                $res = $this->ilias->db->query($q);
                $row = $res->fetchRow(DB_FETCHMODE_ASSOC);

                return $row["obj_id"];
        }
        
        public static function lookupGroupStatusTemplateId($a_obj_id)
        {
                global $ilDB;
                
                $type = self::lookupGroupTye($a_obj_id);
                if($type == GRP_TYPE_CLOSED)
                {
                        $query = 'SELECT obj_id FROM object_data WHERE type = '.$ilDB->quote('rolt','text').' AND title = '.$ilDB->quote('il_grp_status_closed','text');
                }
                else
                {
                        $query = 'SELECT obj_id FROM object_data WHERE type = '.$ilDB->quote('rolt','text').' AND title = '.$ilDB->quote('il_grp_status_open','text');
                }
                $res = $ilDB->query($query);
                $row = $res->fetchRow(DB_FETCHMODE_ASSOC);
                
                return isset($row['obj_id']) ? $row['obj_id'] : 0;
        }


        
        public function updateGroupType()
        {
                global $tree,$rbacreview,$rbacadmin;
                
                $parent_roles = $rbacreview->getParentRoleIds($this->getRefId());
                $real_parent_roles = array_diff(array_keys($parent_roles),$this->getDefaultGroupRoles());
                
                // Delete parent roles with stopped inheritance
                foreach($real_parent_roles as $role_id)
                {
                        // Delete local role
                        $rbacadmin->deleteLocalRole($role_id,$this->getRefId());
                }
                $parent_roles = $rbacreview->getParentRoleIds($this->getRefId());
                $real_parent_roles = array_diff(array_keys($parent_roles),$this->getDefaultGroupRoles());
                
                switch($this->getGroupType())
                {
                        case GRP_TYPE_PUBLIC:
                                $template_id = $this->getGrpStatusOpenTemplateId();
                                break;
                                
                        case GRP_TYPE_CLOSED:
                                $template_id = $this->getGrpStatusClosedTemplateId();
                                break;
                }
                
                $first = true;
                foreach($tree->getFilteredSubTree($this->getRefId(),array('grp')) as $subnode)
                {
                        // Read template operations
                        $template_ops = $rbacreview->getOperationsOfRole($template_id,$subnode['type'], ROLE_FOLDER_ID);
                        
                        // for all parent roles
                        foreach($real_parent_roles as $role_id)
                        {
                                if($rbacreview->isProtected($parent_roles[$role_id]['parent'],$role_id))
                                {
                                        continue;
                                }

                                $rbacadmin->deleteLocalRole($role_id,$subnode['child']);
                                
                                // Store current operations
                                $current_ops = $rbacreview->getOperationsOfRole($role_id,$subnode['type'],$parent_roles[$role_id]['parent']);

                                // Revoke permissions
                                $rbacadmin->revokePermission($subnode['child'],$role_id);

                                // Grant permissions
                                $granted = array();
                                foreach($template_ops as $operation)
                                {
                                        if(in_array($operation,$current_ops))
                                        {
                                                $granted[] = $operation;
                                        }
                                }
                                if($granted)
                                {
                                        $rbacadmin->grantPermission($role_id, $granted,$subnode['child']);
                                }
                                
                                if($first)
                                {
                                        // This is the group itself
                                        $rbacadmin->copyRolePermissionIntersection(
                                                $template_id, ROLE_FOLDER_ID,
                                                $role_id, $parent_roles[$role_id]['parent'],
                                                $subnode["child"],$role_id);
                                        $rbacadmin->assignRoleToFolder($role_id,$subnode['child'],"n");
                                        
                                }
                        }
                        $first = false;
                }
        }

        function initGroupStatus($a_grpStatus = GRP_TYPE_PUBLIC)
        {
                global $rbacadmin, $rbacreview, $rbacsystem;

                //define all relevant roles that rights are needed to be changed
                $arr_parentRoles = $rbacreview->getParentRoleIds($this->getRefId());

                $real_local_roles = $rbacreview->getRolesOfRoleFolder($this->getRefId(),false);
                $arr_relevantParentRoleIds = array_diff(array_keys($arr_parentRoles),$real_local_roles);

                //group status open (aka public) or group status closed
                if ($a_grpStatus == GRP_TYPE_PUBLIC || $a_grpStatus == GRP_TYPE_CLOSED)
                {
                        if ($a_grpStatus == GRP_TYPE_PUBLIC)
                        {
                                $template_id = $this->getGrpStatusOpenTemplateId();
                        } 
                        else 
                        {
                                $template_id = $this->getGrpStatusClosedTemplateId();
                        }
                        //get defined operations from template
                        $template_ops = $rbacreview->getOperationsOfRole($template_id, 'grp', ROLE_FOLDER_ID);

                        foreach ($arr_relevantParentRoleIds as $parentRole)
                        {
                                if ($rbacreview->isProtected($arr_parentRoles[$parentRole]['parent'],$parentRole))
                                {
                                        continue;
                                }

                                $granted_permissions = array();

                                // Delete the linked role for the parent role
                                // (just in case if it already exists).
                                
                                // Added additional check, since this operation is very dangerous.
                                // If there is no role folder ALL parent roles are deleted. 

                                // @todo refactor rolf
                                $rbacadmin->deleteLocalRole($parentRole,$this->getRefId());

                                // Grant permissions on the group object for
                                // the parent role. In the foreach loop we
                                // compute the intersection of the role
                                // template il_grp_status_open/_closed and the
                                // permission template of the parent role.
                                $current_ops = $rbacreview->getRoleOperationsOnObject($parentRole, $this->getRefId());
                                $rbacadmin->revokePermission($this->getRefId(), $parentRole);
                                foreach ($template_ops as $template_op)
                                {
                                        if (in_array($template_op,$current_ops))
                                        {
                                                array_push($granted_permissions,$template_op);
                                        }
                                }
                                if (!empty($granted_permissions))
                                {
                                        $rbacadmin->grantPermission($parentRole, $granted_permissions, $this->getRefId());
                                }

                                // Create a linked role for the parent role and
                                // initialize it with the intersection of
                                // il_grp_status_open/_closed and the permission
                                // template of the parent role
                                
                                $rbacadmin->copyRolePermissionIntersection(
                                        $template_id, ROLE_FOLDER_ID,
                                        $parentRole, $arr_parentRoles[$parentRole]['parent'],
                                        $this->getRefId(), $parentRole
                                );
                                $rbacadmin->assignRoleToFolder($parentRole,$this->getRefId(),"false");
                        }//END foreach
                }
        }

        public function setGroupStatus($a_status)
        {
                $this->group_status = $a_status;
        }

        public function getGroupStatus()
        {
                return $this->group_status;
        }

        function readGroupStatus()
        {
                global $rbacsystem,$rbacreview;

                $local_roles = $rbacreview->getRolesOfRoleFolder($this->getRefId());

                //get all relevant roles
                $arr_globalRoles = array_diff($local_roles, $this->getDefaultGroupRoles());

                //if one global role has no permission to join the group is officially closed !
                foreach ($arr_globalRoles as $globalRole)
                {
                        if ($rbacsystem->checkPermission($this->getRefId(), $globalRole ,"join"))
                        {
                                return $this->group_status = GRP_TYPE_PUBLIC;
                        }
                }

                return $this->group_status = GRP_TYPE_CLOSED;
        }

        function getMemberRoles($a_user_id)
        {
                global $rbacadmin, $rbacreview,$ilBench;

                $ilBench->start("Group", "getMemberRoles");

                $arr_assignedRoles = array();

                $arr_assignedRoles = array_intersect($rbacreview->assignedRoles($a_user_id),$this->getLocalGroupRoles());

                $ilBench->stop("Group", "getMemberRoles");

                return $arr_assignedRoles;
        }

        function isAdmin($a_userId)
        {
                global $rbacreview;

                $grp_Roles = $this->getDefaultGroupRoles();

                if (in_array($a_userId,$rbacreview->assignedUsers($grp_Roles["grp_admin_role"])))
                {
                        return true;
                }
                else
                {
                        return false;
                }
        }



        function initDefaultRoles()
        {
                include_once './Services/AccessControl/classes/class.ilObjRole.php';
                $role = ilObjRole::createDefaultRole(
                                'il_grp_admin_'.$this->getRefId(),
                                "Groupadmin group obj_no.".$this->getId(),
                                'il_grp_admin',
                                $this->getRefId()
                );
                $this->m_roleAdminId = $role->getId();
                
                $role = ilObjRole::createDefaultRole(
                                'il_grp_member_'.$this->getRefId(),
                                "Groupmember of group obj_no.".$this->getId(),
                                'il_grp_member',
                                $this->getRefId()
                );
                $this->m_roleMemberId = $role->getId();
                
                return array();
        }

        function notify($a_event,$a_ref_id,$a_parent_non_rbac_id,$a_node_id,$a_params = 0)
        {
                global $tree;

                $parent_id = (int) $tree->getParentId($a_node_id);

                if ($parent_id != 0)
                {
                        $obj_data =& $this->ilias->obj_factory->getInstanceByRefId($a_node_id);
                        $obj_data->notify($a_event,$a_ref_id,$a_parent_non_rbac_id,$parent_id,$a_params);
                }

                return true;
        }


        function exportXML()
        {
                include_once 'Modules/Group/classes/class.ilGroupXMLWriter.php';

                $xml_writer = new ilGroupXMLWriter($this);
                $xml_writer->start();

                $xml = $xml_writer->getXML();
                
                $name = time().'__'.$this->ilias->getSetting('inst_id').'__grp_'.$this->getId();

                $this->__initFileObject();

                $this->file_obj->addGroupDirectory();
                $this->file_obj->addDirectory($name);
                $this->file_obj->writeToFile($xml,$name.'/'.$name.'.xml');
                $this->file_obj->zipFile($name,$name.'.zip');
                $this->file_obj->deleteDirectory($name);

                return true;
        }

        function deleteExportFiles($a_files)
        {
                $this->__initFileObject();

                foreach($a_files as $file)
                {
                        $this->file_obj->deleteFile($file);
                }
                return true;
        }

        function downloadExportFile($file)
        {
                $this->__initFileObject();

                if($abs_name = $this->file_obj->getExportFile($file))
                {
                        ilUtil::deliverFile($abs_name,$file);
                        // Not reached
                }
                return false;
        }

        function _importFromXMLString($xml,$parent_id)
        {
                include_once 'Modules/Group/classes/class.ilGroupXMLParser.php';

                $import_parser = new ilGroupXMLParser($xml,$parent_id);

                return $import_parser->startParsing();
        }

        function _importFromFile($file,$parent_id)
        {
                global $lng;

                include_once './Modules/Group/classes/class.ilFileDataGroup.php';

                $file_obj = new ilFileDataGroup(null);
                $file_obj->addImportDirectory();
                $file_obj->createImportFile($_FILES["xmldoc"]["tmp_name"],$_FILES['xmldoc']['name']);
                $file_obj->unpackImportFile();

                if(!$file_obj->validateImportFile())
                {
                        return false;
                }
                return ilObjGroup::_importFromXMLString(file_get_contents($file_obj->getImportFile()),$parent_id);
        }

        function _lookupIdByTitle($a_title)
        {
                global $ilDB;

                $query = "SELECT * FROM object_data WHERE title = ".
                        $ilDB->quote($a_title ,'text')." AND type = 'grp'";
                $res = $ilDB->query($query);
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        return $row->obj_id;
                }
                return 0;
        }


        function _isMember($a_user_id,$a_ref_id,$a_field = '')
        {
                global $rbacreview,$ilObjDataCache,$ilDB;

                $local_roles = $rbacreview->getRolesOfRoleFolder($a_ref_id,false);
                $user_roles = $rbacreview->assignedRoles($a_user_id);

                // 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_user_id);
                        switch($a_field)
                        {
                                case 'login':
                                        $and = "AND login = '".$tmp_user->getLogin()."' ";
                                        break;
                                case 'email':
                                        $and = "AND email = '".$tmp_user->getEmail()."' ";
                                        break;
                                case 'matriculation':
                                        $and = "AND matriculation = '".$tmp_user->getMatriculation()."' ";
                                        break;

                                default:
                                        $and = "AND usr_id = '".$a_user_id."'";
                                        break;
                        }
                        if(!$members = ilObjGroup::_getMembers($ilObjDataCache->lookupObjId($a_ref_id)))
                        {
                                return false;
                        }
                        $query = "SELECT * FROM usr_data as ud ".
                                "WHERE usr_id IN (".implode(",",ilUtil::quoteArray($members)).") ".
                                $and;
                        $res = $ilDB->query($query);

                        return $res->numRows() ? true : false;
                }

                if (!array_intersect($local_roles,$user_roles))
                {
                        return false;
                }

                return true;
        }

        function _getMembers($a_obj_id)
        {
                global $rbacreview;

                // get reference
                $ref_ids = ilObject::_getAllReferences($a_obj_id);
                $ref_id = current($ref_ids);

                $local_roles = $rbacreview->getRolesOfRoleFolder($ref_id,false);

                $users = array();
                foreach($local_roles as $role_id)
                {
                        $users = array_merge($users,$rbacreview->assignedUsers($role_id));
                }

                return array_unique($users);
        }
        
        public function getViewMode($a_translate_inherit = true)
        {               
                $view = (int) $this->view_mode;
                
                if(!$view)
                {
                        $view = ilContainer::VIEW_DEFAULT;
                }
                
                if($a_translate_inherit)
                {
                        $view = self::translateViewMode($this->id, $view, $this->ref_id);
                }
                
                return $view;
        }

        public function setViewMode($a_view_mode)
        {               
                $this->view_mode = $a_view_mode;
        }

        public static function lookupViewMode($a_obj_id)
        {
                global $ilDB;

                $query = 'SELECT view_mode FROM grp_settings '.
                        'WHERE obj_id = '.$ilDB->quote($a_obj_id,'integer');
                $res = $ilDB->query($query);

                $view_mode = NULL;
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $view_mode = $row->view_mode;
                }
                return self::translateViewMode($a_obj_id,$view_mode);
        }
        
        protected static function translateViewMode($a_obj_id,$a_view_mode,$a_ref_id = null)
        {
                global $tree;
                
                if(!$a_view_mode)
                {
                        $a_view_mode = ilContainer::VIEW_DEFAULT;
                }
                
                // view mode is inherit => check for parent course
                if($a_view_mode == ilContainer::VIEW_INHERIT)
                {
                        if(!$a_ref_id)
                        {
                                $ref = ilObject::_getAllReferences($a_obj_id);
                                $a_ref_id = end($ref);
                        }                       

                        $crs_ref = $tree->checkForParentType($a_ref_id, 'crs');
                        if(!$crs_ref)
                        {
                                return ilContainer::VIEW_DEFAULT;
                        }

                        include_once './Modules/Course/classes/class.ilObjCourse.php';
                        $view_mode = ilObjCourse::_lookupViewMode(ilObject::_lookupObjId($crs_ref));
                        
                        // validate course view mode
                        if(!in_array($view_mode, array(ilContainer::VIEW_SESSIONS, 
                                ilContainer::VIEW_BY_TYPE, ilContainer::VIEW_SIMPLE)))
                        {
                                return ilContainer::VIEW_DEFAULT;
                        }
                        
                        return $view_mode;
                }
                                                
                return $a_view_mode;
        }                       

        function addAdditionalSubItemInformation(&$a_item_data)
        {               
                include_once './Services/Object/classes/class.ilObjectActivation.php';
                ilObjectActivation::addAdditionalSubItemInformation($a_item_data);
        }       

        // Private / Protected
        function __initFileObject()
        {
                if($this->file_obj)
                {
                        return $this->file_obj;
                }
                else
                {
                        include_once './Modules/Group/classes/class.ilFileDataGroup.php';

                        return $this->file_obj = new ilFileDataGroup($this);
                }
        }

        function getMessage()
        {
                return $this->message;
        }
        function setMessage($a_message)
        {
                $this->message = $a_message;
        }
        function appendMessage($a_message)
        {
                if($this->getMessage())
                {
                        $this->message .= "<br /> ";
                }
                $this->message .= $a_message;
        }
        
        protected function prepareAppointments($a_mode = 'create')
        {
                include_once('./Services/Calendar/classes/class.ilCalendarAppointmentTemplate.php');
                
                switch($a_mode)
                {
                        case 'create':
                        case 'update':
                                if($this->isRegistrationUnlimited())
                                {
                                        return array();
                                }
                                $app = new ilCalendarAppointmentTemplate(self::CAL_REG_START);
                                $app->setTitle($this->getTitle());
                                $app->setSubtitle('grp_cal_reg_start');
                                $app->setTranslationType(IL_CAL_TRANSLATION_SYSTEM);
                                $app->setDescription($this->getLongDescription());      
                                $app->setStart($this->getRegistrationStart());
                                $apps[] = $app;

                                $app = new ilCalendarAppointmentTemplate(self::CAL_REG_END);
                                $app->setTitle($this->getTitle());
                                $app->setSubtitle('grp_cal_reg_end');
                                $app->setTranslationType(IL_CAL_TRANSLATION_SYSTEM);
                                $app->setDescription($this->getLongDescription());
                                $app->setStart($this->getRegistrationEnd());
                                $apps[] = $app;
                                
                                return $apps;
                                
                        case 'delete':
                                // Nothing to do: The category and all assigned appointments will be deleted.
                                return array();
                }
        }
        
        protected function initParticipants()
        {
                include_once('./Modules/Group/classes/class.ilGroupParticipants.php');
                $this->members_obj = ilGroupParticipants::_getInstanceByObjId($this->getId());
        }
        
        public static function lookupObjectsByCode($a_code)
        {
                global $ilDB;
                
                $query = "SELECT obj_id FROM grp_settings ".
                        "WHERE reg_ac_enabled = ".$ilDB->quote(1,'integer')." ".
                        "AND reg_ac = ".$ilDB->quote($a_code,'text');
                $res = $ilDB->query($query);
                
                $obj_ids = array();
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $obj_ids[] = $row->obj_id;
                }
                return $obj_ids;
        }
        
        public function register($a_user_id,$a_role = IL_GRP_MEMBER, $a_force_registration = false)
        {
                include_once './Services/Membership/exceptions/class.ilMembershipRegistrationException.php';
                include_once "./Modules/Group/classes/class.ilGroupParticipants.php";
                $part = ilGroupParticipants::_getInstanceByObjId($this->getId());

                if($part->isAssigned($a_user_id))
                {
                        return true;
                }
                
                if(!$a_force_registration)
                {
                        // Availability
                        if(!$this->isRegistrationEnabled())
                        {
                                include_once './Modules/Group/classes/class.ilObjGroupAccess.php';

                                if(!ilObjGroupAccess::_usingRegistrationCode())
                                {
                                        throw new ilMembershipRegistrationException('Cant registrate to group '.$this->getId().
                                                ', group subscription is deactivated.', '456');
                                }
                        }

                        // Time Limitation
                        if(!$this->isRegistrationUnlimited())
                        {
                                $start = $this->getRegistrationStart();
                                $end = $this->getRegistrationEnd();
                                $time = new ilDateTime(time(),IL_CAL_UNIX);

                                if( !(ilDateTime::_after($time, $start) and ilDateTime::_before($time,$end)) )
                                {
                                        throw new ilMembershipRegistrationException('Cant registrate to group '.$this->getId().
                                        ', group is out of registration time.', '789');
                                }
                        }

                        // Max members
                        if($this->isMembershipLimited())
                        {
                                $free = max(0,$this->getMaxMembers() - $part->getCountMembers());
                                include_once('./Modules/Group/classes/class.ilGroupWaitingList.php');
                                $waiting_list = new ilGroupWaitingList($this->getId());
                                if($this->isWaitingListEnabled() and (!$free or $waiting_list->getCountUsers()))
                                {
                                        $this->lng->loadLanguageModule("grp");
                                        $waiting_list->addToList($a_user_id);

                                        $info = sprintf($this->lng->txt('grp_added_to_list'),
                                                $this->getTitle(),
                                                $waiting_list->getPosition($a_user_id));

                                        include_once('./Modules/Group/classes/class.ilGroupParticipants.php');
                                        include_once('./Modules/Group/classes/class.ilGroupMembershipMailNotification.php');
                                        $participants = ilGroupParticipants::_getInstanceByObjId($this->getId());
                                        $participants->sendNotification(ilGroupMembershipMailNotification::TYPE_WAITING_LIST_MEMBER,$a_user_id);

                                        throw new ilMembershipRegistrationException($info, '124');
                                }

                                if(!$free or $waiting_list->getCountUsers())
                                {
                                        throw new ilMembershipRegistrationException('Cant registrate to group '.$this->getId().
                                                ', membership is limited.', '123');
                                }
                        }
                }
                
                $part->add($a_user_id,$a_role);
                $part->sendNotification($part->TYPE_NOTIFICATION_REGISTRATION, $a_user_id);
                return true;
        }       
        
} //END class.ilObjGroup
?>