$user_counter++;
}
}
// Adding courses to a session.
foreach ($node_session->Course as $node_course) {
$course_code = Database::escape_string(trim(api_utf8_decode($node_course->CourseCode)));
// Verify that the course pointed by the course code node exists.
if (CourseManager::course_exists($course_code)) {
// If the course exists we continue.
$course_info = CourseManager::get_course_information($course_code);
$courseId = $course_info['c_id'];
$session_course_relation = SessionManager::relation_session_course_exist($session_id, $courseId);
if (!$session_course_relation) {
$sql_course = "INSERT INTO {$tbl_session_course} SET\n c_id = {$courseId},\n session_id = {$session_id}";
$rs_course = Database::query($sql_course);
SessionManager::installCourse($id_session, $courseId);
}
$course_coaches = explode(',', $node_course->Coach);
// Adding coachs to session course user
foreach ($course_coaches as $course_coach) {
$coach_id = UserManager::purify_username(api_utf8_decode($course_coach), $purification_option_for_usernames);
$coach_id = UserManager::get_user_id_from_username($course_coach);
if ($coach_id !== false) {
$sql = "INSERT IGNORE INTO {$tbl_session_course_user} SET\n user_id='{$coach_id}',\n c_id = '{$courseId}',\n session_id = '{$session_id}',\n status = 2 ";
$rs_coachs = Database::query($sql);
} else {
$error_message .= get_lang('UserDoesNotExist') . ' : ' . $user . '<br />';
}
}
// Adding users.
$course_counter++;
$update_session_course = "UPDATE {$tbl_session_course} SET nbr_users='{$users_in_course_counter}' WHERE course_code='{$course_code}'";
Database::query($update_session_course);
$inserted_in_course[$course_code] = $course_info['title'];
}
if (CourseManager::course_exists($course_code, true)) {
// If the course exists we continue.
// Also subscribe to virtual courses through check on visual code.
$list = CourseManager::get_courses_info_from_visual_code($course_code);
foreach ($list as $vcourse) {
if ($vcourse['code'] == $course_code) {
// Ignore, this has already been inserted.
} else {
$sql_course = "INSERT INTO {$tbl_session_course} SET\n course_code = '" . $vcourse['code'] . "',\n id_session='{$session_id}'";
$rs_course = Database::query($sql_course);
$course_info = api_get_course_info($course['code']);
SessionManager::installCourse($id_session, $course_info['real_id']);
$course_coaches = explode(",", $node_course->Coach);
// adding coachs to session course user
foreach ($course_coaches as $course_coach) {
$coach_id = UserManager::purify_username(api_utf8_decode($course_coach), $purification_option_for_usernames);
$coach_id = UserManager::get_user_id_from_username($course_coach);
if ($coach_id !== false) {
$sql = "INSERT IGNORE INTO {$tbl_session_course_user} SET\n id_user='******',\n course_code='{$vcourse['code']}',\n id_session = '{$session_id}',\n status = 2 ";
$rs_coachs = Database::query($sql);
} else {
$error_message .= get_lang('UserDoesNotExist') . ' : ' . $user . '<br />';
}
}
// adding users
$course_counter++;
$users_in_course_counter = 0;
/**
* @param string $file
* @param bool $updateSession options:
* 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 mixed $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 this: 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 int $showDescription
* @return array
*/
static function importCSV($file, $updateSession, $defaultUserId = null, $logger = null, $extraFields = array(), $extraFieldId = null, $daysCoachAccessBeforeBeginning = null, $daysCoachAccessAfterBeginning = null, $sessionVisibility = 1, $fieldsToAvoidUpdate = array(), $deleteUsersNotInList = false, $updateCourseCoaches = false, $sessionWithCoursesModifier = false, $addOriginalCourseTeachersAsCourseSessionCoaches = true, $removeAllTeachersFromCourse = true, $showDescription = null)
{
$content = file($file);
$error_message = null;
$session_counter = 0;
if (empty($defaultUserId)) {
$defaultUserId = api_get_user_id();
}
$eol = PHP_EOL;
if (PHP_SAPI != 'cli') {
$eol = '<br />';
}
$debug = false;
if (isset($logger)) {
$debug = true;
}
$extraParameters = null;
if (!empty($daysCoachAccessBeforeBeginning) && !empty($daysCoachAccessAfterBeginning)) {
$extraParameters .= ' , nb_days_access_before_beginning = ' . intval($daysCoachAccessBeforeBeginning);
$extraParameters .= ' , nb_days_access_after_end = ' . intval($daysCoachAccessAfterBeginning);
}
if (!is_null($showDescription)) {
$extraParameters .= ' , show_description = ' . intval($showDescription);
}
$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 = array();
if (!api_strstr($content[0], ';')) {
$error_message = get_lang('NotCSV');
} else {
$tag_names = array();
foreach ($content as $key => $enreg) {
$enreg = explode(';', trim($enreg));
if ($key) {
foreach ($tag_names as $tag_key => $tag_name) {
$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('NoNeededData');
break;
}
}
}
$sessionList = array();
// 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 = Database::escape_string($enreg['SessionName']);
// 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;
}
$date_start = $enreg['DateStart'];
$date_end = $enreg['DateEnd'];
$session_category_id = isset($enreg['SessionCategory']) ? $enreg['SessionCategory'] : null;
$sessionDescription = isset($enreg['SessionDescription']) ? $enreg['SessionDescription'] : null;
$extraSessionParameters = null;
if (!empty($sessionDescription)) {
$extraSessionParameters = " , description = '" . Database::escape_string($sessionDescription) . "'";
}
// Searching a general coach.
if (!empty($enreg['Coach'])) {
$coach_id = UserManager::get_user_id_from_username($enreg['Coach']);
if ($coach_id === false) {
// If the coach-user does not exist - I'm the coach.
$coach_id = $defaultUserId;
}
} else {
$coach_id = $defaultUserId;
}
if (!$updateSession) {
// Always 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 1 FROM ' . $tbl_session . '
WHERE name="' . $session_name . $suffix . '"';
$rs = Database::query($sql);
if (Database::result($rs, 0, 0)) {
$i++;
} else {
$unique_name = true;
$session_name .= $suffix;
}
}
$sessionCondition = '';
if (!empty($session_category_id)) {
$sessionCondition = "session_category_id = '{$session_category_id}',";
}
// Creating the session.
$sql = "INSERT IGNORE INTO {$tbl_session} SET\n name = '" . $session_name . "',\n id_coach = '{$coach_id}',\n access_start_date = '{$date_start}',\n access_end_date = '{$date_end}',\n visibility = '{$visibilityAfterExpirationPerSession}',\n {$sessionCondition}\n session_admin_id = " . intval($defaultUserId) . $extraParameters . $extraSessionParameters;
Database::query($sql);
$session_id = Database::insert_id();
if ($debug) {
if ($session_id) {
foreach ($enreg as $key => $value) {
if (substr($key, 0, 6) == 'extra_') {
//an extra field
self::update_session_extra_field_value($session_id, substr($key, 6), $value);
}
}
$logger->addInfo("Sessions - Session created: #{$session_id} - {$session_name}");
} else {
$logger->addError("Sessions - Session NOT created: {$session_name}");
}
}
$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 ($my_session_result === false) {
// Creating a session.
$sql = "INSERT IGNORE INTO {$tbl_session} SET\n name = '{$session_name}',\n id_coach = '{$coach_id}',\n access_start_date = '{$date_start}',\n access_end_date = '{$date_end}',\n visibility = '{$visibilityAfterExpirationPerSession}',\n session_category_id = '{$session_category_id}' " . $extraParameters . $extraSessionParameters;
Database::query($sql);
// We get the last insert id.
$my_session_result = SessionManager::get_session_by_name($enreg['SessionName']);
$session_id = $my_session_result['id'];
if ($session_id) {
foreach ($enreg as $key => $value) {
if (substr($key, 0, 6) == 'extra_') {
//an extra field
self::update_session_extra_field_value($session_id, substr($key, 6), $value);
}
}
if ($debug) {
$logger->addInfo("Sessions - #{$session_id} created: {$session_name}");
}
// Delete session-user relation only for students
$sql = "DELETE FROM {$tbl_session_user}\n WHERE session_id = '{$session_id}' AND relation_type <> " . SESSION_RELATION_TYPE_RRHH;
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}\n WHERE session_id = '{$session_id}' AND status in ('0', '2')";
Database::query($sql);
} else {
// Delete session-course-user relation ships *only* for students.
$sql = "DELETE FROM {$tbl_session_course_user}\n WHERE session_id = '{$session_id}' AND status <> 2";
Database::query($sql);
}
}
} else {
if ($debug) {
$logger->addError("Sessions - Session to be updated: {$session_name}");
}
// Updating the session.
$params = array('id_coach' => $coach_id, 'access_start_date' => $date_start, 'access_end_date' => $date_end, '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)) {
if (!empty($enreg['SessionName'])) {
$params['name'] = $enreg['SessionName'];
}
$session_id = $sessionId;
} else {
$row = Database::query("SELECT id FROM {$tbl_session} WHERE name = '{$session_name}'");
list($session_id) = Database::fetch_array($row);
}
if ($session_id) {
if ($debug) {
$logger->addError("Sessions - Session to be updated #{$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['nb_days_access_before_beginning'] = intval($daysCoachAccessBeforeBeginning);
}
if (empty($sessionInfo['nb_days_access_after_end']) || !empty($sessionInfo['nb_days_access_after_end']) && $sessionInfo['nb_days_access_after_end'] < $daysCoachAccessAfterBeginning) {
$params['nb_days_access_after_end'] = intval($daysCoachAccessAfterBeginning);
}
}
Database::update($tbl_session, $params, array('id = ?' => $session_id));
foreach ($enreg as $key => $value) {
if (substr($key, 0, 6) == 'extra_') {
//an extra field
self::update_session_extra_field_value($session_id, substr($key, 6), $value);
}
}
// Delete session-user relation only for students
$sql = "DELETE FROM {$tbl_session_user}\n WHERE session_id = '{$session_id}' AND relation_type <> " . SESSION_RELATION_TYPE_RRHH;
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}\n WHERE session_id = '{$session_id}' AND status in ('0', '2')";
Database::query($sql);
} else {
// Delete session-course-user relation ships *only* for students.
$sql = "DELETE FROM {$tbl_session_course_user}\n WHERE session_id = '{$session_id}' AND status <> 2";
Database::query($sql);
}
} else {
if ($debug) {
$logger->addError("Sessions - Session not found");
}
}
}
$session_counter++;
}
$sessionList[] = $session_id;
$users = explode('|', $enreg['Users']);
// Adding the relationship "Session - User" for students
$userList = array();
if (is_array($users)) {
foreach ($users as $user) {
$user_id = UserManager::get_user_id_from_username($user);
if ($user_id !== false) {
$userList[] = $user_id;
// Insert new users.
$sql = "INSERT IGNORE INTO {$tbl_session_user} SET\n user_id = '{$user_id}',\n session_id = '{$session_id}',\n registered_at = '" . api_get_utc_datetime() . "'";
Database::query($sql);
if ($debug) {
$logger->addInfo("Sessions - 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']);
}
}
}
}
}
$courses = explode('|', $enreg['Courses']);
// 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}\n SET c_id = '{$courseId}', session_id='{$session_id}'";
Database::query($sql);
SessionManager::installCourse($session_id, $courseInfo['real_id']);
if ($debug) {
$logger->addInfo("Sessions - 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)) {
SessionManager::subscribe_users_to_session_course($userList, $session_id, $course_code);
if ($debug) {
$msg = "Sessions - Adding student list " . implode(', #', $userList) . " to course: '{$course_code}' and session #{$session_id}";
$logger->addInfo($msg);
}
}
}
// Adding coaches to session course user.
if (!empty($course_coaches)) {
$savedCoaches = array();
// 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 = array();
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 ($coach_id !== false) {
// Just insert new coaches
SessionManager::updateCoaches($session_id, $courseId, array($coach_id), false);
if ($debug) {
$logger->addInfo("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('UserDoesNotExist') . ' : ' . $course_coach . $eol;
}
}
}
// Custom courses/session coaches
$teacherToAdd = null;
// Only one coach is added.
if ($onlyAddFirstCoachOrTeacher == true) {
foreach ($course_coaches as $course_coach) {
$coach_id = UserManager::get_user_id_from_username($course_coach);
if ($coach_id !== false) {
$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']) {
CourseManager::unsubscribe_user($teacher['user_id'], $course_code);
}
}
}
if (!empty($teacherToAdd)) {
SessionManager::updateCoaches($session_id, $courseId, array($teacherToAdd), true);
CourseManager::subscribe_user($teacherToAdd, $course_code, COURSEMANAGER);
}
}
// See BT#6449#note-195
// All coaches are added.
if ($removeAllTeachersFromCourse) {
$teacherToAdd = null;
foreach ($course_coaches as $course_coach) {
$coach_id = UserManager::get_user_id_from_username($course_coach);
if ($coach_id !== false) {
$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)) {
CourseManager::unsubscribe_user($teacher['user_id'], $course_code);
}
}
}
foreach ($teacherToAdd as $teacherId) {
CourseManager::subscribe_user($teacherId, $course_code, COURSEMANAGER);
}
}
}
// Continue default behaviour.
if ($onlyAddFirstCoachOrTeacher == false) {
// Checking one more time see BT#6449#note-149
$coaches = SessionManager::getCoachesByCourseSession($session_id, $courseId);
// Update coaches if only there's 1 course see BT#6449#note-189
if (empty($coaches) || count($courses) == 1) {
foreach ($course_coaches as $course_coach) {
$course_coach = trim($course_coach);
$coach_id = UserManager::get_user_id_from_username($course_coach);
if ($coach_id !== false) {
// Just insert new coaches
SessionManager::updateCoaches($session_id, $courseId, array($coach_id), false);
if ($debug) {
$logger->addInfo("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('UserDoesNotExist') . ' : ' . $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 ($user_id !== false) {
SessionManager::subscribe_users_to_session_course(array($user_id), $session_id, $course_code);
if ($debug) {
$logger->addInfo("Sessions - Adding student: user #{$user_id} ({$user}) to course: '{$course_code}' and session #{$session_id}");
}
} else {
$error_message .= get_lang('UserDoesNotExist') . ': ' . $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);
}
}
return array('error_message' => $error_message, 'session_counter' => $session_counter, 'session_list' => $sessionList);
}
