course.lib.php 170 KB

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