course.lib.php 183 KB

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