course.lib.php 200 KB

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