course.lib.php 235 KB

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