chamilo-lms/main/mySpace/student.php

<?php

/* For licensing terms, see /license.txt */

/**
 * Report on students subscribed to courses I am teaching.
 */
$cidReset = true;

require_once __DIR__.'/../inc/global.inc.php';

api_block_anonymous_users();

$allowToTrack = api_is_platform_admin(true, true) ||
    api_is_teacher() ||
    api_is_student_boss();

if (!$allowToTrack) {
    api_not_allowed(true);
}

$nameTools = get_lang('Students');

$export_csv = isset($_GET['export']) && 'csv' === $_GET['export'];
$keyword = isset($_GET['keyword']) ? Security::remove_XSS($_GET['keyword']) : null;
$active = isset($_GET['active']) ? (int) $_GET['active'] : 1;
$sleepingDays = isset($_GET['sleeping_days']) ? (int) $_GET['sleeping_days'] : null;
$this_section = SECTION_TRACKING;

$webCodePath = api_get_path(WEB_CODE_PATH);

$interbreadcrumb[] = [
    'url' => api_is_student_boss() ? '#' : 'index.php',
    'name' => get_lang('MySpace'),
];

if (isset($_GET['user_id']) && '' != $_GET['user_id'] && !isset($_GET['type'])) {
    $interbreadcrumb[] = [
        'url' => 'teachers.php',
        'name' => get_lang('Teachers'),
    ];
}

if (isset($_GET['user_id']) && '' != $_GET['user_id'] && isset($_GET['type']) && 'coach' === $_GET['type']) {
    $interbreadcrumb[] = ['url' => 'coaches.php', 'name' => get_lang('Tutors')];
}

function get_count_users(): int
{
    $users = get_users(null, null, 0, 3, true);

    return $users['count_users'];
}

function get_users($from, $limit, $column = 0, $direction = 3, $getCount = false): array
{
    global $export_csv;
    $active = $_GET['active'] ?? 1;
    $keyword = isset($_GET['keyword']) ? Security::remove_XSS($_GET['keyword']) : null;
    $sleepingDays = isset($_GET['sleeping_days']) ? (int) $_GET['sleeping_days'] : null;
    $sessionId = isset($_GET['id_session']) ? (int) $_GET['id_session'] : 0;

    $webCodePath = api_get_path(WEB_CODE_PATH);

    $lastConnectionDate = null;
    if (!empty($sleepingDays)) {
        $lastConnectionDate = api_get_utc_datetime(strtotime($sleepingDays.' days ago'));
    }

    // Filter by Extra Fields
    $useExtraFields = false;
    $extraFieldResult = [];
    foreach ($_GET as $key => $value) {
        if (substr($key, 0, 6) == 'extra_') {
            $variable = substr($key, 6);
            if (UserManager::is_extra_field_available($variable) && !empty($value)) {
                if (is_array($value)) {
                    $value = $value[$key];
                }
                $useExtraFields = true;
                $extraFieldResult[] = UserManager::get_extra_user_data_by_value(
                    $variable,
                    $value,
                    true
                );
            }
        }
    }
    $filterUsers = [];
    if ($useExtraFields) {
        if (count($extraFieldResult) > 1) {
            for ($i = 0; $i < count($extraFieldResult) - 1; $i++) {
                if (is_array($extraFieldResult[$i + 1])) {
                    $filterUsers = array_intersect($extraFieldResult[$i], $extraFieldResult[$i + 1]);
                }
            }
        } else {
            $filterUsers = $extraFieldResult[0];
        }
    }

    $is_western_name_order = api_is_western_name_order();
    $coach_id = api_get_user_id();
    $column = 'u.user_id';
    $drhLoaded = false;
    $students = [];

    if (api_is_drh()) {
        if (api_drh_can_access_all_session_content()) {
            $students = SessionManager::getAllUsersFromCoursesFromAllSessionFromStatus(
                'drh_all',
                api_get_user_id(),
                $getCount,
                $from,
                $limit,
                $column,
                $direction,
                $keyword,
                $active,
                $lastConnectionDate,
                null,
                null,
                api_is_student_boss() ? null : STUDENT,
                $filterUsers
            );
            $drhLoaded = true;
        }
        $allowDhrAccessToAllStudents = api_get_configuration_value('drh_allow_access_to_all_students');
        if ($allowDhrAccessToAllStudents) {
            $conditions = ['status' => STUDENT];
            if (isset($active)) {
                $conditions['active'] = (int) $active;
            }
            $students = UserManager::get_user_list(
                $conditions,
                [],
                $from,
                $limit,
                null,
                $keyword,
                $lastConnectionDate,
                $getCount,
                $filterUsers
            );
            $drhLoaded = true;
        }
    }

    $checkSessionVisibility = api_get_configuration_value('show_users_in_active_sessions_in_tracking');
    if (false === $drhLoaded) {
        $students = UserManager::getUsersFollowedByUser(
            api_get_user_id(),
            api_is_student_boss() ? null : STUDENT,
            false,
            false,
            $getCount,
            $from,
            $limit,
            $column,
            $direction,
            $active,
            $lastConnectionDate,
            api_is_student_boss() ? STUDENT_BOSS : COURSEMANAGER,
            $keyword,
            $checkSessionVisibility,
            $filterUsers
        );
    }

    if ($getCount) {
        return ['count_users' => (int) $students];
    }

    $url = $webCodePath.'mySpace/myStudents.php';

    $all_datas = [];
    foreach ($students as $student_data) {
        $student_id = $student_data['user_id'];
        $student_data = api_get_user_info($student_id);

        if (isset($_GET['id_session'])) {
            $courses = Tracking::get_course_list_in_session_from_student($student_id, $sessionId);
        }

        $avg_time_spent = $avg_student_score = $avg_student_progress = 0;
        $nb_courses_student = 0;
        if (!empty($courses)) {
            foreach ($courses as $course_code) {
                $courseInfo = api_get_course_info($course_code);
                $courseId = $courseInfo['real_id'];

                if (CourseManager::is_user_subscribed_in_course($student_id, $course_code, true)) {
                    $avg_time_spent += Tracking::get_time_spent_on_the_course(
                        $student_id,
                        $courseId,
                        $_GET['id_session']
                    );
                    $my_average = Tracking::get_avg_student_score($student_id, $course_code);
                    if (is_numeric($my_average)) {
                        $avg_student_score += $my_average;
                    }
                    $avg_student_progress += Tracking::get_avg_student_progress($student_id, $course_code);
                    $nb_courses_student++;
                }
            }
        }

        if ($nb_courses_student > 0) {
            $avg_time_spent = $avg_time_spent / $nb_courses_student;
            $avg_student_score = $avg_student_score / $nb_courses_student;
            $avg_student_progress = $avg_student_progress / $nb_courses_student;
        } else {
            $avg_time_spent = null;
            $avg_student_score = null;
            $avg_student_progress = null;
        }

        $urlDetails = $url."?student=$student_id";
        if (isset($_GET['id_coach']) && 0 != intval($_GET['id_coach'])) {
            $urlDetails = $url."?student=$student_id&id_coach=$coach_id&id_session=$sessionId";
        }

        $row = [];
        if (!$export_csv) {
            $row[] = $student_id;
        }
        if ($is_western_name_order) {
            $first = Display::url($student_data['firstname'], $urlDetails);
            $last = Display::url($student_data['lastname'], $urlDetails);
        } else {
            $first = Display::url($student_data['lastname'], $urlDetails);
            $last = Display::url($student_data['firstname'], $urlDetails);
        }

        if ($export_csv) {
            $first = strip_tags($first);
            $last = strip_tags($last);
        }

        $row[] = $first;
        $row[] = $last;

        $string_date = Tracking::get_last_connection_date($student_id, !$export_csv);
        $first_date = Tracking::get_first_connection_date($student_id);
        $row[] = $first_date;
        $row[] = $string_date;

        if (!$export_csv) {
            $detailsLink = Display::url(
                Display::return_icon('2rightarrow.png', get_lang('Details').' '.$student_data['username']),
                $urlDetails,
                ['id' => 'details_'.$student_data['username']]
            );

            $userIsFollowed = UserManager::is_user_followed_by_drh($student_id, api_get_user_id());
            $lostPasswordLink = '';
            if ((api_is_drh() && $userIsFollowed) || api_is_platform_admin()) {
                $lostPasswordLink = '&nbsp;'.Display::url(
                        Display::return_icon('edit.png', get_lang('Edit')),
                        $webCodePath.'mySpace/user_edit.php?user_id='.$student_id
                    );
            }

            $row[] = $lostPasswordLink.$detailsLink;
        }
        $all_datas[] = $row;
    }

    return $all_datas;
}

if ($export_csv) {
    $is_western_name_order = api_is_western_name_order(PERSON_NAME_DATA_EXPORT);
} else {
    $is_western_name_order = api_is_western_name_order();
}

$sort_by_first_name = api_sort_by_first_name();
$actionsLeft = '';

if (api_is_drh()) {
    $menu_items = [
        Display::url(
            Display::return_icon('statistics.png', get_lang('MyStats'), '', ICON_SIZE_MEDIUM),
            $webCodePath.'auth/my_progress.php'
        ),
        Display::url(
            Display::return_icon('user_na.png', get_lang('Students'), [], ICON_SIZE_MEDIUM),
            '#'
        ),
        Display::url(
            Display::return_icon('teacher.png', get_lang('Trainers'), [], ICON_SIZE_MEDIUM),
            'teachers.php'
        ),
        Display::url(
            Display::return_icon('course.png', get_lang('Courses'), [], ICON_SIZE_MEDIUM),
            'course.php'
        ),
        Display::url(
            Display::return_icon('session.png', get_lang('Sessions'), [], ICON_SIZE_MEDIUM),
            'session.php'
        ),
        Display::url(
            Display::return_icon('skills.png', get_lang('Skills'), [], ICON_SIZE_MEDIUM),
            $webCodePath.'social/my_skills_report.php'
        ),
    ];

    $actionsLeft .= implode('', $menu_items);
} elseif (api_is_student_boss()) {
    $actionsLeft .= Display::url(
        Display::return_icon('statistics.png', get_lang('MyStats'), '', ICON_SIZE_MEDIUM),
        $webCodePath.'auth/my_progress.php'
    );
    $actionsLeft .= Display::url(
        Display::return_icon('user_na.png', get_lang('Students'), [], ICON_SIZE_MEDIUM),
        '#'
    );
    $actionsLeft .= Display::url(
        Display::return_icon('skills.png', get_lang('Skills'), [], ICON_SIZE_MEDIUM),
        $webCodePath.'social/my_skills_report.php'
    );
    $actionsLeft .= Display::url(
        Display::return_icon('statistics.png', get_lang('CompanyReport'), [], ICON_SIZE_MEDIUM),
        $webCodePath.'mySpace/company_reports.php'
    );

    $actionsLeft .= Display::url(
        Display::return_icon('calendar-user.png', get_lang('MyStudentsSchedule'), [], ICON_SIZE_MEDIUM),
        $webCodePath.'mySpace/calendar_plan.php'
    );

    $actionsLeft .= Display::url(
        Display::return_icon(
            'certificate_list.png',
            get_lang('GradebookSeeListOfStudentsCertificates'),
            [],
            ICON_SIZE_MEDIUM
        ),
        $webCodePath.'gradebook/certificate_report.php'
    );
}

$actionsRight = Display::url(
    Display::return_icon('printer.png', get_lang('Print'), [], ICON_SIZE_MEDIUM),
    'javascript: void(0);',
    ['onclick' => 'javascript: window.print();']
);
$actionsRight .= Display::url(
    Display::return_icon('export_csv.png', get_lang('ExportAsCSV'), [], ICON_SIZE_MEDIUM),
    api_get_self().'?export=csv&keyword='.$keyword
);

$toolbar = Display::toolbarAction('toolbar-student', [$actionsLeft, $actionsRight]);

$itemPerPage = 10;
$perPage = api_get_configuration_value('my_space_users_items_per_page');
if ($perPage) {
    $itemPerPage = (int) $perPage;
}

$table = new SortableTable(
    'tracking_student',
    'get_count_users',
    'get_users',
    ($is_western_name_order xor $sort_by_first_name) ? 1 : 0,
    $itemPerPage
);

$params = [
    'keyword' => $keyword,
    'active' => $active,
    'sleeping_days' => $sleepingDays,
];
$table->set_additional_parameters($params);

$table->set_header(0, '&nbsp;', false);

if ($is_western_name_order) {
    $table->set_header(1, get_lang('FirstName'), false);
    $table->set_header(2, get_lang('LastName'), false);
} else {
    $table->set_header(2, get_lang('LastName'), false);
    $table->set_header(1, get_lang('FirstName'), false);
}

$table->set_header(3, get_lang('FirstLogin'), false);
$table->set_header(4, get_lang('LastConnexion'), false);
$table->set_header(5, get_lang('Details'), false);

// Only show empty actions bar if delete users has been blocked
$actionsList = [];
$actionsList['send_emails'] = get_lang('SendEmail');
$table->set_form_actions($actionsList);

if ($export_csv) {
    if ($is_western_name_order) {
        $csv_header[] = [
            get_lang('FirstName'),
            get_lang('LastName'),
            get_lang('FirstLogin'),
            get_lang('LastConnexion'),
        ];
    } else {
        $csv_header[] = [
            get_lang('LastName'),
            get_lang('FirstName'),
            get_lang('FirstLogin'),
            get_lang('LastConnexion'),
        ];
    }
}

$form = new FormValidator(
    'search_user',
    'get',
    $webCodePath.'mySpace/student.php'
);
$form = Tracking::setUserSearchForm($form, true);
$form->setDefaults($params);

if ($export_csv) {
    // send the csv file if asked
    $content = $table->get_table_data();
    $csv_content = array_merge($csv_header, $content);
    Export::arrayToCsv($csv_content, 'reporting_student_list');
    exit;
} else {

    // It sends the email to selected users
    if (isset($_POST['action']) && 'send_message' == $_POST['action']) {
        $subject = $_POST['subject'] ?? '';
        $message = $_POST['message'] ?? '';
        $users = $_POST['uid'] ?? '';
        if (!empty($subject) && !empty($message) && !empty($users)) {
            foreach ($users as $uid) {
                MessageManager::send_message_simple(
                    $uid,
                    $subject,
                    $message,
                    api_get_user_id()
                );
            }
            Display::addFlash(Display::return_message(get_lang('MessageSent')));
        }
    }

    $script = '<script>
        $(function() {
          $("#form_tracking_student_id input[type=\"checkbox\"]").on("click", function() {
            $("#compose_message").hide();
          });
        });
        function action_click(element, table_id) {
            this.event.preventDefault();
            var amIChecked = false;
            $(".hd-users").remove();
            $("#form_tracking_student_id input[type=\"checkbox\"]").each(function() {
                if (this.checked) {
                    amIChecked = true;
                    var input = $("<input>", {
                        type: "hidden",
                        name: "uid[]",
                        value: this.value,
                        class: "hd-users",
                    });
                    $("#students_messages").append(input);
                }
            });
            if (!amIChecked) {
                alert("'.get_lang('YouMustSelectAtLeastOneDestinee').'");
                return false;
            }
            $("#compose_message").show();
            return false;
        }
    </script>
    ';

    Display::display_header($nameTools);
    $token = Security::get_token();
    echo $toolbar;
    echo Display::page_subheader($nameTools);
    if (isset($active)) {
        if ($active) {
            $activeLabel = get_lang('ActiveUsers');
        } else {
            $activeLabel = get_lang('InactiveUsers');
        }
        echo Display::page_subheader2($activeLabel);
    }
    $form->display();
    $table->display();

    $frmMessage = new FormValidator(
        'students_messages',
        'post',
        api_get_self()
    );
    $frmMessage->addHtml('<div id="compose_message" style="display:none;">');
    $frmMessage->addText('subject', get_lang('Subject'));
    $frmMessage->addRule('subject', 'obligatorio', 'required');
    $frmMessage->addHtmlEditor('message', get_lang('Message'));
    $frmMessage->addButtonSend(get_lang('Send'));
    $frmMessage->addHidden('sec_token', $token);
    $frmMessage->addHidden('action', 'send_message');
    $frmMessage->addHtml('</div>');
    $frmMessage->display();

    echo $script;
}

Display::display_footer();