course.lib.php 86 KB

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