course.lib.php 211 KB

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