class.ilObjCourseAccess.php

Go to the documentation of this file.

<?php

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

include_once("./Services/Object/classes/class.ilObjectAccess.php");
include_once './Modules/Course/classes/class.ilCourseConstants.php';
include_once 'Modules/Course/classes/class.ilCourseParticipants.php';
include_once 'Modules/Course/classes/class.ilCourseParticipant.php';

class ilObjCourseAccess extends ilObjectAccess
{

        protected static $using_code = false;

        function _checkAccess($a_cmd, $a_permission, $a_ref_id, $a_obj_id, $a_user_id = "")
        {
                global $ilUser, $lng, $rbacsystem, $ilAccess, $ilias;


                if ($a_user_id == "")
                {
                        $a_user_id = $ilUser->getId();
                }
                
                if($ilUser->getId() == $a_user_id)
                {
                        $participants = ilCourseParticipant::_getInstanceByObjId($a_obj_id,$a_user_id);
                }
                else
                {
                        $participants = ilCourseParticipants::_getInstanceByObjId($a_obj_id);
                }


                switch ($a_cmd)
                {
                        case "view":
                                if($participants->isBlocked($a_user_id) and $participants->isAssigned($a_user_id))
                                {
                                        $ilAccess->addInfoItem(IL_NO_OBJECT_ACCESS, $lng->txt("crs_status_blocked"));
                                        return false;
                                } 
                                break;

                        case 'leave':

                                // Regular member
                                if($a_permission == 'leave')
                                {
                                        include_once './Modules/Course/classes/class.ilCourseParticipants.php';
                                        if(!$participants->isAssigned($a_user_id))
                                        {
                                                return false;
                                        }
                                }
                                // Waiting list
                                if($a_permission == 'join')
                                {
                                        include_once './Modules/Course/classes/class.ilCourseWaitingList.php';
                                        if(!ilCourseWaitingList::_isOnList($a_user_id, $a_obj_id))
                                        {
                                                return false;
                                        }
                                        return true;
                                }
                                break;

                        case 'join':

                                include_once './Modules/Course/classes/class.ilCourseWaitingList.php';
                                if(ilCourseWaitingList::_isOnList($a_user_id, $a_obj_id))
                                {
                                        return false;
                                }
                                break;
                }
                
                switch ($a_permission)
                {               
                        case 'visible':
                                $visible = null;
                                $active = self::_isActivated($a_obj_id, $visible);
                                $tutor = $rbacsystem->checkAccessOfUser($a_user_id,'write',$a_ref_id);                          
                                if(!$active)
                                {
                                        $ilAccess->addInfoItem(IL_NO_OBJECT_ACCESS, $lng->txt("offline"));
                                }
                                if(!$tutor and !$active && !$visible)
                                {
                                        return false;
                                }
                                break;
                        
                        case 'read':                                                    
                                $tutor = $rbacsystem->checkAccessOfUser($a_user_id,'write',$a_ref_id);
                                if($tutor)
                                {
                                        return true;
                                }
                                $active = self::_isActivated($a_obj_id);
                                if(!$active)
                                {
                                        $ilAccess->addInfoItem(IL_NO_OBJECT_ACCESS, $lng->txt("offline"));
                                        return false;
                                }
                                if($participants->isBlocked($a_user_id) and $participants->isAssigned($a_user_id))
                                {
                                        $ilAccess->addInfoItem(IL_NO_OBJECT_ACCESS, $lng->txt("crs_status_blocked"));
                                        return false;
                                } 
                                break;
                                
                        case 'join':                            
                                if(!self::_registrationEnabled($a_obj_id))
                                {
                                        return false;
                                }

                                if($participants->isAssigned($a_user_id))
                                {
                                        return false;
                                }
                                break;
                }
                return true;
        }

        function _getCommands()
        {
                $commands = array();
                $commands[] = array("permission" => "crs_linked", "cmd" => "", "lang_var" => "view", "default" => true);

                include_once './Services/WebServices/FileManager/classes/class.ilFMSettings.php';
                if(ilFMSettings::getInstance()->isEnabled())
                {
                        $commands[] = array(
                                'permission' => 'read',
                                'cmd' => 'fileManagerLaunch',
                                'lang_var' => 'fm_start',
                                'enable_anonymous' => false
                        );
                }

                $commands[] = array("permission" => "join", "cmd" => "join", "lang_var" => "join");

                // on waiting list
                $commands[]     = array('permission' => "join", "cmd" => "leave", "lang_var" => "leave_waiting_list");
                
                // regualar users
                $commands[]     = array('permission' => "leave", "cmd" => "leave", "lang_var" => "crs_unsubscribe");

                include_once ('Services/WebDAV/classes/class.ilDAVActivationChecker.php');
                if (ilDAVActivationChecker::_isActive())
                {
                        include_once './Services/WebDAV/classes/class.ilDAVUtils.php';
                        if(ilDAVUtils::getInstance()->isLocalPasswordInstructionRequired())
                        {
                                $commands[] = array('permission' => 'read', 'cmd' => 'showPasswordInstruction', 'lang_var' => 'mount_webfolder', 'enable_anonymous' => 'false');
                        }
                        else
                        {
                                $commands[] = array("permission" => "read", "cmd" => "mount_webfolder", "lang_var" => "mount_webfolder", "enable_anonymous" => "false");
                        }
                }

                $commands[] = array("permission" => "write", "cmd" => "enableAdministrationPanel", "lang_var" => "edit_content");
                $commands[] = array("permission" => "write", "cmd" => "edit", "lang_var" => "settings");
                return $commands;
        }
        
        function _checkGoto($a_target)
        {
                global $ilAccess,$ilUser;
                
                $t_arr = explode("_", $a_target);
                
                // registration codes
                if(substr($t_arr[2],0,5) == 'rcode' and $ilUser->getId() != ANONYMOUS_USER_ID)
                {
                        self::$using_code = true;
                        return true;
                }
                

                if ($t_arr[0] != "crs" || ((int) $t_arr[1]) <= 0)
                {
                        return false;
                }

                // checking for read results in endless loop, if read is given
                // but visible is not given (-> see bug 5323)
                if ($ilAccess->checkAccess("read", "", $t_arr[1]) ||
                        $ilAccess->checkAccess("visible", "", $t_arr[1]))
                //if ($ilAccess->checkAccess("visible", "", $t_arr[1]))
                {
                        return true;
                }
                return false;
        }
        
        function _lookupViewMode($a_id)
        {
                global $ilDB;

                $query = "SELECT view_mode FROM crs_settings WHERE obj_id = ".$ilDB->quote($a_id ,'integer')." ";
                $res = $ilDB->query($query);
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        return $row->view_mode;
                }
                return false;
        }
        
        protected static function _isOnline($a_obj_id)
        {
                global $ilDB;
                
                $query = "SELECT * FROM crs_settings ".
                        "WHERE obj_id = ".$ilDB->quote($a_obj_id ,'integer')." ";
                $res = $ilDB->query($query);
                $row = $res->fetchRow(DB_FETCHMODE_OBJECT);                             
                return (bool)$row->activation_type;     
        }

        public static function _isActivated($a_obj_id, &$a_visible_flag = null, $a_mind_member_view = true)
        {               
                // #7669
                if($a_mind_member_view)
                {
                        include_once './Services/Container/classes/class.ilMemberViewSettings.php';
                        if(ilMemberViewSettings::getInstance()->isActive())
                        {               
                                $a_visible_flag = true;                 
                                return true;
                        }
                }
                
                // offline?
                if(!self::_isOnline($a_obj_id))
                {
                        $a_visible_flag = false;
                        return false;                                                   
                }                               
                
                $ref_id = ilObject::_getAllReferences($a_obj_id);
                $ref_id = array_pop($ref_id);           
                
                $a_visible_flag = true;         
                
                include_once './Services/Object/classes/class.ilObjectActivation.php';
                $item = ilObjectActivation::getItem($ref_id);           
                switch($item['timing_type'])
                {                                               
                        case ilObjectActivation::TIMINGS_ACTIVATION:
                                if(time() < $item['timing_start'] or
                                   time() > $item['timing_end'])
                                {
                                        $a_visible_flag = $item['visible'];
                                        return false;
                                }
                                // fallthrough
                                
                        default:                        
                                return true;
                }
        }

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

                $query = "SELECT * FROM crs_settings ".
                        "WHERE obj_id = ".$ilDB->quote($a_obj_id ,'integer')." ";

                $res = $ilDB->query($query);
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $type = $row->sub_limitation_type;
                        $reg_start = $row->sub_start;
                        $reg_end = $row->sub_end;
                }

                switch($type)
                {
                        case IL_CRS_SUBSCRIPTION_UNLIMITED:
                                return true;

                        case IL_CRS_SUBSCRIPTION_DEACTIVATED:
                                return false;

                        case IL_CRS_SUBSCRIPTION_LIMITED:
                                if(time() > $reg_start and
                                   time() < $reg_end)
                                {
                                        return true;
                                }
                        default:
                                return false;
                }
                return false;
        }
        
        public static function lookupRegistrationInfo($a_obj_id)
        {
                global $ilDB, $ilUser, $lng;
                
                $query = 'SELECT sub_limitation_type, sub_start, sub_end, sub_mem_limit, sub_max_members FROM crs_settings '.
                        'WHERE obj_id = '.$ilDB->quote($a_obj_id);
                $res = $ilDB->query($query);
                
                $info = array();
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $info['reg_info_start'] = new ilDateTime($row->sub_start, IL_CAL_UNIX);
                        $info['reg_info_end'] = new ilDateTime($row->sub_end, IL_CAL_UNIX);
                        $info['reg_info_type'] = $row->sub_limitation_type;
                        $info['reg_info_max_members'] = $row->sub_max_members;
                        $info['reg_info_mem_limit'] = $row->sub_mem_limit;
                }
                
                $registration_possible = true;

                // Limited registration
                if($info['reg_info_type'] == ilCourseConstants::SUBSCRIPTION_LIMITED)
                {
                        $dt = new ilDateTime(time(),IL_CAL_UNIX);
                        if(ilDateTime::_before($dt, $info['reg_info_start']))
                        {
                                $info['reg_info_list_prop']['property'] = $lng->txt('crs_list_reg_start');
                                $info['reg_info_list_prop']['value'] = ilDatePresentation::formatDate($info['reg_info_start']);
                        }
                        elseif(ilDateTime::_before($dt, $info['reg_info_end']))
                        {
                                $info['reg_info_list_prop']['property'] = $lng->txt('crs_list_reg_end');
                                $info['reg_info_list_prop']['value'] = ilDatePresentation::formatDate($info['reg_info_end']);
                        }
                        else
                        {
                                $registration_possible = false;
                                $info['reg_info_list_prop']['property'] = $lng->txt('crs_list_reg_period');
                                $info['reg_info_list_prop']['value'] = $lng->txt('crs_list_reg_noreg');
                        }
                }
                else if($info['reg_info_type'] == ilCourseConstants::SUBSCRIPTION_UNLIMITED)
                {
                        $registration_possible = true;
                }
                else
                {
                        $registration_possible = false;
                        $info['reg_info_list_prop']['property'] = $lng->txt('crs_list_reg_period');
                        $info['reg_info_list_prop']['value'] = $lng->txt('crs_list_reg_noreg');
                }
                
                if($info['reg_info_mem_limit'] && $registration_possible)
                {
                        // Check if users are on waiting list
                        // @todo
                        
                        
                        // Check for free places
                        $part = ilCourseParticipant::_getInstanceByObjId($a_obj_id, $ilUser->getId());
                        if($part->getNumberOfMembers() <= $info['reg_info_max_members'])
                        {
                                $info['reg_info_list_prop_limit']['property'] = $lng->txt('crs_list_reg_limit_places');
                                $info['reg_info_list_prop_limit']['value'] = max(
                                                0,
                                                $info['reg_info_max_members'] - $part->getNumberOfMembers()
                                        );
                        }
                        else
                        {
                                $info['reg_info_list_prop_limit']['property'] = '';
                                $info['reg_info_list_prop_limit']['value'] = $lng->txt('crs_list_reg_limit_full');
                        }
                }
                
                return $info;
        }

        static function _isOffline($a_obj_id)
        {
                $dummy = null;
                return !self::_isActivated($a_obj_id, $dummy, false);
        }
        
        function _preloadData($a_obj_ids, $a_ref_ids)
        {
                global $ilUser;
                
                include_once("./Modules/Course/classes/class.ilCourseWaitingList.php");
                ilCourseWaitingList::_preloadOnListInfo($ilUser->getId(), $a_obj_ids);
                
                include_once "./Modules/Course/classes/class.ilCourseCertificateAdapter.php";
                ilCourseCertificateAdapter::_preloadListData($ilUser->getId(), $a_obj_ids);             
        }

        public static function _usingRegistrationCode()
        {
                return self::$using_code;
        }

}

?>