Chamilo is a learning management system focused on ease of use and accessibility
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
chamilo-lms/public/main/inc/lib/sessionmanager.lib.php

10123 lines
379 KiB

<?php
/* For licensing terms, see /license.txt */
use Chamilo\CoreBundle\Entity\Asset;
use Chamilo\CoreBundle\Entity\Course;
use Chamilo\CoreBundle\Entity\ExtraField;
use Chamilo\CoreBundle\Entity\SequenceResource;
use Chamilo\CoreBundle\Entity\Session;
use Chamilo\CoreBundle\Entity\SessionCategory;
use Chamilo\CoreBundle\Entity\SessionRelCourse;
use Chamilo\CoreBundle\Entity\SessionRelCourseRelUser;
use Chamilo\CoreBundle\Entity\SessionRelUser;
use Chamilo\CoreBundle\Entity\User;
use Chamilo\CoreBundle\Framework\Container;
use Chamilo\CourseBundle\Entity\CSurvey;
use ExtraField as ExtraFieldModel;
use Monolog\Logger;
use Symfony\Component\HttpFoundation\File\UploadedFile;
use Chamilo\CoreBundle\Component\Utils\ActionIcon;
use Chamilo\CoreBundle\Component\Utils\ObjectIcon;
use Chamilo\CoreBundle\Component\Utils\StateIcon;
/**
* This is the session library for Chamilo
* (as in courses>session, not as in PHP session)
* All main sessions functions should be placed here.
* This class provides methods for sessions management.
* Include/require it in your code to use its features.
*/
class SessionManager
{
public const STATUS_PLANNED = 1;
public const STATUS_PROGRESS = 2;
public const STATUS_FINISHED = 3;
public const STATUS_CANCELLED = 4;
// See BT#4871
public const SESSION_CHANGE_USER_REASON_SCHEDULE = 1;
public const SESSION_CHANGE_USER_REASON_CLASSROOM = 2;
public const SESSION_CHANGE_USER_REASON_LOCATION = 3;
public const SESSION_CHANGE_USER_REASON_ENROLLMENT_ANNULATION = 4;
public const DEFAULT_VISIBILITY = 4; //SESSION_AVAILABLE
public function __construct()
{
}
/**
* Fetches a session from the database.
*
* @param int $id Session Id
*
* @return array Session details
*/
public static function fetch($id)
{
if (empty($id)) {
return [];
}
$session = api_get_session_entity($id);
if (!$session) {
return [];
}
$result = [
'id' => $session->getId(),
'session_category_id' => $session->getCategory() ? $session->getCategory()->getId() : null,
'name' => $session->getTitle(), // only provided for backwards compatibility - should be removed in the long run
'title' => $session->getTitle(),
'description' => $session->getDescription(),
'show_description' => $session->getShowDescription(),
'duration' => $session->getDuration(),
'nbr_courses' => $session->getNbrCourses(),
'nbr_users' => $session->getNbrUsers(),
'nbr_classes' => $session->getNbrClasses(),
'visibility' => $session->getVisibility(),
'promotion_id' => $session->getPromotion() ? $session->getPromotion()->getId() : 0,
'display_start_date' => $session->getDisplayStartDate()?->format('Y-m-d H:i:s'),
'display_end_date' => $session->getDisplayEndDate()?->format('Y-m-d H:i:s'),
'access_start_date' => $session->getAccessStartDate()?->format('Y-m-d H:i:s'),
'access_end_date' => $session->getAccessEndDate()?->format('Y-m-d H:i:s'),
'coach_access_start_date' => $session->getCoachAccessStartDate()?->format('Y-m-d H:i:s'),
'coach_access_end_date' => $session->getCoachAccessEndDate()?->format('Y-m-d H:i:s'),
'send_subscription_notification' => $session->getSendSubscriptionNotification(),
'status' => $session->getStatus(),
'status_label' => self::getStatusLabel($session->getStatus()),
];
// Converted to local values
$variables = [
'display_start_date',
'display_end_date',
'access_start_date',
'access_end_date',
'coach_access_start_date',
'coach_access_end_date',
];
foreach ($variables as $value) {
$result[$value.'_to_local_time'] = null;
if (!empty($result[$value])) {
$result[$value.'_to_local_time'] = api_get_local_time($result[$value]);
}
}
return $result;
}
/**
* Create a session.
*
* @author Carlos Vargas <carlos.vargas@beeznest.com>, from existing code
*
* @param string $name
* @param string $startDate (YYYY-MM-DD hh:mm:ss)
* @param string $endDate (YYYY-MM-DD hh:mm:ss)
* @param string $displayStartDate (YYYY-MM-DD hh:mm:ss)
* @param string $displayEndDate (YYYY-MM-DD hh:mm:ss)
* @param string $coachStartDate (YYYY-MM-DD hh:mm:ss)
* @param string $coachEndDate (YYYY-MM-DD hh:mm:ss)
* @param array $coachesId If int, this is the session coach id,
* if string, the coach ID will be looked for from the user table
* @param int $sessionCategoryId ID of the session category in which this session is registered
* @param int $visibility Visibility after end date (0 = read-only, 1 = invisible, 2 = accessible)
* @param bool $fixSessionNameIfExists
* @param string $duration
* @param string $description Optional. The session description
* @param int $showDescription Optional. Whether show the session description
* @param array $extraFields
* @param int $sessionAdminId Optional. If this sessions was created by a session admin, assign it to him
* @param bool $sendSubscriptionNotification Optional.
* Whether send a mail notification to users being subscribed
* @param int $accessUrlId Optional.
* @param int $status
*
* @return mixed Session ID on success, error message otherwise
*
* @todo use an array to replace all this parameters or use the model.lib.php ...
*/
public static function create_session(
$name,
$startDate,
$endDate,
$displayStartDate,
$displayEndDate,
$coachStartDate,
$coachEndDate,
array $coachesId,
$sessionCategoryId,
$visibility = 1,
$fixSessionNameIfExists = false,
$duration = null,
$description = null,
$showDescription = 0,
$extraFields = [],
$sessionAdminId = 0,
$sendSubscriptionNotification = false,
$accessUrlId = 0,
$status = 0
) {
global $_configuration;
// Check portal limits
$accessUrlId = api_is_multiple_url_enabled()
? (empty($accessUrlId) ? api_get_current_access_url_id() : (int) $accessUrlId)
: 1;
if (isset($_configuration[$accessUrlId]) &&
is_array($_configuration[$accessUrlId]) &&
isset($_configuration[$accessUrlId]['hosting_limit_sessions']) &&
$_configuration[$accessUrlId]['hosting_limit_sessions'] > 0
) {
$num = self::count_sessions();
if ($num >= $_configuration[$accessUrlId]['hosting_limit_sessions']) {
api_warn_hosting_contact('hosting_limit_sessions');
return get_lang('The number of sessions limit for this portal has been reached');
}
}
$name = Database::escape_string(trim($name));
$sessionCategoryId = (int) $sessionCategoryId;
$visibility = (int) $visibility;
$tbl_session = Database::get_main_table(TABLE_MAIN_SESSION);
$startDate = Database::escape_string($startDate);
$endDate = Database::escape_string($endDate);
if (empty($name)) {
$msg = get_lang('A title is required for the session');
return $msg;
} elseif (!empty($startDate) && !api_is_valid_date($startDate, 'Y-m-d H:i') &&
!api_is_valid_date($startDate, 'Y-m-d H:i:s')
) {
$msg = get_lang('Invalid start date was given.');
return $msg;
} elseif (!empty($endDate) && !api_is_valid_date($endDate, 'Y-m-d H:i') &&
!api_is_valid_date($endDate, 'Y-m-d H:i:s')
) {
$msg = get_lang('Invalid end date was given.');
return $msg;
} elseif (!empty($startDate) && !empty($endDate) && $startDate >= $endDate) {
$msg = get_lang('The first date should be before the end date');
return $msg;
} else {
$ready_to_create = false;
if ($fixSessionNameIfExists) {
$name = self::generateNextSessionName($name);
if ($name) {
$ready_to_create = true;
} else {
$msg = get_lang('Session title already exists');
return $msg;
}
} else {
$rs = Database::query("SELECT 1 FROM $tbl_session WHERE title='".$name."'");
if (Database::num_rows($rs)) {
$msg = get_lang('Session title already exists');
return $msg;
}
$ready_to_create = true;
}
if ($ready_to_create) {
$sessionAdminId = !empty($sessionAdminId) ? $sessionAdminId : api_get_user_id();
$session = new Session();
$session
->setTitle($name)
->addSessionAdmin(api_get_user_entity($sessionAdminId))
->setVisibility($visibility)
->setDescription($description)
->setShowDescription(1 === $showDescription)
->setSendSubscriptionNotification((bool) $sendSubscriptionNotification)
;
foreach ($coachesId as $coachId) {
$session->addGeneralCoach(api_get_user_entity($coachId));
}
$startDate = $startDate ? api_get_utc_datetime($startDate, true, true) : null;
$endDate = $endDate ? api_get_utc_datetime($endDate, true, true) : null;
$displayStartDate = $displayStartDate ? api_get_utc_datetime($displayStartDate, true, true) : null;
$displayEndDate = $displayEndDate ? api_get_utc_datetime($displayEndDate, true, true) : null;
$coachStartDate = $coachStartDate ? api_get_utc_datetime($coachStartDate, true, true) : null;
$coachEndDate = $coachEndDate ? api_get_utc_datetime($coachEndDate, true, true) : null;
$session->setAccessStartDate($startDate);
$session->setAccessEndDate($endDate);
$session->setDisplayStartDate($displayStartDate);
$session->setDisplayEndDate($displayEndDate);
$session->setCoachAccessStartDate($coachStartDate);
$session->setCoachAccessEndDate($coachEndDate);
if (!empty($sessionCategoryId)) {
//$session->setCategory($category);
//$values['session_category_id'] = $sessionCategoryId;
}
if ('true' === api_get_setting('session.allow_session_status')) {
$session->setStatus($status);
}
$em = Database::getManager();
$em->persist($session);
$em->flush();
$session_id = $session->getId();
$duration = (int) $duration;
if (!empty($duration)) {
$sql = "UPDATE $tbl_session SET
access_start_date = NULL,
access_end_date = NULL,
display_start_date = NULL,
display_end_date = NULL,
coach_access_start_date = NULL,
coach_access_end_date = NULL,
duration = $duration
WHERE id = $session_id";
Database::query($sql);
} else {
$sql = "UPDATE $tbl_session
SET duration = 0
WHERE id = $session_id";
Database::query($sql);
}
if (!empty($session_id)) {
$extraFields['item_id'] = $session_id;
$sessionFieldValue = new ExtraFieldValue('session');
$sessionFieldValue->saveFieldValues($extraFields);
/*
Sends a message to the user_id = 1
$user_info = api_get_user_info(1);
$complete_name = $user_info['firstname'].' '.$user_info['lastname'];
$subject = api_get_setting('siteName').' - '.get_lang('A new session has been created');
$message = get_lang('A new session has been created')." <br /> ".get_lang('Session name').' : '.$name;
api_mail_html($complete_name, $user_info['email'], $subject, $message);
*
*/
// Adding to the correct URL
//UrlManager::add_session_to_url($session_id, $accessUrlId);
// add event to system log
$user_id = api_get_user_id();
Event::addEvent(
LOG_SESSION_CREATE,
LOG_SESSION_ID,
$session_id,
api_get_utc_datetime(),
$user_id
);
}
return $session_id;
}
}
}
/**
* @param string $name
*
* @return bool
*/
public static function sessionNameExists($name)
{
$name = Database::escape_string($name);
$sql = "SELECT COUNT(*) as count FROM ".Database::get_main_table(TABLE_MAIN_SESSION)."
WHERE title = '$name'";
$result = Database::fetch_array(Database::query($sql));
return $result['count'] > 0;
}
/**
* @param string $where_condition
*
* @return mixed
*/
public static function get_count_admin($where_condition = '')
{
$tbl_session = Database::get_main_table(TABLE_MAIN_SESSION);
$tbl_session_category = Database::get_main_table(TABLE_MAIN_SESSION_CATEGORY);
$tbl_user = Database::get_main_table(TABLE_MAIN_USER);
$table_access_url_rel_session = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_SESSION);
$tbl_session_rel_user = Database::get_main_table(TABLE_MAIN_SESSION_USER);
$where = 'WHERE 1=1 ';
$user_id = api_get_user_id();
$extraJoin = '';
if (api_is_session_admin() &&
'false' == api_get_setting('allow_session_admins_to_manage_all_sessions')
) {
$where .= " AND (
sru.user_id = '$user_id' AND
sru.relation_type IN ('".Session::DRH.", ".Session::SESSION_ADMIN."')
)
";
$extraJoin = " INNER JOIN $tbl_session_rel_user sru
ON sru.session_id = s.id ";
}
$today = api_get_utc_datetime();
$today = api_strtotime($today, 'UTC');
$today = date('Y-m-d', $today);
if (!empty($where_condition)) {
$where_condition = str_replace("( session_active = ':' )", '1=1', $where_condition);
$where_condition = str_replace('category_name', 'sc.title', $where_condition);
$where_condition = str_replace(
["AND session_active = '1' )", " AND ( session_active = '1' )"],
[') GROUP BY s.title HAVING session_active = 1 ', " GROUP BY s.title HAVING session_active = 1 "],
$where_condition
);
$where_condition = str_replace(
["AND session_active = '0' )", " AND ( session_active = '0' )"],
[') GROUP BY s.title HAVING session_active = 0 ', " GROUP BY s.title HAVING session_active = '0' "],
$where_condition
);
} else {
$where_condition = " AND 1 = 1";
}
$courseCondition = null;
if (strpos($where_condition, 'c.id')) {
$table = Database::get_main_table(TABLE_MAIN_SESSION_COURSE);
$tableCourse = Database::get_main_table(TABLE_MAIN_COURSE);
$courseCondition = " INNER JOIN $table course_rel_session
ON (s.id = course_rel_session.session_id)
INNER JOIN $tableCourse c
ON (course_rel_session.c_id = c.id)
";
}
$sql = "SELECT COUNT(id) as total_rows FROM (
SELECT DISTINCT
IF (
(s.access_start_date <= '$today' AND '$today' <= s.access_end_date) OR
(s.access_start_date IS NULL AND s.access_end_date IS NULL ) OR
(s.access_start_date <= '$today' AND s.access_end_date IS NULL) OR
('$today' <= s.access_end_date AND s.access_start_date IS NULL)
, 1, 0) as session_active,
s.id
FROM $tbl_session s
LEFT JOIN $tbl_session_category sc
ON s.session_category_id = sc.id
INNER JOIN $tbl_user u
ON s.id_coach = u.id
$courseCondition
$extraJoin
$where $where_condition ) as session_table";
if (api_is_multiple_url_enabled()) {
$access_url_id = api_get_current_access_url_id();
if (-1 != $access_url_id) {
$where .= " AND ar.access_url_id = $access_url_id ";
$sql = "SELECT count(id) as total_rows FROM (
SELECT DISTINCT
IF (
(s.access_start_date <= '$today' AND '$today' <= s.access_end_date) OR
(s.access_start_date IS NULL AND s.access_end_date IS NULL) OR
(s.access_start_date <= '$today' AND s.access_end_date IS NULL) OR
('$today' <= s.access_end_date AND s.access_start_date IS NULL)
, 1, 0)
as session_active,
s.id
FROM $tbl_session s
LEFT JOIN $tbl_session_category sc
ON s.session_category_id = sc.id
INNER JOIN $tbl_user u ON s.id_coach = u.id
INNER JOIN $table_access_url_rel_session ar
ON ar.session_id = s.id
$courseCondition
$extraJoin
$where $where_condition) as session_table";
}
}
$result_rows = Database::query($sql);
$row = Database::fetch_array($result_rows);
$num = $row['total_rows'];
return $num;
}
/**
* Get session list for a session admin or platform admin.
*
* @param int $userId User Id for the session admin.
* @param array $options Order and limit keys.
* @param bool $getCount Whether to get all the results or only the count.
* @param array $columns Columns from jqGrid.
* @param string $listType
* @param array $extraFieldsToLoad
* @param bool $formatted
*
* @return array
*/
public static function getSessionsForAdmin(
$userId,
$options = [],
$getCount = false,
$columns = [],
$listType = 'all',
$extraFieldsToLoad = [],
$formatted = false,
$language = ''
) {
$tblSession = Database::get_main_table(TABLE_MAIN_SESSION);
$sessionCategoryTable = Database::get_main_table(TABLE_MAIN_SESSION_CATEGORY);
$tblSessionRelUser = Database::get_main_table(TABLE_MAIN_SESSION_USER);
$where = 'WHERE 1 = 1 ';
$userId = (int) $userId;
$extraFieldModel = new ExtraFieldModel('session');
$conditions = $extraFieldModel->parseConditions($options);
$sqlInjectJoins = $conditions['inject_joins'];
$where .= $conditions['where'];
$sqlInjectWhere = $conditions['inject_where'];
$injectExtraFields = $conditions['inject_extra_fields'];
$order = empty($conditions['order']) ? ' ORDER BY s.title ASC' : $conditions['order'];
$limit = $conditions['limit'];
$isMakingOrder = false;
$showCountUsers = false;
if (true === $getCount) {
$select = ' SELECT count(DISTINCT s.id) as total_rows ';
} else {
if (!empty($columns['column_model'])) {
foreach ($columns['column_model'] as $column) {
if ('users' == $column['name']) {
$showCountUsers = true;
break;
}
}
}
$select =
"SELECT DISTINCT
s.title,
s.display_start_date,
s.display_end_date,
access_start_date,
access_end_date,
s.visibility,
s.session_category_id,
s.id
";
// ofaj fix
if (!empty($extraFieldsToLoad)) {
$select = "SELECT DISTINCT s.* ";
}
if ('true' === api_get_setting('session.allow_session_status')) {
$select .= ', status';
}
if (isset($options['order'])) {
$isMakingOrder = 0 === strpos($options['order'], 'category_name');
}
}
$isFilteringSessionCategory = false !== strpos($where, 'category_name');
$isFilteringSessionCategoryWithName = false !== strpos($where, 'sc.title');
if ($isMakingOrder || $isFilteringSessionCategory || $isFilteringSessionCategoryWithName) {
$sqlInjectJoins .= " LEFT JOIN $sessionCategoryTable sc ON s.session_category_id = sc.id ";
if ($isFilteringSessionCategory) {
$where = str_replace('category_name', 'sc.title', $where);
}
if ($isMakingOrder) {
$order = str_replace('category_name', 'sc.title', $order);
}
}
if (!empty($language)) {
$table = Database::get_main_table(TABLE_MAIN_SESSION_COURSE);
$tableCourse = Database::get_main_table(TABLE_MAIN_COURSE);
$sqlInjectJoins .= " INNER JOIN $table sc ON (sc.session_id = s.id)
INNER JOIN $tableCourse c ON (sc.c_id = c.id)";
$language = Database::escape_string($language);
// Get the isoCode to filter course_language
$isoCode = '';
$languageId = api_get_language_id($language);
if (!empty($languageId)) {
$languageInfo = api_get_language_info($languageId);
$isoCode = $languageInfo['isocode'];
}
if ('true' === api_get_setting('language.allow_course_multiple_languages')) {
$tblExtraField = Database::get_main_table(TABLE_EXTRA_FIELD);
$tblExtraFieldValue = Database::get_main_table(TABLE_EXTRA_FIELD_VALUES);
$extraFieldType = ExtraField::COURSE_FIELD_TYPE;
$sql = "SELECT id FROM $tblExtraField WHERE item_type = $extraFieldType AND variable = 'multiple_language'";
$rs = Database::query($sql);
if (Database::num_rows($rs) > 0) {
$fieldId = Database::result($rs, 0, 0);
$sqlInjectJoins .= " LEFT JOIN $tblExtraFieldValue cfv ON (c.id = cfv.item_id AND cfv.field_id = $fieldId)";
$where .= " AND (c.course_language = '$isoCode' OR cfv.field_value LIKE '%$language%')";
} else {
$where .= " AND c.course_language = '$isoCode' ";
}
} else {
$where .= " AND c.course_language = '$isoCode' ";
}
}
$allowSessionAdminsToManageAllSessions = !api_is_platform_admin()
&& api_is_session_admin()
&& 'false' === api_get_setting('allow_session_admins_to_manage_all_sessions');
$allowTeachersToCreateSessions = !api_is_platform_admin()
&& api_is_teacher()
&& 'true' === api_get_setting('allow_teachers_to_create_sessions');
if ($allowSessionAdminsToManageAllSessions || $allowTeachersToCreateSessions) {
$sqlInjectJoins .= " INNER JOIN $tblSessionRelUser sru ON sru.session_id = s.id ";
$relationTypeList = [];
if ($allowSessionAdminsToManageAllSessions) {
$relationTypeList[] = Session::SESSION_ADMIN;
}
if ($allowTeachersToCreateSessions) {
$relationTypeList[] = Session::GENERAL_COACH;
}
$where .= " AND (sru.user_id = $userId AND sru.relation_type IN(".implode(',', $relationTypeList)."))";
}
$query = "$select";
if (!empty($injectExtraFields)) {
$injectExtraFields = rtrim(trim($injectExtraFields), ',');
$query .= ", $injectExtraFields";
}
$query .= " FROM $tblSession s $sqlInjectJoins $where $sqlInjectWhere";
if (api_is_multiple_url_enabled()) {
$tblAccessUrlRelSession = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_SESSION);
$accessUrlId = api_get_current_access_url_id();
if (-1 != $accessUrlId) {
$where .= " AND ar.access_url_id = $accessUrlId ";
$query = "$select
FROM $tblSession s $sqlInjectJoins
INNER JOIN $tblAccessUrlRelSession ar
ON (ar.session_id = s.id) $where";
}
}
$date = api_get_utc_datetime();
switch ($listType) {
case 'all':
break;
case 'active':
$query .= "AND (
(s.access_end_date IS NULL)
OR
(
s.access_start_date IS NOT NULL AND
s.access_end_date IS NOT NULL AND
s.access_start_date <= '$date' AND s.access_end_date >= '$date')
OR
(
s.access_start_date IS NULL AND
s.access_end_date IS NOT NULL AND
s.access_end_date >= '$date'
)
)";
break;
case 'close':
$query .= "AND (
(
s.access_start_date IS NOT NULL AND
s.access_end_date IS NOT NULL AND
s.access_start_date <= '$date' AND s.access_end_date <= '$date')
OR
(
s.access_start_date IS NULL AND
s.access_end_date IS NOT NULL AND
s.access_end_date <= '$date'
)
)";
break;
}
$query .= $order;
$query .= $limit;
if (!$formatted) {
$result = Database::query($query);
$sessions = Database::store_result($result, 'ASSOC');
if ($showCountUsers && !$getCount) {
foreach ($sessions as &$session) {
$result = Database::query("SELECT COUNT(session_id) AS nbr
FROM session_rel_user WHERE session_id = {$session['id']} AND relation_type = ".Session::STUDENT);
$session['users'] = Database::fetch_assoc($result)['nbr'];
}
}
if ('all' === $listType) {
if ($getCount) {
return $sessions[0]['total_rows'];
}
return $sessions;
}
return $sessions;
}
// For search diagnosis format (Ofaj)
$categories = self::get_all_session_category();
$orderedCategories = [];
if (!empty($categories)) {
foreach ($categories as $category) {
$orderedCategories[$category['id']] = $category['title'];
}
}
$result = Database::query($query);
$formattedSessions = [];
if (Database::num_rows($result)) {
$sessions = Database::store_result($result, 'ASSOC');
if ($getCount) {
return $sessions[0]['total_rows'];
}
$activeIcon = Display::getMdiIcon(StateIcon::ACTIVE, 'ch-tool-icon', null, ICON_SIZE_SMALL, get_lang('Active'));
$inactiveIcon = Display::getMdiIcon(StateIcon::INACTIVE, 'ch-tool-icon', null, ICON_SIZE_SMALL, get_lang('Inactive'));
foreach ($sessions as $session) {
$session_id = $session['id'];
if ($showCountUsers) {
$session['users'] = self::get_users_by_session(
$session['id'],
0,
true
);
$usersLang = self::getCountUsersLangBySession($session['id']);
$tooltipUserLangs = '';
if (!empty($usersLang)) {
$tooltipUserLangs = implode(' | ', $usersLang);
}
$session['users'] = '<a href="#" title="'.$tooltipUserLangs.'">'.$session['users'].'</a>';
$courses = self::getCoursesInSession($session_id);
$teachers = '';
foreach ($courses as $courseId) {
$courseInfo = api_get_course_info_by_id($courseId);
// Ofaj
$teachers = CourseManager::get_coachs_from_course_to_string($session_id, $courseInfo['real_id']);
}
// ofaj
$session['teachers'] = '';
if (!empty($teachers)) {
$session['teachers'] = Display::getMdiIcon(ObjectIcon::TEACHER, 'ch-tool-icon', null, ICON_SIZE_SMALL, addslashes($teachers));
}
}
$url = api_get_path(WEB_CODE_PATH).'session/resume_session.php?id_session='.$session['id'];
if (api_is_drh()) {
$url = api_get_path(WEB_CODE_PATH).'session/about.php?session_id='.$session['id'];
}
if (api_is_platform_admin()) {
$url = api_get_path(WEB_CODE_PATH).'session/resume_session.php?id_session='.$session['id'];
}
if ($extraFieldsToLoad) {
$url = api_get_path(WEB_CODE_PATH).'session/about.php?session_id='.$session['id'];
}
$session['title'] = Display::url($session['name'], $url);
if (isset($session['session_active']) && $session['session_active'] == 1) {
$session['session_active'] = $activeIcon;
} else {
$session['session_active'] = $inactiveIcon;
}
$session = self::convert_dates_to_local($session, true);
switch ($session['visibility']) {
case SESSION_VISIBLE_READ_ONLY: //1
$session['visibility'] = get_lang('ReadOnly');
break;
case SESSION_VISIBLE: //2
case SESSION_AVAILABLE: //4
$session['visibility'] = get_lang('Visible');
break;
case SESSION_INVISIBLE: //3
$session['visibility'] = api_ucfirst(get_lang('Invisible'));
break;
}
if (!empty($extraFieldsToLoad)) {
foreach ($extraFieldsToLoad as $field) {
$extraFieldValue = new ExtraFieldValue('session');
$fieldData = $extraFieldValue->getAllValuesByItemAndField(
$session['id'],
$field['id']
);
$fieldDataArray = [];
$fieldDataToString = '';
if (!empty($fieldData)) {
foreach ($fieldData as $data) {
$fieldDataArray[] = $data['field_value'];
}
$fieldDataToString = implode(', ', $fieldDataArray);
}
$session[$field['variable']] = $fieldDataToString;
}
}
$categoryName = $orderedCategories[$session['session_category_id']] ?? '';
$session['category_name'] = $categoryName;
if (isset($session['status'])) {
$session['status'] = self::getStatusLabel($session['status']);
}
$formattedSessions[] = $session;
}
}
return $formattedSessions;
}
/**
* Get the count of users by language and session
*
* @param $sid
* @param int $urlId
* @param null $status
*
* @return array A list of ISO lang of users registered in the session , ex: FR 6
*/
public static function getCountUsersLangBySession(
$sid,
$urlId = 0,
$status = null
): array
{
$sid = (int) $sid;
$urlId = empty($urlId) ? api_get_current_access_url_id() : (int) $urlId;
$tblUser = Database::get_main_table(TABLE_MAIN_USER);
$tblSessionUser = Database::get_main_table(TABLE_MAIN_SESSION_USER);
$tableAccessUrlUser = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_USER);
$tableLanguage = Database::get_main_table(TABLE_MAIN_LANGUAGE);
$sql = "SELECT l.isocode, count(u.id) as cLang
FROM $tblSessionUser su
INNER JOIN $tblUser u ON (u.id = su.user_id)
INNER JOIN $tableLanguage l ON (l.english_name = u.language)
LEFT OUTER JOIN $tableAccessUrlUser au ON (au.user_id = u.id)
";
if (is_numeric($status)) {
$status = (int) $status;
$sql .= " WHERE su.relation_type = $status AND (au.access_url_id = $urlId OR au.access_url_id is null)";
} else {
$sql .= " WHERE (au.access_url_id = $urlId OR au.access_url_id is null )";
}
$sql .= " AND su.session_id = $sid GROUP BY l.isocode";
$rs = Database::query($sql);
$usersLang = [];
if (Database::num_rows($rs) > 0) {
while ($row = Database::fetch_assoc($rs)) {
$usersLang[] = strtoupper($row['isocode'])." ".$row['cLang'];
}
}
return $usersLang;
}
/**
* Gets the admin session list callback of the session/session_list.php page.
*
* @param array $options order and limit keys
* @param bool $getCount Whether to get all the results or only the count
* @param array $columns
* @param array $extraFieldsToLoad
* @param string $listType
*
* @return mixed Integer for number of rows, or array of results
* @assert ([],true) !== false
*/
public static function formatSessionsAdminForGrid(
$options = [],
$getCount = false,
$columns = [],
$extraFieldsToLoad = [],
$listType = 'all'
) {
$showCountUsers = false;
if (!$getCount && !empty($columns['column_model'])) {
foreach ($columns['column_model'] as $column) {
if ('users' === $column['name']) {
$showCountUsers = true;
}
}
}
$userId = api_get_user_id();
$sessions = self::getSessionsForAdmin($userId, $options, $getCount, $columns, $listType, $extraFieldsToLoad);
if ($getCount) {
return (int) $sessions;
}
$formattedSessions = [];
$categories = self::get_all_session_category();
$orderedCategories = [];
if (!empty($categories)) {
foreach ($categories as $category) {
$orderedCategories[$category['id']] = $category['title'];
}
}
$activeIcon = Display::getMdiIcon(StateIcon::ACTIVE, 'ch-tool-icon', null, ICON_SIZE_SMALL, get_lang('active'));
$inactiveIcon = Display::getMdiIcon(StateIcon::INACTIVE, 'ch-tool-icon', null, ICON_SIZE_SMALL, get_lang('inactive'));
foreach ($sessions as $session) {
if ($showCountUsers) {
$session['users'] = self::get_users_by_session($session['id'], 0, true);
}
$url = api_get_path(WEB_CODE_PATH).'session/resume_session.php?id_session='.$session['id'];
if ($extraFieldsToLoad || api_is_drh()) {
$url = api_get_path(WEB_PATH).'sessions/'.$session['id'].'/about/';
}
$session['title'] = Display::url($session['title'], $url);
if (!empty($extraFieldsToLoad)) {
foreach ($extraFieldsToLoad as $field) {
$extraFieldValue = new ExtraFieldValue('session');
$fieldData = $extraFieldValue->getAllValuesByItemAndField(
$session['id'],
$field['id']
);
$fieldDataArray = [];
$fieldDataToString = '';
if (!empty($fieldData)) {
foreach ($fieldData as $data) {
$fieldDataArray[] = $data['field_value'];
}
$fieldDataToString = implode(', ', $fieldDataArray);
}
$session[$field['variable']] = $fieldDataToString;
}
}
if (isset($session['session_active']) && 1 == $session['session_active']) {
$session['session_active'] = $activeIcon;
} else {
$session['session_active'] = $inactiveIcon;
}
$session = self::convert_dates_to_local($session, true);
switch ($session['visibility']) {
case SESSION_VISIBLE_READ_ONLY: //1
$session['visibility'] = get_lang('Read only');
break;
case SESSION_VISIBLE: //2
case SESSION_AVAILABLE: //4
$session['visibility'] = get_lang('Visible');
break;
case SESSION_INVISIBLE: //3
$session['visibility'] = api_ucfirst(get_lang('invisible'));
break;
}
// Cleaning double selects.
foreach ($session as $key => &$value) {
/*if (isset($optionsByDouble[$key]) || isset($optionsByDouble[$key.'_second'])) {
$options = explode('::', $value);
}*/
$original_key = $key;
if (false !== strpos($key, '_second')) {
$key = str_replace('_second', '', $key);
}
/*if (isset($optionsByDouble[$key]) &&
isset($options[0]) &&
isset($optionsByDouble[$key][$options[0]])
) {
if (false === strpos($original_key, '_second')) {
$value = $optionsByDouble[$key][$options[0]]['option_display_text'];
} else {
$value = $optionsByDouble[$key][$options[1]]['option_display_text'];
}
}*/
}
$categoryName = isset($orderedCategories[$session['session_category_id']]) ? $orderedCategories[$session['session_category_id']] : '';
$session['category_name'] = $categoryName;
if (isset($session['status'])) {
$session['status'] = self::getStatusLabel($session['status']);
}
$formattedSessions[] = $session;
}
return $formattedSessions;
}
/**
* Gets the progress of learning paths in the given session.
*
* @param int $sessionId
* @param int $courseId
* @param string $date_from
* @param string $date_to
* @param array options order and limit keys
*
* @return array table with user name, lp name, progress
*/
public static function get_session_lp_progress(
$sessionId,
$courseId,
$date_from,
$date_to,
$options
) {
//escaping vars
$sessionId = $sessionId === 'T' ? 'T' : intval($sessionId);
$courseId = intval($courseId);
//tables
$session_course_user = Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER);
$user = Database::get_main_table(TABLE_MAIN_USER);
$tbl_course_lp_view = Database::get_course_table(TABLE_LP_VIEW);
$course = api_get_course_info_by_id($courseId);
$sessionCond = 'and session_id = %s';
if ($sessionId === 'T') {
$sessionCond = '';
}
$where = " WHERE c_id = '%s' AND s.status = ".Session::STUDENT." $sessionCond";
$limit = null;
if (!empty($options['limit'])) {
$limit = " LIMIT ".$options['limit'];
}
if (!empty($options['where'])) {
$where .= ' '.$options['where'];
}
$order = null;
if (!empty($options['order'])) {
$order = " ORDER BY ".$options['order']." ";
}
$sql = "SELECT u.id as user_id, u.lastname, u.firstname, u.username, u.email, s.c_id
FROM $session_course_user s
INNER JOIN $user u ON u.id = s.user_id
$where
$order
$limit";
$sql_query = sprintf($sql, Database::escape_string($course['real_id']), $sessionId);
$rs = Database::query($sql_query);
while ($user = Database::fetch_array($rs)) {
$users[$user['user_id']] = $user;
}
// Get lessons
$lessons = LearnpathList::get_course_lessons($course['code'], $sessionId);
$table = [];
foreach ($users as $user) {
$data = [
'lastname' => $user[1],
'firstname' => $user[2],
'username' => $user[3],
];
$sessionCond = 'AND v.session_id = %d';
if ($sessionId == 'T') {
$sessionCond = "";
}
//Get lessons progress by user
$sql = "SELECT v.lp_id as id, v.progress
FROM $tbl_course_lp_view v
WHERE v.c_id = %d
AND v.user_id = %d
$sessionCond";
$sql_query = sprintf(
$sql,
intval($courseId),
intval($user['user_id']),
$sessionId
);
$result = Database::query($sql_query);
$user_lessons = [];
while ($row = Database::fetch_array($result)) {
$user_lessons[$row['id']] = $row;
}
//Match course lessons with user progress
$progress = 0;
$count = 0;
foreach ($lessons as $lesson) {
$data[$lesson['id']] = (!empty($user_lessons[$lesson['id']]['progress'])) ? $user_lessons[$lesson['id']]['progress'] : 0;
$progress += $data[$lesson['id']];
$data[$lesson['id']] = $data[$lesson['id']].'%';
$count++;
}
if (0 == $count) {
$data['total'] = 0;
} else {
$data['total'] = round($progress / $count, 2).'%';
}
$table[] = $data;
}
return $table;
}
/**
* Gets the survey answers.
*
* @param int $sessionId
* @param int $courseId
* @param int $surveyId
* @param array options order and limit keys
*
* @todo fix the query
*
* @return array table with username, lp name, progress
*/
public static function get_survey_overview(
$sessionId,
$courseId,
$surveyId,
$date_from,
$date_to,
$options
) {
$sessionId = (int) $sessionId;
$courseId = (int) $courseId;
$surveyId = (int) $surveyId;
//tables
$session_course_user = Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER);
$user = Database::get_main_table(TABLE_MAIN_USER);
$c_survey = Database::get_course_table(TABLE_SURVEY);
$c_survey_answer = Database::get_course_table(TABLE_SURVEY_ANSWER);
$c_survey_question = Database::get_course_table(TABLE_SURVEY_QUESTION);
$c_survey_question_option = Database::get_course_table(TABLE_SURVEY_QUESTION_OPTION);
$course = api_get_course_info_by_id($courseId);
$where = " WHERE c_id = '%s' AND s.status = ".Session::STUDENT." AND session_id = %s";
$limit = null;
if (!empty($options['limit'])) {
$limit = " LIMIT ".$options['limit'];
}
if (!empty($options['where'])) {
$where .= ' '.$options['where'];
}
$order = null;
if (!empty($options['order'])) {
$order = " ORDER BY ".$options['order'];
}
$sql = "SELECT u.id as user_id, u.lastname, u.firstname, u.username, u.email, s.c_id
FROM $session_course_user s
INNER JOIN $user u ON u.id = s.user_id
$where $order $limit";
$sql_query = sprintf($sql, intval($course['real_id']), $sessionId);
$rs = Database::query($sql_query);
while ($user = Database::fetch_array($rs)) {
$users[$user['user_id']] = $user;
}
$repo = Container::getSurveyRepository();
/** @var CSurvey $survey */
$survey = $repo->find($surveyId);
$questions = $survey->getQuestions();
$anonymous = (1 == $survey->getAnonymous()) ? true : false;
$table = [];
foreach ($users as $user) {
$data = [
'lastname' => ($anonymous ? '***' : $user[1]),
'firstname' => ($anonymous ? '***' : $user[2]),
'username' => ($anonymous ? '***' : $user[3]),
];
//Get questions by user
$sql = "SELECT sa.question_id, sa.option_id, sqo.option_text, sq.type
FROM $c_survey_answer sa
INNER JOIN $c_survey_question sq
ON sq.question_id = sa.question_id
LEFT JOIN $c_survey_question_option sqo
ON
sqo.c_id = sa.c_id AND
sqo.question_id = sq.question_id AND
sqo.iid = sa.option_id AND
sqo.survey_id = sq.survey_id
WHERE
sa.survey_id = %d AND
sa.c_id = %d AND
sa.user = %d
"; //. $where_survey;
$sql_query = sprintf($sql, $surveyId, $courseId, $user['user_id']);
$result = Database::query($sql_query);
$user_questions = [];
while ($row = Database::fetch_array($result)) {
$user_questions[$row['question_id']] = $row;
}
//Match course lessons with user progress
foreach ($questions as $question) {
$questionId = $question->getIid();
$option_text = 'option_text';
if ('open' === $user_questions[$questionId]['type']) {
$option_text = 'option_id';
}
$data[$questionId] = $user_questions[$questionId][$option_text];
}
$table[] = $data;
}
return $table;
}
/**
* Gets the progress of the given session.
*
* @param int $sessionId
* @param int $courseId
* @param array options order and limit keys
*
* @return array table with username, lp name, progress
*/
public static function get_session_progress(
$sessionId,
$courseId,
$date_from,
$date_to,
$options
) {
$sessionId = (int) $sessionId;
$getAllSessions = false;
if (empty($sessionId)) {
$sessionId = 0;
$getAllSessions = true;
}
//tables
$session_course_user = Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER);
$user = Database::get_main_table(TABLE_MAIN_USER);
$workTable = Database::get_course_table(TABLE_STUDENT_PUBLICATION);
$workTableAssignment = Database::get_course_table(TABLE_STUDENT_PUBLICATION_ASSIGNMENT);
$tbl_course_lp = Database::get_course_table(TABLE_LP_MAIN);
$wiki = Database::get_course_table(TABLE_WIKI);
$table_stats_default = Database::get_main_table(TABLE_STATISTIC_TRACK_E_DEFAULT);
$table_stats_access = Database::get_main_table(TABLE_STATISTIC_TRACK_E_ACCESS);
$course = api_get_course_info_by_id($courseId);
$where = " WHERE c_id = '%s' AND s.status = ".Session::STUDENT;
$limit = null;
if (!empty($options['limit'])) {
$limit = " LIMIT ".$options['limit'];
}
if (!empty($options['where'])) {
$where .= ' '.$options['where'];
}
$order = null;
if (!empty($options['order'])) {
$order = " ORDER BY ".$options['order'];
}
//TODO, fix create report without session
$queryVariables = [$course['real_id']];
if (!empty($sessionId)) {
$where .= ' AND session_id = %s';
$queryVariables[] = $sessionId;
$sql = "SELECT
u.id as user_id, u.lastname, u.firstname, u.username,
u.email, s.c_id, s.session_id
FROM $session_course_user s
INNER JOIN $user u
ON u.id = s.user_id
$where $order $limit";
} else {
$sql = "SELECT
u.id as user_id, u.lastname, u.firstname, u.username,
u.email, s.c_id, s.session_id
FROM $session_course_user s
INNER JOIN $user u ON u.id = s.user_id
$where $order $limit";
}
$sql_query = vsprintf($sql, $queryVariables);
$rs = Database::query($sql_query);
while ($user = Database::fetch_array($rs)) {
$users[$user['user_id']] = $user;
}
/**
* Lessons.
*/
$sql = "SELECT * FROM $tbl_course_lp WHERE c_id = %s "; //AND session_id = %s
$sql_query = sprintf($sql, $course['real_id']);
$result = Database::query($sql_query);
$arrLesson = [[]];
while ($row = Database::fetch_array($result)) {
if (empty($arrLesson[$row['session_id']]['lessons_total'])) {
$arrLesson[$row['session_id']]['lessons_total'] = 1;
} else {
$arrLesson[$row['session_id']]['lessons_total']++;
}
}
$session = api_get_session_entity($sessionId);
$qb = Container::getQuizRepository()->findAllByCourse($course, $session, null, 2);
$exercises = $qb->getQuery()->getResult();
$exercises_total = count($exercises);
/*$exercises = ExerciseLib::get_all_exercises(
$course,
$sessionId,
false,
'',
$getAllSessions
);
$exercises_total = count($exercises);*/
/**
* Assignments.
*/
//total
$params = [$course['real_id']];
if ($getAllSessions) {
$sql = "SELECT count(w.id) as count
FROM $workTable w
LEFT JOIN $workTableAssignment a
ON (a.publication_id = w.id AND a.c_id = w.c_id)
WHERE
w.c_id = %s AND
parent_id = 0 AND
active IN (1, 0)";
} else {
$sql = "SELECT count(w.id) as count
FROM $workTable w
LEFT JOIN $workTableAssignment a
ON (a.publication_id = w.id AND a.c_id = w.c_id)
WHERE
w.c_id = %s AND
parent_id = 0 AND
active IN (1, 0)";
if (empty($sessionId)) {
$sql .= ' AND w.session_id = NULL ';
} else {
$sql .= ' AND w.session_id = %s ';
$params[] = $sessionId;
}
}
$sql_query = vsprintf($sql, $params);
$result = Database::query($sql_query);
$row = Database::fetch_array($result);
$assignments_total = $row['count'];
/**
* Wiki.
*/
if ($getAllSessions) {
$sql = "SELECT count(distinct page_id) as count FROM $wiki
WHERE c_id = %s";
} else {
$sql = "SELECT count(distinct page_id) as count FROM $wiki
WHERE c_id = %s and session_id = %s";
}
$sql_query = sprintf($sql, $course['real_id'], $sessionId);
$result = Database::query($sql_query);
$row = Database::fetch_array($result);
$wiki_total = $row['count'];
/**
* Surveys.
*/
$survey_user_list = [];
$survey_list = SurveyManager::get_surveys($course['code'], $sessionId);
$surveys_total = count($survey_list);
foreach ($survey_list as $survey) {
$user_list = SurveyManager::get_people_who_filled_survey(
$survey['survey_id'],
false,
$course['real_id']
);
foreach ($user_list as $user_id) {
isset($survey_user_list[$user_id]) ? $survey_user_list[$user_id]++ : $survey_user_list[$user_id] = 1;
}
}
/**
* Forums.
*/
$forums_total = CourseManager::getCountForum(
$course['real_id'],
$sessionId,
$getAllSessions
);
//process table info
foreach ($users as $user) {
//Course description
$sql = "SELECT count(*) as count
FROM $table_stats_access
WHERE access_tool = 'course_description'
AND c_id = '%s'
AND session_id = %s
AND access_user_id = %s ";
$sql_query = sprintf($sql, $course['real_id'], $user['id_session'], $user['user_id']);
$result = Database::query($sql_query);
$row = Database::fetch_array($result);
$course_description_progress = ($row['count'] > 0) ? 100 : 0;
if (!empty($arrLesson[$user['id_session']]['lessons_total'])) {
$lessons_total = $arrLesson[$user['id_session']]['lessons_total'];
} else {
$lessons_total = !empty($arrLesson[0]['lessons_total']) ? $arrLesson[0]['lessons_total'] : 0;
}
//Lessons
//TODO: Lessons done and left is calculated by progress per item in lesson,
// maybe we should calculate it only per completed lesson?
$lessons_progress = Tracking::get_avg_student_progress(
$user['user_id'],
$course['code'],
[],
$user['id_session']
);
$lessons_done = ($lessons_progress * $lessons_total) / 100;
$lessons_left = $lessons_total - $lessons_done;
// Exercises
$exercises_progress = str_replace(
'%',
'',
Tracking::get_exercise_student_progress(
$exercises,
$user['user_id'],
$course['real_id'],
$user['id_session']
)
);
$exercises_done = round(($exercises_progress * $exercises_total) / 100);
$exercises_left = $exercises_total - $exercises_done;
//Assignments
$assignments_done = Container::getStudentPublicationRepository()->countUserPublications(
$user['user_id'],
$course['code'],
$user['id_session']
);
$assignments_left = $assignments_total - $assignments_done;
if (!empty($assignments_total)) {
$assignments_progress = round((($assignments_done * 100) / $assignments_total), 2);
} else {
$assignments_progress = 0;
}
// Wiki
// total revisions per user
$sql = "SELECT count(*) as count
FROM $wiki
WHERE c_id = %s and session_id = %s and user_id = %s";
$sql_query = sprintf($sql, $course['real_id'], $user['id_session'], $user['user_id']);
$result = Database::query($sql_query);
$row = Database::fetch_array($result);
$wiki_revisions = $row['count'];
//count visited wiki pages
$sql = "SELECT count(distinct default_value) as count
FROM $table_stats_default
WHERE
default_user_id = %s AND
default_event_type = 'wiki_page_view' AND
default_value_type = 'wiki_page_id' AND
c_id = %s
";
$sql_query = sprintf($sql, $user['user_id'], $course['real_id']);
$result = Database::query($sql_query);
$row = Database::fetch_array($result);
$wiki_read = $row['count'];
$wiki_unread = $wiki_total - $wiki_read;
if (!empty($wiki_total)) {
$wiki_progress = round((($wiki_read * 100) / $wiki_total), 2);
} else {
$wiki_progress = 0;
}
// Surveys
$surveys_done = isset($survey_user_list[$user['user_id']]) ? $survey_user_list[$user['user_id']] : 0;
$surveys_left = $surveys_total - $surveys_done;
if (!empty($surveys_total)) {
$surveys_progress = round((($surveys_done * 100) / $surveys_total), 2);
} else {
$surveys_progress = 0;
}
//Forums
$forums_done = CourseManager::getCountForumPerUser(
$user['user_id'],
$course['real_id'],
$user['id_session']
);
$forums_left = $forums_total - $forums_done;
if (!empty($forums_total)) {
$forums_progress = round((($forums_done * 100) / $forums_total), 2);
} else {
$forums_progress = 0;
}
// Overall Total
$overall_total = ($course_description_progress + $exercises_progress + $forums_progress + $assignments_progress + $wiki_progress + $surveys_progress) / 6;
$link = '<a href="'.api_get_path(WEB_CODE_PATH).'my_space/myStudents.php?student='.$user[0].'&details=true&course='.$course['code'].'&sid='.$sessionId.'"> %s </a>';
$linkForum = '<a href="'.api_get_path(WEB_CODE_PATH).'forum/index.php?cid='.$course['real_id'].'&sid='.$sessionId.'"> %s </a>';
$linkWork = '<a href="'.api_get_path(WEB_CODE_PATH).'work/work.php?cid='.$course['real_id'].'&sid='.$sessionId.'"> %s </a>';
$linkWiki = '<a href="'.api_get_path(WEB_CODE_PATH).'wiki/index.php?cid='.$course['real_id'].'&sid='.$sessionId.'&action=statistics"> %s </a>';
$linkSurvey = '<a href="'.api_get_path(WEB_CODE_PATH).'survey/survey_list.php?cid='.$course['real_id'].'&sid='.$sessionId.'"> %s </a>';
$table[] = [
'lastname' => $user[1],
'firstname' => $user[2],
'username' => $user[3],
//'profile' => '',
'total' => round($overall_total, 2).'%',
'courses' => sprintf($link, $course_description_progress.'%'),
'lessons' => sprintf($link, $lessons_progress.'%'),
'exercises' => sprintf($link, $exercises_progress.'%'),
'forums' => sprintf($link, $forums_progress.'%'),
'homeworks' => sprintf($link, $assignments_progress.'%'),
'wikis' => sprintf($link, $wiki_progress.'%'),
'surveys' => sprintf($link, $surveys_progress.'%'),
//course description
'course_description_progress' => $course_description_progress.'%',
//lessons
'lessons_total' => sprintf($link, $lessons_total),
'lessons_done' => sprintf($link, $lessons_done),
'lessons_left' => sprintf($link, $lessons_left),
'lessons_progress' => sprintf($link, $lessons_progress.'%'),
//exercises
'exercises_total' => sprintf($link, $exercises_total),
'exercises_done' => sprintf($link, $exercises_done),
'exercises_left' => sprintf($link, $exercises_left),
'exercises_progress' => sprintf($link, $exercises_progress.'%'),
//forums
'forums_total' => sprintf($linkForum, $forums_total),
'forums_done' => sprintf($linkForum, $forums_done),
'forums_left' => sprintf($linkForum, $forums_left),
'forums_progress' => sprintf($linkForum, $forums_progress.'%'),
//assignments
'assignments_total' => sprintf($linkWork, $assignments_total),
'assignments_done' => sprintf($linkWork, $assignments_done),
'assignments_left' => sprintf($linkWork, $assignments_left),
'assignments_progress' => sprintf($linkWork, $assignments_progress.'%'),
//wiki
'wiki_total' => sprintf($linkWiki, $wiki_total),
'wiki_revisions' => sprintf($linkWiki, $wiki_revisions),
'wiki_read' => sprintf($linkWiki, $wiki_read),
'wiki_unread' => sprintf($linkWiki, $wiki_unread),
'wiki_progress' => sprintf($linkWiki, $wiki_progress.'%'),
//survey
'surveys_total' => sprintf($linkSurvey, $surveys_total),
'surveys_done' => sprintf($linkSurvey, $surveys_done),
'surveys_left' => sprintf($linkSurvey, $surveys_left),
'surveys_progress' => sprintf($linkSurvey, $surveys_progress.'%'),
];
}
return $table;
}
/**
* Get the ip, total of clicks, login date and time logged in for all user, in one session.
*
* @todo track_e_course_access table should have ip so we dont have to look for it in track_e_login
*
* @author César Perales <cesar.perales@beeznest.com>, Beeznest Team
*
* @version 1.9.6
*/
public static function get_user_data_access_tracking_overview(
$sessionId,
$courseId,
$studentId = 0,
$profile = '',
$date_from = '',
$date_to = '',
$options = []
) {
$sessionId = intval($sessionId);
$courseId = intval($courseId);
$studentId = intval($studentId);
$profile = intval($profile);
$date_from = Database::escape_string($date_from);
$date_to = Database::escape_string($date_to);
// database table definition
$user = Database::get_main_table(TABLE_MAIN_USER);
$course = Database::get_main_table(TABLE_MAIN_COURSE);
$track_e_login = Database::get_main_table(TABLE_STATISTIC_TRACK_E_LOGIN);
$track_e_course_access = Database::get_main_table(TABLE_STATISTIC_TRACK_E_COURSE_ACCESS);
$sessionTable = Database::get_main_table(TABLE_MAIN_SESSION);
global $export_csv;
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();
}
$where = null;
if (isset($sessionId) && !empty($sessionId)) {
$where = sprintf(" WHERE a.session_id = %d", $sessionId);
}
if (isset($courseId) && !empty($courseId)) {
$where .= sprintf(" AND c.id = %d", $courseId);
}
if (isset($studentId) && !empty($studentId)) {
$where .= sprintf(" AND u.id = %d", $studentId);
}
if (isset($profile) && !empty($profile)) {
$where .= sprintf(" AND u.status = %d", $profile);
}
if (!empty($date_to) && !empty($date_from)) {
$where .= sprintf(
" AND a.login_course_date >= '%s 00:00:00'
AND a.login_course_date <= '%s 23:59:59'",
$date_from,
$date_to
);
}
$limit = null;
if (!empty($options['limit'])) {
$limit = " LIMIT ".$options['limit'];
}
if (!empty($options['where'])) {
$where .= ' '.$options['where'];
}
$order = null;
if (!empty($options['order'])) {
$order = " ORDER BY ".$options['order'];
}
//TODO add course name
$sql = "SELECT
a.login_course_date ,
u.username ,
".($is_western_name_order ? "
u.firstname,
u.lastname,
" : "
u.lastname,
u.firstname,
")."
a.logout_course_date,
a.counter,
c.title,
c.code,
u.id as user_id,
a.session_id
FROM $track_e_course_access a
INNER JOIN $user u ON a.user_id = u.id
INNER JOIN $course c ON a.c_id = c.id
$where $order $limit";
$result = Database::query(sprintf($sql, $sessionId, $courseId));
$data = [];
while ($user = Database::fetch_assoc($result)) {
$data[] = $user;
}
foreach ($data as $key => $info) {
$sql = "SELECT
title
FROM $sessionTable
WHERE
id = {$info['session_id']}";
$result = Database::query($sql);
$session = Database::fetch_assoc($result);
// building array to display
$return[] = [
'user_id' => $info['user_id'],
'logindate' => $info['login_course_date'],
'username' => $info['username'],
'firstname' => $info['firstname'],
'lastname' => $info['lastname'],
'clicks' => $info['counter'], //+ $clicks[$info['user_id']],
'ip' => '',
'timeLoggedIn' => gmdate("H:i:s", strtotime($info['logout_course_date']) - strtotime($info['login_course_date'])),
'session' => $session['title'],
];
}
foreach ($return as $key => $info) {
//Search for ip, we do less querys if we iterate the final array
$sql = sprintf(
"SELECT user_ip FROM $track_e_login WHERE login_user_id = %d AND login_date < '%s' ORDER BY login_date DESC LIMIT 1",
$info['user_id'],
$info['logindate']
); //TODO add select by user too
$result = Database::query($sql);
$ip = Database::fetch_assoc($result);
//if no ip founded, we search the closest higher ip
if (empty($ip['user_ip'])) {
$sql = sprintf(
"SELECT user_ip FROM $track_e_login WHERE login_user_id = %d AND login_date > '%s' ORDER BY login_date ASC LIMIT 1",
$info['user_id'],
$info['logindate']
); //TODO add select by user too
$result = Database::query($sql);
$ip = Database::fetch_assoc($result);
}
//add ip to final array
$return[$key]['ip'] = $ip['user_ip'];
}
return $return;
}
/**
* Creates a new course code based in given code.
*
* @param string $session_name
* <code>
* $wanted_code = 'curse' if there are in the DB codes like curse1 curse2 the function will return: course3
* if the course code doest not exist in the DB the same course code will be returned
* </code>
*
* @return string wanted unused code
*/
public static function generateNextSessionName($session_name)
{
$session_name_ok = !self::sessionNameExists($session_name);
if (!$session_name_ok) {
$table = Database::get_main_table(TABLE_MAIN_SESSION);
$session_name = Database::escape_string($session_name);
$sql = "SELECT count(*) as count FROM $table
WHERE title LIKE '$session_name%'";
$result = Database::query($sql);
if (Database::num_rows($result) > 0) {
$row = Database::fetch_array($result);
$count = $row['count'] + 1;
$session_name = $session_name.'_'.$count;
$result = self::sessionNameExists($session_name);
if (!$result) {
return $session_name;
}
}
return false;
}
return $session_name;
}
/**
* Edit a session.
*
* @author Carlos Vargas from existing code
*
* @param int $id Session primary key
* @param string $name
* @param string $startDate
* @param string $endDate
* @param string $displayStartDate
* @param string $displayEndDate
* @param string $coachStartDate
* @param string $coachEndDate
* @param array $coachesId
* @param int $sessionCategoryId
* @param int $visibility
* @param string $description
* @param int $showDescription
* @param int $duration
* @param array $extraFields
* @param int $sessionAdminId
* @param bool $sendSubscriptionNotification Optional. Whether send a mail notification to users being subscribed
* @param int $status
*
* @return mixed
*/
public static function edit_session(
$id,
$name,
$startDate,
$endDate,
$displayStartDate,
$displayEndDate,
$coachStartDate,
$coachEndDate,
$coachesId,
$sessionCategoryId,
$visibility,
$description = null,
$showDescription = 0,
$duration = 0,
$extraFields = [],
$sessionAdminId = 0,
$sendSubscriptionNotification = false,
$status = 0
) {
$id = (int) $id;
$status = (int) $status;
$coachesId = array_map(fn($id) => (int) $id, $coachesId);
$sessionCategoryId = (int) $sessionCategoryId;
$visibility = (int) $visibility;
$duration = (int) $duration;
$em = Database::getManager();
if (empty($name)) {
Display::addFlash(
Display::return_message(get_lang('A name is required for the session'), 'warning')
);
return false;
} elseif (empty($coachesId)) {
Display::addFlash(
Display::return_message(get_lang('You must select a coach'), 'warning')
);
return false;
} elseif (!empty($startDate) &&
!api_is_valid_date($startDate, 'Y-m-d H:i') &&
!api_is_valid_date($startDate, 'Y-m-d H:i:s')
) {
Display::addFlash(
Display::return_message(get_lang('Invalid start date was given.'), 'warning')
);
return false;
} elseif (!empty($endDate) &&
!api_is_valid_date($endDate, 'Y-m-d H:i') &&
!api_is_valid_date($endDate, 'Y-m-d H:i:s')
) {
Display::addFlash(
Display::return_message(get_lang('Invalid end date was given.'), 'warning')
);
return false;
} elseif (!empty($startDate) && !empty($endDate) && $startDate >= $endDate) {
Display::addFlash(
Display::return_message(get_lang('The first date should be before the end date'), 'warning')
);
return false;
} else {
$sessionInfo = self::get_session_by_name($name);
$exists = false;
if (!empty($sessionInfo) && (int) $sessionInfo['id'] !== $id) {
$exists = true;
}
if ($exists) {
Display::addFlash(
Display::return_message(get_lang('Session name already exists'), 'warning')
);
return false;
} else {
$sessionEntity = api_get_session_entity($id);
$sessionEntity
->setTitle($name)
->setDuration($duration)
->setDescription($description)
->setShowDescription(1 === $showDescription)
->setVisibility($visibility)
->setSendSubscriptionNotification((bool) $sendSubscriptionNotification)
->setAccessStartDate(null)
->setAccessStartDate(null)
->setDisplayStartDate(null)
->setDisplayEndDate(null)
->setCoachAccessStartDate(null)
->setCoachAccessEndDate(null)
;
$newGeneralCoaches = array_map(
fn($coachId) => api_get_user_entity($coachId),
$coachesId
);
$currentGeneralCoaches = $sessionEntity->getGeneralCoaches();
foreach ($newGeneralCoaches as $generalCoach) {
if (!$sessionEntity->hasUserAsGeneralCoach($generalCoach)) {
$sessionEntity->addGeneralCoach($generalCoach);
}
}
foreach ($currentGeneralCoaches as $generalCoach) {
if (!in_array($generalCoach, $newGeneralCoaches, true)) {
$sessionEntity->removeGeneralCoach($generalCoach);
}
}
if (!empty($sessionAdminId)) {
$sessionEntity->addSessionAdmin(api_get_user_entity($sessionAdminId));
}
if (!empty($startDate)) {
$sessionEntity->setAccessStartDate(api_get_utc_datetime($startDate, true, true));
}
if (!empty($endDate)) {
$sessionEntity->setAccessEndDate(api_get_utc_datetime($endDate, true, true));
}
if (!empty($displayStartDate)) {
$sessionEntity->setDisplayStartDate(api_get_utc_datetime($displayStartDate, true, true));
}
if (!empty($displayEndDate)) {
$sessionEntity->setDisplayEndDate(api_get_utc_datetime($displayEndDate, true, true));
}
if (!empty($coachStartDate)) {
$sessionEntity->setCoachAccessStartDate(api_get_utc_datetime($coachStartDate, true, true));
}
if (!empty($coachEndDate)) {
$sessionEntity->setCoachAccessEndDate(api_get_utc_datetime($coachEndDate, true, true));
}
if (!empty($sessionCategoryId)) {
$category = $em->getRepository(SessionCategory::class)->find($sessionCategoryId);
$sessionEntity->setCategory($category);
} else {
$sessionEntity->setCategory(null);
}
if ('true' === api_get_setting('session.allow_session_status')) {
$sessionEntity->setStatus($status);
}
$em->flush();
if (!empty($extraFields)) {
$extraFields['item_id'] = $id;
$sessionFieldValue = new ExtraFieldValue('session');
$sessionFieldValue->saveFieldValues($extraFields);
}
return $id;
}
}
}
/**
* Delete session.
*
* @author Carlos Vargas from existing code
*
* @param array $id_checked an array to delete sessions
* @param bool $from_ws optional, true if the function is called
* by a webservice, false otherwise
*
* @return bool
* */
public static function delete($id_checked, $from_ws = false)
{
$sessionId = null;
if (is_array($id_checked)) {
foreach ($id_checked as $sessionId) {
self::delete($sessionId);
}
} else {
$sessionId = (int) $id_checked;
}
if (empty($sessionId)) {
return false;
}
$tbl_session_rel_course = Database::get_main_table(TABLE_MAIN_SESSION_COURSE);
$tbl_session_rel_course_rel_user = Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER);
$tbl_session_rel_user = Database::get_main_table(TABLE_MAIN_SESSION_USER);
$tbl_url_session = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_SESSION);
$userGroupSessionTable = Database::get_main_table(TABLE_USERGROUP_REL_SESSION);
$trackCourseAccess = Database::get_main_table(TABLE_STATISTIC_TRACK_E_COURSE_ACCESS);
$trackAccess = Database::get_main_table(TABLE_STATISTIC_TRACK_E_ACCESS);
$ticket = Database::get_main_table(TABLE_TICKET_TICKET);
$em = Database::getManager();
$userId = api_get_user_id();
$user = api_get_user_entity();
$repo = Container::getSequenceResourceRepository();
$sequenceResource = $repo->findRequirementForResource(
$sessionId,
SequenceResource::SESSION_TYPE
);
$sessionEntity = api_get_session_entity($sessionId);
if (null === $sessionEntity) {
return false;
}
if ($sequenceResource) {
Display::addFlash(
Display::return_message(
get_lang('There is a sequence resource linked to this session. You must delete this link first.'),
'error'
)
);
return false;
}
if (self::allowed($sessionEntity) && !$from_ws) {
if (!$sessionEntity->hasUserAsSessionAdmin($user) && !api_is_platform_admin()) {
api_not_allowed(true);
}
}
// Delete Picture Session
SessionManager::deleteAsset($sessionId);
// Delete documents inside a session
$courses = self::getCoursesInSession($sessionId);
foreach ($courses as $courseId) {
$courseInfo = api_get_course_info_by_id($courseId);
/*DocumentManager::deleteDocumentsFromSession($courseInfo, $sessionId);
$works = Database::select(
'*',
$tbl_student_publication,
[
'where' => ['session_id = ? AND c_id = ?' => [$sessionId, $courseId]],
]
);
$currentCourseRepositorySys = api_get_path(SYS_COURSE_PATH).$courseInfo['path'].'/';
foreach ($works as $index => $work) {
if ($work['filetype'] = 'folder') {
Database::query("DELETE FROM $tbl_student_publication_assignment WHERE publication_id = $index");
}
my_delete($currentCourseRepositorySys.'/'.$work['url']);
}*/
}
$sessionName = $sessionEntity->getTitle();
$em->remove($sessionEntity);
$em->flush();
// Class
$sql = "DELETE FROM $userGroupSessionTable
WHERE session_id = $sessionId";
Database::query($sql);
//Database::query("DELETE FROM $tbl_student_publication WHERE session_id = $sessionId");
Database::query("DELETE FROM $tbl_session_rel_course WHERE session_id = $sessionId");
Database::query("DELETE FROM $tbl_session_rel_course_rel_user WHERE session_id = $sessionId");
Database::query("DELETE FROM $tbl_session_rel_user WHERE session_id = $sessionId");
//Database::query("DELETE FROM $tbl_item_properties WHERE session_id = $sessionId");
Database::query("DELETE FROM $tbl_url_session WHERE session_id = $sessionId");
Database::query("DELETE FROM $trackCourseAccess WHERE session_id = $sessionId");
Database::query("DELETE FROM $trackAccess WHERE session_id = $sessionId");
$sql = "UPDATE $ticket SET session_id = NULL WHERE session_id = $sessionId";
Database::query($sql);
$extraFieldValue = new ExtraFieldValue('session');
$extraFieldValue->deleteValuesByItem($sessionId);
$repo->deleteSequenceResource($sessionId, SequenceResource::SESSION_TYPE);
// Add event to system log
Event::addEvent(
LOG_SESSION_DELETE,
LOG_SESSION_ID,
$sessionName.' - id:'.$sessionId,
api_get_utc_datetime(),
$userId
);
return true;
}
/**
* @param int $id promotion id
*
* @return bool
*/
public static function clear_session_ref_promotion($id)
{
$tbl_session = Database::get_main_table(TABLE_MAIN_SESSION);
$id = intval($id);
$sql = "UPDATE $tbl_session
SET promotion_id = 0
WHERE promotion_id = $id";
if (Database::query($sql)) {
return true;
} else {
return false;
}
}
/**
* Subscribes students to the given session and optionally (default)
* unsubscribes previous users.
*
* @author Carlos Vargas from existing code
* @author Julio Montoya. Cleaning code.
*
* @param int $sessionId
* @param array $userList
* @param int $session_visibility
* @param bool $empty_users
* @param bool $registerUsersToAllCourses
*
* @return bool
*/
public static function subscribeUsersToSession(
$sessionId,
$userList,
$session_visibility = SESSION_VISIBLE_READ_ONLY,
$empty_users = true,
$registerUsersToAllCourses = true
) {
$sessionId = (int) $sessionId;
if (empty($sessionId)) {
return false;
}
foreach ($userList as $intUser) {
if ($intUser != strval(intval($intUser))) {
return false;
}
}
$tbl_session_rel_course = Database::get_main_table(TABLE_MAIN_SESSION_COURSE);
$tbl_session_rel_course_rel_user = Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER);
$tbl_session_rel_user = Database::get_main_table(TABLE_MAIN_SESSION_USER);
$tbl_session = Database::get_main_table(TABLE_MAIN_SESSION);
$session = api_get_session_entity($sessionId);
// from function parameter
if (empty($session_visibility)) {
$session_visibility = $session->getVisibility();
//default status loaded if empty
// by default readonly 1
if (empty($session_visibility)) {
$session_visibility = SESSION_VISIBLE_READ_ONLY;
}
} else {
if (!in_array($session_visibility, [SESSION_VISIBLE_READ_ONLY, SESSION_VISIBLE, SESSION_INVISIBLE])) {
$session_visibility = SESSION_VISIBLE_READ_ONLY;
}
}
$sql = "SELECT user_id FROM $tbl_session_rel_course_rel_user
WHERE session_id = $sessionId AND status = ".Session::STUDENT;
$result = Database::query($sql);
$existingUsers = [];
while ($row = Database::fetch_array($result)) {
$existingUsers[] = $row['user_id'];
}
$sql = "SELECT c_id FROM $tbl_session_rel_course
WHERE session_id = $sessionId";
$result = Database::query($sql);
$course_list = [];
while ($row = Database::fetch_array($result)) {
$course_list[] = $row['c_id'];
}
if ($session->getSendSubscriptionNotification() && is_array($userList)) {
// Sending emails only
foreach ($userList as $user_id) {
if (in_array($user_id, $existingUsers)) {
continue;
}
$tplSubject = new Template(
null,
false,
false,
false,
false,
false
);
$layoutSubject = $tplSubject->get_template(
'mail/subject_subscription_to_session_confirmation.tpl'
);
$subject = $tplSubject->fetch($layoutSubject);
$user_info = api_get_user_info($user_id);
$tplContent = new Template(
null,
false,
false,
false,
false,
false
);
// Variables for default template
$tplContent->assign('complete_name', stripslashes($user_info['complete_name']));
$tplContent->assign('session_name', $session->getTitle());
$tplContent->assign(
'session_coaches',
$session->getGeneralCoaches()->map(fn(User $coach) => UserManager::formatUserFullName($coach))
);
$layoutContent = $tplContent->get_template(
'mail/content_subscription_to_session_confirmation.tpl'
);
$content = $tplContent->fetch($layoutContent);
api_mail_html(
$user_info['complete_name'],
$user_info['mail'],
$subject,
$content,
api_get_person_name(
api_get_setting('administratorName'),
api_get_setting('administratorSurname')
),
api_get_setting('emailAdministrator')
);
}
}
if ($registerUsersToAllCourses) {
foreach ($course_list as $courseId) {
// for each course in the session
$nbr_users = 0;
$courseId = (int) $courseId;
$sql = "SELECT DISTINCT user_id
FROM $tbl_session_rel_course_rel_user
WHERE
session_id = $sessionId AND
c_id = $courseId AND
status = ".Session::STUDENT;
$result = Database::query($sql);
$existingUsers = [];
while ($row = Database::fetch_array($result)) {
$existingUsers[] = $row['user_id'];
}
// Delete existing users
if ($empty_users) {
foreach ($existingUsers as $existing_user) {
if (!in_array($existing_user, $userList)) {
self::unSubscribeUserFromCourseSession($existing_user, $courseId, $sessionId);
}
}
}
$usersToSubscribeInCourse = array_filter(
$userList,
function ($userId) use ($existingUsers) {
return !in_array($userId, $existingUsers);
}
);
self::insertUsersInCourse(
$usersToSubscribeInCourse,
$courseId,
$sessionId,
['visibility' => $session_visibility],
false
);
}
}
// Delete users from the session
if (true === $empty_users) {
$sql = "DELETE FROM $tbl_session_rel_user
WHERE
session_id = $sessionId AND
relation_type = ".Session::STUDENT;
// Don't reset session_rel_user.registered_at of users that will be registered later anyways.
if (!empty($userList)) {
$avoidDeleteThisUsers = " AND user_id NOT IN ('".implode("','", $userList)."')";
$sql .= $avoidDeleteThisUsers;
}
Event::addEvent(
LOG_SESSION_DELETE_USER,
LOG_USER_ID,
'all',
api_get_utc_datetime(),
api_get_user_id(),
null,
$sessionId
);
Database::query($sql);
}
// Insert missing users into session
foreach ($userList as $enreg_user) {
$isUserSubscribed = self::isUserSubscribedAsStudent($sessionId, $enreg_user);
if (false === $isUserSubscribed) {
$enreg_user = (int) $enreg_user;
$sql = "INSERT IGNORE INTO $tbl_session_rel_user (relation_type, session_id, user_id, registered_at)
VALUES (".Session::STUDENT.", $sessionId, $enreg_user, '".api_get_utc_datetime()."')";
Database::query($sql);
Event::addEvent(
LOG_SESSION_ADD_USER,
LOG_USER_ID,
$enreg_user,
api_get_utc_datetime(),
api_get_user_id(),
null,
$sessionId
);
}
}
// update number of users in the session
$sql = "UPDATE $tbl_session
SET nbr_users = (SELECT count(user_id) FROM $tbl_session_rel_user WHERE session_id = $sessionId)
WHERE id = $sessionId";
Database::query($sql);
return true;
}
/**
* Returns user list of the current users subscribed in the course-session.
*
* @param int $sessionId
* @param array $courseInfo
* @param int $status
*
* @return array
*/
public static function getUsersByCourseSession(
$sessionId,
$courseInfo,
$status = null
) {
$sessionId = (int) $sessionId;
$courseId = $courseInfo['real_id'];
if (empty($sessionId) || empty($courseId)) {
return [];
}
$statusCondition = null;
if (isset($status) && !is_null($status)) {
$status = (int) $status;
$statusCondition = " AND status = $status";
}
$table = Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER);
$sql = "SELECT DISTINCT user_id
FROM $table
WHERE
session_id = $sessionId AND
c_id = $courseId
$statusCondition
";
$result = Database::query($sql);
$existingUsers = [];
while ($row = Database::fetch_array($result)) {
$existingUsers[] = $row['user_id'];
}
return $existingUsers;
}
/**
* Returns user list of the current users subscribed in the course-session.
*
* @param array $sessionList
* @param array $courseList
* @param int $status
* @param int $start
* @param int $limit
*
* @return array
*/
public static function getUsersByCourseAndSessionList(
$sessionList,
$courseList,
$status = null,
$start = null,
$limit = null
) {
if (empty($sessionList) || empty($courseList)) {
return [];
}
$sessionListToString = implode("','", $sessionList);
$courseListToString = implode("','", $courseList);
$statusCondition = null;
if (isset($status) && !is_null($status)) {
$status = (int) $status;
$statusCondition = " AND status = $status";
}
$table = Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER);
$sql = "SELECT DISTINCT user_id
FROM $table
WHERE
session_id IN ('$sessionListToString') AND
c_id IN ('$courseListToString')
$statusCondition
";
if (!is_null($start) && !is_null($limit)) {
$start = (int) $start;
$limit = (int) $limit;
$sql .= "LIMIT $start, $limit";
}
$result = Database::query($sql);
$existingUsers = [];
while ($row = Database::fetch_array($result)) {
$existingUsers[] = $row['user_id'];
}
return $existingUsers;
}
/**
* Remove a list of users from a course-session.
*
* @param array $userList
* @param int $sessionId
* @param array $courseInfo
* @param int $status
* @param bool $updateTotal
*
* @return bool
*/
public static function removeUsersFromCourseSession(
$userList,
$sessionId,
$courseInfo,
$status = null,
$updateTotal = true
) {
$table = Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER);
$tableSessionCourse = Database::get_main_table(TABLE_MAIN_SESSION_COURSE);
$sessionId = (int) $sessionId;
if (empty($sessionId) || empty($userList) || empty($courseInfo)) {
return false;
}
$courseId = is_array($courseInfo) ? $courseInfo['real_id'] : $courseInfo;
$statusCondition = null;
if (isset($status) && !is_null($status)) {
$status = (int) $status;
$statusCondition = " AND status = $status";
}
foreach ($userList as $userId) {
$userId = (int) $userId;
$sql = "DELETE FROM $table
WHERE
session_id = $sessionId AND
c_id = $courseId AND
user_id = $userId
$statusCondition
";
Database::query($sql);
Event::addEvent(
LOG_SESSION_DELETE_USER_COURSE,
LOG_USER_ID,
$userId,
api_get_utc_datetime(),
api_get_user_id(),
$courseId,
$sessionId
);
}
if ($updateTotal) {
// Count users in this session-course relation
$sql = "SELECT COUNT(user_id) as nbUsers
FROM $table
WHERE
session_id = $sessionId AND
c_id = $courseId AND
status = ".Session::STUDENT;
$result = Database::query($sql);
[$userCount] = Database::fetch_array($result);
// update the session-course relation to add the users total
$sql = "UPDATE $tableSessionCourse
SET nbr_users = $userCount
WHERE
session_id = $sessionId AND
c_id = $courseId";
Database::query($sql);
}
}
/**
* Subscribe a user to an specific course inside a session.
*
* @param array $user_list
* @param int $session_id
* @param string $course_code
* @param int $session_visibility
* @param bool $removeUsersNotInList
*
* @return bool
*/
public static function subscribe_users_to_session_course(
$user_list,
$session_id,
$course_code,
$session_visibility = SESSION_VISIBLE_READ_ONLY,
$removeUsersNotInList = false
) {
if (empty($session_id) || empty($course_code)) {
return false;
}
$session_id = (int) $session_id;
$session_visibility = (int) $session_visibility;
$course_code = Database::escape_string($course_code);
$courseInfo = api_get_course_info($course_code);
$courseId = $courseInfo['real_id'];
$subscribe = (int) api_get_course_setting('subscribe_users_to_forum_notifications', $courseInfo);
$forums = [];
if (1 === $subscribe) {
$forums = get_forums($courseId, $session_id);
}
if ($removeUsersNotInList) {
$currentUsers = self::getUsersByCourseSession($session_id, $courseInfo, 0);
if (!empty($user_list)) {
$userToDelete = array_diff($currentUsers, $user_list);
} else {
$userToDelete = $currentUsers;
}
if (!empty($userToDelete)) {
self::removeUsersFromCourseSession(
$userToDelete,
$session_id,
$courseInfo,
0,
true
);
}
}
self::insertUsersInCourse(
$user_list,
$courseId,
$session_id,
['visibility' => $session_visibility]
);
}
/**
* Unsubscribe user from session.
*
* @param int Session id
* @param int User id
*
* @return bool True in case of success, false in case of error
*/
public static function unsubscribe_user_from_session($session_id, $user_id)
{
$session_id = (int) $session_id;
$user_id = (int) $user_id;
$tbl_session_rel_user = Database::get_main_table(TABLE_MAIN_SESSION_USER);
$tbl_session = Database::get_main_table(TABLE_MAIN_SESSION);
$sql = "DELETE FROM $tbl_session_rel_user
WHERE
session_id = $session_id AND
user_id = $user_id ";
Database::query($sql);
// Update number of users
$sql = "UPDATE $tbl_session
SET nbr_users = nbr_users - 1
WHERE id = $session_id ";
Database::query($sql);
Event::addEvent(
LOG_SESSION_DELETE_USER,
LOG_USER_ID,
$user_id,
api_get_utc_datetime(),
api_get_user_id(),
null,
$session_id
);
// Get the list of courses related to this session
$course_list = self::get_course_list_by_session_id($session_id);
if (!empty($course_list)) {
foreach ($course_list as $course) {
self::unSubscribeUserFromCourseSession($user_id, $course['id'], $session_id);
}
}
return true;
}
/**
* @param int $user_id
* @param int $courseId
* @param int $session_id
*/
public static function unSubscribeUserFromCourseSession($user_id, $courseId, $session_id)
{
$user_id = (int) $user_id;
$courseId = (int) $courseId;
$session_id = (int) $session_id;
$tbl_session_rel_course_rel_user = Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER);
$tbl_session_rel_course = Database::get_main_table(TABLE_MAIN_SESSION_COURSE);
// Delete user from course
$sql = "DELETE FROM $tbl_session_rel_course_rel_user
WHERE session_id = $session_id AND c_id = $courseId AND user_id = $user_id";
$result = Database::query($sql);
if (Database::affected_rows($result)) {
// Update number of users in this relation
$sql = "UPDATE $tbl_session_rel_course SET
nbr_users = nbr_users - 1
WHERE session_id = $session_id AND c_id = $courseId";
Database::query($sql);
}
Event::addEvent(
LOG_SESSION_DELETE_USER_COURSE,
LOG_USER_ID,
$user_id,
api_get_utc_datetime(),
api_get_user_id(),
$courseId,
$session_id
);
}
/**
* Subscribes courses to the given session and optionally (default)
* unsubscribe previous users.
*
* @author Carlos Vargas from existing code
*
* @param int $sessionId
* @param array $courseList List of courses int ids
* @param bool $removeExistingCoursesWithUsers Whether to unsubscribe
* existing courses and users (true, default) or not (false)
* @param bool $copyEvaluation from base course to session course
* @param bool $copyCourseTeachersAsCoach
* @param bool $importAssignments
*
* @throws Exception
*
* @return bool False on failure, true otherwise
* */
public static function add_courses_to_session(
$sessionId,
$courseList,
$removeExistingCoursesWithUsers = true,
$copyEvaluation = false,
$copyCourseTeachersAsCoach = false,
$importAssignments = false
) {
$sessionId = (int) $sessionId;
if (empty($sessionId) || empty($courseList)) {
return false;
}
$session = api_get_session_entity($sessionId);
if (!$session) {
return false;
}
$sessionVisibility = $session->getVisibility();
$tbl_session_rel_course_rel_user = Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER);
$tbl_session = Database::get_main_table(TABLE_MAIN_SESSION);
$tbl_session_rel_user = Database::get_main_table(TABLE_MAIN_SESSION_USER);
$tbl_session_rel_course = Database::get_main_table(TABLE_MAIN_SESSION_COURSE);
// Get list of courses subscribed to this session
$sql = "SELECT c_id
FROM $tbl_session_rel_course
WHERE session_id = $sessionId";
$rs = Database::query($sql);
$existingCourses = Database::store_result($rs);
$nbr_courses = count($existingCourses);
// Get list of users subscribed to this session
$sql = "SELECT user_id
FROM $tbl_session_rel_user
WHERE
session_id = $sessionId AND
relation_type = ".Session::STUDENT;
$result = Database::query($sql);
$user_list = Database::store_result($result);
// Remove existing courses from the session.
if (true === $removeExistingCoursesWithUsers && !empty($existingCourses)) {
foreach ($existingCourses as $existingCourse) {
if (!in_array($existingCourse['c_id'], $courseList)) {
$sql = "DELETE FROM $tbl_session_rel_course
WHERE
c_id = ".$existingCourse['c_id']." AND
session_id = $sessionId";
Database::query($sql);
$sql = "DELETE FROM $tbl_session_rel_course_rel_user
WHERE
c_id = ".$existingCourse['c_id']." AND
session_id = $sessionId";
Database::query($sql);
Event::addEvent(
LOG_SESSION_DELETE_COURSE,
LOG_COURSE_ID,
$existingCourse['c_id'],
api_get_utc_datetime(),
api_get_user_id(),
$existingCourse['c_id'],
$sessionId
);
CourseManager::remove_course_ranking(
$existingCourse['c_id'],
$sessionId
);
$nbr_courses--;
}
}
}
// Pass through the courses list we want to add to the session
foreach ($courseList as $courseId) {
$courseInfo = api_get_course_info_by_id($courseId);
// If course doesn't exists continue!
if (empty($courseInfo)) {
continue;
}
$exists = false;
// check if the course we want to add is already subscribed
foreach ($existingCourses as $existingCourse) {
if ($courseId == $existingCourse['c_id']) {
$exists = true;
}
}
if (!$exists) {
// Copy gradebook categories and links (from base course)
// to the new course session
if ($copyEvaluation) {
$cats = Category::load(null, null, $courseInfo['code']);
if (!empty($cats)) {
$sessionCategory = Category:: load(
null,
null,
$courseInfo['code'],
null,
null,
$sessionId,
false
);
// @todo remove commented code
if (empty($sessionCategory)) {
// There is no category for this course+session, so create one
$cat = new Category();
$sessionName = $session->getTitle();
$cat->set_name($courseInfo['code'].' - '.get_lang('Session').' '.$sessionName);
$cat->set_session_id($sessionId);
$cat->set_course_code($courseInfo['code']);
$cat->set_description(null);
//$cat->set_user_id($stud_id);
$cat->set_parent_id(0);
$cat->set_weight(100);
$cat->set_visible(0);
$cat->set_certificate_min_score(75);
$cat->add();
$sessionGradeBookCategoryId = $cat->get_id();
} else {
if (!empty($sessionCategory[0])) {
$sessionGradeBookCategoryId = $sessionCategory[0]->get_id();
}
}
$categoryIdList = [];
/** @var Category $cat */
foreach ($cats as $cat) {
$categoryIdList[$cat->get_id()] = $cat->get_id();
}
$newCategoryIdList = [];
foreach ($cats as $cat) {
$links = $cat->get_links(
null,
false,
$courseInfo['code'],
0
);
//$cat->set_session_id($sessionId);
//$oldCategoryId = $cat->get_id();
//$newId = $cat->add();
//$newCategoryIdList[$oldCategoryId] = $newId;
//$parentId = $cat->get_parent_id();
/*if (!empty($parentId)) {
$newParentId = $newCategoryIdList[$parentId];
$cat->set_parent_id($newParentId);
$cat->save();
}*/
if (!empty($links)) {
/** @var AbstractLink $link */
foreach ($links as $link) {
//$newCategoryId = $newCategoryIdList[$link->get_category_id()];
$link->set_category_id($sessionGradeBookCategoryId);
$link->add();
}
}
$evaluationList = $cat->get_evaluations(
null,
false,
$courseInfo['code'],
0
);
if (!empty($evaluationList)) {
/** @var Evaluation $evaluation */
foreach ($evaluationList as $evaluation) {
//$evaluationId = $newCategoryIdList[$evaluation->get_category_id()];
$evaluation->set_category_id($sessionGradeBookCategoryId);
$evaluation->add();
}
}
}
// Create
DocumentManager::generateDefaultCertificate(
$courseInfo,
true,
$sessionId
);
}
}
if ($importAssignments) {
$workTable = Database::get_course_table(TABLE_STUDENT_PUBLICATION);
$sql = " SELECT * FROM $workTable
WHERE active = 1 AND
c_id = $courseId AND
parent_id = 0 AND
(session_id IS NULL OR session_id = 0)";
$result = Database::query($sql);
$workList = Database::store_result($result, 'ASSOC');
foreach ($workList as $work) {
$values = [
'work_title' => $work['title'],
'new_dir' => $work['url'].'_session_'.$sessionId,
'description' => $work['description'],
'qualification' => $work['qualification'],
'allow_text_assignment' => $work['allow_text_assignment'],
];
// @todo add addDir with resources
/*addDir(
$values,
api_get_user_id(),
$courseInfo,
0,
$sessionId
);*/
}
}
// If the course isn't subscribed yet
$sql = "INSERT INTO $tbl_session_rel_course (session_id, c_id, nbr_users, position)
VALUES ($sessionId, $courseId, 0, 0)";
Database::query($sql);
Event::addEvent(
LOG_SESSION_ADD_COURSE,
LOG_COURSE_ID,
$courseId,
api_get_utc_datetime(),
api_get_user_id(),
$courseId,
$sessionId
);
// We add the current course in the existing courses array,
// to avoid adding another time the current course
$existingCourses[] = ['c_id' => $courseId];
$nbr_courses++;
// Subscribe all the users from the session to this course inside the session
self::insertUsersInCourse(
array_column($user_list, 'id'),
$courseId,
$sessionId,
['visibility' => $sessionVisibility],
false
);
}
if ($copyCourseTeachersAsCoach) {
$teachers = CourseManager::get_teacher_list_from_course_code($courseInfo['code']);
if (!empty($teachers)) {
foreach ($teachers as $teacher) {
self::updateCoaches(
$sessionId,
$courseId,
[$teacher['user_id']],
false
);
}
}
}
}
$sql = "UPDATE $tbl_session SET nbr_courses = $nbr_courses WHERE id = $sessionId";
Database::query($sql);
return true;
}
/**
* Unsubscribe course from a session.
*
* @param int $session_id
* @param int $course_id
*
* @return bool True in case of success, false otherwise
*/
public static function unsubscribe_course_from_session($session_id, $course_id)
{
$session_id = (int) $session_id;
$course_id = (int) $course_id;
if (empty($course_id) || empty($session_id)) {
return false;
}
$tbl_session_rel_course = Database::get_main_table(TABLE_MAIN_SESSION_COURSE);
$tbl_session_rel_course_rel_user = Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER);
$tbl_session = Database::get_main_table(TABLE_MAIN_SESSION);
// Unsubscribe course.
$sql = "DELETE FROM $tbl_session_rel_course
WHERE c_id = $course_id AND session_id = $session_id";
$result = Database::query($sql);
$nb_affected = Database::affected_rows($result);
$sql = "DELETE FROM $tbl_session_rel_course_rel_user
WHERE c_id = $course_id AND session_id = $session_id";
Database::query($sql);
Event::addEvent(
LOG_SESSION_DELETE_COURSE,
LOG_COURSE_ID,
$course_id,
api_get_utc_datetime(),
api_get_user_id(),
$course_id,
$session_id
);
if ($nb_affected > 0) {
// Update number of courses in the session
$sql = "UPDATE $tbl_session SET nbr_courses= nbr_courses - $nb_affected
WHERE id = $session_id";
Database::query($sql);
return true;
}
return false;
}
/**
* Creates a new extra field for a given session.
*
* @param string $variable Field's internal variable name
* @param int $fieldType Field's type
* @param string $displayText Field's language var name
* @param string $default Field's default value
*
* @return int new extra field id
*/
public static function create_session_extra_field(
$variable,
$valueType,
$displayText,
$default = ''
) {
$extraField = new ExtraFieldModel('session');
$params = [
'variable' => $variable,
'value_type' => $valueType,
'display_text' => $displayText,
'default_value' => $default,
];
return $extraField->save($params);
}
/**
* Update an extra field value for a given session.
*
* @param int $sessionId Session ID
* @param string $variable Field variable name
* @param string $value Optional. Default field value
*
* @return bool|int An integer when register a new extra field. And boolean when update the extrafield
*/
public static function update_session_extra_field_value($sessionId, $variable, $value = '')
{
$extraFieldValue = new ExtraFieldValue('session');
$params = [
'item_id' => $sessionId,
'variable' => $variable,
'value' => $value,
];
return $extraFieldValue->save($params);
}
/**
* Checks the relationship between a session and a course.
*
* @param int $session_id
* @param int $courseId
*
* @return bool returns TRUE if the session and the course are related, FALSE otherwise
* */
public static function relation_session_course_exist($session_id, $courseId)
{
$tbl_session_course = Database::get_main_table(TABLE_MAIN_SESSION_COURSE);
$return_value = false;
$sql = "SELECT c_id FROM $tbl_session_course
WHERE
session_id = ".intval($session_id)." AND
c_id = ".intval($courseId);
$result = Database::query($sql);
$num = Database::num_rows($result);
if ($num > 0) {
$return_value = true;
}
return $return_value;
}
/**
* Get the session information by name.
*
* @param string $name
*
* @return mixed false if the session does not exist, array if the session exist
*/
public static function get_session_by_name($name)
{
$tbl_session = Database::get_main_table(TABLE_MAIN_SESSION);
$name = Database::escape_string(trim($name));
if (empty($name)) {
return false;
}
$sql = 'SELECT *
FROM '.$tbl_session.'
WHERE title = "'.$name.'"';
$result = Database::query($sql);
$num = Database::num_rows($result);
if ($num > 0) {
return Database::fetch_array($result);
} else {
return false;
}
}
/**
* @param int $sessionId
* @param int $name
*
* @return bool
*/
public static function sessionNameExistBesidesMySession($sessionId, $name)
{
$table = Database::get_main_table(TABLE_MAIN_SESSION);
$name = Database::escape_string(trim($name));
$sessionId = (int) $sessionId;
if (empty($name)) {
return false;
}
$sql = "SELECT *
FROM $table
WHERE title = '$name' AND id <> $sessionId ";
$result = Database::query($sql);
$num = Database::num_rows($result);
if ($num > 0) {
return true;
}
return false;
}
/**
* Create a session category.
*
* @author Jhon Hinojosa <jhon.hinojosa@dokeos.com>, from existing code
*
* @param string name
* @param int year_start
* @param int month_start
* @param int day_start
* @param int year_end
* @param int month_end
* @param int day_end
*
* @return int session ID
* */
public static function create_category_session(
$sname,
$syear_start,
$smonth_start,
$sday_start,
$syear_end,
$smonth_end,
$sday_end
) {
$tbl_session_category = Database::get_main_table(TABLE_MAIN_SESSION_CATEGORY);
$name = trim($sname);
$year_start = intval($syear_start);
$month_start = intval($smonth_start);
$day_start = intval($sday_start);
$year_end = intval($syear_end);
$month_end = intval($smonth_end);
$day_end = intval($sday_end);
$date_start = "$year_start-".(($month_start < 10) ? "0$month_start" : $month_start)."-".(($day_start < 10) ? "0$day_start" : $day_start);
$date_end = "$year_end-".(($month_end < 10) ? "0$month_end" : $month_end)."-".(($day_end < 10) ? "0$day_end" : $day_end);
if (empty($name)) {
$msg = get_lang('Please give a name to the sessions category');
return $msg;
} elseif (!$month_start || !$day_start || !$year_start || !checkdate($month_start, $day_start, $year_start)) {
$msg = get_lang('Invalid start date was given.');
return $msg;
} elseif (!$month_end && !$day_end && !$year_end) {
$date_end = '';
} elseif (!$month_end || !$day_end || !$year_end || !checkdate($month_end, $day_end, $year_end)) {
$msg = get_lang('Invalid end date was given.');
return $msg;
} elseif ($date_start >= $date_end) {
$msg = get_lang('The first date should be before the end date');
return $msg;
}
$access_url_id = api_get_current_access_url_id();
$params = [
'title' => $name,
'date_start' => $date_start,
'access_url_id' => $access_url_id,
];
if (!empty($date_end)) {
$params['date_end'] = $date_end;
}
$id = Database::insert($tbl_session_category, $params);
// Add event to system log
$user_id = api_get_user_id();
Event::addEvent(
LOG_SESSION_CATEGORY_CREATE,
LOG_SESSION_CATEGORY_ID,
$id,
api_get_utc_datetime(),
$user_id
);
return $id;
}
/**
* Edit a sessions category.
*
* @author Jhon Hinojosa <jhon.hinojosa@dokeos.com>,from existing code
*
* @param int id
* @param string name
* @param int year_start
* @param int month_start
* @param int day_start
* @param int year_end
* @param int month_end
* @param int day_end
*
* @return bool
* The parameter id is a primary key
* */
public static function edit_category_session(
$id,
$sname,
$syear_start,
$smonth_start,
$sday_start,
$syear_end,
$smonth_end,
$sday_end
) {
$tbl_session_category = Database::get_main_table(TABLE_MAIN_SESSION_CATEGORY);
$name = trim($sname);
$year_start = intval($syear_start);
$month_start = intval($smonth_start);
$day_start = intval($sday_start);
$year_end = intval($syear_end);
$month_end = intval($smonth_end);
$day_end = intval($sday_end);
$id = intval($id);
$date_start = "$year_start-".(($month_start < 10) ? "0$month_start" : $month_start)."-".(($day_start < 10) ? "0$day_start" : $day_start);
$date_end = "$year_end-".(($month_end < 10) ? "0$month_end" : $month_end)."-".(($day_end < 10) ? "0$day_end" : $day_end);
if (empty($name)) {
$msg = get_lang('Please give a name to the sessions category');
return $msg;
} elseif (!$month_start || !$day_start || !$year_start || !checkdate($month_start, $day_start, $year_start)) {
$msg = get_lang('Invalid start date was given.');
return $msg;
} elseif (!$month_end && !$day_end && !$year_end) {
$date_end = null;
} elseif (!$month_end || !$day_end || !$year_end || !checkdate($month_end, $day_end, $year_end)) {
$msg = get_lang('Invalid end date was given.');
return $msg;
} elseif ($date_start >= $date_end) {
$msg = get_lang('The first date should be before the end date');
return $msg;
}
if (null != $date_end) {
$sql = "UPDATE $tbl_session_category
SET
title = '".Database::escape_string($name)."',
date_start = '$date_start' ,
date_end = '$date_end'
WHERE id= $id";
} else {
$sql = "UPDATE $tbl_session_category SET
title = '".Database::escape_string($name)."',
date_start = '$date_start',
date_end = NULL
WHERE id= $id";
}
$result = Database::query($sql);
return $result ? true : false;
}
/**
* Delete sessions categories.
*
* @param array|int $categoryId
* @param bool $deleteSessions Optional. Include delete session.
* @param bool $fromWs Optional. True if the function is called by a webservice, false otherwise.
*
* @return bool Nothing, or false on error
* The parameters is a array to delete sessions
*
* @author Jhon Hinojosa <jhon.hinojosa@dokeos.com>, from existing code
*/
public static function delete_session_category($categoryId, $deleteSessions = false, $fromWs = false)
{
$tblSessionCategory = Database::get_main_table(TABLE_MAIN_SESSION_CATEGORY);
$tblSession = Database::get_main_table(TABLE_MAIN_SESSION);
if (is_array($categoryId)) {
$categoryId = array_map('intval', $categoryId);
} else {
$categoryId = [(int) $categoryId];
}
$categoryId = implode(', ', $categoryId);
if ($deleteSessions) {
$sql = "SELECT id FROM $tblSession WHERE session_category_id IN ($categoryId)";
$result = Database::query($sql);
while ($rows = Database::fetch_array($result)) {
$sessionId = $rows['id'];
self::delete($sessionId, $fromWs);
}
} else {
$sql = "UPDATE $tblSession SET session_category_id = NULL WHERE session_category_id IN ($categoryId)";
Database::query($sql);
}
$sql = "DELETE FROM $tblSessionCategory WHERE id IN ($categoryId)";
Database::query($sql);
// Add event to system log
Event::addEvent(
LOG_SESSION_CATEGORY_DELETE,
LOG_SESSION_CATEGORY_ID,
$categoryId,
api_get_utc_datetime(),
api_get_user_id()
);
return true;
}
/**
* Get a list of sessions of which the given conditions match with an = 'cond'.
*
* @param array $conditions a list of condition example :
* array('status' => STUDENT) or
* array('s.name' => array('operator' => 'LIKE', value = '%$needle%'))
* @param array $order_by a list of fields on which sort
* @param int $urlId
* @param array $onlyThisSessionList
*
* @return array an array with all sessions of the platform
*
* @todo optional course code parameter, optional sorting parameters...
*/
public static function get_sessions_list(
$conditions = [],
$order_by = [],
$from = null,
$to = null,
$urlId = 0,
$onlyThisSessionList = []
) {
$session_table = Database::get_main_table(TABLE_MAIN_SESSION);
$session_category_table = Database::get_main_table(TABLE_MAIN_SESSION_CATEGORY);
$user_table = Database::get_main_table(TABLE_MAIN_USER);
$table_access_url_rel_session = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_SESSION);
$session_course_table = Database::get_main_table(TABLE_MAIN_SESSION_COURSE);
$course_table = Database::get_main_table(TABLE_MAIN_COURSE);
$urlId = empty($urlId) ? api_get_current_access_url_id() : (int) $urlId;
$return_array = [];
$sql_query = " SELECT
DISTINCT(s.id),
s.title,
s.nbr_courses,
s.access_start_date,
s.access_end_date,
sc.name as category_name,
s.promotion_id
FROM $session_table s
INNER JOIN $table_access_url_rel_session ar ON ar.session_id = s.id
LEFT JOIN $session_category_table sc ON s.session_category_id = sc.id
LEFT JOIN $session_course_table sco ON (sco.session_id = s.id)
INNER JOIN $course_table c ON sco.c_id = c.id
WHERE ar.access_url_id = $urlId ";
$availableFields = [
's.id',
's.title',
'c.id',
];
$availableOperator = [
'like',
'>=',
'<=',
'=',
];
if (count($conditions) > 0) {
foreach ($conditions as $field => $options) {
$operator = strtolower($options['operator']);
$value = Database::escape_string($options['value']);
if (in_array($field, $availableFields) && in_array($operator, $availableOperator)) {
$sql_query .= ' AND '.$field." $operator '".$value."'";
}
}
}
if (!empty($onlyThisSessionList)) {
$onlyThisSessionList = array_map('intval', $onlyThisSessionList);
$onlyThisSessionList = implode("','", $onlyThisSessionList);
$sql_query .= " AND s.id IN ('$onlyThisSessionList') ";
}
$orderAvailableList = ['title'];
if (count($order_by) > 0) {
$order = null;
$direction = null;
if (isset($order_by[0]) && in_array($order_by[0], $orderAvailableList)) {
$order = $order_by[0];
}
if (isset($order_by[1]) && in_array(strtolower($order_by[1]), ['desc', 'asc'])) {
$direction = $order_by[1];
}
if (!empty($order)) {
$sql_query .= " ORDER BY $order $direction ";
}
}
if (!is_null($from) && !is_null($to)) {
$to = (int) $to;
$from = (int) $from;
$sql_query .= "LIMIT $from, $to";
}
$sql_result = Database::query($sql_query);
if (Database::num_rows($sql_result) > 0) {
while ($result = Database::fetch_array($sql_result)) {
$return_array[$result['id']] = $result;
}
}
return $return_array;
}
/**
* Get the session category information by id.
*
* @param string session category ID
*
* @return mixed false if the session category does not exist, array if the session category exists
*/
public static function get_session_category($id)
{
$table = Database::get_main_table(TABLE_MAIN_SESSION_CATEGORY);
$id = (int) $id;
$sql = "SELECT id, title, date_start, date_end
FROM $table
WHERE id= $id";
$result = Database::query($sql);
$num = Database::num_rows($result);
if ($num > 0) {
return Database::fetch_array($result);
} else {
return false;
}
}
/**
* Get Hot Sessions (limit 8).
*
* @return array with sessions
*/
public static function getHotSessions()
{
$tbl_session = Database::get_main_table(TABLE_MAIN_SESSION);
$tbl_session_category = Database::get_main_table(TABLE_MAIN_SESSION_CATEGORY);
$tbl_users = Database::get_main_table(TABLE_MAIN_USER);
$tbl_extra_fields = Database::get_main_table(TABLE_EXTRA_FIELD_VALUES);
$tbl_session_user = Database::get_main_table(TABLE_MAIN_SESSION_USER);
$tbl_lp = Database::get_course_table(TABLE_LP_MAIN);
$extraField = new ExtraFieldModel('session');
$field = $extraField->get_handler_field_info_by_field_variable('image');
$sql = "SELECT
s.id,
s.title,
s.session_category_id,
c.title as category_name,
s.description,
s.nbr_users as users,
(SELECT COUNT(*) FROM $tbl_lp WHERE session_id = s.id) as lessons ";
if (false !== $field) {
$fieldId = $field['id'];
$sql .= ",(SELECT value FROM $tbl_extra_fields WHERE field_id = $fieldId AND item_id = s.id) as image ";
}
$sql .= " FROM $tbl_session s
LEFT JOIN $tbl_session_category c
ON s.session_category_id = c.id
ORDER BY 8 DESC
LIMIT 8";
$result = Database::query($sql);
if (Database::num_rows($result) > 0) {
$plugin = BuyCoursesPlugin::create();
$checker = $plugin->isEnabled();
$sessions = [];
while ($row = Database::fetch_array($result, 'ASSOC')) {
if (!isset($row['image'])) {
$row['image'] = '';
}
$row['on_sale'] = '';
if ($checker) {
$row['on_sale'] = $plugin->getItemByProduct(
$row['id'],
BuyCoursesPlugin::PRODUCT_TYPE_SESSION
);
}
$sessions[] = $row;
}
return $sessions;
}
return false;
}
/**
* Get all session categories (filter by access_url_id).
*
* @return mixed false if the session category does not exist, array if the session category exists
*/
public static function get_all_session_category()
{
$table = Database::get_main_table(TABLE_MAIN_SESSION_CATEGORY);
$id = api_get_current_access_url_id();
$sql = 'SELECT * FROM '.$table.'
WHERE access_url_id = '.$id.'
ORDER BY title ASC';
$result = Database::query($sql);
if (Database::num_rows($result) > 0) {
$data = Database::store_result($result, 'ASSOC');
return $data;
}
return false;
}
/**
* Assign a coach to course in session with status = 2.
*
* @param int $userId
* @param int $sessionId
* @param int $courseId
* @param bool $noCoach optional, if is true the user don't be a coach now,
* otherwise it'll assign a coach
*
* @return bool true if there are affected rows, otherwise false
*/
public static function set_coach_to_course_session(
$userId,
$sessionId = 0,
$courseId = 0,
$noCoach = false
) {
$userId = (int) $userId;
$sessionId = !empty($sessionId) ? (int) $sessionId : api_get_session_id();
$courseId = !empty($courseId) ? (int) $courseId : api_get_course_id();
if (empty($sessionId) || empty($courseId) || empty($userId)) {
return false;
}
$tblSessionRelCourseRelUser = Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER);
$tblSessionRelUser = Database::get_main_table(TABLE_MAIN_SESSION_USER);
$user = api_get_user_entity($userId);
if (!$user->hasRole('ROLE_TEACHER')) {
return false;
}
if ($noCoach) {
// check if user_id exists in session_rel_user (if the user is
// subscribed to the session in any manner)
$sql = "SELECT count(user_id) count FROM $tblSessionRelUser
WHERE
session_id = $sessionId AND
user_id = $userId";
$res = Database::query($sql);
if (Database::num_rows($res) > 0) {
$resultRow = Database::fetch_assoc($res);
// If the user is only connected to a course coach then deleted it.
if (1 === (int) $resultRow['count']) {
$sql = "DELETE FROM $tblSessionRelUser
WHERE
session_id = $sessionId AND
user_id = $userId ";
Database::query($sql);
}
}
// The user is not subscribed to the session, so make sure
// he isn't subscribed to a course in this session either
// and then exit
$sql = "DELETE FROM $tblSessionRelCourseRelUser
WHERE
session_id = $sessionId AND
c_id = $courseId AND
user_id = $userId AND
status = ".Session::COURSE_COACH."
";
$result = Database::query($sql);
return Database::affected_rows($result) > 0;
}
// Assign user as a coach to course
// First check if the user is registered to the course
$sql = "SELECT user_id FROM $tblSessionRelCourseRelUser
WHERE
session_id = $sessionId AND
c_id = $courseId AND
user_id = $userId";
$rs_check = Database::query($sql);
// Then update or insert.
if (Database::num_rows($rs_check) > 0) {
$sql = "UPDATE $tblSessionRelCourseRelUser
SET status = ".Session::COURSE_COACH."
WHERE
session_id = $sessionId AND
c_id = $courseId AND
user_id = $userId ";
$result = Database::query($sql);
return Database::affected_rows($result) > 0;
}
$sessionRepo = Container::getSessionRepository();
$session = api_get_session_entity($sessionId);
$sessionRepo->addUserInCourse(
Session::COURSE_COACH,
api_get_user_entity($userId),
api_get_course_entity($courseId),
$session
);
$sessionRepo->update($session);
/*
$em = Database::getManager();
$sessionRelCourseRelUser = new SessionRelCourseRelUser();
$sessionRelCourseRelUser
->setSession(api_get_session_entity($sessionId))
->setCourse(api_get_course_entity($courseId))
->setUser(api_get_user_entity($userId))
->setStatus(2)
->setVisibility(1)
;
$em->persist($sessionRelCourseRelUser);
$em->flush();*/
return true;
}
/**
* Subscribes sessions to human resource manager (Dashboard feature).
*
* @param array $userInfo Human Resource Manager info
* @param array $sessions_list Sessions id
* @param bool $sendEmail
* @param bool $removeSessionsFromUser
*
* @return int
* */
public static function subscribeSessionsToDrh(
$userInfo,
$sessions_list,
$sendEmail = false,
$removeSessionsFromUser = true
) {
// Database Table Definitions
$tbl_session_rel_user = Database::get_main_table(TABLE_MAIN_SESSION_USER);
$tbl_session_rel_access_url = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_SESSION);
if (empty($userInfo)) {
return 0;
}
$userId = $userInfo['user_id'];
// Only subscribe DRH users.
$rolesAllowed = [
DRH,
SESSIONADMIN,
PLATFORM_ADMIN,
COURSE_TUTOR,
];
$isAdmin = api_is_platform_admin_by_id($userInfo['user_id']);
if (!$isAdmin && !in_array($userInfo['status'], $rolesAllowed)) {
return 0;
}
$affected_rows = 0;
// Deleting assigned sessions to hrm_id.
if ($removeSessionsFromUser) {
if (api_is_multiple_url_enabled()) {
$sql = "SELECT s.session_id
FROM $tbl_session_rel_user s
INNER JOIN $tbl_session_rel_access_url a
ON (a.session_id = s.session_id)
WHERE
s.user_id = $userId AND
relation_type = ".Session::DRH." AND
access_url_id = ".api_get_current_access_url_id();
} else {
$sql = "SELECT s.session_id
FROM $tbl_session_rel_user s
WHERE user_id = $userId AND relation_type=".Session::DRH;
}
$result = Database::query($sql);
if (Database::num_rows($result) > 0) {
while ($row = Database::fetch_array($result)) {
$sql = "DELETE FROM $tbl_session_rel_user
WHERE
session_id = {$row['session_id']} AND
user_id = $userId AND
relation_type =".Session::DRH;
Database::query($sql);
}
}
}
// Inserting new sessions list.
if (!empty($sessions_list) && is_array($sessions_list)) {
foreach ($sessions_list as $session_id) {
$session_id = intval($session_id);
$sql = "SELECT session_id
FROM $tbl_session_rel_user
WHERE
session_id = $session_id AND
user_id = $userId AND
relation_type = '".Session::DRH."'";
$result = Database::query($sql);
if (0 == Database::num_rows($result)) {
$sql = "INSERT IGNORE INTO $tbl_session_rel_user (session_id, user_id, relation_type, registered_at)
VALUES (
$session_id,
$userId,
'".Session::DRH."',
'".api_get_utc_datetime()."'
)";
Database::query($sql);
$affected_rows++;
}
}
}
return $affected_rows;
}
/**
* @param int $sessionId
*
* @return array
*/
public static function getDrhUsersInSession($sessionId)
{
return self::get_users_by_session($sessionId, Session::DRH);
}
/**
* @param int $userId
* @param int $sessionId
*
* @return array
*/
public static function getSessionFollowedByDrh($userId, $sessionId)
{
$tbl_session = Database::get_main_table(TABLE_MAIN_SESSION);
$tbl_session_rel_user = Database::get_main_table(TABLE_MAIN_SESSION_USER);
$tbl_session_rel_access_url = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_SESSION);
$userId = (int) $userId;
$sessionId = (int) $sessionId;
$select = " SELECT * ";
if (api_is_multiple_url_enabled()) {
$sql = " $select FROM $tbl_session s
INNER JOIN $tbl_session_rel_user sru ON (sru.session_id = s.id)
LEFT JOIN $tbl_session_rel_access_url a ON (s.id = a.session_id)
WHERE
sru.user_id = '$userId' AND
sru.session_id = '$sessionId' AND
sru.relation_type = '".Session::DRH."' AND
access_url_id = ".api_get_current_access_url_id()."
";
} else {
$sql = "$select FROM $tbl_session s
INNER JOIN $tbl_session_rel_user sru
ON
sru.session_id = s.id AND
sru.user_id = '$userId' AND
sru.session_id = '$sessionId' AND
sru.relation_type = '".Session::DRH."'
";
}
$result = Database::query($sql);
if (Database::num_rows($result)) {
$row = Database::fetch_array($result, 'ASSOC');
$row['course_list'] = self::get_course_list_by_session_id($sessionId);
return $row;
}
return [];
}
/**
* Get sessions followed by human resources manager.
*
* @param int $userId
* @param int $start
* @param int $limit
* @param bool $getCount
* @param bool $getOnlySessionId
* @param bool $getSql
* @param string $orderCondition
* @param string $keyword
* @param string $description
* @param array $options
*
* @return array sessions
*/
public static function get_sessions_followed_by_drh(
$userId,
$start = null,
$limit = null,
$getCount = false,
$getOnlySessionId = false,
$getSql = false,
$orderCondition = null,
$keyword = '',
$description = '',
$options = []
) {
return self::getSessionsFollowedByUser(
$userId,
DRH,
$start,
$limit,
$getCount,
$getOnlySessionId,
$getSql,
$orderCondition,
$keyword,
$description,
$options
);
}
/**
* Get sessions followed by human resources manager.
*
* @param int $userId
* @param int $status DRH Optional
* @param int $start
* @param int $limit
* @param bool $getCount
* @param bool $getOnlySessionId
* @param bool $getSql
* @param string $orderCondition
* @param string $keyword
* @param string $description
* @param array $options
*
* @return array|string sessions
*/
public static function getSessionsFollowedByUser(
$userId,
$status = null,
$start = null,
$limit = null,
$getCount = false,
$getOnlySessionId = false,
$getSql = false,
$orderCondition = null,
$keyword = '',
$description = '',
$options = []
) {
// Database Table Definitions
$tbl_session = Database::get_main_table(TABLE_MAIN_SESSION);
$tbl_session_rel_access_url = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_SESSION);
$extraFieldModel = new ExtraFieldModel('session');
$conditions = $extraFieldModel->parseConditions($options);
$sqlInjectJoins = $conditions['inject_joins'];
$extraFieldsConditions = $conditions['where'];
$sqlInjectWhere = $conditions['inject_where'];
$injectExtraFields = $conditions['inject_extra_fields'];
if (!empty($injectExtraFields)) {
$injectExtraFields = ' , '.$injectExtraFields.' s.id';
}
$userId = (int) $userId;
$user = api_get_user_entity($userId);
$select = ' SELECT DISTINCT * '.$injectExtraFields;
if ($getCount) {
$select = ' SELECT count(DISTINCT(s.id)) as count ';
}
if ($getOnlySessionId) {
$select = ' SELECT DISTINCT(s.id) ';
}
$limitCondition = null;
if (!is_null($start) && !is_null($limit)) {
$limitCondition = " LIMIT ".intval($start).", ".intval($limit);
}
if (empty($orderCondition)) {
$orderCondition = ' ORDER BY s.title ';
}
$whereConditions = null;
switch ($status) {
case DRH:
$sessionsQuery = array_map(
fn(Session $session) => $session->getId(),
$user->getDRHSessions()
);
break;
case COURSEMANAGER:
$coachSessions = array_map(
fn(Session $session) => $session->getId(),
$user->getSessionsByStatusInCourseSubscription(Session::COURSE_COACH)->getValues()
);
$adminSessions = array_map(
fn(Session $session) => $session->getId(),
$user->getSessionsAsAdmin()
);
$sessionsQuery = array_merge($coachSessions, $adminSessions);
break;
case SESSIONADMIN:
$sessionsQuery = array_map(
fn(Session $session) => $session->getId(),
$user->getSessionsAsAdmin()
);
break;
default:
$sessionsQuery = array_map(
fn(Session $session) => $session->getId(),
$user->getSessionsAsStudent()
);
break;
}
$keywordCondition = '';
if (!empty($keyword)) {
$keyword = Database::escape_string($keyword);
$keywordCondition = " AND (s.title LIKE '%$keyword%' ) ";
if (!empty($description)) {
$description = Database::escape_string($description);
$keywordCondition = " AND (s.title LIKE '%$keyword%' OR s.description LIKE '%$description%' ) ";
}
}
$whereConditions .= $keywordCondition;
$subQuery = !empty($sessionsQuery) ? (' AND s.id IN ('.implode(',', $sessionsQuery).')') : '';
$sql = " $select
FROM $tbl_session s
INNER JOIN $tbl_session_rel_access_url a
ON (s.id = a.session_id)
$sqlInjectJoins
WHERE
access_url_id = ".api_get_current_access_url_id()."
$subQuery
$whereConditions
$extraFieldsConditions
$sqlInjectWhere
$orderCondition
$limitCondition";
if ($getSql) {
return $sql;
}
$result = Database::query($sql);
if ($getCount) {
$row = Database::fetch_array($result);
if ($row) {
return (int) $row['count'];
}
return 0;
}
$sessions = [];
if (Database::num_rows($result) > 0) {
$imgPath = Display::return_icon(
'session_default_small.png',
null,
[],
ICON_SIZE_SMALL,
false,
true
);
$extraFieldValue = new ExtraFieldValue('session');
while ($row = Database::fetch_array($result)) {
if ($getOnlySessionId) {
$sessions[$row['id']] = $row;
continue;
}
$extraFieldImage = $extraFieldValue->get_values_by_handler_and_field_variable($row['id'], 'image');
$image = $imgPath;
if (!empty($extraFieldImage) && isset($extraFieldImage['url'])) {
$image = $extraFieldImage['url'];
}
$row['image'] = $image;
if ('0000-00-00 00:00:00' === $row['display_start_date'] || '0000-00-00' === $row['display_start_date']) {
$row['display_start_date'] = null;
}
if ('0000-00-00 00:00:00' === $row['display_end_date'] || '0000-00-00' === $row['display_end_date']) {
$row['display_end_date'] = null;
}
if ('0000-00-00 00:00:00' === $row['access_start_date'] || '0000-00-00' === $row['access_start_date']) {
$row['access_start_date'] = null;
}
if ('0000-00-00 00:00:00' === $row['access_end_date'] || '0000-00-00' === $row['access_end_date']) {
$row['access_end_date'] = null;
}
if ('0000-00-00 00:00:00' === $row['coach_access_start_date'] ||
'0000-00-00' === $row['coach_access_start_date']
) {
$row['coach_access_start_date'] = null;
}
if ('0000-00-00 00:00:00' === $row['coach_access_end_date'] ||
'0000-00-00' === $row['coach_access_end_date']
) {
$row['coach_access_end_date'] = null;
}
$sessions[$row['id']] = $row;
}
}
return $sessions;
}
/**
* Gets the list (or the count) of courses by session filtered by access_url.
*
* @param int $session_id The session id
* @param string $course_name The course code
* @param string $orderBy Field to order the data
* @param bool $getCount Optional. Count the session courses
*
* @return array|int List of courses. Whether $getCount is true, return the count
*/
public static function get_course_list_by_session_id(
$session_id,
$course_name = '',
$orderBy = null,
$getCount = false
) {
$tbl_course = Database::get_main_table(TABLE_MAIN_COURSE);
$tbl_session_rel_course = Database::get_main_table(TABLE_MAIN_SESSION_COURSE);
$session_id = (int) $session_id;
$sqlSelect = '*, c.id, c.id as real_id, c.code as course_code';
if ($getCount) {
$sqlSelect = 'COUNT(1) as count';
}
// select the courses
$sql = "SELECT $sqlSelect
FROM $tbl_course c
INNER JOIN $tbl_session_rel_course src
ON (c.id = src.c_id)
WHERE src.session_id = '$session_id' ";
if (!empty($course_name)) {
$course_name = Database::escape_string($course_name);
$sql .= " AND c.title LIKE '%$course_name%' ";
}
if (!empty($orderBy)) {
$orderBy = Database::escape_string($orderBy);
$orderBy = " ORDER BY $orderBy";
} else {
if (self::orderCourseIsEnabled()) {
$orderBy .= ' ORDER BY position ';
} else {
$orderBy .= ' ORDER BY title ';
}
}
$sql .= Database::escape_string($orderBy);
$result = Database::query($sql);
$num_rows = Database::num_rows($result);
$courses = [];
if ($num_rows > 0) {
if ($getCount) {
$count = Database::fetch_assoc($result);
return (int) $count['count'];
}
while ($row = Database::fetch_array($result, 'ASSOC')) {
$courses[$row['real_id']] = $row;
}
}
return $courses;
}
/**
* Gets the list of courses by session filtered by access_url.
*
* @param $userId
* @param $sessionId
* @param null $from
* @param null $limit
* @param null $column
* @param null $direction
* @param bool $getCount
* @param string $keyword
*
* @return array
*/
public static function getAllCoursesFollowedByUser(
$userId,
$sessionId,
$from = null,
$limit = null,
$column = null,
$direction = null,
$getCount = false,
$keyword = ''
) {
if (empty($sessionId)) {
$sessionsSQL = self::get_sessions_followed_by_drh(
$userId,
null,
null,
null,
true,
true
);
} else {
$sessionsSQL = intval($sessionId);
}
$tbl_course = Database::get_main_table(TABLE_MAIN_COURSE);
$tbl_session_rel_course = Database::get_main_table(TABLE_MAIN_SESSION_COURSE);
if ($getCount) {
$select = "SELECT COUNT(DISTINCT(c.code)) as count ";
} else {
$select = "SELECT DISTINCT c.* ";
}
$keywordCondition = null;
if (!empty($keyword)) {
$keyword = Database::escape_string($keyword);
$keywordCondition = " AND (c.code LIKE '%$keyword%' OR c.title LIKE '%$keyword%' ) ";
}
// Select the courses
$sql = "$select
FROM $tbl_course c
INNER JOIN $tbl_session_rel_course src
ON c.id = src.c_id
WHERE
src.session_id IN ($sessionsSQL)
$keywordCondition
";
if ($getCount) {
$result = Database::query($sql);
$row = Database::fetch_array($result, 'ASSOC');
return $row['count'];
}
if (isset($from) && isset($limit)) {
$from = intval($from);
$limit = intval($limit);
$sql .= " LIMIT $from, $limit";
}
$result = Database::query($sql);
$num_rows = Database::num_rows($result);
$courses = [];
if ($num_rows > 0) {
while ($row = Database::fetch_array($result, 'ASSOC')) {
$courses[$row['id']] = $row;
}
}
return $courses;
}
/**
* Gets the list of courses by session filtered by access_url.
*
* @param int $session_id
* @param string $course_name
*
* @return array list of courses
*/
public static function get_course_list_by_session_id_like($session_id, $course_name = '')
{
$tbl_course = Database::get_main_table(TABLE_MAIN_COURSE);
$tbl_session_rel_course = Database::get_main_table(TABLE_MAIN_SESSION_COURSE);
$session_id = (int) $session_id;
$course_name = Database::escape_string($course_name);
// select the courses
$sql = "SELECT c.id, c.title FROM $tbl_course c
INNER JOIN $tbl_session_rel_course src
ON c.id = src.c_id
WHERE ";
if (!empty($session_id)) {
$sql .= "src.session_id LIKE '$session_id' AND ";
}
if (!empty($course_name)) {
$sql .= "UPPER(c.title) LIKE UPPER('%$course_name%') ";
}
$sql .= "ORDER BY title;";
$result = Database::query($sql);
$num_rows = Database::num_rows($result);
$courses = [];
if ($num_rows > 0) {
while ($row = Database::fetch_array($result, 'ASSOC')) {
$courses[$row['id']] = $row;
}
}
return $courses;
}
/**
* Gets the count of courses by session filtered by access_url.
*
* @param int session id
* @param string $keyword
*
* @return array list of courses
*/
public static function getCourseCountBySessionId($session_id, $keyword = '')
{
$tbl_course = Database::get_main_table(TABLE_MAIN_COURSE);
$tbl_session_rel_course = Database::get_main_table(TABLE_MAIN_SESSION_COURSE);
$session_id = (int) $session_id;
// select the courses
$sql = "SELECT COUNT(c.code) count
FROM $tbl_course c
INNER JOIN $tbl_session_rel_course src
ON c.id = src.c_id
WHERE src.session_id = '$session_id' ";
$keywordCondition = null;
if (!empty($keyword)) {
$keyword = Database::escape_string($keyword);
$keywordCondition = " AND (c.code LIKE '%$keyword%' OR c.title LIKE '%$keyword%' ) ";
}
$sql .= $keywordCondition;
$result = Database::query($sql);
$num_rows = Database::num_rows($result);
if ($num_rows > 0) {
$row = Database::fetch_array($result, 'ASSOC');
return $row['count'];
}
return null;
}
/**
* Get the session id based on the original id and field name in the extra fields.
* Returns 0 if session was not found.
*
* @param string $value Original session id
* @param string $variable Original field name
*
* @return int Session id
*/
public static function getSessionIdFromOriginalId($value, $variable)
{
$extraFieldValue = new ExtraFieldValue('session');
$result = $extraFieldValue->get_item_id_from_field_variable_and_field_value(
$variable,
$value
);
if (!empty($result)) {
return $result['item_id'];
}
return 0;
}
/**
* Get users by session.
*
* @param int $id session id
* @param int $status filter by status coach = 2
* @param bool $getCount Optional. Allow get the number of rows from the result
* @param int $urlId
*
* @return array|int A list with an user list. If $getCount is true then return a the count of registers
*/
public static function get_users_by_session(
$id,
$status = null,
$getCount = false,
$urlId = 0
) {
if (empty($id)) {
return [];
}
$id = (int) $id;
$urlId = empty($urlId) ? api_get_current_access_url_id() : (int) $urlId;
$tbl_user = Database::get_main_table(TABLE_MAIN_USER);
$tbl_session_rel_user = Database::get_main_table(TABLE_MAIN_SESSION_USER);
$table_access_url_user = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_USER);
$selectedField = '
u.id as user_id, u.lastname, u.firstname, u.username, su.relation_type, au.access_url_id,
su.moved_to, su.moved_status, su.moved_at, su.registered_at
';
if ($getCount) {
$selectedField = 'count(1) AS count';
}
$sql = "SELECT $selectedField
FROM $tbl_user u
INNER JOIN $tbl_session_rel_user su
ON u.id = su.user_id AND
su.session_id = $id
LEFT OUTER JOIN $table_access_url_user au
ON (au.user_id = u.id)
";
if (is_numeric($status)) {
$status = (int) $status;
$sql .= " WHERE su.relation_type = $status AND (au.access_url_id = $urlId OR au.access_url_id is null)";
} else {
$sql .= " WHERE (au.access_url_id = $urlId OR au.access_url_id is null )";
}
$sql .= ' ORDER BY su.relation_type, ';
$sql .= api_sort_by_first_name() ? ' u.firstname, u.lastname' : ' u.lastname, u.firstname';
$result = Database::query($sql);
if ($getCount) {
$count = Database::fetch_assoc($result);
if ($count) {
return (int) $count['count'];
}
return 0;
}
$return = [];
while ($row = Database::fetch_array($result, 'ASSOC')) {
$return[] = $row;
}
return $return;
}
/**
* The general coach (session_rel_user.relation_type = Session::GENERAL_COACH).
*
* @param int $user_id user id
* @param bool $asPlatformAdmin The user is platform admin, return everything
*
* @return array
*/
public static function get_sessions_by_general_coach($user_id, $asPlatformAdmin = false)
{
$sessionTable = Database::get_main_table(TABLE_MAIN_SESSION);
$user_id = (int) $user_id;
$innerJoin = '';
$whereConditions = '';
if (!$asPlatformAdmin) {
$innerJoin = " INNER JOIN session_rel_user AS sru ON (s.id = sru.session_id) ";
$whereConditions = "sru.user_id = $user_id AND sru.relation_type = ".Session::GENERAL_COACH;
}
if (api_is_multiple_url_enabled()) {
$tblSessionRelAccessUrl = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_SESSION);
$access_url_id = api_get_current_access_url_id();
if (-1 != $access_url_id) {
$innerJoin .= " INNER JOIN $tblSessionRelAccessUrl session_rel_url
ON (s.id = access_url_rel_session.session_id)";
$whereConditions .= " AND access_url_rel_session.access_url_id = $access_url_id";
}
}
$sql = "SELECT s.* FROM $sessionTable AS s $innerJoin ";
if (!empty($whereConditions)) {
$sql .= "WHERE $whereConditions ";
}
$sql .= "ORDER BY s.title";
$result = Database::query($sql);
return Database::store_result($result, 'ASSOC');
}
/**
* @param int $user_id
* @param int $courseId
* @param int $session_id
*
* @return array|bool
*/
public static function get_user_status_in_course_session($user_id, $courseId, $session_id)
{
$table = Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER);
$tbl_user = Database::get_main_table(TABLE_MAIN_USER);
$sql = "SELECT session_rcru.status
FROM $table session_rcru
INNER JOIN $tbl_user user
ON (session_rcru.user_id = user.id)
WHERE
session_rcru.session_id = '".intval($session_id)."' AND
session_rcru.c_id ='".intval($courseId)."' AND
user.id = ".intval($user_id);
$result = Database::query($sql);
$status = false;
if (Database::num_rows($result)) {
$status = Database::fetch_row($result);
$status = $status['0'];
}
return $status;
}
/**
* Gets user status within a session.
*
* @param int $userId
* @param int $sessionId
*
* @return SessionRelUser
*/
public static function getUserStatusInSession($userId, $sessionId)
{
$em = Database::getManager();
$subscriptions = $em
->getRepository(SessionRelUser::class)
->findBy(['session' => $sessionId, 'user' => $userId]);
/** @var SessionRelUser $subscription */
$subscription = current($subscriptions);
return $subscription;
}
/**
* @param int $id
*
* @return array
*/
public static function get_all_sessions_by_promotion($id)
{
$table = Database::get_main_table(TABLE_MAIN_SESSION);
return Database::select(
'*',
$table,
['where' => ['promotion_id = ?' => $id]]
);
}
/**
* @param int $promotion_id
* @param array $list
*/
public static function subscribe_sessions_to_promotion($promotion_id, $list)
{
$table = Database::get_main_table(TABLE_MAIN_SESSION);
$params = [];
$params['promotion_id'] = 0;
Database::update(
$table,
$params,
['promotion_id = ?' => $promotion_id]
);
$params['promotion_id'] = $promotion_id;
if (!empty($list)) {
foreach ($list as $session_id) {
$session_id = (int) $session_id;
Database::update($table, $params, ['id = ?' => $session_id]);
}
}
}
/**
* Updates a session status.
*
* @param int session id
* @param int status
*/
public static function set_session_status($session_id, $status)
{
$t = Database::get_main_table(TABLE_MAIN_SESSION);
$params['visibility'] = $status;
Database::update($t, $params, ['id = ?' => $session_id]);
}
/**
* Copies a session with the same data to a new session.
* The new copy is not assigned to the same promotion.
*
* @param int $id Session ID
* @param bool $copy_courses Whether to copy the relationship with courses
* @param bool $copyTeachersAndDrh
* @param bool $create_new_courses New courses will be created
* @param bool $set_exercises_lp_invisible Set exercises and LPs in the new session to invisible by default
*
* @return int The new session ID on success, 0 otherwise
*
* @see subscribe_sessions_to_promotions() for that.
*
* @todo make sure the extra session fields are copied too
*/
public static function copy(
$id,
$copy_courses = true,
$copyTeachersAndDrh = true,
$create_new_courses = false,
$set_exercises_lp_invisible = false
) {
$id = (int) $id;
$s = self::fetch($id);
if (empty($s)) {
return false;
}
// Check all dates before copying
// Get timestamp for now in UTC - see http://php.net/manual/es/function.time.php#117251
$now = time() - date('Z');
// Timestamp in one month
$inOneMonth = $now + (30 * 24 * 3600);
$inOneMonth = api_get_local_time($inOneMonth);
if (api_strtotime($s['access_start_date']) < $now) {
$s['access_start_date'] = api_get_local_time($now);
} else {
$s['access_start_date'] = api_get_local_time($s['access_start_date']);
}
if (api_strtotime($s['display_start_date']) < $now) {
$s['display_start_date'] = api_get_local_time($now);
} else {
$s['display_start_date'] = api_get_local_time($s['display_start_date']);
}
if (api_strtotime($s['coach_access_start_date']) < $now) {
$s['coach_access_start_date'] = api_get_local_time($now);
} else {
$s['coach_access_start_date'] = api_get_local_time($s['coach_access_start_date']);
}
if (api_strtotime($s['access_end_date']) < $now) {
$s['access_end_date'] = $inOneMonth;
} else {
$s['access_end_date'] = api_get_local_time($s['access_end_date']);
}
if (api_strtotime($s['display_end_date']) < $now) {
$s['display_end_date'] = $inOneMonth;
} else {
$s['display_end_date'] = api_get_local_time($s['display_end_date']);
}
if (api_strtotime($s['coach_access_end_date']) < $now) {
$s['coach_access_end_date'] = $inOneMonth;
} else {
$s['coach_access_end_date'] = api_get_local_time($s['coach_access_end_date']);
}
$extraFieldValue = new ExtraFieldValue('session');
$extraFieldsValues = $extraFieldValue->getAllValuesByItem($id);
$extraFieldsValuesToCopy = [];
if (!empty($extraFieldsValues)) {
foreach ($extraFieldsValues as $extraFieldValue) {
//$extraFieldsValuesToCopy['extra_'.$extraFieldValue['variable']] = $extraFieldValue['value'];
$extraFieldsValuesToCopy['extra_'.$extraFieldValue['variable']]['extra_'.$extraFieldValue['variable']] = $extraFieldValue['value'];
}
}
// @todo fix session image url copy.
/*if (isset($extraFieldsValuesToCopy['extra_image']) &&
isset($extraFieldsValuesToCopy['extra_image']['extra_image'])
) {
$extraFieldsValuesToCopy['extra_image'] = [
'tmp_name' => api_get_path(SYS_UPLOAD_PATH).$extraFieldsValuesToCopy['extra_image']['extra_image'],
'error' => 0,
];
}*/
$generalCoaches = self::getGeneralCoachesIdForSession($id);
// Now try to create the session
$sid = self::create_session(
$s['title'].' '.get_lang('Copy'),
$s['access_start_date'],
$s['access_end_date'],
$s['display_start_date'],
$s['display_end_date'],
$s['coach_access_start_date'],
$s['coach_access_end_date'],
$generalCoaches,
$s['session_category_id'],
(int) $s['visibility'],
true,
$s['duration'],
$s['description'],
$s['show_description'],
$extraFieldsValuesToCopy
);
if (!is_numeric($sid) || empty($sid)) {
return false;
}
if ($copy_courses) {
// Register courses from the original session to the new session
$courses = self::get_course_list_by_session_id($id);
$short_courses = $new_short_courses = [];
if (is_array($courses) && count($courses) > 0) {
foreach ($courses as $course) {
$short_courses[] = $course;
}
}
// We will copy the current courses of the session to new courses
if (!empty($short_courses)) {
if ($create_new_courses) {
api_set_more_memory_and_time_limits();
$params = [];
$params['skip_lp_dates'] = true;
foreach ($short_courses as $course_data) {
$course = CourseManager::copy_course_simple(
$course_data['title'].' '.get_lang(
'Copy'
),
$course_data['course_code'],
$id,
$sid,
$params
);
if (null !== $course) {
$course_info = api_get_course_info($course->getCode());
//By default new elements are invisible
if ($set_exercises_lp_invisible) {
$list = new LearnpathList('', $course_info, $sid);
$flat_list = $list->get_flat_list();
if (!empty($flat_list)) {
foreach ($flat_list as $lp_id => $data) {
// @todo fix
/*api_item_property_update(
$course_info,
TOOL_LEARNPATH,
$lp_id,
'invisible',
api_get_user_id(),
0,
0,
0,
0,
$sid
);*/
}
}
$quiz_table = Database::get_course_table(TABLE_QUIZ_TEST);
$course_id = $course_info['real_id'];
//@todo check this query
$sql = "UPDATE $quiz_table SET active = 0
WHERE c_id = $course_id AND session_id = $sid";
Database::query($sql);
}
$new_short_courses[] = $course_info['real_id'];
}
}
} else {
foreach ($short_courses as $course_data) {
$new_short_courses[] = $course_data['id'];
}
}
$short_courses = $new_short_courses;
self::add_courses_to_session($sid, $short_courses, true);
if (false === $create_new_courses && $copyTeachersAndDrh) {
foreach ($short_courses as $courseItemId) {
$coachList = self::getCoachesByCourseSession($id, $courseItemId);
foreach ($coachList as $userId) {
self::set_coach_to_course_session($userId, $sid, $courseItemId);
}
}
}
}
}
if ($copyTeachersAndDrh) {
// Register users from the original session to the new session
$users = self::get_users_by_session($id);
if (!empty($users)) {
$userListByStatus = [];
foreach ($users as $userData) {
$userData['relation_type'] = (int) $userData['relation_type'];
$userListByStatus[$userData['relation_type']][] = $userData;
}
foreach ($userListByStatus as $status => $userList) {
$userList = array_column($userList, 'user_id');
switch ($status) {
case 0:
/*self::subscribeUsersToSession(
$sid,
$userList,
SESSION_VISIBLE_READ_ONLY,
false,
true
);*/
break;
case 1:
// drh users
foreach ($userList as $drhId) {
$userInfo = api_get_user_info($drhId);
self::subscribeSessionsToDrh($userInfo, [$sid], false, false);
}
break;
}
}
}
}
return $sid;
}
/**
* Get the number of sessions.
*
* @param int $access_url_id ID of the URL we want to filter on (optional)
*
* @return int Number of sessions
*/
public static function count_sessions($access_url_id = 0)
{
$session_table = Database::get_main_table(TABLE_MAIN_SESSION);
$access_url_rel_session_table = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_SESSION);
$access_url_id = (int) $access_url_id;
$sql = "SELECT count(s.id) FROM $session_table s";
if (!empty($access_url_id)) {
$sql .= ", $access_url_rel_session_table u ".
" WHERE s.id = u.session_id AND u.access_url_id = $access_url_id";
}
$res = Database::query($sql);
$row = Database::fetch_row($res);
return $row[0];
}
public static function cantEditSession(?Session $session = null, bool $checkSession = true): bool
{
if (!self::allowToManageSessions()) {
return false;
}
if (api_is_platform_admin() && self::allowed($session)) {
return true;
}
if ($checkSession) {
if (self::allowed($session)) {
return true;
}
return false;
}
return true;
}
/**
* Protect a session to be edited.
*
* @return mixed | bool true if pass the check, api_not_allowed otherwise
*/
public static function protectSession(?Session $session = null, bool $checkSession = true)
{
if (!self::cantEditSession($session, $checkSession)) {
api_not_allowed(true);
}
}
public static function allowToManageSessions(): bool
{
if (self::allowManageAllSessions()) {
return true;
}
if (api_is_teacher() && 'true' === api_get_setting('allow_teachers_to_create_sessions')) {
return true;
}
return false;
}
/**
* @return bool
*/
public static function allowOnlyMySessions()
{
if (self::allowToManageSessions() &&
!api_is_platform_admin() &&
api_is_teacher()
) {
return true;
}
return false;
}
/**
* @return bool
*/
public static function allowManageAllSessions()
{
if (api_is_platform_admin() || api_is_session_admin()) {
return true;
}
return false;
}
/**
* @param $id
*
* @return bool
*/
public static function protect_teacher_session_edit($id)
{
if (!api_is_coach($id) && !api_is_platform_admin()) {
api_not_allowed(true);
} else {
return true;
}
}
/**
* @param int $courseId
*
* @return array
*/
public static function get_session_by_course($courseId)
{
$table_session_course = Database::get_main_table(TABLE_MAIN_SESSION_COURSE);
$table_session = Database::get_main_table(TABLE_MAIN_SESSION);
$url = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_SESSION);
$courseId = (int) $courseId;
$urlId = api_get_current_access_url_id();
if (empty($courseId)) {
return [];
}
$sql = "SELECT title, s.id
FROM $table_session_course sc
INNER JOIN $table_session s
ON (sc.session_id = s.id)
INNER JOIN $url u
ON (u.session_id = s.id)
WHERE
u.access_url_id = $urlId AND
sc.c_id = '$courseId' ";
$result = Database::query($sql);
return Database::store_result($result);
}
/**
* @param int $userId
* @param bool $ignoreVisibilityForAdmins
* @param bool $ignoreTimeLimit
*
* @return array
*/
public static function get_sessions_by_user(
$userId,
$ignoreVisibilityForAdmins = false,
$ignoreTimeLimit = false
) {
$sessionCategories = UserManager::get_sessions_by_category(
$userId,
false,
$ignoreVisibilityForAdmins,
$ignoreTimeLimit
);
$sessionArray = [];
if (!empty($sessionCategories)) {
foreach ($sessionCategories as $category) {
if (isset($category['sessions'])) {
foreach ($category['sessions'] as $session) {
$sessionArray[] = $session;
}
}
}
}
return $sessionArray;
}
/**
* @param string $file
* @param bool $updateSession true: if the session exists it will be updated.
* false: if session exists a new session will be created adding a counter session1, session2, etc
* @param int $defaultUserId
* @param Logger $logger
* @param array $extraFields convert a file row to an extra field. Example in CSV file there's a SessionID
* then it will converted to extra_external_session_id if you set: array('SessionId' => 'extra_external_session_id')
* @param string $extraFieldId
* @param int $daysCoachAccessBeforeBeginning
* @param int $daysCoachAccessAfterBeginning
* @param int $sessionVisibility
* @param array $fieldsToAvoidUpdate
* @param bool $deleteUsersNotInList
* @param bool $updateCourseCoaches
* @param bool $sessionWithCoursesModifier
* @param bool $addOriginalCourseTeachersAsCourseSessionCoaches
* @param bool $removeAllTeachersFromCourse
* @param int $showDescription
* @param array $teacherBackupList
* @param array $groupBackup
*
* @return array
*/
public static function importCSV(
$file,
$updateSession,
$defaultUserId = null,
$logger = null,
$extraFields = [],
$extraFieldId = null,
$daysCoachAccessBeforeBeginning = null,
$daysCoachAccessAfterBeginning = null,
$sessionVisibility = 1,
$fieldsToAvoidUpdate = [],
$deleteUsersNotInList = false,
$updateCourseCoaches = false,
$sessionWithCoursesModifier = false,
$addOriginalCourseTeachersAsCourseSessionCoaches = true,
$removeAllTeachersFromCourse = true,
$showDescription = null,
&$teacherBackupList = [],
&$groupBackup = []
) {
$content = file($file);
$error_message = null;
$session_counter = 0;
$defaultUserId = empty($defaultUserId) ? api_get_user_id() : (int) $defaultUserId;
$eol = PHP_EOL;
if (PHP_SAPI != 'cli') {
$eol = '<br />';
}
$debug = false;
if (isset($logger)) {
$debug = true;
}
$tbl_session = Database::get_main_table(TABLE_MAIN_SESSION);
$tbl_session_user = Database::get_main_table(TABLE_MAIN_SESSION_USER);
$tbl_session_course = Database::get_main_table(TABLE_MAIN_SESSION_COURSE);
$tbl_session_course_user = Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER);
$sessions = [];
if (!api_strstr($content[0], ';')) {
$error_message = get_lang('The specified file is not CSV format !');
} else {
$tag_names = [];
foreach ($content as $key => $enreg) {
$enreg = explode(';', trim($enreg));
if ($key) {
foreach ($tag_names as $tag_key => $tag_name) {
if (isset($enreg[$tag_key])) {
$sessions[$key - 1][$tag_name] = $enreg[$tag_key];
}
}
} else {
foreach ($enreg as $tag_name) {
$tag_names[] = api_preg_replace('/[^a-zA-Z0-9_\-]/', '', $tag_name);
}
if (!in_array('SessionName', $tag_names) ||
!in_array('DateStart', $tag_names) ||
!in_array('DateEnd', $tag_names)
) {
$error_message = get_lang('The specified file doesn\'t contain all needed data !');
break;
}
}
}
$sessionList = [];
$report = [];
// Looping the sessions.
foreach ($sessions as $enreg) {
$user_counter = 0;
$course_counter = 0;
if (isset($extraFields) && !empty($extraFields)) {
foreach ($extraFields as $original => $to) {
$enreg[$to] = isset($enreg[$original]) ? $enreg[$original] : null;
}
}
$session_name = $enreg['SessionName'];
if ($debug) {
$logger->debug('---------------------------------------');
$logger->debug("Sessions - Start process of session: $session_name");
$logger->debug('---------------------------------------');
}
// Default visibility
$visibilityAfterExpirationPerSession = $sessionVisibility;
if (isset($enreg['VisibilityAfterExpiration'])) {
$visibility = $enreg['VisibilityAfterExpiration'];
switch ($visibility) {
case 'read_only':
$visibilityAfterExpirationPerSession = SESSION_VISIBLE_READ_ONLY;
break;
case 'accessible':
$visibilityAfterExpirationPerSession = SESSION_VISIBLE;
break;
case 'not_accessible':
$visibilityAfterExpirationPerSession = SESSION_INVISIBLE;
break;
}
}
if (empty($session_name)) {
continue;
}
$displayAccessStartDate = isset($enreg['DisplayStartDate']) ? $enreg['DisplayStartDate'] : $enreg['DateStart'];
$displayAccessEndDate = isset($enreg['DisplayEndDate']) ? $enreg['DisplayEndDate'] : $enreg['DateEnd'];
$coachAccessStartDate = isset($enreg['CoachStartDate']) ? $enreg['CoachStartDate'] : $enreg['DateStart'];
$coachAccessEndDate = isset($enreg['CoachEndDate']) ? $enreg['CoachEndDate'] : $enreg['DateEnd'];
// We assume the dates are already in UTC
$dateStart = explode('/', $enreg['DateStart']);
$dateEnd = explode('/', $enreg['DateEnd']);
$dateStart = $dateStart[0].'-'.$dateStart[1].'-'.$dateStart[2].' 00:00:00';
$dateEnd = $dateEnd[0].'-'.$dateEnd[1].'-'.$dateEnd[2].' 23:59:59';
$displayAccessStartDate = explode('/', $displayAccessStartDate);
$displayAccessStartDate = implode('-', $displayAccessStartDate).' 00:00:00';
$displayAccessEndDate = explode('/', $displayAccessEndDate);
$displayAccessEndDate = implode('-', $displayAccessEndDate).' 23:59:59';
$coachAccessStartDate = explode('/', $coachAccessStartDate);
$coachAccessStartDate = implode('-', $coachAccessStartDate).' 00:00:00';
$coachAccessEndDate = explode('/', $coachAccessEndDate);
$coachAccessEndDate = implode('-', $coachAccessEndDate).' 23:59:59';
$session_category_id = isset($enreg['SessionCategory']) ? $enreg['SessionCategory'] : null;
$sessionDescription = isset($enreg['SessionDescription']) ? $enreg['SessionDescription'] : null;
$classes = isset($enreg['Classes']) ? explode('|', $enreg['Classes']) : [];
$extraParams = [];
if (!is_null($showDescription)) {
$extraParams['show_description'] = intval($showDescription);
}
$coachBefore = '';
$coachAfter = '';
if (!empty($daysCoachAccessBeforeBeginning) && !empty($daysCoachAccessAfterBeginning)) {
$date = new \DateTime($dateStart);
$interval = new DateInterval('P'.$daysCoachAccessBeforeBeginning.'D');
$date->sub($interval);
$coachBefore = $date->format('Y-m-d h:i');
$coachAccessStartDate = $coachBefore;
$coachBefore = api_get_utc_datetime($coachBefore);
$date = new \DateTime($dateEnd);
$interval = new DateInterval('P'.$daysCoachAccessAfterBeginning.'D');
$date->add($interval);
$coachAfter = $date->format('Y-m-d h:i');
$coachAccessEndDate = $coachAfter;
$coachAfter = api_get_utc_datetime($coachAfter);
}
$dateStart = api_get_utc_datetime($dateStart);
$dateEnd = api_get_utc_datetime($dateEnd);
$displayAccessStartDate = api_get_utc_datetime($displayAccessStartDate);
$displayAccessEndDate = api_get_utc_datetime($displayAccessEndDate);
$coachAccessStartDate = api_get_utc_datetime($coachAccessStartDate);
$coachAccessEndDate = api_get_utc_datetime($coachAccessEndDate);
if (!empty($sessionDescription)) {
$extraParams['description'] = $sessionDescription;
}
if (!empty($session_category_id)) {
$extraParams['session_category_id'] = $session_category_id;
}
// Searching a general coach.
if (!empty($enreg['Coach'])) {
$coach_id = UserManager::get_user_id_from_username($enreg['Coach']);
if (false === $coach_id) {
// If the coach-user does not exist - I'm the coach.
$coach_id = $defaultUserId;
}
} else {
$coach_id = $defaultUserId;
}
$users = explode('|', $enreg['Users']);
$courses = explode('|', $enreg['Courses']);
$deleteOnlyCourseCoaches = false;
if (1 == count($courses)) {
if ($logger) {
$logger->debug('Only one course delete old coach list');
}
$deleteOnlyCourseCoaches = true;
}
if (!$updateSession) {
// Create a session.
$unique_name = false;
$i = 0;
// Change session name, verify that session doesn't exist.
$suffix = null;
while (!$unique_name) {
if ($i > 1) {
$suffix = ' - '.$i;
}
$sql = 'SELECT id FROM '.$tbl_session.'
WHERE title = "'.Database::escape_string($session_name).$suffix.'"';
$rs = Database::query($sql);
if (Database::result($rs, 0, 0)) {
$i++;
} else {
$unique_name = true;
$session_name .= $suffix;
}
}
$sessionParams = [
'title' => $session_name,
'access_start_date' => $dateStart,
'access_end_date' => $dateEnd,
'display_start_date' => $displayAccessStartDate,
'display_end_date' => $displayAccessEndDate,
'coach_access_start_date' => $coachAccessStartDate,
'coach_access_end_date' => $coachAccessEndDate,
'visibility' => $visibilityAfterExpirationPerSession,
'nbr_users' => 0,
'nbr_courses' => 0,
'nbr_classes' => 0,
'status' => 0,
'duration' => 0,
];
if (!empty($extraParams)) {
$sessionParams = array_merge($sessionParams, $extraParams);
}
// Creating the session.
$session_id = Database::insert($tbl_session, $sessionParams);
if ($session_id) {
Database::insert(
$tbl_session_user,
[
'relation_type' => Session::GENERAL_COACH,
'duration' => 0,
'registered_at' => api_get_utc_datetime(),
'user_id' => $coach_id,
'session_id' => $session_id,
]
);
Database::insert(
$tbl_session_user,
[
'relation_type' => Session::GENERAL_COACH,
'duration' => 0,
'registered_at' => api_get_utc_datetime(),
'user_id' => $defaultUserId,
'session_id' => $session_id,
]
);
foreach ($enreg as $key => $value) {
if ('extra_' === substr($key, 0, 6)) { //an extra field
self::update_session_extra_field_value($session_id, substr($key, 6), $value);
}
}
if ($debug) {
$logger->debug("Session created: #$session_id - $session_name");
}
} else {
if ($debug) {
$message = "Sessions - Session NOT created: $session_name";
$logger->debug($message);
$report[] = $message;
}
}
$session_counter++;
} else {
$sessionId = null;
if (isset($extraFields) && !empty($extraFields) && !empty($enreg['extra_'.$extraFieldId])) {
$sessionId = self::getSessionIdFromOriginalId($enreg['extra_'.$extraFieldId], $extraFieldId);
if (empty($sessionId)) {
$my_session_result = false;
} else {
$my_session_result = true;
}
} else {
$my_session_result = self::get_session_by_name($enreg['SessionName']);
}
if (false === $my_session_result) {
// One more check
$sessionExistsWithName = self::get_session_by_name($session_name);
if ($sessionExistsWithName) {
if ($debug) {
$message = "Skip Session - Trying to update a session, but name already exists: $session_name";
$logger->debug($message);
$report[] = $message;
}
continue;
}
$sessionParams = [
'title' => $session_name,
'access_start_date' => $dateStart,
'access_end_date' => $dateEnd,
'display_start_date' => $displayAccessStartDate,
'display_end_date' => $displayAccessEndDate,
'coach_access_start_date' => $coachAccessStartDate,
'coach_access_end_date' => $coachAccessEndDate,
'visibility' => $visibilityAfterExpirationPerSession,
'nbr_users' => 0,
'nbr_courses' => 0,
'nbr_classes' => 0,
'status' => 0,
'duration' => 0,
];
if (!empty($extraParams)) {
$sessionParams = array_merge($sessionParams, $extraParams);
}
$session_id = Database::insert($tbl_session, $sessionParams);
if ($session_id) {
Database::insert(
$tbl_session_user,
[
'relation_type' => Session::GENERAL_COACH,
'duration' => 0,
'registered_at' => api_get_utc_datetime(),
'user_id' => $coach_id,
'session_id' => $session_id,
]
);
Database::insert(
$tbl_session_user,
[
'relation_type' => Session::GENERAL_COACH,
'duration' => 0,
'registered_at' => api_get_utc_datetime(),
'user_id' => $defaultUserId,
'session_id' => $session_id,
]
);
foreach ($enreg as $key => $value) {
if ('extra_' == substr($key, 0, 6)) { //an extra field
self::update_session_extra_field_value($session_id, substr($key, 6), $value);
}
}
if ($debug) {
$logger->debug("Sessions - #$session_id created: $session_name");
}
// Delete session-user relation only for students
$sql = "DELETE FROM $tbl_session_user
WHERE session_id = '$session_id' AND relation_type = ".Session::STUDENT;
Database::query($sql);
$sql = "DELETE FROM $tbl_session_course WHERE session_id = '$session_id'";
Database::query($sql);
// Delete session-course-user relationships students and coaches.
if ($updateCourseCoaches) {
$sql = "DELETE FROM $tbl_session_course_user
WHERE session_id = '$session_id' AND status in (".Session::STUDENT.", ".Session::COURSE_COACH.")";
Database::query($sql);
} else {
// Delete session-course-user relation ships *only* for students.
$sql = "DELETE FROM $tbl_session_course_user
WHERE session_id = '$session_id' AND status =".Session::STUDENT;
Database::query($sql);
}
if ($deleteOnlyCourseCoaches) {
$sql = "DELETE FROM $tbl_session_course_user
WHERE session_id = '$session_id' AND status = ".Session::COURSE_COACH;
Database::query($sql);
}
}
} else {
// Updating the session.
$params = [
'access_start_date' => $dateStart,
'access_end_date' => $dateEnd,
'display_start_date' => $displayAccessStartDate,
'display_end_date' => $displayAccessEndDate,
'coach_access_start_date' => $coachAccessStartDate,
'coach_access_end_date' => $coachAccessEndDate,
'visibility' => $visibilityAfterExpirationPerSession,
'session_category_id' => $session_category_id,
];
if (!empty($sessionDescription)) {
$params['description'] = $sessionDescription;
}
if (!empty($fieldsToAvoidUpdate)) {
foreach ($fieldsToAvoidUpdate as $field) {
unset($params[$field]);
}
}
if (isset($sessionId) && !empty($sessionId)) {
$session_id = $sessionId;
if (!empty($enreg['SessionName'])) {
$sessionExistsWithName = self::get_session_by_name($session_name);
if (false === $sessionExistsWithName) {
$sessionName = Database::escape_string($enreg['SessionName']);
$sql = "UPDATE $tbl_session SET title = '$sessionName' WHERE id = $session_id";
Database::query($sql);
$logger->debug(
"Session #$session_id name IS updated with: '$session_name' External id: ".$enreg['extra_'.$extraFieldId]
);
} else {
$sessionExistsBesidesMe = self::sessionNameExistBesidesMySession(
$session_id,
$session_name
);
if (true === $sessionExistsBesidesMe) {
if ($debug) {
$message = "Skip Session. Error when update session Session #$session_id Name: '$session_name'. Other session has the same name. External id: ".$enreg['extra_'.$extraFieldId];
$logger->debug($message);
$report[] = $message;
}
continue;
} else {
if ($debug) {
$logger->debug(
"Session #$session_id name is not updated because it didn't change (but update of other session values will continue) Name: '$session_name' External id: ".$enreg['extra_'.$extraFieldId]
);
}
}
}
}
} else {
$my_session_result = self::get_session_by_name($session_name);
$session_id = $my_session_result['id'];
}
if ($debug) {
$logger->debug("Session #$session_id to be updated: '$session_name'");
}
if ($session_id) {
$sessionInfo = api_get_session_info($session_id);
$params['show_description'] = isset($sessionInfo['show_description']) ? $sessionInfo['show_description'] : intval($showDescription);
if (!empty($daysCoachAccessBeforeBeginning) && !empty($daysCoachAccessAfterBeginning)) {
if (empty($sessionInfo['nb_days_access_before_beginning']) ||
(!empty($sessionInfo['nb_days_access_before_beginning']) &&
$sessionInfo['nb_days_access_before_beginning'] < $daysCoachAccessBeforeBeginning)
) {
$params['coach_access_start_date'] = $coachBefore;
}
if (empty($sessionInfo['nb_days_access_after_end']) ||
(!empty($sessionInfo['nb_days_access_after_end']) &&
$sessionInfo['nb_days_access_after_end'] < $daysCoachAccessAfterBeginning)
) {
$params['coach_access_end_date'] = $coachAfter;
}
}
Database::update($tbl_session, $params, ['id = ?' => $session_id]);
Database::delete(
$tbl_session_user,
['session_id = ? AND relation_type = ?' => [$session_id, Session::GENERAL_COACH]]
);
Database::insert(
$tbl_session_user,
[
'relation_type' => Session::GENERAL_COACH,
'duration' => 0,
'registered_at' => api_get_utc_datetime(),
'user_id' => $coach_id,
'session_id' => $session_id,
]
);
foreach ($enreg as $key => $value) {
if ('extra_' == substr($key, 0, 6)) { //an extra field
self::update_session_extra_field_value($session_id, substr($key, 6), $value);
}
}
if ($debug) {
$logger->debug("Session updated #$session_id");
}
// Delete session-user relation only for students
$sql = "DELETE FROM $tbl_session_user
WHERE session_id = '$session_id' AND relation_type = ".Session::STUDENT;
Database::query($sql);
$sql = "DELETE FROM $tbl_session_course WHERE session_id = '$session_id'";
Database::query($sql);
// Delete session-course-user relationships students and coaches.
if ($updateCourseCoaches) {
$sql = "DELETE FROM $tbl_session_course_user
WHERE session_id = '$session_id' AND status in (".Session::STUDENT.", ".Session::COURSE_COACH.")";
Database::query($sql);
} else {
// Delete session-course-user relation ships *only* for students.
$sql = "DELETE FROM $tbl_session_course_user
WHERE session_id = '$session_id' AND status = ".Session::STUDENT;
Database::query($sql);
}
if ($deleteOnlyCourseCoaches) {
$sql = "DELETE FROM $tbl_session_course_user
WHERE session_id = '$session_id' AND status = ".Session::COURSE_COACH;
Database::query($sql);
}
} else {
if ($debug) {
$logger->debug(
"Sessions - Session not found"
);
}
}
}
$session_counter++;
}
$sessionList[] = $session_id;
// Adding the relationship "Session - User" for students
$userList = [];
if (is_array($users)) {
$extraFieldValueCareer = new ExtraFieldValue('career');
$careerList = isset($enreg['extra_careerid']) && !empty($enreg['extra_careerid']) ? $enreg['extra_careerid'] : [];
$careerList = str_replace(['[', ']'], '', $careerList);
if (!empty($careerList)) {
$careerList = explode(',', $careerList);
$finalCareerIdList = [];
foreach ($careerList as $careerId) {
$realCareerIdList = $extraFieldValueCareer->get_item_id_from_field_variable_and_field_value(
'external_career_id',
$careerId
);
if (isset($realCareerIdList['item_id'])) {
$finalCareerIdList[] = $realCareerIdList['item_id'];
}
}
}
foreach ($users as $user) {
$user_id = UserManager::get_user_id_from_username($user);
if (false !== $user_id) {
if (!empty($finalCareerIdList)) {
foreach ($finalCareerIdList as $careerId) {
UserManager::addUserCareer($user_id, $careerId);
}
}
$userList[] = $user_id;
// Insert new users.
$sql = "INSERT IGNORE INTO $tbl_session_user SET
user_id = '$user_id',
session_id = '$session_id',
registered_at = '".api_get_utc_datetime()."'";
Database::query($sql);
if ($debug) {
$logger->debug("Adding User #$user_id ($user) to session #$session_id");
}
$user_counter++;
}
}
}
if ($deleteUsersNotInList) {
// Getting user in DB in order to compare to the new list.
$usersListInDatabase = self::get_users_by_session($session_id, 0);
if (!empty($usersListInDatabase)) {
if (empty($userList)) {
foreach ($usersListInDatabase as $userInfo) {
self::unsubscribe_user_from_session($session_id, $userInfo['user_id']);
}
} else {
foreach ($usersListInDatabase as $userInfo) {
if (!in_array($userInfo['user_id'], $userList)) {
self::unsubscribe_user_from_session($session_id, $userInfo['user_id']);
}
}
}
}
}
// See BT#6449
$onlyAddFirstCoachOrTeacher = false;
if ($sessionWithCoursesModifier) {
if (count($courses) >= 2) {
// Only first teacher in course session;
$onlyAddFirstCoachOrTeacher = true;
// Remove all teachers from course.
$removeAllTeachersFromCourse = false;
}
}
foreach ($courses as $course) {
$courseArray = bracketsToArray($course);
$course_code = $courseArray[0];
if (CourseManager::course_exists($course_code)) {
$courseInfo = api_get_course_info($course_code);
$courseId = $courseInfo['real_id'];
// Adding the course to a session.
$sql = "INSERT IGNORE INTO $tbl_session_course
SET c_id = '$courseId', session_id='$session_id'";
Database::query($sql);
self::installCourse($session_id, $courseInfo['real_id']);
if ($debug) {
$logger->debug("Adding course '$course_code' to session #$session_id");
}
$course_counter++;
$course_coaches = isset($courseArray[1]) ? $courseArray[1] : null;
$course_users = isset($courseArray[2]) ? $courseArray[2] : null;
$course_users = explode(',', $course_users);
$course_coaches = explode(',', $course_coaches);
// Checking if the flag is set TeachersWillBeAddedAsCoachInAllCourseSessions (course_edit.php)
$addTeachersToSession = true;
if (array_key_exists('add_teachers_to_sessions_courses', $courseInfo)) {
$addTeachersToSession = $courseInfo['add_teachers_to_sessions_courses'];
}
// If any user provided for a course, use the users array.
if (empty($course_users)) {
if (!empty($userList)) {
self::subscribe_users_to_session_course(
$userList,
$session_id,
$course_code
);
if ($debug) {
$msg = "Adding student list ".implode(', #', $userList)." to course: '$course_code' and session #$session_id";
$logger->debug($msg);
}
}
}
// Adding coaches to session course user.
if (!empty($course_coaches)) {
$savedCoaches = [];
// only edit if add_teachers_to_sessions_courses is set.
if ($addTeachersToSession) {
if ($addOriginalCourseTeachersAsCourseSessionCoaches) {
// Adding course teachers as course session teachers.
$alreadyAddedTeachers = CourseManager::get_teacher_list_from_course_code(
$course_code
);
if (!empty($alreadyAddedTeachers)) {
$teachersToAdd = [];
foreach ($alreadyAddedTeachers as $user) {
$teachersToAdd[] = $user['username'];
}
$course_coaches = array_merge(
$course_coaches,
$teachersToAdd
);
}
}
foreach ($course_coaches as $course_coach) {
$coach_id = UserManager::get_user_id_from_username($course_coach);
if (false !== $coach_id) {
// Just insert new coaches
self::updateCoaches(
$session_id,
$courseId,
[$coach_id],
false
);
if ($debug) {
$logger->debug("Adding course coach: user #$coach_id ($course_coach) to course: '$course_code' and session #$session_id");
}
$savedCoaches[] = $coach_id;
} else {
$error_message .= get_lang('This user doesn\'t exist').' : '.$course_coach.$eol;
}
}
}
// Custom courses/session coaches
$teacherToAdd = null;
// Only one coach is added.
if (true == $onlyAddFirstCoachOrTeacher) {
if ($debug) {
$logger->debug("onlyAddFirstCoachOrTeacher : true");
}
foreach ($course_coaches as $course_coach) {
$coach_id = UserManager::get_user_id_from_username($course_coach);
if (false !== $coach_id) {
$teacherToAdd = $coach_id;
break;
}
}
// Un subscribe everyone that's not in the list.
$teacherList = CourseManager::get_teacher_list_from_course_code($course_code);
if (!empty($teacherList)) {
foreach ($teacherList as $teacher) {
if ($teacherToAdd != $teacher['user_id']) {
$sql = "SELECT * FROM ".Database::get_main_table(TABLE_MAIN_COURSE_USER)."
WHERE
user_id = ".$teacher['user_id']." AND
c_id = '".$courseId."'
";
$result = Database::query($sql);
$rows = Database::num_rows($result);
if ($rows > 0) {
$userCourseData = Database::fetch_array($result, 'ASSOC');
if (!empty($userCourseData)) {
$teacherBackupList[$teacher['user_id']][$course_code] = $userCourseData;
}
}
$sql = "SELECT * FROM ".Database::get_course_table(TABLE_GROUP_USER)."
WHERE
user_id = ".$teacher['user_id']." AND
c_id = '".$courseInfo['real_id']."'
";
$result = Database::query($sql);
while ($groupData = Database::fetch_array($result, 'ASSOC')) {
$groupBackup['user'][$teacher['user_id']][$course_code][$groupData['group_id']] = $groupData;
}
$sql = "SELECT * FROM ".Database::get_course_table(TABLE_GROUP_TUTOR)."
WHERE
user_id = ".$teacher['user_id']." AND
c_id = '".$courseInfo['real_id']."'
";
$result = Database::query($sql);
while ($groupData = Database::fetch_array($result, 'ASSOC')) {
$groupBackup['tutor'][$teacher['user_id']][$course_code][$groupData['group_id']] = $groupData;
}
CourseManager::unsubscribe_user(
$teacher['user_id'],
$course_code
);
if ($debug) {
$logger->debug("Delete user #".$teacher['user_id']." from base course: $course_code");
}
}
}
}
if (!empty($teacherToAdd)) {
self::updateCoaches(
$session_id,
$courseId,
[$teacherToAdd],
true
);
if ($debug) {
$logger->debug("Add coach #$teacherToAdd to course $courseId and session $session_id");
}
$userCourseCategory = '';
if (isset($teacherBackupList[$teacherToAdd]) &&
isset($teacherBackupList[$teacherToAdd][$course_code])
) {
$courseUserData = $teacherBackupList[$teacherToAdd][$course_code];
$userCourseCategory = $courseUserData['user_course_cat'];
}
CourseManager::subscribeUser(
$teacherToAdd,
$courseId,
COURSEMANAGER,
0,
$userCourseCategory
);
if ($debug) {
$logger->debug("Subscribe user #$teacherToAdd as teacher in course $course_code with user userCourseCategory $userCourseCategory");
}
if (isset($groupBackup['user'][$teacherToAdd]) &&
isset($groupBackup['user'][$teacherToAdd][$course_code]) &&
!empty($groupBackup['user'][$teacherToAdd][$course_code])
) {
foreach ($groupBackup['user'][$teacherToAdd][$course_code] as $data) {
GroupManager::subscribeUsers(
$teacherToAdd,
api_get_group_entity($data['group_id']),
$data['c_id']
);
}
}
if (isset($groupBackup['tutor'][$teacherToAdd]) &&
isset($groupBackup['tutor'][$teacherToAdd][$course_code]) &&
!empty($groupBackup['tutor'][$teacherToAdd][$course_code])
) {
foreach ($groupBackup['tutor'][$teacherToAdd][$course_code] as $data) {
GroupManager::subscribeTutors(
$teacherToAdd,
api_get_group_entity($data['group_id']),
$data['c_id']
);
}
}
}
}
// See BT#6449#note-195
// All coaches are added.
if ($removeAllTeachersFromCourse) {
if ($debug) {
$logger->debug("removeAllTeachersFromCourse true");
}
$teacherToAdd = null;
foreach ($course_coaches as $course_coach) {
$coach_id = UserManager::get_user_id_from_username(
$course_coach
);
if (false !== $coach_id) {
$teacherToAdd[] = $coach_id;
}
}
if (!empty($teacherToAdd)) {
// Deleting all course teachers and adding the only coach as teacher.
$teacherList = CourseManager::get_teacher_list_from_course_code($course_code);
if (!empty($teacherList)) {
foreach ($teacherList as $teacher) {
if (!in_array($teacher['user_id'], $teacherToAdd)) {
$sql = "SELECT * FROM ".Database::get_main_table(TABLE_MAIN_COURSE_USER)."
WHERE
user_id = ".$teacher['user_id']." AND
c_id = '".$courseId."'
";
$result = Database::query($sql);
$rows = Database::num_rows($result);
if ($rows > 0) {
$userCourseData = Database::fetch_array($result, 'ASSOC');
if (!empty($userCourseData)) {
$teacherBackupList[$teacher['user_id']][$course_code] = $userCourseData;
}
}
$sql = "SELECT * FROM ".Database::get_course_table(TABLE_GROUP_USER)."
WHERE
user_id = ".$teacher['user_id']." AND
c_id = '".$courseInfo['real_id']."'
";
$result = Database::query($sql);
while ($groupData = Database::fetch_array($result, 'ASSOC')) {
$groupBackup['user'][$teacher['user_id']][$course_code][$groupData['group_id']] = $groupData;
}
$sql = "SELECT * FROM ".Database::get_course_table(TABLE_GROUP_TUTOR)."
WHERE
user_id = ".$teacher['user_id']." AND
c_id = '".$courseInfo['real_id']."'
";
$result = Database::query($sql);
while ($groupData = Database::fetch_array($result, 'ASSOC')) {
$groupBackup['tutor'][$teacher['user_id']][$course_code][$groupData['group_id']] = $groupData;
}
CourseManager::unsubscribe_user(
$teacher['user_id'],
$course_code
);
if ($debug) {
$logger->debug("Delete user #".$teacher['user_id']." from base course: $course_code");
}
}
}
}
foreach ($teacherToAdd as $teacherId) {
$userCourseCategory = '';
if (isset($teacherBackupList[$teacherId]) &&
isset($teacherBackupList[$teacherId][$course_code])
) {
$courseUserData = $teacherBackupList[$teacherId][$course_code];
$userCourseCategory = $courseUserData['user_course_cat'];
}
CourseManager::subscribeUser(
$teacherId,
$courseInfo['real_id'],
COURSEMANAGER,
0,
$userCourseCategory
);
if ($debug) {
$logger->debug("Add user as teacher #".$teacherId." in base course: $course_code with userCourseCategory: $userCourseCategory");
}
if (isset($groupBackup['user'][$teacherId]) &&
isset($groupBackup['user'][$teacherId][$course_code]) &&
!empty($groupBackup['user'][$teacherId][$course_code])
) {
foreach ($groupBackup['user'][$teacherId][$course_code] as $data) {
GroupManager::subscribeUsers(
$teacherId,
api_get_group_entity($data['group_id']),
$data['c_id']
);
}
}
if (isset($groupBackup['tutor'][$teacherId]) &&
isset($groupBackup['tutor'][$teacherId][$course_code]) &&
!empty($groupBackup['tutor'][$teacherId][$course_code])
) {
foreach ($groupBackup['tutor'][$teacherId][$course_code] as $data) {
GroupManager::subscribeTutors(
$teacherId,
api_get_group_entity($data['group_id']),
$data['c_id']
);
}
}
}
}
}
// Continue default behaviour.
if (false == $onlyAddFirstCoachOrTeacher) {
// Checking one more time see BT#6449#note-149
$coaches = self::getCoachesByCourseSession($session_id, $courseId);
// Update coaches if only there's 1 course see BT#6449#note-189
if (empty($coaches) || 1 == count($courses)) {
foreach ($course_coaches as $course_coach) {
$course_coach = trim($course_coach);
$coach_id = UserManager::get_user_id_from_username($course_coach);
if (false !== $coach_id) {
// Just insert new coaches
self::updateCoaches(
$session_id,
$courseId,
[$coach_id],
false
);
if ($debug) {
$logger->debug("Sessions - Adding course coach: user #$coach_id ($course_coach) to course: '$course_code' and session #$session_id");
}
$savedCoaches[] = $coach_id;
} else {
$error_message .= get_lang('This user doesn\'t exist').' : '.$course_coach.$eol;
}
}
}
}
}
// Adding Students, updating relationship "Session - Course - User".
$course_users = array_filter($course_users);
if (!empty($course_users)) {
foreach ($course_users as $user) {
$user_id = UserManager::get_user_id_from_username($user);
if (false !== $user_id) {
self::subscribe_users_to_session_course(
[$user_id],
$session_id,
$course_code
);
if ($debug) {
$logger->debug("Adding student: user #$user_id ($user) to course: '$course_code' and session #$session_id");
}
} else {
$error_message .= get_lang('This user doesn\'t exist').': '.$user.$eol;
}
}
}
$inserted_in_course[$course_code] = $courseInfo['title'];
}
}
$access_url_id = api_get_current_access_url_id();
UrlManager::add_session_to_url($session_id, $access_url_id);
$sql = "UPDATE $tbl_session SET nbr_users = '$user_counter', nbr_courses = '$course_counter'
WHERE id = '$session_id'";
Database::query($sql);
self::addClassesByName($session_id, $classes, false);
if ($debug) {
$logger->debug("End process session #$session_id -------------------- ");
}
}
if (!empty($report)) {
if ($debug) {
$logger->debug("--Summary--");
foreach ($report as $line) {
$logger->debug($line);
}
}
}
}
return [
'error_message' => $error_message,
'session_counter' => $session_counter,
'session_list' => $sessionList,
];
}
/**
* @param int $sessionId
* @param int $courseId
*
* @return array
*/
public static function getCoachesByCourseSession($sessionId, $courseId)
{
$table = Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER);
$sessionId = (int) $sessionId;
$courseId = (int) $courseId;
$sql = "SELECT user_id FROM $table
WHERE
session_id = '$sessionId' AND
c_id = '$courseId' AND
status = ".Session::COURSE_COACH;
$result = Database::query($sql);
$coaches = [];
if (Database::num_rows($result) > 0) {
while ($row = Database::fetch_array($result)) {
$coaches[] = $row['user_id'];
}
}
return $coaches;
}
/**
* @param int $sessionId
* @param int $courseId
* @param string $separator
*
* @return string
*/
public static function getCoachesByCourseSessionToString(
$sessionId,
$courseId,
$separator = ''
) {
$coaches = self::getCoachesByCourseSession($sessionId, $courseId);
$list = [];
if (!empty($coaches)) {
foreach ($coaches as $coachId) {
$userInfo = api_get_user_info($coachId);
if ($userInfo) {
$list[] = $userInfo['complete_name'];
}
}
}
$separator = empty($separator) ? CourseManager::USER_SEPARATOR : $separator;
return array_to_string($list, $separator);
}
/**
* Get all coaches added in the session - course relationship.
*
* @param int $sessionId
*
* @return array
*/
public static function getCoachesBySession($sessionId)
{
$table = Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER);
$sessionId = intval($sessionId);
$sql = "SELECT DISTINCT user_id
FROM $table
WHERE session_id = '$sessionId' AND status = ".Session::COURSE_COACH;
$result = Database::query($sql);
$coaches = [];
if (Database::num_rows($result) > 0) {
while ($row = Database::fetch_array($result)) {
$coaches[] = $row['user_id'];
}
}
return $coaches;
}
/**
* @param int $userId
*
* @return array
*/
public static function getAllCoursesFromAllSessionFromDrh($userId)
{
$sessions = self::get_sessions_followed_by_drh($userId);
$coursesFromSession = [];
if (!empty($sessions)) {
foreach ($sessions as $session) {
$courseList = self::get_course_list_by_session_id($session['id']);
foreach ($courseList as $course) {
$coursesFromSession[] = $course['code'];
}
}
}
return $coursesFromSession;
}
/**
* getAllCoursesFromAllSessions.
*
* @return array
*/
public static function getAllCoursesFromAllSessions()
{
$sessions = self::get_sessions_list();
$coursesFromSession = [];
if (!empty($sessions)) {
foreach ($sessions as $session) {
$courseList = self::get_course_list_by_session_id($session['id']);
foreach ($courseList as $course) {
$coursesFromSession[$course['code'].':'.$session['id']] = $course['visual_code'].' - '.$course['title'].' ('.$session['title'].')';
}
}
}
return $coursesFromSession;
}
/**
* Return user id list or count of users depending of the $getCount parameter.
*
* @param string $status
* @param int $userId
* @param bool $getCount
* @param int $from
* @param int $numberItems
* @param string $column
* @param string $direction
* @param string $keyword
* @param string $active
* @param string $lastConnectionDate
* @param array $sessionIdList
* @param array $studentIdList
* @param int $filterByStatus
*
* @return array|int
*/
public static function getAllUsersFromCoursesFromAllSessionFromStatus(
$status,
$userId,
$getCount = false,
$from = null,
$numberItems = null,
$column = '',
$direction = 'asc',
$keyword = null,
$active = null,
$lastConnectionDate = null,
$sessionIdList = [],
$studentIdList = [],
$filterByStatus = null
) {
$filterByStatus = (int) $filterByStatus;
$userId = (int) $userId;
if (empty($column)) {
$column = 'u.lastname';
if (api_is_western_name_order()) {
$column = 'u.firstname';
}
}
$tbl_user = Database::get_main_table(TABLE_MAIN_USER);
$tbl_session = Database::get_main_table(TABLE_MAIN_SESSION);
$tbl_course = Database::get_main_table(TABLE_MAIN_COURSE);
$tbl_course_user = Database::get_main_table(TABLE_MAIN_COURSE_USER);
$tbl_user_rel_access_url = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_USER);
$tbl_course_rel_access_url = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_COURSE);
$tbl_session_rel_course_rel_user = Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER);
$tbl_session_rel_access_url = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_SESSION);
$direction = in_array(strtolower($direction), ['asc', 'desc']) ? $direction : 'asc';
$column = Database::escape_string($column);
$urlId = api_get_current_access_url_id();
$sessionConditions = '';
$courseConditions = '';
$userConditions = '';
if (isset($active)) {
$active = (int) $active;
$userConditions .= " AND active = $active";
}
$courseList = CourseManager::get_courses_followed_by_drh($userId, DRH);
if (!empty($courseList)) {
$courseIdList = array_column($courseList, 'id');
$courseConditions = ' AND c.id IN ("'.implode('","', $courseIdList).'")';
}
$userConditionsFromDrh = '';
// Classic DRH
if (empty($studentIdList)) {
$studentListSql = UserManager::get_users_followed_by_drh(
$userId,
$filterByStatus,
true,
false
);
if (!empty($studentListSql)) {
$studentIdList = array_keys($studentListSql);
$studentListSql = "'".implode("','", $studentIdList)."'";
}
} else {
$studentIdList = array_map('intval', $studentIdList);
$studentListSql = "'".implode("','", $studentIdList)."'";
}
if (!empty($studentListSql)) {
$userConditionsFromDrh = " AND u.id IN ($studentListSql) ";
}
switch ($status) {
case 'admin':
case 'drh':
break;
case 'drh_all':
// Show all by DRH
if (empty($sessionIdList)) {
$sessionListFollowed = self::get_sessions_followed_by_drh(
$userId,
null,
null,
false,
true
);
if (!empty($sessionListFollowed)) {
$sessionIdList = array_column($sessionListFollowed, 'id');
}
}
if (!empty($sessionIdList)) {
$sessionIdList = array_map('intval', $sessionIdList);
$sessionsListSql = "'".implode("','", $sessionIdList)."'";
$sessionConditions = " AND s.id IN ($sessionsListSql) ";
}
break;
case 'teacher':
case 'session_admin':
$generalCoachedSessions = array_map(
fn(Session $session) => $session->getId(),
api_get_user_entity($userId)->getSessionsAsGeneralCoach()
);
$sessionConditions = " AND s.IN (".implode(',', $generalCoachedSessions).") ";
$userConditionsFromDrh = '';
break;
}
$select = 'SELECT DISTINCT u.*, u.id as user_id';
$masterSelect = 'SELECT DISTINCT id, id as user_id FROM ';
if ($getCount) {
$select = 'SELECT DISTINCT u.id, u.id as user_id';
$masterSelect = 'SELECT COUNT(DISTINCT(id)) as count FROM ';
}
if (!empty($filterByStatus)) {
$userConditions .= " AND u.status = $filterByStatus";
}
if (!empty($lastConnectionDate)) {
$lastConnectionDate = Database::escape_string($lastConnectionDate);
$userConditions .= " AND u.last_login <= '$lastConnectionDate' ";
}
if (!empty($keyword)) {
$keyword = Database::escape_string($keyword);
$userConditions .= " AND (
u.username LIKE '%$keyword%' OR
u.firstname LIKE '%$keyword%' OR
u.lastname LIKE '%$keyword%' OR
u.official_code LIKE '%$keyword%' OR
u.email LIKE '%$keyword%'
)";
}
$where = " WHERE
access_url_id = $urlId
$userConditions
";
$userUnion = '';
if (!empty($userConditionsFromDrh)) {
$userUnion = "
UNION (
$select
FROM $tbl_user u
INNER JOIN $tbl_user_rel_access_url url
ON (url.user_id = u.id)
$where
$userConditionsFromDrh
)";
}
$sql = "$masterSelect (
($select
FROM $tbl_session s
INNER JOIN $tbl_session_rel_access_url url
ON (url.session_id = s.id)
INNER JOIN $tbl_session_rel_course_rel_user su
ON (s.id = su.session_id)
INNER JOIN $tbl_user u
ON (u.id = su.user_id)
$where
$sessionConditions
$userConditionsFromDrh
) UNION (
$select
FROM $tbl_course c
INNER JOIN $tbl_course_rel_access_url url
ON (url.c_id = c.id)
INNER JOIN $tbl_course_user cu
ON (cu.c_id = c.id)
INNER JOIN $tbl_user u
ON (u.id = cu.user_id)
$where
$courseConditions
$userConditionsFromDrh
) $userUnion
) as t1
";
if ($getCount) {
$result = Database::query($sql);
$count = 0;
if (Database::num_rows($result)) {
$rows = Database::fetch_array($result);
$count = $rows['count'];
}
return $count;
}
if (!empty($column) && !empty($direction)) {
$column = str_replace('u.', '', $column);
$sql .= " ORDER BY `$column` $direction ";
}
$limitCondition = '';
if (isset($from) && isset($numberItems)) {
$from = (int) $from;
$numberItems = (int) $numberItems;
$limitCondition = "LIMIT $from, $numberItems";
}
$sql .= $limitCondition;
$result = Database::query($sql);
return Database::store_result($result);
}
/**
* @param int $sessionId
* @param int $courseId
* @param array $coachList
* @param bool $deleteCoachesNotInList
*/
public static function updateCoaches(
$sessionId,
$courseId,
$coachList,
$deleteCoachesNotInList = false
) {
$currentCoaches = self::getCoachesByCourseSession($sessionId, $courseId);
if (!empty($coachList)) {
foreach ($coachList as $userId) {
self::set_coach_to_course_session($userId, $sessionId, $courseId);
}
}
if ($deleteCoachesNotInList) {
if (!empty($coachList)) {
$coachesToDelete = array_diff($currentCoaches, $coachList);
} else {
$coachesToDelete = $currentCoaches;
}
if (!empty($coachesToDelete)) {
foreach ($coachesToDelete as $userId) {
self::set_coach_to_course_session(
$userId,
$sessionId,
$courseId,
true
);
}
}
}
}
/**
* @param array $sessions
* @param array $sessionsDestination
*
* @return array
*/
public static function copyStudentsFromSession($sessions, $sessionsDestination)
{
$messages = [];
if (!empty($sessions)) {
foreach ($sessions as $sessionId) {
$sessionInfo = self::fetch($sessionId);
$userList = self::get_users_by_session($sessionId, 0);
if (!empty($userList)) {
$newUserList = [];
$userToString = null;
foreach ($userList as $userInfo) {
$newUserList[] = $userInfo['user_id'];
$userToString .= $userInfo['firstname'].' '.$userInfo['lastname'].'<br />';
}
if (!empty($sessionsDestination)) {
foreach ($sessionsDestination as $sessionDestinationId) {
$sessionDestinationInfo = self::fetch($sessionDestinationId);
$messages[] = Display::return_message(
sprintf(
get_lang(
'AddingStudentsFromSessionXToSessionY'
),
$sessionInfo['title'],
$sessionDestinationInfo['title']
),
'info',
false
);
if ($sessionId == $sessionDestinationId) {
$messages[] = Display::return_message(
sprintf(
get_lang('Session %s skipped'),
$sessionDestinationId
),
'warning',
false
);
continue;
}
$messages[] = Display::return_message(get_lang('Learners list').'<br />'.$userToString, 'info', false);
self::subscribeUsersToSession(
$sessionDestinationId,
$newUserList,
SESSION_VISIBLE_READ_ONLY,
false
);
}
} else {
$messages[] = Display::return_message(get_lang('No destination session provided'), 'warning');
}
} else {
$messages[] = Display::return_message(
get_lang('No student found for the session').' #'.$sessionInfo['title'],
'warning'
);
}
}
} else {
$messages[] = Display::return_message(get_lang('No data available'), 'warning');
}
return $messages;
}
/**
* Assign coaches of a session(s) as teachers to a given course (or courses).
*
* @param array A list of session IDs
* @param array A list of course IDs
*
* @return string
*/
public static function copyCoachesFromSessionToCourse($sessions, $courses)
{
$coachesPerSession = [];
foreach ($sessions as $sessionId) {
$coaches = self::getCoachesBySession($sessionId);
$coachesPerSession[$sessionId] = $coaches;
}
$result = [];
if (!empty($courses)) {
foreach ($courses as $courseId) {
$courseInfo = api_get_course_info_by_id($courseId);
foreach ($coachesPerSession as $sessionId => $coachList) {
CourseManager::updateTeachers(
$courseInfo,
$coachList,
false,
false,
false
);
$result[$courseInfo['code']][$sessionId] = $coachList;
}
}
}
$sessionUrl = api_get_path(WEB_CODE_PATH).'session/resume_session.php?id_session=';
$htmlResult = null;
if (!empty($result)) {
foreach ($result as $courseCode => $data) {
$url = api_get_course_url($courseCode);
$htmlResult .= sprintf(
get_lang('Coaches subscribed as teachers in course %s'),
Display::url($courseCode, $url, ['target' => '_blank'])
);
foreach ($data as $sessionId => $coachList) {
$sessionInfo = self::fetch($sessionId);
$htmlResult .= '<br />';
$htmlResult .= Display::url(
get_lang('Session').': '.$sessionInfo['title'].' <br />',
$sessionUrl.$sessionId,
['target' => '_blank']
);
$teacherList = [];
foreach ($coachList as $coachId) {
$userInfo = api_get_user_info($coachId);
$teacherList[] = $userInfo['complete_name'];
}
if (!empty($teacherList)) {
$htmlResult .= implode(', ', $teacherList);
} else {
$htmlResult .= get_lang('Nothing to add');
}
}
$htmlResult .= '<br />';
}
$htmlResult = Display::return_message($htmlResult, 'normal', false);
}
return $htmlResult;
}
/**
* @param string $keyword
* @param string $active
* @param string $lastConnectionDate
* @param array $sessionIdList
* @param array $studentIdList
* @param int $filterUserStatus STUDENT|COURSEMANAGER constants
*
* @return array|int
*/
public static function getCountUserTracking(
$keyword = null,
$active = null,
$lastConnectionDate = null,
$sessionIdList = [],
$studentIdList = [],
$filterUserStatus = null
) {
$userId = api_get_user_id();
$drhLoaded = false;
if (api_is_drh()) {
if (api_drh_can_access_all_session_content()) {
$count = self::getAllUsersFromCoursesFromAllSessionFromStatus(
'drh_all',
$userId,
true,
null,
null,
null,
null,
$keyword,
$active,
$lastConnectionDate,
$sessionIdList,
$studentIdList,
$filterUserStatus
);
$drhLoaded = true;
}
}
if (false == $drhLoaded) {
$count = UserManager::getUsersFollowedByUser(
$userId,
$filterUserStatus,
false,
false,
true,
null,
null,
null,
null,
$active,
$lastConnectionDate,
api_is_student_boss() ? STUDENT_BOSS : COURSEMANAGER,
$keyword
);
}
return $count;
}
/**
* Get teachers followed by a user.
*
* @param int $userId
* @param int $active
* @param string $lastConnectionDate
* @param bool $getCount
* @param array $sessionIdList
*
* @return array|int
*/
public static function getTeacherTracking(
$userId,
$active = 1,
$lastConnectionDate = null,
$getCount = false,
$sessionIdList = []
) {
$teacherListId = [];
if (api_is_drh() || api_is_platform_admin()) {
// Followed teachers by drh
if (api_drh_can_access_all_session_content()) {
if (empty($sessionIdList)) {
$sessions = self::get_sessions_followed_by_drh($userId);
$sessionIdList = [];
foreach ($sessions as $session) {
$sessionIdList[] = $session['id'];
}
}
$sessionIdList = array_map('intval', $sessionIdList);
$sessionToString = implode("', '", $sessionIdList);
$course = Database::get_main_table(TABLE_MAIN_COURSE);
$sessionCourse = Database::get_main_table(TABLE_MAIN_SESSION_COURSE);
$courseUser = Database::get_main_table(TABLE_MAIN_COURSE_USER);
// Select the teachers.
$sql = "SELECT DISTINCT(cu.user_id)
FROM $course c
INNER JOIN $sessionCourse src
ON c.id = src.c_id
INNER JOIN $courseUser cu
ON (cu.c_id = c.id)
WHERE src.session_id IN ('$sessionToString') AND cu.status = 1";
$result = Database::query($sql);
while ($row = Database::fetch_array($result, 'ASSOC')) {
$teacherListId[$row['user_id']] = $row['user_id'];
}
} else {
$teacherResult = UserManager::get_users_followed_by_drh($userId, COURSEMANAGER);
foreach ($teacherResult as $userInfo) {
$teacherListId[] = $userInfo['user_id'];
}
}
}
if (!empty($teacherListId)) {
$tableUser = Database::get_main_table(TABLE_MAIN_USER);
$select = "SELECT DISTINCT u.* ";
if ($getCount) {
$select = "SELECT count(DISTINCT(u.id)) as count";
}
$sql = "$select FROM $tableUser u";
if (!empty($lastConnectionDate)) {
$tableLogin = Database::get_main_table(TABLE_STATISTIC_TRACK_E_LOGIN);
//$sql .= " INNER JOIN $tableLogin l ON (l.login_user_id = u.user_id) ";
}
$active = intval($active);
$teacherListId = implode("','", $teacherListId);
$where = " WHERE u.active = $active AND u.id IN ('$teacherListId') ";
if (!empty($lastConnectionDate)) {
$lastConnectionDate = Database::escape_string($lastConnectionDate);
//$where .= " AND l.login_date <= '$lastConnectionDate' ";
}
$sql .= $where;
$result = Database::query($sql);
if (Database::num_rows($result)) {
if ($getCount) {
$row = Database::fetch_array($result);
return $row['count'];
} else {
return Database::store_result($result, 'ASSOC');
}
}
}
return 0;
}
/**
* Get the list of course tools that have to be dealt with in case of
* registering any course to a session.
*
* @return array The list of tools to be dealt with (literal names)
*/
public static function getCourseToolToBeManaged()
{
return [
'courseDescription',
'courseIntroduction',
];
}
/**
* Calls the methods bound to each tool when a course is registered into a session.
*
* @param int $sessionId
* @param int $courseId
*
* @return bool
*/
public static function installCourse($sessionId, $courseId)
{
return true;
$toolList = self::getCourseToolToBeManaged();
foreach ($toolList as $tool) {
$method = 'add'.$tool;
if (method_exists(get_class(), $method)) {
self::$method($sessionId, $courseId);
}
}
}
/**
* Calls the methods bound to each tool when a course is unregistered from
* a session.
*
* @param int $sessionId
* @param int $courseId
*/
public static function unInstallCourse($sessionId, $courseId)
{
return true;
$toolList = self::getCourseToolToBeManaged();
foreach ($toolList as $tool) {
$method = 'remove'.$tool;
if (method_exists(get_class(), $method)) {
self::$method($sessionId, $courseId);
}
}
}
/**
* @param array $userSessionList format see self::importSessionDrhCSV()
* @param bool $sendEmail
* @param bool $removeOldRelationShips
*/
public static function subscribeDrhToSessionList(
$userSessionList,
$sendEmail,
$removeOldRelationShips
) {
if (!empty($userSessionList)) {
foreach ($userSessionList as $userId => $data) {
$sessionList = [];
foreach ($data['session_list'] as $sessionInfo) {
$sessionList[] = $sessionInfo['session_id'];
}
$userInfo = $data['user_info'];
self::subscribeSessionsToDrh(
$userInfo,
$sessionList,
$sendEmail,
$removeOldRelationShips
);
}
}
}
/**
* @param array $userSessionList format see self::importSessionDrhCSV()
*
* @return string
*/
public static function checkSubscribeDrhToSessionList($userSessionList)
{
$message = null;
if (!empty($userSessionList)) {
if (!empty($userSessionList)) {
foreach ($userSessionList as $userId => $data) {
$userInfo = $data['user_info'];
$sessionListSubscribed = self::get_sessions_followed_by_drh($userId);
if (!empty($sessionListSubscribed)) {
$sessionListSubscribed = array_keys($sessionListSubscribed);
}
$sessionList = [];
if (!empty($data['session_list'])) {
foreach ($data['session_list'] as $sessionInfo) {
if (in_array($sessionInfo['session_id'], $sessionListSubscribed)) {
$sessionList[] = $sessionInfo['session_info']['title'];
}
}
}
$message .= '<strong>'.get_lang('User').'</strong>: ';
$message .= $userInfo['complete_name_with_username'].' <br />';
if (!in_array($userInfo['status'], [DRH]) && !api_is_platform_admin_by_id($userInfo['user_id'])) {
$message .= get_lang('Users must have the HR director role').'<br />';
continue;
}
if (!empty($sessionList)) {
$message .= '<strong>'.get_lang('Course sessions').':</strong> <br />';
$message .= implode(', ', $sessionList).'<br /><br />';
} else {
$message .= get_lang('No session provided').' <br /><br />';
}
}
}
}
return $message;
}
/**
* @param string $file
* @param bool $sendEmail
* @param bool $removeOldRelationShips
*
* @return string
*/
public static function importSessionDrhCSV($file, $sendEmail, $removeOldRelationShips)
{
$list = Import::csv_reader($file);
if (!empty($list)) {
$userSessionList = [];
foreach ($list as $data) {
$sessionInfo = [];
if (isset($data['SessionId'])) {
$sessionInfo = api_get_session_info($data['SessionId']);
}
if (isset($data['SessionName']) && empty($sessionInfo)) {
$sessionInfo = self::get_session_by_name($data['SessionName']);
}
if (empty($sessionInfo)) {
$sessionData = isset($data['SessionName']) ? $data['SessionName'] : $data['SessionId'];
Display::addFlash(
Display::return_message(get_lang('SessionNotFound').' - '.$sessionData, 'warning')
);
continue;
}
$userList = explode(',', $data['Username']);
foreach ($userList as $username) {
$userInfo = api_get_user_info_from_username($username);
if (empty($userInfo)) {
Display::addFlash(
Display::return_message(get_lang('UserDoesNotExist').' - '.$username, 'warning')
);
continue;
}
if (!empty($userInfo) && !empty($sessionInfo)) {
$userSessionList[$userInfo['user_id']]['session_list'][] = [
'session_id' => $sessionInfo['id'],
'session_info' => $sessionInfo,
];
$userSessionList[$userInfo['user_id']]['user_info'] = $userInfo;
}
}
}
self::subscribeDrhToSessionList($userSessionList, $sendEmail, $removeOldRelationShips);
return self::checkSubscribeDrhToSessionList($userSessionList);
}
}
/**
* Courses re-ordering in resume_session.php flag see BT#8316.
*/
public static function orderCourseIsEnabled()
{
$sessionCourseOrder = api_get_setting('session_course_ordering');
if ('true' === $sessionCourseOrder) {
return true;
}
return false;
}
/**
* @param string $direction (up/down)
* @param int $sessionId
* @param int $courseId
*
* @return bool
*/
public static function move($direction, $sessionId, $courseId)
{
if (!self::orderCourseIsEnabled()) {
return false;
}
$sessionId = intval($sessionId);
$courseId = intval($courseId);
$table = Database::get_main_table(TABLE_MAIN_SESSION_COURSE);
$courseList = self::get_course_list_by_session_id($sessionId, null, 'position');
$position = [];
$count = 0;
foreach ($courseList as $course) {
if ('' == $course['position']) {
$course['position'] = $count;
}
$position[$course['code']] = $course['position'];
// Saving current order.
$sql = "UPDATE $table SET position = $count
WHERE session_id = $sessionId AND c_id = '".$course['real_id']."'";
Database::query($sql);
$count++;
}
// Loading new positions.
$courseList = self::get_course_list_by_session_id($sessionId, null, 'position');
$found = false;
switch ($direction) {
case 'up':
$courseList = array_reverse($courseList);
break;
case 'down':
break;
}
foreach ($courseList as $course) {
if ($found) {
$nextId = $course['real_id'];
$nextOrder = $course['position'];
break;
}
if ($courseId == $course['real_id']) {
$thisCourseCode = $course['real_id'];
$thisOrder = $course['position'];
$found = true;
}
}
$sql1 = "UPDATE $table SET position = '".intval($nextOrder)."'
WHERE session_id = $sessionId AND c_id = $thisCourseCode";
Database::query($sql1);
$sql2 = "UPDATE $table SET position = '".intval($thisOrder)."'
WHERE session_id = $sessionId AND c_id = $nextId";
Database::query($sql2);
return true;
}
/**
* @param int $sessionId
* @param int $courseId
*
* @return bool
*/
public static function moveUp($sessionId, $courseId)
{
return self::move('up', $sessionId, $courseId);
}
/**
* @param int $sessionId
* @param string $courseCode
*
* @return bool
*/
public static function moveDown($sessionId, $courseCode)
{
return self::move('down', $sessionId, $courseCode);
}
/**
* Use the session duration to allow/block user access see BT#8317
* Needs these DB changes
* ALTER TABLE session ADD COLUMN duration int;
* ALTER TABLE session_rel_user ADD COLUMN duration int;.
*/
public static function durationPerUserIsEnabled()
{
return api_get_configuration_value('session_duration_feature');
}
/**
* Returns the number of days the student has left in a session when using
* sessions durations.
*
* @param int $userId
*
* @return int
*/
public static function getDayLeftInSession(array $sessionInfo, $userId)
{
$sessionId = $sessionInfo['id'];
$subscription = self::getUserSession($userId, $sessionId);
$duration = empty($subscription['duration'])
? $sessionInfo['duration']
: $sessionInfo['duration'] + $subscription['duration'];
// Get an array with the details of the first access of the student to
// this session
$courseAccess = CourseManager::getFirstCourseAccessPerSessionAndUser(
$sessionId,
$userId
);
$currentTime = time();
// If no previous access, return false
if (0 == count($courseAccess)) {
return $duration;
}
$firstAccess = api_strtotime($courseAccess['login_course_date'], 'UTC');
$endDateInSeconds = $firstAccess + $duration * 24 * 60 * 60;
$leftDays = round(($endDateInSeconds - $currentTime) / 60 / 60 / 24);
return $leftDays;
}
/**
* @param int $duration
* @param int $userId
* @param int $sessionId
*
* @return bool
*/
public static function editUserSessionDuration($duration, $userId, $sessionId)
{
$duration = (int) $duration;
$userId = (int) $userId;
$sessionId = (int) $sessionId;
if (empty($userId) || empty($sessionId)) {
return false;
}
$table = Database::get_main_table(TABLE_MAIN_SESSION_USER);
$parameters = ['duration' => $duration];
$where = ['session_id = ? AND user_id = ? ' => [$sessionId, $userId]];
Database::update($table, $parameters, $where);
return true;
}
/**
* Gets one row from the session_rel_user table.
*
* @param int $userId
* @param int $sessionId
*
* @return array
*/
public static function getUserSession($userId, $sessionId)
{
$userId = (int) $userId;
$sessionId = (int) $sessionId;
if (empty($userId) || empty($sessionId)) {
return false;
}
$table = Database::get_main_table(TABLE_MAIN_SESSION_USER);
$sql = "SELECT * FROM $table
WHERE session_id = $sessionId AND user_id = $userId";
$result = Database::query($sql);
$values = [];
if (Database::num_rows($result)) {
$values = Database::fetch_array($result, 'ASSOC');
}
return $values;
}
/**
* Check if user is subscribed inside a session as student.
*
* @param int $sessionId The session id
* @param int $userId The user id
*
* @return bool Whether is subscribed
*/
public static function isUserSubscribedAsStudent($sessionId, $userId)
{
$sessionRelUserTable = Database::get_main_table(TABLE_MAIN_SESSION_USER);
$sessionId = (int) $sessionId;
$userId = (int) $userId;
// COUNT(1) actually returns the number of rows from the table (as if
// counting the results from the first column)
$sql = "SELECT COUNT(1) AS qty FROM $sessionRelUserTable
WHERE
session_id = $sessionId AND
user_id = $userId AND
relation_type = ".Session::STUDENT;
$result = Database::fetch_assoc(Database::query($sql));
if (!empty($result) && $result['qty'] > 0) {
return true;
}
return false;
}
/**
* Check if user is subscribed inside a session as a HRM.
*
* @param int $sessionId The session id
* @param int $userId The user id
*
* @return bool Whether is subscribed
*/
public static function isUserSubscribedAsHRM($sessionId, $userId)
{
$sessionRelUserTable = Database::get_main_table(TABLE_MAIN_SESSION_USER);
$sessionId = (int) $sessionId;
$userId = (int) $userId;
// COUNT(1) actually returns the number of rows from the table (as if
// counting the results from the first column)
$sql = "SELECT COUNT(1) AS qty FROM $sessionRelUserTable
WHERE
session_id = $sessionId AND
user_id = $userId AND
relation_type = ".Session::DRH;
$result = Database::fetch_assoc(Database::query($sql));
if (!empty($result) && $result['qty'] > 0) {
return true;
}
return false;
}
/**
* Get the session coached by a user (general coach and course-session coach).
*
* @param int $coachId The coach id
* @param bool $checkSessionRelUserVisibility Check the session visibility
* @param bool $asPlatformAdmin The user is a platform admin and we want all sessions
*
* @return array The session list
*/
public static function getSessionsCoachedByUser(
$coachId,
$checkSessionRelUserVisibility = false,
$asPlatformAdmin = false
) {
// Get all sessions where $coachId is the general coach
$sessions = self::get_sessions_by_general_coach($coachId, $asPlatformAdmin);
// Get all sessions where $coachId is the course - session coach
$courseSessionList = self::getCoursesListByCourseCoach($coachId);
$sessionsByCoach = [];
if (!empty($courseSessionList)) {
foreach ($courseSessionList as $userCourseSubscription) {
$session = $userCourseSubscription->getSession();
$sessionsByCoach[$session->getId()] = api_get_session_info(
$session->getId()
);
}
}
if (!empty($sessionsByCoach)) {
$sessions = array_merge($sessions, $sessionsByCoach);
}
// Remove repeated sessions
if (!empty($sessions)) {
$cleanSessions = [];
foreach ($sessions as $session) {
$cleanSessions[$session['id']] = $session;
}
$sessions = $cleanSessions;
}
if ($checkSessionRelUserVisibility) {
if (!empty($sessions)) {
$newSessions = [];
foreach ($sessions as $session) {
$visibility = api_get_session_visibility($session['id']);
if (SESSION_INVISIBLE == $visibility) {
continue;
}
$newSessions[] = $session;
}
$sessions = $newSessions;
}
}
return $sessions;
}
/**
* Check if the course belongs to the session.
*
* @param int $sessionId The session id
* @param string $courseCode The course code
*
* @return bool
*/
public static function sessionHasCourse($sessionId, $courseCode)
{
$sessionId = (int) $sessionId;
$courseCode = Database::escape_string($courseCode);
$courseTable = Database::get_main_table(TABLE_MAIN_COURSE);
$sessionRelCourseTable = Database::get_main_table(TABLE_MAIN_SESSION_COURSE);
$sql = "SELECT COUNT(1) AS qty
FROM $courseTable c
INNER JOIN $sessionRelCourseTable src
ON c.id = src.c_id
WHERE src.session_id = $sessionId
AND c.code = '$courseCode' ";
$result = Database::query($sql);
if (false !== $result) {
$data = Database::fetch_assoc($result);
if ($data['qty'] > 0) {
return true;
}
}
return false;
}
/**
* Calculate the total user time in the platform.
*
* @param int $userId The user id
* @param string $from Optional. From date
* @param string $until Optional. Until date
*
* @return string The time (hh:mm:ss)
*/
public static function getTotalUserTimeInPlatform($userId, $from = '', $until = '')
{
$userId = (int) $userId;
$trackLoginTable = Database::get_main_table(TABLE_STATISTIC_TRACK_E_LOGIN);
$whereConditions = [
'login_user_id = ? ' => $userId,
];
if (!empty($from) && !empty($until)) {
$whereConditions["AND (login_date >= '?' "] = $from;
$whereConditions["AND logout_date <= DATE_ADD('?', INTERVAL 1 DAY)) "] = $until;
}
$trackResult = Database::select(
'SEC_TO_TIME(SUM(UNIX_TIMESTAMP(logout_date) - UNIX_TIMESTAMP(login_date))) as total_time',
$trackLoginTable,
[
'where' => $whereConditions,
],
'first'
);
if (false != $trackResult) {
return $trackResult['total_time'] ? $trackResult['total_time'] : '00:00:00';
}
return '00:00:00';
}
/**
* Get the courses list by a course coach.
*
* @param int $coachId The coach id
*
* @return array (id, user_id, session_id, c_id, visibility, status, legal_agreement)
*/
public static function getCoursesListByCourseCoach($coachId)
{
$entityManager = Database::getManager();
$repo = $entityManager->getRepository(SessionRelCourseRelUser::class);
return $repo->findBy([
'user' => $coachId,
'status' => Session::COURSE_COACH,
]);
}
/**
* Get the count of user courses in session.
*
* @param int $sessionId
* @param int $courseId
*
* @return array
*/
public static function getTotalUserCoursesInSession($sessionId, $courseId = 0)
{
$tableUser = Database::get_main_table(TABLE_MAIN_USER);
$table = Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER);
$sessionId = (int) $sessionId;
if (empty($sessionId)) {
return [];
}
$courseCondition = '';
if (!empty($courseId)) {
$courseId = (int) $courseId;
$courseCondition = " c_id = $courseId AND ";
}
$sql = "SELECT
COUNT(u.id) as count,
u.id,
scu.status status_in_session,
u.status user_status
FROM $table scu
INNER JOIN $tableUser u
ON scu.user_id = u.id
WHERE
$courseCondition
scu.session_id = ".$sessionId."
GROUP BY u.id";
$result = Database::query($sql);
$list = [];
while ($data = Database::fetch_assoc($result)) {
$list[] = $data;
}
return $list;
}
/**
* Returns list of a few data from session (name, short description, start
* date, end date) and the given extra fields if defined based on a
* session category Id.
*
* @param int $categoryId The internal ID of the session category
* @param string $target Value to search for in the session field values
* @param array $extraFields A list of fields to be scanned and returned
*
* @return mixed
*/
public static function getShortSessionListAndExtraByCategory(
$categoryId,
$target,
$extraFields = null,
$publicationDate = null
) {
$categoryId = (int) $categoryId;
$sessionList = [];
// Check if categoryId is valid
if ($categoryId > 0) {
$target = Database::escape_string($target);
$sTable = Database::get_main_table(TABLE_MAIN_SESSION);
$sfTable = Database::get_main_table(TABLE_EXTRA_FIELD);
$sfvTable = Database::get_main_table(TABLE_EXTRA_FIELD_VALUES);
// Join session field and session field values tables
$joinTable = $sfTable.' sf INNER JOIN '.$sfvTable.' sfv ON sf.id = sfv.field_id';
$fieldsArray = [];
foreach ($extraFields as $field) {
$fieldsArray[] = Database::escape_string($field);
}
$extraFieldType = ExtraField::SESSION_FIELD_TYPE;
if (isset($publicationDate)) {
$publicationDateString = $publicationDate->format('Y-m-d H:i:s');
$wherePublication = " AND id NOT IN (
SELECT sfv.item_id FROM $joinTable
WHERE
sf.item_type = $extraFieldType AND
((sf.variable = 'publication_start_date' AND sfv.field_value > '$publicationDateString' and sfv.field_value != '') OR
(sf.variable = 'publication_end_date' AND sfv.field_value < '$publicationDateString' and sfv.field_value != ''))
)";
}
// Get the session list from session category and target
$sessionList = Database::select(
'id, title, access_start_date, access_end_date',
$sTable,
[
'where' => [
"session_category_id = ? AND id IN (
SELECT sfv.item_id FROM $joinTable
WHERE
sf.item_type = $extraFieldType AND
sfv.item_id = session.id AND
sf.variable = 'target' AND
sfv.field_value = ?
) $wherePublication" => [$categoryId, $target],
],
]
);
$whereFieldVariables = [];
$whereFieldIds = [];
if (
is_array($fieldsArray) &&
count($fieldsArray) > 0
) {
$whereParams = '?';
for ($i = 1; $i < count($fieldsArray); $i++) {
$whereParams .= ', ?';
}
$whereFieldVariables = ' variable IN ( '.$whereParams.' )';
$whereFieldIds = 'field_id IN ( '.$whereParams.' )';
}
// Get session fields
$extraField = new ExtraFieldModel('session');
$questionMarks = substr(str_repeat('?, ', count($fieldsArray)), 0, -2);
$fieldsList = $extraField->get_all([
' variable IN ( '.$questionMarks.' )' => $fieldsArray,
]);
// Index session fields
foreach ($fieldsList as $field) {
$fields[$field['id']] = $field['variable'];
}
// Get session field values
$extra = new ExtraFieldValue('session');
$questionMarksFields = substr(str_repeat('?, ', count($fields)), 0, -2);
$sessionFieldValueList = $extra->get_all(['where' => ['field_id IN ( '.$questionMarksFields.' )' => array_keys($fields)]]);
// Add session fields values to session list
foreach ($sessionList as $id => &$session) {
foreach ($sessionFieldValueList as $sessionFieldValue) {
// Match session field values to session
if ($sessionFieldValue['item_id'] == $id) {
// Check if session field value is set in session field list
if (isset($fields[$sessionFieldValue['field_id']])) {
// Avoid overwriting the session's ID field
if ('id' != $fields[$sessionFieldValue['field_id']]) {
$var = $fields[$sessionFieldValue['field_id']];
$val = $sessionFieldValue['value'];
// Assign session field value to session
$session[$var] = $val;
}
}
}
}
}
}
return $sessionList;
}
/**
* Return the Session Category id searched by name.
*
* @param string $categoryName Name attribute of session category used for search query
* @param bool $force boolean used to get even if something is wrong (e.g not unique name)
*
* @return int|array If success, return category id (int), else it will return an array
* with the next structure:
* array('error' => true, 'errorMessage' => ERROR_MESSAGE)
*/
public static function getSessionCategoryIdByName($categoryName, $force = false)
{
// Start error result
$errorResult = ['error' => true, 'errorMessage' => get_lang('There was an error.')];
$categoryName = Database::escape_string($categoryName);
// Check if is not empty category name
if (!empty($categoryName)) {
$sessionCategoryTable = Database::get_main_table(TABLE_MAIN_SESSION_CATEGORY);
// Get all session category with same name
$result = Database::select(
'id',
$sessionCategoryTable,
[
'where' => [
'title = ?' => $categoryName,
],
]
);
// Check the result
if ($result < 1) {
// If not found any result, update error message
$errorResult['errorMessage'] = 'Not found any session category name '.$categoryName;
} elseif (count($result) > 1 && !$force) {
// If found more than one result and force is disabled, update error message
$errorResult['errorMessage'] = 'Found many session categories';
} elseif (1 == count($result) || $force) {
// If found just one session category or force option is enabled
return key($result);
}
} else {
// category name is empty, update error message
$errorResult['errorMessage'] = 'Not valid category name';
}
return $errorResult;
}
/**
* Return all data from sessions (plus extra field, course and coach data) by category id.
*
* @param int $sessionCategoryId session category id used to search sessions
*
* @return array If success, return session list and more session related data, else it will return an array
* with the next structure:
* array('error' => true, 'errorMessage' => ERROR_MESSAGE)
*/
public static function getSessionListAndExtraByCategoryId($sessionCategoryId)
{
// Start error result
$errorResult = [
'error' => true,
'errorMessage' => get_lang('There was an error.'),
];
$sessionCategoryId = intval($sessionCategoryId);
// Check if session category id is valid
if ($sessionCategoryId > 0) {
// Get table names
$sessionTable = Database::get_main_table(TABLE_MAIN_SESSION);
$sessionFieldTable = Database::get_main_table(TABLE_EXTRA_FIELD);
$sessionFieldValueTable = Database::get_main_table(TABLE_EXTRA_FIELD_VALUES);
$sessionCourseUserTable = Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER);
$userTable = Database::get_main_table(TABLE_MAIN_USER);
$courseTable = Database::get_main_table(TABLE_MAIN_COURSE);
// Get all data from all sessions whit the session category specified
$sessionList = Database::select(
'*',
$sessionTable,
[
'where' => [
'session_category_id = ?' => $sessionCategoryId,
],
]
);
$extraFieldType = ExtraField::SESSION_FIELD_TYPE;
// Check if session list query had result
if (!empty($sessionList)) {
// implode all session id
$sessionIdsString = '('.implode(', ', array_keys($sessionList)).')';
// Get all field variables
$sessionFieldList = Database::select(
'id, variable',
$sessionFieldTable,
['item_type = ? ' => [$extraFieldType]]
);
// Get all field values
$sql = "SELECT item_id, field_id, value FROM
$sessionFieldValueTable v INNER JOIN $sessionFieldTable f
ON (f.id = v.field_id)
WHERE
item_id IN $sessionIdsString AND
item_type = $extraFieldType
";
$result = Database::query($sql);
$sessionFieldValueList = Database::store_result($result, 'ASSOC');
// Check if session field values had result
if (!empty($sessionFieldValueList)) {
$sessionFieldValueListBySession = [];
foreach ($sessionFieldValueList as $key => $sessionFieldValue) {
// Create an array to index ids to session id
$sessionFieldValueListBySession[$sessionFieldValue['item_id']][] = $key;
}
}
// Query used to find course-coaches from sessions
$sql = "SELECT
scu.session_id,
c.id AS course_id,
c.code AS course_code,
c.title AS course_title,
u.username AS coach_username,
u.firstname AS coach_firstname,
u.lastname AS coach_lastname
FROM $courseTable c
INNER JOIN $sessionCourseUserTable scu ON c.id = scu.c_id
INNER JOIN $userTable u ON scu.user_id = u.id
WHERE scu.status = ".Session::COURSE_COACH." AND scu.session_id IN $sessionIdsString
ORDER BY scu.session_id ASC ";
$res = Database::query($sql);
$sessionCourseList = Database::store_result($res, 'ASSOC');
// Check if course list had result
if (!empty($sessionCourseList)) {
foreach ($sessionCourseList as $key => $sessionCourse) {
// Create an array to index ids to session_id
$sessionCourseListBySession[$sessionCourse['session_id']][] = $key;
}
}
// Join lists
if (is_array($sessionList)) {
foreach ($sessionList as $id => &$row) {
if (
!empty($sessionFieldValueListBySession) &&
is_array($sessionFieldValueListBySession[$id])
) {
// If have an index array for session extra fields, use it to join arrays
foreach ($sessionFieldValueListBySession[$id] as $key) {
$row['extra'][$key] = [
'field_name' => $sessionFieldList[$sessionFieldValueList[$key]['field_id']]['variable'],
'value' => $sessionFieldValueList[$key]['value'],
];
}
}
if (
!empty($sessionCourseListBySession) &&
is_array($sessionCourseListBySession[$id])
) {
// If have an index array for session course coach, use it to join arrays
foreach ($sessionCourseListBySession[$id] as $key) {
$row['course'][$key] = [
'course_id' => $sessionCourseList[$key]['course_id'],
'course_code' => $sessionCourseList[$key]['course_code'],
'course_title' => $sessionCourseList[$key]['course_title'],
'coach_username' => $sessionCourseList[$key]['coach_username'],
'coach_firstname' => $sessionCourseList[$key]['coach_firstname'],
'coach_lastname' => $sessionCourseList[$key]['coach_lastname'],
];
}
}
}
}
return $sessionList;
} else {
// Not found result, update error message
$errorResult['errorMessage'] = 'Not found any session for session category id '.$sessionCategoryId;
}
}
return $errorResult;
}
/**
* Return session description from session id.
*
* @param int $sessionId
*
* @return string
*/
public static function getDescriptionFromSessionId($sessionId)
{
// Init variables
$sessionId = (int) $sessionId;
$description = '';
// Check if session id is valid
if ($sessionId > 0) {
// Select query from session id
$rows = Database::select(
'description',
Database::get_main_table(TABLE_MAIN_SESSION),
[
'where' => [
'id = ?' => $sessionId,
],
]
);
// Check if select query result is not empty
if (!empty($rows)) {
// Get session description
$description = $rows[0]['description'];
}
}
return $description;
}
/**
* Get a session list filtered by name, description or any of the given extra fields.
*
* @param string $term The term to search
* @param array $extraFieldsToInclude Extra fields to include in the session data
*
* @return array The list
*/
public static function searchSession($term, $extraFieldsToInclude = [])
{
$sTable = Database::get_main_table(TABLE_MAIN_SESSION);
$extraFieldTable = Database::get_main_table(TABLE_EXTRA_FIELD);
$sfvTable = Database::get_main_table(TABLE_EXTRA_FIELD_VALUES);
$term = Database::escape_string($term);
$extraFieldType = ExtraField::SESSION_FIELD_TYPE;
if (is_array($extraFieldsToInclude) && count($extraFieldsToInclude) > 0) {
$resultData = Database::select('*', $sTable, [
'where' => [
"title LIKE %?% " => $term,
" OR description LIKE %?% " => $term,
" OR id IN (
SELECT item_id
FROM $sfvTable v INNER JOIN $extraFieldTable e
ON (v.field_id = e.id)
WHERE field_value LIKE %?% AND item_type = $extraFieldType
) " => $term,
],
]);
} else {
$resultData = Database::select('*', $sTable, [
'where' => [
"title LIKE %?% " => $term,
"OR description LIKE %?% " => $term,
],
]);
return $resultData;
}
foreach ($resultData as $id => &$session) {
$session['extra'] = self::getFilteredExtraFields($id, $extraFieldsToInclude);
}
return $resultData;
}
/**
* @param int $sessionId
* @param array $extraFieldsToInclude (empty means all)
*
* @return array
*/
public static function getFilteredExtraFields($sessionId, $extraFieldsToInclude = [])
{
$extraData = [];
$variables = [];
$variablePlaceHolders = [];
foreach ($extraFieldsToInclude as $sessionExtraField) {
$variablePlaceHolders[] = "?";
$variables[] = Database::escape_string($sessionExtraField);
}
$sessionExtraField = new ExtraFieldModel('session');
$fieldList = $sessionExtraField->get_all(empty($extraFieldsToInclude) ? [] : [
"variable IN ( ".implode(", ", $variablePlaceHolders)." ) " => $variables,
]);
if (empty($fieldList)) {
return [];
}
$fields = [];
// Index session fields
foreach ($fieldList as $field) {
$fields[$field['id']] = $field['variable'];
}
// Get session field values
$extra = new ExtraFieldValue('session');
$sessionFieldValueList = [];
foreach (array_keys($fields) as $fieldId) {
$sessionFieldValue = $extra->get_values_by_handler_and_field_id($sessionId, $fieldId);
if (false != $sessionFieldValue) {
$sessionFieldValueList[$fieldId] = $sessionFieldValue;
}
}
foreach ($sessionFieldValueList as $sessionFieldValue) {
// Match session field values to session
if ($sessionFieldValue['item_id'] != $sessionId) {
continue;
}
// Check if session field value is set in session field list
if (!isset($fields[$sessionFieldValue['field_id']])) {
continue;
}
$extrafieldVariable = $fields[$sessionFieldValue['field_id']];
$extrafieldValue = $sessionFieldValue['value'];
$extraData[] = [
'variable' => $extrafieldVariable,
'value' => $extrafieldValue,
];
}
return $extraData;
}
/**
* @param int $sessionId
*
* @return bool
*/
public static function isValidId($sessionId)
{
$sessionId = (int) $sessionId;
if ($sessionId > 0) {
$rows = Database::select(
'id',
Database::get_main_table(TABLE_MAIN_SESSION),
['where' => ['id = ?' => $sessionId]]
);
if (!empty($rows)) {
return true;
}
}
return false;
}
/**
* Get list of sessions based on users of a group for a group admin.
*
* @param int $userId The user id
*
* @return array
*/
public static function getSessionsFollowedForGroupAdmin($userId)
{
$sessionList = [];
$sessionTable = Database::get_main_table(TABLE_MAIN_SESSION);
$sessionUserTable = Database::get_main_table(TABLE_MAIN_SESSION_USER);
$userGroup = new UserGroupModel();
$userIdList = $userGroup->getGroupUsersByUser($userId);
if (empty($userIdList)) {
return [];
}
$sql = "SELECT DISTINCT s.*
FROM $sessionTable s
INNER JOIN $sessionUserTable sru
ON s.id = sru.id_session
WHERE
(sru.id_user IN (".implode(', ', $userIdList).")
AND sru.relation_type = ".Session::STUDENT."
)";
if (api_is_multiple_url_enabled()) {
$sessionAccessUrlTable = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_SESSION);
$accessUrlId = api_get_current_access_url_id();
if (-1 != $accessUrlId) {
$sql = "SELECT DISTINCT s.*
FROM $sessionTable s
INNER JOIN $sessionUserTable sru ON s.id = sru.id_session
INNER JOIN $sessionAccessUrlTable srau ON s.id = srau.session_id
WHERE
srau.access_url_id = $accessUrlId
AND (
sru.id_user IN (".implode(', ', $userIdList).")
AND sru.relation_type = ".Session::STUDENT."
)";
}
}
$result = Database::query($sql);
while ($row = Database::fetch_assoc($result)) {
$sessionList[] = $row;
}
return $sessionList;
}
public static function getSessionVisibility(Session $session) : string
{
switch ($session->getVisibility()) {
case 1:
return get_lang('Read only');
case 2:
return get_lang('Visible');
case 3:
return api_ucfirst(get_lang('invisible'));
}
return '';
}
/**
* Returns a human readable string.
*
* @return array
*/
public static function parseSessionDates(Session $session, bool $showTime = false)
{
$displayDates = self::convertSessionDateToString(
$session->getDisplayStartDate(),
$session->getDisplayEndDate(),
$showTime,
true
);
$accessDates = self::convertSessionDateToString(
$session->getAccessStartDate(),
$session->getAccessEndDate(),
$showTime,
true
);
$coachDates = self::convertSessionDateToString(
$session->getCoachAccessStartDate(),
$session->getCoachAccessEndDate(),
$showTime,
true
);
return [
'access' => $accessDates,
'display' => $displayDates,
'coach' => $coachDates,
];
}
/**
* @throws Exception
*/
public static function setForm(FormValidator $form, Session $session = null, $fromSessionId = null): array
{
$categoriesList = self::get_all_session_category();
$categoriesOptions = [
'0' => get_lang('none'),
];
if (false != $categoriesList) {
foreach ($categoriesList as $categoryItem) {
$categoriesOptions[$categoryItem['id']] = $categoryItem['title'];
}
}
// Database Table Definitions
$tbl_user = Database::get_main_table(TABLE_MAIN_USER);
$form->addText(
'title',
get_lang('Session name'),
true,
['maxlength' => 150, 'aria-label' => get_lang('Session name')]
);
$form->addRule('title', get_lang('Session name already exists'), 'callback', 'check_session_name');
if (!api_is_platform_admin() && api_is_teacher()) {
$form->addSelectFromCollection(
'coach_username',
get_lang('Coach name'),
[api_get_user_entity()],
[
'id' => 'coach_username',
'style' => 'width:370px;',
'multiple' => true,
],
false,
'getFullname'
);
} else {
$sql = "SELECT COUNT(1) FROM $tbl_user WHERE status = 1";
$rs = Database::query($sql);
$countUsers = (int) Database::result($rs, 0, '0');
if ($countUsers < 1) {
$orderClause = 'ORDER BY ';
$orderClause .= api_sort_by_first_name() ? 'firstname, lastname, username' : 'lastname, firstname, username';
$sql = "SELECT id as user_id, lastname, firstname, username
FROM $tbl_user
WHERE status = '1' ".
$orderClause;
if (api_is_multiple_url_enabled()) {
$userRelAccessUrlTable = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_USER);
$accessUrlId = api_get_current_access_url_id();
if (-1 != $accessUrlId) {
$sql = "SELECT user.id as user_id, username, lastname, firstname
FROM $tbl_user user
INNER JOIN $userRelAccessUrlTable url_user
ON (url_user.user_id = user.id)
WHERE
access_url_id = $accessUrlId AND
status = 1 "
.$orderClause;
}
}
$result = Database::query($sql);
$coachesList = Database::store_result($result);
$coachesOptions = [];
foreach ($coachesList as $coachItem) {
$coachesOptions[$coachItem['user_id']] =
api_get_person_name($coachItem['firstname'], $coachItem['lastname']).' ('.$coachItem['username'].')';
}
$form->addSelect(
'coach_username',
get_lang('Coach name'),
$coachesOptions,
[
'id' => 'coach_username',
'style' => 'width:370px;',
'multiple' => true,
]
);
} else {
$coaches = [];
if ($session) {
foreach ($session->getGeneralCoaches() as $coach) {
$coaches[$coach->getId()] = $coach->getFullName();
}
}
$form->addSelectAjax(
'coach_username',
get_lang('Coach name'),
$coaches,
[
'url' => api_get_path(WEB_AJAX_PATH).'session.ajax.php?a=search_general_coach',
'width' => '100%',
'id' => 'coach_username',
'multiple' => true,
]
);
}
}
$form->addRule('coach_username', get_lang('Required field'), 'required');
$form->addHtml('<div id="ajax_list_coachs"></div>');
$form->addButtonAdvancedSettings('advanced_params');
$form->addElement('html', '<div id="advanced_params_options" style="'.(isset($fromSessionId) ? 'display:block' : 'display:none').'">');
if (null === $session) {
$form->addSelectAjax(
'session_template',
get_lang('Session template'),
[],
[
'url' => api_get_path(WEB_AJAX_PATH).'session.ajax.php?a=search_template_session',
'id' => 'system_template',
]
);
}
if (isset($fromSessionId)) {
$session = api_get_session_entity($fromSessionId);
}
$form->addSelect(
'session_category',
get_lang('Sessions categories'),
$categoriesOptions,
[
'id' => 'session_category',
]
);
if ('true' === api_get_setting('session.allow_session_status')) {
$statusList = self::getStatusList();
$form->addSelect(
'status',
get_lang('SessionStatus'),
$statusList,
[
'id' => 'status',
]
);
}
$form->addHtmlEditor(
'description',
get_lang('Description'),
false,
false,
[
'ToolbarSet' => 'Minimal',
]
);
$form->addElement('checkbox', 'show_description', null, get_lang('Show description'));
$visibilityGroup = [];
$visibilityGroup[] = $form->createElement(
'select',
'session_visibility',
null,
[
SESSION_VISIBLE_READ_ONLY => get_lang('Read only'),
SESSION_VISIBLE => get_lang('Accessible'),
SESSION_INVISIBLE => api_ucfirst(get_lang('Not accessible')),
],
[]
);
$form->addGroup(
$visibilityGroup,
'visibility_group',
get_lang('Visibility after end date'),
null,
false
);
$options = [
0 => get_lang('By duration'),
1 => get_lang('By dates'),
];
$form->addSelect('access', get_lang('Access'), $options, [
'onchange' => 'accessSwitcher(this.value)',
'id' => 'access',
]);
$form->addHtml('<div id="duration_div" style="display:none">');
$form->addElement(
'number',
'duration',
[
get_lang('Session duration'),
get_lang('The session duration allows you to set a number of days of access starting from the first access date of the user to the session. This way, you can set a session to last for 15 days instead of starting at a fixed date for all students.'),
],
[
'maxlength' => 50,
]
);
$form->addHtml('</div>');
$form->addHtml('<div id="date_fields" style="display:none">');
// Dates
$form->addDateTimePicker(
'access_start_date',
[get_lang('Access start date'), get_lang('Date on which the session is made available to all')],
['id' => 'access_start_date']
);
$form->addDateTimePicker(
'access_end_date',
[get_lang('Access end date'), get_lang('Date on which the session is closed')],
['id' => 'access_end_date']
);
$form->addRule(
['access_start_date', 'access_end_date'],
get_lang('Start date must be before the end date'),
'compare_datetime_text',
'< allow_empty'
);
$form->addDateTimePicker(
'display_start_date',
[
get_lang('Start date to display'),
get_lang('Date that will be shown in the session information as the date on which the session starts'),
],
['id' => 'display_start_date']
);
$form->addDateTimePicker(
'display_end_date',
[
get_lang('End date to display'),
get_lang('Date that will be shown in the session information as the date on which the session ends'),
],
['id' => 'display_end_date']
);
$form->addRule(
['display_start_date', 'display_end_date'],
get_lang('Start date must be before the end date'),
'compare_datetime_text',
'< allow_empty'
);
$form->addDateTimePicker(
'coach_access_start_date',
[
get_lang('Access start date for coaches'),
get_lang('Date on which the session is made available to coaches, so they can prepare it before the students get connected'),
],
['id' => 'coach_access_start_date']
);
$form->addDateTimePicker(
'coach_access_end_date',
[
get_lang('Access end date for coaches'),
get_lang('Date on which the session is closed to coaches. The additional delay will allow them to export all relevant tracking information'),
],
['id' => 'coach_access_end_date']
);
$form->addRule(
['coach_access_start_date', 'coach_access_end_date'],
get_lang('Start date must be before the end date'),
'compare_datetime_text',
'< allow_empty'
);
$form->addElement('html', '</div>');
$form->addCheckBox(
'send_subscription_notification',
get_lang('Send an email when a user being subscribed to session'),
);
// Picture
$form->addFile(
'picture',
get_lang('Add image'),
['id' => 'picture', 'class' => 'picture-form', 'crop_image' => true, 'crop_ratio' => '1 / 1']
);
$allowedPictureTypes = api_get_supported_image_extensions(false);
$form->addRule('picture', get_lang('Only PNG, JPG or GIF images allowed').' ('.implode(',', $allowedPictureTypes).')', 'filetype', $allowedPictureTypes);
if ($session && $session->getImage()) {
if (isset($fromSessionId)) {
$imageUrl = self::getSessionPictureUrl($session);
$form->addLabel(get_lang('Image'), "<img src = '$imageUrl' />");
$form->addHidden('image_session_template', $imageUrl);
} else {
$form->addElement('checkbox', 'delete_picture', null, get_lang('Delete picture'));
$imageUrl = self::getSessionPictureUrl($session);
$form->addLabel(get_lang('Image'), "<img src = '$imageUrl' />");
}
}
// Extra fields
$extra_field = new ExtraFieldModel('session');
$extra = $extra_field->addElements($form, $session ? $session->getId() : 0, ['image']);
$form->addElement('html', '</div>');
$js = $extra['jquery_ready_content'];
return ['js' => $js];
}
/**
* Saves the session picture.
*
* @param int $sessionId
* @param array $file
* @param string $crop
*
* @return false
*/
public static function updateSessionPicture(
$sessionId,
$file,
string $crop = ''
) {
if (empty($file)) {
return false;
}
$sessionRepo = Container::getSessionRepository();
$assetRepo = Container::getAssetRepository();
$asset = (new Asset())
->setCategory(Asset::SESSION)
->setTitle($file['name'])
;
if (!empty($crop)) {
$asset->setCrop($crop);
}
$asset = $assetRepo->createFromRequest($asset, $file);
/** @var Session $session */
$session = $sessionRepo->find($sessionId);
$session->setImage($asset);
$sessionRepo->update($session);
}
/**
* Deletes de session picture as asset.
*
* @param int $sessionId
*/
public static function deleteAsset(int $sessionId): void
{
$sessionRepo = Container::getSessionRepository();
/** @var Session $session */
$session = $sessionRepo->find($sessionId);
$em = Database::getManager();
if ($session->hasImage()) {
$asset = $session->getImage();
$em->remove($asset);
$em->flush();
}
}
/**
* Get the session picture url.
*
* @param Session $session
* @return string
*/
public static function getSessionPictureUrl(Session $session): string
{
$assetRepo = Container::getAssetRepository();
$imageUrl = $assetRepo->getAssetUrl($session->getImage());
return $imageUrl;
}
/**
* Gets the number of rows in the session table filtered through the given
* array of parameters.
*
* @param array Array of options/filters/keys
*
* @return int The number of rows, or false on wrong param
* @assert ('a') === false
*/
public static function get_count_admin_complete($options = [])
{
if (!is_array($options)) {
return false;
}
$tbl_session = Database::get_main_table(TABLE_MAIN_SESSION);
$tbl_session_category = Database::get_main_table(TABLE_MAIN_SESSION_CATEGORY);
$tbl_user = Database::get_main_table(TABLE_MAIN_USER);
$sessionCourseUserTable = Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER);
$courseTable = Database::get_main_table(TABLE_MAIN_COURSE);
$tbl_session_field_values = Database::get_main_table(TABLE_EXTRA_FIELD_VALUES);
$tbl_session_field_options = Database::get_main_table(TABLE_EXTRA_FIELD_OPTIONS);
$tblSessionRelUser = Database::get_main_table(TABLE_MAIN_SESSION_USER);
$where = 'WHERE 1 = 1 ';
if (api_is_session_admin() &&
'false' == api_get_setting('allow_session_admins_to_see_all_sessions')
) {
$user_id = api_get_user_id();
$where .= ' AND (sru.relation_type = '.Session::SESSION_ADMIN." AND sru.user_id = $user_id) ";
} else {
$where .= ' AND sru.relation_type = '.Session::GENERAL_COACH.' ';
}
$extraFieldTables = '';
if (!empty($options['where'])) {
$options['where'] = str_replace('course_title', 'c.title', $options['where']);
$options['where'] = str_replace("( session_active = '0' )", '1=1', $options['where']);
$options['where'] = str_replace(
["AND session_active = '1' )", " AND ( session_active = '1' )"],
[') GROUP BY s.title HAVING session_active = 1 ', " GROUP BY s.title HAVING session_active = 1 "],
$options['where']
);
$options['where'] = str_replace(
["AND session_active = '0' )", " AND ( session_active = '0' )"],
[') GROUP BY s.title HAVING session_active = 0 ', " GROUP BY s.title HAVING session_active = '0' "],
$options['where']
);
if (!empty($options['extra'])) {
$options['where'] = str_replace(' 1 = 1 AND', '', $options['where']);
$options['where'] = str_replace('AND', 'OR', $options['where']);
foreach ($options['extra'] as $extra) {
$options['where'] = str_replace(
$extra['field'],
'fv.field_id = '.$extra['id'].' AND fvo.option_value',
$options['where']
);
$extraFieldTables = "$tbl_session_field_values fv, $tbl_session_field_options fvo, ";
}
}
$where .= ' AND '.$options['where'];
}
$today = api_get_utc_datetime();
$query_rows = "SELECT count(*) as total_rows, c.title as course_title, s.title,
IF (
(s.access_start_date <= '$today' AND '$today' < s.access_end_date) OR
(s.access_start_date = '0000-00-00 00:00:00' AND s.access_end_date = '0000-00-00 00:00:00' ) OR
(s.access_start_date IS NULL AND s.access_end_date IS NULL) OR
(s.access_start_date <= '$today' AND ('0000-00-00 00:00:00' = s.access_end_date OR s.access_end_date IS NULL )) OR
('$today' < s.access_end_date AND ('0000-00-00 00:00:00' = s.access_start_date OR s.access_start_date IS NULL) )
, 1, 0) as session_active
FROM $extraFieldTables $tbl_session s
LEFT JOIN $tbl_session_category sc
ON s.session_category_id = sc.id
INNER JOIN $tblSessionRelUser sru
ON s.id = sru.session_id
INNER JOIN $tbl_user u
ON sru.user_id = u.id
INNER JOIN $sessionCourseUserTable scu
ON s.id = scu.session_id
INNER JOIN $courseTable c
ON c.id = scu.c_id
$where ";
if (api_is_multiple_url_enabled()) {
$table_access_url_rel_session = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_SESSION);
$access_url_id = api_get_current_access_url_id();
if (-1 != $access_url_id) {
$where .= " AND ar.access_url_id = $access_url_id ";
$query_rows = "SELECT count(*) as total_rows
FROM $tbl_session s
LEFT JOIN $tbl_session_category sc
ON s.session_category_id = sc.id
INNER JOIN $tblSessionRelUser sru ON s.id = sru.session_id
INNER JOIN $tbl_user u
ON sru.user_id = u.id
INNER JOIN $table_access_url_rel_session ar
ON ar.session_id = s.id $where ";
}
}
$result = Database::query($query_rows);
$num = 0;
if (Database::num_rows($result)) {
$rows = Database::fetch_array($result);
$num = $rows['total_rows'];
}
return $num;
}
/**
* @param string $listType
* @param array $extraFields
*
* @return array
*/
public static function getGridColumns(
$listType = 'all',
$extraFields = [],
$addExtraFields = true
) {
$showCount = ('true' === api_get_setting('session.session_list_show_count_users'));
// Column config
$operators = ['cn', 'nc'];
$date_operators = ['gt', 'ge', 'lt', 'le'];
switch ($listType) {
case 'my_space':
$columns = [
get_lang('Title'),
get_lang('Date'),
get_lang('Number of courses per session'),
get_lang('Number of learners by session'),
get_lang('Details'),
];
$columnModel = [
['name' => 'name', 'index' => 'name', 'align' => 'left'],
['name' => 'date', 'index' => 'access_start_date', 'align' => 'left'],
[
'name' => 'course_per_session',
'index' => 'course_per_session',
'sortable' => 'false',
'search' => 'false',
],
[
'name' => 'student_per_session',
'index' => 'student_per_session',
'sortable' => 'false',
'search' => 'false',
],
[
'name' => 'actions',
'index' => 'actions',
'sortable' => 'false',
'search' => 'false',
],
];
break;
case 'all':
case 'active':
case 'close':
$columns = [
'#',
get_lang('Name'),
get_lang('Category'),
get_lang('Start date to display'),
get_lang('End date to display'),
get_lang('Visibility'),
];
$columnModel = [
[
'name' => 'id',
'index' => 's.id',
'hidden' => 'true',
],
[
'name' => 'name',
'index' => 's.title',
'width' => '160',
'align' => 'left',
'search' => 'true',
'searchoptions' => ['sopt' => $operators],
],
[
'name' => 'category_name',
'index' => 'category_name',
'align' => 'left',
'search' => 'true',
'searchoptions' => ['sopt' => $operators],
],
[
'name' => 'display_start_date',
'index' => 'display_start_date',
'align' => 'left',
'search' => 'true',
'searchoptions' => [
'dataInit' => 'date_pick_today',
'sopt' => $date_operators,
],
],
[
'name' => 'display_end_date',
'index' => 'display_end_date',
'align' => 'left',
'search' => 'true',
'searchoptions' => [
'dataInit' => 'date_pick_one_month',
'sopt' => $date_operators,
],
],
[
'name' => 'visibility',
'index' => 'visibility',
'align' => 'left',
'search' => 'false',
],
];
if ($showCount) {
$columns[] = get_lang('Users');
$columnModel[] = [
'name' => 'users',
'index' => 'users',
'align' => 'left',
'search' => 'false',
];
// ofaj
$columns[] = get_lang('Teachers');
$columnModel[] = [
'name' => 'teachers',
'index' => 'teachers',
'align' => 'left',
'search' => 'false',
];
}
if ('true' === api_get_setting('session.allow_session_status')) {
$columns[] = get_lang('SessionStatus');
$list = self::getStatusList();
$listToString = '';
foreach ($list as $statusId => $status) {
$listToString .= $statusId.':'.$status.';';
}
$columnModel[] = [
'name' => 'status',
'index' => 'status',
'align' => 'left',
'search' => 'true',
'stype' => 'select',
// for the bottom bar
'searchoptions' => [
'defaultValue' => '1',
'value' => $listToString,
],
];
}
break;
case 'simple':
$columns = [
'#',
get_lang('Name'),
get_lang('Category'),
get_lang('Session Display Start Date'),
get_lang('Session Display End Date'),
get_lang('Visibility'),
];
$columnModel = [
[
'name' => 'id',
'index' => 's.id',
'hidden' => 'true',
],
[
'name' => 'name',
'index' => 's.title',
'width' => '160',
'align' => 'left',
'search' => 'true',
'searchoptions' => ['sopt' => $operators],
],
[
'name' => 'category_name',
'index' => 'category_name',
'align' => 'left',
'search' => 'true',
'searchoptions' => ['sopt' => $operators],
],
[
'name' => 'display_start_date',
'index' => 'display_start_date',
'align' => 'left',
'search' => 'true',
'searchoptions' => [
'dataInit' => 'date_pick_today',
'sopt' => $date_operators,
],
],
[
'name' => 'display_end_date',
'index' => 'display_end_date',
'align' => 'left',
'search' => 'true',
'searchoptions' => [
'dataInit' => 'date_pick_one_month',
'sopt' => $date_operators,
],
],
[
'name' => 'visibility',
'index' => 'visibility',
'align' => 'left',
'search' => 'false',
],
];
if ($showCount) {
$columns[] = get_lang('Users');
$columnModel[] = [
'name' => 'users',
'index' => 'users',
'align' => 'left',
'search' => 'false',
];
// ofaj
$columns[] = get_lang('Teachers');
$columnModel[] = [
'name' => 'teachers',
'index' => 'teachers',
'align' => 'left',
'search' => 'false',
];
}
if ('true' === api_get_setting('session.allow_session_status')) {
$columns[] = get_lang('SessionStatus');
$list = self::getStatusList();
$listToString = '';
foreach ($list as $statusId => $status) {
$listToString .= $statusId.':'.$status.';';
}
$columnModel[] = ['name' => 'status', 'index' => 'status', 'align' => 'left', 'search' => 'true', 'stype' => 'select',
// for the bottom bar
'searchoptions' => [
'defaultValue' => '1',
'value' => $listToString,
],
];
}
break;
case 'complete':
$columns = [
get_lang('Name'),
get_lang('Start date to display'),
get_lang('End date to display'),
get_lang('Coach'),
get_lang('Status'),
get_lang('Visibility'),
get_lang('Course title'),
];
$columnModel = [
[
'name' => 'name',
'index' => 's.title',
'width' => '200',
'align' => 'left',
'search' => 'true',
'searchoptions' => ['sopt' => $operators],
],
[
'name' => 'display_start_date',
'index' => 'display_start_date',
'align' => 'left',
'search' => 'true',
'searchoptions' => ['dataInit' => 'date_pick_today', 'sopt' => $date_operators],
],
[
'name' => 'display_end_date',
'index' => 'display_end_date',
'align' => 'left',
'search' => 'true',
'searchoptions' => ['dataInit' => 'date_pick_one_month', 'sopt' => $date_operators],
],
[
'name' => 'coach_name',
'index' => 'coach_name',
'align' => 'left',
'search' => 'false',
'searchoptions' => ['sopt' => $operators],
],
[
'name' => 'session_active',
'index' => 'session_active',
'align' => 'left',
'search' => 'true',
'stype' => 'select',
// for the bottom bar
'searchoptions' => [
'defaultValue' => '1',
'value' => '1:'.get_lang('Active').';0:'.get_lang('Inactive'),
],
// for the top bar
'editoptions' => [
'value' => '" ":'.get_lang('All').';1:'.get_lang('Active').';0:'.get_lang(
'Inactive'
),
],
],
[
'name' => 'visibility',
'index' => 'visibility',
'align' => 'left',
'search' => 'false',
],
[
'name' => 'course_title',
'index' => 'course_title',
'hidden' => 'true',
'search' => 'true',
'searchoptions' => ['searchhidden' => 'true', 'sopt' => $operators],
],
];
break;
case 'custom':
$columns = [
'#',
get_lang('Name'),
get_lang('Category'),
get_lang('Start date to display'),
get_lang('End date to display'),
get_lang('Visibility'),
];
$columnModel = [
[
'name' => 'id',
'index' => 's.id',
'hidden' => 'true',
],
[
'name' => 'name',
'index' => 's.title',
'width' => '160',
'align' => 'left',
'search' => 'true',
'searchoptions' => ['sopt' => $operators],
],
[
'name' => 'category_name',
'index' => 'category_name',
'align' => 'left',
'search' => 'true',
'searchoptions' => ['sopt' => $operators],
],
[
'name' => 'display_start_date',
'index' => 'display_start_date',
'align' => 'left',
'search' => 'true',
'searchoptions' => [
'dataInit' => 'date_pick_today',
'sopt' => $date_operators,
],
],
[
'name' => 'display_end_date',
'index' => 'display_end_date',
'align' => 'left',
'search' => 'true',
'searchoptions' => [
'dataInit' => 'date_pick_one_month',
'sopt' => $date_operators,
],
],
[
'name' => 'visibility',
'index' => 'visibility',
'align' => 'left',
'search' => 'false',
],
];
if ($showCount) {
$columns[] = get_lang('Users');
$columnModel[] = [
'name' => 'users',
'index' => 'users',
'align' => 'left',
'search' => 'false',
];
// ofaj
$columns[] = get_lang('Teachers');
$columnModel[] = [
'name' => 'teachers',
'index' => 'teachers',
'align' => 'left',
'search' => 'false',
];
}
if ('true' === api_get_setting('session.allow_session_status')) {
$columns[] = get_lang('SessionStatus');
$list = self::getStatusList();
$listToString = '';
foreach ($list as $statusId => $status) {
$listToString .= $statusId.':'.$status.';';
}
$columnModel[] = [
'name' => 'status',
'index' => 'status',
'align' => 'left',
'search' => 'true',
'stype' => 'select',
// for the bottom bar
'searchoptions' => [
'defaultValue' => '1',
'value' => $listToString,
],
];
}
break;
}
if (!empty($extraFields)) {
foreach ($extraFields as $field) {
$columns[] = $field['display_text'];
$columnModel[] = [
'name' => $field['variable'],
'index' => $field['variable'],
'align' => 'center',
'search' => 'false',
];
}
}
// Inject extra session fields
$rules = [];
if ($addExtraFields) {
$sessionField = new ExtraFieldModel('session');
$rules = $sessionField->getRules($columns, $columnModel);
}
if (!in_array('actions', array_column($columnModel, 'name'))) {
$columnModel[] = [
'name' => 'actions',
'index' => 'actions',
'align' => 'left',
'formatter' => 'action_formatter',
'sortable' => 'false',
'search' => 'false',
];
$columns[] = get_lang('Actions');
}
$columnName = [];
foreach ($columnModel as $col) {
$columnName[] = $col['name'];
}
$return = [
'columns' => $columns,
'column_model' => $columnModel,
'rules' => $rules,
'simple_column_name' => $columnName,
];
return $return;
}
/**
* Converts all dates sent through the param array (given form) to correct dates with timezones.
*
* @param array The dates The same array, with times converted
* @param bool $applyFormat Whether apply the DATE_TIME_FORMAT_SHORT format for sessions
*
* @return array The same array, with times converted
*/
public static function convert_dates_to_local($params, $applyFormat = false)
{
if (!is_array($params)) {
return false;
}
$params['display_start_date'] = api_get_local_time($params['display_start_date'], null, null, true);
$params['display_end_date'] = api_get_local_time($params['display_end_date'], null, null, true);
$params['access_start_date'] = api_get_local_time($params['access_start_date'], null, null, true);
$params['access_end_date'] = api_get_local_time($params['access_end_date'], null, null, true);
$params['coach_access_start_date'] = isset($params['coach_access_start_date']) ? api_get_local_time($params['coach_access_start_date'], null, null, true) : null;
$params['coach_access_end_date'] = isset($params['coach_access_end_date']) ? api_get_local_time($params['coach_access_end_date'], null, null, true) : null;
if ($applyFormat) {
if (isset($params['display_start_date'])) {
$params['display_start_date'] = api_format_date($params['display_start_date'], DATE_TIME_FORMAT_SHORT);
}
if (isset($params['display_end_date'])) {
$params['display_end_date'] = api_format_date($params['display_end_date'], DATE_TIME_FORMAT_SHORT);
}
if (isset($params['access_start_date'])) {
$params['access_start_date'] = api_format_date($params['access_start_date'], DATE_TIME_FORMAT_SHORT);
}
if (isset($params['access_end_date'])) {
$params['access_end_date'] = api_format_date($params['access_end_date'], DATE_TIME_FORMAT_SHORT);
}
if (isset($params['coach_access_start_date'])) {
$params['coach_access_start_date'] = api_format_date($params['coach_access_start_date'], DATE_TIME_FORMAT_SHORT);
}
if (isset($params['coach_access_end_date'])) {
$params['coach_access_end_date'] = api_format_date($params['coach_access_end_date'], DATE_TIME_FORMAT_SHORT);
}
}
return $params;
}
/**
* Gets the admin session list callback of the session/session_list.php
* page with all user/details in the right fomat.
*
* @param array $options
*
* @return array Array of rows results
* @asset ('a') === false
*/
public static function get_sessions_admin_complete($options = [])
{
if (!is_array($options)) {
return false;
}
$tbl_session = Database::get_main_table(TABLE_MAIN_SESSION);
$tbl_session_category = Database::get_main_table(TABLE_MAIN_SESSION_CATEGORY);
$tbl_user = Database::get_main_table(TABLE_MAIN_USER);
$tbl_session_rel_course = Database::get_main_table(TABLE_MAIN_SESSION_COURSE);
$tbl_course = Database::get_main_table(TABLE_MAIN_COURSE);
$tblSessionRelUser = Database::get_main_table(TABLE_MAIN_SESSION_USER);
$extraFieldTable = Database::get_main_table(TABLE_EXTRA_FIELD);
$tbl_session_field_values = Database::get_main_table(TABLE_EXTRA_FIELD_VALUES);
$tbl_session_field_options = Database::get_main_table(TABLE_EXTRA_FIELD_OPTIONS);
$where = 'WHERE 1 = 1 ';
if (!api_is_platform_admin()) {
if (api_is_session_admin() &&
'false' == api_get_setting('allow_session_admins_to_manage_all_sessions')
) {
$user_id = api_get_user_id();
$where .= ' AND (sru.relation_type = '.Session::SESSION_ADMIN." AND sru.user_id = $user_id) ";
} else {
$where .= ' AND sru.relation_type = '.Session::GENERAL_COACH.' ';
}
}
$coach_name = " CONCAT(u.lastname , ' ', u.firstname) as coach_name ";
if (api_is_western_name_order()) {
$coach_name = " CONCAT(u.firstname, ' ', u.lastname) as coach_name ";
}
$today = api_get_utc_datetime();
$injectExtraFields = null;
$extra_fields_info = [];
//for now only sessions
$extra_field = new ExtraFieldModel('session');
$double_fields = [];
$extra_field_option = new ExtraFieldOption('session');
if (isset($options['extra'])) {
$extra_fields = $options['extra'];
if (!empty($extra_fields)) {
foreach ($extra_fields as $extra) {
$injectExtraFields .= " IF (fv.field_id = {$extra['id']}, fvo.option_display_text, NULL ) as {$extra['field']} , ";
if (isset($extra_fields_info[$extra['id']])) {
$info = $extra_fields_info[$extra['id']];
} else {
$info = $extra_field->get($extra['id']);
$extra_fields_info[$extra['id']] = $info;
}
if (ExtraFieldModel::FIELD_TYPE_DOUBLE_SELECT == $info['value_type']) {
$double_fields[$info['id']] = $info;
}
}
}
}
$options_by_double = [];
foreach ($double_fields as $double) {
$my_options = $extra_field_option->get_field_options_by_field(
$double['id'],
true
);
$options_by_double['extra_'.$double['field_variable']] = $my_options;
}
//sc.name as category_name,
$select = "
SELECT * FROM (
SELECT DISTINCT
IF (
(s.access_start_date <= '$today' AND '$today' < s.access_end_date) OR
(s.access_start_date = '0000-00-00 00:00:00' AND s.access_end_date = '0000-00-00 00:00:00' ) OR
(s.access_start_date IS NULL AND s.access_end_date IS NULL) OR
(s.access_start_date <= '$today' AND ('0000-00-00 00:00:00' = s.access_end_date OR s.access_end_date IS NULL )) OR
('$today' < s.access_end_date AND ('0000-00-00 00:00:00' = s.access_start_date OR s.access_start_date IS NULL) )
, 1, 0) as session_active,
s.title,
s.nbr_courses,
s.nbr_users,
s.display_start_date,
s.display_end_date,
$coach_name,
access_start_date,
access_end_date,
s.visibility,
u.id as user_id,
$injectExtraFields
c.title as course_title,
s.id ";
if (!empty($options['where'])) {
if (!empty($options['extra'])) {
$options['where'] = str_replace(' 1 = 1 AND', '', $options['where']);
$options['where'] = str_replace('AND', 'OR', $options['where']);
foreach ($options['extra'] as $extra) {
$options['where'] = str_replace($extra['field'], 'fv.field_id = '.$extra['id'].' AND fvo.option_value', $options['where']);
}
}
$options['where'] = str_replace('course_title', 'c.title', $options['where']);
$options['where'] = str_replace("( session_active = '0' )", '1=1', $options['where']);
$options['where'] = str_replace(
["AND session_active = '1' )", " AND ( session_active = '1' )"],
[') GROUP BY s.title HAVING session_active = 1 ', " GROUP BY s.title HAVING session_active = 1 "],
$options['where']
);
$options['where'] = str_replace(
["AND session_active = '0' )", " AND ( session_active = '0' )"],
[') GROUP BY s.title HAVING session_active = 0 ', " GROUP BY s.title HAVING session_active = '0' "],
$options['where']
);
$where .= ' AND '.$options['where'];
}
$limit = '';
if (!empty($options['limit'])) {
$limit = ' LIMIT '.$options['limit'];
}
$query = "$select FROM $tbl_session s
LEFT JOIN $tbl_session_field_values fv
ON (fv.item_id = s.id)
LEFT JOIN $extraFieldTable f
ON f.id = fv.field_id
LEFT JOIN $tbl_session_field_options fvo
ON (fv.field_id = fvo.field_id)
LEFT JOIN $tbl_session_rel_course src
ON (src.session_id = s.id)
LEFT JOIN $tbl_course c
ON (src.c_id = c.id)
LEFT JOIN $tbl_session_category sc
ON (s.session_category_id = sc.id)
INNER JOIN $tblSessionRelUser sru ON s.id = sru.session_id
INNER JOIN $tbl_user u
ON sru.user_id = u.id
$where
$limit
";
if (api_is_multiple_url_enabled()) {
$table_access_url_rel_session = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_SESSION);
$access_url_id = api_get_current_access_url_id();
if (-1 != $access_url_id) {
$query = "$select
FROM $tbl_session s
LEFT JOIN $tbl_session_field_values fv
ON (fv.item_id = s.id)
LEFT JOIN $tbl_session_field_options fvo
ON (fv.field_id = fvo.field_id)
LEFT JOIN $tbl_session_rel_course src
ON (src.session_id = s.id)
LEFT JOIN $tbl_course c
ON (src.c_id = c.id)
LEFT JOIN $tbl_session_category sc
ON (s.session_category_id = sc.id)
INNER JOIN $tblSessionRelUser sru ON s.id = sru.session_id
INNER JOIN $tbl_user u
ON sru.user_id = u.id
INNER JOIN $table_access_url_rel_session ar
ON (ar.session_id = s.id AND ar.access_url_id = $access_url_id)
$where
$limit
";
}
}
$query .= ') AS s';
if (!empty($options['order'])) {
$query .= ' ORDER BY '.$options['order'];
}
$result = Database::query($query);
$acceptIcon = Display::getMdiIcon(StateIcon::ACTIVE, 'ch-tool-icon', null, ICON_SIZE_SMALL, get_lang('Active'));
$errorIcon = Display::getMdiIcon(StateIcon::INACTIVE, 'ch-tool-icon', null, ICON_SIZE_SMALL, get_lang('Inactive'));
$formatted_sessions = [];
if (Database::num_rows($result)) {
$sessions = Database::store_result($result, 'ASSOC');
foreach ($sessions as $session) {
$session_id = $session['id'];
$session['title'] = Display::url($session['title'], "resume_session.php?id_session=".$session['id']);
$session['coach_name'] = Display::url($session['coach_name'], "user_information.php?user_id=".$session['user_id']);
if (1 == $session['session_active']) {
$session['session_active'] = $acceptIcon;
} else {
$session['session_active'] = $errorIcon;
}
$session = self::convert_dates_to_local($session);
switch ($session['visibility']) {
case SESSION_VISIBLE_READ_ONLY: //1
$session['visibility'] = get_lang('Read only');
break;
case SESSION_VISIBLE: //2
case SESSION_AVAILABLE: //4
$session['visibility'] = get_lang('Visible');
break;
case SESSION_INVISIBLE: //3
$session['visibility'] = api_ucfirst(get_lang('invisible'));
break;
}
// Cleaning double selects
foreach ($session as $key => &$value) {
if (isset($options_by_double[$key]) || isset($options_by_double[$key.'_second'])) {
$options = explode('::', $value);
}
$original_key = $key;
if (false === strpos($key, '_second')) {
} else {
$key = str_replace('_second', '', $key);
}
if (isset($options_by_double[$key])) {
if (isset($options[0])) {
if (isset($options_by_double[$key][$options[0]])) {
if (false === strpos($original_key, '_second')) {
$value = $options_by_double[$key][$options[0]]['option_display_text'];
} else {
$value = $options_by_double[$key][$options[1]]['option_display_text'];
}
}
}
}
}
// Magic filter
if (isset($formatted_sessions[$session_id])) {
$formatted_sessions[$session_id] = self::compareArraysToMerge(
$formatted_sessions[$session_id],
$session
);
} else {
$formatted_sessions[$session_id] = $session;
}
}
}
return $formatted_sessions;
}
/**
* Compare two arrays.
*
* @param array $array1
* @param array $array2
*
* @return array
*/
public static function compareArraysToMerge($array1, $array2)
{
if (empty($array2)) {
return $array1;
}
foreach ($array1 as $key => $item) {
if (!isset($array1[$key])) {
//My string is empty try the other one
if (isset($array2[$key]) && !empty($array2[$key])) {
$array1[$key] = $array2[$key];
}
}
}
return $array1;
}
/**
* Get link to the admin page for this session.
*
* @param int $id Session ID
*
* @return mixed URL to the admin page to manage the session, or false on error
*/
public static function getAdminPath($id)
{
$id = (int) $id;
$session = self::fetch($id);
if (empty($session)) {
return false;
}
return api_get_path(WEB_CODE_PATH).'session/resume_session.php?id_session='.$id;
}
/**
* Get link to the user page for this session.
* If a course is provided, build the link to the course.
*
* @param int $id Session ID
* @param int $courseId Course ID (optional) in case the link has to send straight to the course
*
* @return mixed URL to the page to use the session, or false on error
*/
public static function getPath($id, $courseId = 0)
{
$id = (int) $id;
$session = self::fetch($id);
if (empty($session)) {
return false;
}
if (empty($courseId)) {
return api_get_path(WEB_CODE_PATH).'session/index.php?session_id='.$id;
} else {
$courseInfo = api_get_course_info_by_id($courseId);
if ($courseInfo) {
return $courseInfo['course_public_url'].'?id_session='.$id;
}
}
return false;
}
/**
* Return an associative array 'id_course' => [id_session1, id_session2...]
* where course id_course is in sessions id_session1, id_session2
* for course where user is coach
* i.e. coach for the course or
* main coach for a session the course is in
* for a session category (or woth no session category if empty).
*
* @param int $userId
*
* @return array
*/
public static function getSessionCourseForUser($userId)
{
// list of COURSES where user is COURSE session coach
$listCourseCourseCoachSession = self::getCoursesForCourseSessionCoach($userId);
// list of courses where user is MAIN session coach
$listCourseMainCoachSession = self::getCoursesForMainSessionCoach($userId);
// merge these 2 array
$listResCourseSession = $listCourseCourseCoachSession;
foreach ($listCourseMainCoachSession as $courseId2 => $listSessionId2) {
if (isset($listResCourseSession[$courseId2])) {
// if sessionId array exists for this course
// same courseId, merge the list of session
foreach ($listCourseMainCoachSession[$courseId2] as $i => $sessionId2) {
if (!in_array($sessionId2, $listResCourseSession[$courseId2])) {
$listResCourseSession[$courseId2][] = $sessionId2;
}
}
} else {
$listResCourseSession[$courseId2] = $listSessionId2;
}
}
return $listResCourseSession;
}
/**
* Return an associative array 'id_course' => [id_session1, id_session2...]
* where course id_course is in sessions id_session1, id_session2.
*
* @param int $userId
*
* @return array
*/
public static function getCoursesForCourseSessionCoach($userId)
{
$userId = (int) $userId;
$listResCourseSession = [];
$tblCourse = Database::get_main_table(TABLE_MAIN_COURSE);
$tblSessionRelCourseRelUser = Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER);
$sql = "SELECT session_id, c_id, c.id
FROM $tblSessionRelCourseRelUser srcru
LEFT JOIN $tblCourse c
ON c.id = srcru.c_id
WHERE
srcru.user_id = $userId AND
srcru.status = ".Session::COURSE_COACH;
$res = Database::query($sql);
while ($data = Database::fetch_assoc($res)) {
if (api_get_session_visibility($data['session_id'])) {
if (!isset($listResCourseSession[$data['id']])) {
$listResCourseSession[$data['id']] = [];
}
$listResCourseSession[$data['id']][] = $data['session_id'];
}
}
return $listResCourseSession;
}
/**
* Return an associative array 'id_course' => [id_session1, id_session2...]
* where course id_course is in sessions id_session1, id_session2.
*
* @param $userId
*
* @return array
*/
public static function getCoursesForMainSessionCoach($userId)
{
$userId = (int) $userId;
$user = api_get_user_entity($userId);
$listResCourseSession = [];
$sessions = $user->getSessionsAsGeneralCoach();
foreach ($sessions as $session) {
$sessionId = $session->getId();
$listCoursesInSession = self::getCoursesInSession($sessionId);
foreach ($listCoursesInSession as $i => $courseId) {
if (api_get_session_visibility($sessionId)) {
if (!isset($listResCourseSession[$courseId])) {
$listResCourseSession[$courseId] = [];
}
$listResCourseSession[$courseId][] = $sessionId;
}
}
}
return $listResCourseSession;
}
/**
* Return an array of course_id used in session $sessionId.
*
* @param $sessionId
*
* @return array
*/
public static function getCoursesInSession($sessionId)
{
if (empty($sessionId)) {
return [];
}
$tblSessionRelCourse = Database::get_main_table(TABLE_MAIN_SESSION_COURSE);
$tblCourse = Database::get_main_table(TABLE_MAIN_COURSE);
// list of course in this session
$sql = "SELECT session_id, c.id
FROM $tblSessionRelCourse src
LEFT JOIN $tblCourse c
ON c.id = src.c_id
WHERE session_id = ".intval($sessionId);
$res = Database::query($sql);
$listResultsCourseId = [];
while ($data = Database::fetch_assoc($res)) {
$listResultsCourseId[] = $data['id'];
}
return $listResultsCourseId;
}
/**
* Return an array of courses in session for user
* and for each courses the list of session that use this course for user.
*
* [0] => array
* userCatId
* userCatTitle
* courseInUserCatList
* [0] => array
* courseId
* title
* courseCode
* sessionCatList
* [0] => array
* catSessionId
* catSessionName
* sessionList
* [0] => array
* sessionId
* sessionName
*
* @param int $userId
*
* @return array
*/
public static function getNamedSessionCourseForCoach($userId)
{
$listResults = [];
$listCourseSession = self::getSessionCourseForUser($userId);
foreach ($listCourseSession as $courseId => $listSessionId) {
// Course info
$courseInfo = api_get_course_info_by_id($courseId);
$listOneCourse = [];
$listOneCourse['courseId'] = $courseId;
$listOneCourse['title'] = $courseInfo['title'];
//$listOneCourse['courseCode'] = $courseInfo['code'];
$listOneCourse['course'] = $courseInfo;
$listOneCourse['sessionCatList'] = [];
$listCat = [];
foreach ($listSessionId as $i => $sessionId) {
// here we got all session for this course
// lets check there session categories
$sessionInfo = self::fetch($sessionId);
$catId = $sessionInfo['session_category_id'];
if (!isset($listCat[$catId])) {
$listCatInfo = self::get_session_category($catId);
if ($listCatInfo) {
$listCat[$catId] = [];
$listCat[$catId]['catSessionId'] = $catId;
$listCat[$catId]['catSessionName'] = $listCatInfo['title'];
$listCat[$catId]['sessionList'] = [];
}
}
$listSessionInfo = self::fetch($sessionId);
$listSessionIdName = [
'sessionId' => $sessionId,
'sessionName' => $listSessionInfo['title'],
];
$listCat[$catId]['sessionList'][] = $listSessionIdName;
}
// sort $listCat by catSessionName
usort($listCat, 'self::compareBySessionName');
// in each catSession sort sessionList by sessionName
foreach ($listCat as $i => $listCatSessionInfo) {
$listSessionList = $listCatSessionInfo['sessionList'];
usort($listSessionList, 'self::compareCatSessionInfo');
$listCat[$i]['sessionList'] = $listSessionList;
}
$listOneCourse['sessionCatList'] = $listCat;
//$listResults[$userCatId]['courseInUserCatList'][] = $listOneCourse;
}
// sort by user course cat
uasort($listResults, 'self::compareByUserCourseCat');
// sort by course title
foreach ($listResults as $userCourseCatId => $tabCoursesInCat) {
$courseInUserCatList = $tabCoursesInCat['courseInUserCatList'];
uasort($courseInUserCatList, 'self::compareByCourse');
$listResults[$userCourseCatId]['courseInUserCatList'] = $courseInUserCatList;
}
return $listResults;
}
/**
* @param int $userId
* @param int $courseId
*
* @return array
*/
public static function searchCourseInSessionsFromUser($userId, $courseId)
{
$table = Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER);
$userId = (int) $userId;
$courseId = (int) $courseId;
if (empty($userId) || empty($courseId)) {
return [];
}
$sql = "SELECT * FROM $table
WHERE c_id = $courseId AND user_id = $userId";
$result = Database::query($sql);
return Database::store_result($result, 'ASSOC');
}
/**
* Subscribe and redirect to session after inscription.
*/
public static function redirectToSession()
{
$sessionId = (int) ChamiloSession::read('session_redirect');
$onlyOneCourseSessionToRedirect = ChamiloSession::read('only_one_course_session_redirect');
if ($sessionId) {
$sessionInfo = api_get_session_info($sessionId);
if (!empty($sessionInfo)) {
$userId = api_get_user_id();
$response = self::isUserSubscribedAsStudent($sessionId, $userId);
if ($response) {
$urlToRedirect = api_get_path(WEB_CODE_PATH).'session/index.php?session_id='.$sessionId;
if (!empty($onlyOneCourseSessionToRedirect)) {
$urlToRedirect = api_get_path(WEB_PATH).
'courses/'.$onlyOneCourseSessionToRedirect.'/index.php?id_session='.$sessionId;
}
header('Location: '.$urlToRedirect);
exit;
}
}
}
}
/**
* @return int
*/
public static function getCountUsersInCourseSession(Course $course, Session $session)
{
$url = api_get_url_entity(api_get_current_access_url_id());
return Database::getManager()
->createQuery("
SELECT COUNT(scu)
FROM ChamiloCoreBundle:SessionRelCourseRelUser scu
INNER JOIN ChamiloCoreBundle:SessionRelUser su
WITH scu.user = su.user
AND scu.session = su.session
INNER JOIN ChamiloCoreBundle:AccessUrlRelUser a
WITH a.user = su.user
WHERE
scu.course = :course AND
su.relationType <> :relationType AND
scu.session = :session AND
a.url = :url
")
->setParameters([
'course' => $course->getId(),
'relationType' => Session::DRH,
'session' => $session->getId(),
'url' => $url,
])
->getSingleScalarResult();
}
/**
* Get course IDs where user in not subscribed in session.
*
* @return array
*/
public static function getAvoidedCoursesInSession(User $user, Session $session)
{
$courseIds = [];
/** @var SessionRelCourse $sessionCourse */
foreach ($session->getCourses() as $sessionCourse) {
/** @var Course $course */
$course = $sessionCourse->getCourse();
if ($session->getUserInCourse($user, $course)->count()) {
continue;
}
$courseIds[] = $course->getId();
}
return $courseIds;
}
/**
* @param int $userId
* @param int $sessionId
* @param ExtraFieldValue $extraFieldValue
* @param string $collapsableLink
*
* @return array
*/
public static function getCollapsableData($userId, $sessionId, $extraFieldValue, $collapsableLink)
{
$collapsed = 0;
// Get default collapsed value in extra field
$value = $extraFieldValue->get_values_by_handler_and_field_variable($sessionId, 'collapsed');
if (!empty($value) && isset($value['value'])) {
$collapsed = $value['value'];
}
$userRelSession = self::getUserSession($userId, $sessionId);
if ($userRelSession) {
if (isset($userRelSession['collapsed']) && '' != $userRelSession['collapsed']) {
$collapsed = $userRelSession['collapsed'];
}
} else {
return ['collapsed' => $collapsed, 'collapsable_link' => '&nbsp;'];
}
$link = $collapsableLink.'&session_id='.$sessionId.'&value=1';
$image = '<i class="fa fa-folder-open"></i>';
if (1 == $collapsed) {
$link = $collapsableLink.'&session_id='.$sessionId.'&value=0';
$image = '<i class="fa fa-folder"></i>';
}
$link = Display::url(
$image,
$link
);
return ['collapsed' => $collapsed, 'collapsable_link' => $link];
}
/**
* Converts "start date" and "end date" to "From start date to end date" string.
*
* @param string|DateTime $startDate
* @param string|DateTime $endDate
* @param bool $showTime
* @param bool $dateHuman
*
* @return string
*/
public static function convertSessionDateToString($startDate, $endDate, $showTime, $dateHuman)
{
// api_get_local_time returns empty if date is invalid like 0000-00-00 00:00:00
$startDateToLocal = api_get_local_time(
$startDate,
null,
null,
true,
$showTime,
$dateHuman
);
$endDateToLocal = api_get_local_time(
$endDate,
null,
null,
true,
$showTime,
$dateHuman
);
$format = $showTime ? DATE_TIME_FORMAT_LONG_24H : DATE_FORMAT_LONG_NO_DAY;
$result = '';
if (!empty($startDateToLocal) && !empty($endDateToLocal)) {
$result = sprintf(
get_lang('From %s to %s'),
api_format_date($startDateToLocal, $format),
api_format_date($endDateToLocal, $format)
);
} else {
if (!empty($startDateToLocal)) {
$result = get_lang('From').' '.api_format_date($startDateToLocal, $format);
}
if (!empty($endDateToLocal)) {
$result = get_lang('Until').' '.api_format_date($endDateToLocal, $format);
}
}
if (empty($result)) {
$result = get_lang('No time limits');
}
return $result;
}
/**
* @param int $id
*/
public static function getSessionChangeUserReason($id): string
{
$reasons = self::getSessionChangeUserReasons();
return $reasons[$id] ?? '';
}
public static function getSessionChangeUserReasons(): array
{
return [
self::SESSION_CHANGE_USER_REASON_SCHEDULE => get_lang('ScheduleChanged'),
self::SESSION_CHANGE_USER_REASON_CLASSROOM => get_lang('ClassRoomChanged'),
self::SESSION_CHANGE_USER_REASON_LOCATION => get_lang('LocationChanged'),
//self::SESSION_CHANGE_USER_REASON_ENROLLMENT_ANNULATION => get_lang('EnrollmentAnnulation'),
];
}
public static function getStatusList()
{
return [
self::STATUS_PLANNED => get_lang('Planned'),
self::STATUS_PROGRESS => get_lang('InProgress'),
self::STATUS_FINISHED => get_lang('Finished'),
self::STATUS_CANCELLED => get_lang('Cancelled'),
];
}
public static function getStatusLabel($status)
{
$list = self::getStatusList();
if (!isset($list[$status])) {
return get_lang('NoStatus');
}
return $list[$status];
}
public static function getDefaultSessionTab()
{
$default = 'all';
$view = api_get_setting('session.default_session_list_view');
if ('false' !== $view && !empty($view)) {
$default = $view;
}
return $default;
}
/**
* @return array
*/
public static function getSessionListTabs($listType)
{
$tabs = [
[
'content' => get_lang('All sessions'),
'url' => api_get_path(WEB_CODE_PATH).'session/session_list.php?list_type=all',
],
[
'content' => get_lang('Active sessions'),
'url' => api_get_path(WEB_CODE_PATH).'session/session_list.php?list_type=active',
],
[
'content' => get_lang('Closed sessions'),
'url' => api_get_path(WEB_CODE_PATH).'session/session_list.php?list_type=close',
],
[
'content' => get_lang('Custom sessions'),
'url' => api_get_path(WEB_CODE_PATH).'session/session_list.php?list_type=custom',
],
/*[
'content' => get_lang('Complete'),
'url' => api_get_path(WEB_CODE_PATH).'session/session_list_simple.php?list_type=complete',
],*/
];
$default = null;
switch ($listType) {
case 'all':
$default = 1;
break;
case 'active':
$default = 2;
break;
case 'close':
$default = 3;
break;
case 'custom':
$default = 4;
break;
}
return Display::tabsOnlyLink($tabs, $default);
}
/**
* Check if a session is followed by human resources manager.
*
* @param int $sessionId
* @param int $userId
*
* @return bool
*/
public static function isSessionFollowedByDrh($sessionId, $userId)
{
$userId = (int) $userId;
$sessionId = (int) $sessionId;
$tblSession = Database::get_main_table(TABLE_MAIN_SESSION);
$tblSessionRelUser = Database::get_main_table(TABLE_MAIN_SESSION_USER);
if (api_is_multiple_url_enabled()) {
$tblSessionRelAccessUrl = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_SESSION);
$sql = "SELECT s.id FROM $tblSession s
INNER JOIN $tblSessionRelUser sru ON (sru.session_id = s.id)
LEFT JOIN $tblSessionRelAccessUrl a ON (s.id = a.session_id)
WHERE
sru.user_id = '$userId' AND
sru.session_id = '$sessionId' AND
sru.relation_type = '".Session::DRH."' AND
access_url_id = ".api_get_current_access_url_id();
} else {
$sql = "SELECT s.id FROM $tblSession s
INNER JOIN $tblSessionRelUser sru ON sru.session_id = s.id
WHERE
sru.user_id = '$userId' AND
sru.session_id = '$sessionId' AND
sru.relation_type = '".Session::DRH."'";
}
$result = Database::query($sql);
return Database::num_rows($result) > 0;
}
/**
* Add a warning message when session is read-only mode.
*/
public static function addFlashSessionReadOnly()
{
if (api_get_session_id() && !api_is_allowed_to_session_edit()) {
Display::addFlash(
Display::return_message(get_lang('The session is read only'), 'warning')
);
}
}
public static function insertUsersInCourses(array $studentIds, array $courseIds, int $sessionId)
{
$session = api_get_session_entity($sessionId);
foreach ($courseIds as $courseId) {
self::insertUsersInCourse($studentIds, $courseId, $sessionId, [], false);
}
foreach ($studentIds as $studentId) {
$user = api_get_user_entity($studentId);
$session->addUserInSession(Session::STUDENT, $user);
}
}
public static function insertUsersInCourse(
array $studentIds,
int $courseId,
int $sessionId,
array $relationInfo = [],
bool $updateSession = true
) {
$course = api_get_course_entity($courseId);
$session = api_get_session_entity($sessionId);
$em = Database::getManager();
$relationInfo = array_merge(['visibility' => 0, 'status' => Session::STUDENT], $relationInfo);
foreach ($studentIds as $studentId) {
$user = api_get_user_entity($studentId);
$session
->addUserInCourse($relationInfo['status'], $user, $course)
->setVisibility($relationInfo['visibility']);
Event::logUserSubscribedInCourseSession($user, $course, $session);
if ($updateSession) {
$session->addUserInSession(Session::STUDENT, $user);
}
}
$em->persist($session);
$em->flush();
}
public static function getCareersFromSession(int $sessionId): array
{
$extraFieldValueSession = new ExtraFieldValue('session');
$extraFieldValueCareer = new ExtraFieldValue('career');
$value = $extraFieldValueSession->get_values_by_handler_and_field_variable($sessionId, 'careerid');
$careers = [];
if (isset($value['value']) && !empty($value['value'])) {
$careerList = str_replace(['[', ']'], '', $value['value']);
$careerList = explode(',', $careerList);
$careerManager = new Career();
foreach ($careerList as $career) {
$careerIdValue = $extraFieldValueCareer->get_item_id_from_field_variable_and_field_value(
'external_career_id',
$career
);
if (isset($careerIdValue['item_id']) && !empty($careerIdValue['item_id'])) {
$finalCareerId = $careerIdValue['item_id'];
$careerInfo = $careerManager->get($finalCareerId);
if (!empty($careerInfo)) {
$careers[] = $careerInfo;
}
}
}
}
return $careers;
}
public static function getCareerDiagramPerSessionList($sessionList, $userId)
{
if (empty($sessionList) || empty($userId)) {
return '';
}
$userId = (int) $userId;
$content = Display::page_subheader(get_lang('OngoingTraining'));
$content .= '
<script>
resizeIframe = function(iFrame) {
iFrame.height = iFrame.contentWindow.document.body.scrollHeight + 20;
}
</script>
';
$careersAdded = [];
foreach ($sessionList as $sessionId) {
$visibility = api_get_session_visibility($sessionId, null, false, $userId);
if (SESSION_AVAILABLE === $visibility) {
$careerList = self::getCareersFromSession($sessionId);
if (empty($careerList)) {
continue;
}
foreach ($careerList as $career) {
$careerId = $career['id'];
if (!in_array($careerId, $careersAdded)) {
$careersAdded[] = $careerId;
$careerUrl = api_get_path(WEB_CODE_PATH).'user/career_diagram.php?iframe=1&career_id='.$career['id'].'&user_id='.$userId;
$content .= '
<iframe
onload="resizeIframe(this)"
style="width:100%;"
border="0"
frameborder="0"
scrolling="no"
src="'.$careerUrl.'"
></iframe>';
}
}
}
}
return $content;
}
private static function allowed(?Session $session = null): bool
{
if (api_is_platform_admin()) {
return true;
}
if (null === $session) {
return false;
}
$user = api_get_user_entity();
if (api_is_session_admin() &&
'true' !== api_get_setting('session.allow_session_admins_to_manage_all_sessions')
) {
if (!$session->hasUserAsSessionAdmin($user)) {
return false;
}
}
if (api_is_teacher() &&
'true' === api_get_setting('session.allow_teachers_to_create_sessions')
) {
if (!$session->hasUserAsGeneralCoach($user)) {
return false;
}
}
return true;
}
/**
* Add classes (by their names) to a session.
*
* @param int $sessionId
* @param array $classesNames
* @param bool $deleteClassSessions Optional. Empty the session list for the usergroup (class)
*/
private static function addClassesByName($sessionId, $classesNames, $deleteClassSessions = true)
{
if (!$classesNames) {
return;
}
$usergroup = new UserGroupModel();
foreach ($classesNames as $className) {
if (empty($className)) {
continue;
}
$usergroup->subscribe_sessions_to_usergroup(
$usergroup->getIdByName($className),
[$sessionId],
$deleteClassSessions
);
}
}
/**
* @param array $listA
* @param array $listB
*
* @return int
*/
private static function compareCatSessionInfo($listA, $listB)
{
if ($listA['sessionName'] == $listB['sessionName']) {
return 0;
} elseif ($listA['sessionName'] > $listB['sessionName']) {
return 1;
} else {
return -1;
}
}
/**
* @param array $listA
* @param array $listB
*
* @return int
*/
private static function compareBySessionName($listA, $listB)
{
if ('' == $listB['catSessionName']) {
return -1;
} elseif ('' == $listA['catSessionName']) {
return 1;
} elseif ($listA['catSessionName'] == $listB['catSessionName']) {
return 0;
} elseif ($listA['catSessionName'] > $listB['catSessionName']) {
return 1;
} else {
return -1;
}
}
/**
* @param array $listA
* @param array $listB
*
* @return int
*/
private static function compareByUserCourseCat($listA, $listB)
{
if ($listA['courseInUserCategoryTitle'] == $listB['courseInUserCategoryTitle']) {
return 0;
} elseif ($listA['courseInUserCategoryTitle'] > $listB['courseInUserCategoryTitle']) {
return 1;
} else {
return -1;
}
}
/**
* @param array $listA
* @param array $listB
*
* @return int
*/
private static function compareByCourse($listA, $listB)
{
if ($listA['title'] == $listB['title']) {
return 0;
} elseif ($listA['title'] > $listB['title']) {
return 1;
} else {
return -1;
}
}
public static function getGeneralCoachesIdForSession(int $sessionId): array
{
return api_get_session_entity($sessionId)
->getGeneralCoaches()
->map(fn(User $user) => $user->getId())
->getValues();
}
public static function getGeneralCoachesNamesForSession(int $sessionId): array
{
return api_get_session_entity($sessionId)
->getGeneralCoaches()
->map(fn(User $user) => $user->getFullname())
->getValues();
}
public static function sessionHasSessionAdmin(int $sessionId, int $userId): bool
{
$adminIds = api_get_session_entity($sessionId)
->getSessionAdmins()
->map(fn(User $user) => $user->getId())
->getValues();
return in_array($userId, $adminIds);
}
}