course.lib.php 90 KB

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