course.lib.php 82 KB

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