course.lib.php 158 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370
  1. <?php
  2. /* For licensing terms, see /license.txt*/
  3. /**
  4. * This is the course library for Chamilo.
  5. *
  6. * All main course functions should be placed here.
  7. *
  8. * Many functions of this library deal with providing support for
  9. * virtual/linked/combined courses (this was already used in several universities
  10. * but not available in standard Chamilo).
  11. *
  12. * The implementation changed, initially a course was a real course
  13. * if target_course_code was 0 , this was changed to NULL.
  14. * There are probably some places left with the wrong code.
  15. *
  16. * @package chamilo.library
  17. */
  18. /**
  19. DOCUMENTATION
  20. (list not up to date, you can auto generate documentation with phpDocumentor)
  21. CourseManager::get_real_course_code_select_html($element_name, $has_size=true, $only_current_user_courses=true)
  22. CourseManager::check_parameter($parameter, $error_message)
  23. CourseManager::check_parameter_or_fail($parameter, $error_message)
  24. CourseManager::course_code_exists($wanted_course_code)
  25. CourseManager::get_real_course_list()
  26. CourseManager::get_virtual_course_list()
  27. GENERAL COURSE FUNCTIONS
  28. CourseManager::get_access_settings($course_code)
  29. CourseManager::set_course_tool_visibility($tool_table_id, $visibility)
  30. CourseManager::get_user_in_course_status($user_id, $course_code)
  31. CourseManager::add_user_to_course($user_id, $course_code)
  32. CourseManager::get_virtual_course_info($real_course_code)
  33. CourseManager::is_virtual_course_from_visual_code($visual_code)
  34. CourseManager::is_virtual_course_from_system_code($system_code)
  35. CourseManager::get_virtual_courses_linked_to_real_course($real_course_code)
  36. CourseManager::get_list_of_virtual_courses_for_specific_user_and_real_course($user_id, $real_course_code)
  37. CourseManager::has_virtual_courses_from_code($real_course_code, $user_id)
  38. CourseManager::get_target_of_linked_course($virtual_course_code)
  39. TITLE AND CODE FUNCTIONS
  40. CourseManager::determine_course_title_from_course_info($user_id, $course_info)
  41. CourseManager::create_combined_name($user_is_registered_in_real_course, $real_course_name, $virtual_course_list)
  42. CourseManager::create_combined_code($user_is_registered_in_real_course, $real_course_code, $virtual_course_list)
  43. USER FUNCTIONS
  44. CourseManager::get_real_course_list_of_user_as_course_admin($user_id)
  45. CourseManager::get_course_list_of_user_as_course_admin($user_id)
  46. CourseManager::is_user_subscribed_in_course($user_id, $course_code)
  47. CourseManager::is_user_subscribed_in_real_or_linked_course($user_id, $course_code)
  48. CourseManager::get_user_list_from_course_code($course_code)
  49. CourseManager::get_real_and_linked_user_list($course_code);
  50. GROUP FUNCTIONS
  51. CourseManager::get_group_list_of_course($course_code)
  52. CREATION FUNCTIONS
  53. CourseManager::attempt_create_virtual_course($real_course_code, $course_title, $wanted_course_code, $course_language, $course_category)
  54. */
  55. /* INIT SECTION */
  56. /**
  57. * Configuration files
  58. */
  59. require_once api_get_path(CONFIGURATION_PATH).'add_course.conf.php';
  60. require_once api_get_path(LIBRARY_PATH).'add_course.lib.inc.php';
  61. /**
  62. * Constants definition
  63. */
  64. //LOGIC: course visibility and registration settings
  65. /*
  66. COURSE VISIBILITY
  67. MAPPING OLD SETTINGS TO NEW SETTINGS
  68. -----------------------
  69. NOT_VISIBLE_NO_SUBSCRIPTION_ALLOWED
  70. --> COURSE_VISIBILITY_REGISTERED, SUBSCRIBE_NOT_ALLOWED
  71. NOT_VISIBLE_SUBSCRIPTION_ALLOWED
  72. --> COURSE_VISIBILITY_REGISTERED, SUBSCRIBE_ALLOWED
  73. VISIBLE_SUBSCRIPTION_ALLOWED
  74. --> COURSE_VISIBILITY_OPEN_PLATFORM, SUBSCRIBE_ALLOWED
  75. VISIBLE_NO_SUBSCRIPTION_ALLOWED
  76. --> COURSE_VISIBILITY_OPEN_PLATFORM, SUBSCRIBE_NOT_ALLOWED
  77. */
  78. //OLD SETTINGS
  79. define('NOT_VISIBLE_NO_SUBSCRIPTION_ALLOWED', 0);
  80. define('NOT_VISIBLE_SUBSCRIPTION_ALLOWED', 1);
  81. define('VISIBLE_SUBSCRIPTION_ALLOWED', 2);
  82. define('VISIBLE_NO_SUBSCRIPTION_ALLOWED', 3);
  83. /**
  84. * Variables
  85. */
  86. $TABLECOURSE = Database::get_main_table(TABLE_MAIN_COURSE);
  87. $TABLECOURSDOMAIN = Database::get_main_table(TABLE_MAIN_CATEGORY);
  88. $TABLEUSER = Database::get_main_table(TABLE_MAIN_USER);
  89. $TABLECOURSUSER = Database::get_main_table(TABLE_MAIN_COURSE_USER);
  90. $TABLEANNOUNCEMENTS = 'announcement';
  91. $coursesRepositories = $_configuration['root_sys'];
  92. /**
  93. * CourseManager Class
  94. * @package chamilo.library
  95. */
  96. class CourseManager {
  97. /**
  98. * Returns all the information of a given coursecode
  99. * @param string $course_code, the course code
  100. * @return an array with all the fields of the course table
  101. * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
  102. */
  103. public static function get_course_information($course_code) {
  104. return Database::fetch_array(Database::query(
  105. "SELECT * FROM ".Database::get_main_table(TABLE_MAIN_COURSE)."
  106. WHERE code='".Database::escape_string($course_code)."'"),'ASSOC'
  107. );
  108. }
  109. /**
  110. * Returns all the information of a given coursecode
  111. * @param int the course id
  112. * @return an array with all the fields of the course table
  113. */
  114. public static function get_course_information_by_id($course_id) {
  115. return Database::select('*', Database::get_main_table(TABLE_MAIN_COURSE), array('where'=>array('id = ?' =>intval($course_id))),'first');
  116. }
  117. /**
  118. * Returns a list of courses. Should work with quickform syntax
  119. * @param integer Offset (from the 7th = '6'). Optional.
  120. * @param integer Number of results we want. Optional.
  121. * @param string The column we want to order it by. Optional, defaults to first column.
  122. * @param string The direction of the order (ASC or DESC). Optional, defaults to ASC.
  123. * @param string The visibility of the course, or all by default.
  124. * @param string If defined, only return results for which the course *title* begins with this string
  125. */
  126. public static function get_courses_list($from = 0, $howmany = 0, $orderby = 1, $orderdirection = 'ASC', $visibility = -1, $startwith = '') {
  127. $sql = "SELECT * FROM ".Database::get_main_table(TABLE_MAIN_COURSE)." ";
  128. if (!empty($startwith)) {
  129. $sql .= "WHERE title LIKE '".Database::escape_string($startwith)."%' ";
  130. if ($visibility !== -1 && $visibility == strval(intval($visibility))) {
  131. $sql .= " AND visibility = $visibility ";
  132. }
  133. } else {
  134. $sql .= "WHERE 1 ";
  135. if ($visibility !== -1 && $visibility == strval(intval($visibility))) {
  136. $sql .= " AND visibility = $visibility ";
  137. }
  138. }
  139. if (!empty($orderby)) {
  140. $sql .= " ORDER BY ".Database::escape_string($orderby)." ";
  141. } else {
  142. $sql .= " ORDER BY 1 ";
  143. }
  144. if (!in_array($orderdirection, array('ASC', 'DESC'))) {
  145. $sql .= 'ASC';
  146. } else {
  147. $sql .= Database::escape_string($orderdirection);
  148. }
  149. if (!empty($howmany) && is_int($howmany) and $howmany > 0) {
  150. $sql .= ' LIMIT '.Database::escape_string($howmany);
  151. } else {
  152. $sql .= ' LIMIT 1000000'; //virtually no limit
  153. }
  154. if (!empty($from)) {
  155. $from = intval($from);
  156. $sql .= ' OFFSET '.Database::escape_string($from);
  157. } else {
  158. $sql .= ' OFFSET 0';
  159. }
  160. return Database::store_result(Database::query($sql));
  161. }
  162. /**
  163. * Returns the access settings of the course:
  164. * which visibility;
  165. * wether subscribing is allowed;
  166. * wether unsubscribing is allowed.
  167. *
  168. * @param string $course_code, the course code
  169. * @todo for more consistency: use course_info call from database API
  170. * @return an array with int fields "visibility", "subscribe", "unsubscribe"
  171. */
  172. public static function get_access_settings($course_code) {
  173. return Database::fetch_array(Database::query(
  174. "SELECT visibility, subscribe, unsubscribe from ".Database::get_main_table(TABLE_MAIN_COURSE)."
  175. WHERE code = '".Database::escape_string($course_code)."'")
  176. );
  177. }
  178. /**
  179. * Returns the status of a user in a course, which is COURSEMANAGER or STUDENT.
  180. * @param int User ID
  181. * @param string Course code
  182. * @return int the status of the user in that course
  183. */
  184. public static function get_user_in_course_status($user_id, $course_code) {
  185. $result = Database::fetch_array(Database::query(
  186. "SELECT status FROM ".Database::get_main_table(TABLE_MAIN_COURSE_USER)."
  187. WHERE course_code = '".Database::escape_string($course_code)."' AND user_id = ".Database::escape_string($user_id))
  188. );
  189. return $result['status'];
  190. }
  191. /**
  192. * Unsubscribe one or more users from a course
  193. *
  194. * @param mixed user_id or an array with user ids
  195. * @param int session id
  196. * @param string course code
  197. *
  198. */
  199. public static function unsubscribe_user($user_id, $course_code, $session_id = 0) {
  200. if (!is_array($user_id)) {
  201. $user_id = array($user_id);
  202. }
  203. if (count($user_id) == 0) {
  204. return;
  205. }
  206. $table_user = Database :: get_main_table(TABLE_MAIN_USER);
  207. if (!empty($session_id)) {
  208. $session_id = intval($session_id);
  209. } else {
  210. $session_id = intval($_SESSION['id_session']);
  211. }
  212. //Cleaning the $user_id variable
  213. if (is_array($user_id)) {
  214. $new_user_id_list = array();
  215. foreach($user_id as $my_user_id) {
  216. $new_user_id_list[]= intval($my_user_id);
  217. }
  218. $new_user_id_list = array_filter($new_user_id_list);
  219. $user_ids = implode(',', $new_user_id_list);
  220. } else {
  221. $user_ids = intval($user_id);
  222. }
  223. $course_code = Database::escape_string($course_code);
  224. $course = Database::fetch_object(Database::query("SELECT db_name FROM ".Database::get_main_table(TABLE_MAIN_COURSE)."
  225. WHERE code = '".$course_code."'"));
  226. // Unsubscribe user from all groups in the course.
  227. Database::query("DELETE FROM ".Database::get_course_table(TABLE_GROUP_USER, $course->db_name)."
  228. WHERE user_id IN (".$user_ids.")");
  229. Database::query("DELETE FROM ".Database::get_course_table(TABLE_GROUP_TUTOR, $course->db_name)."
  230. WHERE user_id IN (".$user_ids.")");
  231. // Erase user student publications (works) in the course - by André Boivin
  232. //@todo field student_publication.author should be the user id
  233. $table_course_user_publication = Database :: get_course_table(TABLE_STUDENT_PUBLICATION, $course->db_name);
  234. $sqlu = "SELECT * FROM $table_user WHERE user_id IN (".$user_ids.")";
  235. $resu = Database::query($sqlu);
  236. $username = Database::fetch_array($resu,'ASSOC');
  237. $userfirstname = $username['firstname'];
  238. $userlastname = $username['lastname'];
  239. $publication_name = $userfirstname.' '.$userlastname ;
  240. $sql = "DELETE FROM $table_course_user_publication WHERE author = '".Database::escape_string($publication_name)."'";
  241. Database::query($sql);
  242. // Unsubscribe user from all blogs in the course.
  243. Database::query("DELETE FROM ".Database::get_course_table(TABLE_BLOGS_REL_USER, $course->db_name)."
  244. WHERE user_id IN (".$user_ids.")");
  245. Database::query("DELETE FROM ".Database::get_course_table(TABLE_BLOGS_TASKS_REL_USER, $course->db_name)."
  246. WHERE user_id IN (".$user_ids.")");
  247. //Deleting users in forum_notification and mailqueue course tables
  248. $sql_delete_forum_notification = "DELETE FROM ".Database::get_course_table(TABLE_FORUM_NOTIFICATION, $course->db_name)." WHERE user_id IN (".$user_ids.")";
  249. Database::query($sql_delete_forum_notification);
  250. $sql_delete_mail_queue = "DELETE FROM ".Database::get_course_table(TABLE_FORUM_MAIL_QUEUE, $course->db_name)." WHERE user_id IN (".$user_ids.")";
  251. Database::query($sql_delete_mail_queue);
  252. // Unsubscribe user from the course.
  253. if (!empty($session_id)) {
  254. // Delete in table session_rel_course_rel_user
  255. Database::query("DELETE FROM ".Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER)."
  256. WHERE id_session ='".$session_id."' AND course_code = '".Database::escape_string($_SESSION['_course']['id'])."' AND id_user IN ($user_ids)");
  257. foreach ($user_id as $uid) {
  258. // check if a user is register in the session with other course
  259. $sql = "SELECT id_user FROM ".Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER)." WHERE id_session='$session_id' AND id_user='$uid'";
  260. $rs = Database::query($sql);
  261. if (Database::num_rows($rs) == 0) {
  262. // Delete in table session_rel_user
  263. Database::query("DELETE FROM ".Database::get_main_table(TABLE_MAIN_SESSION_USER)."
  264. WHERE id_session ='".$session_id."' AND id_user='$uid' AND relation_type<>".SESSION_RELATION_TYPE_RRHH."");
  265. }
  266. }
  267. // Update the table session
  268. $row = Database::fetch_array(Database::query("SELECT COUNT(*) FROM ".Database::get_main_table(TABLE_MAIN_SESSION_USER)."
  269. WHERE id_session = '".$session_id."' AND relation_type<>".SESSION_RELATION_TYPE_RRHH." "));
  270. $count = $row[0]; // number of users by session
  271. $result = Database::query("UPDATE ".Database::get_main_table(TABLE_MAIN_SESSION)." SET nbr_users = '$count'
  272. WHERE id = '".$session_id."'");
  273. // Update the table session_rel_course
  274. $row = Database::fetch_array(@Database::query("SELECT COUNT(*) FROM ".Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER)." WHERE id_session = '$session_id' AND course_code = '$course_code' AND status<>2" ));
  275. $count = $row[0]; // number of users by session and course
  276. $result = @Database::query("UPDATE ".Database::get_main_table(TABLE_MAIN_SESSION_COURSE)." SET nbr_users = '$count' WHERE id_session = '$session_id' AND course_code = '$course_code' ");
  277. } else {
  278. Database::query("DELETE FROM ".Database::get_main_table(TABLE_MAIN_COURSE_USER)."
  279. WHERE user_id IN (".$user_ids.") AND relation_type<>".COURSE_RELATION_TYPE_RRHH." AND course_code = '".$course_code."'");
  280. // add event to system log
  281. $user_id = api_get_user_id();
  282. event_system(LOG_UNSUBSCRIBE_USER_FROM_COURSE, LOG_COURSE_CODE, $course_code, api_get_utc_datetime(), $user_id);
  283. }
  284. }
  285. /**
  286. * Subscribe a user to a course. No checks are performed here to see if
  287. * course subscription is allowed.
  288. * @param int User ID
  289. * @param string Course code
  290. * @param int Status (STUDENT, COURSEMANAGER, COURSE_ADMIN, NORMAL_COURSE_MEMBER)
  291. * @return bool True on success, false on failure
  292. * @see add_user_to_course
  293. */
  294. public static function subscribe_user($user_id, $course_code, $status = STUDENT, $session_id = 0) {
  295. if ($user_id != strval(intval($user_id))) {
  296. return false; //detected possible SQL injection
  297. }
  298. $course_code = Database::escape_string($course_code);
  299. if (empty ($user_id) || empty ($course_code)) {
  300. return false;
  301. }
  302. if (!empty($session_id)) {
  303. $session_id = intval($session_id);
  304. } else {
  305. $session_id = intval($_SESSION['id_session']);
  306. }
  307. $status = ($status == STUDENT || $status == COURSEMANAGER) ? $status : STUDENT;
  308. $role_id = ($status == COURSEMANAGER) ? COURSE_ADMIN : NORMAL_COURSE_MEMBER;
  309. // A preliminary check whether the user has bben already registered on the platform.
  310. if (Database::num_rows(@Database::query("SELECT status FROM ".Database::get_main_table(TABLE_MAIN_USER)."
  311. WHERE user_id = '$user_id' ")) == 0) {
  312. return false; // The user has not been registered to the platform.
  313. }
  314. // Check whether the user has not been already subscribed to the course.
  315. if (empty($session_id)) {
  316. if (Database::num_rows(@Database::query("SELECT * FROM ".Database::get_main_table(TABLE_MAIN_COURSE_USER)."
  317. WHERE user_id = '$user_id' AND relation_type<>".COURSE_RELATION_TYPE_RRHH." AND course_code = '$course_code'")) > 0) {
  318. return false; // The user has been already subscribed to the course.
  319. }
  320. }
  321. if (!empty($session_id)) {
  322. // Check whether the user has not already been stored in the session_rel_course_user table
  323. if (Database::num_rows(@Database::query("SELECT * FROM ".Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER)."
  324. WHERE course_code = '".$_SESSION['_course']['id']."'
  325. AND id_session ='".$session_id."'
  326. AND id_user = '".$user_id."'")) > 0) {
  327. return false;
  328. }
  329. // check if the user is registered in the session with other course
  330. $sql = "SELECT id_user FROM ".Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER)." WHERE id_session='".$session_id."' AND id_user='$user_id'";
  331. $rs = Database::query($sql);
  332. if (Database::num_rows($rs) == 0) {
  333. // Check whether the user has not already been stored in the session_rel_user table
  334. if (Database::num_rows(@Database::query("SELECT * FROM ".Database::get_main_table(TABLE_MAIN_SESSION_USER)."
  335. WHERE id_session ='".$session_id."'
  336. AND id_user = '".$user_id."' AND relation_type<>".SESSION_RELATION_TYPE_RRHH." ")) > 0) {
  337. return false;
  338. }
  339. }
  340. // Add him/her in the table session_rel_course_rel_user
  341. @Database::query("INSERT INTO ".Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER)."
  342. SET id_session ='".$session_id."',
  343. course_code = '".$_SESSION['_course']['id']."',
  344. id_user = '".$user_id."'");
  345. // Add him/her in the table session_rel_user
  346. @Database::query("INSERT INTO ".Database::get_main_table(TABLE_MAIN_SESSION_USER)."
  347. SET id_session ='".$session_id."',
  348. id_user = '".$user_id."'");
  349. // Update the table session
  350. $row = Database::fetch_array(@Database::query("SELECT COUNT(*) FROM ".Database::get_main_table(TABLE_MAIN_SESSION_USER)." WHERE id_session = '".$session_id."' AND relation_type<>".SESSION_RELATION_TYPE_RRHH.""));
  351. $count = $row[0]; // number of users by session
  352. $result = @Database::query("UPDATE ".Database::get_main_table(TABLE_MAIN_SESSION)." SET nbr_users = '$count' WHERE id = '".$session_id."'");
  353. // Update the table session_rel_course
  354. $row = Database::fetch_array(@Database::query("SELECT COUNT(*) FROM ".Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER)." WHERE id_session = '".$session_id."' AND course_code = '$course_code' AND status<>2" ));
  355. $count = $row[0]; // number of users by session
  356. $result = @Database::query("UPDATE ".Database::get_main_table(TABLE_MAIN_SESSION_COURSE)." SET nbr_users = '$count' WHERE id_session = '".$session_id."' AND course_code = '$course_code' ");
  357. } else {
  358. $course_sort = self::userCourseSort($user_id, $course_code);
  359. $result = @Database::query("INSERT INTO ".Database::get_main_table(TABLE_MAIN_COURSE_USER)."
  360. SET course_code = '$course_code',
  361. user_id = '$user_id',
  362. status = '".$status."',
  363. sort = '". ($course_sort)."'");
  364. // Add event to the system log
  365. $user_id = api_get_user_id();
  366. event_system(LOG_SUBSCRIBE_USER_TO_COURSE, LOG_COURSE_CODE, $course_code, api_get_utc_datetime(), $user_id);
  367. }
  368. return (bool)$result;
  369. }
  370. /**
  371. * Get the course id based on the original id and field name in the extra fields. Returns 0 if course was not found
  372. *
  373. * @param string Original course id
  374. * @param string Original field name
  375. * @return int Course id
  376. */
  377. public static function get_course_code_from_original_id($original_course_id_value, $original_course_id_name) {
  378. $t_cfv = Database::get_main_table(TABLE_MAIN_COURSE_FIELD_VALUES);
  379. $table_field = Database::get_main_table(TABLE_MAIN_COURSE_FIELD);
  380. $sql_course = "SELECT course_code FROM $table_field cf INNER JOIN $t_cfv cfv ON cfv.field_id=cf.id WHERE field_variable='$original_course_id_name' AND field_value='$original_course_id_value'";
  381. $res = Database::query($sql_course);
  382. $row = Database::fetch_object($res);
  383. if ($row) {
  384. return $row->course_code;
  385. } else {
  386. return 0;
  387. }
  388. }
  389. /**
  390. * Gets the course code from the course id. Returns null if course id was not found
  391. *
  392. * @param int Course id
  393. * @return string Course code
  394. */
  395. public static function get_course_code_from_course_id($id) {
  396. $table = Database::get_main_table(TABLE_MAIN_COURSE);
  397. $id = intval($id);
  398. $sql = "SELECT code FROM $table WHERE id = '$id' ";
  399. $res = Database::query($sql);
  400. $row = Database::fetch_object($res);
  401. if ($row) {
  402. return $row->code;
  403. } else {
  404. return null;
  405. }
  406. }
  407. /**
  408. * Subscribe a user $user_id to a course $course_code.
  409. * @author Hugues Peeters
  410. * @author Roan Embrechts
  411. *
  412. * @param int $user_id the id of the user
  413. * @param string $course_code the course code
  414. * @param string $status (optional) The user's status in the course
  415. *
  416. * @return boolean true if subscription succeeds, boolean false otherwise.
  417. */
  418. public static function add_user_to_course($user_id, $course_code, $status = STUDENT) {
  419. $user_table = Database::get_main_table(TABLE_MAIN_USER);
  420. $course_table = Database::get_main_table(TABLE_MAIN_COURSE);
  421. $course_user_table = Database::get_main_table(TABLE_MAIN_COURSE_USER);
  422. $status = ($status == STUDENT || $status == COURSEMANAGER) ? $status : STUDENT;
  423. if (empty($user_id) || empty($course_code) || ($user_id != strval(intval($user_id)))) {
  424. return false;
  425. }
  426. $course_code = Database::escape_string($course_code);
  427. // Check in advance whether the user has already been registered on the platform.
  428. if (Database::num_rows(Database::query("SELECT status FROM ".$user_table." WHERE user_id = '$user_id' ")) == 0) {
  429. return false; // Thehe user has not been registered to the platform.
  430. }
  431. // Check whether the user has already been subscribed to this course.
  432. 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) {
  433. return false; // The user has been subscribed to the course.
  434. }
  435. // Check in advance whether subscription is allowed or not for this course.
  436. if (Database::num_rows(Database::query("SELECT code, visibility FROM ".$course_table." WHERE code = '$course_code' AND subscribe = '".SUBSCRIBE_NOT_ALLOWED."'")) > 0) {
  437. return false; // Subscription is not allowed for this course.
  438. }
  439. // Ok, subscribe the user.
  440. $max_sort = api_max_sort_value('0', $user_id);
  441. return (bool)Database::query("INSERT INTO ".$course_user_table."
  442. SET course_code = '$course_code',
  443. user_id = '$user_id',
  444. status = '".$status."',
  445. sort = '". ($max_sort + 1)."'");
  446. }
  447. /**
  448. * Checks wether a parameter exists.
  449. * If it doesn't, the function displays an error message.
  450. *
  451. * @return true if parameter is set and not empty, false otherwise
  452. * @todo move function to better place, main_api ?
  453. */
  454. public static function check_parameter($parameter, $error_message) {
  455. if (empty($parameter)) {
  456. Display::display_normal_message($error_message);
  457. return false;
  458. }
  459. return true;
  460. }
  461. /**
  462. * Lets the script die when a parameter check fails.
  463. * @todo move function to better place, main_api ?
  464. */
  465. public static function check_parameter_or_fail($parameter, $error_message) {
  466. if (!self::check_parameter($parameter, $error_message)) {
  467. die();
  468. }
  469. }
  470. /**
  471. * @return true if there already are one or more courses
  472. * with the same code OR visual_code (visualcode), false otherwise
  473. */
  474. public static function course_code_exists($wanted_course_code) {
  475. $wanted_course_code = Database::escape_string($wanted_course_code);
  476. $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'"));
  477. return $result['number'] > 0;
  478. }
  479. /**
  480. * @return an array with the course info of all real courses on the platform
  481. */
  482. public static function get_real_course_list() {
  483. $sql_result = Database::query("SELECT * FROM ".Database::get_main_table(TABLE_MAIN_COURSE)." WHERE target_course_code IS NULL");
  484. $real_course_list = array();
  485. while ($result = Database::fetch_array($sql_result)) {
  486. $real_course_list[$result['code']] = $result;
  487. }
  488. return $real_course_list;
  489. }
  490. /**
  491. * Lists all virtual courses
  492. * @return array Course info (course code => details) of all virtual courses on the platform
  493. */
  494. public static function get_virtual_course_list() {
  495. $sql_result = Database::query("SELECT * FROM ".Database::get_main_table(TABLE_MAIN_COURSE)." WHERE target_course_code IS NOT NULL");
  496. $virtual_course_list = array();
  497. while ($result = Database::fetch_array($sql_result)) {
  498. $virtual_course_list[$result['code']] = $result;
  499. }
  500. return $virtual_course_list;
  501. }
  502. /**
  503. * Returns an array with the course info of the real courses of which
  504. * the current user is course admin
  505. * @return array A list of courses details for courses to which the user is subscribed as course admin (status = 1)
  506. */
  507. public static function get_real_course_list_of_user_as_course_admin($user_id) {
  508. $result_array = array();
  509. if ($user_id != strval(intval($user_id))) {
  510. return $result_array;
  511. }
  512. $sql_result = Database::query("SELECT *
  513. FROM ".Database::get_main_table(TABLE_MAIN_COURSE)." course
  514. LEFT JOIN ".Database::get_main_table(TABLE_MAIN_COURSE_USER)." course_user
  515. ON course.code = course_user.course_code
  516. WHERE course.target_course_code IS NULL
  517. AND course_user.user_id = '$user_id'
  518. AND course_user.status = '1'");
  519. if ($sql_result === false) { return $result_array; }
  520. while ($result = Database::fetch_array($sql_result)) {
  521. $result_array[] = $result;
  522. }
  523. return $result_array;
  524. }
  525. /**
  526. * Get course list as coach
  527. *
  528. * @param int user id
  529. * @return array course list
  530. *
  531. * */
  532. public static function get_course_list_as_coach($user_id, $include_courses_in_sessions = false) {
  533. //1. Getting courses as teacher (No session)
  534. $courses_temp = CourseManager::get_course_list_of_user_as_course_admin($user_id);
  535. $courses_as_admin = array();
  536. if (!empty($courses_temp)) {
  537. foreach($courses_temp as $course_item) {
  538. $courses_as_admin[0][$course_item['course_code']] = $course_item['course_code'];
  539. }
  540. }
  541. //2. Include courses in sessions
  542. if ($include_courses_in_sessions) {
  543. $sessions = Tracking::get_sessions_coached_by_user($user_id);
  544. if (!empty($sessions)) {
  545. foreach($sessions as $session_item) {
  546. $courses = Tracking :: get_courses_followed_by_coach($user_id, $session_item['id']);
  547. foreach($courses as $course_item) {
  548. $courses_as_admin[$session_item['id']][$course_item] = $course_item;
  549. }
  550. }
  551. }
  552. }
  553. return $courses_as_admin;
  554. }
  555. public static function get_user_list_from_courses_as_coach($user_id, $include_sessions = true) {
  556. $courses_as_admin = $students_in_courses = array();
  557. $sessions = CourseManager::get_course_list_as_coach($user_id, true);
  558. if (!empty($sessions)) {
  559. foreach($sessions as $session_id => $courses) {
  560. if (!$include_sessions) {
  561. if (!empty($session_id)) {
  562. continue;
  563. }
  564. }
  565. if (empty($session_id)) {
  566. foreach($courses as $course_code) {
  567. $students_in_course = CourseManager::get_user_list_from_course_code($course_code);
  568. foreach($students_in_course as $user_item) {
  569. //Only students
  570. if ($user_item['status_rel'] == STUDENT)
  571. $students_in_courses[$user_item['user_id']] = $user_item['user_id'];
  572. }
  573. }
  574. } else {
  575. $students_in_course = SessionManager::get_users_by_session($session_id, '0');
  576. foreach($students_in_course as $user_item) {
  577. $students_in_courses[$user_item['user_id']] = $user_item['user_id'];
  578. }
  579. }
  580. }
  581. }
  582. $students = Tracking :: get_student_followed_by_coach($coach_id);
  583. if (!empty($students_in_courses)) {
  584. if (!empty($students)) {
  585. $students = array_merge($students, $students_in_courses);
  586. } else {
  587. $students = $students_in_courses;
  588. }
  589. }
  590. if (!empty($students)) {
  591. $students = array_unique($students);
  592. }
  593. return $students;
  594. }
  595. /**
  596. * @return an array with the course info of all the courses (real and virtual) of which
  597. * the current user is course admin
  598. */
  599. public static function get_course_list_of_user_as_course_admin($user_id) {
  600. if ($user_id != strval(intval($user_id))) {
  601. return array();
  602. }
  603. // Definitions database tables and variables
  604. $tbl_course = Database::get_main_table(TABLE_MAIN_COURSE);
  605. $tbl_course_user = Database::get_main_table(TABLE_MAIN_COURSE_USER);
  606. $user_id = intval($user_id);
  607. $data = array();
  608. $sql_nb_cours = "SELECT course_rel_user.course_code, course.title, course.id, course.db_name
  609. FROM $tbl_course_user as course_rel_user
  610. INNER JOIN $tbl_course as course
  611. ON course.code = course_rel_user.course_code
  612. WHERE course_rel_user.user_id='$user_id' AND course_rel_user.status='1'
  613. ORDER BY course.title";
  614. if (api_get_multiple_access_url()) {
  615. $tbl_course_rel_access_url = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_COURSE);
  616. $access_url_id = api_get_current_access_url_id();
  617. if ($access_url_id != -1) {
  618. $sql_nb_cours = " SELECT course_rel_user.course_code, course.title, course.id, course.db_name
  619. FROM $tbl_course_user as course_rel_user
  620. INNER JOIN $tbl_course as course
  621. ON course.code = course_rel_user.course_code
  622. INNER JOIN $tbl_course_rel_access_url course_rel_url
  623. ON (course_rel_url.course_code= course.code)
  624. WHERE access_url_id = $access_url_id AND course_rel_user.user_id='$user_id' AND course_rel_user.status='1'
  625. ORDER BY course.title";
  626. }
  627. }
  628. $result_nb_cours = Database::query($sql_nb_cours);
  629. if (Database::num_rows($result_nb_cours) > 0) {
  630. while ($row = Database::fetch_array($result_nb_cours,'ASSOC')) {
  631. $data[$row['course_code']] = $row;
  632. }
  633. }
  634. return $data;
  635. }
  636. /**
  637. * Find out for which courses the user is registered and determine a visual course code and course title from that.
  638. * Takes virtual courses into account
  639. *
  640. * Default case: the name and code stay what they are.
  641. *
  642. * Scenarios:
  643. * - User is registered in real course and virtual courses; name / code become a mix of all
  644. * - User is registered in real course only: name stays that of real course
  645. * - User is registered in virtual course only: name becomes that of virtual course
  646. * - user is not registered to any of the real/virtual courses: name stays that of real course
  647. * (I'm not sure about the last case, but this seems not too bad)
  648. *
  649. * @author Roan Embrechts
  650. * @param $user_id, the id of the user
  651. * @param $course_info, an array with course info that you get using Database::get_course_info($course_system_code);
  652. * @return an array with indices
  653. * $return_result['title'] - the course title of the combined courses
  654. * $return_result['code'] - the course code of the combined courses
  655. */
  656. public static function determine_course_title_from_course_info($user_id, $course_info) {
  657. if ($user_id != strval(intval($user_id))) {
  658. return array();
  659. }
  660. $real_course_id = $course_info['system_code'];
  661. $real_course_info = Database::get_course_info($real_course_id);
  662. $real_course_name = $real_course_info['title'];
  663. $real_course_visual_code = $real_course_info['visual_code'];
  664. $real_course_real_code = Database::escape_string($course_info['system_code']);
  665. //is the user registered in the real course?
  666. $result = Database::fetch_array(Database::query("SELECT * FROM ".Database::get_main_table(TABLE_MAIN_COURSE_USER)."
  667. WHERE user_id = '$user_id' AND relation_type<>".COURSE_RELATION_TYPE_RRHH." AND course_code = '$real_course_real_code'"));
  668. $user_is_registered_in_real_course = !empty($result);
  669. //get a list of virtual courses linked to the current real course and to which the current user is subscribed
  670. $user_subscribed_virtual_course_list = self::get_list_of_virtual_courses_for_specific_user_and_real_course($user_id, $real_course_id);
  671. $virtual_courses_exist = count($user_subscribed_virtual_course_list) > 0;
  672. //now determine course code and name
  673. if ($user_is_registered_in_real_course && $virtual_courses_exist) {
  674. $course_info['name'] = self::create_combined_name($user_is_registered_in_real_course, $real_course_name, $user_subscribed_virtual_course_list);
  675. $course_info['official_code'] = self::create_combined_code($user_is_registered_in_real_course, $real_course_visual_code, $user_subscribed_virtual_course_list);
  676. }
  677. elseif ($user_is_registered_in_real_course) {
  678. //course name remains real course name
  679. $course_info['name'] = $real_course_name;
  680. $course_info['official_code'] = $real_course_visual_code;
  681. }
  682. elseif ($virtual_courses_exist) {
  683. $course_info['name'] = self::create_combined_name($user_is_registered_in_real_course, $real_course_name, $user_subscribed_virtual_course_list);
  684. $course_info['official_code'] = self::create_combined_code($user_is_registered_in_real_course, $real_course_visual_code, $user_subscribed_virtual_course_list);
  685. } else {
  686. //course name remains real course name
  687. $course_info['name'] = $real_course_name;
  688. $course_info['official_code'] = $real_course_visual_code;
  689. }
  690. $return_result['title'] = $course_info['name'];
  691. $return_result['code'] = $course_info['official_code'];
  692. return $return_result;
  693. }
  694. /**
  695. * Create a course title based on all real and virtual courses the user is registered in.
  696. * @param boolean $user_is_registered_in_real_course
  697. * @param string $real_course_name, the title of the real course
  698. * @param array $virtual_course_list, the list of virtual courses
  699. */
  700. public static function create_combined_name($user_is_registered_in_real_course, $real_course_name, $virtual_course_list) {
  701. $complete_course_name = array();
  702. if ($user_is_registered_in_real_course) {
  703. // Add the real name to the result.
  704. $complete_course_name[] = $real_course_name;
  705. }
  706. // Add course titles of all virtual courses.
  707. foreach ($virtual_course_list as $current_course) {
  708. $complete_course_name[] = $current_course['title'];
  709. }
  710. // 'CombinedCourse' is from course_home language file.
  711. return (($user_is_registered_in_real_course || count($virtual_course_list) > 1) ? get_lang('CombinedCourse').' ' : '').implode(' &amp; ', $complete_course_name);
  712. }
  713. /**
  714. * Create a course code based on all real and virtual courses the user is registered in.
  715. */
  716. public static function create_combined_code($user_is_registered_in_real_course, $real_course_code, $virtual_course_list) {
  717. $complete_course_code = array();
  718. if ($user_is_registered_in_real_course) {
  719. // Add the real code to the result
  720. $complete_course_code[] = $real_course_code;
  721. }
  722. // Add codes of all virtual courses.
  723. foreach ($virtual_course_list as $current_course) {
  724. $complete_course_code[] = $current_course['visual_code'];
  725. }
  726. return implode(' &amp; ', $complete_course_code);
  727. }
  728. /**
  729. * Return course info array of virtual course
  730. *
  731. * Note this is different from getting information about a real course!
  732. *
  733. * @param $real_course_code, the id of the real course which the virtual course is linked to
  734. */
  735. public static function get_virtual_course_info($real_course_code) {
  736. $sql_result = Database::query("SELECT * FROM ".Database::get_main_table(TABLE_MAIN_COURSE)."
  737. WHERE target_course_code = '".Database::escape_string($real_course_code)."'");
  738. $result = array();
  739. while ($virtual_course = Database::fetch_array($sql_result)) {
  740. $result[] = $virtual_course;
  741. }
  742. return $result;
  743. }
  744. /**
  745. * @param string $system_code, the system code of the course
  746. * @return true if the course is a virtual course, false otherwise
  747. */
  748. public static function is_virtual_course_from_system_code($system_code) {
  749. $result = Database::fetch_array(Database::query("SELECT target_course_code FROM ".Database::get_main_table(TABLE_MAIN_COURSE)."
  750. WHERE code = '".Database::escape_string($system_code)."'"));
  751. return !empty($result['target_course_code']);
  752. }
  753. /**
  754. * Returns whether the course code given is a visual code
  755. * @param string Visual course code
  756. * @return true if the course is a virtual course, false otherwise
  757. */
  758. public static function is_virtual_course_from_visual_code($visual_code) {
  759. $result = Database::fetch_array(Database::query("SELECT target_course_code FROM ".Database::get_main_table(TABLE_MAIN_COURSE)."
  760. WHERE visual_code = '".Database::escape_string($visual_code)."'"));
  761. return !empty($result['target_course_code']);
  762. }
  763. /**
  764. * @return true if the real course has virtual courses that the user is subscribed to, false otherwise
  765. */
  766. public static function has_virtual_courses_from_code($real_course_code, $user_id) {
  767. return count(self::get_list_of_virtual_courses_for_specific_user_and_real_course($user_id, $real_course_code)) > 0;
  768. }
  769. /**
  770. * Return an array of arrays, listing course info of all virtual course
  771. * linked to the real course ID $real_course_code
  772. *
  773. * @param string The id of the real course which the virtual courses are linked to
  774. * @return array List of courses details
  775. */
  776. public static function get_virtual_courses_linked_to_real_course($real_course_code) {
  777. $sql_result = Database::query("SELECT * FROM ".Database::get_main_table(TABLE_MAIN_COURSE)."
  778. WHERE target_course_code = '".Database::get_main_table(TABLE_MAIN_COURSE)."'");
  779. $result_array = array();
  780. while ($result = Database::fetch_array($sql_result)) {
  781. $result_array[] = $result;
  782. }
  783. return $result_array;
  784. }
  785. /**
  786. * This function returns the course code of the real course
  787. * to which a virtual course is linked.
  788. *
  789. * @param the course code of the virtual course
  790. * @return the course code of the real course
  791. */
  792. public static function get_target_of_linked_course($virtual_course_code) {
  793. //get info about the virtual course
  794. $result = Database::fetch_array(Database::query("SELECT * FROM ".Database::get_main_table(TABLE_MAIN_COURSE)."
  795. WHERE code = '".Database::escape_string($virtual_course_code)."'"));
  796. return $result['target_course_code'];
  797. }
  798. /*
  799. USER FUNCTIONS
  800. */
  801. /**
  802. * Check if user is subscribed inside a course
  803. * @param int User id
  804. * @param string Course code, if this parameter is null, it'll check for all courses
  805. * @param bool True for checking inside sessions too, by default is not checked
  806. * @return bool true if the user is registered in the course, false otherwise
  807. */
  808. public static function is_user_subscribed_in_course($user_id, $course_code = null, $in_a_session = false) {
  809. $user_id = intval($user_id);
  810. $condition_course = '';
  811. if (isset($course_code)) {
  812. $course_code = Database::escape_string($course_code);
  813. $condition_course = ' AND course_code = "'.$course_code.'" ';
  814. }
  815. $result = Database::fetch_array(Database::query("SELECT * FROM ".Database::get_main_table(TABLE_MAIN_COURSE_USER)."
  816. WHERE user_id = $user_id AND relation_type<>".COURSE_RELATION_TYPE_RRHH." $condition_course "));
  817. if (!empty($result)) {
  818. return true; // The user has been registered in this course.
  819. }
  820. if (!$in_a_session) {
  821. return false; // The user has not been registered in this course.
  822. }
  823. if (Database::num_rows(Database::query('SELECT 1 FROM '.Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER).
  824. ' WHERE id_user = '.$user_id.' '.$condition_course.' ')) > 0) {
  825. return true;
  826. }
  827. if (Database::num_rows(Database::query('SELECT 1 FROM '.Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER).
  828. ' WHERE id_user = '.$user_id.' AND status=2 '.$condition_course.' ')) > 0) {
  829. return true;
  830. }
  831. if (Database::num_rows(Database::query('SELECT 1 FROM '.Database::get_main_table(TABLE_MAIN_SESSION).
  832. ' WHERE id='.intval($_SESSION['id_session']).' AND id_coach='.$user_id)) > 0) {
  833. return true;
  834. }
  835. return false;
  836. }
  837. /**
  838. * Is the user a teacher in the given course?
  839. *
  840. * @param $user_id, the id (int) of the user
  841. * @param $course_code, the course code
  842. *
  843. * @return true if the user is a teacher in the course, false otherwise
  844. */
  845. public static function is_course_teacher($user_id, $course_code) {
  846. if ($user_id != strval(intval($user_id))) {
  847. return false;
  848. }
  849. $sql_result = Database::query('SELECT status FROM '.Database::get_main_table(TABLE_MAIN_COURSE_USER).
  850. ' WHERE course_code="'.Database::escape_string($course_code).'" and user_id="'.$user_id.'"');
  851. if (Database::num_rows($sql_result) > 0) {
  852. return Database::result($sql_result, 0, 'status') == 1;
  853. }
  854. return false;
  855. }
  856. /**
  857. * Is the user subscribed in the real course or linked courses?
  858. *
  859. * @param int the id of the user
  860. * @param array info about the course (comes from course table, see database lib)
  861. *
  862. * @return true if the user is registered in the real course or linked courses, false otherwise
  863. */
  864. public static function is_user_subscribed_in_real_or_linked_course ($user_id, $course_code, $session_id = '') {
  865. if ($user_id != strval(intval($user_id))) {
  866. return false;
  867. }
  868. $course_code = Database::escape_string($course_code);
  869. if ($session_id == '') {
  870. $result = Database::fetch_array(Database::query("SELECT *
  871. FROM ".Database::get_main_table(TABLE_MAIN_COURSE)." course
  872. LEFT JOIN ".Database::get_main_table(TABLE_MAIN_COURSE_USER)." course_user
  873. ON course.code = course_user.course_code
  874. 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')"));
  875. return !empty($result);
  876. }
  877. // From here we trust session id.
  878. // Is he/she subscribed to the session's course?
  879. // A user?
  880. if (Database::num_rows(Database::query("SELECT id_user
  881. FROM ".Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER)."
  882. WHERE id_session='".$_SESSION['id_session']."'
  883. AND id_user='$user_id'"))) {
  884. return true;
  885. }
  886. // A course coach?
  887. if (Database::num_rows(Database::query("SELECT id_user
  888. FROM ".Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER)."
  889. WHERE id_session='".$_SESSION['id_session']."'
  890. AND id_user = '$user_id' AND status = 2
  891. AND course_code='$course_code'"))) {
  892. return true;
  893. }
  894. // A session coach?
  895. if (Database::num_rows(Database::query("SELECT id_coach
  896. FROM ".Database::get_main_table(TABLE_MAIN_SESSION)." AS session
  897. WHERE session.id='".$_SESSION['id_session']."'
  898. AND id_coach='$user_id'"))) {
  899. return true;
  900. }
  901. return false;
  902. }
  903. /**
  904. * Return user info array of all users registered in the specified real or virtual course
  905. * This only returns the users that are registered in this actual course, not linked courses.
  906. *
  907. * @param string $course_code the code of the course
  908. * @param boolean $with_session determines if the course is used in a session or not
  909. * @param integer $session_id the id of the session
  910. * @param string $limit the LIMIT statement of the sql statement
  911. * @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 ...
  912. * @return array
  913. */
  914. public static function get_user_list_from_course_code($course_code, $with_session = true, $session_id = 0, $limit = '', $order_by = '') {
  915. // variable initialisation
  916. $session_id = intval($session_id);
  917. $course_code = Database::escape_string($course_code);
  918. $where = array();
  919. // if the $order_by does not contain 'ORDER BY' we have to check if it is a valid field that can be sorted on
  920. if (!strstr($order_by,'ORDER BY')) {
  921. if (!empty($order_by) AND in_array($order_by, array('lastname', 'firstname', 'username', 'email', 'official_code'))){
  922. $order_by = 'ORDER BY user.'.$order_by;
  923. } else {
  924. $order_by = '';
  925. }
  926. }
  927. $sql = $session_id == 0
  928. ? 'SELECT DISTINCT course_rel_user.status as status_rel, user.user_id, course_rel_user.role, course_rel_user.tutor_id, user.* '
  929. : 'SELECT DISTINCT user.user_id, session_course_user.status as status_session, user.* ';
  930. $sql .= ' FROM '.Database::get_main_table(TABLE_MAIN_USER).' as user ';
  931. if (!empty($session_id)) {
  932. $sql .= ' LEFT JOIN '.Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER).' as session_course_user
  933. ON user.user_id = session_course_user.id_user
  934. AND session_course_user.course_code="'.$course_code.'"
  935. AND session_course_user.id_session = '.$session_id;
  936. $where[] = ' session_course_user.course_code IS NOT NULL ';
  937. } else {
  938. $sql .= ' LEFT JOIN '.Database::get_main_table(TABLE_MAIN_COURSE_USER).' as course_rel_user
  939. ON user.user_id = course_rel_user.user_id AND course_rel_user.relation_type<>'.COURSE_RELATION_TYPE_RRHH.'
  940. AND course_rel_user.course_code="'.$course_code.'"';
  941. $where[] = ' course_rel_user.course_code IS NOT NULL ';
  942. }
  943. $multiple_access_url = api_get_multiple_access_url();
  944. if ($multiple_access_url) {
  945. $sql .= ' LEFT JOIN '.Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_USER).' au ON (au.user_id = user.user_id) ';
  946. }
  947. $sql .= ' WHERE '.implode(' OR ', $where);
  948. if ($multiple_access_url) {
  949. $current_access_url_id = api_get_current_access_url_id();
  950. $sql .= " AND (access_url_id = $current_access_url_id ) ";
  951. }
  952. $sql .= ' '.$order_by.' '.$limit;
  953. $rs = Database::query($sql);
  954. $users = array();
  955. if (Database::num_rows($rs)) {
  956. while ($user = Database::fetch_array($rs)) {
  957. //$user_info = Database::get_user_info_from_id($user['user_id']);
  958. $user_info = $user;
  959. $user_info['status'] = $user['status'];
  960. if (isset($user['role'])) {
  961. $user_info['role'] = $user['role'];
  962. }
  963. if (isset($user['tutor_id'])) {
  964. $user_info['tutor_id'] = $user['tutor_id'];
  965. }
  966. if (!empty($session_id)) {
  967. $user_info['status_session'] = $user['status_session'];
  968. }
  969. $users[$user['user_id']] = $user_info;
  970. }
  971. }
  972. return $users;
  973. }
  974. /**
  975. * Gets subscribed users in a course or in a course/session
  976. *
  977. * @param string $course_code
  978. * @param int $session_id
  979. * @return int
  980. */
  981. public static function get_users_count_in_course($course_code, $session_id = 0) {
  982. // variable initialisation
  983. $session_id = intval($session_id);
  984. $course_code = Database::escape_string($course_code);
  985. $sql .= 'SELECT DISTINCT count(*) as count FROM '.Database::get_main_table(TABLE_MAIN_USER).' as user ';
  986. $where = array();
  987. if (!empty($session_id)) {
  988. $sql .= ' LEFT JOIN '.Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER).' as session_course_user
  989. ON user.user_id = session_course_user.id_user
  990. AND session_course_user.course_code = "'.$course_code.'"
  991. AND session_course_user.id_session = '.$session_id;
  992. $where[] = ' session_course_user.course_code IS NOT NULL ';
  993. } else {
  994. $sql .= ' LEFT JOIN '.Database::get_main_table(TABLE_MAIN_COURSE_USER).' as course_rel_user
  995. ON user.user_id = course_rel_user.user_id AND course_rel_user.relation_type<>'.COURSE_RELATION_TYPE_RRHH.'
  996. AND course_rel_user.course_code="'.$course_code.'"';
  997. $where[] = ' course_rel_user.course_code IS NOT NULL ';
  998. }
  999. $multiple_access_url = api_get_multiple_access_url();
  1000. if ($multiple_access_url) {
  1001. $sql .= ' LEFT JOIN '.Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_USER).' au ON (au.user_id = user.user_id) ';
  1002. }
  1003. $sql .= ' WHERE '.implode(' OR ', $where);
  1004. if ($multiple_access_url) {
  1005. $current_access_url_id = api_get_current_access_url_id();
  1006. $sql .= " AND (access_url_id = $current_access_url_id ) ";
  1007. }
  1008. $rs = Database::query($sql);
  1009. $users = array();
  1010. $count = 0;
  1011. if (Database::num_rows($rs)) {
  1012. $user = Database::fetch_array($rs);
  1013. $count = $user['count'];
  1014. }
  1015. return $count;
  1016. }
  1017. /**
  1018. * Get a list of coaches of a course and a session
  1019. * @param string Course code
  1020. * @param int Session ID
  1021. * @return array List of users
  1022. */
  1023. public static function get_coach_list_from_course_code($course_code, $session_id) {
  1024. if ($session_id != strval(intval($session_id))) {
  1025. return array();
  1026. }
  1027. $course_code = Database::escape_string($course_code);
  1028. $users = array();
  1029. // We get the coach for the given course in a given session.
  1030. $rs = Database::query('SELECT id_user FROM '.Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER).
  1031. ' WHERE id_session="'.$session_id.'" AND course_code="'.$course_code.'" AND status = 2');
  1032. while ($user = Database::fetch_array($rs)) {
  1033. $user_info = Database::get_user_info_from_id($user['id_user']);
  1034. $user_info['status'] = $user['status'];
  1035. $user_info['role'] = $user['role'];
  1036. $user_info['tutor_id'] = $user['tutor_id'];
  1037. $user_info['email'] = $user['email'];
  1038. $users[$user['id_user']] = $user_info;
  1039. }
  1040. // We get the session coach.
  1041. $rs = Database::query('SELECT id_coach FROM '.Database::get_main_table(TABLE_MAIN_SESSION).
  1042. ' WHERE id="'.$session_id.'"');
  1043. $user_info = array();
  1044. $session_id_coach = Database::result($rs, 0, 'id_coach');
  1045. $user_info = Database::get_user_info_from_id($session_id_coach);
  1046. $user_info['status'] = $user['status'];
  1047. $user_info['role'] = $user['role'];
  1048. $user_info['tutor_id'] = $user['tutor_id'];
  1049. $user_info['email'] = $user['email'];
  1050. $users[$session_id_coach] = $user_info;
  1051. return $users;
  1052. }
  1053. /**
  1054. * Return user info array of all users registered in the specified real or virtual course
  1055. * This only returns the users that are registered in this actual course, not linked courses.
  1056. *
  1057. * @param string $course_code
  1058. * @param boolean $full list to true if we want sessions students too
  1059. * @return array with user id
  1060. */
  1061. public static function get_student_list_from_course_code($course_code, $with_session = false, $session_id = 0) {
  1062. $session_id = intval($session_id);
  1063. $course_code = Database::escape_string($course_code);
  1064. $students = array();
  1065. if ($session_id == 0) {
  1066. // students directly subscribed to the course
  1067. $rs = Database::query("SELECT * FROM ".Database::get_main_table(TABLE_MAIN_COURSE_USER)."
  1068. WHERE course_code = '$course_code' AND status = 5");
  1069. while ($student = Database::fetch_array($rs)) {
  1070. $students[$student['user_id']] = $student;
  1071. }
  1072. }
  1073. // students subscribed to the course through a session
  1074. if (api_get_setting('use_session_mode') == 'true' && $with_session) {
  1075. $sql_query = "SELECT * FROM ".Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER)." WHERE course_code = '$course_code' AND status<>2";
  1076. if ($session_id != 0) {
  1077. $sql_query .= ' AND id_session = '.$session_id;
  1078. }
  1079. $rs = Database::query($sql_query);
  1080. while($student = Database::fetch_array($rs)) {
  1081. $students[$student['id_user']] = $student;
  1082. }
  1083. }
  1084. return $students;
  1085. }
  1086. /**
  1087. * Return user info array of all teacher-users registered in the specified real or virtual course
  1088. * This only returns the users that are registered in this actual course, not linked courses.
  1089. *
  1090. * @param string $course_code
  1091. * @return array with user id
  1092. */
  1093. public static function get_teacher_list_from_course_code($course_code) {
  1094. $course_code = Database::escape_string($course_code);
  1095. // teachers directly subscribed to the course
  1096. $teachers = array();
  1097. // TODO: This query is not optimal.
  1098. $rs = Database::query("SELECT u.user_id, u.lastname, u.firstname, u.email, u.username, u.status " .
  1099. "FROM ".Database::get_main_table(TABLE_MAIN_COURSE_USER)." cu, ".Database::get_main_table(TABLE_MAIN_USER)." u ".
  1100. "WHERE cu.course_code = '$course_code' " .
  1101. "AND cu.status = 1 " .
  1102. "AND cu.user_id = u.user_id");
  1103. while ($teacher = Database::fetch_array($rs)) {
  1104. $teachers[$teacher['user_id']] = $teacher;
  1105. }
  1106. return $teachers;
  1107. }
  1108. /**
  1109. * Return user info array of all users registered in the specified course
  1110. * this includes the users of the course itsel and the users of all linked courses.
  1111. *
  1112. * @param array $course_info
  1113. * @return array with user info
  1114. */
  1115. public static function get_real_and_linked_user_list($course_code, $with_sessions = true, $session_id = 0) {
  1116. //get list of virtual courses
  1117. $virtual_course_list = self::get_virtual_courses_linked_to_real_course($course_code);
  1118. //get users from real course
  1119. $user_list = self::get_user_list_from_course_code($course_code, $with_sessions, $session_id);
  1120. foreach ($user_list as $this_user) {
  1121. $complete_user_list[] = $this_user;
  1122. }
  1123. //get users from linked courses
  1124. foreach ($virtual_course_list as $this_course) {
  1125. $course_code = $this_course['code'];
  1126. $user_list = self::get_user_list_from_course_code($course_code, $with_sessions, $session_id);
  1127. foreach ($user_list as $this_user) {
  1128. $complete_user_list[] = $this_user;
  1129. }
  1130. }
  1131. return $complete_user_list;
  1132. }
  1133. /**
  1134. * Return an array of arrays, listing course info of all courses in the list
  1135. * linked to the real course $real_course_code, to which the user $user_id is subscribed.
  1136. *
  1137. * @param $user_id, the id (int) of the user
  1138. * @param $real_course_code, the id (char) of the real course
  1139. *
  1140. * @return array of course info arrays
  1141. */
  1142. public static function get_list_of_virtual_courses_for_specific_user_and_real_course($user_id, $course_code) {
  1143. $result_array = array();
  1144. if ($user_id != strval(intval($user_id))) {
  1145. return $result_array;
  1146. }
  1147. $course_code = Database::escape_string($course_code);
  1148. $sql = "SELECT *
  1149. FROM ".Database::get_main_table(TABLE_MAIN_COURSE)." course
  1150. LEFT JOIN ".Database::get_main_table(TABLE_MAIN_COURSE_USER)." course_user
  1151. ON course.code = course_user.course_code
  1152. WHERE course.target_course_code = '$course_code' AND course_user.user_id = '$user_id' AND course_user.relation_type<>".COURSE_RELATION_TYPE_RRHH." ";
  1153. $sql_result = Database::query($sql);
  1154. while ($result = Database::fetch_array($sql_result)) {
  1155. $result_array[] = $result;
  1156. }
  1157. return $result_array;
  1158. }
  1159. /*
  1160. GROUP FUNCTIONS
  1161. */
  1162. /**
  1163. * Get the list of groups from the course
  1164. * @param string Course code
  1165. * @param int Session ID (optional)
  1166. * @return array List of groups info
  1167. */
  1168. public static function get_group_list_of_course($course_code, $session_id = 0) {
  1169. $course_info = Database::get_course_info($course_code);
  1170. $database_name = $course_info['db_name'];
  1171. $group_list = array();
  1172. $session_id != 0 ? $session_condition = ' WHERE g.session_id IN(1,'.intval($session_id).')' : $session_condition = ' WHERE g.session_id = 0';
  1173. $sql="SELECT g.id, g.name, COUNT(gu.id) userNb
  1174. FROM ".Database::get_course_table(TABLE_GROUP, $database_name)." AS g
  1175. LEFT JOIN ".Database::get_course_table(TABLE_GROUP_USER, $database_name)." gu
  1176. ON g.id = gu.group_id
  1177. $session_condition
  1178. GROUP BY g.id
  1179. ORDER BY g.name";
  1180. $result = Database::query($sql);
  1181. while ($group_data = Database::fetch_array($result)) {
  1182. $group_list[$group_data['id']] = $group_data;
  1183. }
  1184. return $group_list;
  1185. }
  1186. /**
  1187. * Checks all parameters needed to create a virtual course.
  1188. * If they are all set, the virtual course creation procedure is called.
  1189. *
  1190. * Call this function instead of create_virtual_course
  1191. * @param string Course code
  1192. * @param string Course title
  1193. * @param string Wanted course code
  1194. * @param string Course language
  1195. * @param string Course category
  1196. * @return bool True on success, false on error
  1197. */
  1198. public static function attempt_create_virtual_course($real_course_code, $course_title, $wanted_course_code, $course_language, $course_category) {
  1199. //better: create parameter list, check the entire list, when false display errormessage
  1200. self::check_parameter_or_fail($real_course_code, 'Unspecified parameter: real course id.');
  1201. self::check_parameter_or_fail($course_title, 'Unspecified parameter: course title.');
  1202. self::check_parameter_or_fail($wanted_course_code, 'Unspecified parameter: wanted course code.');
  1203. self::check_parameter_or_fail($course_language, 'Unspecified parameter: course language.');
  1204. self::check_parameter_or_fail($course_category, 'Unspecified parameter: course category.');
  1205. return self::create_virtual_course($real_course_code, $course_title, $wanted_course_code, $course_language, $course_category);
  1206. }
  1207. /**
  1208. * This function creates a virtual course.
  1209. * It assumes all parameters have been checked and are not empty.
  1210. * It checks wether a course with the $wanted_course_code already exists.
  1211. *
  1212. * Users of this library should consider this function private,
  1213. * please call attempt_create_virtual_course instead of this one.
  1214. *
  1215. * note: The virtual course 'owner' id (the first course admin) is set to the CURRENT user id.
  1216. * @param string Course code
  1217. * @param string Course title
  1218. * @param string Wanted course code
  1219. * @param string Course language
  1220. * @param string Course category
  1221. * @return true if the course creation succeeded, false otherwise
  1222. * @todo research: expiration date of a course
  1223. */
  1224. public static function create_virtual_course($real_course_code, $course_title, $wanted_course_code, $course_language, $course_category) {
  1225. global $firstExpirationDelay;
  1226. $user_id = api_get_user_id();
  1227. $real_course_info = Database::get_course_info($real_course_code);
  1228. $real_course_code = $real_course_info['system_code'];
  1229. //check: virtual course creation fails if another course has the same
  1230. //code, real or fake.
  1231. if (self::course_code_exists($wanted_course_code)) {
  1232. Display::display_error_message($wanted_course_code.' - '.get_lang('CourseCodeAlreadyExists'));
  1233. return false;
  1234. }
  1235. //add data to course table, course_rel_user
  1236. $course_sys_code = $wanted_course_code;
  1237. $course_screen_code = $wanted_course_code;
  1238. $course_repository = $real_course_info['directory'];
  1239. $course_db_name = $real_course_info['db_name'];
  1240. $responsible_teacher = $real_course_info['tutor_name'];
  1241. $faculty_shortname = $course_category;
  1242. // $course_title = $course_title;
  1243. // $course_language = $course_language;
  1244. $teacher_id = $user_id;
  1245. //HACK ----------------------------------------------------------------
  1246. $expiration_date = time() + $firstExpirationDelay;
  1247. //END HACK ------------------------------------------------------------
  1248. 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);
  1249. //above was the normal course creation table update call,
  1250. //now one more thing: fill in the target_course_code field
  1251. Database::query("UPDATE ".Database::get_main_table(TABLE_MAIN_COURSE)." SET target_course_code = '$real_course_code'
  1252. WHERE code = '".Database::escape_string($course_sys_code)."' LIMIT 1 ");
  1253. return true;
  1254. }
  1255. /**
  1256. * Delete a course
  1257. * This function deletes a whole course-area from the platform. When the
  1258. * given course is a virtual course, the database and directory will not be
  1259. * deleted.
  1260. * When the given course is a real course, also all virtual courses refering
  1261. * to the given course will be deleted.
  1262. * Considering the fact that we remove all traces of the course in the main
  1263. * database, it makes sense to remove all tracking as well (if stats databases exist)
  1264. * so that a new course created with this code would not use the remains of an older
  1265. * course.
  1266. *
  1267. * @param string The code of the course to delete
  1268. * @todo When deleting a virtual course: unsubscribe users from that virtual
  1269. * course from the groups in the real course if they are not subscribed in
  1270. * that real course.
  1271. * @todo Remove globals
  1272. */
  1273. public static function delete_course($code) {
  1274. global $_configuration;
  1275. $table_course = Database::get_main_table(TABLE_MAIN_COURSE);
  1276. $table_course_user = Database::get_main_table(TABLE_MAIN_COURSE_USER);
  1277. $table_course_class = Database::get_main_table(TABLE_MAIN_COURSE_CLASS);
  1278. $user_role_table = Database::get_main_table(MAIN_USER_ROLE_TABLE);
  1279. $location_table = Database::get_main_table(MAIN_LOCATION_TABLE);
  1280. $role_right_location_table = Database::get_main_table(MAIN_ROLE_RIGHT_LOCATION_TABLE);
  1281. $table_session_course = Database::get_main_table(TABLE_MAIN_SESSION_COURSE);
  1282. $table_session_course_user = Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER);
  1283. $table_course_survey = Database::get_main_table(TABLE_MAIN_SHARED_SURVEY);
  1284. $table_course_survey_question = Database::get_main_table(TABLE_MAIN_SHARED_SURVEY_QUESTION);
  1285. $table_course_survey_question_option = Database::get_main_table(TABLE_MAIN_SHARED_SURVEY_QUESTION_OPTION);
  1286. $stats = false;
  1287. if (Database::get_statistic_database() != ''){
  1288. $stats = true;
  1289. $table_stats_hotpots = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_HOTPOTATOES);
  1290. $table_stats_attempt = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_ATTEMPT);
  1291. $table_stats_exercises = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_EXERCICES);
  1292. $table_stats_access = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_ACCESS);
  1293. $table_stats_lastaccess = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_LASTACCESS);
  1294. $table_stats_course_access = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_COURSE_ACCESS);
  1295. $table_stats_online = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_ONLINE);
  1296. $table_stats_default = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_DEFAULT);
  1297. $table_stats_downloads = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_DOWNLOADS);
  1298. $table_stats_links = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_LINKS);
  1299. $table_stats_uploads = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_UPLOADS);
  1300. }
  1301. $code = Database::escape_string($code);
  1302. $sql = "SELECT * FROM $table_course WHERE code='".$code."'";
  1303. $res = Database::query($sql);
  1304. if (Database::num_rows($res) == 0) {
  1305. return;
  1306. }
  1307. $this_course = Database::fetch_array($res);
  1308. $db_name = $this_course['db_name'];
  1309. self::create_database_dump($code);
  1310. if (!self::is_virtual_course_from_system_code($code)) {
  1311. // If this is not a virtual course, look for virtual courses that depend on this one, if any
  1312. $virtual_courses = self::get_virtual_courses_linked_to_real_course($code);
  1313. foreach ($virtual_courses as $index => $virtual_course) {
  1314. // Unsubscribe all classes from the virtual course
  1315. $sql = "DELETE FROM $table_course_class WHERE course_code='".$virtual_course['code']."'";
  1316. Database::query($sql);
  1317. // Unsubscribe all users from the virtual course
  1318. $sql = "DELETE FROM $table_course_user WHERE course_code='".$virtual_course['code']."'";
  1319. Database::query($sql);
  1320. // Delete the course from the sessions tables
  1321. $sql = "DELETE FROM $table_session_course WHERE course_code='".$virtual_course['code']."'";
  1322. Database::query($sql);
  1323. $sql = "DELETE FROM $table_session_course_user WHERE course_code='".$virtual_course['code']."'";
  1324. Database::query($sql);
  1325. // Delete the course from the survey tables
  1326. $sql = "DELETE FROM $table_course_survey WHERE course_code='".$virtual_course['code']."'";
  1327. Database::query($sql);
  1328. $sql = "DELETE FROM $table_course_survey_user WHERE db_name='".$virtual_course['db_name']."'";
  1329. Database::query($sql);
  1330. $sql = "DELETE FROM $table_course_survey_reminder WHERE db_name='".$virtual_course['db_name']."'";
  1331. Database::query($sql);
  1332. // Delete the course from the stats tables
  1333. if ($stats) {
  1334. $sql = "DELETE FROM $table_stats_hotpots WHERE exe_cours_id = '".$virtual_course['code']."'";
  1335. Database::query($sql);
  1336. $sql = "DELETE FROM $table_stats_attempt WHERE course_code = '".$virtual_course['code']."'";
  1337. Database::query($sql);
  1338. $sql = "DELETE FROM $table_stats_exercises WHERE exe_cours_id = '".$virtual_course['code']."'";
  1339. Database::query($sql);
  1340. $sql = "DELETE FROM $table_stats_access WHERE access_cours_code = '".$virtual_course['code']."'";
  1341. Database::query($sql);
  1342. $sql = "DELETE FROM $table_stats_lastaccess WHERE access_cours_code = '".$virtual_course['code']."'";
  1343. Database::query($sql);
  1344. $sql = "DELETE FROM $table_stats_course_access WHERE course_code = '".$virtual_course['code']."'";
  1345. Database::query($sql);
  1346. $sql = "DELETE FROM $table_stats_online WHERE course = '".$virtual_course['code']."'";
  1347. Database::query($sql);
  1348. $sql = "DELETE FROM $table_stats_default WHERE default_cours_code = '".$virtual_course['code']."'";
  1349. Database::query($sql);
  1350. $sql = "DELETE FROM $table_stats_downloads WHERE down_cours_id = '".$virtual_course['code']."'";
  1351. Database::query($sql);
  1352. $sql = "DELETE FROM $table_stats_links WHERE links_cours_id = '".$virtual_course['code']."'";
  1353. Database::query($sql);
  1354. $sql = "DELETE FROM $table_stats_uploads WHERE upload_cours_id = '".$virtual_course['code']."'";
  1355. Database::query($sql);
  1356. }
  1357. // Delete the course from the course table
  1358. $sql = "DELETE FROM $table_course WHERE code='".$virtual_course['code']."'";
  1359. Database::query($sql);
  1360. }
  1361. $sql = "SELECT * FROM $table_course WHERE code='".$code."'";
  1362. $res = Database::query($sql);
  1363. $course = Database::fetch_array($res);
  1364. if (!$_configuration['single_database']) {
  1365. $sql = "DROP DATABASE IF EXISTS ".$course['db_name'];
  1366. Database::query($sql);
  1367. } else {
  1368. //TODO Clean the following code as currently it would probably delete another course
  1369. //similarly named, by mistake...
  1370. $db_pattern = $_configuration['table_prefix'].$course['db_name'].$_configuration['db_glue'];
  1371. $sql = "SHOW TABLES LIKE '$db_pattern%'";
  1372. $result = Database::query($sql);
  1373. while (list ($courseTable) = Database::fetch_array($result)) {
  1374. Database::query("DROP TABLE $courseTable");
  1375. }
  1376. }
  1377. $course_dir = api_get_path(SYS_COURSE_PATH).$course['directory'];
  1378. $archive_dir = api_get_path(SYS_ARCHIVE_PATH).$course['directory'].'_'.time();
  1379. if (is_dir($course_dir)) {
  1380. rename($course_dir, $archive_dir);
  1381. }
  1382. }
  1383. // Unsubscribe all classes from the course
  1384. $sql = "DELETE FROM $table_course_class WHERE course_code='".$code."'";
  1385. Database::query($sql);
  1386. // Unsubscribe all users from the course
  1387. $sql = "DELETE FROM $table_course_user WHERE course_code='".$code."'";
  1388. Database::query($sql);
  1389. // Delete the course from the sessions tables
  1390. $sql = "DELETE FROM $table_session_course WHERE course_code='".$code."'";
  1391. Database::query($sql);
  1392. $sql = "DELETE FROM $table_session_course_user WHERE course_code='".$code."'";
  1393. Database::query($sql);
  1394. $sql = 'SELECT survey_id FROM '.$table_course_survey.' WHERE course_code="'.$code.'"';
  1395. $result_surveys = Database::query($sql);
  1396. while($surveys = Database::fetch_array($result_surveys)) {
  1397. $survey_id = $surveys[0];
  1398. $sql = 'DELETE FROM '.$table_course_survey_question.' WHERE survey_id="'.$survey_id.'"';
  1399. Database::query($sql);
  1400. $sql = 'DELETE FROM '.$table_course_survey_question_option.' WHERE survey_id="'.$survey_id.'"';
  1401. Database::query($sql);
  1402. $sql = 'DELETE FROM '.$table_course_survey.' WHERE survey_id="'.$survey_id.'"';
  1403. Database::query($sql);
  1404. }
  1405. // Delete the course from the stats tables
  1406. if ($stats) {
  1407. $sql = "DELETE FROM $table_stats_hotpots WHERE exe_cours_id = '".$code."'";
  1408. Database::query($sql);
  1409. $sql = "DELETE FROM $table_stats_attempt WHERE course_code = '".$code."'";
  1410. Database::query($sql);
  1411. $sql = "DELETE FROM $table_stats_exercises WHERE exe_cours_id = '".$code."'";
  1412. Database::query($sql);
  1413. $sql = "DELETE FROM $table_stats_access WHERE access_cours_code = '".$code."'";
  1414. Database::query($sql);
  1415. $sql = "DELETE FROM $table_stats_lastaccess WHERE access_cours_code = '".$code."'";
  1416. Database::query($sql);
  1417. $sql = "DELETE FROM $table_stats_course_access WHERE course_code = '".$code."'";
  1418. Database::query($sql);
  1419. $sql = "DELETE FROM $table_stats_online WHERE course = '".$code."'";
  1420. Database::query($sql);
  1421. $sql = "DELETE FROM $table_stats_default WHERE default_cours_code = '".$code."'";
  1422. Database::query($sql);
  1423. $sql = "DELETE FROM $table_stats_downloads WHERE down_cours_id = '".$code."'";
  1424. Database::query($sql);
  1425. $sql = "DELETE FROM $table_stats_links WHERE links_cours_id = '".$code."'";
  1426. Database::query($sql);
  1427. $sql = "DELETE FROM $table_stats_uploads WHERE upload_cours_id = '".$code."'";
  1428. Database::query($sql);
  1429. }
  1430. global $_configuration;
  1431. if ($_configuration['multiple_access_urls']) {
  1432. require_once api_get_path(LIBRARY_PATH).'urlmanager.lib.php';
  1433. $url_id = 1;
  1434. if (api_get_current_access_url_id() != -1) {
  1435. $url_id = api_get_current_access_url_id();
  1436. }
  1437. UrlManager::delete_url_rel_course($code, $url_id);
  1438. }
  1439. // Delete the course from the database
  1440. $sql = "DELETE FROM $table_course WHERE code='".$code."'";
  1441. Database::query($sql);
  1442. // delete extra course fields
  1443. $t_cf = Database::get_main_table(TABLE_MAIN_COURSE_FIELD);
  1444. $t_cfv = Database::get_main_table(TABLE_MAIN_COURSE_FIELD_VALUES);
  1445. $sql = "SELECT distinct field_id FROM $t_cfv WHERE course_code = '$code'";
  1446. $res_field_ids = @Database::query($sql);
  1447. while($row_field_id = Database::fetch_row($res_field_ids)){
  1448. $field_ids[] = $row_field_id[0];
  1449. }
  1450. //delete from table_course_field_value from a given course_code
  1451. $sql_course_field_value = "DELETE FROM $t_cfv WHERE course_code = '$code'";
  1452. @Database::query($sql_course_field_value);
  1453. $sql = "SELECT distinct field_id FROM $t_cfv";
  1454. $res_field_all_ids = @Database::query($sql);
  1455. while($row_field_all_id = Database::fetch_row($res_field_all_ids)){
  1456. $field_all_ids[] = $row_field_all_id[0];
  1457. }
  1458. if (is_array($field_ids) && count($field_ids) > 0) {
  1459. foreach ($field_ids as $field_id) {
  1460. // check if field id is used into table field value
  1461. if (is_array($field_all_ids)) {
  1462. if (in_array($field_id, $field_all_ids)) {
  1463. continue;
  1464. } else {
  1465. $sql_course_field = "DELETE FROM $t_cf WHERE id = '$field_id'";
  1466. Database::query($sql_course_field);
  1467. }
  1468. }
  1469. }
  1470. }
  1471. // Add event to system log
  1472. $user_id = api_get_user_id();
  1473. event_system(LOG_COURSE_DELETE, LOG_COURSE_CODE, $code, api_get_utc_datetime(), $user_id, $code);
  1474. }
  1475. /**
  1476. * Creates a file called mysql_dump.sql in the course folder
  1477. * @param $course_code The code of the course
  1478. * @todo Implementation for single database
  1479. */
  1480. public static function create_database_dump($course_code) {
  1481. global $_configuration;
  1482. if ($_configuration['single_database']) {
  1483. return;
  1484. }
  1485. $sql_dump = '';
  1486. $course_code = Database::escape_string($course_code);
  1487. $table_course = Database::get_main_table(TABLE_MAIN_COURSE);
  1488. $sql = "SELECT * FROM $table_course WHERE code = '$course_code'";
  1489. $res = Database::query($sql);
  1490. $course = Database::fetch_array($res);
  1491. $sql = "SHOW TABLES FROM ".$course['db_name'];
  1492. $res = Database::query($sql);
  1493. while ($table = Database::fetch_array($res)) {
  1494. $sql = "SELECT * FROM ".$course['db_name'].".".$table[0]."";
  1495. $res3 = Database::query($sql);
  1496. while ($row = Database::fetch_array($res3)) {
  1497. foreach ($row as $key => $value) {
  1498. $row[$key] = $key."='".addslashes($row[$key])."'";
  1499. }
  1500. $sql_dump .= "\nINSERT INTO $table[0] SET ".implode(', ', $row).';';
  1501. }
  1502. }
  1503. if (is_dir(api_get_path(SYS_COURSE_PATH).$course['directory'])) {
  1504. $file_name = api_get_path(SYS_COURSE_PATH).$course['directory'].'/mysql_dump.sql';
  1505. $handle = fopen($file_name, 'a+');
  1506. if ($handle !== false) {
  1507. fwrite($handle, $sql_dump);
  1508. fclose($handle);
  1509. } else {
  1510. //TODO trigger exception in a try-catch
  1511. }
  1512. }
  1513. }
  1514. /**
  1515. * Sort courses for a specific user ??
  1516. * @param int User ID
  1517. * @param string Course code
  1518. * @return int Minimum course order
  1519. * @todo Review documentation
  1520. */
  1521. public static function userCourseSort($user_id, $course_code) {
  1522. if ($user_id != strval(intval($user_id))) {
  1523. return false;
  1524. }
  1525. $course_code = Database::escape_string($course_code);
  1526. $TABLECOURSE = Database::get_main_table(TABLE_MAIN_COURSE);
  1527. $TABLECOURSUSER = Database::get_main_table(TABLE_MAIN_COURSE_USER);
  1528. $course_title = Database::result(Database::query('SELECT title FROM '.$TABLECOURSE.
  1529. ' WHERE code="'.$course_code.'"'), 0, 0);
  1530. $result = Database::query('SELECT course.code as code, course.title as title, cu.sort as sort FROM '.$TABLECOURSUSER.' as cu, '.$TABLECOURSE.' as course
  1531. WHERE course.code = cu.course_code
  1532. AND user_id = "'.$user_id.'"
  1533. AND cu.relation_type<>'.COURSE_RELATION_TYPE_RRHH.'
  1534. AND user_course_cat=0 ORDER BY cu.sort');
  1535. $course_title_precedent = '';
  1536. $counter = 0;
  1537. $course_found = false;
  1538. $course_sort = 1;
  1539. while ($courses = Database::fetch_array($result)){
  1540. if ($course_title_precedent == '') {
  1541. $course_title_precedent = $courses['title'];
  1542. }
  1543. if (api_strcasecmp($course_title_precedent, $course_title) < 0) {
  1544. $course_found = true;
  1545. $course_sort = $courses['sort'];
  1546. if ($counter == 0) {
  1547. $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.'"';
  1548. $course_sort++;
  1549. } else {
  1550. $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.'"';
  1551. }
  1552. Database::query($sql);
  1553. break;
  1554. } else {
  1555. $course_title_precedent = $courses['title'];
  1556. }
  1557. $counter++;
  1558. }
  1559. // We must register the course in the beginning of the list
  1560. if (Database::num_rows($result) > 0 && !$course_found) {
  1561. $course_sort = Database::result(Database::query('SELECT min(sort) as min_sort FROM '.$TABLECOURSUSER.
  1562. ' WHERE user_id="'.$user_id.'" AND user_course_cat="0"'), 0, 0);
  1563. Database::query('UPDATE '.$TABLECOURSUSER.' SET sort = sort+1
  1564. WHERE user_id= "'.$user_id.'" AND user_course_cat="0"');
  1565. }
  1566. return $course_sort;
  1567. }
  1568. /**
  1569. * create recursively all categories as option of the select passed in paramater.
  1570. *
  1571. * @param object $select_element the quickform select where the options will be added
  1572. * @param string $category_selected_code the option value to select by default (used mainly for edition of courses)
  1573. * @param string $parent_code the parent category of the categories added (default=null for root category)
  1574. * @param string $padding the indent param (you shouldn't indicate something here)
  1575. */
  1576. public static function select_and_sort_categories($select_element, $category_selected_code = '', $parent_code = null , $padding = '') {
  1577. $sql = "SELECT code, name, auth_course_child, auth_cat_child
  1578. FROM ".Database::get_main_table(TABLE_MAIN_CATEGORY)."
  1579. WHERE parent_id ".(is_null($parent_code) ? "IS NULL" : "='".Database::escape_string($parent_code)."'")."
  1580. ORDER BY code";
  1581. $res = Database::query($sql);
  1582. while ($cat = Database::fetch_array($res)) {
  1583. $params = $cat['auth_course_child'] == 'TRUE' ? '' : 'disabled';
  1584. $params .= ($cat['code'] == $category_selected_code) ? ' selected' : '';
  1585. $select_element->addOption($padding.'('.$cat['code'].') '.$cat['name'], $cat['code'], $params);
  1586. if ($cat['auth_cat_child']) {
  1587. self::select_and_sort_categories($select_element, $category_selected_code, $cat['code'], $padding.' - ');
  1588. }
  1589. }
  1590. }
  1591. /**
  1592. * check if course exists
  1593. * @param string course_code
  1594. * @param string whether to accept virtual course codes or not
  1595. * @return true if exists, false else
  1596. */
  1597. public static function course_exists($course_code, $accept_virtual = false) {
  1598. if ($accept_virtual === true) {
  1599. $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).'"';
  1600. } else {
  1601. $sql = 'SELECT 1 FROM '.Database::get_main_table(TABLE_MAIN_COURSE).' WHERE code="'.Database::escape_string($course_code).'"';
  1602. }
  1603. return Database::num_rows(Database::query($sql));
  1604. }
  1605. /**
  1606. * Send an email to tutor after the auth-suscription of a student in your course
  1607. * @author Carlos Vargas <carlos.vargas@dokeos.com>, Dokeos Latino
  1608. * @param int $user_id the id of the user
  1609. * @param string $course_code the course code
  1610. * @param string $send_to_tutor_also
  1611. * @return string we return the message that is displayed when the action is succesfull
  1612. */
  1613. public static function email_to_tutor($user_id, $course_code, $send_to_tutor_also = false) {
  1614. if ($user_id != strval(intval($user_id))) {
  1615. return false;
  1616. }
  1617. $course_code = Database::escape_string($course_code);
  1618. $student = Database::fetch_array(Database::query("SELECT * FROM ".Database::get_main_table(TABLE_MAIN_USER)."
  1619. WHERE user_id='".$user_id."'"));
  1620. $information = self::get_course_information($course_code);
  1621. $name_course = $information['title'];
  1622. $sql = "SELECT * FROM ".Database::get_main_table(TABLE_MAIN_COURSE_USER)." WHERE course_code='".$course_code."'";
  1623. // TODO: Ivan: This is a mistake, please, have a look at it. Intention here is diffcult to be guessed.
  1624. //if ($send_to_tutor_also = true) {
  1625. // Proposed change:
  1626. if ($send_to_tutor_also) {
  1627. //
  1628. $sql .= " AND tutor_id=1";
  1629. } else {
  1630. $sql .= " AND status=1";
  1631. }
  1632. $result = Database::query($sql);
  1633. while ($row = Database::fetch_array($result)) {
  1634. $tutor = Database::fetch_array(Database::query("SELECT * FROM ".Database::get_main_table(TABLE_MAIN_USER)."
  1635. WHERE user_id='".$row['user_id']."'"));
  1636. $emailto = $tutor['email'];
  1637. $emailsubject = get_lang('NewUserInTheCourse').': '.$name_course;
  1638. $emailbody = get_lang('Dear').': '. api_get_person_name($tutor['firstname'], $tutor['lastname'])."\n";
  1639. $emailbody .= get_lang('MessageNewUserInTheCourse').': '.$name_course."\n";
  1640. $emailbody .= get_lang('UserName').': '.$student['username']."\n";
  1641. if (api_is_western_name_order()) {
  1642. $emailbody .= get_lang('FirstName').': '.$student['firstname']."\n";
  1643. $emailbody .= get_lang('LastName').': '.$student['lastname']."\n";
  1644. } else {
  1645. $emailbody .= get_lang('LastName').': '.$student['lastname']."\n";
  1646. $emailbody .= get_lang('FirstName').': '.$student['firstname']."\n";
  1647. }
  1648. $emailbody .= get_lang('Email').': '.$student['email']."\n\n";
  1649. $recipient_name = api_get_person_name($tutor['firstname'], $tutor['lastname'], null, PERSON_NAME_EMAIL_ADDRESS);
  1650. $sender_name = api_get_person_name(api_get_setting('administratorName'), api_get_setting('administratorSurname'), null, PERSON_NAME_EMAIL_ADDRESS);
  1651. $email_admin = api_get_setting('emailAdministrator');
  1652. @api_mail($recipient_name, $emailto, $emailsubject, $emailbody, $sender_name,$email_admin);
  1653. }
  1654. }
  1655. public static function get_special_course_list() {
  1656. $tbl_course_field = Database :: get_main_table(TABLE_MAIN_COURSE_FIELD);
  1657. $tbl_course_field_value = Database :: get_main_table(TABLE_MAIN_COURSE_FIELD_VALUES);
  1658. //we filter the courses from the URL
  1659. $join_access_url = $where_access_url='';
  1660. if (api_get_multiple_access_url()) {
  1661. $access_url_id = api_get_current_access_url_id();
  1662. if ($access_url_id != -1) {
  1663. $tbl_url_course = Database :: get_main_table(TABLE_MAIN_ACCESS_URL_REL_COURSE);
  1664. $join_access_url= "LEFT JOIN $tbl_url_course url_rel_course ON url_rel_course.course_code= tcfv.course_code ";
  1665. $where_access_url =" AND access_url_id = $access_url_id ";
  1666. }
  1667. }
  1668. // get course list auto-register
  1669. $sql = "SELECT DISTINCT(tcfv.course_code) FROM $tbl_course_field_value tcfv INNER JOIN $tbl_course_field tcf
  1670. ON tcfv.field_id = tcf.id $join_access_url
  1671. WHERE tcf.field_variable = 'special_course' AND tcfv.field_value = 1 $where_access_url";
  1672. $special_course_result = Database::query($sql);
  1673. $special_course_list = array();
  1674. if (Database::num_rows($special_course_result)>0) {
  1675. $special_course_list = array();
  1676. while ($result_row = Database::fetch_array($special_course_result)) {
  1677. $special_course_list[] = $result_row['course_code'];
  1678. }
  1679. }
  1680. return $special_course_list;
  1681. }
  1682. /**
  1683. * Get list of courses for a given user
  1684. * @param int user ID
  1685. * @param boolean Whether to include courses from session or not
  1686. * @return array List of codes and db names
  1687. * @author isaac flores paz
  1688. */
  1689. public static function get_courses_list_by_user_id($user_id, $include_sessions = false) {
  1690. $user_id = intval($user_id);
  1691. $course_list = array();
  1692. $codes = array();
  1693. $tbl_course = Database::get_main_table(TABLE_MAIN_COURSE);
  1694. $tbl_course_user = Database::get_main_table(TABLE_MAIN_COURSE_USER);
  1695. $tbl_user_course_category = Database::get_user_personal_table(TABLE_USER_COURSE_CATEGORY);
  1696. $special_course_list = self::get_special_course_list();
  1697. $with_special_courses = $without_special_courses = '';
  1698. if (!empty($special_course_list)) {
  1699. $sc_string = '"'.implode('","',$special_course_list).'"';
  1700. $with_special_courses = ' course.code IN ('.$sc_string.')';
  1701. $without_special_courses = ' AND course.code NOT IN ('.$sc_string.')';
  1702. }
  1703. if (!empty($with_special_courses)) {
  1704. $sql = "SELECT DISTINCT(course.code), course.db_name db_name, course.title
  1705. FROM ".$tbl_course_user." course_rel_user
  1706. LEFT JOIN ".$tbl_course." course
  1707. ON course.code = course_rel_user.course_code
  1708. LEFT JOIN ".$tbl_user_course_category." user_course_category
  1709. ON course_rel_user.user_course_cat = user_course_category.id
  1710. WHERE $with_special_courses
  1711. GROUP BY course.code
  1712. ORDER BY user_course_category.sort,course.title,course_rel_user.sort ASC";
  1713. $rs_special_course = Database::query($sql);
  1714. if (Database::num_rows($rs_special_course) > 0) {
  1715. while ($result_row = Database::fetch_array($rs_special_course)) {
  1716. $result_row['special_course'] = 1;
  1717. $course_list[] = $result_row;
  1718. $codes[] = $result_row['code'];
  1719. }
  1720. }
  1721. }
  1722. // get course list not auto-register. Use Distinct to avoid multiple
  1723. // entries when a course is assigned to a HRD (DRH) as watcher
  1724. $sql = "SELECT DISTINCT(course.code),course.db_name,course.title
  1725. FROM $tbl_course course
  1726. INNER JOIN $tbl_course_user cru
  1727. ON course.code=cru.course_code
  1728. WHERE cru.user_id='$user_id' $without_special_courses";
  1729. $result = Database::query($sql);
  1730. if (Database::num_rows($result)) {
  1731. while ($row = Database::fetch_array($result, 'ASSOC')) {
  1732. $course_list[] = $row;
  1733. $codes[] = $row['code'];
  1734. }
  1735. }
  1736. if ($include_sessions === true) {
  1737. $r = Database::query("SELECT DISTINCT(c.code),c.db_name,c.title
  1738. FROM ".Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER)." s, ".Database::get_main_table(TABLE_MAIN_COURSE)." c
  1739. WHERE id_user = $user_id AND s.course_code=c.code");
  1740. while ($row = Database::fetch_array($r, 'ASSOC')) {
  1741. if (!in_array($row['code'], $codes)) {
  1742. $course_list[] = $row;
  1743. }
  1744. }
  1745. }
  1746. return $course_list;
  1747. }
  1748. /**
  1749. * Get course ID from a given course directory name
  1750. * @param string Course directory (without any slash)
  1751. * @return string Course code, or false if not found
  1752. */
  1753. public static function get_course_id_from_path ($path) {
  1754. $path = Database::escape_string(str_replace('.', '', str_replace('/', '', $path)));
  1755. $res = Database::query("SELECT code FROM ".Database::get_main_table(TABLE_MAIN_COURSE)."
  1756. WHERE directory LIKE BINARY '$path'");
  1757. if ($res === false) {
  1758. return false;
  1759. }
  1760. if (Database::num_rows($res) != 1) {
  1761. return false;
  1762. }
  1763. $row = Database::fetch_array($res);
  1764. return $row['code'];
  1765. }
  1766. /**
  1767. * Get course code(s) from visual code
  1768. * @param string Visual code
  1769. * @return array List of codes for the given visual code
  1770. */
  1771. public static function get_courses_info_from_visual_code($code) {
  1772. $result = array();
  1773. $sql_result = Database::query("SELECT * FROM ".Database::get_main_table(TABLE_MAIN_COURSE)."
  1774. WHERE visual_code = '".Database::escape_string($code)."'");
  1775. while ($virtual_course = Database::fetch_array($sql_result)) {
  1776. $result[] = $virtual_course;
  1777. }
  1778. return $result;
  1779. }
  1780. /**
  1781. * Get emails of tutors to course
  1782. * @param string Visual code
  1783. * @return array List of emails of tutors to course
  1784. * @author @author Carlos Vargas <carlos.vargas@dokeos.com>, Dokeos Latino
  1785. * */
  1786. public static function get_emails_of_tutors_to_course($code) {
  1787. $list = array();
  1788. $res = Database::query("SELECT user_id FROM ".Database::get_main_table(TABLE_MAIN_COURSE_USER)."
  1789. WHERE course_code='".Database::escape_string($code)."' AND status=1");
  1790. while ($list_users = Database::fetch_array($res)) {
  1791. $result = Database::query("SELECT * FROM ".Database::get_main_table(TABLE_MAIN_USER)."
  1792. WHERE user_id=".$list_users['user_id']);
  1793. while ($row_user = Database::fetch_array($result)){
  1794. $name_teacher = api_get_person_name($row_user['firstname'], $row_user['lastname'], null, PERSON_NAME_EMAIL_ADDRESS);
  1795. $list[] = array($row_user['email'] => $name_teacher);
  1796. }
  1797. }
  1798. return $list;
  1799. }
  1800. /**
  1801. * Get coachs' emails by session
  1802. * @param int session id
  1803. * @param string course code
  1804. * @return array array(email => name_tutor) by coach
  1805. * @author Carlos Vargas <carlos.vargas@dokeos.com>
  1806. */
  1807. public static function get_email_of_tutor_to_session($session_id,$course_code) {
  1808. $tbl_session_course_user = Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER);
  1809. $tbl_user = Database::get_main_table(TABLE_MAIN_USER);
  1810. $coachs_emails = array();
  1811. $course_code = Database::escape_string($course_code);
  1812. $session_id = intval($session_id);
  1813. $sql = "SELECT id_user FROM $tbl_session_course_user WHERE id_session='$session_id' AND course_code='$course_code' AND status =2";
  1814. $rs = Database::query($sql);
  1815. if (Database::num_rows($rs) > 0) {
  1816. $user_ids = array();
  1817. while ($row = Database::fetch_array($rs)) {
  1818. $user_ids[] = $row['id_user'];
  1819. }
  1820. $sql = "SELECT firstname,lastname,email FROM $tbl_user WHERE user_id IN (".implode(",",$user_ids).")";
  1821. $rs_user = Database::query($sql);
  1822. while ($row_emails = Database::fetch_array($rs_user)) {
  1823. $name_tutor = api_get_person_name($row_emails['firstname'], $row_emails['lastname'], null, PERSON_NAME_EMAIL_ADDRESS);
  1824. $mail_tutor = array($row_emails['email'] => $name_tutor);
  1825. $coachs_emails[] = $mail_tutor;
  1826. }
  1827. }
  1828. return $coachs_emails;
  1829. }
  1830. /**
  1831. * Creates a new extra field for a given course
  1832. * @param string Field's internal variable name
  1833. * @param int Field's type
  1834. * @param string Field's language var name
  1835. * @return int new extra field id
  1836. */
  1837. public static function create_course_extra_field($fieldvarname, $fieldtype, $fieldtitle) {
  1838. // database table definition
  1839. $t_cfv = Database::get_main_table(TABLE_MAIN_COURSE_FIELD_VALUES);
  1840. $t_cf = Database::get_main_table(TABLE_MAIN_COURSE_FIELD);
  1841. $fieldvarname = Database::escape_string($fieldvarname);
  1842. $fieldtitle = Database::escape_string($fieldtitle);
  1843. $fieldtype = (int)$fieldtype;
  1844. $time = time();
  1845. $sql_field = "SELECT id FROM $t_cf WHERE field_variable = '$fieldvarname'";
  1846. $res_field = Database::query($sql_field);
  1847. $r_field = Database::fetch_row($res_field);
  1848. if (Database::num_rows($res_field) > 0) {
  1849. return $r_field[0];
  1850. }
  1851. // save new fieldlabel into course_field table
  1852. $sql = "SELECT MAX(field_order) FROM $t_cf";
  1853. $res = Database::query($sql);
  1854. $order = 0;
  1855. if (Database::num_rows($res) > 0) {
  1856. $row = Database::fetch_row($res);
  1857. $order = $row[0] + 1;
  1858. }
  1859. $sql = "INSERT INTO $t_cf
  1860. SET field_type = '$fieldtype',
  1861. field_variable = '$fieldvarname',
  1862. field_display_text = '$fieldtitle',
  1863. field_order = '$order',
  1864. tms = FROM_UNIXTIME($time)";
  1865. Database::query($sql);
  1866. return Database::insert_id();
  1867. }
  1868. /**
  1869. * Updates course attribute. Note that you need to check that your attribute is valid before you use this function
  1870. *
  1871. * @param int Course id
  1872. * @param string Attribute name
  1873. * @param string Attribute value
  1874. * @return bool True if attribute was successfully updated, false if course was not found or attribute name is invalid
  1875. */
  1876. public static function update_attribute($id, $name, $value) {
  1877. $id = (int)$id;
  1878. $table = Database::get_main_table(TABLE_MAIN_COURSE);
  1879. $sql = "UPDATE $table SET $name = '".Database::escape_string($value)."' WHERE id = '$id';";
  1880. return Database::query($sql);
  1881. }
  1882. /**
  1883. * Update course attributes. Will only update attributes with a non-empty value. Note that you NEED to check that your attributes are valid before using this function
  1884. *
  1885. * @param int Course id
  1886. * @param array Associative array with field names as keys and field values as values
  1887. * @return bool True if update was successful, false otherwise
  1888. */
  1889. public static function update_attributes($id, $attributes) {
  1890. $id = (int)$id;
  1891. $table = Database::get_main_table(TABLE_MAIN_COURSE);
  1892. $sql = "UPDATE $table SET ";
  1893. $i = 0;
  1894. foreach($attributes as $name => $value) {
  1895. if($value != '') {
  1896. if($i > 0) {
  1897. $sql .= ", ";
  1898. }
  1899. $sql .= " $name = '".Database::escape_string($value)."'";
  1900. $i++;
  1901. }
  1902. }
  1903. $sql .= " WHERE id = '$id';";
  1904. return Database::query($sql);
  1905. }
  1906. /**
  1907. * Update an extra field value for a given course
  1908. * @param integer Course ID
  1909. * @param string Field variable name
  1910. * @param string Field value
  1911. * @return boolean true if field updated, false otherwise
  1912. */
  1913. public static function update_course_extra_field_value($course_code, $fname, $fvalue = '') {
  1914. $t_cfv = Database::get_main_table(TABLE_MAIN_COURSE_FIELD_VALUES);
  1915. $t_cf = Database::get_main_table(TABLE_MAIN_COURSE_FIELD);
  1916. $fname = Database::escape_string($fname);
  1917. $course_code = Database::escape_string($course_code);
  1918. $fvalues = '';
  1919. if (is_array($fvalue)) {
  1920. foreach ($fvalue as $val) {
  1921. $fvalues .= Database::escape_string($val).';';
  1922. }
  1923. if (!empty($fvalues)) {
  1924. $fvalues = substr($fvalues, 0, -1);
  1925. }
  1926. } else {
  1927. $fvalues = Database::escape_string($fvalue);
  1928. }
  1929. $sqlcf = "SELECT * FROM $t_cf WHERE field_variable='$fname'";
  1930. $rescf = Database::query($sqlcf);
  1931. if (Database::num_rows($rescf) == 1) {
  1932. // Ok, the field exists
  1933. // Check if enumerated field, if the option is available
  1934. $rowcf = Database::fetch_array($rescf);
  1935. $tms = time();
  1936. $sqlcfv = "SELECT * FROM $t_cfv WHERE course_code = '$course_code' AND field_id = '".$rowcf['id']."' ORDER BY id";
  1937. $rescfv = Database::query($sqlcfv);
  1938. $n = Database::num_rows($rescfv);
  1939. if ($n > 1) {
  1940. //problem, we already have to values for this field and user combination - keep last one
  1941. while ($rowcfv = Database::fetch_array($rescfv)) { // See the TODO note below.
  1942. if ($n > 1) {
  1943. $sqld = "DELETE FROM $t_cfv WHERE id = ".$rowcfv['id'];
  1944. $resd = Database::query($sqld);
  1945. $n--;
  1946. }
  1947. $rowcfv = Database::fetch_array($rescfv);
  1948. if ($rowcfv['field_value'] != $fvalues) {
  1949. $sqlu = "UPDATE $t_cfv SET field_value = '$fvalues', tms = FROM_UNIXTIME($tms) WHERE id = ".$rowcfv['id'];
  1950. $resu = Database::query($sqlu);
  1951. return ($resu ? true : false);
  1952. }
  1953. 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...
  1954. }
  1955. } elseif ($n == 1) {
  1956. //we need to update the current record
  1957. $rowcfv = Database::fetch_array($rescfv);
  1958. if ($rowcfv['field_value'] != $fvalues) {
  1959. $sqlu = "UPDATE $t_cfv SET field_value = '$fvalues', tms = FROM_UNIXTIME($tms) WHERE id = ".$rowcfv['id'];
  1960. //error_log('UM::update_extra_field_value: '.$sqlu);
  1961. $resu = Database::query($sqlu);
  1962. return ($resu ? true : false);
  1963. }
  1964. return true;
  1965. } else {
  1966. $sqli = "INSERT INTO $t_cfv (course_code,field_id,field_value,tms) " .
  1967. "VALUES ('$course_code',".$rowcf['id'].",'$fvalues',FROM_UNIXTIME($tms))";
  1968. //error_log('UM::update_extra_field_value: '.$sqli);
  1969. $resi = Database::query($sqli);
  1970. return ($resi ? true : false);
  1971. }
  1972. } else {
  1973. return false; //field not found
  1974. }
  1975. }
  1976. /**
  1977. * Get the course id of an course by the database name
  1978. * @param string The database name
  1979. * @return string The course id
  1980. */
  1981. public static function get_course_id_by_database_name($db_name) {
  1982. return Database::result(Database::query('SELECT code FROM '.Database::get_main_table(TABLE_MAIN_COURSE).
  1983. ' WHERE db_name="'.Database::escape_string($db_name).'"'), 0, 'code');
  1984. }
  1985. public static function get_session_category_id_by_session_id($session_id) {
  1986. return Database::result(Database::query('SELECT sc.id session_category
  1987. FROM '.Database::get_main_table(TABLE_MAIN_SESSION_CATEGORY).' sc
  1988. INNER JOIN '.Database::get_main_table(TABLE_MAIN_SESSION).' s
  1989. ON sc.id=s.session_category_id WHERE s.id="'.Database::escape_string($session_id).'"'),
  1990. 0, 'session_category');
  1991. }
  1992. /**
  1993. * Get the course id of an course by the database name
  1994. * @param string The database name
  1995. * @return string The course id
  1996. */
  1997. public static function get_course_extra_field_list($code) {
  1998. $tbl_course_field = Database::get_main_table(TABLE_MAIN_COURSE_FIELD);
  1999. $tbl_course_field_value = Database::get_main_table(TABLE_MAIN_COURSE_FIELD_VALUES);
  2000. $sql_field = "SELECT id, field_type, field_variable, field_display_text, field_default_value
  2001. FROM $tbl_course_field WHERE field_visible = '1' ";
  2002. $res_field = Database::query($sql_field);
  2003. $extra_fields = array();
  2004. while($rowcf = Database::fetch_array($res_field)) {
  2005. $extra_field_id = $rowcf['id'];
  2006. $sql_field_value = "SELECT field_value FROM $tbl_course_field_value WHERE course_code = '$code' AND field_id = '$extra_field_id' ";
  2007. $res_field_value = Database::query($sql_field_value);
  2008. if(Database::num_rows($res_field_value) > 0 ) {
  2009. $r_field_value = Database::fetch_row($res_field_value);
  2010. $rowcf['extra_field_value'] = $r_field_value[0];
  2011. }
  2012. $extra_fields[] = $rowcf;
  2013. }
  2014. return $extra_fields;
  2015. }
  2016. /**
  2017. * Gets the value of a course extra field. Returns null if it was not found
  2018. *
  2019. * @param string Name of the extra field
  2020. * @param string Course code
  2021. * @return string Value
  2022. */
  2023. public static function get_course_extra_field_value($field_name, $code) {
  2024. $tbl_course_field = Database::get_main_table(TABLE_MAIN_COURSE_FIELD);
  2025. $tbl_course_field_value = Database::get_main_table(TABLE_MAIN_COURSE_FIELD_VALUES);
  2026. $sql = "SELECT id FROM $tbl_course_field WHERE field_visible = '1' AND field_variable = '$field_name';";
  2027. $res = Database::query($sql);
  2028. $row = Database::fetch_object($res);
  2029. if(!$row) {
  2030. return null;
  2031. } else {
  2032. $sql_field_value = "SELECT field_value FROM $tbl_course_field_value WHERE course_code = '$code' AND field_id = '{$row->id}';";
  2033. $res_field_value = Database::query($sql_field_value);
  2034. $row_field_value = Database::fetch_object($res_field_value);
  2035. if(!$row_field_value) {
  2036. return null;
  2037. } else {
  2038. return $row_field_value['field_value'];
  2039. }
  2040. }
  2041. }
  2042. /**
  2043. * Get the database name of a course by the code
  2044. * @param string The course code
  2045. * @return string The database name
  2046. */
  2047. public static function get_name_database_course($course_code) {
  2048. return Database::result(Database::query('SELECT db_name FROM '.Database::get_main_table(TABLE_MAIN_COURSE).
  2049. ' WHERE code="'.Database::escape_string($course_code).'"'), 0, 'db_name');
  2050. }
  2051. /**
  2052. * Lists details of the course description
  2053. * @param array The course description
  2054. * @param string The encoding
  2055. * @param bool If true is displayed if false is hidden
  2056. * @return string The course description in html
  2057. */
  2058. public static function get_details_course_description_html($descriptions, $charset, $action_show = true) {
  2059. if (isset($descriptions) && count($descriptions) > 0) {
  2060. $data = '';
  2061. foreach ($descriptions as $id => $description) {
  2062. $data .= '<div class="sectiontitle">';
  2063. if (api_is_allowed_to_edit() && $action_show) {
  2064. //delete
  2065. $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;">';
  2066. $data .= Display::return_icon('delete.gif', get_lang('Delete'), array('style' => 'vertical-align:middle;float:right;'));
  2067. $data .= '</a> ';
  2068. //edit
  2069. $data .= '<a href="'.api_get_self().'?'.api_get_cidreq().'&amp;description_id='.$description->id.'">';
  2070. $data .= Display::return_icon('edit.png', get_lang('Edit'), array('style' => 'vertical-align:middle;float:right; padding-right:4px;'), 22);
  2071. $data .= '</a> ';
  2072. }
  2073. $data .= $description->title;
  2074. $data .= '</div>';
  2075. $data .= '<div class="sectioncomment">';
  2076. $data .= text_filter($description->content);
  2077. $data .= '</div>';
  2078. }
  2079. } else {
  2080. $data .= '<em>'.get_lang('ThisCourseDescriptionIsEmpty').'</em>';
  2081. }
  2082. return $data;
  2083. }
  2084. /**
  2085. * Returns the details of a course category
  2086. *
  2087. * @param string Category code
  2088. * @return array Course category
  2089. */
  2090. public static function get_course_category($code) {
  2091. $table_categories = Database::get_main_table(TABLE_MAIN_CATEGORY);
  2092. $sql = "SELECT * FROM $table_categories WHERE code = '$code';";
  2093. return Database::fetch_array(Database::query($sql));
  2094. }
  2095. /*
  2096. ==============================================================================
  2097. DEPRECATED METHODS
  2098. ==============================================================================
  2099. */
  2100. /**
  2101. * This code creates a select form element to let the user
  2102. * choose a real course to link to.
  2103. *
  2104. * A good non-display library should not use echo statements, but just return text/html
  2105. * so users of the library can choose when to display.
  2106. *
  2107. * We display the course code, but internally store the course id.
  2108. *
  2109. * @param boolean $has_size, true the select tag gets a size element, false it stays a dropdownmenu
  2110. * @param boolean $only_current_user_courses, true only the real courses of which the
  2111. * current user is course admin are displayed, false all real courses are shown.
  2112. * @param string $element_name the name of the select element
  2113. * @return a string containing html code for a form select element.
  2114. * @deprecated Function not in use
  2115. */
  2116. public static function get_real_course_code_select_html($element_name, $has_size = true, $only_current_user_courses = true, $user_id) {
  2117. if ($only_current_user_courses) {
  2118. $real_course_list = self::get_real_course_list_of_user_as_course_admin($user_id);
  2119. } else {
  2120. $real_course_list = self::get_real_course_list();
  2121. }
  2122. if ($has_size) {
  2123. $size_element = "size=\"".SELECT_BOX_SIZE."\"";
  2124. } else {
  2125. $size_element = "";
  2126. }
  2127. $html_code = "<select name=\"$element_name\" $size_element >\n";
  2128. foreach ($real_course_list as $real_course) {
  2129. $course_code = $real_course["code"];
  2130. $html_code .= "<option value=\"".$course_code."\">";
  2131. $html_code .= $course_code;
  2132. $html_code .= "</option>\n";
  2133. }
  2134. $html_code .= "</select>\n";
  2135. return $html_code;
  2136. }
  2137. /**
  2138. * Get count rows of a table inside a course database
  2139. * @param string The table of which the rows should be counted
  2140. * @param int optionally count rows by session id
  2141. * @return int The number of rows in the given table.
  2142. */
  2143. public static function count_rows_course_table($table, $session_id = '') {
  2144. $condition_session = '';
  2145. if ($session_id !== '') {
  2146. $session_id = intval($session_id);
  2147. $condition_session = " WHERE session_id = '$session_id' ";
  2148. }
  2149. $sql = "SELECT COUNT(*) AS n FROM $table $condition_session ";
  2150. $rs = Database::query($sql);
  2151. $row = Database::fetch_row($rs);
  2152. return $row[0];
  2153. }
  2154. /**
  2155. * Subscribes courses to human resource manager (Dashboard feature)
  2156. * @param int Human Resource Manager id
  2157. * @param array Courses code
  2158. * @param int Relation type
  2159. **/
  2160. public static function suscribe_courses_to_hr_manager($hr_manager_id,$courses_list) {
  2161. global $_configuration;
  2162. // Database Table Definitions
  2163. $tbl_course = Database::get_main_table(TABLE_MAIN_COURSE);
  2164. $tbl_course_rel_user = Database::get_main_table(TABLE_MAIN_COURSE_USER);
  2165. $tbl_course_rel_access_url = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_COURSE);
  2166. $hr_manager_id = intval($hr_manager_id);
  2167. $affected_rows = 0;
  2168. //Deleting assigned courses to hrm_id
  2169. if ($_configuration['multiple_access_urls']) {
  2170. $sql = "SELECT s.course_code FROM $tbl_course_rel_user s INNER JOIN $tbl_course_rel_access_url a ON (a.course_code = s.course_code) WHERE user_id = $hr_manager_id AND relation_type=".COURSE_RELATION_TYPE_RRHH." AND access_url_id = ".api_get_current_access_url_id()."";
  2171. } else {
  2172. $sql = "SELECT course_code FROM $tbl_course_rel_user WHERE user_id = $hr_manager_id AND relation_type=".COURSE_RELATION_TYPE_RRHH." ";
  2173. }
  2174. $result = Database::query($sql);
  2175. if (Database::num_rows($result) > 0) {
  2176. while ($row = Database::fetch_array($result)) {
  2177. $sql = "DELETE FROM $tbl_course_rel_user WHERE course_code = '{$row['course_code']}' AND user_id = $hr_manager_id AND relation_type=".COURSE_RELATION_TYPE_RRHH." ";
  2178. Database::query($sql);
  2179. }
  2180. }
  2181. // inserting new courses list
  2182. if (is_array($courses_list)) {
  2183. foreach ($courses_list as $course_code) {
  2184. $course_code = Database::escape_string($course_code);
  2185. $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."')";
  2186. Database::query($insert_sql);
  2187. if (Database::affected_rows()) {
  2188. $affected_rows++;
  2189. }
  2190. }
  2191. }
  2192. return $affected_rows;
  2193. }
  2194. /**
  2195. * get courses followed by human resources manager
  2196. * @param int human resources manager id
  2197. * @return array courses
  2198. */
  2199. public static function get_courses_followed_by_drh($hr_dept_id) {
  2200. // Database Table Definitions
  2201. $tbl_course = Database::get_main_table(TABLE_MAIN_COURSE);
  2202. $tbl_course_rel_user = Database::get_main_table(TABLE_MAIN_COURSE_USER);
  2203. $tbl_course_rel_access_url = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_COURSE);
  2204. $hr_dept_id = intval($hr_dept_id);
  2205. $assigned_courses_to_hrm = array();
  2206. if (api_get_multiple_access_url()) {
  2207. $sql = "SELECT * FROM $tbl_course c
  2208. INNER JOIN $tbl_course_rel_user cru ON (cru.course_code = c.code) LEFT JOIN $tbl_course_rel_access_url a ON (a.course_code = c.code) WHERE cru.user_id = '$hr_dept_id' AND status = ".DRH." AND relation_type = '".COURSE_RELATION_TYPE_RRHH."' AND access_url_id = ".api_get_current_access_url_id()."";
  2209. } else {
  2210. $sql = "SELECT * FROM $tbl_course c
  2211. 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."' ";
  2212. }
  2213. $rs_assigned_courses = Database::query($sql);
  2214. if (Database::num_rows($rs_assigned_courses) > 0) {
  2215. while ($row_assigned_courses = Database::fetch_array($rs_assigned_courses)) {
  2216. $assigned_courses_to_hrm[$row_assigned_courses['code']] = $row_assigned_courses;
  2217. }
  2218. }
  2219. return $assigned_courses_to_hrm;
  2220. }
  2221. /**
  2222. * check if a course is special (autoregister)
  2223. * @param string course code
  2224. */
  2225. public static function is_special_course($course_code){
  2226. $tbl_course_field_value = Database::get_main_table(TABLE_MAIN_COURSE_FIELD_VALUES);
  2227. $tbl_course_field = Database::get_main_table(TABLE_MAIN_COURSE_FIELD);
  2228. $is_special = false;
  2229. $sql = "SELECT course_code FROM $tbl_course_field_value tcfv INNER JOIN $tbl_course_field tcf ON " .
  2230. " tcfv.field_id = tcf.id WHERE tcf.field_variable = 'special_course' AND tcfv.field_value = 1 AND course_code='$course_code'";
  2231. $result = Database::query($sql);
  2232. $num_rows = Database::num_rows($result);
  2233. if ($num_rows > 0){
  2234. $is_special = true;
  2235. }
  2236. return $is_special;
  2237. }
  2238. /**
  2239. * Update course picture
  2240. * @param string Course code
  2241. * @param string File name
  2242. * @param string The full system name of the image from which course picture will be created.
  2243. * @return bool Returns the resulting. In case of internal error or negative validation returns FALSE.
  2244. */
  2245. public static function update_course_picture($course_code, $filename, $source_file = null) {
  2246. $course_info = api_get_course_info($course_code);
  2247. $store_path = api_get_path(SYS_COURSE_PATH).$course_info['path']; // course path
  2248. $course_image = $store_path.'/course-pic.png'; // image name for courses
  2249. $course_medium_image = $store_path.'/course-pic85x85.png';
  2250. $extension = strtolower(substr(strrchr($filename, '.'), 1));
  2251. $result = false;
  2252. if (file_exists($course_image)) {
  2253. @unlink($course_image);
  2254. }
  2255. if (file_exists($course_medium_image)) {
  2256. @unlink($course_medium_image);
  2257. }
  2258. $my_course_image = new Image($source_file);
  2259. $result = $my_course_image->send_image($course_image, -1, 'png');
  2260. //Redimension image to 100x85
  2261. if ($result) {
  2262. $medium = new Image($course_image);
  2263. $picture_infos = $medium->get_image_size();
  2264. $medium->resize(100, 85, 0, false);
  2265. $rs = $medium->send_image($store_path.'/course-pic85x85.png', -1, 'png');
  2266. }
  2267. return $result;
  2268. }
  2269. /**
  2270. * @deprecated See CourseManager::course_code_exists()
  2271. */
  2272. public static function is_existing_course_code($wanted_course_code) {
  2273. return self::course_code_exists($wanted_course_code);
  2274. }
  2275. /**
  2276. * Display special courses (and only these) as several HTML divs of class userportal-course-item
  2277. *
  2278. * Special courses are courses that stick on top of the list and are "auto-registerable"
  2279. * in the sense that any user clicking them is registered as a student
  2280. * @param int User id
  2281. * @param bool Whether to show the document quick-loader or not
  2282. * @return void
  2283. */
  2284. function display_special_courses($user_id, $load_dirs = false) {
  2285. $user_id = intval($user_id);
  2286. $user_info = api_get_user_info($user_id);
  2287. $tbl_course = Database::get_main_table(TABLE_MAIN_COURSE);
  2288. $tbl_course_user = Database::get_main_table(TABLE_MAIN_COURSE_USER);
  2289. $tbl_user_course_category = Database::get_user_personal_table(TABLE_USER_COURSE_CATEGORY);
  2290. $special_course_list = self::get_special_course_list();
  2291. $with_special_courses = $without_special_courses = '';
  2292. if (!empty($special_course_list)) {
  2293. $with_special_courses = ' course.code IN ("'.implode('","',$special_course_list).'")';
  2294. }
  2295. if (!empty($with_special_courses)) {
  2296. $sql = "SELECT course.code, course.visual_code, course.subscribe subscr, course.unsubscribe unsubscr,
  2297. course.title title, course.tutor_name tutor, course.db_name, course.directory, course_rel_user.status status,
  2298. course_rel_user.sort sort, course_rel_user.user_course_cat user_course_cat, course_rel_user.user_id, course.visibility
  2299. FROM $tbl_course course
  2300. LEFT JOIN $tbl_course_user course_rel_user ON course.code = course_rel_user.course_code AND course_rel_user.user_id = '$user_id'
  2301. WHERE $with_special_courses group by course.code";
  2302. $rs_special_course = Database::query($sql);
  2303. $number_of_courses = Database::num_rows($rs_special_course);
  2304. $key = 0;
  2305. $status_icon = '';
  2306. if ($number_of_courses > 0) {
  2307. while ($course = Database::fetch_array($rs_special_course)) {
  2308. // Get notifications.
  2309. $my_course = array();
  2310. $my_course['db'] = $course['db_name'];
  2311. $my_course['k'] = $course['code'];
  2312. $my_course['id_session'] = null;
  2313. $my_course['s'] = $course['status'];
  2314. $show_notification = Display::show_notification($my_course);
  2315. if (empty($course['user_id'])) {
  2316. $course['status'] = $user_info['status'];
  2317. }
  2318. $status_icon = Display::return_icon('blackboard.png', get_lang('Course'), array('width'=>'48px'));
  2319. /*
  2320. if ($course['status'] == 1) {
  2321. $status_icon = Display::return_icon('course.gif', get_lang('Course')).' '.Display::return_icon('teachers.gif', get_lang('Status').': '.get_lang('Teacher'), array('style' => 'width: 11px; height: 11px;'));
  2322. }
  2323. if (($course['status'] == 5 && !api_is_coach()) || empty($course['status'])) {
  2324. $status_icon = Display::return_icon('course.gif', get_lang('Course')).' '.Display::return_icon('students.gif', get_lang('Status').': '.get_lang('Student'), array('style' => 'width: 11px; height: 11px;'));
  2325. }*/
  2326. echo '<div class="userportal-course-item">';
  2327. if (api_is_platform_admin()) {
  2328. echo '<div style="float:right;">';
  2329. if ($load_dirs) {
  2330. echo '<a id="document_preview_'.$course['id'].'_0" class="document_preview" href="javascript:void();">'.Display::return_icon('folder.png', get_lang('Documents'), array('align' => 'absmiddle'),22).'</a>';
  2331. echo '<a href="'.api_get_path(WEB_CODE_PATH).'course_info/infocours.php?cidReq='.$course['code'].'">'.Display::return_icon('edit.png', get_lang('Edit'), array('align' => 'absmiddle'),22).'</a>';
  2332. echo Display::div('', array('id' => 'document_result_'.$course['id'].'_0', 'class'=>'document_preview_container'));
  2333. } else {
  2334. echo '<a href="'.api_get_path(WEB_CODE_PATH).'course_info/infocours.php?cidReq='.$course['code'].'">'.Display::return_icon('edit.png', get_lang('Edit'), array('align' => 'absmiddle'),22).'</a>';
  2335. }
  2336. if ($course['status'] == COURSEMANAGER) {
  2337. //echo Display::return_icon('teachers.gif', get_lang('Status').': '.get_lang('Teacher'), array('style'=>'width: 11px; height: 11px;'));
  2338. }
  2339. echo '</div>';
  2340. } else {
  2341. echo '<div style="float:right;">';
  2342. if ($load_dirs) {
  2343. echo '<a id="document_preview_'.$course['id'].'_0" class="document_preview" href="javascript:void();">'.Display::return_icon('folder.png', get_lang('Documents'), array('align' => 'absmiddle'),22).'</a>';
  2344. echo Display::div('', array('id' => 'document_result_'.$course['id'].'_0', 'class'=>'document_preview_container'));
  2345. }
  2346. echo '</div>';
  2347. }
  2348. $course_visibility = $course['visibility'];
  2349. if ($course_visibility != COURSE_VISIBILITY_CLOSED || $course['status'] == COURSEMANAGER) {
  2350. $course_title = '<a href="'.api_get_path(WEB_COURSE_PATH).$course['directory'].'/?id_session=0&amp;autoreg=1">'.$course['title'].'</a>';
  2351. } else {
  2352. $course_title = $course['title']." ".Display::tag('span',get_lang('CourseClosed'), array('class'=>'item_closed'));
  2353. }
  2354. echo '<div style="float: left; margin-right: 10px;">'.$status_icon.'</div><span class="userportal-course-item-title">'.$course_title.'</span><br />';
  2355. if (api_get_setting('display_coursecode_in_courselist') == 'true') {
  2356. echo $course['visual_code'];
  2357. }
  2358. if (api_get_setting('display_coursecode_in_courselist') == 'true' && api_get_setting('display_teacher_in_courselist') == 'true') {
  2359. echo ' - ';
  2360. }
  2361. if (api_get_setting('display_teacher_in_courselist') == 'true') {
  2362. echo $course['tutor'];
  2363. }
  2364. echo '&nbsp;';
  2365. echo Display::return_icon('klipper.png', get_lang('CourseAutoRegister'));
  2366. // Show notifications.
  2367. echo $show_notification;
  2368. echo '</div>';
  2369. $key++;
  2370. }
  2371. }
  2372. }
  2373. }
  2374. /**
  2375. * Display courses (without special courses) as several HTML divs
  2376. * of course categories, as class userportal-catalog-item.
  2377. * @uses display_courses_in_category() to display the courses themselves
  2378. * @param int user id
  2379. * @param bool Whether to show the document quick-loader or not
  2380. * @return void
  2381. */
  2382. function display_courses($user_id, $load_dirs = false) {
  2383. global $_user, $_configuration;
  2384. // Building an array that contains all the id's of the user defined course categories.
  2385. // Initially this was inside the display_courses_in_category function but when we do it here we have fewer
  2386. // sql executions = performance increase.
  2387. $all_user_categories = self :: get_user_course_categories();
  2388. // Step 0: We display the course without a user category.
  2389. self :: display_courses_in_category(0, $load_dirs);
  2390. // Step 1: We get all the categories of the user.
  2391. $tucc = Database::get_user_personal_table(TABLE_USER_COURSE_CATEGORY);
  2392. $sql = "SELECT id, title FROM $tucc WHERE user_id='".$_user['user_id']."' ORDER BY sort ASC";
  2393. $result = Database::query($sql);
  2394. while ($row = Database::fetch_array($result)) {
  2395. // We simply display the title of the category.
  2396. echo '<div class="userportal-catalog-item">';
  2397. echo '<ul class="catalog_box">';
  2398. echo '<li>';
  2399. echo Display::return_icon('folder_yellow.png', get_lang('Category'), array('width' => '48px', 'align' => 'absmiddle'));
  2400. echo '<span>';
  2401. echo '<a name="category'.$row['id'].'"></a>'; // Display an internal anchor.
  2402. echo $row['title'];
  2403. echo '</span>';
  2404. echo '</li>';
  2405. self :: display_courses_in_category($row['id'], $load_dirs);
  2406. echo '</ul>';
  2407. echo '</div>';
  2408. }
  2409. }
  2410. /**
  2411. * Display courses inside a category (without special courses) as HTML dics of
  2412. * class userportal-course-item.
  2413. * @param int User category id
  2414. * @param bool Whether to show the document quick-loader or not
  2415. * @return void
  2416. */
  2417. function display_courses_in_category($user_category_id, $load_dirs = false) {
  2418. global $_user;
  2419. // Table definitions
  2420. $TABLECOURS = Database :: get_main_table(TABLE_MAIN_COURSE);
  2421. $TABLECOURSUSER = Database :: get_main_table(TABLE_MAIN_COURSE_USER);
  2422. $TABLE_ACCESS_URL_REL_COURSE = Database :: get_main_table(TABLE_MAIN_ACCESS_URL_REL_COURSE);
  2423. $TABLE_USER_COURSE_CATEGORY = Database :: get_user_personal_table(TABLE_USER_COURSE_CATEGORY);
  2424. $current_url_id = api_get_current_access_url_id();
  2425. // Get course list auto-register
  2426. $special_course_list = self::get_special_course_list();
  2427. $without_special_courses = '';
  2428. if (!empty($special_course_list)) {
  2429. $without_special_courses = ' AND course.code NOT IN ("'.implode('","',$special_course_list).'")';
  2430. }
  2431. $sql_select_courses = "SELECT course.id, course.code, course.visual_code, course.subscribe subscr, course.unsubscribe unsubscr,
  2432. course.title title, course.tutor_name tutor, course.db_name, course.directory, course_rel_user.status status,
  2433. course_rel_user.sort sort, course_rel_user.user_course_cat user_course_cat, course.visibility
  2434. FROM $TABLECOURS course,
  2435. $TABLECOURSUSER course_rel_user, ".$TABLE_ACCESS_URL_REL_COURSE." url
  2436. WHERE course.code = course_rel_user.course_code AND url.course_code = course.code
  2437. AND course_rel_user.user_id = '".$_user['user_id']."'
  2438. AND course_rel_user.relation_type<>".COURSE_RELATION_TYPE_RRHH."
  2439. AND course_rel_user.user_course_cat='".$user_category_id."' $without_special_courses ";
  2440. // If multiple URL access mode is enabled, only fetch courses
  2441. // corresponding to the current URL.
  2442. if (api_get_multiple_access_url() && $current_url_id != -1){
  2443. $sql_select_courses .= " AND url.course_code=course.code AND access_url_id='".$current_url_id."'";
  2444. }
  2445. // Use user's classification for courses (if any).
  2446. $sql_select_courses .= " ORDER BY course_rel_user.user_course_cat, course_rel_user.sort ASC";
  2447. $result = Database::query($sql_select_courses);
  2448. $number_of_courses = Database::num_rows($result);
  2449. $key = 0;
  2450. $status_icon = '';
  2451. // Browse through all courses.
  2452. while ($course = Database::fetch_array($result)) {
  2453. // Get notifications.
  2454. $my_course = array();
  2455. $my_course['db'] = $course['db_name'];
  2456. $my_course['k'] = $course['code'];
  2457. $my_course['id_session'] = null;
  2458. $my_course['s'] = $course['status'];
  2459. // For each course, get if there is any notification icon to show
  2460. // (something that would have changed since the user's last visit).
  2461. $show_notification = Display :: show_notification($my_course);
  2462. // New code displaying the user's status in respect to this course.
  2463. $status_icon = Display::return_icon('blackboard.png', get_lang('Course'), array('width' => '48px'));
  2464. echo '<div class="userportal-course-item">';
  2465. if (api_is_platform_admin()) {
  2466. echo '<div style="float:right;">';
  2467. if ($load_dirs) {
  2468. echo '<a id="document_preview_'.$course['id'].'_0" class="document_preview" href="javascript:void();">'.Display::return_icon('folder.png', get_lang('Documents'), array('align' => 'absmiddle'),22).'</a>';
  2469. echo '<a href="'.api_get_path(WEB_CODE_PATH).'course_info/infocours.php?cidReq='.$course['code'].'">'.Display::return_icon('edit.png', get_lang('Edit'), array('align' => 'absmiddle'),22).'</a>';
  2470. echo Display::div('', array('id' => 'document_result_'.$course['id'].'_0', 'class'=>'document_preview_container'));
  2471. } else {
  2472. echo '<a href="'.api_get_path(WEB_CODE_PATH).'course_info/infocours.php?cidReq='.$course['code'].'">'.Display::return_icon('edit.png', get_lang('Edit'), array('align' => 'absmiddle'),22).'</a>';
  2473. }
  2474. if ($course['status'] == COURSEMANAGER) {
  2475. //echo Display::return_icon('teachers.gif', get_lang('Status').': '.get_lang('Teacher'), array('style'=>'width: 11px; height: 11px;'));
  2476. }
  2477. echo '</div>';
  2478. } else {
  2479. echo '<div style="float:right;">';
  2480. if ($load_dirs) {
  2481. echo '<a id="document_preview_'.$course['id'].'_0" class="document_preview" href="javascript:void();">'.Display::return_icon('folder.png', get_lang('Documents'), array('align' => 'absmiddle'),22).'</a>';
  2482. echo Display::div('', array('id' => 'document_result_'.$course['id'].'_0', 'class'=>'document_preview_container'));
  2483. }
  2484. echo '</div>';
  2485. }
  2486. // Function logic - act on the data (check if the course is virtual, if yes change the link).
  2487. $is_virtual_course = CourseManager :: is_virtual_course_from_system_code($course['code']);
  2488. if ($is_virtual_course) {
  2489. // If the current user is also subscribed in the real course to which this
  2490. // virtual course is linked, we don't need to display the virtual course entry in
  2491. // the course list - it is combined with the real course entry.
  2492. $target_course_code = CourseManager :: get_target_of_linked_course($course['code']);
  2493. $is_subscribed_in_target_course = CourseManager :: is_user_subscribed_in_course(api_get_user_id(), $target_course_code);
  2494. if ($is_subscribed_in_target_course) {
  2495. return; // Do not display this course entry.
  2496. }
  2497. }
  2498. // Check if the course has virtual courses attached. If yes change the course title and display code.
  2499. $has_virtual_courses = CourseManager :: has_virtual_courses_from_code($course['code'], api_get_user_id());
  2500. if ($has_virtual_courses) {
  2501. $course_info = api_get_course_info($course['code']);
  2502. $return_result = CourseManager :: determine_course_title_from_course_info(api_get_user_id(), $course_info);
  2503. $course_title = $return_result['title'];
  2504. $course_display_code = $return_result['code'];
  2505. } else {
  2506. $course_title = $course['title'];
  2507. $course_display_code = $course['visual_code'];
  2508. }
  2509. // Show a hyperlink to the course, unless the course is closed and user is not course admin.
  2510. $course_visibility = $course['visibility'];
  2511. $course_title_url = '';
  2512. if ($course_visibility != COURSE_VISIBILITY_CLOSED || $course['status'] == COURSEMANAGER) {
  2513. $course_title_url = api_get_path(WEB_COURSE_PATH).$course['directory'].'/?id_session=0';
  2514. $course_title = Display::url($course['title'], $course_title_url);
  2515. } else {
  2516. $course_title = $course['title']." ".Display::tag('span',get_lang('CourseClosed'), array('class'=>'item_closed'));
  2517. }
  2518. if (!empty($course_title_url)) {
  2519. $status_icon = Display::url($status_icon, $course_title_url);
  2520. }
  2521. // Start displaying the course block itself.
  2522. echo '<div style="float: left; margin-right: 10px;">'.$status_icon.'</div><span class="userportal-course-item-title">'.$course_title.'</span><br />';
  2523. if (api_get_setting('display_coursecode_in_courselist') == 'true') {
  2524. echo $course_display_code;
  2525. }
  2526. if (api_get_setting('display_coursecode_in_courselist') == 'true' && api_get_setting('display_teacher_in_courselist') == 'true') {
  2527. echo ' - ';
  2528. }
  2529. if (api_get_setting('display_teacher_in_courselist') == 'true') {
  2530. if (!empty($course['tutor']))
  2531. echo $course['tutor'];
  2532. }
  2533. // Show notifications.
  2534. echo $show_notification;
  2535. echo '</div>';
  2536. $key++;
  2537. }
  2538. }
  2539. /**
  2540. * Retrieves the user defined course categories
  2541. * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
  2542. * @return array containing all the titles of the user defined courses with the id as key of the array
  2543. */
  2544. function get_user_course_categories() {
  2545. global $_user;
  2546. $output = array();
  2547. $table_category = Database::get_user_personal_table(TABLE_USER_COURSE_CATEGORY);
  2548. $sql = "SELECT * FROM ".$table_category." WHERE user_id='".Database::escape_string($_user['user_id'])."'";
  2549. $result = Database::query($sql);
  2550. while ($row = Database::fetch_array($result)) {
  2551. $output[$row['id']] = $row['title'];
  2552. }
  2553. return $output;
  2554. }
  2555. /**
  2556. * Get the course id based on the original id and field name in the extra fields. Returns 0 if course was not found
  2557. *
  2558. * @param string Original course id
  2559. * @param string Original field name
  2560. * @return int Course id
  2561. */
  2562. public static function get_course_id_from_original_id($original_course_id_value, $original_course_id_name) {
  2563. $t_cfv = Database::get_main_table(TABLE_MAIN_COURSE_FIELD_VALUES);
  2564. $table_field = Database::get_main_table(TABLE_MAIN_COURSE_FIELD);
  2565. $sql_course = "SELECT id FROM $table_field cf INNER JOIN $t_cfv cfv ON cfv.field_id=cf.id WHERE field_variable='$original_course_id_name' AND field_value='$original_course_id_value'";
  2566. $res = Database::query($sql_course);
  2567. $row = Database::fetch_object($res);
  2568. if($row != false) {
  2569. return $row->id;
  2570. } else {
  2571. return 0;
  2572. }
  2573. }
  2574. /**
  2575. * Display code for one specific course a logged in user is subscribed to.
  2576. * Shows a link to the course, what's new icons...
  2577. *
  2578. * $my_course['d'] - course directory
  2579. * $my_course['i'] - course title
  2580. * $my_course['c'] - visual course code
  2581. * $my_course['k'] - system course code
  2582. * $my_course['db'] - course database
  2583. *
  2584. * @param array Course details
  2585. * @param integer Session ID
  2586. * @param string CSS class to apply to course entry
  2587. * @param boolean Whether the session is supposedly accessible now (not in the case it has passed and is in invisible/unaccessible mode)
  2588. * @param bool Whether to show the document quick-loader or not
  2589. * @return string The HTML to be printed for the course entry
  2590. *
  2591. * @version 1.0.3
  2592. * @todo refactor into different functions for database calls | logic | display
  2593. * @todo replace single-character $my_course['d'] indices
  2594. * @todo move code for what's new icons to a separate function to clear things up
  2595. * @todo add a parameter user_id so that it is possible to show the courselist of other users (=generalisation). This will prevent having to write a new function for this.
  2596. */
  2597. function get_logged_user_course_html($course, $session_id = 0, $class = 'courses', $session_accessible = true, $load_dirs = false) {
  2598. global $nosession, $nbDigestEntries, $digest, $thisCourseSysCode, $orderKey;
  2599. $charset = api_get_system_encoding();
  2600. $current_uid = api_get_user_id();
  2601. $info = api_get_course_info($course['code']);
  2602. $status_course = CourseManager::get_user_in_course_status($current_uid, $course['code']);
  2603. if (!is_array($course['code'])) {
  2604. $my_course = api_get_course_info($course['code']);
  2605. $my_course['k'] = $my_course['id'];
  2606. $my_course['db'] = $my_course['dbName'];
  2607. $my_course['c'] = $my_course['official_code'];
  2608. $my_course['i'] = $my_course['name'];
  2609. $my_course['d'] = $my_course['path'];
  2610. $my_course['t'] = $my_course['titular'];
  2611. $my_course['id_session'] = $session_id;
  2612. $my_course['status'] = empty($session_id) ? $status_course : 5;
  2613. }
  2614. if (api_get_setting('use_session_mode') == 'true' && !$nosession) {
  2615. global $now, $date_start, $date_end;
  2616. }
  2617. // Initialise.
  2618. $result = '';
  2619. // Table definitions
  2620. //$statistic_database = Database::get_statistic_database();
  2621. $main_user_table = Database :: get_main_table(TABLE_MAIN_USER);
  2622. $tbl_session = Database :: get_main_table(TABLE_MAIN_SESSION);
  2623. $tbl_session_category = Database :: get_main_table(TABLE_MAIN_SESSION_CATEGORY);
  2624. $course_database = $my_course['db'];
  2625. $course_tool_table = Database :: get_course_table(TABLE_TOOL_LIST, $course_database);
  2626. $tool_edit_table = Database :: get_course_table(TABLE_ITEM_PROPERTY, $course_database);
  2627. $course_group_user_table = Database :: get_course_table(TOOL_USER, $course_database);
  2628. $user_id = api_get_user_id();
  2629. $course_system_code = $my_course['k'];
  2630. $course_visual_code = $my_course['c'];
  2631. $course_title = $my_course['i'];
  2632. $course_directory = $my_course['d'];
  2633. $course_teacher = $my_course['t'];
  2634. $course_teacher_email = isset($my_course['email']) ? $my_course['email'] : '';
  2635. $course_info = Database :: get_course_info($course_system_code);
  2636. $course_access_settings = CourseManager :: get_access_settings($course_system_code);
  2637. $course_id = isset($course_info['course_id']) ? $course_info['course_id'] : null;
  2638. $course_visibility = $course_access_settings['visibility'];
  2639. $user_in_course_status = CourseManager :: get_user_in_course_status(api_get_user_id(), $course_system_code);
  2640. // Function logic - act on the data.
  2641. $is_virtual_course = CourseManager :: is_virtual_course_from_system_code($my_course['k']);
  2642. if ($is_virtual_course) {
  2643. // If the current user is also subscribed in the real course to which this
  2644. // virtual course is linked, we don't need to display the virtual course entry in
  2645. // the course list - it is combined with the real course entry.
  2646. $target_course_code = CourseManager :: get_target_of_linked_course($course_system_code);
  2647. $is_subscribed_in_target_course = CourseManager :: is_user_subscribed_in_course(api_get_user_id(), $target_course_code);
  2648. if ($is_subscribed_in_target_course) {
  2649. return; //do not display this course entry
  2650. }
  2651. }
  2652. $has_virtual_courses = CourseManager :: has_virtual_courses_from_code($course_system_code, api_get_user_id());
  2653. if ($has_virtual_courses) {
  2654. $return_result = CourseManager :: determine_course_title_from_course_info(api_get_user_id(), $course_info);
  2655. $course_display_title = $return_result['title'];
  2656. $course_display_code = $return_result['code'];
  2657. } else {
  2658. $course_display_title = $course_title;
  2659. $course_display_code = $course_visual_code;
  2660. }
  2661. $s_course_status = $my_course['status'];
  2662. $is_coach = api_is_coach($my_course['id_session'], $course['code']);
  2663. $s_htlm_status_icon = Display::return_icon('blackboard_blue.png', get_lang('Course'), array('width' => '48px'));
  2664. /*
  2665. if ($s_course_status == 1) {
  2666. $s_htlm_status_icon = Display::return_icon('course.gif', get_lang('Course')).' '.Display::return_icon('teachers.gif', get_lang('Status').': '.get_lang('Teacher'), array('style' => 'width: 11px; height: 11px;'));
  2667. }
  2668. if ($s_course_status == 2 || ($is_coach && $s_course_status != 1)) {
  2669. $s_htlm_status_icon = Display::return_icon('course.gif', get_lang('Course')).' '.Display::return_icon('coachs.gif', get_lang('Status').': '.get_lang('GeneralCoach'), array('style' => 'width: 11px; height: 11px;'));
  2670. }
  2671. if (($s_course_status == 5 && !$is_coach) || empty($s_course_status)) {
  2672. $s_htlm_status_icon = Display::return_icon('course.gif', get_lang('Course')).' '.Display::return_icon('students.gif', get_lang('Status').': '.get_lang('Student'), array('style' => 'width: 11px; height: 11px;'));
  2673. }
  2674. */
  2675. // Display course entry.
  2676. // Show a hyperlink to the course, unless the course is closed and user is not course admin.
  2677. $session_url = '';
  2678. $session_title = '';
  2679. if ($session_accessible) {
  2680. if ($course_visibility != COURSE_VISIBILITY_CLOSED || $user_in_course_status == COURSEMANAGER) {
  2681. if (api_get_setting('use_session_mode') == 'true' && !$nosession) {
  2682. if (empty($my_course['id_session'])) {
  2683. $my_course['id_session'] = 0;
  2684. }
  2685. if ($user_in_course_status == COURSEMANAGER || ($date_start <= $now && $date_end >= $now) || $date_start == '0000-00-00') {
  2686. $session_url = api_get_path(WEB_COURSE_PATH).$course_directory.'/?id_session='.$my_course['id_session'];
  2687. $session_title = '<a href="'.api_get_path(WEB_COURSE_PATH).$course_directory.'/?id_session='.$my_course['id_session'].'">'.$course_display_title.'</a>';
  2688. }
  2689. } else {
  2690. $session_url = api_get_path(WEB_COURSE_PATH).$course_directory.'/';
  2691. $session_title = '<a href="'.api_get_path(WEB_COURSE_PATH).$course_directory.'/">'.$course_display_title.'</a>';
  2692. }
  2693. } else {
  2694. $session_title = $course_display_title.' '.Display::tag('span',get_lang('CourseClosed'), array('class'=>'item_closed'));
  2695. }
  2696. } else {
  2697. $session_title = $course_display_title;
  2698. }
  2699. if (!empty($session_url)) {
  2700. $s_htlm_status_icon = Display::url($s_htlm_status_icon, $session_url);
  2701. }
  2702. $result .= '<li class="'.$class.'"><div class="coursestatusicons">'.$s_htlm_status_icon.'</div>';
  2703. $result .= $session_title;
  2704. if ($load_dirs) {
  2705. $result .= '<div style="float:right;">';
  2706. $result .= '<a id="document_preview_'.$info['real_id'].'_'.$my_course['id_session'].'" class="document_preview" href="javascript:void();">'.Display::return_icon('folder.png', get_lang('Documents'), array('align' => 'absmiddle'),22).'</a>';
  2707. $result .= Display::div('', array('id' => 'document_result_'.$info['real_id'].'_'.$my_course['id_session'], 'class'=>'document_preview_container'));
  2708. $result .= '</div>';
  2709. }
  2710. // Show the course_code and teacher if chosen to display this.
  2711. if (api_get_setting('display_coursecode_in_courselist') == 'true' || api_get_setting('display_teacher_in_courselist') == 'true') {
  2712. $result .= '<br />';
  2713. }
  2714. if (api_get_setting('display_coursecode_in_courselist') == 'true') {
  2715. $result .= $course_display_code;
  2716. }
  2717. if (api_get_setting('display_teacher_in_courselist') == 'true') {
  2718. if (api_get_setting('use_session_mode')=='true' && !$nosession) {
  2719. $coachs_course = api_get_coachs_from_course($my_course['id_session'], $course['code']);
  2720. $course_coachs = array();
  2721. if (is_array($coachs_course)) {
  2722. foreach ($coachs_course as $coach_course) {
  2723. $course_coachs[] = api_get_person_name($coach_course['firstname'], $coach_course['lastname']);
  2724. }
  2725. }
  2726. if ($s_course_status == 1 || ($s_course_status == 5 && empty($my_course['id_session'])) || empty($s_course_status)) {
  2727. $result .= $course_teacher;
  2728. }
  2729. if (($s_course_status == 5 && !empty($my_course['id_session'])) || ($is_coach && $s_course_status != 1)) {
  2730. if (is_array($course_coachs) && count($course_coachs)> 0 ) {
  2731. if (api_get_setting('display_coursecode_in_courselist') == 'true' && api_get_setting('display_teacher_in_courselist') == 'true') {
  2732. $result .= ' &ndash; ';
  2733. }
  2734. $result .= get_lang('Coachs').': '.implode(', ',$course_coachs);
  2735. }
  2736. }
  2737. } else {
  2738. $result .= $course_teacher;
  2739. }
  2740. if(!empty($course_teacher_email)) {
  2741. $result .= ' ('.$course_teacher_email.')';
  2742. }
  2743. }
  2744. $result .= isset($course['special_course']) ? ' '.Display::return_icon('klipper.png', get_lang('CourseAutoRegister')) : '';
  2745. $current_course_settings = CourseManager :: get_access_settings($my_course['k']);
  2746. // Display the "what's new" icons.
  2747. $result .= Display :: show_notification($my_course);
  2748. if ((CONFVAL_showExtractInfo == SCRIPTVAL_InCourseList || CONFVAL_showExtractInfo == SCRIPTVAL_Both) && $nbDigestEntries > 0) {
  2749. reset($digest);
  2750. $result .= '
  2751. <ul>';
  2752. while (list($key2) = each($digest[$thisCourseSysCode])) {
  2753. $result .= '<li>';
  2754. if ($orderKey[1] == 'keyTools') {
  2755. $result .= "<a href=\"$toolsList[$key2] [\"path\"] $thisCourseSysCode \">";
  2756. $result .= "$toolsList[$key2][\"name\"]</a>";
  2757. } else {
  2758. $result .= api_convert_and_format_date($key2, DATE_FORMAT_LONG, date_default_timezone_get());
  2759. }
  2760. $result .= '</li>';
  2761. $result .= '<ul>';
  2762. reset ($digest[$thisCourseSysCode][$key2]);
  2763. while (list ($key3, $dataFromCourse) = each($digest[$thisCourseSysCode][$key2])) {
  2764. $result .= '<li>';
  2765. if ($orderKey[2] == 'keyTools') {
  2766. $result .= "<a href=\"$toolsList[$key3] [\"path\"] $thisCourseSysCode \">";
  2767. $result .= "$toolsList[$key3][\"name\"]</a>";
  2768. } else {
  2769. $result .= api_convert_and_format_date($key3, DATE_FORMAT_LONG, date_default_timezone_get());
  2770. }
  2771. $result .= '<ul compact="compact">';
  2772. reset($digest[$thisCourseSysCode][$key2][$key3]);
  2773. while (list ($key4, $dataFromCourse) = each($digest[$thisCourseSysCode][$key2][$key3])) {
  2774. $result .= '<li>';
  2775. $result .= @htmlspecialchars(api_substr(strip_tags($dataFromCourse), 0, CONFVAL_NB_CHAR_FROM_CONTENT), ENT_QUOTES, $charset);
  2776. $result .= '</li>';
  2777. }
  2778. $result .= '</ul>';
  2779. $result .= '</li>';
  2780. }
  2781. $result .= '</ul>';
  2782. $result .= '</li>';
  2783. }
  2784. $result .= '</ul>';
  2785. }
  2786. $result .= '</li>';
  2787. $session_category_id = null;
  2788. if (api_get_setting('use_session_mode') == 'true' && !$nosession) {
  2789. $session = '';
  2790. $active = false;
  2791. if (!empty($my_course['session_name'])) {
  2792. // Request for the name of the general coach
  2793. $sql = 'SELECT lastname, firstname,sc.name
  2794. FROM '.$tbl_session.' ts
  2795. LEFT JOIN '.$main_user_table .' tu
  2796. ON ts.id_coach = tu.user_id
  2797. INNER JOIN '.$tbl_session_category.' sc ON ts.session_category_id = sc.id
  2798. WHERE ts.id='.(int) $my_course['id_session']. ' LIMIT 1';
  2799. $rs = Database::query($sql);
  2800. $sessioncoach = Database::store_result($rs);
  2801. $sessioncoach = $sessioncoach[0];
  2802. $session = array();
  2803. $session['title'] = $my_course['session_name'];
  2804. $session_category_id = CourseManager::get_session_category_id_by_session_id($my_course['id_session']);
  2805. $session['category'] = $sessioncoach['name'];
  2806. if ($my_course['date_start'] == '0000-00-00') {
  2807. //$session['dates'] = get_lang('WithoutTimeLimits');
  2808. $session['dates'] = '';
  2809. if (api_get_setting('show_session_coach') === 'true') {
  2810. $session['coach'] = get_lang('GeneralCoach').': '.api_get_person_name($sessioncoach['firstname'], $sessioncoach['lastname']);
  2811. }
  2812. $active = true;
  2813. } else {
  2814. $session ['dates'] = ' - '.get_lang('From').' '.$my_course['date_start'].' '.get_lang('To').' '.$my_course['date_end'];
  2815. if (api_get_setting('show_session_coach') === 'true') {
  2816. $session['coach'] = get_lang('GeneralCoach').': '.api_get_person_name($sessioncoach['firstname'], $sessioncoach['lastname']);
  2817. }
  2818. $active = ($date_start <= $now && $date_end >= $now);
  2819. }
  2820. }
  2821. $user_course_category = '';
  2822. if (isset($my_course['user_course_cat'])) {
  2823. $user_course_category = $my_course['user_course_cat'];
  2824. }
  2825. $output = array ($user_course_category, $result, $my_course['id_session'], $session, 'active' => $active, 'session_category_id' => $session_category_id);
  2826. } else {
  2827. $output = array ($my_course['user_course_cat'], $result);
  2828. }
  2829. return $output;
  2830. }
  2831. /**
  2832. *
  2833. * @param string source course code
  2834. * @param int source session id
  2835. * @param string destination course code
  2836. * @param int destination session id
  2837. * @return bool
  2838. */
  2839. function copy_course($source_course_code, $source_session_id, $destination_course_code, $destination_session_id, $params = array()) {
  2840. require_once api_get_path(SYS_CODE_PATH).'coursecopy/classes/CourseBuilder.class.php';
  2841. require_once api_get_path(SYS_CODE_PATH).'coursecopy/classes/CourseRestorer.class.php';
  2842. require_once api_get_path(SYS_CODE_PATH).'coursecopy/classes/CourseSelectForm.class.php';
  2843. $course_info = api_get_course_info($source_course_code);
  2844. if (!empty($course_info)) {
  2845. $cb = new CourseBuilder('', $course_info);
  2846. $course = $cb->build($source_session_id, $source_course_code, true);
  2847. $course_restorer = new CourseRestorer($course);
  2848. $course_restorer->skip_content = $params;
  2849. $course_restorer->restore($destination_course_code, $destination_session_id, true, true);
  2850. return true;
  2851. }
  2852. return false;
  2853. }
  2854. /**
  2855. * A simpler version of the copy_course, the function creates an empty course with an autogenerated course code
  2856. *
  2857. * @param string new course title
  2858. * @param string source course code
  2859. * @param int source session id
  2860. * @param int destination session id
  2861. * @param bool new copied tools (Exercises and LPs)will be set to invisible by default?
  2862. *
  2863. * @return array
  2864. */
  2865. function copy_course_simple($new_title, $source_course_code, $source_session_id = 0, $destination_session_id = 0, $params = array()) {
  2866. $source_course_info = api_get_course_info($source_course_code);
  2867. if (!empty($source_course_info)) {
  2868. $new_course_code = self::generate_nice_next_course_code($source_course_code);
  2869. if ($new_course_code) {
  2870. $new_course_info = self::create_course($new_title, $new_course_code, false);
  2871. if (!empty($new_course_info['code'])) {
  2872. $result = self::copy_course($source_course_code, $source_session_id, $new_course_info['code'], $destination_session_id, $params);
  2873. if ($result) {
  2874. return $new_course_info;
  2875. }
  2876. }
  2877. }
  2878. }
  2879. return false;
  2880. }
  2881. /**
  2882. * Creates a new course code based in given code
  2883. *
  2884. * @param string wanted code
  2885. * <code> $wanted_code = 'curse' if there are in the DB codes like curse1 curse2 the function will return: course3</code>
  2886. * if the course code doest not exist in the DB the same course code will be returned
  2887. * @return string wanted unused code
  2888. */
  2889. function generate_nice_next_course_code($wanted_code) {
  2890. require_once api_get_path(LIBRARY_PATH).'add_course.lib.inc.php';
  2891. $course_code_ok = !self::course_code_exists($wanted_code);
  2892. if (!$course_code_ok) {
  2893. $wanted_code = generate_course_code($wanted_code);
  2894. $table = Database::get_main_table(TABLE_MAIN_COURSE);
  2895. $wanted_code = Database::escape_string($wanted_code);
  2896. $sql = "SELECT count(*) as count FROM $table WHERE code LIKE '$wanted_code%'";
  2897. $result = Database::query($sql);
  2898. if (Database::num_rows($result) > 0 ) {
  2899. $row = Database::fetch_array($result);
  2900. $count = $row['count'] + 1;
  2901. $wanted_code = $wanted_code.'_'.$count;
  2902. $result = api_get_course_info($wanted_code);
  2903. if (empty($result)) {
  2904. return $wanted_code;
  2905. }
  2906. }
  2907. return false;
  2908. }
  2909. return $wanted_code;
  2910. }
  2911. /**
  2912. * Creates a course very fast (the function doesn't need a lot of parameters)
  2913. *
  2914. * @param string course title
  2915. * @param bool add example content or not
  2916. * @param mixed false if the course was not created, array with the course info
  2917. *
  2918. Coded found in create_course/add_course.php
  2919. */
  2920. function create_course($title, $wanted_code = '', $exemplary_content = false) {
  2921. require_once api_get_path(LIBRARY_PATH).'add_course.lib.inc.php';
  2922. global $_configuration, $firstExpirationDelay;
  2923. if (empty($title)) {
  2924. return false;
  2925. }
  2926. if (empty($wanted_code)) {
  2927. $wanted_code = $title;
  2928. // Check whether the requested course code has already been occupied.
  2929. $dbnamelength = strlen($_configuration['db_prefix']);
  2930. // Ensure the database prefix + database name do not get over 40 characters.
  2931. $maxlength = 40 - $dbnamelength;
  2932. $wanted_code = generate_course_code(api_substr($title, 0, $maxlength));
  2933. }
  2934. // Create the course immediately
  2935. $keys = define_course_keys($wanted_code, '', $_configuration['db_prefix']);
  2936. if (count($keys)) {
  2937. $visual_code = $keys['currentCourseCode'];
  2938. $code = $keys['currentCourseId'];
  2939. $db_name = $keys['currentCourseDbName'];
  2940. $directory = $keys['currentCourseRepository'];
  2941. $code_info = api_get_course_info($code);
  2942. if (empty($code_info)) {
  2943. $expiration_date = time() + $firstExpirationDelay;
  2944. prepare_course_repository($directory, $code);
  2945. update_Db_course($db_name);
  2946. $pictures_array = fill_course_repository($directory, $exemplary_content);
  2947. fill_Db_course($db_name, $directory, $course_language, $pictures_array, $exemplary_content);
  2948. $course_language = api_get_setting('platformLanguage');
  2949. $result = register_course($code, $visual_code, $directory, $db_name, '', '', $title, $course_language, api_get_user_id(), $expiration_date);
  2950. $course_info = api_get_course_info($code);
  2951. if (!empty($course_info)) {
  2952. return $course_info;
  2953. }
  2954. }
  2955. }
  2956. return false;
  2957. }
  2958. } //end class CourseManager