api.lib.php 302 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578
  1. <?php
  2. /* For licensing terms, see /license.txt */
  3. use Chamilo\CoreBundle\Entity\SettingsCurrent;
  4. use Chamilo\CourseBundle\Entity\CItemProperty;
  5. use Chamilo\UserBundle\Entity\User;
  6. use ChamiloSession as Session;
  7. use Symfony\Component\Finder\Finder;
  8. /**
  9. * This is a code library for Chamilo.
  10. * It is included by default in every Chamilo file (through including the global.inc.php)
  11. * This library is in process of being transferred to src/Chamilo/CoreBundle/Component/Utils/ChamiloApi.
  12. * Whenever a function is transferred to the ChamiloApi class, the places where it is used should include
  13. * the "use Chamilo\CoreBundle\Component\Utils\ChamiloApi;" statement.
  14. *
  15. * @package chamilo.library
  16. */
  17. /**
  18. * Constants declaration.
  19. */
  20. // PHP version requirement.
  21. define('REQUIRED_PHP_VERSION', '5.5');
  22. define('REQUIRED_MIN_MEMORY_LIMIT', '128');
  23. define('REQUIRED_MIN_UPLOAD_MAX_FILESIZE', '10');
  24. define('REQUIRED_MIN_POST_MAX_SIZE', '10');
  25. // USER STATUS CONSTANTS
  26. /** global status of a user: student */
  27. define('STUDENT', 5);
  28. /** global status of a user: course manager */
  29. define('COURSEMANAGER', 1);
  30. /** global status of a user: session admin */
  31. define('SESSIONADMIN', 3);
  32. /** global status of a user: human ressource manager */
  33. define('DRH', 4);
  34. /** global status of a user: human ressource manager */
  35. define('ANONYMOUS', 6);
  36. /** global status of a user: low security, necessary for inserting data from
  37. * the teacher through HTMLPurifier */
  38. define('COURSEMANAGERLOWSECURITY', 10);
  39. // Soft user status
  40. define('PLATFORM_ADMIN', 11);
  41. define('SESSION_COURSE_COACH', 12);
  42. define('SESSION_GENERAL_COACH', 13);
  43. define('COURSE_STUDENT', 14); //student subscribed in a course
  44. define('SESSION_STUDENT', 15); //student subscribed in a session course
  45. define('COURSE_TUTOR', 16); // student is tutor of a course (NOT in session)
  46. define('STUDENT_BOSS', 17); // student is boss
  47. define('INVITEE', 20);
  48. define('HRM_REQUEST', 21); //HRM has request for vinculation with user
  49. // Table of status
  50. $_status_list[COURSEMANAGER] = 'teacher'; // 1
  51. $_status_list[SESSIONADMIN] = 'session_admin'; // 3
  52. $_status_list[DRH] = 'drh'; // 4
  53. $_status_list[STUDENT] = 'user'; // 5
  54. $_status_list[ANONYMOUS] = 'anonymous'; // 6
  55. $_status_list[INVITEE] = 'invited'; // 20
  56. // COURSE VISIBILITY CONSTANTS
  57. /** only visible for course admin */
  58. define('COURSE_VISIBILITY_CLOSED', 0);
  59. /** only visible for users registered in the course */
  60. define('COURSE_VISIBILITY_REGISTERED', 1);
  61. /** Open for all registered users on the platform */
  62. define('COURSE_VISIBILITY_OPEN_PLATFORM', 2);
  63. /** Open for the whole world */
  64. define('COURSE_VISIBILITY_OPEN_WORLD', 3);
  65. /** Invisible to all except admin */
  66. define('COURSE_VISIBILITY_HIDDEN', 4);
  67. define('COURSE_REQUEST_PENDING', 0);
  68. define('COURSE_REQUEST_ACCEPTED', 1);
  69. define('COURSE_REQUEST_REJECTED', 2);
  70. define('DELETE_ACTION_ENABLED', false);
  71. // EMAIL SENDING RECIPIENT CONSTANTS
  72. define('SEND_EMAIL_EVERYONE', 1);
  73. define('SEND_EMAIL_STUDENTS', 2);
  74. define('SEND_EMAIL_TEACHERS', 3);
  75. // SESSION VISIBILITY CONSTANTS
  76. define('SESSION_VISIBLE_READ_ONLY', 1);
  77. define('SESSION_VISIBLE', 2);
  78. define('SESSION_INVISIBLE', 3); // not available
  79. define('SESSION_AVAILABLE', 4);
  80. define('SESSION_LINK_TARGET', '_self');
  81. define('SUBSCRIBE_ALLOWED', 1);
  82. define('SUBSCRIBE_NOT_ALLOWED', 0);
  83. define('UNSUBSCRIBE_ALLOWED', 1);
  84. define('UNSUBSCRIBE_NOT_ALLOWED', 0);
  85. // SURVEY VISIBILITY CONSTANTS
  86. define('SURVEY_VISIBLE_TUTOR', 0);
  87. define('SURVEY_VISIBLE_TUTOR_STUDENT', 1);
  88. define('SURVEY_VISIBLE_PUBLIC', 2);
  89. // CONSTANTS defining all tools, using the english version
  90. /* When you add a new tool you must add it into function api_get_tools_lists() too */
  91. define('TOOL_DOCUMENT', 'document');
  92. define('TOOL_LP_FINAL_ITEM', 'final_item');
  93. define('TOOL_READOUT_TEXT', 'readout_text');
  94. define('TOOL_THUMBNAIL', 'thumbnail');
  95. define('TOOL_HOTPOTATOES', 'hotpotatoes');
  96. define('TOOL_CALENDAR_EVENT', 'calendar_event');
  97. define('TOOL_LINK', 'link');
  98. define('TOOL_LINK_CATEGORY', 'link_category');
  99. define('TOOL_COURSE_DESCRIPTION', 'course_description');
  100. define('TOOL_SEARCH', 'search');
  101. define('TOOL_LEARNPATH', 'learnpath');
  102. define('TOOL_LEARNPATH_CATEGORY', 'learnpath_category');
  103. define('TOOL_AGENDA', 'agenda');
  104. define('TOOL_ANNOUNCEMENT', 'announcement');
  105. define('TOOL_FORUM', 'forum');
  106. define('TOOL_FORUM_CATEGORY', 'forum_category');
  107. define('TOOL_FORUM_THREAD', 'forum_thread');
  108. define('TOOL_FORUM_POST', 'forum_post');
  109. define('TOOL_FORUM_ATTACH', 'forum_attachment');
  110. define('TOOL_FORUM_THREAD_QUALIFY', 'forum_thread_qualify');
  111. define('TOOL_THREAD', 'thread');
  112. define('TOOL_POST', 'post');
  113. define('TOOL_DROPBOX', 'dropbox');
  114. define('TOOL_QUIZ', 'quiz');
  115. define('TOOL_TEST_CATEGORY', 'test_category');
  116. define('TOOL_USER', 'user');
  117. define('TOOL_GROUP', 'group');
  118. define('TOOL_BLOGS', 'blog_management');
  119. define('TOOL_CHAT', 'chat');
  120. define('TOOL_STUDENTPUBLICATION', 'student_publication');
  121. define('TOOL_TRACKING', 'tracking');
  122. define('TOOL_HOMEPAGE_LINK', 'homepage_link');
  123. define('TOOL_COURSE_SETTING', 'course_setting');
  124. define('TOOL_BACKUP', 'backup');
  125. define('TOOL_COPY_COURSE_CONTENT', 'copy_course_content');
  126. define('TOOL_RECYCLE_COURSE', 'recycle_course');
  127. define('TOOL_COURSE_HOMEPAGE', 'course_homepage');
  128. define('TOOL_COURSE_RIGHTS_OVERVIEW', 'course_rights');
  129. define('TOOL_UPLOAD', 'file_upload');
  130. define('TOOL_COURSE_MAINTENANCE', 'course_maintenance');
  131. define('TOOL_SURVEY', 'survey');
  132. define('TOOL_WIKI', 'wiki');
  133. define('TOOL_GLOSSARY', 'glossary');
  134. define('TOOL_GRADEBOOK', 'gradebook');
  135. define('TOOL_NOTEBOOK', 'notebook');
  136. define('TOOL_ATTENDANCE', 'attendance');
  137. define('TOOL_COURSE_PROGRESS', 'course_progress');
  138. define('TOOL_PORTFOLIO', 'portfolio');
  139. define('TOOL_PLAGIARISM', 'compilatio');
  140. // CONSTANTS defining Chamilo interface sections
  141. define('SECTION_CAMPUS', 'mycampus');
  142. define('SECTION_COURSES', 'mycourses');
  143. define('SECTION_CATALOG', 'catalog');
  144. define('SECTION_MYPROFILE', 'myprofile');
  145. define('SECTION_MYAGENDA', 'myagenda');
  146. define('SECTION_COURSE_ADMIN', 'course_admin');
  147. define('SECTION_PLATFORM_ADMIN', 'platform_admin');
  148. define('SECTION_MYGRADEBOOK', 'mygradebook');
  149. define('SECTION_TRACKING', 'session_my_space');
  150. define('SECTION_SOCIAL', 'social-network');
  151. define('SECTION_DASHBOARD', 'dashboard');
  152. define('SECTION_REPORTS', 'reports');
  153. define('SECTION_GLOBAL', 'global');
  154. define('SECTION_INCLUDE', 'include');
  155. // CONSTANT name for local authentication source
  156. define('PLATFORM_AUTH_SOURCE', 'platform');
  157. define('CAS_AUTH_SOURCE', 'cas');
  158. define('LDAP_AUTH_SOURCE', 'extldap');
  159. // CONSTANT defining the default HotPotatoes files directory
  160. define('DIR_HOTPOTATOES', '/HotPotatoes_files');
  161. // event logs types
  162. define('LOG_COURSE_DELETE', 'course_deleted');
  163. define('LOG_COURSE_CREATE', 'course_created');
  164. // @todo replace 'soc_gr' with social_group
  165. define('LOG_GROUP_PORTAL_CREATED', 'soc_gr_created');
  166. define('LOG_GROUP_PORTAL_UPDATED', 'soc_gr_updated');
  167. define('LOG_GROUP_PORTAL_DELETED', 'soc_gr_deleted');
  168. define('LOG_GROUP_PORTAL_USER_DELETE_ALL', 'soc_gr_delete_users');
  169. define('LOG_GROUP_PORTAL_ID', 'soc_gr_portal_id');
  170. define('LOG_GROUP_PORTAL_REL_USER_ARRAY', 'soc_gr_user_array');
  171. define('LOG_GROUP_PORTAL_USER_SUBSCRIBED', 'soc_gr_u_subs');
  172. define('LOG_GROUP_PORTAL_USER_UNSUBSCRIBED', 'soc_gr_u_unsubs');
  173. define('LOG_GROUP_PORTAL_USER_UPDATE_ROLE', 'soc_gr_update_role');
  174. define('LOG_USER_DELETE', 'user_deleted');
  175. define('LOG_USER_CREATE', 'user_created');
  176. define('LOG_USER_ENABLE', 'user_enable');
  177. define('LOG_USER_DISABLE', 'user_disable');
  178. define('LOG_USER_ANONYMIZE', 'user_anonymized');
  179. define('LOG_USER_FIELD_CREATE', 'user_field_created');
  180. define('LOG_USER_FIELD_DELETE', 'user_field_deleted');
  181. define('LOG_SESSION_CREATE', 'session_created');
  182. define('LOG_SESSION_DELETE', 'session_deleted');
  183. define('LOG_SESSION_ADD_USER_COURSE', 'session_add_user_course');
  184. define('LOG_SESSION_DELETE_USER_COURSE', 'session_delete_user_course');
  185. define('LOG_SESSION_ADD_USER', 'session_add_user');
  186. define('LOG_SESSION_DELETE_USER', 'session_delete_user');
  187. define('LOG_SESSION_ADD_COURSE', 'session_add_course');
  188. define('LOG_SESSION_DELETE_COURSE', 'session_delete_course');
  189. define('LOG_SESSION_CATEGORY_CREATE', 'session_cat_created'); //changed in 1.9.8
  190. define('LOG_SESSION_CATEGORY_DELETE', 'session_cat_deleted'); //changed in 1.9.8
  191. define('LOG_CONFIGURATION_SETTINGS_CHANGE', 'settings_changed');
  192. define('LOG_PLATFORM_LANGUAGE_CHANGE', 'platform_lng_changed'); //changed in 1.9.8
  193. define('LOG_SUBSCRIBE_USER_TO_COURSE', 'user_subscribed');
  194. define('LOG_UNSUBSCRIBE_USER_FROM_COURSE', 'user_unsubscribed');
  195. define('LOG_ATTEMPTED_FORCED_LOGIN', 'attempted_forced_login');
  196. define('LOG_HOMEPAGE_CHANGED', 'homepage_changed');
  197. define('LOG_PROMOTION_CREATE', 'promotion_created');
  198. define('LOG_PROMOTION_DELETE', 'promotion_deleted');
  199. define('LOG_CAREER_CREATE', 'career_created');
  200. define('LOG_CAREER_DELETE', 'career_deleted');
  201. define('LOG_USER_PERSONAL_DOC_DELETED', 'user_doc_deleted');
  202. define('LOG_WIKI_ACCESS', 'wiki_page_view');
  203. // All results from an exercise
  204. define('LOG_EXERCISE_RESULT_DELETE', 'exe_result_deleted');
  205. // Logs only the one attempt
  206. define('LOG_EXERCISE_ATTEMPT_DELETE', 'exe_attempt_deleted');
  207. define('LOG_LP_ATTEMPT_DELETE', 'lp_attempt_deleted');
  208. define('LOG_QUESTION_RESULT_DELETE', 'qst_attempt_deleted');
  209. define('LOG_MY_FOLDER_CREATE', 'my_folder_created');
  210. define('LOG_MY_FOLDER_CHANGE', 'my_folder_changed');
  211. define('LOG_MY_FOLDER_DELETE', 'my_folder_deleted');
  212. define('LOG_MY_FOLDER_COPY', 'my_folder_copied');
  213. define('LOG_MY_FOLDER_CUT', 'my_folder_cut');
  214. define('LOG_MY_FOLDER_PASTE', 'my_folder_pasted');
  215. define('LOG_MY_FOLDER_UPLOAD', 'my_folder_uploaded');
  216. // Event logs data types (max 20 chars)
  217. define('LOG_COURSE_CODE', 'course_code');
  218. define('LOG_COURSE_ID', 'course_id');
  219. define('LOG_USER_ID', 'user_id');
  220. define('LOG_USER_OBJECT', 'user_object');
  221. define('LOG_USER_FIELD_VARIABLE', 'user_field_variable');
  222. define('LOG_SESSION_ID', 'session_id');
  223. define('LOG_QUESTION_ID', 'question_id');
  224. define('LOG_SESSION_CATEGORY_ID', 'session_category_id');
  225. define('LOG_CONFIGURATION_SETTINGS_CATEGORY', 'settings_category');
  226. define('LOG_CONFIGURATION_SETTINGS_VARIABLE', 'settings_variable');
  227. define('LOG_PLATFORM_LANGUAGE', 'default_platform_language');
  228. define('LOG_CAREER_ID', 'career_id');
  229. define('LOG_PROMOTION_ID', 'promotion_id');
  230. define('LOG_GRADEBOOK_LOCKED', 'gradebook_locked');
  231. define('LOG_GRADEBOOK_UNLOCKED', 'gradebook_unlocked');
  232. define('LOG_GRADEBOOK_ID', 'gradebook_id');
  233. define('LOG_WIKI_PAGE_ID', 'wiki_page_id');
  234. define('LOG_EXERCISE_ID', 'exercise_id');
  235. define('LOG_EXERCISE_AND_USER_ID', 'exercise_and_user_id');
  236. define('LOG_LP_ID', 'lp_id');
  237. define('LOG_EXERCISE_ATTEMPT_QUESTION_ID', 'exercise_a_q_id');
  238. define('LOG_EXERCISE_ATTEMPT', 'exe_id');
  239. define('LOG_WORK_DIR_DELETE', 'work_dir_delete');
  240. define('LOG_WORK_FILE_DELETE', 'work_file_delete');
  241. define('LOG_WORK_DATA', 'work_data_array');
  242. define('LOG_MY_FOLDER_PATH', 'path');
  243. define('LOG_MY_FOLDER_NEW_PATH', 'new_path');
  244. define('LOG_TERM_CONDITION_ACCEPTED', 'term_condition_accepted');
  245. define('LOG_USER_CONFIRMED_EMAIL', 'user_confirmed_email');
  246. define('LOG_USER_REMOVED_LEGAL_ACCEPT', 'user_removed_legal_accept');
  247. define('LOG_USER_DELETE_ACCOUNT_REQUEST', 'user_delete_account_request');
  248. define('LOG_QUESTION_CREATED', 'question_created');
  249. define('LOG_QUESTION_UPDATED', 'question_updated');
  250. define('USERNAME_PURIFIER', '/[^0-9A-Za-z_\.]/');
  251. //used when login_is_email setting is true
  252. define('USERNAME_PURIFIER_MAIL', '/[^0-9A-Za-z_\.@]/');
  253. define('USERNAME_PURIFIER_SHALLOW', '/\s/');
  254. // This constant is a result of Windows OS detection, it has a boolean value:
  255. // true whether the server runs on Windows OS, false otherwise.
  256. define('IS_WINDOWS_OS', api_is_windows_os());
  257. // Checks for installed optional php-extensions.
  258. // intl extension (from PECL), it is installed by default as of PHP 5.3.0.
  259. define('INTL_INSTALLED', function_exists('intl_get_error_code'));
  260. // iconv extension, for PHP5 on Windows it is installed by default.
  261. define('ICONV_INSTALLED', function_exists('iconv'));
  262. define('MBSTRING_INSTALLED', function_exists('mb_strlen')); // mbstring extension.
  263. // Patterns for processing paths. Examples.
  264. define('REPEATED_SLASHES_PURIFIER', '/\/{2,}/'); // $path = preg_replace(REPEATED_SLASHES_PURIFIER, '/', $path);
  265. define('VALID_WEB_PATH', '/https?:\/\/[^\/]*(\/.*)?/i'); // $is_valid_path = preg_match(VALID_WEB_PATH, $path);
  266. // $new_path = preg_replace(VALID_WEB_SERVER_BASE, $new_base, $path);
  267. define('VALID_WEB_SERVER_BASE', '/https?:\/\/[^\/]*/i');
  268. // Constants for api_get_path() and api_get_path_type(), etc. - registered path types.
  269. // basic (leaf elements)
  270. define('REL_CODE_PATH', 'REL_CODE_PATH');
  271. define('REL_COURSE_PATH', 'REL_COURSE_PATH');
  272. define('REL_HOME_PATH', 'REL_HOME_PATH');
  273. // Constants for api_get_path() and api_get_path_type(), etc. - registered path types.
  274. define('WEB_PATH', 'WEB_PATH');
  275. define('WEB_APP_PATH', 'WEB_APP_PATH');
  276. define('SYS_PATH', 'SYS_PATH');
  277. define('SYS_APP_PATH', 'SYS_APP_PATH');
  278. define('SYS_UPLOAD_PATH', 'SYS_UPLOAD_PATH');
  279. define('WEB_UPLOAD_PATH', 'WEB_UPLOAD_PATH');
  280. define('REL_PATH', 'REL_PATH');
  281. define('WEB_COURSE_PATH', 'WEB_COURSE_PATH');
  282. define('SYS_COURSE_PATH', 'SYS_COURSE_PATH');
  283. define('WEB_CODE_PATH', 'WEB_CODE_PATH');
  284. define('SYS_CODE_PATH', 'SYS_CODE_PATH');
  285. define('SYS_LANG_PATH', 'SYS_LANG_PATH');
  286. define('WEB_IMG_PATH', 'WEB_IMG_PATH');
  287. define('WEB_CSS_PATH', 'WEB_CSS_PATH');
  288. define('WEB_PUBLIC_PATH', 'WEB_PUBLIC_PATH');
  289. define('SYS_CSS_PATH', 'SYS_CSS_PATH');
  290. define('SYS_PLUGIN_PATH', 'SYS_PLUGIN_PATH');
  291. define('WEB_PLUGIN_PATH', 'WEB_PLUGIN_PATH');
  292. define('WEB_PLUGIN_ASSET_PATH', 'WEB_PLUGIN_ASSET_PATH');
  293. define('SYS_ARCHIVE_PATH', 'SYS_ARCHIVE_PATH');
  294. define('WEB_ARCHIVE_PATH', 'WEB_ARCHIVE_PATH');
  295. define('SYS_INC_PATH', 'SYS_INC_PATH');
  296. define('LIBRARY_PATH', 'LIBRARY_PATH');
  297. define('CONFIGURATION_PATH', 'CONFIGURATION_PATH');
  298. define('WEB_LIBRARY_PATH', 'WEB_LIBRARY_PATH');
  299. define('WEB_LIBRARY_JS_PATH', 'WEB_LIBRARY_JS_PATH');
  300. define('WEB_AJAX_PATH', 'WEB_AJAX_PATH');
  301. define('SYS_TEST_PATH', 'SYS_TEST_PATH');
  302. define('WEB_TEMPLATE_PATH', 'WEB_TEMPLATE_PATH');
  303. define('SYS_TEMPLATE_PATH', 'SYS_TEMPLATE_PATH');
  304. define('SYS_PUBLIC_PATH', 'SYS_PUBLIC_PATH');
  305. define('SYS_HOME_PATH', 'SYS_HOME_PATH');
  306. define('WEB_HOME_PATH', 'WEB_HOME_PATH');
  307. define('WEB_FONTS_PATH', 'WEB_FONTS_PATH');
  308. define('SYS_FONTS_PATH', 'SYS_FONTS_PATH');
  309. define('SYS_DEFAULT_COURSE_DOCUMENT_PATH', 'SYS_DEFAULT_COURSE_DOCUMENT_PATH');
  310. define('REL_DEFAULT_COURSE_DOCUMENT_PATH', 'REL_DEFAULT_COURSE_DOCUMENT_PATH');
  311. define('WEB_DEFAULT_COURSE_DOCUMENT_PATH', 'WEB_DEFAULT_COURSE_DOCUMENT_PATH');
  312. // Relations type with Course manager
  313. define('COURSE_RELATION_TYPE_COURSE_MANAGER', 1);
  314. define('SESSION_RELATION_TYPE_COURSE_MANAGER', 1);
  315. // Relations type with Human resources manager
  316. define('COURSE_RELATION_TYPE_RRHH', 1);
  317. define('SESSION_RELATION_TYPE_RRHH', 1);
  318. //User image sizes
  319. define('USER_IMAGE_SIZE_ORIGINAL', 1);
  320. define('USER_IMAGE_SIZE_BIG', 2);
  321. define('USER_IMAGE_SIZE_MEDIUM', 3);
  322. define('USER_IMAGE_SIZE_SMALL', 4);
  323. // Relation type between users
  324. define('USER_UNKNOWN', 0);
  325. define('USER_RELATION_TYPE_UNKNOWN', 1);
  326. define('USER_RELATION_TYPE_PARENT', 2); // should be deprecated is useless
  327. define('USER_RELATION_TYPE_FRIEND', 3);
  328. define('USER_RELATION_TYPE_GOODFRIEND', 4); // should be deprecated is useless
  329. define('USER_RELATION_TYPE_ENEMY', 5); // should be deprecated is useless
  330. define('USER_RELATION_TYPE_DELETED', 6);
  331. define('USER_RELATION_TYPE_RRHH', 7);
  332. define('USER_RELATION_TYPE_BOSS', 8);
  333. define('USER_RELATION_TYPE_HRM_REQUEST', 9);
  334. // Gradebook link constants
  335. // Please do not change existing values, they are used in the database !
  336. define('GRADEBOOK_ITEM_LIMIT', 1000);
  337. define('LINK_EXERCISE', 1);
  338. define('LINK_DROPBOX', 2);
  339. define('LINK_STUDENTPUBLICATION', 3);
  340. define('LINK_LEARNPATH', 4);
  341. define('LINK_FORUM_THREAD', 5);
  342. //define('LINK_WORK',6);
  343. define('LINK_ATTENDANCE', 7);
  344. define('LINK_SURVEY', 8);
  345. define('LINK_HOTPOTATOES', 9);
  346. // Score display types constants
  347. define('SCORE_DIV', 1); // X / Y
  348. define('SCORE_PERCENT', 2); // XX %
  349. define('SCORE_DIV_PERCENT', 3); // X / Y (XX %)
  350. define('SCORE_AVERAGE', 4); // XX %
  351. define('SCORE_DECIMAL', 5); // 0.50 (X/Y)
  352. define('SCORE_BAR', 6); // Uses the Display::bar_progress function
  353. define('SCORE_SIMPLE', 7); // X
  354. define('SCORE_IGNORE_SPLIT', 8); // ??
  355. define('SCORE_DIV_PERCENT_WITH_CUSTOM', 9); // X / Y (XX %) - Good!
  356. define('SCORE_CUSTOM', 10); // Good!
  357. define('SCORE_DIV_SIMPLE_WITH_CUSTOM', 11); // X - Good!
  358. define('SCORE_DIV_SIMPLE_WITH_CUSTOM_LETTERS', 12); // X - Good!
  359. define('SCORE_ONLY_SCORE', 13); // X - Good!
  360. define('SCORE_NUMERIC', 14);
  361. define('SCORE_BOTH', 1);
  362. define('SCORE_ONLY_DEFAULT', 2);
  363. define('SCORE_ONLY_CUSTOM', 3);
  364. // From display.lib.php
  365. define('MAX_LENGTH_BREADCRUMB', 100);
  366. define('ICON_SIZE_ATOM', 8);
  367. define('ICON_SIZE_TINY', 16);
  368. define('ICON_SIZE_SMALL', 22);
  369. define('ICON_SIZE_MEDIUM', 32);
  370. define('ICON_SIZE_LARGE', 48);
  371. define('ICON_SIZE_BIG', 64);
  372. define('ICON_SIZE_HUGE', 128);
  373. define('SHOW_TEXT_NEAR_ICONS', false);
  374. // Session catalog
  375. define('CATALOG_COURSES', 0);
  376. define('CATALOG_SESSIONS', 1);
  377. define('CATALOG_COURSES_SESSIONS', 2);
  378. // Hook type events, pre-process and post-process.
  379. // All means to be executed for both hook event types
  380. define('HOOK_EVENT_TYPE_PRE', 0);
  381. define('HOOK_EVENT_TYPE_POST', 1);
  382. define('HOOK_EVENT_TYPE_ALL', 10);
  383. define('CAREER_STATUS_ACTIVE', 1);
  384. define('CAREER_STATUS_INACTIVE', 0);
  385. define('PROMOTION_STATUS_ACTIVE', 1);
  386. define('PROMOTION_STATUS_INACTIVE', 0);
  387. // Group permissions
  388. define('GROUP_PERMISSION_OPEN', '1');
  389. define('GROUP_PERMISSION_CLOSED', '2');
  390. // Group user permissions
  391. define('GROUP_USER_PERMISSION_ADMIN', '1'); // the admin of a group
  392. define('GROUP_USER_PERMISSION_READER', '2'); // a normal user
  393. define('GROUP_USER_PERMISSION_PENDING_INVITATION', '3'); // When an admin/moderator invites a user
  394. define('GROUP_USER_PERMISSION_PENDING_INVITATION_SENT_BY_USER', '4'); // an user joins a group
  395. define('GROUP_USER_PERMISSION_MODERATOR', '5'); // a moderator
  396. define('GROUP_USER_PERMISSION_ANONYMOUS', '6'); // an anonymous user
  397. define('GROUP_USER_PERMISSION_HRM', '7'); // a human resources manager
  398. define('GROUP_IMAGE_SIZE_ORIGINAL', 1);
  399. define('GROUP_IMAGE_SIZE_BIG', 2);
  400. define('GROUP_IMAGE_SIZE_MEDIUM', 3);
  401. define('GROUP_IMAGE_SIZE_SMALL', 4);
  402. define('GROUP_TITLE_LENGTH', 50);
  403. // Exercise
  404. // @todo move into a class
  405. define('ALL_ON_ONE_PAGE', 1);
  406. define('ONE_PER_PAGE', 2);
  407. define('EXERCISE_FEEDBACK_TYPE_END', 0); //Feedback - show score and expected answers
  408. define('EXERCISE_FEEDBACK_TYPE_DIRECT', 1); //DirectFeedback - Do not show score nor answers
  409. define('EXERCISE_FEEDBACK_TYPE_EXAM', 2); //NoFeedback - Show score only
  410. define('RESULT_DISABLE_SHOW_SCORE_AND_EXPECTED_ANSWERS', 0); //show score and expected answers
  411. define('RESULT_DISABLE_NO_SCORE_AND_EXPECTED_ANSWERS', 1); //Do not show score nor answers
  412. define('RESULT_DISABLE_SHOW_SCORE_ONLY', 2); //Show score only
  413. define('RESULT_DISABLE_SHOW_FINAL_SCORE_ONLY_WITH_CATEGORIES', 3); //Show final score only with categories
  414. define('RESULT_DISABLE_SHOW_SCORE_ATTEMPT_SHOW_ANSWERS_LAST_ATTEMPT', 4);
  415. define('RESULT_DISABLE_DONT_SHOW_SCORE_ONLY_IF_USER_FINISHES_ATTEMPTS_SHOW_ALWAYS_FEEDBACK', 5);
  416. define('RESULT_DISABLE_RANKING', 6);
  417. define('RESULT_DISABLE_SHOW_ONLY_IN_CORRECT_ANSWER', 7);
  418. // 4: Show final score only with and show expected answers only on the last attempt
  419. define('EXERCISE_MAX_NAME_SIZE', 80);
  420. // Question types (edit next array as well when adding values)
  421. // @todo move into a class
  422. define('UNIQUE_ANSWER', 1);
  423. define('MULTIPLE_ANSWER', 2);
  424. define('FILL_IN_BLANKS', 3);
  425. define('MATCHING', 4);
  426. define('FREE_ANSWER', 5);
  427. define('HOT_SPOT', 6);
  428. define('HOT_SPOT_ORDER', 7);
  429. define('HOT_SPOT_DELINEATION', 8);
  430. define('MULTIPLE_ANSWER_COMBINATION', 9);
  431. define('UNIQUE_ANSWER_NO_OPTION', 10);
  432. define('MULTIPLE_ANSWER_TRUE_FALSE', 11);
  433. define('MULTIPLE_ANSWER_COMBINATION_TRUE_FALSE', 12);
  434. define('ORAL_EXPRESSION', 13);
  435. define('GLOBAL_MULTIPLE_ANSWER', 14);
  436. define('MEDIA_QUESTION', 15);
  437. define('CALCULATED_ANSWER', 16);
  438. define('UNIQUE_ANSWER_IMAGE', 17);
  439. define('DRAGGABLE', 18);
  440. define('MATCHING_DRAGGABLE', 19);
  441. define('ANNOTATION', 20);
  442. define('READING_COMPREHENSION', 21);
  443. define('MULTIPLE_ANSWER_TRUE_FALSE_DEGREE_CERTAINTY', 22);
  444. define('EXERCISE_CATEGORY_RANDOM_SHUFFLED', 1);
  445. define('EXERCISE_CATEGORY_RANDOM_ORDERED', 2);
  446. define('EXERCISE_CATEGORY_RANDOM_DISABLED', 0);
  447. // Question selection type
  448. define('EX_Q_SELECTION_ORDERED', 1);
  449. define('EX_Q_SELECTION_RANDOM', 2);
  450. define('EX_Q_SELECTION_CATEGORIES_ORDERED_QUESTIONS_ORDERED', 3);
  451. define('EX_Q_SELECTION_CATEGORIES_RANDOM_QUESTIONS_ORDERED', 4);
  452. define('EX_Q_SELECTION_CATEGORIES_ORDERED_QUESTIONS_RANDOM', 5);
  453. define('EX_Q_SELECTION_CATEGORIES_RANDOM_QUESTIONS_RANDOM', 6);
  454. define('EX_Q_SELECTION_CATEGORIES_RANDOM_QUESTIONS_ORDERED_NO_GROUPED', 7);
  455. define('EX_Q_SELECTION_CATEGORIES_RANDOM_QUESTIONS_RANDOM_NO_GROUPED', 8);
  456. define('EX_Q_SELECTION_CATEGORIES_ORDERED_BY_PARENT_QUESTIONS_ORDERED', 9);
  457. define('EX_Q_SELECTION_CATEGORIES_ORDERED_BY_PARENT_QUESTIONS_RANDOM', 10);
  458. // Used to save the skill_rel_item table
  459. define('ITEM_TYPE_EXERCISE', 1);
  460. define('ITEM_TYPE_HOTPOTATOES', 2);
  461. define('ITEM_TYPE_LINK', 3);
  462. define('ITEM_TYPE_LEARNPATH', 4);
  463. define('ITEM_TYPE_GRADEBOOK', 5);
  464. define('ITEM_TYPE_STUDENT_PUBLICATION', 6);
  465. //define('ITEM_TYPE_FORUM', 7);
  466. define('ITEM_TYPE_ATTENDANCE', 8);
  467. define('ITEM_TYPE_SURVEY', 9);
  468. define('ITEM_TYPE_FORUM_THREAD', 10);
  469. // one big string with all question types, for the validator in pear/HTML/QuickForm/Rule/QuestionType
  470. define(
  471. 'QUESTION_TYPES',
  472. UNIQUE_ANSWER.':'.
  473. MULTIPLE_ANSWER.':'.
  474. FILL_IN_BLANKS.':'.
  475. MATCHING.':'.
  476. FREE_ANSWER.':'.
  477. HOT_SPOT.':'.
  478. HOT_SPOT_ORDER.':'.
  479. HOT_SPOT_DELINEATION.':'.
  480. MULTIPLE_ANSWER_COMBINATION.':'.
  481. UNIQUE_ANSWER_NO_OPTION.':'.
  482. MULTIPLE_ANSWER_TRUE_FALSE.':'.
  483. MULTIPLE_ANSWER_COMBINATION_TRUE_FALSE.':'.
  484. ORAL_EXPRESSION.':'.
  485. GLOBAL_MULTIPLE_ANSWER.':'.
  486. MEDIA_QUESTION.':'.
  487. CALCULATED_ANSWER.':'.
  488. UNIQUE_ANSWER_IMAGE.':'.
  489. DRAGGABLE.':'.
  490. MATCHING_DRAGGABLE.':'.
  491. MULTIPLE_ANSWER_TRUE_FALSE_DEGREE_CERTAINTY.':'.
  492. ANNOTATION
  493. );
  494. //Some alias used in the QTI exports
  495. define('MCUA', 1);
  496. define('TF', 1);
  497. define('MCMA', 2);
  498. define('FIB', 3);
  499. // Skills
  500. define('SKILL_TYPE_REQUIREMENT', 'required');
  501. define('SKILL_TYPE_ACQUIRED', 'acquired');
  502. define('SKILL_TYPE_BOTH', 'both');
  503. // Message
  504. define('MESSAGE_STATUS_NEW', '0');
  505. define('MESSAGE_STATUS_UNREAD', '1');
  506. //2 ??
  507. define('MESSAGE_STATUS_DELETED', '3');
  508. define('MESSAGE_STATUS_OUTBOX', '4');
  509. define('MESSAGE_STATUS_INVITATION_PENDING', '5');
  510. define('MESSAGE_STATUS_INVITATION_ACCEPTED', '6');
  511. define('MESSAGE_STATUS_INVITATION_DENIED', '7');
  512. define('MESSAGE_STATUS_WALL', '8');
  513. define('MESSAGE_STATUS_WALL_DELETE', '9');
  514. define('MESSAGE_STATUS_WALL_POST', '10');
  515. define('MESSAGE_STATUS_CONVERSATION', '11');
  516. define('MESSAGE_STATUS_FORUM', '12');
  517. // Images
  518. define('IMAGE_WALL_SMALL_SIZE', 200);
  519. define('IMAGE_WALL_MEDIUM_SIZE', 500);
  520. define('IMAGE_WALL_BIG_SIZE', 2000);
  521. define('IMAGE_WALL_SMALL', 'small');
  522. define('IMAGE_WALL_MEDIUM', 'medium');
  523. define('IMAGE_WALL_BIG', 'big');
  524. // Social PLUGIN PLACES
  525. define('SOCIAL_LEFT_PLUGIN', 1);
  526. define('SOCIAL_CENTER_PLUGIN', 2);
  527. define('SOCIAL_RIGHT_PLUGIN', 3);
  528. define('CUT_GROUP_NAME', 50);
  529. /**
  530. * FormValidator Filter.
  531. */
  532. define('NO_HTML', 1);
  533. define('STUDENT_HTML', 2);
  534. define('TEACHER_HTML', 3);
  535. define('STUDENT_HTML_FULLPAGE', 4);
  536. define('TEACHER_HTML_FULLPAGE', 5);
  537. // Timeline
  538. define('TIMELINE_STATUS_ACTIVE', '1');
  539. define('TIMELINE_STATUS_INACTIVE', '2');
  540. // Event email template class
  541. define('EVENT_EMAIL_TEMPLATE_ACTIVE', 1);
  542. define('EVENT_EMAIL_TEMPLATE_INACTIVE', 0);
  543. // Course home
  544. define('SHORTCUTS_HORIZONTAL', 0);
  545. define('SHORTCUTS_VERTICAL', 1);
  546. // Image class
  547. define('IMAGE_PROCESSOR', 'gd'); // 'imagick' or 'gd' strings
  548. // Course copy
  549. define('FILE_SKIP', 1);
  550. define('FILE_RENAME', 2);
  551. define('FILE_OVERWRITE', 3);
  552. define('UTF8_CONVERT', false); //false by default
  553. define('DOCUMENT', 'file');
  554. define('FOLDER', 'folder');
  555. define('RESOURCE_ASSET', 'asset');
  556. define('RESOURCE_DOCUMENT', 'document');
  557. define('RESOURCE_GLOSSARY', 'glossary');
  558. define('RESOURCE_EVENT', 'calendar_event');
  559. define('RESOURCE_LINK', 'link');
  560. define('RESOURCE_COURSEDESCRIPTION', 'course_description');
  561. define('RESOURCE_LEARNPATH', 'learnpath');
  562. define('RESOURCE_LEARNPATH_CATEGORY', 'learnpath_category');
  563. define('RESOURCE_ANNOUNCEMENT', 'announcement');
  564. define('RESOURCE_FORUM', 'forum');
  565. define('RESOURCE_FORUMTOPIC', 'thread');
  566. define('RESOURCE_FORUMPOST', 'post');
  567. define('RESOURCE_QUIZ', 'quiz');
  568. define('RESOURCE_TEST_CATEGORY', 'test_category');
  569. define('RESOURCE_QUIZQUESTION', 'Exercise_Question');
  570. define('RESOURCE_TOOL_INTRO', 'Tool introduction');
  571. define('RESOURCE_LINKCATEGORY', 'Link_Category');
  572. define('RESOURCE_FORUMCATEGORY', 'Forum_Category');
  573. define('RESOURCE_SCORM', 'Scorm');
  574. define('RESOURCE_SURVEY', 'survey');
  575. define('RESOURCE_SURVEYQUESTION', 'survey_question');
  576. define('RESOURCE_SURVEYINVITATION', 'survey_invitation');
  577. define('RESOURCE_WIKI', 'wiki');
  578. define('RESOURCE_THEMATIC', 'thematic');
  579. define('RESOURCE_ATTENDANCE', 'attendance');
  580. define('RESOURCE_WORK', 'work');
  581. define('RESOURCE_SESSION_COURSE', 'session_course');
  582. define('RESOURCE_GRADEBOOK', 'gradebook');
  583. define('ADD_THEMATIC_PLAN', 6);
  584. // Max online users to show per page (whoisonline)
  585. define('MAX_ONLINE_USERS', 12);
  586. // Number of characters maximum to show in preview of course blog posts
  587. define('BLOG_MAX_PREVIEW_CHARS', 800);
  588. // HTML string to replace with a 'Read more...' link
  589. define('BLOG_PAGE_BREAK', '<div style="page-break-after: always"><span style="display: none;">&nbsp;</span></div>');
  590. // Make sure the CHAMILO_LOAD_WYSIWYG constant is defined
  591. // To remove CKeditor libs from HTML, set this constant to true before loading
  592. if (!defined('CHAMILO_LOAD_WYSIWYG')) {
  593. define('CHAMILO_LOAD_WYSIWYG', true);
  594. }
  595. /* Constants for course home */
  596. define('TOOL_PUBLIC', 'Public');
  597. define('TOOL_PUBLIC_BUT_HIDDEN', 'PublicButHide');
  598. define('TOOL_COURSE_ADMIN', 'courseAdmin');
  599. define('TOOL_PLATFORM_ADMIN', 'platformAdmin');
  600. define('TOOL_AUTHORING', 'toolauthoring');
  601. define('TOOL_INTERACTION', 'toolinteraction');
  602. define('TOOL_COURSE_PLUGIN', 'toolcourseplugin'); //all plugins that can be enabled in courses
  603. define('TOOL_ADMIN', 'tooladmin');
  604. define('TOOL_ADMIN_PLATFORM', 'tooladminplatform');
  605. define('TOOL_DRH', 'tool_drh');
  606. define('TOOL_STUDENT_VIEW', 'toolstudentview');
  607. define('TOOL_ADMIN_VISIBLE', 'tooladminvisible');
  608. /**
  609. * Inclusion of internationalization libraries.
  610. */
  611. require_once __DIR__.'/internationalization.lib.php';
  612. /**
  613. * Returns a path to a certain resource within the Chamilo area, specifyed through a parameter.
  614. * Also, this function provides conversion between path types, in this case the input path points inside the Chamilo area too.
  615. *
  616. * See $_configuration['course_folder'] in the configuration.php to alter the WEB_COURSE_PATH and SYS_COURSE_PATH parameters.
  617. *
  618. * @param string $path (optional) A path which type is to be converted. Also, it may be a defined constant for a path.
  619. * This parameter has meaning when $type parameter has one of the following values: TO_WEB, TO_SYS, TO_REL. Otherwise it is ignored.
  620. *
  621. * @return string the requested path or the converted path
  622. *
  623. *
  624. * Notes about the current behaviour model:
  625. * 1. Windows back-slashes are converted to slashes in the result.
  626. * 2. A semi-absolute web-path is detected by its leading slash. On Linux systems, absolute system paths start with
  627. * a slash too, so an additional check about presence of leading system server base is implemented. For example, the function is
  628. * able to distinguish type difference between /var/www/chamilo/courses/ (SYS) and /chamilo/courses/ (REL).
  629. * 3. The function api_get_path() returns only these three types of paths, which in some sense are absolute. The function has
  630. * no a mechanism for processing relative web/system paths, such as: lesson01.html, ./lesson01.html, ../css/my_styles.css.
  631. * It has not been identified as needed yet.
  632. * 4. Also, resolving the meta-symbols "." and ".." within paths has not been implemented, it is to be identified as needed.
  633. *
  634. * For examples go to: *
  635. * See main/admin/system_status.php?section=paths
  636. *
  637. * Vchamilo changes : allow using an alternate configuration
  638. * to get vchamilo instance paths
  639. */
  640. function api_get_path($path = '', $configuration = [])
  641. {
  642. global $paths;
  643. // get proper configuration data if exists
  644. global $_configuration;
  645. $emptyConfigurationParam = false;
  646. if (empty($configuration)) {
  647. $configuration = (array) $_configuration;
  648. $emptyConfigurationParam = true;
  649. }
  650. $course_folder = 'courses/';
  651. static $root_web = '';
  652. $root_sys = $_configuration['root_sys'];
  653. // If no $root_web has been set so far *and* no custom config has been passed to the function
  654. // then re-use the previously-calculated (run-specific) $root_web and skip this complex calculation
  655. if (empty($root_web) || $emptyConfigurationParam === false || empty($configuration)) {
  656. // Resolve master hostname.
  657. if (!empty($configuration) && array_key_exists('root_web', $configuration)) {
  658. $root_web = $configuration['root_web'];
  659. } else {
  660. $root_web = '';
  661. // Try guess it from server.
  662. if (defined('SYSTEM_INSTALLATION') && SYSTEM_INSTALLATION) {
  663. if (($pos = strpos(($requested_page_rel = api_get_self()), 'main/install')) !== false) {
  664. $root_rel = substr($requested_page_rel, 0, $pos);
  665. // See http://www.mediawiki.org/wiki/Manual:$wgServer
  666. $server_protocol = (isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] == 'on') ? 'https' : 'http';
  667. $server_name =
  668. isset($_SERVER['SERVER_NAME']) ? $_SERVER['SERVER_NAME']
  669. : (isset($_SERVER['HOSTNAME']) ? $_SERVER['HOSTNAME']
  670. : (isset($_SERVER['HTTP_HOST']) ? $_SERVER['HTTP_HOST']
  671. : (isset($_SERVER['SERVER_ADDR']) ? $_SERVER['SERVER_ADDR']
  672. : 'localhost')));
  673. if (isset($_SERVER['SERVER_PORT']) &&
  674. !strpos($server_name, ':') &&
  675. (($server_protocol == 'http' && $_SERVER['SERVER_PORT'] != 80) ||
  676. ($server_protocol == 'https' && $_SERVER['SERVER_PORT'] != 443))
  677. ) {
  678. $server_name .= ":".$_SERVER['SERVER_PORT'];
  679. }
  680. $root_web = $server_protocol.'://'.$server_name.$root_rel;
  681. $root_sys = str_replace('\\', '/', realpath(__DIR__.'/../../../')).'/';
  682. }
  683. // Here we give up, so we don't touch anything.
  684. }
  685. }
  686. }
  687. if (isset($configuration['multiple_access_urls']) &&
  688. $configuration['multiple_access_urls']
  689. ) {
  690. // To avoid that the api_get_access_url() function fails since global.inc.php also calls the api.lib.php.
  691. if (isset($configuration['access_url']) && !empty($configuration['access_url'])) {
  692. // We look into the DB the function api_get_access_url
  693. $urlInfo = api_get_access_url($configuration['access_url']);
  694. // Avoid default value
  695. $defaultValues = ['http://localhost/', 'https://localhost/'];
  696. if (!empty($urlInfo['url']) && !in_array($urlInfo['url'], $defaultValues)) {
  697. $root_web = $urlInfo['active'] == 1 ? $urlInfo['url'] : $configuration['root_web'];
  698. }
  699. }
  700. }
  701. $paths = [];
  702. // Initialise cache with default values.
  703. if (!array_key_exists($root_web, $paths)) {
  704. $paths[$root_web] = [
  705. WEB_PATH => '',
  706. SYS_PATH => '',
  707. REL_PATH => '',
  708. WEB_COURSE_PATH => '',
  709. SYS_COURSE_PATH => '',
  710. REL_COURSE_PATH => '',
  711. WEB_CODE_PATH => 'main/',
  712. SYS_CODE_PATH => 'main/',
  713. REL_CODE_PATH => '/main/',
  714. SYS_LANG_PATH => 'lang/',
  715. WEB_IMG_PATH => 'img/',
  716. WEB_CSS_PATH => 'web/css/',
  717. SYS_CSS_PATH => 'app/Resources/public/css/',
  718. SYS_PLUGIN_PATH => 'plugin/',
  719. WEB_PLUGIN_PATH => 'plugin/',
  720. WEB_PLUGIN_ASSET_PATH => 'public/plugins/',
  721. SYS_ARCHIVE_PATH => 'app/cache/',
  722. WEB_ARCHIVE_PATH => 'app/cache/',
  723. SYS_HOME_PATH => 'app/home/',
  724. WEB_HOME_PATH => 'app/home/',
  725. REL_HOME_PATH => 'app/home/',
  726. SYS_APP_PATH => 'app/',
  727. WEB_APP_PATH => 'app/',
  728. SYS_UPLOAD_PATH => 'app/upload/',
  729. SYS_INC_PATH => 'inc/',
  730. CONFIGURATION_PATH => 'app/config/',
  731. LIBRARY_PATH => 'inc/lib/',
  732. WEB_LIBRARY_PATH => 'inc/lib/',
  733. WEB_LIBRARY_JS_PATH => 'inc/lib/javascript/',
  734. WEB_AJAX_PATH => 'inc/ajax/',
  735. SYS_TEST_PATH => 'tests/',
  736. WEB_TEMPLATE_PATH => 'template/',
  737. SYS_TEMPLATE_PATH => 'template/',
  738. WEB_UPLOAD_PATH => 'app/upload/',
  739. WEB_PUBLIC_PATH => 'web/',
  740. SYS_PUBLIC_PATH => 'web/',
  741. WEB_FONTS_PATH => 'fonts/',
  742. SYS_FONTS_PATH => 'fonts/',
  743. ];
  744. }
  745. $isInitialized = [];
  746. $course_folder = isset($configuration['course_folder']) ? $configuration['course_folder'] : $course_folder;
  747. $root_rel = isset($configuration['url_append']) ? $configuration['url_append'] : '';
  748. if (!empty($root_rel)) {
  749. // Adds "/" to the root_rel
  750. $hasSlash = substr($configuration['url_append'], 0, 1);
  751. if ($hasSlash !== '/') {
  752. $root_rel = '/'.$root_rel;
  753. }
  754. }
  755. // Web server base and system server base.
  756. if (!array_key_exists($root_web, $isInitialized)) {
  757. // process absolute global roots
  758. if (!empty($configuration)) {
  759. $code_folder = 'main';
  760. } else {
  761. $code_folder = $paths[$root_web][REL_CODE_PATH];
  762. }
  763. // Support for the installation process.
  764. // Developers might use the function api_get_path() directly or indirectly (this is difficult to be traced), at the moment when
  765. // configuration has not been created yet. This is why this function should be upgraded to return correct results in this case.
  766. // Dealing with trailing slashes.
  767. $slashed_root_web = api_add_trailing_slash($root_web);
  768. $root_sys = api_add_trailing_slash($root_sys);
  769. $root_rel = api_add_trailing_slash($root_rel);
  770. $code_folder = api_add_trailing_slash($code_folder);
  771. $course_folder = api_add_trailing_slash($course_folder);
  772. // Initialization of a table that contains common-purpose paths.
  773. $paths[$root_web][REL_PATH] = $root_rel;
  774. $paths[$root_web][REL_COURSE_PATH] = $root_rel.$course_folder;
  775. $paths[$root_web][REL_CODE_PATH] = $root_rel.$code_folder;
  776. $paths[$root_web][REL_DEFAULT_COURSE_DOCUMENT_PATH] = $paths[$root_web][REL_PATH].'main/default_course_document/';
  777. $paths[$root_web][WEB_PATH] = $slashed_root_web;
  778. $paths[$root_web][WEB_CODE_PATH] = $paths[$root_web][WEB_PATH].$code_folder;
  779. $paths[$root_web][WEB_COURSE_PATH] = $paths[$root_web][WEB_PATH].$course_folder;
  780. $paths[$root_web][WEB_DEFAULT_COURSE_DOCUMENT_PATH] = $paths[$root_web][WEB_CODE_PATH].'default_course_document/';
  781. $paths[$root_web][WEB_APP_PATH] = $paths[$root_web][WEB_PATH].$paths[$root_web][WEB_APP_PATH];
  782. $paths[$root_web][WEB_PLUGIN_PATH] = $paths[$root_web][WEB_PATH].$paths[$root_web][WEB_PLUGIN_PATH];
  783. $paths[$root_web][WEB_PLUGIN_ASSET_PATH] = $paths[$root_web][WEB_PATH].$paths[$root_web][WEB_PLUGIN_ASSET_PATH];
  784. $paths[$root_web][WEB_ARCHIVE_PATH] = $paths[$root_web][WEB_PATH].$paths[$root_web][WEB_ARCHIVE_PATH];
  785. $paths[$root_web][WEB_CSS_PATH] = $paths[$root_web][WEB_PATH].$paths[$root_web][WEB_CSS_PATH];
  786. $paths[$root_web][WEB_IMG_PATH] = $paths[$root_web][WEB_CODE_PATH].$paths[$root_web][WEB_IMG_PATH];
  787. $paths[$root_web][WEB_LIBRARY_PATH] = $paths[$root_web][WEB_CODE_PATH].$paths[$root_web][WEB_LIBRARY_PATH];
  788. $paths[$root_web][WEB_LIBRARY_JS_PATH] = $paths[$root_web][WEB_CODE_PATH].$paths[$root_web][WEB_LIBRARY_JS_PATH];
  789. $paths[$root_web][WEB_AJAX_PATH] = $paths[$root_web][WEB_CODE_PATH].$paths[$root_web][WEB_AJAX_PATH];
  790. $paths[$root_web][WEB_FONTS_PATH] = $paths[$root_web][WEB_CODE_PATH].$paths[$root_web][WEB_FONTS_PATH];
  791. $paths[$root_web][WEB_TEMPLATE_PATH] = $paths[$root_web][WEB_CODE_PATH].$paths[$root_web][WEB_TEMPLATE_PATH];
  792. $paths[$root_web][WEB_UPLOAD_PATH] = $paths[$root_web][WEB_PATH].$paths[$root_web][WEB_UPLOAD_PATH];
  793. $paths[$root_web][WEB_PUBLIC_PATH] = $paths[$root_web][WEB_PATH].$paths[$root_web][WEB_PUBLIC_PATH];
  794. $paths[$root_web][WEB_HOME_PATH] = $paths[$root_web][WEB_PATH].$paths[$root_web][REL_HOME_PATH];
  795. $paths[$root_web][SYS_PATH] = $root_sys;
  796. $paths[$root_web][SYS_CODE_PATH] = $root_sys.$code_folder;
  797. $paths[$root_web][SYS_TEST_PATH] = $paths[$root_web][SYS_PATH].$paths[$root_web][SYS_TEST_PATH];
  798. $paths[$root_web][SYS_TEMPLATE_PATH] = $paths[$root_web][SYS_CODE_PATH].$paths[$root_web][SYS_TEMPLATE_PATH];
  799. $paths[$root_web][SYS_PUBLIC_PATH] = $paths[$root_web][SYS_PATH].$paths[$root_web][SYS_PUBLIC_PATH];
  800. $paths[$root_web][SYS_CSS_PATH] = $paths[$root_web][SYS_PATH].$paths[$root_web][SYS_CSS_PATH];
  801. $paths[$root_web][SYS_FONTS_PATH] = $paths[$root_web][SYS_CODE_PATH].$paths[$root_web][SYS_FONTS_PATH];
  802. $paths[$root_web][SYS_ARCHIVE_PATH] = $paths[$root_web][SYS_PATH].$paths[$root_web][SYS_ARCHIVE_PATH];
  803. $paths[$root_web][SYS_APP_PATH] = $paths[$root_web][SYS_PATH].$paths[$root_web][SYS_APP_PATH];
  804. $paths[$root_web][SYS_COURSE_PATH] = $paths[$root_web][SYS_APP_PATH].$course_folder;
  805. $paths[$root_web][SYS_UPLOAD_PATH] = $paths[$root_web][SYS_PATH].$paths[$root_web][SYS_UPLOAD_PATH];
  806. $paths[$root_web][SYS_LANG_PATH] = $paths[$root_web][SYS_CODE_PATH].$paths[$root_web][SYS_LANG_PATH];
  807. $paths[$root_web][SYS_HOME_PATH] = $paths[$root_web][SYS_PATH].$paths[$root_web][SYS_HOME_PATH];
  808. $paths[$root_web][SYS_PLUGIN_PATH] = $paths[$root_web][SYS_PATH].$paths[$root_web][SYS_PLUGIN_PATH];
  809. $paths[$root_web][SYS_INC_PATH] = $paths[$root_web][SYS_CODE_PATH].$paths[$root_web][SYS_INC_PATH];
  810. $paths[$root_web][LIBRARY_PATH] = $paths[$root_web][SYS_CODE_PATH].$paths[$root_web][LIBRARY_PATH];
  811. $paths[$root_web][CONFIGURATION_PATH] = $paths[$root_web][SYS_PATH].$paths[$root_web][CONFIGURATION_PATH];
  812. global $virtualChamilo;
  813. if (!empty($virtualChamilo)) {
  814. $paths[$root_web][SYS_ARCHIVE_PATH] = api_add_trailing_slash($virtualChamilo[SYS_ARCHIVE_PATH]);
  815. $paths[$root_web][SYS_HOME_PATH] = api_add_trailing_slash($virtualChamilo[SYS_HOME_PATH]);
  816. $paths[$root_web][SYS_COURSE_PATH] = api_add_trailing_slash($virtualChamilo[SYS_COURSE_PATH]);
  817. $paths[$root_web][SYS_UPLOAD_PATH] = api_add_trailing_slash($virtualChamilo[SYS_UPLOAD_PATH]);
  818. $paths[$root_web][WEB_HOME_PATH] = api_add_trailing_slash($virtualChamilo[WEB_HOME_PATH]);
  819. $paths[$root_web][WEB_UPLOAD_PATH] = api_add_trailing_slash($virtualChamilo[WEB_UPLOAD_PATH]);
  820. $paths[$root_web][WEB_ARCHIVE_PATH] = api_add_trailing_slash($virtualChamilo[WEB_ARCHIVE_PATH]);
  821. //$paths[$root_web][WEB_COURSE_PATH] = api_add_trailing_slash($virtualChamilo[WEB_COURSE_PATH]);
  822. // WEB_UPLOAD_PATH should be handle by apache htaccess in the vhost
  823. // RewriteEngine On
  824. // RewriteRule /app/upload/(.*)$ http://localhost/other/upload/my-chamilo111-net/$1 [QSA,L]
  825. //$paths[$root_web][WEB_UPLOAD_PATH] = api_add_trailing_slash($virtualChamilo[WEB_UPLOAD_PATH]);
  826. //$paths[$root_web][REL_PATH] = $virtualChamilo[REL_PATH];
  827. //$paths[$root_web][REL_COURSE_PATH] = $virtualChamilo[REL_COURSE_PATH];
  828. }
  829. $isInitialized[$root_web] = true;
  830. }
  831. $path = trim($path);
  832. // Retrieving a common-purpose path.
  833. if (isset($paths[$root_web][$path])) {
  834. return $paths[$root_web][$path];
  835. }
  836. // Second purification.
  837. // Replacing Windows back slashes.
  838. $path = str_replace('\\', '/', $path);
  839. // Query strings sometimes mighth wrongly appear in non-URLs.
  840. // Let us check remove them from all types of paths.
  841. if (($pos = strpos($path, '?')) !== false) {
  842. $path = substr($path, 0, $pos);
  843. }
  844. // Detection of the input path type. Conversion to semi-absolute type ( /chamilo/main/inc/.... ).
  845. if (preg_match(VALID_WEB_PATH, $path)) {
  846. // A special case: When a URL points to the document download script directly, without
  847. // mod-rewrite translation, we have to translate it into an "ordinary" web path.
  848. // For example:
  849. // http://localhost/chamilo/main/document/download.php?doc_url=/image.png&cDir=/
  850. // becomes
  851. // http://localhost/chamilo/courses/TEST/document/image.png
  852. // TEST is a course directory name, so called "system course code".
  853. if (strpos($path, 'download.php') !== false) { // Fast detection first.
  854. $path = urldecode($path);
  855. if (preg_match('/(.*)main\/document\/download.php\?doc_url=\/(.*)&cDir=\/(.*)?/', $path, $matches)) {
  856. $sys_course_code =
  857. isset($_SESSION['_course']['sysCode']) // User is inside a course?
  858. ? $_SESSION['_course']['sysCode'] // Yes, then use course's directory name.
  859. : '{SYS_COURSE_CODE}'; // No, then use a fake code, it may be processed later.
  860. $path = $matches[1].'courses/'.$sys_course_code.'/document/'.str_replace('//', '/', $matches[3].'/'.$matches[2]);
  861. }
  862. }
  863. // Replacement of the present web server base with a slash '/'.
  864. $path = preg_replace(VALID_WEB_SERVER_BASE, '/', $path);
  865. }
  866. // Path now is semi-absolute. It is convenient at this moment repeated slashes to be removed.
  867. $path = preg_replace(REPEATED_SLASHES_PURIFIER, '/', $path);
  868. return $path;
  869. }
  870. /**
  871. * Gets a modified version of the path for the CDN, if defined in
  872. * configuration.php.
  873. *
  874. * @param string $web_path The path of the resource without CDN
  875. *
  876. * @return string The path of the resource converted to CDN
  877. *
  878. * @author Yannick Warnier <ywarnier@beeznst.org>
  879. */
  880. function api_get_cdn_path($web_path)
  881. {
  882. global $_configuration;
  883. if (!empty($_configuration['cdn_enable'])) {
  884. $web_root = api_get_path(WEB_PATH);
  885. $ext = substr($web_path, strrpos($web_path, '.'));
  886. if (isset($ext[2])) { // faster version of strlen to check if len>2
  887. // Check for CDN definitions
  888. if (!empty($ext)) {
  889. foreach ($_configuration['cdn'] as $host => $exts) {
  890. if (in_array($ext, $exts)) {
  891. //Use host as defined in $_configuration['cdn'], without
  892. // trailing slash
  893. return str_replace($web_root, $host.'/', $web_path);
  894. }
  895. }
  896. }
  897. }
  898. }
  899. return $web_path;
  900. }
  901. /**
  902. * @return bool Return true if CAS authentification is activated
  903. */
  904. function api_is_cas_activated()
  905. {
  906. return api_get_setting('cas_activate') == "true";
  907. }
  908. /**
  909. * @return bool Return true if LDAP authentification is activated
  910. */
  911. function api_is_ldap_activated()
  912. {
  913. global $extAuthSource;
  914. return is_array($extAuthSource[LDAP_AUTH_SOURCE]);
  915. }
  916. /**
  917. * @return bool Return true if Facebook authentification is activated
  918. */
  919. function api_is_facebook_auth_activated()
  920. {
  921. global $_configuration;
  922. return isset($_configuration['facebook_auth']) && $_configuration['facebook_auth'] == 1;
  923. }
  924. /**
  925. * Adds to a given path a trailing slash if it is necessary (adds "/" character at the end of the string).
  926. *
  927. * @param string $path the input path
  928. *
  929. * @return string returns the modified path
  930. */
  931. function api_add_trailing_slash($path)
  932. {
  933. return substr($path, -1) == '/' ? $path : $path.'/';
  934. // This code is about 20% faster than the preg_replace equivalent
  935. //return preg_replace('/([^\/])$/', '$1/', $path);
  936. }
  937. /**
  938. * Removes from a given path the trailing slash if it is necessary (removes "/" character from the end of the string).
  939. *
  940. * @param string $path the input path
  941. *
  942. * @return string returns the modified path
  943. */
  944. function api_remove_trailing_slash($path)
  945. {
  946. return substr($path, -1) == '/' ? substr($path, 0, -1) : $path;
  947. }
  948. /**
  949. * Checks the RFC 3986 syntax of a given URL.
  950. *
  951. * @param string $url the URL to be checked
  952. * @param bool $absolute whether the URL is absolute (beginning with a scheme such as "http:")
  953. *
  954. * @return string|false Returns the URL if it is valid, FALSE otherwise.
  955. * This function is an adaptation from the function valid_url(), Drupal CMS.
  956. *
  957. * @see http://drupal.org
  958. * Note: The built-in function filter_var($urs, FILTER_VALIDATE_URL) has a bug for some versions of PHP.
  959. * @see http://bugs.php.net/51192
  960. */
  961. function api_valid_url($url, $absolute = false)
  962. {
  963. if ($absolute) {
  964. if (preg_match("
  965. /^ # Start at the beginning of the text
  966. (?:ftp|https?|feed):\/\/ # Look for ftp, http, https or feed schemes
  967. (?: # Userinfo (optional) which is typically
  968. (?:(?:[\w\.\-\+!$&'\(\)*\+,;=]|%[0-9a-f]{2})+:)* # a username or a username and password
  969. (?:[\w\.\-\+%!$&'\(\)*\+,;=]|%[0-9a-f]{2})+@ # combination
  970. )?
  971. (?:
  972. (?:[a-z0-9\-\.]|%[0-9a-f]{2})+ # A domain name or a IPv4 address
  973. |(?:\[(?:[0-9a-f]{0,4}:)*(?:[0-9a-f]{0,4})\]) # or a well formed IPv6 address
  974. )
  975. (?::[0-9]+)? # Server port number (optional)
  976. (?:[\/|\?]
  977. (?:[\w#!:\.\?\+=&@$'~*,;\/\(\)\[\]\-]|%[0-9a-f]{2}) # The path and query (optional)
  978. *)?
  979. $/xi", $url)) {
  980. return $url;
  981. }
  982. return false;
  983. } else {
  984. return preg_match("/^(?:[\w#!:\.\?\+=&@$'~*,;\/\(\)\[\]\-]|%[0-9a-f]{2})+$/i", $url) ? $url : false;
  985. }
  986. }
  987. /**
  988. * Checks whether a given string looks roughly like an email address.
  989. *
  990. * @param string $address the e-mail address to be checked
  991. *
  992. * @return mixed returns the e-mail if it is valid, FALSE otherwise
  993. */
  994. function api_valid_email($address)
  995. {
  996. return filter_var($address, FILTER_VALIDATE_EMAIL);
  997. }
  998. /* PROTECTION FUNCTIONS
  999. Use these functions to protect your scripts. */
  1000. /**
  1001. * Function used to protect a course script.
  1002. * The function blocks access when
  1003. * - there is no $_SESSION["_course"] defined; or
  1004. * - $is_allowed_in_course is set to false (this depends on the course
  1005. * visibility and user status).
  1006. *
  1007. * This is only the first proposal, test and improve!
  1008. *
  1009. * @param bool Option to print headers when displaying error message. Default: false
  1010. * @param bool whether session admins should be allowed or not
  1011. *
  1012. * @return bool True if the user has access to the current course or is out of a course context, false otherwise
  1013. *
  1014. * @todo replace global variable
  1015. *
  1016. * @author Roan Embrechts
  1017. */
  1018. function api_protect_course_script($print_headers = false, $allow_session_admins = false, $allow_drh = false)
  1019. {
  1020. $course_info = api_get_course_info();
  1021. if (empty($course_info)) {
  1022. api_not_allowed($print_headers);
  1023. return false;
  1024. }
  1025. $is_allowed_in_course = api_is_allowed_in_course();
  1026. $is_visible = false;
  1027. if (api_is_drh()) {
  1028. return true;
  1029. }
  1030. // Session admin has access to course
  1031. $sessionAccess = api_get_configuration_value('session_admins_access_all_content');
  1032. if ($sessionAccess) {
  1033. $allow_session_admins = true;
  1034. }
  1035. if (api_is_platform_admin($allow_session_admins)) {
  1036. return true;
  1037. }
  1038. if (isset($course_info) && isset($course_info['visibility'])) {
  1039. switch ($course_info['visibility']) {
  1040. default:
  1041. case COURSE_VISIBILITY_CLOSED:
  1042. // Completely closed: the course is only accessible to the teachers. - 0
  1043. if (api_get_user_id() && !api_is_anonymous() && $is_allowed_in_course) {
  1044. $is_visible = true;
  1045. }
  1046. break;
  1047. case COURSE_VISIBILITY_REGISTERED:
  1048. // Private - access authorized to course members only - 1
  1049. if (api_get_user_id() && !api_is_anonymous() && $is_allowed_in_course) {
  1050. $is_visible = true;
  1051. }
  1052. break;
  1053. case COURSE_VISIBILITY_OPEN_PLATFORM:
  1054. // Open - access allowed for users registered on the platform - 2
  1055. if (api_get_user_id() && !api_is_anonymous() && $is_allowed_in_course) {
  1056. $is_visible = true;
  1057. }
  1058. break;
  1059. case COURSE_VISIBILITY_OPEN_WORLD:
  1060. //Open - access allowed for the whole world - 3
  1061. $is_visible = true;
  1062. break;
  1063. case COURSE_VISIBILITY_HIDDEN:
  1064. //Completely closed: the course is only accessible to the teachers. - 0
  1065. if (api_is_platform_admin()) {
  1066. $is_visible = true;
  1067. }
  1068. break;
  1069. }
  1070. //If password is set and user is not registered to the course then the course is not visible
  1071. if ($is_allowed_in_course == false &&
  1072. isset($course_info['registration_code']) &&
  1073. !empty($course_info['registration_code'])
  1074. ) {
  1075. $is_visible = false;
  1076. }
  1077. }
  1078. // Check session visibility
  1079. $session_id = api_get_session_id();
  1080. if (!empty($session_id)) {
  1081. //$is_allowed_in_course was set in local.inc.php
  1082. if (!$is_allowed_in_course) {
  1083. $is_visible = false;
  1084. }
  1085. }
  1086. if (!$is_visible) {
  1087. api_not_allowed($print_headers);
  1088. return false;
  1089. }
  1090. return true;
  1091. }
  1092. /**
  1093. * Function used to protect an admin script.
  1094. *
  1095. * The function blocks access when the user has no platform admin rights
  1096. * with an error message printed on default output
  1097. *
  1098. * @param bool Whether to allow session admins as well
  1099. * @param bool Whether to allow HR directors as well
  1100. * @param string An optional message (already passed through get_lang)
  1101. *
  1102. * @return bool True if user is allowed, false otherwise.
  1103. * The function also outputs an error message in case not allowed
  1104. *
  1105. * @author Roan Embrechts (original author)
  1106. */
  1107. function api_protect_admin_script($allow_sessions_admins = false, $allow_drh = false, $message = null)
  1108. {
  1109. if (!api_is_platform_admin($allow_sessions_admins, $allow_drh)) {
  1110. api_not_allowed(true, $message);
  1111. return false;
  1112. }
  1113. return true;
  1114. }
  1115. /**
  1116. * Function used to protect a teacher script.
  1117. * The function blocks access when the user has no teacher rights.
  1118. *
  1119. * @return bool True if the current user can access the script, false otherwise
  1120. *
  1121. * @author Yoselyn Castillo
  1122. */
  1123. function api_protect_teacher_script()
  1124. {
  1125. if (!api_is_allowed_to_edit()) {
  1126. api_not_allowed(true);
  1127. return false;
  1128. }
  1129. return true;
  1130. }
  1131. /**
  1132. * Function used to prevent anonymous users from accessing a script.
  1133. *
  1134. * @param bool|true $printHeaders
  1135. *
  1136. * @author Roan Embrechts
  1137. *
  1138. * @return bool
  1139. */
  1140. function api_block_anonymous_users($printHeaders = true)
  1141. {
  1142. $user = api_get_user_info();
  1143. if (!(isset($user['user_id']) && $user['user_id']) || api_is_anonymous($user['user_id'], true)) {
  1144. api_not_allowed($printHeaders);
  1145. return false;
  1146. }
  1147. return true;
  1148. }
  1149. /**
  1150. * Returns a rough evaluation of the browser's name and version based on very
  1151. * simple regexp.
  1152. *
  1153. * @return array with the navigator name and version ['name' => '...', 'version' => '...']
  1154. */
  1155. function api_get_navigator()
  1156. {
  1157. $navigator = 'Unknown';
  1158. $version = 0;
  1159. if (!isset($_SERVER['HTTP_USER_AGENT'])) {
  1160. return ['name' => 'Unknown', 'version' => '0.0.0'];
  1161. }
  1162. if (strpos($_SERVER['HTTP_USER_AGENT'], 'Opera') !== false) {
  1163. $navigator = 'Opera';
  1164. list(, $version) = explode('Opera', $_SERVER['HTTP_USER_AGENT']);
  1165. } elseif (strpos($_SERVER['HTTP_USER_AGENT'], 'Edge') !== false) {
  1166. $navigator = 'Edge';
  1167. list(, $version) = explode('Edge', $_SERVER['HTTP_USER_AGENT']);
  1168. } elseif (strpos($_SERVER['HTTP_USER_AGENT'], 'MSIE') !== false) {
  1169. $navigator = 'Internet Explorer';
  1170. list(, $version) = explode('MSIE ', $_SERVER['HTTP_USER_AGENT']);
  1171. } elseif (strpos($_SERVER['HTTP_USER_AGENT'], 'Chrome') !== false) {
  1172. $navigator = 'Chrome';
  1173. list(, $version) = explode('Chrome', $_SERVER['HTTP_USER_AGENT']);
  1174. } elseif (stripos($_SERVER['HTTP_USER_AGENT'], 'Safari') !== false) {
  1175. $navigator = 'Safari';
  1176. if (stripos($_SERVER['HTTP_USER_AGENT'], 'Version/') !== false) {
  1177. // If this Safari does have the "Version/" string in its user agent
  1178. // then use that as a version indicator rather than what's after
  1179. // "Safari/" which is rather a "build number" or something
  1180. list(, $version) = explode('Version/', $_SERVER['HTTP_USER_AGENT']);
  1181. } else {
  1182. list(, $version) = explode('Safari/', $_SERVER['HTTP_USER_AGENT']);
  1183. }
  1184. } elseif (strpos($_SERVER['HTTP_USER_AGENT'], 'Firefox') !== false) {
  1185. $navigator = 'Firefox';
  1186. list(, $version) = explode('Firefox', $_SERVER['HTTP_USER_AGENT']);
  1187. } elseif (strpos($_SERVER['HTTP_USER_AGENT'], 'Netscape') !== false) {
  1188. $navigator = 'Netscape';
  1189. if (stripos($_SERVER['HTTP_USER_AGENT'], 'Netscape/') !== false) {
  1190. list(, $version) = explode('Netscape', $_SERVER['HTTP_USER_AGENT']);
  1191. } else {
  1192. list(, $version) = explode('Navigator', $_SERVER['HTTP_USER_AGENT']);
  1193. }
  1194. } elseif (strpos($_SERVER['HTTP_USER_AGENT'], 'Konqueror') !== false) {
  1195. $navigator = 'Konqueror';
  1196. list(, $version) = explode('Konqueror', $_SERVER['HTTP_USER_AGENT']);
  1197. } elseif (stripos($_SERVER['HTTP_USER_AGENT'], 'applewebkit') !== false) {
  1198. $navigator = 'AppleWebKit';
  1199. list(, $version) = explode('Version/', $_SERVER['HTTP_USER_AGENT']);
  1200. } elseif (strpos($_SERVER['HTTP_USER_AGENT'], 'Gecko') !== false) {
  1201. $navigator = 'Mozilla';
  1202. list(, $version) = explode('; rv:', $_SERVER['HTTP_USER_AGENT']);
  1203. }
  1204. // Now cut extra stuff around (mostly *after*) the version number
  1205. $version = preg_replace('/^([\/\s])?([\d\.]+)?.*/', '\2', $version);
  1206. if (strpos($version, '.') === false) {
  1207. $version = number_format(doubleval($version), 1);
  1208. }
  1209. $return = ['name' => $navigator, 'version' => $version];
  1210. return $return;
  1211. }
  1212. /**
  1213. * @return true if user self registration is allowed, false otherwise
  1214. */
  1215. function api_is_self_registration_allowed()
  1216. {
  1217. return isset($GLOBALS['allowSelfReg']) ? $GLOBALS['allowSelfReg'] : false;
  1218. }
  1219. /**
  1220. * This function returns the id of the user which is stored in the $_user array.
  1221. *
  1222. * example: The function can be used to check if a user is logged in
  1223. * if (api_get_user_id())
  1224. *
  1225. * @return int the id of the current user, 0 if is empty
  1226. */
  1227. function api_get_user_id()
  1228. {
  1229. $userInfo = Session::read('_user');
  1230. if ($userInfo && isset($userInfo['user_id'])) {
  1231. return (int) $userInfo['user_id'];
  1232. }
  1233. return 0;
  1234. }
  1235. /**
  1236. * Gets the list of courses a specific user is subscribed to.
  1237. *
  1238. * @param int User ID
  1239. * @param bool $fetch_session Whether to get session courses or not - NOT YET IMPLEMENTED
  1240. *
  1241. * @return array Array of courses in the form [0]=>('code'=>xxx,'db'=>xxx,'dir'=>xxx,'status'=>d)
  1242. *
  1243. * @deprecated use CourseManager::get_courses_list_by_user_id()
  1244. */
  1245. function api_get_user_courses($userId, $fetch_session = true)
  1246. {
  1247. // Get out if not integer
  1248. if ($userId != strval(intval($userId))) {
  1249. return [];
  1250. }
  1251. $t_course = Database::get_main_table(TABLE_MAIN_COURSE);
  1252. $t_course_user = Database::get_main_table(TABLE_MAIN_COURSE_USER);
  1253. $sql = "SELECT cc.id as real_id, cc.code code, cc.directory dir, cu.status status
  1254. FROM $t_course cc, $t_course_user cu
  1255. WHERE
  1256. cc.id = cu.c_id AND
  1257. cu.user_id = $userId AND
  1258. cu.relation_type <> ".COURSE_RELATION_TYPE_RRHH;
  1259. $result = Database::query($sql);
  1260. if ($result === false) {
  1261. return [];
  1262. }
  1263. $courses = [];
  1264. while ($row = Database::fetch_array($result)) {
  1265. // we only need the database name of the course
  1266. $courses[] = $row;
  1267. }
  1268. return $courses;
  1269. }
  1270. /**
  1271. * Formats user information into a standard array
  1272. * This function should be only used inside api_get_user_info().
  1273. *
  1274. * @param array Non-standard user array
  1275. * @param bool $add_password
  1276. * @param bool $loadAvatars turn off to improve performance
  1277. *
  1278. * @return array Standard user array
  1279. */
  1280. function _api_format_user($user, $add_password = false, $loadAvatars = true)
  1281. {
  1282. $result = [];
  1283. $result['firstname'] = null;
  1284. $result['lastname'] = null;
  1285. if (isset($user['firstname']) && isset($user['lastname'])) { // with only lowercase
  1286. $result['firstname'] = $user['firstname'];
  1287. $result['lastname'] = $user['lastname'];
  1288. } elseif (isset($user['firstName']) && isset($user['lastName'])) { // with uppercase letters
  1289. $result['firstname'] = isset($user['firstName']) ? $user['firstName'] : null;
  1290. $result['lastname'] = isset($user['lastName']) ? $user['lastName'] : null;
  1291. }
  1292. if (isset($user['email'])) {
  1293. $result['mail'] = isset($user['email']) ? $user['email'] : null;
  1294. $result['email'] = isset($user['email']) ? $user['email'] : null;
  1295. } else {
  1296. $result['mail'] = isset($user['mail']) ? $user['mail'] : null;
  1297. $result['email'] = isset($user['mail']) ? $user['mail'] : null;
  1298. }
  1299. $result['complete_name'] = api_get_person_name($result['firstname'], $result['lastname']);
  1300. $result['complete_name_with_username'] = $result['complete_name'];
  1301. if (!empty($user['username']) && !api_get_configuration_value('hide_username_with_complete_name')) {
  1302. $result['complete_name_with_username'] = $result['complete_name'].' ('.$user['username'].')';
  1303. }
  1304. $showEmail = api_get_setting('show_email_addresses') === 'true';
  1305. if (!empty($user['email'])) {
  1306. $result['complete_name_with_email_forced'] = $result['complete_name'].' ('.$user['email'].')';
  1307. if ($showEmail) {
  1308. $result['complete_name_with_email'] = $result['complete_name'].' ('.$user['email'].')';
  1309. }
  1310. } else {
  1311. $result['complete_name_with_email'] = $result['complete_name'];
  1312. $result['complete_name_with_email_forced'] = $result['complete_name'];
  1313. }
  1314. // Kept for historical reasons
  1315. $result['firstName'] = $result['firstname'];
  1316. $result['lastName'] = $result['lastname'];
  1317. $attributes = [
  1318. 'phone',
  1319. 'address',
  1320. 'picture_uri',
  1321. 'official_code',
  1322. 'status',
  1323. 'active',
  1324. 'auth_source',
  1325. 'username',
  1326. 'theme',
  1327. 'language',
  1328. 'creator_id',
  1329. 'registration_date',
  1330. 'hr_dept_id',
  1331. 'expiration_date',
  1332. 'last_login',
  1333. 'user_is_online',
  1334. ];
  1335. if (api_get_setting('extended_profile') === 'true') {
  1336. $attributes[] = 'competences';
  1337. $attributes[] = 'diplomas';
  1338. $attributes[] = 'teach';
  1339. $attributes[] = 'openarea';
  1340. }
  1341. foreach ($attributes as $attribute) {
  1342. $result[$attribute] = isset($user[$attribute]) ? $user[$attribute] : null;
  1343. }
  1344. $user_id = (int) $user['user_id'];
  1345. // Maintain the user_id index for backwards compatibility
  1346. $result['user_id'] = $result['id'] = $user_id;
  1347. $hasCertificates = Certificate::getCertificateByUser($user_id);
  1348. $result['has_certificates'] = 0;
  1349. if (!empty($hasCertificates)) {
  1350. $result['has_certificates'] = 1;
  1351. }
  1352. $result['icon_status'] = '';
  1353. $result['icon_status_medium'] = '';
  1354. $result['is_admin'] = UserManager::is_admin($user_id);
  1355. // Getting user avatar.
  1356. if ($loadAvatars) {
  1357. $result['avatar'] = '';
  1358. $result['avatar_no_query'] = '';
  1359. $result['avatar_small'] = '';
  1360. $result['avatar_medium'] = '';
  1361. if (!isset($user['avatar'])) {
  1362. $originalFile = UserManager::getUserPicture(
  1363. $user_id,
  1364. USER_IMAGE_SIZE_ORIGINAL,
  1365. null,
  1366. $result
  1367. );
  1368. $result['avatar'] = $originalFile;
  1369. $avatarString = explode('?', $result['avatar']);
  1370. $result['avatar_no_query'] = reset($avatarString);
  1371. } else {
  1372. $result['avatar'] = $user['avatar'];
  1373. $avatarString = explode('?', $user['avatar']);
  1374. $result['avatar_no_query'] = reset($avatarString);
  1375. }
  1376. if (!isset($user['avatar_small'])) {
  1377. $smallFile = UserManager::getUserPicture(
  1378. $user_id,
  1379. USER_IMAGE_SIZE_SMALL,
  1380. null,
  1381. $result
  1382. );
  1383. $result['avatar_small'] = $smallFile;
  1384. } else {
  1385. $result['avatar_small'] = $user['avatar_small'];
  1386. }
  1387. if (!isset($user['avatar_medium'])) {
  1388. $mediumFile = UserManager::getUserPicture(
  1389. $user_id,
  1390. USER_IMAGE_SIZE_MEDIUM,
  1391. null,
  1392. $result
  1393. );
  1394. $result['avatar_medium'] = $mediumFile;
  1395. } else {
  1396. $result['avatar_medium'] = $user['avatar_medium'];
  1397. }
  1398. $urlImg = api_get_path(WEB_IMG_PATH);
  1399. $iconStatus = '';
  1400. $iconStatusMedium = '';
  1401. switch ($result['status']) {
  1402. case STUDENT:
  1403. if ($result['has_certificates']) {
  1404. $iconStatus = $urlImg.'icons/svg/identifier_graduated.svg';
  1405. } else {
  1406. $iconStatus = $urlImg.'icons/svg/identifier_student.svg';
  1407. }
  1408. break;
  1409. case COURSEMANAGER:
  1410. if ($result['is_admin']) {
  1411. $iconStatus = $urlImg.'icons/svg/identifier_admin.svg';
  1412. } else {
  1413. $iconStatus = $urlImg.'icons/svg/identifier_teacher.svg';
  1414. }
  1415. break;
  1416. case STUDENT_BOSS:
  1417. $iconStatus = $urlImg.'icons/svg/identifier_teacher.svg';
  1418. break;
  1419. }
  1420. if (!empty($iconStatus)) {
  1421. $iconStatusMedium = '<img src="'.$iconStatus.'" width="32px" height="32px">';
  1422. $iconStatus = '<img src="'.$iconStatus.'" width="22px" height="22px">';
  1423. }
  1424. $result['icon_status'] = $iconStatus;
  1425. $result['icon_status_medium'] = $iconStatusMedium;
  1426. }
  1427. if (isset($user['user_is_online'])) {
  1428. $result['user_is_online'] = $user['user_is_online'] == true ? 1 : 0;
  1429. }
  1430. if (isset($user['user_is_online_in_chat'])) {
  1431. $result['user_is_online_in_chat'] = (int) $user['user_is_online_in_chat'];
  1432. }
  1433. if ($add_password) {
  1434. $result['password'] = $user['password'];
  1435. }
  1436. if (isset($result['profile_completed'])) {
  1437. $result['profile_completed'] = $user['profile_completed'];
  1438. }
  1439. $result['profile_url'] = api_get_path(WEB_CODE_PATH).'social/profile.php?u='.$user_id;
  1440. // Send message link
  1441. $sendMessage = api_get_path(WEB_AJAX_PATH).'user_manager.ajax.php?a=get_user_popup&user_id='.$user_id;
  1442. $result['complete_name_with_message_link'] = Display::url(
  1443. $result['complete_name_with_username'],
  1444. $sendMessage,
  1445. ['class' => 'ajax']
  1446. );
  1447. if (isset($user['extra'])) {
  1448. $result['extra'] = $user['extra'];
  1449. }
  1450. return $result;
  1451. }
  1452. /**
  1453. * Finds all the information about a user.
  1454. * If no parameter is passed you find all the information about the current user.
  1455. *
  1456. * @param int $user_id
  1457. * @param bool $checkIfUserOnline
  1458. * @param bool $showPassword
  1459. * @param bool $loadExtraData
  1460. * @param bool $loadOnlyVisibleExtraData Get the user extra fields that are visible
  1461. * @param bool $loadAvatars turn off to improve performance and if avatars are not needed
  1462. * @param bool $updateCache update apc cache if exists
  1463. *
  1464. * @return mixed $user_info user_id, lastname, firstname, username, email, etc or false on error
  1465. *
  1466. * @author Patrick Cool <patrick.cool@UGent.be>
  1467. * @author Julio Montoya
  1468. *
  1469. * @version 21 September 2004
  1470. */
  1471. function api_get_user_info(
  1472. $user_id = 0,
  1473. $checkIfUserOnline = false,
  1474. $showPassword = false,
  1475. $loadExtraData = false,
  1476. $loadOnlyVisibleExtraData = false,
  1477. $loadAvatars = true,
  1478. $updateCache = false
  1479. ) {
  1480. $apcVar = null;
  1481. $user = false;
  1482. $cacheAvailable = api_get_configuration_value('apc');
  1483. if (empty($user_id)) {
  1484. $userFromSession = Session::read('_user');
  1485. if (isset($userFromSession)) {
  1486. if ($cacheAvailable === true &&
  1487. (
  1488. empty($userFromSession['is_anonymous']) &&
  1489. (isset($userFromSession['status']) && $userFromSession['status'] != ANONYMOUS)
  1490. )
  1491. ) {
  1492. $apcVar = api_get_configuration_value('apc_prefix').'userinfo_'.$userFromSession['user_id'];
  1493. if (apcu_exists($apcVar)) {
  1494. if ($updateCache) {
  1495. apcu_store($apcVar, $userFromSession, 60);
  1496. }
  1497. $user = apcu_fetch($apcVar);
  1498. } else {
  1499. $user = _api_format_user(
  1500. $userFromSession,
  1501. $showPassword,
  1502. $loadAvatars
  1503. );
  1504. apcu_store($apcVar, $user, 60);
  1505. }
  1506. } else {
  1507. $user = _api_format_user(
  1508. $userFromSession,
  1509. $showPassword,
  1510. $loadAvatars
  1511. );
  1512. }
  1513. return $user;
  1514. }
  1515. return false;
  1516. }
  1517. // Make sure user_id is safe
  1518. $user_id = (int) $user_id;
  1519. // Re-use user information if not stale and already stored in APCu
  1520. if ($cacheAvailable === true) {
  1521. $apcVar = api_get_configuration_value('apc_prefix').'userinfo_'.$user_id;
  1522. if (apcu_exists($apcVar) && $updateCache == false && $checkIfUserOnline == false) {
  1523. $user = apcu_fetch($apcVar);
  1524. return $user;
  1525. }
  1526. }
  1527. $sql = "SELECT * FROM ".Database::get_main_table(TABLE_MAIN_USER)."
  1528. WHERE id = $user_id";
  1529. $result = Database::query($sql);
  1530. if (Database::num_rows($result) > 0) {
  1531. $result_array = Database::fetch_array($result);
  1532. $result_array['user_is_online_in_chat'] = 0;
  1533. if ($checkIfUserOnline) {
  1534. $use_status_in_platform = user_is_online($user_id);
  1535. $result_array['user_is_online'] = $use_status_in_platform;
  1536. $user_online_in_chat = 0;
  1537. if ($use_status_in_platform) {
  1538. $user_status = UserManager::get_extra_user_data_by_field(
  1539. $user_id,
  1540. 'user_chat_status',
  1541. false,
  1542. true
  1543. );
  1544. if ((int) $user_status['user_chat_status'] == 1) {
  1545. $user_online_in_chat = 1;
  1546. }
  1547. }
  1548. $result_array['user_is_online_in_chat'] = $user_online_in_chat;
  1549. }
  1550. if ($loadExtraData) {
  1551. $fieldValue = new ExtraFieldValue('user');
  1552. $result_array['extra'] = $fieldValue->getAllValuesForAnItem(
  1553. $user_id,
  1554. $loadOnlyVisibleExtraData
  1555. );
  1556. }
  1557. $user = _api_format_user($result_array, $showPassword, $loadAvatars);
  1558. }
  1559. if ($cacheAvailable === true) {
  1560. apcu_store($apcVar, $user, 60);
  1561. }
  1562. return $user;
  1563. }
  1564. /**
  1565. * @param int $userId
  1566. *
  1567. * @return User
  1568. */
  1569. function api_get_user_entity($userId)
  1570. {
  1571. $userId = (int) $userId;
  1572. $repo = UserManager::getRepository();
  1573. /** @var User $user */
  1574. $user = $repo->find($userId);
  1575. return $user;
  1576. }
  1577. /**
  1578. * Finds all the information about a user from username instead of user id.
  1579. *
  1580. * @param string $username
  1581. *
  1582. * @return mixed $user_info array user_id, lastname, firstname, username, email or false on error
  1583. *
  1584. * @author Yannick Warnier <yannick.warnier@beeznest.com>
  1585. */
  1586. function api_get_user_info_from_username($username = '')
  1587. {
  1588. if (empty($username)) {
  1589. return false;
  1590. }
  1591. $username = trim($username);
  1592. $sql = "SELECT * FROM ".Database::get_main_table(TABLE_MAIN_USER)."
  1593. WHERE username='".Database::escape_string($username)."'";
  1594. $result = Database::query($sql);
  1595. if (Database::num_rows($result) > 0) {
  1596. $resultArray = Database::fetch_array($result);
  1597. return _api_format_user($resultArray);
  1598. }
  1599. return false;
  1600. }
  1601. /**
  1602. * Get first user with an email.
  1603. *
  1604. * @param string $email
  1605. *
  1606. * @return array|bool
  1607. */
  1608. function api_get_user_info_from_email($email = '')
  1609. {
  1610. if (empty($email)) {
  1611. return false;
  1612. }
  1613. $sql = "SELECT * FROM ".Database::get_main_table(TABLE_MAIN_USER)."
  1614. WHERE email ='".Database::escape_string($email)."' LIMIT 1";
  1615. $result = Database::query($sql);
  1616. if (Database::num_rows($result) > 0) {
  1617. $resultArray = Database::fetch_array($result);
  1618. return _api_format_user($resultArray);
  1619. }
  1620. return false;
  1621. }
  1622. /**
  1623. * @return string
  1624. */
  1625. function api_get_course_id()
  1626. {
  1627. return Session::read('_cid', null);
  1628. }
  1629. /**
  1630. * Returns the current course id (integer).
  1631. *
  1632. * @param string $code Optional course code
  1633. *
  1634. * @return int
  1635. */
  1636. function api_get_course_int_id($code = null)
  1637. {
  1638. if (!empty($code)) {
  1639. $code = Database::escape_string($code);
  1640. $row = Database::select(
  1641. 'id',
  1642. Database::get_main_table(TABLE_MAIN_COURSE),
  1643. ['where' => ['code = ?' => [$code]]],
  1644. 'first'
  1645. );
  1646. if (is_array($row) && isset($row['id'])) {
  1647. return $row['id'];
  1648. } else {
  1649. return false;
  1650. }
  1651. }
  1652. return Session::read('_real_cid', 0);
  1653. }
  1654. /**
  1655. * Returns the current course directory.
  1656. *
  1657. * This function relies on api_get_course_info()
  1658. *
  1659. * @param string The course code - optional (takes it from session if not given)
  1660. *
  1661. * @return string The directory where the course is located inside the Chamilo "courses" directory
  1662. *
  1663. * @author Yannick Warnier <yannick.warnier@beeznest.com>
  1664. */
  1665. function api_get_course_path($course_code = null)
  1666. {
  1667. $info = !empty($course_code) ? api_get_course_info($course_code) : api_get_course_info();
  1668. return $info['path'];
  1669. }
  1670. /**
  1671. * Gets a course setting from the current course_setting table. Try always using integer values.
  1672. *
  1673. * @param string $setting_name The name of the setting we want from the table
  1674. * @param string $course_code
  1675. *
  1676. * @return mixed The value of that setting in that table. Return -1 if not found.
  1677. */
  1678. function api_get_course_setting($setting_name, $course_code = null)
  1679. {
  1680. $course_info = api_get_course_info($course_code);
  1681. $table = Database::get_course_table(TABLE_COURSE_SETTING);
  1682. $setting_name = Database::escape_string($setting_name);
  1683. if (!empty($course_info['real_id']) && !empty($setting_name)) {
  1684. $sql = "SELECT value FROM $table
  1685. WHERE c_id = {$course_info['real_id']} AND variable = '$setting_name'";
  1686. $res = Database::query($sql);
  1687. if (Database::num_rows($res) > 0) {
  1688. $row = Database::fetch_array($res);
  1689. if ($setting_name === 'email_alert_manager_on_new_quiz') {
  1690. if (!is_null($row['value'])) {
  1691. $result = explode(',', $row['value']);
  1692. $row['value'] = $result;
  1693. }
  1694. }
  1695. return $row['value'];
  1696. }
  1697. }
  1698. return -1;
  1699. }
  1700. /**
  1701. * Gets an anonymous user ID.
  1702. *
  1703. * For some tools that need tracking, like the learnpath tool, it is necessary
  1704. * to have a usable user-id to enable some kind of tracking, even if not
  1705. * perfect. An anonymous ID is taken from the users table by looking for a
  1706. * status of "6" (anonymous).
  1707. *
  1708. * @return int User ID of the anonymous user, or O if no anonymous user found
  1709. */
  1710. function api_get_anonymous_id()
  1711. {
  1712. // Find if another anon is connected now
  1713. $table = Database::get_main_table(TABLE_STATISTIC_TRACK_E_LOGIN);
  1714. $tableU = Database::get_main_table(TABLE_MAIN_USER);
  1715. $ip = Database::escape_string(api_get_real_ip());
  1716. $max = (int) api_get_configuration_value('max_anonymous_users');
  1717. if ($max >= 2) {
  1718. $sql = "SELECT * FROM $table as TEL
  1719. JOIN $tableU as U
  1720. ON U.user_id = TEL.login_user_id
  1721. WHERE TEL.user_ip = '$ip'
  1722. AND U.status = ".ANONYMOUS."
  1723. AND U.user_id != 2 ";
  1724. $result = Database::query($sql);
  1725. if (empty(Database::num_rows($result))) {
  1726. $login = uniqid('anon_');
  1727. $anonList = UserManager::get_user_list(['status' => ANONYMOUS], ['registration_date ASC']);
  1728. if (count($anonList) >= $max) {
  1729. foreach ($anonList as $userToDelete) {
  1730. UserManager::delete_user($userToDelete['user_id']);
  1731. break;
  1732. }
  1733. }
  1734. $userId = UserManager::create_user(
  1735. $login,
  1736. 'anon',
  1737. ANONYMOUS,
  1738. ' anonymous@localhost',
  1739. $login,
  1740. $login
  1741. );
  1742. return $userId;
  1743. } else {
  1744. $row = Database::fetch_array($result, 'ASSOC');
  1745. return $row['user_id'];
  1746. }
  1747. }
  1748. $table = Database::get_main_table(TABLE_MAIN_USER);
  1749. $sql = "SELECT user_id
  1750. FROM $table
  1751. WHERE status = ".ANONYMOUS." ";
  1752. $res = Database::query($sql);
  1753. if (Database::num_rows($res) > 0) {
  1754. $row = Database::fetch_array($res, 'ASSOC');
  1755. return $row['user_id'];
  1756. }
  1757. // No anonymous user was found.
  1758. return 0;
  1759. }
  1760. /**
  1761. * @param string $courseCode
  1762. * @param int $sessionId
  1763. * @param int $groupId
  1764. *
  1765. * @return string
  1766. */
  1767. function api_get_cidreq_params($courseCode, $sessionId = 0, $groupId = 0)
  1768. {
  1769. $courseCode = !empty($courseCode) ? htmlspecialchars($courseCode) : '';
  1770. $sessionId = !empty($sessionId) ? (int) $sessionId : 0;
  1771. $groupId = !empty($groupId) ? (int) $groupId : 0;
  1772. $url = 'cidReq='.$courseCode;
  1773. $url .= '&id_session='.$sessionId;
  1774. $url .= '&gidReq='.$groupId;
  1775. return $url;
  1776. }
  1777. /**
  1778. * Returns the current course url part including session, group, and gradebook params.
  1779. *
  1780. * @param bool $addSessionId
  1781. * @param bool $addGroupId
  1782. * @param string $origin
  1783. *
  1784. * @return string Course & session references to add to a URL
  1785. */
  1786. function api_get_cidreq($addSessionId = true, $addGroupId = true, $origin = '')
  1787. {
  1788. $courseCode = api_get_course_id();
  1789. $url = empty($courseCode) ? '' : 'cidReq='.htmlspecialchars($courseCode);
  1790. $origin = empty($origin) ? api_get_origin() : Security::remove_XSS($origin);
  1791. if ($addSessionId) {
  1792. if (!empty($url)) {
  1793. $url .= api_get_session_id() == 0 ? '&id_session=0' : '&id_session='.api_get_session_id();
  1794. }
  1795. }
  1796. if ($addGroupId) {
  1797. if (!empty($url)) {
  1798. $url .= api_get_group_id() == 0 ? '&gidReq=0' : '&gidReq='.api_get_group_id();
  1799. }
  1800. }
  1801. if (!empty($url)) {
  1802. $url .= '&gradebook='.intval(api_is_in_gradebook());
  1803. $url .= '&origin='.$origin;
  1804. }
  1805. return $url;
  1806. }
  1807. /**
  1808. * Get if we visited a gradebook page.
  1809. *
  1810. * @return bool
  1811. */
  1812. function api_is_in_gradebook()
  1813. {
  1814. return Session::read('in_gradebook', false);
  1815. }
  1816. /**
  1817. * Set that we are in a page inside a gradebook.
  1818. */
  1819. function api_set_in_gradebook()
  1820. {
  1821. Session::write('in_gradebook', true);
  1822. }
  1823. /**
  1824. * Remove gradebook session.
  1825. */
  1826. function api_remove_in_gradebook()
  1827. {
  1828. Session::erase('in_gradebook');
  1829. }
  1830. /**
  1831. * Returns the current course info array see api_format_course_array()
  1832. * If the course_code is given, the returned array gives info about that
  1833. * particular course, if none given it gets the course info from the session.
  1834. *
  1835. * @param string $course_code
  1836. * @param bool $strict
  1837. *
  1838. * @return array
  1839. */
  1840. function api_get_course_info($course_code = null, $strict = false)
  1841. {
  1842. if (!empty($course_code)) {
  1843. $course_code = Database::escape_string($course_code);
  1844. $courseId = api_get_course_int_id($course_code);
  1845. if (empty($courseId)) {
  1846. return [];
  1847. }
  1848. $course_table = Database::get_main_table(TABLE_MAIN_COURSE);
  1849. $course_cat_table = Database::get_main_table(TABLE_MAIN_CATEGORY);
  1850. $sql = "SELECT
  1851. course.*,
  1852. course_category.code faCode,
  1853. course_category.name faName
  1854. FROM $course_table
  1855. LEFT JOIN $course_cat_table
  1856. ON course.category_code = course_category.code
  1857. WHERE course.id = $courseId";
  1858. $result = Database::query($sql);
  1859. $courseInfo = [];
  1860. if (Database::num_rows($result) > 0) {
  1861. $data = Database::fetch_array($result);
  1862. $courseInfo = api_format_course_array($data);
  1863. }
  1864. return $courseInfo;
  1865. }
  1866. global $_course;
  1867. if ($_course == '-1') {
  1868. $_course = [];
  1869. }
  1870. return $_course;
  1871. }
  1872. /**
  1873. * @param int $courseId
  1874. *
  1875. * @return \Chamilo\CoreBundle\Entity\Course
  1876. */
  1877. function api_get_course_entity($courseId = 0)
  1878. {
  1879. if (empty($courseId)) {
  1880. $courseId = api_get_course_int_id();
  1881. }
  1882. return Database::getManager()->getRepository('ChamiloCoreBundle:Course')->find($courseId);
  1883. }
  1884. /**
  1885. * @param int $id
  1886. *
  1887. * @return \Chamilo\CoreBundle\Entity\Session
  1888. */
  1889. function api_get_session_entity($id = 0)
  1890. {
  1891. if (empty($id)) {
  1892. $id = api_get_session_id();
  1893. }
  1894. return Database::getManager()->getRepository('ChamiloCoreBundle:Session')->find($id);
  1895. }
  1896. /**
  1897. * Returns the current course info array.
  1898. * Now if the course_code is given, the returned array gives info about that
  1899. * particular course, not specially the current one.
  1900. *
  1901. * @param int $id Numeric ID of the course
  1902. *
  1903. * @return array The course info as an array formatted by api_format_course_array, including category.name
  1904. */
  1905. function api_get_course_info_by_id($id = null)
  1906. {
  1907. if (!empty($id)) {
  1908. $id = (int) $id;
  1909. $course_table = Database::get_main_table(TABLE_MAIN_COURSE);
  1910. $course_cat_table = Database::get_main_table(TABLE_MAIN_CATEGORY);
  1911. $sql = "SELECT
  1912. course.*,
  1913. course_category.code faCode,
  1914. course_category.name faName
  1915. FROM $course_table
  1916. LEFT JOIN $course_cat_table
  1917. ON course.category_code = course_category.code
  1918. WHERE course.id = $id";
  1919. $result = Database::query($sql);
  1920. $_course = [];
  1921. if (Database::num_rows($result) > 0) {
  1922. $row = Database::fetch_array($result);
  1923. $_course = api_format_course_array($row);
  1924. }
  1925. return $_course;
  1926. }
  1927. global $_course;
  1928. if ($_course == '-1') {
  1929. $_course = [];
  1930. }
  1931. return $_course;
  1932. }
  1933. /**
  1934. * Reformat the course array (output by api_get_course_info()) in order, mostly,
  1935. * to switch from 'code' to 'id' in the array. This is a legacy feature and is
  1936. * now possibly causing massive confusion as a new "id" field has been added to
  1937. * the course table in 1.9.0.
  1938. *
  1939. * @param $course_data
  1940. *
  1941. * @return array
  1942. *
  1943. * @todo eradicate the false "id"=code field of the $_course array and use the int id
  1944. */
  1945. function api_format_course_array($course_data)
  1946. {
  1947. if (empty($course_data)) {
  1948. return [];
  1949. }
  1950. $_course = [];
  1951. $_course['id'] = $course_data['code'];
  1952. $_course['real_id'] = $course_data['id'];
  1953. // Added
  1954. $_course['code'] = $course_data['code'];
  1955. $_course['name'] = $course_data['title'];
  1956. $_course['title'] = $course_data['title'];
  1957. $_course['official_code'] = $course_data['visual_code'];
  1958. $_course['visual_code'] = $course_data['visual_code'];
  1959. $_course['sysCode'] = $course_data['code'];
  1960. $_course['path'] = $course_data['directory']; // Use as key in path.
  1961. $_course['directory'] = $course_data['directory'];
  1962. $_course['creation_date'] = $course_data['creation_date'];
  1963. $_course['titular'] = $course_data['tutor_name'];
  1964. $_course['language'] = $course_data['course_language'];
  1965. $_course['extLink']['url'] = $course_data['department_url'];
  1966. $_course['extLink']['name'] = $course_data['department_name'];
  1967. $_course['categoryCode'] = $course_data['faCode'];
  1968. $_course['categoryName'] = $course_data['faName'];
  1969. $_course['visibility'] = $course_data['visibility'];
  1970. $_course['subscribe_allowed'] = $course_data['subscribe'];
  1971. $_course['subscribe'] = $course_data['subscribe'];
  1972. $_course['unsubscribe'] = $course_data['unsubscribe'];
  1973. $_course['course_language'] = $course_data['course_language'];
  1974. $_course['activate_legal'] = isset($course_data['activate_legal']) ? $course_data['activate_legal'] : false;
  1975. $_course['legal'] = $course_data['legal'];
  1976. $_course['show_score'] = $course_data['show_score']; //used in the work tool
  1977. $_course['department_name'] = $course_data['department_name'];
  1978. $_course['department_url'] = $course_data['department_url'];
  1979. $courseSys = api_get_path(SYS_COURSE_PATH).$course_data['directory'];
  1980. $webCourseHome = api_get_path(WEB_COURSE_PATH).$course_data['directory'];
  1981. // Course password
  1982. $_course['registration_code'] = !empty($course_data['registration_code']) ? sha1($course_data['registration_code']) : null;
  1983. $_course['disk_quota'] = $course_data['disk_quota'];
  1984. $_course['course_public_url'] = $webCourseHome.'/index.php';
  1985. $_course['course_sys_path'] = $courseSys.'/';
  1986. if (array_key_exists('add_teachers_to_sessions_courses', $course_data)) {
  1987. $_course['add_teachers_to_sessions_courses'] = $course_data['add_teachers_to_sessions_courses'];
  1988. }
  1989. // Course image
  1990. $_course['course_image_source'] = '';
  1991. if (file_exists($courseSys.'/course-pic85x85.png')) {
  1992. $url_image = $webCourseHome.'/course-pic85x85.png';
  1993. $_course['course_image_source'] = $courseSys.'/course-pic85x85.png';
  1994. } else {
  1995. $url_image = Display::return_icon(
  1996. 'course.png',
  1997. null,
  1998. null,
  1999. ICON_SIZE_BIG,
  2000. null,
  2001. true,
  2002. false
  2003. );
  2004. }
  2005. $_course['course_image'] = $url_image;
  2006. // Course large image
  2007. $_course['course_image_large_source'] = '';
  2008. if (file_exists($courseSys.'/course-pic.png')) {
  2009. $url_image = $webCourseHome.'/course-pic.png';
  2010. $_course['course_image_large_source'] = $courseSys.'/course-pic.png';
  2011. } else {
  2012. $url_image = Display::return_icon(
  2013. 'session_default.png',
  2014. null,
  2015. null,
  2016. null,
  2017. null,
  2018. true,
  2019. true
  2020. );
  2021. }
  2022. $_course['course_image_large'] = $url_image;
  2023. return $_course;
  2024. }
  2025. /**
  2026. * Returns a difficult to guess password.
  2027. *
  2028. * @param int $length the length of the password
  2029. *
  2030. * @return string the generated password
  2031. */
  2032. function api_generate_password($length = 8)
  2033. {
  2034. if ($length < 2) {
  2035. $length = 2;
  2036. }
  2037. $charactersLowerCase = 'abcdefghijkmnopqrstuvwxyz';
  2038. $charactersUpperCase = 'ABCDEFGHJKLMNPQRSTUVWXYZ';
  2039. $minNumbers = 2;
  2040. $length = $length - $minNumbers;
  2041. $minLowerCase = round($length / 2);
  2042. $minUpperCase = $length - $minLowerCase;
  2043. $password = '';
  2044. $passwordRequirements = api_get_configuration_value('password_requirements');
  2045. $factory = new RandomLib\Factory();
  2046. $generator = $factory->getGenerator(new SecurityLib\Strength(SecurityLib\Strength::MEDIUM));
  2047. if (!empty($passwordRequirements)) {
  2048. $length = $passwordRequirements['min']['length'];
  2049. $minNumbers = $passwordRequirements['min']['numeric'];
  2050. $minLowerCase = $passwordRequirements['min']['lowercase'];
  2051. $minUpperCase = $passwordRequirements['min']['uppercase'];
  2052. $rest = $length - $minNumbers - $minLowerCase - $minUpperCase;
  2053. // Add the rest to fill the length requirement
  2054. if ($rest > 0) {
  2055. $password .= $generator->generateString($rest, $charactersLowerCase.$charactersUpperCase);
  2056. }
  2057. }
  2058. // Min digits default 2
  2059. for ($i = 0; $i < $minNumbers; $i++) {
  2060. $password .= $generator->generateInt(2, 9);
  2061. }
  2062. // Min lowercase
  2063. $password .= $generator->generateString($minLowerCase, $charactersLowerCase);
  2064. // Min uppercase
  2065. $password .= $generator->generateString($minUpperCase, $charactersUpperCase);
  2066. $password = str_shuffle($password);
  2067. return $password;
  2068. }
  2069. /**
  2070. * Checks a password to see wether it is OK to use.
  2071. *
  2072. * @param string $password
  2073. *
  2074. * @return bool if the password is acceptable, false otherwise
  2075. * Notes about what a password "OK to use" is:
  2076. * 1. The password should be at least 5 characters long.
  2077. * 2. Only English letters (uppercase or lowercase, it doesn't matter) and digits are allowed.
  2078. * 3. The password should contain at least 3 letters.
  2079. * 4. It should contain at least 2 digits.
  2080. * Settings will change if the configuration value is set: password_requirements
  2081. */
  2082. function api_check_password($password)
  2083. {
  2084. $passwordRequirements = Security::getPasswordRequirements();
  2085. $minLength = $passwordRequirements['min']['length'];
  2086. $minNumbers = $passwordRequirements['min']['numeric'];
  2087. // Optional
  2088. $minLowerCase = $passwordRequirements['min']['lowercase'];
  2089. $minUpperCase = $passwordRequirements['min']['uppercase'];
  2090. $minLetters = $minLowerCase + $minUpperCase;
  2091. $passwordLength = api_strlen($password);
  2092. $conditions = [
  2093. 'min_length' => $passwordLength >= $minLength,
  2094. ];
  2095. $digits = 0;
  2096. $lowerCase = 0;
  2097. $upperCase = 0;
  2098. for ($i = 0; $i < $passwordLength; $i++) {
  2099. $currentCharacterCode = api_ord(api_substr($password, $i, 1));
  2100. if ($currentCharacterCode >= 65 && $currentCharacterCode <= 90) {
  2101. $upperCase++;
  2102. }
  2103. if ($currentCharacterCode >= 97 && $currentCharacterCode <= 122) {
  2104. $lowerCase++;
  2105. }
  2106. if ($currentCharacterCode >= 48 && $currentCharacterCode <= 57) {
  2107. $digits++;
  2108. }
  2109. }
  2110. // Min number of digits
  2111. $conditions['min_numeric'] = $digits >= $minNumbers;
  2112. if (!empty($minUpperCase)) {
  2113. // Uppercase
  2114. $conditions['min_uppercase'] = $upperCase >= $minUpperCase;
  2115. }
  2116. if (!empty($minLowerCase)) {
  2117. // Lowercase
  2118. $conditions['min_lowercase'] = $upperCase >= $minLowerCase;
  2119. }
  2120. // Min letters
  2121. $letters = $upperCase + $lowerCase;
  2122. $conditions['min_letters'] = $letters >= $minLetters;
  2123. $isPasswordOk = true;
  2124. foreach ($conditions as $condition) {
  2125. if ($condition === false) {
  2126. $isPasswordOk = false;
  2127. break;
  2128. }
  2129. }
  2130. if ($isPasswordOk === false) {
  2131. $output = get_lang('NewPasswordRequirementsNotMatched').'<br />';
  2132. $output .= Security::getPasswordRequirementsToString($conditions);
  2133. Display::addFlash(Display::return_message($output, 'warning', false));
  2134. }
  2135. return $isPasswordOk;
  2136. }
  2137. /**
  2138. * Clears the user ID from the session if it was the anonymous user. Generally
  2139. * used on out-of-tools pages to remove a user ID that could otherwise be used
  2140. * in the wrong context.
  2141. * This function is to be used in conjunction with the api_set_anonymous()
  2142. * function to simulate the user existence in case of an anonymous visit.
  2143. *
  2144. * @param bool database check switch - passed to api_is_anonymous()
  2145. *
  2146. * @return bool true if succesfully unregistered, false if not anonymous
  2147. */
  2148. function api_clear_anonymous($db_check = false)
  2149. {
  2150. global $_user;
  2151. if (api_is_anonymous($_user['user_id'], $db_check)) {
  2152. unset($_user['user_id']);
  2153. Session::erase('_uid');
  2154. return true;
  2155. }
  2156. return false;
  2157. }
  2158. /**
  2159. * Returns the status string corresponding to the status code.
  2160. *
  2161. * @author Noel Dieschburg
  2162. *
  2163. * @param the int status code
  2164. *
  2165. * @return string
  2166. */
  2167. function get_status_from_code($status_code)
  2168. {
  2169. switch ($status_code) {
  2170. case STUDENT:
  2171. return get_lang('Student', '');
  2172. case COURSEMANAGER:
  2173. return get_lang('Teacher', '');
  2174. case SESSIONADMIN:
  2175. return get_lang('SessionsAdmin', '');
  2176. case DRH:
  2177. return get_lang('Drh', '');
  2178. }
  2179. }
  2180. /**
  2181. * Sets the current user as anonymous if it hasn't been identified yet. This
  2182. * function should be used inside a tool only. The function api_clear_anonymous()
  2183. * acts in the opposite direction by clearing the anonymous user's data every
  2184. * time we get on a course homepage or on a neutral page (index, admin, my space).
  2185. *
  2186. * @return bool true if set user as anonymous, false if user was already logged in or anonymous id could not be found
  2187. */
  2188. function api_set_anonymous()
  2189. {
  2190. global $_user;
  2191. if (!empty($_user['user_id'])) {
  2192. return false;
  2193. }
  2194. $user_id = api_get_anonymous_id();
  2195. if ($user_id == 0) {
  2196. return false;
  2197. }
  2198. if (isset($_user['is_anonymous'])) {
  2199. return false;
  2200. }
  2201. Session::erase('_user');
  2202. $_user['user_id'] = $user_id;
  2203. $_user['is_anonymous'] = true;
  2204. $GLOBALS['_user'] = $_user;
  2205. Session::write('_user', $_user);
  2206. return true;
  2207. }
  2208. /**
  2209. * Gets the current Chamilo (not PHP/cookie) session ID.
  2210. *
  2211. * @return int O if no active session, the session ID otherwise
  2212. */
  2213. function api_get_session_id()
  2214. {
  2215. return (int) Session::read('id_session', 0);
  2216. }
  2217. /**
  2218. * Gets the current Chamilo (not social network) group ID.
  2219. *
  2220. * @return int O if no active session, the session ID otherwise
  2221. */
  2222. function api_get_group_id()
  2223. {
  2224. return Session::read('_gid', 0);
  2225. }
  2226. /**
  2227. * Gets the current or given session name.
  2228. *
  2229. * @param int Session ID (optional)
  2230. *
  2231. * @return string The session name, or null if not found
  2232. */
  2233. function api_get_session_name($session_id = 0)
  2234. {
  2235. if (empty($session_id)) {
  2236. $session_id = api_get_session_id();
  2237. if (empty($session_id)) {
  2238. return null;
  2239. }
  2240. }
  2241. $t = Database::get_main_table(TABLE_MAIN_SESSION);
  2242. $s = "SELECT name FROM $t WHERE id = ".(int) $session_id;
  2243. $r = Database::query($s);
  2244. $c = Database::num_rows($r);
  2245. if ($c > 0) {
  2246. //technically, there can be only one, but anyway we take the first
  2247. $rec = Database::fetch_array($r);
  2248. return $rec['name'];
  2249. }
  2250. return null;
  2251. }
  2252. /**
  2253. * Gets the session info by id.
  2254. *
  2255. * @param int $id Session ID
  2256. *
  2257. * @return array information of the session
  2258. */
  2259. function api_get_session_info($id)
  2260. {
  2261. return SessionManager::fetch($id);
  2262. }
  2263. /**
  2264. * Gets the session visibility by session id.
  2265. *
  2266. * @param int $session_id
  2267. * @param int $courseId
  2268. * @param bool $ignore_visibility_for_admins
  2269. *
  2270. * @return int
  2271. * 0 = session still available,
  2272. * SESSION_VISIBLE_READ_ONLY = 1,
  2273. * SESSION_VISIBLE = 2,
  2274. * SESSION_INVISIBLE = 3
  2275. */
  2276. function api_get_session_visibility(
  2277. $session_id,
  2278. $courseId = null,
  2279. $ignore_visibility_for_admins = true
  2280. ) {
  2281. if (api_is_platform_admin()) {
  2282. if ($ignore_visibility_for_admins) {
  2283. return SESSION_AVAILABLE;
  2284. }
  2285. }
  2286. $now = time();
  2287. if (empty($session_id)) {
  2288. return 0; // Means that the session is still available.
  2289. }
  2290. $session_id = (int) $session_id;
  2291. $tbl_session = Database::get_main_table(TABLE_MAIN_SESSION);
  2292. $result = Database::query("SELECT * FROM $tbl_session WHERE id = $session_id");
  2293. if (Database::num_rows($result) <= 0) {
  2294. return SESSION_INVISIBLE;
  2295. }
  2296. $row = Database::fetch_array($result, 'ASSOC');
  2297. $visibility = $original_visibility = $row['visibility'];
  2298. // I don't care the session visibility.
  2299. if (empty($row['access_start_date']) && empty($row['access_end_date'])) {
  2300. // Session duration per student.
  2301. if (isset($row['duration']) && !empty($row['duration'])) {
  2302. $duration = $row['duration'] * 24 * 60 * 60;
  2303. $courseAccess = CourseManager::getFirstCourseAccessPerSessionAndUser($session_id, api_get_user_id());
  2304. // If there is a session duration but there is no previous
  2305. // access by the user, then the session is still available
  2306. if (count($courseAccess) == 0) {
  2307. return SESSION_AVAILABLE;
  2308. }
  2309. $currentTime = time();
  2310. $firstAccess = isset($courseAccess['login_course_date'])
  2311. ? api_strtotime($courseAccess['login_course_date'], 'UTC')
  2312. : 0;
  2313. $userDurationData = SessionManager::getUserSession(
  2314. api_get_user_id(),
  2315. $session_id
  2316. );
  2317. $userDuration = isset($userDurationData['duration'])
  2318. ? (intval($userDurationData['duration']) * 24 * 60 * 60)
  2319. : 0;
  2320. $totalDuration = $firstAccess + $duration + $userDuration;
  2321. return $totalDuration > $currentTime ? SESSION_AVAILABLE : SESSION_VISIBLE_READ_ONLY;
  2322. }
  2323. return SESSION_AVAILABLE;
  2324. }
  2325. // If start date was set.
  2326. if (!empty($row['access_start_date'])) {
  2327. $visibility = $now > api_strtotime($row['access_start_date'], 'UTC') ? SESSION_AVAILABLE : SESSION_INVISIBLE;
  2328. }
  2329. // If the end date was set.
  2330. if (!empty($row['access_end_date'])) {
  2331. // Only if date_start said that it was ok
  2332. if ($visibility === SESSION_AVAILABLE) {
  2333. $visibility = $now < api_strtotime($row['access_end_date'], 'UTC')
  2334. ? SESSION_AVAILABLE // Date still available
  2335. : $row['visibility']; // Session ends
  2336. }
  2337. }
  2338. // If I'm a coach the visibility can change in my favor depending in the coach dates.
  2339. $isCoach = api_is_coach($session_id, $courseId);
  2340. if ($isCoach) {
  2341. // Test start date.
  2342. if (!empty($row['coach_access_start_date'])) {
  2343. $start = api_strtotime($row['coach_access_start_date'], 'UTC');
  2344. $visibility = $start < $now ? SESSION_AVAILABLE : SESSION_INVISIBLE;
  2345. }
  2346. // Test end date.
  2347. if (!empty($row['coach_access_end_date'])) {
  2348. if ($visibility === SESSION_AVAILABLE) {
  2349. $endDateCoach = api_strtotime($row['coach_access_end_date'], 'UTC');
  2350. $visibility = $endDateCoach >= $now ? SESSION_AVAILABLE : $row['visibility'];
  2351. }
  2352. }
  2353. }
  2354. return $visibility;
  2355. }
  2356. /**
  2357. * This function returns a (star) session icon if the session is not null and
  2358. * the user is not a student.
  2359. *
  2360. * @param int $session_id
  2361. * @param int $status_id User status id - if 5 (student), will return empty
  2362. *
  2363. * @return string Session icon
  2364. */
  2365. function api_get_session_image($session_id, $status_id)
  2366. {
  2367. $session_id = (int) $session_id;
  2368. $session_img = '';
  2369. if ((int) $status_id != 5) { //check whether is not a student
  2370. if ($session_id > 0) {
  2371. $session_img = "&nbsp;&nbsp;".Display::return_icon(
  2372. 'star.png',
  2373. get_lang('SessionSpecificResource'),
  2374. ['align' => 'absmiddle'],
  2375. ICON_SIZE_SMALL
  2376. );
  2377. }
  2378. }
  2379. return $session_img;
  2380. }
  2381. /**
  2382. * This function add an additional condition according to the session of the course.
  2383. *
  2384. * @param int $session_id session id
  2385. * @param bool $and optional, true if more than one condition false if the only condition in the query
  2386. * @param bool $with_base_content optional, true to accept content with session=0 as well,
  2387. * false for strict session condition
  2388. * @param string $session_field
  2389. *
  2390. * @return string condition of the session
  2391. */
  2392. function api_get_session_condition(
  2393. $session_id,
  2394. $and = true,
  2395. $with_base_content = false,
  2396. $session_field = 'session_id'
  2397. ) {
  2398. $session_id = (int) $session_id;
  2399. if (empty($session_field)) {
  2400. $session_field = "session_id";
  2401. }
  2402. // Condition to show resources by session
  2403. $condition_add = $and ? " AND " : " WHERE ";
  2404. if ($with_base_content) {
  2405. $condition_session = $condition_add." ( $session_field = $session_id OR $session_field = 0 OR $session_field IS NULL) ";
  2406. } else {
  2407. if (empty($session_id)) {
  2408. $condition_session = $condition_add." ($session_field = $session_id OR $session_field IS NULL)";
  2409. } else {
  2410. $condition_session = $condition_add." $session_field = $session_id ";
  2411. }
  2412. }
  2413. return $condition_session;
  2414. }
  2415. /**
  2416. * Returns the value of a setting from the web-adjustable admin config settings.
  2417. *
  2418. * WARNING true/false are stored as string, so when comparing you need to check e.g.
  2419. * if (api_get_setting('show_navigation_menu') == 'true') //CORRECT
  2420. * instead of
  2421. * if (api_get_setting('show_navigation_menu') == true) //INCORRECT
  2422. *
  2423. * @param string $variable The variable name
  2424. * @param string $key The subkey (sub-variable) if any. Defaults to NULL
  2425. *
  2426. * @return string
  2427. *
  2428. * @author René Haentjens
  2429. * @author Bart Mollet
  2430. */
  2431. function api_get_setting($variable, $key = null)
  2432. {
  2433. global $_setting;
  2434. if ($variable == 'header_extra_content') {
  2435. $filename = api_get_home_path().'header_extra_content.txt';
  2436. if (file_exists($filename)) {
  2437. $value = file_get_contents($filename);
  2438. return $value;
  2439. } else {
  2440. return '';
  2441. }
  2442. }
  2443. if ($variable == 'footer_extra_content') {
  2444. $filename = api_get_home_path().'footer_extra_content.txt';
  2445. if (file_exists($filename)) {
  2446. $value = file_get_contents($filename);
  2447. return $value;
  2448. } else {
  2449. return '';
  2450. }
  2451. }
  2452. $value = null;
  2453. if (is_null($key)) {
  2454. $value = ((isset($_setting[$variable]) && $_setting[$variable] != '') ? $_setting[$variable] : null);
  2455. } else {
  2456. if (isset($_setting[$variable][$key])) {
  2457. $value = $_setting[$variable][$key];
  2458. }
  2459. }
  2460. return $value;
  2461. }
  2462. /**
  2463. * @param string $plugin
  2464. * @param string $variable
  2465. *
  2466. * @return string
  2467. */
  2468. function api_get_plugin_setting($plugin, $variable)
  2469. {
  2470. $variableName = $plugin.'_'.$variable;
  2471. $result = api_get_setting($variableName);
  2472. if (isset($result[$plugin])) {
  2473. $value = $result[$plugin];
  2474. $unserialized = UnserializeApi::unserialize('not_allowed_classes', $value, true);
  2475. if (false !== $unserialized) {
  2476. $value = $unserialized;
  2477. }
  2478. return $value;
  2479. }
  2480. return null;
  2481. }
  2482. /**
  2483. * Returns the value of a setting from the web-adjustable admin config settings.
  2484. */
  2485. function api_get_settings_params($params)
  2486. {
  2487. $table = Database::get_main_table(TABLE_MAIN_SETTINGS_CURRENT);
  2488. $result = Database::select('*', $table, ['where' => $params]);
  2489. return $result;
  2490. }
  2491. /**
  2492. * @param array $params example: [id = ? => '1']
  2493. *
  2494. * @return array
  2495. */
  2496. function api_get_settings_params_simple($params)
  2497. {
  2498. $table = Database::get_main_table(TABLE_MAIN_SETTINGS_CURRENT);
  2499. $result = Database::select('*', $table, ['where' => $params], 'one');
  2500. return $result;
  2501. }
  2502. /**
  2503. * Returns the value of a setting from the web-adjustable admin config settings.
  2504. */
  2505. function api_delete_settings_params($params)
  2506. {
  2507. $table = Database::get_main_table(TABLE_MAIN_SETTINGS_CURRENT);
  2508. $result = Database::delete($table, $params);
  2509. return $result;
  2510. }
  2511. /**
  2512. * Returns an escaped version of $_SERVER['PHP_SELF'] to avoid XSS injection.
  2513. *
  2514. * @return string Escaped version of $_SERVER['PHP_SELF']
  2515. */
  2516. function api_get_self()
  2517. {
  2518. return htmlentities($_SERVER['PHP_SELF']);
  2519. }
  2520. /* USER PERMISSIONS */
  2521. /**
  2522. * Checks whether current user is a platform administrator.
  2523. *
  2524. * @param bool $allowSessionAdmins Whether session admins should be considered admins or not
  2525. * @param bool $allowDrh Whether HR directors should be considered admins or not
  2526. *
  2527. * @return bool true if the user has platform admin rights,
  2528. * false otherwise
  2529. *
  2530. * @see usermanager::is_admin(user_id) for a user-id specific function
  2531. */
  2532. function api_is_platform_admin($allowSessionAdmins = false, $allowDrh = false)
  2533. {
  2534. $isAdmin = Session::read('is_platformAdmin');
  2535. if ($isAdmin) {
  2536. return true;
  2537. }
  2538. $user = api_get_user_info();
  2539. return
  2540. isset($user['status']) &&
  2541. (
  2542. ($allowSessionAdmins && $user['status'] == SESSIONADMIN) ||
  2543. ($allowDrh && $user['status'] == DRH)
  2544. );
  2545. }
  2546. /**
  2547. * Checks whether the user given as user id is in the admin table.
  2548. *
  2549. * @param int $user_id If none provided, will use current user
  2550. * @param int $url URL ID. If provided, also check if the user is active on given URL
  2551. *
  2552. * @return bool True if the user is admin, false otherwise
  2553. */
  2554. function api_is_platform_admin_by_id($user_id = null, $url = null)
  2555. {
  2556. $user_id = (int) $user_id;
  2557. if (empty($user_id)) {
  2558. $user_id = api_get_user_id();
  2559. }
  2560. $admin_table = Database::get_main_table(TABLE_MAIN_ADMIN);
  2561. $sql = "SELECT * FROM $admin_table WHERE user_id = $user_id";
  2562. $res = Database::query($sql);
  2563. $is_admin = Database::num_rows($res) === 1;
  2564. if (!$is_admin || !isset($url)) {
  2565. return $is_admin;
  2566. }
  2567. // We get here only if $url is set
  2568. $url = (int) $url;
  2569. $url_user_table = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_USER);
  2570. $sql = "SELECT * FROM $url_user_table
  2571. WHERE access_url_id = $url AND user_id = $user_id";
  2572. $res = Database::query($sql);
  2573. $result = Database::num_rows($res) === 1;
  2574. return $result;
  2575. }
  2576. /**
  2577. * Returns the user's numeric status ID from the users table.
  2578. *
  2579. * @param int $user_id If none provided, will use current user
  2580. *
  2581. * @return int User's status (1 for teacher, 5 for student, etc)
  2582. */
  2583. function api_get_user_status($user_id = null)
  2584. {
  2585. $user_id = (int) $user_id;
  2586. if (empty($user_id)) {
  2587. $user_id = api_get_user_id();
  2588. }
  2589. $table = Database::get_main_table(TABLE_MAIN_USER);
  2590. $sql = "SELECT status FROM $table WHERE user_id = $user_id ";
  2591. $result = Database::query($sql);
  2592. $status = null;
  2593. if (Database::num_rows($result)) {
  2594. $row = Database::fetch_array($result);
  2595. $status = $row['status'];
  2596. }
  2597. return $status;
  2598. }
  2599. /**
  2600. * Checks whether current user is allowed to create courses.
  2601. *
  2602. * @return bool true if the user has course creation rights,
  2603. * false otherwise
  2604. */
  2605. function api_is_allowed_to_create_course()
  2606. {
  2607. if (api_is_platform_admin()) {
  2608. return true;
  2609. }
  2610. // Teachers can only create courses
  2611. if (api_is_teacher()) {
  2612. if (api_get_setting('allow_users_to_create_courses') === 'true') {
  2613. return true;
  2614. } else {
  2615. return false;
  2616. }
  2617. }
  2618. return Session::read('is_allowedCreateCourse');
  2619. }
  2620. /**
  2621. * Checks whether the current user is a course administrator.
  2622. *
  2623. * @return bool True if current user is a course administrator
  2624. */
  2625. function api_is_course_admin()
  2626. {
  2627. if (api_is_platform_admin()) {
  2628. return true;
  2629. }
  2630. return Session::read('is_courseAdmin');
  2631. }
  2632. /**
  2633. * Checks whether the current user is a course coach
  2634. * Based on the presence of user in session.id_coach (session general coach).
  2635. *
  2636. * @return bool True if current user is a course coach
  2637. */
  2638. function api_is_session_general_coach()
  2639. {
  2640. return Session::read('is_session_general_coach');
  2641. }
  2642. /**
  2643. * Checks whether the current user is a course tutor
  2644. * Based on the presence of user in session_rel_course_rel_user.user_id with status = 2.
  2645. *
  2646. * @return bool True if current user is a course tutor
  2647. */
  2648. function api_is_course_tutor()
  2649. {
  2650. return Session::read('is_courseTutor');
  2651. }
  2652. /**
  2653. * @param int $user_id
  2654. * @param int $courseId
  2655. * @param int $session_id
  2656. *
  2657. * @return bool
  2658. */
  2659. function api_is_course_session_coach($user_id, $courseId, $session_id)
  2660. {
  2661. $session_table = Database::get_main_table(TABLE_MAIN_SESSION);
  2662. $session_rel_course_rel_user_table = Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER);
  2663. $user_id = (int) $user_id;
  2664. $session_id = (int) $session_id;
  2665. $courseId = (int) $courseId;
  2666. $sql = "SELECT DISTINCT session.id
  2667. FROM $session_table
  2668. INNER JOIN $session_rel_course_rel_user_table session_rc_ru
  2669. ON session.id = session_rc_ru.session_id
  2670. WHERE
  2671. session_rc_ru.user_id = '".$user_id."' AND
  2672. session_rc_ru.c_id = '$courseId' AND
  2673. session_rc_ru.status = 2 AND
  2674. session_rc_ru.session_id = '$session_id'";
  2675. $result = Database::query($sql);
  2676. return Database::num_rows($result) > 0;
  2677. }
  2678. /**
  2679. * Checks whether the current user is a course or session coach.
  2680. *
  2681. * @param int $session_id
  2682. * @param int $courseId
  2683. * @param bool Check whether we are in student view and, if we are, return false
  2684. *
  2685. * @return bool True if current user is a course or session coach
  2686. */
  2687. function api_is_coach($session_id = 0, $courseId = null, $check_student_view = true)
  2688. {
  2689. $userId = api_get_user_id();
  2690. if (!empty($session_id)) {
  2691. $session_id = (int) $session_id;
  2692. } else {
  2693. $session_id = api_get_session_id();
  2694. }
  2695. // The student preview was on
  2696. if ($check_student_view && api_is_student_view_active()) {
  2697. return false;
  2698. }
  2699. if (!empty($courseId)) {
  2700. $courseId = (int) $courseId;
  2701. } else {
  2702. $courseId = api_get_course_int_id();
  2703. }
  2704. $session_table = Database::get_main_table(TABLE_MAIN_SESSION);
  2705. $session_rel_course_rel_user_table = Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER);
  2706. $sessionIsCoach = [];
  2707. if (!empty($courseId)) {
  2708. $sql = "SELECT DISTINCT s.id, name, access_start_date, access_end_date
  2709. FROM $session_table s
  2710. INNER JOIN $session_rel_course_rel_user_table session_rc_ru
  2711. ON session_rc_ru.session_id = s.id AND session_rc_ru.user_id = '".$userId."'
  2712. WHERE
  2713. session_rc_ru.c_id = '$courseId' AND
  2714. session_rc_ru.status = 2 AND
  2715. session_rc_ru.session_id = '$session_id'";
  2716. $result = Database::query($sql);
  2717. $sessionIsCoach = Database::store_result($result);
  2718. }
  2719. if (!empty($session_id)) {
  2720. $sql = "SELECT DISTINCT id, name, access_start_date, access_end_date
  2721. FROM $session_table
  2722. WHERE session.id_coach = $userId AND id = $session_id
  2723. ORDER BY access_start_date, access_end_date, name";
  2724. $result = Database::query($sql);
  2725. if (!empty($sessionIsCoach)) {
  2726. $sessionIsCoach = array_merge(
  2727. $sessionIsCoach,
  2728. Database::store_result($result)
  2729. );
  2730. } else {
  2731. $sessionIsCoach = Database::store_result($result);
  2732. }
  2733. }
  2734. return count($sessionIsCoach) > 0;
  2735. }
  2736. /**
  2737. * Checks whether the current user is a session administrator.
  2738. *
  2739. * @return bool True if current user is a course administrator
  2740. */
  2741. function api_is_session_admin()
  2742. {
  2743. $user = api_get_user_info();
  2744. return isset($user['status']) && $user['status'] == SESSIONADMIN;
  2745. }
  2746. /**
  2747. * Checks whether the current user is a human resources manager.
  2748. *
  2749. * @return bool True if current user is a human resources manager
  2750. */
  2751. function api_is_drh()
  2752. {
  2753. $user = api_get_user_info();
  2754. return isset($user['status']) && $user['status'] == DRH;
  2755. }
  2756. /**
  2757. * Checks whether the current user is a student.
  2758. *
  2759. * @return bool True if current user is a human resources manager
  2760. */
  2761. function api_is_student()
  2762. {
  2763. $user = api_get_user_info();
  2764. return isset($user['status']) && $user['status'] == STUDENT;
  2765. }
  2766. /**
  2767. * Checks whether the current user has the status 'teacher'.
  2768. *
  2769. * @return bool True if current user is a human resources manager
  2770. */
  2771. function api_is_teacher()
  2772. {
  2773. $user = api_get_user_info();
  2774. return isset($user['status']) && $user['status'] == COURSEMANAGER;
  2775. }
  2776. /**
  2777. * Checks whether the current user is a invited user.
  2778. *
  2779. * @return bool
  2780. */
  2781. function api_is_invitee()
  2782. {
  2783. $user = api_get_user_info();
  2784. return isset($user['status']) && $user['status'] == INVITEE;
  2785. }
  2786. /**
  2787. * This function checks whether a session is assigned into a category.
  2788. *
  2789. * @param int - session id
  2790. * @param string - category name
  2791. *
  2792. * @return bool - true if is found, otherwise false
  2793. */
  2794. function api_is_session_in_category($session_id, $category_name)
  2795. {
  2796. $session_id = (int) $session_id;
  2797. $category_name = Database::escape_string($category_name);
  2798. $tbl_session = Database::get_main_table(TABLE_MAIN_SESSION);
  2799. $tbl_session_category = Database::get_main_table(TABLE_MAIN_SESSION_CATEGORY);
  2800. $sql = "SELECT 1
  2801. FROM $tbl_session
  2802. WHERE $session_id IN (
  2803. SELECT s.id FROM $tbl_session s, $tbl_session_category sc
  2804. WHERE
  2805. s.session_category_id = sc.id AND
  2806. sc.name LIKE '%$category_name'
  2807. )";
  2808. $rs = Database::query($sql);
  2809. if (Database::num_rows($rs) > 0) {
  2810. return true;
  2811. } else {
  2812. return false;
  2813. }
  2814. }
  2815. /**
  2816. * Displays the title of a tool.
  2817. * Normal use: parameter is a string:
  2818. * api_display_tool_title("My Tool").
  2819. *
  2820. * Optionally, there can be a subtitle below
  2821. * the normal title, and / or a supra title above the normal title.
  2822. *
  2823. * e.g. supra title:
  2824. * group
  2825. * GROUP PROPERTIES
  2826. *
  2827. * e.g. subtitle:
  2828. * AGENDA
  2829. * calender & events tool
  2830. *
  2831. * @author Hugues Peeters <hugues.peeters@claroline.net>
  2832. *
  2833. * @param mixed $title_element - it could either be a string or an array
  2834. * containing 'supraTitle', 'mainTitle',
  2835. * 'subTitle'
  2836. */
  2837. function api_display_tool_title($title_element)
  2838. {
  2839. if (is_string($title_element)) {
  2840. $tit = $title_element;
  2841. unset($title_element);
  2842. $title_element['mainTitle'] = $tit;
  2843. }
  2844. echo '<h3>';
  2845. if (!empty($title_element['supraTitle'])) {
  2846. echo '<small>'.$title_element['supraTitle'].'</small><br />';
  2847. }
  2848. if (!empty($title_element['mainTitle'])) {
  2849. echo $title_element['mainTitle'];
  2850. }
  2851. if (!empty($title_element['subTitle'])) {
  2852. echo '<br /><small>'.$title_element['subTitle'].'</small>';
  2853. }
  2854. echo '</h3>';
  2855. }
  2856. /**
  2857. * Displays options for switching between student view and course manager view.
  2858. *
  2859. * Changes in version 1.2 (Patrick Cool)
  2860. * Student view switch now behaves as a real switch. It maintains its current state until the state
  2861. * is changed explicitly
  2862. *
  2863. * Changes in version 1.1 (Patrick Cool)
  2864. * student view now works correctly in subfolders of the document tool
  2865. * student view works correctly in the new links tool
  2866. *
  2867. * Example code for using this in your tools:
  2868. * //if ($is_courseAdmin && api_get_setting('student_view_enabled') == 'true') {
  2869. * // display_tool_view_option($isStudentView);
  2870. * //}
  2871. * //and in later sections, use api_is_allowed_to_edit()
  2872. *
  2873. * @author Roan Embrechts
  2874. * @author Patrick Cool
  2875. * @author Julio Montoya, changes added in Chamilo
  2876. *
  2877. * @version 1.2
  2878. *
  2879. * @todo rewrite code so it is easier to understand
  2880. */
  2881. function api_display_tool_view_option()
  2882. {
  2883. if (api_get_setting('student_view_enabled') != 'true') {
  2884. return '';
  2885. }
  2886. $sourceurl = '';
  2887. $is_framed = false;
  2888. // Exceptions apply for all multi-frames pages
  2889. if (strpos($_SERVER['REQUEST_URI'], 'chat/chat_banner.php') !== false) {
  2890. // The chat is a multiframe bit that doesn't work too well with the student_view, so do not show the link
  2891. return '';
  2892. }
  2893. // Uncomment to remove student view link from document view page
  2894. if (strpos($_SERVER['REQUEST_URI'], 'lp/lp_header.php') !== false) {
  2895. if (empty($_GET['lp_id'])) {
  2896. return '';
  2897. }
  2898. $sourceurl = substr($_SERVER['REQUEST_URI'], 0, strpos($_SERVER['REQUEST_URI'], '?'));
  2899. $sourceurl = str_replace(
  2900. 'lp/lp_header.php',
  2901. 'lp/lp_controller.php?'.api_get_cidreq().'&action=view&lp_id='.intval($_GET['lp_id']).'&isStudentView='.($_SESSION['studentview'] == 'studentview' ? 'false' : 'true'),
  2902. $sourceurl
  2903. );
  2904. //showinframes doesn't handle student view anyway...
  2905. //return '';
  2906. $is_framed = true;
  2907. }
  2908. // Check whether the $_SERVER['REQUEST_URI'] contains already url parameters (thus a questionmark)
  2909. if (!$is_framed) {
  2910. if (strpos($_SERVER['REQUEST_URI'], '?') === false) {
  2911. $sourceurl = api_get_self().'?'.api_get_cidreq();
  2912. } else {
  2913. $sourceurl = $_SERVER['REQUEST_URI'];
  2914. }
  2915. }
  2916. $output_string = '';
  2917. if (!empty($_SESSION['studentview'])) {
  2918. if ($_SESSION['studentview'] == 'studentview') {
  2919. // We have to remove the isStudentView=true from the $sourceurl
  2920. $sourceurl = str_replace('&isStudentView=true', '', $sourceurl);
  2921. $sourceurl = str_replace('&isStudentView=false', '', $sourceurl);
  2922. $output_string .= '<a class="btn btn-primary btn-sm" href="'.$sourceurl.'&isStudentView=false" target="_self">'.
  2923. Display::returnFontAwesomeIcon('eye').' '.get_lang('SwitchToTeacherView').'</a>';
  2924. } elseif ($_SESSION['studentview'] == 'teacherview') {
  2925. // Switching to teacherview
  2926. $sourceurl = str_replace('&isStudentView=true', '', $sourceurl);
  2927. $sourceurl = str_replace('&isStudentView=false', '', $sourceurl);
  2928. $output_string .= '<a class="btn btn-default btn-sm" href="'.$sourceurl.'&isStudentView=true" target="_self">'.
  2929. Display::returnFontAwesomeIcon('eye').' '.get_lang('SwitchToStudentView').'</a>';
  2930. }
  2931. } else {
  2932. $output_string .= '<a class="btn btn-default btn-sm" href="'.$sourceurl.'&isStudentView=true" target="_self">'.
  2933. Display::returnFontAwesomeIcon('eye').' '.get_lang('SwitchToStudentView').'</a>';
  2934. }
  2935. $output_string = Security::remove_XSS($output_string);
  2936. $html = Display::tag('div', $output_string, ['class' => 'view-options']);
  2937. return $html;
  2938. }
  2939. // TODO: This is for the permission section.
  2940. /**
  2941. * Function that removes the need to directly use is_courseAdmin global in
  2942. * tool scripts. It returns true or false depending on the user's rights in
  2943. * this particular course.
  2944. * Optionally checking for tutor and coach roles here allows us to use the
  2945. * student_view feature altogether with these roles as well.
  2946. *
  2947. * @param bool Whether to check if the user has the tutor role
  2948. * @param bool Whether to check if the user has the coach role
  2949. * @param bool Whether to check if the user has the session coach role
  2950. * @param bool check the student view or not
  2951. *
  2952. * @author Roan Embrechts
  2953. * @author Patrick Cool
  2954. * @author Julio Montoya
  2955. *
  2956. * @version 1.1, February 2004
  2957. *
  2958. * @return bool true: the user has the rights to edit, false: he does not
  2959. */
  2960. function api_is_allowed_to_edit(
  2961. $tutor = false,
  2962. $coach = false,
  2963. $session_coach = false,
  2964. $check_student_view = true
  2965. ) {
  2966. $allowSessionAdminEdit = api_get_configuration_value('session_admins_edit_courses_content') === true;
  2967. // Admins can edit anything.
  2968. if (api_is_platform_admin($allowSessionAdminEdit)) {
  2969. //The student preview was on
  2970. if ($check_student_view && api_is_student_view_active()) {
  2971. return false;
  2972. } else {
  2973. return true;
  2974. }
  2975. }
  2976. $sessionId = api_get_session_id();
  2977. if ($sessionId && api_get_configuration_value('session_courses_read_only_mode')) {
  2978. $efv = new ExtraFieldValue('course');
  2979. $lockExrafieldField = $efv->get_values_by_handler_and_field_variable(
  2980. api_get_course_int_id(),
  2981. 'session_courses_read_only_mode'
  2982. );
  2983. if (!empty($lockExrafieldField['value'])) {
  2984. return false;
  2985. }
  2986. }
  2987. $is_allowed_coach_to_edit = api_is_coach(null, null, $check_student_view);
  2988. $session_visibility = api_get_session_visibility($sessionId);
  2989. $is_courseAdmin = api_is_course_admin();
  2990. if (!$is_courseAdmin && $tutor) {
  2991. // If we also want to check if the user is a tutor...
  2992. $is_courseAdmin = $is_courseAdmin || api_is_course_tutor();
  2993. }
  2994. if (!$is_courseAdmin && $coach) {
  2995. // If we also want to check if the user is a coach...';
  2996. // Check if session visibility is read only for coaches.
  2997. if ($session_visibility == SESSION_VISIBLE_READ_ONLY) {
  2998. $is_allowed_coach_to_edit = false;
  2999. }
  3000. if (api_get_setting('allow_coach_to_edit_course_session') == 'true') {
  3001. // Check if coach is allowed to edit a course.
  3002. $is_courseAdmin = $is_courseAdmin || $is_allowed_coach_to_edit;
  3003. }
  3004. }
  3005. if (!$is_courseAdmin && $session_coach) {
  3006. $is_courseAdmin = $is_courseAdmin || $is_allowed_coach_to_edit;
  3007. }
  3008. // Check if the student_view is enabled, and if so, if it is activated.
  3009. if (api_get_setting('student_view_enabled') == 'true') {
  3010. if (!empty($sessionId)) {
  3011. // Check if session visibility is read only for coaches.
  3012. if ($session_visibility == SESSION_VISIBLE_READ_ONLY) {
  3013. $is_allowed_coach_to_edit = false;
  3014. }
  3015. if (api_get_setting('allow_coach_to_edit_course_session') == 'true') {
  3016. // Check if coach is allowed to edit a course.
  3017. $is_allowed = $is_allowed_coach_to_edit;
  3018. } else {
  3019. $is_allowed = false;
  3020. }
  3021. if ($check_student_view) {
  3022. $is_allowed = $is_allowed && $_SESSION['studentview'] != 'studentview';
  3023. }
  3024. } else {
  3025. if ($check_student_view) {
  3026. $is_allowed = $is_courseAdmin && $_SESSION['studentview'] != 'studentview';
  3027. } else {
  3028. $is_allowed = $is_courseAdmin;
  3029. }
  3030. }
  3031. return $is_allowed;
  3032. } else {
  3033. return $is_courseAdmin;
  3034. }
  3035. }
  3036. /**
  3037. * Returns true if user is a course coach of at least one course in session.
  3038. *
  3039. * @param int $sessionId
  3040. *
  3041. * @return bool
  3042. */
  3043. function api_is_coach_of_course_in_session($sessionId)
  3044. {
  3045. if (api_is_platform_admin()) {
  3046. return true;
  3047. }
  3048. $userId = api_get_user_id();
  3049. $courseList = UserManager::get_courses_list_by_session(
  3050. $userId,
  3051. $sessionId
  3052. );
  3053. // Session visibility.
  3054. $visibility = api_get_session_visibility(
  3055. $sessionId,
  3056. null,
  3057. false
  3058. );
  3059. if ($visibility != SESSION_VISIBLE && !empty($courseList)) {
  3060. // Course Coach session visibility.
  3061. $blockedCourseCount = 0;
  3062. $closedVisibilityList = [
  3063. COURSE_VISIBILITY_CLOSED,
  3064. COURSE_VISIBILITY_HIDDEN,
  3065. ];
  3066. foreach ($courseList as $course) {
  3067. // Checking session visibility
  3068. $sessionCourseVisibility = api_get_session_visibility(
  3069. $sessionId,
  3070. $course['real_id']
  3071. );
  3072. $courseIsVisible = !in_array(
  3073. $course['visibility'],
  3074. $closedVisibilityList
  3075. );
  3076. if ($courseIsVisible === false || $sessionCourseVisibility == SESSION_INVISIBLE) {
  3077. $blockedCourseCount++;
  3078. }
  3079. }
  3080. // If all courses are blocked then no show in the list.
  3081. if ($blockedCourseCount === count($courseList)) {
  3082. $visibility = SESSION_INVISIBLE;
  3083. } else {
  3084. $visibility = SESSION_VISIBLE;
  3085. }
  3086. }
  3087. switch ($visibility) {
  3088. case SESSION_VISIBLE_READ_ONLY:
  3089. case SESSION_VISIBLE:
  3090. case SESSION_AVAILABLE:
  3091. return true;
  3092. break;
  3093. case SESSION_INVISIBLE:
  3094. return false;
  3095. }
  3096. return false;
  3097. }
  3098. /**
  3099. * Checks if a student can edit contents in a session depending
  3100. * on the session visibility.
  3101. *
  3102. * @param bool $tutor Whether to check if the user has the tutor role
  3103. * @param bool $coach Whether to check if the user has the coach role
  3104. *
  3105. * @return bool true: the user has the rights to edit, false: he does not
  3106. */
  3107. function api_is_allowed_to_session_edit($tutor = false, $coach = false)
  3108. {
  3109. if (api_is_allowed_to_edit($tutor, $coach)) {
  3110. // If I'm a teacher, I will return true in order to not affect the normal behaviour of Chamilo tools.
  3111. return true;
  3112. } else {
  3113. $sessionId = api_get_session_id();
  3114. if ($sessionId == 0) {
  3115. // I'm not in a session so i will return true to not affect the normal behaviour of Chamilo tools.
  3116. return true;
  3117. } else {
  3118. // I'm in a session and I'm a student
  3119. // Get the session visibility
  3120. $session_visibility = api_get_session_visibility($sessionId);
  3121. // if 5 the session is still available
  3122. switch ($session_visibility) {
  3123. case SESSION_VISIBLE_READ_ONLY: // 1
  3124. return false;
  3125. case SESSION_VISIBLE: // 2
  3126. return true;
  3127. case SESSION_INVISIBLE: // 3
  3128. return false;
  3129. case SESSION_AVAILABLE: //5
  3130. return true;
  3131. }
  3132. }
  3133. }
  3134. }
  3135. /**
  3136. * Checks whether the user is allowed in a specific tool for a specific action.
  3137. *
  3138. * @param string $tool the tool we are checking if the user has a certain permission
  3139. * @param string $action the action we are checking (add, edit, delete, move, visibility)
  3140. *
  3141. * @return bool
  3142. *
  3143. * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
  3144. * @author Julio Montoya
  3145. *
  3146. * @version 1.0
  3147. */
  3148. function api_is_allowed($tool, $action, $task_id = 0)
  3149. {
  3150. $_user = api_get_user_info();
  3151. $_course = api_get_course_info();
  3152. if (api_is_course_admin()) {
  3153. return true;
  3154. }
  3155. if (is_array($_course) and count($_course) > 0) {
  3156. require_once api_get_path(SYS_CODE_PATH).'permissions/permissions_functions.inc.php';
  3157. // Getting the permissions of this user.
  3158. if ($task_id == 0) {
  3159. $user_permissions = get_permissions('user', $_user['user_id']);
  3160. $_SESSION['total_permissions'][$_course['code']] = $user_permissions;
  3161. }
  3162. // Getting the permissions of the task.
  3163. if ($task_id != 0) {
  3164. $task_permissions = get_permissions('task', $task_id);
  3165. /* !!! */$_SESSION['total_permissions'][$_course['code']] = $task_permissions;
  3166. }
  3167. //print_r($_SESSION['total_permissions']);
  3168. // Getting the permissions of the groups of the user
  3169. //$groups_of_user = GroupManager::get_group_ids($_course['db_name'], $_user['user_id']);
  3170. //foreach($groups_of_user as $group)
  3171. // $this_group_permissions = get_permissions('group', $group);
  3172. // Getting the permissions of the courseroles of the user
  3173. $user_courserole_permissions = get_roles_permissions('user', $_user['user_id']);
  3174. // Getting the permissions of the platformroles of the user
  3175. //$user_platformrole_permissions = get_roles_permissions('user', $_user['user_id'], ', platform');
  3176. // Getting the permissions of the roles of the groups of the user
  3177. //foreach($groups_of_user as $group)
  3178. // $this_group_courserole_permissions = get_roles_permissions('group', $group);
  3179. // Getting the permissions of the platformroles of the groups of the user
  3180. //foreach($groups_of_user as $group)
  3181. // $this_group_platformrole_permissions = get_roles_permissions('group', $group, 'platform');
  3182. }
  3183. // If the permissions are limited, we have to map the extended ones to the limited ones.
  3184. if (api_get_setting('permissions') == 'limited') {
  3185. if ($action == 'Visibility') {
  3186. $action = 'Edit';
  3187. }
  3188. if ($action == 'Move') {
  3189. $action = 'Edit';
  3190. }
  3191. }
  3192. // The session that contains all the permissions already exists for this course
  3193. // so there is no need to requery everything.
  3194. //my_print_r($_SESSION['total_permissions'][$_course['code']][$tool]);
  3195. if (is_array($_SESSION['total_permissions'][$_course['code']][$tool])) {
  3196. if (in_array($action, $_SESSION['total_permissions'][$_course['code']][$tool])) {
  3197. return true;
  3198. } else {
  3199. return false;
  3200. }
  3201. }
  3202. }
  3203. /**
  3204. * Tells whether this user is an anonymous user.
  3205. *
  3206. * @param int $user_id User ID (optional, will take session ID if not provided)
  3207. * @param bool $db_check Whether to check in the database (true) or simply in
  3208. * the session (false) to see if the current user is the anonymous user
  3209. *
  3210. * @return bool true if this user is anonymous, false otherwise
  3211. */
  3212. function api_is_anonymous($user_id = null, $db_check = false)
  3213. {
  3214. if (!isset($user_id)) {
  3215. $user_id = api_get_user_id();
  3216. }
  3217. if ($db_check) {
  3218. $info = api_get_user_info($user_id);
  3219. if ($info['status'] == ANONYMOUS) {
  3220. return true;
  3221. }
  3222. }
  3223. $_user = api_get_user_info();
  3224. if (isset($_user['status']) && $_user['status'] == ANONYMOUS) {
  3225. //if ($_user['user_id'] == 0) {
  3226. // In some cases, api_set_anonymous doesn't seem to be triggered in local.inc.php. Make sure it is.
  3227. // Occurs in agenda for admin links - YW
  3228. global $use_anonymous;
  3229. if (isset($use_anonymous) && $use_anonymous) {
  3230. api_set_anonymous();
  3231. }
  3232. return true;
  3233. }
  3234. return (isset($_user['is_anonymous']) && $_user['is_anonymous'] === true) || $_user === false;
  3235. }
  3236. /**
  3237. * Displays message "You are not allowed here..." and exits the entire script.
  3238. *
  3239. * @param bool $print_headers Whether or not to print headers (default = false -> does not print them)
  3240. * @param string $message
  3241. * @param int $responseCode
  3242. */
  3243. function api_not_allowed(
  3244. $print_headers = false,
  3245. $message = null,
  3246. $responseCode = 0
  3247. ) {
  3248. if (api_get_setting('sso_authentication') === 'true') {
  3249. global $osso;
  3250. if ($osso) {
  3251. $osso->logout();
  3252. }
  3253. }
  3254. $home_url = api_get_path(WEB_PATH);
  3255. $user_id = api_get_user_id();
  3256. $course = api_get_course_id();
  3257. global $this_section;
  3258. if (CustomPages::enabled() && !isset($user_id)) {
  3259. if (empty($user_id)) {
  3260. // Why the CustomPages::enabled() need to be to set the request_uri
  3261. $_SESSION['request_uri'] = $_SERVER['REQUEST_URI'];
  3262. }
  3263. CustomPages::display(CustomPages::INDEX_UNLOGGED);
  3264. }
  3265. $origin = api_get_origin();
  3266. $msg = null;
  3267. if (isset($message)) {
  3268. $msg = $message;
  3269. } else {
  3270. $msg = Display::return_message(
  3271. get_lang('NotAllowedClickBack').'
  3272. <script>function goBack(){window.history.back();}</script>',
  3273. 'error',
  3274. false
  3275. );
  3276. $msg .= '<p class="text-center">
  3277. <a onclick="goBack();" class="btn btn-default" href="'.$home_url.'">'.get_lang('GoBack').'</a>
  3278. </p>';
  3279. }
  3280. $msg = Display::div($msg, ['align' => 'center']);
  3281. $show_headers = 0;
  3282. if ($print_headers && $origin != 'learnpath') {
  3283. $show_headers = 1;
  3284. }
  3285. $tpl = new Template(null, $show_headers, $show_headers, false, true, false, true, $responseCode);
  3286. $tpl->assign('hide_login_link', 1);
  3287. $tpl->assign('content', $msg);
  3288. if (($user_id != 0 && !api_is_anonymous()) &&
  3289. (!isset($course) || $course == -1) &&
  3290. empty($_GET['cidReq'])
  3291. ) {
  3292. // if the access is not authorized and there is some login information
  3293. // but the cidReq is not found, assume we are missing course data and send the user
  3294. // to the user_portal
  3295. $tpl->display_one_col_template();
  3296. exit;
  3297. }
  3298. if (!empty($_SERVER['REQUEST_URI']) &&
  3299. (
  3300. !empty($_GET['cidReq']) ||
  3301. $this_section == SECTION_MYPROFILE ||
  3302. $this_section == SECTION_PLATFORM_ADMIN
  3303. )
  3304. ) {
  3305. $courseCode = api_get_course_id();
  3306. // Only display form and return to the previous URL if there was a course ID included
  3307. if ($user_id != 0 && !api_is_anonymous()) {
  3308. //if there is a user ID, then the user is not allowed but the session is still there. Say so and exit
  3309. $tpl->assign('content', $msg);
  3310. $tpl->display_one_col_template();
  3311. exit;
  3312. }
  3313. if (!is_null($courseCode)) {
  3314. api_set_firstpage_parameter($courseCode);
  3315. }
  3316. // If the user has no user ID, then his session has expired
  3317. $form = api_get_not_allowed_login_form();
  3318. // see same text in auth/gotocourse.php and main_api.lib.php function api_not_allowed (above)
  3319. $content = Display::return_message(get_lang('NotAllowed'), 'error', false);
  3320. if (!empty($courseCode)) {
  3321. $content .= '<h4>'.get_lang('LoginToGoToThisCourse').'</h4>';
  3322. }
  3323. if (api_is_cas_activated()) {
  3324. $content .= Display::return_message(sprintf(get_lang('YouHaveAnInstitutionalAccount'), api_get_setting("Institution")), '', false);
  3325. $content .= Display::div(
  3326. "<br/><a href='".get_cas_direct_URL(api_get_course_id())."'>".sprintf(get_lang('LoginWithYourAccount'), api_get_setting("Institution"))."</a><br/><br/>",
  3327. ['align' => 'center']
  3328. );
  3329. $content .= Display::return_message(get_lang('YouDontHaveAnInstitutionAccount'));
  3330. $content .= "<p style='text-align:center'><a href='#' onclick='$(this).parent().next().toggle()'>".get_lang('LoginWithExternalAccount')."</a></p>";
  3331. $content .= "<div style='display:none;'>";
  3332. }
  3333. $content .= '<div class="well">';
  3334. $content .= $form->returnForm();
  3335. $content .= '</div>';
  3336. if (api_is_cas_activated()) {
  3337. $content .= "</div>";
  3338. }
  3339. if (!empty($courseCode)) {
  3340. $content .= '<hr/><p style="text-align:center"><a href="'.$home_url.'">'.
  3341. get_lang('ReturnToCourseHomepage').'</a></p>';
  3342. } else {
  3343. $content .= '<hr/><p style="text-align:center"><a href="'.$home_url.'">'.
  3344. get_lang('BackHome').'</a></p>';
  3345. }
  3346. $tpl->setLoginBodyClass();
  3347. $tpl->assign('content', $content);
  3348. $tpl->display_one_col_template();
  3349. exit;
  3350. }
  3351. if ($user_id != 0 && !api_is_anonymous()) {
  3352. $tpl->display_one_col_template();
  3353. exit;
  3354. }
  3355. $msg = null;
  3356. // The session is over and we were not in a course,
  3357. // or we try to get directly to a private course without being logged
  3358. $courseId = api_get_course_int_id();
  3359. if (!empty($courseId)) {
  3360. api_set_firstpage_parameter(api_get_course_id());
  3361. $tpl->setLoginBodyClass();
  3362. // see same text in auth/gotocourse.php and main_api.lib.php function api_not_allowed (bellow)
  3363. $msg = Display::return_message(get_lang('NotAllowed'), 'error', false);
  3364. $msg .= '<h4>'.get_lang('LoginToGoToThisCourse').'</h4>';
  3365. $casEnabled = api_is_cas_activated();
  3366. if ($casEnabled) {
  3367. $msg .= Display::return_message(
  3368. sprintf(get_lang('YouHaveAnInstitutionalAccount'), api_get_setting("Institution")),
  3369. '',
  3370. false
  3371. );
  3372. $msg .= Display::div("<br/><a href='".get_cas_direct_URL(api_get_course_int_id())."'>".getCASLogoHTML()." ".sprintf(get_lang('LoginWithYourAccount'), api_get_setting("Institution"))."</a><br/><br/>", ['align' => 'center']);
  3373. $msg .= Display::return_message(get_lang('YouDontHaveAnInstitutionAccount'));
  3374. $msg .= "<p style='text-align:center'><a href='#' onclick='$(this).parent().next().toggle()'>".get_lang('LoginWithExternalAccount')."</a></p>";
  3375. $msg .= "<div style='display:none;'>";
  3376. }
  3377. $form = api_get_not_allowed_login_form();
  3378. $msg .= '<div class="well">';
  3379. $msg .= $form->returnForm();
  3380. $msg .= '</div>';
  3381. if ($casEnabled) {
  3382. $msg .= "</div>";
  3383. }
  3384. } else {
  3385. // we were not in a course, return to home page
  3386. $msg = Display::return_message(
  3387. get_lang('NotAllowed'),
  3388. 'error',
  3389. false
  3390. );
  3391. $msg .= '<p class="text-center">
  3392. <a class="btn btn-default" href="'.$home_url.'">'.get_lang('BackHome').'</a>
  3393. </p>';
  3394. if (!empty($message)) {
  3395. $msg = $message;
  3396. }
  3397. if (api_is_anonymous()) {
  3398. $form = api_get_not_allowed_login_form();
  3399. $msg .= '<div class="well">';
  3400. $msg .= $form->returnForm();
  3401. $msg .= '</div>';
  3402. }
  3403. }
  3404. $tpl->assign('content', $msg);
  3405. $tpl->display_one_col_template();
  3406. exit;
  3407. }
  3408. /**
  3409. * @return FormValidator
  3410. */
  3411. function api_get_not_allowed_login_form()
  3412. {
  3413. $action = api_get_self().'?'.Security::remove_XSS($_SERVER['QUERY_STRING']);
  3414. $action = str_replace('&amp;', '&', $action);
  3415. Session::write('redirect_after_not_allow_page', $action);
  3416. $action .= '&redirect_after_not_allow_page=1';
  3417. $form = new FormValidator(
  3418. 'formLogin',
  3419. 'post',
  3420. $action,
  3421. null,
  3422. ['class' => 'form-stacked']
  3423. );
  3424. $params = [
  3425. 'placeholder' => get_lang('UserName'),
  3426. 'class' => 'col-md-3',
  3427. ];
  3428. if (api_browser_support('autocapitalize')) {
  3429. $params['autocapitalize'] = 'none';
  3430. }
  3431. $form->addElement(
  3432. 'text',
  3433. 'login',
  3434. null,
  3435. $params
  3436. );
  3437. $form->addElement(
  3438. 'password',
  3439. 'password',
  3440. null,
  3441. ['placeholder' => get_lang('Password'), 'class' => 'col-md-3']
  3442. ); //new
  3443. $form->addButtonNext(get_lang('LoginEnter'), 'submitAuth');
  3444. return $form;
  3445. }
  3446. /**
  3447. * Gets a UNIX timestamp from a database (MySQL) datetime format string.
  3448. *
  3449. * @param $last_post_datetime standard output date in a sql query
  3450. *
  3451. * @return int timestamp
  3452. *
  3453. * @author Toon Van Hoecke <Toon.VanHoecke@UGent.be>
  3454. *
  3455. * @version October 2003
  3456. * @desc convert sql date to unix timestamp
  3457. */
  3458. function convert_sql_date($last_post_datetime)
  3459. {
  3460. list($last_post_date, $last_post_time) = explode(' ', $last_post_datetime);
  3461. list($year, $month, $day) = explode('-', $last_post_date);
  3462. list($hour, $min, $sec) = explode(':', $last_post_time);
  3463. return mktime((int) $hour, (int) $min, (int) $sec, (int) $month, (int) $day, (int) $year);
  3464. }
  3465. /**
  3466. * Gets item visibility from the item_property table.
  3467. *
  3468. * Getting the visibility is done by getting the last updated visibility entry,
  3469. * using the largest session ID found if session 0 and another was found (meaning
  3470. * the only one that is actually from the session, in case there are results from
  3471. * session 0 *AND* session n).
  3472. *
  3473. * @param array $_course Course properties array (result of api_get_course_info())
  3474. * @param string $tool Tool (learnpath, document, etc)
  3475. * @param int $id The item ID in the given tool
  3476. * @param int $session The session ID (optional)
  3477. * @param int $user_id
  3478. * @param string $type
  3479. * @param string $group_id
  3480. *
  3481. * @return int -1 on error, 0 if invisible, 1 if visible
  3482. */
  3483. function api_get_item_visibility(
  3484. $_course,
  3485. $tool,
  3486. $id,
  3487. $session = 0,
  3488. $user_id = null,
  3489. $type = null,
  3490. $group_id = null
  3491. ) {
  3492. if (!is_array($_course) || count($_course) == 0 || empty($tool) || empty($id)) {
  3493. return -1;
  3494. }
  3495. $tool = Database::escape_string($tool);
  3496. $id = (int) $id;
  3497. $session = (int) $session;
  3498. $TABLE_ITEMPROPERTY = Database::get_course_table(TABLE_ITEM_PROPERTY);
  3499. $course_id = (int) $_course['real_id'];
  3500. $userCondition = '';
  3501. if (!empty($user_id)) {
  3502. $user_id = (int) $user_id;
  3503. $userCondition = " AND to_user_id = $user_id ";
  3504. }
  3505. $typeCondition = '';
  3506. if (!empty($type)) {
  3507. $type = Database::escape_string($type);
  3508. $typeCondition = " AND lastedit_type = '$type' ";
  3509. }
  3510. $groupCondition = '';
  3511. if (!empty($group_id)) {
  3512. $group_id = (int) $group_id;
  3513. $groupCondition = " AND to_group_id = '$group_id' ";
  3514. }
  3515. $sql = "SELECT visibility
  3516. FROM $TABLE_ITEMPROPERTY
  3517. WHERE
  3518. c_id = $course_id AND
  3519. tool = '$tool' AND
  3520. ref = $id AND
  3521. (session_id = $session OR session_id = 0 OR session_id IS NULL)
  3522. $userCondition $typeCondition $groupCondition
  3523. ORDER BY session_id DESC, lastedit_date DESC
  3524. LIMIT 1";
  3525. $res = Database::query($sql);
  3526. if ($res === false || Database::num_rows($res) == 0) {
  3527. return -1;
  3528. }
  3529. $row = Database::fetch_array($res);
  3530. return (int) $row['visibility'];
  3531. }
  3532. /**
  3533. * Delete a row in the c_item_property table.
  3534. *
  3535. * @param array $courseInfo
  3536. * @param string $tool
  3537. * @param int $itemId
  3538. * @param int $userId
  3539. * @param int $groupId group.iid
  3540. * @param int $sessionId
  3541. *
  3542. * @return false|null
  3543. */
  3544. function api_item_property_delete(
  3545. $courseInfo,
  3546. $tool,
  3547. $itemId,
  3548. $userId,
  3549. $groupId = 0,
  3550. $sessionId = 0
  3551. ) {
  3552. if (empty($courseInfo)) {
  3553. return false;
  3554. }
  3555. $courseId = (int) $courseInfo['real_id'];
  3556. if (empty($courseId) || empty($tool) || empty($itemId)) {
  3557. return false;
  3558. }
  3559. $table = Database::get_course_table(TABLE_ITEM_PROPERTY);
  3560. $tool = Database::escape_string($tool);
  3561. $itemId = intval($itemId);
  3562. $userId = intval($userId);
  3563. $groupId = intval($groupId);
  3564. $sessionId = intval($sessionId);
  3565. $groupCondition = " AND to_group_id = $groupId ";
  3566. if (empty($groupId)) {
  3567. $groupCondition = " AND (to_group_id is NULL OR to_group_id = 0) ";
  3568. }
  3569. $userCondition = " AND to_user_id = $userId ";
  3570. if (empty($userId)) {
  3571. $userCondition = " AND (to_user_id is NULL OR to_user_id = 0) ";
  3572. }
  3573. $sessionCondition = api_get_session_condition($sessionId, true, false, 'session_id');
  3574. $sql = "DELETE FROM $table
  3575. WHERE
  3576. c_id = $courseId AND
  3577. tool = '$tool' AND
  3578. ref = $itemId
  3579. $sessionCondition
  3580. $userCondition
  3581. $groupCondition
  3582. ";
  3583. Database::query($sql);
  3584. }
  3585. /**
  3586. * Updates or adds item properties to the Item_propetry table
  3587. * Tool and lastedit_type are language independant strings (langvars->get_lang!).
  3588. *
  3589. * @param array $_course array with course properties
  3590. * @param string $tool tool id, linked to 'rubrique' of the course tool_list (Warning: language sensitive !!)
  3591. * @param int $item_id id of the item itself, linked to key of every tool ('id', ...)
  3592. * @param string $last_edit_type add or update action
  3593. * (1) message to be translated (in trad4all) : e.g. DocumentAdded, DocumentUpdated;
  3594. * (2) "delete"
  3595. * (3) "visible"
  3596. * (4) "invisible"
  3597. * @param int $user_id id of the editing/adding user
  3598. * @param array $groupInfo must include group.iid/group.od
  3599. * @param int $to_user_id id of the intended user (always has priority over $to_group_id !), only relevant for $type (1)
  3600. * @param string $start_visible 0000-00-00 00:00:00 format
  3601. * @param string $end_visible 0000-00-00 00:00:00 format
  3602. * @param int $session_id The session ID, if any, otherwise will default to 0
  3603. *
  3604. * @return bool false if update fails
  3605. *
  3606. * @author Toon Van Hoecke <Toon.VanHoecke@UGent.be>, Ghent University
  3607. *
  3608. * @version January 2005
  3609. * @desc update the item_properties table (if entry not exists, insert) of the course
  3610. */
  3611. function api_item_property_update(
  3612. $_course,
  3613. $tool,
  3614. $item_id,
  3615. $last_edit_type,
  3616. $user_id,
  3617. $groupInfo = [],
  3618. $to_user_id = null,
  3619. $start_visible = '',
  3620. $end_visible = '',
  3621. $session_id = 0
  3622. ) {
  3623. if (empty($_course)) {
  3624. return false;
  3625. }
  3626. $course_id = $_course['real_id'];
  3627. if (empty($course_id)) {
  3628. return false;
  3629. }
  3630. $to_group_id = 0;
  3631. if (!empty($groupInfo) && isset($groupInfo['iid'])) {
  3632. $to_group_id = (int) $groupInfo['iid'];
  3633. }
  3634. $em = Database::getManager();
  3635. // Definition of variables.
  3636. $tool = Database::escape_string($tool);
  3637. $item_id = (int) $item_id;
  3638. $lastEditTypeNoFilter = $last_edit_type;
  3639. $last_edit_type = Database::escape_string($last_edit_type);
  3640. $user_id = (int) $user_id;
  3641. $startVisible = "NULL";
  3642. if (!empty($start_visible)) {
  3643. $start_visible = Database::escape_string($start_visible);
  3644. $startVisible = "'$start_visible'";
  3645. }
  3646. $endVisible = "NULL";
  3647. if (!empty($end_visible)) {
  3648. $end_visible = Database::escape_string($end_visible);
  3649. $endVisible = "'$end_visible'";
  3650. }
  3651. $to_filter = '';
  3652. $time = api_get_utc_datetime();
  3653. if (!empty($session_id)) {
  3654. $session_id = (int) $session_id;
  3655. } else {
  3656. $session_id = api_get_session_id();
  3657. }
  3658. // Definition of tables.
  3659. $tableItemProperty = Database::get_course_table(TABLE_ITEM_PROPERTY);
  3660. if ($to_user_id <= 0) {
  3661. $to_user_id = null; // No to_user_id set
  3662. }
  3663. if (!is_null($to_user_id)) {
  3664. // $to_user_id has more priority than $to_group_id
  3665. $to_user_id = (int) $to_user_id;
  3666. $to_field = 'to_user_id';
  3667. $to_value = $to_user_id;
  3668. } else {
  3669. // $to_user_id is not set.
  3670. $to_field = 'to_group_id';
  3671. $to_value = $to_group_id;
  3672. }
  3673. $toValueCondition = empty($to_value) ? 'NULL' : "'$to_value'";
  3674. // Set filters for $to_user_id and $to_group_id, with priority for $to_user_id
  3675. $condition_session = " AND session_id = $session_id ";
  3676. if (empty($session_id)) {
  3677. $condition_session = ' AND (session_id = 0 OR session_id IS NULL) ';
  3678. }
  3679. $filter = " c_id = $course_id AND tool = '$tool' AND ref = $item_id $condition_session ";
  3680. // Check whether $to_user_id and $to_group_id are passed in the function call.
  3681. // If both are not passed (both are null) then it is a message for everybody and $to_group_id should be 0 !
  3682. if (is_null($to_user_id) && is_null($to_group_id)) {
  3683. $to_group_id = 0;
  3684. }
  3685. if (!is_null($to_user_id)) {
  3686. // Set filter to intended user.
  3687. $to_filter = " AND to_user_id = $to_user_id $condition_session";
  3688. } else {
  3689. // Set filter to intended group.
  3690. if (($to_group_id != 0) && $to_group_id == strval(intval($to_group_id))) {
  3691. $to_filter = " AND to_group_id = $to_group_id $condition_session";
  3692. }
  3693. }
  3694. // Adding filter if set.
  3695. $filter .= $to_filter;
  3696. // Update if possible
  3697. $set_type = '';
  3698. switch ($lastEditTypeNoFilter) {
  3699. case 'delete':
  3700. // delete = make item only visible for the platform admin.
  3701. $visibility = '2';
  3702. if (!empty($session_id)) {
  3703. // Check whether session id already exist into item_properties for updating visibility or add it.
  3704. $sql = "SELECT session_id FROM $tableItemProperty
  3705. WHERE
  3706. c_id = $course_id AND
  3707. tool = '$tool' AND
  3708. ref = $item_id AND
  3709. session_id = $session_id";
  3710. $rs = Database::query($sql);
  3711. if (Database::num_rows($rs) > 0) {
  3712. $sql = "UPDATE $tableItemProperty
  3713. SET lastedit_type = '".str_replace('_', '', ucwords($tool))."Deleted',
  3714. lastedit_date = '$time',
  3715. lastedit_user_id = $user_id,
  3716. visibility = $visibility,
  3717. session_id = $session_id $set_type
  3718. WHERE $filter";
  3719. $result = Database::query($sql);
  3720. } else {
  3721. $sql = "INSERT INTO $tableItemProperty (c_id, tool, ref, insert_date, insert_user_id, lastedit_date, lastedit_type, lastedit_user_id, $to_field, visibility, start_visible, end_visible, session_id)
  3722. VALUES ($course_id, '$tool',$item_id, '$time', $user_id, '$time', '$last_edit_type',$user_id, $toValueCondition, $visibility, $startVisible, $endVisible, $session_id)";
  3723. $result = Database::query($sql);
  3724. $id = Database::insert_id();
  3725. if ($id) {
  3726. $sql = "UPDATE $tableItemProperty SET id = iid WHERE iid = $id";
  3727. Database::query($sql);
  3728. }
  3729. }
  3730. } else {
  3731. $sql = "UPDATE $tableItemProperty
  3732. SET
  3733. lastedit_type='".str_replace('_', '', ucwords($tool))."Deleted',
  3734. lastedit_date='$time',
  3735. lastedit_user_id = $user_id,
  3736. visibility = $visibility $set_type
  3737. WHERE $filter";
  3738. $result = Database::query($sql);
  3739. }
  3740. break;
  3741. case 'visible': // Change item to visible.
  3742. $visibility = '1';
  3743. if (!empty($session_id)) {
  3744. // Check whether session id already exist into item_properties for updating visibility or add it.
  3745. $sql = "SELECT session_id FROM $tableItemProperty
  3746. WHERE
  3747. c_id = $course_id AND
  3748. tool = '$tool' AND
  3749. ref = $item_id AND
  3750. session_id = $session_id";
  3751. $rs = Database::query($sql);
  3752. if (Database::num_rows($rs) > 0) {
  3753. $sql = "UPDATE $tableItemProperty
  3754. SET
  3755. lastedit_type='".str_replace('_', '', ucwords($tool))."Visible',
  3756. lastedit_date='$time',
  3757. lastedit_user_id = $user_id,
  3758. visibility = $visibility,
  3759. session_id = $session_id $set_type
  3760. WHERE $filter";
  3761. $result = Database::query($sql);
  3762. } else {
  3763. $sql = "INSERT INTO $tableItemProperty (c_id, tool, ref, insert_date, insert_user_id, lastedit_date, lastedit_type, lastedit_user_id, $to_field, visibility, start_visible, end_visible, session_id)
  3764. VALUES ($course_id, '$tool', $item_id, '$time', $user_id, '$time', '$last_edit_type', $user_id, $toValueCondition, $visibility, $startVisible, $endVisible, $session_id)";
  3765. $result = Database::query($sql);
  3766. $id = Database::insert_id();
  3767. if ($id) {
  3768. $sql = "UPDATE $tableItemProperty SET id = iid WHERE iid = $id";
  3769. Database::query($sql);
  3770. }
  3771. }
  3772. } else {
  3773. $sql = "UPDATE $tableItemProperty
  3774. SET
  3775. lastedit_type='".str_replace('_', '', ucwords($tool))."Visible',
  3776. lastedit_date='$time',
  3777. lastedit_user_id = $user_id,
  3778. visibility = $visibility $set_type
  3779. WHERE $filter";
  3780. $result = Database::query($sql);
  3781. }
  3782. break;
  3783. case 'invisible': // Change item to invisible.
  3784. $visibility = '0';
  3785. if (!empty($session_id)) {
  3786. // Check whether session id already exist into item_properties for updating visibility or add it
  3787. $sql = "SELECT session_id FROM $tableItemProperty
  3788. WHERE
  3789. c_id = $course_id AND
  3790. tool = '$tool' AND
  3791. ref = $item_id AND
  3792. session_id = $session_id";
  3793. $rs = Database::query($sql);
  3794. if (Database::num_rows($rs) > 0) {
  3795. $sql = "UPDATE $tableItemProperty
  3796. SET
  3797. lastedit_type = '".str_replace('_', '', ucwords($tool))."Invisible',
  3798. lastedit_date = '$time',
  3799. lastedit_user_id = $user_id,
  3800. visibility = $visibility,
  3801. session_id = $session_id $set_type
  3802. WHERE $filter";
  3803. $result = Database::query($sql);
  3804. } else {
  3805. $sql = "INSERT INTO $tableItemProperty (c_id, tool, ref, insert_date, insert_user_id, lastedit_date, lastedit_type, lastedit_user_id,$to_field, visibility, start_visible, end_visible, session_id)
  3806. VALUES ($course_id, '$tool', $item_id, '$time', $user_id, '$time', '$last_edit_type', $user_id, $toValueCondition, $visibility, $startVisible, $endVisible, $session_id)";
  3807. $result = Database::query($sql);
  3808. $id = Database::insert_id();
  3809. if ($id) {
  3810. $sql = "UPDATE $tableItemProperty SET id = iid WHERE iid = $id";
  3811. Database::query($sql);
  3812. }
  3813. }
  3814. } else {
  3815. $sql = "UPDATE $tableItemProperty
  3816. SET
  3817. lastedit_type = '".str_replace('_', '', ucwords($tool))."Invisible',
  3818. lastedit_date = '$time',
  3819. lastedit_user_id = $user_id,
  3820. visibility = $visibility $set_type
  3821. WHERE $filter";
  3822. $result = Database::query($sql);
  3823. }
  3824. break;
  3825. default: // The item will be added or updated.
  3826. $set_type = ", lastedit_type = '$last_edit_type' ";
  3827. $visibility = '1';
  3828. //$filter .= $to_filter; already added
  3829. $sql = "UPDATE $tableItemProperty
  3830. SET
  3831. lastedit_date = '$time',
  3832. lastedit_user_id = $user_id $set_type
  3833. WHERE $filter";
  3834. $result = Database::query($sql);
  3835. }
  3836. // Insert if no entries are found (can only happen in case of $last_edit_type switch is 'default').
  3837. if ($result == false || Database::affected_rows($result) == 0) {
  3838. $objCourse = $em->find('ChamiloCoreBundle:Course', intval($course_id));
  3839. $objTime = new DateTime('now', new DateTimeZone('UTC'));
  3840. $objUser = api_get_user_entity($user_id);
  3841. if (empty($objUser)) {
  3842. // Use anonymous
  3843. $user_id = api_get_anonymous_id();
  3844. $objUser = api_get_user_entity($user_id);
  3845. }
  3846. $objGroup = null;
  3847. if (!empty($to_group_id)) {
  3848. $objGroup = $em->find('ChamiloCourseBundle:CGroupInfo', $to_group_id);
  3849. }
  3850. $objToUser = api_get_user_entity($to_user_id);
  3851. $objSession = $em->find('ChamiloCoreBundle:Session', intval($session_id));
  3852. $startVisibleDate = !empty($start_visible) ? new DateTime($start_visible, new DateTimeZone('UTC')) : null;
  3853. $endVisibleDate = !empty($endVisibleDate) ? new DateTime($endVisibleDate, new DateTimeZone('UTC')) : null;
  3854. $cItemProperty = new CItemProperty($objCourse);
  3855. $cItemProperty
  3856. ->setTool($tool)
  3857. ->setRef($item_id)
  3858. ->setInsertDate($objTime)
  3859. ->setInsertUser($objUser)
  3860. ->setLasteditDate($objTime)
  3861. ->setLasteditType($last_edit_type)
  3862. ->setGroup($objGroup)
  3863. ->setToUser($objToUser)
  3864. ->setVisibility($visibility)
  3865. ->setStartVisible($startVisibleDate)
  3866. ->setEndVisible($endVisibleDate)
  3867. ->setSession($objSession);
  3868. $em->persist($cItemProperty);
  3869. $em->flush();
  3870. $id = $cItemProperty->getIid();
  3871. if ($id) {
  3872. $cItemProperty->setId($id);
  3873. $em->merge($cItemProperty);
  3874. $em->flush();
  3875. return false;
  3876. }
  3877. }
  3878. return true;
  3879. }
  3880. /**
  3881. * Gets item property by tool.
  3882. *
  3883. * @param string course code
  3884. * @param string tool name, linked to 'rubrique' of the course tool_list (Warning: language sensitive !!)
  3885. * @param int id of the item itself, linked to key of every tool ('id', ...), "*" = all items of the tool
  3886. * @param int $session_id
  3887. * @param string $tool
  3888. * @param string $course_code
  3889. *
  3890. * @return array All fields from c_item_property (all rows found) or empty array
  3891. */
  3892. function api_get_item_property_by_tool($tool, $course_code, $session_id = null)
  3893. {
  3894. $course_info = api_get_course_info($course_code);
  3895. $tool = Database::escape_string($tool);
  3896. // Definition of tables.
  3897. $item_property_table = Database::get_course_table(TABLE_ITEM_PROPERTY);
  3898. $session_id = (int) $session_id;
  3899. $session_condition = ' AND session_id = '.$session_id;
  3900. if (empty($session_id)) {
  3901. $session_condition = " AND (session_id = 0 OR session_id IS NULL) ";
  3902. }
  3903. $course_id = $course_info['real_id'];
  3904. $sql = "SELECT * FROM $item_property_table
  3905. WHERE
  3906. c_id = $course_id AND
  3907. tool = '$tool'
  3908. $session_condition ";
  3909. $rs = Database::query($sql);
  3910. $list = [];
  3911. if (Database::num_rows($rs) > 0) {
  3912. while ($row = Database::fetch_array($rs, 'ASSOC')) {
  3913. $list[] = $row;
  3914. }
  3915. }
  3916. return $list;
  3917. }
  3918. /**
  3919. * Gets item property by tool and user.
  3920. *
  3921. * @param int $userId
  3922. * @param int $tool
  3923. * @param int $courseId
  3924. * @param int $session_id
  3925. *
  3926. * @return array
  3927. */
  3928. function api_get_item_property_list_by_tool_by_user(
  3929. $userId,
  3930. $tool,
  3931. $courseId,
  3932. $session_id = 0
  3933. ) {
  3934. $userId = intval($userId);
  3935. $tool = Database::escape_string($tool);
  3936. $session_id = intval($session_id);
  3937. $courseId = intval($courseId);
  3938. // Definition of tables.
  3939. $item_property_table = Database::get_course_table(TABLE_ITEM_PROPERTY);
  3940. $session_condition = ' AND session_id = '.$session_id;
  3941. if (empty($session_id)) {
  3942. $session_condition = " AND (session_id = 0 OR session_id IS NULL) ";
  3943. }
  3944. $sql = "SELECT * FROM $item_property_table
  3945. WHERE
  3946. insert_user_id = $userId AND
  3947. c_id = $courseId AND
  3948. tool = '$tool'
  3949. $session_condition ";
  3950. $rs = Database::query($sql);
  3951. $list = [];
  3952. if (Database::num_rows($rs) > 0) {
  3953. while ($row = Database::fetch_array($rs, 'ASSOC')) {
  3954. $list[] = $row;
  3955. }
  3956. }
  3957. return $list;
  3958. }
  3959. /**
  3960. * Gets item property id from tool of a course.
  3961. *
  3962. * @param string $course_code course code
  3963. * @param string $tool tool name, linked to 'rubrique' of the course tool_list (Warning: language sensitive !!)
  3964. * @param int $ref id of the item itself, linked to key of every tool ('id', ...), "*" = all items of the tool
  3965. * @param int $sessionId Session ID (optional)
  3966. *
  3967. * @return int
  3968. */
  3969. function api_get_item_property_id($course_code, $tool, $ref, $sessionId = 0)
  3970. {
  3971. $course_info = api_get_course_info($course_code);
  3972. $tool = Database::escape_string($tool);
  3973. $ref = (int) $ref;
  3974. // Definition of tables.
  3975. $tableItemProperty = Database::get_course_table(TABLE_ITEM_PROPERTY);
  3976. $course_id = $course_info['real_id'];
  3977. $sessionId = (int) $sessionId;
  3978. $sessionCondition = " AND session_id = $sessionId ";
  3979. if (empty($sessionId)) {
  3980. $sessionCondition = ' AND (session_id = 0 OR session_id IS NULL) ';
  3981. }
  3982. $sql = "SELECT id FROM $tableItemProperty
  3983. WHERE
  3984. c_id = $course_id AND
  3985. tool = '$tool' AND
  3986. ref = $ref
  3987. $sessionCondition";
  3988. $rs = Database::query($sql);
  3989. $item_property_id = '';
  3990. if (Database::num_rows($rs) > 0) {
  3991. $row = Database::fetch_array($rs);
  3992. $item_property_id = $row['id'];
  3993. }
  3994. return $item_property_id;
  3995. }
  3996. /**
  3997. * Inserts a record in the track_e_item_property table (No update).
  3998. *
  3999. * @param string $tool
  4000. * @param int $ref
  4001. * @param string $title
  4002. * @param string $content
  4003. * @param int $progress
  4004. *
  4005. * @return bool|int
  4006. */
  4007. function api_track_item_property_update($tool, $ref, $title, $content, $progress)
  4008. {
  4009. $tbl_stats_item_property = Database::get_main_table(TABLE_STATISTIC_TRACK_E_ITEM_PROPERTY);
  4010. $course_id = api_get_course_int_id(); //numeric
  4011. $course_code = api_get_course_id(); //alphanumeric
  4012. $item_property_id = api_get_item_property_id($course_code, $tool, $ref);
  4013. if (!empty($item_property_id)) {
  4014. $sql = "INSERT IGNORE INTO $tbl_stats_item_property SET
  4015. course_id = '$course_id',
  4016. item_property_id = '$item_property_id',
  4017. title = '".Database::escape_string($title)."',
  4018. content = '".Database::escape_string($content)."',
  4019. progress = '".intval($progress)."',
  4020. lastedit_date = '".api_get_utc_datetime()."',
  4021. lastedit_user_id = '".api_get_user_id()."',
  4022. session_id = '".api_get_session_id()."'";
  4023. $result = Database::query($sql);
  4024. $affected_rows = Database::affected_rows($result);
  4025. return $affected_rows;
  4026. }
  4027. return false;
  4028. }
  4029. /**
  4030. * @param string $tool
  4031. * @param int $ref
  4032. *
  4033. * @return array|resource
  4034. */
  4035. function api_get_track_item_property_history($tool, $ref)
  4036. {
  4037. $tbl_stats_item_property = Database::get_main_table(TABLE_STATISTIC_TRACK_E_ITEM_PROPERTY);
  4038. $course_id = api_get_course_int_id(); //numeric
  4039. $course_code = api_get_course_id(); //alphanumeric
  4040. $item_property_id = api_get_item_property_id($course_code, $tool, $ref);
  4041. $sql = "SELECT * FROM $tbl_stats_item_property
  4042. WHERE item_property_id = $item_property_id AND course_id = $course_id
  4043. ORDER BY lastedit_date DESC";
  4044. $result = Database::query($sql);
  4045. if ($result === false or $result === null) {
  4046. $result = [];
  4047. } else {
  4048. $result = Database::store_result($result, 'ASSOC');
  4049. }
  4050. return $result;
  4051. }
  4052. /**
  4053. * Gets item property data from tool of a course id.
  4054. *
  4055. * @param int $course_id
  4056. * @param string $tool tool name, linked to 'rubrique' of the course tool_list (Warning: language sensitive !!)
  4057. * @param int $ref id of the item itself, linked to key of every tool ('id', ...), "*" = all items of the tool
  4058. * @param int $session_id
  4059. * @param int $groupId
  4060. *
  4061. * @return array with all fields from c_item_property, empty array if not found or false if course could not be found
  4062. */
  4063. function api_get_item_property_info($course_id, $tool, $ref, $session_id = 0, $groupId = 0)
  4064. {
  4065. $courseInfo = api_get_course_info_by_id($course_id);
  4066. if (empty($courseInfo)) {
  4067. return false;
  4068. }
  4069. $tool = Database::escape_string($tool);
  4070. $course_id = $courseInfo['real_id'];
  4071. $ref = (int) $ref;
  4072. $session_id = (int) $session_id;
  4073. $sessionCondition = " session_id = $session_id";
  4074. if (empty($session_id)) {
  4075. $sessionCondition = ' (session_id = 0 OR session_id IS NULL) ';
  4076. }
  4077. // Definition of tables.
  4078. $table = Database::get_course_table(TABLE_ITEM_PROPERTY);
  4079. $sql = "SELECT * FROM $table
  4080. WHERE
  4081. c_id = $course_id AND
  4082. tool = '$tool' AND
  4083. ref = $ref AND
  4084. $sessionCondition ";
  4085. if (!empty($groupId)) {
  4086. $groupId = (int) $groupId;
  4087. $sql .= " AND to_group_id = $groupId ";
  4088. }
  4089. $rs = Database::query($sql);
  4090. $row = [];
  4091. if (Database::num_rows($rs) > 0) {
  4092. $row = Database::fetch_array($rs, 'ASSOC');
  4093. }
  4094. return $row;
  4095. }
  4096. /**
  4097. * Displays a combo box so the user can select his/her preferred language.
  4098. *
  4099. * @param string The desired name= value for the select
  4100. * @param bool Whether we use the JQuery Chozen library or not
  4101. * (in some cases, like the indexing language picker, it can alter the presentation)
  4102. *
  4103. * @return string
  4104. */
  4105. function api_get_languages_combo($name = 'language')
  4106. {
  4107. $ret = '';
  4108. $platformLanguage = api_get_setting('platformLanguage');
  4109. // Retrieve a complete list of all the languages.
  4110. $language_list = api_get_languages();
  4111. if (count($language_list['name']) < 2) {
  4112. return $ret;
  4113. }
  4114. // The the current language of the user so that his/her language occurs as selected in the dropdown menu.
  4115. if (isset($_SESSION['user_language_choice'])) {
  4116. $default = $_SESSION['user_language_choice'];
  4117. } else {
  4118. $default = $platformLanguage;
  4119. }
  4120. $languages = $language_list['name'];
  4121. $folder = $language_list['folder'];
  4122. $ret .= '<select name="'.$name.'" id="language_chosen" class="selectpicker form-control">';
  4123. foreach ($languages as $key => $value) {
  4124. if ($folder[$key] == $default) {
  4125. $selected = ' selected="selected"';
  4126. } else {
  4127. $selected = '';
  4128. }
  4129. $ret .= sprintf('<option value=%s" %s>%s</option>', $folder[$key], $selected, $value);
  4130. }
  4131. $ret .= '</select>';
  4132. return $ret;
  4133. }
  4134. /**
  4135. * Displays a form (drop down menu) so the user can select his/her preferred language.
  4136. * The form works with or without javascript.
  4137. *
  4138. * @param bool Hide form if only one language available (defaults to false = show the box anyway)
  4139. * @param bool $showAsButton
  4140. *
  4141. * @return string|null Display the box directly
  4142. */
  4143. function api_display_language_form($hide_if_no_choice = false, $showAsButton = false)
  4144. {
  4145. // Retrieve a complete list of all the languages.
  4146. $language_list = api_get_languages();
  4147. if (count($language_list['name']) <= 1 && $hide_if_no_choice) {
  4148. return; //don't show any form
  4149. }
  4150. // The the current language of the user so that his/her language occurs as selected in the dropdown menu.
  4151. if (isset($_SESSION['user_language_choice'])) {
  4152. $user_selected_language = $_SESSION['user_language_choice'];
  4153. }
  4154. if (empty($user_selected_language)) {
  4155. $user_selected_language = api_get_setting('platformLanguage');
  4156. }
  4157. $currentLanguageId = api_get_language_id($user_selected_language);
  4158. $currentLanguageInfo = api_get_language_info($currentLanguageId);
  4159. $countryCode = languageToCountryIsoCode($currentLanguageInfo['isocode']);
  4160. $url = api_get_self();
  4161. if ($showAsButton) {
  4162. $html = '<div class="btn-group">
  4163. <button type="button" class="btn btn-default dropdown-toggle" data-toggle="dropdown">
  4164. <span class="flag-icon flag-icon-'.$countryCode.'"></span>
  4165. '.$currentLanguageInfo['original_name'].'
  4166. <span class="caret">
  4167. </span>
  4168. </button>';
  4169. } else {
  4170. $html = '
  4171. <a href="'.$url.'" class="dropdown-toggle" data-toggle="dropdown" role="button">
  4172. <span class="flag-icon flag-icon-'.$countryCode.'"></span>
  4173. '.$currentLanguageInfo['original_name'].'
  4174. <span class="caret"></span>
  4175. </a>
  4176. ';
  4177. }
  4178. $html .= '<ul class="dropdown-menu" role="menu">';
  4179. foreach ($language_list['all'] as $key => $data) {
  4180. $urlLink = $url.'?language='.$data['english_name'];
  4181. $html .= '<li><a href="'.$urlLink.'"><span class="flag-icon flag-icon-'.languageToCountryIsoCode($data['isocode']).'"></span> '.$data['original_name'].'</a></li>';
  4182. }
  4183. $html .= '</ul>';
  4184. if ($showAsButton) {
  4185. $html .= '</div>';
  4186. }
  4187. return $html;
  4188. }
  4189. /**
  4190. * @param string $languageIsoCode
  4191. *
  4192. * @return string
  4193. */
  4194. function languageToCountryIsoCode($languageIsoCode)
  4195. {
  4196. // @todo save in DB
  4197. switch ($languageIsoCode) {
  4198. case 'ko':
  4199. $country = 'kr';
  4200. break;
  4201. case 'ja':
  4202. $country = 'jp';
  4203. break;
  4204. case 'ca':
  4205. $country = 'es';
  4206. break;
  4207. case 'gl':
  4208. $country = 'es';
  4209. break;
  4210. case 'ka':
  4211. $country = 'ge';
  4212. break;
  4213. case 'sl':
  4214. $country = 'si';
  4215. break;
  4216. case 'eu':
  4217. $country = 'es';
  4218. break;
  4219. case 'cs':
  4220. $country = 'cz';
  4221. break;
  4222. case 'el':
  4223. $country = 'ae';
  4224. break;
  4225. case 'ar':
  4226. $country = 'ae';
  4227. break;
  4228. case 'en':
  4229. $country = 'gb';
  4230. break;
  4231. case 'he':
  4232. $country = 'il';
  4233. break;
  4234. case 'uk':
  4235. $country = 'ua'; //Ukraine
  4236. break;
  4237. case 'da':
  4238. $country = 'dk';
  4239. break;
  4240. case 'pt-BR':
  4241. $country = 'br';
  4242. break;
  4243. case 'qu':
  4244. $country = 'pe';
  4245. break;
  4246. case 'sv':
  4247. $country = 'se';
  4248. break;
  4249. case 'zh-TW':
  4250. case 'zh':
  4251. $country = 'cn';
  4252. break;
  4253. default:
  4254. $country = $languageIsoCode;
  4255. break;
  4256. }
  4257. $country = strtolower($country);
  4258. return $country;
  4259. }
  4260. /**
  4261. * Returns a list of all the languages that are made available by the admin.
  4262. *
  4263. * @return array An array with all languages. Structure of the array is
  4264. * array['name'] = An array with the name of every language
  4265. * array['folder'] = An array with the corresponding names of the language-folders in the filesystem
  4266. */
  4267. function api_get_languages()
  4268. {
  4269. $tbl_language = Database::get_main_table(TABLE_MAIN_LANGUAGE);
  4270. $sql = "SELECT * FROM $tbl_language WHERE available='1'
  4271. ORDER BY original_name ASC";
  4272. $result = Database::query($sql);
  4273. $language_list = [];
  4274. while ($row = Database::fetch_array($result)) {
  4275. $language_list['name'][] = $row['original_name'];
  4276. $language_list['folder'][] = $row['dokeos_folder'];
  4277. $language_list['all'][] = $row;
  4278. }
  4279. return $language_list;
  4280. }
  4281. /**
  4282. * Returns a list of all the languages that are made available by the admin.
  4283. *
  4284. * @return array
  4285. */
  4286. function api_get_languages_to_array()
  4287. {
  4288. $tbl_language = Database::get_main_table(TABLE_MAIN_LANGUAGE);
  4289. $sql = "SELECT * FROM $tbl_language WHERE available='1' ORDER BY original_name ASC";
  4290. $result = Database::query($sql);
  4291. $languages = [];
  4292. while ($row = Database::fetch_array($result)) {
  4293. $languages[$row['dokeos_folder']] = $row['original_name'];
  4294. }
  4295. return $languages;
  4296. }
  4297. /**
  4298. * Returns the id (the database id) of a language.
  4299. *
  4300. * @param string language name (the corresponding name of the language-folder in the filesystem)
  4301. *
  4302. * @return int id of the language
  4303. */
  4304. function api_get_language_id($language)
  4305. {
  4306. $tbl_language = Database::get_main_table(TABLE_MAIN_LANGUAGE);
  4307. if (empty($language)) {
  4308. return null;
  4309. }
  4310. $language = Database::escape_string($language);
  4311. $sql = "SELECT id FROM $tbl_language
  4312. WHERE dokeos_folder = '$language' LIMIT 1";
  4313. $result = Database::query($sql);
  4314. $row = Database::fetch_array($result);
  4315. return $row['id'];
  4316. }
  4317. /**
  4318. * Gets language of the requested type for the current user. Types are :
  4319. * user_profil_lang : profile language of current user
  4320. * user_select_lang : language selected by user at login
  4321. * course_lang : language of the current course
  4322. * platform_lang : default platform language.
  4323. *
  4324. * @param string $lang_type
  4325. *
  4326. * @return string
  4327. */
  4328. function api_get_language_from_type($lang_type)
  4329. {
  4330. $return = false;
  4331. switch ($lang_type) {
  4332. case 'platform_lang':
  4333. $temp_lang = api_get_setting('platformLanguage');
  4334. if (!empty($temp_lang)) {
  4335. $return = $temp_lang;
  4336. }
  4337. break;
  4338. case 'user_profil_lang':
  4339. $_user = api_get_user_info();
  4340. if (isset($_user['language']) && !empty($_user['language'])) {
  4341. $return = $_user['language'];
  4342. }
  4343. break;
  4344. case 'user_selected_lang':
  4345. if (isset($_SESSION['user_language_choice']) && !empty($_SESSION['user_language_choice'])) {
  4346. $return = $_SESSION['user_language_choice'];
  4347. }
  4348. break;
  4349. case 'course_lang':
  4350. global $_course;
  4351. $cidReq = null;
  4352. if (empty($_course)) {
  4353. // Code modified because the local.inc.php file it's declarated after this work
  4354. // causing the function api_get_course_info() returns a null value
  4355. $cidReq = isset($_GET["cidReq"]) ? Database::escape_string($_GET["cidReq"]) : null;
  4356. $cDir = (!empty($_GET['cDir']) ? $_GET['cDir'] : null);
  4357. if (empty($cidReq) && !empty($cDir)) {
  4358. $c = CourseManager::getCourseCodeFromDirectory($cDir);
  4359. if ($c) {
  4360. $cidReq = $c;
  4361. }
  4362. }
  4363. }
  4364. $_course = api_get_course_info($cidReq);
  4365. if (isset($_course['language']) && !empty($_course['language'])) {
  4366. $return = $_course['language'];
  4367. $showCourseInUserLanguage = api_get_course_setting('show_course_in_user_language');
  4368. if ($showCourseInUserLanguage == 1) {
  4369. $userInfo = api_get_user_info();
  4370. if (isset($userInfo['language'])) {
  4371. $return = $userInfo['language'];
  4372. }
  4373. }
  4374. }
  4375. break;
  4376. default:
  4377. $return = false;
  4378. break;
  4379. }
  4380. return $return;
  4381. }
  4382. /**
  4383. * Get the language information by its id.
  4384. *
  4385. * @param int $languageId
  4386. *
  4387. * @throws Exception
  4388. *
  4389. * @return array
  4390. */
  4391. function api_get_language_info($languageId)
  4392. {
  4393. if (empty($languageId)) {
  4394. return [];
  4395. }
  4396. $language = Database::getManager()
  4397. ->find('ChamiloCoreBundle:Language', $languageId);
  4398. if (!$language) {
  4399. return [];
  4400. }
  4401. return [
  4402. 'id' => $language->getId(),
  4403. 'original_name' => $language->getOriginalName(),
  4404. 'english_name' => $language->getEnglishName(),
  4405. 'isocode' => $language->getIsocode(),
  4406. 'dokeos_folder' => $language->getDokeosFolder(),
  4407. 'available' => $language->getAvailable(),
  4408. 'parent_id' => $language->getParent() ? $language->getParent()->getId() : null,
  4409. ];
  4410. }
  4411. /**
  4412. * Returns the name of the visual (CSS) theme to be applied on the current page.
  4413. * The returned name depends on the platform, course or user -wide settings.
  4414. *
  4415. * @return string The visual theme's name, it is the name of a folder inside web/css/themes
  4416. */
  4417. function api_get_visual_theme()
  4418. {
  4419. static $visual_theme;
  4420. if (!isset($visual_theme)) {
  4421. // Get style directly from DB
  4422. $styleFromDatabase = api_get_settings_params_simple(
  4423. [
  4424. 'variable = ? AND access_url = ?' => [
  4425. 'stylesheets',
  4426. api_get_current_access_url_id(),
  4427. ],
  4428. ]
  4429. );
  4430. if ($styleFromDatabase) {
  4431. $platform_theme = $styleFromDatabase['selected_value'];
  4432. } else {
  4433. $platform_theme = api_get_setting('stylesheets');
  4434. }
  4435. // Platform's theme.
  4436. $visual_theme = $platform_theme;
  4437. if (api_get_setting('user_selected_theme') == 'true') {
  4438. $user_info = api_get_user_info();
  4439. if (isset($user_info['theme'])) {
  4440. $user_theme = $user_info['theme'];
  4441. if (!empty($user_theme)) {
  4442. $visual_theme = $user_theme;
  4443. // User's theme.
  4444. }
  4445. }
  4446. }
  4447. $course_id = api_get_course_id();
  4448. if (!empty($course_id)) {
  4449. if (api_get_setting('allow_course_theme') == 'true') {
  4450. $course_theme = api_get_course_setting('course_theme', $course_id);
  4451. if (!empty($course_theme) && $course_theme != -1) {
  4452. if (!empty($course_theme)) {
  4453. // Course's theme.
  4454. $visual_theme = $course_theme;
  4455. }
  4456. }
  4457. $allow_lp_theme = api_get_course_setting('allow_learning_path_theme');
  4458. if ($allow_lp_theme == 1) {
  4459. global $lp_theme_css, $lp_theme_config;
  4460. // These variables come from the file lp_controller.php.
  4461. if (!$lp_theme_config) {
  4462. if (!empty($lp_theme_css)) {
  4463. // LP's theme.
  4464. $visual_theme = $lp_theme_css;
  4465. }
  4466. }
  4467. }
  4468. }
  4469. }
  4470. if (empty($visual_theme)) {
  4471. $visual_theme = 'chamilo';
  4472. }
  4473. global $lp_theme_log;
  4474. if ($lp_theme_log) {
  4475. $visual_theme = $platform_theme;
  4476. }
  4477. }
  4478. return $visual_theme;
  4479. }
  4480. /**
  4481. * Returns a list of CSS themes currently available in the CSS folder
  4482. * The folder must have a default.css file.
  4483. *
  4484. * @param bool $getOnlyThemeFromVirtualInstance Used by the vchamilo plugin
  4485. *
  4486. * @return array list of themes directories from the css folder
  4487. * Note: Directory names (names of themes) in the file system should contain ASCII-characters only
  4488. */
  4489. function api_get_themes($getOnlyThemeFromVirtualInstance = false)
  4490. {
  4491. // This configuration value is set by the vchamilo plugin
  4492. $virtualTheme = api_get_configuration_value('virtual_css_theme_folder');
  4493. $readCssFolder = function ($dir) use ($virtualTheme) {
  4494. $finder = new Finder();
  4495. $themes = $finder->directories()->in($dir)->depth(0)->sortByName();
  4496. $list = [];
  4497. /** @var Symfony\Component\Finder\SplFileInfo $theme */
  4498. foreach ($themes as $theme) {
  4499. $folder = $theme->getFilename();
  4500. // A theme folder is consider if there's a default.css file
  4501. if (!file_exists($theme->getPathname().'/default.css')) {
  4502. continue;
  4503. }
  4504. $name = ucwords(str_replace('_', ' ', $folder));
  4505. if ($folder == $virtualTheme) {
  4506. continue;
  4507. }
  4508. $list[$folder] = $name;
  4509. }
  4510. return $list;
  4511. };
  4512. $dir = api_get_path(SYS_CSS_PATH).'themes/';
  4513. $list = $readCssFolder($dir);
  4514. if (!empty($virtualTheme)) {
  4515. $newList = $readCssFolder($dir.'/'.$virtualTheme);
  4516. if ($getOnlyThemeFromVirtualInstance) {
  4517. return $newList;
  4518. }
  4519. $list = $list + $newList;
  4520. asort($list);
  4521. }
  4522. return $list;
  4523. }
  4524. /**
  4525. * Find the largest sort value in a given user_course_category
  4526. * This function is used when we are moving a course to a different category
  4527. * and also when a user subscribes to courses (the new course is added at the end of the main category.
  4528. *
  4529. * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
  4530. *
  4531. * @param int $user_course_category the id of the user_course_category
  4532. * @param int $user_id
  4533. *
  4534. * @return int the value of the highest sort of the user_course_category
  4535. */
  4536. function api_max_sort_value($user_course_category, $user_id)
  4537. {
  4538. $tbl_course_user = Database::get_main_table(TABLE_MAIN_COURSE_USER);
  4539. $sql = "SELECT max(sort) as max_sort FROM $tbl_course_user
  4540. WHERE
  4541. user_id='".intval($user_id)."' AND
  4542. relation_type<>".COURSE_RELATION_TYPE_RRHH." AND
  4543. user_course_cat='".intval($user_course_category)."'";
  4544. $result_max = Database::query($sql);
  4545. if (Database::num_rows($result_max) == 1) {
  4546. $row_max = Database::fetch_array($result_max);
  4547. return $row_max['max_sort'];
  4548. }
  4549. return 0;
  4550. }
  4551. /**
  4552. * Transforms a number of seconds in hh:mm:ss format.
  4553. *
  4554. * @author Julian Prud'homme
  4555. *
  4556. * @param int the number of seconds
  4557. *
  4558. * @return string the formated time
  4559. */
  4560. function api_time_to_hms($seconds, $space = ':')
  4561. {
  4562. // $seconds = -1 means that we have wrong data in the db.
  4563. if ($seconds == -1) {
  4564. return
  4565. get_lang('Unknown').
  4566. Display::return_icon(
  4567. 'info2.gif',
  4568. get_lang('WrongDatasForTimeSpentOnThePlatform'),
  4569. ['align' => 'absmiddle', 'hspace' => '3px']
  4570. );
  4571. }
  4572. // How many hours ?
  4573. $hours = floor($seconds / 3600);
  4574. // How many minutes ?
  4575. $min = floor(($seconds - ($hours * 3600)) / 60);
  4576. // How many seconds
  4577. $sec = floor($seconds - ($hours * 3600) - ($min * 60));
  4578. if ($hours < 10) {
  4579. $hours = "0$hours";
  4580. }
  4581. if ($sec < 10) {
  4582. $sec = "0$sec";
  4583. }
  4584. if ($min < 10) {
  4585. $min = "0$min";
  4586. }
  4587. return $hours.$space.$min.$space.$sec;
  4588. }
  4589. /* FILE SYSTEM RELATED FUNCTIONS */
  4590. /**
  4591. * Returns the permissions to be assigned to every newly created directory by the web-server.
  4592. * The return value is based on the platform administrator's setting
  4593. * "Administration > Configuration settings > Security > Permissions for new directories".
  4594. *
  4595. * @return int returns the permissions in the format "Owner-Group-Others, Read-Write-Execute", as an integer value
  4596. */
  4597. function api_get_permissions_for_new_directories()
  4598. {
  4599. static $permissions;
  4600. if (!isset($permissions)) {
  4601. $permissions = trim(api_get_setting('permissions_for_new_directories'));
  4602. // The default value 0777 is according to that in the platform administration panel after fresh system installation.
  4603. $permissions = octdec(!empty($permissions) ? $permissions : '0777');
  4604. }
  4605. return $permissions;
  4606. }
  4607. /**
  4608. * Returns the permissions to be assigned to every newly created directory by the web-server.
  4609. * The return value is based on the platform administrator's setting
  4610. * "Administration > Configuration settings > Security > Permissions for new files".
  4611. *
  4612. * @return int returns the permissions in the format
  4613. * "Owner-Group-Others, Read-Write-Execute", as an integer value
  4614. */
  4615. function api_get_permissions_for_new_files()
  4616. {
  4617. static $permissions;
  4618. if (!isset($permissions)) {
  4619. $permissions = trim(api_get_setting('permissions_for_new_files'));
  4620. // The default value 0666 is according to that in the platform
  4621. // administration panel after fresh system installation.
  4622. $permissions = octdec(!empty($permissions) ? $permissions : '0666');
  4623. }
  4624. return $permissions;
  4625. }
  4626. /**
  4627. * Deletes a file, or a folder and its contents.
  4628. *
  4629. * @author Aidan Lister <aidan@php.net>
  4630. *
  4631. * @version 1.0.3
  4632. *
  4633. * @param string $dirname Directory to delete
  4634. * @param bool Deletes only the content or not
  4635. * @param bool $strict if one folder/file fails stop the loop
  4636. *
  4637. * @return bool Returns TRUE on success, FALSE on failure
  4638. *
  4639. * @see http://aidanlister.com/2004/04/recursively-deleting-a-folder-in-php/
  4640. *
  4641. * @author Yannick Warnier, adaptation for the Chamilo LMS, April, 2008
  4642. * @author Ivan Tcholakov, a sanity check about Directory class creation has been added, September, 2009
  4643. */
  4644. function rmdirr($dirname, $delete_only_content_in_folder = false, $strict = false)
  4645. {
  4646. $res = true;
  4647. // A sanity check.
  4648. if (!file_exists($dirname)) {
  4649. return false;
  4650. }
  4651. $php_errormsg = '';
  4652. // Simple delete for a file.
  4653. if (is_file($dirname) || is_link($dirname)) {
  4654. $res = unlink($dirname);
  4655. if ($res === false) {
  4656. error_log(__FILE__.' line '.__LINE__.': '.((bool) ini_get('track_errors') ? $php_errormsg : 'Error not recorded because track_errors is off in your php.ini'), 0);
  4657. }
  4658. return $res;
  4659. }
  4660. // Loop through the folder.
  4661. $dir = dir($dirname);
  4662. // A sanity check.
  4663. $is_object_dir = is_object($dir);
  4664. if ($is_object_dir) {
  4665. while (false !== $entry = $dir->read()) {
  4666. // Skip pointers.
  4667. if ($entry == '.' || $entry == '..') {
  4668. continue;
  4669. }
  4670. // Recurse.
  4671. if ($strict) {
  4672. $result = rmdirr("$dirname/$entry");
  4673. if ($result == false) {
  4674. $res = false;
  4675. break;
  4676. }
  4677. } else {
  4678. rmdirr("$dirname/$entry");
  4679. }
  4680. }
  4681. }
  4682. // Clean up.
  4683. if ($is_object_dir) {
  4684. $dir->close();
  4685. }
  4686. if ($delete_only_content_in_folder == false) {
  4687. $res = rmdir($dirname);
  4688. if ($res === false) {
  4689. error_log(__FILE__.' line '.__LINE__.': '.((bool) ini_get('track_errors') ? $php_errormsg : 'error not recorded because track_errors is off in your php.ini'), 0);
  4690. }
  4691. }
  4692. return $res;
  4693. }
  4694. // TODO: This function is to be simplified. File access modes to be implemented.
  4695. /**
  4696. * function adapted from a php.net comment
  4697. * copy recursively a folder.
  4698. *
  4699. * @param the source folder
  4700. * @param the dest folder
  4701. * @param an array of excluded file_name (without extension)
  4702. * @param copied_files the returned array of copied files
  4703. * @param string $source
  4704. * @param string $dest
  4705. */
  4706. function copyr($source, $dest, $exclude = [], $copied_files = [])
  4707. {
  4708. if (empty($dest)) {
  4709. return false;
  4710. }
  4711. // Simple copy for a file
  4712. if (is_file($source)) {
  4713. $path_info = pathinfo($source);
  4714. if (!in_array($path_info['filename'], $exclude)) {
  4715. copy($source, $dest);
  4716. }
  4717. return true;
  4718. } elseif (!is_dir($source)) {
  4719. //then source is not a dir nor a file, return
  4720. return false;
  4721. }
  4722. // Make destination directory.
  4723. if (!is_dir($dest)) {
  4724. mkdir($dest, api_get_permissions_for_new_directories());
  4725. }
  4726. // Loop through the folder.
  4727. $dir = dir($source);
  4728. while (false !== $entry = $dir->read()) {
  4729. // Skip pointers
  4730. if ($entry == '.' || $entry == '..') {
  4731. continue;
  4732. }
  4733. // Deep copy directories.
  4734. if ($dest !== "$source/$entry") {
  4735. $files = copyr("$source/$entry", "$dest/$entry", $exclude, $copied_files);
  4736. }
  4737. }
  4738. // Clean up.
  4739. $dir->close();
  4740. return true;
  4741. }
  4742. /**
  4743. * @todo: Using DIRECTORY_SEPARATOR is not recommended, this is an obsolete approach.
  4744. * Documentation header to be added here.
  4745. *
  4746. * @param string $pathname
  4747. * @param string $base_path_document
  4748. * @param int $session_id
  4749. *
  4750. * @return mixed True if directory already exists, false if a file already exists at
  4751. * the destination and null if everything goes according to plan
  4752. */
  4753. function copy_folder_course_session(
  4754. $pathname,
  4755. $base_path_document,
  4756. $session_id,
  4757. $course_info,
  4758. $document,
  4759. $source_course_id
  4760. ) {
  4761. $table = Database::get_course_table(TABLE_DOCUMENT);
  4762. $session_id = intval($session_id);
  4763. $source_course_id = intval($source_course_id);
  4764. // Check whether directory already exists.
  4765. if (is_dir($pathname) || empty($pathname)) {
  4766. return true;
  4767. }
  4768. // Ensure that a file with the same name does not already exist.
  4769. if (is_file($pathname)) {
  4770. trigger_error('copy_folder_course_session(): File exists', E_USER_WARNING);
  4771. return false;
  4772. }
  4773. $course_id = $course_info['real_id'];
  4774. $folders = explode(DIRECTORY_SEPARATOR, str_replace($base_path_document.DIRECTORY_SEPARATOR, '', $pathname));
  4775. $new_pathname = $base_path_document;
  4776. $path = '';
  4777. foreach ($folders as $folder) {
  4778. $new_pathname .= DIRECTORY_SEPARATOR.$folder;
  4779. $path .= DIRECTORY_SEPARATOR.$folder;
  4780. if (!file_exists($new_pathname)) {
  4781. $path = Database::escape_string($path);
  4782. $sql = "SELECT * FROM $table
  4783. WHERE
  4784. c_id = $source_course_id AND
  4785. path = '$path' AND
  4786. filetype = 'folder' AND
  4787. session_id = '$session_id'";
  4788. $rs1 = Database::query($sql);
  4789. $num_rows = Database::num_rows($rs1);
  4790. if ($num_rows == 0) {
  4791. mkdir($new_pathname, api_get_permissions_for_new_directories());
  4792. // Insert new folder with destination session_id.
  4793. $params = [
  4794. 'c_id' => $course_id,
  4795. 'path' => $path,
  4796. 'comment' => $document->comment,
  4797. 'title' => basename($new_pathname),
  4798. 'filetype' => 'folder',
  4799. 'size' => '0',
  4800. 'session_id' => $session_id,
  4801. ];
  4802. $document_id = Database::insert($table, $params);
  4803. if ($document_id) {
  4804. $sql = "UPDATE $table SET id = iid WHERE iid = $document_id";
  4805. Database::query($sql);
  4806. api_item_property_update(
  4807. $course_info,
  4808. TOOL_DOCUMENT,
  4809. $document_id,
  4810. 'FolderCreated',
  4811. api_get_user_id(),
  4812. 0,
  4813. 0,
  4814. null,
  4815. null,
  4816. $session_id
  4817. );
  4818. }
  4819. }
  4820. }
  4821. } // en foreach
  4822. }
  4823. // TODO: chmodr() is a better name. Some corrections are needed. Documentation header to be added here.
  4824. /**
  4825. * @param string $path
  4826. */
  4827. function api_chmod_R($path, $filemode)
  4828. {
  4829. if (!is_dir($path)) {
  4830. return chmod($path, $filemode);
  4831. }
  4832. $handler = opendir($path);
  4833. while ($file = readdir($handler)) {
  4834. if ($file != '.' && $file != '..') {
  4835. $fullpath = "$path/$file";
  4836. if (!is_dir($fullpath)) {
  4837. if (!chmod($fullpath, $filemode)) {
  4838. return false;
  4839. }
  4840. } else {
  4841. if (!api_chmod_R($fullpath, $filemode)) {
  4842. return false;
  4843. }
  4844. }
  4845. }
  4846. }
  4847. closedir($handler);
  4848. return chmod($path, $filemode);
  4849. }
  4850. // TODO: Where the following function has been copy/pased from? There is no information about author and license. Style, coding conventions...
  4851. /**
  4852. * Parse info file format. (e.g: file.info).
  4853. *
  4854. * Files should use an ini-like format to specify values.
  4855. * White-space generally doesn't matter, except inside values.
  4856. * e.g.
  4857. *
  4858. * @verbatim
  4859. * key = value
  4860. * key = "value"
  4861. * key = 'value'
  4862. * key = "multi-line
  4863. *
  4864. * value"
  4865. * key = 'multi-line
  4866. *
  4867. * value'
  4868. * key
  4869. * =
  4870. * 'value'
  4871. * @endverbatim
  4872. *
  4873. * Arrays are created using a GET-like syntax:
  4874. *
  4875. * @verbatim
  4876. * key[] = "numeric array"
  4877. * key[index] = "associative array"
  4878. * key[index][] = "nested numeric array"
  4879. * key[index][index] = "nested associative array"
  4880. * @endverbatim
  4881. *
  4882. * PHP constants are substituted in, but only when used as the entire value:
  4883. *
  4884. * Comments should start with a semi-colon at the beginning of a line.
  4885. *
  4886. * This function is NOT for placing arbitrary module-specific settings. Use
  4887. * variable_get() and variable_set() for that.
  4888. *
  4889. * Information stored in the module.info file:
  4890. * - name: The real name of the module for display purposes.
  4891. * - description: A brief description of the module.
  4892. * - dependencies: An array of shortnames of other modules this module depends on.
  4893. * - package: The name of the package of modules this module belongs to.
  4894. *
  4895. * Example of .info file:
  4896. * <code>
  4897. * @verbatim
  4898. * name = Forum
  4899. * description = Enables threaded discussions about general topics.
  4900. * dependencies[] = taxonomy
  4901. * dependencies[] = comment
  4902. * package = Core - optional
  4903. * version = VERSION
  4904. * @endverbatim
  4905. * </code>
  4906. *
  4907. * @param string $filename
  4908. * The file we are parsing. Accepts file with relative or absolute path.
  4909. *
  4910. * @return
  4911. * The info array
  4912. */
  4913. function api_parse_info_file($filename)
  4914. {
  4915. $info = [];
  4916. if (!file_exists($filename)) {
  4917. return $info;
  4918. }
  4919. $data = file_get_contents($filename);
  4920. if (preg_match_all('
  4921. @^\s* # Start at the beginning of a line, ignoring leading whitespace
  4922. ((?:
  4923. [^=;\[\]]| # Key names cannot contain equal signs, semi-colons or square brackets,
  4924. \[[^\[\]]*\] # unless they are balanced and not nested
  4925. )+?)
  4926. \s*=\s* # Key/value pairs are separated by equal signs (ignoring white-space)
  4927. (?:
  4928. ("(?:[^"]|(?<=\\\\)")*")| # Double-quoted string, which may contain slash-escaped quotes/slashes
  4929. (\'(?:[^\']|(?<=\\\\)\')*\')| # Single-quoted string, which may contain slash-escaped quotes/slashes
  4930. ([^\r\n]*?) # Non-quoted string
  4931. )\s*$ # Stop at the next end of a line, ignoring trailing whitespace
  4932. @msx', $data, $matches, PREG_SET_ORDER)) {
  4933. $key = $value1 = $value2 = $value3 = '';
  4934. foreach ($matches as $match) {
  4935. // Fetch the key and value string.
  4936. $i = 0;
  4937. foreach (['key', 'value1', 'value2', 'value3'] as $var) {
  4938. $$var = isset($match[++$i]) ? $match[$i] : '';
  4939. }
  4940. $value = stripslashes(substr($value1, 1, -1)).stripslashes(substr($value2, 1, -1)).$value3;
  4941. // Parse array syntax.
  4942. $keys = preg_split('/\]?\[/', rtrim($key, ']'));
  4943. $last = array_pop($keys);
  4944. $parent = &$info;
  4945. // Create nested arrays.
  4946. foreach ($keys as $key) {
  4947. if ($key == '') {
  4948. $key = count($parent);
  4949. }
  4950. if (!isset($parent[$key]) || !is_array($parent[$key])) {
  4951. $parent[$key] = [];
  4952. }
  4953. $parent = &$parent[$key];
  4954. }
  4955. // Handle PHP constants.
  4956. if (defined($value)) {
  4957. $value = constant($value);
  4958. }
  4959. // Insert actual value.
  4960. if ($last == '') {
  4961. $last = count($parent);
  4962. }
  4963. $parent[$last] = $value;
  4964. }
  4965. }
  4966. return $info;
  4967. }
  4968. /**
  4969. * Gets Chamilo version from the configuration files.
  4970. *
  4971. * @return string A string of type "1.8.4", or an empty string if the version could not be found
  4972. */
  4973. function api_get_version()
  4974. {
  4975. return (string) api_get_configuration_value('system_version');
  4976. }
  4977. /**
  4978. * Gets the software name (the name/brand of the Chamilo-based customized system).
  4979. *
  4980. * @return string
  4981. */
  4982. function api_get_software_name()
  4983. {
  4984. $name = api_get_configuration_value('software_name');
  4985. if (!empty($name)) {
  4986. return $name;
  4987. } else {
  4988. return 'Chamilo';
  4989. }
  4990. }
  4991. /**
  4992. * Checks whether status given in parameter exists in the platform.
  4993. *
  4994. * @param mixed the status (can be either int either string)
  4995. *
  4996. * @return bool if the status exists, else returns false
  4997. */
  4998. function api_status_exists($status_asked)
  4999. {
  5000. global $_status_list;
  5001. return in_array($status_asked, $_status_list) ? true : isset($_status_list[$status_asked]);
  5002. }
  5003. /**
  5004. * Checks whether status given in parameter exists in the platform. The function
  5005. * returns the status ID or false if it does not exist, but given the fact there
  5006. * is no "0" status, the return value can be checked against
  5007. * if(api_status_key()) to know if it exists.
  5008. *
  5009. * @param mixed The status (can be either int or string)
  5010. *
  5011. * @return mixed Status ID if exists, false otherwise
  5012. */
  5013. function api_status_key($status)
  5014. {
  5015. global $_status_list;
  5016. return isset($_status_list[$status]) ? $status : array_search($status, $_status_list);
  5017. }
  5018. /**
  5019. * Gets the status langvars list.
  5020. *
  5021. * @return string[] the list of status with their translations
  5022. */
  5023. function api_get_status_langvars()
  5024. {
  5025. return [
  5026. COURSEMANAGER => get_lang('Teacher', ''),
  5027. SESSIONADMIN => get_lang('SessionsAdmin', ''),
  5028. DRH => get_lang('Drh', ''),
  5029. STUDENT => get_lang('Student', ''),
  5030. ANONYMOUS => get_lang('Anonymous', ''),
  5031. STUDENT_BOSS => get_lang('RoleStudentBoss', ''),
  5032. INVITEE => get_lang('Invited'),
  5033. ];
  5034. }
  5035. /**
  5036. * The function that retrieves all the possible settings for a certain config setting.
  5037. *
  5038. * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
  5039. */
  5040. function api_get_settings_options($var)
  5041. {
  5042. $table_settings_options = Database::get_main_table(TABLE_MAIN_SETTINGS_OPTIONS);
  5043. $var = Database::escape_string($var);
  5044. $sql = "SELECT * FROM $table_settings_options
  5045. WHERE variable = '$var'
  5046. ORDER BY id";
  5047. $result = Database::query($sql);
  5048. $settings_options_array = [];
  5049. while ($row = Database::fetch_array($result, 'ASSOC')) {
  5050. $settings_options_array[] = $row;
  5051. }
  5052. return $settings_options_array;
  5053. }
  5054. /**
  5055. * @param array $params
  5056. */
  5057. function api_set_setting_option($params)
  5058. {
  5059. $table = Database::get_main_table(TABLE_MAIN_SETTINGS_OPTIONS);
  5060. if (empty($params['id'])) {
  5061. Database::insert($table, $params);
  5062. } else {
  5063. Database::update($table, $params, ['id = ? ' => $params['id']]);
  5064. }
  5065. }
  5066. /**
  5067. * @param array $params
  5068. */
  5069. function api_set_setting_simple($params)
  5070. {
  5071. $table = Database::get_main_table(TABLE_MAIN_SETTINGS_CURRENT);
  5072. $url_id = api_get_current_access_url_id();
  5073. if (empty($params['id'])) {
  5074. $params['access_url'] = $url_id;
  5075. Database::insert($table, $params);
  5076. } else {
  5077. Database::update($table, $params, ['id = ? ' => [$params['id']]]);
  5078. }
  5079. }
  5080. /**
  5081. * @param int $id
  5082. */
  5083. function api_delete_setting_option($id)
  5084. {
  5085. $table = Database::get_main_table(TABLE_MAIN_SETTINGS_OPTIONS);
  5086. if (!empty($id)) {
  5087. Database::delete($table, ['id = ? ' => $id]);
  5088. }
  5089. }
  5090. /**
  5091. * Sets a platform configuration setting to a given value.
  5092. *
  5093. * @param string The variable we want to update
  5094. * @param string The value we want to record
  5095. * @param string The sub-variable if any (in most cases, this will remain null)
  5096. * @param string The category if any (in most cases, this will remain null)
  5097. * @param int The access_url for which this parameter is valid
  5098. * @param string $cat
  5099. *
  5100. * @return bool|null
  5101. */
  5102. function api_set_setting($var, $value, $subvar = null, $cat = null, $access_url = 1)
  5103. {
  5104. if (empty($var)) {
  5105. return false;
  5106. }
  5107. $t_settings = Database::get_main_table(TABLE_MAIN_SETTINGS_CURRENT);
  5108. $var = Database::escape_string($var);
  5109. $value = Database::escape_string($value);
  5110. $access_url = (int) $access_url;
  5111. if (empty($access_url)) {
  5112. $access_url = 1;
  5113. }
  5114. $select = "SELECT id FROM $t_settings WHERE variable = '$var' ";
  5115. if (!empty($subvar)) {
  5116. $subvar = Database::escape_string($subvar);
  5117. $select .= " AND subkey = '$subvar'";
  5118. }
  5119. if (!empty($cat)) {
  5120. $cat = Database::escape_string($cat);
  5121. $select .= " AND category = '$cat'";
  5122. }
  5123. if ($access_url > 1) {
  5124. $select .= " AND access_url = $access_url";
  5125. } else {
  5126. $select .= " AND access_url = 1 ";
  5127. }
  5128. $res = Database::query($select);
  5129. if (Database::num_rows($res) > 0) {
  5130. // Found item for this access_url.
  5131. $row = Database::fetch_array($res);
  5132. $sql = "UPDATE $t_settings SET selected_value = '$value'
  5133. WHERE id = ".$row['id'];
  5134. Database::query($sql);
  5135. } else {
  5136. // Item not found for this access_url, we have to check if it exist with access_url = 1
  5137. $select = "SELECT * FROM $t_settings
  5138. WHERE variable = '$var' AND access_url = 1 ";
  5139. // Just in case
  5140. if ($access_url == 1) {
  5141. if (!empty($subvar)) {
  5142. $select .= " AND subkey = '$subvar'";
  5143. }
  5144. if (!empty($cat)) {
  5145. $select .= " AND category = '$cat'";
  5146. }
  5147. $res = Database::query($select);
  5148. if (Database::num_rows($res) > 0) {
  5149. // We have a setting for access_url 1, but none for the current one, so create one.
  5150. $row = Database::fetch_array($res);
  5151. $insert = "INSERT INTO $t_settings (variable, subkey, type,category, selected_value, title, comment, scope, subkeytext, access_url)
  5152. VALUES
  5153. ('".$row['variable']."',".(!empty($row['subkey']) ? "'".$row['subkey']."'" : "NULL").",".
  5154. "'".$row['type']."','".$row['category']."',".
  5155. "'$value','".$row['title']."',".
  5156. "".(!empty($row['comment']) ? "'".$row['comment']."'" : "NULL").",".(!empty($row['scope']) ? "'".$row['scope']."'" : "NULL").",".
  5157. "".(!empty($row['subkeytext']) ? "'".$row['subkeytext']."'" : "NULL").",$access_url)";
  5158. Database::query($insert);
  5159. } else {
  5160. // Such a setting does not exist.
  5161. //error_log(__FILE__.':'.__LINE__.': Attempting to update setting '.$var.' ('.$subvar.') which does not exist at all', 0);
  5162. }
  5163. } else {
  5164. // Other access url.
  5165. if (!empty($subvar)) {
  5166. $select .= " AND subkey = '$subvar'";
  5167. }
  5168. if (!empty($cat)) {
  5169. $select .= " AND category = '$cat'";
  5170. }
  5171. $res = Database::query($select);
  5172. if (Database::num_rows($res) > 0) {
  5173. // We have a setting for access_url 1, but none for the current one, so create one.
  5174. $row = Database::fetch_array($res);
  5175. if ($row['access_url_changeable'] == 1) {
  5176. $insert = "INSERT INTO $t_settings (variable,subkey, type,category, selected_value,title, comment,scope, subkeytext,access_url, access_url_changeable) VALUES
  5177. ('".$row['variable']."',".
  5178. (!empty($row['subkey']) ? "'".$row['subkey']."'" : "NULL").",".
  5179. "'".$row['type']."','".$row['category']."',".
  5180. "'$value','".$row['title']."',".
  5181. "".(!empty($row['comment']) ? "'".$row['comment']."'" : "NULL").",".
  5182. (!empty($row['scope']) ? "'".$row['scope']."'" : "NULL").",".
  5183. "".(!empty($row['subkeytext']) ? "'".$row['subkeytext']."'" : "NULL").",$access_url,".$row['access_url_changeable'].")";
  5184. Database::query($insert);
  5185. }
  5186. } else { // Such a setting does not exist.
  5187. //error_log(__FILE__.':'.__LINE__.': Attempting to update setting '.$var.' ('.$subvar.') which does not exist at all. The access_url is: '.$access_url.' ',0);
  5188. }
  5189. }
  5190. }
  5191. }
  5192. /**
  5193. * Sets a whole category of settings to one specific value.
  5194. *
  5195. * @param string Category
  5196. * @param string Value
  5197. * @param int Access URL. Optional. Defaults to 1
  5198. * @param array Optional array of filters on field type
  5199. * @param string $category
  5200. * @param string $value
  5201. *
  5202. * @return bool
  5203. */
  5204. function api_set_settings_category($category, $value = null, $access_url = 1, $fieldtype = [])
  5205. {
  5206. if (empty($category)) {
  5207. return false;
  5208. }
  5209. $category = Database::escape_string($category);
  5210. $t_s = Database::get_main_table(TABLE_MAIN_SETTINGS_CURRENT);
  5211. $access_url = (int) $access_url;
  5212. if (empty($access_url)) {
  5213. $access_url = 1;
  5214. }
  5215. if (isset($value)) {
  5216. $value = Database::escape_string($value);
  5217. $sql = "UPDATE $t_s SET selected_value = '$value'
  5218. WHERE category = '$category' AND access_url = $access_url";
  5219. if (is_array($fieldtype) && count($fieldtype) > 0) {
  5220. $sql .= " AND ( ";
  5221. $i = 0;
  5222. foreach ($fieldtype as $type) {
  5223. if ($i > 0) {
  5224. $sql .= ' OR ';
  5225. }
  5226. $type = Database::escape_string($type);
  5227. $sql .= " type='".$type."' ";
  5228. $i++;
  5229. }
  5230. $sql .= ")";
  5231. }
  5232. $res = Database::query($sql);
  5233. return $res !== false;
  5234. } else {
  5235. $sql = "UPDATE $t_s SET selected_value = NULL
  5236. WHERE category = '$category' AND access_url = $access_url";
  5237. if (is_array($fieldtype) && count($fieldtype) > 0) {
  5238. $sql .= " AND ( ";
  5239. $i = 0;
  5240. foreach ($fieldtype as $type) {
  5241. if ($i > 0) {
  5242. $sql .= ' OR ';
  5243. }
  5244. $type = Database::escape_string($type);
  5245. $sql .= " type='".$type."' ";
  5246. $i++;
  5247. }
  5248. $sql .= ")";
  5249. }
  5250. $res = Database::query($sql);
  5251. return $res !== false;
  5252. }
  5253. }
  5254. /**
  5255. * Gets all available access urls in an array (as in the database).
  5256. *
  5257. * @return array An array of database records
  5258. */
  5259. function api_get_access_urls($from = 0, $to = 1000000, $order = 'url', $direction = 'ASC')
  5260. {
  5261. $table = Database::get_main_table(TABLE_MAIN_ACCESS_URL);
  5262. $from = (int) $from;
  5263. $to = (int) $to;
  5264. $order = Database::escape_string($order, null, false);
  5265. $direction = Database::escape_string($direction, null, false);
  5266. $sql = "SELECT id, url, description, active, created_by, tms
  5267. FROM $table
  5268. ORDER BY $order $direction
  5269. LIMIT $to OFFSET $from";
  5270. $res = Database::query($sql);
  5271. return Database::store_result($res);
  5272. }
  5273. /**
  5274. * Gets the access url info in an array.
  5275. *
  5276. * @param int $id Id of the access url
  5277. * @param bool $returnDefault Set to false if you want the real URL if URL 1 is still 'http://localhost/'
  5278. *
  5279. * @return array All the info (url, description, active, created_by, tms)
  5280. * from the access_url table
  5281. *
  5282. * @author Julio Montoya
  5283. */
  5284. function api_get_access_url($id, $returnDefault = true)
  5285. {
  5286. static $staticResult;
  5287. $id = (int) $id;
  5288. if (isset($staticResult[$id])) {
  5289. $result = $staticResult[$id];
  5290. } else {
  5291. // Calling the Database:: library dont work this is handmade.
  5292. $table_access_url = Database::get_main_table(TABLE_MAIN_ACCESS_URL);
  5293. $sql = "SELECT url, description, active, created_by, tms
  5294. FROM $table_access_url WHERE id = '$id' ";
  5295. $res = Database::query($sql);
  5296. $result = @Database::fetch_array($res);
  5297. $staticResult[$id] = $result;
  5298. }
  5299. // If the result url is 'http://localhost/' (the default) and the root_web
  5300. // (=current url) is different, and the $id is = 1 (which might mean
  5301. // api_get_current_access_url_id() returned 1 by default), then return the
  5302. // root_web setting instead of the current URL
  5303. // This is provided as an option to avoid breaking the storage of URL-specific
  5304. // homepages in home/localhost/
  5305. if ($id === 1 && $returnDefault === false) {
  5306. $currentUrl = api_get_current_access_url_id();
  5307. // only do this if we are on the main URL (=1), otherwise we could get
  5308. // information on another URL instead of the one asked as parameter
  5309. if ($currentUrl === 1) {
  5310. $rootWeb = api_get_path(WEB_PATH);
  5311. $default = 'http://localhost/';
  5312. if ($result['url'] === $default && $rootWeb != $default) {
  5313. $result['url'] = $rootWeb;
  5314. }
  5315. }
  5316. }
  5317. return $result;
  5318. }
  5319. /**
  5320. * Gets all the current settings for a specific access url.
  5321. *
  5322. * @param string The category, if any, that we want to get
  5323. * @param string Whether we want a simple list (display a category) or
  5324. * a grouped list (group by variable as in settings.php default). Values: 'list' or 'group'
  5325. * @param int Access URL's ID. Optional. Uses 1 by default, which is the unique URL
  5326. *
  5327. * @return array Array of database results for the current settings of the current access URL
  5328. */
  5329. function &api_get_settings($cat = null, $ordering = 'list', $access_url = 1, $url_changeable = 0)
  5330. {
  5331. $table = Database::get_main_table(TABLE_MAIN_SETTINGS_CURRENT);
  5332. $access_url = (int) $access_url;
  5333. $where_condition = '';
  5334. if ($url_changeable == 1) {
  5335. $where_condition = " AND access_url_changeable= '1' ";
  5336. }
  5337. if (empty($access_url) || $access_url == -1) {
  5338. $access_url = 1;
  5339. }
  5340. $sql = "SELECT * FROM $table
  5341. WHERE access_url = $access_url $where_condition ";
  5342. if (!empty($cat)) {
  5343. $cat = Database::escape_string($cat);
  5344. $sql .= " AND category='$cat' ";
  5345. }
  5346. if ($ordering == 'group') {
  5347. $sql .= " ORDER BY id ASC";
  5348. } else {
  5349. $sql .= " ORDER BY 1,2 ASC";
  5350. }
  5351. $result = Database::query($sql);
  5352. if ($result === null) {
  5353. return [];
  5354. }
  5355. $result = Database::store_result($result, 'ASSOC');
  5356. return $result;
  5357. }
  5358. /**
  5359. * @param string $value The value we want to record
  5360. * @param string $variable The variable name we want to insert
  5361. * @param string $subKey The subkey for the variable we want to insert
  5362. * @param string $type The type for the variable we want to insert
  5363. * @param string $category The category for the variable we want to insert
  5364. * @param string $title The title
  5365. * @param string $comment The comment
  5366. * @param string $scope The scope
  5367. * @param string $subKeyText The subkey text
  5368. * @param int $accessUrlId The access_url for which this parameter is valid
  5369. * @param int $visibility The changeability of this setting for non-master urls
  5370. *
  5371. * @return int The setting ID
  5372. */
  5373. function api_add_setting(
  5374. $value,
  5375. $variable,
  5376. $subKey = '',
  5377. $type = 'textfield',
  5378. $category = '',
  5379. $title = '',
  5380. $comment = '',
  5381. $scope = '',
  5382. $subKeyText = '',
  5383. $accessUrlId = 1,
  5384. $visibility = 0
  5385. ) {
  5386. $em = Database::getManager();
  5387. $settingRepo = $em->getRepository('ChamiloCoreBundle:SettingsCurrent');
  5388. $accessUrlId = (int) $accessUrlId ?: 1;
  5389. if (is_array($value)) {
  5390. $value = serialize($value);
  5391. } else {
  5392. $value = trim($value);
  5393. }
  5394. $criteria = ['variable' => $variable, 'accessUrl' => $accessUrlId];
  5395. if (!empty($subKey)) {
  5396. $criteria['subkey'] = $subKey;
  5397. }
  5398. // Check if this variable doesn't exist already
  5399. /** @var SettingsCurrent $setting */
  5400. $setting = $settingRepo->findOneBy($criteria);
  5401. if ($setting) {
  5402. $setting->setSelectedValue($value);
  5403. $em->persist($setting);
  5404. $em->flush();
  5405. return $setting->getId();
  5406. }
  5407. // Item not found for this access_url, we have to check if the whole thing is missing
  5408. // (in which case we ignore the insert) or if there *is* a record but just for access_url = 1
  5409. $setting = new SettingsCurrent();
  5410. $setting
  5411. ->setVariable($variable)
  5412. ->setSelectedValue($value)
  5413. ->setType($type)
  5414. ->setCategory($category)
  5415. ->setSubkey($subKey)
  5416. ->setTitle($title)
  5417. ->setComment($comment)
  5418. ->setScope($scope)
  5419. ->setSubkeytext($subKeyText)
  5420. ->setAccessUrl($accessUrlId)
  5421. ->setAccessUrlChangeable($visibility);
  5422. $em->persist($setting);
  5423. $em->flush();
  5424. return $setting->getId();
  5425. }
  5426. /**
  5427. * Checks wether a user can or can't view the contents of a course.
  5428. *
  5429. * @deprecated use CourseManager::is_user_subscribed_in_course
  5430. *
  5431. * @param int $userid User id or NULL to get it from $_SESSION
  5432. * @param int $cid course id to check whether the user is allowed
  5433. *
  5434. * @return bool
  5435. */
  5436. function api_is_course_visible_for_user($userid = null, $cid = null)
  5437. {
  5438. if ($userid === null) {
  5439. $userid = api_get_user_id();
  5440. }
  5441. if (empty($userid) || strval(intval($userid)) != $userid) {
  5442. if (api_is_anonymous()) {
  5443. $userid = api_get_anonymous_id();
  5444. } else {
  5445. return false;
  5446. }
  5447. }
  5448. $cid = Database::escape_string($cid);
  5449. $courseInfo = api_get_course_info($cid);
  5450. $courseId = $courseInfo['real_id'];
  5451. $is_platformAdmin = api_is_platform_admin();
  5452. $course_table = Database::get_main_table(TABLE_MAIN_COURSE);
  5453. $course_cat_table = Database::get_main_table(TABLE_MAIN_CATEGORY);
  5454. $sql = "SELECT
  5455. $course_table.category_code,
  5456. $course_table.visibility,
  5457. $course_table.code,
  5458. $course_cat_table.code
  5459. FROM $course_table
  5460. LEFT JOIN $course_cat_table
  5461. ON $course_table.category_code = $course_cat_table.code
  5462. WHERE
  5463. $course_table.code = '$cid'
  5464. LIMIT 1";
  5465. $result = Database::query($sql);
  5466. if (Database::num_rows($result) > 0) {
  5467. $visibility = Database::fetch_array($result);
  5468. $visibility = $visibility['visibility'];
  5469. } else {
  5470. $visibility = 0;
  5471. }
  5472. // Shortcut permissions in case the visibility is "open to the world".
  5473. if ($visibility === COURSE_VISIBILITY_OPEN_WORLD) {
  5474. return true;
  5475. }
  5476. $tbl_course_user = Database::get_main_table(TABLE_MAIN_COURSE_USER);
  5477. $sql = "SELECT
  5478. is_tutor, status
  5479. FROM $tbl_course_user
  5480. WHERE
  5481. user_id = '$userid' AND
  5482. relation_type <> '".COURSE_RELATION_TYPE_RRHH."' AND
  5483. c_id = $courseId
  5484. LIMIT 1";
  5485. $result = Database::query($sql);
  5486. if (Database::num_rows($result) > 0) {
  5487. // This user has got a recorded state for this course.
  5488. $cuData = Database::fetch_array($result);
  5489. $is_courseMember = true;
  5490. $is_courseAdmin = ($cuData['status'] == 1);
  5491. }
  5492. if (!$is_courseAdmin) {
  5493. // This user has no status related to this course.
  5494. // Is it the session coach or the session admin?
  5495. $tbl_session = Database::get_main_table(TABLE_MAIN_SESSION);
  5496. $tbl_session_course = Database::get_main_table(TABLE_MAIN_SESSION_COURSE);
  5497. $tbl_session_course_user = Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER);
  5498. $sql = "SELECT
  5499. session.id_coach, session_admin_id, session.id
  5500. FROM
  5501. $tbl_session as session
  5502. INNER JOIN $tbl_session_course
  5503. ON session_rel_course.session_id = session.id
  5504. AND session_rel_course.c_id = '$courseId'
  5505. LIMIT 1";
  5506. $result = Database::query($sql);
  5507. $row = Database::store_result($result);
  5508. if ($row[0]['id_coach'] == $userid) {
  5509. $is_courseMember = true;
  5510. $is_courseAdmin = false;
  5511. } elseif ($row[0]['session_admin_id'] == $userid) {
  5512. $is_courseMember = false;
  5513. $is_courseAdmin = false;
  5514. } else {
  5515. // Check if the current user is the course coach.
  5516. $sql = "SELECT 1
  5517. FROM $tbl_session_course
  5518. WHERE session_rel_course.c_id = '$courseId'
  5519. AND session_rel_course.id_coach = '$userid'
  5520. LIMIT 1";
  5521. $result = Database::query($sql);
  5522. //if ($row = Database::fetch_array($result)) {
  5523. if (Database::num_rows($result) > 0) {
  5524. $is_courseMember = true;
  5525. $tbl_user = Database::get_main_table(TABLE_MAIN_USER);
  5526. $sql = "SELECT status FROM $tbl_user
  5527. WHERE user_id = $userid
  5528. LIMIT 1";
  5529. $result = Database::query($sql);
  5530. if (Database::result($result, 0, 0) == 1) {
  5531. $is_courseAdmin = true;
  5532. } else {
  5533. $is_courseAdmin = false;
  5534. }
  5535. } else {
  5536. // Check if the user is a student is this session.
  5537. $sql = "SELECT id
  5538. FROM $tbl_session_course_user
  5539. WHERE
  5540. user_id = '$userid' AND
  5541. c_id = '$courseId'
  5542. LIMIT 1";
  5543. if (Database::num_rows($result) > 0) {
  5544. // This user haa got a recorded state for this course.
  5545. while ($row = Database::fetch_array($result)) {
  5546. $is_courseMember = true;
  5547. $is_courseAdmin = false;
  5548. }
  5549. }
  5550. }
  5551. }
  5552. }
  5553. switch ($visibility) {
  5554. case COURSE_VISIBILITY_OPEN_WORLD:
  5555. return true;
  5556. case COURSE_VISIBILITY_OPEN_PLATFORM:
  5557. return isset($userid);
  5558. case COURSE_VISIBILITY_REGISTERED:
  5559. case COURSE_VISIBILITY_CLOSED:
  5560. return $is_platformAdmin || $is_courseMember || $is_courseAdmin;
  5561. case COURSE_VISIBILITY_HIDDEN:
  5562. return $is_platformAdmin;
  5563. }
  5564. return false;
  5565. }
  5566. /**
  5567. * Returns whether an element (forum, message, survey ...) belongs to a session or not.
  5568. *
  5569. * @param string the tool of the element
  5570. * @param int the element id in database
  5571. * @param int the session_id to compare with element session id
  5572. *
  5573. * @return bool true if the element is in the session, false else
  5574. */
  5575. function api_is_element_in_the_session($tool, $element_id, $session_id = null)
  5576. {
  5577. if (is_null($session_id)) {
  5578. $session_id = api_get_session_id();
  5579. }
  5580. $element_id = (int) $element_id;
  5581. if (empty($element_id)) {
  5582. return false;
  5583. }
  5584. // Get information to build query depending of the tool.
  5585. switch ($tool) {
  5586. case TOOL_SURVEY:
  5587. $table_tool = Database::get_course_table(TABLE_SURVEY);
  5588. $key_field = 'survey_id';
  5589. break;
  5590. case TOOL_ANNOUNCEMENT:
  5591. $table_tool = Database::get_course_table(TABLE_ANNOUNCEMENT);
  5592. $key_field = 'id';
  5593. break;
  5594. case TOOL_AGENDA:
  5595. $table_tool = Database::get_course_table(TABLE_AGENDA);
  5596. $key_field = 'id';
  5597. break;
  5598. case TOOL_GROUP:
  5599. $table_tool = Database::get_course_table(TABLE_GROUP);
  5600. $key_field = 'id';
  5601. break;
  5602. default:
  5603. return false;
  5604. }
  5605. $course_id = api_get_course_int_id();
  5606. $sql = "SELECT session_id FROM $table_tool
  5607. WHERE c_id = $course_id AND $key_field = ".$element_id;
  5608. $rs = Database::query($sql);
  5609. if ($element_session_id = Database::result($rs, 0, 0)) {
  5610. if ($element_session_id == intval($session_id)) {
  5611. // The element belongs to the session.
  5612. return true;
  5613. }
  5614. }
  5615. return false;
  5616. }
  5617. /**
  5618. * Replaces "forbidden" characters in a filename string.
  5619. *
  5620. * @param string $filename
  5621. * @param bool $treat_spaces_as_hyphens
  5622. *
  5623. * @return string
  5624. */
  5625. function api_replace_dangerous_char($filename, $treat_spaces_as_hyphens = true)
  5626. {
  5627. // Some non-properly encoded file names can cause the whole file to be
  5628. // skipped when uploaded. Avoid this by detecting the encoding and
  5629. // converting to UTF-8, setting the source as ASCII (a reasonably
  5630. // limited characters set) if nothing could be found (BT#
  5631. $encoding = api_detect_encoding($filename);
  5632. if (empty($encoding)) {
  5633. $encoding = 'ASCII';
  5634. if (!api_is_valid_ascii($filename)) {
  5635. // try iconv and try non standard ASCII a.k.a CP437
  5636. // see BT#15022
  5637. if (function_exists('iconv')) {
  5638. $result = iconv('CP437', 'UTF-8', $filename);
  5639. if (api_is_valid_utf8($result)) {
  5640. $filename = $result;
  5641. $encoding = 'UTF-8';
  5642. }
  5643. }
  5644. }
  5645. }
  5646. $filename = api_to_system_encoding($filename, $encoding);
  5647. $url = URLify::filter(
  5648. $filename,
  5649. 250,
  5650. '',
  5651. true,
  5652. true,
  5653. false,
  5654. false,
  5655. $treat_spaces_as_hyphens
  5656. );
  5657. return $url;
  5658. }
  5659. /**
  5660. * Fixes the $_SERVER['REQUEST_URI'] that is empty in IIS6.
  5661. *
  5662. * @author Ivan Tcholakov, 28-JUN-2006.
  5663. */
  5664. function api_request_uri()
  5665. {
  5666. if (!empty($_SERVER['REQUEST_URI'])) {
  5667. return $_SERVER['REQUEST_URI'];
  5668. }
  5669. $uri = $_SERVER['SCRIPT_NAME'];
  5670. if (!empty($_SERVER['QUERY_STRING'])) {
  5671. $uri .= '?'.$_SERVER['QUERY_STRING'];
  5672. }
  5673. $_SERVER['REQUEST_URI'] = $uri;
  5674. return $uri;
  5675. }
  5676. /** Gets the current access_url id of the Chamilo Platform
  5677. * @author Julio Montoya <gugli100@gmail.com>
  5678. *
  5679. * @return int access_url_id of the current Chamilo Installation
  5680. */
  5681. function api_get_current_access_url_id()
  5682. {
  5683. $access_url_table = Database::get_main_table(TABLE_MAIN_ACCESS_URL);
  5684. $path = Database::escape_string(api_get_path(WEB_PATH));
  5685. $sql = "SELECT id FROM $access_url_table WHERE url = '".$path."'";
  5686. $result = Database::query($sql);
  5687. if (Database::num_rows($result) > 0) {
  5688. $access_url_id = Database::result($result, 0, 0);
  5689. if ($access_url_id === false) {
  5690. return -1;
  5691. }
  5692. return (int) $access_url_id;
  5693. }
  5694. //if the url in WEB_PATH was not found, it can only mean that there is
  5695. // either a configuration problem or the first URL has not been defined yet
  5696. // (by default it is http://localhost/). Thus the more sensible thing we can
  5697. // do is return 1 (the main URL) as the user cannot hack this value anyway
  5698. return 1;
  5699. }
  5700. /**
  5701. * Gets the registered urls from a given user id.
  5702. *
  5703. * @author Julio Montoya <gugli100@gmail.com>
  5704. *
  5705. * @return int user id
  5706. */
  5707. function api_get_access_url_from_user($user_id)
  5708. {
  5709. $user_id = (int) $user_id;
  5710. $table_url_rel_user = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_USER);
  5711. $table_url = Database::get_main_table(TABLE_MAIN_ACCESS_URL);
  5712. $sql = "SELECT access_url_id
  5713. FROM $table_url_rel_user url_rel_user
  5714. INNER JOIN $table_url u
  5715. ON (url_rel_user.access_url_id = u.id)
  5716. WHERE user_id = ".intval($user_id);
  5717. $result = Database::query($sql);
  5718. $list = [];
  5719. while ($row = Database::fetch_array($result, 'ASSOC')) {
  5720. $list[] = $row['access_url_id'];
  5721. }
  5722. return $list;
  5723. }
  5724. /**
  5725. * Gets the status of a user in a course.
  5726. *
  5727. * @param int $user_id
  5728. * @param int $courseId
  5729. *
  5730. * @return int user status
  5731. */
  5732. function api_get_status_of_user_in_course($user_id, $courseId)
  5733. {
  5734. $tbl_rel_course_user = Database::get_main_table(TABLE_MAIN_COURSE_USER);
  5735. if (!empty($user_id) && !empty($courseId)) {
  5736. $user_id = intval($user_id);
  5737. $courseId = intval($courseId);
  5738. $sql = 'SELECT status
  5739. FROM '.$tbl_rel_course_user.'
  5740. WHERE user_id='.$user_id.' AND c_id = '.$courseId;
  5741. $result = Database::query($sql);
  5742. $row_status = Database::fetch_array($result, 'ASSOC');
  5743. return $row_status['status'];
  5744. } else {
  5745. return 0;
  5746. }
  5747. }
  5748. /**
  5749. * Checks whether the curent user is in a group or not.
  5750. *
  5751. * @param string The group id - optional (takes it from session if not given)
  5752. * @param string The course code - optional (no additional check by course if course code is not given)
  5753. *
  5754. * @return bool
  5755. *
  5756. * @author Ivan Tcholakov
  5757. */
  5758. function api_is_in_group($groupIdParam = null, $courseCodeParam = null)
  5759. {
  5760. if (!empty($courseCodeParam)) {
  5761. $courseCode = api_get_course_id();
  5762. if (!empty($courseCode)) {
  5763. if ($courseCodeParam != $courseCode) {
  5764. return false;
  5765. }
  5766. } else {
  5767. return false;
  5768. }
  5769. }
  5770. $groupId = api_get_group_id();
  5771. if (isset($groupId) && $groupId != '') {
  5772. if (!empty($groupIdParam)) {
  5773. return $groupIdParam == $groupId;
  5774. } else {
  5775. return true;
  5776. }
  5777. }
  5778. return false;
  5779. }
  5780. /**
  5781. * Checks whether a secret key is valid.
  5782. *
  5783. * @param string $original_key_secret - secret key from (webservice) client
  5784. * @param string $security_key - security key from Chamilo
  5785. *
  5786. * @return bool - true if secret key is valid, false otherwise
  5787. */
  5788. function api_is_valid_secret_key($original_key_secret, $security_key)
  5789. {
  5790. return $original_key_secret == sha1($security_key);
  5791. }
  5792. /**
  5793. * Checks whether a user is into course.
  5794. *
  5795. * @param int $course_id - the course id
  5796. * @param int $user_id - the user id
  5797. *
  5798. * @return bool
  5799. */
  5800. function api_is_user_of_course($course_id, $user_id)
  5801. {
  5802. $tbl_course_rel_user = Database::get_main_table(TABLE_MAIN_COURSE_USER);
  5803. $sql = 'SELECT user_id FROM '.$tbl_course_rel_user.'
  5804. WHERE
  5805. c_id ="'.intval($course_id).'" AND
  5806. user_id = "'.intval($user_id).'" AND
  5807. relation_type <> '.COURSE_RELATION_TYPE_RRHH.' ';
  5808. $result = Database::query($sql);
  5809. return Database::num_rows($result) == 1;
  5810. }
  5811. /**
  5812. * Checks whether the server's operating system is Windows (TM).
  5813. *
  5814. * @return bool - true if the operating system is Windows, false otherwise
  5815. */
  5816. function api_is_windows_os()
  5817. {
  5818. if (function_exists('php_uname')) {
  5819. // php_uname() exists as of PHP 4.0.2, according to the documentation.
  5820. // We expect that this function will always work for Chamilo 1.8.x.
  5821. $os = php_uname();
  5822. }
  5823. // The following methods are not needed, but let them stay, just in case.
  5824. elseif (isset($_ENV['OS'])) {
  5825. // Sometimes $_ENV['OS'] may not be present (bugs?)
  5826. $os = $_ENV['OS'];
  5827. } elseif (defined('PHP_OS')) {
  5828. // PHP_OS means on which OS PHP was compiled, this is why
  5829. // using PHP_OS is the last choice for detection.
  5830. $os = PHP_OS;
  5831. } else {
  5832. return false;
  5833. }
  5834. return strtolower(substr((string) $os, 0, 3)) == 'win';
  5835. }
  5836. /**
  5837. * This function informs whether the sent request is XMLHttpRequest.
  5838. */
  5839. function api_is_xml_http_request()
  5840. {
  5841. return isset($_SERVER['HTTP_X_REQUESTED_WITH']) && strtolower($_SERVER['HTTP_X_REQUESTED_WITH']) == 'xmlhttprequest';
  5842. }
  5843. /**
  5844. * This wrapper function has been implemented for avoiding some known problems about the function getimagesize().
  5845. *
  5846. * @see http://php.net/manual/en/function.getimagesize.php
  5847. * @see http://www.dokeos.com/forum/viewtopic.php?t=12345
  5848. * @see http://www.dokeos.com/forum/viewtopic.php?t=16355
  5849. *
  5850. * @return int
  5851. */
  5852. function api_getimagesize($path)
  5853. {
  5854. $image = new Image($path);
  5855. return $image->get_image_size();
  5856. }
  5857. /**
  5858. * This function resizes an image, with preserving its proportions (or aspect ratio).
  5859. *
  5860. * @author Ivan Tcholakov, MAY-2009.
  5861. *
  5862. * @param int $image System path or URL of the image
  5863. * @param int $target_width Targeted width
  5864. * @param int $target_height Targeted height
  5865. *
  5866. * @return array Calculated new width and height
  5867. */
  5868. function api_resize_image($image, $target_width, $target_height)
  5869. {
  5870. $image_properties = api_getimagesize($image);
  5871. return api_calculate_image_size(
  5872. $image_properties['width'],
  5873. $image_properties['height'],
  5874. $target_width,
  5875. $target_height
  5876. );
  5877. }
  5878. /**
  5879. * This function calculates new image size, with preserving image's proportions (or aspect ratio).
  5880. *
  5881. * @author Ivan Tcholakov, MAY-2009.
  5882. * @author The initial idea has been taken from code by Patrick Cool, MAY-2004.
  5883. *
  5884. * @param int $image_width Initial width
  5885. * @param int $image_height Initial height
  5886. * @param int $target_width Targeted width
  5887. * @param int $target_height Targeted height
  5888. *
  5889. * @return array Calculated new width and height
  5890. */
  5891. function api_calculate_image_size(
  5892. $image_width,
  5893. $image_height,
  5894. $target_width,
  5895. $target_height
  5896. ) {
  5897. // Only maths is here.
  5898. $result = ['width' => $image_width, 'height' => $image_height];
  5899. if ($image_width <= 0 || $image_height <= 0) {
  5900. return $result;
  5901. }
  5902. $resize_factor_width = $target_width / $image_width;
  5903. $resize_factor_height = $target_height / $image_height;
  5904. $delta_width = $target_width - $image_width * $resize_factor_height;
  5905. $delta_height = $target_height - $image_height * $resize_factor_width;
  5906. if ($delta_width > $delta_height) {
  5907. $result['width'] = ceil($image_width * $resize_factor_height);
  5908. $result['height'] = ceil($image_height * $resize_factor_height);
  5909. } elseif ($delta_width < $delta_height) {
  5910. $result['width'] = ceil($image_width * $resize_factor_width);
  5911. $result['height'] = ceil($image_height * $resize_factor_width);
  5912. } else {
  5913. $result['width'] = ceil($target_width);
  5914. $result['height'] = ceil($target_height);
  5915. }
  5916. return $result;
  5917. }
  5918. /**
  5919. * Returns a list of Chamilo's tools or
  5920. * checks whether a given identificator is a valid Chamilo's tool.
  5921. *
  5922. * @author Isaac flores paz
  5923. *
  5924. * @param string The tool name to filter
  5925. *
  5926. * @return mixed Filtered string or array
  5927. */
  5928. function api_get_tools_lists($my_tool = null)
  5929. {
  5930. $tools_list = [
  5931. TOOL_DOCUMENT,
  5932. TOOL_THUMBNAIL,
  5933. TOOL_HOTPOTATOES,
  5934. TOOL_CALENDAR_EVENT,
  5935. TOOL_LINK,
  5936. TOOL_COURSE_DESCRIPTION,
  5937. TOOL_SEARCH,
  5938. TOOL_LEARNPATH,
  5939. TOOL_ANNOUNCEMENT,
  5940. TOOL_FORUM,
  5941. TOOL_THREAD,
  5942. TOOL_POST,
  5943. TOOL_DROPBOX,
  5944. TOOL_QUIZ,
  5945. TOOL_USER,
  5946. TOOL_GROUP,
  5947. TOOL_BLOGS,
  5948. TOOL_CHAT,
  5949. TOOL_STUDENTPUBLICATION,
  5950. TOOL_TRACKING,
  5951. TOOL_HOMEPAGE_LINK,
  5952. TOOL_COURSE_SETTING,
  5953. TOOL_BACKUP,
  5954. TOOL_COPY_COURSE_CONTENT,
  5955. TOOL_RECYCLE_COURSE,
  5956. TOOL_COURSE_HOMEPAGE,
  5957. TOOL_COURSE_RIGHTS_OVERVIEW,
  5958. TOOL_UPLOAD,
  5959. TOOL_COURSE_MAINTENANCE,
  5960. TOOL_SURVEY,
  5961. TOOL_WIKI,
  5962. TOOL_GLOSSARY,
  5963. TOOL_GRADEBOOK,
  5964. TOOL_NOTEBOOK,
  5965. TOOL_ATTENDANCE,
  5966. TOOL_COURSE_PROGRESS,
  5967. ];
  5968. if (empty($my_tool)) {
  5969. return $tools_list;
  5970. }
  5971. return in_array($my_tool, $tools_list) ? $my_tool : '';
  5972. }
  5973. /**
  5974. * Checks whether we already approved the last version term and condition.
  5975. *
  5976. * @param int user id
  5977. *
  5978. * @return bool true if we pass false otherwise
  5979. */
  5980. function api_check_term_condition($userId)
  5981. {
  5982. if (api_get_setting('allow_terms_conditions') === 'true') {
  5983. // Check if exists terms and conditions
  5984. if (LegalManager::count() == 0) {
  5985. return true;
  5986. }
  5987. $extraFieldValue = new ExtraFieldValue('user');
  5988. $data = $extraFieldValue->get_values_by_handler_and_field_variable(
  5989. $userId,
  5990. 'legal_accept'
  5991. );
  5992. if (!empty($data) && isset($data['value']) && !empty($data['value'])) {
  5993. $result = $data['value'];
  5994. $user_conditions = explode(':', $result);
  5995. $version = $user_conditions[0];
  5996. $langId = $user_conditions[1];
  5997. $realVersion = LegalManager::get_last_version($langId);
  5998. return $version >= $realVersion;
  5999. }
  6000. return false;
  6001. }
  6002. return false;
  6003. }
  6004. /**
  6005. * Gets all information of a tool into course.
  6006. *
  6007. * @param int The tool id
  6008. *
  6009. * @return array
  6010. */
  6011. function api_get_tool_information_by_name($name)
  6012. {
  6013. $t_tool = Database::get_course_table(TABLE_TOOL_LIST);
  6014. $course_id = api_get_course_int_id();
  6015. $sql = "SELECT * FROM $t_tool
  6016. WHERE c_id = $course_id AND name = '".Database::escape_string($name)."' ";
  6017. $rs = Database::query($sql);
  6018. return Database::fetch_array($rs, 'ASSOC');
  6019. }
  6020. /**
  6021. * Function used to protect a "global" admin script.
  6022. * The function blocks access when the user has no global platform admin rights.
  6023. * Global admins are the admins that are registered in the main.admin table
  6024. * AND the users who have access to the "principal" portal.
  6025. * That means that there is a record in the main.access_url_rel_user table
  6026. * with his user id and the access_url_id=1.
  6027. *
  6028. * @author Julio Montoya
  6029. *
  6030. * @param int $user_id
  6031. *
  6032. * @return bool
  6033. */
  6034. function api_is_global_platform_admin($user_id = null)
  6035. {
  6036. $user_id = (int) $user_id;
  6037. if (empty($user_id)) {
  6038. $user_id = api_get_user_id();
  6039. }
  6040. if (api_is_platform_admin_by_id($user_id)) {
  6041. $urlList = api_get_access_url_from_user($user_id);
  6042. // The admin is registered in the first "main" site with access_url_id = 1
  6043. if (in_array(1, $urlList)) {
  6044. return true;
  6045. } else {
  6046. return false;
  6047. }
  6048. }
  6049. return false;
  6050. }
  6051. /**
  6052. * @param int $admin_id_to_check
  6053. * @param int $my_user_id
  6054. * @param bool $allow_session_admin
  6055. *
  6056. * @return bool
  6057. */
  6058. function api_global_admin_can_edit_admin(
  6059. $admin_id_to_check,
  6060. $my_user_id = null,
  6061. $allow_session_admin = false
  6062. ) {
  6063. if (empty($my_user_id)) {
  6064. $my_user_id = api_get_user_id();
  6065. }
  6066. $iam_a_global_admin = api_is_global_platform_admin($my_user_id);
  6067. $user_is_global_admin = api_is_global_platform_admin($admin_id_to_check);
  6068. if ($iam_a_global_admin) {
  6069. // Global admin can edit everything
  6070. return true;
  6071. } else {
  6072. // If i'm a simple admin
  6073. $is_platform_admin = api_is_platform_admin_by_id($my_user_id);
  6074. if ($allow_session_admin) {
  6075. $is_platform_admin = api_is_platform_admin_by_id($my_user_id) || (api_get_user_status($my_user_id) == SESSIONADMIN);
  6076. }
  6077. if ($is_platform_admin) {
  6078. if ($user_is_global_admin) {
  6079. return false;
  6080. } else {
  6081. return true;
  6082. }
  6083. } else {
  6084. return false;
  6085. }
  6086. }
  6087. }
  6088. /**
  6089. * @param int $admin_id_to_check
  6090. * @param int $my_user_id
  6091. * @param bool $allow_session_admin
  6092. *
  6093. * @return bool|null
  6094. */
  6095. function api_protect_super_admin($admin_id_to_check, $my_user_id = null, $allow_session_admin = false)
  6096. {
  6097. if (api_global_admin_can_edit_admin($admin_id_to_check, $my_user_id, $allow_session_admin)) {
  6098. return true;
  6099. } else {
  6100. api_not_allowed();
  6101. }
  6102. }
  6103. /**
  6104. * Function used to protect a global admin script.
  6105. * The function blocks access when the user has no global platform admin rights.
  6106. * See also the api_is_global_platform_admin() function wich defines who's a "global" admin.
  6107. *
  6108. * @author Julio Montoya
  6109. */
  6110. function api_protect_global_admin_script()
  6111. {
  6112. if (!api_is_global_platform_admin()) {
  6113. api_not_allowed();
  6114. return false;
  6115. }
  6116. return true;
  6117. }
  6118. /**
  6119. * Get active template.
  6120. *
  6121. * @param string theme type (optional: default)
  6122. * @param string path absolute(abs) or relative(rel) (optional:rel)
  6123. *
  6124. * @return string actived template path
  6125. */
  6126. function api_get_template($path_type = 'rel')
  6127. {
  6128. $path_types = ['rel', 'abs'];
  6129. $template_path = '';
  6130. if (in_array($path_type, $path_types)) {
  6131. if ($path_type == 'rel') {
  6132. $template_path = api_get_path(SYS_TEMPLATE_PATH);
  6133. } else {
  6134. $template_path = api_get_path(WEB_TEMPLATE_PATH);
  6135. }
  6136. }
  6137. $actived_theme = 'default';
  6138. if (api_get_setting('active_template')) {
  6139. $actived_theme = api_get_setting('active_template');
  6140. }
  6141. $actived_theme_path = $template_path.$actived_theme.DIRECTORY_SEPARATOR;
  6142. return $actived_theme_path;
  6143. }
  6144. /**
  6145. * Check browser support for specific file types or features
  6146. * This function checks if the user's browser supports a file format or given
  6147. * feature, or returns the current browser and major version when
  6148. * $format=check_browser. Only a limited number of formats and features are
  6149. * checked by this method. Make sure you check its definition first.
  6150. *
  6151. * @param string $format Can be a file format (extension like svg, webm, ...) or a feature (like autocapitalize, ...)
  6152. *
  6153. * @return bool or return text array if $format=check_browser
  6154. *
  6155. * @author Juan Carlos Raña Trabado
  6156. */
  6157. function api_browser_support($format = '')
  6158. {
  6159. $browser = new Browser();
  6160. $current_browser = $browser->getBrowser();
  6161. $a_versiontemp = explode('.', $browser->getVersion());
  6162. $current_majorver = $a_versiontemp[0];
  6163. static $result;
  6164. if (isset($result[$format])) {
  6165. return $result[$format];
  6166. }
  6167. // Native svg support
  6168. if ($format == 'svg') {
  6169. if (($current_browser == 'Internet Explorer' && $current_majorver >= 9) ||
  6170. ($current_browser == 'Firefox' && $current_majorver > 1) ||
  6171. ($current_browser == 'Safari' && $current_majorver >= 4) ||
  6172. ($current_browser == 'Chrome' && $current_majorver >= 1) ||
  6173. ($current_browser == 'Opera' && $current_majorver >= 9)
  6174. ) {
  6175. $result[$format] = true;
  6176. return true;
  6177. } else {
  6178. $result[$format] = false;
  6179. return false;
  6180. }
  6181. } elseif ($format == 'pdf') {
  6182. // native pdf support
  6183. if ($current_browser == 'Chrome' && $current_majorver >= 6) {
  6184. $result[$format] = true;
  6185. return true;
  6186. } else {
  6187. $result[$format] = false;
  6188. return false;
  6189. }
  6190. } elseif ($format == 'tif' || $format == 'tiff') {
  6191. //native tif support
  6192. if ($current_browser == 'Safari' && $current_majorver >= 5) {
  6193. $result[$format] = true;
  6194. return true;
  6195. } else {
  6196. $result[$format] = false;
  6197. return false;
  6198. }
  6199. } elseif ($format == 'ogg' || $format == 'ogx' || $format == 'ogv' || $format == 'oga') {
  6200. //native ogg, ogv,oga support
  6201. if (($current_browser == 'Firefox' && $current_majorver >= 3) ||
  6202. ($current_browser == 'Chrome' && $current_majorver >= 3) ||
  6203. ($current_browser == 'Opera' && $current_majorver >= 9)) {
  6204. $result[$format] = true;
  6205. return true;
  6206. } else {
  6207. $result[$format] = false;
  6208. return false;
  6209. }
  6210. } elseif ($format == 'mpg' || $format == 'mpeg') {
  6211. //native mpg support
  6212. if (($current_browser == 'Safari' && $current_majorver >= 5)) {
  6213. $result[$format] = true;
  6214. return true;
  6215. } else {
  6216. $result[$format] = false;
  6217. return false;
  6218. }
  6219. } elseif ($format == 'mp4') {
  6220. //native mp4 support (TODO: Android, iPhone)
  6221. if ($current_browser == 'Android' || $current_browser == 'iPhone') {
  6222. $result[$format] = true;
  6223. return true;
  6224. } else {
  6225. $result[$format] = false;
  6226. return false;
  6227. }
  6228. } elseif ($format == 'mov') {
  6229. //native mov support( TODO:check iPhone)
  6230. if ($current_browser == 'Safari' && $current_majorver >= 5 || $current_browser == 'iPhone') {
  6231. $result[$format] = true;
  6232. return true;
  6233. } else {
  6234. $result[$format] = false;
  6235. return false;
  6236. }
  6237. } elseif ($format == 'avi') {
  6238. //native avi support
  6239. if ($current_browser == 'Safari' && $current_majorver >= 5) {
  6240. $result[$format] = true;
  6241. return true;
  6242. } else {
  6243. $result[$format] = false;
  6244. return false;
  6245. }
  6246. } elseif ($format == 'wmv') {
  6247. //native wmv support
  6248. if ($current_browser == 'Firefox' && $current_majorver >= 4) {
  6249. $result[$format] = true;
  6250. return true;
  6251. } else {
  6252. $result[$format] = false;
  6253. return false;
  6254. }
  6255. } elseif ($format == 'webm') {
  6256. //native webm support (TODO:check IE9, Chrome9, Android)
  6257. if (($current_browser == 'Firefox' && $current_majorver >= 4) ||
  6258. ($current_browser == 'Opera' && $current_majorver >= 9) ||
  6259. ($current_browser == 'Internet Explorer' && $current_majorver >= 9) ||
  6260. ($current_browser == 'Chrome' && $current_majorver >= 9) ||
  6261. $current_browser == 'Android'
  6262. ) {
  6263. $result[$format] = true;
  6264. return true;
  6265. } else {
  6266. $result[$format] = false;
  6267. return false;
  6268. }
  6269. } elseif ($format == 'wav') {
  6270. //native wav support (only some codecs !)
  6271. if (($current_browser == 'Firefox' && $current_majorver >= 4) ||
  6272. ($current_browser == 'Safari' && $current_majorver >= 5) ||
  6273. ($current_browser == 'Opera' && $current_majorver >= 9) ||
  6274. ($current_browser == 'Internet Explorer' && $current_majorver >= 9) ||
  6275. ($current_browser == 'Chrome' && $current_majorver > 9) ||
  6276. $current_browser == 'Android' ||
  6277. $current_browser == 'iPhone'
  6278. ) {
  6279. $result[$format] = true;
  6280. return true;
  6281. } else {
  6282. $result[$format] = false;
  6283. return false;
  6284. }
  6285. } elseif ($format == 'mid' || $format == 'kar') {
  6286. //native midi support (TODO:check Android)
  6287. if ($current_browser == 'Opera' && $current_majorver >= 9 || $current_browser == 'Android') {
  6288. $result[$format] = true;
  6289. return true;
  6290. } else {
  6291. $result[$format] = false;
  6292. return false;
  6293. }
  6294. } elseif ($format == 'wma') {
  6295. //native wma support
  6296. if ($current_browser == 'Firefox' && $current_majorver >= 4) {
  6297. $result[$format] = true;
  6298. return true;
  6299. } else {
  6300. $result[$format] = false;
  6301. return false;
  6302. }
  6303. } elseif ($format == 'au') {
  6304. //native au support
  6305. if ($current_browser == 'Safari' && $current_majorver >= 5) {
  6306. $result[$format] = true;
  6307. return true;
  6308. } else {
  6309. $result[$format] = false;
  6310. return false;
  6311. }
  6312. } elseif ($format == 'mp3') {
  6313. //native mp3 support (TODO:check Android, iPhone)
  6314. if (($current_browser == 'Safari' && $current_majorver >= 5) ||
  6315. ($current_browser == 'Chrome' && $current_majorver >= 6) ||
  6316. ($current_browser == 'Internet Explorer' && $current_majorver >= 9) ||
  6317. $current_browser == 'Android' ||
  6318. $current_browser == 'iPhone' ||
  6319. $current_browser == 'Firefox'
  6320. ) {
  6321. $result[$format] = true;
  6322. return true;
  6323. } else {
  6324. $result[$format] = false;
  6325. return false;
  6326. }
  6327. } elseif ($format == 'autocapitalize') {
  6328. // Help avoiding showing the autocapitalize option if the browser doesn't
  6329. // support it: this attribute is against the HTML5 standard
  6330. if ($current_browser == 'Safari' || $current_browser == 'iPhone') {
  6331. return true;
  6332. } else {
  6333. return false;
  6334. }
  6335. } elseif ($format == "check_browser") {
  6336. $array_check_browser = [$current_browser, $current_majorver];
  6337. return $array_check_browser;
  6338. } else {
  6339. $result[$format] = false;
  6340. return false;
  6341. }
  6342. }
  6343. /**
  6344. * This function checks if exist path and file browscap.ini
  6345. * In order for this to work, your browscap configuration setting in php.ini
  6346. * must point to the correct location of the browscap.ini file on your system
  6347. * http://php.net/manual/en/function.get-browser.php.
  6348. *
  6349. * @return bool
  6350. *
  6351. * @author Juan Carlos Raña Trabado
  6352. */
  6353. function api_check_browscap()
  6354. {
  6355. $setting = ini_get('browscap');
  6356. if ($setting) {
  6357. $browser = get_browser($_SERVER['HTTP_USER_AGENT'], true);
  6358. if (strpos($setting, 'browscap.ini') && !empty($browser)) {
  6359. return true;
  6360. }
  6361. }
  6362. return false;
  6363. }
  6364. /**
  6365. * Returns the <script> HTML tag.
  6366. */
  6367. function api_get_js($file)
  6368. {
  6369. return '<script type="text/javascript" src="'.api_get_path(WEB_LIBRARY_PATH).'javascript/'.$file.'"></script>'."\n";
  6370. }
  6371. /**
  6372. * Returns the <script> HTML tag.
  6373. *
  6374. * @return string
  6375. */
  6376. function api_get_asset($file)
  6377. {
  6378. return '<script type="text/javascript" src="'.api_get_path(WEB_PUBLIC_PATH).'assets/'.$file.'"></script>'."\n";
  6379. }
  6380. /**
  6381. * Returns the <script> HTML tag.
  6382. *
  6383. * @param string $file
  6384. * @param string $media
  6385. *
  6386. * @return string
  6387. */
  6388. function api_get_css_asset($file, $media = 'screen')
  6389. {
  6390. return '<link href="'.api_get_path(WEB_PUBLIC_PATH).'assets/'.$file.'" rel="stylesheet" media="'.$media.'" type="text/css" />'."\n";
  6391. }
  6392. /**
  6393. * Returns the <link> HTML tag.
  6394. *
  6395. * @param string $file
  6396. * @param string $media
  6397. */
  6398. function api_get_css($file, $media = 'screen')
  6399. {
  6400. return '<link href="'.$file.'" rel="stylesheet" media="'.$media.'" type="text/css" />'."\n";
  6401. }
  6402. /**
  6403. * Returns the js header to include the jquery library.
  6404. */
  6405. function api_get_jquery_js()
  6406. {
  6407. return api_get_asset('jquery/dist/jquery.min.js');
  6408. }
  6409. /**
  6410. * Returns the jquery path.
  6411. *
  6412. * @return string
  6413. */
  6414. function api_get_jquery_web_path()
  6415. {
  6416. return api_get_path(WEB_PUBLIC_PATH).'assets/jquery/dist/jquery.min.js';
  6417. }
  6418. /**
  6419. * @return string
  6420. */
  6421. function api_get_jquery_ui_js_web_path()
  6422. {
  6423. return api_get_path(WEB_PUBLIC_PATH).'assets/jquery-ui/jquery-ui.min.js';
  6424. }
  6425. /**
  6426. * @return string
  6427. */
  6428. function api_get_jquery_ui_css_web_path()
  6429. {
  6430. return api_get_path(WEB_PUBLIC_PATH).'assets/jquery-ui/themes/smoothness/jquery-ui.min.css';
  6431. }
  6432. /**
  6433. * Returns the jquery-ui library js headers.
  6434. *
  6435. * @param bool add the jqgrid library
  6436. *
  6437. * @return string html tags
  6438. */
  6439. function api_get_jquery_ui_js($include_jqgrid = false)
  6440. {
  6441. $libraries = [];
  6442. if ($include_jqgrid) {
  6443. $libraries[] = 'jqgrid';
  6444. }
  6445. return api_get_jquery_libraries_js($libraries);
  6446. }
  6447. function api_get_jqgrid_js()
  6448. {
  6449. return api_get_jquery_libraries_js(['jqgrid']);
  6450. }
  6451. /**
  6452. * Returns the jquery library js and css headers.
  6453. *
  6454. * @param array list of jquery libraries supported jquery-ui, jqgrid
  6455. * @param bool add the jquery library
  6456. *
  6457. * @return string html tags
  6458. */
  6459. function api_get_jquery_libraries_js($libraries)
  6460. {
  6461. $js = '';
  6462. $js_path = api_get_path(WEB_LIBRARY_PATH).'javascript/';
  6463. //jqgrid js and css
  6464. if (in_array('jqgrid', $libraries)) {
  6465. $languaje = 'en';
  6466. $platform_isocode = strtolower(api_get_language_isocode());
  6467. //languages supported by jqgrid see files in main/inc/lib/javascript/jqgrid/js/i18n
  6468. $jqgrid_langs = [
  6469. 'bg', 'bg1251', 'cat', 'cn', 'cs', 'da', 'de', 'el', 'en', 'es', 'fa', 'fi', 'fr', 'gl', 'he', 'hu', 'is', 'it', 'ja', 'nl', 'no', 'pl', 'pt-br', 'pt', 'ro', 'ru', 'sk', 'sr', 'sv', 'tr', 'ua',
  6470. ];
  6471. if (in_array($platform_isocode, $jqgrid_langs)) {
  6472. $languaje = $platform_isocode;
  6473. }
  6474. //$js .= '<link rel="stylesheet" href="'.$js_path.'jqgrid/css/ui.jqgrid.css" type="text/css">';
  6475. $js .= api_get_css($js_path.'jqgrid/css/ui.jqgrid.css');
  6476. $js .= api_get_js('jqgrid/js/i18n/grid.locale-'.$languaje.'.js');
  6477. $js .= api_get_js('jqgrid/js/jquery.jqGrid.min.js');
  6478. }
  6479. //Document multiple upload funcionality
  6480. if (in_array('jquery-upload', $libraries)) {
  6481. $js .= api_get_asset('blueimp-load-image/js/load-image.all.min.js');
  6482. $js .= api_get_asset('blueimp-canvas-to-blob/js/canvas-to-blob.min.js');
  6483. $js .= api_get_asset('jquery-file-upload/js/jquery.iframe-transport.js');
  6484. $js .= api_get_asset('jquery-file-upload/js/jquery.fileupload.js');
  6485. $js .= api_get_asset('jquery-file-upload/js/jquery.fileupload-process.js');
  6486. $js .= api_get_asset('jquery-file-upload/js/jquery.fileupload-image.js');
  6487. $js .= api_get_asset('jquery-file-upload/js/jquery.fileupload-audio.js');
  6488. $js .= api_get_asset('jquery-file-upload/js/jquery.fileupload-video.js');
  6489. $js .= api_get_asset('jquery-file-upload/js/jquery.fileupload-validate.js');
  6490. $js .= api_get_css(api_get_path(WEB_PUBLIC_PATH).'assets/jquery-file-upload/css/jquery.fileupload.css');
  6491. $js .= api_get_css(api_get_path(WEB_PUBLIC_PATH).'assets/jquery-file-upload/css/jquery.fileupload-ui.css');
  6492. }
  6493. // jquery datepicker
  6494. if (in_array('datepicker', $libraries)) {
  6495. $languaje = 'en-GB';
  6496. $platform_isocode = strtolower(api_get_language_isocode());
  6497. // languages supported by jqgrid see files in main/inc/lib/javascript/jqgrid/js/i18n
  6498. $datapicker_langs = [
  6499. 'af', 'ar', 'ar-DZ', 'az', 'bg', 'bs', 'ca', 'cs', 'cy-GB', 'da', 'de', 'el', 'en-AU', 'en-GB', 'en-NZ', 'eo', 'es', 'et', 'eu', 'fa', 'fi', 'fo', 'fr', 'fr-CH', 'gl', 'he', 'hi', 'hr', 'hu', 'hy', 'id', 'is', 'it', 'ja', 'ka', 'kk', 'km', 'ko', 'lb', 'lt', 'lv', 'mk', 'ml', 'ms', 'nl', 'nl-BE', 'no', 'pl', 'pt', 'pt-BR', 'rm', 'ro', 'ru', 'sk', 'sl', 'sq', 'sr', 'sr-SR', 'sv', 'ta', 'th', 'tj', 'tr', 'uk', 'vi', 'zh-CN', 'zh-HK', 'zh-TW',
  6500. ];
  6501. if (in_array($platform_isocode, $datapicker_langs)) {
  6502. $languaje = $platform_isocode;
  6503. }
  6504. $js .= api_get_js('jquery-ui/jquery-ui-i18n.min.js');
  6505. $script = '<script>
  6506. $(function(){
  6507. $.datepicker.setDefaults($.datepicker.regional["'.$languaje.'"]);
  6508. $.datepicker.regional["local"] = $.datepicker.regional["'.$languaje.'"];
  6509. });
  6510. </script>
  6511. ';
  6512. $js .= $script;
  6513. }
  6514. return $js;
  6515. }
  6516. /**
  6517. * Returns the URL to the course or session, removing the complexity of the URL
  6518. * building piece by piece.
  6519. *
  6520. * This function relies on api_get_course_info()
  6521. *
  6522. * @param string $courseCode The course code - optional (takes it from context if not given)
  6523. * @param int $sessionId The session ID - optional (takes it from context if not given)
  6524. * @param int $groupId The group ID - optional (takes it from context if not given)
  6525. *
  6526. * @return string The URL to a course, a session, or empty string if nothing works e.g. https://localhost/courses/ABC/index.php?session_id=3&gidReq=1
  6527. *
  6528. * @author Julio Montoya <gugli100@gmail.com>
  6529. */
  6530. function api_get_course_url($courseCode = null, $sessionId = null, $groupId = null)
  6531. {
  6532. $courseDirectory = '';
  6533. $url = '';
  6534. // If courseCode not set, get context or []
  6535. if (empty($courseCode)) {
  6536. $courseInfo = api_get_course_info();
  6537. } else {
  6538. $courseInfo = api_get_course_info($courseCode);
  6539. }
  6540. // If course defined, get directory, otherwise keep empty string
  6541. if (!empty($courseInfo['directory'])) {
  6542. $courseDirectory = $courseInfo['directory'];
  6543. }
  6544. // If sessionId not set, get context or 0
  6545. if (empty($sessionId)) {
  6546. $sessionId = api_get_session_id();
  6547. }
  6548. // If groupId not set, get context or 0
  6549. if (empty($groupId)) {
  6550. $groupId = api_get_group_id();
  6551. }
  6552. // Build the URL
  6553. if (!empty($courseDirectory)) {
  6554. // directory not empty, so we do have a course
  6555. $url = api_get_path(WEB_COURSE_PATH).$courseDirectory.'/index.php?id_session='.$sessionId.'&gidReq='.$groupId;
  6556. } elseif (!empty($sessionId) && api_get_configuration_value('remove_session_url') !== true) {
  6557. // if the course was unset and the session was set, send directly to the session
  6558. $url = api_get_path(WEB_CODE_PATH).'session/index.php?session_id='.$sessionId;
  6559. }
  6560. // if not valid combination was found, return an empty string
  6561. return $url;
  6562. }
  6563. /**
  6564. * Check if the current portal has the $_configuration['multiple_access_urls'] parameter on.
  6565. *
  6566. * @return bool true if multi site is enabled
  6567. */
  6568. function api_get_multiple_access_url()
  6569. {
  6570. global $_configuration;
  6571. if (isset($_configuration['multiple_access_urls']) && $_configuration['multiple_access_urls']) {
  6572. return true;
  6573. }
  6574. return false;
  6575. }
  6576. /**
  6577. * @return bool
  6578. */
  6579. function api_is_multiple_url_enabled()
  6580. {
  6581. return api_get_multiple_access_url();
  6582. }
  6583. /**
  6584. * Returns a md5 unique id.
  6585. *
  6586. * @todo add more parameters
  6587. */
  6588. function api_get_unique_id()
  6589. {
  6590. $id = md5(time().uniqid().api_get_user_id().api_get_course_id().api_get_session_id());
  6591. return $id;
  6592. }
  6593. /**
  6594. * Get home path.
  6595. *
  6596. * @return string
  6597. */
  6598. function api_get_home_path()
  6599. {
  6600. // FIX : Start the routing determination from central path definition
  6601. $home = api_get_path(SYS_HOME_PATH);
  6602. if (api_get_multiple_access_url()) {
  6603. $access_url_id = api_get_current_access_url_id();
  6604. $url_info = api_get_access_url($access_url_id);
  6605. $url = api_remove_trailing_slash(preg_replace('/https?:\/\//i', '', $url_info['url']));
  6606. $clean_url = api_replace_dangerous_char($url);
  6607. $clean_url = str_replace('/', '-', $clean_url);
  6608. $clean_url .= '/';
  6609. if ($clean_url != 'localhost/') {
  6610. // means that the multiple URL was not well configured we don't rename the $home variable
  6611. return "{$home}{$clean_url}";
  6612. }
  6613. }
  6614. return $home;
  6615. }
  6616. /**
  6617. * @param int Course id
  6618. * @param int tool id: TOOL_QUIZ, TOOL_FORUM, TOOL_STUDENTPUBLICATION, TOOL_LEARNPATH
  6619. * @param int the item id (tool id, exercise id, lp id)
  6620. *
  6621. * @return bool
  6622. */
  6623. function api_resource_is_locked_by_gradebook($item_id, $link_type, $course_code = null)
  6624. {
  6625. if (api_is_platform_admin()) {
  6626. return false;
  6627. }
  6628. if (api_get_setting('gradebook_locking_enabled') == 'true') {
  6629. if (empty($course_code)) {
  6630. $course_code = api_get_course_id();
  6631. }
  6632. $table = Database::get_main_table(TABLE_MAIN_GRADEBOOK_LINK);
  6633. $item_id = intval($item_id);
  6634. $link_type = intval($link_type);
  6635. $course_code = Database::escape_string($course_code);
  6636. $sql = "SELECT locked FROM $table
  6637. WHERE locked = 1 AND ref_id = $item_id AND type = $link_type AND course_code = '$course_code' ";
  6638. $result = Database::query($sql);
  6639. if (Database::num_rows($result)) {
  6640. return true;
  6641. }
  6642. }
  6643. return false;
  6644. }
  6645. /**
  6646. * Blocks a page if the item was added in a gradebook.
  6647. *
  6648. * @param int exercise id, work id, thread id,
  6649. * @param int LINK_EXERCISE, LINK_STUDENTPUBLICATION, LINK_LEARNPATH LINK_FORUM_THREAD, LINK_ATTENDANCE
  6650. * see gradebook/lib/be/linkfactory
  6651. * @param string course code
  6652. *
  6653. * @return false|null
  6654. */
  6655. function api_block_course_item_locked_by_gradebook($item_id, $link_type, $course_code = null)
  6656. {
  6657. if (api_is_platform_admin()) {
  6658. return false;
  6659. }
  6660. if (api_resource_is_locked_by_gradebook($item_id, $link_type, $course_code)) {
  6661. $message = Display::return_message(get_lang('ResourceLockedByGradebook'), 'warning');
  6662. api_not_allowed(true, $message);
  6663. }
  6664. }
  6665. /**
  6666. * Checks the PHP version installed is enough to run Chamilo.
  6667. *
  6668. * @param string Include path (used to load the error page)
  6669. */
  6670. function api_check_php_version($my_inc_path = null)
  6671. {
  6672. if (!function_exists('version_compare') || version_compare(phpversion(), REQUIRED_PHP_VERSION, '<')) {
  6673. $global_error_code = 1;
  6674. // Incorrect PHP version
  6675. $global_page = $my_inc_path.'global_error_message.inc.php';
  6676. if (file_exists($global_page)) {
  6677. require $global_page;
  6678. }
  6679. exit;
  6680. }
  6681. }
  6682. /**
  6683. * Checks whether the Archive directory is present and writeable. If not,
  6684. * prints a warning message.
  6685. */
  6686. function api_check_archive_dir()
  6687. {
  6688. if (is_dir(api_get_path(SYS_ARCHIVE_PATH)) && !is_writable(api_get_path(SYS_ARCHIVE_PATH))) {
  6689. $message = Display::return_message(get_lang('ArchivesDirectoryNotWriteableContactAdmin'), 'warning');
  6690. api_not_allowed(true, $message);
  6691. }
  6692. }
  6693. /**
  6694. * Returns an array of global configuration settings which should be ignored
  6695. * when printing the configuration settings screens.
  6696. *
  6697. * @return array Array of strings, each identifying one of the excluded settings
  6698. */
  6699. function api_get_locked_settings()
  6700. {
  6701. return [
  6702. 'server_type',
  6703. 'permanently_remove_deleted_files',
  6704. 'account_valid_duration',
  6705. 'service_ppt2lp',
  6706. 'wcag_anysurfer_public_pages',
  6707. 'upload_extensions_list_type',
  6708. 'upload_extensions_blacklist',
  6709. 'upload_extensions_whitelist',
  6710. 'upload_extensions_skip',
  6711. 'upload_extensions_replace_by',
  6712. 'hide_dltt_markup',
  6713. 'split_users_upload_directory',
  6714. 'permissions_for_new_directories',
  6715. 'permissions_for_new_files',
  6716. 'platform_charset',
  6717. 'ldap_description',
  6718. 'cas_activate',
  6719. 'cas_server',
  6720. 'cas_server_uri',
  6721. 'cas_port',
  6722. 'cas_protocol',
  6723. 'cas_add_user_activate',
  6724. 'update_user_info_cas_with_ldap',
  6725. 'languagePriority1',
  6726. 'languagePriority2',
  6727. 'languagePriority3',
  6728. 'languagePriority4',
  6729. 'login_is_email',
  6730. 'chamilo_database_version',
  6731. ];
  6732. }
  6733. /**
  6734. * Checks if the user is corrently logged in. Returns the user ID if he is, or
  6735. * false if he isn't. If the user ID is given and is an integer, then the same
  6736. * ID is simply returned.
  6737. *
  6738. * @param int User ID
  6739. *
  6740. * @return bool Integer User ID is logged in, or false otherwise
  6741. */
  6742. function api_user_is_login($user_id = null)
  6743. {
  6744. $user_id = empty($user_id) ? api_get_user_id() : (int) $user_id;
  6745. return $user_id && !api_is_anonymous();
  6746. }
  6747. /**
  6748. * Guess the real ip for register in the database, even in reverse proxy cases.
  6749. * To be recognized, the IP has to be found in either $_SERVER['REMOTE_ADDR'] or
  6750. * in $_SERVER['HTTP_X_FORWARDED_FOR'], which is in common use with rproxies.
  6751. * Note: the result of this function is not SQL-safe. Please escape it before
  6752. * inserting in a database.
  6753. *
  6754. * @return string the user's real ip (unsafe - escape it before inserting to db)
  6755. *
  6756. * @author Jorge Frisancho Jibaja <jrfdeft@gmail.com>, USIL - Some changes to allow the use of real IP using reverse proxy
  6757. *
  6758. * @version CEV CHANGE 24APR2012
  6759. */
  6760. function api_get_real_ip()
  6761. {
  6762. $ip = trim($_SERVER['REMOTE_ADDR']);
  6763. if (!empty($_SERVER['HTTP_X_FORWARDED_FOR'])) {
  6764. if (preg_match('/,/', $_SERVER['HTTP_X_FORWARDED_FOR'])) {
  6765. @list($ip1, $ip2) = @explode(',', $_SERVER['HTTP_X_FORWARDED_FOR']);
  6766. } else {
  6767. $ip1 = $_SERVER['HTTP_X_FORWARDED_FOR'];
  6768. }
  6769. $ip = trim($ip1);
  6770. }
  6771. return $ip;
  6772. }
  6773. /**
  6774. * Checks whether an IP is included inside an IP range.
  6775. *
  6776. * @param string IP address
  6777. * @param string IP range
  6778. * @param string $ip
  6779. *
  6780. * @return bool True if IP is in the range, false otherwise
  6781. *
  6782. * @author claudiu at cnixs dot com on http://www.php.net/manual/fr/ref.network.php#55230
  6783. * @author Yannick Warnier for improvements and managment of multiple ranges
  6784. *
  6785. * @todo check for IPv6 support
  6786. */
  6787. function api_check_ip_in_range($ip, $range)
  6788. {
  6789. if (empty($ip) or empty($range)) {
  6790. return false;
  6791. }
  6792. $ip_ip = ip2long($ip);
  6793. // divide range param into array of elements
  6794. if (strpos($range, ',') !== false) {
  6795. $ranges = explode(',', $range);
  6796. } else {
  6797. $ranges = [$range];
  6798. }
  6799. foreach ($ranges as $range) {
  6800. $range = trim($range);
  6801. if (empty($range)) {
  6802. continue;
  6803. }
  6804. if (strpos($range, '/') === false) {
  6805. if (strcmp($ip, $range) === 0) {
  6806. return true; // there is a direct IP match, return OK
  6807. }
  6808. continue; //otherwise, get to the next range
  6809. }
  6810. // the range contains a "/", so analyse completely
  6811. list($net, $mask) = explode("/", $range);
  6812. $ip_net = ip2long($net);
  6813. // mask binary magic
  6814. $ip_mask = ~((1 << (32 - $mask)) - 1);
  6815. $ip_ip_net = $ip_ip & $ip_mask;
  6816. if ($ip_ip_net == $ip_net) {
  6817. return true;
  6818. }
  6819. }
  6820. return false;
  6821. }
  6822. function api_check_user_access_to_legal($course_visibility)
  6823. {
  6824. $course_visibility_list = [COURSE_VISIBILITY_OPEN_WORLD, COURSE_VISIBILITY_OPEN_PLATFORM];
  6825. return in_array($course_visibility, $course_visibility_list) || api_is_drh();
  6826. }
  6827. /**
  6828. * Checks if the global chat is enabled or not.
  6829. *
  6830. * @return bool
  6831. */
  6832. function api_is_global_chat_enabled()
  6833. {
  6834. return
  6835. !api_is_anonymous() &&
  6836. api_get_setting('allow_global_chat') === 'true' &&
  6837. api_get_setting('allow_social_tool') === 'true';
  6838. }
  6839. /**
  6840. * @todo Fix tool_visible_by_default_at_creation labels
  6841. *
  6842. * @param int $item_id
  6843. * @param int $tool_id
  6844. * @param int $group_id id
  6845. * @param array $courseInfo
  6846. * @param int $sessionId
  6847. * @param int $userId
  6848. */
  6849. function api_set_default_visibility(
  6850. $item_id,
  6851. $tool_id,
  6852. $group_id = 0,
  6853. $courseInfo = [],
  6854. $sessionId = 0,
  6855. $userId = 0
  6856. ) {
  6857. $courseInfo = empty($courseInfo) ? api_get_course_info() : $courseInfo;
  6858. $courseId = $courseInfo['real_id'];
  6859. $courseCode = $courseInfo['code'];
  6860. $sessionId = empty($sessionId) ? api_get_session_id() : $sessionId;
  6861. $userId = empty($userId) ? api_get_user_id() : $userId;
  6862. // if group is null force group_id = 0, this force is needed to create a LP folder with group = 0
  6863. if (is_null($group_id)) {
  6864. $group_id = 0;
  6865. } else {
  6866. $group_id = empty($group_id) ? api_get_group_id() : $group_id;
  6867. }
  6868. $groupInfo = [];
  6869. if (!empty($group_id)) {
  6870. $groupInfo = GroupManager::get_group_properties($group_id);
  6871. }
  6872. $original_tool_id = $tool_id;
  6873. switch ($tool_id) {
  6874. case TOOL_LINK:
  6875. case TOOL_LINK_CATEGORY:
  6876. $tool_id = 'links';
  6877. break;
  6878. case TOOL_DOCUMENT:
  6879. $tool_id = 'documents';
  6880. break;
  6881. case TOOL_LEARNPATH:
  6882. $tool_id = 'learning';
  6883. break;
  6884. case TOOL_ANNOUNCEMENT:
  6885. $tool_id = 'announcements';
  6886. break;
  6887. case TOOL_FORUM:
  6888. case TOOL_FORUM_CATEGORY:
  6889. case TOOL_FORUM_THREAD:
  6890. $tool_id = 'forums';
  6891. break;
  6892. case TOOL_QUIZ:
  6893. $tool_id = 'quiz';
  6894. break;
  6895. }
  6896. $setting = api_get_setting('tool_visible_by_default_at_creation');
  6897. if (isset($setting[$tool_id])) {
  6898. $visibility = 'invisible';
  6899. if ($setting[$tool_id] == 'true') {
  6900. $visibility = 'visible';
  6901. }
  6902. // Read the portal and course default visibility
  6903. if ($tool_id == 'documents') {
  6904. $visibility = DocumentManager::getDocumentDefaultVisibility($courseCode);
  6905. }
  6906. api_item_property_update(
  6907. $courseInfo,
  6908. $original_tool_id,
  6909. $item_id,
  6910. $visibility,
  6911. $userId,
  6912. $groupInfo,
  6913. null,
  6914. null,
  6915. null,
  6916. $sessionId
  6917. );
  6918. // Fixes default visibility for tests
  6919. switch ($original_tool_id) {
  6920. case TOOL_QUIZ:
  6921. if (empty($sessionId)) {
  6922. $objExerciseTmp = new Exercise($courseId);
  6923. $objExerciseTmp->read($item_id);
  6924. if ($visibility == 'visible') {
  6925. $objExerciseTmp->enable();
  6926. $objExerciseTmp->save();
  6927. } else {
  6928. $objExerciseTmp->disable();
  6929. $objExerciseTmp->save();
  6930. }
  6931. }
  6932. break;
  6933. }
  6934. }
  6935. }
  6936. /**
  6937. * @return string
  6938. */
  6939. function api_get_security_key()
  6940. {
  6941. return api_get_configuration_value('security_key');
  6942. }
  6943. /**
  6944. * @param int $user_id
  6945. * @param int $courseId
  6946. * @param int $session_id
  6947. *
  6948. * @return array
  6949. */
  6950. function api_detect_user_roles($user_id, $courseId, $session_id = 0)
  6951. {
  6952. $user_roles = [];
  6953. $courseInfo = api_get_course_info_by_id($courseId);
  6954. $course_code = $courseInfo['code'];
  6955. $url_id = api_get_current_access_url_id();
  6956. if (api_is_platform_admin_by_id($user_id, $url_id)) {
  6957. $user_roles[] = PLATFORM_ADMIN;
  6958. }
  6959. /*if (api_is_drh()) {
  6960. $user_roles[] = DRH;
  6961. }*/
  6962. if (!empty($session_id)) {
  6963. if (SessionManager::user_is_general_coach($user_id, $session_id)) {
  6964. $user_roles[] = SESSION_GENERAL_COACH;
  6965. }
  6966. }
  6967. if (!empty($course_code)) {
  6968. if (empty($session_id)) {
  6969. if (CourseManager::is_course_teacher($user_id, $course_code)) {
  6970. $user_roles[] = COURSEMANAGER;
  6971. }
  6972. if (CourseManager::get_tutor_in_course_status($user_id, $courseInfo['real_id'])) {
  6973. $user_roles[] = COURSE_TUTOR;
  6974. }
  6975. if (CourseManager::is_user_subscribed_in_course($user_id, $course_code)) {
  6976. $user_roles[] = COURSE_STUDENT;
  6977. }
  6978. } else {
  6979. $user_status_in_session = SessionManager::get_user_status_in_course_session(
  6980. $user_id,
  6981. $courseId,
  6982. $session_id
  6983. );
  6984. if (!empty($user_status_in_session)) {
  6985. if ($user_status_in_session == 0) {
  6986. $user_roles[] = SESSION_STUDENT;
  6987. }
  6988. if ($user_status_in_session == 2) {
  6989. $user_roles[] = SESSION_COURSE_COACH;
  6990. }
  6991. }
  6992. /*if (api_is_course_session_coach($user_id, $course_code, $session_id)) {
  6993. $user_roles[] = SESSION_COURSE_COACH;
  6994. }*/
  6995. }
  6996. }
  6997. return $user_roles;
  6998. }
  6999. /**
  7000. * @param int $courseId
  7001. * @param int $session_id
  7002. *
  7003. * @return bool
  7004. */
  7005. function api_coach_can_edit_view_results($courseId = null, $session_id = null)
  7006. {
  7007. if (api_is_platform_admin()) {
  7008. return true;
  7009. }
  7010. $user_id = api_get_user_id();
  7011. if (empty($courseId)) {
  7012. $courseId = api_get_course_int_id();
  7013. }
  7014. if (empty($session_id)) {
  7015. $session_id = api_get_session_id();
  7016. }
  7017. $roles = api_detect_user_roles($user_id, $courseId, $session_id);
  7018. if (in_array(SESSION_COURSE_COACH, $roles)) {
  7019. //return api_get_setting('session_tutor_reports_visibility') == 'true';
  7020. return true;
  7021. } else {
  7022. if (in_array(COURSEMANAGER, $roles)) {
  7023. return true;
  7024. }
  7025. return false;
  7026. }
  7027. }
  7028. /**
  7029. * @param string $file
  7030. *
  7031. * @return string
  7032. */
  7033. function api_get_js_simple($file)
  7034. {
  7035. return '<script type="text/javascript" src="'.$file.'"></script>'."\n";
  7036. }
  7037. function api_set_settings_and_plugins()
  7038. {
  7039. global $_configuration;
  7040. $_setting = [];
  7041. $_plugins = [];
  7042. // access_url == 1 is the default chamilo location
  7043. $settings_by_access_list = [];
  7044. $access_url_id = api_get_current_access_url_id();
  7045. if ($access_url_id != 1) {
  7046. $url_info = api_get_access_url($_configuration['access_url']);
  7047. if ($url_info['active'] == 1) {
  7048. $settings_by_access = &api_get_settings(null, 'list', $_configuration['access_url'], 1);
  7049. foreach ($settings_by_access as &$row) {
  7050. if (empty($row['variable'])) {
  7051. $row['variable'] = 0;
  7052. }
  7053. if (empty($row['subkey'])) {
  7054. $row['subkey'] = 0;
  7055. }
  7056. if (empty($row['category'])) {
  7057. $row['category'] = 0;
  7058. }
  7059. $settings_by_access_list[$row['variable']][$row['subkey']][$row['category']] = $row;
  7060. }
  7061. }
  7062. }
  7063. $result = api_get_settings(null, 'list', 1);
  7064. foreach ($result as &$row) {
  7065. if ($access_url_id != 1) {
  7066. if ($url_info['active'] == 1) {
  7067. $var = empty($row['variable']) ? 0 : $row['variable'];
  7068. $subkey = empty($row['subkey']) ? 0 : $row['subkey'];
  7069. $category = empty($row['category']) ? 0 : $row['category'];
  7070. }
  7071. if ($row['access_url_changeable'] == 1 && $url_info['active'] == 1) {
  7072. if (isset($settings_by_access_list[$var]) &&
  7073. $settings_by_access_list[$var][$subkey][$category]['selected_value'] != '') {
  7074. if ($row['subkey'] == null) {
  7075. $_setting[$row['variable']] = $settings_by_access_list[$var][$subkey][$category]['selected_value'];
  7076. } else {
  7077. $_setting[$row['variable']][$row['subkey']] = $settings_by_access_list[$var][$subkey][$category]['selected_value'];
  7078. }
  7079. } else {
  7080. if ($row['subkey'] == null) {
  7081. $_setting[$row['variable']] = $row['selected_value'];
  7082. } else {
  7083. $_setting[$row['variable']][$row['subkey']] = $row['selected_value'];
  7084. }
  7085. }
  7086. } else {
  7087. if ($row['subkey'] == null) {
  7088. $_setting[$row['variable']] = $row['selected_value'];
  7089. } else {
  7090. $_setting[$row['variable']][$row['subkey']] = $row['selected_value'];
  7091. }
  7092. }
  7093. } else {
  7094. if ($row['subkey'] == null) {
  7095. $_setting[$row['variable']] = $row['selected_value'];
  7096. } else {
  7097. $_setting[$row['variable']][$row['subkey']] = $row['selected_value'];
  7098. }
  7099. }
  7100. }
  7101. $result = api_get_settings('Plugins', 'list', $access_url_id);
  7102. $_plugins = [];
  7103. foreach ($result as &$row) {
  7104. $key = &$row['variable'];
  7105. if (is_string($_setting[$key])) {
  7106. $_setting[$key] = [];
  7107. }
  7108. $_setting[$key][] = $row['selected_value'];
  7109. $_plugins[$key][] = $row['selected_value'];
  7110. }
  7111. $_SESSION['_setting'] = $_setting;
  7112. $_SESSION['_plugins'] = $_plugins;
  7113. }
  7114. /**
  7115. * Modify default memory_limit and max_execution_time limits
  7116. * Needed when processing long tasks.
  7117. */
  7118. function api_set_more_memory_and_time_limits()
  7119. {
  7120. if (function_exists('ini_set')) {
  7121. api_set_memory_limit('256M');
  7122. ini_set('max_execution_time', 1800);
  7123. }
  7124. }
  7125. /**
  7126. * Tries to set memory limit, if authorized and new limit is higher than current.
  7127. *
  7128. * @param string $mem New memory limit
  7129. *
  7130. * @return bool True on success, false on failure or current is higher than suggested
  7131. * @assert (null) === false
  7132. * @assert (-1) === false
  7133. * @assert (0) === true
  7134. * @assert ('1G') === true
  7135. */
  7136. function api_set_memory_limit($mem)
  7137. {
  7138. //if ini_set() not available, this function is useless
  7139. if (!function_exists('ini_set') || is_null($mem) || $mem == -1) {
  7140. return false;
  7141. }
  7142. $memory_limit = ini_get('memory_limit');
  7143. if (api_get_bytes_memory_limit($mem) > api_get_bytes_memory_limit($memory_limit)) {
  7144. ini_set('memory_limit', $mem);
  7145. return true;
  7146. }
  7147. return false;
  7148. }
  7149. /**
  7150. * Gets memory limit in bytes.
  7151. *
  7152. * @param string The memory size (128M, 1G, 1000K, etc)
  7153. *
  7154. * @return int
  7155. * @assert (null) === false
  7156. * @assert ('1t') === 1099511627776
  7157. * @assert ('1g') === 1073741824
  7158. * @assert ('1m') === 1048576
  7159. * @assert ('100k') === 102400
  7160. */
  7161. function api_get_bytes_memory_limit($mem)
  7162. {
  7163. $size = strtolower(substr($mem, -1));
  7164. switch ($size) {
  7165. case 't':
  7166. $mem = intval(substr($mem, -1)) * 1024 * 1024 * 1024 * 1024;
  7167. break;
  7168. case 'g':
  7169. $mem = intval(substr($mem, 0, -1)) * 1024 * 1024 * 1024;
  7170. break;
  7171. case 'm':
  7172. $mem = intval(substr($mem, 0, -1)) * 1024 * 1024;
  7173. break;
  7174. case 'k':
  7175. $mem = intval(substr($mem, 0, -1)) * 1024;
  7176. break;
  7177. default:
  7178. // we assume it's integer only
  7179. $mem = intval($mem);
  7180. break;
  7181. }
  7182. return $mem;
  7183. }
  7184. /**
  7185. * Finds all the information about a user from username instead of user id.
  7186. *
  7187. * @param string $officialCode
  7188. *
  7189. * @return array $user_info user_id, lastname, firstname, username, email, ...
  7190. *
  7191. * @author Yannick Warnier <yannick.warnier@beeznest.com>
  7192. */
  7193. function api_get_user_info_from_official_code($officialCode)
  7194. {
  7195. if (empty($officialCode)) {
  7196. return false;
  7197. }
  7198. $sql = "SELECT * FROM ".Database::get_main_table(TABLE_MAIN_USER)."
  7199. WHERE official_code ='".Database::escape_string($officialCode)."'";
  7200. $result = Database::query($sql);
  7201. if (Database::num_rows($result) > 0) {
  7202. $result_array = Database::fetch_array($result);
  7203. return _api_format_user($result_array);
  7204. }
  7205. return false;
  7206. }
  7207. /**
  7208. * @param string $usernameInputId
  7209. * @param string $passwordInputId
  7210. *
  7211. * @return string|null
  7212. */
  7213. function api_get_password_checker_js($usernameInputId, $passwordInputId)
  7214. {
  7215. $checkPass = api_get_setting('allow_strength_pass_checker');
  7216. $useStrengthPassChecker = $checkPass === 'true';
  7217. if ($useStrengthPassChecker === false) {
  7218. return null;
  7219. }
  7220. $translations = [
  7221. 'wordLength' => get_lang('PasswordIsTooShort'),
  7222. 'wordNotEmail' => get_lang('YourPasswordCannotBeTheSameAsYourEmail'),
  7223. 'wordSimilarToUsername' => get_lang('YourPasswordCannotContainYourUsername'),
  7224. 'wordTwoCharacterClasses' => get_lang('WordTwoCharacterClasses'),
  7225. 'wordRepetitions' => get_lang('TooManyRepetitions'),
  7226. 'wordSequences' => get_lang('YourPasswordContainsSequences'),
  7227. 'errorList' => get_lang('ErrorsFound'),
  7228. 'veryWeak' => get_lang('PasswordVeryWeak'),
  7229. 'weak' => get_lang('PasswordWeak'),
  7230. 'normal' => get_lang('PasswordNormal'),
  7231. 'medium' => get_lang('PasswordMedium'),
  7232. 'strong' => get_lang('PasswordStrong'),
  7233. 'veryStrong' => get_lang('PasswordVeryStrong'),
  7234. ];
  7235. $js = api_get_asset('pwstrength-bootstrap/dist/pwstrength-bootstrap.min.js');
  7236. $js .= "<script>
  7237. var errorMessages = {
  7238. password_to_short : \"".get_lang('PasswordIsTooShort')."\",
  7239. same_as_username : \"".get_lang('YourPasswordCannotBeTheSameAsYourUsername')."\"
  7240. };
  7241. $(function() {
  7242. var lang = ".json_encode($translations).";
  7243. var options = {
  7244. onLoad : function () {
  7245. //$('#messages').text('Start typing password');
  7246. },
  7247. onKeyUp: function (evt) {
  7248. $(evt.target).pwstrength('outputErrorList');
  7249. },
  7250. errorMessages : errorMessages,
  7251. viewports: {
  7252. progress: '#password_progress',
  7253. verdict: '#password-verdict',
  7254. errors: '#password-errors'
  7255. },
  7256. usernameField: '$usernameInputId'
  7257. };
  7258. options.i18n = {
  7259. t: function (key) {
  7260. var result = lang[key];
  7261. return result === key ? '' : result; // This assumes you return the
  7262. }
  7263. };
  7264. $('".$passwordInputId."').pwstrength(options);
  7265. });
  7266. </script>";
  7267. return $js;
  7268. }
  7269. /**
  7270. * create an user extra field called 'captcha_blocked_until_date'.
  7271. *
  7272. * @param string $username
  7273. *
  7274. * @return bool
  7275. */
  7276. function api_block_account_captcha($username)
  7277. {
  7278. $userInfo = api_get_user_info_from_username($username);
  7279. if (empty($userInfo)) {
  7280. return false;
  7281. }
  7282. $minutesToBlock = api_get_setting('captcha_time_to_block');
  7283. $time = time() + $minutesToBlock * 60;
  7284. UserManager::update_extra_field_value(
  7285. $userInfo['user_id'],
  7286. 'captcha_blocked_until_date',
  7287. api_get_utc_datetime($time)
  7288. );
  7289. return true;
  7290. }
  7291. /**
  7292. * @param string $username
  7293. *
  7294. * @return bool
  7295. */
  7296. function api_clean_account_captcha($username)
  7297. {
  7298. $userInfo = api_get_user_info_from_username($username);
  7299. if (empty($userInfo)) {
  7300. return false;
  7301. }
  7302. Session::erase('loginFailedCount');
  7303. UserManager::update_extra_field_value(
  7304. $userInfo['user_id'],
  7305. 'captcha_blocked_until_date',
  7306. null
  7307. );
  7308. return true;
  7309. }
  7310. /**
  7311. * @param string $username
  7312. *
  7313. * @return bool
  7314. */
  7315. function api_get_user_blocked_by_captcha($username)
  7316. {
  7317. $userInfo = api_get_user_info_from_username($username);
  7318. if (empty($userInfo)) {
  7319. return false;
  7320. }
  7321. $data = UserManager::get_extra_user_data_by_field(
  7322. $userInfo['user_id'],
  7323. 'captcha_blocked_until_date'
  7324. );
  7325. if (isset($data) && isset($data['captcha_blocked_until_date'])) {
  7326. return $data['captcha_blocked_until_date'];
  7327. }
  7328. return false;
  7329. }
  7330. /**
  7331. * Remove tags from HTML anf return the $in_number_char first non-HTML char
  7332. * Postfix the text with "..." if it has been truncated.
  7333. *
  7334. * @param string $text
  7335. * @param int $number
  7336. *
  7337. * @return string
  7338. *
  7339. * @author hubert borderiou
  7340. */
  7341. function api_get_short_text_from_html($text, $number)
  7342. {
  7343. // Delete script and style tags
  7344. $text = preg_replace('/(<(script|style)\b[^>]*>).*?(<\/\2>)/is', "$1$3", $text);
  7345. $text = api_html_entity_decode($text);
  7346. $out_res = api_remove_tags_with_space($text, false);
  7347. $postfix = "...";
  7348. if (strlen($out_res) > $number) {
  7349. $out_res = substr($out_res, 0, $number).$postfix;
  7350. }
  7351. return $out_res;
  7352. }
  7353. /**
  7354. * Replace tags with a space in a text.
  7355. * If $in_double_quote_replace, replace " with '' (for HTML attribute purpose, for exemple).
  7356. *
  7357. * @return string
  7358. *
  7359. * @author hubert borderiou
  7360. */
  7361. function api_remove_tags_with_space($in_html, $in_double_quote_replace = true)
  7362. {
  7363. $out_res = $in_html;
  7364. if ($in_double_quote_replace) {
  7365. $out_res = str_replace('"', "''", $out_res);
  7366. }
  7367. // avoid text stuck together when tags are removed, adding a space after >
  7368. $out_res = str_replace(">", "> ", $out_res);
  7369. $out_res = strip_tags($out_res);
  7370. return $out_res;
  7371. }
  7372. /**
  7373. * If true, the drh can access all content (courses, users) inside a session.
  7374. *
  7375. * @return bool
  7376. */
  7377. function api_drh_can_access_all_session_content()
  7378. {
  7379. $value = api_get_setting('drh_can_access_all_session_content');
  7380. return $value === 'true';
  7381. }
  7382. /**
  7383. * @param string $tool
  7384. * @param string $setting
  7385. * @param int $defaultValue
  7386. *
  7387. * @return string
  7388. */
  7389. function api_get_default_tool_setting($tool, $setting, $defaultValue)
  7390. {
  7391. global $_configuration;
  7392. if (isset($_configuration[$tool]) &&
  7393. isset($_configuration[$tool]['default_settings']) &&
  7394. isset($_configuration[$tool]['default_settings'][$setting])
  7395. ) {
  7396. return $_configuration[$tool]['default_settings'][$setting];
  7397. }
  7398. return $defaultValue;
  7399. }
  7400. /**
  7401. * Checks if user can login as another user.
  7402. *
  7403. * @param int $loginAsUserId the user id to log in
  7404. * @param int $userId my user id
  7405. *
  7406. * @return bool
  7407. */
  7408. function api_can_login_as($loginAsUserId, $userId = null)
  7409. {
  7410. if (empty($userId)) {
  7411. $userId = api_get_user_id();
  7412. }
  7413. if ($loginAsUserId == $userId) {
  7414. return false;
  7415. }
  7416. if (empty($loginAsUserId)) {
  7417. return false;
  7418. }
  7419. if ($loginAsUserId != strval(intval($loginAsUserId))) {
  7420. return false;
  7421. }
  7422. // Check if the user to login is an admin
  7423. if (api_is_platform_admin_by_id($loginAsUserId)) {
  7424. // Only super admins can login to admin accounts
  7425. if (!api_global_admin_can_edit_admin($loginAsUserId)) {
  7426. return false;
  7427. }
  7428. }
  7429. $userInfo = api_get_user_info($loginAsUserId);
  7430. $isDrh = function () use ($loginAsUserId) {
  7431. if (api_is_drh()) {
  7432. if (api_drh_can_access_all_session_content()) {
  7433. $users = SessionManager::getAllUsersFromCoursesFromAllSessionFromStatus(
  7434. 'drh_all',
  7435. api_get_user_id()
  7436. );
  7437. $userList = [];
  7438. if (is_array($users)) {
  7439. foreach ($users as $user) {
  7440. $userList[] = $user['user_id'];
  7441. }
  7442. }
  7443. if (in_array($loginAsUserId, $userList)) {
  7444. return true;
  7445. }
  7446. } else {
  7447. if (api_is_drh() &&
  7448. UserManager::is_user_followed_by_drh($loginAsUserId, api_get_user_id())
  7449. ) {
  7450. return true;
  7451. }
  7452. }
  7453. }
  7454. return false;
  7455. };
  7456. $loginAsStatusForSessionAdmins = [STUDENT];
  7457. if (api_get_configuration_value('allow_session_admin_login_as_teacher')) {
  7458. $loginAsStatusForSessionAdmins[] = COURSEMANAGER;
  7459. }
  7460. return api_is_platform_admin() ||
  7461. (api_is_session_admin() && in_array($userInfo['status'], $loginAsStatusForSessionAdmins)) ||
  7462. $isDrh();
  7463. }
  7464. /**
  7465. * @return bool
  7466. */
  7467. function api_is_allowed_in_course()
  7468. {
  7469. if (api_is_platform_admin()) {
  7470. return true;
  7471. }
  7472. return Session::read('is_allowed_in_course');
  7473. }
  7474. /**
  7475. * Set the cookie to go directly to the course code $in_firstpage
  7476. * after login.
  7477. *
  7478. * @param string $value is the course code of the course to go
  7479. */
  7480. function api_set_firstpage_parameter($value)
  7481. {
  7482. setcookie('GotoCourse', $value);
  7483. }
  7484. /**
  7485. * Delete the cookie to go directly to the course code $in_firstpage
  7486. * after login.
  7487. */
  7488. function api_delete_firstpage_parameter()
  7489. {
  7490. setcookie('GotoCourse', '', time() - 3600);
  7491. }
  7492. /**
  7493. * @return bool if course_code for direct course access after login is set
  7494. */
  7495. function exist_firstpage_parameter()
  7496. {
  7497. return isset($_COOKIE['GotoCourse']) && $_COOKIE['GotoCourse'] != '';
  7498. }
  7499. /**
  7500. * @return return the course_code of the course where user login
  7501. */
  7502. function api_get_firstpage_parameter()
  7503. {
  7504. return $_COOKIE['GotoCourse'];
  7505. }
  7506. /**
  7507. * Return true on https install.
  7508. *
  7509. * @return bool
  7510. */
  7511. function api_is_https()
  7512. {
  7513. if (!empty($_SERVER['HTTP_X_FORWARDED_PROTO']) &&
  7514. $_SERVER['HTTP_X_FORWARDED_PROTO'] == 'https' || !empty($_configuration['force_https_forwarded_proto'])
  7515. ) {
  7516. $isSecured = true;
  7517. } else {
  7518. if (!empty($_SERVER['HTTPS']) && $_SERVER['HTTPS'] != 'off') {
  7519. $isSecured = true;
  7520. } else {
  7521. $isSecured = false;
  7522. // last chance
  7523. if (!empty($_SERVER['SERVER_PORT']) && $_SERVER['SERVER_PORT'] == 443) {
  7524. $isSecured = true;
  7525. }
  7526. }
  7527. }
  7528. return $isSecured;
  7529. }
  7530. /**
  7531. * Return protocol (http or https).
  7532. *
  7533. * @return string
  7534. */
  7535. function api_get_protocol()
  7536. {
  7537. return api_is_https() ? 'https' : 'http';
  7538. }
  7539. /**
  7540. * Return a string where " are replaced with 2 '
  7541. * It is useful when you pass a PHP variable in a Javascript browser dialog
  7542. * e.g. : alert("<?php get_lang('Message') ?>");
  7543. * and message contains character ".
  7544. *
  7545. * @param string $in_text
  7546. *
  7547. * @return string
  7548. */
  7549. function convert_double_quote_to_single($in_text)
  7550. {
  7551. return api_preg_replace('/"/', "''", $in_text);
  7552. }
  7553. /**
  7554. * Get origin.
  7555. *
  7556. * @param string
  7557. *
  7558. * @return string
  7559. */
  7560. function api_get_origin()
  7561. {
  7562. $origin = isset($_REQUEST['origin']) ? Security::remove_XSS($_REQUEST['origin']) : '';
  7563. return $origin;
  7564. }
  7565. /**
  7566. * Warns an user that the portal reach certain limit.
  7567. *
  7568. * @param string $limitName
  7569. */
  7570. function api_warn_hosting_contact($limitName)
  7571. {
  7572. $hostingParams = api_get_configuration_value(1);
  7573. $email = null;
  7574. if (!empty($hostingParams)) {
  7575. if (isset($hostingParams['hosting_contact_mail'])) {
  7576. $email = $hostingParams['hosting_contact_mail'];
  7577. }
  7578. }
  7579. if (!empty($email)) {
  7580. $subject = get_lang('HostingWarningReached');
  7581. $body = get_lang('PortalName').': '.api_get_path(WEB_PATH)." \n ";
  7582. $body .= get_lang('PortalLimitType').': '.$limitName." \n ";
  7583. if (isset($hostingParams[$limitName])) {
  7584. $body .= get_lang('Value').': '.$hostingParams[$limitName];
  7585. }
  7586. api_mail_html(null, $email, $subject, $body);
  7587. }
  7588. }
  7589. /**
  7590. * Gets value of a variable from app/config/configuration.php
  7591. * Variables that are not set in the configuration.php file but set elsewhere:
  7592. * - virtual_css_theme_folder (vchamilo plugin)
  7593. * - access_url (global.inc.php)
  7594. * - apc/apc_prefix (global.inc.php).
  7595. *
  7596. * @param string $variable
  7597. *
  7598. * @return bool|mixed
  7599. */
  7600. function api_get_configuration_value($variable)
  7601. {
  7602. global $_configuration;
  7603. // Check the current url id, id = 1 by default
  7604. $urlId = isset($_configuration['access_url']) ? (int) $_configuration['access_url'] : 1;
  7605. $variable = trim($variable);
  7606. // Check if variable exists
  7607. if (isset($_configuration[$variable])) {
  7608. if (is_array($_configuration[$variable])) {
  7609. // Check if it exists for the sub portal
  7610. if (array_key_exists($urlId, $_configuration[$variable])) {
  7611. return $_configuration[$variable][$urlId];
  7612. } else {
  7613. // Try to found element with id = 1 (master portal)
  7614. if (array_key_exists(1, $_configuration[$variable])) {
  7615. return $_configuration[$variable][1];
  7616. }
  7617. }
  7618. }
  7619. return $_configuration[$variable];
  7620. }
  7621. return false;
  7622. }
  7623. /**
  7624. * Returns supported image extensions in the portal.
  7625. *
  7626. * @param bool $supportVectors Whether vector images should also be accepted or not
  7627. *
  7628. * @return array Supported image extensions in the portal
  7629. */
  7630. function api_get_supported_image_extensions($supportVectors = true)
  7631. {
  7632. // jpg can also be called jpeg, jpe, jfif and jif. See https://en.wikipedia.org/wiki/JPEG#JPEG_filename_extensions
  7633. $supportedImageExtensions = ['jpg', 'jpeg', 'png', 'gif', 'jpe', 'jfif', 'jif'];
  7634. if ($supportVectors) {
  7635. array_push($supportedImageExtensions, 'svg');
  7636. }
  7637. if (version_compare(PHP_VERSION, '5.5.0', '>=')) {
  7638. array_push($supportedImageExtensions, 'webp');
  7639. }
  7640. return $supportedImageExtensions;
  7641. }
  7642. /**
  7643. * This setting changes the registration status for the campus.
  7644. *
  7645. * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
  7646. *
  7647. * @version August 2006
  7648. *
  7649. * @param bool $listCampus Whether we authorize
  7650. *
  7651. * @todo the $_settings should be reloaded here. => write api function for this and use this in global.inc.php also.
  7652. */
  7653. function api_register_campus($listCampus = true)
  7654. {
  7655. $tbl_settings = Database::get_main_table(TABLE_MAIN_SETTINGS_CURRENT);
  7656. $sql = "UPDATE $tbl_settings SET selected_value='true' WHERE variable='registered'";
  7657. Database::query($sql);
  7658. if (!$listCampus) {
  7659. $sql = "UPDATE $tbl_settings SET selected_value='true' WHERE variable='donotlistcampus'";
  7660. Database::query($sql);
  7661. }
  7662. }
  7663. /**
  7664. * Checks whether current user is a student boss.
  7665. *
  7666. * @global array $_user
  7667. *
  7668. * @return bool
  7669. */
  7670. function api_is_student_boss()
  7671. {
  7672. $_user = api_get_user_info();
  7673. return isset($_user['status']) && $_user['status'] == STUDENT_BOSS;
  7674. }
  7675. /**
  7676. * Check whether the user type should be exclude.
  7677. * Such as invited or anonymous users.
  7678. *
  7679. * @param bool $checkDB Optional. Whether check the user status
  7680. * @param int $userId Options. The user id
  7681. *
  7682. * @return bool
  7683. */
  7684. function api_is_excluded_user_type($checkDB = false, $userId = 0)
  7685. {
  7686. if ($checkDB) {
  7687. $userId = empty($userId) ? api_get_user_id() : (int) $userId;
  7688. if ($userId == 0) {
  7689. return true;
  7690. }
  7691. $userInfo = api_get_user_info($userId);
  7692. switch ($userInfo['status']) {
  7693. case INVITEE:
  7694. case ANONYMOUS:
  7695. return true;
  7696. default:
  7697. return false;
  7698. }
  7699. }
  7700. $isInvited = api_is_invitee();
  7701. $isAnonymous = api_is_anonymous();
  7702. if ($isInvited || $isAnonymous) {
  7703. return true;
  7704. }
  7705. return false;
  7706. }
  7707. /**
  7708. * Get the user status to ignore in reports.
  7709. *
  7710. * @param string $format Optional. The result type (array or string)
  7711. *
  7712. * @return array|string
  7713. */
  7714. function api_get_users_status_ignored_in_reports($format = 'array')
  7715. {
  7716. $excludedTypes = [
  7717. INVITEE,
  7718. ANONYMOUS,
  7719. ];
  7720. if ($format == 'string') {
  7721. return implode(', ', $excludedTypes);
  7722. }
  7723. return $excludedTypes;
  7724. }
  7725. /**
  7726. * Set the Site Use Cookie Warning for 1 year.
  7727. */
  7728. function api_set_site_use_cookie_warning_cookie()
  7729. {
  7730. setcookie('ChamiloUsesCookies', 'ok', time() + 31556926);
  7731. }
  7732. /**
  7733. * Return true if the Site Use Cookie Warning Cookie warning exists.
  7734. *
  7735. * @return bool
  7736. */
  7737. function api_site_use_cookie_warning_cookie_exist()
  7738. {
  7739. return isset($_COOKIE['ChamiloUsesCookies']);
  7740. }
  7741. /**
  7742. * Given a number of seconds, format the time to show hours, minutes and seconds.
  7743. *
  7744. * @param int $time The time in seconds
  7745. * @param string $originFormat Optional. PHP o JS
  7746. *
  7747. * @return string (00h00'00")
  7748. */
  7749. function api_format_time($time, $originFormat = 'php')
  7750. {
  7751. $h = get_lang('h');
  7752. $hours = $time / 3600;
  7753. $mins = ($time % 3600) / 60;
  7754. $secs = ($time % 60);
  7755. if ($time < 0) {
  7756. $hours = 0;
  7757. $mins = 0;
  7758. $secs = 0;
  7759. }
  7760. if ($originFormat == 'js') {
  7761. $formattedTime = trim(sprintf("%02d : %02d : %02d", $hours, $mins, $secs));
  7762. } else {
  7763. $formattedTime = trim(sprintf("%02d$h%02d'%02d\"", $hours, $mins, $secs));
  7764. }
  7765. return $formattedTime;
  7766. }
  7767. /**
  7768. * Create a new empty directory with index.html file.
  7769. *
  7770. * @param string $name The new directory name
  7771. * @param string $parentDirectory Directory parent directory name
  7772. *
  7773. * @return bool Return true if the directory was create. Otherwise return false
  7774. */
  7775. function api_create_protected_dir($name, $parentDirectory)
  7776. {
  7777. $isCreated = false;
  7778. if (!is_writable($parentDirectory)) {
  7779. return false;
  7780. }
  7781. $fullPath = $parentDirectory.api_replace_dangerous_char($name);
  7782. if (mkdir($fullPath, api_get_permissions_for_new_directories(), true)) {
  7783. $fp = fopen($fullPath.'/index.html', 'w');
  7784. if ($fp) {
  7785. if (fwrite($fp, '<html><head></head><body></body></html>')) {
  7786. $isCreated = true;
  7787. }
  7788. }
  7789. fclose($fp);
  7790. }
  7791. return $isCreated;
  7792. }
  7793. /**
  7794. * Sends an HTML email using the phpmailer class (and multipart/alternative to downgrade gracefully)
  7795. * Sender name and email can be specified, if not specified
  7796. * name and email of the platform admin are used.
  7797. *
  7798. * @author Bert Vanderkimpen ICT&O UGent
  7799. * @author Yannick Warnier <yannick.warnier@beeznest.com>
  7800. *
  7801. * @param string name of recipient
  7802. * @param string email of recipient
  7803. * @param string email subject
  7804. * @param string email body
  7805. * @param string sender name
  7806. * @param string sender e-mail
  7807. * @param array extra headers in form $headers = array($name => $value) to allow parsing
  7808. * @param array data file (path and filename)
  7809. * @param bool True for attaching a embedded file inside content html (optional)
  7810. * @param array Additional parameters
  7811. *
  7812. * @return int true if mail was sent
  7813. *
  7814. * @see class.phpmailer.php
  7815. */
  7816. function api_mail_html(
  7817. $recipient_name,
  7818. $recipient_email,
  7819. $subject,
  7820. $message,
  7821. $senderName = '',
  7822. $senderEmail = '',
  7823. $extra_headers = [],
  7824. $data_file = [],
  7825. $embedded_image = false,
  7826. $additionalParameters = []
  7827. ) {
  7828. global $platform_email;
  7829. $mail = new PHPMailer();
  7830. $mail->Mailer = $platform_email['SMTP_MAILER'];
  7831. $mail->Host = $platform_email['SMTP_HOST'];
  7832. $mail->Port = $platform_email['SMTP_PORT'];
  7833. $mail->CharSet = isset($platform_email['SMTP_CHARSET']) ? $platform_email['SMTP_CHARSET'] : 'UTF-8';
  7834. // Stay far below SMTP protocol 980 chars limit.
  7835. $mail->WordWrap = 200;
  7836. if ($platform_email['SMTP_AUTH']) {
  7837. $mail->SMTPAuth = 1;
  7838. $mail->Username = $platform_email['SMTP_USER'];
  7839. $mail->Password = $platform_email['SMTP_PASS'];
  7840. if (isset($platform_email['SMTP_SECURE'])) {
  7841. $mail->SMTPSecure = $platform_email['SMTP_SECURE'];
  7842. }
  7843. }
  7844. $mail->SMTPDebug = isset($platform_email['SMTP_DEBUG']) ? $platform_email['SMTP_DEBUG'] : 0;
  7845. // 5 = low, 1 = high
  7846. $mail->Priority = 3;
  7847. $mail->SMTPKeepAlive = true;
  7848. api_set_noreply_and_from_address_to_mailer(
  7849. $mail,
  7850. ['name' => $senderName, 'email' => $senderEmail],
  7851. !empty($extra_headers['reply_to']) ? $extra_headers['reply_to'] : []
  7852. );
  7853. unset($extra_headers['reply_to']);
  7854. $mail->Subject = $subject;
  7855. $mail->AltBody = strip_tags(
  7856. str_replace('<br />', "\n", api_html_entity_decode($message))
  7857. );
  7858. $list = api_get_configuration_value('send_all_emails_to');
  7859. if (!empty($list) && isset($list['emails'])) {
  7860. foreach ($list['emails'] as $email) {
  7861. //$mail->AddBCC($email);
  7862. $mail->AddAddress($email);
  7863. }
  7864. }
  7865. // Send embedded image.
  7866. if ($embedded_image) {
  7867. // Get all images html inside content.
  7868. preg_match_all("/<img\s+.*?src=[\"\']?([^\"\' >]*)[\"\']?[^>]*>/i", $message, $m);
  7869. // Prepare new tag images.
  7870. $new_images_html = [];
  7871. $i = 1;
  7872. if (!empty($m[1])) {
  7873. foreach ($m[1] as $image_path) {
  7874. $real_path = realpath($image_path);
  7875. $filename = basename($image_path);
  7876. $image_cid = $filename.'_'.$i;
  7877. $encoding = 'base64';
  7878. $image_type = mime_content_type($real_path);
  7879. $mail->AddEmbeddedImage(
  7880. $real_path,
  7881. $image_cid,
  7882. $filename,
  7883. $encoding,
  7884. $image_type
  7885. );
  7886. $new_images_html[] = '<img src="cid:'.$image_cid.'" />';
  7887. $i++;
  7888. }
  7889. }
  7890. // Replace origin image for new embedded image html.
  7891. $x = 0;
  7892. if (!empty($m[0])) {
  7893. foreach ($m[0] as $orig_img) {
  7894. $message = str_replace($orig_img, $new_images_html[$x], $message);
  7895. $x++;
  7896. }
  7897. }
  7898. }
  7899. $mailView = new Template(null, false, false, false, false, false, false);
  7900. $noReply = api_get_setting('noreply_email_address');
  7901. if (!empty($noReply)) {
  7902. $message .= "<br />".get_lang('ThisIsAutomaticEmailNoReply');
  7903. }
  7904. $mailView->assign('content', $message);
  7905. if (isset($additionalParameters['link'])) {
  7906. $mailView->assign('link', $additionalParameters['link']);
  7907. }
  7908. $mailView->assign('mail_header_style', api_get_configuration_value('mail_header_style'));
  7909. $mailView->assign('mail_content_style', api_get_configuration_value('mail_content_style'));
  7910. $layout = $mailView->get_template('mail/mail.tpl');
  7911. $mail->Body = $mailView->fetch($layout);
  7912. // Attachment ...
  7913. if (!empty($data_file)) {
  7914. foreach ($data_file as $file_attach) {
  7915. if (!empty($file_attach['path']) && !empty($file_attach['filename'])) {
  7916. $mail->AddAttachment($file_attach['path'], $file_attach['filename']);
  7917. }
  7918. }
  7919. }
  7920. // Only valid addresses are accepted.
  7921. if (is_array($recipient_email)) {
  7922. foreach ($recipient_email as $dest) {
  7923. if (api_valid_email($dest)) {
  7924. $mail->AddAddress($dest, $recipient_name);
  7925. }
  7926. }
  7927. } else {
  7928. if (api_valid_email($recipient_email)) {
  7929. $mail->AddAddress($recipient_email, $recipient_name);
  7930. } else {
  7931. return 0;
  7932. }
  7933. }
  7934. if (is_array($extra_headers) && count($extra_headers) > 0) {
  7935. foreach ($extra_headers as $key => $value) {
  7936. switch (strtolower($key)) {
  7937. case 'encoding':
  7938. case 'content-transfer-encoding':
  7939. $mail->Encoding = $value;
  7940. break;
  7941. case 'charset':
  7942. $mail->Charset = $value;
  7943. break;
  7944. case 'contenttype':
  7945. case 'content-type':
  7946. $mail->ContentType = $value;
  7947. break;
  7948. default:
  7949. $mail->AddCustomHeader($key.':'.$value);
  7950. break;
  7951. }
  7952. }
  7953. } else {
  7954. if (!empty($extra_headers)) {
  7955. $mail->AddCustomHeader($extra_headers);
  7956. }
  7957. }
  7958. // WordWrap the html body (phpMailer only fixes AltBody) FS#2988
  7959. $mail->Body = $mail->WrapText($mail->Body, $mail->WordWrap);
  7960. // Send the mail message.
  7961. if (!$mail->Send()) {
  7962. error_log('ERROR: mail not sent to '.$recipient_name.' ('.$recipient_email.') because of '.$mail->ErrorInfo.'<br />');
  7963. if ($mail->SMTPDebug) {
  7964. error_log(
  7965. "Connection details :: ".
  7966. "Protocol: ".$mail->Mailer.' :: '.
  7967. "Host/Port: ".$mail->Host.':'.$mail->Port.' :: '.
  7968. "Authent/Open: ".($mail->SMTPAuth ? 'Authent' : 'Open').' :: '.
  7969. ($mail->SMTPAuth ? " User/Pass: ".$mail->Username.':'.$mail->Password : '').' :: '.
  7970. "Sender: ".$mail->Sender
  7971. );
  7972. }
  7973. return 0;
  7974. }
  7975. if (!empty($additionalParameters)) {
  7976. $plugin = new AppPlugin();
  7977. $smsPlugin = $plugin->getSMSPluginLibrary();
  7978. if ($smsPlugin) {
  7979. $smsPlugin->send($additionalParameters);
  7980. }
  7981. }
  7982. // Clear all the addresses.
  7983. $mail->ClearAddresses();
  7984. // Clear all attachments
  7985. $mail->ClearAttachments();
  7986. return 1;
  7987. }
  7988. /**
  7989. * @param string $tool Possible values: GroupManager::GROUP_TOOL_*
  7990. * @param bool $showHeader
  7991. */
  7992. function api_protect_course_group($tool, $showHeader = true)
  7993. {
  7994. $groupId = api_get_group_id();
  7995. if (!empty($groupId)) {
  7996. $userId = api_get_user_id();
  7997. $groupInfo = GroupManager::get_group_properties($groupId);
  7998. // Group doesn't exists
  7999. if (empty($groupInfo)) {
  8000. api_not_allowed($showHeader);
  8001. }
  8002. // Check group access
  8003. $allow = GroupManager::user_has_access(
  8004. $userId,
  8005. $groupInfo['iid'],
  8006. $tool
  8007. );
  8008. if (!$allow) {
  8009. api_not_allowed($showHeader);
  8010. }
  8011. }
  8012. }
  8013. /**
  8014. * Check if a date is in a date range.
  8015. *
  8016. * @param datetime $startDate
  8017. * @param datetime $endDate
  8018. * @param datetime $currentDate
  8019. *
  8020. * @return bool true if date is in rage, false otherwise
  8021. */
  8022. function api_is_date_in_date_range($startDate, $endDate, $currentDate = null)
  8023. {
  8024. $startDate = strtotime(api_get_local_time($startDate));
  8025. $endDate = strtotime(api_get_local_time($endDate));
  8026. $currentDate = strtotime(api_get_local_time($currentDate));
  8027. if ($currentDate >= $startDate && $currentDate <= $endDate) {
  8028. return true;
  8029. }
  8030. return false;
  8031. }
  8032. /**
  8033. * Eliminate the duplicates of a multidimensional array by sending the key.
  8034. *
  8035. * @param array $array multidimensional array
  8036. * @param int $key key to find to compare
  8037. *
  8038. * @return array
  8039. */
  8040. function api_unique_multidim_array($array, $key)
  8041. {
  8042. $temp_array = [];
  8043. $i = 0;
  8044. $key_array = [];
  8045. foreach ($array as $val) {
  8046. if (!in_array($val[$key], $key_array)) {
  8047. $key_array[$i] = $val[$key];
  8048. $temp_array[$i] = $val;
  8049. }
  8050. $i++;
  8051. }
  8052. return $temp_array;
  8053. }
  8054. /**
  8055. * Limit the access to Session Admins when the limit_session_admin_role
  8056. * configuration variable is set to true.
  8057. */
  8058. function api_protect_limit_for_session_admin()
  8059. {
  8060. $limitAdmin = api_get_setting('limit_session_admin_role');
  8061. if (api_is_session_admin() && $limitAdmin === 'true') {
  8062. api_not_allowed(true);
  8063. }
  8064. }
  8065. /**
  8066. * Limits that a session admin has access to list users.
  8067. * When limit_session_admin_list_users configuration variable is set to true.
  8068. */
  8069. function api_protect_session_admin_list_users()
  8070. {
  8071. $limitAdmin = api_get_configuration_value('limit_session_admin_list_users');
  8072. if (api_is_session_admin() && true === $limitAdmin) {
  8073. api_not_allowed(true);
  8074. }
  8075. }
  8076. /**
  8077. * @return bool
  8078. */
  8079. function api_is_student_view_active()
  8080. {
  8081. $studentView = Session::read('studentview');
  8082. return $studentView == 'studentview';
  8083. }
  8084. /**
  8085. * Adds a file inside the upload/$type/id.
  8086. *
  8087. * @param string $type
  8088. * @param array $file
  8089. * @param int $itemId
  8090. * @param string $cropParameters
  8091. *
  8092. * @return array|bool
  8093. */
  8094. function api_upload_file($type, $file, $itemId, $cropParameters = '')
  8095. {
  8096. $upload = process_uploaded_file($file);
  8097. if ($upload) {
  8098. $name = api_replace_dangerous_char($file['name']);
  8099. // No "dangerous" files
  8100. $name = disable_dangerous_file($name);
  8101. $pathId = '/'.substr((string) $itemId, 0, 1).'/'.$itemId.'/';
  8102. $path = api_get_path(SYS_UPLOAD_PATH).$type.$pathId;
  8103. if (!is_dir($path)) {
  8104. mkdir($path, api_get_permissions_for_new_directories(), true);
  8105. }
  8106. $pathToSave = $path.$name;
  8107. $result = moveUploadedFile($file, $pathToSave);
  8108. if ($result) {
  8109. if (!empty($cropParameters)) {
  8110. $image = new Image($pathToSave);
  8111. $image->crop($cropParameters);
  8112. }
  8113. return ['path_to_save' => $pathId.$name];
  8114. }
  8115. return false;
  8116. }
  8117. }
  8118. /**
  8119. * @param string $type
  8120. * @param int $itemId
  8121. * @param string $file
  8122. *
  8123. * @return bool
  8124. */
  8125. function api_get_uploaded_web_url($type, $itemId, $file)
  8126. {
  8127. return api_get_uploaded_file($type, $itemId, $file, true);
  8128. }
  8129. /**
  8130. * @param string $type
  8131. * @param int $itemId
  8132. * @param string $file
  8133. * @param bool $getUrl
  8134. *
  8135. * @return bool
  8136. */
  8137. function api_get_uploaded_file($type, $itemId, $file, $getUrl = false)
  8138. {
  8139. $itemId = (int) $itemId;
  8140. $pathId = '/'.substr((string) $itemId, 0, 1).'/'.$itemId.'/';
  8141. $path = api_get_path(SYS_UPLOAD_PATH).$type.$pathId;
  8142. $file = basename($file);
  8143. $file = $path.'/'.$file;
  8144. if (Security::check_abs_path($file, $path) && is_file($file) && file_exists($file)) {
  8145. if ($getUrl) {
  8146. return str_replace(api_get_path(SYS_UPLOAD_PATH), api_get_path(WEB_UPLOAD_PATH), $file);
  8147. }
  8148. return $file;
  8149. }
  8150. return false;
  8151. }
  8152. /**
  8153. * @param string $type
  8154. * @param int $itemId
  8155. * @param string $file
  8156. * @param string $title
  8157. */
  8158. function api_download_uploaded_file($type, $itemId, $file, $title = '')
  8159. {
  8160. $file = api_get_uploaded_file($type, $itemId, $file);
  8161. if ($file) {
  8162. if (Security::check_abs_path($file, api_get_path(SYS_UPLOAD_PATH).$type)) {
  8163. DocumentManager::file_send_for_download($file, true, $title);
  8164. exit;
  8165. }
  8166. }
  8167. api_not_allowed(true);
  8168. }
  8169. /**
  8170. * @param string $type
  8171. * @param string $file
  8172. */
  8173. function api_remove_uploaded_file($type, $file)
  8174. {
  8175. $typePath = api_get_path(SYS_UPLOAD_PATH).$type;
  8176. $path = $typePath.'/'.$file;
  8177. if (Security::check_abs_path($path, $typePath) && file_exists($path) && is_file($path)) {
  8178. unlink($path);
  8179. }
  8180. }
  8181. /**
  8182. * @param string $type
  8183. * @param int $itemId
  8184. * @param string $file
  8185. *
  8186. * @return bool
  8187. */
  8188. function api_remove_uploaded_file_by_id($type, $itemId, $file)
  8189. {
  8190. $file = api_get_uploaded_file($type, $itemId, $file, false);
  8191. $typePath = api_get_path(SYS_UPLOAD_PATH).$type;
  8192. if (Security::check_abs_path($file, $typePath) && file_exists($file) && is_file($file)) {
  8193. unlink($file);
  8194. return true;
  8195. }
  8196. return false;
  8197. }
  8198. /**
  8199. * Converts string value to float value.
  8200. *
  8201. * 3.141516 => 3.141516
  8202. * 3,141516 => 3.141516
  8203. *
  8204. * @todo WIP
  8205. *
  8206. * @param string $number
  8207. *
  8208. * @return float
  8209. */
  8210. function api_float_val($number)
  8211. {
  8212. $number = (float) str_replace(',', '.', trim($number));
  8213. return $number;
  8214. }
  8215. /**
  8216. * Converts float values
  8217. * Example if $decimals = 2.
  8218. *
  8219. * 3.141516 => 3.14
  8220. * 3,141516 => 3,14
  8221. *
  8222. * @param string $number number in iso code
  8223. * @param int $decimals
  8224. * @param string $decimalSeparator
  8225. * @param string $thousandSeparator
  8226. *
  8227. * @return bool|string
  8228. */
  8229. function api_number_format($number, $decimals = 0, $decimalSeparator = '.', $thousandSeparator = ',')
  8230. {
  8231. $number = api_float_val($number);
  8232. return number_format($number, $decimals, $decimalSeparator, $thousandSeparator);
  8233. }
  8234. /**
  8235. * Set location url with a exit break by default.
  8236. *
  8237. * @param $url
  8238. * @param bool $exit
  8239. */
  8240. function location($url, $exit = true)
  8241. {
  8242. header('Location: '.$url);
  8243. if ($exit) {
  8244. exit;
  8245. }
  8246. }
  8247. /**
  8248. * @return string
  8249. */
  8250. function api_get_web_url()
  8251. {
  8252. if (api_get_setting('server_type') === 'test') {
  8253. return api_get_path(WEB_PATH).'web/app_dev.php/';
  8254. } else {
  8255. return api_get_path(WEB_PATH).'web/';
  8256. }
  8257. }
  8258. /**
  8259. * @param string $from
  8260. * @param string $to
  8261. *
  8262. * @return string
  8263. */
  8264. function api_get_relative_path($from, $to)
  8265. {
  8266. // some compatibility fixes for Windows paths
  8267. $from = is_dir($from) ? rtrim($from, '\/').'/' : $from;
  8268. $to = is_dir($to) ? rtrim($to, '\/').'/' : $to;
  8269. $from = str_replace('\\', '/', $from);
  8270. $to = str_replace('\\', '/', $to);
  8271. $from = explode('/', $from);
  8272. $to = explode('/', $to);
  8273. $relPath = $to;
  8274. foreach ($from as $depth => $dir) {
  8275. // find first non-matching dir
  8276. if ($dir === $to[$depth]) {
  8277. // ignore this directory
  8278. array_shift($relPath);
  8279. } else {
  8280. // get number of remaining dirs to $from
  8281. $remaining = count($from) - $depth;
  8282. if ($remaining > 1) {
  8283. // add traversals up to first matching dir
  8284. $padLength = (count($relPath) + $remaining - 1) * -1;
  8285. $relPath = array_pad($relPath, $padLength, '..');
  8286. break;
  8287. } else {
  8288. $relPath[0] = './'.$relPath[0];
  8289. }
  8290. }
  8291. }
  8292. return implode('/', $relPath);
  8293. }
  8294. /**
  8295. * Unserialize content using Brummann\Polyfill\Unserialize.
  8296. *
  8297. * @param string $type
  8298. * @param string $serialized
  8299. * @param bool $ignoreErrors. Optional.
  8300. *
  8301. * @return mixed
  8302. */
  8303. function api_unserialize_content($type, $serialized, $ignoreErrors = false)
  8304. {
  8305. switch ($type) {
  8306. case 'career':
  8307. case 'sequence_graph':
  8308. $allowedClasses = [Graph::class, VerticesMap::class, Vertices::class, Edges::class];
  8309. break;
  8310. case 'lp':
  8311. $allowedClasses = [
  8312. learnpath::class,
  8313. learnpathItem::class,
  8314. aicc::class,
  8315. aiccBlock::class,
  8316. aiccItem::class,
  8317. aiccObjective::class,
  8318. aiccResource::class,
  8319. scorm::class,
  8320. scormItem::class,
  8321. scormMetadata::class,
  8322. scormOrganization::class,
  8323. scormResource::class,
  8324. Link::class,
  8325. LpItem::class,
  8326. ];
  8327. break;
  8328. case 'course':
  8329. $allowedClasses = [
  8330. Course::class,
  8331. Announcement::class,
  8332. Attendance::class,
  8333. CalendarEvent::class,
  8334. CourseCopyLearnpath::class,
  8335. CourseCopyTestCategory::class,
  8336. CourseDescription::class,
  8337. CourseSession::class,
  8338. Document::class,
  8339. Forum::class,
  8340. ForumCategory::class,
  8341. ForumPost::class,
  8342. ForumTopic::class,
  8343. Glossary::class,
  8344. GradeBookBackup::class,
  8345. Link::class,
  8346. LinkCategory::class,
  8347. Quiz::class,
  8348. QuizQuestion::class,
  8349. QuizQuestionOption::class,
  8350. ScormDocument::class,
  8351. Survey::class,
  8352. SurveyInvitation::class,
  8353. SurveyQuestion::class,
  8354. Thematic::class,
  8355. ToolIntro::class,
  8356. Wiki::class,
  8357. Work::class,
  8358. stdClass::class,
  8359. ];
  8360. break;
  8361. case 'not_allowed_classes':
  8362. default:
  8363. $allowedClasses = false;
  8364. }
  8365. if ($ignoreErrors) {
  8366. return @Unserialize::unserialize(
  8367. $serialized,
  8368. ['allowed_classes' => $allowedClasses]
  8369. );
  8370. }
  8371. return Unserialize::unserialize(
  8372. $serialized,
  8373. ['allowed_classes' => $allowedClasses]
  8374. );
  8375. }
  8376. /**
  8377. * Set the From and ReplyTo properties to PHPMailer instance.
  8378. *
  8379. * @param PHPMailer $mailer
  8380. * @param array $sender
  8381. * @param array $replyToAddress
  8382. *
  8383. * @throws phpmailerException
  8384. */
  8385. function api_set_noreply_and_from_address_to_mailer(PHPMailer $mailer, array $sender, array $replyToAddress = [])
  8386. {
  8387. $platformEmail = $GLOBALS['platform_email'];
  8388. $noReplyAddress = api_get_setting('noreply_email_address');
  8389. $avoidReplyToAddress = false;
  8390. if (!empty($noReplyAddress)) {
  8391. $avoidReplyToAddress = api_get_configuration_value('mail_no_reply_avoid_reply_to');
  8392. }
  8393. $notification = new Notification();
  8394. // If the parameter is set don't use the admin.
  8395. $senderName = !empty($sender['name']) ? $sender['name'] : $notification->getDefaultPlatformSenderName();
  8396. $senderEmail = !empty($sender['email']) ? $sender['email'] : $notification->getDefaultPlatformSenderEmail();
  8397. // Reply to first
  8398. if (!$avoidReplyToAddress) {
  8399. $mailer->AddCustomHeader('Errors-To: '.$notification->getDefaultPlatformSenderEmail());
  8400. if (
  8401. !empty($replyToAddress) &&
  8402. $platformEmail['SMTP_UNIQUE_REPLY_TO'] &&
  8403. PHPMailer::ValidateAddress($replyToAddress['mail'])
  8404. ) {
  8405. $mailer->AddReplyTo($replyToAddress['email'], $replyToAddress['name']);
  8406. // Errors to sender
  8407. $mailer->AddCustomHeader('Errors-To: '.$replyToAddress['mail']);
  8408. $mailer->Sender = $replyToAddress['mail'];
  8409. }
  8410. }
  8411. //If the SMTP configuration only accept one sender
  8412. if (
  8413. isset($platformEmail['SMTP_UNIQUE_SENDER']) &&
  8414. $platformEmail['SMTP_UNIQUE_SENDER']
  8415. ) {
  8416. $senderName = $platformEmail['SMTP_FROM_NAME'];
  8417. $senderEmail = $platformEmail['SMTP_FROM_EMAIL'];
  8418. if (PHPMailer::ValidateAddress($senderEmail)) {
  8419. //force-set Sender to $senderEmail, otherwise SetFrom only does it if it is currently empty
  8420. $mailer->Sender = $senderEmail;
  8421. }
  8422. }
  8423. $mailer->SetFrom($senderEmail, $senderName, !$avoidReplyToAddress);
  8424. }
  8425. /**
  8426. * @param string $template
  8427. *
  8428. * @return string
  8429. */
  8430. function api_find_template($template)
  8431. {
  8432. return Template::findTemplateFilePath($template);
  8433. }
  8434. /**
  8435. * @return array
  8436. */
  8437. function api_get_language_list_for_flag()
  8438. {
  8439. $table = Database::get_main_table(TABLE_MAIN_LANGUAGE);
  8440. $sql = "SELECT english_name, isocode FROM $table
  8441. ORDER BY original_name ASC";
  8442. static $languages = [];
  8443. if (empty($languages)) {
  8444. $result = Database::query($sql);
  8445. while ($row = Database::fetch_array($result)) {
  8446. $languages[$row['english_name']] = $row['isocode'];
  8447. }
  8448. $languages['english'] = 'gb';
  8449. }
  8450. return $languages;
  8451. }
  8452. /**
  8453. * @return string
  8454. */
  8455. function api_get_language_translate_html()
  8456. {
  8457. $translate = api_get_configuration_value('translate_html');
  8458. if (!$translate) {
  8459. return '';
  8460. }
  8461. $languageList = api_get_languages();
  8462. $hideAll = '';
  8463. foreach ($languageList['all'] as $language) {
  8464. $hideAll .= '
  8465. $("span:lang('.$language['isocode'].')").filter(
  8466. function(e, val) {
  8467. // Only find the spans if they have set the lang
  8468. if ($(this).attr("lang") == null) {
  8469. return false;
  8470. }
  8471. // Ignore ckeditor classes
  8472. return !this.className.match(/cke(.*)/);
  8473. }).hide();'."\n";
  8474. }
  8475. $userInfo = api_get_user_info();
  8476. $languageId = api_get_language_id($userInfo['language']);
  8477. $languageInfo = api_get_language_info($languageId);
  8478. $isoCode = 'en';
  8479. if (!empty($languageInfo)) {
  8480. $isoCode = $languageInfo['isocode'];
  8481. }
  8482. return '
  8483. $(function() {
  8484. '.$hideAll.'
  8485. var defaultLanguageFromUser = "'.$isoCode.'";
  8486. $("span:lang('.$isoCode.')").filter(
  8487. function() {
  8488. // Ignore ckeditor classes
  8489. return !this.className.match(/cke(.*)/);
  8490. }).show();
  8491. var defaultLanguage = "";
  8492. var langFromUserFound = false;
  8493. $(this).find("span").filter(
  8494. function() {
  8495. // Ignore ckeditor classes
  8496. return !this.className.match(/cke(.*)/);
  8497. }).each(function() {
  8498. defaultLanguage = $(this).attr("lang");
  8499. if (defaultLanguage) {
  8500. $(this).before().next("br").remove();
  8501. if (defaultLanguageFromUser == defaultLanguage) {
  8502. langFromUserFound = true;
  8503. }
  8504. }
  8505. });
  8506. // Show default language
  8507. if (langFromUserFound == false && defaultLanguage) {
  8508. $("span:lang("+defaultLanguage+")").filter(
  8509. function() {
  8510. // Ignore ckeditor classes
  8511. return !this.className.match(/cke(.*)/);
  8512. }).show();
  8513. }
  8514. });
  8515. ';
  8516. }