api.lib.php 280 KB

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