course.lib.php 214 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587
  1. <?php
  2. /* For licensing terms, see /license.txt*/
  3. use Chamilo\CoreBundle\Entity\ExtraField as EntityExtraField;
  4. /**
  5. * Class CourseManager
  6. *
  7. * This is the course library for Chamilo.
  8. *
  9. * All main course functions should be placed here.
  10. *
  11. * Many functions of this library deal with providing support for
  12. * virtual/linked/combined courses (this was already used in several universities
  13. * but not available in standard Chamilo).
  14. *
  15. * The implementation changed, initially a course was a real course
  16. * if target_course_code was 0 , this was changed to NULL.
  17. * There are probably some places left with the wrong code.
  18. *
  19. * @package chamilo.library
  20. */
  21. class CourseManager
  22. {
  23. const MAX_COURSE_LENGTH_CODE = 40;
  24. /** This constant is used to show separate user names in the course
  25. * list (userportal), footer, etc */
  26. const USER_SEPARATOR = ' |';
  27. const COURSE_FIELD_TYPE_CHECKBOX = 10;
  28. public $columns = array();
  29. /**
  30. * Creates a course
  31. * @param array $params columns in the main.course table
  32. *
  33. * @return mixed false if the course was not created, array with the course info
  34. */
  35. public static function create_course($params, $extraFields = array())
  36. {
  37. global $_configuration;
  38. // Check portal limits
  39. $access_url_id = 1;
  40. if (api_get_multiple_access_url()) {
  41. $access_url_id = api_get_current_access_url_id();
  42. }
  43. if (isset($_configuration[$access_url_id]) &&
  44. is_array($_configuration[$access_url_id])
  45. ) {
  46. if (isset($_configuration[$access_url_id]['hosting_limit_courses']) &&
  47. $_configuration[$access_url_id]['hosting_limit_courses'] > 0
  48. ) {
  49. $num = self::count_courses($access_url_id);
  50. if ($num >= $_configuration[$access_url_id]['hosting_limit_courses']) {
  51. api_warn_hosting_contact('hosting_limit_courses');
  52. return api_set_failure(get_lang('PortalCoursesLimitReached'));
  53. }
  54. }
  55. if (isset($_configuration[$access_url_id]['hosting_limit_active_courses']) &&
  56. $_configuration[$access_url_id]['hosting_limit_active_courses'] > 0
  57. ) {
  58. $num = self::countActiveCourses($access_url_id);
  59. if ($num >= $_configuration[$access_url_id]['hosting_limit_active_courses']) {
  60. api_warn_hosting_contact('hosting_limit_active_courses');
  61. return api_set_failure(
  62. get_lang('PortalActiveCoursesLimitReached')
  63. );
  64. }
  65. }
  66. }
  67. if (empty($params['title'])) {
  68. return false;
  69. }
  70. if (empty($params['wanted_code'])) {
  71. $params['wanted_code'] = $params['title'];
  72. // Check whether the requested course code has already been occupied.
  73. $params['wanted_code'] = CourseManager::generate_course_code(
  74. api_substr($params['title'], 0, self::MAX_COURSE_LENGTH_CODE)
  75. );
  76. }
  77. // Create the course keys
  78. $keys = AddCourse::define_course_keys($params['wanted_code']);
  79. $params['exemplary_content'] = isset($params['exemplary_content']) ? $params['exemplary_content'] : false;
  80. if (count($keys)) {
  81. $params['code'] = $keys['currentCourseCode'];
  82. $params['visual_code'] = $keys['currentCourseId'];
  83. $params['directory'] = $keys['currentCourseRepository'];
  84. $course_info = api_get_course_info($params['code']);
  85. if (empty($course_info)) {
  86. $course_id = AddCourse::register_course($params);
  87. $course_info = api_get_course_info_by_id($course_id);
  88. if (!empty($course_info)) {
  89. AddCourse::prepare_course_repository($course_info['directory'], $course_info['code']);
  90. AddCourse::fill_db_course(
  91. $course_id,
  92. $course_info['directory'],
  93. $course_info['course_language'],
  94. $params['exemplary_content']
  95. );
  96. if (api_get_setting('gradebook_enable_grade_model') == 'true') {
  97. //Create gradebook_category for the new course and add
  98. // a gradebook model for the course
  99. if (isset($params['gradebook_model_id']) &&
  100. !empty($params['gradebook_model_id']) &&
  101. $params['gradebook_model_id'] != '-1'
  102. ) {
  103. GradebookUtils::create_default_course_gradebook(
  104. $course_info['code'],
  105. $params['gradebook_model_id']
  106. );
  107. }
  108. }
  109. // If parameter defined, copy the contents from a specific
  110. // template course into this new course
  111. $template = api_get_setting('course_creation_use_template');
  112. if (!empty($template)) {
  113. // Include the necessary libraries to generate a course copy
  114. require_once api_get_path(SYS_CODE_PATH) . 'coursecopy/classes/CourseBuilder.class.php';
  115. require_once api_get_path(SYS_CODE_PATH) . 'coursecopy/classes/CourseRestorer.class.php';
  116. require_once api_get_path(SYS_CODE_PATH) . 'coursecopy/classes/CourseSelectForm.class.php';
  117. // Call the course copy object
  118. $originCourse = api_get_course_info_by_id($template);
  119. $originCourse['official_code'] = $originCourse['code'];
  120. $cb = new CourseBuilder(null, $originCourse);
  121. $course = $cb->build(null, $originCourse['code']);
  122. $cr = new CourseRestorer($course);
  123. $cr->set_file_option();
  124. $cr->restore($course_info['id']); //course_info[id] is the course.code value (I know...)
  125. }
  126. $params['course_code'] = $course_info['code'];
  127. $courseFieldValue = new ExtraFieldValue('course');
  128. $courseFieldValue->saveFieldValues($params);
  129. return $course_info;
  130. }
  131. }
  132. }
  133. return false;
  134. }
  135. /**
  136. * Returns all the information of a given course code
  137. * @param string $course_code , the course code
  138. * @return an array with all the fields of the course table
  139. * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
  140. * @assert ('') === false
  141. */
  142. public static function get_course_information($course_code)
  143. {
  144. return Database::fetch_array(
  145. Database::query(
  146. "SELECT *, id as real_id FROM " . Database::get_main_table(TABLE_MAIN_COURSE) . "
  147. WHERE code='" . Database::escape_string($course_code) . "'"), 'ASSOC'
  148. );
  149. }
  150. /**
  151. * Returns all the information of a given coursecode
  152. * @param int the course id
  153. * @return an array with all the fields of the course table
  154. * @deprecated use api_get_course_info_by_id()
  155. * @assert ('') === false
  156. */
  157. public static function get_course_information_by_id($course_id)
  158. {
  159. return Database::select(
  160. '*, id as real_id',
  161. Database::get_main_table(TABLE_MAIN_COURSE),
  162. array('where' => array('id = ?' => intval($course_id))),
  163. 'first'
  164. );
  165. }
  166. /**
  167. * Returns a list of courses. Should work with quickform syntax
  168. * @param integer $from Offset (from the 7th = '6'). Optional.
  169. * @param integer $howmany Number of results we want. Optional.
  170. * @param int $orderby The column we want to order it by. Optional, defaults to first column.
  171. * @param string $orderdirection The direction of the order (ASC or DESC). Optional, defaults to ASC.
  172. * @param int $visibility The visibility of the course, or all by default.
  173. * @param string $startwith If defined, only return results for which the course *title* begins with this string
  174. * @param string $urlId The Access URL ID, if using multiple URLs
  175. * @param bool $alsoSearchCode An extension option to indicate that we also want to search for course codes (not *only* titles)
  176. * @param array $conditionsLike
  177. * @return array
  178. */
  179. public static function get_courses_list(
  180. $from = 0,
  181. $howmany = 0,
  182. $orderby = 1,
  183. $orderdirection = 'ASC',
  184. $visibility = -1,
  185. $startwith = '',
  186. $urlId = null,
  187. $alsoSearchCode = false,
  188. $conditionsLike = array()
  189. ) {
  190. $sql = "SELECT course.* FROM " . Database::get_main_table(TABLE_MAIN_COURSE) . " course ";
  191. if (!empty($urlId)) {
  192. $table = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_COURSE);
  193. $sql .= " INNER JOIN $table url ON (url.c_id = course.id) ";
  194. }
  195. if (!empty($startwith)) {
  196. $sql .= "WHERE (title LIKE '" . Database::escape_string($startwith) . "%' ";
  197. if ($alsoSearchCode) {
  198. $sql .= "OR code LIKE '" . Database::escape_string($startwith) . "%' ";
  199. }
  200. $sql .= ') ';
  201. if ($visibility !== -1 && $visibility == strval(intval($visibility))) {
  202. $sql .= " AND visibility = $visibility ";
  203. }
  204. } else {
  205. $sql .= "WHERE 1 ";
  206. if ($visibility !== -1 && $visibility == strval(intval($visibility))) {
  207. $sql .= " AND visibility = $visibility ";
  208. }
  209. }
  210. if (!empty($urlId)) {
  211. $urlId = intval($urlId);
  212. $sql .= " AND access_url_id= $urlId";
  213. }
  214. $allowedFields = array(
  215. 'title',
  216. 'code'
  217. );
  218. if (count($conditionsLike) > 0) {
  219. $sql .= ' AND ';
  220. $temp_conditions = array();
  221. foreach ($conditionsLike as $field => $value) {
  222. if (!in_array($field, $allowedFields)) {
  223. continue;
  224. }
  225. $field = Database::escape_string($field);
  226. $value = Database::escape_string($value);
  227. $simple_like = false;
  228. if ($simple_like) {
  229. $temp_conditions[] = $field . " LIKE '$value%'";
  230. } else {
  231. $temp_conditions[] = $field . ' LIKE \'%' . $value . '%\'';
  232. }
  233. }
  234. $condition = ' AND ';
  235. if (!empty($temp_conditions)) {
  236. $sql .= implode(' ' . $condition . ' ', $temp_conditions);
  237. }
  238. }
  239. if (!empty($orderby)) {
  240. $sql .= " ORDER BY " . Database::escape_string($orderby) . " ";
  241. } else {
  242. $sql .= " ORDER BY 1 ";
  243. }
  244. if (!in_array($orderdirection, array('ASC', 'DESC'))) {
  245. $sql .= 'ASC';
  246. } else {
  247. $sql .= ($orderdirection == 'ASC' ? 'ASC' : 'DESC');
  248. }
  249. if (!empty($howmany) && is_int($howmany) and $howmany > 0) {
  250. $sql .= ' LIMIT ' . Database::escape_string($howmany);
  251. } else {
  252. $sql .= ' LIMIT 1000000'; //virtually no limit
  253. }
  254. if (!empty($from)) {
  255. $from = intval($from);
  256. $sql .= ' OFFSET ' . intval($from);
  257. } else {
  258. $sql .= ' OFFSET 0';
  259. }
  260. return Database::store_result(Database::query($sql));
  261. }
  262. /**
  263. * Returns the access settings of the course:
  264. * which visibility;
  265. * whether subscribing is allowed;
  266. * whether unsubscribing is allowed.
  267. *
  268. * @param string $course_code , the course code
  269. * @todo for more consistency: use course_info call from database API
  270. * @return an array with int fields "visibility", "subscribe", "unsubscribe"
  271. * @assert ('') === false
  272. */
  273. public static function get_access_settings($course_code)
  274. {
  275. return Database::fetch_array(
  276. Database::query(
  277. "SELECT visibility, subscribe, unsubscribe
  278. FROM " . Database::get_main_table(TABLE_MAIN_COURSE) . "
  279. WHERE code = '" . Database::escape_string($course_code) . "'"
  280. )
  281. );
  282. }
  283. /**
  284. * Returns the status of a user in a course, which is COURSEMANAGER or STUDENT.
  285. * @param int $user_id
  286. * @param string $course_code
  287. *
  288. * @return int the status of the user in that course
  289. */
  290. public static function get_user_in_course_status($user_id, $course_code)
  291. {
  292. $courseInfo = api_get_course_info($course_code);
  293. $courseId = $courseInfo['real_id'];
  294. $result = Database::fetch_array(
  295. Database::query(
  296. "SELECT status FROM " . Database::get_main_table(TABLE_MAIN_COURSE_USER) . "
  297. WHERE
  298. c_id = $courseId AND
  299. user_id = " . intval($user_id)
  300. )
  301. );
  302. return $result['status'];
  303. }
  304. /**
  305. * @param int $userId
  306. * @param int $courseId
  307. *
  308. * @return mixed
  309. */
  310. public static function getUserCourseInfo($userId, $courseId)
  311. {
  312. $result = Database::fetch_array(
  313. Database::query(
  314. "SELECT * FROM " . Database::get_main_table(TABLE_MAIN_COURSE_USER) . "
  315. WHERE
  316. c_id = '" . intval($courseId). "' AND
  317. user_id = " . intval($userId)
  318. )
  319. );
  320. return $result;
  321. }
  322. /**
  323. * @param int $userId
  324. * @param int $courseId
  325. * @param bool $isTutor
  326. * @return bool
  327. */
  328. public static function updateUserCourseTutor($userId, $courseId, $isTutor)
  329. {
  330. $table = Database::escape_string(TABLE_MAIN_COURSE_USER);
  331. $courseId = intval($courseId);
  332. $isTutor = intval($isTutor);
  333. $sql = "UPDATE $table SET is_tutor = '".$isTutor."'
  334. WHERE
  335. user_id = '".$userId."' AND
  336. c_id = '".$courseId."'";
  337. $result = Database::query($sql);
  338. if (Database::affected_rows($result) > 0) {
  339. return true;
  340. } else {
  341. return false;
  342. }
  343. }
  344. /**
  345. * @param int $user_id
  346. * @param string $course_code
  347. * @return mixed
  348. */
  349. public static function get_tutor_in_course_status($user_id, $course_code)
  350. {
  351. $result = Database::fetch_array(
  352. Database::query(
  353. "SELECT is_tutor FROM " . Database::get_main_table(TABLE_MAIN_COURSE_USER) . "
  354. WHERE course_code = '" . Database::escape_string($course_code) . "' AND user_id = " . intval($user_id)
  355. )
  356. );
  357. return $result['is_tutor'];
  358. }
  359. /**
  360. * Unsubscribe one or more users from a course
  361. *
  362. * @param mixed user_id or an array with user ids
  363. * @param string course code
  364. * @param int session id
  365. * @assert ('', '') === false
  366. *
  367. */
  368. public static function unsubscribe_user($user_id, $course_code, $session_id = 0)
  369. {
  370. if (!is_array($user_id)) {
  371. $user_id = array($user_id);
  372. }
  373. if (count($user_id) == 0) {
  374. return;
  375. }
  376. if (!empty($session_id)) {
  377. $session_id = intval($session_id);
  378. } else {
  379. $session_id = api_get_session_id();
  380. }
  381. $user_list = array();
  382. // Cleaning the $user_id variable
  383. if (is_array($user_id)) {
  384. $new_user_id_list = array();
  385. foreach ($user_id as $my_user_id) {
  386. $new_user_id_list[] = intval($my_user_id);
  387. }
  388. $new_user_id_list = array_filter($new_user_id_list);
  389. $user_list = $new_user_id_list;
  390. $user_ids = implode(',', $new_user_id_list);
  391. } else {
  392. $user_ids = intval($user_id);
  393. $user_list[] = $user_id;
  394. }
  395. $course_info = api_get_course_info($course_code);
  396. $course_id = $course_info['real_id'];
  397. // Unsubscribe user from all groups in the course.
  398. $sql = "DELETE FROM " . Database::get_course_table(TABLE_GROUP_USER) . "
  399. WHERE c_id = $course_id AND user_id IN (" . $user_ids . ")";
  400. Database::query($sql);
  401. $sql = "DELETE FROM " . Database::get_course_table(TABLE_GROUP_TUTOR) . "
  402. WHERE c_id = $course_id AND user_id IN (" . $user_ids . ")";
  403. Database::query($sql);
  404. // Erase user student publications (works) in the course - by André Boivin
  405. if (!empty($user_list)) {
  406. require_once api_get_path(SYS_CODE_PATH) . 'work/work.lib.php';
  407. foreach ($user_list as $userId) {
  408. // Getting all work from user
  409. $workList = getWorkPerUser($userId);
  410. if (!empty($workList)) {
  411. foreach ($workList as $work) {
  412. $work = $work['work'];
  413. // Getting user results
  414. if (!empty($work->user_results)) {
  415. foreach ($work->user_results as $workSent) {
  416. deleteWorkItem($workSent['id'], $course_info);
  417. }
  418. }
  419. }
  420. }
  421. }
  422. }
  423. // Unsubscribe user from all blogs in the course.
  424. Database::query("DELETE FROM " . Database::get_course_table(TABLE_BLOGS_REL_USER) . " WHERE c_id = $course_id AND user_id IN (" . $user_ids . ")");
  425. Database::query("DELETE FROM " . Database::get_course_table(TABLE_BLOGS_TASKS_REL_USER) . " WHERE c_id = $course_id AND user_id IN (" . $user_ids . ")");
  426. // Deleting users in forum_notification and mailqueue course tables
  427. $sql = "DELETE FROM " . Database::get_course_table(TABLE_FORUM_NOTIFICATION) . "
  428. WHERE c_id = $course_id AND user_id IN (" . $user_ids . ")";
  429. Database::query($sql);
  430. $sql = "DELETE FROM " . Database::get_course_table(TABLE_FORUM_MAIL_QUEUE) . "
  431. WHERE c_id = $course_id AND user_id IN (" . $user_ids . ")";
  432. Database::query($sql);
  433. // Unsubscribe user from the course.
  434. if (!empty($session_id)) {
  435. // Delete in table session_rel_course_rel_user
  436. $sql = "DELETE FROM " . Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER) . "
  437. WHERE
  438. session_id ='" . $session_id . "' AND
  439. c_id = '" . $course_id . "' AND
  440. user_id IN ($user_ids)";
  441. Database::query($sql);
  442. foreach ($user_list as $uid) {
  443. // check if a user is register in the session with other course
  444. $sql = "SELECT user_id FROM " . Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER) . "
  445. WHERE session_id='$session_id' AND user_id='$uid'";
  446. $rs = Database::query($sql);
  447. if (Database::num_rows($rs) == 0) {
  448. // Delete in table session_rel_user
  449. $sql = "DELETE FROM " . Database::get_main_table(TABLE_MAIN_SESSION_USER) . "
  450. WHERE
  451. session_id ='" . $session_id . "' AND
  452. user_id = '$uid' AND
  453. relation_type<>" . SESSION_RELATION_TYPE_RRHH . "";
  454. Database::query($sql);
  455. }
  456. }
  457. // Update the table session
  458. $sql = "SELECT COUNT(*) FROM " . Database::get_main_table(TABLE_MAIN_SESSION_USER) . "
  459. WHERE session_id = '" . $session_id . "' AND relation_type <> " . SESSION_RELATION_TYPE_RRHH;
  460. $row = Database::fetch_array(Database::query($sql));
  461. $count = $row[0];
  462. // number of users by session
  463. $sql = "UPDATE " . Database::get_main_table(TABLE_MAIN_SESSION) . " SET nbr_users = '$count'
  464. WHERE id = '" . $session_id . "'";
  465. Database::query($sql);
  466. // Update the table session_rel_course
  467. $sql = "SELECT COUNT(*) FROM " . Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER) . "
  468. WHERE session_id = '$session_id' AND c_id = '$course_id' AND status<>2";
  469. $row = Database::fetch_array(@Database::query($sql));
  470. $count = $row[0];
  471. // number of users by session and course
  472. $sql = "UPDATE " . Database::get_main_table(TABLE_MAIN_SESSION_COURSE) . "
  473. SET nbr_users = '$count'
  474. WHERE session_id = '$session_id' AND c_id = '$course_id'";
  475. Database::query($sql);
  476. } else {
  477. $sql = "DELETE FROM " . Database::get_main_table(TABLE_MAIN_COURSE_USER) . "
  478. WHERE
  479. user_id IN (" . $user_ids . ") AND
  480. relation_type<>" . COURSE_RELATION_TYPE_RRHH . " AND
  481. c_id = '" . $course_id . "'";
  482. Database::query($sql);
  483. // add event to system log
  484. $user_id = api_get_user_id();
  485. Event::addEvent(
  486. LOG_UNSUBSCRIBE_USER_FROM_COURSE,
  487. LOG_COURSE_CODE,
  488. $course_code,
  489. api_get_utc_datetime(),
  490. $user_id
  491. );
  492. foreach ($user_list as $userId) {
  493. $userInfo = api_get_user_info($userId);
  494. Event::addEvent(
  495. LOG_UNSUBSCRIBE_USER_FROM_COURSE,
  496. LOG_USER_OBJECT,
  497. $userInfo,
  498. api_get_utc_datetime(),
  499. $user_id
  500. );
  501. }
  502. }
  503. }
  504. /**
  505. * Subscribe a user to a course. No checks are performed here to see if
  506. * course subscription is allowed.
  507. * @param int User ID
  508. * @param string Course code
  509. * @param int Status (STUDENT, COURSEMANAGER, COURSE_ADMIN, NORMAL_COURSE_MEMBER)
  510. * @return bool True on success, false on failure
  511. * @see add_user_to_course
  512. * @assert ('', '') === false
  513. */
  514. public static function subscribe_user(
  515. $user_id,
  516. $course_code,
  517. $status = STUDENT,
  518. $session_id = 0,
  519. $userCourseCategoryId = 0
  520. ) {
  521. if ($user_id != strval(intval($user_id))) {
  522. return false; //detected possible SQL injection
  523. }
  524. $course_code = Database::escape_string($course_code);
  525. $courseInfo = api_get_course_info($course_code);
  526. $courseId = $courseInfo['real_id'];
  527. $courseCode = $courseInfo['code'];
  528. $userCourseCategoryId = intval($userCourseCategoryId);
  529. if (empty($user_id) || empty ($course_code)) {
  530. return false;
  531. }
  532. if (!empty($session_id)) {
  533. $session_id = intval($session_id);
  534. } else {
  535. $session_id = api_get_session_id();
  536. }
  537. $status = ($status == STUDENT || $status == COURSEMANAGER) ? $status : STUDENT;
  538. //$role_id = ($status == COURSEMANAGER) ? COURSE_ADMIN : NORMAL_COURSE_MEMBER;
  539. // A preliminary check whether the user has bben already registered on the platform.
  540. if (Database::num_rows(Database::query(
  541. "SELECT status FROM " . Database::get_main_table(TABLE_MAIN_USER) . "
  542. WHERE user_id = '$user_id' ")) == 0
  543. ) {
  544. return false; // The user has not been registered to the platform.
  545. }
  546. // Check whether the user has not been already subscribed to the course.
  547. if (empty($session_id)) {
  548. if (Database::num_rows(Database::query("
  549. SELECT * FROM " . Database::get_main_table(TABLE_MAIN_COURSE_USER) . "
  550. WHERE user_id = '$user_id' AND relation_type<>" . COURSE_RELATION_TYPE_RRHH . " AND c_id = '$courseId'")) > 0
  551. ) {
  552. // The user has been already subscribed to the course.
  553. return false;
  554. }
  555. }
  556. if (!empty($session_id)) {
  557. SessionManager::subscribe_users_to_session_course(array($user_id), $session_id, $courseCode);
  558. } else {
  559. CourseManager::add_user_to_course($user_id, $courseCode, $status);
  560. // Add event to the system log
  561. Event::addEvent(
  562. LOG_SUBSCRIBE_USER_TO_COURSE,
  563. LOG_COURSE_CODE,
  564. $course_code,
  565. api_get_utc_datetime(),
  566. api_get_user_id()
  567. );
  568. $user_info = api_get_user_info($user_id);
  569. Event::addEvent(
  570. LOG_SUBSCRIBE_USER_TO_COURSE,
  571. LOG_USER_OBJECT,
  572. $user_info,
  573. api_get_utc_datetime(),
  574. api_get_user_id()
  575. );
  576. }
  577. return true;
  578. }
  579. /**
  580. * Get the course id based on the original id and field name in the
  581. * extra fields. Returns 0 if course was not found
  582. *
  583. * @param string $original_course_id_value
  584. * @param string $original_course_id_name
  585. * @return int Course id
  586. *
  587. * @assert ('', '') === false
  588. */
  589. public static function get_course_code_from_original_id($original_course_id_value, $original_course_id_name)
  590. {
  591. $t_cfv = Database::get_main_table(TABLE_EXTRA_FIELD_VALUES);
  592. $table_field = Database::get_main_table(TABLE_EXTRA_FIELD);
  593. $extraFieldType = EntityExtraField::COURSE_FIELD_TYPE;
  594. $original_course_id_value = Database::escape_string($original_course_id_value);
  595. $original_course_id_name = Database::escape_string($original_course_id_name);
  596. $sql = "SELECT item_id
  597. FROM $table_field cf
  598. INNER JOIN $t_cfv cfv
  599. ON cfv.field_id=cf.id
  600. WHERE
  601. variable = '$original_course_id_name' AND
  602. value = '$original_course_id_value' AND
  603. cf.extra_field_type = $extraFieldType
  604. ";
  605. $res = Database::query($sql);
  606. $row = Database::fetch_object($res);
  607. if ($row) {
  608. return $row->item_id;
  609. } else {
  610. return 0;
  611. }
  612. }
  613. /**
  614. * Gets the course code from the course id. Returns null if course id was not found
  615. *
  616. * @param int Course id
  617. * @return string Course code
  618. * @assert ('') === false
  619. */
  620. public static function get_course_code_from_course_id($id)
  621. {
  622. $table = Database::get_main_table(TABLE_MAIN_COURSE);
  623. $id = intval($id);
  624. $sql = "SELECT code FROM $table WHERE id = '$id' ";
  625. $res = Database::query($sql);
  626. $row = Database::fetch_object($res);
  627. if ($row) {
  628. return $row->code;
  629. } else {
  630. return null;
  631. }
  632. }
  633. /**
  634. * Subscribe a user $user_id to a course defined by $courseCode.
  635. * @author Hugues Peeters
  636. * @author Roan Embrechts
  637. *
  638. * @param int $user_id the id of the user
  639. * @param string $courseCode the course code
  640. * @param int $status (optional) The user's status in the course
  641. * @param int The user category in which this subscription will be classified
  642. *
  643. * @return boolean true if subscription succeeds, boolean false otherwise.
  644. * @assert ('', '') === false
  645. */
  646. public static function add_user_to_course($user_id, $courseCode, $status = STUDENT, $userCourseCategoryId = 0)
  647. {
  648. $debug = false;
  649. $user_table = Database::get_main_table(TABLE_MAIN_USER);
  650. $course_table = Database::get_main_table(TABLE_MAIN_COURSE);
  651. $course_user_table = Database::get_main_table(TABLE_MAIN_COURSE_USER);
  652. $status = ($status == STUDENT || $status == COURSEMANAGER) ? $status : STUDENT;
  653. if (empty($user_id) || empty($courseCode) || ($user_id != strval(intval($user_id)))) {
  654. return false;
  655. }
  656. $courseCode = Database::escape_string($courseCode);
  657. $courseInfo = api_get_course_info($courseCode);
  658. $courseId = $courseInfo['real_id'];
  659. // Check in advance whether the user has already been registered on the platform.
  660. $sql = "SELECT status FROM " . $user_table . " WHERE user_id = $user_id ";
  661. if (Database::num_rows(Database::query($sql)) == 0) {
  662. if ($debug) {
  663. error_log('The user has not been registered to the platform');
  664. }
  665. return false; // The user has not been registered to the platform.
  666. }
  667. // Check whether the user has already been subscribed to this course.
  668. $sql = "SELECT * FROM $course_user_table
  669. WHERE
  670. user_id = $user_id AND
  671. relation_type <> " . COURSE_RELATION_TYPE_RRHH . " AND
  672. c_id = $courseId";
  673. if (Database::num_rows(Database::query($sql)) > 0) {
  674. if ($debug) {
  675. error_log('The user has been already subscribed to the course');
  676. }
  677. return false; // The user has been subscribed to the course.
  678. }
  679. if (!api_is_course_admin()) {
  680. // Check in advance whether subscription is allowed or not for this course.
  681. $sql = "SELECT code, visibility FROM $course_table
  682. WHERE id = $courseId AND subscribe = '" . SUBSCRIBE_NOT_ALLOWED . "'";
  683. if (Database::num_rows(Database::query($sql)) > 0) {
  684. if ($debug) {
  685. error_log('Subscription is not allowed for this course');
  686. }
  687. return false; // Subscription is not allowed for this course.
  688. }
  689. }
  690. // Ok, subscribe the user.
  691. $max_sort = api_max_sort_value('0', $user_id);
  692. $params = [
  693. 'c_id' => $courseId,
  694. 'user_id' => $user_id,
  695. 'status' => $status,
  696. 'sort' => $max_sort + 1,
  697. 'user_course_cat' => $userCourseCategoryId
  698. ];
  699. $insertId = Database::insert($course_user_table, $params);
  700. return $insertId;
  701. }
  702. /**
  703. * Checks wether a parameter exists.
  704. * If it doesn't, the function displays an error message.
  705. *
  706. * @return true if parameter is set and not empty, false otherwise
  707. * @todo move function to better place, main_api ?
  708. */
  709. public static function check_parameter($parameter, $error_message)
  710. {
  711. if (empty($parameter)) {
  712. Display::display_normal_message($error_message);
  713. return false;
  714. }
  715. return true;
  716. }
  717. /**
  718. * Lets the script die when a parameter check fails.
  719. * @todo move function to better place, main_api ?
  720. */
  721. public static function check_parameter_or_fail($parameter, $error_message)
  722. {
  723. if (!self::check_parameter($parameter, $error_message)) {
  724. die();
  725. }
  726. }
  727. /**
  728. * @return true if there already are one or more courses
  729. * with the same code OR visual_code (visualcode), false otherwise
  730. */
  731. public static function course_code_exists($wanted_course_code)
  732. {
  733. $wanted_course_code = Database::escape_string($wanted_course_code);
  734. $sql = "SELECT COUNT(*) as number FROM " . Database::get_main_table(TABLE_MAIN_COURSE) . "
  735. WHERE code = '$wanted_course_code' OR visual_code = '$wanted_course_code'";
  736. $result = Database::fetch_array(Database::query($sql));
  737. return $result['number'] > 0;
  738. }
  739. /**
  740. * @return an array with the course info of all real courses on the platform
  741. *@deprecate don't use this function
  742. */
  743. public static function get_real_course_list()
  744. {
  745. $sql_result = Database::query(
  746. "SELECT * FROM " . Database::get_main_table(TABLE_MAIN_COURSE) . "
  747. WHERE target_course_code IS NULL"
  748. );
  749. $real_course_list = array();
  750. while ($result = Database::fetch_array($sql_result)) {
  751. $real_course_list[$result['code']] = $result;
  752. }
  753. return $real_course_list;
  754. }
  755. /**
  756. * Get course list as coach
  757. *
  758. * @param int $user_id
  759. * @param bool $include_courses_in_sessions
  760. * @return array Course list
  761. *
  762. **/
  763. public static function get_course_list_as_coach($user_id, $include_courses_in_sessions = false)
  764. {
  765. // 1. Getting courses as teacher (No session)
  766. $courses_temp = CourseManager::get_course_list_of_user_as_course_admin($user_id);
  767. $courseList = array();
  768. if (!empty($courses_temp)) {
  769. foreach ($courses_temp as $course_item) {
  770. $courseList[0][$course_item['code']] = $course_item['code'];
  771. }
  772. }
  773. //2. Include courses in sessions
  774. if ($include_courses_in_sessions) {
  775. $sessions = Tracking::get_sessions_coached_by_user($user_id);
  776. if (!empty($sessions)) {
  777. foreach ($sessions as $session_item) {
  778. $courses = Tracking:: get_courses_followed_by_coach($user_id, $session_item['id']);
  779. if (is_array($courses)) {
  780. foreach ($courses as $course_item) {
  781. $courseList[$session_item['id']][$course_item] = $course_item;
  782. }
  783. }
  784. }
  785. }
  786. }
  787. return $courseList;
  788. }
  789. /**
  790. * @param int $user_id
  791. * @param bool $include_sessions
  792. * @return array
  793. */
  794. public static function get_user_list_from_courses_as_coach($user_id, $include_sessions = true)
  795. {
  796. $students_in_courses = array();
  797. $sessions = CourseManager::get_course_list_as_coach($user_id, true);
  798. if (!empty($sessions)) {
  799. foreach ($sessions as $session_id => $courses) {
  800. if (!$include_sessions) {
  801. if (!empty($session_id)) {
  802. continue;
  803. }
  804. }
  805. if (empty($session_id)) {
  806. foreach ($courses as $course_code) {
  807. $students_in_course = CourseManager::get_user_list_from_course_code($course_code);
  808. foreach ($students_in_course as $user_item) {
  809. //Only students
  810. if ($user_item['status_rel'] == STUDENT) {
  811. $students_in_courses[$user_item['user_id']] = $user_item['user_id'];
  812. }
  813. }
  814. }
  815. } else {
  816. $students_in_course = SessionManager::get_users_by_session($session_id, '0');
  817. if (is_array($students_in_course)) {
  818. foreach ($students_in_course as $user_item) {
  819. $students_in_courses[$user_item['user_id']] = $user_item['user_id'];
  820. }
  821. }
  822. }
  823. }
  824. }
  825. $students = Tracking:: get_student_followed_by_coach($user_id);
  826. if (!empty($students_in_courses)) {
  827. if (!empty($students)) {
  828. $students = array_merge($students, $students_in_courses);
  829. } else {
  830. $students = $students_in_courses;
  831. }
  832. }
  833. if (!empty($students)) {
  834. $students = array_unique($students);
  835. }
  836. return $students;
  837. }
  838. /**
  839. * @param int $user_id
  840. * @return array An array with the course info of all the courses (real and virtual)
  841. * of which the current user is course admin.
  842. */
  843. public static function get_course_list_of_user_as_course_admin($user_id)
  844. {
  845. if ($user_id != strval(intval($user_id))) {
  846. return array();
  847. }
  848. // Definitions database tables and variables
  849. $tbl_course = Database::get_main_table(TABLE_MAIN_COURSE);
  850. $tbl_course_user = Database::get_main_table(TABLE_MAIN_COURSE_USER);
  851. $user_id = intval($user_id);
  852. $data = array();
  853. $sql = "SELECT
  854. course.code,
  855. course.title,
  856. course.id,
  857. course.id as real_id
  858. FROM $tbl_course_user as course_rel_user
  859. INNER JOIN $tbl_course as course
  860. ON course.id = course_rel_user.c_id
  861. WHERE
  862. course_rel_user.user_id='$user_id' AND
  863. course_rel_user.status='1'
  864. ORDER BY course.title";
  865. if (api_get_multiple_access_url()) {
  866. $tbl_course_rel_access_url = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_COURSE);
  867. $access_url_id = api_get_current_access_url_id();
  868. if ($access_url_id != -1) {
  869. $sql = "
  870. SELECT
  871. course.code,
  872. course.title,
  873. course.id,
  874. course.id as real_id
  875. FROM $tbl_course_user as course_rel_user
  876. INNER JOIN $tbl_course as course
  877. ON course.id = course_rel_user.c_id
  878. INNER JOIN $tbl_course_rel_access_url course_rel_url
  879. ON (course_rel_url.c_id = course.id)
  880. WHERE
  881. access_url_id = $access_url_id AND
  882. course_rel_user.user_id = '$user_id' AND
  883. course_rel_user.status = '1'
  884. ORDER BY course.title";
  885. }
  886. }
  887. $result_nb_cours = Database::query($sql);
  888. if (Database::num_rows($result_nb_cours) > 0) {
  889. while ($row = Database::fetch_array($result_nb_cours, 'ASSOC')) {
  890. $data[$row['id']] = $row;
  891. }
  892. }
  893. return $data;
  894. }
  895. /**
  896. * Return an array of arrays, listing course info of all virtual course
  897. * linked to the real course ID $real_course_code
  898. *
  899. * @param string The id of the real course which the virtual courses are linked to
  900. * @return array List of courses details
  901. * @deprecated virtual courses doesn't exist anymore
  902. */
  903. public static function get_virtual_courses_linked_to_real_course($real_course_code)
  904. {
  905. $sql_result = Database::query(
  906. "SELECT * FROM " . Database::get_main_table(TABLE_MAIN_COURSE) . "
  907. WHERE target_course_code = '" . Database::get_main_table(TABLE_MAIN_COURSE) . "'"
  908. );
  909. $result_array = array();
  910. while ($result = Database::fetch_array($sql_result)) {
  911. $result_array[] = $result;
  912. }
  913. return $result_array;
  914. }
  915. /**
  916. * @param int $userId
  917. * @param array $courseInfo
  918. * @return bool
  919. */
  920. public static function isUserSubscribedInCourseAsDrh($userId, $courseInfo)
  921. {
  922. $userId = intval($userId);
  923. if (!api_is_drh()) {
  924. return false;
  925. }
  926. if (empty($courseInfo) || empty($userId)) {
  927. return false;
  928. }
  929. $courseId = intval($courseInfo['real_id']);
  930. $table = Database::get_main_table(TABLE_MAIN_COURSE_USER);
  931. $sql = "SELECT * FROM $table
  932. WHERE
  933. user_id = $userId AND
  934. relation_type = " . COURSE_RELATION_TYPE_RRHH . " AND
  935. c_id = $courseId";
  936. $result = Database::fetch_array(Database::query($sql));
  937. if (!empty($result)) {
  938. // The user has been registered in this course.
  939. return true;
  940. }
  941. }
  942. /**
  943. * Check if user is subscribed inside a course
  944. * @param int $user_id
  945. * @param string $course_code , if this parameter is null, it'll check for all courses
  946. * @param bool $in_a_session True for checking inside sessions too, by default is not checked
  947. * @return bool $session_id true if the user is registered in the course, false otherwise
  948. */
  949. public static function is_user_subscribed_in_course(
  950. $user_id,
  951. $course_code = null,
  952. $in_a_session = false,
  953. $session_id = null
  954. ) {
  955. $user_id = intval($user_id);
  956. if (empty($session_id)) {
  957. $session_id = api_get_session_id();
  958. } else {
  959. $session_id = intval($session_id);
  960. }
  961. $condition_course = '';
  962. if (isset($course_code)) {
  963. $courseInfo = api_get_course_info($course_code);
  964. if (empty($courseInfo)) {
  965. return false;
  966. }
  967. $courseId = $courseInfo['real_id'];
  968. $condition_course = ' AND c_id = ' . $courseId;
  969. }
  970. $sql = "SELECT * FROM " . Database::get_main_table(TABLE_MAIN_COURSE_USER) . "
  971. WHERE
  972. user_id = $user_id AND
  973. relation_type<>" . COURSE_RELATION_TYPE_RRHH . "
  974. $condition_course ";
  975. $result = Database::fetch_array(Database::query($sql));
  976. if (!empty($result)) {
  977. // The user has been registered in this course.
  978. return true;
  979. }
  980. if (!$in_a_session) {
  981. // The user has not been registered in this course.
  982. return false;
  983. }
  984. $tableSessionCourseUser = Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER);
  985. $sql = 'SELECT 1 FROM ' . $tableSessionCourseUser .
  986. ' WHERE user_id = ' . $user_id . ' ' . $condition_course;
  987. if (Database::num_rows(Database::query($sql)) > 0) {
  988. return true;
  989. }
  990. $sql = 'SELECT 1 FROM ' . $tableSessionCourseUser .
  991. ' WHERE user_id = ' . $user_id . ' AND status=2 ' . $condition_course;
  992. if (Database::num_rows(Database::query($sql)) > 0) {
  993. return true;
  994. }
  995. $sql = 'SELECT 1 FROM ' . Database::get_main_table(TABLE_MAIN_SESSION) .
  996. ' WHERE id = ' . $session_id . ' AND id_coach=' . $user_id;
  997. if (Database::num_rows(Database::query($sql)) > 0) {
  998. return true;
  999. }
  1000. return false;
  1001. }
  1002. /**
  1003. * Is the user a teacher in the given course?
  1004. *
  1005. * @param $user_id , the id (int) of the user
  1006. * @param $course_code , the course code
  1007. *
  1008. * @return true if the user is a teacher in the course, false otherwise
  1009. */
  1010. public static function is_course_teacher($user_id, $course_code)
  1011. {
  1012. if ($user_id != strval(intval($user_id))) {
  1013. return false;
  1014. }
  1015. $courseInfo = api_get_course_info($course_code);
  1016. $courseId = $courseInfo['real_id'];
  1017. $result = Database::query(
  1018. 'SELECT status FROM ' . Database::get_main_table(TABLE_MAIN_COURSE_USER) .
  1019. ' WHERE c_id = ' . $courseId . ' AND user_id = ' . $user_id . ''
  1020. );
  1021. if (Database::num_rows($result) > 0) {
  1022. return Database::result($result, 0, 'status') == 1;
  1023. }
  1024. return false;
  1025. }
  1026. /**
  1027. * Is the user subscribed in the real course or linked courses?
  1028. *
  1029. * @param int the id of the user
  1030. * @param array info about the course (comes from course table, see database lib)
  1031. * @deprecated linked_courses definition doesn't exists
  1032. * @return true if the user is registered in the real course or linked courses, false otherwise
  1033. */
  1034. public static function is_user_subscribed_in_real_or_linked_course($user_id, $course_code, $session_id = '')
  1035. {
  1036. if ($user_id != strval(intval($user_id))) {
  1037. return false;
  1038. }
  1039. $course_code = Database::escape_string($course_code);
  1040. if ($session_id == '') {
  1041. $result = Database::fetch_array(
  1042. Database::query(
  1043. "SELECT *
  1044. FROM " . Database::get_main_table(TABLE_MAIN_COURSE) . " course
  1045. LEFT JOIN " . Database::get_main_table(TABLE_MAIN_COURSE_USER) . " course_user
  1046. ON course.id = course_user.c_id
  1047. WHERE
  1048. course_user.user_id = '$user_id' AND
  1049. course_user.relation_type<>" . COURSE_RELATION_TYPE_RRHH . " AND
  1050. ( course.code = '$course_code' OR target_course_code = '$course_code')"
  1051. )
  1052. );
  1053. return !empty($result);
  1054. }
  1055. $session_id = intval($session_id);
  1056. // From here we trust session id.
  1057. // Is he/she subscribed to the session's course?
  1058. // A user?
  1059. if (Database::num_rows(Database::query("SELECT user_id
  1060. FROM " . Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER) . "
  1061. WHERE session_id='" . $session_id . "'
  1062. AND user_id ='$user_id'"))
  1063. ) {
  1064. return true;
  1065. }
  1066. // A course coach?
  1067. if (Database::num_rows(Database::query("SELECT user_id
  1068. FROM " . Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER) . "
  1069. WHERE session_id='" . $session_id . "'
  1070. AND user_id = '$user_id' AND status = 2
  1071. AND course_code='$course_code'"))
  1072. ) {
  1073. return true;
  1074. }
  1075. // A session coach?
  1076. if (Database::num_rows(Database::query("SELECT id_coach
  1077. FROM " . Database::get_main_table(TABLE_MAIN_SESSION) . " AS session
  1078. WHERE session.id='" . $session_id . "'
  1079. AND id_coach='$user_id'"))
  1080. ) {
  1081. return true;
  1082. }
  1083. return false;
  1084. }
  1085. /**
  1086. * Return user info array of all users registered in a course
  1087. * This only returns the users that are registered in this actual course, not linked courses.
  1088. * @param string $course_code
  1089. * @param int $session_id
  1090. * @param string $limit
  1091. * @param string $order_by the field to order the users by.
  1092. * Valid values are 'lastname', 'firstname', 'username', 'email', 'official_code' OR a part of a SQL statement
  1093. * that starts with ORDER BY ...
  1094. * @param null $filter_by_status if using the session_id: 0 or 2 (student, coach),
  1095. * if using session_id = 0 STUDENT or COURSEMANAGER
  1096. * @param null $return_count
  1097. * @param bool $add_reports
  1098. * @param bool $resumed_report
  1099. * @param array $extra_field
  1100. * @param array $courseCodeList
  1101. * @param array $userIdList
  1102. * @param string $filterByActive
  1103. * @param array $sessionIdList
  1104. * @return array|int
  1105. */
  1106. public static function get_user_list_from_course_code(
  1107. $course_code = null,
  1108. $session_id = 0,
  1109. $limit = null,
  1110. $order_by = null,
  1111. $filter_by_status = null,
  1112. $return_count = null,
  1113. $add_reports = false,
  1114. $resumed_report = false,
  1115. $extra_field = array(),
  1116. $courseCodeList = array(),
  1117. $userIdList = array(),
  1118. $filterByActive = null,
  1119. $sessionIdList = array()
  1120. ) {
  1121. $course_table = Database::get_main_table(TABLE_MAIN_COURSE);
  1122. $sessionTable = Database::get_main_table(TABLE_MAIN_SESSION);
  1123. $session_id = intval($session_id);
  1124. $course_code = Database::escape_string($course_code);
  1125. $courseInfo = api_get_course_info($course_code);
  1126. $courseId = 0;
  1127. if (!empty($courseInfo)) {
  1128. $courseId = $courseInfo['real_id'];
  1129. }
  1130. $where = array();
  1131. if (empty($order_by)) {
  1132. $order_by = 'user.lastname, user.firstname';
  1133. if (api_is_western_name_order()) {
  1134. $order_by = 'user.firstname, user.lastname';
  1135. }
  1136. }
  1137. // if the $order_by does not contain 'ORDER BY' we have to check if it is a valid field that can be sorted on
  1138. if (!strstr($order_by, 'ORDER BY')) {
  1139. if (!empty($order_by)) {
  1140. $order_by = 'ORDER BY ' . $order_by;
  1141. } else {
  1142. $order_by = '';
  1143. }
  1144. }
  1145. $filter_by_status_condition = null;
  1146. if (!empty($session_id) || !empty($sessionIdList)) {
  1147. $sql = 'SELECT DISTINCT
  1148. user.user_id,
  1149. session_course_user.status as status_session,
  1150. session_id,
  1151. user.*,
  1152. course.*,
  1153. session.name as session_name
  1154. ';
  1155. if ($return_count) {
  1156. $sql = " SELECT COUNT(user.user_id) as count";
  1157. }
  1158. $sessionCondition = " session_course_user.session_id = $session_id";
  1159. if (!empty($sessionIdList)) {
  1160. $sessionIdListTostring = implode("','", array_map('intval', $sessionIdList));
  1161. $sessionCondition = " session_course_user.session_id IN ('$sessionIdListTostring') ";
  1162. }
  1163. $courseCondition = " course.id = $courseId";
  1164. if (!empty($courseCodeList)) {
  1165. $courseCodeListForSession = array_map(array('Database', 'escape_string'), $courseCodeList);
  1166. $courseCodeListForSession = implode('","', $courseCodeListForSession);
  1167. $courseCondition = ' course.code IN ("' . $courseCodeListForSession . '") ';
  1168. }
  1169. $sql .= ' FROM ' . Database::get_main_table(TABLE_MAIN_USER) . ' as user ';
  1170. $sql .= " LEFT JOIN ".Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER) . " as session_course_user
  1171. ON
  1172. user.user_id = session_course_user.user_id AND
  1173. $sessionCondition
  1174. INNER JOIN $course_table course ON session_course_user.c_id = course.id AND
  1175. $courseCondition
  1176. INNER JOIN $sessionTable session ON session_course_user.session_id = session.id
  1177. ";
  1178. $where[] = ' session_course_user.c_id IS NOT NULL ';
  1179. // 2 = coach
  1180. // 0 = student
  1181. if (isset($filter_by_status)) {
  1182. $filter_by_status = intval($filter_by_status);
  1183. $filter_by_status_condition = " session_course_user.status = $filter_by_status AND ";
  1184. }
  1185. } else {
  1186. if ($return_count) {
  1187. $sql = " SELECT COUNT(*) as count";
  1188. if ($resumed_report) {
  1189. //$sql = " SELECT count(field_id) ";
  1190. }
  1191. } else {
  1192. if (empty($course_code)) {
  1193. $sql = 'SELECT DISTINCT
  1194. course.title,
  1195. course.code,
  1196. course_rel_user.status as status_rel,
  1197. user.user_id,
  1198. course_rel_user.is_tutor,
  1199. user.* ';
  1200. } else {
  1201. $sql = 'SELECT DISTINCT
  1202. course_rel_user.status as status_rel,
  1203. user.user_id,
  1204. course_rel_user.is_tutor,
  1205. user.* ';
  1206. }
  1207. }
  1208. $sql .= ' FROM ' . Database::get_main_table(TABLE_MAIN_USER) . ' as user ';
  1209. $sql .= ' LEFT JOIN ' . Database::get_main_table(TABLE_MAIN_COURSE_USER) . ' as course_rel_user
  1210. ON user.user_id = course_rel_user.user_id AND
  1211. course_rel_user.relation_type <> ' . COURSE_RELATION_TYPE_RRHH . ' ';
  1212. $sql .= " INNER JOIN $course_table course ON course_rel_user.c_id = course.id ";
  1213. if (!empty($course_code)) {
  1214. $sql .= ' AND course_rel_user.c_id="' . $courseId . '"';
  1215. }
  1216. $where[] = ' course_rel_user.c_id IS NOT NULL ';
  1217. if (isset($filter_by_status) && is_numeric($filter_by_status)) {
  1218. $filter_by_status = intval($filter_by_status);
  1219. $filter_by_status_condition = " course_rel_user.status = $filter_by_status AND ";
  1220. }
  1221. }
  1222. $multiple_access_url = api_get_multiple_access_url();
  1223. if ($multiple_access_url) {
  1224. $sql .= ' LEFT JOIN ' . Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_USER) . ' au
  1225. ON (au.user_id = user.user_id) ';
  1226. }
  1227. $extraFieldWasAdded = false;
  1228. if ($return_count && $resumed_report) {
  1229. foreach ($extra_field as $extraField) {
  1230. $extraFieldInfo = UserManager::get_extra_field_information_by_name($extraField);
  1231. if (!empty($extraFieldInfo)) {
  1232. $fieldValuesTable = Database::get_main_table(TABLE_EXTRA_FIELD_VALUES);
  1233. $sql .= ' LEFT JOIN '.$fieldValuesTable.' as ufv
  1234. ON (
  1235. user.user_id = ufv.item_id AND
  1236. (field_id = '.$extraFieldInfo['id'].' OR field_id IS NULL)
  1237. )';
  1238. $extraFieldWasAdded = true;
  1239. }
  1240. }
  1241. }
  1242. $sql .= ' WHERE ' . $filter_by_status_condition . ' ' . implode(' OR ', $where);
  1243. if ($multiple_access_url) {
  1244. $current_access_url_id = api_get_current_access_url_id();
  1245. $sql .= " AND (access_url_id = $current_access_url_id ) ";
  1246. }
  1247. if ($return_count && $resumed_report && $extraFieldWasAdded) {
  1248. $sql .= ' AND field_id IS NOT NULL GROUP BY value ';
  1249. }
  1250. if (!empty($courseCodeList)) {
  1251. $courseCodeList = array_map(array('Database', 'escape_string'), $courseCodeList);
  1252. $courseCodeList = implode('","', $courseCodeList);
  1253. if (empty($sessionIdList)) {
  1254. $sql .= ' AND course.code IN ("'.$courseCodeList.'")';
  1255. }
  1256. }
  1257. if (!empty($userIdList)) {
  1258. $userIdList = array_map('intval', $userIdList);
  1259. $userIdList = implode('","', $userIdList);
  1260. $sql .= ' AND user.user_id IN ("' . $userIdList . '")';
  1261. }
  1262. if (isset($filterByActive)) {
  1263. $filterByActive = intval($filterByActive);
  1264. $sql .= ' AND user.active = ' . $filterByActive;
  1265. }
  1266. $sql .= ' ' . $order_by . ' ' . $limit;
  1267. $rs = Database::query($sql);
  1268. $users = array();
  1269. $extra_fields = UserManager::get_extra_fields(0, 100, null, null, true, true);
  1270. $counter = 1;
  1271. $count_rows = Database::num_rows($rs);
  1272. if ($return_count && $resumed_report) {
  1273. return $count_rows;
  1274. }
  1275. $table_user_field_value = Database::get_main_table(TABLE_EXTRA_FIELD_VALUES);
  1276. $tableExtraField = Database::get_main_table(TABLE_EXTRA_FIELD);
  1277. if ($count_rows) {
  1278. while ($user = Database::fetch_array($rs)) {
  1279. if ($return_count) {
  1280. return $user['count'];
  1281. }
  1282. $report_info = array();
  1283. $user_info = $user;
  1284. $user_info['status'] = $user['status'];
  1285. if (isset($user['is_tutor'])) {
  1286. $user_info['is_tutor'] = $user['is_tutor'];
  1287. }
  1288. if (!empty($session_id)) {
  1289. $user_info['status_session'] = $user['status_session'];
  1290. }
  1291. $sessionId = isset($user['session_id']) ? $user['session_id'] : 0;
  1292. $course_code = isset($user['code']) ? $user['code'] : null;
  1293. if ($add_reports) {
  1294. if ($resumed_report) {
  1295. $extra = array();
  1296. if (!empty($extra_fields)) {
  1297. foreach ($extra_fields as $extra) {
  1298. if (in_array($extra['1'], $extra_field)) {
  1299. $user_data = UserManager::get_extra_user_data_by_field(
  1300. $user['user_id'],
  1301. $extra['1']
  1302. );
  1303. break;
  1304. }
  1305. }
  1306. }
  1307. $row_key = '-1';
  1308. $name = '-';
  1309. if (!empty($extra)) {
  1310. if (!empty($user_data[$extra['1']])) {
  1311. $row_key = $user_data[$extra['1']];
  1312. $name = $user_data[$extra['1']];
  1313. $users[$row_key]['extra_'.$extra['1']] = $name;
  1314. }
  1315. }
  1316. $users[$row_key]['training_hours'] += Tracking::get_time_spent_on_the_course(
  1317. $user['user_id'],
  1318. $courseId,
  1319. $sessionId
  1320. );
  1321. $users[$row_key]['count_users'] += $counter;
  1322. $registered_users_with_extra_field = 0;
  1323. if (!empty($name) && $name != '-') {
  1324. $extraFieldType = EntityExtraField::COURSE_FIELD_TYPE;
  1325. $name = Database::escape_string($name);
  1326. $sql = "SELECT count(v.item_id) as count
  1327. FROM $table_user_field_value v INNER JOIN
  1328. $tableExtraField f
  1329. ON (f.id = v.field_id)
  1330. WHERE value = '$name' AND extra_field_type = $extraFieldType";
  1331. $result_count = Database::query($sql);
  1332. if (Database::num_rows($result_count)) {
  1333. $row_count = Database::fetch_array($result_count);
  1334. $registered_users_with_extra_field = $row_count['count'];
  1335. }
  1336. }
  1337. $users[$row_key]['count_users_registered'] = $registered_users_with_extra_field;
  1338. $users[$row_key]['average_hours_per_user'] = $users[$row_key]['training_hours'] / $users[$row_key]['count_users'];
  1339. $category = Category:: load(
  1340. null,
  1341. null,
  1342. $course_code,
  1343. null,
  1344. null,
  1345. $sessionId
  1346. );
  1347. if (!isset($users[$row_key]['count_certificates'])) {
  1348. $users[$row_key]['count_certificates'] = 0;
  1349. }
  1350. if (isset($category[0]) && $category[0]->is_certificate_available($user['user_id'])) {
  1351. $users[$row_key]['count_certificates']++;
  1352. }
  1353. foreach ($extra_fields as $extra) {
  1354. if ($extra['1'] == 'ruc') {
  1355. continue;
  1356. }
  1357. if (!isset($users[$row_key][$extra['1']])) {
  1358. $user_data = UserManager::get_extra_user_data_by_field($user['user_id'], $extra['1']);
  1359. if (!empty($user_data[$extra['1']])) {
  1360. $users[$row_key][$extra['1']] = $user_data[$extra['1']];
  1361. }
  1362. }
  1363. }
  1364. } else {
  1365. $sessionName = !empty($sessionId) ? ' - '.$user['session_name'] : '';
  1366. $report_info['course'] = $user['title'].$sessionName;
  1367. $report_info['user'] = api_get_person_name($user['firstname'], $user['lastname']);
  1368. $report_info['time'] = api_time_to_hms(
  1369. Tracking::get_time_spent_on_the_course(
  1370. $user['user_id'],
  1371. $courseId,
  1372. $sessionId
  1373. )
  1374. );
  1375. $category = Category:: load(
  1376. null,
  1377. null,
  1378. $course_code,
  1379. null,
  1380. null,
  1381. $sessionId
  1382. );
  1383. $report_info['certificate'] = Display::label(get_lang('No'));
  1384. if (isset($category[0]) && $category[0]->is_certificate_available($user['user_id'])) {
  1385. $report_info['certificate'] = Display::label(get_lang('Yes'), 'success');
  1386. }
  1387. $progress = intval(
  1388. Tracking::get_avg_student_progress(
  1389. $user['user_id'],
  1390. $course_code,
  1391. array(),
  1392. $sessionId
  1393. )
  1394. );
  1395. $report_info['progress_100'] = $progress == 100 ? Display::label(get_lang('Yes'), 'success') : Display::label(get_lang('No'));
  1396. $report_info['progress'] = $progress . "%";
  1397. foreach ($extra_fields as $extra) {
  1398. $user_data = UserManager::get_extra_user_data_by_field($user['user_id'], $extra['1']);
  1399. $report_info[$extra['1']] = $user_data[$extra['1']];
  1400. }
  1401. $report_info['user_id'] = $user['user_id'];
  1402. $users[] = $report_info;
  1403. }
  1404. } else {
  1405. $users[$user['user_id']] = $user_info;
  1406. }
  1407. }
  1408. }
  1409. return $users;
  1410. }
  1411. /**
  1412. * @param bool $resumed_report
  1413. * @param array $extra_field
  1414. * @param array $courseCodeList
  1415. * @param array $userIdList
  1416. * @param array $sessionIdList
  1417. * @return array|int
  1418. */
  1419. static function get_count_user_list_from_course_code(
  1420. $resumed_report = false,
  1421. $extra_field = array(),
  1422. $courseCodeList = array(),
  1423. $userIdList = array(),
  1424. $sessionIdList = array()
  1425. ) {
  1426. return self::get_user_list_from_course_code(
  1427. null,
  1428. 0,
  1429. null,
  1430. null,
  1431. null,
  1432. true,
  1433. false,
  1434. $resumed_report,
  1435. $extra_field,
  1436. $courseCodeList,
  1437. $userIdList,
  1438. null,
  1439. $sessionIdList
  1440. );
  1441. }
  1442. /**
  1443. * Gets subscribed users in a course or in a course/session
  1444. *
  1445. * @param string $course_code
  1446. * @param int $session_id
  1447. * @return int
  1448. */
  1449. public static function get_users_count_in_course(
  1450. $course_code,
  1451. $session_id = 0,
  1452. $status = null
  1453. ) {
  1454. // variable initialisation
  1455. $session_id = intval($session_id);
  1456. $course_code = Database::escape_string($course_code);
  1457. $courseInfo = api_get_course_info($course_code);
  1458. $courseId = $courseInfo['real_id'];
  1459. $sql = 'SELECT DISTINCT count(*) as count FROM ' . Database::get_main_table(TABLE_MAIN_USER) . ' as user ';
  1460. $where = array();
  1461. if (!empty($session_id)) {
  1462. $sql .= ' LEFT JOIN ' . Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER) . ' as session_course_user
  1463. ON
  1464. user.user_id = session_course_user.user_id AND
  1465. session_course_user.c_id = "' . $courseId . '" AND
  1466. session_course_user.session_id = ' . $session_id;
  1467. $where[] = ' session_course_user.c_id IS NOT NULL ';
  1468. } else {
  1469. $sql .= ' LEFT JOIN ' . Database::get_main_table(TABLE_MAIN_COURSE_USER) . ' as course_rel_user
  1470. ON
  1471. user.user_id = course_rel_user.user_id AND
  1472. course_rel_user.relation_type<>' . COURSE_RELATION_TYPE_RRHH . ' AND
  1473. course_rel_user.c_id = ' . $courseId ;
  1474. $where[] = ' course_rel_user.c_id IS NOT NULL ';
  1475. }
  1476. $multiple_access_url = api_get_multiple_access_url();
  1477. if ($multiple_access_url) {
  1478. $sql .= ' LEFT JOIN ' . Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_USER) . ' au ON (au.user_id = user.user_id) ';
  1479. }
  1480. $sql .= ' WHERE ' . implode(' OR ', $where);
  1481. if ($multiple_access_url) {
  1482. $current_access_url_id = api_get_current_access_url_id();
  1483. $sql .= " AND (access_url_id = $current_access_url_id ) ";
  1484. }
  1485. $rs = Database::query($sql);
  1486. $count = 0;
  1487. if (Database::num_rows($rs)) {
  1488. $user = Database::fetch_array($rs);
  1489. $count = $user['count'];
  1490. }
  1491. return $count;
  1492. }
  1493. /**
  1494. * Get a list of coaches of a course and a session
  1495. * @param string Course code
  1496. * @param int Session ID
  1497. * @return array List of users
  1498. */
  1499. public static function get_coach_list_from_course_code($course_code, $session_id)
  1500. {
  1501. if (empty($course_code) OR empty($session_id)) {
  1502. return array();
  1503. }
  1504. $course_code = Database::escape_string($course_code);
  1505. $courseInfo = api_get_course_info($course_code);
  1506. $courseId = $courseInfo['real_id'];
  1507. $session_id = intval($session_id);
  1508. $users = array();
  1509. // We get the coach for the given course in a given session.
  1510. $sql = 'SELECT user_id FROM ' . Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER) .
  1511. ' WHERE session_id ="' . $session_id . '" AND c_id="' . $courseId . '" AND status = 2';
  1512. $rs = Database::query($sql);
  1513. while ($user = Database::fetch_array($rs)) {
  1514. $user_info = api_get_user_info($user['user_id']);
  1515. $user_info['status'] = $user['status'];
  1516. //$user_info['tutor_id'] = $user['tutor_id'];
  1517. $user_info['email'] = $user['email'];
  1518. $users[$user['user_id']] = $user_info;
  1519. }
  1520. $table = Database::get_main_table(TABLE_MAIN_SESSION);
  1521. // We get the session coach.
  1522. $sql = 'SELECT id_coach FROM ' . $table . ' WHERE id=' . $session_id;
  1523. $rs = Database::query($sql);
  1524. $session_id_coach = Database::result($rs, 0, 'id_coach');
  1525. $user_info = api_get_user_info($session_id_coach);
  1526. $user_info['status'] = $user['status'];
  1527. //$user_info['tutor_id'] = $user['tutor_id'];
  1528. $user_info['email'] = $user['email'];
  1529. $users[$session_id_coach] = $user_info;
  1530. return $users;
  1531. }
  1532. /**
  1533. * Return user info array of all users registered in a course
  1534. * This only returns the users that are registered in this actual course, not linked courses.
  1535. *
  1536. * @param string $course_code
  1537. * @param boolean $with_session
  1538. * @param integer $session_id
  1539. * @param string $date_from
  1540. * @param string $date_to
  1541. * @param boolean $includeInvitedUsers Whether include the invited users
  1542. * @return array with user id
  1543. */
  1544. public static function get_student_list_from_course_code(
  1545. $course_code,
  1546. $with_session = false,
  1547. $session_id = 0,
  1548. $date_from = null,
  1549. $date_to = null,
  1550. $includeInvitedUsers = true
  1551. ) {
  1552. $userTable = Database::get_main_table(TABLE_MAIN_USER);
  1553. $session_id = intval($session_id);
  1554. $course_code = Database::escape_string($course_code);
  1555. $courseInfo = api_get_course_info($course_code);
  1556. $courseId = $courseInfo['real_id'];
  1557. $students = array();
  1558. if ($session_id == 0) {
  1559. // students directly subscribed to the course
  1560. $sql = "SELECT * FROM " . Database::get_main_table(TABLE_MAIN_COURSE_USER) . " cu
  1561. INNER JOIN $userTable u
  1562. ON cu.user_id = u.user_id
  1563. WHERE c_id = '$courseId' AND cu.status = " . STUDENT;
  1564. if (!$includeInvitedUsers) {
  1565. $sql .= " AND u.status != " . INVITEE;
  1566. }
  1567. $rs = Database::query($sql);
  1568. while ($student = Database::fetch_array($rs)) {
  1569. $students[$student['user_id']] = $student;
  1570. }
  1571. }
  1572. // students subscribed to the course through a session
  1573. if ($with_session) {
  1574. $joinSession = "";
  1575. //Session creation date
  1576. if (!empty($date_from) && !empty($date_to)) {
  1577. $joinSession = "INNER JOIN " . Database::get_main_table(TABLE_MAIN_SESSION) . " s";
  1578. }
  1579. $sql_query = "SELECT * FROM " . Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER) . " scu
  1580. $joinSession
  1581. INNER JOIN $userTable u ON scu.user_id = u.user_id
  1582. WHERE scu.c_id = '$courseId' AND scu.status <> 2";
  1583. if (!empty($date_from) && !empty($date_to)) {
  1584. $date_from = Database::escape_string($date_from);
  1585. $date_to = Database::escape_string($date_to);
  1586. $sql_query .= " AND s.date_start >= '$date_from' AND s.date_end <= '$date_to'";
  1587. }
  1588. if ($session_id != 0) {
  1589. $sql_query .= ' AND scu.session_id = ' . $session_id;
  1590. }
  1591. if (!$includeInvitedUsers) {
  1592. $sql_query .= " AND u.status != " . INVITEE;
  1593. }
  1594. $rs = Database::query($sql_query);
  1595. while ($student = Database::fetch_array($rs)) {
  1596. $students[$student['user_id']] = $student;
  1597. }
  1598. }
  1599. return $students;
  1600. }
  1601. /**
  1602. * Return user info array of all teacher-users registered in a course
  1603. * This only returns the users that are registered in this actual course, not linked courses.
  1604. *
  1605. * @param string $course_code
  1606. * @return array with user id
  1607. */
  1608. public static function get_teacher_list_from_course_code($course_code)
  1609. {
  1610. $courseInfo = api_get_course_info($course_code);
  1611. $courseId = $courseInfo['real_id'];
  1612. $sql = "SELECT DISTINCT
  1613. u.id as user_id,
  1614. u.lastname,
  1615. u.firstname,
  1616. u.email,
  1617. u.username,
  1618. u.status
  1619. FROM " . Database::get_main_table(TABLE_MAIN_COURSE_USER) . " cu
  1620. INNER JOIN " . Database::get_main_table(TABLE_MAIN_USER) . " u
  1621. ON (cu.user_id = u.id)
  1622. WHERE
  1623. cu.c_id = $courseId AND
  1624. cu.status = 1 ";
  1625. $rs = Database::query($sql);
  1626. $teachers = array();
  1627. while ($teacher = Database::fetch_array($rs)) {
  1628. $teachers[$teacher['user_id']] = $teacher;
  1629. }
  1630. return $teachers;
  1631. }
  1632. /**
  1633. * Returns a string list of teachers assigned to the given course
  1634. * @param string $course_code
  1635. * @param string $separator between teachers names
  1636. * @param bool $add_link_to_profile Whether to add a link to the teacher's profile
  1637. * @return string List of teachers teaching the course
  1638. */
  1639. public static function get_teacher_list_from_course_code_to_string(
  1640. $course_code,
  1641. $separator = self::USER_SEPARATOR,
  1642. $add_link_to_profile = false
  1643. ) {
  1644. $teacher_list = self::get_teacher_list_from_course_code($course_code);
  1645. $teacher_string = '';
  1646. $list = array();
  1647. if (!empty($teacher_list)) {
  1648. foreach ($teacher_list as $teacher) {
  1649. $teacher_name = api_get_person_name(
  1650. $teacher['firstname'],
  1651. $teacher['lastname']
  1652. );
  1653. if ($add_link_to_profile) {
  1654. $url = api_get_path(WEB_AJAX_PATH) . 'user_manager.ajax.php?a=get_user_popup&resizable=0&height=300&user_id=' . $teacher['user_id'];
  1655. $teacher_name = Display::url(
  1656. $teacher_name,
  1657. $url,
  1658. array('class' => 'ajax')
  1659. );
  1660. }
  1661. $list[] = $teacher_name;
  1662. }
  1663. if (!empty($list)) {
  1664. $teacher_string = array_to_string($list, $separator);
  1665. }
  1666. }
  1667. return $teacher_string;
  1668. }
  1669. /**
  1670. * This function returns information about coachs from a course in session
  1671. * @param int $session_id
  1672. * @param int $courseId
  1673. * @return array - array containing user_id, lastname, firstname, username
  1674. *
  1675. */
  1676. public static function get_coachs_from_course($session_id = 0, $courseId = '')
  1677. {
  1678. if (!empty($session_id)) {
  1679. $session_id = intval($session_id);
  1680. } else {
  1681. $session_id = api_get_session_id();
  1682. }
  1683. if (!empty($courseId)) {
  1684. $courseId = intval($courseId);
  1685. } else {
  1686. $courseId = api_get_course_int_id();
  1687. }
  1688. $tbl_user = Database:: get_main_table(TABLE_MAIN_USER);
  1689. $tbl_session_course_user = Database:: get_main_table(TABLE_MAIN_SESSION_COURSE_USER);
  1690. $coaches = array();
  1691. $sql = "SELECT DISTINCT u.user_id,u.lastname,u.firstname,u.username
  1692. FROM $tbl_user u, $tbl_session_course_user scu
  1693. WHERE
  1694. u.user_id = scu.user_id AND
  1695. scu.session_id = '$session_id' AND
  1696. scu.c_id = '$courseId' AND
  1697. scu.status = 2";
  1698. $rs = Database::query($sql);
  1699. if (Database::num_rows($rs) > 0) {
  1700. while ($row = Database::fetch_array($rs)) {
  1701. $coaches[] = $row;
  1702. }
  1703. return $coaches;
  1704. } else {
  1705. return false;
  1706. }
  1707. }
  1708. /**
  1709. * @param int $session_id
  1710. * @param int $courseId
  1711. * @param string $separator
  1712. * @param bool $add_link_to_profile
  1713. * @return null|string
  1714. */
  1715. public static function get_coachs_from_course_to_string(
  1716. $session_id = 0,
  1717. $courseId = null,
  1718. $separator = self::USER_SEPARATOR,
  1719. $add_link_to_profile = false
  1720. ) {
  1721. $coachs_course = self::get_coachs_from_course($session_id, $courseId);
  1722. $course_coachs = array();
  1723. if (is_array($coachs_course)) {
  1724. foreach ($coachs_course as $coach_course) {
  1725. $coach_name = api_get_person_name($coach_course['firstname'], $coach_course['lastname']);
  1726. if ($add_link_to_profile) {
  1727. $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'];
  1728. $coach_name = Display::url($coach_name, $url, array('class' => 'ajax'));
  1729. }
  1730. $course_coachs[] = $coach_name;
  1731. }
  1732. }
  1733. $coaches_to_string = null;
  1734. if (is_array($course_coachs) && count($course_coachs) > 0) {
  1735. $coaches_to_string = array_to_string($course_coachs, $separator);
  1736. }
  1737. return $coaches_to_string;
  1738. }
  1739. /**
  1740. * @param int $courseId
  1741. * @param int $session_id
  1742. * @return string
  1743. * @deprecated seem not to be use
  1744. */
  1745. public static function get_coach_list_from_course_code_to_string($courseId, $session_id)
  1746. {
  1747. $tutor_data = '';
  1748. if ($session_id != 0) {
  1749. $coaches = self::get_email_of_tutor_to_session($session_id, $courseId);
  1750. $coach_list = array();
  1751. foreach ($coaches as $coach) {
  1752. $coach_list[] = $coach['complete_name'];
  1753. }
  1754. if (!empty($coach_list)) {
  1755. $tutor_data = implode(self::USER_SEPARATOR, $coach_list);
  1756. }
  1757. }
  1758. return $tutor_data;
  1759. }
  1760. /**
  1761. * Return user info array of all users registered in the specified course
  1762. * this includes the users of the course itself and the users of all linked courses.
  1763. *
  1764. * @param string $course_code
  1765. * @param bool $with_sessions
  1766. * @param int $session_id
  1767. * @return array with user info
  1768. */
  1769. public static function get_real_and_linked_user_list($course_code, $with_sessions = true, $session_id = 0)
  1770. {
  1771. //get list of virtual courses
  1772. $virtual_course_list = self::get_virtual_courses_linked_to_real_course($course_code);
  1773. $complete_user_list = array();
  1774. //get users from real course
  1775. $user_list = self::get_user_list_from_course_code($course_code, $session_id);
  1776. foreach ($user_list as $this_user) {
  1777. $complete_user_list[] = $this_user;
  1778. }
  1779. //get users from linked courses
  1780. foreach ($virtual_course_list as $this_course) {
  1781. $course_code = $this_course['code'];
  1782. $user_list = self::get_user_list_from_course_code($course_code, $session_id);
  1783. foreach ($user_list as $this_user) {
  1784. $complete_user_list[] = $this_user;
  1785. }
  1786. }
  1787. return $complete_user_list;
  1788. }
  1789. /**
  1790. * Return an array of arrays, listing course info of all courses in the list
  1791. * linked to the real course $real_course_code, to which the user $user_id is subscribed.
  1792. *
  1793. * @param $user_id , the id (int) of the user
  1794. * @param $real_course_code , the id (char) of the real course
  1795. *
  1796. * @return array of course info arrays
  1797. * @deprecated virtual course feature is not supported
  1798. */
  1799. public static function get_list_of_virtual_courses_for_specific_user_and_real_course($user_id, $course_code)
  1800. {
  1801. $result_array = array();
  1802. if ($user_id != strval(intval($user_id))) {
  1803. return $result_array;
  1804. }
  1805. $course_code = Database::escape_string($course_code);
  1806. $sql = "SELECT *
  1807. FROM " . Database::get_main_table(TABLE_MAIN_COURSE) . " course
  1808. LEFT JOIN " . Database::get_main_table(TABLE_MAIN_COURSE_USER) . " course_user
  1809. ON course.id = course_user.c_id
  1810. WHERE
  1811. course.target_course_code = '$course_code' AND
  1812. course_user.user_id = '$user_id' AND
  1813. course_user.relation_type<>" . COURSE_RELATION_TYPE_RRHH . " ";
  1814. $sql_result = Database::query($sql);
  1815. while ($result = Database::fetch_array($sql_result)) {
  1816. $result_array[] = $result;
  1817. }
  1818. return $result_array;
  1819. }
  1820. /**
  1821. * Get the list of groups from the course
  1822. * @param string $course_code
  1823. * @param int $session_id Session ID (optional)
  1824. * @param boolean $in_get_empty_group get empty groups (optional)
  1825. * @return array List of groups info
  1826. */
  1827. public static function get_group_list_of_course($course_code, $session_id = 0, $in_get_empty_group = 0)
  1828. {
  1829. $course_info = api_get_course_info($course_code);
  1830. if (empty($course_info)) {
  1831. return array();
  1832. }
  1833. $course_id = $course_info['real_id'];
  1834. if (empty($course_id)) {
  1835. return array();
  1836. }
  1837. $group_list = array();
  1838. $session_id != 0 ? $session_condition = ' WHERE g.session_id IN(1,' . intval($session_id) . ')' : $session_condition = ' WHERE g.session_id = 0';
  1839. if ($in_get_empty_group == 0) {
  1840. // get only groups that are not empty
  1841. $sql = "SELECT DISTINCT g.id, g.name
  1842. FROM " . Database::get_course_table(TABLE_GROUP) . " AS g
  1843. INNER JOIN " . Database::get_course_table(TABLE_GROUP_USER) . " gu
  1844. ON (g.id = gu.group_id AND g.c_id = $course_id AND gu.c_id = $course_id)
  1845. $session_condition
  1846. ORDER BY g.name";
  1847. } else {
  1848. // get all groups even if they are empty
  1849. $sql = "SELECT g.id, g.name
  1850. FROM " . Database::get_course_table(TABLE_GROUP) . " AS g
  1851. $session_condition
  1852. AND c_id = $course_id";
  1853. }
  1854. $result = Database::query($sql);
  1855. while ($group_data = Database::fetch_array($result)) {
  1856. $group_data['userNb'] = GroupManager::number_of_students($group_data['id'], $course_id);
  1857. $group_list[$group_data['id']] = $group_data;
  1858. }
  1859. return $group_list;
  1860. }
  1861. /**
  1862. * Delete a course
  1863. * This function deletes a whole course-area from the platform. When the
  1864. * given course is a virtual course, the database and directory will not be
  1865. * deleted.
  1866. * When the given course is a real course, also all virtual courses refering
  1867. * to the given course will be deleted.
  1868. * Considering the fact that we remove all traces of the course in the main
  1869. * database, it makes sense to remove all tracking as well (if stats databases exist)
  1870. * so that a new course created with this code would not use the remains of an older
  1871. * course.
  1872. *
  1873. * @param string The code of the course to delete
  1874. * @todo When deleting a virtual course: unsubscribe users from that virtual
  1875. * course from the groups in the real course if they are not subscribed in
  1876. * that real course.
  1877. * @todo Remove globals
  1878. */
  1879. public static function delete_course($code)
  1880. {
  1881. $table_course = Database::get_main_table(TABLE_MAIN_COURSE);
  1882. $table_course_user = Database::get_main_table(TABLE_MAIN_COURSE_USER);
  1883. $table_session_course = Database::get_main_table(TABLE_MAIN_SESSION_COURSE);
  1884. $table_session_course_user = Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER);
  1885. $table_course_survey = Database::get_main_table(TABLE_MAIN_SHARED_SURVEY);
  1886. $table_course_survey_question = Database::get_main_table(TABLE_MAIN_SHARED_SURVEY_QUESTION);
  1887. $table_course_survey_question_option = Database::get_main_table(TABLE_MAIN_SHARED_SURVEY_QUESTION_OPTION);
  1888. $table_course_rel_url = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_COURSE);
  1889. $table_stats_hotpots = Database::get_main_table(TABLE_STATISTIC_TRACK_E_HOTPOTATOES);
  1890. $table_stats_attempt = Database::get_main_table(TABLE_STATISTIC_TRACK_E_ATTEMPT);
  1891. $table_stats_exercises = Database::get_main_table(TABLE_STATISTIC_TRACK_E_EXERCISES);
  1892. $table_stats_access = Database::get_main_table(TABLE_STATISTIC_TRACK_E_ACCESS);
  1893. $table_stats_lastaccess = Database::get_main_table(TABLE_STATISTIC_TRACK_E_LASTACCESS);
  1894. $table_stats_course_access = Database::get_main_table(TABLE_STATISTIC_TRACK_E_COURSE_ACCESS);
  1895. $table_stats_online = Database::get_main_table(TABLE_STATISTIC_TRACK_E_ONLINE);
  1896. $table_stats_default = Database::get_main_table(TABLE_STATISTIC_TRACK_E_DEFAULT);
  1897. $table_stats_downloads = Database::get_main_table(TABLE_STATISTIC_TRACK_E_DOWNLOADS);
  1898. $table_stats_links = Database::get_main_table(TABLE_STATISTIC_TRACK_E_LINKS);
  1899. $table_stats_uploads = Database::get_main_table(TABLE_STATISTIC_TRACK_E_UPLOADS);
  1900. $codeFiltered = Database::escape_string($code);
  1901. $sql = "SELECT * FROM $table_course WHERE code='" . $codeFiltered . "'";
  1902. $res = Database::query($sql);
  1903. if (Database::num_rows($res) == 0) {
  1904. return;
  1905. }
  1906. $sql = "SELECT * FROM $table_course WHERE code = '" . $codeFiltered . "'";
  1907. $res = Database::query($sql);
  1908. $course = Database::fetch_array($res);
  1909. $courseId = $course['id'];
  1910. $count = 0;
  1911. if (api_is_multiple_url_enabled()) {
  1912. $url_id = 1;
  1913. if (api_get_current_access_url_id() != -1) {
  1914. $url_id = api_get_current_access_url_id();
  1915. }
  1916. UrlManager::delete_url_rel_course($courseId, $url_id);
  1917. $count = UrlManager::getcountUrlRelCourse($courseId);
  1918. }
  1919. if ($count == 0) {
  1920. self::create_database_dump($code);
  1921. $course_tables = AddCourse::get_course_tables();
  1922. // Cleaning c_x tables
  1923. if (!empty($courseId)) {
  1924. foreach ($course_tables as $table) {
  1925. $table = Database::get_course_table($table);
  1926. $sql = "DELETE FROM $table WHERE c_id = $courseId ";
  1927. Database::query($sql);
  1928. }
  1929. }
  1930. $course_dir = api_get_path(SYS_COURSE_PATH) . $course['directory'];
  1931. $archive_dir = api_get_path(SYS_ARCHIVE_PATH) . $course['directory'] . '_' . time();
  1932. if (is_dir($course_dir)) {
  1933. rename($course_dir, $archive_dir);
  1934. }
  1935. // Unsubscribe all classes from the course
  1936. /*$sql = "DELETE FROM $table_course_class WHERE course_code='".$code."'";
  1937. Database::query($sql);*/
  1938. // Unsubscribe all users from the course
  1939. $sql = "DELETE FROM $table_course_user WHERE c_id='" . $courseId . "'";
  1940. Database::query($sql);
  1941. // Delete the course from the sessions tables
  1942. $sql = "DELETE FROM $table_session_course WHERE c_id='" . $courseId . "'";
  1943. Database::query($sql);
  1944. $sql = "DELETE FROM $table_session_course_user WHERE c_id='" . $courseId . "'";
  1945. Database::query($sql);
  1946. // Delete from Course - URL
  1947. $sql = "DELETE FROM $table_course_rel_url WHERE c_id = '" . $courseId. "'";
  1948. Database::query($sql);
  1949. $sql = 'SELECT survey_id FROM ' . $table_course_survey . ' WHERE course_code="' . $codeFiltered . '"';
  1950. $result_surveys = Database::query($sql);
  1951. while ($surveys = Database::fetch_array($result_surveys)) {
  1952. $survey_id = $surveys[0];
  1953. $sql = 'DELETE FROM ' . $table_course_survey_question . ' WHERE survey_id="' . $survey_id . '"';
  1954. Database::query($sql);
  1955. $sql = 'DELETE FROM ' . $table_course_survey_question_option . ' WHERE survey_id="' . $survey_id . '"';
  1956. Database::query($sql);
  1957. $sql = 'DELETE FROM ' . $table_course_survey . ' WHERE survey_id="' . $survey_id . '"';
  1958. Database::query($sql);
  1959. }
  1960. // Delete the course from the stats tables
  1961. $sql = "DELETE FROM $table_stats_hotpots WHERE c_id = $courseId";
  1962. Database::query($sql);
  1963. $sql = "DELETE FROM $table_stats_attempt WHERE c_id = $courseId";
  1964. Database::query($sql);
  1965. $sql = "DELETE FROM $table_stats_exercises WHERE c_id = $courseId";
  1966. Database::query($sql);
  1967. $sql = "DELETE FROM $table_stats_access WHERE c_id = $courseId";
  1968. Database::query($sql);
  1969. $sql = "DELETE FROM $table_stats_lastaccess WHERE c_id = $courseId";
  1970. Database::query($sql);
  1971. $sql = "DELETE FROM $table_stats_course_access WHERE c_id = $courseId";
  1972. Database::query($sql);
  1973. $sql = "DELETE FROM $table_stats_online WHERE c_id = $courseId";
  1974. Database::query($sql);
  1975. // Do not delete rows from track_e_default as these include course
  1976. // creation and other important things that do not take much space
  1977. // but give information on the course history
  1978. //$sql = "DELETE FROM $table_stats_default WHERE c_id = $courseId";
  1979. //Database::query($sql);
  1980. $sql = "DELETE FROM $table_stats_downloads WHERE c_id = $courseId";
  1981. Database::query($sql);
  1982. $sql = "DELETE FROM $table_stats_links WHERE c_id = $courseId";
  1983. Database::query($sql);
  1984. $sql = "DELETE FROM $table_stats_uploads WHERE c_id = $courseId";
  1985. Database::query($sql);
  1986. // Delete the course from the database
  1987. $sql = "DELETE FROM $table_course WHERE code = '" . $codeFiltered . "'";
  1988. Database::query($sql);
  1989. // delete extra course fields
  1990. $extraFieldValues = new ExtraFieldValue('course');
  1991. $extraFieldValues->deleteValuesByItem($courseId);
  1992. // Add event to system log
  1993. $user_id = api_get_user_id();
  1994. Event::addEvent(
  1995. LOG_COURSE_DELETE,
  1996. LOG_COURSE_CODE,
  1997. $code,
  1998. api_get_utc_datetime(),
  1999. $user_id,
  2000. $courseId
  2001. );
  2002. }
  2003. }
  2004. /**
  2005. * Creates a file called mysql_dump.sql in the course folder
  2006. * @param $course_code The code of the course
  2007. * @todo Implementation for single database
  2008. */
  2009. public static function create_database_dump($course_code)
  2010. {
  2011. $sql_dump = '';
  2012. $course_code = Database::escape_string($course_code);
  2013. $table_course = Database::get_main_table(TABLE_MAIN_COURSE);
  2014. $sql = "SELECT * FROM $table_course WHERE code = '$course_code'";
  2015. $res = Database::query($sql);
  2016. $course = Database::fetch_array($res);
  2017. $course_tables = AddCourse::get_course_tables();
  2018. if (!empty($course['id'])) {
  2019. //Cleaning c_x tables
  2020. foreach ($course_tables as $table) {
  2021. $table = Database::get_course_table($table);
  2022. $sql = "SELECT * FROM $table WHERE c_id = {$course['id']} ";
  2023. $res_table = Database::query($sql);
  2024. while ($row = Database::fetch_array($res_table, 'ASSOC')) {
  2025. $row_to_save = array();
  2026. foreach ($row as $key => $value) {
  2027. $row_to_save[$key] = $key . "='" . Database::escape_string($row[$key]) . "'";
  2028. }
  2029. $sql_dump .= "\nINSERT INTO $table SET " . implode(', ', $row_to_save) . ';';
  2030. }
  2031. }
  2032. }
  2033. if (is_dir(api_get_path(SYS_COURSE_PATH) . $course['directory'])) {
  2034. $file_name = api_get_path(SYS_COURSE_PATH) . $course['directory'] . '/mysql_dump.sql';
  2035. $handle = fopen($file_name, 'a+');
  2036. if ($handle !== false) {
  2037. fwrite($handle, $sql_dump);
  2038. fclose($handle);
  2039. } else {
  2040. //TODO trigger exception in a try-catch
  2041. }
  2042. }
  2043. }
  2044. /**
  2045. * Sort courses for a specific user ??
  2046. * @param int User ID
  2047. * @param string Course code
  2048. * @return int Minimum course order
  2049. * @todo Review documentation
  2050. */
  2051. public static function userCourseSort($user_id, $course_code)
  2052. {
  2053. if ($user_id != strval(intval($user_id))) {
  2054. return false;
  2055. }
  2056. $course_code = Database::escape_string($course_code);
  2057. $TABLECOURSE = Database::get_main_table(TABLE_MAIN_COURSE);
  2058. $TABLECOURSUSER = Database::get_main_table(TABLE_MAIN_COURSE_USER);
  2059. $course_title = Database::result(Database::query('SELECT title FROM ' . $TABLECOURSE . ' WHERE code="' . $course_code . '"'),
  2060. 0, 0);
  2061. $sql = 'SELECT course.code as code, course.title as title, cu.sort as sort
  2062. FROM ' . $TABLECOURSUSER . ' as cu, ' . $TABLECOURSE . ' as course
  2063. WHERE course.id = cu.c_id AND user_id = "' . $user_id . '" AND
  2064. cu.relation_type<>' . COURSE_RELATION_TYPE_RRHH . ' AND
  2065. user_course_cat = 0
  2066. ORDER BY cu.sort';
  2067. $result = Database::query($sql);
  2068. $course_title_precedent = '';
  2069. $counter = 0;
  2070. $course_found = false;
  2071. $course_sort = 1;
  2072. if (Database::num_rows($result) > 0) {
  2073. while ($courses = Database::fetch_array($result)) {
  2074. if ($course_title_precedent == '') {
  2075. $course_title_precedent = $courses['title'];
  2076. }
  2077. if (api_strcasecmp($course_title_precedent, $course_title) < 0) {
  2078. $course_found = true;
  2079. $course_sort = $courses['sort'];
  2080. if ($counter == 0) {
  2081. $sql = 'UPDATE ' . $TABLECOURSUSER . '
  2082. SET sort = sort+1
  2083. WHERE
  2084. user_id= "' . $user_id . '" AND
  2085. relation_type<>' . COURSE_RELATION_TYPE_RRHH . '
  2086. AND user_course_cat="0"
  2087. AND sort > "' . $course_sort . '"';
  2088. $course_sort++;
  2089. } else {
  2090. $sql = 'UPDATE ' . $TABLECOURSUSER . ' SET sort = sort+1
  2091. WHERE
  2092. user_id= "' . $user_id . '" AND
  2093. relation_type<>' . COURSE_RELATION_TYPE_RRHH . ' AND
  2094. user_course_cat="0" AND
  2095. sort >= "' . $course_sort . '"';
  2096. }
  2097. Database::query($sql);
  2098. break;
  2099. } else {
  2100. $course_title_precedent = $courses['title'];
  2101. }
  2102. $counter++;
  2103. }
  2104. // We must register the course in the beginning of the list
  2105. if (!$course_found) {
  2106. $course_sort = Database::result(Database::query('SELECT min(sort) as min_sort FROM ' . $TABLECOURSUSER . ' WHERE user_id="' . $user_id . '" AND user_course_cat="0"'),
  2107. 0, 0);
  2108. Database::query('UPDATE ' . $TABLECOURSUSER . ' SET sort = sort+1 WHERE user_id= "' . $user_id . '" AND user_course_cat="0"');
  2109. }
  2110. }
  2111. return $course_sort;
  2112. }
  2113. /**
  2114. * create recursively all categories as option of the select passed in parameter.
  2115. *
  2116. * @param HTML_QuickForm_Element $element
  2117. * @param string $defaultCode the option value to select by default (used mainly for edition of courses)
  2118. * @param string $parentCode the parent category of the categories added (default=null for root category)
  2119. * @param string $padding the indent param (you shouldn't indicate something here)
  2120. * @deprecated use the select_ajax solution see admin/course_edit.php
  2121. */
  2122. public static function select_and_sort_categories(
  2123. $element,
  2124. $defaultCode = null,
  2125. $parentCode = null,
  2126. $padding = null
  2127. ) {
  2128. setCategoriesInForm($element, $defaultCode, $parentCode, $padding);
  2129. }
  2130. /**
  2131. * check if course exists
  2132. * @param string course_code
  2133. * @param string whether to accept virtual course codes or not
  2134. * @return true if exists, false else
  2135. */
  2136. public static function course_exists($course_code, $accept_virtual = false)
  2137. {
  2138. if ($accept_virtual === true) {
  2139. $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) . '"';
  2140. } else {
  2141. $sql = 'SELECT 1 FROM ' . Database::get_main_table(TABLE_MAIN_COURSE) . ' WHERE code="' . Database::escape_string($course_code) . '"';
  2142. }
  2143. return Database::num_rows(Database::query($sql));
  2144. }
  2145. /**
  2146. * Send an email to tutor after the auth-suscription of a student in your course
  2147. * @author Carlos Vargas <carlos.vargas@dokeos.com>, Dokeos Latino
  2148. * @param int $user_id the id of the user
  2149. * @param string $course_code the course code
  2150. * @param bool $send_to_tutor_also
  2151. * @return string we return the message that is displayed when the action is successful
  2152. */
  2153. public static function email_to_tutor($user_id, $courseId, $send_to_tutor_also = false)
  2154. {
  2155. if ($user_id != strval(intval($user_id))) {
  2156. return false;
  2157. }
  2158. $courseId = intval($courseId);
  2159. $information = api_get_course_info_by_id($courseId);
  2160. $course_code = $information['code'];
  2161. $courseId = $information['id'];
  2162. $student = api_get_user_info($user_id);
  2163. $name_course = $information['title'];
  2164. $sql = "SELECT * FROM " . Database::get_main_table(TABLE_MAIN_COURSE_USER) . " WHERE c_id ='" . $courseId . "'";
  2165. // TODO: Ivan: This is a mistake, please, have a look at it. Intention here is diffcult to be guessed.
  2166. //if ($send_to_tutor_also = true)
  2167. // Proposed change:
  2168. if ($send_to_tutor_also) {
  2169. $sql .= " AND is_tutor=1";
  2170. } else {
  2171. $sql .= " AND status=1";
  2172. }
  2173. $result = Database::query($sql);
  2174. while ($row = Database::fetch_array($result)) {
  2175. $tutor = api_get_user_info($row['user_id']);
  2176. $emailto = $tutor['email'];
  2177. $emailsubject = get_lang('NewUserInTheCourse') . ': ' . $name_course;
  2178. $emailbody = get_lang('Dear') . ': ' . api_get_person_name($tutor['firstname'], $tutor['lastname']) . "\n";
  2179. $emailbody .= get_lang('MessageNewUserInTheCourse') . ': ' . $name_course . "\n";
  2180. $emailbody .= get_lang('UserName') . ': ' . $student['username'] . "\n";
  2181. if (api_is_western_name_order()) {
  2182. $emailbody .= get_lang('FirstName') . ': ' . $student['firstname'] . "\n";
  2183. $emailbody .= get_lang('LastName') . ': ' . $student['lastname'] . "\n";
  2184. } else {
  2185. $emailbody .= get_lang('LastName') . ': ' . $student['lastname'] . "\n";
  2186. $emailbody .= get_lang('FirstName') . ': ' . $student['firstname'] . "\n";
  2187. }
  2188. $emailbody .= get_lang('Email') . ': ' . $student['email'] . "\n\n";
  2189. $recipient_name = api_get_person_name($tutor['firstname'], $tutor['lastname'], null,
  2190. PERSON_NAME_EMAIL_ADDRESS);
  2191. $sender_name = api_get_person_name(api_get_setting('administratorName'),
  2192. api_get_setting('administratorSurname'), null, PERSON_NAME_EMAIL_ADDRESS);
  2193. $email_admin = api_get_setting('emailAdministrator');
  2194. $additionalParameters = array(
  2195. 'smsType' => SmsPlugin::NEW_USER_SUBSCRIBED_COURSE,
  2196. 'userId' => $tutor['user_id'],
  2197. 'userUsername' => $student['username'],
  2198. 'courseCode' => $course_code
  2199. );
  2200. api_mail_html(
  2201. $recipient_name,
  2202. $emailto,
  2203. $emailsubject,
  2204. $emailbody,
  2205. $sender_name,
  2206. $email_admin,
  2207. null,
  2208. null,
  2209. null,
  2210. $additionalParameters
  2211. );
  2212. }
  2213. }
  2214. /**
  2215. * @return array
  2216. */
  2217. public static function get_special_course_list()
  2218. {
  2219. $courseTable = Database:: get_main_table(TABLE_MAIN_COURSE);
  2220. $tbl_course_field = Database:: get_main_table(TABLE_EXTRA_FIELD);
  2221. $tbl_course_field_value = Database:: get_main_table(TABLE_EXTRA_FIELD_VALUES);
  2222. //we filter the courses from the URL
  2223. $join_access_url = $where_access_url = '';
  2224. if (api_get_multiple_access_url()) {
  2225. $access_url_id = api_get_current_access_url_id();
  2226. if ($access_url_id != -1) {
  2227. $tbl_url_course = Database:: get_main_table(TABLE_MAIN_ACCESS_URL_REL_COURSE);
  2228. $join_access_url = "LEFT JOIN $tbl_url_course url_rel_course
  2229. ON url_rel_course.c_id = tcfv.c_id ";
  2230. $where_access_url = " AND access_url_id = $access_url_id ";
  2231. }
  2232. }
  2233. $extraFieldType = EntityExtraField::COURSE_FIELD_TYPE;
  2234. // get course list auto-register
  2235. $sql = "SELECT DISTINCT(c.code)
  2236. FROM $tbl_course_field_value tcfv
  2237. INNER JOIN $tbl_course_field tcf
  2238. ON tcfv.field_id = tcf.id $join_access_url
  2239. INNER JOIN $courseTable c
  2240. ON (c.id = tcfv.item_id)
  2241. WHERE
  2242. tcf.extra_field_type = $extraFieldType AND
  2243. tcf.variable = 'special_course' AND
  2244. tcfv.value = 1 $where_access_url";
  2245. $result = Database::query($sql);
  2246. $courseList = array();
  2247. if (Database::num_rows($result) > 0) {
  2248. while ($result_row = Database::fetch_array($result)) {
  2249. $courseList[] = $result_row['code'];
  2250. }
  2251. }
  2252. return $courseList;
  2253. }
  2254. /**
  2255. * Get list of courses for a given user
  2256. * @param int $user_id
  2257. * @param boolean $include_sessions Whether to include courses from session or not
  2258. * @param boolean $adminGetsAllCourses If the user is platform admin, whether he gets all the courses or just his. Note: This does *not* include all sessions
  2259. * @return array List of codes and db name
  2260. * @author isaac flores paz
  2261. */
  2262. public static function get_courses_list_by_user_id($user_id, $include_sessions = false, $adminGetsAllCourses = false)
  2263. {
  2264. $user_id = intval($user_id);
  2265. $course_list = array();
  2266. $codes = array();
  2267. $tbl_course = Database::get_main_table(TABLE_MAIN_COURSE);
  2268. $tbl_course_user = Database::get_main_table(TABLE_MAIN_COURSE_USER);
  2269. $tbl_user_course_category = Database::get_main_table(TABLE_USER_COURSE_CATEGORY);
  2270. $special_course_list = self::get_special_course_list();
  2271. if ($adminGetsAllCourses && UserManager::is_admin($user_id)) {
  2272. // get the whole courses list
  2273. $sql = "SELECT DISTINCT(course.code), course.id as real_id
  2274. FROM $tbl_course course";
  2275. } else {
  2276. $with_special_courses = $without_special_courses = '';
  2277. if (!empty($special_course_list)) {
  2278. $sc_string = '"' . implode('","', $special_course_list) . '"';
  2279. $with_special_courses = ' course.code IN (' . $sc_string . ')';
  2280. $without_special_courses = ' AND course.code NOT IN (' . $sc_string . ')';
  2281. }
  2282. if (!empty($with_special_courses)) {
  2283. $sql = "SELECT DISTINCT(course.code), course.id as real_id
  2284. FROM " . $tbl_course_user . " course_rel_user
  2285. LEFT JOIN " . $tbl_course . " course
  2286. ON course.id = course_rel_user.c_id
  2287. LEFT JOIN " . $tbl_user_course_category . " user_course_category
  2288. ON course_rel_user.user_course_cat = user_course_category.id
  2289. WHERE $with_special_courses
  2290. GROUP BY course.code
  2291. ORDER BY user_course_category.sort,course.title,course_rel_user.sort ASC";
  2292. $rs_special_course = Database::query($sql);
  2293. if (Database::num_rows($rs_special_course) > 0) {
  2294. while ($result_row = Database::fetch_array($rs_special_course)) {
  2295. $result_row['special_course'] = 1;
  2296. $course_list[] = $result_row;
  2297. $codes[] = $result_row['real_id'];
  2298. }
  2299. }
  2300. }
  2301. // get course list not auto-register. Use Distinct to avoid multiple
  2302. // entries when a course is assigned to a HRD (DRH) as watcher
  2303. $sql = "SELECT DISTINCT(course.code), course.id as real_id
  2304. FROM $tbl_course course
  2305. INNER JOIN $tbl_course_user cru ON course.id = cru.c_id
  2306. WHERE cru.user_id='$user_id' $without_special_courses";
  2307. }
  2308. $result = Database::query($sql);
  2309. if (Database::num_rows($result)) {
  2310. while ($row = Database::fetch_array($result, 'ASSOC')) {
  2311. $course_list[] = $row;
  2312. $codes[] = $row['real_id'];
  2313. }
  2314. }
  2315. if ($include_sessions === true) {
  2316. $sql = "SELECT DISTINCT(c.code), c.id as real_id
  2317. FROM " . Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER) . " s, " . Database::get_main_table(TABLE_MAIN_COURSE) . " c
  2318. WHERE user_id = $user_id AND s.c_id = c.id";
  2319. $r = Database::query($sql);
  2320. while ($row = Database::fetch_array($r, 'ASSOC')) {
  2321. if (!in_array($row['real_id'], $codes)) {
  2322. $course_list[] = $row;
  2323. }
  2324. }
  2325. }
  2326. return $course_list;
  2327. }
  2328. /**
  2329. * Get course ID from a given course directory name
  2330. * @param string Course directory (without any slash)
  2331. * @return string Course code, or false if not found
  2332. */
  2333. public static function get_course_id_from_path($path)
  2334. {
  2335. $path = Database::escape_string(str_replace('.', '', str_replace('/', '', $path)));
  2336. $res = Database::query("SELECT code FROM " . Database::get_main_table(TABLE_MAIN_COURSE) . "
  2337. WHERE directory LIKE BINARY '$path'");
  2338. if ($res === false) {
  2339. return false;
  2340. }
  2341. if (Database::num_rows($res) != 1) {
  2342. return false;
  2343. }
  2344. $row = Database::fetch_array($res);
  2345. return $row['code'];
  2346. }
  2347. /**
  2348. * Get course code(s) from visual code
  2349. * @deprecated
  2350. * @param string Visual code
  2351. * @return array List of codes for the given visual code
  2352. */
  2353. public static function get_courses_info_from_visual_code($code)
  2354. {
  2355. $result = array();
  2356. $sql_result = Database::query("SELECT * FROM " . Database::get_main_table(TABLE_MAIN_COURSE) . "
  2357. WHERE visual_code = '" . Database::escape_string($code) . "'");
  2358. while ($virtual_course = Database::fetch_array($sql_result)) {
  2359. $result[] = $virtual_course;
  2360. }
  2361. return $result;
  2362. }
  2363. /**
  2364. * Get emails of tutors to course
  2365. * @param string Visual code
  2366. * @return array List of emails of tutors to course
  2367. * @author @author Carlos Vargas <carlos.vargas@dokeos.com>, Dokeos Latino
  2368. * */
  2369. public static function get_emails_of_tutors_to_course($courseId)
  2370. {
  2371. $list = array();
  2372. $res = Database::query("SELECT user_id FROM " . Database::get_main_table(TABLE_MAIN_COURSE_USER) . "
  2373. WHERE c_id ='" . intval($courseId) . "' AND status=1");
  2374. while ($list_users = Database::fetch_array($res)) {
  2375. $result = Database::query("SELECT * FROM " . Database::get_main_table(TABLE_MAIN_USER) . "
  2376. WHERE user_id=" . $list_users['user_id']);
  2377. while ($row_user = Database::fetch_array($result)) {
  2378. $name_teacher = api_get_person_name($row_user['firstname'], $row_user['lastname']);
  2379. $list[] = array($row_user['email'] => $name_teacher);
  2380. }
  2381. }
  2382. return $list;
  2383. }
  2384. /**
  2385. * Get coaches emails by session
  2386. * @param int session id
  2387. * @param int $courseId
  2388. * @return array array(email => name_tutor) by coach
  2389. * @author Carlos Vargas <carlos.vargas@dokeos.com>
  2390. */
  2391. public static function get_email_of_tutor_to_session($session_id, $courseId)
  2392. {
  2393. $tbl_session_course_user = Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER);
  2394. $tbl_user = Database::get_main_table(TABLE_MAIN_USER);
  2395. $coachs_emails = array();
  2396. $courseId = intval($courseId);
  2397. $session_id = intval($session_id);
  2398. $sql = "SELECT user_id
  2399. FROM $tbl_session_course_user
  2400. WHERE
  2401. session_id = '$session_id' AND
  2402. c_id = '$courseId' AND
  2403. status = 2
  2404. ";
  2405. $rs = Database::query($sql);
  2406. if (Database::num_rows($rs) > 0) {
  2407. $user_ids = array();
  2408. while ($row = Database::fetch_array($rs)) {
  2409. $user_ids[] = $row['user_id'];
  2410. }
  2411. $sql = "SELECT firstname, lastname, email FROM $tbl_user
  2412. WHERE user_id IN (" . implode(",", $user_ids) . ")";
  2413. $rs_user = Database::query($sql);
  2414. while ($row_emails = Database::fetch_array($rs_user)) {
  2415. $mail_tutor = array(
  2416. 'email' => $row_emails['email'],
  2417. 'complete_name' => api_get_person_name($row_emails['firstname'], $row_emails['lastname'])
  2418. );
  2419. $coachs_emails[] = $mail_tutor;
  2420. }
  2421. }
  2422. return $coachs_emails;
  2423. }
  2424. /**
  2425. * Creates a new extra field for a given course
  2426. * @param string Field's internal variable name
  2427. * @param int Field's type
  2428. * @param string Field's language var name
  2429. * @return int new extra field id
  2430. */
  2431. public static function create_course_extra_field($variable, $fieldType, $displayText, $default)
  2432. {
  2433. $extraField = new ExtraField('course');
  2434. $params = [
  2435. 'variable' => $variable,
  2436. 'field_type' => $fieldType,
  2437. 'display_text' => $displayText,
  2438. 'default_value' => $default
  2439. ];
  2440. return $extraField->save($params);
  2441. }
  2442. /**
  2443. * Updates course attribute. Note that you need to check that your
  2444. * attribute is valid before you use this function
  2445. *
  2446. * @param int Course id
  2447. * @param string Attribute name
  2448. * @param string Attribute value
  2449. * @return bool True if attribute was successfully updated,
  2450. * false if course was not found or attribute name is invalid
  2451. */
  2452. public static function update_attribute($id, $name, $value)
  2453. {
  2454. $id = (int)$id;
  2455. $table = Database::get_main_table(TABLE_MAIN_COURSE);
  2456. $sql = "UPDATE $table SET $name = '" . Database::escape_string($value) . "'
  2457. WHERE id = '$id';";
  2458. return Database::query($sql);
  2459. }
  2460. /**
  2461. * Update course attributes. Will only update attributes with a non-empty value.
  2462. * Note that you NEED to check that your attributes are valid before using this function
  2463. *
  2464. * @param int Course id
  2465. * @param array Associative array with field names as keys and field values as values
  2466. * @return bool True if update was successful, false otherwise
  2467. */
  2468. public static function update_attributes($id, $attributes)
  2469. {
  2470. $id = (int)$id;
  2471. $table = Database::get_main_table(TABLE_MAIN_COURSE);
  2472. $sql = "UPDATE $table SET ";
  2473. $i = 0;
  2474. foreach ($attributes as $name => $value) {
  2475. if ($value != '') {
  2476. if ($i > 0) {
  2477. $sql .= ", ";
  2478. }
  2479. $sql .= " $name = '" . Database::escape_string($value) . "'";
  2480. $i++;
  2481. }
  2482. }
  2483. $sql .= " WHERE id = '$id';";
  2484. return Database::query($sql);
  2485. }
  2486. /**
  2487. * Update an extra field value for a given course
  2488. * @param integer Course ID
  2489. * @param string Field variable name
  2490. * @param string Field value
  2491. * @return boolean true if field updated, false otherwise
  2492. */
  2493. public static function update_course_extra_field_value($course_code, $variable, $value = '')
  2494. {
  2495. $courseInfo = api_get_course_info($course_code);
  2496. $courseId = $courseInfo['real_id'];
  2497. $extraFieldValues = new ExtraFieldValue('course');
  2498. $params = [
  2499. 'item_id' => $courseId,
  2500. 'variable' => $variable,
  2501. 'value' => $value
  2502. ];
  2503. $extraFieldValues->save($params);
  2504. }
  2505. /**
  2506. * @param int $session_id
  2507. * @return mixed
  2508. */
  2509. public static function get_session_category_id_by_session_id($session_id)
  2510. {
  2511. return Database::result(
  2512. Database::query('SELECT sc.id session_category
  2513. FROM ' . Database::get_main_table(TABLE_MAIN_SESSION_CATEGORY) . ' sc
  2514. INNER JOIN ' . Database::get_main_table(TABLE_MAIN_SESSION) . ' s
  2515. ON sc.id=s.session_category_id WHERE s.id="' . Database::escape_string($session_id) . '"'),
  2516. 0,
  2517. 'session_category'
  2518. );
  2519. }
  2520. /**
  2521. * Gets the value of a course extra field. Returns null if it was not found
  2522. *
  2523. * @param string Name of the extra field
  2524. * @param string Course code
  2525. *
  2526. * @return string Value
  2527. */
  2528. public static function get_course_extra_field_value($variable, $code)
  2529. {
  2530. $courseInfo = api_get_course_info($code);
  2531. $courseId = $courseInfo['real_id'];
  2532. $extraFieldValues = new ExtraFieldValue('course');
  2533. $result = $extraFieldValues->get_values_by_handler_and_field_variable($variable, $courseId);
  2534. if (!empty($result['value'])) {
  2535. return $result['value'];
  2536. }
  2537. return null;
  2538. }
  2539. /**
  2540. * Lists details of the course description
  2541. * @param array The course description
  2542. * @param string The encoding
  2543. * @param bool If true is displayed if false is hidden
  2544. * @return string The course description in html
  2545. */
  2546. public static function get_details_course_description_html($descriptions, $charset, $action_show = true)
  2547. {
  2548. $data = null;
  2549. if (isset($descriptions) && count($descriptions) > 0) {
  2550. foreach ($descriptions as $description) {
  2551. $data .= '<div class="sectiontitle">';
  2552. if (api_is_allowed_to_edit() && $action_show) {
  2553. //delete
  2554. $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'),
  2555. ENT_QUOTES, $charset)) . '\')) return false;">';
  2556. $data .= Display::return_icon('delete.gif', get_lang('Delete'),
  2557. array('style' => 'vertical-align:middle;float:right;'));
  2558. $data .= '</a> ';
  2559. //edit
  2560. $data .= '<a href="' . api_get_self() . '?' . api_get_cidreq() . '&amp;description_id=' . $description->id . '">';
  2561. $data .= Display::return_icon('edit.png', get_lang('Edit'),
  2562. array('style' => 'vertical-align:middle;float:right; padding-right:4px;'), ICON_SIZE_SMALL);
  2563. $data .= '</a> ';
  2564. }
  2565. $data .= $description->title;
  2566. $data .= '</div>';
  2567. $data .= '<div class="sectioncomment">';
  2568. $data .= $description->content;
  2569. $data .= '</div>';
  2570. }
  2571. } else {
  2572. $data .= '<em>' . get_lang('ThisCourseDescriptionIsEmpty') . '</em>';
  2573. }
  2574. return $data;
  2575. }
  2576. /**
  2577. * Returns the details of a course category
  2578. *
  2579. * @param string Category code
  2580. * @return array Course category
  2581. */
  2582. public static function get_course_category($code)
  2583. {
  2584. $table_categories = Database::get_main_table(TABLE_MAIN_CATEGORY);
  2585. $sql = "SELECT * FROM $table_categories WHERE code = '$code';";
  2586. return Database::fetch_array(Database::query($sql));
  2587. }
  2588. /**
  2589. * Get count rows of a table inside a course database
  2590. * @param string $table The table of which the rows should be counted
  2591. * @param int $session_id optionally count rows by session id
  2592. * @return int $course_id The number of rows in the given table.
  2593. * @deprecated
  2594. */
  2595. public static function count_rows_course_table($table, $session_id = '', $course_id = null)
  2596. {
  2597. $condition_session = '';
  2598. if ($session_id !== '') {
  2599. $session_id = intval($session_id);
  2600. $condition_session = " AND session_id = '$session_id' ";
  2601. }
  2602. if (!empty($course_id)) {
  2603. $course_id = intval($course_id);
  2604. } else {
  2605. $course_id = api_get_course_int_id();
  2606. }
  2607. $condition_session .= " AND c_id = '$course_id' ";
  2608. $sql = "SELECT COUNT(*) AS n FROM $table WHERE 1=1 $condition_session ";
  2609. $rs = Database::query($sql);
  2610. $row = Database::fetch_row($rs);
  2611. return $row[0];
  2612. }
  2613. /**
  2614. * Subscribes courses to human resource manager (Dashboard feature)
  2615. * @param int $hr_manager_id Human Resource Manager id
  2616. * @param array $courses_list Courses code
  2617. * @return int
  2618. **/
  2619. public static function subscribeCoursesToDrhManager($hr_manager_id, $courses_list)
  2620. {
  2621. $tbl_course_rel_user = Database::get_main_table(TABLE_MAIN_COURSE_USER);
  2622. $tbl_course_rel_access_url = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_COURSE);
  2623. $hr_manager_id = intval($hr_manager_id);
  2624. $affected_rows = 0;
  2625. //Deleting assigned courses to hrm_id
  2626. if (api_is_multiple_url_enabled()) {
  2627. $sql = "SELECT s.c_id FROM $tbl_course_rel_user s
  2628. INNER JOIN $tbl_course_rel_access_url a
  2629. ON (a.c_id = s.c_id)
  2630. WHERE
  2631. user_id = $hr_manager_id AND
  2632. relation_type=" . COURSE_RELATION_TYPE_RRHH . " AND
  2633. access_url_id = " . api_get_current_access_url_id() . "";
  2634. } else {
  2635. $sql = "SELECT c_id FROM $tbl_course_rel_user
  2636. WHERE user_id = $hr_manager_id AND relation_type=" . COURSE_RELATION_TYPE_RRHH . " ";
  2637. }
  2638. $result = Database::query($sql);
  2639. if (Database::num_rows($result) > 0) {
  2640. while ($row = Database::fetch_array($result)) {
  2641. $sql = "DELETE FROM $tbl_course_rel_user
  2642. WHERE
  2643. c_id = '{$row['c_id']}' AND
  2644. user_id = $hr_manager_id AND
  2645. relation_type=" . COURSE_RELATION_TYPE_RRHH . " ";
  2646. Database::query($sql);
  2647. }
  2648. }
  2649. // inserting new courses list
  2650. if (is_array($courses_list)) {
  2651. foreach ($courses_list as $course_code) {
  2652. $courseInfo = api_get_course_info($course_code);
  2653. $courseId = $courseInfo['real_id'];
  2654. $sql = "INSERT IGNORE INTO $tbl_course_rel_user(c_id, user_id, status, relation_type)
  2655. VALUES($courseId, $hr_manager_id, '" . DRH . "', '" . COURSE_RELATION_TYPE_RRHH . "')";
  2656. $result = Database::query($sql);
  2657. if (Database::affected_rows($result)) {
  2658. $affected_rows++;
  2659. }
  2660. }
  2661. }
  2662. return $affected_rows;
  2663. }
  2664. /**
  2665. * get courses followed by human resources manager
  2666. * @param int $user_id
  2667. * @param int $from
  2668. * @param int $limit
  2669. * @param string $column
  2670. * @param string $direction
  2671. * @return array courses
  2672. */
  2673. public static function get_courses_followed_by_drh(
  2674. $user_id,
  2675. $status = DRH,
  2676. $from = null,
  2677. $limit = null,
  2678. $column = null,
  2679. $direction = null,
  2680. $getCount = false
  2681. ) {
  2682. return self::getCoursesFollowedByUser(
  2683. $user_id,
  2684. $status,
  2685. $from,
  2686. $limit,
  2687. $column,
  2688. $direction,
  2689. $getCount
  2690. );
  2691. }
  2692. /**
  2693. * get courses followed by user
  2694. * @param int $user_id
  2695. * @param int $status
  2696. * @param int $from
  2697. * @param int $limit
  2698. * @param string $column
  2699. * @param string $direction
  2700. * @param boolean $getCount
  2701. * @param string $keyword
  2702. * @param int $sessionId
  2703. * @param boolean $showAllAssignedCourses
  2704. * @return array courses
  2705. */
  2706. public static function getCoursesFollowedByUser(
  2707. $user_id,
  2708. $status = null,
  2709. $from = null,
  2710. $limit = null,
  2711. $column = null,
  2712. $direction = null,
  2713. $getCount = false,
  2714. $keyword = null,
  2715. $sessionId = null,
  2716. $showAllAssignedCourses = false
  2717. ) {
  2718. // Database Table Definitions
  2719. $tbl_course = Database::get_main_table(TABLE_MAIN_COURSE);
  2720. $tbl_course_rel_user = Database::get_main_table(TABLE_MAIN_COURSE_USER);
  2721. $tbl_course_rel_access_url = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_COURSE);
  2722. $sessionId = intval($sessionId);
  2723. $user_id = intval($user_id);
  2724. $select = "SELECT DISTINCT *, c.id as real_id ";
  2725. if ($getCount) {
  2726. $select = "SELECT COUNT(DISTINCT c.id) as count";
  2727. }
  2728. $whereConditions = null;
  2729. switch ($status) {
  2730. case COURSEMANAGER:
  2731. $whereConditions .= " AND cru.user_id = '$user_id'";
  2732. if (!$showAllAssignedCourses) {
  2733. $whereConditions .= " AND status = " . COURSEMANAGER;
  2734. } else {
  2735. $whereConditions .= " AND relation_type = " . COURSE_RELATION_TYPE_COURSE_MANAGER;
  2736. }
  2737. break;
  2738. case DRH:
  2739. $whereConditions .= " AND
  2740. cru.user_id = '$user_id' AND
  2741. status = " . DRH . " AND
  2742. relation_type = '" . COURSE_RELATION_TYPE_RRHH . "'
  2743. ";
  2744. break;
  2745. }
  2746. $keywordCondition = null;
  2747. if (!empty($keyword)) {
  2748. $keyword = Database::escape_string($keyword);
  2749. $keywordCondition = " AND (c.code LIKE '%$keyword%' OR c.title LIKE '%$keyword%' ) ";
  2750. }
  2751. $orderBy = null;
  2752. $extraInnerJoin = null;
  2753. if (!empty($sessionId)) {
  2754. if (!empty($sessionId)) {
  2755. $courseList = SessionManager::get_course_list_by_session_id(
  2756. $sessionId
  2757. );
  2758. if (!empty($courseList)) {
  2759. $courseListToString = implode("','", array_keys($courseList));
  2760. $whereConditions .= " AND c.id IN ('" . $courseListToString . "')";
  2761. }
  2762. $tableSessionRelCourse = Database::get_main_table(TABLE_MAIN_SESSION_COURSE);
  2763. $orderBy = ' ORDER BY position';
  2764. $extraInnerJoin = " INNER JOIN $tableSessionRelCourse src
  2765. ON (c.id = src.c_id AND session_id = $sessionId) ";
  2766. }
  2767. }
  2768. $whereConditions .= $keywordCondition;
  2769. $sql = "$select
  2770. FROM $tbl_course c
  2771. INNER JOIN $tbl_course_rel_user cru ON (cru.c_id = c.id)
  2772. INNER JOIN $tbl_course_rel_access_url a ON (a.c_id = c.id)
  2773. $extraInnerJoin
  2774. WHERE
  2775. access_url_id = " . api_get_current_access_url_id() . "
  2776. $whereConditions
  2777. $orderBy
  2778. ";
  2779. if (isset($from) && isset($limit)) {
  2780. $from = intval($from);
  2781. $limit = intval($limit);
  2782. $sql .= " LIMIT $from, $limit";
  2783. }
  2784. $result = Database::query($sql);
  2785. if ($getCount) {
  2786. $row = Database::fetch_array($result);
  2787. return $row['count'];
  2788. }
  2789. $courses = array();
  2790. if (Database::num_rows($result) > 0) {
  2791. while ($row = Database::fetch_array($result)) {
  2792. $courses[$row['code']] = $row;
  2793. }
  2794. }
  2795. return $courses;
  2796. }
  2797. /**
  2798. * check if a course is special (autoregister)
  2799. * @param int $courseId
  2800. * @return bool
  2801. */
  2802. public static function isSpecialCourse($courseId)
  2803. {
  2804. $extraFieldValue = new ExtraFieldValue('course');
  2805. $result = $extraFieldValue->get_values_by_handler_and_field_variable(
  2806. $courseId,
  2807. 'special_course'
  2808. );
  2809. if (!empty($result)) {
  2810. if ($result['value'] == 1) {
  2811. return true;
  2812. }
  2813. }
  2814. return false;
  2815. }
  2816. /**
  2817. * Update course picture
  2818. * @param string Course code
  2819. * @param string File name
  2820. * @param string The full system name of the image from which course picture will be created.
  2821. * @return bool Returns the resulting. In case of internal error or negative validation returns FALSE.
  2822. */
  2823. public static function update_course_picture($course_code, $filename, $source_file = null)
  2824. {
  2825. $course_info = api_get_course_info($course_code);
  2826. // course path
  2827. $store_path = api_get_path(SYS_COURSE_PATH) . $course_info['path'];
  2828. // image name for courses
  2829. $course_image = $store_path . '/course-pic.png';
  2830. $course_medium_image = $store_path . '/course-pic85x85.png';
  2831. if (file_exists($course_image)) {
  2832. unlink($course_image);
  2833. }
  2834. if (file_exists($course_medium_image)) {
  2835. unlink($course_medium_image);
  2836. }
  2837. $my_course_image = new Image($source_file);
  2838. $result = $my_course_image->send_image($course_image, -1, 'png');
  2839. // Resize image to 100x85 (should be 85x85 but 100x85 visually gives
  2840. // better results for most images people put as course icon)
  2841. if ($result) {
  2842. $medium = new Image($course_image);
  2843. //$picture_infos = $medium->get_image_size();
  2844. $medium->resize(100, 85, 0, false);
  2845. $medium->send_image($store_path . '/course-pic85x85.png', -1, 'png');
  2846. }
  2847. return $result;
  2848. }
  2849. /**
  2850. * Deletes the course picture
  2851. * @param string $courseCode
  2852. */
  2853. public static function deleteCoursePicture($courseCode)
  2854. {
  2855. $course_info = api_get_course_info($courseCode);
  2856. // course path
  2857. $storePath = api_get_path(SYS_COURSE_PATH) . $course_info['path'];
  2858. // image name for courses
  2859. $courseImage = $storePath . '/course-pic.png';
  2860. $courseMediumImage = $storePath . '/course-pic85x85.png';
  2861. $courseSmallImage = $storePath . '/course-pic32.png';
  2862. if (file_exists($courseImage)) {
  2863. unlink($courseImage);
  2864. }
  2865. if (file_exists($courseMediumImage)) {
  2866. unlink($courseMediumImage);
  2867. }
  2868. if (file_exists($courseSmallImage)) {
  2869. unlink($courseSmallImage);
  2870. }
  2871. }
  2872. /**
  2873. * @deprecated See CourseManager::course_code_exists()
  2874. */
  2875. public static function is_existing_course_code($wanted_course_code)
  2876. {
  2877. return self::course_code_exists($wanted_course_code);
  2878. }
  2879. /**
  2880. * Builds the course block in user_portal.php
  2881. * @todo use Twig
  2882. */
  2883. public static function course_item_html_no_icon($params)
  2884. {
  2885. $html = '<div class="course_item">';
  2886. $html .= '<div class="row">';
  2887. $html .= '<div class="col-md-7">';
  2888. $notifications = isset($params['notifications']) ? $params['notifications'] : null;
  2889. $html .= '<h3>' . $params['title'] . $notifications . '</h3> ';
  2890. if (isset($params['description'])) {
  2891. $html .= '<p>' . $params['description'] . '</p>';
  2892. }
  2893. if (!empty($params['subtitle'])) {
  2894. $html .= '<small>' . $params['subtitle'] . '</small>';
  2895. }
  2896. if (!empty($params['teachers'])) {
  2897. $html .= '<h5>' . Display::return_icon('teacher.png', get_lang('Teacher'), array(),
  2898. ICON_SIZE_TINY) . $params['teachers'] . '</h5>';
  2899. }
  2900. if (!empty($params['coaches'])) {
  2901. $html .= '<h5>' . Display::return_icon('teacher.png', get_lang('Coach'), array(),
  2902. ICON_SIZE_TINY) . $params['coaches'] . '</h5>';
  2903. }
  2904. $html .= '</div>';
  2905. $params['right_actions'] = isset($params['right_actions']) ? $params['right_actions'] : null;
  2906. $html .= '<div class="pull-right course-box-actions">' . $params['right_actions'] . '</div>';
  2907. $html .= '</div>';
  2908. $html .= '</div>';
  2909. return $html;
  2910. }
  2911. public static function session_items_html($params, $is_sub_content = false)
  2912. {
  2913. $html = '';
  2914. $html .= '<div class="row">';
  2915. $html .= '<div class="col-md-2">';
  2916. if (!empty($params['link'])){
  2917. $html .= '<a class="thumbnail" href="'.$params['link'].'">';
  2918. $html .= $params['icon'];
  2919. $html .= '</a>';
  2920. }else{
  2921. $html .= $params['icon'];
  2922. }
  2923. $html .= '</div>';
  2924. $html .= '<div class="col-md-10">';
  2925. $html .= $params['title'];
  2926. $html .= $params['coaches'];
  2927. $html .= '</div>';
  2928. $html .= '</div>';
  2929. return $html;
  2930. }
  2931. public static function session_list_html($params,$items_session, $is_sub_content = false)
  2932. {
  2933. $html = '';
  2934. $params['right_actions'] = isset($params['right_actions']) ? $params['right_actions'] : null;
  2935. $class = "panel-body";
  2936. $html .= '<div class="panel-heading">';
  2937. if (!empty($params['link'])){
  2938. $html.= '<a href="'.$params['link'].'">';
  2939. $html.= $params['icon'];
  2940. $html.= '</a>';
  2941. }else{
  2942. $html.= $params['icon'];
  2943. }
  2944. $html .= $params['title'];
  2945. $html .= '<div class="pull-right">' . $params['right_actions'] . '</div>';
  2946. $html .= '</div>';
  2947. $html .= '<div class="sessions ' . $class . '">';
  2948. $html .= '<div class="row">';
  2949. $html .= '<div class="col-md-12">';
  2950. if (!empty($params['subtitle'])) {
  2951. $html .= '<p class="subtitle-session"><i class="fa fa-clock-o"></i> ' . $params['subtitle'] . '</p>';
  2952. }
  2953. if (isset($params['show_description'], $params['description']) && $params['show_description'] == 1) {
  2954. $html .= '<p class="description-session">' . $params['description'] . '</p>';
  2955. }
  2956. $html .= $items_session;
  2957. $html .= '</div>';
  2958. $html .= '</div>';
  2959. $html .= '</div>';
  2960. return $html;
  2961. }
  2962. /**
  2963. * Builds the course block in user_portal.php
  2964. * @todo use Twig
  2965. */
  2966. public static function course_item_html($params, $is_sub_content = false)
  2967. {
  2968. $html = '';
  2969. $class = "panel panel-default";
  2970. if ($is_sub_content) {
  2971. $class = "course_item";
  2972. }
  2973. $html .= '<div class="' . $class . '">';
  2974. $html .= '<div class="panel-body">';
  2975. $html .= '<div class="course-items">';
  2976. $html .= ' <div class="row">';
  2977. $html .= '<div class="col-md-2">';
  2978. if (!empty($params['link'])) {
  2979. $html .= '<a class="thumbnail" href="' . $params['link'] . '">';
  2980. $html .= $params['icon'];
  2981. $html .= '</a>';
  2982. } else {
  2983. $html .= '<div class="thumbnail">';
  2984. $html .= $params['icon'];
  2985. $html .= '</div>';
  2986. }
  2987. $html .= '</div>';
  2988. $notifications = isset($params['notifications']) ? $params['notifications'] : null;
  2989. $param_class = isset($params['class']) ? $params['class'] : null;
  2990. $params['right_actions'] = isset($params['right_actions']) ? $params['right_actions'] : null;
  2991. $html .= '<div class="col-md-10 ' . $param_class . '">';
  2992. $html .= '<div class="pull-right">' . $params['right_actions'] . '</div>';
  2993. $html .= '<h4 class="title">' . $params['title'] . $notifications . '</h4> ';
  2994. if (isset($params['show_description'], $params['description']) && $params['show_description'] == 1) {
  2995. $html .= '<p class="description-session">' . $params['description'] . '</p>';
  2996. }
  2997. if (!empty($params['subtitle'])) {
  2998. $html .= '<div class="subtitle-session">' . $params['subtitle'] . '</div>';
  2999. }
  3000. if (!empty($params['teachers'])) {
  3001. $html .= '<h5>' . Display::return_icon('teacher.png', get_lang('Teacher'), array(),
  3002. ICON_SIZE_TINY) . $params['teachers'] . '</h5>';
  3003. }
  3004. if (!empty($params['coaches'])) {
  3005. $html .= '<h5>' . Display::return_icon('teacher.png', get_lang('Coach'), array(),
  3006. ICON_SIZE_TINY) . $params['coaches'] . '</h5>';
  3007. }
  3008. $html .= '</div>';
  3009. $html .= '</div>';
  3010. $html .= '</div>';
  3011. $html .= '</div>';
  3012. $html .= '</div>';
  3013. return $html;
  3014. }
  3015. /**
  3016. * @param string $main_content
  3017. * @param string $sub_content
  3018. * @param string $sub_sub_content
  3019. * @return string
  3020. */
  3021. public static function course_item_parent($main_content, $sub_content, $sub_sub_content = null)
  3022. {
  3023. return '<div class="panel panel-default">' . $main_content . $sub_content . $sub_sub_content . '</div>';
  3024. }
  3025. public static function session_item_parent($main_content, $sub_content, $sub_sub_content = null)
  3026. {
  3027. return '<div class="panel panel-default"><div class="panel-body">' . $main_content . $sub_content . $sub_sub_content . '</div></div>';
  3028. }
  3029. /**
  3030. * Display special courses (and only these) as several HTML divs of class userportal-course-item
  3031. *
  3032. * Special courses are courses that stick on top of the list and are "auto-registerable"
  3033. * in the sense that any user clicking them is registered as a student
  3034. * @param int User id
  3035. * @param bool Whether to show the document quick-loader or not
  3036. * @return string
  3037. */
  3038. public static function display_special_courses($user_id, $load_dirs = false)
  3039. {
  3040. $user_id = intval($user_id);
  3041. $tbl_course = Database::get_main_table(TABLE_MAIN_COURSE);
  3042. $tbl_course_user = Database::get_main_table(TABLE_MAIN_COURSE_USER);
  3043. $special_course_list = self::get_special_course_list();
  3044. $with_special_courses = $without_special_courses = '';
  3045. if (!empty($special_course_list)) {
  3046. $with_special_courses = ' course.code IN ("' . implode('","', $special_course_list) . '")';
  3047. }
  3048. $html = null;
  3049. $courseCount = 0;
  3050. if (!empty($with_special_courses)) {
  3051. $sql = "SELECT
  3052. course.id,
  3053. course.code,
  3054. course.subscribe subscr,
  3055. course.unsubscribe unsubscr,
  3056. course_rel_user.status status,
  3057. course_rel_user.sort sort,
  3058. course_rel_user.user_course_cat user_course_cat,
  3059. course_rel_user.user_id
  3060. FROM $tbl_course course
  3061. LEFT JOIN $tbl_course_user course_rel_user
  3062. ON course.id = course_rel_user.c_id AND course_rel_user.user_id = '$user_id'
  3063. WHERE $with_special_courses group by course.code";
  3064. $rs_special_course = Database::query($sql);
  3065. $number_of_courses = Database::num_rows($rs_special_course);
  3066. $key = 0;
  3067. if ($number_of_courses > 0) {
  3068. while ($course = Database::fetch_array($rs_special_course)) {
  3069. $course_info = api_get_course_info($course['code']);
  3070. if ($course_info['visibility'] == COURSE_VISIBILITY_HIDDEN) {
  3071. continue;
  3072. }
  3073. $courseCount++;
  3074. $params = array();
  3075. // Get notifications.
  3076. $course_info['id_session'] = null;
  3077. $course_info['status'] = $course['status'];
  3078. $show_notification = Display::show_notification($course_info);
  3079. if (empty($course['user_id'])) {
  3080. $course['status'] = STUDENT;
  3081. }
  3082. $params['icon'] = Display::return_icon('blackboard.png', api_htmlentities($course_info['title']),
  3083. array(), ICON_SIZE_LARGE);
  3084. $params['right_actions'] = '';
  3085. if (api_is_platform_admin()) {
  3086. if ($load_dirs) {
  3087. $params['right_actions'] .= '<a id="document_preview_' . $course['real_id'] . '_0" class="document_preview" href="javascript:void(0);">' . Display::return_icon('folder.png',
  3088. get_lang('Documents'), array('align' => 'absmiddle'), ICON_SIZE_SMALL) . '</a>';
  3089. $params['right_actions'] .= '<a href="' . api_get_path(WEB_CODE_PATH) . 'course_info/infocours.php?cidReq=' . $course['code'] . '">' . Display::return_icon('edit.png',
  3090. get_lang('Edit'), array('align' => 'absmiddle'), ICON_SIZE_SMALL) . '</a>';
  3091. $params['right_actions'] .= Display::div('', array(
  3092. 'id' => 'document_result_' . $course['real_id'] . '_0',
  3093. 'class' => 'document_preview_container'
  3094. ));
  3095. } else {
  3096. $params['right_actions'] .= '<a href="' . api_get_path(WEB_CODE_PATH) . 'course_info/infocours.php?cidReq=' . $course['code'] . '">' . Display::return_icon('edit.png',
  3097. get_lang('Edit'), array('align' => 'absmiddle'), ICON_SIZE_SMALL) . '</a>';
  3098. }
  3099. if ($course['status'] == COURSEMANAGER) {
  3100. //echo Display::return_icon('teachers.gif', get_lang('Status').': '.get_lang('Teacher'), array('style'=>'width: 11px; height: 11px;'));
  3101. }
  3102. } else {
  3103. if ($course_info['visibility'] != COURSE_VISIBILITY_CLOSED) {
  3104. if ($load_dirs) {
  3105. $params['right_actions'] .= '<a id="document_preview_' . $course['real_id'] . '_0" class="document_preview" href="javascript:void(0);">' . Display::return_icon('folder.png',
  3106. get_lang('Documents'), array('align' => 'absmiddle'), ICON_SIZE_SMALL) . '</a>';
  3107. $params['right_actions'] .= Display::div('', array(
  3108. 'id' => 'document_result_' . $course['real_id'] . '_0',
  3109. 'class' => 'document_preview_container'
  3110. ));
  3111. }
  3112. }
  3113. }
  3114. if ($course_info['visibility'] != COURSE_VISIBILITY_CLOSED || $course['status'] == COURSEMANAGER) {
  3115. $course_title = '<a href="' . api_get_path(WEB_COURSE_PATH) . $course_info['path'] . '/?id_session=0&amp;autoreg=1">' . $course_info['title'] . '</a>';
  3116. } else {
  3117. $course_title = $course_info['title'] . " " . Display::tag('span', get_lang('CourseClosed'),
  3118. array('class' => 'item_closed'));
  3119. }
  3120. if (api_get_setting('display_coursecode_in_courselist') == 'true') {
  3121. $course_title .= ' (' . $course_info['visual_code'] . ') ';
  3122. }
  3123. if (api_get_setting('display_teacher_in_courselist') == 'true') {
  3124. $params['teachers'] = CourseManager::get_teacher_list_from_course_code_to_string($course['code'],
  3125. self::USER_SEPARATOR, true);
  3126. }
  3127. $course_title .= '&nbsp;';
  3128. $course_title .= Display::return_icon('klipper.png', get_lang('CourseAutoRegister'));
  3129. $params['title'] = $course_title;
  3130. $params['link'] = api_get_path(WEB_COURSE_PATH) . $course_info['path'] . '/?id_session=0&amp;autoreg=1';
  3131. if ($course_info['visibility'] != COURSE_VISIBILITY_CLOSED) {
  3132. $params['notifications'] = $show_notification;
  3133. }
  3134. $html .= self::course_item_html($params, false);
  3135. $key++;
  3136. }
  3137. }
  3138. }
  3139. return [
  3140. 'html' => $html,
  3141. 'course_count' => $courseCount
  3142. ];
  3143. }
  3144. /**
  3145. * Display courses (without special courses) as several HTML divs
  3146. * of course categories, as class userportal-catalog-item.
  3147. * @uses displayCoursesInCategory() to display the courses themselves
  3148. * @param int user id
  3149. * @param bool Whether to show the document quick-loader or not
  3150. * @return string
  3151. */
  3152. public static function display_courses($user_id, $load_dirs = false)
  3153. {
  3154. $user_id = intval($user_id);
  3155. if (empty($user_id)) {
  3156. $user_id = api_get_user_id();
  3157. }
  3158. // Step 1: We get all the categories of the user
  3159. $table = Database::get_main_table(TABLE_USER_COURSE_CATEGORY);
  3160. $sql = "SELECT id, title FROM $table
  3161. WHERE user_id = '" . $user_id . "'
  3162. ORDER BY sort ASC";
  3163. $result = Database::query($sql);
  3164. $html = null;
  3165. $courseCount = 0;
  3166. while ($row = Database::fetch_array($result)) {
  3167. // We simply display the title of the category.
  3168. $params = array(
  3169. 'icon' => Display::return_icon(
  3170. 'folder_yellow.png',
  3171. api_htmlentities($row['title']), array(), ICON_SIZE_LARGE
  3172. ),
  3173. 'title' => $row['title'],
  3174. 'class' => 'table_user_course_category'
  3175. );
  3176. $courseInCategory = self:: displayCoursesInCategory(
  3177. $row['id'],
  3178. $load_dirs
  3179. );
  3180. $html .= self::course_item_parent(
  3181. self::course_item_html($params, true),
  3182. $courseInCategory['html']
  3183. );
  3184. $courseCount += $courseInCategory['course_count'];
  3185. }
  3186. // Step 2: We display the course without a user category.
  3187. $courseInCategory = self::displayCoursesInCategory(0, $load_dirs);
  3188. $html .= $courseInCategory['html'];
  3189. $courseCount += $courseInCategory['course_count'];
  3190. return [
  3191. 'html' => $html,
  3192. 'course_count' => $courseCount
  3193. ];
  3194. }
  3195. /**
  3196. * Display courses inside a category (without special courses) as HTML dics of
  3197. * class userportal-course-item.
  3198. * @param int User category id
  3199. * @param bool Whether to show the document quick-loader or not
  3200. * @return string
  3201. */
  3202. public static function displayCoursesInCategory($user_category_id, $load_dirs = false)
  3203. {
  3204. $user_id = api_get_user_id();
  3205. // Table definitions
  3206. $TABLECOURS = Database:: get_main_table(TABLE_MAIN_COURSE);
  3207. $TABLECOURSUSER = Database:: get_main_table(TABLE_MAIN_COURSE_USER);
  3208. $TABLE_ACCESS_URL_REL_COURSE = Database:: get_main_table(TABLE_MAIN_ACCESS_URL_REL_COURSE);
  3209. $current_url_id = api_get_current_access_url_id();
  3210. // Get course list auto-register
  3211. $special_course_list = self::get_special_course_list();
  3212. $without_special_courses = '';
  3213. if (!empty($special_course_list)) {
  3214. $without_special_courses = ' AND course.code NOT IN ("' . implode('","', $special_course_list) . '")';
  3215. }
  3216. //AND course_rel_user.relation_type<>".COURSE_RELATION_TYPE_RRHH."
  3217. $sql = "SELECT
  3218. course.id,
  3219. course.title,
  3220. course.code,
  3221. course.subscribe subscr,
  3222. course.unsubscribe unsubscr,
  3223. course_rel_user.status status,
  3224. course_rel_user.sort sort,
  3225. course_rel_user.user_course_cat user_course_cat
  3226. FROM $TABLECOURS course,
  3227. $TABLECOURSUSER course_rel_user,
  3228. $TABLE_ACCESS_URL_REL_COURSE url
  3229. WHERE
  3230. course.id = course_rel_user.c_id AND
  3231. url.c_id = course.id AND
  3232. course_rel_user.user_id = '" . $user_id . "' AND
  3233. course_rel_user.user_course_cat = '" . $user_category_id . "'
  3234. $without_special_courses ";
  3235. // If multiple URL access mode is enabled, only fetch courses
  3236. // corresponding to the current URL.
  3237. if (api_get_multiple_access_url() && $current_url_id != -1) {
  3238. $sql .= " AND url.c_id = course.id AND access_url_id='" . $current_url_id . "'";
  3239. }
  3240. // Use user's classification for courses (if any).
  3241. $sql .= " ORDER BY course_rel_user.user_course_cat, course_rel_user.sort ASC";
  3242. $result = Database::query($sql);
  3243. $status_icon = '';
  3244. $html = '';
  3245. $course_list = array();
  3246. $showCustomIcon = api_get_setting('course_images_in_courses_list');
  3247. $courseCount = 0;
  3248. // Browse through all courses.
  3249. while ($course = Database::fetch_array($result)) {
  3250. $course_info = api_get_course_info($course['code']);
  3251. if (isset($course_info['visibility']) &&
  3252. $course_info['visibility'] == COURSE_VISIBILITY_HIDDEN
  3253. ) {
  3254. continue;
  3255. }
  3256. $course_info['id_session'] = null;
  3257. $course_info['status'] = $course['status'];
  3258. //In order to avoid doubles
  3259. if (in_array($course_info['real_id'], $course_list)) {
  3260. continue;
  3261. } else {
  3262. $course_list[] = $course_info['real_id'];
  3263. }
  3264. $courseCount++;
  3265. // For each course, get if there is any notification icon to show
  3266. // (something that would have changed since the user's last visit).
  3267. $show_notification = Display::show_notification($course_info);
  3268. $status_icon = Display::return_icon(
  3269. 'blackboard.png',
  3270. api_htmlentities($course_info['title']),
  3271. array(),
  3272. ICON_SIZE_LARGE
  3273. );
  3274. $iconName = basename($course_info['course_image']);
  3275. if ($showCustomIcon === 'true' && $iconName != 'course.png') {
  3276. $status_icon = Display::img(
  3277. $course_info['course_image'],
  3278. api_htmlentities($course_info['title']),
  3279. array()
  3280. );
  3281. }
  3282. $params = array();
  3283. $params['right_actions'] = '';
  3284. if (api_is_platform_admin()) {
  3285. if ($load_dirs) {
  3286. $params['right_actions'] .= '<a id="document_preview_' . $course_info['real_id'] . '_0" class="document_preview" href="javascript:void(0);">' . Display::return_icon('folder.png',
  3287. get_lang('Documents'), array('align' => 'absmiddle'), ICON_SIZE_SMALL) . '</a>';
  3288. $params['right_actions'] .= '<a href="' . api_get_path(WEB_CODE_PATH) . 'course_info/infocours.php?cidReq=' . $course['code'] . '">' . Display::return_icon('edit.png',
  3289. get_lang('Edit'), array('align' => 'absmiddle'), ICON_SIZE_SMALL) . '</a>';
  3290. $params['right_actions'] .= Display::div('', array(
  3291. 'id' => 'document_result_' . $course_info['real_id'] . '_0',
  3292. 'class' => 'document_preview_container'
  3293. ));
  3294. } else {
  3295. $params['right_actions'] .= '<a href="' . api_get_path(WEB_CODE_PATH) . 'course_info/infocours.php?cidReq=' . $course['code'] . '">' . Display::return_icon('edit.png',
  3296. get_lang('Edit'), array('align' => 'absmiddle'), ICON_SIZE_SMALL) . '</a>';
  3297. }
  3298. if ($course_info['status'] == COURSEMANAGER) {
  3299. //echo Display::return_icon('teachers.gif', get_lang('Status').': '.get_lang('Teacher'), array('style'=>'width: 11px; height: 11px;'));
  3300. }
  3301. } else {
  3302. if ($course_info['visibility'] != COURSE_VISIBILITY_CLOSED) {
  3303. if ($load_dirs) {
  3304. $params['right_actions'] .= '<a id="document_preview_' . $course_info['real_id'] . '_0" class="document_preview" href="javascript:void(0);">' . Display::return_icon('folder.png',
  3305. get_lang('Documents'), array('align' => 'absmiddle'), ICON_SIZE_SMALL) . '</a>';
  3306. $params['right_actions'] .= Display::div('', array(
  3307. 'id' => 'document_result_' . $course_info['real_id'] . '_0',
  3308. 'class' => 'document_preview_container'
  3309. ));
  3310. } else {
  3311. if ($course_info['status'] == COURSEMANAGER) {
  3312. $params['right_actions'] .= '<a href="' . api_get_path(WEB_CODE_PATH) . 'course_info/infocours.php?cidReq=' . $course['code'] . '">' . Display::return_icon('edit.png',
  3313. get_lang('Edit'), array('align' => 'absmiddle'), ICON_SIZE_SMALL) . '</a>';
  3314. }
  3315. }
  3316. }
  3317. }
  3318. $course_title = $course_info['title'];
  3319. $course_title_url = '';
  3320. if ($course_info['visibility'] != COURSE_VISIBILITY_CLOSED || $course['status'] == COURSEMANAGER) {
  3321. $course_title_url = api_get_path(WEB_COURSE_PATH) . $course_info['path'] . '/index.php?id_session=0';
  3322. $course_title = Display::url($course_info['title'], $course_title_url);
  3323. } else {
  3324. $course_title = $course_info['title'] . " " . Display::tag('span', get_lang('CourseClosed'),
  3325. array('class' => 'item_closed'));
  3326. }
  3327. // Start displaying the course block itself
  3328. if (api_get_setting('display_coursecode_in_courselist') == 'true') {
  3329. $course_title .= ' (' . $course_info['visual_code'] . ') ';
  3330. }
  3331. if (api_get_setting('display_teacher_in_courselist') == 'true') {
  3332. $teachers = CourseManager::get_teacher_list_from_course_code_to_string(
  3333. $course['code'],
  3334. self::USER_SEPARATOR,
  3335. true
  3336. );
  3337. }
  3338. $params['link'] = $course_title_url;
  3339. $params['icon'] = $status_icon;
  3340. $params['title'] = $course_title;
  3341. $params['teachers'] = $teachers;
  3342. if ($course_info['visibility'] != COURSE_VISIBILITY_CLOSED) {
  3343. $params['notifications'] = $show_notification;
  3344. }
  3345. $isSubcontent = true;
  3346. if (empty($user_category_id)) {
  3347. $isSubcontent = false;
  3348. }
  3349. $html .= self::course_item_html($params, $isSubcontent);
  3350. }
  3351. return [
  3352. 'html' => $html,
  3353. 'course_count' => $courseCount
  3354. ];
  3355. }
  3356. /**
  3357. * Retrieves the user defined course categories
  3358. * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
  3359. * @return array containing all the titles of the user defined courses with the id as key of the array
  3360. */
  3361. public static function get_user_course_categories()
  3362. {
  3363. global $_user;
  3364. $output = array();
  3365. $table_category = Database::get_main_table(TABLE_USER_COURSE_CATEGORY);
  3366. $sql = "SELECT * FROM " . $table_category . " WHERE user_id='" . intval($_user['user_id']) . "'";
  3367. $result = Database::query($sql);
  3368. while ($row = Database::fetch_array($result)) {
  3369. $output[$row['id']] = $row['title'];
  3370. }
  3371. return $output;
  3372. }
  3373. /**
  3374. * Get the course id based on the original id and field name in the extra fields.
  3375. * Returns 0 if course was not found
  3376. *
  3377. * @param string $value Original course code
  3378. * @param string $variable Original field name
  3379. * @return int Course id
  3380. */
  3381. public static function getCourseInfoFromOriginalId($value, $variable)
  3382. {
  3383. $extraFieldValue = new ExtraFieldValue('course');
  3384. $result = $extraFieldValue->get_item_id_from_field_variable_and_field_value(
  3385. $variable,
  3386. $value
  3387. );
  3388. if (!empty($result)) {
  3389. $courseInfo = api_get_course_info_by_id($result['item_id']);
  3390. return $courseInfo;
  3391. }
  3392. return 0;
  3393. }
  3394. /**
  3395. * Display code for one specific course a logged in user is subscribed to.
  3396. * Shows a link to the course, what's new icons...
  3397. *
  3398. * $my_course['d'] - course directory
  3399. * $my_course['i'] - course title
  3400. * $my_course['c'] - visual course code
  3401. * $my_course['k'] - system course code
  3402. *
  3403. * @param array Course details
  3404. * @param integer Session ID
  3405. * @param string CSS class to apply to course entry
  3406. * @param boolean Whether the session is supposedly accessible now
  3407. * (not in the case it has passed and is in invisible/unaccessible mode)
  3408. * @param bool Whether to show the document quick-loader or not
  3409. * @return string The HTML to be printed for the course entry
  3410. *
  3411. * @version 1.0.3
  3412. * @todo refactor into different functions for database calls | logic | display
  3413. * @todo replace single-character $my_course['d'] indices
  3414. * @todo move code for what's new icons to a separate function to clear things up
  3415. * @todo add a parameter user_id so that it is possible to show the
  3416. * courselist of other users (=generalisation).
  3417. * This will prevent having to write a new function for this.
  3418. */
  3419. public static function get_logged_user_course_html(
  3420. $course,
  3421. $session_id = 0,
  3422. $class = 'courses',
  3423. $session_accessible = true,
  3424. $load_dirs = false
  3425. ) {
  3426. global $nosession;
  3427. $user_id = api_get_user_id();
  3428. $course_info = api_get_course_info_by_id($course['real_id']);
  3429. $status_course = CourseManager::get_user_in_course_status($user_id, $course_info['code']);
  3430. $course_info['status'] = empty($session_id) ? $status_course : STUDENT;
  3431. $course_info['id_session'] = $session_id;
  3432. if (!$nosession) {
  3433. global $now, $date_start, $date_end;
  3434. }
  3435. if (empty($date_start) or empty($date_end)) {
  3436. $sess = SessionManager::get_sessions_list(
  3437. array(
  3438. 's.id' => array(
  3439. 'operator' => '=',
  3440. 'value' => $course_info['id_session'],
  3441. ),
  3442. )
  3443. );
  3444. $date_start = $sess[$course_info['id_session']]['date_start'];
  3445. $date_end = $sess[$course_info['id_session']]['date_end'];
  3446. }
  3447. if (empty($now)) {
  3448. // maybe use api_get_utcdate() here?
  3449. $now = date('Y-m-d h:i:s');
  3450. }
  3451. // Table definitions
  3452. $main_user_table = Database:: get_main_table(TABLE_MAIN_USER);
  3453. $tbl_session = Database:: get_main_table(TABLE_MAIN_SESSION);
  3454. $tbl_session_category = Database:: get_main_table(TABLE_MAIN_SESSION_CATEGORY);
  3455. $course_access_settings = CourseManager::get_access_settings($course_info['code']);
  3456. $course_visibility = $course_access_settings['visibility'];
  3457. if ($course_visibility == COURSE_VISIBILITY_HIDDEN) {
  3458. return '';
  3459. }
  3460. $user_in_course_status = CourseManager::get_user_in_course_status(
  3461. api_get_user_id(),
  3462. $course_info['code']
  3463. );
  3464. $is_coach = api_is_coach($course_info['id_session'], $course_info['real_id']);
  3465. // Display course entry.
  3466. // Show a hyperlink to the course, unless the course is closed and user is not course admin.
  3467. $session_url = '';
  3468. $session_title = '';
  3469. $params = array();
  3470. $params['icon'] = Display::return_icon(
  3471. 'blackboard_blue.png',
  3472. api_htmlentities($course_info['name']),
  3473. array(),
  3474. ICON_SIZE_LARGE
  3475. );
  3476. // Display the "what's new" icons
  3477. $notifications = '';
  3478. if ($course_visibility != COURSE_VISIBILITY_CLOSED && $course_visibility != COURSE_VISIBILITY_HIDDEN) {
  3479. $notifications .= Display:: show_notification($course_info);
  3480. }
  3481. if ($session_accessible) {
  3482. if ($course_visibility != COURSE_VISIBILITY_CLOSED ||
  3483. $user_in_course_status == COURSEMANAGER
  3484. ) {
  3485. if (!$nosession) {
  3486. if (empty($course_info['id_session'])) {
  3487. $course_info['id_session'] = 0;
  3488. }
  3489. $sessionCourseAvailable = false;
  3490. $sessionCourseStatus = api_get_session_visibility($session_id, $course_info['id']);
  3491. if (in_array($sessionCourseStatus,
  3492. array(SESSION_VISIBLE_READ_ONLY, SESSION_VISIBLE, SESSION_AVAILABLE))) {
  3493. $sessionCourseAvailable = true;
  3494. }
  3495. if ($user_in_course_status == COURSEMANAGER || $sessionCourseAvailable) {
  3496. $session_url = api_get_path(WEB_COURSE_PATH) . $course_info['path'] . '/?id_session=' . $course_info['id_session'];
  3497. $session_title = '<h4><a href="' . api_get_path(WEB_COURSE_PATH) . $course_info['path'] . '/?id_session=' . $course_info['id_session'] . '">'. $course_info['name'] . '</a>'.$notifications.'</h4>';
  3498. } else {
  3499. $session_title = $course_info['name'];
  3500. }
  3501. } else {
  3502. $session_url = api_get_path(WEB_COURSE_PATH) . $course_info['path'] . '/';
  3503. $session_title = '<h4><a href="' . api_get_path(WEB_COURSE_PATH) . $course_info['path'] . '/">' . $course_info['name'] . '</a>'.$notifications.'</h4>';
  3504. }
  3505. } else {
  3506. $session_title = $course_info['name'] . ' ' . Display::tag('span', get_lang('CourseClosed'),
  3507. array('class' => 'item_closed'));
  3508. }
  3509. } else {
  3510. $session_title = $course_info['name'];
  3511. }
  3512. $showCustomIcon = api_get_setting('course_images_in_courses_list');
  3513. $iconName = basename($course_info['course_image']);
  3514. if ($showCustomIcon === 'true' && $iconName != 'course.png') {
  3515. $params['icon'] = Display::img(
  3516. $course_info['course_image'],
  3517. api_htmlentities($course_info['name']),
  3518. array()
  3519. );
  3520. }
  3521. $params['link'] = $session_url;
  3522. $params['title'] = $session_title;
  3523. $params['right_actions'] = '';
  3524. if ($course_visibility != COURSE_VISIBILITY_CLOSED &&
  3525. $course_visibility != COURSE_VISIBILITY_HIDDEN
  3526. ) {
  3527. if ($load_dirs) {
  3528. $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',
  3529. get_lang('Documents'), array('align' => 'absmiddle'), ICON_SIZE_SMALL) . '</a>';
  3530. $params['right_actions'] .= Display::div('', array(
  3531. 'id' => 'document_result_' . $course_info['real_id'] . '_' . $course_info['id_session'],
  3532. 'class' => 'document_preview_container'
  3533. ));
  3534. }
  3535. }
  3536. if (api_get_setting('display_coursecode_in_courselist') == 'true') {
  3537. $session_title .= ' (' . $course_info['visual_code'] . ') ';
  3538. }
  3539. if (api_get_setting('display_teacher_in_courselist') == 'true') {
  3540. $teacher_list = null;
  3541. if (!$nosession) {
  3542. $teacher_list = CourseManager::get_teacher_list_from_course_code_to_string(
  3543. $course_info['code'],
  3544. self::USER_SEPARATOR,
  3545. true
  3546. );
  3547. $course_coachs = CourseManager::get_coachs_from_course_to_string(
  3548. $course_info['id_session'],
  3549. $course_info['real_id'],
  3550. self::USER_SEPARATOR,
  3551. true
  3552. );
  3553. $icon_coachs = Display::return_icon('teacher.png','',null,ICON_SIZE_TINY);
  3554. if ($course_info['status'] == COURSEMANAGER || ($course_info['status'] == STUDENT && empty($course_info['id_session'])) || empty($course_info['status'])) {
  3555. $params['teachers'] = $teacher_list;
  3556. }
  3557. if (($course_info['status'] == STUDENT && !empty($course_info['id_session'])) || ($is_coach && $course_info['status'] != COURSEMANAGER)) {
  3558. $params['coaches'] = $icon_coachs.$course_coachs;
  3559. }
  3560. } else {
  3561. $params['teachers'] = $teacher_list;
  3562. }
  3563. }
  3564. $session_title .= isset($course['special_course']) ? ' ' . Display::return_icon('klipper.png',
  3565. get_lang('CourseAutoRegister')) : '';
  3566. $params['title'] = $session_title;
  3567. $params['extra'] = '';
  3568. $html = self::session_items_html($params, true);
  3569. $session_category_id = null;
  3570. if (!$nosession) {
  3571. $session = '';
  3572. $active = false;
  3573. if (!empty($course_info['session_name'])) {
  3574. // Request for the name of the general coach
  3575. $sql = 'SELECT lastname, firstname,sc.name
  3576. FROM ' . $tbl_session . ' ts
  3577. LEFT JOIN ' . $main_user_table . ' tu
  3578. ON ts.id_coach = tu.user_id
  3579. INNER JOIN ' . $tbl_session_category . ' sc ON ts.session_category_id = sc.id
  3580. WHERE ts.id=' . (int)$course_info['id_session'] . ' LIMIT 1';
  3581. $rs = Database::query($sql);
  3582. $sessioncoach = Database::store_result($rs);
  3583. $sessioncoach = $sessioncoach[0];
  3584. $session = array();
  3585. $session['title'] = $course_info['session_name'];
  3586. $session_category_id = CourseManager::get_session_category_id_by_session_id($course_info['id_session']);
  3587. $session['category'] = $sessioncoach['name'];
  3588. if ($course_info['date_start'] == '0000-00-00') {
  3589. //$session['dates'] = get_lang('WithoutTimeLimits');
  3590. $session['dates'] = '';
  3591. if (api_get_setting('show_session_coach') === 'true') {
  3592. $session['coach'] = get_lang('GeneralCoach') . ': ' . api_get_person_name($sessioncoach['firstname'],
  3593. $sessioncoach['lastname']);
  3594. }
  3595. $active = true;
  3596. } else {
  3597. $session ['dates'] = ' - ' . get_lang('From') . ' ' . $course_info['date_start'] . ' ' . get_lang('To') . ' ' . $course_info['date_end'];
  3598. if (api_get_setting('show_session_coach') === 'true') {
  3599. $session['coach'] = get_lang('GeneralCoach') . ': ' . api_get_person_name($sessioncoach['firstname'],
  3600. $sessioncoach['lastname']);
  3601. }
  3602. $active = ($date_start <= $now && $date_end >= $now);
  3603. }
  3604. }
  3605. $user_course_category = '';
  3606. if (isset($course_info['user_course_cat'])) {
  3607. $user_course_category = $course_info['user_course_cat'];
  3608. }
  3609. $output = array(
  3610. $user_course_category,
  3611. $html,
  3612. $course_info['id_session'],
  3613. $session,
  3614. 'active' => $active,
  3615. 'session_category_id' => $session_category_id
  3616. );
  3617. } else {
  3618. $output = array($course_info['user_course_cat'], $html);
  3619. }
  3620. return $output;
  3621. }
  3622. /**
  3623. *
  3624. * @param string source course code
  3625. * @param int source session id
  3626. * @param string destination course code
  3627. * @param int destination session id
  3628. * @return bool
  3629. */
  3630. public static function copy_course(
  3631. $source_course_code,
  3632. $source_session_id,
  3633. $destination_course_code,
  3634. $destination_session_id,
  3635. $params = array()
  3636. ) {
  3637. require_once api_get_path(SYS_CODE_PATH) . 'coursecopy/classes/CourseBuilder.class.php';
  3638. require_once api_get_path(SYS_CODE_PATH) . 'coursecopy/classes/CourseRestorer.class.php';
  3639. require_once api_get_path(SYS_CODE_PATH) . 'coursecopy/classes/CourseSelectForm.class.php';
  3640. $course_info = api_get_course_info($source_course_code);
  3641. if (!empty($course_info)) {
  3642. $cb = new CourseBuilder('', $course_info);
  3643. $course = $cb->build($source_session_id, $source_course_code, true);
  3644. $course_restorer = new CourseRestorer($course);
  3645. $course_restorer->skip_content = $params;
  3646. $course_restorer->restore($destination_course_code, $destination_session_id, true, true);
  3647. return true;
  3648. }
  3649. return false;
  3650. }
  3651. /**
  3652. * A simpler version of the copy_course, the function creates an empty course with an autogenerated course code
  3653. *
  3654. * @param string new course title
  3655. * @param string source course code
  3656. * @param int source session id
  3657. * @param int destination session id
  3658. * @param bool new copied tools (Exercises and LPs)will be set to invisible by default?
  3659. *
  3660. * @return array
  3661. */
  3662. public static function copy_course_simple(
  3663. $new_title,
  3664. $source_course_code,
  3665. $source_session_id = 0,
  3666. $destination_session_id = 0,
  3667. $params = array()
  3668. ) {
  3669. $source_course_info = api_get_course_info($source_course_code);
  3670. if (!empty($source_course_info)) {
  3671. $new_course_code = self::generate_nice_next_course_code($source_course_code);
  3672. if ($new_course_code) {
  3673. $new_course_info = self::create_course($new_title, $new_course_code, false);
  3674. if (!empty($new_course_info['code'])) {
  3675. $result = self::copy_course($source_course_code, $source_session_id, $new_course_info['code'],
  3676. $destination_session_id, $params);
  3677. if ($result) {
  3678. return $new_course_info;
  3679. }
  3680. }
  3681. }
  3682. }
  3683. return false;
  3684. }
  3685. /**
  3686. * Creates a new course code based in a given code
  3687. *
  3688. * @param string wanted code
  3689. * <code> $wanted_code = 'curse' if there are in the DB codes like curse1 curse2 the function will return: course3</code>
  3690. * if the course code doest not exist in the DB the same course code will be returned
  3691. * @return string wanted unused code
  3692. */
  3693. public static function generate_nice_next_course_code($wanted_code)
  3694. {
  3695. $course_code_ok = !self::course_code_exists($wanted_code);
  3696. if (!$course_code_ok) {
  3697. $wanted_code = CourseManager::generate_course_code($wanted_code);
  3698. $table = Database::get_main_table(TABLE_MAIN_COURSE);
  3699. $wanted_code = Database::escape_string($wanted_code);
  3700. $sql = "SELECT count(*) as count FROM $table WHERE code LIKE '$wanted_code%'";
  3701. $result = Database::query($sql);
  3702. if (Database::num_rows($result) > 0) {
  3703. $row = Database::fetch_array($result);
  3704. $count = $row['count'] + 1;
  3705. $wanted_code = $wanted_code . '_' . $count;
  3706. $result = api_get_course_info($wanted_code);
  3707. if (empty($result)) {
  3708. return $wanted_code;
  3709. }
  3710. }
  3711. return false;
  3712. }
  3713. return $wanted_code;
  3714. }
  3715. /**
  3716. * Gets the status of the users agreement in a course course-session
  3717. *
  3718. * @param int $user_id
  3719. * @param string $course_code
  3720. * @param int $session_id
  3721. * @return boolean
  3722. */
  3723. public static function is_user_accepted_legal($user_id, $course_code, $session_id = null)
  3724. {
  3725. $user_id = intval($user_id);
  3726. $course_code = Database::escape_string($course_code);
  3727. $session_id = intval($session_id);
  3728. $courseInfo = api_get_course_info($course_code);
  3729. $courseId = $courseInfo['real_id'];
  3730. // Course legal
  3731. $enabled = api_get_plugin_setting('courselegal', 'tool_enable');
  3732. if ($enabled == 'true') {
  3733. require_once api_get_path(SYS_PLUGIN_PATH) . 'courselegal/config.php';
  3734. $plugin = CourseLegalPlugin::create();
  3735. return $plugin->isUserAcceptedLegal($user_id, $course_code, $session_id);
  3736. }
  3737. if (empty($session_id)) {
  3738. $table = Database::get_main_table(TABLE_MAIN_COURSE_USER);
  3739. $sql = "SELECT legal_agreement FROM $table
  3740. WHERE user_id = $user_id AND c_id = $courseId ";
  3741. $result = Database::query($sql);
  3742. if (Database::num_rows($result) > 0) {
  3743. $result = Database::fetch_array($result);
  3744. if ($result['legal_agreement'] == 1) {
  3745. return true;
  3746. }
  3747. }
  3748. return false;
  3749. } else {
  3750. $table = Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER);
  3751. $sql = "SELECT legal_agreement FROM $table
  3752. WHERE user_id = $user_id AND c_id = $courseId AND session_id = $session_id";
  3753. $result = Database::query($sql);
  3754. if (Database::num_rows($result) > 0) {
  3755. $result = Database::fetch_array($result);
  3756. if ($result['legal_agreement'] == 1) {
  3757. return true;
  3758. }
  3759. }
  3760. return false;
  3761. }
  3762. }
  3763. /**
  3764. * Saves the user-course legal agreement
  3765. * @param int user id
  3766. * @param string course code
  3767. * @param int session id
  3768. * @return mixed
  3769. */
  3770. public static function save_user_legal($user_id, $course_code, $session_id = null)
  3771. {
  3772. // Course plugin legal
  3773. $enabled = api_get_plugin_setting('courselegal', 'tool_enable');
  3774. if ($enabled == 'true') {
  3775. require_once api_get_path(SYS_PLUGIN_PATH) . 'courselegal/config.php';
  3776. $plugin = CourseLegalPlugin::create();
  3777. return $plugin->saveUserLegal($user_id, $course_code, $session_id);
  3778. }
  3779. $user_id = intval($user_id);
  3780. $course_code = Database::escape_string($course_code);
  3781. $session_id = intval($session_id);
  3782. $courseInfo = api_get_course_info($course_code);
  3783. $courseId = $courseInfo['real_id'];
  3784. if (empty($session_id)) {
  3785. $table = Database::get_main_table(TABLE_MAIN_COURSE_USER);
  3786. $sql = "UPDATE $table SET legal_agreement = '1'
  3787. WHERE user_id = $user_id AND c_id = $courseId ";
  3788. Database::query($sql);
  3789. } else {
  3790. $table = Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER);
  3791. $sql = "UPDATE $table SET legal_agreement = '1'
  3792. WHERE user_id = $user_id AND c_id = $courseId AND session_id = $session_id";
  3793. Database::query($sql);
  3794. }
  3795. }
  3796. /**
  3797. * @param int $user_id
  3798. * @param int $course_id
  3799. * @param int $session_id
  3800. * @param int $url_id
  3801. * @return bool
  3802. */
  3803. public static function get_user_course_vote($user_id, $course_id, $session_id = null, $url_id = null)
  3804. {
  3805. $table_user_course_vote = Database::get_main_table(TABLE_MAIN_USER_REL_COURSE_VOTE);
  3806. $session_id = !isset($session_id) ? api_get_session_id() : intval($session_id);
  3807. $url_id = empty($url_id) ? api_get_current_access_url_id() : intval($url_id);
  3808. $user_id = intval($user_id);
  3809. if (empty($user_id)) {
  3810. return false;
  3811. }
  3812. $params = array(
  3813. 'user_id' => $user_id,
  3814. 'c_id' => $course_id,
  3815. 'session_id' => $session_id,
  3816. 'url_id' => $url_id
  3817. );
  3818. $result = Database::select(
  3819. 'vote',
  3820. $table_user_course_vote,
  3821. array(
  3822. 'where' => array(
  3823. 'user_id = ? AND c_id = ? AND session_id = ? AND url_id = ?' => $params
  3824. )
  3825. ),
  3826. 'first'
  3827. );
  3828. if (!empty($result)) {
  3829. return $result['vote'];
  3830. }
  3831. return false;
  3832. }
  3833. /**
  3834. * @param int $course_id
  3835. * @param int $session_id
  3836. * @param int $url_id
  3837. * @return array
  3838. */
  3839. public static function get_course_ranking($course_id, $session_id = null, $url_id = null)
  3840. {
  3841. $table_course_ranking = Database::get_main_table(TABLE_STATISTIC_TRACK_COURSE_RANKING);
  3842. $session_id = !isset($session_id) ? api_get_session_id() : intval($session_id);
  3843. $url_id = empty($url_id) ? api_get_current_access_url_id() : intval($url_id);
  3844. $now = api_get_utc_datetime();
  3845. $params = array(
  3846. 'c_id' => $course_id,
  3847. 'session_id' => $session_id,
  3848. 'url_id' => $url_id,
  3849. 'creation_date' => $now,
  3850. );
  3851. $result = Database::select(
  3852. 'c_id, accesses, total_score, users',
  3853. $table_course_ranking,
  3854. array('where' => array('c_id = ? AND session_id = ? AND url_id = ?' => $params)),
  3855. 'first'
  3856. );
  3857. $point_average_in_percentage = 0;
  3858. $point_average_in_star = 0;
  3859. $users_who_voted = 0;
  3860. if (!empty($result['users'])) {
  3861. $users_who_voted = $result['users'];
  3862. $point_average_in_percentage = round($result['total_score'] / $result['users'] * 100 / 5, 2);
  3863. $point_average_in_star = round($result['total_score'] / $result['users'], 1);
  3864. }
  3865. $result['user_vote'] = false;
  3866. if (!api_is_anonymous()) {
  3867. $result['user_vote'] = self::get_user_course_vote(api_get_user_id(), $course_id, $session_id, $url_id);
  3868. }
  3869. $result['point_average'] = $point_average_in_percentage;
  3870. $result['point_average_star'] = $point_average_in_star;
  3871. $result['users_who_voted'] = $users_who_voted;
  3872. return $result;
  3873. }
  3874. /**
  3875. *
  3876. * Updates the course ranking
  3877. * @param int course id
  3878. * @param int session id
  3879. * @param id url id
  3880. * @return array
  3881. **/
  3882. public static function update_course_ranking(
  3883. $course_id = null,
  3884. $session_id = null,
  3885. $url_id = null,
  3886. $points_to_add = null,
  3887. $add_access = true,
  3888. $add_user = true
  3889. ) {
  3890. // Course catalog stats modifications see #4191
  3891. $table_course_ranking = Database::get_main_table(TABLE_STATISTIC_TRACK_COURSE_RANKING);
  3892. $now = api_get_utc_datetime();
  3893. $course_id = empty($course_id) ? api_get_course_int_id() : intval($course_id);
  3894. $session_id = !isset($session_id) ? api_get_session_id() : intval($session_id);
  3895. $url_id = empty($url_id) ? api_get_current_access_url_id() : intval($url_id);
  3896. $params = array(
  3897. 'c_id' => $course_id,
  3898. 'session_id' => $session_id,
  3899. 'url_id' => $url_id,
  3900. 'creation_date' => $now,
  3901. );
  3902. $result = Database::select(
  3903. 'id, accesses, total_score, users',
  3904. $table_course_ranking,
  3905. array('where' => array('c_id = ? AND session_id = ? AND url_id = ?' => $params)),
  3906. 'first'
  3907. );
  3908. // Problem here every time we load the courses/XXXX/index.php course home page we update the access
  3909. if (empty($result)) {
  3910. if ($add_access) {
  3911. $params['accesses'] = 1;
  3912. }
  3913. //The votes and users are empty
  3914. if (isset($points_to_add) && !empty($points_to_add)) {
  3915. $params['total_score'] = intval($points_to_add);
  3916. }
  3917. if ($add_user) {
  3918. $params['users'] = 1;
  3919. }
  3920. $result = Database::insert($table_course_ranking, $params);
  3921. } else {
  3922. $my_params = array();
  3923. if ($add_access) {
  3924. $my_params['accesses'] = intval($result['accesses']) + 1;
  3925. }
  3926. if (isset($points_to_add) && !empty($points_to_add)) {
  3927. $my_params['total_score'] = $result['total_score'] + $points_to_add;
  3928. }
  3929. if ($add_user) {
  3930. $my_params['users'] = $result['users'] + 1;
  3931. }
  3932. if (!empty($my_params)) {
  3933. $result = Database::update(
  3934. $table_course_ranking,
  3935. $my_params,
  3936. array('c_id = ? AND session_id = ? AND url_id = ?' => $params)
  3937. );
  3938. }
  3939. }
  3940. return $result;
  3941. }
  3942. /**
  3943. * Add user vote to a course
  3944. *
  3945. * @param int user id
  3946. * @param int vote [1..5]
  3947. * @param int course id
  3948. * @param int session id
  3949. * @param int url id (access_url_id)
  3950. * @return mixed 'added', 'updated' or 'nothing'
  3951. */
  3952. public static function add_course_vote($user_id, $vote, $course_id, $session_id = null, $url_id = null)
  3953. {
  3954. $table_user_course_vote = Database::get_main_table(TABLE_MAIN_USER_REL_COURSE_VOTE);
  3955. $course_id = empty($course_id) ? api_get_course_int_id() : intval($course_id);
  3956. if (empty($course_id) || empty($user_id)) {
  3957. return false;
  3958. }
  3959. if (!in_array($vote, array(1, 2, 3, 4, 5))) {
  3960. return false;
  3961. }
  3962. $session_id = !isset($session_id) ? api_get_session_id() : intval($session_id);
  3963. $url_id = empty($url_id) ? api_get_current_access_url_id() : intval($url_id);
  3964. $vote = intval($vote);
  3965. $params = array(
  3966. 'user_id' => intval($user_id),
  3967. 'c_id' => $course_id,
  3968. 'session_id' => $session_id,
  3969. 'url_id' => $url_id,
  3970. 'vote' => $vote
  3971. );
  3972. $action_done = 'nothing';
  3973. $result = Database::select(
  3974. 'id, vote',
  3975. $table_user_course_vote,
  3976. array('where' => array('user_id = ? AND c_id = ? AND session_id = ? AND url_id = ?' => $params)),
  3977. 'first'
  3978. );
  3979. if (empty($result)) {
  3980. Database::insert($table_user_course_vote, $params);
  3981. $points_to_add = $vote;
  3982. $add_user = true;
  3983. $action_done = 'added';
  3984. } else {
  3985. $my_params = array('vote' => $vote);
  3986. $points_to_add = $vote - $result['vote'];
  3987. $add_user = false;
  3988. Database::update(
  3989. $table_user_course_vote,
  3990. $my_params,
  3991. array('user_id = ? AND c_id = ? AND session_id = ? AND url_id = ?' => $params)
  3992. );
  3993. $action_done = 'updated';
  3994. }
  3995. // Current points
  3996. if (!empty($points_to_add)) {
  3997. self::update_course_ranking(
  3998. $course_id,
  3999. $session_id,
  4000. $url_id,
  4001. $points_to_add,
  4002. false,
  4003. $add_user
  4004. );
  4005. }
  4006. return $action_done;
  4007. }
  4008. /**
  4009. * Remove course ranking + user votes
  4010. *
  4011. * @param int $course_id
  4012. * @param int $session_id
  4013. * @param int $url_id
  4014. *
  4015. */
  4016. public static function remove_course_ranking($course_id, $session_id, $url_id = null)
  4017. {
  4018. $table_course_ranking = Database::get_main_table(TABLE_STATISTIC_TRACK_COURSE_RANKING);
  4019. $table_user_course_vote = Database::get_main_table(TABLE_MAIN_USER_REL_COURSE_VOTE);
  4020. if (!empty($course_id) && isset($session_id)) {
  4021. $url_id = empty($url_id) ? api_get_current_access_url_id() : intval($url_id);
  4022. $params = array(
  4023. 'c_id' => $course_id,
  4024. 'session_id' => $session_id,
  4025. 'url_id' => $url_id,
  4026. );
  4027. Database::delete($table_course_ranking, array('c_id = ? AND session_id = ? AND url_id = ?' => $params));
  4028. Database::delete($table_user_course_vote, array('c_id = ? AND session_id = ? AND url_id = ?' => $params));
  4029. }
  4030. }
  4031. /**
  4032. * Returns an array with the hottest courses
  4033. * @param int $days number of days
  4034. * @param int $limit number of hottest courses
  4035. * @return array
  4036. */
  4037. public static function return_hot_courses($days = 30, $limit = 5)
  4038. {
  4039. global $_configuration;
  4040. if (api_is_invitee()) {
  4041. return array();
  4042. }
  4043. $limit = intval($limit);
  4044. // Getting my courses
  4045. $my_course_list = CourseManager::get_courses_list_by_user_id(api_get_user_id());
  4046. $my_course_code_list = array();
  4047. foreach ($my_course_list as $course) {
  4048. $my_course_code_list[$course['real_id']] = $course['real_id'];
  4049. }
  4050. if (api_is_drh()) {
  4051. $courses = CourseManager::get_courses_followed_by_drh(api_get_user_id());
  4052. foreach ($courses as $course) {
  4053. $my_course_code_list[$course['real_id']] = $course['real_id'];
  4054. }
  4055. }
  4056. $table_course_access = Database::get_main_table(TABLE_STATISTIC_TRACK_E_COURSE_ACCESS);
  4057. $table_course = Database::get_main_table(TABLE_MAIN_COURSE);
  4058. $table_course_url = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_COURSE);
  4059. //@todo all dates in the tracking_course_access, last_access are in the DB time (NOW) not UTC
  4060. /*
  4061. $today = api_get_utc_datetime();
  4062. $today_diff = time() -intval($days)*24*60*60;
  4063. $today_diff = api_get_utc_datetime($today_diff);
  4064. * */
  4065. //WHERE login_course_date <= '$today' AND login_course_date >= '$today_diff'
  4066. //$table_course_access table uses the now() and interval ...
  4067. $now = api_get_utc_datetime(time());
  4068. $sql = "SELECT COUNT(course_access_id) course_count, a.c_id, visibility
  4069. FROM $table_course c
  4070. INNER JOIN $table_course_access a
  4071. ON (c.id = a.c_id)
  4072. INNER JOIN $table_course_url u
  4073. ON u.c_id = c.id
  4074. WHERE
  4075. u.access_url_id = " . api_get_current_access_url_id() . " AND
  4076. login_course_date <= '$now' AND
  4077. login_course_date > DATE_SUB(now(), INTERVAL $days DAY) AND
  4078. visibility <> '" . COURSE_VISIBILITY_CLOSED . "' AND visibility <> '" . COURSE_VISIBILITY_HIDDEN . "'
  4079. GROUP BY a.c_id
  4080. ORDER BY course_count DESC
  4081. LIMIT $limit
  4082. ";
  4083. $result = Database::query($sql);
  4084. $courses = array();
  4085. if (Database::num_rows($result)) {
  4086. $courses = Database::store_result($result, 'ASSOC');
  4087. $courses = self::process_hot_course_item($courses, $my_course_code_list);
  4088. }
  4089. return $courses;
  4090. }
  4091. /**
  4092. * @param array $courses
  4093. * @param array $my_course_code_list
  4094. * @return mixed
  4095. */
  4096. public static function process_hot_course_item($courses, $my_course_code_list = array())
  4097. {
  4098. $hotCourses = [];
  4099. $ajax_url = api_get_path(WEB_AJAX_PATH) . 'course.ajax.php?a=add_course_vote';
  4100. $stok = Security::get_existing_token();
  4101. foreach ($courses as $courseId) {
  4102. $course_info = api_get_course_info_by_id($courseId['c_id']);
  4103. $courseCode = $course_info['code'];
  4104. $categoryCode = !empty($course_info['categoryCode']) ? $course_info['categoryCode'] : "";
  4105. $my_course['extra_info'] = $course_info;
  4106. $my_course['extra_info']['go_to_course_button'] = '';
  4107. $my_course['extra_info']['register_button'] = '';
  4108. $access_link = self::get_access_link_by_user(
  4109. api_get_user_id(),
  4110. $course_info,
  4111. $my_course_code_list
  4112. );
  4113. //Course visibility
  4114. if ($access_link && in_array('register', $access_link)) {
  4115. $my_course['extra_info']['register_button'] = Display::url(get_lang('Subscribe'),
  4116. api_get_path(WEB_COURSE_PATH) . $course_info['path'] . '/index.php?action=subscribe&amp;sec_token=' . $stok,
  4117. array('class' => 'btn btn-primary'));
  4118. }
  4119. if ($access_link && in_array('enter',
  4120. $access_link) || $course_info['visibility'] == COURSE_VISIBILITY_OPEN_WORLD
  4121. ) {
  4122. $my_course['extra_info']['go_to_course_button'] = Display::url(get_lang('GoToCourse'),
  4123. api_get_path(WEB_COURSE_PATH) . $course_info['path'] . '/index.php',
  4124. array('class' => 'btn btn-primary'));
  4125. }
  4126. if ($access_link && in_array('unsubscribe', $access_link)) {
  4127. $my_course['extra_info']['unsubscribe_button'] = Display::url(get_lang('Unsubscribe'),
  4128. api_get_path(WEB_CODE_PATH) . 'auth/courses.php?action=unsubscribe&amp;unsubscribe=' . $courseCode . '&amp;sec_token=' . $stok . '&amp;category_code=' . $categoryCode,
  4129. array('class' => 'btn btn-primary'));
  4130. }
  4131. //Description
  4132. $my_course['extra_info']['description_button'] = '';
  4133. if ($course_info['visibility'] == COURSE_VISIBILITY_OPEN_WORLD || in_array($course_info['real_id'],
  4134. $my_course_code_list)
  4135. ) {
  4136. $my_course['extra_info']['description_button'] = Display::url(get_lang('Description'),
  4137. api_get_path(WEB_AJAX_PATH) . 'course_home.ajax.php?a=show_course_information&amp;code=' . $course_info['code'],
  4138. array('class' => 'btn btn-default ajax'));
  4139. }
  4140. $my_course['extra_info']['teachers'] = CourseManager::get_teacher_list_from_course_code_to_string($course_info['code']);
  4141. $point_info = self::get_course_ranking($course_info['real_id'], 0);
  4142. $my_course['extra_info']['rating_html'] = Display::return_rating_system('star_' . $course_info['real_id'],
  4143. $ajax_url . '&amp;course_id=' . $course_info['real_id'], $point_info);
  4144. $hotCourses[] = $my_course;
  4145. }
  4146. return $hotCourses;
  4147. }
  4148. /**
  4149. * @param int $limit
  4150. * @return array
  4151. */
  4152. public static function return_most_accessed_courses($limit = 5)
  4153. {
  4154. $table_course_ranking = Database::get_main_table(TABLE_STATISTIC_TRACK_COURSE_RANKING);
  4155. $params['url_id'] = api_get_current_access_url_id();
  4156. $result = Database::select(
  4157. 'c_id, accesses, total_score, users',
  4158. $table_course_ranking,
  4159. array('where' => array('url_id = ?' => $params), 'order' => 'accesses DESC', 'limit' => $limit),
  4160. 'all',
  4161. true
  4162. );
  4163. return $result;
  4164. }
  4165. /**
  4166. * Get courses count
  4167. * @param int Access URL ID (optional)
  4168. * @param int $visibility
  4169. *
  4170. * @return int Number of courses
  4171. */
  4172. public static function count_courses($access_url_id = null, $visibility = null)
  4173. {
  4174. $table_course = Database::get_main_table(TABLE_MAIN_COURSE);
  4175. $table_course_rel_access_url = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_COURSE);
  4176. $sql = "SELECT count(id) FROM $table_course c";
  4177. if (!empty($access_url_id) && $access_url_id == intval($access_url_id)) {
  4178. $sql .= ", $table_course_rel_access_url u
  4179. WHERE c.id = u.c_id AND u.access_url_id = $access_url_id";
  4180. if (!empty($visibility)) {
  4181. $visibility = intval($visibility);
  4182. $sql .= " AND visibility = $visibility ";
  4183. }
  4184. } else {
  4185. if (!empty($visibility)) {
  4186. $visibility = intval($visibility);
  4187. $sql .= " WHERE visibility = $visibility ";
  4188. }
  4189. }
  4190. $res = Database::query($sql);
  4191. $row = Database::fetch_row($res);
  4192. return $row[0];
  4193. }
  4194. /**
  4195. * Get active courses count.
  4196. * Active = all courses except the ones with hidden visibility.
  4197. *
  4198. * @param int $urlId Access URL ID (optional)
  4199. * @return int Number of courses
  4200. */
  4201. public static function countActiveCourses($urlId = null)
  4202. {
  4203. $table_course = Database::get_main_table(TABLE_MAIN_COURSE);
  4204. $table_course_rel_access_url = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_COURSE);
  4205. $sql = "SELECT count(id) FROM $table_course c";
  4206. if (!empty($urlId) && $urlId == intval($urlId)) {
  4207. $sql .= ", $table_course_rel_access_url u
  4208. WHERE
  4209. c.id = u.c_id AND
  4210. u.access_url_id = $urlId AND
  4211. visibility <> " . COURSE_VISIBILITY_HIDDEN;
  4212. } else {
  4213. $sql .= " WHERE visibility <> " . COURSE_VISIBILITY_HIDDEN;
  4214. }
  4215. $res = Database::query($sql);
  4216. $row = Database::fetch_row($res);
  4217. return $row[0];
  4218. }
  4219. /**
  4220. * Get available le courses count
  4221. * @param int Access URL ID (optional)
  4222. * @return int Number of courses
  4223. */
  4224. public static function countAvailableCourses($accessUrlId = null)
  4225. {
  4226. global $_configuration;
  4227. $tableCourse = Database::get_main_table(TABLE_MAIN_COURSE);
  4228. $tableCourseRelAccessUrl = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_COURSE);
  4229. $specialCourseList = self::get_special_course_list();
  4230. $withoutSpecialCourses = '';
  4231. if (!empty($specialCourseList)) {
  4232. $withoutSpecialCourses = ' AND c.code NOT IN ("' . implode('","', $specialCourseList) . '")';
  4233. }
  4234. $visibilityCondition = null;
  4235. $hidePrivate = api_get_setting('course_catalog_hide_private');
  4236. if ($hidePrivate === 'true') {
  4237. $courseInfo = api_get_course_info();
  4238. $courseVisibility = $courseInfo['visibility'];
  4239. $visibilityCondition = ' AND c.visibility <> 1';
  4240. }
  4241. if (!empty($accessUrlId) && $accessUrlId == intval($accessUrlId)) {
  4242. $sql = "SELECT count(c.id) FROM $tableCourse c, $tableCourseRelAccessUrl u
  4243. WHERE
  4244. c.id = u.c_id AND
  4245. u.access_url_id = $accessUrlId AND
  4246. c.visibility != 0 AND
  4247. c.visibility != 4
  4248. $withoutSpecialCourses
  4249. $visibilityCondition
  4250. ";
  4251. }
  4252. $res = Database::query($sql);
  4253. $row = Database::fetch_row($res);
  4254. return $row[0];
  4255. }
  4256. /**
  4257. * Return a link to go to the course, validating the visibility of the
  4258. * course and the user status
  4259. * @param int User ID
  4260. * @param array Course details array
  4261. * @param array List of courses to which the user is subscribed (if not provided, will be generated)
  4262. * @return mixed 'enter' for a link to go to the course or 'register' for a link to subscribe, or false if no access
  4263. */
  4264. static function get_access_link_by_user($uid, $course, $user_courses = array())
  4265. {
  4266. if (empty($uid) or empty($course)) {
  4267. return false;
  4268. }
  4269. if (empty($user_courses)) {
  4270. // get the array of courses to which the user is subscribed
  4271. $user_courses = CourseManager::get_courses_list_by_user_id($uid);
  4272. foreach ($user_courses as $k => $v) {
  4273. $user_courses[$k] = $v['real_id'];
  4274. }
  4275. }
  4276. if (!isset($course['real_id']) && empty($course['real_id'])) {
  4277. $course = api_get_course_info($course['code']);
  4278. }
  4279. if ($course['visibility'] == COURSE_VISIBILITY_HIDDEN) {
  4280. return array();
  4281. }
  4282. $is_admin = api_is_platform_admin_by_id($uid);
  4283. $options = array();
  4284. // Register button
  4285. if (!api_is_anonymous($uid) &&
  4286. (
  4287. ($course['visibility'] == COURSE_VISIBILITY_OPEN_WORLD || $course['visibility'] == COURSE_VISIBILITY_OPEN_PLATFORM)
  4288. //$course['visibility'] == COURSE_VISIBILITY_REGISTERED && $course['subscribe'] == SUBSCRIBE_ALLOWED
  4289. ) &&
  4290. $course['subscribe'] == SUBSCRIBE_ALLOWED &&
  4291. (!in_array($course['real_id'], $user_courses) || empty($user_courses))
  4292. ) {
  4293. $options[] = 'register';
  4294. }
  4295. // Go To Course button (only if admin, if course public or if student already subscribed)
  4296. if ($is_admin ||
  4297. $course['visibility'] == COURSE_VISIBILITY_OPEN_WORLD && empty($course['registration_code']) ||
  4298. (api_user_is_login($uid) && $course['visibility'] == COURSE_VISIBILITY_OPEN_PLATFORM && empty($course['registration_code'])) ||
  4299. (in_array($course['real_id'], $user_courses) && $course['visibility'] != COURSE_VISIBILITY_CLOSED)
  4300. ) {
  4301. $options[] = 'enter';
  4302. }
  4303. if ($is_admin ||
  4304. $course['visibility'] == COURSE_VISIBILITY_OPEN_WORLD && empty($course['registration_code']) ||
  4305. (api_user_is_login($uid) && $course['visibility'] == COURSE_VISIBILITY_OPEN_PLATFORM && empty($course['registration_code'])) ||
  4306. (in_array($course['real_id'], $user_courses) && $course['visibility'] != COURSE_VISIBILITY_CLOSED)
  4307. ) {
  4308. $options[] = 'enter';
  4309. }
  4310. if ($course['visibility'] != COURSE_VISIBILITY_HIDDEN && empty($course['registration_code']) && $course['unsubscribe'] == UNSUBSCRIBE_ALLOWED && api_user_is_login($uid) && (in_array($course['real_id'],
  4311. $user_courses))
  4312. ) {
  4313. $options[] = 'unsubscribe';
  4314. }
  4315. return $options;
  4316. }
  4317. /**
  4318. * @param int $courseId
  4319. * @param array $teachers
  4320. * @param bool $deleteTeachersNotInList
  4321. * @param bool $editTeacherInSessions
  4322. * @param bool $deleteSessionTeacherNotInList
  4323. * @return bool
  4324. */
  4325. public static function updateTeachers(
  4326. $courseId,
  4327. $teachers,
  4328. $deleteTeachersNotInList = true,
  4329. $editTeacherInSessions = false,
  4330. $deleteSessionTeacherNotInList = false
  4331. ) {
  4332. if (empty($teachers)) {
  4333. return false;
  4334. }
  4335. if (!is_array($teachers)) {
  4336. $teachers = array($teachers);
  4337. }
  4338. $courseId = intval($courseId);
  4339. $courseInfo = api_get_course_info_by_id($courseId);
  4340. $course_code = $courseInfo['code'];
  4341. $course_user_table = Database::get_main_table(TABLE_MAIN_COURSE_USER);
  4342. $alreadyAddedTeachers = CourseManager::get_teacher_list_from_course_code($course_code);
  4343. if ($deleteTeachersNotInList) {
  4344. // Delete only teacher relations that doesn't match the selected teachers
  4345. $cond = null;
  4346. if (count($teachers) > 0) {
  4347. foreach ($teachers as $key) {
  4348. $key = Database::escape_string($key);
  4349. $cond .= " AND user_id <> '" . $key . "'";
  4350. }
  4351. }
  4352. $sql = 'DELETE FROM ' . $course_user_table . '
  4353. WHERE c_id ="' . $courseId . '" AND status="1"' . $cond;
  4354. Database::query($sql);
  4355. }
  4356. if (count($teachers) > 0) {
  4357. foreach ($teachers as $userId) {
  4358. $userId = intval($userId);
  4359. // We check if the teacher is already subscribed in this course
  4360. $sql = 'SELECT 1 FROM ' . $course_user_table . '
  4361. WHERE user_id = "' . $userId . '" AND c_id = "' . $courseId . '" ';
  4362. $result = Database::query($sql);
  4363. if (Database::num_rows($result)) {
  4364. $sql = 'UPDATE ' . $course_user_table . ' SET status = "1"
  4365. WHERE c_id = "' . $courseId . '" AND user_id = "' . $userId . '" ';
  4366. } else {
  4367. $sql = "INSERT INTO " . $course_user_table . " SET
  4368. c_id = '" . $courseId . "',
  4369. user_id = '" . $userId . "',
  4370. status = '1',
  4371. is_tutor = '0',
  4372. sort = '0',
  4373. user_course_cat='0'";
  4374. }
  4375. Database::query($sql);
  4376. }
  4377. }
  4378. if ($editTeacherInSessions) {
  4379. $sessions = SessionManager::get_session_by_course($courseId);
  4380. if (!empty($sessions)) {
  4381. foreach ($sessions as $session) {
  4382. // Remove old and add new
  4383. if ($deleteSessionTeacherNotInList) {
  4384. foreach ($teachers as $userId) {
  4385. SessionManager::set_coach_to_course_session($userId, $session['id'], $courseId);
  4386. }
  4387. $teachersToDelete = array();
  4388. if (!empty($alreadyAddedTeachers)) {
  4389. $teachersToDelete = array_diff(array_keys($alreadyAddedTeachers), $teachers);
  4390. }
  4391. if (!empty($teachersToDelete)) {
  4392. foreach ($teachersToDelete as $userId) {
  4393. SessionManager::set_coach_to_course_session($userId, $session['id'], $courseId,
  4394. true);
  4395. }
  4396. }
  4397. } else {
  4398. // Add new teachers only
  4399. foreach ($teachers as $userId) {
  4400. SessionManager::set_coach_to_course_session($userId, $session['id'], $courseId);
  4401. }
  4402. }
  4403. }
  4404. }
  4405. }
  4406. }
  4407. /**
  4408. * Course available settings variables see c_course_setting table
  4409. * @param AppPlugin $appPlugin
  4410. * @return array
  4411. */
  4412. public static function getCourseSettingVariables(AppPlugin $appPlugin)
  4413. {
  4414. $pluginCourseSettings = $appPlugin->getAllPluginCourseSettings();
  4415. $courseSettings = array(
  4416. // Get allow_learning_path_theme from table
  4417. 'allow_learning_path_theme',
  4418. // Get allow_open_chat_window from table
  4419. 'allow_open_chat_window',
  4420. 'allow_public_certificates',
  4421. // Get allow_user_edit_agenda from table
  4422. 'allow_user_edit_agenda',
  4423. // Get allow_user_edit_announcement from table
  4424. 'allow_user_edit_announcement',
  4425. // Get allow_user_image_forum from table
  4426. 'allow_user_image_forum',
  4427. //Get allow show user list
  4428. 'allow_user_view_user_list',
  4429. // Get course_theme from table
  4430. 'course_theme',
  4431. //Get allow show user list
  4432. 'display_info_advance_inside_homecourse',
  4433. 'documents_default_visibility',
  4434. // Get send_mail_setting (work)from table
  4435. 'email_alert_manager_on_new_doc',
  4436. // Get send_mail_setting (work)from table
  4437. 'email_alert_manager_on_new_quiz',
  4438. // Get send_mail_setting (dropbox) from table
  4439. 'email_alert_on_new_doc_dropbox',
  4440. 'email_alert_students_on_new_homework',
  4441. // Get send_mail_setting (auth)from table
  4442. 'email_alert_to_teacher_on_new_user_in_course',
  4443. 'enable_lp_auto_launch',
  4444. 'pdf_export_watermark_text',
  4445. 'show_system_folders'
  4446. );
  4447. $allowLPReturnLink = api_get_setting('allow_lp_return_link');
  4448. if ($allowLPReturnLink === 'true') {
  4449. $courseSettings[] = 'lp_return_link';
  4450. }
  4451. if (!empty($pluginCourseSettings)) {
  4452. $courseSettings = array_merge(
  4453. $courseSettings,
  4454. $pluginCourseSettings
  4455. );
  4456. }
  4457. return $courseSettings;
  4458. }
  4459. /**
  4460. * @param AppPlugin $appPlugin
  4461. * @param string $variable
  4462. * @param string $value
  4463. * @param int $courseId
  4464. * @return bool
  4465. */
  4466. public static function saveCourseConfigurationSetting(AppPlugin $appPlugin, $variable, $value, $courseId)
  4467. {
  4468. $settingList = self::getCourseSettingVariables($appPlugin);
  4469. if (!in_array($variable, $settingList)) {
  4470. return false;
  4471. }
  4472. $courseSettingTable = Database::get_course_table(TABLE_COURSE_SETTING);
  4473. if (self::hasCourseSetting($variable, $courseId)) {
  4474. // Update
  4475. Database::update(
  4476. $courseSettingTable,
  4477. array('value' => $value),
  4478. array('variable = ? AND c_id = ?' => array($variable, $courseId))
  4479. );
  4480. } else {
  4481. // Create
  4482. Database::insert(
  4483. $courseSettingTable,
  4484. array('value' => $value, 'c_id' => $courseId, 'variable' => $variable)
  4485. );
  4486. }
  4487. return true;
  4488. }
  4489. /**
  4490. * Check if course setting exists
  4491. * @param string $variable
  4492. * @param int $courseId
  4493. * @return bool
  4494. */
  4495. public static function hasCourseSetting($variable, $courseId)
  4496. {
  4497. $courseSetting = Database::get_course_table(TABLE_COURSE_SETTING);
  4498. $courseId = intval($courseId);
  4499. $variable = Database::escape_string($variable);
  4500. $sql = "SELECT variable FROM $courseSetting
  4501. WHERE c_id = $courseId AND variable = '$variable'";
  4502. $result = Database::query($sql);
  4503. return Database::num_rows($result) > 0;
  4504. }
  4505. /**
  4506. * Get information from the track_e_course_access table
  4507. * @param int $sessionId
  4508. * @param int $userId
  4509. * @return array
  4510. */
  4511. public static function getCourseAccessPerSessionAndUser($sessionId, $userId, $limit = null)
  4512. {
  4513. $table = Database:: get_main_table(TABLE_STATISTIC_TRACK_E_COURSE_ACCESS);
  4514. $sessionId = intval($sessionId);
  4515. $userId = intval($userId);
  4516. $sql = "SELECT * FROM $table
  4517. WHERE session_id = $sessionId AND user_id = $userId";
  4518. if (!empty($limit)) {
  4519. $limit = intval($limit);
  4520. $sql .= " LIMIT $limit";
  4521. }
  4522. $result = Database::query($sql);
  4523. return Database::store_result($result);
  4524. }
  4525. /**
  4526. * Get information from the track_e_course_access table
  4527. * @param int $courseId
  4528. * @param int $sessionId
  4529. * @param string $startDate
  4530. * @param string $endDate
  4531. * @return array
  4532. */
  4533. public static function getCourseAccessPerCourseAndSession(
  4534. $courseId,
  4535. $sessionId,
  4536. $startDate,
  4537. $endDate
  4538. ) {
  4539. $table = Database:: get_main_table(TABLE_STATISTIC_TRACK_E_COURSE_ACCESS);
  4540. $courseId = intval($courseId);
  4541. $sessionId = intval($sessionId);
  4542. $startDate = Database::escape_string($startDate);
  4543. $endDate = Database::escape_string($endDate);
  4544. $sql = "SELECT * FROM $table
  4545. WHERE
  4546. c_id = $courseId AND
  4547. session_id = $sessionId AND
  4548. login_course_date BETWEEN '$startDate' AND '$endDate'
  4549. ";
  4550. $result = Database::query($sql);
  4551. return Database::store_result($result);
  4552. }
  4553. /**
  4554. * Get login information from the track_e_course_access table, for any
  4555. * course in the given session
  4556. * @param int $sessionId
  4557. * @param int $userId
  4558. * @return array
  4559. */
  4560. public static function getFirstCourseAccessPerSessionAndUser($sessionId, $userId)
  4561. {
  4562. $sessionId = intval($sessionId);
  4563. $userId = intval($userId);
  4564. $table = Database:: get_main_table(TABLE_STATISTIC_TRACK_E_COURSE_ACCESS);
  4565. $sql = "SELECT * FROM $table
  4566. WHERE session_id = $sessionId AND user_id = $userId
  4567. ORDER BY login_course_date ASC
  4568. LIMIT 1";
  4569. $result = Database::query($sql);
  4570. $courseAccess = array();
  4571. if (Database::num_rows($result)) {
  4572. $courseAccess = Database::fetch_array($result, 'ASSOC');
  4573. }
  4574. return $courseAccess;
  4575. }
  4576. /**
  4577. * @param int $courseId
  4578. * @param int $sessionId
  4579. * @param bool $getAllSessions
  4580. * @return mixed
  4581. */
  4582. public static function getCountForum(
  4583. $courseId,
  4584. $sessionId = 0,
  4585. $getAllSessions = false
  4586. ) {
  4587. $forum = Database::get_course_table(TABLE_FORUM);
  4588. if ($getAllSessions) {
  4589. $sql = "SELECT count(*) as count
  4590. FROM $forum f
  4591. where f.c_id = %s";
  4592. } else {
  4593. $sql = "SELECT count(*) as count
  4594. FROM $forum f
  4595. where f.c_id = %s and f.session_id = %s";
  4596. }
  4597. $sql = sprintf($sql, intval($courseId), intval($sessionId));
  4598. $result = Database::query($sql);
  4599. $row = Database::fetch_array($result);
  4600. return $row['count'];
  4601. }
  4602. /**
  4603. * @param int $userId
  4604. * @param int $courseId
  4605. * @param int $sessionId
  4606. * @return mixed
  4607. */
  4608. public static function getCountPostInForumPerUser(
  4609. $userId,
  4610. $courseId,
  4611. $sessionId = 0
  4612. ) {
  4613. $forum = Database::get_course_table(TABLE_FORUM);
  4614. $forum_post = Database::get_course_table(TABLE_FORUM_POST);
  4615. $sql = "SELECT count(distinct post_id) as count
  4616. FROM $forum_post p
  4617. INNER JOIN $forum f
  4618. ON f.forum_id = p.forum_id AND f.c_id = p.c_id
  4619. WHERE p.poster_id = %s and f.session_id = %s and p.c_id = %s";
  4620. $sql = sprintf(
  4621. $sql,
  4622. intval($userId),
  4623. intval($sessionId),
  4624. intval($courseId)
  4625. );
  4626. $result = Database::query($sql);
  4627. $row = Database::fetch_array($result);
  4628. return $row['count'];
  4629. }
  4630. /**
  4631. * @param int $userId
  4632. * @param int $courseId
  4633. * @param int $sessionId
  4634. * @return mixed
  4635. */
  4636. public static function getCountForumPerUser(
  4637. $userId,
  4638. $courseId,
  4639. $sessionId = 0
  4640. ) {
  4641. $forum = Database::get_course_table(TABLE_FORUM);
  4642. $forum_post = Database::get_course_table(TABLE_FORUM_POST);
  4643. $sql = "SELECT count(distinct f.forum_id) as count
  4644. FROM $forum_post p
  4645. INNER JOIN $forum f
  4646. ON f.forum_id = p.forum_id AND f.c_id = p.c_id
  4647. WHERE p.poster_id = %s and f.session_id = %s and p.c_id = %s";
  4648. $sql = sprintf(
  4649. $sql,
  4650. intval($userId),
  4651. intval($sessionId),
  4652. intval($courseId)
  4653. );
  4654. $result = Database::query($sql);
  4655. $row = Database::fetch_array($result);
  4656. return $row['count'];
  4657. }
  4658. /**
  4659. * Returns the course name from a given code
  4660. * @param string $code
  4661. */
  4662. public static function getCourseNameFromCode($code)
  4663. {
  4664. $tbl_main_categories = Database:: get_main_table(TABLE_MAIN_COURSE);
  4665. $sql = 'SELECT title
  4666. FROM ' . $tbl_main_categories . '
  4667. WHERE code = "' . Database::escape_string($code) . '"';
  4668. $result = Database::query($sql);
  4669. if ($col = Database::fetch_array($result)) {
  4670. return $col['title'];
  4671. }
  4672. }
  4673. /**
  4674. * Generates a course code from a course title
  4675. * @todo Such a function might be useful in other places too. It might be moved in the CourseManager class.
  4676. * @todo the function might be upgraded for avoiding code duplications (currently, it might suggest a code that is already in use)
  4677. * @param string $title A course title
  4678. * @return string A proposed course code
  4679. * +
  4680. * @assert (null,null) === false
  4681. * @assert ('ABC_DEF', null) === 'ABCDEF'
  4682. * @assert ('ABC09*^[%A', null) === 'ABC09A'
  4683. */
  4684. public static function generate_course_code($title)
  4685. {
  4686. return substr(
  4687. preg_replace('/[^A-Z0-9]/', '', strtoupper(api_replace_dangerous_char($title))),
  4688. 0,
  4689. CourseManager::MAX_COURSE_LENGTH_CODE
  4690. );
  4691. }
  4692. /**
  4693. * @param $courseId
  4694. * @return array
  4695. */
  4696. public static function getCourseSettings($courseId)
  4697. {
  4698. $settingTable = Database::get_course_table(TABLE_COURSE_SETTING);
  4699. $courseId = intval($courseId);
  4700. $sql = "SELECT * FROM $settingTable WHERE c_id = $courseId";
  4701. $result = Database::query($sql);
  4702. $settings = array();
  4703. if (Database::num_rows($result)) {
  4704. while ($row = Database::fetch_array($result, 'ASSOC')) {
  4705. $settings[$row['variable']] = $row;
  4706. }
  4707. }
  4708. return $settings;
  4709. }
  4710. /**
  4711. * this function gets all the users of the course,
  4712. * including users from linked courses
  4713. */
  4714. public static function getCourseUsers()
  4715. {
  4716. //this would return only the users from real courses:
  4717. $session_id = api_get_session_id();
  4718. if ($session_id != 0) {
  4719. $user_list = self::get_real_and_linked_user_list(api_get_course_id(), true, $session_id);
  4720. } else {
  4721. $user_list = self::get_real_and_linked_user_list(api_get_course_id(), false, 0);
  4722. }
  4723. return $user_list;
  4724. }
  4725. /**
  4726. * this function gets all the groups of the course,
  4727. * not including linked courses
  4728. */
  4729. public static function getCourseGroups()
  4730. {
  4731. $session_id = api_get_session_id();
  4732. if ($session_id != 0) {
  4733. $new_group_list = self::get_group_list_of_course(api_get_course_id(), $session_id, 1);
  4734. } else {
  4735. $new_group_list = self::get_group_list_of_course(api_get_course_id(), 0, 1);
  4736. }
  4737. return $new_group_list;
  4738. }
  4739. /**
  4740. * @param FormValidator $form
  4741. * @param array $to_already_selected
  4742. */
  4743. public static function addUserGroupMultiSelect(&$form, $to_already_selected)
  4744. {
  4745. $user_list = self::getCourseUsers();
  4746. $group_list = self::getCourseGroups();
  4747. $array = self::buildSelectOptions($group_list, $user_list, $to_already_selected);
  4748. $result = array();
  4749. foreach ($array as $content) {
  4750. $result[$content['value']] = $content['content'];
  4751. }
  4752. $form->addElement(
  4753. 'advmultiselect',
  4754. 'users',
  4755. get_lang('Users'),
  4756. $result,
  4757. array('select_all_checkbox' => true)
  4758. );
  4759. }
  4760. /**
  4761. * This function separates the users from the groups
  4762. * users have a value USER:XXX (with XXX the groups id have a value
  4763. * GROUP:YYY (with YYY the group id)
  4764. * @param array $to Array of strings that define the type and id of each destination
  4765. * @return array Array of groups and users (each an array of IDs)
  4766. */
  4767. public static function separateUsersGroups($to)
  4768. {
  4769. $grouplist = array();
  4770. $userlist = array();
  4771. foreach ($to as $to_item) {
  4772. if (!empty($to_item)) {
  4773. $parts = explode(':', $to_item);
  4774. $type = isset($parts[0]) ? $parts[0] : '';
  4775. $id = isset($parts[1]) ? $parts[1] : '';
  4776. switch ($type) {
  4777. case 'GROUP':
  4778. $grouplist[] = intval($id);
  4779. break;
  4780. case 'USER':
  4781. $userlist[] = intval($id);
  4782. break;
  4783. }
  4784. }
  4785. }
  4786. $send_to['groups'] = $grouplist;
  4787. $send_to['users'] = $userlist;
  4788. return $send_to;
  4789. }
  4790. /**
  4791. * this function shows the form for sending a message to a specific group or user.
  4792. */
  4793. /**
  4794. * @param FormValidator $form
  4795. * @param int $group_id
  4796. * @param array $to
  4797. */
  4798. public static function addGroupMultiSelect($form, $group_id, $to = array())
  4799. {
  4800. $group_users = GroupManager::get_subscribed_users($group_id);
  4801. $array = self::buildSelectOptions(null, $group_users, $to);
  4802. $result = array();
  4803. foreach ($array as $content) {
  4804. $result[$content['value']] = $content['content'];
  4805. }
  4806. $form->addElement('advmultiselect', 'users', get_lang('Users'), $result);
  4807. }
  4808. /**
  4809. * this function shows the form for sending a message to a specific group or user.
  4810. * @param array $group_list
  4811. * @param array $user_list
  4812. * @param array $to_already_selected
  4813. * @return array
  4814. */
  4815. public static function buildSelectOptions(
  4816. $group_list = array(),
  4817. $user_list = array(),
  4818. $to_already_selected = array()
  4819. ) {
  4820. if (empty($to_already_selected)) {
  4821. $to_already_selected = array();
  4822. }
  4823. $result = array();
  4824. // adding the groups to the select form
  4825. if ($group_list) {
  4826. foreach ($group_list as $this_group) {
  4827. if (is_array($to_already_selected)) {
  4828. if (!in_array(
  4829. "GROUP:" . $this_group['id'],
  4830. $to_already_selected
  4831. )
  4832. ) { // $to_already_selected is the array containing the groups (and users) that are already selected
  4833. $user_label = ($this_group['userNb'] > 0) ? get_lang('Users') : get_lang('LowerCaseUser');
  4834. $user_disabled = ($this_group['userNb'] > 0) ? "" : "disabled=disabled";
  4835. $result[] = array(
  4836. 'disabled' => $user_disabled,
  4837. 'value' => "GROUP:" . $this_group['id'],
  4838. 'content' => "G: " . $this_group['name'] . " - " . $this_group['userNb'] . " " . $user_label
  4839. );
  4840. }
  4841. }
  4842. }
  4843. }
  4844. // adding the individual users to the select form
  4845. if ($user_list) {
  4846. foreach ($user_list as $user) {
  4847. if (is_array($to_already_selected)) {
  4848. if (!in_array(
  4849. "USER:" . $user['user_id'],
  4850. $to_already_selected
  4851. )
  4852. ) { // $to_already_selected is the array containing the users (and groups) that are already selected
  4853. $result[] = array(
  4854. 'value' => "USER:" . $user['user_id'],
  4855. 'content' => api_get_person_name($user['firstname'], $user['lastname'])
  4856. );
  4857. }
  4858. }
  4859. }
  4860. }
  4861. return $result;
  4862. }
  4863. /**
  4864. * @return array a list (array) of all courses.
  4865. */
  4866. public static function get_course_list()
  4867. {
  4868. $table = Database::get_main_table(TABLE_MAIN_COURSE);
  4869. return Database::store_result(Database::query("SELECT *, id as real_id FROM $table"));
  4870. }
  4871. /**
  4872. * Returns course code from a given gradebook category's id
  4873. * @param int Category ID
  4874. * @return string Course code
  4875. */
  4876. public static function get_course_by_category($category_id)
  4877. {
  4878. $category_id = intval($category_id);
  4879. $info = Database::fetch_array(
  4880. Database::query('SELECT course_code FROM ' . Database::get_main_table(TABLE_MAIN_GRADEBOOK_CATEGORY) . '
  4881. WHERE id=' . $category_id), 'ASSOC'
  4882. );
  4883. return $info ? $info['course_code'] : false;
  4884. }
  4885. /**
  4886. * This function gets all the courses that are not in a session
  4887. * @param date Start date
  4888. * @param date End date
  4889. * @param bool $includeClosed Whether to include closed and hidden courses
  4890. * @return array Not-in-session courses
  4891. */
  4892. public static function getCoursesWithoutSession($startDate = null, $endDate = null, $includeClosed = false)
  4893. {
  4894. $dateConditional = ($startDate && $endDate) ?
  4895. " WHERE session_id IN (SELECT id FROM " . Database::get_main_table(TABLE_MAIN_SESSION) .
  4896. " WHERE date_start = '$startDate' AND date_end = '$endDate')" :
  4897. null;
  4898. $visibility = ($includeClosed ? '' : 'visibility NOT IN (0, 4) AND ');
  4899. $query = "SELECT id, code, title
  4900. FROM " . Database::get_main_table(TABLE_MAIN_COURSE). "
  4901. WHERE $visibility code NOT IN (
  4902. SELECT DISTINCT course_code FROM " . Database::get_main_table(TABLE_MAIN_SESSION_COURSE) . $dateConditional . ")
  4903. ORDER BY id";
  4904. $result = Database::query($query);
  4905. $courses = array();
  4906. while ($row = Database::fetch_array($result)) {
  4907. $courses[] = $row;
  4908. }
  4909. return $courses;
  4910. }
  4911. /**
  4912. * Get list of courses based on users of a group for a group admin
  4913. * @param int $userId The user id
  4914. * @return array
  4915. */
  4916. public static function getCoursesFollowedByGroupAdmin($userId)
  4917. {
  4918. $coursesList = [];
  4919. $courseTable = Database::get_main_table(TABLE_MAIN_COURSE);
  4920. $courseUserTable = Database::get_main_table(TABLE_MAIN_COURSE_USER);
  4921. $userGroup = new UserGroup();
  4922. $userIdList = $userGroup->getGroupUsersByUser($userId);
  4923. if (empty($userIdList)) {
  4924. return [];
  4925. }
  4926. $sql = "SELECT DISTINCT(c.id), c.title
  4927. FROM $courseTable c
  4928. INNER JOIN $courseUserTable cru ON c.id = cru.c_id
  4929. WHERE (
  4930. cru.user_id IN (" . implode(', ', $userIdList) . ")
  4931. AND cru.relation_type = 0
  4932. )";
  4933. if (api_is_multiple_url_enabled()) {
  4934. $courseAccessUrlTable = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_COURSE);
  4935. $accessUrlId = api_get_current_access_url_id();
  4936. if ($accessUrlId != -1) {
  4937. $sql = "SELECT DISTINCT(c.id), c.title
  4938. FROM $courseTable c
  4939. INNER JOIN $courseUserTable cru ON c.id = cru.c_id
  4940. INNER JOIN $courseAccessUrlTable crau ON c.id = crau.c_id
  4941. WHERE crau.access_url_id = $accessUrlId
  4942. AND (
  4943. cru.id_user IN (" . implode(', ', $userIdList) . ") AND
  4944. cru.relation_type = 0
  4945. )";
  4946. }
  4947. }
  4948. $result = Database::query($sql);
  4949. while ($row = Database::fetch_assoc($result)) {
  4950. $coursesList[] = $row;
  4951. }
  4952. return $coursesList;
  4953. }
  4954. }