course.lib.php 212 KB

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