course.lib.php 80 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970
  1. <?php //$id: $
  2. /* For licensing terms, see /dokeos_license.txt
  3. Copyright (c) Roan Embrechts, Vrije Universiteit Brussel
  4. Copyright (c) Bart Mollet, Hogeschool Gent
  5. Copyright (c) Yannick Warnier, Dokeos SPRL
  6. */
  7. /**
  8. ==============================================================================
  9. * This is the course library for Dokeos.
  10. *
  11. * All main course functions should be placed here.
  12. * Many functions of this library deal with providing support for
  13. * virtual/linked/combined courses (this was already used in several universities
  14. * but not available in standard Dokeos).
  15. *
  16. * The implementation changed, initially a course was a real course
  17. * if target_course_code was 0 , this was changed to NULL.
  18. * There are probably some places left with the wrong code.
  19. *
  20. * @package dokeos.library
  21. ==============================================================================
  22. */
  23. /*
  24. ==============================================================================
  25. DOCUMENTATION
  26. (list not up to date, you can auto generate documentation with phpDocumentor)
  27. CourseManager::get_real_course_code_select_html($element_name, $has_size=true, $only_current_user_courses=true)
  28. CourseManager::check_parameter($parameter, $error_message)
  29. CourseManager::check_parameter_or_fail($parameter, $error_message)
  30. CourseManager::is_existing_course_code($wanted_course_code)
  31. CourseManager::get_real_course_list()
  32. CourseManager::get_virtual_course_list()
  33. GENERAL COURSE FUNCTIONS
  34. CourseManager::get_access_settings($course_code)
  35. CourseManager::set_course_tool_visibility($tool_table_id, $visibility)
  36. CourseManager::get_user_in_course_status($user_id, $course_code)
  37. CourseManager::add_user_to_course($user_id, $course_code)
  38. CourseManager::get_virtual_course_info($real_course_code)
  39. CourseManager::is_virtual_course_from_visual_code($visual_code)
  40. CourseManager::is_virtual_course_from_system_code($system_code)
  41. CourseManager::get_virtual_courses_linked_to_real_course($real_course_code)
  42. CourseManager::get_list_of_virtual_courses_for_specific_user_and_real_course($user_id, $real_course_code)
  43. CourseManager::has_virtual_courses_from_code($real_course_code, $user_id)
  44. CourseManager::get_target_of_linked_course($virtual_course_code)
  45. TITLE AND CODE FUNCTIONS
  46. CourseManager::determine_course_title_from_course_info($user_id, $course_info)
  47. CourseManager::create_combined_name($user_is_registered_in_real_course, $real_course_name, $virtual_course_list)
  48. CourseManager::create_combined_code($user_is_registered_in_real_course, $real_course_code, $virtual_course_list)
  49. USER FUNCTIONS
  50. CourseManager::get_real_course_list_of_user_as_course_admin($user_id)
  51. CourseManager::get_course_list_of_user_as_course_admin($user_id)
  52. CourseManager::is_user_subscribed_in_course($user_id, $course_code)
  53. CourseManager::is_user_subscribed_in_real_or_linked_course($user_id, $course_code)
  54. CourseManager::get_user_list_from_course_code($course_code)
  55. CourseManager::get_real_and_linked_user_list($course_code);
  56. GROUP FUNCTIONS
  57. CourseManager::get_group_list_of_course($course_code)
  58. CREATION FUNCTIONS
  59. CourseManager::attempt_create_virtual_course($real_course_code, $course_title, $wanted_course_code, $course_language, $course_category)
  60. ==============================================================================
  61. */
  62. /*
  63. ==============================================================================
  64. INIT SECTION
  65. ==============================================================================
  66. */
  67. /*
  68. -----------------------------------------------------------
  69. Configuration files
  70. -----------------------------------------------------------
  71. */
  72. require_once api_get_path(CONFIGURATION_PATH).'add_course.conf.php';
  73. /*
  74. -----------------------------------------------------------
  75. Libraries
  76. we assume main_api is also included...
  77. -----------------------------------------------------------
  78. */
  79. require_once api_get_path(LIBRARY_PATH).'database.lib.php';
  80. require_once api_get_path(LIBRARY_PATH).'add_course.lib.inc.php';
  81. /*
  82. -----------------------------------------------------------
  83. Constants
  84. -----------------------------------------------------------
  85. */
  86. //LOGIC: course visibility and registration settings
  87. /*
  88. COURSE VISIBILITY
  89. MAPPING OLD SETTINGS TO NEW SETTINGS
  90. -----------------------
  91. NOT_VISIBLE_NO_SUBSCRIPTION_ALLOWED
  92. --> COURSE_VISIBILITY_REGISTERED, SUBSCRIBE_NOT_ALLOWED
  93. NOT_VISIBLE_SUBSCRIPTION_ALLOWED
  94. --> COURSE_VISIBILITY_REGISTERED, SUBSCRIBE_ALLOWED
  95. VISIBLE_SUBSCRIPTION_ALLOWED
  96. --> COURSE_VISIBILITY_OPEN_PLATFORM, SUBSCRIBE_ALLOWED
  97. VISIBLE_NO_SUBSCRIPTION_ALLOWED
  98. --> COURSE_VISIBILITY_OPEN_PLATFORM, SUBSCRIBE_NOT_ALLOWED
  99. */
  100. //OLD SETTINGS
  101. define('NOT_VISIBLE_NO_SUBSCRIPTION_ALLOWED', 0);
  102. define('NOT_VISIBLE_SUBSCRIPTION_ALLOWED', 1);
  103. define('VISIBLE_SUBSCRIPTION_ALLOWED', 2);
  104. define('VISIBLE_NO_SUBSCRIPTION_ALLOWED', 3);
  105. /*
  106. -----------------------------------------------------------
  107. Variables
  108. -----------------------------------------------------------
  109. */
  110. $TABLECOURSE = Database::get_main_table(TABLE_MAIN_COURSE);
  111. $TABLECOURSDOMAIN = Database::get_main_table(TABLE_MAIN_CATEGORY);
  112. $TABLEUSER = Database::get_main_table(TABLE_MAIN_USER);
  113. $TABLECOURSUSER = Database::get_main_table(TABLE_MAIN_COURSE_USER);
  114. $TABLEANNOUNCEMENTS = 'announcement';
  115. $coursesRepositories = $_configuration['root_sys'];
  116. /*
  117. ==============================================================================
  118. CourseManager CLASS
  119. ==============================================================================
  120. */
  121. /**
  122. * @package dokeos.library
  123. */
  124. class CourseManager {
  125. /**
  126. * Returns all the information of a given coursecode
  127. * @param string $course_code, the course code
  128. * @return an array with all the fields of the course table
  129. * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
  130. */
  131. public static function get_course_information($course_code) {
  132. return Database::fetch_array(Database::query(
  133. "SELECT * FROM ".Database::get_main_table(TABLE_MAIN_COURSE)."
  134. WHERE code='".Database::escape_string($course_code)."'", __FILE__, __LINE__)
  135. );
  136. }
  137. /**
  138. * Returns a list of courses. Should work with quickform syntax
  139. * @param integer Offset (from the 7th = '6'). Optional.
  140. * @param integer Number of results we want. Optional.
  141. * @param string The column we want to order it by. Optional, defaults to first column.
  142. * @param string The direction of the order (ASC or DESC). Optional, defaults to ASC.
  143. * @param string The visibility of the course, or all by default.
  144. * @param string If defined, only return results for which the course *title* begins with this string
  145. */
  146. public static function get_courses_list($from = 0, $howmany = 0, $orderby = 1, $orderdirection = 'ASC', $visibility = -1, $startwith = '') {
  147. $sql = "SELECT code, title FROM ".Database::get_main_table(TABLE_MAIN_COURSE)." ";
  148. if (!empty($startwith)) {
  149. $sql .= "WHERE LIKE title '".Database::escape_string($startwith)."%' ";
  150. if ($visibility !== -1 && $visibility == strval(intval($visibility))) {
  151. $sql .= " AND visibility = $visibility ";
  152. }
  153. } else {
  154. $sql .= "WHERE 1 ";
  155. if ($visibility !== -1 && $visibility == strval(intval($visibility))) {
  156. $sql .= " AND visibility = $visibility ";
  157. }
  158. }
  159. if (!empty($orderby)) {
  160. $sql .= " ORDER BY ".Database::escape_string($orderby)." ";
  161. } else {
  162. $sql .= " ORDER BY 1 ";
  163. }
  164. if (!in_array($orderdirection, array('ASC', 'DESC'))) {
  165. $sql .= 'ASC';
  166. } else {
  167. $sql .= Database::escape_string($orderdirection);
  168. }
  169. if (!empty($howmany) && is_int($howmany) and $howmany > 0) {
  170. $sql .= ' LIMIT '.Database::escape_string($howmany);
  171. } else {
  172. $sql .= ' LIMIT 1000000'; //virtually no limit
  173. }
  174. if (!empty($from)) {
  175. $from = intval($from);
  176. $sql .= ' OFFSET '.Database::escape_string($from);
  177. } else {
  178. $sql .= ' OFFSET 0';
  179. }
  180. return Database::store_result(Database::query($sql, __FILE__, __LINE__));
  181. }
  182. /**
  183. * Returns the access settings of the course:
  184. * which visibility;
  185. * wether subscribing is allowed;
  186. * wether unsubscribing is allowed.
  187. *
  188. * @param string $course_code, the course code
  189. * @todo for more consistency: use course_info call from database API
  190. * @return an array with int fields "visibility", "subscribe", "unsubscribe"
  191. */
  192. public static function get_access_settings($course_code) {
  193. return Database::fetch_array(Database::query(
  194. "SELECT visibility, subscribe, unsubscribe from ".Database::get_main_table(TABLE_MAIN_COURSE)."
  195. WHERE code = '".Database::escape_string($course_code)."'", __FILE__, __LINE__)
  196. );
  197. }
  198. /**
  199. * Returns the status of a user in a course, which is COURSEMANAGER or STUDENT.
  200. * @param int User ID
  201. * @param string Course code
  202. * @return int the status of the user in that course
  203. */
  204. public static function get_user_in_course_status($user_id, $course_code) {
  205. $result = Database::fetch_array(Database::query(
  206. "SELECT * FROM ".Database::get_main_table(TABLE_MAIN_COURSE_USER)."
  207. WHERE course_code = '".Database::escape_string($course_code)."' AND user_id = ".Database::escape_string($user_id), __FILE__, __LINE__)
  208. );
  209. return $result['status'];
  210. }
  211. /**
  212. * Unsubscribe one or more users from a course
  213. * @param int|array $user_id
  214. * @param string $course_code
  215. */
  216. public static function unsubscribe_user($user_id, $course_code) {
  217. if (!is_array($user_id)) {
  218. $user_id = array($user_id);
  219. }
  220. if (count($user_id) == 0) {
  221. return;
  222. }
  223. $user_ids = implode(',', $user_id);
  224. $course_code = Database::escape_string($course_code);
  225. $course = Database::fetch_object(Database::query("SELECT * FROM ".Database::get_main_table(TABLE_MAIN_COURSE)."
  226. WHERE code = '".$course_code."'", __FILE__, __LINE__));
  227. // Unsubscribe user from all groups in the course.
  228. Database::query("DELETE FROM ".Database::get_course_table(TABLE_GROUP_USER, $course->db_name)."
  229. WHERE user_id IN (".$user_ids.")", __FILE__, __LINE__);
  230. Database::query("DELETE FROM ".Database::get_course_table(TABLE_GROUP_TUTOR, $course->db_name)."
  231. WHERE user_id IN (".$user_ids.")", __FILE__, __LINE__);
  232. // Unsubscribe user from all blogs in the course.
  233. Database::query("DELETE FROM ".Database::get_course_table(TABLE_BLOGS_REL_USER, $course->db_name)."
  234. WHERE user_id IN (".$user_ids.")", __FILE__, __LINE__);
  235. Database::query("DELETE FROM ".Database::get_course_table(TABLE_BLOGS_TASKS_REL_USER, $course->db_name)."
  236. WHERE user_id IN (".$user_ids.")", __FILE__, __LINE__);
  237. // Unsubscribe user from the course.
  238. if (!empty($_SESSION['id_session'])) { // We suppose the session is safe!
  239. // Delete in table session_rel_course_rel_user
  240. $my_session_id = Database::escape_string ($_SESSION['id_session']);
  241. Database::query("DELETE FROM ".Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER)."
  242. WHERE id_session ='".$my_session_id."'
  243. AND course_code = '".Database::escape_string($_SESSION['_course']['id'])."'
  244. AND id_user IN ($user_ids)", __FILE__, __LINE__);
  245. // Delete in table session_rel_user
  246. Database::query("DELETE FROM ".Database::get_main_table(TABLE_MAIN_SESSION_USER)."
  247. WHERE id_session ='".$my_session_id."'
  248. AND id_user IN ($user_ids)", __FILE__, __LINE__);
  249. // Update the table session
  250. $row = Database::fetch_array(Database::query("SELECT COUNT(*) FROM ".Database::get_main_table(TABLE_MAIN_SESSION_USER)."
  251. WHERE id_session = '".$my_session_id."'", __FILE__, __LINE__));
  252. $count = $row[0]; // number of users by session
  253. $result = Database::query("UPDATE ".Database::get_main_table(TABLE_MAIN_SESSION)." SET nbr_users = '$count'
  254. WHERE id = '".$my_session_id."'", __FILE__, __LINE__);
  255. } else {
  256. Database::query("DELETE FROM ".Database::get_main_table(TABLE_MAIN_COURSE_USER)."
  257. WHERE user_id IN (".$user_ids.") AND course_code = '".$course_code."'", __FILE__, __LINE__);
  258. // add event to system log
  259. $time = time();
  260. $user_id = api_get_user_id();
  261. event_system(LOG_UNSUBSCRIBE_USER_FROM_COURSE, LOG_COURSE_CODE, $course_code, $time, $user_id);
  262. }
  263. }
  264. /**
  265. * Subscribe a user to a course. No checks are performed here to see if
  266. * course subscription is allowed.
  267. * @param int User ID
  268. * @param string Course code
  269. * @param int Status (STUDENT, COURSEMANAGER, COURSE_ADMIN, NORMAL_COURSE_MEMBER)
  270. * @return bool True on success, false on failure
  271. * @see add_user_to_course
  272. */
  273. public static function subscribe_user($user_id, $course_code, $status = STUDENT) {
  274. if ($user_id != strval(intval($user_id))) {
  275. return false; //detected possible SQL injection
  276. }
  277. $course_code = Database::escape_string($course_code);
  278. if (empty ($user_id) || empty ($course_code)) {
  279. return false;
  280. }
  281. $status = ($status == STUDENT || $status == COURSEMANAGER) ? $status : STUDENT;
  282. $role_id = ($status == COURSEMANAGER) ? COURSE_ADMIN : NORMAL_COURSE_MEMBER;
  283. // A preliminary check whether the user has bben already registered on the platform.
  284. if (Database::num_rows(@Database::query("SELECT status FROM ".Database::get_main_table(TABLE_MAIN_USER)."
  285. WHERE user_id = '$user_id' ", __FILE__, __LINE__)) == 0) {
  286. return false; // The user has not been registered to the platform.
  287. }
  288. // Check whether the user has not been already subscribed to the course.
  289. if (Database::num_rows(@Database::query("SELECT * FROM ".Database::get_main_table(TABLE_MAIN_COURSE_USER)."
  290. WHERE user_id = '$user_id' AND course_code = '$course_code'", __FILE__, __LINE__)) > 0) {
  291. return false; // The user has been already subscribed to the course.
  292. }
  293. if (!empty($_SESSION['id_session'])) {
  294. // Check whether the user has not already been stored in the session_rel_course_user table
  295. if (Database::num_rows(@Database::query("SELECT * FROM ".Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER)."
  296. WHERE course_code = '".$_SESSION['_course']['id']."'
  297. AND id_session ='".$_SESSION['id_session']."'
  298. AND id_user = '".$user_id."'", __FILE__, __LINE__)) > 0) {
  299. return false;
  300. }
  301. // Check whether the user has not already been stored in the session_rel_user table
  302. if (Database::num_rows(@Database::query("SELECT * FROM ".Database::get_main_table(TABLE_MAIN_SESSION_USER)."
  303. WHERE id_session ='".$_SESSION['id_session']."'
  304. AND id_user = '".$user_id."'", __FILE__, __LINE__)) > 0) {
  305. return false;
  306. }
  307. // Add him/her in the table session_rel_course_rel_user
  308. @Database::query("INSERT INTO ".Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER)."
  309. SET id_session ='".$_SESSION['id_session']."',
  310. course_code = '".$_SESSION['_course']['id']."',
  311. id_user = '".$user_id."'", __FILE__, __LINE__);
  312. // Add him/her in the table session_rel_user
  313. @Database::query("INSERT INTO ".Database::get_main_table(TABLE_MAIN_SESSION_USER)."
  314. SET id_session ='".$_SESSION['id_session']."',
  315. id_user = '".$user_id."'", __FILE__, __LINE__);
  316. // Update the table session
  317. $row = Database::fetch_array(@Database::query("SELECT COUNT(*) FROM ".Database::get_main_table(TABLE_MAIN_SESSION_USER)." WHERE id_session = '".$_SESSION['id_session']."'", __FILE__, __LINE__));
  318. $count = $row[0]; // number of users by session
  319. $result = @Database::query("UPDATE ".Database::get_main_table(TABLE_MAIN_SESSION)." SET nbr_users = '$count' WHERE id = '".$_SESSION['id_session']."'", __FILE__, __LINE__);
  320. } else {
  321. $course_sort = self::userCourseSort($user_id, $course_code);
  322. $result = @Database::query("INSERT INTO ".Database::get_main_table(TABLE_MAIN_COURSE_USER)."
  323. SET course_code = '$course_code',
  324. user_id = '$user_id',
  325. status = '".$status."',
  326. sort = '". ($course_sort)."'", __FILE__, __LINE__);
  327. // Add event to the system log.
  328. $time = time();
  329. $user_id = api_get_user_id();
  330. event_system(LOG_SUBSCRIBE_USER_TO_COURSE, LOG_COURSE_CODE, $course_code, $time, $user_id);
  331. }
  332. return (bool)$result;
  333. }
  334. /**
  335. * Subscribe a user $user_id to a course $course_code.
  336. * @author Hugues Peeters
  337. * @author Roan Embrechts
  338. *
  339. * @param int $user_id the id of the user
  340. * @param string $course_code the course code
  341. * @param string $status (optional) The user's status in the course
  342. *
  343. * @return boolean true if subscription succeeds, boolean false otherwise.
  344. */
  345. public static function add_user_to_course($user_id, $course_code, $status = STUDENT) {
  346. $user_table = Database::get_main_table(TABLE_MAIN_USER);
  347. $course_table = Database::get_main_table(TABLE_MAIN_COURSE);
  348. $course_user_table = Database::get_main_table(TABLE_MAIN_COURSE_USER);
  349. $status = ($status == STUDENT || $status == COURSEMANAGER) ? $status : STUDENT;
  350. if (empty($user_id) || empty($course_code) || ($user_id != strval(intval($user_id)))) {
  351. return false;
  352. }
  353. $course_code = Database::escape_string($course_code);
  354. // Check in advance whether the user has already been registered on the platform.
  355. if (Database::num_rows(Database::query("SELECT status FROM ".$user_table." WHERE user_id = '$user_id' ", __FILE__, __LINE__)) == 0) {
  356. return false; // Thehe user has not been registered to the platform.
  357. }
  358. // Check whether the user has already been subscribed to this course.
  359. if (Database::num_rows(Database::query("SELECT * FROM ".$course_user_table." WHERE user_id = '$user_id' AND course_code = '$course_code'", __FILE__, __LINE__)) > 0) {
  360. return false; // The user has been subscribed to the course.
  361. }
  362. // Check in advance whether subscription is allowed or not for this course.
  363. if (Database::num_rows(Database::query("SELECT code, visibility FROM ".$course_table." WHERE code = '$course_code' AND subscribe = '".SUBSCRIBE_NOT_ALLOWED."'", __FILE__, __LINE__)) > 0) {
  364. return false; // Subscription is not allowed for this course.
  365. }
  366. // Ok, subscribe the user.
  367. $max_sort = api_max_sort_value('0', $user_id);
  368. return (bool)Database::query("INSERT INTO ".$course_user_table."
  369. SET course_code = '$course_code',
  370. user_id = '$user_id',
  371. status = '".$status."',
  372. sort = '". ($max_sort + 1)."'", __FILE__, __LINE__);
  373. }
  374. /**
  375. * Checks wether a parameter exists.
  376. * If it doesn't, the function displays an error message.
  377. *
  378. * @return true if parameter is set and not empty, false otherwise
  379. * @todo move function to better place, main_api ?
  380. */
  381. public static function check_parameter($parameter, $error_message) {
  382. if (empty($parameter)) {
  383. Display::display_normal_message($error_message);
  384. return false;
  385. }
  386. return true;
  387. }
  388. /**
  389. * Lets the script die when a parameter check fails.
  390. * @todo move function to better place, main_api ?
  391. */
  392. public static function check_parameter_or_fail($parameter, $error_message) {
  393. if (!self::check_parameter($parameter, $error_message)) {
  394. die();
  395. }
  396. }
  397. /**
  398. * @return true if there already are one or more courses
  399. * with the same code OR visual_code (visualcode), false otherwise
  400. */
  401. // TODO: course_code_exists() is a better name.
  402. public static function is_existing_course_code($wanted_course_code) {
  403. $wanted_course_code = Database::escape_string($wanted_course_code);
  404. $result = Database::fetch_array(Database::query("SELECT COUNT(*) as number FROM ".Database::get_main_table(TABLE_MAIN_COURSE)."WHERE code = '$wanted_course_code' OR visual_code = '$wanted_course_code'", __FILE__, __LINE__));
  405. return $result['number'] > 0;
  406. }
  407. /**
  408. * @return an array with the course info of all real courses on the platform
  409. */
  410. public static function get_real_course_list() {
  411. $sql_result = Database::query("SELECT * FROM ".Database::get_main_table(TABLE_MAIN_COURSE)." WHERE target_course_code IS NULL", __FILE__, __LINE__);
  412. while ($result = Database::fetch_array($sql_result)) {
  413. $real_course_list[] = $result;
  414. }
  415. return $real_course_list;
  416. }
  417. /**
  418. * @return an array with the course info of all virtual courses on the platform
  419. */
  420. public static function get_virtual_course_list() {
  421. $sql_result = Database::query("SELECT * FROM ".Database::get_main_table(TABLE_MAIN_COURSE)." WHERE target_course_code IS NOT NULL", __FILE__, __LINE__);
  422. while ($result = Database::fetch_array($sql_result)) {
  423. $virtual_course_list[] = $result;
  424. }
  425. return $virtual_course_list;
  426. }
  427. /**
  428. * @return an array with the course info of the real courses of which
  429. * the current user is course admin
  430. */
  431. public static function get_real_course_list_of_user_as_course_admin($user_id) {
  432. if ($user_id != strval(intval($user_id))) {
  433. return array();
  434. }
  435. $sql_result = Database::query("SELECT *
  436. FROM ".Database::get_main_table(TABLE_MAIN_COURSE)." course
  437. LEFT JOIN ".Database::get_main_table(TABLE_MAIN_COURSE_USER)." course_user
  438. ON course.code = course_user.course_code
  439. WHERE course.target_course_code IS NULL
  440. AND course_user.user_id = '$user_id'
  441. AND course_user.status = '1'", __FILE__, __LINE__);
  442. while ($result = Database::fetch_array($sql_result)) {
  443. $result_array[] = $result;
  444. }
  445. return $result_array;
  446. }
  447. /**
  448. * @return an array with the course info of all the courses (real and virtual) of which
  449. * the current user is course admin
  450. */
  451. public static function get_course_list_of_user_as_course_admin($user_id) {
  452. if ($user_id != strval(intval($user_id))) {
  453. return array();
  454. }
  455. $sql_result = Database::query("SELECT *
  456. FROM ".Database::get_main_table(TABLE_MAIN_COURSE)." course
  457. LEFT JOIN ".Database::get_main_table(TABLE_MAIN_COURSE_USER)." course_user
  458. ON course.code = course_user.course_code
  459. WHERE course_user.user_id = '$user_id'
  460. AND course_user.status = '1'", __FILE__, __LINE__);
  461. while ($result = Database::fetch_array($sql_result)) {
  462. $result_array[] = $result;
  463. }
  464. return $result_array;
  465. }
  466. /**
  467. * Find out for which courses the user is registered and determine a visual course code and course title from that.
  468. * Takes virtual courses into account
  469. *
  470. * Default case: the name and code stay what they are.
  471. *
  472. * Scenarios:
  473. * - User is registered in real course and virtual courses; name / code become a mix of all
  474. * - User is registered in real course only: name stays that of real course
  475. * - User is registered in virtual course only: name becomes that of virtual course
  476. * - user is not registered to any of the real/virtual courses: name stays that of real course
  477. * (I'm not sure about the last case, but this seems not too bad)
  478. *
  479. * @author Roan Embrechts
  480. * @param $user_id, the id of the user
  481. * @param $course_info, an array with course info that you get using Database::get_course_info($course_system_code);
  482. * @return an array with indices
  483. * $return_result['title'] - the course title of the combined courses
  484. * $return_result['code'] - the course code of the combined courses
  485. */
  486. public static function determine_course_title_from_course_info($user_id, $course_info) {
  487. if ($user_id != strval(intval($user_id))) {
  488. return array();
  489. }
  490. $real_course_id = $course_info['system_code'];
  491. $real_course_info = Database::get_course_info($real_course_id);
  492. $real_course_name = $real_course_info['title'];
  493. $real_course_visual_code = $real_course_info['visual_code'];
  494. $real_course_real_code = Database::escape_string($course_info['system_code']);
  495. //is the user registered in the real course?
  496. $result = Database::fetch_array(Database::query("SELECT * FROM ".Database::get_main_table(TABLE_MAIN_COURSE_USER)."
  497. WHERE user_id = '$user_id' AND course_code = '$real_course_real_code'", __FILE__, __LINE__));
  498. $user_is_registered_in_real_course = !empty($result);
  499. //get a list of virtual courses linked to the current real course and to which the current user is subscribed
  500. $user_subscribed_virtual_course_list = self::get_list_of_virtual_courses_for_specific_user_and_real_course($user_id, $real_course_id);
  501. $virtual_courses_exist = count($user_subscribed_virtual_course_list) > 0;
  502. //now determine course code and name
  503. if ($user_is_registered_in_real_course && $virtual_courses_exist) {
  504. $course_info['name'] = self::create_combined_name($user_is_registered_in_real_course, $real_course_name, $user_subscribed_virtual_course_list);
  505. $course_info['official_code'] = self::create_combined_code($user_is_registered_in_real_course, $real_course_visual_code, $user_subscribed_virtual_course_list);
  506. }
  507. elseif ($user_is_registered_in_real_course) {
  508. //course name remains real course name
  509. $course_info['name'] = $real_course_name;
  510. $course_info['official_code'] = $real_course_visual_code;
  511. }
  512. elseif ($virtual_courses_exist) {
  513. $course_info['name'] = self::create_combined_name($user_is_registered_in_real_course, $real_course_name, $user_subscribed_virtual_course_list);
  514. $course_info['official_code'] = self::create_combined_code($user_is_registered_in_real_course, $real_course_visual_code, $user_subscribed_virtual_course_list);
  515. } else {
  516. //course name remains real course name
  517. $course_info['name'] = $real_course_name;
  518. $course_info['official_code'] = $real_course_visual_code;
  519. }
  520. $return_result['title'] = $course_info['name'];
  521. $return_result['code'] = $course_info['official_code'];
  522. return $return_result;
  523. }
  524. /**
  525. * Create a course title based on all real and virtual courses the user is registered in.
  526. * @param boolean $user_is_registered_in_real_course
  527. * @param string $real_course_name, the title of the real course
  528. * @param array $virtual_course_list, the list of virtual courses
  529. */
  530. public static function create_combined_name($user_is_registered_in_real_course, $real_course_name, $virtual_course_list) {
  531. $complete_course_name = array();
  532. if ($user_is_registered_in_real_course) {
  533. // Add the real name to the result.
  534. $complete_course_name[] = $real_course_name;
  535. }
  536. // Add course titles of all virtual courses.
  537. foreach ($virtual_course_list as $current_course) {
  538. $complete_course_name[] = $current_course['title'];
  539. }
  540. // 'CombinedCourse' is from course_home language file.
  541. return (($user_is_registered_in_real_course || count($virtual_course_list) > 1) ? get_lang('CombinedCourse').' ' : '').implode(' &amp; ', $complete_course_name);
  542. }
  543. /**
  544. * Create a course code based on all real and virtual courses the user is registered in.
  545. */
  546. public static function create_combined_code($user_is_registered_in_real_course, $real_course_code, $virtual_course_list) {
  547. $complete_course_code = array();
  548. if ($user_is_registered_in_real_course) {
  549. // Add the real code to the result
  550. $complete_course_code[] = $real_course_code;
  551. }
  552. // Add codes of all virtual courses.
  553. foreach ($virtual_course_list as $current_course) {
  554. $complete_course_code[] = $current_course['visual_code'];
  555. }
  556. return implode(' &amp; ', $complete_course_code);
  557. }
  558. /**
  559. * Return course info array of virtual course
  560. *
  561. * Note this is different from getting information about a real course!
  562. *
  563. * @param $real_course_code, the id of the real course which the virtual course is linked to
  564. */
  565. public static function get_virtual_course_info($real_course_code) {
  566. $sql_result = Database::query("SELECT * FROM ".Database::get_main_table(TABLE_MAIN_COURSE)."
  567. WHERE target_course_code = '".Database::escape_string($real_course_code)."'", __FILE__, __LINE__);
  568. $result = array();
  569. while ($virtual_course = Database::fetch_array($sql_result)) {
  570. $result[] = $virtual_course;
  571. }
  572. return $result;
  573. }
  574. /**
  575. * @param string $system_code, the system code of the course
  576. * @return true if the course is a virtual course, false otherwise
  577. */
  578. public static function is_virtual_course_from_system_code($system_code) {
  579. $result = Database::fetch_array(Database::query("SELECT target_course_code FROM ".Database::get_main_table(TABLE_MAIN_COURSE)."
  580. WHERE code = '".Database::escape_string($system_code)."'", __FILE__, __LINE__));
  581. return !empty($result['target_course_code']);
  582. }
  583. /**
  584. * Returns whether the course code given is a visual code
  585. * @param string Visual course code
  586. * @return true if the course is a virtual course, false otherwise
  587. */
  588. public static function is_virtual_course_from_visual_code($visual_code) {
  589. $result = Database::fetch_array(Database::query("SELECT target_course_code FROM ".Database::get_main_table(TABLE_MAIN_COURSE)."
  590. WHERE visual_code = '".Database::escape_string($visual_code)."'", __FILE__, __LINE__));
  591. return !empty($result['target_course_code']);
  592. }
  593. /**
  594. * @return true if the real course has virtual courses that the user is subscribed to, false otherwise
  595. */
  596. public static function has_virtual_courses_from_code($real_course_code, $user_id) {
  597. return count(self::get_list_of_virtual_courses_for_specific_user_and_real_course($user_id, $real_course_code)) > 0;
  598. }
  599. /**
  600. * Return an array of arrays, listing course info of all virtual course
  601. * linked to the real course ID $real_course_code
  602. *
  603. * @param string The id of the real course which the virtual courses are linked to
  604. * @return array List of courses details
  605. */
  606. public static function get_virtual_courses_linked_to_real_course($real_course_code) {
  607. $sql_result = Database::query("SELECT * FROM ".Database::get_main_table(TABLE_MAIN_COURSE)."
  608. WHERE target_course_code = '".Database::get_main_table(TABLE_MAIN_COURSE)."'", __FILE__, __LINE__);
  609. $result_array = array();
  610. while ($result = Database::fetch_array($sql_result)) {
  611. $result_array[] = $result;
  612. }
  613. return $result_array;
  614. }
  615. /**
  616. * This function returns the course code of the real course
  617. * to which a virtual course is linked.
  618. *
  619. * @param the course code of the virtual course
  620. * @return the course code of the real course
  621. */
  622. public static function get_target_of_linked_course($virtual_course_code) {
  623. //get info about the virtual course
  624. $result = Database::fetch_array(Database::query("SELECT * FROM ".Database::get_main_table(TABLE_MAIN_COURSE)."
  625. WHERE code = '".Database::escape_string($virtual_course_code)."'", __FILE__, __LINE__));
  626. return $result['target_course_code'];
  627. }
  628. /*
  629. ==============================================================================
  630. USER FUNCTIONS
  631. ==============================================================================
  632. */
  633. /**
  634. * Return course info array of virtual course
  635. *
  636. * @param $user_id, the id (int) of the user
  637. * @param $course_info, array with info about the course (comes from course table)
  638. *
  639. * @return true if the user is registered in the course, false otherwise
  640. */
  641. public static function is_user_subscribed_in_course($user_id, $course_code, $in_a_session = false) {
  642. $user_id = intval($user_id);
  643. $course_code = Database::escape_string($course_code);
  644. $result = Database::fetch_array(Database::query("SELECT * FROM ".Database::get_main_table(TABLE_MAIN_COURSE_USER)."
  645. WHERE user_id = $user_id AND course_code = '$course_code'", __FILE__, __LINE__));
  646. if (!empty($result)) {
  647. return true; // The user has been registered in this course.
  648. }
  649. if (!$in_a_session) {
  650. return false; // The user has not been registered in this course.
  651. }
  652. if (Database::num_rows(Database::query('SELECT 1 FROM '.Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER).
  653. ' WHERE id_user = '.$user_id.' AND course_code="'.$course_code.'"', __FILE__, __LINE__)) > 0) {
  654. return true;
  655. }
  656. if (Database::num_rows(Database::query('SELECT 1 FROM '.Database::get_main_table(TABLE_MAIN_SESSION_COURSE).
  657. ' WHERE id_coach = '.$user_id.' AND course_code="'.$course_code.'"', __FILE__, __LINE__)) > 0) {
  658. return true;
  659. }
  660. if (Database::num_rows(Database::query('SELECT 1 FROM '.Database::get_main_table(TABLE_MAIN_SESSION).
  661. ' WHERE id='.intval($_SESSION['id_session']).' AND id_coach='.$user_id, __FILE__, __LINE__)) > 0) {
  662. return true;
  663. }
  664. return false;
  665. }
  666. /**
  667. * Is the user a teacher in the given course?
  668. *
  669. * @param $user_id, the id (int) of the user
  670. * @param $course_code, the course code
  671. *
  672. * @return true if the user is a teacher in the course, false otherwise
  673. */
  674. public static function is_course_teacher($user_id, $course_code) {
  675. if ($user_id != strval(intval($user_id))) {
  676. return false;
  677. }
  678. $sql_result = Database::query('SELECT status FROM '.Database::get_main_table(TABLE_MAIN_COURSE_USER).
  679. ' WHERE course_code="'.Database::escape_string($course_code).'" and user_id="'.$user_id.'"', __FILE__, __LINE__);
  680. if (Database::num_rows($sql_result) > 0) {
  681. return Database::result($sql_result, 0, 'status') == 1;
  682. }
  683. return false;
  684. }
  685. /**
  686. * Is the user subscribed in the real course or linked courses?
  687. *
  688. * @param int the id of the user
  689. * @param array info about the course (comes from course table, see database lib)
  690. *
  691. * @return true if the user is registered in the real course or linked courses, false otherwise
  692. */
  693. public static function is_user_subscribed_in_real_or_linked_course ($user_id, $course_code, $session_id = '') {
  694. if ($user_id != strval(intval($user_id))) {
  695. return false;
  696. }
  697. $course_code = Database::escape_string($course_code);
  698. if ($session_id == '') {
  699. $result = Database::fetch_array(Database::query("SELECT *
  700. FROM ".Database::get_main_table(TABLE_MAIN_COURSE)." course
  701. LEFT JOIN ".Database::get_main_table(TABLE_MAIN_COURSE_USER)." course_user
  702. ON course.code = course_user.course_code
  703. WHERE course_user.user_id = '$user_id' AND ( course.code = '$course_code' OR target_course_code = '$course_code')", __FILE__, __LINE__));
  704. return !empty($result);
  705. }
  706. // From here we trust session id.
  707. // Is he/she subscribed to the session's course?
  708. // A user?
  709. if (Database::num_rows(Database::query("SELECT id_user
  710. FROM ".Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER)."
  711. WHERE id_session='".$_SESSION['id_session']."'
  712. AND id_user='$user_id'", __FILE__, __LINE__))) {
  713. return true;
  714. }
  715. // A course coach?
  716. if (Database::num_rows(Database::query("SELECT id_coach
  717. FROM ".Database::get_main_table(TABLE_MAIN_SESSION_COURSE)." AS session_course
  718. WHERE id_session='".$_SESSION['id_session']."'
  719. AND id_coach = '$user_id'
  720. AND course_code='$course_code'", __FILE__, __LINE__))) {
  721. return true;
  722. }
  723. // A session coach?
  724. if (Database::num_rows(Database::query("SELECT id_coach
  725. FROM ".Database::get_main_table(TABLE_MAIN_SESSION)." AS session
  726. WHERE session.id='".$_SESSION['id_session']."'
  727. AND id_coach='$user_id'", __FILE__, __LINE__))) {
  728. return true;
  729. }
  730. return false;
  731. }
  732. /**
  733. * Return user info array of all users registered in the specified real or virtual course
  734. * This only returns the users that are registered in this actual course, not linked courses.
  735. *
  736. * @param string $course_code
  737. * @return array with user info
  738. */
  739. public static function get_user_list_from_course_code($course_code, $with_session = true, $session_id = 0, $limit = '', $order_by = '') {
  740. $session_id = intval($session_id);
  741. $course_code = Database::escape_string($course_code);
  742. $users = array();
  743. $where = array();
  744. $sql = $session_id == 0
  745. ? 'SELECT DISTINCT course_rel_user.status, user.user_id, course_rel_user.role, course_rel_user.tutor_id '
  746. : 'SELECT DISTINCT user.user_id ';
  747. $sql .= ' FROM '.Database::get_main_table(TABLE_MAIN_USER).' as user ';
  748. if (api_get_setting('use_session_mode')=='true' && $with_session) {
  749. $sql .= ' LEFT JOIN '.Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER).' as session_course_user
  750. ON user.user_id = session_course_user.id_user
  751. AND session_course_user.course_code="'.$course_code.'"';
  752. if ($session_id != 0) {
  753. $sql .= ' AND session_course_user.id_session = '.$session_id;
  754. }
  755. $where[] = ' session_course_user.course_code IS NOT NULL ';
  756. }
  757. if ($session_id == 0) {
  758. $sql .= ' LEFT JOIN '.Database::get_main_table(TABLE_MAIN_COURSE_USER).' as course_rel_user
  759. ON user.user_id = course_rel_user.user_id
  760. AND course_rel_user.course_code="'.$course_code.'"';
  761. $where[] = ' course_rel_user.course_code IS NOT NULL ';
  762. }
  763. $sql .= ' WHERE '.implode(' OR ', $where);
  764. $sql .= ' '.$order_by.' '.$limit;
  765. $rs = Database::query($sql, __FILE__, __LINE__);
  766. while ($user = Database::fetch_array($rs)) {
  767. $user_info = Database::get_user_info_from_id($user['user_id']);
  768. $user_info['status'] = $user['status'];
  769. if (isset($user['role'])) {
  770. $user_info['role'] = $user['role'];
  771. }
  772. if (isset($user['tutor_id'])) {
  773. $user_info['tutor_id'] = $user['tutor_id'];
  774. }
  775. $users[$user['user_id']] = $user_info;
  776. }
  777. return $users;
  778. }
  779. /**
  780. * Get a list of coaches of a course and a session
  781. * @param string Course code
  782. * @param int Session ID
  783. * @return array List of users
  784. */
  785. public static function get_coach_list_from_course_code($course_code, $session_id) {
  786. if ($session_id != strval(intval($session_id))) {
  787. return array();
  788. }
  789. $course_code = Database::escape_string($course_code);
  790. $users = array();
  791. // We get the coach for the given course in a given session.
  792. $rs = Database::query('SELECT id_coach FROM '.Database::get_main_table(TABLE_MAIN_SESSION_COURSE).
  793. ' WHERE id_session="'.$session_id.'" AND course_code="'.$course_code.'"', __FILE__, __LINE__);
  794. while ($user = Database::fetch_array($rs)) {
  795. $user_info = Database::get_user_info_from_id($user['id_coach']);
  796. $user_info['status'] = $user['status'];
  797. $user_info['role'] = $user['role'];
  798. $user_info['tutor_id'] = $user['tutor_id'];
  799. $user_info['email'] = $user['email'];
  800. $users[$user['id_coach']] = $user_info;
  801. }
  802. // We get the session coach.
  803. $rs = Database::query('SELECT id_coach FROM '.Database::get_main_table(TABLE_MAIN_SESSION).
  804. ' WHERE id="'.$session_id.'"', __FILE__, __LINE__);
  805. $user_info = array();
  806. $session_id_coach = Database::result($rs, 0, 'id_coach');
  807. $user_info = Database::get_user_info_from_id($session_id_coach);
  808. $user_info['status'] = $user['status'];
  809. $user_info['role'] = $user['role'];
  810. $user_info['tutor_id'] = $user['tutor_id'];
  811. $user_info['email'] = $user['email'];
  812. $users[$session_id_coach] = $user_info;
  813. return $users;
  814. }
  815. /**
  816. * Return user info array of all users registered in the specified real or virtual course
  817. * This only returns the users that are registered in this actual course, not linked courses.
  818. *
  819. * @param string $course_code
  820. * @param boolean $full list to true if we want sessions students too
  821. * @return array with user id
  822. */
  823. public static function get_student_list_from_course_code($course_code, $with_session = false, $session_id = 0) {
  824. $session_id = intval($session_id);
  825. $course_code = Database::escape_string($course_code);
  826. $students = array();
  827. if ($session_id == 0) {
  828. // students directly subscribed to the course
  829. $rs = Database::query("SELECT * FROM ".Database::get_main_table(TABLE_MAIN_COURSE_USER)."
  830. WHERE course_code = '$course_code' AND status = 5", __FILE__, __LINE__);
  831. while ($student = Database::fetch_array($rs)) {
  832. $students[$student['user_id']] = $student;
  833. }
  834. }
  835. // students subscribed to the course through a session
  836. if (api_get_setting('use_session_mode') == 'true' && $with_session) {
  837. $sql_query = "SELECT * FROM ".Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER)." WHERE course_code = '$course_code'";
  838. if ($session_id != 0) {
  839. $sql_query .= ' AND id_session = '.$session_id;
  840. }
  841. $rs = Database::query($sql_query, __FILE__, __LINE__);
  842. while($student = Database::fetch_array($rs)) {
  843. $students[$student['id_user']] = $student;
  844. }
  845. }
  846. return $students;
  847. }
  848. /**
  849. * Return user info array of all teacher-users registered in the specified real or virtual course
  850. * This only returns the users that are registered in this actual course, not linked courses.
  851. *
  852. * @param string $course_code
  853. * @return array with user id
  854. */
  855. public static function get_teacher_list_from_course_code($course_code) {
  856. $course_code = Database::escape_string($course_code);
  857. // teachers directly subscribed to the course
  858. $teachers = array();
  859. // TODO: This query is not optimal.
  860. $rs = Database::query("SELECT u.user_id, u.lastname, u.firstname, u.email, u.username, u.status " .
  861. "FROM ".Database::get_main_table(TABLE_MAIN_COURSE_USER)." cu, ".Database::get_main_table(TABLE_MAIN_USER)." u ".
  862. "WHERE cu.course_code = '$course_code' " .
  863. "AND cu.status = 1 " .
  864. "AND cu.user_id = u.user_id", __FILE__, __LINE__);
  865. while ($teacher = Database::fetch_array($rs)) {
  866. $teachers[$teacher['user_id']] = $teacher;
  867. }
  868. return $teachers;
  869. }
  870. /**
  871. * Return user info array of all users registered in the specified course
  872. * this includes the users of the course itsel and the users of all linked courses.
  873. *
  874. * @param array $course_info
  875. * @return array with user info
  876. */
  877. public static function get_real_and_linked_user_list($course_code, $with_sessions = true, $session_id = 0) {
  878. //get list of virtual courses
  879. $virtual_course_list = self::get_virtual_courses_linked_to_real_course($course_code);
  880. //get users from real course
  881. $user_list = self::get_user_list_from_course_code($course_code, $with_sessions, $session_id);
  882. foreach ($user_list as $this_user) {
  883. $complete_user_list[] = $this_user;
  884. }
  885. //get users from linked courses
  886. foreach ($virtual_course_list as $this_course) {
  887. $course_code = $this_course['code'];
  888. $user_list = self::get_user_list_from_course_code($course_code, $with_sessions, $session_id);
  889. foreach ($user_list as $this_user) {
  890. $complete_user_list[] = $this_user;
  891. }
  892. }
  893. return $complete_user_list;
  894. }
  895. /**
  896. * Return an array of arrays, listing course info of all courses in the list
  897. * linked to the real course $real_course_code, to which the user $user_id is subscribed.
  898. *
  899. * @param $user_id, the id (int) of the user
  900. * @param $real_course_code, the id (char) of the real course
  901. *
  902. * @return array of course info arrays
  903. */
  904. public static function get_list_of_virtual_courses_for_specific_user_and_real_course($user_id, $real_course_code) {
  905. $result_array = array();
  906. if ($user_id != strval(intval($user_id))) {
  907. return $result_array;
  908. }
  909. $course_code = Database::escape_string($course_code);
  910. $sql_result = Database::query("SELECT *
  911. FROM ".Database::get_main_table(TABLE_MAIN_COURSE)." course
  912. LEFT JOIN ".Database::get_main_table(TABLE_MAIN_COURSE_USER)." course_user
  913. ON course.code = course_user.course_code
  914. WHERE course.target_course_code = '$real_course_code' AND course_user.user_id = '$user_id'", __FILE__, __LINE__);
  915. while ($result = Database::fetch_array($sql_result)) {
  916. $result_array[] = $result;
  917. }
  918. return $result_array;
  919. }
  920. /*
  921. ==============================================================================
  922. GROUP FUNCTIONS
  923. ==============================================================================
  924. */
  925. /**
  926. * Get the list of groups from the course
  927. * @param string Course code
  928. * @param int Session ID (optional)
  929. * @return array List of groups info
  930. */
  931. public static function get_group_list_of_course($course_code, $session_id = 0) {
  932. $course_info = Database::get_course_info($course_code);
  933. $database_name = $course_info['db_name'];
  934. $group_list = array();
  935. $session_condition = $session_id == 0 ? '' : ' WHERE g.session_id IN(0,'.intval($session_id).')';
  936. $result = Database::query("SELECT g.id, g.name, COUNT(gu.id) userNb
  937. FROM ".Database::get_course_table(TABLE_GROUP, $database_name)." AS g
  938. LEFT JOIN ".Database::get_course_table(TABLE_GROUP_USER, $database_name)." gu
  939. ON g.id = gu.group_id
  940. $session_condition
  941. GROUP BY g.id
  942. ORDER BY g.name", __FILE__, __LINE__);
  943. while ($group_data = Database::fetch_array($result)) {
  944. $group_list[$group_data['id']] = $group_data;
  945. }
  946. return $group_list;
  947. }
  948. /**
  949. * Checks all parameters needed to create a virtual course.
  950. * If they are all set, the virtual course creation procedure is called.
  951. *
  952. * Call this function instead of create_virtual_course
  953. * @param string Course code
  954. * @param string Course title
  955. * @param string Wanted course code
  956. * @param string Course language
  957. * @param string Course category
  958. * @return bool True on success, false on error
  959. */
  960. public static function attempt_create_virtual_course($real_course_code, $course_title, $wanted_course_code, $course_language, $course_category) {
  961. //better: create parameter list, check the entire list, when false display errormessage
  962. self::check_parameter_or_fail($real_course_code, 'Unspecified parameter: real course id.');
  963. self::check_parameter_or_fail($course_title, 'Unspecified parameter: course title.');
  964. self::check_parameter_or_fail($wanted_course_code, 'Unspecified parameter: wanted course code.');
  965. self::check_parameter_or_fail($course_language, 'Unspecified parameter: course language.');
  966. self::check_parameter_or_fail($course_category, 'Unspecified parameter: course category.');
  967. return self::create_virtual_course($real_course_code, $course_title, $wanted_course_code, $course_language, $course_category);
  968. }
  969. /**
  970. * This function creates a virtual course.
  971. * It assumes all parameters have been checked and are not empty.
  972. * It checks wether a course with the $wanted_course_code already exists.
  973. *
  974. * Users of this library should consider this function private,
  975. * please call attempt_create_virtual_course instead of this one.
  976. *
  977. * @note The virtual course 'owner' id (the first course admin) is set to the CURRENT user id.
  978. * @param string Course code
  979. * @param string Course title
  980. * @param string Wanted course code
  981. * @param string Course language
  982. * @param string Course category
  983. * @return true if the course creation succeeded, false otherwise
  984. * @todo research: expiration date of a course
  985. */
  986. public static function create_virtual_course($real_course_code, $course_title, $wanted_course_code, $course_language, $course_category) {
  987. global $firstExpirationDelay;
  988. $user_id = api_get_user_id();
  989. $real_course_info = Database::get_course_info($real_course_code);
  990. $real_course_code = $real_course_info['system_code'];
  991. //check: virtual course creation fails if another course has the same
  992. //code, real or fake.
  993. if (self::is_existing_course_code($wanted_course_code)) {
  994. Display::display_error_message($wanted_course_code.' - '.get_lang('CourseCodeAlreadyExists'));
  995. return false;
  996. }
  997. //add data to course table, course_rel_user
  998. $course_sys_code = $wanted_course_code;
  999. $course_screen_code = $wanted_course_code;
  1000. $course_repository = $real_course_info['directory'];
  1001. $course_db_name = $real_course_info['db_name'];
  1002. $responsible_teacher = $real_course_info['tutor_name'];
  1003. $faculty_shortname = $course_category;
  1004. // $course_title = $course_title;
  1005. // $course_language = $course_language;
  1006. $teacher_id = $user_id;
  1007. //HACK ----------------------------------------------------------------
  1008. $expiration_date = time() + $firstExpirationDelay;
  1009. //END HACK ------------------------------------------------------------
  1010. 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);
  1011. //above was the normal course creation table update call,
  1012. //now one more thing: fill in the target_course_code field
  1013. Database::query("UPDATE ".Database::get_main_table(TABLE_MAIN_COURSE)." SET target_course_code = '$real_course_code'
  1014. WHERE code = '".Database::escape_string($course_sys_code)."' LIMIT 1 ", __FILE__, __LINE__);
  1015. return true;
  1016. }
  1017. /**
  1018. * Delete a course
  1019. * This function deletes a whole course-area from the platform. When the
  1020. * given course is a virtual course, the database and directory will not be
  1021. * deleted.
  1022. * When the given course is a real course, also all virtual courses refering
  1023. * to the given course will be deleted.
  1024. * Considering the fact that we remove all traces of the course in the main
  1025. * database, it makes sense to remove all tracking as well (if stats databases exist)
  1026. * so that a new course created with this code would not use the remains of an older
  1027. * course.
  1028. *
  1029. * @param string The code of the course to delete
  1030. * @todo When deleting a virtual course: unsubscribe users from that virtual
  1031. * course from the groups in the real course if they are not subscribed in
  1032. * that real course.
  1033. * @todo Remove globals
  1034. */
  1035. public static function delete_course($code) {
  1036. global $_configuration;
  1037. $table_course = Database::get_main_table(TABLE_MAIN_COURSE);
  1038. $table_course_user = Database::get_main_table(TABLE_MAIN_COURSE_USER);
  1039. $table_course_class = Database::get_main_table(TABLE_MAIN_COURSE_CLASS);
  1040. $user_role_table = Database::get_main_table(MAIN_USER_ROLE_TABLE);
  1041. $location_table = Database::get_main_table(MAIN_LOCATION_TABLE);
  1042. $role_right_location_table = Database::get_main_table(MAIN_ROLE_RIGHT_LOCATION_TABLE);
  1043. $table_session_course = Database::get_main_table(TABLE_MAIN_SESSION_COURSE);
  1044. $table_session_course_user = Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER);
  1045. $table_course_survey = Database::get_main_table(TABLE_MAIN_SHARED_SURVEY);
  1046. $table_course_survey_question = Database::get_main_table(TABLE_MAIN_SHARED_SURVEY_QUESTION);
  1047. $table_course_survey_question_option = Database::get_main_table(TABLE_MAIN_SHARED_SURVEY_QUESTION_OPTION);
  1048. $stats = false;
  1049. if (Database::get_statistic_database() != ''){
  1050. $stats = true;
  1051. $table_stats_hotpots = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_HOTPOTATOES);
  1052. $table_stats_attempt = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_ATTEMPT);
  1053. $table_stats_exercises = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_EXERCICES);
  1054. $table_stats_access = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_ACCESS);
  1055. $table_stats_lastaccess = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_LASTACCESS);
  1056. $table_stats_course_access = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_COURSE_ACCESS);
  1057. $table_stats_online = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_ONLINE);
  1058. $table_stats_default = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_DEFAULT);
  1059. $table_stats_downloads = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_DOWNLOADS);
  1060. $table_stats_links = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_LINKS);
  1061. $table_stats_uploads = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_UPLOADS);
  1062. }
  1063. $code = Database::escape_string($code);
  1064. $sql = "SELECT * FROM $table_course WHERE code='".$code."'";
  1065. $res = Database::query($sql, __FILE__, __LINE__);
  1066. if (Database::num_rows($res) == 0) {
  1067. return;
  1068. }
  1069. $this_course = Database::fetch_array($res);
  1070. $db_name = $this_course['db_name'];
  1071. self::create_database_dump($code);
  1072. if (!self::is_virtual_course_from_system_code($code)) {
  1073. // If this is not a virtual course, look for virtual courses that depend on this one, if any
  1074. $virtual_courses = self::get_virtual_courses_linked_to_real_course($code);
  1075. foreach ($virtual_courses as $index => $virtual_course) {
  1076. // Unsubscribe all classes from the virtual course
  1077. $sql = "DELETE FROM $table_course_class WHERE course_code='".$virtual_course['code']."'";
  1078. Database::query($sql, __FILE__, __LINE__);
  1079. // Unsubscribe all users from the virtual course
  1080. $sql = "DELETE FROM $table_course_user WHERE course_code='".$virtual_course['code']."'";
  1081. Database::query($sql, __FILE__, __LINE__);
  1082. // Delete the course from the sessions tables
  1083. $sql = "DELETE FROM $table_session_course WHERE course_code='".$virtual_course['code']."'";
  1084. Database::query($sql, __FILE__, __LINE__);
  1085. $sql = "DELETE FROM $table_session_course_user WHERE course_code='".$virtual_course['code']."'";
  1086. Database::query($sql, __FILE__, __LINE__);
  1087. // Delete the course from the survey tables
  1088. $sql = "DELETE FROM $table_course_survey WHERE course_code='".$virtual_course['code']."'";
  1089. Database::query($sql, __FILE__, __LINE__);
  1090. $sql = "DELETE FROM $table_course_survey_user WHERE db_name='".$virtual_course['db_name']."'";
  1091. Database::query($sql, __FILE__, __LINE__);
  1092. $sql = "DELETE FROM $table_course_survey_reminder WHERE db_name='".$virtual_course['db_name']."'";
  1093. Database::query($sql, __FILE__, __LINE__);
  1094. // Delete the course from the stats tables
  1095. if ($stats) {
  1096. $sql = "DELETE FROM $table_stats_hotpots WHERE exe_cours_id = '".$virtual_course['code']."'";
  1097. Database::query($sql, __FILE__, __LINE__);
  1098. $sql = "DELETE FROM $table_stats_attempt WHERE course_code = '".$virtual_course['code']."'";
  1099. Database::query($sql, __FILE__, __LINE__);
  1100. $sql = "DELETE FROM $table_stats_exercises WHERE exe_cours_id = '".$virtual_course['code']."'";
  1101. Database::query($sql, __FILE__, __LINE__);
  1102. $sql = "DELETE FROM $table_stats_access WHERE access_cours_code = '".$virtual_course['code']."'";
  1103. Database::query($sql, __FILE__, __LINE__);
  1104. $sql = "DELETE FROM $table_stats_lastaccess WHERE access_cours_code = '".$virtual_course['code']."'";
  1105. Database::query($sql, __FILE__, __LINE__);
  1106. $sql = "DELETE FROM $table_stats_course_access WHERE course_code = '".$virtual_course['code']."'";
  1107. Database::query($sql, __FILE__, __LINE__);
  1108. $sql = "DELETE FROM $table_stats_online WHERE course = '".$virtual_course['code']."'";
  1109. Database::query($sql, __FILE__, __LINE__);
  1110. $sql = "DELETE FROM $table_stats_default WHERE default_cours_code = '".$virtual_course['code']."'";
  1111. Database::query($sql, __FILE__, __LINE__);
  1112. $sql = "DELETE FROM $table_stats_downloads WHERE down_cours_id = '".$virtual_course['code']."'";
  1113. Database::query($sql, __FILE__, __LINE__);
  1114. $sql = "DELETE FROM $table_stats_links WHERE links_cours_id = '".$virtual_course['code']."'";
  1115. Database::query($sql, __FILE__, __LINE__);
  1116. $sql = "DELETE FROM $table_stats_uploads WHERE upload_cours_id = '".$virtual_course['code']."'";
  1117. Database::query($sql, __FILE__, __LINE__);
  1118. }
  1119. // Delete the course from the course table
  1120. $sql = "DELETE FROM $table_course WHERE code='".$virtual_course['code']."'";
  1121. Database::query($sql, __FILE__, __LINE__);
  1122. }
  1123. $sql = "SELECT * FROM $table_course WHERE code='".$code."'";
  1124. $res = Database::query($sql, __FILE__, __LINE__);
  1125. $course = Database::fetch_array($res);
  1126. if (!$_configuration['single_database']) {
  1127. $sql = "DROP DATABASE IF EXISTS ".$course['db_name'];
  1128. Database::query($sql, __FILE__, __LINE__);
  1129. } else {
  1130. //TODO Clean the following code as currently it would probably delete another course
  1131. //similarly named, by mistake...
  1132. $db_pattern = $_configuration['table_prefix'].$course['db_name'].$_configuration['db_glue'];
  1133. $sql = "SHOW TABLES LIKE '$db_pattern%'";
  1134. $result = Database::query($sql, __FILE__, __LINE__);
  1135. while (list ($courseTable) = Database::fetch_array($result)) {
  1136. Database::query("DROP TABLE $courseTable", __FILE__, __LINE__);
  1137. }
  1138. }
  1139. $course_dir = api_get_path(SYS_COURSE_PATH).$course['directory'];
  1140. $archive_dir = api_get_path(SYS_ARCHIVE_PATH).$course['directory'].'_'.time();
  1141. if (is_dir($course_dir)) {
  1142. rename($course_dir, $archive_dir);
  1143. }
  1144. }
  1145. // Unsubscribe all classes from the course
  1146. $sql = "DELETE FROM $table_course_class WHERE course_code='".$code."'";
  1147. Database::query($sql, __FILE__, __LINE__);
  1148. // Unsubscribe all users from the course
  1149. $sql = "DELETE FROM $table_course_user WHERE course_code='".$code."'";
  1150. Database::query($sql, __FILE__, __LINE__);
  1151. // Delete the course from the sessions tables
  1152. $sql = "DELETE FROM $table_session_course WHERE course_code='".$code."'";
  1153. Database::query($sql, __FILE__, __LINE__);
  1154. $sql = "DELETE FROM $table_session_course_user WHERE course_code='".$code."'";
  1155. Database::query($sql, __FILE__, __LINE__);
  1156. $sql = 'SELECT survey_id FROM '.$table_course_survey.' WHERE course_code="'.$code.'"';
  1157. $result_surveys = Database::query($sql, __FILE__, __LINE__);
  1158. while($surveys = Database::fetch_array($result_surveys)) {
  1159. $survey_id = $surveys[0];
  1160. $sql = 'DELETE FROM '.$table_course_survey_question.' WHERE survey_id="'.$survey_id.'"';
  1161. Database::query($sql, __FILE__, __LINE__);
  1162. $sql = 'DELETE FROM '.$table_course_survey_question_option.' WHERE survey_id="'.$survey_id.'"';
  1163. Database::query($sql, __FILE__, __LINE__);
  1164. $sql = 'DELETE FROM '.$table_course_survey.' WHERE survey_id="'.$survey_id.'"';
  1165. Database::query($sql, __FILE__, __LINE__);
  1166. }
  1167. // Delete the course from the stats tables
  1168. if ($stats) {
  1169. $sql = "DELETE FROM $table_stats_hotpots WHERE exe_cours_id = '".$code."'";
  1170. Database::query($sql, __FILE__, __LINE__);
  1171. $sql = "DELETE FROM $table_stats_attempt WHERE course_code = '".$code."'";
  1172. Database::query($sql, __FILE__, __LINE__);
  1173. $sql = "DELETE FROM $table_stats_exercises WHERE exe_cours_id = '".$code."'";
  1174. Database::query($sql, __FILE__, __LINE__);
  1175. $sql = "DELETE FROM $table_stats_access WHERE access_cours_code = '".$code."'";
  1176. Database::query($sql, __FILE__, __LINE__);
  1177. $sql = "DELETE FROM $table_stats_lastaccess WHERE access_cours_code = '".$code."'";
  1178. Database::query($sql, __FILE__, __LINE__);
  1179. $sql = "DELETE FROM $table_stats_course_access WHERE course_code = '".$code."'";
  1180. Database::query($sql, __FILE__, __LINE__);
  1181. $sql = "DELETE FROM $table_stats_online WHERE course = '".$code."'";
  1182. Database::query($sql, __FILE__, __LINE__);
  1183. $sql = "DELETE FROM $table_stats_default WHERE default_cours_code = '".$code."'";
  1184. Database::query($sql, __FILE__, __LINE__);
  1185. $sql = "DELETE FROM $table_stats_downloads WHERE down_cours_id = '".$code."'";
  1186. Database::query($sql, __FILE__, __LINE__);
  1187. $sql = "DELETE FROM $table_stats_links WHERE links_cours_id = '".$code."'";
  1188. Database::query($sql, __FILE__, __LINE__);
  1189. $sql = "DELETE FROM $table_stats_uploads WHERE upload_cours_id = '".$code."'";
  1190. Database::query($sql, __FILE__, __LINE__);
  1191. }
  1192. global $_configuration;
  1193. if ($_configuration['multiple_access_urls'] == true) {
  1194. require_once api_get_path(LIBRARY_PATH).'urlmanager.lib.php';
  1195. $url_id = 1;
  1196. if (api_get_current_access_url_id() != -1) {
  1197. $url_id = api_get_current_access_url_id();
  1198. }
  1199. UrlManager::delete_url_rel_course($code, $url_id);
  1200. }
  1201. // Delete the course from the database
  1202. $sql = "DELETE FROM $table_course WHERE code='".$code."'";
  1203. Database::query($sql, __FILE__, __LINE__);
  1204. // delete extra course fields
  1205. $t_cf = Database::get_main_table(TABLE_MAIN_COURSE_FIELD);
  1206. $t_cfv = Database::get_main_table(TABLE_MAIN_COURSE_FIELD_VALUES);
  1207. $sql = "SELECT distinct field_id FROM $t_cfv WHERE course_code = '$code'";
  1208. $res_field_ids = @Database::query($sql, __FILE__, __LINE__);
  1209. while($row_field_id = Database::fetch_row($res_field_ids)){
  1210. $field_ids[] = $row_field_id[0];
  1211. }
  1212. //delete from table_course_field_value from a given course_code
  1213. $sql_course_field_value = "DELETE FROM $t_cfv WHERE course_code = '$code'";
  1214. @Database::query($sql_course_field_value, __FILE__, __LINE__);
  1215. $sql = "SELECT distinct field_id FROM $t_cfv";
  1216. $res_field_all_ids = @Database::query($sql, __FILE__, __LINE__);
  1217. while($row_field_all_id = Database::fetch_row($res_field_all_ids)){
  1218. $field_all_ids[] = $row_field_all_id[0];
  1219. }
  1220. if (is_array($field_ids) && count($field_ids) > 0) {
  1221. foreach ($field_ids as $field_id) {
  1222. // check if field id is used into table field value
  1223. if (is_array($field_all_ids)) {
  1224. if (in_array($field_id, $field_all_ids)) {
  1225. continue;
  1226. } else {
  1227. $sql_course_field = "DELETE FROM $t_cf WHERE id = '$field_id'";
  1228. Database::query($sql_course_field, __FILE__, __LINE__);
  1229. }
  1230. }
  1231. }
  1232. }
  1233. // add event to system log
  1234. $time = time();
  1235. $user_id = api_get_user_id();
  1236. event_system(LOG_COURSE_DELETE, LOG_COURSE_CODE, $code, $time, $user_id, $code);
  1237. }
  1238. /**
  1239. * Creates a file called mysql_dump.sql in the course folder
  1240. * @param $course_code The code of the course
  1241. * @todo Implementation for single database
  1242. */
  1243. public static function create_database_dump($course_code) {
  1244. global $_configuration;
  1245. if ($_configuration['single_database']) {
  1246. return;
  1247. }
  1248. $sql_dump = '';
  1249. $course_code = Database::escape_string($course_code);
  1250. $table_course = Database::get_main_table(TABLE_MAIN_COURSE);
  1251. $sql = "SELECT * FROM $table_course WHERE code = '$course_code'";
  1252. $res = Database::query($sql, __FILE__, __LINE__);
  1253. $course = Database::fetch_array($res);
  1254. $sql = "SHOW TABLES FROM ".$course['db_name'];
  1255. $res = Database::query($sql, __FILE__, __LINE__);
  1256. while ($table = Database::fetch_array($res)) {
  1257. $sql = "SELECT * FROM ".$course['db_name'].".".$table[0]."";
  1258. $res3 = Database::query($sql, __FILE__, __LINE__);
  1259. while ($row = Database::fetch_array($res3)) {
  1260. foreach ($row as $key => $value) {
  1261. $row[$key] = $key."='".addslashes($row[$key])."'";
  1262. }
  1263. $sql_dump .= "\nINSERT INTO $table[0] SET ".implode(', ', $row).';';
  1264. }
  1265. }
  1266. if (is_dir(api_get_path(SYS_COURSE_PATH).$course['directory'])) {
  1267. $file_name = api_get_path(SYS_COURSE_PATH).$course['directory'].'/mysql_dump.sql';
  1268. $handle = fopen($file_name, 'a+');
  1269. if ($handle !== false) {
  1270. fwrite($handle, $sql_dump);
  1271. fclose($handle);
  1272. } else {
  1273. //TODO trigger exception in a try-catch
  1274. }
  1275. }
  1276. }
  1277. /**
  1278. * Sort courses for a specific user ??
  1279. * @param int User ID
  1280. * @param string Course code
  1281. * @return int Minimum course order
  1282. * @todo Review documentation
  1283. */
  1284. public static function userCourseSort($user_id, $course_code) {
  1285. if ($user_id != strval(intval($user_id))) {
  1286. return false;
  1287. }
  1288. $course_code = Database::escape_string($course_code);
  1289. $TABLECOURSE = Database::get_main_table(TABLE_MAIN_COURSE);
  1290. $TABLECOURSUSER = Database::get_main_table(TABLE_MAIN_COURSE_USER);
  1291. $course_title = Database::result(Database::query('SELECT title FROM '.$TABLECOURSE.
  1292. ' WHERE code="'.$course_code.'"', __FILE__, __LINE__), 0, 0);
  1293. $result = Database::query('SELECT course.code as code, course.title as title, cu.sort as sort FROM '.$TABLECOURSUSER.' as cu, '.$TABLECOURSE.' as course
  1294. WHERE course.code = cu.course_code
  1295. AND user_id = "'.$user_id.'"
  1296. AND user_course_cat=0 ORDER BY cu.sort', __FILE__, __LINE__);
  1297. $course_title_precedent = '';
  1298. $counter = 0;
  1299. $course_found = false;
  1300. $course_sort = 1;
  1301. while ($courses = Database::fetch_array($result)){
  1302. if ($course_title_precedent == '') {
  1303. $course_title_precedent = $courses['title'];
  1304. }
  1305. if (api_strcasecmp($course_title_precedent, $course_title) < 0) {
  1306. $course_found = true;
  1307. $course_sort = $courses['sort'];
  1308. if ($counter == 0) {
  1309. $sql = 'UPDATE '.$TABLECOURSUSER.' SET sort = sort+1 WHERE user_id= "'.$user_id.'" AND user_course_cat="0" AND sort > "'.$course_sort.'"';
  1310. $course_sort++;
  1311. } else {
  1312. $sql = 'UPDATE '.$TABLECOURSUSER.' SET sort = sort+1 WHERE user_id= "'.$user_id.'" AND user_course_cat="0" AND sort >= "'.$course_sort.'"';
  1313. }
  1314. Database::query($sql, __FILE__, __LINE__);
  1315. break;
  1316. } else {
  1317. $course_title_precedent = $courses['title'];
  1318. }
  1319. $counter++;
  1320. }
  1321. // We must register the course in the beginning of the list
  1322. if (Database::num_rows($result) > 0 && !$course_found) {
  1323. $course_sort = Database::result(Database::query('SELECT min(sort) as min_sort FROM '.$TABLECOURSUSER.
  1324. ' WHERE user_id="'.$user_id.'" AND user_course_cat="0"', __FILE__, __LINE__), 0, 0);
  1325. Database::query('UPDATE '.$TABLECOURSUSER.' SET sort = sort+1
  1326. WHERE user_id= "'.$user_id.'" AND user_course_cat="0"', __FILE__, __LINE__);
  1327. }
  1328. return $course_sort;
  1329. }
  1330. /**
  1331. * create recursively all categories as option of the select passed in paramater.
  1332. *
  1333. * @param object $select_element the quickform select where the options will be added
  1334. * @param string $category_selected_code the option value to select by default (used mainly for edition of courses)
  1335. * @param string $parent_code the parent category of the categories added (default=null for root category)
  1336. * @param string $padding the indent param (you shouldn't indicate something here)
  1337. */
  1338. public static function select_and_sort_categories($select_element, $category_selected_code = '', $parent_code = null , $padding = '') {
  1339. $res = Database::query("SELECT code, name, auth_course_child, auth_cat_child
  1340. FROM ".Database::get_main_table(TABLE_MAIN_CATEGORY)."
  1341. WHERE parent_id ".(is_null($parent_code) ? "IS NULL" : "='".Database::escape_string($parent_code)."'")."
  1342. ORDER BY code", __FILE__, __LINE__);
  1343. while ($cat = Database::fetch_array($res)) {
  1344. $params = $cat['auth_course_child'] == 'TRUE' ? '' : 'disabled';
  1345. $params .= ($cat['code'] == $category_selected_code) ? ' selected' : '';
  1346. $select_element->addOption($padding.'('.$cat['code'].') '.$cat['name'], $cat['code'], $params);
  1347. if ($cat['auth_cat_child']) {
  1348. self::select_and_sort_categories($select_element, $category_selected_code, $cat['code'], $padding.' - ');
  1349. }
  1350. }
  1351. }
  1352. /**
  1353. * check if course exists
  1354. * @param string course_code
  1355. * @param string whether to accept virtual course codes or not
  1356. * @return true if exists, false else
  1357. */
  1358. public static function course_exists($course_code, $accept_virtual = false) {
  1359. if ($accept_virtual === true) {
  1360. $sql = 'SELECT 1 FROM '.Database::get_main_table(TABLE_MAIN_COURSE).' WHERE code="'.Database::escape_string($course_code).'" OR visual_code="'.Database::escape_string($course_code).'"';
  1361. } else {
  1362. $sql = 'SELECT 1 FROM '.Database::get_main_table(TABLE_MAIN_COURSE).' WHERE code="'.Database::escape_string($course_code).'"';
  1363. }
  1364. return Database::num_rows(Database::query($sql, __FILE__, __LINE__));
  1365. }
  1366. /**
  1367. * Send an email to tutor after the auth-suscription of a student in your course
  1368. * @author Carlos Vargas <carlos.vargas@dokeos.com>, Dokeos Latino
  1369. * @param int $user_id the id of the user
  1370. * @param string $course_code the course code
  1371. * @param string $send_to_tutor_also
  1372. * @return string we return the message that is displayed when the action is succesfull
  1373. */
  1374. public static function email_to_tutor($user_id, $course_code, $send_to_tutor_also = false) {
  1375. if ($user_id != strval(intval($user_id))) {
  1376. return false;
  1377. }
  1378. $course_code = Database::escape_string($course_code);
  1379. $student = Database::fetch_array(Database::query("SELECT * FROM ".Database::get_main_table(TABLE_MAIN_USER)."
  1380. WHERE user_id='".$user_id."'", __FILE__, __LINE__));
  1381. $information = self::get_course_information($course_code);
  1382. $name_course = $information['title'];
  1383. $sql = "SELECT * FROM ".Database::get_main_table(TABLE_MAIN_COURSE_USER)." WHERE course_code='".$course_code."'";
  1384. // TODO: Ivan: This is a mistake, please, have a look at it. Intention here is diffcult to be guessed.
  1385. //if ($send_to_tutor_also = true) {
  1386. // Proposed change:
  1387. if ($send_to_tutor_also) {
  1388. //
  1389. $sql .= " AND tutor_id=1";
  1390. } else {
  1391. $sql .= " AND status=1";
  1392. }
  1393. $result = Database::query($sql, __FILE__, __LINE__);
  1394. while ($row = Database::fetch_array($result)) {
  1395. $tutor = Database::fetch_array(Database::query("SELECT * FROM ".Database::get_main_table(TABLE_MAIN_USER)."
  1396. WHERE user_id='".$row['user_id']."'", __FILE__, __LINE__));
  1397. $emailto = $tutor['email'];
  1398. $emailsubject = get_lang('NewUserInTheCourse').': '.$name_course;
  1399. $emailbody = get_lang('Dear').': '. api_get_person_name($tutor['firstname'], $tutor['lastname'])."\n";
  1400. $emailbody .= get_lang('MessageNewUserInTheCourse').': '.$name_course."\n";
  1401. $emailbody .= get_lang('UserName').': '.$student['username']."\n";
  1402. if (api_is_western_name_order()) {
  1403. $emailbody .= get_lang('FirstName').': '.$student['firstname']."\n";
  1404. $emailbody .= get_lang('LastName').': '.$student['lastname']."\n";
  1405. } else {
  1406. $emailbody .= get_lang('LastName').': '.$student['lastname']."\n";
  1407. $emailbody .= get_lang('FirstName').': '.$student['firstname']."\n";
  1408. }
  1409. $emailbody .= get_lang('Email').': '.$student['email']."\n\n";
  1410. $recipient_name = api_get_person_name($tutor['firstname'], $tutor['lastname'], null, PERSON_NAME_EMAIL_ADDRESS);
  1411. $sender_name = api_get_person_name(api_get_setting('administratorName'), api_get_setting('administratorSurname'), null, PERSON_NAME_EMAIL_ADDRESS);
  1412. $email_admin = api_get_setting('emailAdministrator');
  1413. @api_mail($recipient_name, $emailto, $emailsubject, $emailbody, $sender_name,$email_admin);
  1414. }
  1415. }
  1416. /**
  1417. * Get list of courses for a given user
  1418. * @param int user ID
  1419. * @param boolean Whether to include courses from session or not
  1420. * @return array List of codes and db names
  1421. * @author isaac flores paz
  1422. */
  1423. public static function get_courses_list_by_user_id($user_id, $include_sessions = false) {
  1424. $user_id = intval($user_id);
  1425. $course_list = array();
  1426. $codes = array();
  1427. $result = Database::query('SELECT c.code,c.db_name,c.title
  1428. FROM '.Database::get_main_table(TABLE_MAIN_COURSE).' c
  1429. INNER JOIN '.Database::get_main_table(TABLE_MAIN_COURSE_USER).' cru
  1430. ON c.code=cru.course_code
  1431. WHERE cru.user_id='.$user_id, __FILE__, __LINE__);
  1432. while ($row = Database::fetch_array($result, 'ASSOC')) {
  1433. $course_list[] = $row;
  1434. $codes[] = $row['code'];
  1435. }
  1436. if ($include_sessions === true) {
  1437. $r = Database::query("SELECT distinct(c.code),c.db_name,c.title
  1438. FROM ".Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER)." s, ".Database::get_main_table(TABLE_MAIN_COURSE)." c
  1439. WHERE id_user = $user_id AND s.course_code=c.code", __FILE__, __LINE__);
  1440. while ($row = Database::fetch_array($r, 'ASSOC')) {
  1441. if (!in_array($row['code'], $codes)) {
  1442. $course_list[] = $row;
  1443. }
  1444. }
  1445. }
  1446. return $course_list;
  1447. }
  1448. /**
  1449. * Get course ID from a given course directory name
  1450. * @param string Course directory (without any slash)
  1451. * @return string Course code, or false if not found
  1452. */
  1453. public static function get_course_id_from_path ($path) {
  1454. $path = Database::escape_string(str_replace('.', '', str_replace('/', '', $path)));
  1455. $res = Database::query("SELECT code FROM ".Database::get_main_table(TABLE_MAIN_COURSE)."
  1456. WHERE directory LIKE BINARY '$path'", __FILE__, __LINE__);
  1457. if ($res === false) {
  1458. return false;
  1459. }
  1460. if (Database::num_rows($res) != 1) {
  1461. return false;
  1462. }
  1463. $row = Database::fetch_array($res);
  1464. return $row['code'];
  1465. }
  1466. /**
  1467. * Get course code(s) from visual code
  1468. * @param string Visual code
  1469. * @return array List of codes for the given visual code
  1470. */
  1471. public static function get_courses_info_from_visual_code($code) {
  1472. $result = array();
  1473. $sql_result = Database::query("SELECT * FROM ".Database::get_main_table(TABLE_MAIN_COURSE)."
  1474. WHERE visual_code = '".Database::escape_string($code)."'", __FILE__, __LINE__);
  1475. while ($virtual_course = Database::fetch_array($sql_result)) {
  1476. $result[] = $virtual_course;
  1477. }
  1478. return $result;
  1479. }
  1480. /**
  1481. * Get emails of tutors to course
  1482. * @param string Visual code
  1483. * @return array List of emails of tutors to course
  1484. * @author @author Carlos Vargas <carlos.vargas@dokeos.com>, Dokeos Latino
  1485. * */
  1486. public static function get_emails_of_tutors_to_course($code) {
  1487. $list = array();
  1488. $res = Database::query("SELECT user_id FROM ".Database::get_main_table(TABLE_MAIN_COURSE_USER)."
  1489. WHERE course_code='".Database::escape_string($code)."' AND status=1", __FILE__, __LINE__);
  1490. while ($list_users = Database::fetch_array($res)) {
  1491. $result = Database::query("SELECT * FROM ".Database::get_main_table(TABLE_MAIN_USER)."
  1492. WHERE user_id=".$list_users['user_id'], __FILE__, __LINE__);
  1493. while ($row_user = Database::fetch_array($result)){
  1494. $name_teacher = api_get_person_name($row_user['firstname'], $row_user['lastname'], null, PERSON_NAME_EMAIL_ADDRESS);
  1495. $list[] = array($row_user['email'] => $name_teacher);
  1496. }
  1497. }
  1498. return $list;
  1499. }
  1500. /**
  1501. * Get emails of tutors to course
  1502. * @param string session session
  1503. * @return string email of tutor to session
  1504. * @author @author Carlos Vargas <carlos.vargas@dokeos.com>, Dokeos Latino
  1505. */
  1506. public static function get_email_of_tutor_to_session($session) {
  1507. $row_email = Database::fetch_array(Database::query("SELECT * FROM ".Database::get_main_table(TABLE_MAIN_SESSION_COURSE)."
  1508. WHERE id_session='".Database::escape_string($session)."'", __FILE__, __LINE__));
  1509. $result_user = Database::query("SELECT * FROM ".Database::get_main_table(TABLE_MAIN_USER)."
  1510. WHERE user_id=".$row_email['id_coach'], __FILE__, __LINE__);
  1511. while ($row_emails = Database::fetch_array($result_user)) {
  1512. $name_tutor = api_get_person_name($row_emails['firstname'], $row_emails['lastname'], null, PERSON_NAME_EMAIL_ADDRESS);
  1513. $mail_tutor = array($row_emails['email'] => $name_tutor);
  1514. }
  1515. return $mail_tutor;
  1516. }
  1517. /**
  1518. * Creates a new extra field for a given course
  1519. * @param string Field's internal variable name
  1520. * @param int Field's type
  1521. * @param string Field's language var name
  1522. * @return int new extra field id
  1523. */
  1524. public static function create_course_extra_field($fieldvarname, $fieldtype, $fieldtitle) {
  1525. // database table definition
  1526. $t_cfv = Database::get_main_table(TABLE_MAIN_COURSE_FIELD_VALUES);
  1527. $t_cf = Database::get_main_table(TABLE_MAIN_COURSE_FIELD);
  1528. $fieldvarname = Database::escape_string($fieldvarname);
  1529. $fieldtitle = Database::escape_string($fieldtitle);
  1530. $fieldtype = (int)$fieldtype;
  1531. $time = time();
  1532. $sql_field = "SELECT id FROM $t_cf WHERE field_variable = '$fieldvarname'";
  1533. $res_field = Database::query($sql_field, __FILE__, __LINE__);
  1534. $r_field = Database::fetch_row($res_field);
  1535. if (Database::num_rows($res_field) > 0) {
  1536. return $r_field[0];
  1537. }
  1538. // save new fieldlabel into course_field table
  1539. $sql = "SELECT MAX(field_order) FROM $t_cf";
  1540. $res = Database::query($sql, __FILE__, __LINE__);
  1541. $order = 0;
  1542. if (Database::num_rows($res) > 0) {
  1543. $row = Database::fetch_row($res);
  1544. $order = $row[0] + 1;
  1545. }
  1546. $sql = "INSERT INTO $t_cf
  1547. SET field_type = '$fieldtype',
  1548. field_variable = '$fieldvarname',
  1549. field_display_text = '$fieldtitle',
  1550. field_order = '$order',
  1551. tms = FROM_UNIXTIME($time)";
  1552. Database::query($sql, __FILE__, __LINE__);
  1553. return Database::insert_id();
  1554. }
  1555. /**
  1556. * Update an extra field value for a given course
  1557. * @param integer Course ID
  1558. * @param string Field variable name
  1559. * @param string Field value
  1560. * @return boolean true if field updated, false otherwise
  1561. */
  1562. public static function update_course_extra_field_value($course_code, $fname, $fvalue = '') {
  1563. $t_cfv = Database::get_main_table(TABLE_MAIN_COURSE_FIELD_VALUES);
  1564. $t_cf = Database::get_main_table(TABLE_MAIN_COURSE_FIELD);
  1565. $fname = Database::escape_string($fname);
  1566. $course_code = Database::escape_string($course_code);
  1567. $fvalues = '';
  1568. if (is_array($fvalue)) {
  1569. foreach ($fvalue as $val) {
  1570. $fvalues .= Database::escape_string($val).';';
  1571. }
  1572. if (!empty($fvalues)) {
  1573. $fvalues = substr($fvalues, 0, -1);
  1574. }
  1575. } else {
  1576. $fvalues = Database::escape_string($fvalue);
  1577. }
  1578. $sqlcf = "SELECT * FROM $t_cf WHERE field_variable='$fname'";
  1579. $rescf = Database::query($sqlcf, __FILE__, __LINE__);
  1580. if (Database::num_rows($rescf) == 1) {
  1581. // Ok, the field exists
  1582. // Check if enumerated field, if the option is available
  1583. $rowcf = Database::fetch_array($rescf);
  1584. $tms = time();
  1585. $sqlcfv = "SELECT * FROM $t_cfv WHERE course_code = '$course_code' AND field_id = '".$rowcf['id']."' ORDER BY id";
  1586. $rescfv = Database::query($sqlcfv, __FILE__, __LINE__);
  1587. $n = Database::num_rows($rescfv);
  1588. if ($n > 1) {
  1589. //problem, we already have to values for this field and user combination - keep last one
  1590. while ($rowcfv = Database::fetch_array($rescfv)) { // See the TODO note below.
  1591. if ($n > 1) {
  1592. $sqld = "DELETE FROM $t_cfv WHERE id = ".$rowcfv['id'];
  1593. $resd = Database::query($sqld, __FILE__, __LINE__);
  1594. $n--;
  1595. }
  1596. $rowcfv = Database::fetch_array($rescfv);
  1597. if ($rowcfv['field_value'] != $fvalues) {
  1598. $sqlu = "UPDATE $t_cfv SET field_value = '$fvalues', tms = FROM_UNIXTIME($tms) WHERE id = ".$rowcfv['id'];
  1599. $resu = Database::query($sqlu, __FILE__, __LINE__);
  1600. return ($resu ? true : false);
  1601. }
  1602. return true; // TODO: Sure exit from the function occures in this "while" cycle. Logic should checked. Maybe "if" instead of "while"? It is not clear...
  1603. }
  1604. } elseif ($n == 1) {
  1605. //we need to update the current record
  1606. $rowcfv = Database::fetch_array($rescfv);
  1607. if ($rowcfv['field_value'] != $fvalues) {
  1608. $sqlu = "UPDATE $t_cfv SET field_value = '$fvalues', tms = FROM_UNIXTIME($tms) WHERE id = ".$rowcfv['id'];
  1609. //error_log('UM::update_extra_field_value: '.$sqlu);
  1610. $resu = Database::query($sqlu, __FILE__, __LINE__);
  1611. return ($resu ? true : false);
  1612. }
  1613. return true;
  1614. } else {
  1615. $sqli = "INSERT INTO $t_cfv (course_code,field_id,field_value,tms) " .
  1616. "VALUES ('$course_code',".$rowcf['id'].",'$fvalues',FROM_UNIXTIME($tms))";
  1617. //error_log('UM::update_extra_field_value: '.$sqli);
  1618. $resi = Database::query($sqli, __FILE__, __LINE__);
  1619. return ($resi ? true : false);
  1620. }
  1621. } else {
  1622. return false; //field not found
  1623. }
  1624. }
  1625. /**
  1626. * Get the course id of an course by the database name
  1627. * @param string The database name
  1628. * @return string The course id
  1629. */
  1630. public static function get_course_id_by_database_name($db_name) {
  1631. return Database::result(Database::query('SELECT code FROM '.Database::get_main_table(TABLE_MAIN_COURSE).
  1632. ' WHERE db_name="'.Database::escape_string($db_name).'"', __FILE__, __LINE__), 0, 'code');
  1633. }
  1634. public static function get_session_category_id_by_session_id($session_id) {
  1635. return Database::result(Database::query('SELECT sc.id session_category
  1636. FROM '.Database::get_main_table(TABLE_MAIN_SESSION_CATEGORY).' sc
  1637. INNER JOIN '.Database::get_main_table(TABLE_MAIN_SESSION).' s
  1638. ON sc.id=s.session_category_id WHERE s.id="'.Database::escape_string($session_id).'"', __FILE__, __LINE__),
  1639. 0, 'session_category');
  1640. }
  1641. /**
  1642. * Get the database name of a course by the code
  1643. * @param string The course code
  1644. * @return string The database name
  1645. */
  1646. public static function get_name_database_course($course_code) {
  1647. return Database::result(Database::query('SELECT db_name FROM '.Database::get_main_table(TABLE_MAIN_COURSE).
  1648. ' WHERE code="'.Database::escape_string($course_code).'"', __FILE__, __LINE__), 0, 'db_name');
  1649. }
  1650. /**
  1651. * Lists details of the course description
  1652. * @param array The course description
  1653. * @param string The encoding
  1654. * @param bool If true is displayed if false is hidden
  1655. * @return string The course description in html
  1656. */
  1657. public static function get_details_course_description_html($descriptions, $charset, $action_show = true) {
  1658. if (isset($descriptions) && count($descriptions) > 0) {
  1659. $data = '';
  1660. foreach ($descriptions as $id => $description) {
  1661. $data .= '<div class="sectiontitle">';
  1662. if (api_is_allowed_to_edit() && $action_show == true) {
  1663. //delete
  1664. $data .= '<a href="'.api_get_self().'?'.api_get_cidreq().'&amp;action=delete&amp;description_id='.$description->id.'" onclick="javascript:if(!confirm(\''.addslashes(api_htmlentities(get_lang('ConfirmYourChoice'), ENT_QUOTES, $charset)).'\')) return false;">';
  1665. $data .= Display::return_icon('delete.gif', get_lang('Delete'), array('style' => 'vertical-align:middle;float:right;'));
  1666. $data .= '</a> ';
  1667. //edit
  1668. $data .= '<a href="'.api_get_self().'?'.api_get_cidreq().'&amp;description_id='.$description->id.'">';
  1669. $data .= Display::return_icon('edit.gif', get_lang('Edit'), array('style' => 'vertical-align:middle;float:right; padding-right:4px;'));
  1670. $data .= '</a> ';
  1671. }
  1672. $data .= $description->title;
  1673. $data .= '</div>';
  1674. $data .= '<div class="sectioncomment">';
  1675. $data .= text_filter($description->content);
  1676. $data .= '</div>';
  1677. }
  1678. } else {
  1679. $data .= '<em>'.get_lang('ThisCourseDescriptionIsEmpty').'</em>';
  1680. }
  1681. return $data;
  1682. }
  1683. /*
  1684. ==============================================================================
  1685. DEPRECATED METHODS
  1686. ==============================================================================
  1687. */
  1688. /**
  1689. * This code creates a select form element to let the user
  1690. * choose a real course to link to.
  1691. *
  1692. * A good non-display library should not use echo statements, but just return text/html
  1693. * so users of the library can choose when to display.
  1694. *
  1695. * We display the course code, but internally store the course id.
  1696. *
  1697. * @param boolean $has_size, true the select tag gets a size element, false it stays a dropdownmenu
  1698. * @param boolean $only_current_user_courses, true only the real courses of which the
  1699. * current user is course admin are displayed, false all real courses are shown.
  1700. * @param string $element_name the name of the select element
  1701. * @return a string containing html code for a form select element.
  1702. * @deprecated Function not in use
  1703. */
  1704. public static function get_real_course_code_select_html($element_name, $has_size = true, $only_current_user_courses = true, $user_id) {
  1705. if ($only_current_user_courses) {
  1706. $real_course_list = self::get_real_course_list_of_user_as_course_admin($user_id);
  1707. } else {
  1708. $real_course_list = self::get_real_course_list();
  1709. }
  1710. if ($has_size) {
  1711. $size_element = "size=\"".SELECT_BOX_SIZE."\"";
  1712. } else {
  1713. $size_element = "";
  1714. }
  1715. $html_code = "<select name=\"$element_name\" $size_element >\n";
  1716. foreach ($real_course_list as $real_course) {
  1717. $course_code = $real_course["code"];
  1718. $html_code .= "<option value=\"".$course_code."\">";
  1719. $html_code .= $course_code;
  1720. $html_code .= "</option>\n";
  1721. }
  1722. $html_code .= "</select>\n";
  1723. return $html_code;
  1724. }
  1725. } //end class CourseManager