course.lib.php 85 KB

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