chamilo-lms2/user_portal.php

<?php
/* For licensing terms, see /license.txt */

use ChamiloSession as Session;

/**
 * This is the index file displayed when a user is logged in on Chamilo.
 *
 * It displays:
 * - personal course list
 * - menu bar
 * Search for CONFIGURATION parameters to modify settings
 *
 * @package chamilo.main
 *
 * @todo Shouldn't the CONFVAL_ constant be moved to the config page? Has anybody any idea what the are used for?
 *       If these are really configuration settings then we can add those to the dokeos config settings.
 * @todo check for duplication of functions with index.php (user_portal.php is orginally a copy of index.php)
 * @todo display_digest, shouldn't this be removed and be made into an extension?
 */

/* Flag forcing the 'current course' reset, as we're not inside a course anymore */
$cidReset = true;

/* Included libraries */
require_once './main/inc/global.inc.php';

// For HTML editor repository.
Session::erase('this_section');

$this_section = SECTION_COURSES;

api_block_anonymous_users(); // Only users who are logged in can proceed.

$logInfo = [
    'tool' => SECTION_COURSES,
    'tool_id' => 0,
    'tool_id_detail' => 0,
    'action' => '',
    'info' => '',
];
Event::registerLog($logInfo);

$userId = api_get_user_id();

$collapsable = api_get_configuration_value('allow_user_session_collapsable');
if ($collapsable) {
    $action = isset($_REQUEST['action']) ? $_REQUEST['action'] : '';
    $sessionId = isset($_REQUEST['session_id']) ? $_REQUEST['session_id'] : '';
    $value = isset($_REQUEST['value']) ? (int) $_REQUEST['value'] : '';
    switch ($action) {
        case 'collapse_session':
            if (!empty($sessionId)) {
                $userRelSession = SessionManager::getUserSession($userId, $sessionId);
                if ($userRelSession) {
                    $table = Database::get_main_table(TABLE_MAIN_SESSION_USER);
                    $sql = "UPDATE $table SET collapsed = $value WHERE id = ".$userRelSession['id'];
                    Database::query($sql);
                    Display::addFlash(Display::return_message(get_lang('Update successful')));
                }
                header('Location: user_portal.php');
                exit;
            }
            break;
    }
}

/* Constants and CONFIGURATION parameters */
$load_dirs = api_get_setting('show_documents_preview');
$displayMyCourseViewBySessionLink = api_get_setting('my_courses_view_by_session') === 'true';
$nameTools = get_lang('My courses');
$loadHistory = isset($_GET['history']) && intval($_GET['history']) == 1 ? true : false;

// Load course notification by ajax
$loadNotificationsByAjax = api_get_configuration_value('user_portal_load_notification_by_ajax');
if ($loadNotificationsByAjax) {
    $htmlHeadXtra[] = '<script>
    $(function() {
        $(".course_notification").each(function(index) {
            var div = $(this);
            var id = $(this).attr("id");       
            var idList = id.split("_");
            var courseId = idList[1];
            var sessionId = idList[2];
            var status = idList[3];
            $.ajax({			
                type: "GET",
                url: "'.api_get_path(WEB_AJAX_PATH).'course_home.ajax.php?a=get_notification&course_id="+courseId+"&session_id="+sessionId+"&status="+status,			
                success: function(data) {			    
                    div.append(data);			    
                }
            });
        });
    });
    </script>';
}

/*
    Header
    Include the HTTP, HTML headers plus the top banner.
*/
if ($load_dirs) {
    $url = api_get_path(WEB_AJAX_PATH).'document.ajax.php?a=document_preview';
    $folder_icon = api_get_path(WEB_IMG_PATH).'icons/22/folder.png';
    $close_icon = api_get_path(WEB_IMG_PATH).'loading1.gif';
    $htmlHeadXtra[] = '<script>
	$(document).ready(function() {
		$(".document_preview_container").hide();
		$(".document_preview").click(function() {
			var my_id = this.id;
			var course_id  = my_id.split("_")[2];
			var session_id = my_id.split("_")[3];

			//showing div
			$(".document_preview_container").hide();
			$("#document_result_" +course_id+"_" + session_id).show();

			// Loading
			var image = $("img", this);
			image.attr("src", "'.$close_icon.'");

			$.ajax({
				url: "'.$url.'",
				data: "course_id="+course_id+"&session_id="+session_id,
	            success: function(return_value) {
	            	image.attr("src", "'.$folder_icon.'");
	            	$("#document_result_" +course_id+"_" + session_id).html(return_value);
	            }
	        });

		});
	});
	</script>';
}
if ($displayMyCourseViewBySessionLink) {
    $htmlHeadXtra[] = '
    <script>
        userId = '.$userId.'
        $(document).ready(function() {
            changeMyCoursesView($.cookie("defaultMyCourseView" + userId));
        });
    
        /**
        * Keep in cookie the last teacher view for the My Courses Tab. default view, or view by session
        * @param inView
        */
        function changeMyCoursesView(inView) {
            $.cookie("defaultMyCourseView"+userId, inView, { expires: 365 });
            if (inView == '.IndexManager::VIEW_BY_SESSION.') {
                $("#viewBySession").addClass("btn-primary");
                $("#viewByDefault").removeClass("btn-primary");
            } else {
                $("#viewByDefault").addClass("btn-primary");
                $("#viewBySession").removeClass("btn-primary");
            }
        }
	</script>';
}

$myCourseListAsCategory = api_get_configuration_value('my_courses_list_as_category');

$controller = new IndexManager(get_lang('My courses'));

if (!$myCourseListAsCategory) {
    // Main courses and session list
    if (isset($_COOKIE['defaultMyCourseView'.$userId]) &&
        $_COOKIE['defaultMyCourseView'.$userId] == IndexManager::VIEW_BY_SESSION &&
        $displayMyCourseViewBySessionLink
    ) {
        $courseAndSessions = $controller->returnCoursesAndSessionsViewBySession($userId);
        IndexManager::setDefaultMyCourseView(IndexManager::VIEW_BY_SESSION, $userId);
    } else {
        $courseAndSessions = $controller->returnCoursesAndSessions($userId, true, null, true, $loadHistory);
        IndexManager::setDefaultMyCourseView(IndexManager::VIEW_BY_DEFAULT, $userId);
    }

    // if teacher, session coach or admin, display the button to change te course view
    if ($displayMyCourseViewBySessionLink &&
        (
            api_is_drh() ||
            api_is_session_general_coach() ||
            api_is_platform_admin() ||
            api_is_session_admin() ||
            api_is_teacher()
        )
    ) {
        $courseAndSessions['html'] = "
            <div class='view-by-session-link'>
                <div class='btn-group pull-right'>
                    <a class='btn btn-default' id='viewByDefault' href='user_portal.php'
                        onclick='changeMyCoursesView(\"".IndexManager::VIEW_BY_DEFAULT."\")'>
                        ".get_lang('MyCoursesDefaultView')."
                    </a>
                    <a class='btn btn-default' id='viewBySession' href='user_portal.php'
                        onclick='changeMyCoursesView(\"".IndexManager::VIEW_BY_SESSION."\")'>
                        ".get_lang('MyCoursesSessionView')."
                    </a>
                </div>
            </div>
            <br /><br />
        ".$courseAndSessions['html'];
    }
} else {
    $categoryCode = isset($_GET['category']) ? $_GET['category'] : '';

    if (!$categoryCode) {
        $courseAndSessions = $controller->returnCourseCategoryListFromUser($userId);
    } else {
        $courseAndSessions = $controller->returnCoursesAndSessions(
            $userId,
            false,
            $categoryCode,
            true,
            $loadHistory
        );
        $getCategory = CourseCategory::getCategory($categoryCode);
        $controller->tpl->assign('category', $getCategory);
    }
}

// Check if a user is enrolled only in one course for going directly to the course after the login.
if (api_get_setting('go_to_course_after_login') === 'true') {
    $count_of_sessions = $courseAndSessions['session_count'];
    $count_of_courses_no_sessions = $courseAndSessions['course_count'];
    // User is subscribe in 1 session and 0 courses.
    if ($count_of_sessions == 1 && $count_of_courses_no_sessions == 0) {
        $sessions = SessionManager::get_sessions_by_user($userId);

        if (isset($sessions[0])) {
            $sessionInfo = $sessions[0];
            // Session only has 1 course.
            if (isset($sessionInfo['courses']) &&
                count($sessionInfo['courses']) == 1
            ) {
                $courseCode = $sessionInfo['courses'][0]['code'];
                $courseInfo = api_get_course_info_by_id($sessionInfo['courses'][0]['real_id']);
                $courseUrl = $courseInfo['course_public_url'].'?id_session='.$sessionInfo['session_id'];
                header('Location:'.$courseUrl);
                exit;
            }

            // Session has many courses.
            if (isset($sessionInfo['session_id'])) {
                $url = api_get_path(WEB_CODE_PATH).'session/index.php?session_id='.$sessionInfo['session_id'];

                header('Location:'.$url);
                exit;
            }
        }
    }

    // User is subscribed to 1 course.
    if (!isset($_SESSION['coursesAlreadyVisited']) &&
        $count_of_sessions == 0 &&
        $count_of_courses_no_sessions == 1
    ) {
        $courses = CourseManager::get_courses_list_by_user_id($userId);
        if (!empty($courses) && isset($courses[0]) && isset($courses[0]['code'])) {
            $courseInfo = api_get_course_info_by_id($courses[0]['real_id']);
            if (!empty($courseInfo)) {
                $courseUrl = $courseInfo['course_public_url'];
                header('Location:'.$courseUrl);
                exit;
            }
        }
    }
}

$showWelcomeCourse = false;
// Show the chamilo mascot
if (empty($courseAndSessions['html_courses']) && !isset($_GET['history'])) {
    $controller->setWelComeCourse();
    $showWelcomeCourse = true;
}

$controller->tpl->assign('content', $courseAndSessions['html']);

// Display the Site Use Cookie Warning Validation
$useCookieValidation = api_get_setting('cookie_warning');
if ($useCookieValidation === 'true') {
    if (isset($_POST['acceptCookies'])) {
        api_set_site_use_cookie_warning_cookie();
    } else {
        if (!api_site_use_cookie_warning_cookie_exist()) {
            if (Template::isToolBarDisplayedForUser()) {
                $controller->tpl->assign('toolBarDisplayed', true);
            } else {
                $controller->tpl->assign('toolBarDisplayed', false);
            }
            $controller->tpl->assign('displayCookieUsageWarning', true);
        }
    }
}

$historyClass = '';
if (!empty($_GET['history'])) {
    $historyClass = 'courses-history';
}
$controller->tpl->assign('course_history_page', $historyClass);
if ($myCourseListAsCategory) {
    $controller->tpl->assign('header', get_lang('My courses'));
}

$controller->setGradeBookDependencyBar($userId);

// Deleting the session_id.
Session::erase('session_id');
Session::erase('id_session');
Session::erase('studentview');
api_remove_in_gradebook();

$controller->tpl->assign('content', $controller->tpl->fetch('@ChamiloTheme/Index/userportal.html.twig'));
$controller->tpl->display_one_col_template();