course.lib.php 89 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264
  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_condition = $session_id == 0 ? '' : ' WHERE g.session_id IN(0,'.intval($session_id).')';
  1011. $result = Database::query("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. while ($group_data = Database::fetch_array($result)) {
  1019. $group_list[$group_data['id']] = $group_data;
  1020. }
  1021. return $group_list;
  1022. }
  1023. /**
  1024. * Checks all parameters needed to create a virtual course.
  1025. * If they are all set, the virtual course creation procedure is called.
  1026. *
  1027. * Call this function instead of create_virtual_course
  1028. * @param string Course code
  1029. * @param string Course title
  1030. * @param string Wanted course code
  1031. * @param string Course language
  1032. * @param string Course category
  1033. * @return bool True on success, false on error
  1034. */
  1035. public static function attempt_create_virtual_course($real_course_code, $course_title, $wanted_course_code, $course_language, $course_category) {
  1036. //better: create parameter list, check the entire list, when false display errormessage
  1037. self::check_parameter_or_fail($real_course_code, 'Unspecified parameter: real course id.');
  1038. self::check_parameter_or_fail($course_title, 'Unspecified parameter: course title.');
  1039. self::check_parameter_or_fail($wanted_course_code, 'Unspecified parameter: wanted course code.');
  1040. self::check_parameter_or_fail($course_language, 'Unspecified parameter: course language.');
  1041. self::check_parameter_or_fail($course_category, 'Unspecified parameter: course category.');
  1042. return self::create_virtual_course($real_course_code, $course_title, $wanted_course_code, $course_language, $course_category);
  1043. }
  1044. /**
  1045. * This function creates a virtual course.
  1046. * It assumes all parameters have been checked and are not empty.
  1047. * It checks wether a course with the $wanted_course_code already exists.
  1048. *
  1049. * Users of this library should consider this function private,
  1050. * please call attempt_create_virtual_course instead of this one.
  1051. *
  1052. * @note The virtual course 'owner' id (the first course admin) is set to the CURRENT user id.
  1053. * @param string Course code
  1054. * @param string Course title
  1055. * @param string Wanted course code
  1056. * @param string Course language
  1057. * @param string Course category
  1058. * @return true if the course creation succeeded, false otherwise
  1059. * @todo research: expiration date of a course
  1060. */
  1061. public static function create_virtual_course($real_course_code, $course_title, $wanted_course_code, $course_language, $course_category) {
  1062. global $firstExpirationDelay;
  1063. $user_id = api_get_user_id();
  1064. $real_course_info = Database::get_course_info($real_course_code);
  1065. $real_course_code = $real_course_info['system_code'];
  1066. //check: virtual course creation fails if another course has the same
  1067. //code, real or fake.
  1068. if (self::is_existing_course_code($wanted_course_code)) {
  1069. Display::display_error_message($wanted_course_code.' - '.get_lang('CourseCodeAlreadyExists'));
  1070. return false;
  1071. }
  1072. //add data to course table, course_rel_user
  1073. $course_sys_code = $wanted_course_code;
  1074. $course_screen_code = $wanted_course_code;
  1075. $course_repository = $real_course_info['directory'];
  1076. $course_db_name = $real_course_info['db_name'];
  1077. $responsible_teacher = $real_course_info['tutor_name'];
  1078. $faculty_shortname = $course_category;
  1079. // $course_title = $course_title;
  1080. // $course_language = $course_language;
  1081. $teacher_id = $user_id;
  1082. //HACK ----------------------------------------------------------------
  1083. $expiration_date = time() + $firstExpirationDelay;
  1084. //END HACK ------------------------------------------------------------
  1085. 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);
  1086. //above was the normal course creation table update call,
  1087. //now one more thing: fill in the target_course_code field
  1088. Database::query("UPDATE ".Database::get_main_table(TABLE_MAIN_COURSE)." SET target_course_code = '$real_course_code'
  1089. WHERE code = '".Database::escape_string($course_sys_code)."' LIMIT 1 ");
  1090. return true;
  1091. }
  1092. /**
  1093. * Delete a course
  1094. * This function deletes a whole course-area from the platform. When the
  1095. * given course is a virtual course, the database and directory will not be
  1096. * deleted.
  1097. * When the given course is a real course, also all virtual courses refering
  1098. * to the given course will be deleted.
  1099. * Considering the fact that we remove all traces of the course in the main
  1100. * database, it makes sense to remove all tracking as well (if stats databases exist)
  1101. * so that a new course created with this code would not use the remains of an older
  1102. * course.
  1103. *
  1104. * @param string The code of the course to delete
  1105. * @todo When deleting a virtual course: unsubscribe users from that virtual
  1106. * course from the groups in the real course if they are not subscribed in
  1107. * that real course.
  1108. * @todo Remove globals
  1109. */
  1110. public static function delete_course($code) {
  1111. global $_configuration;
  1112. $table_course = Database::get_main_table(TABLE_MAIN_COURSE);
  1113. $table_course_user = Database::get_main_table(TABLE_MAIN_COURSE_USER);
  1114. $table_course_class = Database::get_main_table(TABLE_MAIN_COURSE_CLASS);
  1115. $user_role_table = Database::get_main_table(MAIN_USER_ROLE_TABLE);
  1116. $location_table = Database::get_main_table(MAIN_LOCATION_TABLE);
  1117. $role_right_location_table = Database::get_main_table(MAIN_ROLE_RIGHT_LOCATION_TABLE);
  1118. $table_session_course = Database::get_main_table(TABLE_MAIN_SESSION_COURSE);
  1119. $table_session_course_user = Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER);
  1120. $table_course_survey = Database::get_main_table(TABLE_MAIN_SHARED_SURVEY);
  1121. $table_course_survey_question = Database::get_main_table(TABLE_MAIN_SHARED_SURVEY_QUESTION);
  1122. $table_course_survey_question_option = Database::get_main_table(TABLE_MAIN_SHARED_SURVEY_QUESTION_OPTION);
  1123. $stats = false;
  1124. if (Database::get_statistic_database() != ''){
  1125. $stats = true;
  1126. $table_stats_hotpots = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_HOTPOTATOES);
  1127. $table_stats_attempt = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_ATTEMPT);
  1128. $table_stats_exercises = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_EXERCICES);
  1129. $table_stats_access = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_ACCESS);
  1130. $table_stats_lastaccess = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_LASTACCESS);
  1131. $table_stats_course_access = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_COURSE_ACCESS);
  1132. $table_stats_online = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_ONLINE);
  1133. $table_stats_default = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_DEFAULT);
  1134. $table_stats_downloads = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_DOWNLOADS);
  1135. $table_stats_links = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_LINKS);
  1136. $table_stats_uploads = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_UPLOADS);
  1137. }
  1138. $code = Database::escape_string($code);
  1139. $sql = "SELECT * FROM $table_course WHERE code='".$code."'";
  1140. $res = Database::query($sql);
  1141. if (Database::num_rows($res) == 0) {
  1142. return;
  1143. }
  1144. $this_course = Database::fetch_array($res);
  1145. $db_name = $this_course['db_name'];
  1146. self::create_database_dump($code);
  1147. if (!self::is_virtual_course_from_system_code($code)) {
  1148. // If this is not a virtual course, look for virtual courses that depend on this one, if any
  1149. $virtual_courses = self::get_virtual_courses_linked_to_real_course($code);
  1150. foreach ($virtual_courses as $index => $virtual_course) {
  1151. // Unsubscribe all classes from the virtual course
  1152. $sql = "DELETE FROM $table_course_class WHERE course_code='".$virtual_course['code']."'";
  1153. Database::query($sql);
  1154. // Unsubscribe all users from the virtual course
  1155. $sql = "DELETE FROM $table_course_user WHERE course_code='".$virtual_course['code']."'";
  1156. Database::query($sql);
  1157. // Delete the course from the sessions tables
  1158. $sql = "DELETE FROM $table_session_course WHERE course_code='".$virtual_course['code']."'";
  1159. Database::query($sql);
  1160. $sql = "DELETE FROM $table_session_course_user WHERE course_code='".$virtual_course['code']."'";
  1161. Database::query($sql);
  1162. // Delete the course from the survey tables
  1163. $sql = "DELETE FROM $table_course_survey WHERE course_code='".$virtual_course['code']."'";
  1164. Database::query($sql);
  1165. $sql = "DELETE FROM $table_course_survey_user WHERE db_name='".$virtual_course['db_name']."'";
  1166. Database::query($sql);
  1167. $sql = "DELETE FROM $table_course_survey_reminder WHERE db_name='".$virtual_course['db_name']."'";
  1168. Database::query($sql);
  1169. // Delete the course from the stats tables
  1170. if ($stats) {
  1171. $sql = "DELETE FROM $table_stats_hotpots WHERE exe_cours_id = '".$virtual_course['code']."'";
  1172. Database::query($sql);
  1173. $sql = "DELETE FROM $table_stats_attempt WHERE course_code = '".$virtual_course['code']."'";
  1174. Database::query($sql);
  1175. $sql = "DELETE FROM $table_stats_exercises WHERE exe_cours_id = '".$virtual_course['code']."'";
  1176. Database::query($sql);
  1177. $sql = "DELETE FROM $table_stats_access WHERE access_cours_code = '".$virtual_course['code']."'";
  1178. Database::query($sql);
  1179. $sql = "DELETE FROM $table_stats_lastaccess WHERE access_cours_code = '".$virtual_course['code']."'";
  1180. Database::query($sql);
  1181. $sql = "DELETE FROM $table_stats_course_access WHERE course_code = '".$virtual_course['code']."'";
  1182. Database::query($sql);
  1183. $sql = "DELETE FROM $table_stats_online WHERE course = '".$virtual_course['code']."'";
  1184. Database::query($sql);
  1185. $sql = "DELETE FROM $table_stats_default WHERE default_cours_code = '".$virtual_course['code']."'";
  1186. Database::query($sql);
  1187. $sql = "DELETE FROM $table_stats_downloads WHERE down_cours_id = '".$virtual_course['code']."'";
  1188. Database::query($sql);
  1189. $sql = "DELETE FROM $table_stats_links WHERE links_cours_id = '".$virtual_course['code']."'";
  1190. Database::query($sql);
  1191. $sql = "DELETE FROM $table_stats_uploads WHERE upload_cours_id = '".$virtual_course['code']."'";
  1192. Database::query($sql);
  1193. }
  1194. // Delete the course from the course table
  1195. $sql = "DELETE FROM $table_course WHERE code='".$virtual_course['code']."'";
  1196. Database::query($sql);
  1197. }
  1198. $sql = "SELECT * FROM $table_course WHERE code='".$code."'";
  1199. $res = Database::query($sql);
  1200. $course = Database::fetch_array($res);
  1201. if (!$_configuration['single_database']) {
  1202. $sql = "DROP DATABASE IF EXISTS ".$course['db_name'];
  1203. Database::query($sql);
  1204. } else {
  1205. //TODO Clean the following code as currently it would probably delete another course
  1206. //similarly named, by mistake...
  1207. $db_pattern = $_configuration['table_prefix'].$course['db_name'].$_configuration['db_glue'];
  1208. $sql = "SHOW TABLES LIKE '$db_pattern%'";
  1209. $result = Database::query($sql);
  1210. while (list ($courseTable) = Database::fetch_array($result)) {
  1211. Database::query("DROP TABLE $courseTable");
  1212. }
  1213. }
  1214. $course_dir = api_get_path(SYS_COURSE_PATH).$course['directory'];
  1215. $archive_dir = api_get_path(SYS_ARCHIVE_PATH).$course['directory'].'_'.time();
  1216. if (is_dir($course_dir)) {
  1217. rename($course_dir, $archive_dir);
  1218. }
  1219. }
  1220. // Unsubscribe all classes from the course
  1221. $sql = "DELETE FROM $table_course_class WHERE course_code='".$code."'";
  1222. Database::query($sql);
  1223. // Unsubscribe all users from the course
  1224. $sql = "DELETE FROM $table_course_user WHERE course_code='".$code."'";
  1225. Database::query($sql);
  1226. // Delete the course from the sessions tables
  1227. $sql = "DELETE FROM $table_session_course WHERE course_code='".$code."'";
  1228. Database::query($sql);
  1229. $sql = "DELETE FROM $table_session_course_user WHERE course_code='".$code."'";
  1230. Database::query($sql);
  1231. $sql = 'SELECT survey_id FROM '.$table_course_survey.' WHERE course_code="'.$code.'"';
  1232. $result_surveys = Database::query($sql);
  1233. while($surveys = Database::fetch_array($result_surveys)) {
  1234. $survey_id = $surveys[0];
  1235. $sql = 'DELETE FROM '.$table_course_survey_question.' WHERE survey_id="'.$survey_id.'"';
  1236. Database::query($sql);
  1237. $sql = 'DELETE FROM '.$table_course_survey_question_option.' WHERE survey_id="'.$survey_id.'"';
  1238. Database::query($sql);
  1239. $sql = 'DELETE FROM '.$table_course_survey.' WHERE survey_id="'.$survey_id.'"';
  1240. Database::query($sql);
  1241. }
  1242. // Delete the course from the stats tables
  1243. if ($stats) {
  1244. $sql = "DELETE FROM $table_stats_hotpots WHERE exe_cours_id = '".$code."'";
  1245. Database::query($sql);
  1246. $sql = "DELETE FROM $table_stats_attempt WHERE course_code = '".$code."'";
  1247. Database::query($sql);
  1248. $sql = "DELETE FROM $table_stats_exercises WHERE exe_cours_id = '".$code."'";
  1249. Database::query($sql);
  1250. $sql = "DELETE FROM $table_stats_access WHERE access_cours_code = '".$code."'";
  1251. Database::query($sql);
  1252. $sql = "DELETE FROM $table_stats_lastaccess WHERE access_cours_code = '".$code."'";
  1253. Database::query($sql);
  1254. $sql = "DELETE FROM $table_stats_course_access WHERE course_code = '".$code."'";
  1255. Database::query($sql);
  1256. $sql = "DELETE FROM $table_stats_online WHERE course = '".$code."'";
  1257. Database::query($sql);
  1258. $sql = "DELETE FROM $table_stats_default WHERE default_cours_code = '".$code."'";
  1259. Database::query($sql);
  1260. $sql = "DELETE FROM $table_stats_downloads WHERE down_cours_id = '".$code."'";
  1261. Database::query($sql);
  1262. $sql = "DELETE FROM $table_stats_links WHERE links_cours_id = '".$code."'";
  1263. Database::query($sql);
  1264. $sql = "DELETE FROM $table_stats_uploads WHERE upload_cours_id = '".$code."'";
  1265. Database::query($sql);
  1266. }
  1267. global $_configuration;
  1268. if ($_configuration['multiple_access_urls'] == true) {
  1269. require_once api_get_path(LIBRARY_PATH).'urlmanager.lib.php';
  1270. $url_id = 1;
  1271. if (api_get_current_access_url_id() != -1) {
  1272. $url_id = api_get_current_access_url_id();
  1273. }
  1274. UrlManager::delete_url_rel_course($code, $url_id);
  1275. }
  1276. // Delete the course from the database
  1277. $sql = "DELETE FROM $table_course WHERE code='".$code."'";
  1278. Database::query($sql);
  1279. // delete extra course fields
  1280. $t_cf = Database::get_main_table(TABLE_MAIN_COURSE_FIELD);
  1281. $t_cfv = Database::get_main_table(TABLE_MAIN_COURSE_FIELD_VALUES);
  1282. $sql = "SELECT distinct field_id FROM $t_cfv WHERE course_code = '$code'";
  1283. $res_field_ids = @Database::query($sql);
  1284. while($row_field_id = Database::fetch_row($res_field_ids)){
  1285. $field_ids[] = $row_field_id[0];
  1286. }
  1287. //delete from table_course_field_value from a given course_code
  1288. $sql_course_field_value = "DELETE FROM $t_cfv WHERE course_code = '$code'";
  1289. @Database::query($sql_course_field_value);
  1290. $sql = "SELECT distinct field_id FROM $t_cfv";
  1291. $res_field_all_ids = @Database::query($sql);
  1292. while($row_field_all_id = Database::fetch_row($res_field_all_ids)){
  1293. $field_all_ids[] = $row_field_all_id[0];
  1294. }
  1295. if (is_array($field_ids) && count($field_ids) > 0) {
  1296. foreach ($field_ids as $field_id) {
  1297. // check if field id is used into table field value
  1298. if (is_array($field_all_ids)) {
  1299. if (in_array($field_id, $field_all_ids)) {
  1300. continue;
  1301. } else {
  1302. $sql_course_field = "DELETE FROM $t_cf WHERE id = '$field_id'";
  1303. Database::query($sql_course_field);
  1304. }
  1305. }
  1306. }
  1307. }
  1308. // add event to system log
  1309. $time = time();
  1310. $user_id = api_get_user_id();
  1311. event_system(LOG_COURSE_DELETE, LOG_COURSE_CODE, $code, $time, $user_id, $code);
  1312. }
  1313. /**
  1314. * Creates a file called mysql_dump.sql in the course folder
  1315. * @param $course_code The code of the course
  1316. * @todo Implementation for single database
  1317. */
  1318. public static function create_database_dump($course_code) {
  1319. global $_configuration;
  1320. if ($_configuration['single_database']) {
  1321. return;
  1322. }
  1323. $sql_dump = '';
  1324. $course_code = Database::escape_string($course_code);
  1325. $table_course = Database::get_main_table(TABLE_MAIN_COURSE);
  1326. $sql = "SELECT * FROM $table_course WHERE code = '$course_code'";
  1327. $res = Database::query($sql);
  1328. $course = Database::fetch_array($res);
  1329. $sql = "SHOW TABLES FROM ".$course['db_name'];
  1330. $res = Database::query($sql);
  1331. while ($table = Database::fetch_array($res)) {
  1332. $sql = "SELECT * FROM ".$course['db_name'].".".$table[0]."";
  1333. $res3 = Database::query($sql);
  1334. while ($row = Database::fetch_array($res3)) {
  1335. foreach ($row as $key => $value) {
  1336. $row[$key] = $key."='".addslashes($row[$key])."'";
  1337. }
  1338. $sql_dump .= "\nINSERT INTO $table[0] SET ".implode(', ', $row).';';
  1339. }
  1340. }
  1341. if (is_dir(api_get_path(SYS_COURSE_PATH).$course['directory'])) {
  1342. $file_name = api_get_path(SYS_COURSE_PATH).$course['directory'].'/mysql_dump.sql';
  1343. $handle = fopen($file_name, 'a+');
  1344. if ($handle !== false) {
  1345. fwrite($handle, $sql_dump);
  1346. fclose($handle);
  1347. } else {
  1348. //TODO trigger exception in a try-catch
  1349. }
  1350. }
  1351. }
  1352. /**
  1353. * Sort courses for a specific user ??
  1354. * @param int User ID
  1355. * @param string Course code
  1356. * @return int Minimum course order
  1357. * @todo Review documentation
  1358. */
  1359. public static function userCourseSort($user_id, $course_code) {
  1360. if ($user_id != strval(intval($user_id))) {
  1361. return false;
  1362. }
  1363. $course_code = Database::escape_string($course_code);
  1364. $TABLECOURSE = Database::get_main_table(TABLE_MAIN_COURSE);
  1365. $TABLECOURSUSER = Database::get_main_table(TABLE_MAIN_COURSE_USER);
  1366. $course_title = Database::result(Database::query('SELECT title FROM '.$TABLECOURSE.
  1367. ' WHERE code="'.$course_code.'"'), 0, 0);
  1368. $result = Database::query('SELECT course.code as code, course.title as title, cu.sort as sort FROM '.$TABLECOURSUSER.' as cu, '.$TABLECOURSE.' as course
  1369. WHERE course.code = cu.course_code
  1370. AND user_id = "'.$user_id.'"
  1371. AND cu.relation_type<>'.COURSE_RELATION_TYPE_RRHH.'
  1372. AND user_course_cat=0 ORDER BY cu.sort');
  1373. $course_title_precedent = '';
  1374. $counter = 0;
  1375. $course_found = false;
  1376. $course_sort = 1;
  1377. while ($courses = Database::fetch_array($result)){
  1378. if ($course_title_precedent == '') {
  1379. $course_title_precedent = $courses['title'];
  1380. }
  1381. if (api_strcasecmp($course_title_precedent, $course_title) < 0) {
  1382. $course_found = true;
  1383. $course_sort = $courses['sort'];
  1384. if ($counter == 0) {
  1385. $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.'"';
  1386. $course_sort++;
  1387. } else {
  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. }
  1390. Database::query($sql);
  1391. break;
  1392. } else {
  1393. $course_title_precedent = $courses['title'];
  1394. }
  1395. $counter++;
  1396. }
  1397. // We must register the course in the beginning of the list
  1398. if (Database::num_rows($result) > 0 && !$course_found) {
  1399. $course_sort = Database::result(Database::query('SELECT min(sort) as min_sort FROM '.$TABLECOURSUSER.
  1400. ' WHERE user_id="'.$user_id.'" AND user_course_cat="0"'), 0, 0);
  1401. Database::query('UPDATE '.$TABLECOURSUSER.' SET sort = sort+1
  1402. WHERE user_id= "'.$user_id.'" AND user_course_cat="0"');
  1403. }
  1404. return $course_sort;
  1405. }
  1406. /**
  1407. * create recursively all categories as option of the select passed in paramater.
  1408. *
  1409. * @param object $select_element the quickform select where the options will be added
  1410. * @param string $category_selected_code the option value to select by default (used mainly for edition of courses)
  1411. * @param string $parent_code the parent category of the categories added (default=null for root category)
  1412. * @param string $padding the indent param (you shouldn't indicate something here)
  1413. */
  1414. public static function select_and_sort_categories($select_element, $category_selected_code = '', $parent_code = null , $padding = '') {
  1415. $res = Database::query("SELECT code, name, auth_course_child, auth_cat_child
  1416. FROM ".Database::get_main_table(TABLE_MAIN_CATEGORY)."
  1417. WHERE parent_id ".(is_null($parent_code) ? "IS NULL" : "='".Database::escape_string($parent_code)."'")."
  1418. ORDER BY code");
  1419. while ($cat = Database::fetch_array($res)) {
  1420. $params = $cat['auth_course_child'] == 'TRUE' ? '' : 'disabled';
  1421. $params .= ($cat['code'] == $category_selected_code) ? ' selected' : '';
  1422. $select_element->addOption($padding.'('.$cat['code'].') '.$cat['name'], $cat['code'], $params);
  1423. if ($cat['auth_cat_child']) {
  1424. self::select_and_sort_categories($select_element, $category_selected_code, $cat['code'], $padding.' - ');
  1425. }
  1426. }
  1427. }
  1428. /**
  1429. * check if course exists
  1430. * @param string course_code
  1431. * @param string whether to accept virtual course codes or not
  1432. * @return true if exists, false else
  1433. */
  1434. public static function course_exists($course_code, $accept_virtual = false) {
  1435. if ($accept_virtual === true) {
  1436. $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).'"';
  1437. } else {
  1438. $sql = 'SELECT 1 FROM '.Database::get_main_table(TABLE_MAIN_COURSE).' WHERE code="'.Database::escape_string($course_code).'"';
  1439. }
  1440. return Database::num_rows(Database::query($sql));
  1441. }
  1442. /**
  1443. * Send an email to tutor after the auth-suscription of a student in your course
  1444. * @author Carlos Vargas <carlos.vargas@dokeos.com>, Dokeos Latino
  1445. * @param int $user_id the id of the user
  1446. * @param string $course_code the course code
  1447. * @param string $send_to_tutor_also
  1448. * @return string we return the message that is displayed when the action is succesfull
  1449. */
  1450. public static function email_to_tutor($user_id, $course_code, $send_to_tutor_also = false) {
  1451. if ($user_id != strval(intval($user_id))) {
  1452. return false;
  1453. }
  1454. $course_code = Database::escape_string($course_code);
  1455. $student = Database::fetch_array(Database::query("SELECT * FROM ".Database::get_main_table(TABLE_MAIN_USER)."
  1456. WHERE user_id='".$user_id."'"));
  1457. $information = self::get_course_information($course_code);
  1458. $name_course = $information['title'];
  1459. $sql = "SELECT * FROM ".Database::get_main_table(TABLE_MAIN_COURSE_USER)." WHERE course_code='".$course_code."'";
  1460. // TODO: Ivan: This is a mistake, please, have a look at it. Intention here is diffcult to be guessed.
  1461. //if ($send_to_tutor_also = true) {
  1462. // Proposed change:
  1463. if ($send_to_tutor_also) {
  1464. //
  1465. $sql .= " AND tutor_id=1";
  1466. } else {
  1467. $sql .= " AND status=1";
  1468. }
  1469. $result = Database::query($sql);
  1470. while ($row = Database::fetch_array($result)) {
  1471. $tutor = Database::fetch_array(Database::query("SELECT * FROM ".Database::get_main_table(TABLE_MAIN_USER)."
  1472. WHERE user_id='".$row['user_id']."'"));
  1473. $emailto = $tutor['email'];
  1474. $emailsubject = get_lang('NewUserInTheCourse').': '.$name_course;
  1475. $emailbody = get_lang('Dear').': '. api_get_person_name($tutor['firstname'], $tutor['lastname'])."\n";
  1476. $emailbody .= get_lang('MessageNewUserInTheCourse').': '.$name_course."\n";
  1477. $emailbody .= get_lang('UserName').': '.$student['username']."\n";
  1478. if (api_is_western_name_order()) {
  1479. $emailbody .= get_lang('FirstName').': '.$student['firstname']."\n";
  1480. $emailbody .= get_lang('LastName').': '.$student['lastname']."\n";
  1481. } else {
  1482. $emailbody .= get_lang('LastName').': '.$student['lastname']."\n";
  1483. $emailbody .= get_lang('FirstName').': '.$student['firstname']."\n";
  1484. }
  1485. $emailbody .= get_lang('Email').': '.$student['email']."\n\n";
  1486. $recipient_name = api_get_person_name($tutor['firstname'], $tutor['lastname'], null, PERSON_NAME_EMAIL_ADDRESS);
  1487. $sender_name = api_get_person_name(api_get_setting('administratorName'), api_get_setting('administratorSurname'), null, PERSON_NAME_EMAIL_ADDRESS);
  1488. $email_admin = api_get_setting('emailAdministrator');
  1489. @api_mail($recipient_name, $emailto, $emailsubject, $emailbody, $sender_name,$email_admin);
  1490. }
  1491. }
  1492. /**
  1493. * Get list of courses for a given user
  1494. * @param int user ID
  1495. * @param boolean Whether to include courses from session or not
  1496. * @return array List of codes and db names
  1497. * @author isaac flores paz
  1498. */
  1499. public static function get_courses_list_by_user_id($user_id, $include_sessions = false) {
  1500. $user_id = intval($user_id);
  1501. $course_list = array();
  1502. $codes = array();
  1503. $tbl_course = Database::get_main_table(TABLE_MAIN_COURSE);
  1504. $tbl_course_user = Database::get_main_table(TABLE_MAIN_COURSE_USER);
  1505. $tbl_course_field = Database :: get_main_table(TABLE_MAIN_COURSE_FIELD);
  1506. $tbl_course_field_value = Database :: get_main_table(TABLE_MAIN_COURSE_FIELD_VALUES);
  1507. $tbl_user_course_category = Database :: get_user_personal_table(TABLE_USER_COURSE_CATEGORY);
  1508. // get course list auto-register
  1509. $sql = "SELECT course_code FROM $tbl_course_field_value tcfv INNER JOIN $tbl_course_field tcf ON " .
  1510. " tcfv.field_id = tcf.id WHERE tcf.field_variable = 'special_course' AND tcfv.field_value = 1 ";
  1511. $special_course_result = Database::query($sql);
  1512. if(Database::num_rows($special_course_result)>0) {
  1513. $special_course_list = array();
  1514. while ($result_row = Database::fetch_array($special_course_result)) {
  1515. $special_course_list[] = '"'.$result_row['course_code'].'"';
  1516. }
  1517. }
  1518. $with_special_courses = $without_special_courses = '';
  1519. if (!empty($special_course_list)) {
  1520. $with_special_courses = ' course.code IN ('.implode(',',$special_course_list).')';
  1521. $without_special_courses = ' AND course.code NOT IN ('.implode(',',$special_course_list).')';
  1522. }
  1523. if (!empty($with_special_courses)) {
  1524. $sql = "SELECT course.code, course.db_name db_name, course.title
  1525. FROM ".$tbl_course_user." course_rel_user
  1526. LEFT JOIN ".$tbl_course." course
  1527. ON course.code = course_rel_user.course_code
  1528. LEFT JOIN ".$tbl_user_course_category." user_course_category
  1529. ON course_rel_user.user_course_cat = user_course_category.id
  1530. WHERE $with_special_courses
  1531. GROUP BY course.code
  1532. ORDER BY user_course_category.sort,course.title,course_rel_user.sort ASC";
  1533. $rs_special_course = api_sql_query($sql);
  1534. if (Database::num_rows($rs_special_course) > 0) {
  1535. while ($result_row = Database::fetch_array($rs_special_course)) {
  1536. $result_row['special_course'] = 1;
  1537. $course_list[] = $result_row;
  1538. $codes[] = $result_row['code'];
  1539. }
  1540. }
  1541. }
  1542. // get course list not auto-register
  1543. $sql = "SELECT course.code,course.db_name,course.title
  1544. FROM $tbl_course course
  1545. INNER JOIN $tbl_course_user cru
  1546. ON course.code=cru.course_code
  1547. WHERE cru.user_id='$user_id' $without_special_courses";
  1548. $result = Database::query($sql);
  1549. if (Database::num_rows($result)) {
  1550. while ($row = Database::fetch_array($result, 'ASSOC')) {
  1551. $course_list[] = $row;
  1552. $codes[] = $row['code'];
  1553. }
  1554. }
  1555. if ($include_sessions === true) {
  1556. $r = Database::query("SELECT distinct(c.code),c.db_name,c.title
  1557. FROM ".Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER)." s, ".Database::get_main_table(TABLE_MAIN_COURSE)." c
  1558. WHERE id_user = $user_id AND s.course_code=c.code");
  1559. while ($row = Database::fetch_array($r, 'ASSOC')) {
  1560. if (!in_array($row['code'], $codes)) {
  1561. $course_list[] = $row;
  1562. }
  1563. }
  1564. }
  1565. return $course_list;
  1566. }
  1567. /**
  1568. * Get course ID from a given course directory name
  1569. * @param string Course directory (without any slash)
  1570. * @return string Course code, or false if not found
  1571. */
  1572. public static function get_course_id_from_path ($path) {
  1573. $path = Database::escape_string(str_replace('.', '', str_replace('/', '', $path)));
  1574. $res = Database::query("SELECT code FROM ".Database::get_main_table(TABLE_MAIN_COURSE)."
  1575. WHERE directory LIKE BINARY '$path'");
  1576. if ($res === false) {
  1577. return false;
  1578. }
  1579. if (Database::num_rows($res) != 1) {
  1580. return false;
  1581. }
  1582. $row = Database::fetch_array($res);
  1583. return $row['code'];
  1584. }
  1585. /**
  1586. * Get course code(s) from visual code
  1587. * @param string Visual code
  1588. * @return array List of codes for the given visual code
  1589. */
  1590. public static function get_courses_info_from_visual_code($code) {
  1591. $result = array();
  1592. $sql_result = Database::query("SELECT * FROM ".Database::get_main_table(TABLE_MAIN_COURSE)."
  1593. WHERE visual_code = '".Database::escape_string($code)."'");
  1594. while ($virtual_course = Database::fetch_array($sql_result)) {
  1595. $result[] = $virtual_course;
  1596. }
  1597. return $result;
  1598. }
  1599. /**
  1600. * Get emails of tutors to course
  1601. * @param string Visual code
  1602. * @return array List of emails of tutors to course
  1603. * @author @author Carlos Vargas <carlos.vargas@dokeos.com>, Dokeos Latino
  1604. * */
  1605. public static function get_emails_of_tutors_to_course($code) {
  1606. $list = array();
  1607. $res = Database::query("SELECT user_id FROM ".Database::get_main_table(TABLE_MAIN_COURSE_USER)."
  1608. WHERE course_code='".Database::escape_string($code)."' AND status=1");
  1609. while ($list_users = Database::fetch_array($res)) {
  1610. $result = Database::query("SELECT * FROM ".Database::get_main_table(TABLE_MAIN_USER)."
  1611. WHERE user_id=".$list_users['user_id']);
  1612. while ($row_user = Database::fetch_array($result)){
  1613. $name_teacher = api_get_person_name($row_user['firstname'], $row_user['lastname'], null, PERSON_NAME_EMAIL_ADDRESS);
  1614. $list[] = array($row_user['email'] => $name_teacher);
  1615. }
  1616. }
  1617. return $list;
  1618. }
  1619. /**
  1620. * Get coachs' emails by session
  1621. * @param int session id
  1622. * @param string course code
  1623. * @return array array(email => name_tutor) by coach
  1624. * @author Carlos Vargas <carlos.vargas@dokeos.com>
  1625. */
  1626. public static function get_email_of_tutor_to_session($session_id,$course_code) {
  1627. $tbl_session_course_user = Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER);
  1628. $tbl_user = Database::get_main_table(TABLE_MAIN_USER);
  1629. $coachs_emails = array();
  1630. $course_code = Database::escape_string($course_code);
  1631. $session_id = intval($session_id);
  1632. $sql = "SELECT id_user FROM $tbl_session_course_user WHERE id_session='$session_id' AND course_code='$course_code' AND status =2";
  1633. $rs = Database::query($sql);
  1634. if (Database::num_rows($rs) > 0) {
  1635. $user_ids = array();
  1636. while ($row = Database::fetch_array($rs)) {
  1637. $user_ids[] = $row['id_user'];
  1638. }
  1639. $sql = "SELECT firstname,lastname,email FROM $tbl_user WHERE user_id IN (".implode(",",$user_ids).")";
  1640. $rs_user = Database::query($sql);
  1641. while ($row_emails = Database::fetch_array($rs_user)) {
  1642. $name_tutor = api_get_person_name($row_emails['firstname'], $row_emails['lastname'], null, PERSON_NAME_EMAIL_ADDRESS);
  1643. $mail_tutor = array($row_emails['email'] => $name_tutor);
  1644. $coachs_emails[] = $mail_tutor;
  1645. }
  1646. }
  1647. return $coachs_emails;
  1648. }
  1649. /**
  1650. * Creates a new extra field for a given course
  1651. * @param string Field's internal variable name
  1652. * @param int Field's type
  1653. * @param string Field's language var name
  1654. * @return int new extra field id
  1655. */
  1656. public static function create_course_extra_field($fieldvarname, $fieldtype, $fieldtitle) {
  1657. // database table definition
  1658. $t_cfv = Database::get_main_table(TABLE_MAIN_COURSE_FIELD_VALUES);
  1659. $t_cf = Database::get_main_table(TABLE_MAIN_COURSE_FIELD);
  1660. $fieldvarname = Database::escape_string($fieldvarname);
  1661. $fieldtitle = Database::escape_string($fieldtitle);
  1662. $fieldtype = (int)$fieldtype;
  1663. $time = time();
  1664. $sql_field = "SELECT id FROM $t_cf WHERE field_variable = '$fieldvarname'";
  1665. $res_field = Database::query($sql_field);
  1666. $r_field = Database::fetch_row($res_field);
  1667. if (Database::num_rows($res_field) > 0) {
  1668. return $r_field[0];
  1669. }
  1670. // save new fieldlabel into course_field table
  1671. $sql = "SELECT MAX(field_order) FROM $t_cf";
  1672. $res = Database::query($sql);
  1673. $order = 0;
  1674. if (Database::num_rows($res) > 0) {
  1675. $row = Database::fetch_row($res);
  1676. $order = $row[0] + 1;
  1677. }
  1678. $sql = "INSERT INTO $t_cf
  1679. SET field_type = '$fieldtype',
  1680. field_variable = '$fieldvarname',
  1681. field_display_text = '$fieldtitle',
  1682. field_order = '$order',
  1683. tms = FROM_UNIXTIME($time)";
  1684. Database::query($sql);
  1685. return Database::insert_id();
  1686. }
  1687. /**
  1688. * Update an extra field value for a given course
  1689. * @param integer Course ID
  1690. * @param string Field variable name
  1691. * @param string Field value
  1692. * @return boolean true if field updated, false otherwise
  1693. */
  1694. public static function update_course_extra_field_value($course_code, $fname, $fvalue = '') {
  1695. $t_cfv = Database::get_main_table(TABLE_MAIN_COURSE_FIELD_VALUES);
  1696. $t_cf = Database::get_main_table(TABLE_MAIN_COURSE_FIELD);
  1697. $fname = Database::escape_string($fname);
  1698. $course_code = Database::escape_string($course_code);
  1699. $fvalues = '';
  1700. if (is_array($fvalue)) {
  1701. foreach ($fvalue as $val) {
  1702. $fvalues .= Database::escape_string($val).';';
  1703. }
  1704. if (!empty($fvalues)) {
  1705. $fvalues = substr($fvalues, 0, -1);
  1706. }
  1707. } else {
  1708. $fvalues = Database::escape_string($fvalue);
  1709. }
  1710. $sqlcf = "SELECT * FROM $t_cf WHERE field_variable='$fname'";
  1711. $rescf = Database::query($sqlcf);
  1712. if (Database::num_rows($rescf) == 1) {
  1713. // Ok, the field exists
  1714. // Check if enumerated field, if the option is available
  1715. $rowcf = Database::fetch_array($rescf);
  1716. $tms = time();
  1717. $sqlcfv = "SELECT * FROM $t_cfv WHERE course_code = '$course_code' AND field_id = '".$rowcf['id']."' ORDER BY id";
  1718. $rescfv = Database::query($sqlcfv);
  1719. $n = Database::num_rows($rescfv);
  1720. if ($n > 1) {
  1721. //problem, we already have to values for this field and user combination - keep last one
  1722. while ($rowcfv = Database::fetch_array($rescfv)) { // See the TODO note below.
  1723. if ($n > 1) {
  1724. $sqld = "DELETE FROM $t_cfv WHERE id = ".$rowcfv['id'];
  1725. $resd = Database::query($sqld);
  1726. $n--;
  1727. }
  1728. $rowcfv = Database::fetch_array($rescfv);
  1729. if ($rowcfv['field_value'] != $fvalues) {
  1730. $sqlu = "UPDATE $t_cfv SET field_value = '$fvalues', tms = FROM_UNIXTIME($tms) WHERE id = ".$rowcfv['id'];
  1731. $resu = Database::query($sqlu);
  1732. return ($resu ? true : false);
  1733. }
  1734. 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...
  1735. }
  1736. } elseif ($n == 1) {
  1737. //we need to update the current record
  1738. $rowcfv = Database::fetch_array($rescfv);
  1739. if ($rowcfv['field_value'] != $fvalues) {
  1740. $sqlu = "UPDATE $t_cfv SET field_value = '$fvalues', tms = FROM_UNIXTIME($tms) WHERE id = ".$rowcfv['id'];
  1741. //error_log('UM::update_extra_field_value: '.$sqlu);
  1742. $resu = Database::query($sqlu);
  1743. return ($resu ? true : false);
  1744. }
  1745. return true;
  1746. } else {
  1747. $sqli = "INSERT INTO $t_cfv (course_code,field_id,field_value,tms) " .
  1748. "VALUES ('$course_code',".$rowcf['id'].",'$fvalues',FROM_UNIXTIME($tms))";
  1749. //error_log('UM::update_extra_field_value: '.$sqli);
  1750. $resi = Database::query($sqli);
  1751. return ($resi ? true : false);
  1752. }
  1753. } else {
  1754. return false; //field not found
  1755. }
  1756. }
  1757. /**
  1758. * Get the course id of an course by the database name
  1759. * @param string The database name
  1760. * @return string The course id
  1761. */
  1762. public static function get_course_id_by_database_name($db_name) {
  1763. return Database::result(Database::query('SELECT code FROM '.Database::get_main_table(TABLE_MAIN_COURSE).
  1764. ' WHERE db_name="'.Database::escape_string($db_name).'"'), 0, 'code');
  1765. }
  1766. public static function get_session_category_id_by_session_id($session_id) {
  1767. return Database::result(Database::query('SELECT sc.id session_category
  1768. FROM '.Database::get_main_table(TABLE_MAIN_SESSION_CATEGORY).' sc
  1769. INNER JOIN '.Database::get_main_table(TABLE_MAIN_SESSION).' s
  1770. ON sc.id=s.session_category_id WHERE s.id="'.Database::escape_string($session_id).'"'),
  1771. 0, 'session_category');
  1772. }
  1773. /**
  1774. * Get the course id of an course by the database name
  1775. * @param string The database name
  1776. * @return string The course id
  1777. */
  1778. public static function get_course_extra_field_list($code) {
  1779. $tbl_course_field = Database::get_main_table(TABLE_MAIN_COURSE_FIELD);
  1780. $tbl_course_field_value = Database::get_main_table(TABLE_MAIN_COURSE_FIELD_VALUES);
  1781. $sql_field = "SELECT id, field_type, field_variable, field_display_text, field_default_value
  1782. FROM $tbl_course_field WHERE field_visible = '1' ";
  1783. $res_field = api_sql_query($sql_field);
  1784. $extra_fields = array();
  1785. while($rowcf = Database::fetch_array($res_field)) {
  1786. $extra_field_id = $rowcf['id'];
  1787. $sql_field_value = "SELECT field_value FROM $tbl_course_field_value WHERE course_code = '$code' AND field_id = '$extra_field_id' ";
  1788. $res_field_value = api_sql_query($sql_field_value);
  1789. if(Database::num_rows($res_field_value) > 0 ) {
  1790. $r_field_value = Database::fetch_row($res_field_value);
  1791. $rowcf['extra_field_value'] = $r_field_value[0];
  1792. }
  1793. $extra_fields[] = $rowcf;
  1794. }
  1795. return $extra_fields;
  1796. }
  1797. /**
  1798. * Get the database name of a course by the code
  1799. * @param string The course code
  1800. * @return string The database name
  1801. */
  1802. public static function get_name_database_course($course_code) {
  1803. return Database::result(Database::query('SELECT db_name FROM '.Database::get_main_table(TABLE_MAIN_COURSE).
  1804. ' WHERE code="'.Database::escape_string($course_code).'"'), 0, 'db_name');
  1805. }
  1806. /**
  1807. * Lists details of the course description
  1808. * @param array The course description
  1809. * @param string The encoding
  1810. * @param bool If true is displayed if false is hidden
  1811. * @return string The course description in html
  1812. */
  1813. public static function get_details_course_description_html($descriptions, $charset, $action_show = true) {
  1814. if (isset($descriptions) && count($descriptions) > 0) {
  1815. $data = '';
  1816. foreach ($descriptions as $id => $description) {
  1817. $data .= '<div class="sectiontitle">';
  1818. if (api_is_allowed_to_edit() && $action_show == true) {
  1819. //delete
  1820. $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;">';
  1821. $data .= Display::return_icon('delete.gif', get_lang('Delete'), array('style' => 'vertical-align:middle;float:right;'));
  1822. $data .= '</a> ';
  1823. //edit
  1824. $data .= '<a href="'.api_get_self().'?'.api_get_cidreq().'&amp;description_id='.$description->id.'">';
  1825. $data .= Display::return_icon('edit.gif', get_lang('Edit'), array('style' => 'vertical-align:middle;float:right; padding-right:4px;'));
  1826. $data .= '</a> ';
  1827. }
  1828. $data .= $description->title;
  1829. $data .= '</div>';
  1830. $data .= '<div class="sectioncomment">';
  1831. $data .= text_filter($description->content);
  1832. $data .= '</div>';
  1833. }
  1834. } else {
  1835. $data .= '<em>'.get_lang('ThisCourseDescriptionIsEmpty').'</em>';
  1836. }
  1837. return $data;
  1838. }
  1839. /*
  1840. ==============================================================================
  1841. DEPRECATED METHODS
  1842. ==============================================================================
  1843. */
  1844. /**
  1845. * This code creates a select form element to let the user
  1846. * choose a real course to link to.
  1847. *
  1848. * A good non-display library should not use echo statements, but just return text/html
  1849. * so users of the library can choose when to display.
  1850. *
  1851. * We display the course code, but internally store the course id.
  1852. *
  1853. * @param boolean $has_size, true the select tag gets a size element, false it stays a dropdownmenu
  1854. * @param boolean $only_current_user_courses, true only the real courses of which the
  1855. * current user is course admin are displayed, false all real courses are shown.
  1856. * @param string $element_name the name of the select element
  1857. * @return a string containing html code for a form select element.
  1858. * @deprecated Function not in use
  1859. */
  1860. public static function get_real_course_code_select_html($element_name, $has_size = true, $only_current_user_courses = true, $user_id) {
  1861. if ($only_current_user_courses) {
  1862. $real_course_list = self::get_real_course_list_of_user_as_course_admin($user_id);
  1863. } else {
  1864. $real_course_list = self::get_real_course_list();
  1865. }
  1866. if ($has_size) {
  1867. $size_element = "size=\"".SELECT_BOX_SIZE."\"";
  1868. } else {
  1869. $size_element = "";
  1870. }
  1871. $html_code = "<select name=\"$element_name\" $size_element >\n";
  1872. foreach ($real_course_list as $real_course) {
  1873. $course_code = $real_course["code"];
  1874. $html_code .= "<option value=\"".$course_code."\">";
  1875. $html_code .= $course_code;
  1876. $html_code .= "</option>\n";
  1877. }
  1878. $html_code .= "</select>\n";
  1879. return $html_code;
  1880. }
  1881. /**
  1882. * Get count rows of a table inside a course database
  1883. * @param string The table of which the rows should be counted
  1884. * @param int optionally count rows by session id
  1885. * @return int The number of rows in the given table.
  1886. */
  1887. public static function count_rows_course_table($table, $session_id = '') {
  1888. $condition_session = '';
  1889. if ($session_id !== '') {
  1890. $session_id = intval($session_id);
  1891. $condition_session = " WHERE session_id = '$session_id' ";
  1892. }
  1893. $sql = "SELECT COUNT(*) AS n FROM $table $condition_session ";
  1894. $rs = Database::query($sql);
  1895. $row = Database::fetch_row($rs);
  1896. return $row[0];
  1897. }
  1898. /**
  1899. * Subscribes courses to human resource manager (Dashboard feature)
  1900. * @param int Human Resource Manager id
  1901. * @param array Courses code
  1902. * @param int Relation type
  1903. **/
  1904. public static function suscribe_courses_to_hr_manager($hr_manager_id,$courses_list) {
  1905. // Database Table Definitions
  1906. $tbl_course = Database::get_main_table(TABLE_MAIN_COURSE);
  1907. $tbl_course_rel_user = Database::get_main_table(TABLE_MAIN_COURSE_USER);
  1908. $hr_manager_id = intval($hr_manager_id);
  1909. $affected_rows = 0;
  1910. //Deleting assigned courses to hrm_id
  1911. $sql = "SELECT course_code FROM $tbl_course_rel_user WHERE user_id = $hr_manager_id AND relation_type=".COURSE_RELATION_TYPE_RRHH." ";
  1912. $result = Database::query($sql);
  1913. if (Database::num_rows($result) > 0) {
  1914. $sql = "DELETE FROM $tbl_course_rel_user WHERE user_id = $hr_manager_id AND relation_type=".COURSE_RELATION_TYPE_RRHH." ";
  1915. Database::query($sql);
  1916. }
  1917. // inserting new courses list
  1918. if (is_array($courses_list)) {
  1919. foreach ($courses_list as $course_code) {
  1920. $course_code = Database::escape_string($course_code);
  1921. $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."')";
  1922. Database::query($insert_sql);
  1923. if (Database::affected_rows()) {
  1924. $affected_rows++;
  1925. }
  1926. }
  1927. }
  1928. return $affected_rows;
  1929. }
  1930. /**
  1931. * get courses followed by human resources manager
  1932. * @param int human resources manager id
  1933. * @return array courses
  1934. */
  1935. public static function get_courses_followed_by_drh($hr_dept_id) {
  1936. // Database Table Definitions
  1937. $tbl_course = Database::get_main_table(TABLE_MAIN_COURSE);
  1938. $tbl_course_rel_user = Database::get_main_table(TABLE_MAIN_COURSE_USER);
  1939. $hr_dept_id = intval($hr_dept_id);
  1940. $assigned_courses_to_hrm = array();
  1941. $sql = "SELECT * FROM $tbl_course c
  1942. 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."' ";
  1943. $rs_assigned_courses = Database::query($sql);
  1944. if (Database::num_rows($rs_assigned_courses) > 0) {
  1945. while ($row_assigned_courses = Database::fetch_array($rs_assigned_courses)) {
  1946. $assigned_courses_to_hrm[$row_assigned_courses['code']] = $row_assigned_courses;
  1947. }
  1948. }
  1949. return $assigned_courses_to_hrm;
  1950. }
  1951. /**
  1952. * check if a course is special (autoregister)
  1953. * @param string course code
  1954. */
  1955. public static function is_special_course($course_code){
  1956. $tbl_course_field_value = Database::get_main_table(TABLE_MAIN_COURSE_FIELD_VALUES);
  1957. $tbl_course_field = Database::get_main_table(TABLE_MAIN_COURSE_FIELD);
  1958. $is_special = false;
  1959. $sql = "SELECT course_code FROM $tbl_course_field_value tcfv INNER JOIN $tbl_course_field tcf ON " .
  1960. " tcfv.field_id = tcf.id WHERE tcf.field_variable = 'special_course' AND tcfv.field_value = 1 AND course_code='$course_code'";
  1961. $result = Database::query($sql);
  1962. $num_rows = Database::num_rows($result);
  1963. if ($num_rows > 0){
  1964. $is_special = true;
  1965. }
  1966. return $is_special;
  1967. }
  1968. } //end class CourseManager