12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676 |
- <?php
- /*
- ==============================================================================
- Dokeos - elearning and course management software
- Copyright (c) 2004-2005 Dokeos S.A.
- Copyright (c) 2001 Universite catholique de Louvain (UCL)
- Copyright (c) Roan Embrechts, Vrije Universiteit Brussel
- Copyright (c) Bart Mollet, Hogeschool Gent
- Copyright (c) Yannick Warnier, Dokeos S.A.
- For a full list of contributors, see "credits.txt".
- The full license can be read in "license.txt".
- This program is free software; you can redistribute it and/or
- modify it under the terms of the GNU General Public License
- as published by the Free Software Foundation; either version 2
- of the License, or (at your option) any later version.
- See the GNU General Public License for more details.
- Contact address: Dokeos, 44 rue des palais, B-1030 Brussels, Belgium
- Mail: info@dokeos.com
- ==============================================================================
- */
- /**
- ==============================================================================
- * This is the course library for Dokeos.
- *
- * All main course functions should be placed here.
- * Many functions of this library deal with providing support for
- * virtual/linked/combined courses (this was already used in several universities
- * but not available in standard Dokeos).
- *
- * The implementation changed, initially a course was a real course
- * if target_course_code was 0 , this was changed to NULL.
- * There are probably some places left with the wrong code.
- *
- * @package dokeos.library
- ==============================================================================
- */
- /*
- ==============================================================================
- DOCUMENTATION
- (list not up to date, you can auto generate documentation with phpDocumentor)
- CourseManager::get_real_course_code_select_html($element_name, $has_size=true, $only_current_user_courses=true)
- CourseManager::check_parameter($parameter, $error_message)
- CourseManager::check_parameter_or_fail($parameter, $error_message)
- CourseManager::is_existing_course_code($wanted_course_code)
- CourseManager::get_real_course_list()
- CourseManager::get_virtual_course_list()
- GENERAL COURSE FUNCTIONS
- CourseManager::get_access_settings($course_code)
- CourseManager::set_course_tool_visibility($tool_table_id, $visibility)
- CourseManager::get_user_in_course_status($user_id, $course_code)
- CourseManager::add_user_to_course($user_id, $course_code)
- CourseManager::get_virtual_course_info($real_course_code)
- CourseManager::is_virtual_course_from_visual_code($visual_code)
- CourseManager::is_virtual_course_from_system_code($system_code)
- CourseManager::get_virtual_courses_linked_to_real_course($real_course_code)
- CourseManager::get_list_of_virtual_courses_for_specific_user_and_real_course($user_id, $real_course_code)
- CourseManager::has_virtual_courses_from_code($real_course_code, $user_id)
- CourseManager::get_target_of_linked_course($virtual_course_code)
- TITLE AND CODE FUNCTIONS
- CourseManager::determine_course_title_from_course_info($user_id, $course_info)
- CourseManager::create_combined_name($user_is_registered_in_real_course, $real_course_name, $virtual_course_list)
- CourseManager::create_combined_code($user_is_registered_in_real_course, $real_course_code, $virtual_course_list)
- USER FUNCTIONS
- CourseManager::get_real_course_list_of_user_as_course_admin($user_id)
- CourseManager::get_course_list_of_user_as_course_admin($user_id)
- CourseManager::is_user_subscribed_in_course($user_id, $course_code)
- CourseManager::is_user_subscribed_in_real_or_linked_course($user_id, $course_code)
- CourseManager::get_user_list_from_course_code($course_code)
- CourseManager::get_real_and_linked_user_list($course_code);
- GROUP FUNCTIONS
- CourseManager::get_group_list_of_course($course_code)
- CREATION FUNCTIONS
- CourseManager::attempt_create_virtual_course($real_course_code, $course_title, $wanted_course_code, $course_language, $course_category)
- ==============================================================================
- */
- /*
- ==============================================================================
- INIT SECTION
- ==============================================================================
- */
- /*
- -----------------------------------------------------------
- Configuration files
- -----------------------------------------------------------
- */
- include_once (api_get_path(CONFIGURATION_PATH).'add_course.conf.php');
- /*
- -----------------------------------------------------------
- Libraries
- we assume main_api is also included...
- -----------------------------------------------------------
- */
- include_once (api_get_path(LIBRARY_PATH).'database.lib.php');
- include_once (api_get_path(LIBRARY_PATH).'add_course.lib.inc.php');
- /*
- -----------------------------------------------------------
- Constants
- -----------------------------------------------------------
- */
- //LOGIC: course visibility and registration settings
- /*
- COURSE VISIBILITY
- MAPPING OLD SETTINGS TO NEW SETTINGS
- -----------------------
- NOT_VISIBLE_NO_SUBSCRIPTION_ALLOWED
- --> COURSE_VISIBILITY_REGISTERED, SUBSCRIBE_NOT_ALLOWED
- NOT_VISIBLE_SUBSCRIPTION_ALLOWED
- --> COURSE_VISIBILITY_REGISTERED, SUBSCRIBE_ALLOWED
- VISIBLE_SUBSCRIPTION_ALLOWED
- --> COURSE_VISIBILITY_OPEN_PLATFORM, SUBSCRIBE_ALLOWED
- VISIBLE_NO_SUBSCRIPTION_ALLOWED
- --> COURSE_VISIBILITY_OPEN_PLATFORM, SUBSCRIBE_NOT_ALLOWED
- */
- //OLD SETTINGS
- define("NOT_VISIBLE_NO_SUBSCRIPTION_ALLOWED", 0);
- define("NOT_VISIBLE_SUBSCRIPTION_ALLOWED", 1);
- define("VISIBLE_SUBSCRIPTION_ALLOWED", 2);
- define("VISIBLE_NO_SUBSCRIPTION_ALLOWED", 3);
- //NEW SETTINGS
- //these are now defined in the main_api.lib.php
- /*
- COURSE_VISIBILITY_CLOSED
- COURSE_VISIBILITY_REGISTERED
- COURSE_VISIBILITY_OPEN_PLATFORM
- COURSE_VISIBILITY_OPEN_WORLD
- SUBSCRIBE_ALLOWED
- SUBSCRIBE_NOT_ALLOWED
- UNSUBSCRIBE_ALLOWED
- UNSUBSCRIBE_NOT_ALLOWED
- */
- /*
- -----------------------------------------------------------
- Variables
- -----------------------------------------------------------
- */
- $TABLECOURSE = Database :: get_main_table(TABLE_MAIN_COURSE);
- $TABLECOURSDOMAIN = Database :: get_main_table(TABLE_MAIN_CATEGORY);
- $TABLEUSER = Database :: get_main_table(TABLE_MAIN_USER);
- $TABLECOURSUSER = Database :: get_main_table(TABLE_MAIN_COURSE_USER);
- $TABLEANNOUNCEMENTS = "announcement";
- $coursesRepositories = $_configuration['root_sys'];
- /*
- ==============================================================================
- CourseManager CLASS
- ==============================================================================
- */
- /**
- * @package dokeos.library
- */
- class CourseManager
- {
- /**
- * Returns all the information of a given coursecode
- * @param string $course_code, the course code
- * @return an array with all the fields of the course table
- * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
- */
- function get_course_information($course_code)
- {
- $course_table = Database :: get_main_table(TABLE_MAIN_COURSE);
- $sql="SELECT * FROM ".$course_table." WHERE code='".$course_code."'";
- $sql_result = api_sql_query($sql, __FILE__, __LINE__);
- $result = mysql_fetch_array($sql_result);
- return $result;
- }
- /**
- * Returns the access settings of the course:
- * which visibility;
- * wether subscribing is allowed;
- * wether unsubscribing is allowed.
- *
- * @param string $course_code, the course code
- * @todo for more consistency: use course_info call from database API
- * @return an array with int fields "visibility", "subscribe", "unsubscribe"
- */
- function get_access_settings($course_code)
- {
- $course_table = Database :: get_main_table(TABLE_MAIN_COURSE);
- $sql = "SELECT `visibility`, `subscribe`, `unsubscribe` from ".$course_table." where `code` = '".$course_code."'";
- $sql_result = api_sql_query($sql, __FILE__, __LINE__);
- $result = mysql_fetch_array($sql_result);
- return $result;
- }
- /**
- * Returns the status of a user in a course, which is COURSEMANAGER or STUDENT.
- *
- * @return int the status of the user in that course
- */
- function get_user_in_course_status($user_id, $course_code)
- {
- $course_user_table = Database :: get_main_table(TABLE_MAIN_COURSE_USER);
- $sql_query = "SELECT * FROM $course_user_table WHERE `course_code` = '$course_code' AND `user_id` = '$user_id'";
- $sql_result = api_sql_query($sql_query, __FILE__, __LINE__);
- $result = mysql_fetch_array($sql_result);
- return $result["status"];
- }
- /**
- * Unsubscribe one or more users from a course
- * @param int|array $user_id
- * @param string $course_code
- */
- function unsubscribe_user($user_id, $course_code)
- {
- if(!is_array($user_id))
- {
- $user_id = array($user_id);
- }
- if(count($user_id) == 0)
- {
- return;
- }
- $user_ids = implode(',', $user_id);
- $table_course_user = Database :: get_main_table(TABLE_MAIN_COURSE_USER);
- $table_course = Database :: get_main_table(TABLE_MAIN_COURSE);
- // Unsubscribe user from all groups in the course
- $sql = "SELECT * FROM $table_course WHERE code = '".$course_code."'";
- $res = api_sql_query($sql, __FILE__, __LINE__);
- $course = mysql_fetch_object($res);
- $table_group = Database :: get_course_table(TABLE_GROUP_USER, $course->db_name);
- $sql = "DELETE FROM $table_group WHERE user_id IN (".$user_ids.")";
- api_sql_query($sql, __FILE__, __LINE__);
- // Unsubscribe user from all blogs in the course
- $table_blog_user = Database::get_course_table(TABLE_BLOGS_REL_USER, $course->db_name);
- $sql = "DELETE FROM ".$table_blog_user." WHERE user_id IN (".$user_ids.")";
- api_sql_query($sql,__FILE__,__LINE__);
- $table_blogtask_user = Database::get_course_table(TABLE_BLOGS_TASKS_REL_USER, $course->db_name);
- $sql = "DELETE FROM ".$table_blogtask_user." WHERE user_id IN (".$user_ids.")";
- api_sql_query($sql,__FILE__,__LINE__);
- // Unsubscribe user from the course
- $sql = "DELETE FROM $table_course_user WHERE user_id IN (".$user_ids.") AND course_code = '".$course_code."'";
- api_sql_query($sql, __FILE__, __LINE__);
- }
- /**
- * Subscribe a user to a course. No checks are performed here to see if
- * course subscription is allowed.
- * @see add_user_to_course
- */
- function subscribe_user($user_id, $course_code, $status = STUDENT)
- {
- $user_table = Database :: get_main_table(TABLE_MAIN_USER);
- $course_table = Database :: get_main_table(TABLE_MAIN_COURSE);
- $course_user_table = Database :: get_main_table(TABLE_MAIN_COURSE_USER);
- $location_table = Database :: get_main_table(MAIN_LOCATION_TABLE);
- $user_role_table = Database :: get_main_table(MAIN_USER_ROLE_TABLE);
- $status = ($status == STUDENT || $status == COURSEMANAGER) ? $status : STUDENT;
- $role_id = ($status == COURSEMANAGER) ? COURSE_ADMIN : NORMAL_COURSE_MEMBER;
- if (empty ($user_id) || empty ($course_code))
- {
- return false;
- }
- else
- {
- // previously check if the user are already registered on the platform
- $handle = api_sql_query("SELECT status FROM ".$user_table."
- WHERE `user_id` = '$user_id' ");
- if (mysql_num_rows($handle) == 0)
- {
- return false; // the user isn't registered to the platform
- }
- else
- {
- //check if user isn't already subscribed to the course
- $handle = api_sql_query("SELECT * FROM ".$course_user_table."
- WHERE `user_id` = '$user_id'
- AND `course_code` ='$course_code'");
- if (mysql_num_rows($handle) > 0)
- {
- return false; // the user is already subscribed to the course
- }
- else
- {
- $course_sort = CourseManager :: userCourseSort($user_id,$course_code);
- $add_course_user_entry_sql = "INSERT INTO ".$course_user_table."
- SET `course_code` = '$course_code',
- `user_id` = '$user_id',
- `status` = '".$status."',
- `sort` = '". ($course_sort)."'";
- $result = api_sql_query($add_course_user_entry_sql);
- if ($result)
- {
- return true;
- }
- else
- {
- return false;
- }
- }
- }
- }
- }
- /**
- * Subscribe a user $user_id to a course $course_code.
- * @author Hugues Peeters
- * @author Roan Embrechts
- *
- * @param int $user_id the id of the user
- * @param string $course_code the course code
- * @param string $status (optional) The user's status in the course
- *
- * @return boolean true if subscription succeeds, boolean false otherwise.
- * @todo script has ugly ifelseifelseifelseif structure, improve
- */
- function add_user_to_course($user_id, $course_code, $status = STUDENT)
- {
- $user_table = Database :: get_main_table(TABLE_MAIN_USER);
- $course_table = Database :: get_main_table(TABLE_MAIN_COURSE);
- $course_user_table = Database :: get_main_table(TABLE_MAIN_COURSE_USER);
- $status = ($status == STUDENT || $status == COURSEMANAGER) ? $status : STUDENT;
- if (empty($user_id) || empty ($course_code))
- {
- return false;
- }
- else
- {
- // previously check if the user are already registered on the platform
- $handle = api_sql_query("SELECT status FROM ".$user_table."
- WHERE `user_id` = '$user_id' ");
- if (mysql_num_rows($handle) == 0)
- {
- return false; // the user isn't registered to the platform
- }
- else
- {
- //check if user isn't already subscribed to the course
- $handle = api_sql_query("SELECT * FROM ".$course_user_table."
- WHERE `user_id` = '$user_id'
- AND `course_code` ='$course_code'");
- if (mysql_num_rows($handle) > 0)
- {
- return false; // the user is already subscribed to the course
- }
- else
- {
- // previously check if subscription is allowed for this course
- $handle = api_sql_query("SELECT code, visibility FROM ".$course_table."
- WHERE `code` = '$course_code'
- AND `subscribe` = '".SUBSCRIBE_NOT_ALLOWED."'");
- if (mysql_num_rows($handle) > 0)
- {
- return false; // subscription not allowed for this course
- }
- else
- {
- $max_sort = api_max_sort_value('0', $user_id);
- $add_course_user_entry_sql = "INSERT INTO ".$course_user_table."
- SET `course_code` = '$course_code',
- `user_id` = '$user_id',
- `status` = '".$status."',
- `sort` = '". ($max_sort +1)."'";
- $result=api_sql_query($add_course_user_entry_sql);
- if ($result)
- {
- return true;
- }
- else
- {
- return false;
- }
- }
- }
- }
- }
- }
- /**
- * This code creates a select form element to let the user
- * choose a real course to link to.
- *
- * A good non-display library should not use echo statements, but just return text/html
- * so users of the library can choose when to display.
- *
- * We display the course code, but internally store the course id.
- *
- * @param boolean $has_size, true the select tag gets a size element, false it stays a dropdownmenu
- * @param boolean $only_current_user_courses, true only the real courses of which the
- * current user is course admin are displayed, false all real courses are shown.
- * @param string $element_name the name of the select element
- * @return a string containing html code for a form select element.
- * @deprecated Function not in use
- */
- function get_real_course_code_select_html($element_name, $has_size = true, $only_current_user_courses = true, $user_id)
- {
- if ($only_current_user_courses == true)
- {
- $real_course_list = CourseManager :: get_real_course_list_of_user_as_course_admin($user_id);
- }
- else
- {
- $real_course_list = CourseManager :: get_real_course_list();
- }
- if ($has_size == true)
- {
- $size_element = "size=\"".SELECT_BOX_SIZE."\"";
- }
- else
- {
- $size_element = "";
- }
- $html_code = "<select name=\"$element_name\" $size_element >\n";
- foreach ($real_course_list as $real_course)
- {
- $course_code = $real_course["code"];
- $html_code .= "<option value=\"".$course_code."\">";
- $html_code .= $course_code;
- $html_code .= "</option>\n";
- }
- $html_code .= "</select>\n";
- return $html_code;
- }
- /**
- * Checks wether a parameter exists.
- * If it doesn't, the function displays an error message.
- *
- * @return true if parameter is set and not empty, false otherwise
- * @todo move function to better place, main_api ?
- */
- function check_parameter($parameter, $error_message)
- {
- if (!isset ($parameter) || empty ($parameter))
- {
- Display :: display_normal_message($error_message);
- return false;
- }
- return true;
- }
- /**
- * Lets the script die when a parameter check fails.
- * @todo move function to better place, main_api ?
- */
- function check_parameter_or_fail($parameter, $error_message)
- {
- if (!CourseManager :: check_parameter($parameter, $error_message))
- die();
- }
- /**
- * @return true if there already are one or more courses
- * with the same code OR visual_code (visualcode), false otherwise
- */
- function is_existing_course_code($wanted_course_code)
- {
- $course_table = Database :: get_main_table(TABLE_MAIN_COURSE);
- $sql_query = "SELECT COUNT(*) as number FROM ".$course_table."WHERE `code` = '$wanted_course_code' OR `visual_code` = '$wanted_course_code' ";
- $sql_result = api_sql_query($sql_query, __FILE__, __LINE__);
- $result = mysql_fetch_array($sql_result);
- if ($result["number"] > 0)
- {
- return true;
- }
- else
- {
- return false;
- }
- }
- /**
- * @return an array with the course info of all real courses on the platform
- */
- function get_real_course_list()
- {
- $course_table = Database :: get_main_table(TABLE_MAIN_COURSE);
- $sql_query = "SELECT * FROM $course_table WHERE `target_course_code` IS NULL";
- $sql_result = api_sql_query($sql_query, __FILE__, __LINE__);
- while ($result = mysql_fetch_array($sql_result))
- {
- $real_course_list[] = $result;
- }
- return $real_course_list;
- }
- /**
- * @return an array with the course info of all virtual courses on the platform
- */
- function get_virtual_course_list()
- {
- $course_table = Database :: get_main_table(TABLE_MAIN_COURSE);
- $sql_query = "SELECT * FROM $course_table WHERE `target_course_code` IS NOT NULL";
- $sql_result = api_sql_query($sql_query, __FILE__, __LINE__);
- while ($result = mysql_fetch_array($sql_result))
- {
- $virtual_course_list[] = $result;
- }
- return $virtual_course_list;
- }
- /**
- * @return an array with the course info of the real courses of which
- * the current user is course admin
- */
- function get_real_course_list_of_user_as_course_admin($user_id)
- {
- $course_table = Database :: get_main_table(TABLE_MAIN_COURSE);
- $course_user_table = Database :: get_main_table(TABLE_MAIN_COURSE_USER);
- $sql_query = " SELECT *
- FROM $course_table course
- LEFT JOIN $course_user_table course_user
- ON course.`code` = course_user.`course_code`
- WHERE course.`target_course_code` IS NULL
- AND course_user.`user_id` = '$user_id'
- AND course_user.`status` = '1'";
- //api_display_debug_info($sql_query);
- $sql_result = api_sql_query($sql_query, __FILE__, __LINE__);
- while ($result = mysql_fetch_array($sql_result))
- {
- $result_array[] = $result;
- }
- return $result_array;
- }
- /**
- * @return an array with the course info of all the courses (real and virtual) of which
- * the current user is course admin
- */
- function get_course_list_of_user_as_course_admin($user_id)
- {
- $course_table = Database :: get_main_table(TABLE_MAIN_COURSE);
- $course_user_table = Database :: get_main_table(TABLE_MAIN_COURSE_USER);
- $sql_query = " SELECT *
- FROM $course_table course
- LEFT JOIN $course_user_table course_user
- ON course.`code` = course_user.`course_code`
- WHERE course_user.`user_id` = '$user_id'
- AND course_user.`status` = '1'";
- $sql_result = api_sql_query($sql_query, __FILE__, __LINE__);
- while ($result = mysql_fetch_array($sql_result))
- {
- $result_array[] = $result;
- }
- return $result_array;
- }
- /**
- * Find out for which courses the user is registered and determine a visual course code and course title from that.
- * Takes virtual courses into account
- *
- * Default case: the name and code stay what they are.
- *
- * Scenarios:
- * - User is registered in real course and virtual courses; name / code become a mix of all
- * - User is registered in real course only: name stays that of real course
- * - User is registered in virtual course only: name becomes that of virtual course
- * - user is not registered to any of the real/virtual courses: name stays that of real course
- * (I'm not sure about the last case, but this seems not too bad)
- *
- * @author Roan Embrechts
- * @param $user_id, the id of the user
- * @param $course_info, an array with course info that you get using Database::get_course_info($course_system_code);
- * @return an array with indices
- * $return_result["title"] - the course title of the combined courses
- * $return_result["code"] - the course code of the combined courses
- */
- function determine_course_title_from_course_info($user_id, $course_info)
- {
- $real_course_id = $course_info['system_code'];
- $real_course_info = Database :: get_course_info($real_course_id);
- $real_course_name = $real_course_info["title"];
- $real_course_visual_code = $real_course_info["visual_code"];
- $real_course_real_code = $course_info['system_code'];
- //is the user registered in the real course?
- $table = Database :: get_main_table(TABLE_MAIN_COURSE_USER);
- $sql_query = "SELECT * FROM $table WHERE `user_id` = '$user_id' AND `course_code` = '$real_course_real_code'";
- $sql_result = api_sql_query($sql_query, __FILE__, __LINE__);
- $result = mysql_fetch_array($sql_result);
- if (!isset ($result) || empty ($result))
- {
- $user_is_registered_in_real_course = false;
- }
- else
- {
- $user_is_registered_in_real_course = true;
- }
- //get a list of virtual courses linked to the current real course
- //and to which the current user is subscribed
- $user_subscribed_virtual_course_list = CourseManager :: get_list_of_virtual_courses_for_specific_user_and_real_course($user_id, $real_course_id);
- if (count($user_subscribed_virtual_course_list) > 0)
- {
- $virtual_courses_exist = true;
- }
- else
- {
- $virtual_courses_exist = false;
- }
- //now determine course code and name
- if ($user_is_registered_in_real_course && $virtual_courses_exist)
- {
- $course_info["name"] = CourseManager :: create_combined_name($user_is_registered_in_real_course, $real_course_name, $user_subscribed_virtual_course_list);
- $course_info['official_code'] = CourseManager :: create_combined_code($user_is_registered_in_real_course, $real_course_visual_code, $user_subscribed_virtual_course_list);
- }
- else
- if ($user_is_registered_in_real_course)
- {
- //course name remains real course name
- $course_info["name"] = $real_course_name;
- $course_info['official_code'] = $real_course_visual_code;
- }
- else
- if ($virtual_courses_exist)
- {
- $course_info["name"] = CourseManager :: create_combined_name($user_is_registered_in_real_course, $real_course_name, $user_subscribed_virtual_course_list);
- $course_info['official_code'] = CourseManager :: create_combined_code($user_is_registered_in_real_course, $real_course_visual_code, $user_subscribed_virtual_course_list);
- }
- else
- {
- //course name remains real course name
- $course_info["name"] = $real_course_name;
- $course_info['official_code'] = $real_course_visual_code;
- }
- $return_result["title"] = $course_info["name"];
- $return_result["code"] = $course_info['official_code'];
- return $return_result;
- }
- /**
- * Create a course title based on all real and virtual courses the user is registered in.
- * @param boolean $user_is_registered_in_real_course
- * @param string $real_course_name, the title of the real course
- * @param array $virtual_course_list, the list of virtual courses
- */
- function create_combined_name($user_is_registered_in_real_course, $real_course_name, $virtual_course_list)
- {
- if ($user_is_registered_in_real_course || count($virtual_course_list) > 1)
- {
- $complete_course_name_before = get_lang("CombinedCourse")." "; //from course_home lang file
- }
- if ($user_is_registered_in_real_course)
- {
- //add real name to result
- $complete_course_name[] = $real_course_name;
- }
- //add course titles of all virtual courses to the list
- foreach ($virtual_course_list as $current_course)
- {
- $complete_course_name[] = $current_course["title"];
- }
- $complete_course_name = $complete_course_name_before.implode(' & ', $complete_course_name);
- return $complete_course_name;
- }
- /**
- * Create a course code based on all real and virtual courses the user is registered in.
- */
- function create_combined_code($user_is_registered_in_real_course, $real_course_code, $virtual_course_list)
- {
- $complete_course_code .= "";
- if ($user_is_registered_in_real_course)
- {
- //add real name to result
- $complete_course_code[] = $real_course_code;
- }
- //add course titles of all virtual courses to the list
- foreach ($virtual_course_list as $current_course)
- {
- $complete_course_code[] = $current_course["visual_code"];
- }
- $complete_course_code = implode(' & ', $complete_course_code);
- return $complete_course_code;
- }
- /**
- * Return course info array of virtual course
- *
- * Note this is different from getting information about a real course!
- *
- * @param $real_course_code, the id of the real course which the virtual course is linked to
- */
- function get_virtual_course_info($real_course_code)
- {
- $table = Database :: get_main_table(TABLE_MAIN_COURSE);
- $sql_query = "SELECT * FROM $table WHERE `target_course_code` = '$real_course_code'";
- $sql_result = api_sql_query($sql_query, __FILE__, __LINE__);
- $result = array ();
- while ($virtual_course = mysql_fetch_array($sql_result))
- {
- $result[] = $virtual_course;
- }
- return $result;
- }
- /**
- * @param string $system_code, the system code of the course
- * @return true if the course is a virtual course, false otherwise
- */
- function is_virtual_course_from_system_code($system_code)
- {
- $table = Database :: get_main_table(TABLE_MAIN_COURSE);
- $sql_query = "SELECT * FROM $table WHERE `code` = '$system_code'";
- $sql_result = api_sql_query($sql_query, __FILE__, __LINE__);
- $result = mysql_fetch_array($sql_result);
- $target_number = $result["target_course_code"];
- if ($target_number == NULL)
- {
- return false; //this is not a virtual course
- }
- else
- {
- return true; //this is a virtual course
- }
- }
- /**
- * What's annoying is that you can't overload functions in PHP.
- * @return true if the course is a virtual course, false otherwise
- */
- function is_virtual_course_from_visual_code($visual_code)
- {
- $table = Database :: get_main_table(TABLE_MAIN_COURSE);
- $sql_query = "SELECT * FROM $table WHERE `visual_code` = '$visual_code'";
- $sql_result = api_sql_query($sql_query, __FILE__, __LINE__);
- $result = mysql_fetch_array($sql_result);
- $target_number = $result["target_course_code"];
- if ($target_number == NULL)
- {
- return false; //this is not a virtual course
- }
- else
- {
- return true; //this is a virtual course
- }
- }
- /**
- * @return true if the real course has virtual courses that the user is subscribed to, false otherwise
- */
- function has_virtual_courses_from_code($real_course_code, $user_id)
- {
- $user_subscribed_virtual_course_list = CourseManager :: get_list_of_virtual_courses_for_specific_user_and_real_course($user_id, $real_course_code);
- $number_of_virtual_courses = count($user_subscribed_virtual_course_list);
- if (count($user_subscribed_virtual_course_list) > 0)
- {
- return true;
- }
- else
- {
- return false;
- }
- }
- /**
- * Return an array of arrays, listing course info of all virtual course
- * linked to the real course ID $real_course_code
- *
- * @param $real_course_code, the id of the real course which the virtual courses are linked to
- */
- function get_virtual_courses_linked_to_real_course($real_course_code)
- {
- $table = Database :: get_main_table(TABLE_MAIN_COURSE);
- $sql_query = "SELECT * FROM $table WHERE `target_course_code` = '$real_course_code'";
- $sql_result = api_sql_query($sql_query, __FILE__, __LINE__);
- $result_array = array ();
- while ($result = mysql_fetch_array($sql_result))
- {
- $result_array[] = $result;
- }
- return $result_array;
- }
- /**
- * This function returns the course code of the real course
- * to which a virtual course is linked.
- *
- * @param the course code of the virtual course
- * @return the course code of the real course
- */
- function get_target_of_linked_course($virtual_course_code)
- {
- $course_table = Database :: get_main_table(TABLE_MAIN_COURSE);
- //get info about the virtual course
- $sql_query = "SELECT * FROM $course_table WHERE `code` = '$virtual_course_code'";
- $sql_result = api_sql_query($sql_query, __FILE__, __LINE__);
- $result = mysql_fetch_array($sql_result);
- $target_course_code = $result["target_course_code"];
- return $target_course_code;
- }
- /*
- ==============================================================================
- USER FUNCTIONS
- ==============================================================================
- */
- /**
- * Return course info array of virtual course
- *
- * @param $user_id, the id (int) of the user
- * @param $course_info, array with info about the course (comes from course table)
- *
- * @return true if the user is registered in the course, false otherwise
- */
- function is_user_subscribed_in_course($user_id, $course_code, $in_a_session=false)
- {
- $user_id = intval($user_id);
- $course_code = addslashes($course_code);
-
- $table = Database :: get_main_table(TABLE_MAIN_COURSE_USER);
- $sql_query = "SELECT * FROM $table WHERE `user_id` = '$user_id' AND `course_code` = '$course_code'";
- $sql_result = api_sql_query($sql_query, __FILE__, __LINE__);
- $result = mysql_fetch_array($sql_result);
- if (!isset ($result) || empty ($result))
- {
- if($in_a_session)
- {
- $sql = 'SELECT 1 FROM '.Database :: get_main_table(TABLE_MAIN_SESSION_COURSE_USER).'
- WHERE id_user = '.$user_id.' AND course_code="'.$course_code.'"';
-
- $rs = api_sql_query($sql, __FILE__, __LINE__);
- if(mysql_num_rows($rs)>0)
- {
- return true;
- }
- else{
- $sql = 'SELECT 1 FROM '.Database :: get_main_table(TABLE_MAIN_SESSION_COURSE).'
- WHERE id_coach = '.$user_id.' AND course_code="'.$course_code.'"';
- $rs = api_sql_query($sql, __FILE__, __LINE__);
- if(mysql_num_rows($rs)>0)
- {
- return true;
- }
- }
- }
- else
- return false; //user is not registered in course
- }
- else
- {
- return true; //user is registered in course
- }
- }
-
- /**
- * Is the user a teacher in the given course?
- *
- * @param $user_id, the id (int) of the user
- * @param $course_code, the course code
- *
- * @return true if the user is a teacher in the course, false otherwise
- */
- function is_course_teacher($user_id,$course_code)
- {
- $tbl_course_user = Database::get_main_table(TABLE_MAIN_COURSE_USER);
- $sql_query='SELECT status FROM '.$tbl_course_user.' WHERE course_code="'.$course_code.'" and user_id="'.$user_id.'"';
- $sql_result = api_sql_query($sql_query, __FILE__, __LINE__);
- if(Database::num_rows($sql_result)>0)
- {
- $status=mysql_result($sql_result,0,'status');
- if($status==1) return true; else return false;
- }
- return false;
- }
- /**
- * Is the user subscribed in the real course or linked courses?
- *
- * @param $user_id, the id (int) of the user
- * @param $course_info, array with info about the course (comes from course table, see database lib)
- *
- * @return true if the user is registered in the real course or linked courses, false otherwise
- */
- function is_user_subscribed_in_real_or_linked_course($user_id, $course_code, $session_id='')
- {
- if($session_id==''){
- $course_table = Database :: get_main_table(TABLE_MAIN_COURSE);
- $course_user_table = Database :: get_main_table(TABLE_MAIN_COURSE_USER);
- $sql_query = " SELECT *
- FROM $course_table course
- LEFT JOIN $course_user_table course_user
- ON course.`code` = course_user.`course_code`
- WHERE course_user.`user_id` = '$user_id' AND ( course.`code` = '$course_code' OR `target_course_code` = '$course_code') ";
- $sql_result = api_sql_query($sql_query, __FILE__, __LINE__);
- $result = mysql_fetch_array($sql_result);
- if (!isset ($result) || empty ($result))
- {
- return false; //user is not registered in course
- }
- else
- {
- return true; //user is registered in course
- }
- }
- else {
- // is he subscribed to the course of the session ?
- // Database Table Definitions
- $tbl_sessions = Database::get_main_table(TABLE_MAIN_SESSION);
- $tbl_sessions_course = Database::get_main_table(TABLE_MAIN_SESSION_COURSE);
- $tbl_session_course_user= Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER);
- //users
- $sql = "SELECT id_user
- FROM $tbl_session_course_user
- WHERE id_session='".$_SESSION['id_session']."'
- AND id_user='$user_id'";
- $result = api_sql_query($sql,__FILE__,__LINE__);
- if(mysql_num_rows($result))
- return true;
- // is it a course coach ?
- $sql = "SELECT id_coach
- FROM $tbl_sessions_course AS session_course
- WHERE id_session='".$_SESSION['id_session']."'
- AND id_coach = '$user_id'
- AND course_code='$course_code'";
- $result = api_sql_query($sql,__FILE__,__LINE__);
- if(mysql_num_rows($result))
- return true;
- // is it a session coach ?
- $sql = "SELECT id_coach
- FROM $tbl_sessions AS session
- WHERE session.id='".$_SESSION['id_session']."'
- AND id_coach='$user_id'";
- $result = api_sql_query($sql,__FILE__,__LINE__);
- if(mysql_num_rows($result))
- return true;
- return false;
- }
- }
-
- /**
- * Return user info array of all users registered in the specified real or virtual course
- * This only returns the users that are registered in this actual course, not linked courses.
- *
- * @param string $course_code
- * @return array with user info
- */
- function get_user_list_from_course_code($course_code, $with_session=true, $session_id=0){
-
- $session_id = intval($session_id);
- $a_users = array();
-
- $table_users = Database :: get_main_table(TABLE_MAIN_USER);
-
- // users subscribed to the course through a session
- if(api_get_setting('use_session_mode')=='true' && $with_session){
-
- $table_session_course_user = Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER);
-
- $sql_query = "SELECT session_course_user.*, user.user_id FROM $table_session_course_user as session_course_user, $table_users as user WHERE `course_code` = '$course_code' AND session_course_user.id_user = user.user_id ";
- if($session_id!=0)
- $sql_query .= ' AND id_session = '.$session_id;
- $sql_query.=' ORDER BY user.lastname';
-
- $rs = api_sql_query($sql_query, __FILE__, __LINE__);
- while($user = mysql_fetch_array($rs))
- {
- $user_infos = Database :: get_user_info_from_id($user['id_user']);
- $user_infos["status"] = $user["status"];
- $user_infos["role"] = $user["role"];
- $user_infos["tutor_id"] = $user["tutor_id"];
- $a_users[$user['id_user']] = $user_infos;
- }
-
- }
-
- if($session_id == 0){
-
- // users directly subscribed to the course
- $table_course_user = Database :: get_main_table(TABLE_MAIN_COURSE_USER);
-
- $sql_query = "SELECT course_user.user_id, user.user_id, course_user.status, course_user.role, course_user.tutor_id " .
- "FROM $table_course_user as course_user, $table_users as user WHERE `course_code` = '$course_code' AND course_user.user_id = user.user_id ORDER BY user.lastname";
-
- $rs = api_sql_query($sql_query, __FILE__, __LINE__);
-
- while($user = mysql_fetch_array($rs))
- {
- $user_infos = Database :: get_user_info_from_id($user['user_id']);
- $user_infos["status"] = $user["status"];
- $user_infos["role"] = $user["role"];
- $user_infos["tutor_id"] = $user["tutor_id"];
- $a_users[$user['user_id']] = $user_infos;
- }
-
- }
-
- return $a_users;
-
- }
-
-
- function get_coach_list_from_course_code($course_code,$session_id){
-
- $table_session_course = Database :: get_main_table(TABLE_MAIN_SESSION_COURSE);
- $table_session = Database :: get_main_table(TABLE_MAIN_SESSION);
-
- $a_users=array();
-
- //We get the coach for the given course in a given session
- $sql = 'SELECT id_coach FROM '.$table_session_course.' WHERE id_session="'.$session_id.'" AND course_code="'.$course_code.'"';
- $rs = api_sql_query($sql, __FILE__, __LINE__);
- while($user = mysql_fetch_array($rs))
- {
- $user_infos = Database :: get_user_info_from_id($user['id_coach']);
- $user_infos["status"] = $user["status"];
- $user_infos["role"] = $user["role"];
- $user_infos["tutor_id"] = $user["tutor_id"];
- $user_infos['email'] = $user['email'];
- $a_users[$user['id_coach']] = $user_infos;
- }
-
- //We get the session coach
- $sql = 'SELECT id_coach FROM '.$table_session.' WHERE id="'.$session_id.'"';
- $rs = api_sql_query($sql, __FILE__, __LINE__);
- $user_infos=array();
- $session_id_coach = mysql_result($rs,0,'id_coach');
- $user_infos = Database :: get_user_info_from_id($session_id_coach);
- $user_infos["status"] = $user["status"];
- $user_infos["role"] = $user["role"];
- $user_infos["tutor_id"] = $user["tutor_id"];
- $user_infos['email'] = $user['email'];
- $a_users[$session_id_coach] = $user_infos;
-
- return $a_users;
-
- }
-
-
- /**
- * Return user info array of all users registered in the specified real or virtual course
- * This only returns the users that are registered in this actual course, not linked courses.
- *
- * @param string $course_code
- * @param boolean $full list to true if we want sessions students too
- * @return array with user id
- */
- function get_student_list_from_course_code($course_code, $with_session=false, $session_id=0)
- {
- $a_students = array();
-
- $session_id = intval($session_id);
-
- if($session_id == 0)
- {
- // students directly subscribed to the course
- $table = Database :: get_main_table(TABLE_MAIN_COURSE_USER);
- $sql_query = "SELECT * FROM $table WHERE `course_code` = '$course_code' AND `status` = 5";
- $rs = api_sql_query($sql_query, __FILE__, __LINE__);
- while($student = mysql_fetch_array($rs))
- {
- $a_students[$student['user_id']] = $student;
- }
- }
-
- // students subscribed to the course through a session
-
- if(api_get_setting('use_session_mode')=='true' && $with_session)
- {
- $table = Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER);
- $sql_query = "SELECT * FROM $table WHERE `course_code` = '$course_code'";
- if($session_id!=0)
- $sql_query .= ' AND id_session = '.$session_id;
- $rs = api_sql_query($sql_query, __FILE__, __LINE__);
- while($student = mysql_fetch_array($rs))
- {
- $a_students[$student['id_user']] = $student;
- }
- }
-
- return $a_students;
- }
- /**
- * Return user info array of all teacher-users registered in the specified real or virtual course
- * This only returns the users that are registered in this actual course, not linked courses.
- *
- * @param string $course_code
- * @return array with user id
- */
- function get_teacher_list_from_course_code($course_code)
- {
- $a_teachers = array();
- // teachers directly subscribed to the course
- $t_cu = Database :: get_main_table(TABLE_MAIN_COURSE_USER);
- $t_u = Database :: get_main_table(TABLE_MAIN_USER);
- $sql_query = "SELECT u.user_id, u.lastname, u.firstname, u.email, u.username, u.status " .
- "FROM $t_cu cu, $t_u u " .
- "WHERE cu.course_code = '$course_code' " .
- "AND cu.status = 1 " .
- "AND cu.user_id = u.user_id";
- $rs = api_sql_query($sql_query, __FILE__, __LINE__);
- while($teacher = mysql_fetch_array($rs))
- {
- $a_students[$teacher['user_id']] = $teacher;
- }
- return $a_students;
- }
- /**
- * Return user info array of all users registered in the specified course
- * this includes the users of the course itsel and the users of all linked courses.
- *
- * @param array $course_info
- * @return array with user info
- */
- function get_real_and_linked_user_list($course_code, $with_sessions = true, $session_id=0)
- {
- //get list of virtual courses
- $virtual_course_list = CourseManager :: get_virtual_courses_linked_to_real_course($course_code);
- //get users from real course
- $user_list = CourseManager :: get_user_list_from_course_code($course_code, $with_sessions, $session_id);
- foreach ($user_list as $this_user)
- {
- $complete_user_list[] = $this_user;
- }
- //get users from linked courses
- foreach ($virtual_course_list as $this_course)
- {
- $course_code = $this_course["code"];
- $user_list = CourseManager :: get_user_list_from_course_code($course_code, $with_sessions, $session_id);
- foreach ($user_list as $this_user)
- {
- $complete_user_list[] = $this_user;
- }
- }
- return $complete_user_list;
- }
- /**
- * Return an array of arrays, listing course info of all courses in the list
- * linked to the real course $real_course_code, to which the user $user_id is subscribed.
- *
- * @param $user_id, the id (int) of the user
- * @param $real_course_code, the id (char) of the real course
- *
- * @return array of course info arrays
- */
- function get_list_of_virtual_courses_for_specific_user_and_real_course($user_id, $real_course_code)
- {
- $course_table = Database :: get_main_table(TABLE_MAIN_COURSE);
- $course_user_table = Database :: get_main_table(TABLE_MAIN_COURSE_USER);
- $sql_query = " SELECT *
- FROM $course_table course
- LEFT JOIN $course_user_table course_user
- ON course.`code` = course_user.`course_code`
- WHERE course.`target_course_code` = '$real_course_code' AND course_user.`user_id` = '$user_id'";
-
- $sql_result = api_sql_query($sql_query, __FILE__, __LINE__);
- while ($result = mysql_fetch_array($sql_result))
- {
- $result_array[] = $result;
- }
- return $result_array;
- }
- /*
- ==============================================================================
- GROUP FUNCTIONS
- ==============================================================================
- */
- function get_group_list_of_course($course_code)
- {
- $course_info = Database :: get_course_info($course_code);
- $database_name = $course_info['db_name'];
- $group_table = Database :: get_course_table(TABLE_GROUP, $database_name);
- $group_user_table = Database :: get_course_table(TABLE_GROUP_USER, $database_name);
- $sql = "SELECT g.id, g.name, COUNT(gu.id) userNb
- FROM $group_table AS g LEFT JOIN $group_user_table gu
- ON g.id = gu.group_id
- GROUP BY g.id
- ORDER BY g.name";
- $result = api_sql_query($sql, __FILE__, __LINE__) or die(mysql_error());
- while ($group_data = mysql_fetch_array($result))
- {
- $group_list[$group_data['id']] = $group_data;
- }
- return $group_list;
- }
- /**
- * Checks all parameters needed to create a virtual course.
- * If they are all set, the virtual course creation procedure is called.
- *
- * Call this function instead of create_virtual_course
- */
- function attempt_create_virtual_course($real_course_code, $course_title, $wanted_course_code, $course_language, $course_category)
- {
- //better: create parameter list, check the entire list, when false display errormessage
- CourseManager :: check_parameter_or_fail($real_course_code, "Unspecified parameter: real course id.");
- CourseManager :: check_parameter_or_fail($course_title, "Unspecified parameter: course title.");
- CourseManager :: check_parameter_or_fail($wanted_course_code, "Unspecified parameter: wanted course code.");
- CourseManager :: check_parameter_or_fail($course_language, "Unspecified parameter: course language.");
- CourseManager :: check_parameter_or_fail($course_category, "Unspecified parameter: course category.");
- $creation_success = CourseManager :: create_virtual_course($real_course_code, $course_title, $wanted_course_code, $course_language, $course_category);
- return $creation_success;
- }
- /**
- * This function creates a virtual course.
- * It assumes all parameters have been checked and are not empty.
- * It checks wether a course with the $wanted_course_code already exists.
- *
- * Users of this library should consider this function private,
- * please call attempt_create_virtual_course instead of this one.
- *
- * NOTE:
- * The virtual course 'owner' id (the first course admin) is set to the CURRENT user id.
- * @return true if the course creation succeeded, false otherwise
- * @todo research: expiration date of a course
- */
- function create_virtual_course($real_course_code, $course_title, $wanted_course_code, $course_language, $course_category)
- {
- global $firstExpirationDelay;
- $course_table = Database :: get_main_table(TABLE_MAIN_COURSE);
- $user_id = api_get_user_id();
- $real_course_info = Database :: get_course_info($real_course_code);
- $real_course_code = $real_course_info["system_code"];
- //check: virtual course creation fails if another course has the same
- //code, real or fake.
- if (CourseManager :: is_existing_course_code($wanted_course_code))
- {
- Display :: display_error_message($wanted_course_code." - ".get_lang("CourseCodeAlreadyExists"));
- return false;
- }
- //add data to course table, course_rel_user
- $course_sys_code = $wanted_course_code;
- $course_screen_code = $wanted_course_code;
- $course_repository = $real_course_info["directory"];
- $course_db_name = $real_course_info["db_name"];
- $responsible_teacher = $real_course_info["tutor_name"];
- $faculty_shortname = $course_category;
- // $course_title = $course_title;
- // $course_language = $course_language;
- $teacher_id = $user_id;
- //HACK ----------------------------------------------------------------
- $expiration_date = time() + $firstExpirationDelay;
- //END HACK ------------------------------------------------------------
- register_course($course_sys_code, $course_screen_code, $course_repository, $course_db_name, $responsible_teacher, $faculty_shortname, $course_title, $course_language, $teacher_id, $expiration_date);
- //above was the normal course creation table update call,
- //now one more thing: fill in the target_course_code field
- $sql_query = "UPDATE $course_table SET `target_course_code` = '$real_course_code' WHERE `code` = '$course_sys_code' LIMIT 1 ";
- api_sql_query($sql_query, __FILE__, __LINE__);
- return true;
- }
- /**
- * Delete a course
- * This function deletes a whole course-area from the platform. When the
- * given course is a virtual course, the database and directory will not be
- * deleted.
- * When the given course is a real course, also all virtual courses refering
- * to the given course will be deleted.
- * Considering the fact that we remove all traces of the course in the main
- * database, it makes sense to remove all tracking as well (if stats databases exist)
- * so that a new course created with this code would not use the remains of an older
- * course.
- *
- * @param string $code The code of the course to delete
- * @todo When deleting a virtual course: unsubscribe users from that virtual
- * course from the groups in the real course if they are not subscribed in
- * that real course.
- * @todo Remove globals
- */
- function delete_course($code)
- {
- global $_configuration;
-
- $table_course = Database :: get_main_table(TABLE_MAIN_COURSE);
- $table_course_user = Database :: get_main_table(TABLE_MAIN_COURSE_USER);
- $table_course_class = Database :: get_main_table(TABLE_MAIN_COURSE_CLASS);
- $user_role_table = Database :: get_main_table(MAIN_USER_ROLE_TABLE);
- $location_table = Database::get_main_table(MAIN_LOCATION_TABLE);
- $role_right_location_table = Database::get_main_table(MAIN_ROLE_RIGHT_LOCATION_TABLE);
- $table_session_course = Database::get_main_table(TABLE_MAIN_SESSION_COURSE);
- $table_session_course_user = Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER);
- $table_course_survey = Database::get_main_table(TABLE_MAIN_SHARED_SURVEY);
- $table_course_survey_question = Database::get_main_table(TABLE_MAIN_SHARED_SURVEY_QUESTION);
- $table_course_survey_question_option = Database::get_main_table(TABLE_MAIN_SHARED_SURVEY_QUESTION_OPTION);
- $stats = false;
- if(Database::get_statistic_database() != ''){
- $stats = true;
- $table_stats_hotpots = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_HOTPOTATOES);
- $table_stats_attempt = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_ATTEMPT);
- $table_stats_exercises = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_EXERCICES);
- $table_stats_access = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_ACCESS);
- $table_stats_lastaccess = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_LASTACCESS);
- $table_stats_course_access = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_COURSE_ACCESS);
- $table_stats_online = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_ONLINE);
- $table_stats_default = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_DEFAULT);
- $table_stats_downloads = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_DOWNLOADS);
- $table_stats_links = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_LINKS);
- $table_stats_uploads = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_UPLOADS);
- }
- $sql = "SELECT * FROM $table_course WHERE code='".$code."'";
- $res = api_sql_query($sql, __FILE__, __LINE__);
- if (Database::num_rows($res) == 0)
- {
- return;
- }
- $this_course = Database::fetch_array($res);
- $db_name = $this_course['db_name'];
- CourseManager :: create_database_dump($code);
- if (!CourseManager :: is_virtual_course_from_system_code($code))
- {
- // If this is not a virtual course, look for virtual courses that depend on this one, if any
- $virtual_courses = CourseManager :: get_virtual_courses_linked_to_real_course($code);
- foreach ($virtual_courses as $index => $virtual_course)
- {
- // Unsubscribe all classes from the virtual course
- $sql = "DELETE FROM $table_course_class WHERE course_code='".$virtual_course['code']."'";
- api_sql_query($sql, __FILE__, __LINE__);
- // Unsubscribe all users from the virtual course
- $sql = "DELETE FROM $table_course_user WHERE course_code='".$virtual_course['code']."'";
- api_sql_query($sql, __FILE__, __LINE__);
- // Delete the course from the sessions tables
- $sql = "DELETE FROM $table_session_course WHERE course_code='".$virtual_course['code']."'";
- api_sql_query($sql,__FILE__,__LINE__);
- $sql = "DELETE FROM $table_session_course_user WHERE course_code='".$virtual_course['code']."'";
- api_sql_query($sql,__FILE__,__LINE__);
- // Delete the course from the survey tables
- $sql = "DELETE FROM $table_course_survey WHERE course_code='".$virtual_course['code']."'";
- api_sql_query($sql,__FILE__,__LINE__);
- $sql = "DELETE FROM $table_course_survey_user WHERE db_name='".$virtual_course['db_name']."'";
- api_sql_query($sql,__FILE__,__LINE__);
- $sql = "DELETE FROM $table_course_survey_reminder WHERE db_name='".$virtual_course['db_name']."'";
- api_sql_query($sql,__FILE__,__LINE__);
-
- // Delete the course from the stats tables
- if($stats)
- {
- $sql = "DELETE FROM $table_stats_hotpots WHERE exe_cours_id = '".$virtual_course['code']."'";
- api_sql_query($sql,__FILE__,__LINE__);
- $sql = "DELETE FROM $table_stats_attempt WHERE course_code = '".$virtual_course['code']."'";
- api_sql_query($sql,__FILE__,__LINE__);
- $sql = "DELETE FROM $table_stats_exercises WHERE exe_cours_id = '".$virtual_course['code']."'";
- api_sql_query($sql,__FILE__,__LINE__);
- $sql = "DELETE FROM $table_stats_access WHERE access_cours_code = '".$virtual_course['code']."'";
- api_sql_query($sql,__FILE__,__LINE__);
- $sql = "DELETE FROM $table_stats_lastaccess WHERE access_cours_code = '".$virtual_course['code']."'";
- api_sql_query($sql,__FILE__,__LINE__);
- $sql = "DELETE FROM $table_stats_course_access WHERE course_code = '".$virtual_course['code']."'";
- api_sql_query($sql,__FILE__,__LINE__);
- $sql = "DELETE FROM $table_stats_online WHERE course = '".$virtual_course['code']."'";
- api_sql_query($sql,__FILE__,__LINE__);
- $sql = "DELETE FROM $table_stats_default WHERE default_cours_code = '".$virtual_course['code']."'";
- api_sql_query($sql,__FILE__,__LINE__);
- $sql = "DELETE FROM $table_stats_downloads WHERE down_cours_id = '".$virtual_course['code']."'";
- api_sql_query($sql,__FILE__,__LINE__);
- $sql = "DELETE FROM $table_stats_links WHERE links_cours_id = '".$virtual_course['code']."'";
- api_sql_query($sql,__FILE__,__LINE__);
- $sql = "DELETE FROM $table_stats_uploads WHERE upload_cours_id = '".$virtual_course['code']."'";
- api_sql_query($sql,__FILE__,__LINE__);
- }
-
- // Delete the course from the course table
- $sql = "DELETE FROM $table_course WHERE code='".$virtual_course['code']."'";
- api_sql_query($sql, __FILE__, __LINE__);
- }
- $sql = "SELECT * FROM $table_course WHERE code='".$code."'";
- $res = api_sql_query($sql, __FILE__, __LINE__);
- $course = Database::fetch_array($res);
- if (!$_configuration['single_database'])
- {
- $sql = "DROP DATABASE IF EXISTS ".$course['db_name'];
- api_sql_query($sql, __FILE__, __LINE__);
- }
- else
- {
- //TODO Clean the following code as currently it would probably delete another course
- //similarly named, by mistake...
- $db_pattern = $_configuration['table_prefix'].$course['db_name'].$_configuration['db_glue'];
- $sql = "SHOW TABLES LIKE '$db_pattern%'";
- $result = api_sql_query($sql, __FILE__, __LINE__);
- while (list ($courseTable) = Database::fetch_array($result))
- {
- api_sql_query("DROP TABLE `$courseTable`", __FILE__, __LINE__);
- }
- }
- $course_dir = api_get_path(SYS_COURSE_PATH).$course['directory'];
- $garbage_dir = api_get_path(GARBAGE_PATH).$course['directory'].'_'.time();
- rename($course_dir, $garbage_dir);
- }
- // Unsubscribe all classes from the course
- $sql = "DELETE FROM $table_course_class WHERE course_code='".$code."'";
- api_sql_query($sql, __FILE__, __LINE__);
- // Unsubscribe all users from the course
- $sql = "DELETE FROM $table_course_user WHERE course_code='".$code."'";
- api_sql_query($sql, __FILE__, __LINE__);
- // Delete the course from the sessions tables
- $sql = "DELETE FROM $table_session_course WHERE course_code='".$code."'";
- api_sql_query($sql,__FILE__,__LINE__);
- $sql = "DELETE FROM $table_session_course_user WHERE course_code='".$code."'";
- api_sql_query($sql,__FILE__,__LINE__);
-
- $sql='SELECT survey_id FROM '.$table_course_survey.' WHERE course_code="'.$code.'"';
- $result_surveys=api_sql_query($sql);
- while($surveys=mysql_fetch_array($result_surveys)){
- $survey_id=$surveys[0];
- $sql='DELETE FROM '.$table_course_survey_question.' WHERE survey_id="'.$survey_id.'"';
- api_sql_query($sql,__FILE__,__LINE__);
- $sql='DELETE FROM '.$table_course_survey_question_option.' WHERE survey_id="'.$survey_id.'"';
- api_sql_query($sql,__FILE__,__LINE__);
- $sql='DELETE FROM '.$table_course_survey.' WHERE survey_id="'.$survey_id.'"';
- api_sql_query($sql,__FILE__,__LINE__);
- }
- // Delete the course from the stats tables
- if($stats)
- {
- $sql = "DELETE FROM $table_stats_hotpots WHERE exe_cours_id = '".$code."'";
- api_sql_query($sql,__FILE__,__LINE__);
- $sql = "DELETE FROM $table_stats_attempt WHERE course_code = '".$code."'";
- api_sql_query($sql,__FILE__,__LINE__);
- $sql = "DELETE FROM $table_stats_exercises WHERE exe_cours_id = '".$code."'";
- api_sql_query($sql,__FILE__,__LINE__);
- $sql = "DELETE FROM $table_stats_access WHERE access_cours_code = '".$code."'";
- api_sql_query($sql,__FILE__,__LINE__);
- $sql = "DELETE FROM $table_stats_lastaccess WHERE access_cours_code = '".$code."'";
- api_sql_query($sql,__FILE__,__LINE__);
- $sql = "DELETE FROM $table_stats_course_access WHERE course_code = '".$code."'";
- api_sql_query($sql,__FILE__,__LINE__);
- $sql = "DELETE FROM $table_stats_online WHERE course = '".$code."'";
- api_sql_query($sql,__FILE__,__LINE__);
- $sql = "DELETE FROM $table_stats_default WHERE default_cours_code = '".$code."'";
- api_sql_query($sql,__FILE__,__LINE__);
- $sql = "DELETE FROM $table_stats_downloads WHERE down_cours_id = '".$code."'";
- api_sql_query($sql,__FILE__,__LINE__);
- $sql = "DELETE FROM $table_stats_links WHERE links_cours_id = '".$code."'";
- api_sql_query($sql,__FILE__,__LINE__);
- $sql = "DELETE FROM $table_stats_uploads WHERE upload_cours_id = '".$code."'";
- api_sql_query($sql,__FILE__,__LINE__);
- }
- // Delete the course from the database
- $sql = "DELETE FROM $table_course WHERE code='".$code."'";
- api_sql_query($sql, __FILE__, __LINE__);
- }
- /**
- * Creates a file called mysql_dump.sql in the course folder
- * @param $course_code The code of the course
- * @todo Implementation for single database
- */
- function create_database_dump($course_code)
- {
- global $_configuration;
-
- if ($_configuration['single_database'])
- {
- return;
- }
- $sql_dump = '';
- $table_course = Database :: get_main_table(TABLE_MAIN_COURSE);
- $sql = "SELECT * FROM $table_course WHERE code = '$course_code'";
- $res = api_sql_query($sql, __FILE__, __LINE__);
- $course = Database::fetch_array($res);
- $sql = "SHOW TABLES FROM ".$course['db_name'];
- $res = api_sql_query($sql, __FILE__, __LINE__);
- while ($table = Database::fetch_array($res))
- {
- $sql = "SELECT * FROM `".$course['db_name']."`.`".$table[0]."`";
- $res3 = api_sql_query($sql, __FILE__, __LINE__);
- while ($row = Database::fetch_array($res3))
- {
- foreach ($row as $key => $value)
- {
- $row[$key] = $key."='".addslashes($row[$key])."'";
- }
- $sql_dump .= "\nINSERT INTO $table[0] SET ".implode(', ', $row).';';
- }
- }
- $file_name = api_get_path(SYS_COURSE_PATH).$course['directory'].'/mysql_dump.sql';
- $handle = fopen($file_name, 'a+');
- if($handle!==false){
- fwrite($handle, $sql_dump);
- fclose($handle);
- }else{
- //TODO trigger exception in a try-catch
- }
- }
-
- function userCourseSort($user_id,$course_code){
-
- $TABLECOURSE = Database :: get_main_table(TABLE_MAIN_COURSE);
- $TABLECOURSUSER = Database :: get_main_table(TABLE_MAIN_COURSE_USER);
-
- $sql = 'SELECT title FROM '.$TABLECOURSE.' WHERE code="'.$course_code.'"';
- $result = api_sql_query($sql, __FILE__, __LINE__);
- $course_title = mysql_result($result,0,0);
-
- $sql = 'SELECT course.code as code, course.title as title, cu.sort as sort FROM '.$TABLECOURSUSER.' as cu, '.$TABLECOURSE.' as course
- WHERE course.code = cu.course_code
- AND user_id = "'.$user_id.'"
- AND user_course_cat=0 ORDER BY cu.sort';
- $result = api_sql_query($sql, __FILE__, __LINE__);
-
- $s_course_title_precedent = '';
- $counter = 0;
- $b_find_course = false;
- $i_course_sort = 1;
-
- while($courses=mysql_fetch_array($result)){
-
- if($s_course_title_precedent == ''){
- $s_course_title_precedent = $courses['title'];
- }
-
- if(strcasecmp($s_course_title_precedent,$course_title)<0){
-
- $b_find_course = true;
- $i_course_sort = $courses['sort'];
-
- $s_course_code = $courses['code'];
- if($counter == 0){
- $sql = 'UPDATE '.$TABLECOURSUSER.' SET sort = sort+1 WHERE user_id= "'.$user_id.'" AND user_course_cat="0" AND sort > "'.$i_course_sort.'"';
- $i_course_sort++;
- }
- else{
- $sql = 'UPDATE '.$TABLECOURSUSER.' SET sort = sort+1 WHERE user_id= "'.$user_id.'" AND user_course_cat="0" AND sort >= "'.$i_course_sort.'"';
- }
-
- api_sql_query($sql, __FILE__, __LINE__);
- break;
- }
-
- else{
- $s_course_title_precedent = $courses['title'];
- }
-
- $counter++;
- }
-
- //We must register the course in the beginning of the list
- if(mysql_num_rows($result)>0 && !$b_find_course){
- $sql_max = 'SELECT min(sort) as min_sort FROM '.$TABLECOURSUSER.' WHERE user_id="'.$user_id.'" AND user_course_cat="0"';
- $result_min_sort=api_sql_query($sql_max);
- $i_course_sort = mysql_result($result_min_sort,0,0);
-
- $sql = 'UPDATE '.$TABLECOURSUSER.' SET sort = sort+1 WHERE user_id= "'.$user_id.'" AND user_course_cat="0"';
- api_sql_query($sql);
- }
- return $i_course_sort;
- }
-
- /**
- * create recursively all categories as option of the select passed in paramater.
- *
- * @param object $select_element the quickform select where the options will be added
- * @param string $category_selected_code the option value to select by default (used mainly for edition of courses)
- * @param string $parent_code the parent category of the categories added (default=null for root category)
- * @param string $padding the indent param (you shouldn't indicate something here)
- */
- function select_and_sort_categories($select_element, $category_selected_code="", $parent_code=null , $padding="")
- {
- $table_course_category = Database :: get_main_table(TABLE_MAIN_CATEGORY);
- $sql = "SELECT code, name, auth_course_child, auth_cat_child
- FROM ".$table_course_category."
- WHERE parent_id ".(is_null($parent_code) ? "IS NULL" : "='".Database::escape_string($parent_code)."'")."
- ORDER BY code";
- $res = api_sql_query($sql, __FILE__, __LINE__);
-
- $new_padding = $padding.str_repeat('-',3);
-
- while ($cat = Database::fetch_array($res))
- {
- $params = $cat['auth_course_child'] == 'TRUE' ? '' : 'disabled';
- $params .= ($cat['code'] == $category_selected_code) ? ' selected' : '';
- $select_element->addOption($padding.'('.$cat['code'].') '.$cat['name'], $cat['code'], $params);
- if($cat['auth_cat_child'])
- {
- CourseManager::select_and_sort_categories($select_element, $cat['code'], $category_selected_code, $new_padding);
- }
- }
- }
-
- } //end class CourseManager
- ?>
|