common.inc 310 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582
  1. <?php
  2. /**
  3. * @file
  4. * Common functions that many Drupal modules will need to reference.
  5. *
  6. * The functions that are critical and need to be available even when serving
  7. * a cached page are instead located in bootstrap.inc.
  8. */
  9. /**
  10. * @defgroup php_wrappers PHP wrapper functions
  11. * @{
  12. * Functions that are wrappers or custom implementations of PHP functions.
  13. *
  14. * Certain PHP functions should not be used in Drupal. Instead, Drupal's
  15. * replacement functions should be used.
  16. *
  17. * For example, for improved or more secure UTF8-handling, or RFC-compliant
  18. * handling of URLs in Drupal.
  19. *
  20. * For ease of use and memorizing, all these wrapper functions use the same name
  21. * as the original PHP function, but prefixed with "drupal_". Beware, however,
  22. * that not all wrapper functions support the same arguments as the original
  23. * functions.
  24. *
  25. * You should always use these wrapper functions in your code.
  26. *
  27. * Wrong:
  28. * @code
  29. * $my_substring = substr($original_string, 0, 5);
  30. * @endcode
  31. *
  32. * Correct:
  33. * @code
  34. * $my_substring = drupal_substr($original_string, 0, 5);
  35. * @endcode
  36. *
  37. * @}
  38. */
  39. /**
  40. * Return status for saving which involved creating a new item.
  41. */
  42. define('SAVED_NEW', 1);
  43. /**
  44. * Return status for saving which involved an update to an existing item.
  45. */
  46. define('SAVED_UPDATED', 2);
  47. /**
  48. * Return status for saving which deleted an existing item.
  49. */
  50. define('SAVED_DELETED', 3);
  51. /**
  52. * The default group for system CSS files added to the page.
  53. */
  54. define('CSS_SYSTEM', -100);
  55. /**
  56. * The default group for module CSS files added to the page.
  57. */
  58. define('CSS_DEFAULT', 0);
  59. /**
  60. * The default group for theme CSS files added to the page.
  61. */
  62. define('CSS_THEME', 100);
  63. /**
  64. * The default group for JavaScript and jQuery libraries added to the page.
  65. */
  66. define('JS_LIBRARY', -100);
  67. /**
  68. * The default group for module JavaScript code added to the page.
  69. */
  70. define('JS_DEFAULT', 0);
  71. /**
  72. * The default group for theme JavaScript code added to the page.
  73. */
  74. define('JS_THEME', 100);
  75. /**
  76. * Error code indicating that the request exceeded the specified timeout.
  77. *
  78. * @see drupal_http_request()
  79. */
  80. define('HTTP_REQUEST_TIMEOUT', -1);
  81. /**
  82. * @defgroup block_caching Block Caching
  83. * @{
  84. * Constants that define each block's caching state.
  85. *
  86. * Modules specify how their blocks can be cached in their hook_block_info()
  87. * implementations. Caching can be turned off (DRUPAL_NO_CACHE), managed by the
  88. * module declaring the block (DRUPAL_CACHE_CUSTOM), or managed by the core
  89. * Block module. If the Block module is managing the cache, you can specify that
  90. * the block is the same for every page and user (DRUPAL_CACHE_GLOBAL), or that
  91. * it can change depending on the page (DRUPAL_CACHE_PER_PAGE) or by user
  92. * (DRUPAL_CACHE_PER_ROLE or DRUPAL_CACHE_PER_USER). Page and user settings can
  93. * be combined with a bitwise-binary or operator; for example,
  94. * DRUPAL_CACHE_PER_ROLE | DRUPAL_CACHE_PER_PAGE means that the block can change
  95. * depending on the user role or page it is on.
  96. *
  97. * The block cache is cleared in cache_clear_all(), and uses the same clearing
  98. * policy than page cache (node, comment, user, taxonomy added or updated...).
  99. * Blocks requiring more fine-grained clearing might consider disabling the
  100. * built-in block cache (DRUPAL_NO_CACHE) and roll their own.
  101. *
  102. * Note that user 1 is excluded from block caching.
  103. */
  104. /**
  105. * The block should not get cached.
  106. *
  107. * This setting should be used:
  108. * - For simple blocks (notably those that do not perform any db query), where
  109. * querying the db cache would be more expensive than directly generating the
  110. * content.
  111. * - For blocks that change too frequently.
  112. */
  113. define('DRUPAL_NO_CACHE', -1);
  114. /**
  115. * The block is handling its own caching in its hook_block_view().
  116. *
  117. * This setting is useful when time based expiration is needed or a site uses a
  118. * node access which invalidates standard block cache.
  119. */
  120. define('DRUPAL_CACHE_CUSTOM', -2);
  121. /**
  122. * The block or element can change depending on the user's roles.
  123. *
  124. * This is the default setting for blocks, used when the block does not specify
  125. * anything.
  126. */
  127. define('DRUPAL_CACHE_PER_ROLE', 0x0001);
  128. /**
  129. * The block or element can change depending on the user.
  130. *
  131. * This setting can be resource-consuming for sites with large number of users,
  132. * and thus should only be used when DRUPAL_CACHE_PER_ROLE is not sufficient.
  133. */
  134. define('DRUPAL_CACHE_PER_USER', 0x0002);
  135. /**
  136. * The block or element can change depending on the page being viewed.
  137. */
  138. define('DRUPAL_CACHE_PER_PAGE', 0x0004);
  139. /**
  140. * The block or element is the same for every user and page that it is visible.
  141. */
  142. define('DRUPAL_CACHE_GLOBAL', 0x0008);
  143. /**
  144. * @} End of "defgroup block_caching".
  145. */
  146. /**
  147. * Adds content to a specified region.
  148. *
  149. * @param $region
  150. * Page region the content is added to.
  151. * @param $data
  152. * Content to be added.
  153. */
  154. function drupal_add_region_content($region = NULL, $data = NULL) {
  155. static $content = array();
  156. if (isset($region) && isset($data)) {
  157. $content[$region][] = $data;
  158. }
  159. return $content;
  160. }
  161. /**
  162. * Gets assigned content for a given region.
  163. *
  164. * @param $region
  165. * A specified region to fetch content for. If NULL, all regions will be
  166. * returned.
  167. * @param $delimiter
  168. * Content to be inserted between imploded array elements.
  169. */
  170. function drupal_get_region_content($region = NULL, $delimiter = ' ') {
  171. $content = drupal_add_region_content();
  172. if (isset($region)) {
  173. if (isset($content[$region]) && is_array($content[$region])) {
  174. return implode($delimiter, $content[$region]);
  175. }
  176. }
  177. else {
  178. foreach (array_keys($content) as $region) {
  179. if (is_array($content[$region])) {
  180. $content[$region] = implode($delimiter, $content[$region]);
  181. }
  182. }
  183. return $content;
  184. }
  185. }
  186. /**
  187. * Gets the name of the currently active installation profile.
  188. *
  189. * When this function is called during Drupal's initial installation process,
  190. * the name of the profile that's about to be installed is stored in the global
  191. * installation state. At all other times, the standard Drupal systems variable
  192. * table contains the name of the current profile, and we can call
  193. * variable_get() to determine what one is active.
  194. *
  195. * @return $profile
  196. * The name of the installation profile.
  197. */
  198. function drupal_get_profile() {
  199. global $install_state;
  200. if (isset($install_state['parameters']['profile'])) {
  201. $profile = $install_state['parameters']['profile'];
  202. }
  203. else {
  204. $profile = variable_get('install_profile', 'standard');
  205. }
  206. return $profile;
  207. }
  208. /**
  209. * Sets the breadcrumb trail for the current page.
  210. *
  211. * @param $breadcrumb
  212. * Array of links, starting with "home" and proceeding up to but not including
  213. * the current page.
  214. */
  215. function drupal_set_breadcrumb($breadcrumb = NULL) {
  216. $stored_breadcrumb = &drupal_static(__FUNCTION__);
  217. if (isset($breadcrumb)) {
  218. $stored_breadcrumb = $breadcrumb;
  219. }
  220. return $stored_breadcrumb;
  221. }
  222. /**
  223. * Gets the breadcrumb trail for the current page.
  224. */
  225. function drupal_get_breadcrumb() {
  226. $breadcrumb = drupal_set_breadcrumb();
  227. if (!isset($breadcrumb)) {
  228. $breadcrumb = menu_get_active_breadcrumb();
  229. }
  230. return $breadcrumb;
  231. }
  232. /**
  233. * Returns a string containing RDF namespace declarations for use in XML and
  234. * XHTML output.
  235. */
  236. function drupal_get_rdf_namespaces() {
  237. $xml_rdf_namespaces = array();
  238. // Serializes the RDF namespaces in XML namespace syntax.
  239. if (function_exists('rdf_get_namespaces')) {
  240. foreach (rdf_get_namespaces() as $prefix => $uri) {
  241. $xml_rdf_namespaces[] = 'xmlns:' . $prefix . '="' . $uri . '"';
  242. }
  243. }
  244. return count($xml_rdf_namespaces) ? "\n " . implode("\n ", $xml_rdf_namespaces) : '';
  245. }
  246. /**
  247. * Adds output to the HEAD tag of the HTML page.
  248. *
  249. * This function can be called as long as the headers aren't sent. Pass no
  250. * arguments (or NULL for both) to retrieve the currently stored elements.
  251. *
  252. * @param $data
  253. * A renderable array. If the '#type' key is not set then 'html_tag' will be
  254. * added as the default '#type'.
  255. * @param $key
  256. * A unique string key to allow implementations of hook_html_head_alter() to
  257. * identify the element in $data. Required if $data is not NULL.
  258. *
  259. * @return
  260. * An array of all stored HEAD elements.
  261. *
  262. * @see theme_html_tag()
  263. */
  264. function drupal_add_html_head($data = NULL, $key = NULL) {
  265. $stored_head = &drupal_static(__FUNCTION__);
  266. if (!isset($stored_head)) {
  267. // Make sure the defaults, including Content-Type, come first.
  268. $stored_head = _drupal_default_html_head();
  269. }
  270. if (isset($data) && isset($key)) {
  271. if (!isset($data['#type'])) {
  272. $data['#type'] = 'html_tag';
  273. }
  274. $stored_head[$key] = $data;
  275. }
  276. return $stored_head;
  277. }
  278. /**
  279. * Returns elements that are always displayed in the HEAD tag of the HTML page.
  280. */
  281. function _drupal_default_html_head() {
  282. // Add default elements. Make sure the Content-Type comes first because the
  283. // IE browser may be vulnerable to XSS via encoding attacks from any content
  284. // that comes before this META tag, such as a TITLE tag.
  285. $elements['system_meta_content_type'] = array(
  286. '#type' => 'html_tag',
  287. '#tag' => 'meta',
  288. '#attributes' => array(
  289. 'http-equiv' => 'Content-Type',
  290. 'content' => 'text/html; charset=utf-8',
  291. ),
  292. // Security: This always has to be output first.
  293. '#weight' => -1000,
  294. );
  295. // Show Drupal and the major version number in the META GENERATOR tag.
  296. // Get the major version.
  297. list($version, ) = explode('.', VERSION);
  298. $elements['system_meta_generator'] = array(
  299. '#type' => 'html_tag',
  300. '#tag' => 'meta',
  301. '#attributes' => array(
  302. 'name' => 'Generator',
  303. 'content' => 'Drupal ' . $version . ' (http://drupal.org)',
  304. ),
  305. );
  306. // Also send the generator in the HTTP header.
  307. $elements['system_meta_generator']['#attached']['drupal_add_http_header'][] = array('X-Generator', $elements['system_meta_generator']['#attributes']['content']);
  308. return $elements;
  309. }
  310. /**
  311. * Retrieves output to be displayed in the HEAD tag of the HTML page.
  312. */
  313. function drupal_get_html_head() {
  314. $elements = drupal_add_html_head();
  315. drupal_alter('html_head', $elements);
  316. return drupal_render($elements);
  317. }
  318. /**
  319. * Adds a feed URL for the current page.
  320. *
  321. * This function can be called as long the HTML header hasn't been sent.
  322. *
  323. * @param $url
  324. * An internal system path or a fully qualified external URL of the feed.
  325. * @param $title
  326. * The title of the feed.
  327. */
  328. function drupal_add_feed($url = NULL, $title = '') {
  329. $stored_feed_links = &drupal_static(__FUNCTION__, array());
  330. if (isset($url)) {
  331. $stored_feed_links[$url] = theme('feed_icon', array('url' => $url, 'title' => $title));
  332. drupal_add_html_head_link(array(
  333. 'rel' => 'alternate',
  334. 'type' => 'application/rss+xml',
  335. 'title' => $title,
  336. // Force the URL to be absolute, for consistency with other <link> tags
  337. // output by Drupal.
  338. 'href' => url($url, array('absolute' => TRUE)),
  339. ));
  340. }
  341. return $stored_feed_links;
  342. }
  343. /**
  344. * Gets the feed URLs for the current page.
  345. *
  346. * @param $delimiter
  347. * A delimiter to split feeds by.
  348. */
  349. function drupal_get_feeds($delimiter = "\n") {
  350. $feeds = drupal_add_feed();
  351. return implode($delimiter, $feeds);
  352. }
  353. /**
  354. * @defgroup http_handling HTTP handling
  355. * @{
  356. * Functions to properly handle HTTP responses.
  357. */
  358. /**
  359. * Processes a URL query parameter array to remove unwanted elements.
  360. *
  361. * @param $query
  362. * (optional) An array to be processed. Defaults to $_GET.
  363. * @param $exclude
  364. * (optional) A list of $query array keys to remove. Use "parent[child]" to
  365. * exclude nested items. Defaults to array('q').
  366. * @param $parent
  367. * Internal use only. Used to build the $query array key for nested items.
  368. *
  369. * @return
  370. * An array containing query parameters, which can be used for url().
  371. */
  372. function drupal_get_query_parameters(array $query = NULL, array $exclude = array('q'), $parent = '') {
  373. // Set defaults, if none given.
  374. if (!isset($query)) {
  375. $query = $_GET;
  376. }
  377. // If $exclude is empty, there is nothing to filter.
  378. if (empty($exclude)) {
  379. return $query;
  380. }
  381. elseif (!$parent) {
  382. $exclude = array_flip($exclude);
  383. }
  384. $params = array();
  385. foreach ($query as $key => $value) {
  386. $string_key = ($parent ? $parent . '[' . $key . ']' : $key);
  387. if (isset($exclude[$string_key])) {
  388. continue;
  389. }
  390. if (is_array($value)) {
  391. $params[$key] = drupal_get_query_parameters($value, $exclude, $string_key);
  392. }
  393. else {
  394. $params[$key] = $value;
  395. }
  396. }
  397. return $params;
  398. }
  399. /**
  400. * Splits a URL-encoded query string into an array.
  401. *
  402. * @param $query
  403. * The query string to split.
  404. *
  405. * @return
  406. * An array of URL decoded couples $param_name => $value.
  407. */
  408. function drupal_get_query_array($query) {
  409. $result = array();
  410. if (!empty($query)) {
  411. foreach (explode('&', $query) as $param) {
  412. $param = explode('=', $param, 2);
  413. $result[$param[0]] = isset($param[1]) ? rawurldecode($param[1]) : '';
  414. }
  415. }
  416. return $result;
  417. }
  418. /**
  419. * Parses an array into a valid, rawurlencoded query string.
  420. *
  421. * This differs from http_build_query() as we need to rawurlencode() (instead of
  422. * urlencode()) all query parameters.
  423. *
  424. * @param $query
  425. * The query parameter array to be processed, e.g. $_GET.
  426. * @param $parent
  427. * Internal use only. Used to build the $query array key for nested items.
  428. *
  429. * @return
  430. * A rawurlencoded string which can be used as or appended to the URL query
  431. * string.
  432. *
  433. * @see drupal_get_query_parameters()
  434. * @ingroup php_wrappers
  435. */
  436. function drupal_http_build_query(array $query, $parent = '') {
  437. $params = array();
  438. foreach ($query as $key => $value) {
  439. $key = $parent ? $parent . rawurlencode('[' . $key . ']') : rawurlencode($key);
  440. // Recurse into children.
  441. if (is_array($value)) {
  442. $params[] = drupal_http_build_query($value, $key);
  443. }
  444. // If a query parameter value is NULL, only append its key.
  445. elseif (!isset($value)) {
  446. $params[] = $key;
  447. }
  448. else {
  449. // For better readability of paths in query strings, we decode slashes.
  450. $params[] = $key . '=' . str_replace('%2F', '/', rawurlencode($value));
  451. }
  452. }
  453. return implode('&', $params);
  454. }
  455. /**
  456. * Prepares a 'destination' URL query parameter for use with drupal_goto().
  457. *
  458. * Used to direct the user back to the referring page after completing a form.
  459. * By default the current URL is returned. If a destination exists in the
  460. * previous request, that destination is returned. As such, a destination can
  461. * persist across multiple pages.
  462. *
  463. * @return
  464. * An associative array containing the key:
  465. * - destination: The path provided via the destination query string or, if
  466. * not available, the current path.
  467. *
  468. * @see current_path()
  469. * @see drupal_goto()
  470. */
  471. function drupal_get_destination() {
  472. $destination = &drupal_static(__FUNCTION__);
  473. if (isset($destination)) {
  474. return $destination;
  475. }
  476. if (isset($_GET['destination'])) {
  477. $destination = array('destination' => $_GET['destination']);
  478. }
  479. else {
  480. $path = $_GET['q'];
  481. $query = drupal_http_build_query(drupal_get_query_parameters());
  482. if ($query != '') {
  483. $path .= '?' . $query;
  484. }
  485. $destination = array('destination' => $path);
  486. }
  487. return $destination;
  488. }
  489. /**
  490. * Parses a URL string into its path, query, and fragment components.
  491. *
  492. * This function splits both internal paths like @code node?b=c#d @endcode and
  493. * external URLs like @code https://example.com/a?b=c#d @endcode into their
  494. * component parts. See
  495. * @link http://tools.ietf.org/html/rfc3986#section-3 RFC 3986 @endlink for an
  496. * explanation of what the component parts are.
  497. *
  498. * Note that, unlike the RFC, when passed an external URL, this function
  499. * groups the scheme, authority, and path together into the path component.
  500. *
  501. * @param string $url
  502. * The internal path or external URL string to parse.
  503. *
  504. * @return array
  505. * An associative array containing:
  506. * - path: The path component of $url. If $url is an external URL, this
  507. * includes the scheme, authority, and path.
  508. * - query: An array of query parameters from $url, if they exist.
  509. * - fragment: The fragment component from $url, if it exists.
  510. *
  511. * @see drupal_goto()
  512. * @see l()
  513. * @see url()
  514. * @see http://tools.ietf.org/html/rfc3986
  515. *
  516. * @ingroup php_wrappers
  517. */
  518. function drupal_parse_url($url) {
  519. $options = array(
  520. 'path' => NULL,
  521. 'query' => array(),
  522. 'fragment' => '',
  523. );
  524. // External URLs: not using parse_url() here, so we do not have to rebuild
  525. // the scheme, host, and path without having any use for it.
  526. if (strpos($url, '://') !== FALSE) {
  527. // Split off everything before the query string into 'path'.
  528. $parts = explode('?', $url);
  529. $options['path'] = $parts[0];
  530. // If there is a query string, transform it into keyed query parameters.
  531. if (isset($parts[1])) {
  532. $query_parts = explode('#', $parts[1]);
  533. parse_str($query_parts[0], $options['query']);
  534. // Take over the fragment, if there is any.
  535. if (isset($query_parts[1])) {
  536. $options['fragment'] = $query_parts[1];
  537. }
  538. }
  539. }
  540. // Internal URLs.
  541. else {
  542. // parse_url() does not support relative URLs, so make it absolute. E.g. the
  543. // relative URL "foo/bar:1" isn't properly parsed.
  544. $parts = parse_url('http://example.com/' . $url);
  545. // Strip the leading slash that was just added.
  546. $options['path'] = substr($parts['path'], 1);
  547. if (isset($parts['query'])) {
  548. parse_str($parts['query'], $options['query']);
  549. }
  550. if (isset($parts['fragment'])) {
  551. $options['fragment'] = $parts['fragment'];
  552. }
  553. }
  554. // The 'q' parameter contains the path of the current page if clean URLs are
  555. // disabled. It overrides the 'path' of the URL when present, even if clean
  556. // URLs are enabled, due to how Apache rewriting rules work. The path
  557. // parameter must be a string.
  558. if (isset($options['query']['q']) && is_string($options['query']['q'])) {
  559. $options['path'] = $options['query']['q'];
  560. unset($options['query']['q']);
  561. }
  562. return $options;
  563. }
  564. /**
  565. * Encodes a Drupal path for use in a URL.
  566. *
  567. * For aesthetic reasons slashes are not escaped.
  568. *
  569. * Note that url() takes care of calling this function, so a path passed to that
  570. * function should not be encoded in advance.
  571. *
  572. * @param $path
  573. * The Drupal path to encode.
  574. */
  575. function drupal_encode_path($path) {
  576. return str_replace('%2F', '/', rawurlencode($path));
  577. }
  578. /**
  579. * Sends the user to a different page.
  580. *
  581. * This issues an on-site HTTP redirect. The function makes sure the redirected
  582. * URL is formatted correctly.
  583. *
  584. * Usually the redirected URL is constructed from this function's input
  585. * parameters. However you may override that behavior by setting a
  586. * destination in either the $_REQUEST-array (i.e. by using
  587. * the query string of an URI) This is used to direct the user back to
  588. * the proper page after completing a form. For example, after editing
  589. * a post on the 'admin/content'-page or after having logged on using the
  590. * 'user login'-block in a sidebar. The function drupal_get_destination()
  591. * can be used to help set the destination URL.
  592. *
  593. * Drupal will ensure that messages set by drupal_set_message() and other
  594. * session data are written to the database before the user is redirected.
  595. *
  596. * This function ends the request; use it instead of a return in your menu
  597. * callback.
  598. *
  599. * @param $path
  600. * (optional) A Drupal path or a full URL, which will be passed to url() to
  601. * compute the redirect for the URL.
  602. * @param $options
  603. * (optional) An associative array of additional URL options to pass to url().
  604. * @param $http_response_code
  605. * (optional) The HTTP status code to use for the redirection, defaults to
  606. * 302. The valid values for 3xx redirection status codes are defined in
  607. * @link http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.3 RFC 2616 @endlink
  608. * and the
  609. * @link http://tools.ietf.org/html/draft-reschke-http-status-308-07 draft for the new HTTP status codes: @endlink
  610. * - 301: Moved Permanently (the recommended value for most redirects).
  611. * - 302: Found (default in Drupal and PHP, sometimes used for spamming search
  612. * engines).
  613. * - 303: See Other.
  614. * - 304: Not Modified.
  615. * - 305: Use Proxy.
  616. * - 307: Temporary Redirect.
  617. *
  618. * @see drupal_get_destination()
  619. * @see url()
  620. */
  621. function drupal_goto($path = '', array $options = array(), $http_response_code = 302) {
  622. // A destination in $_GET always overrides the function arguments.
  623. // We do not allow absolute URLs to be passed via $_GET, as this can be an attack vector.
  624. if (isset($_GET['destination']) && !url_is_external($_GET['destination'])) {
  625. $destination = drupal_parse_url($_GET['destination']);
  626. // Double check the path derived by drupal_parse_url() is not external.
  627. if (!url_is_external($destination['path'])) {
  628. $path = $destination['path'];
  629. }
  630. $options['query'] = $destination['query'];
  631. $options['fragment'] = $destination['fragment'];
  632. }
  633. // In some cases modules call drupal_goto(current_path()). We need to ensure
  634. // that such a redirect is not to an external URL.
  635. if ($path === current_path() && empty($options['external']) && url_is_external($path)) {
  636. // Force url() to generate a non-external URL.
  637. $options['external'] = FALSE;
  638. }
  639. drupal_alter('drupal_goto', $path, $options, $http_response_code);
  640. // The 'Location' HTTP header must be absolute.
  641. $options['absolute'] = TRUE;
  642. $url = url($path, $options);
  643. header('Location: ' . $url, TRUE, $http_response_code);
  644. // The "Location" header sends a redirect status code to the HTTP daemon. In
  645. // some cases this can be wrong, so we make sure none of the code below the
  646. // drupal_goto() call gets executed upon redirection.
  647. drupal_exit($url);
  648. }
  649. /**
  650. * Delivers a "site is under maintenance" message to the browser.
  651. *
  652. * Page callback functions wanting to report a "site offline" message should
  653. * return MENU_SITE_OFFLINE instead of calling drupal_site_offline(). However,
  654. * functions that are invoked in contexts where that return value might not
  655. * bubble up to menu_execute_active_handler() should call drupal_site_offline().
  656. */
  657. function drupal_site_offline() {
  658. drupal_deliver_page(MENU_SITE_OFFLINE);
  659. }
  660. /**
  661. * Delivers a "page not found" error to the browser.
  662. *
  663. * Page callback functions wanting to report a "page not found" message should
  664. * return MENU_NOT_FOUND instead of calling drupal_not_found(). However,
  665. * functions that are invoked in contexts where that return value might not
  666. * bubble up to menu_execute_active_handler() should call drupal_not_found().
  667. */
  668. function drupal_not_found() {
  669. drupal_deliver_page(MENU_NOT_FOUND);
  670. }
  671. /**
  672. * Delivers an "access denied" error to the browser.
  673. *
  674. * Page callback functions wanting to report an "access denied" message should
  675. * return MENU_ACCESS_DENIED instead of calling drupal_access_denied(). However,
  676. * functions that are invoked in contexts where that return value might not
  677. * bubble up to menu_execute_active_handler() should call
  678. * drupal_access_denied().
  679. */
  680. function drupal_access_denied() {
  681. drupal_deliver_page(MENU_ACCESS_DENIED);
  682. }
  683. /**
  684. * Performs an HTTP request.
  685. *
  686. * This is a flexible and powerful HTTP client implementation. Correctly
  687. * handles GET, POST, PUT or any other HTTP requests. Handles redirects.
  688. *
  689. * @param $url
  690. * A string containing a fully qualified URI.
  691. * @param array $options
  692. * (optional) An array that can have one or more of the following elements:
  693. * - headers: An array containing request headers to send as name/value pairs.
  694. * - method: A string containing the request method. Defaults to 'GET'.
  695. * - data: An array containing the values for the request body or a string
  696. * containing the request body, formatted as
  697. * 'param=value&param=value&...'; to generate this, use
  698. * drupal_http_build_query(). Defaults to NULL.
  699. * - max_redirects: An integer representing how many times a redirect
  700. * may be followed. Defaults to 3.
  701. * - timeout: A float representing the maximum number of seconds the function
  702. * call may take. The default is 30 seconds. If a timeout occurs, the error
  703. * code is set to the HTTP_REQUEST_TIMEOUT constant.
  704. * - context: A context resource created with stream_context_create().
  705. *
  706. * @return object
  707. * An object that can have one or more of the following components:
  708. * - request: A string containing the request body that was sent.
  709. * - code: An integer containing the response status code, or the error code
  710. * if an error occurred.
  711. * - protocol: The response protocol (e.g. HTTP/1.1 or HTTP/1.0).
  712. * - status_message: The status message from the response, if a response was
  713. * received.
  714. * - redirect_code: If redirected, an integer containing the initial response
  715. * status code.
  716. * - redirect_url: If redirected, a string containing the URL of the redirect
  717. * target.
  718. * - error: If an error occurred, the error message. Otherwise not set.
  719. * - headers: An array containing the response headers as name/value pairs.
  720. * HTTP header names are case-insensitive (RFC 2616, section 4.2), so for
  721. * easy access the array keys are returned in lower case.
  722. * - data: A string containing the response body that was received.
  723. *
  724. * @see drupal_http_build_query()
  725. */
  726. function drupal_http_request($url, array $options = array()) {
  727. // Allow an alternate HTTP client library to replace Drupal's default
  728. // implementation.
  729. $override_function = variable_get('drupal_http_request_function', FALSE);
  730. if (!empty($override_function) && function_exists($override_function)) {
  731. return $override_function($url, $options);
  732. }
  733. $result = new stdClass();
  734. // Parse the URL and make sure we can handle the schema.
  735. $uri = @parse_url($url);
  736. if ($uri == FALSE) {
  737. $result->error = 'unable to parse URL';
  738. $result->code = -1001;
  739. return $result;
  740. }
  741. if (!isset($uri['scheme'])) {
  742. $result->error = 'missing schema';
  743. $result->code = -1002;
  744. return $result;
  745. }
  746. timer_start(__FUNCTION__);
  747. // Merge the default options.
  748. $options += array(
  749. 'headers' => array(),
  750. 'method' => 'GET',
  751. 'data' => NULL,
  752. 'max_redirects' => 3,
  753. 'timeout' => 30.0,
  754. 'context' => NULL,
  755. );
  756. // Merge the default headers.
  757. $options['headers'] += array(
  758. 'User-Agent' => 'Drupal (+http://drupal.org/)',
  759. );
  760. // stream_socket_client() requires timeout to be a float.
  761. $options['timeout'] = (float) $options['timeout'];
  762. // Use a proxy if one is defined and the host is not on the excluded list.
  763. $proxy_server = variable_get('proxy_server', '');
  764. if ($proxy_server && _drupal_http_use_proxy($uri['host'])) {
  765. // Set the scheme so we open a socket to the proxy server.
  766. $uri['scheme'] = 'proxy';
  767. // Set the path to be the full URL.
  768. $uri['path'] = $url;
  769. // Since the URL is passed as the path, we won't use the parsed query.
  770. unset($uri['query']);
  771. // Add in username and password to Proxy-Authorization header if needed.
  772. if ($proxy_username = variable_get('proxy_username', '')) {
  773. $proxy_password = variable_get('proxy_password', '');
  774. $options['headers']['Proxy-Authorization'] = 'Basic ' . base64_encode($proxy_username . (!empty($proxy_password) ? ":" . $proxy_password : ''));
  775. }
  776. // Some proxies reject requests with any User-Agent headers, while others
  777. // require a specific one.
  778. $proxy_user_agent = variable_get('proxy_user_agent', '');
  779. // The default value matches neither condition.
  780. if ($proxy_user_agent === NULL) {
  781. unset($options['headers']['User-Agent']);
  782. }
  783. elseif ($proxy_user_agent) {
  784. $options['headers']['User-Agent'] = $proxy_user_agent;
  785. }
  786. }
  787. switch ($uri['scheme']) {
  788. case 'proxy':
  789. // Make the socket connection to a proxy server.
  790. $socket = 'tcp://' . $proxy_server . ':' . variable_get('proxy_port', 8080);
  791. // The Host header still needs to match the real request.
  792. if (!isset($options['headers']['Host'])) {
  793. $options['headers']['Host'] = $uri['host'];
  794. $options['headers']['Host'] .= isset($uri['port']) && $uri['port'] != 80 ? ':' . $uri['port'] : '';
  795. }
  796. break;
  797. case 'http':
  798. case 'feed':
  799. $port = isset($uri['port']) ? $uri['port'] : 80;
  800. $socket = 'tcp://' . $uri['host'] . ':' . $port;
  801. // RFC 2616: "non-standard ports MUST, default ports MAY be included".
  802. // We don't add the standard port to prevent from breaking rewrite rules
  803. // checking the host that do not take into account the port number.
  804. if (!isset($options['headers']['Host'])) {
  805. $options['headers']['Host'] = $uri['host'] . ($port != 80 ? ':' . $port : '');
  806. }
  807. break;
  808. case 'https':
  809. // Note: Only works when PHP is compiled with OpenSSL support.
  810. $port = isset($uri['port']) ? $uri['port'] : 443;
  811. $socket = 'ssl://' . $uri['host'] . ':' . $port;
  812. if (!isset($options['headers']['Host'])) {
  813. $options['headers']['Host'] = $uri['host'] . ($port != 443 ? ':' . $port : '');
  814. }
  815. break;
  816. default:
  817. $result->error = 'invalid schema ' . $uri['scheme'];
  818. $result->code = -1003;
  819. return $result;
  820. }
  821. if (empty($options['context'])) {
  822. $fp = @stream_socket_client($socket, $errno, $errstr, $options['timeout']);
  823. }
  824. else {
  825. // Create a stream with context. Allows verification of a SSL certificate.
  826. $fp = @stream_socket_client($socket, $errno, $errstr, $options['timeout'], STREAM_CLIENT_CONNECT, $options['context']);
  827. }
  828. // Make sure the socket opened properly.
  829. if (!$fp) {
  830. // When a network error occurs, we use a negative number so it does not
  831. // clash with the HTTP status codes.
  832. $result->code = -$errno;
  833. $result->error = trim($errstr) ? trim($errstr) : t('Error opening socket @socket', array('@socket' => $socket));
  834. // Mark that this request failed. This will trigger a check of the web
  835. // server's ability to make outgoing HTTP requests the next time that
  836. // requirements checking is performed.
  837. // See system_requirements().
  838. variable_set('drupal_http_request_fails', TRUE);
  839. return $result;
  840. }
  841. // Construct the path to act on.
  842. $path = isset($uri['path']) ? $uri['path'] : '/';
  843. if (isset($uri['query'])) {
  844. $path .= '?' . $uri['query'];
  845. }
  846. // Convert array $options['data'] to query string.
  847. if (is_array($options['data'])) {
  848. $options['data'] = drupal_http_build_query($options['data']);
  849. }
  850. // Only add Content-Length if we actually have any content or if it is a POST
  851. // or PUT request. Some non-standard servers get confused by Content-Length in
  852. // at least HEAD/GET requests, and Squid always requires Content-Length in
  853. // POST/PUT requests.
  854. $content_length = strlen($options['data']);
  855. if ($content_length > 0 || $options['method'] == 'POST' || $options['method'] == 'PUT') {
  856. $options['headers']['Content-Length'] = $content_length;
  857. }
  858. // If the server URL has a user then attempt to use basic authentication.
  859. if (isset($uri['user'])) {
  860. $options['headers']['Authorization'] = 'Basic ' . base64_encode($uri['user'] . (isset($uri['pass']) ? ':' . $uri['pass'] : ':'));
  861. }
  862. // If the database prefix is being used by SimpleTest to run the tests in a copied
  863. // database then set the user-agent header to the database prefix so that any
  864. // calls to other Drupal pages will run the SimpleTest prefixed database. The
  865. // user-agent is used to ensure that multiple testing sessions running at the
  866. // same time won't interfere with each other as they would if the database
  867. // prefix were stored statically in a file or database variable.
  868. $test_info = &$GLOBALS['drupal_test_info'];
  869. if (!empty($test_info['test_run_id'])) {
  870. $options['headers']['User-Agent'] = drupal_generate_test_ua($test_info['test_run_id']);
  871. }
  872. $request = $options['method'] . ' ' . $path . " HTTP/1.0\r\n";
  873. foreach ($options['headers'] as $name => $value) {
  874. $request .= $name . ': ' . trim($value) . "\r\n";
  875. }
  876. $request .= "\r\n" . $options['data'];
  877. $result->request = $request;
  878. // Calculate how much time is left of the original timeout value.
  879. $timeout = $options['timeout'] - timer_read(__FUNCTION__) / 1000;
  880. if ($timeout > 0) {
  881. stream_set_timeout($fp, floor($timeout), floor(1000000 * fmod($timeout, 1)));
  882. fwrite($fp, $request);
  883. }
  884. // Fetch response. Due to PHP bugs like http://bugs.php.net/bug.php?id=43782
  885. // and http://bugs.php.net/bug.php?id=46049 we can't rely on feof(), but
  886. // instead must invoke stream_get_meta_data() each iteration.
  887. $info = stream_get_meta_data($fp);
  888. $alive = !$info['eof'] && !$info['timed_out'];
  889. $response = '';
  890. while ($alive) {
  891. // Calculate how much time is left of the original timeout value.
  892. $timeout = $options['timeout'] - timer_read(__FUNCTION__) / 1000;
  893. if ($timeout <= 0) {
  894. $info['timed_out'] = TRUE;
  895. break;
  896. }
  897. stream_set_timeout($fp, floor($timeout), floor(1000000 * fmod($timeout, 1)));
  898. $chunk = fread($fp, 1024);
  899. $response .= $chunk;
  900. $info = stream_get_meta_data($fp);
  901. $alive = !$info['eof'] && !$info['timed_out'] && $chunk;
  902. }
  903. fclose($fp);
  904. if ($info['timed_out']) {
  905. $result->code = HTTP_REQUEST_TIMEOUT;
  906. $result->error = 'request timed out';
  907. return $result;
  908. }
  909. // Parse response headers from the response body.
  910. // Be tolerant of malformed HTTP responses that separate header and body with
  911. // \n\n or \r\r instead of \r\n\r\n.
  912. list($response, $result->data) = preg_split("/\r\n\r\n|\n\n|\r\r/", $response, 2);
  913. $response = preg_split("/\r\n|\n|\r/", $response);
  914. // Parse the response status line.
  915. $response_status_array = _drupal_parse_response_status(trim(array_shift($response)));
  916. $result->protocol = $response_status_array['http_version'];
  917. $result->status_message = $response_status_array['reason_phrase'];
  918. $code = $response_status_array['response_code'];
  919. $result->headers = array();
  920. // Parse the response headers.
  921. while ($line = trim(array_shift($response))) {
  922. list($name, $value) = explode(':', $line, 2);
  923. $name = strtolower($name);
  924. if (isset($result->headers[$name]) && $name == 'set-cookie') {
  925. // RFC 2109: the Set-Cookie response header comprises the token Set-
  926. // Cookie:, followed by a comma-separated list of one or more cookies.
  927. $result->headers[$name] .= ',' . trim($value);
  928. }
  929. else {
  930. $result->headers[$name] = trim($value);
  931. }
  932. }
  933. $responses = array(
  934. 100 => 'Continue',
  935. 101 => 'Switching Protocols',
  936. 200 => 'OK',
  937. 201 => 'Created',
  938. 202 => 'Accepted',
  939. 203 => 'Non-Authoritative Information',
  940. 204 => 'No Content',
  941. 205 => 'Reset Content',
  942. 206 => 'Partial Content',
  943. 300 => 'Multiple Choices',
  944. 301 => 'Moved Permanently',
  945. 302 => 'Found',
  946. 303 => 'See Other',
  947. 304 => 'Not Modified',
  948. 305 => 'Use Proxy',
  949. 307 => 'Temporary Redirect',
  950. 400 => 'Bad Request',
  951. 401 => 'Unauthorized',
  952. 402 => 'Payment Required',
  953. 403 => 'Forbidden',
  954. 404 => 'Not Found',
  955. 405 => 'Method Not Allowed',
  956. 406 => 'Not Acceptable',
  957. 407 => 'Proxy Authentication Required',
  958. 408 => 'Request Time-out',
  959. 409 => 'Conflict',
  960. 410 => 'Gone',
  961. 411 => 'Length Required',
  962. 412 => 'Precondition Failed',
  963. 413 => 'Request Entity Too Large',
  964. 414 => 'Request-URI Too Large',
  965. 415 => 'Unsupported Media Type',
  966. 416 => 'Requested range not satisfiable',
  967. 417 => 'Expectation Failed',
  968. 500 => 'Internal Server Error',
  969. 501 => 'Not Implemented',
  970. 502 => 'Bad Gateway',
  971. 503 => 'Service Unavailable',
  972. 504 => 'Gateway Time-out',
  973. 505 => 'HTTP Version not supported',
  974. );
  975. // RFC 2616 states that all unknown HTTP codes must be treated the same as the
  976. // base code in their class.
  977. if (!isset($responses[$code])) {
  978. $code = floor($code / 100) * 100;
  979. }
  980. $result->code = $code;
  981. switch ($code) {
  982. case 200: // OK
  983. case 201: // Created
  984. case 202: // Accepted
  985. case 203: // Non-Authoritative Information
  986. case 204: // No Content
  987. case 205: // Reset Content
  988. case 206: // Partial Content
  989. case 304: // Not modified
  990. break;
  991. case 301: // Moved permanently
  992. case 302: // Moved temporarily
  993. case 307: // Moved temporarily
  994. $location = $result->headers['location'];
  995. $options['timeout'] -= timer_read(__FUNCTION__) / 1000;
  996. if ($options['timeout'] <= 0) {
  997. $result->code = HTTP_REQUEST_TIMEOUT;
  998. $result->error = 'request timed out';
  999. }
  1000. elseif ($options['max_redirects']) {
  1001. // Redirect to the new location.
  1002. $options['max_redirects']--;
  1003. // We need to unset the 'Host' header
  1004. // as we are redirecting to a new location.
  1005. unset($options['headers']['Host']);
  1006. $result = drupal_http_request($location, $options);
  1007. $result->redirect_code = $code;
  1008. }
  1009. if (!isset($result->redirect_url)) {
  1010. $result->redirect_url = $location;
  1011. }
  1012. break;
  1013. default:
  1014. $result->error = $result->status_message;
  1015. }
  1016. return $result;
  1017. }
  1018. /**
  1019. * Splits an HTTP response status line into components.
  1020. *
  1021. * See the @link http://www.w3.org/Protocols/rfc2616/rfc2616-sec6.html status line definition @endlink
  1022. * in RFC 2616.
  1023. *
  1024. * @param string $respone
  1025. * The response status line, for example 'HTTP/1.1 500 Internal Server Error'.
  1026. *
  1027. * @return array
  1028. * Keyed array containing the component parts. If the response is malformed,
  1029. * all possible parts will be extracted. 'reason_phrase' could be empty.
  1030. * Possible keys:
  1031. * - 'http_version'
  1032. * - 'response_code'
  1033. * - 'reason_phrase'
  1034. */
  1035. function _drupal_parse_response_status($response) {
  1036. $response_array = explode(' ', trim($response), 3);
  1037. // Set up empty values.
  1038. $result = array(
  1039. 'reason_phrase' => '',
  1040. );
  1041. $result['http_version'] = $response_array[0];
  1042. $result['response_code'] = $response_array[1];
  1043. if (isset($response_array[2])) {
  1044. $result['reason_phrase'] = $response_array[2];
  1045. }
  1046. return $result;
  1047. }
  1048. /**
  1049. * Helper function for determining hosts excluded from needing a proxy.
  1050. *
  1051. * @return
  1052. * TRUE if a proxy should be used for this host.
  1053. */
  1054. function _drupal_http_use_proxy($host) {
  1055. $proxy_exceptions = variable_get('proxy_exceptions', array('localhost', '127.0.0.1'));
  1056. return !in_array(strtolower($host), $proxy_exceptions, TRUE);
  1057. }
  1058. /**
  1059. * @} End of "HTTP handling".
  1060. */
  1061. /**
  1062. * Strips slashes from a string or array of strings.
  1063. *
  1064. * Callback for array_walk() within fix_gpx_magic().
  1065. *
  1066. * @param $item
  1067. * An individual string or array of strings from superglobals.
  1068. */
  1069. function _fix_gpc_magic(&$item) {
  1070. if (is_array($item)) {
  1071. array_walk($item, '_fix_gpc_magic');
  1072. }
  1073. else {
  1074. $item = stripslashes($item);
  1075. }
  1076. }
  1077. /**
  1078. * Strips slashes from $_FILES items.
  1079. *
  1080. * Callback for array_walk() within fix_gpc_magic().
  1081. *
  1082. * The tmp_name key is skipped keys since PHP generates single backslashes for
  1083. * file paths on Windows systems.
  1084. *
  1085. * @param $item
  1086. * An item from $_FILES.
  1087. * @param $key
  1088. * The key for the item within $_FILES.
  1089. *
  1090. * @see http://php.net/manual/features.file-upload.php#42280
  1091. */
  1092. function _fix_gpc_magic_files(&$item, $key) {
  1093. if ($key != 'tmp_name') {
  1094. if (is_array($item)) {
  1095. array_walk($item, '_fix_gpc_magic_files');
  1096. }
  1097. else {
  1098. $item = stripslashes($item);
  1099. }
  1100. }
  1101. }
  1102. /**
  1103. * Fixes double-escaping caused by "magic quotes" in some PHP installations.
  1104. *
  1105. * @see _fix_gpc_magic()
  1106. * @see _fix_gpc_magic_files()
  1107. */
  1108. function fix_gpc_magic() {
  1109. static $fixed = FALSE;
  1110. if (!$fixed && ini_get('magic_quotes_gpc')) {
  1111. array_walk($_GET, '_fix_gpc_magic');
  1112. array_walk($_POST, '_fix_gpc_magic');
  1113. array_walk($_COOKIE, '_fix_gpc_magic');
  1114. array_walk($_REQUEST, '_fix_gpc_magic');
  1115. array_walk($_FILES, '_fix_gpc_magic_files');
  1116. }
  1117. $fixed = TRUE;
  1118. }
  1119. /**
  1120. * @defgroup validation Input validation
  1121. * @{
  1122. * Functions to validate user input.
  1123. */
  1124. /**
  1125. * Verifies the syntax of the given e-mail address.
  1126. *
  1127. * This uses the
  1128. * @link http://php.net/manual/filter.filters.validate.php PHP e-mail validation filter. @endlink
  1129. *
  1130. * @param $mail
  1131. * A string containing an e-mail address.
  1132. *
  1133. * @return
  1134. * TRUE if the address is in a valid format.
  1135. */
  1136. function valid_email_address($mail) {
  1137. return (bool)filter_var($mail, FILTER_VALIDATE_EMAIL);
  1138. }
  1139. /**
  1140. * Verifies the syntax of the given URL.
  1141. *
  1142. * This function should only be used on actual URLs. It should not be used for
  1143. * Drupal menu paths, which can contain arbitrary characters.
  1144. * Valid values per RFC 3986.
  1145. * @param $url
  1146. * The URL to verify.
  1147. * @param $absolute
  1148. * Whether the URL is absolute (beginning with a scheme such as "http:").
  1149. *
  1150. * @return
  1151. * TRUE if the URL is in a valid format.
  1152. */
  1153. function valid_url($url, $absolute = FALSE) {
  1154. if ($absolute) {
  1155. return (bool)preg_match("
  1156. /^ # Start at the beginning of the text
  1157. (?:ftp|https?|feed):\/\/ # Look for ftp, http, https or feed schemes
  1158. (?: # Userinfo (optional) which is typically
  1159. (?:(?:[\w\.\-\+!$&'\(\)*\+,;=]|%[0-9a-f]{2})+:)* # a username or a username and password
  1160. (?:[\w\.\-\+%!$&'\(\)*\+,;=]|%[0-9a-f]{2})+@ # combination
  1161. )?
  1162. (?:
  1163. (?:[a-z0-9\-\.]|%[0-9a-f]{2})+ # A domain name or a IPv4 address
  1164. |(?:\[(?:[0-9a-f]{0,4}:)*(?:[0-9a-f]{0,4})\]) # or a well formed IPv6 address
  1165. )
  1166. (?::[0-9]+)? # Server port number (optional)
  1167. (?:[\/|\?]
  1168. (?:[\w#!:\.\?\+=&@$'~*,;\/\(\)\[\]\-]|%[0-9a-f]{2}) # The path and query (optional)
  1169. *)?
  1170. $/xi", $url);
  1171. }
  1172. else {
  1173. return (bool)preg_match("/^(?:[\w#!:\.\?\+=&@$'~*,;\/\(\)\[\]\-]|%[0-9a-f]{2})+$/i", $url);
  1174. }
  1175. }
  1176. /**
  1177. * @} End of "defgroup validation".
  1178. */
  1179. /**
  1180. * Registers an event for the current visitor to the flood control mechanism.
  1181. *
  1182. * @param $name
  1183. * The name of an event.
  1184. * @param $window
  1185. * Optional number of seconds before this event expires. Defaults to 3600 (1
  1186. * hour). Typically uses the same value as the flood_is_allowed() $window
  1187. * parameter. Expired events are purged on cron run to prevent the flood table
  1188. * from growing indefinitely.
  1189. * @param $identifier
  1190. * Optional identifier (defaults to the current user's IP address).
  1191. */
  1192. function flood_register_event($name, $window = 3600, $identifier = NULL) {
  1193. if (!isset($identifier)) {
  1194. $identifier = ip_address();
  1195. }
  1196. db_insert('flood')
  1197. ->fields(array(
  1198. 'event' => $name,
  1199. 'identifier' => $identifier,
  1200. 'timestamp' => REQUEST_TIME,
  1201. 'expiration' => REQUEST_TIME + $window,
  1202. ))
  1203. ->execute();
  1204. }
  1205. /**
  1206. * Makes the flood control mechanism forget an event for the current visitor.
  1207. *
  1208. * @param $name
  1209. * The name of an event.
  1210. * @param $identifier
  1211. * Optional identifier (defaults to the current user's IP address).
  1212. */
  1213. function flood_clear_event($name, $identifier = NULL) {
  1214. if (!isset($identifier)) {
  1215. $identifier = ip_address();
  1216. }
  1217. db_delete('flood')
  1218. ->condition('event', $name)
  1219. ->condition('identifier', $identifier)
  1220. ->execute();
  1221. }
  1222. /**
  1223. * Checks whether a user is allowed to proceed with the specified event.
  1224. *
  1225. * Events can have thresholds saying that each user can only do that event
  1226. * a certain number of times in a time window. This function verifies that the
  1227. * current user has not exceeded this threshold.
  1228. *
  1229. * @param $name
  1230. * The unique name of the event.
  1231. * @param $threshold
  1232. * The maximum number of times each user can do this event per time window.
  1233. * @param $window
  1234. * Number of seconds in the time window for this event (default is 3600
  1235. * seconds, or 1 hour).
  1236. * @param $identifier
  1237. * Unique identifier of the current user. Defaults to their IP address.
  1238. *
  1239. * @return
  1240. * TRUE if the user is allowed to proceed. FALSE if they have exceeded the
  1241. * threshold and should not be allowed to proceed.
  1242. */
  1243. function flood_is_allowed($name, $threshold, $window = 3600, $identifier = NULL) {
  1244. if (!isset($identifier)) {
  1245. $identifier = ip_address();
  1246. }
  1247. $number = db_query("SELECT COUNT(*) FROM {flood} WHERE event = :event AND identifier = :identifier AND timestamp > :timestamp", array(
  1248. ':event' => $name,
  1249. ':identifier' => $identifier,
  1250. ':timestamp' => REQUEST_TIME - $window))
  1251. ->fetchField();
  1252. return ($number < $threshold);
  1253. }
  1254. /**
  1255. * @defgroup sanitization Sanitization functions
  1256. * @{
  1257. * Functions to sanitize values.
  1258. *
  1259. * See http://drupal.org/writing-secure-code for information
  1260. * on writing secure code.
  1261. */
  1262. /**
  1263. * Strips dangerous protocols (e.g. 'javascript:') from a URI.
  1264. *
  1265. * This function must be called for all URIs within user-entered input prior
  1266. * to being output to an HTML attribute value. It is often called as part of
  1267. * check_url() or filter_xss(), but those functions return an HTML-encoded
  1268. * string, so this function can be called independently when the output needs to
  1269. * be a plain-text string for passing to t(), l(), drupal_attributes(), or
  1270. * another function that will call check_plain() separately.
  1271. *
  1272. * @param $uri
  1273. * A plain-text URI that might contain dangerous protocols.
  1274. *
  1275. * @return
  1276. * A plain-text URI stripped of dangerous protocols. As with all plain-text
  1277. * strings, this return value must not be output to an HTML page without
  1278. * check_plain() being called on it. However, it can be passed to functions
  1279. * expecting plain-text strings.
  1280. *
  1281. * @see check_url()
  1282. */
  1283. function drupal_strip_dangerous_protocols($uri) {
  1284. static $allowed_protocols;
  1285. if (!isset($allowed_protocols)) {
  1286. $allowed_protocols = array_flip(variable_get('filter_allowed_protocols', array('ftp', 'http', 'https', 'irc', 'mailto', 'news', 'nntp', 'rtsp', 'sftp', 'ssh', 'tel', 'telnet', 'webcal')));
  1287. }
  1288. // Iteratively remove any invalid protocol found.
  1289. do {
  1290. $before = $uri;
  1291. $colonpos = strpos($uri, ':');
  1292. if ($colonpos > 0) {
  1293. // We found a colon, possibly a protocol. Verify.
  1294. $protocol = substr($uri, 0, $colonpos);
  1295. // If a colon is preceded by a slash, question mark or hash, it cannot
  1296. // possibly be part of the URL scheme. This must be a relative URL, which
  1297. // inherits the (safe) protocol of the base document.
  1298. if (preg_match('![/?#]!', $protocol)) {
  1299. break;
  1300. }
  1301. // Check if this is a disallowed protocol. Per RFC2616, section 3.2.3
  1302. // (URI Comparison) scheme comparison must be case-insensitive.
  1303. if (!isset($allowed_protocols[strtolower($protocol)])) {
  1304. $uri = substr($uri, $colonpos + 1);
  1305. }
  1306. }
  1307. } while ($before != $uri);
  1308. return $uri;
  1309. }
  1310. /**
  1311. * Strips dangerous protocols from a URI and encodes it for output to HTML.
  1312. *
  1313. * @param $uri
  1314. * A plain-text URI that might contain dangerous protocols.
  1315. *
  1316. * @return
  1317. * A URI stripped of dangerous protocols and encoded for output to an HTML
  1318. * attribute value. Because it is already encoded, it should not be set as a
  1319. * value within a $attributes array passed to drupal_attributes(), because
  1320. * drupal_attributes() expects those values to be plain-text strings. To pass
  1321. * a filtered URI to drupal_attributes(), call
  1322. * drupal_strip_dangerous_protocols() instead.
  1323. *
  1324. * @see drupal_strip_dangerous_protocols()
  1325. */
  1326. function check_url($uri) {
  1327. return check_plain(drupal_strip_dangerous_protocols($uri));
  1328. }
  1329. /**
  1330. * Applies a very permissive XSS/HTML filter for admin-only use.
  1331. *
  1332. * Use only for fields where it is impractical to use the
  1333. * whole filter system, but where some (mainly inline) mark-up
  1334. * is desired (so check_plain() is not acceptable).
  1335. *
  1336. * Allows all tags that can be used inside an HTML body, save
  1337. * for scripts and styles.
  1338. */
  1339. function filter_xss_admin($string) {
  1340. return filter_xss($string, array('a', 'abbr', 'acronym', 'address', 'article', 'aside', 'b', 'bdi', 'bdo', 'big', 'blockquote', 'br', 'caption', 'cite', 'code', 'col', 'colgroup', 'command', 'dd', 'del', 'details', 'dfn', 'div', 'dl', 'dt', 'em', 'figcaption', 'figure', 'footer', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'header', 'hgroup', 'hr', 'i', 'img', 'ins', 'kbd', 'li', 'mark', 'menu', 'meter', 'nav', 'ol', 'output', 'p', 'pre', 'progress', 'q', 'rp', 'rt', 'ruby', 's', 'samp', 'section', 'small', 'span', 'strong', 'sub', 'summary', 'sup', 'table', 'tbody', 'td', 'tfoot', 'th', 'thead', 'time', 'tr', 'tt', 'u', 'ul', 'var', 'wbr'));
  1341. }
  1342. /**
  1343. * Filters HTML to prevent cross-site-scripting (XSS) vulnerabilities.
  1344. *
  1345. * Based on kses by Ulf Harnhammar, see http://sourceforge.net/projects/kses.
  1346. * For examples of various XSS attacks, see: http://ha.ckers.org/xss.html.
  1347. *
  1348. * This code does four things:
  1349. * - Removes characters and constructs that can trick browsers.
  1350. * - Makes sure all HTML entities are well-formed.
  1351. * - Makes sure all HTML tags and attributes are well-formed.
  1352. * - Makes sure no HTML tags contain URLs with a disallowed protocol (e.g.
  1353. * javascript:).
  1354. *
  1355. * @param $string
  1356. * The string with raw HTML in it. It will be stripped of everything that can
  1357. * cause an XSS attack.
  1358. * @param $allowed_tags
  1359. * An array of allowed tags.
  1360. *
  1361. * @return
  1362. * An XSS safe version of $string, or an empty string if $string is not
  1363. * valid UTF-8.
  1364. *
  1365. * @see drupal_validate_utf8()
  1366. */
  1367. function filter_xss($string, $allowed_tags = array('a', 'em', 'strong', 'cite', 'blockquote', 'code', 'ul', 'ol', 'li', 'dl', 'dt', 'dd')) {
  1368. // Only operate on valid UTF-8 strings. This is necessary to prevent cross
  1369. // site scripting issues on Internet Explorer 6.
  1370. if (!drupal_validate_utf8($string)) {
  1371. return '';
  1372. }
  1373. // Store the text format.
  1374. _filter_xss_split($allowed_tags, TRUE);
  1375. // Remove NULL characters (ignored by some browsers).
  1376. $string = str_replace(chr(0), '', $string);
  1377. // Remove Netscape 4 JS entities.
  1378. $string = preg_replace('%&\s*\{[^}]*(\}\s*;?|$)%', '', $string);
  1379. // Defuse all HTML entities.
  1380. $string = str_replace('&', '&amp;', $string);
  1381. // Change back only well-formed entities in our whitelist:
  1382. // Decimal numeric entities.
  1383. $string = preg_replace('/&amp;#([0-9]+;)/', '&#\1', $string);
  1384. // Hexadecimal numeric entities.
  1385. $string = preg_replace('/&amp;#[Xx]0*((?:[0-9A-Fa-f]{2})+;)/', '&#x\1', $string);
  1386. // Named entities.
  1387. $string = preg_replace('/&amp;([A-Za-z][A-Za-z0-9]*;)/', '&\1', $string);
  1388. return preg_replace_callback('%
  1389. (
  1390. <(?=[^a-zA-Z!/]) # a lone <
  1391. | # or
  1392. <!--.*?--> # a comment
  1393. | # or
  1394. <[^>]*(>|$) # a string that starts with a <, up until the > or the end of the string
  1395. | # or
  1396. > # just a >
  1397. )%x', '_filter_xss_split', $string);
  1398. }
  1399. /**
  1400. * Processes an HTML tag.
  1401. *
  1402. * @param $m
  1403. * An array with various meaning depending on the value of $store.
  1404. * If $store is TRUE then the array contains the allowed tags.
  1405. * If $store is FALSE then the array has one element, the HTML tag to process.
  1406. * @param $store
  1407. * Whether to store $m.
  1408. *
  1409. * @return
  1410. * If the element isn't allowed, an empty string. Otherwise, the cleaned up
  1411. * version of the HTML element.
  1412. */
  1413. function _filter_xss_split($m, $store = FALSE) {
  1414. static $allowed_html;
  1415. if ($store) {
  1416. $allowed_html = array_flip($m);
  1417. return;
  1418. }
  1419. $string = $m[1];
  1420. if (substr($string, 0, 1) != '<') {
  1421. // We matched a lone ">" character.
  1422. return '&gt;';
  1423. }
  1424. elseif (strlen($string) == 1) {
  1425. // We matched a lone "<" character.
  1426. return '&lt;';
  1427. }
  1428. if (!preg_match('%^<\s*(/\s*)?([a-zA-Z0-9\-]+)\s*([^>]*)>?|(<!--.*?-->)$%', $string, $matches)) {
  1429. // Seriously malformed.
  1430. return '';
  1431. }
  1432. $slash = trim($matches[1]);
  1433. $elem = &$matches[2];
  1434. $attrlist = &$matches[3];
  1435. $comment = &$matches[4];
  1436. if ($comment) {
  1437. $elem = '!--';
  1438. }
  1439. if (!isset($allowed_html[strtolower($elem)])) {
  1440. // Disallowed HTML element.
  1441. return '';
  1442. }
  1443. if ($comment) {
  1444. return $comment;
  1445. }
  1446. if ($slash != '') {
  1447. return "</$elem>";
  1448. }
  1449. // Is there a closing XHTML slash at the end of the attributes?
  1450. $attrlist = preg_replace('%(\s?)/\s*$%', '\1', $attrlist, -1, $count);
  1451. $xhtml_slash = $count ? ' /' : '';
  1452. // Clean up attributes.
  1453. $attr2 = implode(' ', _filter_xss_attributes($attrlist));
  1454. $attr2 = preg_replace('/[<>]/', '', $attr2);
  1455. $attr2 = strlen($attr2) ? ' ' . $attr2 : '';
  1456. return "<$elem$attr2$xhtml_slash>";
  1457. }
  1458. /**
  1459. * Processes a string of HTML attributes.
  1460. *
  1461. * @return
  1462. * Cleaned up version of the HTML attributes.
  1463. */
  1464. function _filter_xss_attributes($attr) {
  1465. $attrarr = array();
  1466. $mode = 0;
  1467. $attrname = '';
  1468. while (strlen($attr) != 0) {
  1469. // Was the last operation successful?
  1470. $working = 0;
  1471. switch ($mode) {
  1472. case 0:
  1473. // Attribute name, href for instance.
  1474. if (preg_match('/^([-a-zA-Z]+)/', $attr, $match)) {
  1475. $attrname = strtolower($match[1]);
  1476. $skip = (
  1477. $attrname == 'style' ||
  1478. substr($attrname, 0, 2) == 'on' ||
  1479. substr($attrname, 0, 1) == '-' ||
  1480. // Ignore long attributes to avoid unnecessary processing overhead.
  1481. strlen($attrname) > 96
  1482. );
  1483. $working = $mode = 1;
  1484. $attr = preg_replace('/^[-a-zA-Z]+/', '', $attr);
  1485. }
  1486. break;
  1487. case 1:
  1488. // Equals sign or valueless ("selected").
  1489. if (preg_match('/^\s*=\s*/', $attr)) {
  1490. $working = 1; $mode = 2;
  1491. $attr = preg_replace('/^\s*=\s*/', '', $attr);
  1492. break;
  1493. }
  1494. if (preg_match('/^\s+/', $attr)) {
  1495. $working = 1; $mode = 0;
  1496. if (!$skip) {
  1497. $attrarr[] = $attrname;
  1498. }
  1499. $attr = preg_replace('/^\s+/', '', $attr);
  1500. }
  1501. break;
  1502. case 2:
  1503. // Attribute value, a URL after href= for instance.
  1504. if (preg_match('/^"([^"]*)"(\s+|$)/', $attr, $match)) {
  1505. $thisval = filter_xss_bad_protocol($match[1]);
  1506. if (!$skip) {
  1507. $attrarr[] = "$attrname=\"$thisval\"";
  1508. }
  1509. $working = 1;
  1510. $mode = 0;
  1511. $attr = preg_replace('/^"[^"]*"(\s+|$)/', '', $attr);
  1512. break;
  1513. }
  1514. if (preg_match("/^'([^']*)'(\s+|$)/", $attr, $match)) {
  1515. $thisval = filter_xss_bad_protocol($match[1]);
  1516. if (!$skip) {
  1517. $attrarr[] = "$attrname='$thisval'";
  1518. }
  1519. $working = 1; $mode = 0;
  1520. $attr = preg_replace("/^'[^']*'(\s+|$)/", '', $attr);
  1521. break;
  1522. }
  1523. if (preg_match("%^([^\s\"']+)(\s+|$)%", $attr, $match)) {
  1524. $thisval = filter_xss_bad_protocol($match[1]);
  1525. if (!$skip) {
  1526. $attrarr[] = "$attrname=\"$thisval\"";
  1527. }
  1528. $working = 1; $mode = 0;
  1529. $attr = preg_replace("%^[^\s\"']+(\s+|$)%", '', $attr);
  1530. }
  1531. break;
  1532. }
  1533. if ($working == 0) {
  1534. // Not well formed; remove and try again.
  1535. $attr = preg_replace('/
  1536. ^
  1537. (
  1538. "[^"]*("|$) # - a string that starts with a double quote, up until the next double quote or the end of the string
  1539. | # or
  1540. \'[^\']*(\'|$)| # - a string that starts with a quote, up until the next quote or the end of the string
  1541. | # or
  1542. \S # - a non-whitespace character
  1543. )* # any number of the above three
  1544. \s* # any number of whitespaces
  1545. /x', '', $attr);
  1546. $mode = 0;
  1547. }
  1548. }
  1549. // The attribute list ends with a valueless attribute like "selected".
  1550. if ($mode == 1 && !$skip) {
  1551. $attrarr[] = $attrname;
  1552. }
  1553. return $attrarr;
  1554. }
  1555. /**
  1556. * Processes an HTML attribute value and strips dangerous protocols from URLs.
  1557. *
  1558. * @param $string
  1559. * The string with the attribute value.
  1560. * @param $decode
  1561. * (deprecated) Whether to decode entities in the $string. Set to FALSE if the
  1562. * $string is in plain text, TRUE otherwise. Defaults to TRUE. This parameter
  1563. * is deprecated and will be removed in Drupal 8. To process a plain-text URI,
  1564. * call drupal_strip_dangerous_protocols() or check_url() instead.
  1565. *
  1566. * @return
  1567. * Cleaned up and HTML-escaped version of $string.
  1568. */
  1569. function filter_xss_bad_protocol($string, $decode = TRUE) {
  1570. // Get the plain text representation of the attribute value (i.e. its meaning).
  1571. // @todo Remove the $decode parameter in Drupal 8, and always assume an HTML
  1572. // string that needs decoding.
  1573. if ($decode) {
  1574. if (!function_exists('decode_entities')) {
  1575. require_once DRUPAL_ROOT . '/includes/unicode.inc';
  1576. }
  1577. $string = decode_entities($string);
  1578. }
  1579. return check_plain(drupal_strip_dangerous_protocols($string));
  1580. }
  1581. /**
  1582. * @} End of "defgroup sanitization".
  1583. */
  1584. /**
  1585. * @defgroup format Formatting
  1586. * @{
  1587. * Functions to format numbers, strings, dates, etc.
  1588. */
  1589. /**
  1590. * Formats an RSS channel.
  1591. *
  1592. * Arbitrary elements may be added using the $args associative array.
  1593. */
  1594. function format_rss_channel($title, $link, $description, $items, $langcode = NULL, $args = array()) {
  1595. global $language_content;
  1596. $langcode = $langcode ? $langcode : $language_content->language;
  1597. $output = "<channel>\n";
  1598. $output .= ' <title>' . check_plain($title) . "</title>\n";
  1599. $output .= ' <link>' . check_url($link) . "</link>\n";
  1600. // The RSS 2.0 "spec" doesn't indicate HTML can be used in the description.
  1601. // We strip all HTML tags, but need to prevent double encoding from properly
  1602. // escaped source data (such as &amp becoming &amp;amp;).
  1603. $output .= ' <description>' . check_plain(decode_entities(strip_tags($description))) . "</description>\n";
  1604. $output .= ' <language>' . check_plain($langcode) . "</language>\n";
  1605. $output .= format_xml_elements($args);
  1606. $output .= $items;
  1607. $output .= "</channel>\n";
  1608. return $output;
  1609. }
  1610. /**
  1611. * Formats a single RSS item.
  1612. *
  1613. * Arbitrary elements may be added using the $args associative array.
  1614. */
  1615. function format_rss_item($title, $link, $description, $args = array()) {
  1616. $output = "<item>\n";
  1617. $output .= ' <title>' . check_plain($title) . "</title>\n";
  1618. $output .= ' <link>' . check_url($link) . "</link>\n";
  1619. $output .= ' <description>' . check_plain($description) . "</description>\n";
  1620. $output .= format_xml_elements($args);
  1621. $output .= "</item>\n";
  1622. return $output;
  1623. }
  1624. /**
  1625. * Formats XML elements.
  1626. *
  1627. * @param $array
  1628. * An array where each item represents an element and is either a:
  1629. * - (key => value) pair (<key>value</key>)
  1630. * - Associative array with fields:
  1631. * - 'key': element name
  1632. * - 'value': element contents
  1633. * - 'attributes': associative array of element attributes
  1634. * - 'encoded': TRUE if 'value' is already encoded
  1635. *
  1636. * In both cases, 'value' can be a simple string, or it can be another array
  1637. * with the same format as $array itself for nesting.
  1638. *
  1639. * If 'encoded' is TRUE it is up to the caller to ensure that 'value' is either
  1640. * entity-encoded or CDATA-escaped. Using this option is not recommended when
  1641. * working with untrusted user input, since failing to escape the data
  1642. * correctly has security implications.
  1643. */
  1644. function format_xml_elements($array) {
  1645. $output = '';
  1646. foreach ($array as $key => $value) {
  1647. if (is_numeric($key)) {
  1648. if ($value['key']) {
  1649. $output .= ' <' . $value['key'];
  1650. if (isset($value['attributes']) && is_array($value['attributes'])) {
  1651. $output .= drupal_attributes($value['attributes']);
  1652. }
  1653. if (isset($value['value']) && $value['value'] != '') {
  1654. $output .= '>' . (is_array($value['value']) ? format_xml_elements($value['value']) : (!empty($value['encoded']) ? $value['value'] : check_plain($value['value']))) . '</' . $value['key'] . ">\n";
  1655. }
  1656. else {
  1657. $output .= " />\n";
  1658. }
  1659. }
  1660. }
  1661. else {
  1662. $output .= ' <' . $key . '>' . (is_array($value) ? format_xml_elements($value) : check_plain($value)) . "</$key>\n";
  1663. }
  1664. }
  1665. return $output;
  1666. }
  1667. /**
  1668. * Formats a string containing a count of items.
  1669. *
  1670. * This function ensures that the string is pluralized correctly. Since t() is
  1671. * called by this function, make sure not to pass already-localized strings to
  1672. * it.
  1673. *
  1674. * For example:
  1675. * @code
  1676. * $output = format_plural($node->comment_count, '1 comment', '@count comments');
  1677. * @endcode
  1678. *
  1679. * Example with additional replacements:
  1680. * @code
  1681. * $output = format_plural($update_count,
  1682. * 'Changed the content type of 1 post from %old-type to %new-type.',
  1683. * 'Changed the content type of @count posts from %old-type to %new-type.',
  1684. * array('%old-type' => $info->old_type, '%new-type' => $info->new_type));
  1685. * @endcode
  1686. *
  1687. * @param $count
  1688. * The item count to display.
  1689. * @param $singular
  1690. * The string for the singular case. Make sure it is clear this is singular,
  1691. * to ease translation (e.g. use "1 new comment" instead of "1 new"). Do not
  1692. * use @count in the singular string.
  1693. * @param $plural
  1694. * The string for the plural case. Make sure it is clear this is plural, to
  1695. * ease translation. Use @count in place of the item count, as in
  1696. * "@count new comments".
  1697. * @param $args
  1698. * An associative array of replacements to make after translation. Instances
  1699. * of any key in this array are replaced with the corresponding value.
  1700. * Based on the first character of the key, the value is escaped and/or
  1701. * themed. See format_string(). Note that you do not need to include @count
  1702. * in this array; this replacement is done automatically for the plural case.
  1703. * @param $options
  1704. * An associative array of additional options. See t() for allowed keys.
  1705. *
  1706. * @return
  1707. * A translated string.
  1708. *
  1709. * @see t()
  1710. * @see format_string()
  1711. */
  1712. function format_plural($count, $singular, $plural, array $args = array(), array $options = array()) {
  1713. $args['@count'] = $count;
  1714. if ($count == 1) {
  1715. return t($singular, $args, $options);
  1716. }
  1717. // Get the plural index through the gettext formula.
  1718. $index = (function_exists('locale_get_plural')) ? locale_get_plural($count, isset($options['langcode']) ? $options['langcode'] : NULL) : -1;
  1719. // If the index cannot be computed, use the plural as a fallback (which
  1720. // allows for most flexiblity with the replaceable @count value).
  1721. if ($index < 0) {
  1722. return t($plural, $args, $options);
  1723. }
  1724. else {
  1725. switch ($index) {
  1726. case "0":
  1727. return t($singular, $args, $options);
  1728. case "1":
  1729. return t($plural, $args, $options);
  1730. default:
  1731. unset($args['@count']);
  1732. $args['@count[' . $index . ']'] = $count;
  1733. return t(strtr($plural, array('@count' => '@count[' . $index . ']')), $args, $options);
  1734. }
  1735. }
  1736. }
  1737. /**
  1738. * Parses a given byte count.
  1739. *
  1740. * @param $size
  1741. * A size expressed as a number of bytes with optional SI or IEC binary unit
  1742. * prefix (e.g. 2, 3K, 5MB, 10G, 6GiB, 8 bytes, 9mbytes).
  1743. *
  1744. * @return
  1745. * An integer representation of the size in bytes.
  1746. */
  1747. function parse_size($size) {
  1748. $unit = preg_replace('/[^bkmgtpezy]/i', '', $size); // Remove the non-unit characters from the size.
  1749. $size = preg_replace('/[^0-9\.]/', '', $size); // Remove the non-numeric characters from the size.
  1750. if ($unit) {
  1751. // Find the position of the unit in the ordered string which is the power of magnitude to multiply a kilobyte by.
  1752. return round($size * pow(DRUPAL_KILOBYTE, stripos('bkmgtpezy', $unit[0])));
  1753. }
  1754. else {
  1755. return round($size);
  1756. }
  1757. }
  1758. /**
  1759. * Generates a string representation for the given byte count.
  1760. *
  1761. * @param $size
  1762. * A size in bytes.
  1763. * @param $langcode
  1764. * Optional language code to translate to a language other than what is used
  1765. * to display the page.
  1766. *
  1767. * @return
  1768. * A translated string representation of the size.
  1769. */
  1770. function format_size($size, $langcode = NULL) {
  1771. if ($size < DRUPAL_KILOBYTE) {
  1772. return format_plural($size, '1 byte', '@count bytes', array(), array('langcode' => $langcode));
  1773. }
  1774. else {
  1775. $size = $size / DRUPAL_KILOBYTE; // Convert bytes to kilobytes.
  1776. $units = array(
  1777. t('@size KB', array(), array('langcode' => $langcode)),
  1778. t('@size MB', array(), array('langcode' => $langcode)),
  1779. t('@size GB', array(), array('langcode' => $langcode)),
  1780. t('@size TB', array(), array('langcode' => $langcode)),
  1781. t('@size PB', array(), array('langcode' => $langcode)),
  1782. t('@size EB', array(), array('langcode' => $langcode)),
  1783. t('@size ZB', array(), array('langcode' => $langcode)),
  1784. t('@size YB', array(), array('langcode' => $langcode)),
  1785. );
  1786. foreach ($units as $unit) {
  1787. if (round($size, 2) >= DRUPAL_KILOBYTE) {
  1788. $size = $size / DRUPAL_KILOBYTE;
  1789. }
  1790. else {
  1791. break;
  1792. }
  1793. }
  1794. return str_replace('@size', round($size, 2), $unit);
  1795. }
  1796. }
  1797. /**
  1798. * Formats a time interval with the requested granularity.
  1799. *
  1800. * @param $interval
  1801. * The length of the interval in seconds.
  1802. * @param $granularity
  1803. * How many different units to display in the string.
  1804. * @param $langcode
  1805. * Optional language code to translate to a language other than
  1806. * what is used to display the page.
  1807. *
  1808. * @return
  1809. * A translated string representation of the interval.
  1810. */
  1811. function format_interval($interval, $granularity = 2, $langcode = NULL) {
  1812. $units = array(
  1813. '1 year|@count years' => 31536000,
  1814. '1 month|@count months' => 2592000,
  1815. '1 week|@count weeks' => 604800,
  1816. '1 day|@count days' => 86400,
  1817. '1 hour|@count hours' => 3600,
  1818. '1 min|@count min' => 60,
  1819. '1 sec|@count sec' => 1
  1820. );
  1821. $output = '';
  1822. foreach ($units as $key => $value) {
  1823. $key = explode('|', $key);
  1824. if ($interval >= $value) {
  1825. $output .= ($output ? ' ' : '') . format_plural(floor($interval / $value), $key[0], $key[1], array(), array('langcode' => $langcode));
  1826. $interval %= $value;
  1827. $granularity--;
  1828. }
  1829. if ($granularity == 0) {
  1830. break;
  1831. }
  1832. }
  1833. return $output ? $output : t('0 sec', array(), array('langcode' => $langcode));
  1834. }
  1835. /**
  1836. * Formats a date, using a date type or a custom date format string.
  1837. *
  1838. * @param $timestamp
  1839. * A UNIX timestamp to format.
  1840. * @param $type
  1841. * (optional) The format to use, one of:
  1842. * - 'short', 'medium', or 'long' (the corresponding built-in date formats).
  1843. * - The name of a date type defined by a module in hook_date_format_types(),
  1844. * if it's been assigned a format.
  1845. * - The machine name of an administrator-defined date format.
  1846. * - 'custom', to use $format.
  1847. * Defaults to 'medium'.
  1848. * @param $format
  1849. * (optional) If $type is 'custom', a PHP date format string suitable for
  1850. * input to date(). Use a backslash to escape ordinary text, so it does not
  1851. * get interpreted as date format characters.
  1852. * @param $timezone
  1853. * (optional) Time zone identifier, as described at
  1854. * http://php.net/manual/timezones.php Defaults to the time zone used to
  1855. * display the page.
  1856. * @param $langcode
  1857. * (optional) Language code to translate to. Defaults to the language used to
  1858. * display the page.
  1859. *
  1860. * @return
  1861. * A translated date string in the requested format.
  1862. */
  1863. function format_date($timestamp, $type = 'medium', $format = '', $timezone = NULL, $langcode = NULL) {
  1864. // Use the advanced drupal_static() pattern, since this is called very often.
  1865. static $drupal_static_fast;
  1866. if (!isset($drupal_static_fast)) {
  1867. $drupal_static_fast['timezones'] = &drupal_static(__FUNCTION__);
  1868. }
  1869. $timezones = &$drupal_static_fast['timezones'];
  1870. if (!isset($timezone)) {
  1871. $timezone = date_default_timezone_get();
  1872. }
  1873. // Store DateTimeZone objects in an array rather than repeatedly
  1874. // constructing identical objects over the life of a request.
  1875. if (!isset($timezones[$timezone])) {
  1876. $timezones[$timezone] = timezone_open($timezone);
  1877. }
  1878. // Use the default langcode if none is set.
  1879. global $language;
  1880. if (empty($langcode)) {
  1881. $langcode = isset($language->language) ? $language->language : 'en';
  1882. }
  1883. switch ($type) {
  1884. case 'short':
  1885. $format = variable_get('date_format_short', 'm/d/Y - H:i');
  1886. break;
  1887. case 'long':
  1888. $format = variable_get('date_format_long', 'l, F j, Y - H:i');
  1889. break;
  1890. case 'custom':
  1891. // No change to format.
  1892. break;
  1893. case 'medium':
  1894. default:
  1895. // Retrieve the format of the custom $type passed.
  1896. if ($type != 'medium') {
  1897. $format = variable_get('date_format_' . $type, '');
  1898. }
  1899. // Fall back to 'medium'.
  1900. if ($format === '') {
  1901. $format = variable_get('date_format_medium', 'D, m/d/Y - H:i');
  1902. }
  1903. break;
  1904. }
  1905. // Create a DateTime object from the timestamp.
  1906. $date_time = date_create('@' . $timestamp);
  1907. // Set the time zone for the DateTime object.
  1908. date_timezone_set($date_time, $timezones[$timezone]);
  1909. // Encode markers that should be translated. 'A' becomes '\xEF\AA\xFF'.
  1910. // xEF and xFF are invalid UTF-8 sequences, and we assume they are not in the
  1911. // input string.
  1912. // Paired backslashes are isolated to prevent errors in read-ahead evaluation.
  1913. // The read-ahead expression ensures that A matches, but not \A.
  1914. $format = preg_replace(array('/\\\\\\\\/', '/(?<!\\\\)([AaeDlMTF])/'), array("\xEF\\\\\\\\\xFF", "\xEF\\\\\$1\$1\xFF"), $format);
  1915. // Call date_format().
  1916. $format = date_format($date_time, $format);
  1917. // Pass the langcode to _format_date_callback().
  1918. _format_date_callback(NULL, $langcode);
  1919. // Translate the marked sequences.
  1920. return preg_replace_callback('/\xEF([AaeDlMTF]?)(.*?)\xFF/', '_format_date_callback', $format);
  1921. }
  1922. /**
  1923. * Returns an ISO8601 formatted date based on the given date.
  1924. *
  1925. * Callback for use within hook_rdf_mapping() implementations.
  1926. *
  1927. * @param $date
  1928. * A UNIX timestamp.
  1929. *
  1930. * @return string
  1931. * An ISO8601 formatted date.
  1932. */
  1933. function date_iso8601($date) {
  1934. // The DATE_ISO8601 constant cannot be used here because it does not match
  1935. // date('c') and produces invalid RDF markup.
  1936. return date('c', $date);
  1937. }
  1938. /**
  1939. * Translates a formatted date string.
  1940. *
  1941. * Callback for preg_replace_callback() within format_date().
  1942. */
  1943. function _format_date_callback(array $matches = NULL, $new_langcode = NULL) {
  1944. // We cache translations to avoid redundant and rather costly calls to t().
  1945. static $cache, $langcode;
  1946. if (!isset($matches)) {
  1947. $langcode = $new_langcode;
  1948. return;
  1949. }
  1950. $code = $matches[1];
  1951. $string = $matches[2];
  1952. if (!isset($cache[$langcode][$code][$string])) {
  1953. $options = array(
  1954. 'langcode' => $langcode,
  1955. );
  1956. if ($code == 'F') {
  1957. $options['context'] = 'Long month name';
  1958. }
  1959. if ($code == '') {
  1960. $cache[$langcode][$code][$string] = $string;
  1961. }
  1962. else {
  1963. $cache[$langcode][$code][$string] = t($string, array(), $options);
  1964. }
  1965. }
  1966. return $cache[$langcode][$code][$string];
  1967. }
  1968. /**
  1969. * Format a username.
  1970. *
  1971. * This is also the label callback implementation of
  1972. * callback_entity_info_label() for user_entity_info().
  1973. *
  1974. * By default, the passed-in object's 'name' property is used if it exists, or
  1975. * else, the site-defined value for the 'anonymous' variable. However, a module
  1976. * may override this by implementing hook_username_alter(&$name, $account).
  1977. *
  1978. * @see hook_username_alter()
  1979. *
  1980. * @param $account
  1981. * The account object for the user whose name is to be formatted.
  1982. *
  1983. * @return
  1984. * An unsanitized string with the username to display. The code receiving
  1985. * this result must ensure that check_plain() is called on it before it is
  1986. * printed to the page.
  1987. */
  1988. function format_username($account) {
  1989. $name = !empty($account->name) ? $account->name : variable_get('anonymous', t('Anonymous'));
  1990. drupal_alter('username', $name, $account);
  1991. return $name;
  1992. }
  1993. /**
  1994. * @} End of "defgroup format".
  1995. */
  1996. /**
  1997. * Generates an internal or external URL.
  1998. *
  1999. * When creating links in modules, consider whether l() could be a better
  2000. * alternative than url().
  2001. *
  2002. * @param $path
  2003. * (optional) The internal path or external URL being linked to, such as
  2004. * "node/34" or "http://example.com/foo". The default value is equivalent to
  2005. * passing in '<front>'. A few notes:
  2006. * - If you provide a full URL, it will be considered an external URL.
  2007. * - If you provide only the path (e.g. "node/34"), it will be
  2008. * considered an internal link. In this case, it should be a system URL,
  2009. * and it will be replaced with the alias, if one exists. Additional query
  2010. * arguments for internal paths must be supplied in $options['query'], not
  2011. * included in $path.
  2012. * - If you provide an internal path and $options['alias'] is set to TRUE, the
  2013. * path is assumed already to be the correct path alias, and the alias is
  2014. * not looked up.
  2015. * - The special string '<front>' generates a link to the site's base URL.
  2016. * - If your external URL contains a query (e.g. http://example.com/foo?a=b),
  2017. * then you can either URL encode the query keys and values yourself and
  2018. * include them in $path, or use $options['query'] to let this function
  2019. * URL encode them.
  2020. * @param $options
  2021. * (optional) An associative array of additional options, with the following
  2022. * elements:
  2023. * - 'query': An array of query key/value-pairs (without any URL-encoding) to
  2024. * append to the URL.
  2025. * - 'fragment': A fragment identifier (named anchor) to append to the URL.
  2026. * Do not include the leading '#' character.
  2027. * - 'absolute': Defaults to FALSE. Whether to force the output to be an
  2028. * absolute link (beginning with http:). Useful for links that will be
  2029. * displayed outside the site, such as in an RSS feed.
  2030. * - 'alias': Defaults to FALSE. Whether the given path is a URL alias
  2031. * already.
  2032. * - 'external': Whether the given path is an external URL.
  2033. * - 'language': An optional language object. If the path being linked to is
  2034. * internal to the site, $options['language'] is used to look up the alias
  2035. * for the URL. If $options['language'] is omitted, the global $language_url
  2036. * will be used.
  2037. * - 'https': Whether this URL should point to a secure location. If not
  2038. * defined, the current scheme is used, so the user stays on HTTP or HTTPS
  2039. * respectively. TRUE enforces HTTPS and FALSE enforces HTTP, but HTTPS can
  2040. * only be enforced when the variable 'https' is set to TRUE.
  2041. * - 'base_url': Only used internally, to modify the base URL when a language
  2042. * dependent URL requires so.
  2043. * - 'prefix': Only used internally, to modify the path when a language
  2044. * dependent URL requires so.
  2045. * - 'script': The script filename in Drupal's root directory to use when
  2046. * clean URLs are disabled, such as 'index.php'. Defaults to an empty
  2047. * string, as most modern web servers automatically find 'index.php'. If
  2048. * clean URLs are disabled, the value of $path is appended as query
  2049. * parameter 'q' to $options['script'] in the returned URL. When deploying
  2050. * Drupal on a web server that cannot be configured to automatically find
  2051. * index.php, then hook_url_outbound_alter() can be implemented to force
  2052. * this value to 'index.php'.
  2053. * - 'entity_type': The entity type of the object that called url(). Only
  2054. * set if url() is invoked by entity_uri().
  2055. * - 'entity': The entity object (such as a node) for which the URL is being
  2056. * generated. Only set if url() is invoked by entity_uri().
  2057. *
  2058. * @return
  2059. * A string containing a URL to the given path.
  2060. */
  2061. function url($path = NULL, array $options = array()) {
  2062. // Merge in defaults.
  2063. $options += array(
  2064. 'fragment' => '',
  2065. 'query' => array(),
  2066. 'absolute' => FALSE,
  2067. 'alias' => FALSE,
  2068. 'prefix' => ''
  2069. );
  2070. // Determine whether this is an external link, but ensure that the current
  2071. // path is always treated as internal by default (to prevent external link
  2072. // injection vulnerabilities).
  2073. if (!isset($options['external'])) {
  2074. $options['external'] = $path === $_GET['q'] ? FALSE : url_is_external($path);
  2075. }
  2076. // Preserve the original path before altering or aliasing.
  2077. $original_path = $path;
  2078. // Allow other modules to alter the outbound URL and options.
  2079. drupal_alter('url_outbound', $path, $options, $original_path);
  2080. if (isset($options['fragment']) && $options['fragment'] !== '') {
  2081. $options['fragment'] = '#' . $options['fragment'];
  2082. }
  2083. if ($options['external']) {
  2084. // Split off the fragment.
  2085. if (strpos($path, '#') !== FALSE) {
  2086. list($path, $old_fragment) = explode('#', $path, 2);
  2087. // If $options contains no fragment, take it over from the path.
  2088. if (isset($old_fragment) && !$options['fragment']) {
  2089. $options['fragment'] = '#' . $old_fragment;
  2090. }
  2091. }
  2092. // Append the query.
  2093. if ($options['query']) {
  2094. $path .= (strpos($path, '?') !== FALSE ? '&' : '?') . drupal_http_build_query($options['query']);
  2095. }
  2096. if (isset($options['https']) && variable_get('https', FALSE)) {
  2097. if ($options['https'] === TRUE) {
  2098. $path = str_replace('http://', 'https://', $path);
  2099. }
  2100. elseif ($options['https'] === FALSE) {
  2101. $path = str_replace('https://', 'http://', $path);
  2102. }
  2103. }
  2104. // Reassemble.
  2105. return $path . $options['fragment'];
  2106. }
  2107. // Strip leading slashes from internal paths to prevent them becoming external
  2108. // URLs without protocol. /example.com should not be turned into
  2109. // //example.com.
  2110. $path = ltrim($path, '/');
  2111. global $base_url, $base_secure_url, $base_insecure_url;
  2112. // The base_url might be rewritten from the language rewrite in domain mode.
  2113. if (!isset($options['base_url'])) {
  2114. if (isset($options['https']) && variable_get('https', FALSE)) {
  2115. if ($options['https'] === TRUE) {
  2116. $options['base_url'] = $base_secure_url;
  2117. $options['absolute'] = TRUE;
  2118. }
  2119. elseif ($options['https'] === FALSE) {
  2120. $options['base_url'] = $base_insecure_url;
  2121. $options['absolute'] = TRUE;
  2122. }
  2123. }
  2124. else {
  2125. $options['base_url'] = $base_url;
  2126. }
  2127. }
  2128. // The special path '<front>' links to the default front page.
  2129. if ($path == '<front>') {
  2130. $path = '';
  2131. }
  2132. elseif (!empty($path) && !$options['alias']) {
  2133. $language = isset($options['language']) && isset($options['language']->language) ? $options['language']->language : '';
  2134. require_once DRUPAL_ROOT . '/' . variable_get('path_inc', 'includes/path.inc');
  2135. $alias = drupal_get_path_alias($original_path, $language);
  2136. if ($alias != $original_path) {
  2137. // Strip leading slashes from internal path aliases to prevent them
  2138. // becoming external URLs without protocol. /example.com should not be
  2139. // turned into //example.com.
  2140. $path = ltrim($alias, '/');
  2141. }
  2142. }
  2143. $base = $options['absolute'] ? $options['base_url'] . '/' : base_path();
  2144. $prefix = empty($path) ? rtrim($options['prefix'], '/') : $options['prefix'];
  2145. // With Clean URLs.
  2146. if (!empty($GLOBALS['conf']['clean_url'])) {
  2147. $path = drupal_encode_path($prefix . $path);
  2148. if ($options['query']) {
  2149. return $base . $path . '?' . drupal_http_build_query($options['query']) . $options['fragment'];
  2150. }
  2151. else {
  2152. return $base . $path . $options['fragment'];
  2153. }
  2154. }
  2155. // Without Clean URLs.
  2156. else {
  2157. $path = $prefix . $path;
  2158. $query = array();
  2159. if (!empty($path)) {
  2160. $query['q'] = $path;
  2161. }
  2162. if ($options['query']) {
  2163. // We do not use array_merge() here to prevent overriding $path via query
  2164. // parameters.
  2165. $query += $options['query'];
  2166. }
  2167. $query = $query ? ('?' . drupal_http_build_query($query)) : '';
  2168. $script = isset($options['script']) ? $options['script'] : '';
  2169. return $base . $script . $query . $options['fragment'];
  2170. }
  2171. }
  2172. /**
  2173. * Returns TRUE if a path is external to Drupal (e.g. http://example.com).
  2174. *
  2175. * If a path cannot be assessed by Drupal's menu handler, then we must
  2176. * treat it as potentially insecure.
  2177. *
  2178. * @param $path
  2179. * The internal path or external URL being linked to, such as "node/34" or
  2180. * "http://example.com/foo".
  2181. *
  2182. * @return
  2183. * Boolean TRUE or FALSE, where TRUE indicates an external path.
  2184. */
  2185. function url_is_external($path) {
  2186. $colonpos = strpos($path, ':');
  2187. // Some browsers treat \ as / so normalize to forward slashes.
  2188. $path = str_replace('\\', '/', $path);
  2189. // If the path starts with 2 slashes then it is always considered an external
  2190. // URL without an explicit protocol part.
  2191. return (strpos($path, '//') === 0)
  2192. // Leading control characters may be ignored or mishandled by browsers, so
  2193. // assume such a path may lead to an external location. The \p{C} character
  2194. // class matches all UTF-8 control, unassigned, and private characters.
  2195. || (preg_match('/^\p{C}/u', $path) !== 0)
  2196. // Avoid calling drupal_strip_dangerous_protocols() if there is any slash
  2197. // (/), hash (#) or question_mark (?) before the colon (:) occurrence - if
  2198. // any - as this would clearly mean it is not a URL.
  2199. || ($colonpos !== FALSE
  2200. && !preg_match('![/?#]!', substr($path, 0, $colonpos))
  2201. && drupal_strip_dangerous_protocols($path) == $path);
  2202. }
  2203. /**
  2204. * Formats an attribute string for an HTTP header.
  2205. *
  2206. * @param $attributes
  2207. * An associative array of attributes such as 'rel'.
  2208. *
  2209. * @return
  2210. * A ; separated string ready for insertion in a HTTP header. No escaping is
  2211. * performed for HTML entities, so this string is not safe to be printed.
  2212. *
  2213. * @see drupal_add_http_header()
  2214. */
  2215. function drupal_http_header_attributes(array $attributes = array()) {
  2216. foreach ($attributes as $attribute => &$data) {
  2217. if (is_array($data)) {
  2218. $data = implode(' ', $data);
  2219. }
  2220. $data = $attribute . '="' . $data . '"';
  2221. }
  2222. return $attributes ? ' ' . implode('; ', $attributes) : '';
  2223. }
  2224. /**
  2225. * Converts an associative array to an XML/HTML tag attribute string.
  2226. *
  2227. * Each array key and its value will be formatted into an attribute string.
  2228. * If a value is itself an array, then its elements are concatenated to a single
  2229. * space-delimited string (for example, a class attribute with multiple values).
  2230. *
  2231. * Attribute values are sanitized by running them through check_plain().
  2232. * Attribute names are not automatically sanitized. When using user-supplied
  2233. * attribute names, it is strongly recommended to allow only white-listed names,
  2234. * since certain attributes carry security risks and can be abused.
  2235. *
  2236. * Examples of security aspects when using drupal_attributes:
  2237. * @code
  2238. * // By running the value in the following statement through check_plain,
  2239. * // the malicious script is neutralized.
  2240. * drupal_attributes(array('title' => t('<script>steal_cookie();</script>')));
  2241. *
  2242. * // The statement below demonstrates dangerous use of drupal_attributes, and
  2243. * // will return an onmouseout attribute with JavaScript code that, when used
  2244. * // as attribute in a tag, will cause users to be redirected to another site.
  2245. * //
  2246. * // In this case, the 'onmouseout' attribute should not be whitelisted --
  2247. * // you don't want users to have the ability to add this attribute or others
  2248. * // that take JavaScript commands.
  2249. * drupal_attributes(array('onmouseout' => 'window.location="http://malicious.com/";')));
  2250. * @endcode
  2251. *
  2252. * @param $attributes
  2253. * An associative array of key-value pairs to be converted to attributes.
  2254. *
  2255. * @return
  2256. * A string ready for insertion in a tag (starts with a space).
  2257. *
  2258. * @ingroup sanitization
  2259. */
  2260. function drupal_attributes(array $attributes = array()) {
  2261. foreach ($attributes as $attribute => &$data) {
  2262. $data = implode(' ', (array) $data);
  2263. $data = $attribute . '="' . check_plain($data) . '"';
  2264. }
  2265. return $attributes ? ' ' . implode(' ', $attributes) : '';
  2266. }
  2267. /**
  2268. * Formats an internal or external URL link as an HTML anchor tag.
  2269. *
  2270. * This function correctly handles aliased paths and adds an 'active' class
  2271. * attribute to links that point to the current page (for theming), so all
  2272. * internal links output by modules should be generated by this function if
  2273. * possible.
  2274. *
  2275. * However, for links enclosed in translatable text you should use t() and
  2276. * embed the HTML anchor tag directly in the translated string. For example:
  2277. * @code
  2278. * t('Visit the <a href="@url">settings</a> page', array('@url' => url('admin')));
  2279. * @endcode
  2280. * This keeps the context of the link title ('settings' in the example) for
  2281. * translators.
  2282. *
  2283. * @param string $text
  2284. * The translated link text for the anchor tag.
  2285. * @param string $path
  2286. * The internal path or external URL being linked to, such as "node/34" or
  2287. * "http://example.com/foo". After the url() function is called to construct
  2288. * the URL from $path and $options, the resulting URL is passed through
  2289. * check_plain() before it is inserted into the HTML anchor tag, to ensure
  2290. * well-formed HTML. See url() for more information and notes.
  2291. * @param array $options
  2292. * An associative array of additional options. Defaults to an empty array. It
  2293. * may contain the following elements.
  2294. * - 'attributes': An associative array of HTML attributes to apply to the
  2295. * anchor tag. If element 'class' is included, it must be an array; 'title'
  2296. * must be a string; other elements are more flexible, as they just need
  2297. * to work in a call to drupal_attributes($options['attributes']).
  2298. * - 'html' (default FALSE): Whether $text is HTML or just plain-text. For
  2299. * example, to make an image tag into a link, this must be set to TRUE, or
  2300. * you will see the escaped HTML image tag. $text is not sanitized if
  2301. * 'html' is TRUE. The calling function must ensure that $text is already
  2302. * safe.
  2303. * - 'language': An optional language object. If the path being linked to is
  2304. * internal to the site, $options['language'] is used to determine whether
  2305. * the link is "active", or pointing to the current page (the language as
  2306. * well as the path must match). This element is also used by url().
  2307. * - Additional $options elements used by the url() function.
  2308. *
  2309. * @return string
  2310. * An HTML string containing a link to the given path.
  2311. *
  2312. * @see url()
  2313. */
  2314. function l($text, $path, array $options = array()) {
  2315. global $language_url;
  2316. static $use_theme = NULL;
  2317. // Merge in defaults.
  2318. $options += array(
  2319. 'attributes' => array(),
  2320. 'html' => FALSE,
  2321. );
  2322. // Append active class.
  2323. if (($path == $_GET['q'] || ($path == '<front>' && drupal_is_front_page())) &&
  2324. (empty($options['language']) || $options['language']->language == $language_url->language)) {
  2325. $options['attributes']['class'][] = 'active';
  2326. }
  2327. // Remove all HTML and PHP tags from a tooltip. For best performance, we act only
  2328. // if a quick strpos() pre-check gave a suspicion (because strip_tags() is expensive).
  2329. if (isset($options['attributes']['title']) && strpos($options['attributes']['title'], '<') !== FALSE) {
  2330. $options['attributes']['title'] = strip_tags($options['attributes']['title']);
  2331. }
  2332. // Determine if rendering of the link is to be done with a theme function
  2333. // or the inline default. Inline is faster, but if the theme system has been
  2334. // loaded and a module or theme implements a preprocess or process function
  2335. // or overrides the theme_link() function, then invoke theme(). Preliminary
  2336. // benchmarks indicate that invoking theme() can slow down the l() function
  2337. // by 20% or more, and that some of the link-heavy Drupal pages spend more
  2338. // than 10% of the total page request time in the l() function.
  2339. if (!isset($use_theme) && function_exists('theme')) {
  2340. // Allow edge cases to prevent theme initialization and force inline link
  2341. // rendering.
  2342. if (variable_get('theme_link', TRUE)) {
  2343. drupal_theme_initialize();
  2344. $registry = theme_get_registry(FALSE);
  2345. // We don't want to duplicate functionality that's in theme(), so any
  2346. // hint of a module or theme doing anything at all special with the 'link'
  2347. // theme hook should simply result in theme() being called. This includes
  2348. // the overriding of theme_link() with an alternate function or template,
  2349. // the presence of preprocess or process functions, or the presence of
  2350. // include files.
  2351. $use_theme = !isset($registry['link']['function']) || ($registry['link']['function'] != 'theme_link');
  2352. $use_theme = $use_theme || !empty($registry['link']['preprocess functions']) || !empty($registry['link']['process functions']) || !empty($registry['link']['includes']);
  2353. }
  2354. else {
  2355. $use_theme = FALSE;
  2356. }
  2357. }
  2358. if ($use_theme) {
  2359. return theme('link', array('text' => $text, 'path' => $path, 'options' => $options));
  2360. }
  2361. // The result of url() is a plain-text URL. Because we are using it here
  2362. // in an HTML argument context, we need to encode it properly.
  2363. return '<a href="' . check_plain(url($path, $options)) . '"' . drupal_attributes($options['attributes']) . '>' . ($options['html'] ? $text : check_plain($text)) . '</a>';
  2364. }
  2365. /**
  2366. * Delivers a page callback result to the browser in the appropriate format.
  2367. *
  2368. * This function is most commonly called by menu_execute_active_handler(), but
  2369. * can also be called by error conditions such as drupal_not_found(),
  2370. * drupal_access_denied(), and drupal_site_offline().
  2371. *
  2372. * When a user requests a page, index.php calls menu_execute_active_handler(),
  2373. * which calls the 'page callback' function registered in hook_menu(). The page
  2374. * callback function can return one of:
  2375. * - NULL: to indicate no content.
  2376. * - An integer menu status constant: to indicate an error condition.
  2377. * - A string of HTML content.
  2378. * - A renderable array of content.
  2379. * Returning a renderable array rather than a string of HTML is preferred,
  2380. * because that provides modules with more flexibility in customizing the final
  2381. * result.
  2382. *
  2383. * When the page callback returns its constructed content to
  2384. * menu_execute_active_handler(), this function gets called. The purpose of
  2385. * this function is to determine the most appropriate 'delivery callback'
  2386. * function to route the content to. The delivery callback function then
  2387. * sends the content to the browser in the needed format. The default delivery
  2388. * callback is drupal_deliver_html_page(), which delivers the content as an HTML
  2389. * page, complete with blocks in addition to the content. This default can be
  2390. * overridden on a per menu router item basis by setting 'delivery callback' in
  2391. * hook_menu() or hook_menu_alter(), and can also be overridden on a per request
  2392. * basis in hook_page_delivery_callback_alter().
  2393. *
  2394. * For example, the same page callback function can be used for an HTML
  2395. * version of the page and an Ajax version of the page. The page callback
  2396. * function just needs to decide what content is to be returned and the
  2397. * delivery callback function will send it as an HTML page or an Ajax
  2398. * response, as appropriate.
  2399. *
  2400. * In order for page callbacks to be reusable in different delivery formats,
  2401. * they should not issue any "print" or "echo" statements, but instead just
  2402. * return content.
  2403. *
  2404. * Also note that this function does not perform access checks. The delivery
  2405. * callback function specified in hook_menu(), hook_menu_alter(), or
  2406. * hook_page_delivery_callback_alter() will be called even if the router item
  2407. * access checks fail. This is intentional (it is needed for JSON and other
  2408. * purposes), but it has security implications. Do not call this function
  2409. * directly unless you understand the security implications, and be careful in
  2410. * writing delivery callbacks, so that they do not violate security. See
  2411. * drupal_deliver_html_page() for an example of a delivery callback that
  2412. * respects security.
  2413. *
  2414. * @param $page_callback_result
  2415. * The result of a page callback. Can be one of:
  2416. * - NULL: to indicate no content.
  2417. * - An integer menu status constant: to indicate an error condition.
  2418. * - A string of HTML content.
  2419. * - A renderable array of content.
  2420. * @param $default_delivery_callback
  2421. * (Optional) If given, it is the name of a delivery function most likely
  2422. * to be appropriate for the page request as determined by the calling
  2423. * function (e.g., menu_execute_active_handler()). If not given, it is
  2424. * determined from the menu router information of the current page.
  2425. *
  2426. * @see menu_execute_active_handler()
  2427. * @see hook_menu()
  2428. * @see hook_menu_alter()
  2429. * @see hook_page_delivery_callback_alter()
  2430. */
  2431. function drupal_deliver_page($page_callback_result, $default_delivery_callback = NULL) {
  2432. if (!isset($default_delivery_callback) && ($router_item = menu_get_item())) {
  2433. $default_delivery_callback = $router_item['delivery_callback'];
  2434. }
  2435. $delivery_callback = !empty($default_delivery_callback) ? $default_delivery_callback : 'drupal_deliver_html_page';
  2436. // Give modules a chance to alter the delivery callback used, based on
  2437. // request-time context (e.g., HTTP request headers).
  2438. drupal_alter('page_delivery_callback', $delivery_callback);
  2439. if (function_exists($delivery_callback)) {
  2440. $delivery_callback($page_callback_result);
  2441. }
  2442. else {
  2443. // If a delivery callback is specified, but doesn't exist as a function,
  2444. // something is wrong, but don't print anything, since it's not known
  2445. // what format the response needs to be in.
  2446. watchdog('delivery callback not found', 'callback %callback not found: %q.', array('%callback' => $delivery_callback, '%q' => $_GET['q']), WATCHDOG_ERROR);
  2447. }
  2448. }
  2449. /**
  2450. * Packages and sends the result of a page callback to the browser as HTML.
  2451. *
  2452. * @param $page_callback_result
  2453. * The result of a page callback. Can be one of:
  2454. * - NULL: to indicate no content.
  2455. * - An integer menu status constant: to indicate an error condition.
  2456. * - A string of HTML content.
  2457. * - A renderable array of content.
  2458. *
  2459. * @see drupal_deliver_page()
  2460. */
  2461. function drupal_deliver_html_page($page_callback_result) {
  2462. // Emit the correct charset HTTP header, but not if the page callback
  2463. // result is NULL, since that likely indicates that it printed something
  2464. // in which case, no further headers may be sent, and not if code running
  2465. // for this page request has already set the content type header.
  2466. if (isset($page_callback_result) && is_null(drupal_get_http_header('Content-Type'))) {
  2467. drupal_add_http_header('Content-Type', 'text/html; charset=utf-8');
  2468. }
  2469. // Send appropriate HTTP-Header for browsers and search engines.
  2470. global $language;
  2471. drupal_add_http_header('Content-Language', $language->language);
  2472. // By default, do not allow the site to be rendered in an iframe on another
  2473. // domain, but provide a variable to override this. If the code running for
  2474. // this page request already set the X-Frame-Options header earlier, don't
  2475. // overwrite it here.
  2476. $frame_options = variable_get('x_frame_options', 'SAMEORIGIN');
  2477. if ($frame_options && is_null(drupal_get_http_header('X-Frame-Options'))) {
  2478. drupal_add_http_header('X-Frame-Options', $frame_options);
  2479. }
  2480. // Menu status constants are integers; page content is a string or array.
  2481. if (is_int($page_callback_result)) {
  2482. // @todo: Break these up into separate functions?
  2483. switch ($page_callback_result) {
  2484. case MENU_NOT_FOUND:
  2485. // Print a 404 page.
  2486. drupal_add_http_header('Status', '404 Not Found');
  2487. watchdog('page not found', check_plain($_GET['q']), NULL, WATCHDOG_WARNING);
  2488. // Check for and return a fast 404 page if configured.
  2489. drupal_fast_404();
  2490. // Keep old path for reference, and to allow forms to redirect to it.
  2491. if (!isset($_GET['destination'])) {
  2492. // Make sure that the current path is not interpreted as external URL.
  2493. if (!url_is_external($_GET['q'])) {
  2494. $_GET['destination'] = $_GET['q'];
  2495. }
  2496. }
  2497. $path = drupal_get_normal_path(variable_get('site_404', ''));
  2498. if ($path && $path != $_GET['q']) {
  2499. // Custom 404 handler. Set the active item in case there are tabs to
  2500. // display, or other dependencies on the path.
  2501. menu_set_active_item($path);
  2502. $return = menu_execute_active_handler($path, FALSE);
  2503. }
  2504. if (empty($return) || $return == MENU_NOT_FOUND || $return == MENU_ACCESS_DENIED) {
  2505. // Standard 404 handler.
  2506. drupal_set_title(t('Page not found'));
  2507. $return = t('The requested page "@path" could not be found.', array('@path' => request_uri()));
  2508. }
  2509. drupal_set_page_content($return);
  2510. $page = element_info('page');
  2511. print drupal_render_page($page);
  2512. break;
  2513. case MENU_ACCESS_DENIED:
  2514. // Print a 403 page.
  2515. drupal_add_http_header('Status', '403 Forbidden');
  2516. watchdog('access denied', check_plain($_GET['q']), NULL, WATCHDOG_WARNING);
  2517. // Keep old path for reference, and to allow forms to redirect to it.
  2518. if (!isset($_GET['destination'])) {
  2519. // Make sure that the current path is not interpreted as external URL.
  2520. if (!url_is_external($_GET['q'])) {
  2521. $_GET['destination'] = $_GET['q'];
  2522. }
  2523. }
  2524. $path = drupal_get_normal_path(variable_get('site_403', ''));
  2525. if ($path && $path != $_GET['q']) {
  2526. // Custom 403 handler. Set the active item in case there are tabs to
  2527. // display or other dependencies on the path.
  2528. menu_set_active_item($path);
  2529. $return = menu_execute_active_handler($path, FALSE);
  2530. }
  2531. if (empty($return) || $return == MENU_NOT_FOUND || $return == MENU_ACCESS_DENIED) {
  2532. // Standard 403 handler.
  2533. drupal_set_title(t('Access denied'));
  2534. $return = t('You are not authorized to access this page.');
  2535. }
  2536. print drupal_render_page($return);
  2537. break;
  2538. case MENU_SITE_OFFLINE:
  2539. // Print a 503 page.
  2540. drupal_maintenance_theme();
  2541. drupal_add_http_header('Status', '503 Service unavailable');
  2542. drupal_set_title(t('Site under maintenance'));
  2543. print theme('maintenance_page', array('content' => filter_xss_admin(variable_get('maintenance_mode_message',
  2544. t('@site is currently under maintenance. We should be back shortly. Thank you for your patience.', array('@site' => variable_get('site_name', 'Drupal')))))));
  2545. break;
  2546. }
  2547. }
  2548. elseif (isset($page_callback_result)) {
  2549. // Print anything besides a menu constant, assuming it's not NULL or
  2550. // undefined.
  2551. print drupal_render_page($page_callback_result);
  2552. }
  2553. // Perform end-of-request tasks.
  2554. drupal_page_footer();
  2555. }
  2556. /**
  2557. * Performs end-of-request tasks.
  2558. *
  2559. * This function sets the page cache if appropriate, and allows modules to
  2560. * react to the closing of the page by calling hook_exit().
  2561. */
  2562. function drupal_page_footer() {
  2563. global $user;
  2564. module_invoke_all('exit');
  2565. // Commit the user session, if needed.
  2566. drupal_session_commit();
  2567. if (variable_get('cache', 0) && ($cache = drupal_page_set_cache())) {
  2568. drupal_serve_page_from_cache($cache);
  2569. }
  2570. else {
  2571. ob_flush();
  2572. }
  2573. _registry_check_code(REGISTRY_WRITE_LOOKUP_CACHE);
  2574. drupal_cache_system_paths();
  2575. module_implements_write_cache();
  2576. drupal_file_scan_write_cache();
  2577. system_run_automated_cron();
  2578. }
  2579. /**
  2580. * Performs end-of-request tasks.
  2581. *
  2582. * In some cases page requests need to end without calling drupal_page_footer().
  2583. * In these cases, call drupal_exit() instead. There should rarely be a reason
  2584. * to call exit instead of drupal_exit();
  2585. *
  2586. * @param $destination
  2587. * If this function is called from drupal_goto(), then this argument
  2588. * will be a fully-qualified URL that is the destination of the redirect.
  2589. * This should be passed along to hook_exit() implementations.
  2590. */
  2591. function drupal_exit($destination = NULL) {
  2592. if (drupal_get_bootstrap_phase() == DRUPAL_BOOTSTRAP_FULL) {
  2593. if (!defined('MAINTENANCE_MODE') || MAINTENANCE_MODE != 'update') {
  2594. module_invoke_all('exit', $destination);
  2595. }
  2596. drupal_session_commit();
  2597. }
  2598. exit;
  2599. }
  2600. /**
  2601. * Forms an associative array from a linear array.
  2602. *
  2603. * This function walks through the provided array and constructs an associative
  2604. * array out of it. The keys of the resulting array will be the values of the
  2605. * input array. The values will be the same as the keys unless a function is
  2606. * specified, in which case the output of the function is used for the values
  2607. * instead.
  2608. *
  2609. * @param $array
  2610. * A linear array.
  2611. * @param $function
  2612. * A name of a function to apply to all values before output.
  2613. *
  2614. * @return
  2615. * An associative array.
  2616. */
  2617. function drupal_map_assoc($array, $function = NULL) {
  2618. // array_combine() fails with empty arrays:
  2619. // http://bugs.php.net/bug.php?id=34857.
  2620. $array = !empty($array) ? array_combine($array, $array) : array();
  2621. if (is_callable($function)) {
  2622. $array = array_map($function, $array);
  2623. }
  2624. return $array;
  2625. }
  2626. /**
  2627. * Attempts to set the PHP maximum execution time.
  2628. *
  2629. * This function is a wrapper around the PHP function set_time_limit().
  2630. * When called, set_time_limit() restarts the timeout counter from zero.
  2631. * In other words, if the timeout is the default 30 seconds, and 25 seconds
  2632. * into script execution a call such as set_time_limit(20) is made, the
  2633. * script will run for a total of 45 seconds before timing out.
  2634. *
  2635. * If the current time limit is not unlimited it is possible to decrease the
  2636. * total time limit if the sum of the new time limit and the current time spent
  2637. * running the script is inferior to the original time limit. It is inherent to
  2638. * the way set_time_limit() works, it should rather be called with an
  2639. * appropriate value every time you need to allocate a certain amount of time
  2640. * to execute a task than only once at the beginning of the script.
  2641. *
  2642. * Before calling set_time_limit(), we check if this function is available
  2643. * because it could be disabled by the server administrator. We also hide all
  2644. * the errors that could occur when calling set_time_limit(), because it is
  2645. * not possible to reliably ensure that PHP or a security extension will
  2646. * not issue a warning/error if they prevent the use of this function.
  2647. *
  2648. * @param $time_limit
  2649. * An integer specifying the new time limit, in seconds. A value of 0
  2650. * indicates unlimited execution time.
  2651. *
  2652. * @ingroup php_wrappers
  2653. */
  2654. function drupal_set_time_limit($time_limit) {
  2655. if (function_exists('set_time_limit')) {
  2656. $current = ini_get('max_execution_time');
  2657. // Do not set time limit if it is currently unlimited.
  2658. if ($current != 0) {
  2659. @set_time_limit($time_limit);
  2660. }
  2661. }
  2662. }
  2663. /**
  2664. * Returns the path to a system item (module, theme, etc.).
  2665. *
  2666. * @param $type
  2667. * The type of the item (i.e. theme, theme_engine, module, profile).
  2668. * @param $name
  2669. * The name of the item for which the path is requested.
  2670. *
  2671. * @return
  2672. * The path to the requested item or an empty string if the item is not found.
  2673. */
  2674. function drupal_get_path($type, $name) {
  2675. return dirname(drupal_get_filename($type, $name));
  2676. }
  2677. /**
  2678. * Returns the base URL path (i.e., directory) of the Drupal installation.
  2679. *
  2680. * base_path() adds a "/" to the beginning and end of the returned path if the
  2681. * path is not empty. At the very least, this will return "/".
  2682. *
  2683. * Examples:
  2684. * - http://example.com returns "/" because the path is empty.
  2685. * - http://example.com/drupal/folder returns "/drupal/folder/".
  2686. */
  2687. function base_path() {
  2688. return $GLOBALS['base_path'];
  2689. }
  2690. /**
  2691. * Adds a LINK tag with a distinct 'rel' attribute to the page's HEAD.
  2692. *
  2693. * This function can be called as long the HTML header hasn't been sent, which
  2694. * on normal pages is up through the preprocess step of theme('html'). Adding
  2695. * a link will overwrite a prior link with the exact same 'rel' and 'href'
  2696. * attributes.
  2697. *
  2698. * @param $attributes
  2699. * Associative array of element attributes including 'href' and 'rel'.
  2700. * @param $header
  2701. * Optional flag to determine if a HTTP 'Link:' header should be sent.
  2702. */
  2703. function drupal_add_html_head_link($attributes, $header = FALSE) {
  2704. $element = array(
  2705. '#tag' => 'link',
  2706. '#attributes' => $attributes,
  2707. );
  2708. $href = $attributes['href'];
  2709. if ($header) {
  2710. // Also add a HTTP header "Link:".
  2711. $href = '<' . check_plain($attributes['href']) . '>;';
  2712. unset($attributes['href']);
  2713. $element['#attached']['drupal_add_http_header'][] = array('Link', $href . drupal_http_header_attributes($attributes), TRUE);
  2714. }
  2715. drupal_add_html_head($element, 'drupal_add_html_head_link:' . $attributes['rel'] . ':' . $href);
  2716. }
  2717. /**
  2718. * Adds a cascading stylesheet to the stylesheet queue.
  2719. *
  2720. * Calling drupal_static_reset('drupal_add_css') will clear all cascading
  2721. * stylesheets added so far.
  2722. *
  2723. * If CSS aggregation/compression is enabled, all cascading style sheets added
  2724. * with $options['preprocess'] set to TRUE will be merged into one aggregate
  2725. * file and compressed by removing all extraneous white space.
  2726. * Preprocessed inline stylesheets will not be aggregated into this single file;
  2727. * instead, they are just compressed upon output on the page. Externally hosted
  2728. * stylesheets are never aggregated or compressed.
  2729. *
  2730. * The reason for aggregating the files is outlined quite thoroughly here:
  2731. * http://www.die.net/musings/page_load_time/ "Load fewer external objects. Due
  2732. * to request overhead, one bigger file just loads faster than two smaller ones
  2733. * half its size."
  2734. *
  2735. * $options['preprocess'] should be only set to TRUE when a file is required for
  2736. * all typical visitors and most pages of a site. It is critical that all
  2737. * preprocessed files are added unconditionally on every page, even if the
  2738. * files do not happen to be needed on a page. This is normally done by calling
  2739. * drupal_add_css() in a hook_init() implementation.
  2740. *
  2741. * Non-preprocessed files should only be added to the page when they are
  2742. * actually needed.
  2743. *
  2744. * @param $data
  2745. * (optional) The stylesheet data to be added, depending on what is passed
  2746. * through to the $options['type'] parameter:
  2747. * - 'file': The path to the CSS file relative to the base_path(), or a
  2748. * stream wrapper URI. For example: "modules/devel/devel.css" or
  2749. * "public://generated_css/stylesheet_1.css". Note that Modules should
  2750. * always prefix the names of their CSS files with the module name; for
  2751. * example, system-menus.css rather than simply menus.css. Themes can
  2752. * override module-supplied CSS files based on their filenames, and this
  2753. * prefixing helps prevent confusing name collisions for theme developers.
  2754. * See drupal_get_css() where the overrides are performed. Also, if the
  2755. * direction of the current language is right-to-left (Hebrew, Arabic,
  2756. * etc.), the function will also look for an RTL CSS file and append it to
  2757. * the list. The name of this file should have an '-rtl.css' suffix. For
  2758. * example, a CSS file called 'mymodule-name.css' will have a
  2759. * 'mymodule-name-rtl.css' file added to the list, if exists in the same
  2760. * directory. This CSS file should contain overrides for properties which
  2761. * should be reversed or otherwise different in a right-to-left display.
  2762. * - 'inline': A string of CSS that should be placed in the given scope. Note
  2763. * that it is better practice to use 'file' stylesheets, rather than
  2764. * 'inline', as the CSS would then be aggregated and cached.
  2765. * - 'external': The absolute path to an external CSS file that is not hosted
  2766. * on the local server. These files will not be aggregated if CSS
  2767. * aggregation is enabled.
  2768. * @param $options
  2769. * (optional) A string defining the 'type' of CSS that is being added in the
  2770. * $data parameter ('file', 'inline', or 'external'), or an array which can
  2771. * have any or all of the following keys:
  2772. * - 'type': The type of stylesheet being added. Available options are 'file',
  2773. * 'inline' or 'external'. Defaults to 'file'.
  2774. * - 'basename': Force a basename for the file being added. Modules are
  2775. * expected to use stylesheets with unique filenames, but integration of
  2776. * external libraries may make this impossible. The basename of
  2777. * 'modules/node/node.css' is 'node.css'. If the external library "node.js"
  2778. * ships with a 'node.css', then a different, unique basename would be
  2779. * 'node.js.css'.
  2780. * - 'group': A number identifying the group in which to add the stylesheet.
  2781. * Available constants are:
  2782. * - CSS_SYSTEM: Any system-layer CSS.
  2783. * - CSS_DEFAULT: (default) Any module-layer CSS.
  2784. * - CSS_THEME: Any theme-layer CSS.
  2785. * The group number serves as a weight: the markup for loading a stylesheet
  2786. * within a lower weight group is output to the page before the markup for
  2787. * loading a stylesheet within a higher weight group, so CSS within higher
  2788. * weight groups take precendence over CSS within lower weight groups.
  2789. * - 'every_page': For optimal front-end performance when aggregation is
  2790. * enabled, this should be set to TRUE if the stylesheet is present on every
  2791. * page of the website for users for whom it is present at all. This
  2792. * defaults to FALSE. It is set to TRUE for stylesheets added via module and
  2793. * theme .info files. Modules that add stylesheets within hook_init()
  2794. * implementations, or from other code that ensures that the stylesheet is
  2795. * added to all website pages, should also set this flag to TRUE. All
  2796. * stylesheets within the same group that have the 'every_page' flag set to
  2797. * TRUE and do not have 'preprocess' set to FALSE are aggregated together
  2798. * into a single aggregate file, and that aggregate file can be reused
  2799. * across a user's entire site visit, leading to faster navigation between
  2800. * pages. However, stylesheets that are only needed on pages less frequently
  2801. * visited, can be added by code that only runs for those particular pages,
  2802. * and that code should not set the 'every_page' flag. This minimizes the
  2803. * size of the aggregate file that the user needs to download when first
  2804. * visiting the website. Stylesheets without the 'every_page' flag are
  2805. * aggregated into a separate aggregate file. This other aggregate file is
  2806. * likely to change from page to page, and each new aggregate file needs to
  2807. * be downloaded when first encountered, so it should be kept relatively
  2808. * small by ensuring that most commonly needed stylesheets are added to
  2809. * every page.
  2810. * - 'weight': The weight of the stylesheet specifies the order in which the
  2811. * CSS will appear relative to other stylesheets with the same group and
  2812. * 'every_page' flag. The exact ordering of stylesheets is as follows:
  2813. * - First by group.
  2814. * - Then by the 'every_page' flag, with TRUE coming before FALSE.
  2815. * - Then by weight.
  2816. * - Then by the order in which the CSS was added. For example, all else
  2817. * being the same, a stylesheet added by a call to drupal_add_css() that
  2818. * happened later in the page request gets added to the page after one for
  2819. * which drupal_add_css() happened earlier in the page request.
  2820. * - 'media': The media type for the stylesheet, e.g., all, print, screen.
  2821. * Defaults to 'all'.
  2822. * - 'preprocess': If TRUE and CSS aggregation/compression is enabled, the
  2823. * styles will be aggregated and compressed. Defaults to TRUE.
  2824. * - 'browsers': An array containing information specifying which browsers
  2825. * should load the CSS item. See drupal_pre_render_conditional_comments()
  2826. * for details.
  2827. *
  2828. * @return
  2829. * An array of queued cascading stylesheets.
  2830. *
  2831. * @see drupal_get_css()
  2832. */
  2833. function drupal_add_css($data = NULL, $options = NULL) {
  2834. $css = &drupal_static(__FUNCTION__, array());
  2835. $count = &drupal_static(__FUNCTION__ . '_count', 0);
  2836. // If the $css variable has been reset with drupal_static_reset(), there is
  2837. // no longer any CSS being tracked, so set the counter back to 0 also.
  2838. if (count($css) === 0) {
  2839. $count = 0;
  2840. }
  2841. // Construct the options, taking the defaults into consideration.
  2842. if (isset($options)) {
  2843. if (!is_array($options)) {
  2844. $options = array('type' => $options);
  2845. }
  2846. }
  2847. else {
  2848. $options = array();
  2849. }
  2850. // Create an array of CSS files for each media type first, since each type needs to be served
  2851. // to the browser differently.
  2852. if (isset($data)) {
  2853. $options += array(
  2854. 'type' => 'file',
  2855. 'group' => CSS_DEFAULT,
  2856. 'weight' => 0,
  2857. 'every_page' => FALSE,
  2858. 'media' => 'all',
  2859. 'preprocess' => TRUE,
  2860. 'data' => $data,
  2861. 'browsers' => array(),
  2862. );
  2863. $options['browsers'] += array(
  2864. 'IE' => TRUE,
  2865. '!IE' => TRUE,
  2866. );
  2867. // Files with a query string cannot be preprocessed.
  2868. if ($options['type'] === 'file' && $options['preprocess'] && strpos($options['data'], '?') !== FALSE) {
  2869. $options['preprocess'] = FALSE;
  2870. }
  2871. // Always add a tiny value to the weight, to conserve the insertion order.
  2872. $options['weight'] += $count / 1000;
  2873. $count++;
  2874. // Add the data to the CSS array depending on the type.
  2875. switch ($options['type']) {
  2876. case 'inline':
  2877. // For inline stylesheets, we don't want to use the $data as the array
  2878. // key as $data could be a very long string of CSS.
  2879. $css[] = $options;
  2880. break;
  2881. default:
  2882. // Local and external files must keep their name as the associative key
  2883. // so the same CSS file is not be added twice.
  2884. $css[$data] = $options;
  2885. }
  2886. }
  2887. return $css;
  2888. }
  2889. /**
  2890. * Returns a themed representation of all stylesheets to attach to the page.
  2891. *
  2892. * It loads the CSS in order, with 'module' first, then 'theme' afterwards.
  2893. * This ensures proper cascading of styles so themes can easily override
  2894. * module styles through CSS selectors.
  2895. *
  2896. * Themes may replace module-defined CSS files by adding a stylesheet with the
  2897. * same filename. For example, themes/bartik/system-menus.css would replace
  2898. * modules/system/system-menus.css. This allows themes to override complete
  2899. * CSS files, rather than specific selectors, when necessary.
  2900. *
  2901. * If the original CSS file is being overridden by a theme, the theme is
  2902. * responsible for supplying an accompanying RTL CSS file to replace the
  2903. * module's.
  2904. *
  2905. * @param $css
  2906. * (optional) An array of CSS files. If no array is provided, the default
  2907. * stylesheets array is used instead.
  2908. * @param $skip_alter
  2909. * (optional) If set to TRUE, this function skips calling drupal_alter() on
  2910. * $css, useful when the calling function passes a $css array that has already
  2911. * been altered.
  2912. *
  2913. * @return
  2914. * A string of XHTML CSS tags.
  2915. *
  2916. * @see drupal_add_css()
  2917. */
  2918. function drupal_get_css($css = NULL, $skip_alter = FALSE) {
  2919. if (!isset($css)) {
  2920. $css = drupal_add_css();
  2921. }
  2922. // Allow modules and themes to alter the CSS items.
  2923. if (!$skip_alter) {
  2924. drupal_alter('css', $css);
  2925. }
  2926. // Sort CSS items, so that they appear in the correct order.
  2927. uasort($css, 'drupal_sort_css_js');
  2928. // Provide the page with information about the individual CSS files used,
  2929. // information not otherwise available when CSS aggregation is enabled. The
  2930. // setting is attached later in this function, but is set here, so that CSS
  2931. // files removed below are still considered "used" and prevented from being
  2932. // added in a later AJAX request.
  2933. // Skip if no files were added to the page or jQuery.extend() will overwrite
  2934. // the Drupal.settings.ajaxPageState.css object with an empty array.
  2935. if (!empty($css)) {
  2936. // Cast the array to an object to be on the safe side even if not empty.
  2937. $setting['ajaxPageState']['css'] = (object) array_fill_keys(array_keys($css), 1);
  2938. }
  2939. // Remove the overridden CSS files. Later CSS files override former ones.
  2940. $previous_item = array();
  2941. foreach ($css as $key => $item) {
  2942. if ($item['type'] == 'file') {
  2943. // If defined, force a unique basename for this file.
  2944. $basename = isset($item['basename']) ? $item['basename'] : drupal_basename($item['data']);
  2945. if (isset($previous_item[$basename])) {
  2946. // Remove the previous item that shared the same base name.
  2947. unset($css[$previous_item[$basename]]);
  2948. }
  2949. $previous_item[$basename] = $key;
  2950. }
  2951. }
  2952. // Render the HTML needed to load the CSS.
  2953. $styles = array(
  2954. '#type' => 'styles',
  2955. '#items' => $css,
  2956. );
  2957. if (!empty($setting)) {
  2958. $styles['#attached']['js'][] = array('type' => 'setting', 'data' => $setting);
  2959. }
  2960. return drupal_render($styles);
  2961. }
  2962. /**
  2963. * Sorts CSS and JavaScript resources.
  2964. *
  2965. * Callback for uasort() within:
  2966. * - drupal_get_css()
  2967. * - drupal_get_js()
  2968. *
  2969. * This sort order helps optimize front-end performance while providing modules
  2970. * and themes with the necessary control for ordering the CSS and JavaScript
  2971. * appearing on a page.
  2972. *
  2973. * @param $a
  2974. * First item for comparison. The compared items should be associative arrays
  2975. * of member items from drupal_add_css() or drupal_add_js().
  2976. * @param $b
  2977. * Second item for comparison.
  2978. *
  2979. * @see drupal_add_css()
  2980. * @see drupal_add_js()
  2981. */
  2982. function drupal_sort_css_js($a, $b) {
  2983. // First order by group, so that, for example, all items in the CSS_SYSTEM
  2984. // group appear before items in the CSS_DEFAULT group, which appear before
  2985. // all items in the CSS_THEME group. Modules may create additional groups by
  2986. // defining their own constants.
  2987. if ($a['group'] < $b['group']) {
  2988. return -1;
  2989. }
  2990. elseif ($a['group'] > $b['group']) {
  2991. return 1;
  2992. }
  2993. // Within a group, order all infrequently needed, page-specific files after
  2994. // common files needed throughout the website. Separating this way allows for
  2995. // the aggregate file generated for all of the common files to be reused
  2996. // across a site visit without being cut by a page using a less common file.
  2997. elseif ($a['every_page'] && !$b['every_page']) {
  2998. return -1;
  2999. }
  3000. elseif (!$a['every_page'] && $b['every_page']) {
  3001. return 1;
  3002. }
  3003. // Finally, order by weight.
  3004. elseif ($a['weight'] < $b['weight']) {
  3005. return -1;
  3006. }
  3007. elseif ($a['weight'] > $b['weight']) {
  3008. return 1;
  3009. }
  3010. else {
  3011. return 0;
  3012. }
  3013. }
  3014. /**
  3015. * Default callback to group CSS items.
  3016. *
  3017. * This function arranges the CSS items that are in the #items property of the
  3018. * styles element into groups. Arranging the CSS items into groups serves two
  3019. * purposes. When aggregation is enabled, files within a group are aggregated
  3020. * into a single file, significantly improving page loading performance by
  3021. * minimizing network traffic overhead. When aggregation is disabled, grouping
  3022. * allows multiple files to be loaded from a single STYLE tag, enabling sites
  3023. * with many modules enabled or a complex theme being used to stay within IE's
  3024. * 31 CSS inclusion tag limit: http://drupal.org/node/228818.
  3025. *
  3026. * This function puts multiple items into the same group if they are groupable
  3027. * and if they are for the same 'media' and 'browsers'. Items of the 'file' type
  3028. * are groupable if their 'preprocess' flag is TRUE, items of the 'inline' type
  3029. * are always groupable, and items of the 'external' type are never groupable.
  3030. * This function also ensures that the process of grouping items does not change
  3031. * their relative order. This requirement may result in multiple groups for the
  3032. * same type, media, and browsers, if needed to accommodate other items in
  3033. * between.
  3034. *
  3035. * @param $css
  3036. * An array of CSS items, as returned by drupal_add_css(), but after
  3037. * alteration performed by drupal_get_css().
  3038. *
  3039. * @return
  3040. * An array of CSS groups. Each group contains the same keys (e.g., 'media',
  3041. * 'data', etc.) as a CSS item from the $css parameter, with the value of
  3042. * each key applying to the group as a whole. Each group also contains an
  3043. * 'items' key, which is the subset of items from $css that are in the group.
  3044. *
  3045. * @see drupal_pre_render_styles()
  3046. * @see system_element_info()
  3047. */
  3048. function drupal_group_css($css) {
  3049. $groups = array();
  3050. // If a group can contain multiple items, we track the information that must
  3051. // be the same for each item in the group, so that when we iterate the next
  3052. // item, we can determine if it can be put into the current group, or if a
  3053. // new group needs to be made for it.
  3054. $current_group_keys = NULL;
  3055. // When creating a new group, we pre-increment $i, so by initializing it to
  3056. // -1, the first group will have index 0.
  3057. $i = -1;
  3058. foreach ($css as $item) {
  3059. // The browsers for which the CSS item needs to be loaded is part of the
  3060. // information that determines when a new group is needed, but the order of
  3061. // keys in the array doesn't matter, and we don't want a new group if all
  3062. // that's different is that order.
  3063. ksort($item['browsers']);
  3064. // If the item can be grouped with other items, set $group_keys to an array
  3065. // of information that must be the same for all items in its group. If the
  3066. // item can't be grouped with other items, set $group_keys to FALSE. We
  3067. // put items into a group that can be aggregated together: whether they will
  3068. // be aggregated is up to the _drupal_css_aggregate() function or an
  3069. // override of that function specified in hook_css_alter(), but regardless
  3070. // of the details of that function, a group represents items that can be
  3071. // aggregated. Since a group may be rendered with a single HTML tag, all
  3072. // items in the group must share the same information that would need to be
  3073. // part of that HTML tag.
  3074. switch ($item['type']) {
  3075. case 'file':
  3076. // Group file items if their 'preprocess' flag is TRUE.
  3077. // Help ensure maximum reuse of aggregate files by only grouping
  3078. // together items that share the same 'group' value and 'every_page'
  3079. // flag. See drupal_add_css() for details about that.
  3080. $group_keys = $item['preprocess'] ? array($item['type'], $item['group'], $item['every_page'], $item['media'], $item['browsers']) : FALSE;
  3081. break;
  3082. case 'inline':
  3083. // Always group inline items.
  3084. $group_keys = array($item['type'], $item['media'], $item['browsers']);
  3085. break;
  3086. case 'external':
  3087. // Do not group external items.
  3088. $group_keys = FALSE;
  3089. break;
  3090. }
  3091. // If the group keys don't match the most recent group we're working with,
  3092. // then a new group must be made.
  3093. if ($group_keys !== $current_group_keys) {
  3094. $i++;
  3095. // Initialize the new group with the same properties as the first item
  3096. // being placed into it. The item's 'data' and 'weight' properties are
  3097. // unique to the item and should not be carried over to the group.
  3098. $groups[$i] = $item;
  3099. unset($groups[$i]['data'], $groups[$i]['weight']);
  3100. $groups[$i]['items'] = array();
  3101. $current_group_keys = $group_keys ? $group_keys : NULL;
  3102. }
  3103. // Add the item to the current group.
  3104. $groups[$i]['items'][] = $item;
  3105. }
  3106. return $groups;
  3107. }
  3108. /**
  3109. * Default callback to aggregate CSS files and inline content.
  3110. *
  3111. * Having the browser load fewer CSS files results in much faster page loads
  3112. * than when it loads many small files. This function aggregates files within
  3113. * the same group into a single file unless the site-wide setting to do so is
  3114. * disabled (commonly the case during site development). To optimize download,
  3115. * it also compresses the aggregate files by removing comments, whitespace, and
  3116. * other unnecessary content. Additionally, this functions aggregates inline
  3117. * content together, regardless of the site-wide aggregation setting.
  3118. *
  3119. * @param $css_groups
  3120. * An array of CSS groups as returned by drupal_group_css(). This function
  3121. * modifies the group's 'data' property for each group that is aggregated.
  3122. *
  3123. * @see drupal_group_css()
  3124. * @see drupal_pre_render_styles()
  3125. * @see system_element_info()
  3126. */
  3127. function drupal_aggregate_css(&$css_groups) {
  3128. $preprocess_css = (variable_get('preprocess_css', FALSE) && (!defined('MAINTENANCE_MODE') || MAINTENANCE_MODE != 'update'));
  3129. // For each group that needs aggregation, aggregate its items.
  3130. foreach ($css_groups as $key => $group) {
  3131. switch ($group['type']) {
  3132. // If a file group can be aggregated into a single file, do so, and set
  3133. // the group's data property to the file path of the aggregate file.
  3134. case 'file':
  3135. if ($group['preprocess'] && $preprocess_css) {
  3136. $css_groups[$key]['data'] = drupal_build_css_cache($group['items']);
  3137. }
  3138. break;
  3139. // Aggregate all inline CSS content into the group's data property.
  3140. case 'inline':
  3141. $css_groups[$key]['data'] = '';
  3142. foreach ($group['items'] as $item) {
  3143. $css_groups[$key]['data'] .= drupal_load_stylesheet_content($item['data'], $item['preprocess']);
  3144. }
  3145. break;
  3146. }
  3147. }
  3148. }
  3149. /**
  3150. * #pre_render callback to add the elements needed for CSS tags to be rendered.
  3151. *
  3152. * For production websites, LINK tags are preferable to STYLE tags with @import
  3153. * statements, because:
  3154. * - They are the standard tag intended for linking to a resource.
  3155. * - On Firefox 2 and perhaps other browsers, CSS files included with @import
  3156. * statements don't get saved when saving the complete web page for offline
  3157. * use: http://drupal.org/node/145218.
  3158. * - On IE, if only LINK tags and no @import statements are used, all the CSS
  3159. * files are downloaded in parallel, resulting in faster page load, but if
  3160. * @import statements are used and span across multiple STYLE tags, all the
  3161. * ones from one STYLE tag must be downloaded before downloading begins for
  3162. * the next STYLE tag. Furthermore, IE7 does not support media declaration on
  3163. * the @import statement, so multiple STYLE tags must be used when different
  3164. * files are for different media types. Non-IE browsers always download in
  3165. * parallel, so this is an IE-specific performance quirk:
  3166. * http://www.stevesouders.com/blog/2009/04/09/dont-use-import/.
  3167. *
  3168. * However, IE has an annoying limit of 31 total CSS inclusion tags
  3169. * (http://drupal.org/node/228818) and LINK tags are limited to one file per
  3170. * tag, whereas STYLE tags can contain multiple @import statements allowing
  3171. * multiple files to be loaded per tag. When CSS aggregation is disabled, a
  3172. * Drupal site can easily have more than 31 CSS files that need to be loaded, so
  3173. * using LINK tags exclusively would result in a site that would display
  3174. * incorrectly in IE. Depending on different needs, different strategies can be
  3175. * employed to decide when to use LINK tags and when to use STYLE tags.
  3176. *
  3177. * The strategy employed by this function is to use LINK tags for all aggregate
  3178. * files and for all files that cannot be aggregated (e.g., if 'preprocess' is
  3179. * set to FALSE or the type is 'external'), and to use STYLE tags for groups
  3180. * of files that could be aggregated together but aren't (e.g., if the site-wide
  3181. * aggregation setting is disabled). This results in all LINK tags when
  3182. * aggregation is enabled, a guarantee that as many or only slightly more tags
  3183. * are used with aggregation disabled than enabled (so that if the limit were to
  3184. * be crossed with aggregation enabled, the site developer would also notice the
  3185. * problem while aggregation is disabled), and an easy way for a developer to
  3186. * view HTML source while aggregation is disabled and know what files will be
  3187. * aggregated together when aggregation becomes enabled.
  3188. *
  3189. * This function evaluates the aggregation enabled/disabled condition on a group
  3190. * by group basis by testing whether an aggregate file has been made for the
  3191. * group rather than by testing the site-wide aggregation setting. This allows
  3192. * this function to work correctly even if modules have implemented custom
  3193. * logic for grouping and aggregating files.
  3194. *
  3195. * @param $element
  3196. * A render array containing:
  3197. * - '#items': The CSS items as returned by drupal_add_css() and altered by
  3198. * drupal_get_css().
  3199. * - '#group_callback': A function to call to group #items to enable the use
  3200. * of fewer tags by aggregating files and/or using multiple @import
  3201. * statements within a single tag.
  3202. * - '#aggregate_callback': A function to call to aggregate the items within
  3203. * the groups arranged by the #group_callback function.
  3204. *
  3205. * @return
  3206. * A render array that will render to a string of XHTML CSS tags.
  3207. *
  3208. * @see drupal_get_css()
  3209. */
  3210. function drupal_pre_render_styles($elements) {
  3211. // Group and aggregate the items.
  3212. if (isset($elements['#group_callback'])) {
  3213. $elements['#groups'] = $elements['#group_callback']($elements['#items']);
  3214. }
  3215. if (isset($elements['#aggregate_callback'])) {
  3216. $elements['#aggregate_callback']($elements['#groups']);
  3217. }
  3218. // A dummy query-string is added to filenames, to gain control over
  3219. // browser-caching. The string changes on every update or full cache
  3220. // flush, forcing browsers to load a new copy of the files, as the
  3221. // URL changed.
  3222. $query_string = variable_get('css_js_query_string', '0');
  3223. // For inline CSS to validate as XHTML, all CSS containing XHTML needs to be
  3224. // wrapped in CDATA. To make that backwards compatible with HTML 4, we need to
  3225. // comment out the CDATA-tag.
  3226. $embed_prefix = "\n<!--/*--><![CDATA[/*><!--*/\n";
  3227. $embed_suffix = "\n/*]]>*/-->\n";
  3228. // Defaults for LINK and STYLE elements.
  3229. $link_element_defaults = array(
  3230. '#type' => 'html_tag',
  3231. '#tag' => 'link',
  3232. '#attributes' => array(
  3233. 'type' => 'text/css',
  3234. 'rel' => 'stylesheet',
  3235. ),
  3236. );
  3237. $style_element_defaults = array(
  3238. '#type' => 'html_tag',
  3239. '#tag' => 'style',
  3240. '#attributes' => array(
  3241. 'type' => 'text/css',
  3242. ),
  3243. );
  3244. // Loop through each group.
  3245. foreach ($elements['#groups'] as $group) {
  3246. switch ($group['type']) {
  3247. // For file items, there are three possibilites.
  3248. // - The group has been aggregated: in this case, output a LINK tag for
  3249. // the aggregate file.
  3250. // - The group can be aggregated but has not been (most likely because
  3251. // the site administrator disabled the site-wide setting): in this case,
  3252. // output as few STYLE tags for the group as possible, using @import
  3253. // statement for each file in the group. This enables us to stay within
  3254. // IE's limit of 31 total CSS inclusion tags.
  3255. // - The group contains items not eligible for aggregation (their
  3256. // 'preprocess' flag has been set to FALSE): in this case, output a LINK
  3257. // tag for each file.
  3258. case 'file':
  3259. // The group has been aggregated into a single file: output a LINK tag
  3260. // for the aggregate file.
  3261. if (isset($group['data'])) {
  3262. $element = $link_element_defaults;
  3263. $element['#attributes']['href'] = file_create_url($group['data']);
  3264. $element['#attributes']['media'] = $group['media'];
  3265. $element['#browsers'] = $group['browsers'];
  3266. $elements[] = $element;
  3267. }
  3268. // The group can be aggregated, but hasn't been: combine multiple items
  3269. // into as few STYLE tags as possible.
  3270. elseif ($group['preprocess']) {
  3271. $import = array();
  3272. foreach ($group['items'] as $item) {
  3273. // A theme's .info file may have an entry for a file that doesn't
  3274. // exist as a way of overriding a module or base theme CSS file from
  3275. // being added to the page. Normally, file_exists() calls that need
  3276. // to run for every page request should be minimized, but this one
  3277. // is okay, because it only runs when CSS aggregation is disabled.
  3278. // On a server under heavy enough load that file_exists() calls need
  3279. // to be minimized, CSS aggregation should be enabled, in which case
  3280. // this code is not run. When aggregation is enabled,
  3281. // drupal_load_stylesheet() checks file_exists(), but only when
  3282. // building the aggregate file, which is then reused for many page
  3283. // requests.
  3284. if (file_exists($item['data'])) {
  3285. // The dummy query string needs to be added to the URL to control
  3286. // browser-caching. IE7 does not support a media type on the
  3287. // @import statement, so we instead specify the media for the
  3288. // group on the STYLE tag.
  3289. $import[] = '@import url("' . check_plain(file_create_url($item['data']) . '?' . $query_string) . '");';
  3290. }
  3291. }
  3292. // In addition to IE's limit of 31 total CSS inclusion tags, it also
  3293. // has a limit of 31 @import statements per STYLE tag.
  3294. while (!empty($import)) {
  3295. $import_batch = array_slice($import, 0, 31);
  3296. $import = array_slice($import, 31);
  3297. $element = $style_element_defaults;
  3298. // This simplifies the JavaScript regex, allowing each line
  3299. // (separated by \n) to be treated as a completely different string.
  3300. // This means that we can use ^ and $ on one line at a time, and not
  3301. // worry about style tags since they'll never match the regex.
  3302. $element['#value'] = "\n" . implode("\n", $import_batch) . "\n";
  3303. $element['#attributes']['media'] = $group['media'];
  3304. $element['#browsers'] = $group['browsers'];
  3305. $elements[] = $element;
  3306. }
  3307. }
  3308. // The group contains items ineligible for aggregation: output a LINK
  3309. // tag for each file.
  3310. else {
  3311. foreach ($group['items'] as $item) {
  3312. $element = $link_element_defaults;
  3313. // We do not check file_exists() here, because this code runs for
  3314. // files whose 'preprocess' is set to FALSE, and therefore, even
  3315. // when aggregation is enabled, and we want to avoid needlessly
  3316. // taxing a server that may be under heavy load. The file_exists()
  3317. // performed above for files whose 'preprocess' is TRUE is done for
  3318. // the benefit of theme .info files, but code that deals with files
  3319. // whose 'preprocess' is FALSE is responsible for ensuring the file
  3320. // exists.
  3321. // The dummy query string needs to be added to the URL to control
  3322. // browser-caching.
  3323. $query_string_separator = (strpos($item['data'], '?') !== FALSE) ? '&' : '?';
  3324. $element['#attributes']['href'] = file_create_url($item['data']) . $query_string_separator . $query_string;
  3325. $element['#attributes']['media'] = $item['media'];
  3326. $element['#browsers'] = $group['browsers'];
  3327. $elements[] = $element;
  3328. }
  3329. }
  3330. break;
  3331. // For inline content, the 'data' property contains the CSS content. If
  3332. // the group's 'data' property is set, then output it in a single STYLE
  3333. // tag. Otherwise, output a separate STYLE tag for each item.
  3334. case 'inline':
  3335. if (isset($group['data'])) {
  3336. $element = $style_element_defaults;
  3337. $element['#value'] = $group['data'];
  3338. $element['#value_prefix'] = $embed_prefix;
  3339. $element['#value_suffix'] = $embed_suffix;
  3340. $element['#attributes']['media'] = $group['media'];
  3341. $element['#browsers'] = $group['browsers'];
  3342. $elements[] = $element;
  3343. }
  3344. else {
  3345. foreach ($group['items'] as $item) {
  3346. $element = $style_element_defaults;
  3347. $element['#value'] = $item['data'];
  3348. $element['#value_prefix'] = $embed_prefix;
  3349. $element['#value_suffix'] = $embed_suffix;
  3350. $element['#attributes']['media'] = $item['media'];
  3351. $element['#browsers'] = $group['browsers'];
  3352. $elements[] = $element;
  3353. }
  3354. }
  3355. break;
  3356. // Output a LINK tag for each external item. The item's 'data' property
  3357. // contains the full URL.
  3358. case 'external':
  3359. foreach ($group['items'] as $item) {
  3360. $element = $link_element_defaults;
  3361. $element['#attributes']['href'] = $item['data'];
  3362. $element['#attributes']['media'] = $item['media'];
  3363. $element['#browsers'] = $group['browsers'];
  3364. $elements[] = $element;
  3365. }
  3366. break;
  3367. }
  3368. }
  3369. return $elements;
  3370. }
  3371. /**
  3372. * Aggregates and optimizes CSS files into a cache file in the files directory.
  3373. *
  3374. * The file name for the CSS cache file is generated from the hash of the
  3375. * aggregated contents of the files in $css. This forces proxies and browsers
  3376. * to download new CSS when the CSS changes.
  3377. *
  3378. * The cache file name is retrieved on a page load via a lookup variable that
  3379. * contains an associative array. The array key is the hash of the file names
  3380. * in $css while the value is the cache file name. The cache file is generated
  3381. * in two cases. First, if there is no file name value for the key, which will
  3382. * happen if a new file name has been added to $css or after the lookup
  3383. * variable is emptied to force a rebuild of the cache. Second, the cache file
  3384. * is generated if it is missing on disk. Old cache files are not deleted
  3385. * immediately when the lookup variable is emptied, but are deleted after a set
  3386. * period by drupal_delete_file_if_stale(). This ensures that files referenced
  3387. * by a cached page will still be available.
  3388. *
  3389. * @param $css
  3390. * An array of CSS files to aggregate and compress into one file.
  3391. *
  3392. * @return
  3393. * The URI of the CSS cache file, or FALSE if the file could not be saved.
  3394. */
  3395. function drupal_build_css_cache($css) {
  3396. $data = '';
  3397. $uri = '';
  3398. $map = variable_get('drupal_css_cache_files', array());
  3399. // Create a new array so that only the file names are used to create the hash.
  3400. // This prevents new aggregates from being created unnecessarily.
  3401. $css_data = array();
  3402. foreach ($css as $css_file) {
  3403. $css_data[] = $css_file['data'];
  3404. }
  3405. $key = hash('sha256', serialize($css_data));
  3406. if (isset($map[$key])) {
  3407. $uri = $map[$key];
  3408. }
  3409. if (empty($uri) || !file_exists($uri)) {
  3410. // Build aggregate CSS file.
  3411. foreach ($css as $stylesheet) {
  3412. // Only 'file' stylesheets can be aggregated.
  3413. if ($stylesheet['type'] == 'file') {
  3414. $contents = drupal_load_stylesheet($stylesheet['data'], TRUE);
  3415. // Build the base URL of this CSS file: start with the full URL.
  3416. $css_base_url = file_create_url($stylesheet['data']);
  3417. // Move to the parent.
  3418. $css_base_url = substr($css_base_url, 0, strrpos($css_base_url, '/'));
  3419. // Simplify to a relative URL if the stylesheet URL starts with the
  3420. // base URL of the website.
  3421. if (substr($css_base_url, 0, strlen($GLOBALS['base_root'])) == $GLOBALS['base_root']) {
  3422. $css_base_url = substr($css_base_url, strlen($GLOBALS['base_root']));
  3423. }
  3424. _drupal_build_css_path(NULL, $css_base_url . '/');
  3425. // Anchor all paths in the CSS with its base URL, ignoring external and absolute paths.
  3426. $data .= preg_replace_callback('/url\(\s*[\'"]?(?![a-z]+:|\/+)([^\'")]+)[\'"]?\s*\)/i', '_drupal_build_css_path', $contents);
  3427. }
  3428. }
  3429. // Per the W3C specification at http://www.w3.org/TR/REC-CSS2/cascade.html#at-import,
  3430. // @import rules must proceed any other style, so we move those to the top.
  3431. $regexp = '/@import[^;]+;/i';
  3432. preg_match_all($regexp, $data, $matches);
  3433. $data = preg_replace($regexp, '', $data);
  3434. $data = implode('', $matches[0]) . $data;
  3435. // Prefix filename to prevent blocking by firewalls which reject files
  3436. // starting with "ad*".
  3437. $filename = 'css_' . drupal_hash_base64($data) . '.css';
  3438. // Create the css/ within the files folder.
  3439. $csspath = 'public://css';
  3440. $uri = $csspath . '/' . $filename;
  3441. // Create the CSS file.
  3442. file_prepare_directory($csspath, FILE_CREATE_DIRECTORY);
  3443. if (!file_exists($uri) && !file_unmanaged_save_data($data, $uri, FILE_EXISTS_REPLACE)) {
  3444. return FALSE;
  3445. }
  3446. // If CSS gzip compression is enabled, clean URLs are enabled (which means
  3447. // that rewrite rules are working) and the zlib extension is available then
  3448. // create a gzipped version of this file. This file is served conditionally
  3449. // to browsers that accept gzip using .htaccess rules.
  3450. if (variable_get('css_gzip_compression', TRUE) && variable_get('clean_url', 0) && extension_loaded('zlib')) {
  3451. if (!file_exists($uri . '.gz') && !file_unmanaged_save_data(gzencode($data, 9, FORCE_GZIP), $uri . '.gz', FILE_EXISTS_REPLACE)) {
  3452. return FALSE;
  3453. }
  3454. }
  3455. // Save the updated map.
  3456. $map[$key] = $uri;
  3457. variable_set('drupal_css_cache_files', $map);
  3458. }
  3459. return $uri;
  3460. }
  3461. /**
  3462. * Prefixes all paths within a CSS file for drupal_build_css_cache().
  3463. */
  3464. function _drupal_build_css_path($matches, $base = NULL) {
  3465. $_base = &drupal_static(__FUNCTION__);
  3466. // Store base path for preg_replace_callback.
  3467. if (isset($base)) {
  3468. $_base = $base;
  3469. }
  3470. // Prefix with base and remove '../' segments where possible.
  3471. $path = $_base . (isset($matches[1]) ? $matches[1] : '');
  3472. $last = '';
  3473. while ($path != $last) {
  3474. $last = $path;
  3475. $path = preg_replace('`(^|/)(?!\.\./)([^/]+)/\.\./`', '$1', $path);
  3476. }
  3477. return 'url(' . $path . ')';
  3478. }
  3479. /**
  3480. * Loads the stylesheet and resolves all @import commands.
  3481. *
  3482. * Loads a stylesheet and replaces @import commands with the contents of the
  3483. * imported file. Use this instead of file_get_contents when processing
  3484. * stylesheets.
  3485. *
  3486. * The returned contents are compressed removing white space and comments only
  3487. * when CSS aggregation is enabled. This optimization will not apply for
  3488. * color.module enabled themes with CSS aggregation turned off.
  3489. *
  3490. * @param $file
  3491. * Name of the stylesheet to be processed.
  3492. * @param $optimize
  3493. * Defines if CSS contents should be compressed or not.
  3494. * @param $reset_basepath
  3495. * Used internally to facilitate recursive resolution of @import commands.
  3496. *
  3497. * @return
  3498. * Contents of the stylesheet, including any resolved @import commands.
  3499. */
  3500. function drupal_load_stylesheet($file, $optimize = NULL, $reset_basepath = TRUE) {
  3501. // These statics are not cache variables, so we don't use drupal_static().
  3502. static $_optimize, $basepath;
  3503. if ($reset_basepath) {
  3504. $basepath = '';
  3505. }
  3506. // Store the value of $optimize for preg_replace_callback with nested
  3507. // @import loops.
  3508. if (isset($optimize)) {
  3509. $_optimize = $optimize;
  3510. }
  3511. // Stylesheets are relative one to each other. Start by adding a base path
  3512. // prefix provided by the parent stylesheet (if necessary).
  3513. if ($basepath && !file_uri_scheme($file)) {
  3514. $file = $basepath . '/' . $file;
  3515. }
  3516. // Store the parent base path to restore it later.
  3517. $parent_base_path = $basepath;
  3518. // Set the current base path to process possible child imports.
  3519. $basepath = dirname($file);
  3520. // Load the CSS stylesheet. We suppress errors because themes may specify
  3521. // stylesheets in their .info file that don't exist in the theme's path,
  3522. // but are merely there to disable certain module CSS files.
  3523. $content = '';
  3524. if ($contents = @file_get_contents($file)) {
  3525. // Return the processed stylesheet.
  3526. $content = drupal_load_stylesheet_content($contents, $_optimize);
  3527. }
  3528. // Restore the parent base path as the file and its childen are processed.
  3529. $basepath = $parent_base_path;
  3530. return $content;
  3531. }
  3532. /**
  3533. * Processes the contents of a stylesheet for aggregation.
  3534. *
  3535. * @param $contents
  3536. * The contents of the stylesheet.
  3537. * @param $optimize
  3538. * (optional) Boolean whether CSS contents should be minified. Defaults to
  3539. * FALSE.
  3540. *
  3541. * @return
  3542. * Contents of the stylesheet including the imported stylesheets.
  3543. */
  3544. function drupal_load_stylesheet_content($contents, $optimize = FALSE) {
  3545. // Remove multiple charset declarations for standards compliance (and fixing Safari problems).
  3546. $contents = preg_replace('/^@charset\s+[\'"](\S*?)\b[\'"];/i', '', $contents);
  3547. if ($optimize) {
  3548. // Perform some safe CSS optimizations.
  3549. // Regexp to match comment blocks.
  3550. $comment = '/\*[^*]*\*+(?:[^/*][^*]*\*+)*/';
  3551. // Regexp to match double quoted strings.
  3552. $double_quot = '"[^"\\\\]*(?:\\\\.[^"\\\\]*)*"';
  3553. // Regexp to match single quoted strings.
  3554. $single_quot = "'[^'\\\\]*(?:\\\\.[^'\\\\]*)*'";
  3555. // Strip all comment blocks, but keep double/single quoted strings.
  3556. $contents = preg_replace(
  3557. "<($double_quot|$single_quot)|$comment>Ss",
  3558. "$1",
  3559. $contents
  3560. );
  3561. // Remove certain whitespace.
  3562. // There are different conditions for removing leading and trailing
  3563. // whitespace.
  3564. // @see http://php.net/manual/regexp.reference.subpatterns.php
  3565. $contents = preg_replace('<
  3566. # Strip leading and trailing whitespace.
  3567. \s*([@{};,])\s*
  3568. # Strip only leading whitespace from:
  3569. # - Closing parenthesis: Retain "@media (bar) and foo".
  3570. | \s+([\)])
  3571. # Strip only trailing whitespace from:
  3572. # - Opening parenthesis: Retain "@media (bar) and foo".
  3573. # - Colon: Retain :pseudo-selectors.
  3574. | ([\(:])\s+
  3575. >xS',
  3576. // Only one of the three capturing groups will match, so its reference
  3577. // will contain the wanted value and the references for the
  3578. // two non-matching groups will be replaced with empty strings.
  3579. '$1$2$3',
  3580. $contents
  3581. );
  3582. // End the file with a new line.
  3583. $contents = trim($contents);
  3584. $contents .= "\n";
  3585. }
  3586. // Replaces @import commands with the actual stylesheet content.
  3587. // This happens recursively but omits external files.
  3588. $contents = preg_replace_callback('/@import\s*(?:url\(\s*)?[\'"]?(?![a-z]+:)(?!\/\/)([^\'"\()]+)[\'"]?\s*\)?\s*;/', '_drupal_load_stylesheet', $contents);
  3589. return $contents;
  3590. }
  3591. /**
  3592. * Loads stylesheets recursively and returns contents with corrected paths.
  3593. *
  3594. * This function is used for recursive loading of stylesheets and
  3595. * returns the stylesheet content with all url() paths corrected.
  3596. */
  3597. function _drupal_load_stylesheet($matches) {
  3598. $filename = $matches[1];
  3599. // Load the imported stylesheet and replace @import commands in there as well.
  3600. $file = drupal_load_stylesheet($filename, NULL, FALSE);
  3601. // Determine the file's directory.
  3602. $directory = dirname($filename);
  3603. // If the file is in the current directory, make sure '.' doesn't appear in
  3604. // the url() path.
  3605. $directory = $directory == '.' ? '' : $directory .'/';
  3606. // Alter all internal url() paths. Leave external paths alone. We don't need
  3607. // to normalize absolute paths here (i.e. remove folder/... segments) because
  3608. // that will be done later.
  3609. return preg_replace('/url\(\s*([\'"]?)(?![a-z]+:|\/+)([^\'")]+)([\'"]?)\s*\)/i', 'url(\1' . $directory . '\2\3)', $file);
  3610. }
  3611. /**
  3612. * Deletes old cached CSS files.
  3613. */
  3614. function drupal_clear_css_cache() {
  3615. variable_del('drupal_css_cache_files');
  3616. file_scan_directory('public://css', '/.*/', array('callback' => 'drupal_delete_file_if_stale'));
  3617. }
  3618. /**
  3619. * Callback to delete files modified more than a set time ago.
  3620. */
  3621. function drupal_delete_file_if_stale($uri) {
  3622. // Default stale file threshold is 30 days.
  3623. if (REQUEST_TIME - filemtime($uri) > variable_get('drupal_stale_file_threshold', 2592000)) {
  3624. file_unmanaged_delete($uri);
  3625. }
  3626. }
  3627. /**
  3628. * Prepares a string for use as a CSS identifier (element, class, or ID name).
  3629. *
  3630. * http://www.w3.org/TR/CSS21/syndata.html#characters shows the syntax for valid
  3631. * CSS identifiers (including element names, classes, and IDs in selectors.)
  3632. *
  3633. * @param $identifier
  3634. * The identifier to clean.
  3635. * @param $filter
  3636. * An array of string replacements to use on the identifier.
  3637. *
  3638. * @return
  3639. * The cleaned identifier.
  3640. */
  3641. function drupal_clean_css_identifier($identifier, $filter = array(' ' => '-', '_' => '-', '/' => '-', '[' => '-', ']' => '')) {
  3642. // Use the advanced drupal_static() pattern, since this is called very often.
  3643. static $drupal_static_fast;
  3644. if (!isset($drupal_static_fast)) {
  3645. $drupal_static_fast['allow_css_double_underscores'] = &drupal_static(__FUNCTION__ . ':allow_css_double_underscores');
  3646. }
  3647. $allow_css_double_underscores = &$drupal_static_fast['allow_css_double_underscores'];
  3648. if (!isset($allow_css_double_underscores)) {
  3649. $allow_css_double_underscores = variable_get('allow_css_double_underscores', FALSE);
  3650. }
  3651. // Preserve BEM-style double-underscores depending on custom setting.
  3652. if ($allow_css_double_underscores) {
  3653. $filter['__'] = '__';
  3654. }
  3655. // By default, we filter using Drupal's coding standards.
  3656. $identifier = strtr($identifier, $filter);
  3657. // Valid characters in a CSS identifier are:
  3658. // - the hyphen (U+002D)
  3659. // - a-z (U+0030 - U+0039)
  3660. // - A-Z (U+0041 - U+005A)
  3661. // - the underscore (U+005F)
  3662. // - 0-9 (U+0061 - U+007A)
  3663. // - ISO 10646 characters U+00A1 and higher
  3664. // We strip out any character not in the above list.
  3665. $identifier = preg_replace('/[^\x{002D}\x{0030}-\x{0039}\x{0041}-\x{005A}\x{005F}\x{0061}-\x{007A}\x{00A1}-\x{FFFF}]/u', '', $identifier);
  3666. return $identifier;
  3667. }
  3668. /**
  3669. * Prepares a string for use as a valid class name.
  3670. *
  3671. * Do not pass one string containing multiple classes as they will be
  3672. * incorrectly concatenated with dashes, i.e. "one two" will become "one-two".
  3673. *
  3674. * @param $class
  3675. * The class name to clean.
  3676. *
  3677. * @return
  3678. * The cleaned class name.
  3679. */
  3680. function drupal_html_class($class) {
  3681. // The output of this function will never change, so this uses a normal
  3682. // static instead of drupal_static().
  3683. static $classes = array();
  3684. if (!isset($classes[$class])) {
  3685. $classes[$class] = drupal_clean_css_identifier(drupal_strtolower($class));
  3686. }
  3687. return $classes[$class];
  3688. }
  3689. /**
  3690. * Prepares a string for use as a valid HTML ID and guarantees uniqueness.
  3691. *
  3692. * This function ensures that each passed HTML ID value only exists once on the
  3693. * page. By tracking the already returned ids, this function enables forms,
  3694. * blocks, and other content to be output multiple times on the same page,
  3695. * without breaking (X)HTML validation.
  3696. *
  3697. * For already existing IDs, a counter is appended to the ID string. Therefore,
  3698. * JavaScript and CSS code should not rely on any value that was generated by
  3699. * this function and instead should rely on manually added CSS classes or
  3700. * similarly reliable constructs.
  3701. *
  3702. * Two consecutive hyphens separate the counter from the original ID. To manage
  3703. * uniqueness across multiple Ajax requests on the same page, Ajax requests
  3704. * POST an array of all IDs currently present on the page, which are used to
  3705. * prime this function's cache upon first invocation.
  3706. *
  3707. * To allow reverse-parsing of IDs submitted via Ajax, any multiple consecutive
  3708. * hyphens in the originally passed $id are replaced with a single hyphen.
  3709. *
  3710. * @param $id
  3711. * The ID to clean.
  3712. *
  3713. * @return
  3714. * The cleaned ID.
  3715. */
  3716. function drupal_html_id($id) {
  3717. // If this is an Ajax request, then content returned by this page request will
  3718. // be merged with content already on the base page. The HTML IDs must be
  3719. // unique for the fully merged content. Therefore, initialize $seen_ids to
  3720. // take into account IDs that are already in use on the base page.
  3721. static $drupal_static_fast;
  3722. if (!isset($drupal_static_fast['seen_ids_init'])) {
  3723. $drupal_static_fast['seen_ids_init'] = &drupal_static(__FUNCTION__ . ':init');
  3724. }
  3725. $seen_ids_init = &$drupal_static_fast['seen_ids_init'];
  3726. if (!isset($seen_ids_init)) {
  3727. // Ideally, Drupal would provide an API to persist state information about
  3728. // prior page requests in the database, and we'd be able to add this
  3729. // function's $seen_ids static variable to that state information in order
  3730. // to have it properly initialized for this page request. However, no such
  3731. // page state API exists, so instead, ajax.js adds all of the in-use HTML
  3732. // IDs to the POST data of Ajax submissions. Direct use of $_POST is
  3733. // normally not recommended as it could open up security risks, but because
  3734. // the raw POST data is cast to a number before being returned by this
  3735. // function, this usage is safe.
  3736. if (empty($_POST['ajax_html_ids'])) {
  3737. $seen_ids_init = array();
  3738. }
  3739. else {
  3740. // This function ensures uniqueness by appending a counter to the base id
  3741. // requested by the calling function after the first occurrence of that
  3742. // requested id. $_POST['ajax_html_ids'] contains the ids as they were
  3743. // returned by this function, potentially with the appended counter, so
  3744. // we parse that to reconstruct the $seen_ids array.
  3745. if (isset($_POST['ajax_html_ids'][0]) && strpos($_POST['ajax_html_ids'][0], ',') === FALSE) {
  3746. $ajax_html_ids = $_POST['ajax_html_ids'];
  3747. }
  3748. else {
  3749. // jquery.form.js may send the server a comma-separated string as the
  3750. // first element of an array (see http://drupal.org/node/1575060), so
  3751. // we need to convert it to an array in that case.
  3752. $ajax_html_ids = explode(',', $_POST['ajax_html_ids'][0]);
  3753. }
  3754. foreach ($ajax_html_ids as $seen_id) {
  3755. // We rely on '--' being used solely for separating a base id from the
  3756. // counter, which this function ensures when returning an id.
  3757. $parts = explode('--', $seen_id, 2);
  3758. if (!empty($parts[1]) && is_numeric($parts[1])) {
  3759. list($seen_id, $i) = $parts;
  3760. }
  3761. else {
  3762. $i = 1;
  3763. }
  3764. if (!isset($seen_ids_init[$seen_id]) || ($i > $seen_ids_init[$seen_id])) {
  3765. $seen_ids_init[$seen_id] = $i;
  3766. }
  3767. }
  3768. }
  3769. }
  3770. if (!isset($drupal_static_fast['seen_ids'])) {
  3771. $drupal_static_fast['seen_ids'] = &drupal_static(__FUNCTION__, $seen_ids_init);
  3772. }
  3773. $seen_ids = &$drupal_static_fast['seen_ids'];
  3774. $id = strtr(drupal_strtolower($id), array(' ' => '-', '_' => '-', '[' => '-', ']' => ''));
  3775. // As defined in http://www.w3.org/TR/html4/types.html#type-name, HTML IDs can
  3776. // only contain letters, digits ([0-9]), hyphens ("-"), underscores ("_"),
  3777. // colons (":"), and periods ("."). We strip out any character not in that
  3778. // list. Note that the CSS spec doesn't allow colons or periods in identifiers
  3779. // (http://www.w3.org/TR/CSS21/syndata.html#characters), so we strip those two
  3780. // characters as well.
  3781. $id = preg_replace('/[^A-Za-z0-9\-_]/', '', $id);
  3782. // Removing multiple consecutive hyphens.
  3783. $id = preg_replace('/\-+/', '-', $id);
  3784. // Ensure IDs are unique by appending a counter after the first occurrence.
  3785. // The counter needs to be appended with a delimiter that does not exist in
  3786. // the base ID. Requiring a unique delimiter helps ensure that we really do
  3787. // return unique IDs and also helps us re-create the $seen_ids array during
  3788. // Ajax requests.
  3789. if (isset($seen_ids[$id])) {
  3790. $id = $id . '--' . ++$seen_ids[$id];
  3791. }
  3792. else {
  3793. $seen_ids[$id] = 1;
  3794. }
  3795. return $id;
  3796. }
  3797. /**
  3798. * Provides a standard HTML class name that identifies a page region.
  3799. *
  3800. * It is recommended that template preprocess functions apply this class to any
  3801. * page region that is output by the theme (Drupal core already handles this in
  3802. * the standard template preprocess implementation). Standardizing the class
  3803. * names in this way allows modules to implement certain features, such as
  3804. * drag-and-drop or dynamic Ajax loading, in a theme-independent way.
  3805. *
  3806. * @param $region
  3807. * The name of the page region (for example, 'page_top' or 'content').
  3808. *
  3809. * @return
  3810. * An HTML class that identifies the region (for example, 'region-page-top'
  3811. * or 'region-content').
  3812. *
  3813. * @see template_preprocess_region()
  3814. */
  3815. function drupal_region_class($region) {
  3816. return drupal_html_class("region-$region");
  3817. }
  3818. /**
  3819. * Adds a JavaScript file, setting, or inline code to the page.
  3820. *
  3821. * The behavior of this function depends on the parameters it is called with.
  3822. * Generally, it handles the addition of JavaScript to the page, either as
  3823. * reference to an existing file or as inline code. The following actions can be
  3824. * performed using this function:
  3825. * - Add a file ('file'): Adds a reference to a JavaScript file to the page.
  3826. * - Add inline JavaScript code ('inline'): Executes a piece of JavaScript code
  3827. * on the current page by placing the code directly in the page (for example,
  3828. * to tell the user that a new message arrived, by opening a pop up, alert
  3829. * box, etc.). This should only be used for JavaScript that cannot be executed
  3830. * from a file. When adding inline code, make sure that you are not relying on
  3831. * $() being the jQuery function. Wrap your code in
  3832. * @code (function ($) {... })(jQuery); @endcode
  3833. * or use jQuery() instead of $().
  3834. * - Add external JavaScript ('external'): Allows the inclusion of external
  3835. * JavaScript files that are not hosted on the local server. Note that these
  3836. * external JavaScript references do not get aggregated when preprocessing is
  3837. * on.
  3838. * - Add settings ('setting'): Adds settings to Drupal's global storage of
  3839. * JavaScript settings. Per-page settings are required by some modules to
  3840. * function properly. All settings will be accessible at Drupal.settings.
  3841. *
  3842. * Examples:
  3843. * @code
  3844. * drupal_add_js('misc/collapse.js');
  3845. * drupal_add_js('misc/collapse.js', 'file');
  3846. * drupal_add_js('jQuery(document).ready(function () { alert("Hello!"); });', 'inline');
  3847. * drupal_add_js('jQuery(document).ready(function () { alert("Hello!"); });',
  3848. * array('type' => 'inline', 'scope' => 'footer', 'weight' => 5)
  3849. * );
  3850. * drupal_add_js('http://example.com/example.js', 'external');
  3851. * drupal_add_js(array('myModule' => array('key' => 'value')), 'setting');
  3852. * @endcode
  3853. *
  3854. * Calling drupal_static_reset('drupal_add_js') will clear all JavaScript added
  3855. * so far.
  3856. *
  3857. * If JavaScript aggregation is enabled, all JavaScript files added with
  3858. * $options['preprocess'] set to TRUE will be merged into one aggregate file.
  3859. * Preprocessed inline JavaScript will not be aggregated into this single file.
  3860. * Externally hosted JavaScripts are never aggregated.
  3861. *
  3862. * The reason for aggregating the files is outlined quite thoroughly here:
  3863. * http://www.die.net/musings/page_load_time/ "Load fewer external objects. Due
  3864. * to request overhead, one bigger file just loads faster than two smaller ones
  3865. * half its size."
  3866. *
  3867. * $options['preprocess'] should be only set to TRUE when a file is required for
  3868. * all typical visitors and most pages of a site. It is critical that all
  3869. * preprocessed files are added unconditionally on every page, even if the
  3870. * files are not needed on a page. This is normally done by calling
  3871. * drupal_add_js() in a hook_init() implementation.
  3872. *
  3873. * Non-preprocessed files should only be added to the page when they are
  3874. * actually needed.
  3875. *
  3876. * @param $data
  3877. * (optional) If given, the value depends on the $options parameter, or
  3878. * $options['type'] if $options is passed as an associative array:
  3879. * - 'file': Path to the file relative to base_path().
  3880. * - 'inline': The JavaScript code that should be placed in the given scope.
  3881. * - 'external': The absolute path to an external JavaScript file that is not
  3882. * hosted on the local server. These files will not be aggregated if
  3883. * JavaScript aggregation is enabled.
  3884. * - 'setting': An associative array with configuration options. The array is
  3885. * merged directly into Drupal.settings. All modules should wrap their
  3886. * actual configuration settings in another variable to prevent conflicts in
  3887. * the Drupal.settings namespace. Items added with a string key will replace
  3888. * existing settings with that key; items with numeric array keys will be
  3889. * added to the existing settings array.
  3890. * @param $options
  3891. * (optional) A string defining the type of JavaScript that is being added in
  3892. * the $data parameter ('file'/'setting'/'inline'/'external'), or an
  3893. * associative array. JavaScript settings should always pass the string
  3894. * 'setting' only. Other types can have the following elements in the array:
  3895. * - type: The type of JavaScript that is to be added to the page. Allowed
  3896. * values are 'file', 'inline', 'external' or 'setting'. Defaults
  3897. * to 'file'.
  3898. * - scope: The location in which you want to place the script. Possible
  3899. * values are 'header' or 'footer'. If your theme implements different
  3900. * regions, you can also use these. Defaults to 'header'.
  3901. * - group: A number identifying the group in which to add the JavaScript.
  3902. * Available constants are:
  3903. * - JS_LIBRARY: Any libraries, settings, or jQuery plugins.
  3904. * - JS_DEFAULT: Any module-layer JavaScript.
  3905. * - JS_THEME: Any theme-layer JavaScript.
  3906. * The group number serves as a weight: JavaScript within a lower weight
  3907. * group is presented on the page before JavaScript within a higher weight
  3908. * group.
  3909. * - every_page: For optimal front-end performance when aggregation is
  3910. * enabled, this should be set to TRUE if the JavaScript is present on every
  3911. * page of the website for users for whom it is present at all. This
  3912. * defaults to FALSE. It is set to TRUE for JavaScript files that are added
  3913. * via module and theme .info files. Modules that add JavaScript within
  3914. * hook_init() implementations, or from other code that ensures that the
  3915. * JavaScript is added to all website pages, should also set this flag to
  3916. * TRUE. All JavaScript files within the same group and that have the
  3917. * 'every_page' flag set to TRUE and do not have 'preprocess' set to FALSE
  3918. * are aggregated together into a single aggregate file, and that aggregate
  3919. * file can be reused across a user's entire site visit, leading to faster
  3920. * navigation between pages. However, JavaScript that is only needed on
  3921. * pages less frequently visited, can be added by code that only runs for
  3922. * those particular pages, and that code should not set the 'every_page'
  3923. * flag. This minimizes the size of the aggregate file that the user needs
  3924. * to download when first visiting the website. JavaScript without the
  3925. * 'every_page' flag is aggregated into a separate aggregate file. This
  3926. * other aggregate file is likely to change from page to page, and each new
  3927. * aggregate file needs to be downloaded when first encountered, so it
  3928. * should be kept relatively small by ensuring that most commonly needed
  3929. * JavaScript is added to every page.
  3930. * - weight: A number defining the order in which the JavaScript is added to
  3931. * the page relative to other JavaScript with the same 'scope', 'group',
  3932. * and 'every_page' value. In some cases, the order in which the JavaScript
  3933. * is presented on the page is very important. jQuery, for example, must be
  3934. * added to the page before any jQuery code is run, so jquery.js uses the
  3935. * JS_LIBRARY group and a weight of -20, jquery.once.js (a library drupal.js
  3936. * depends on) uses the JS_LIBRARY group and a weight of -19, drupal.js uses
  3937. * the JS_LIBRARY group and a weight of -1, other libraries use the
  3938. * JS_LIBRARY group and a weight of 0 or higher, and all other scripts use
  3939. * one of the other group constants. The exact ordering of JavaScript is as
  3940. * follows:
  3941. * - First by scope, with 'header' first, 'footer' last, and any other
  3942. * scopes provided by a custom theme coming in between, as determined by
  3943. * the theme.
  3944. * - Then by group.
  3945. * - Then by the 'every_page' flag, with TRUE coming before FALSE.
  3946. * - Then by weight.
  3947. * - Then by the order in which the JavaScript was added. For example, all
  3948. * else being the same, JavaScript added by a call to drupal_add_js() that
  3949. * happened later in the page request gets added to the page after one for
  3950. * which drupal_add_js() happened earlier in the page request.
  3951. * - requires_jquery: Set this to FALSE if the JavaScript you are adding does
  3952. * not have a dependency on jQuery. Defaults to TRUE, except for JavaScript
  3953. * settings where it defaults to FALSE. This is used on sites that have the
  3954. * 'javascript_always_use_jquery' variable set to FALSE; on those sites, if
  3955. * all the JavaScript added to the page by drupal_add_js() does not have a
  3956. * dependency on jQuery, then for improved front-end performance Drupal
  3957. * will not add jQuery and related libraries and settings to the page.
  3958. * - defer: If set to TRUE, the defer attribute is set on the <script>
  3959. * tag. Defaults to FALSE.
  3960. * - cache: If set to FALSE, the JavaScript file is loaded anew on every page
  3961. * call; in other words, it is not cached. Used only when 'type' references
  3962. * a JavaScript file. Defaults to TRUE.
  3963. * - preprocess: If TRUE and JavaScript aggregation is enabled, the script
  3964. * file will be aggregated. Defaults to TRUE.
  3965. *
  3966. * @return
  3967. * The current array of JavaScript files, settings, and in-line code,
  3968. * including Drupal defaults, anything previously added with calls to
  3969. * drupal_add_js(), and this function call's additions.
  3970. *
  3971. * @see drupal_get_js()
  3972. */
  3973. function drupal_add_js($data = NULL, $options = NULL) {
  3974. $javascript = &drupal_static(__FUNCTION__, array());
  3975. $jquery_added = &drupal_static(__FUNCTION__ . ':jquery_added', FALSE);
  3976. // If the $javascript variable has been reset with drupal_static_reset(),
  3977. // jQuery and related files will have been removed from the list, so set the
  3978. // variable back to FALSE to indicate they have not yet been added.
  3979. if (empty($javascript)) {
  3980. $jquery_added = FALSE;
  3981. }
  3982. // Construct the options, taking the defaults into consideration.
  3983. if (isset($options)) {
  3984. if (!is_array($options)) {
  3985. $options = array('type' => $options);
  3986. }
  3987. }
  3988. else {
  3989. $options = array();
  3990. }
  3991. if (isset($options['type']) && $options['type'] == 'setting') {
  3992. $options += array('requires_jquery' => FALSE);
  3993. }
  3994. $options += drupal_js_defaults($data);
  3995. // Preprocess can only be set if caching is enabled.
  3996. $options['preprocess'] = $options['cache'] ? $options['preprocess'] : FALSE;
  3997. // Tweak the weight so that files of the same weight are included in the
  3998. // order of the calls to drupal_add_js().
  3999. $options['weight'] += count($javascript) / 1000;
  4000. if (isset($data)) {
  4001. // Add jquery.js, drupal.js, and related files and settings if they have
  4002. // not been added yet. However, if the 'javascript_always_use_jquery'
  4003. // variable is set to FALSE (indicating that the site does not want jQuery
  4004. // automatically added on all pages) then only add it if a file or setting
  4005. // that requires jQuery is being added also.
  4006. if (!$jquery_added && (variable_get('javascript_always_use_jquery', TRUE) || $options['requires_jquery'])) {
  4007. $jquery_added = TRUE;
  4008. // url() generates the prefix using hook_url_outbound_alter(). Instead of
  4009. // running the hook_url_outbound_alter() again here, extract the prefix
  4010. // from url().
  4011. url('', array('prefix' => &$prefix));
  4012. $default_javascript = array(
  4013. 'settings' => array(
  4014. 'data' => array(
  4015. array('basePath' => base_path()),
  4016. array('pathPrefix' => empty($prefix) ? '' : $prefix),
  4017. ),
  4018. 'type' => 'setting',
  4019. 'scope' => 'header',
  4020. 'group' => JS_LIBRARY,
  4021. 'every_page' => TRUE,
  4022. 'weight' => 0,
  4023. ),
  4024. 'misc/drupal.js' => array(
  4025. 'data' => 'misc/drupal.js',
  4026. 'type' => 'file',
  4027. 'scope' => 'header',
  4028. 'group' => JS_LIBRARY,
  4029. 'every_page' => TRUE,
  4030. 'weight' => -1,
  4031. 'requires_jquery' => TRUE,
  4032. 'preprocess' => TRUE,
  4033. 'cache' => TRUE,
  4034. 'defer' => FALSE,
  4035. ),
  4036. );
  4037. $javascript = drupal_array_merge_deep($javascript, $default_javascript);
  4038. // Register all required libraries.
  4039. drupal_add_library('system', 'jquery', TRUE);
  4040. drupal_add_library('system', 'jquery.once', TRUE);
  4041. }
  4042. switch ($options['type']) {
  4043. case 'setting':
  4044. // All JavaScript settings are placed in the header of the page with
  4045. // the library weight so that inline scripts appear afterwards.
  4046. $javascript['settings']['data'][] = $data;
  4047. break;
  4048. case 'inline':
  4049. $javascript[] = $options;
  4050. break;
  4051. default: // 'file' and 'external'
  4052. // Local and external files must keep their name as the associative key
  4053. // so the same JavaScript file is not added twice.
  4054. $javascript[$options['data']] = $options;
  4055. }
  4056. }
  4057. return $javascript;
  4058. }
  4059. /**
  4060. * Constructs an array of the defaults that are used for JavaScript items.
  4061. *
  4062. * @param $data
  4063. * (optional) The default data parameter for the JavaScript item array.
  4064. *
  4065. * @see drupal_get_js()
  4066. * @see drupal_add_js()
  4067. */
  4068. function drupal_js_defaults($data = NULL) {
  4069. return array(
  4070. 'type' => 'file',
  4071. 'group' => JS_DEFAULT,
  4072. 'every_page' => FALSE,
  4073. 'weight' => 0,
  4074. 'requires_jquery' => TRUE,
  4075. 'scope' => 'header',
  4076. 'cache' => TRUE,
  4077. 'defer' => FALSE,
  4078. 'preprocess' => TRUE,
  4079. 'version' => NULL,
  4080. 'data' => $data,
  4081. );
  4082. }
  4083. /**
  4084. * Returns a themed presentation of all JavaScript code for the current page.
  4085. *
  4086. * References to JavaScript files are placed in a certain order: first, all
  4087. * 'core' files, then all 'module' and finally all 'theme' JavaScript files
  4088. * are added to the page. Then, all settings are output, followed by 'inline'
  4089. * JavaScript code. If running update.php, all preprocessing is disabled.
  4090. *
  4091. * Note that hook_js_alter(&$javascript) is called during this function call
  4092. * to allow alterations of the JavaScript during its presentation. Calls to
  4093. * drupal_add_js() from hook_js_alter() will not be added to the output
  4094. * presentation. The correct way to add JavaScript during hook_js_alter()
  4095. * is to add another element to the $javascript array, deriving from
  4096. * drupal_js_defaults(). See locale_js_alter() for an example of this.
  4097. *
  4098. * @param $scope
  4099. * (optional) The scope for which the JavaScript rules should be returned.
  4100. * Defaults to 'header'.
  4101. * @param $javascript
  4102. * (optional) An array with all JavaScript code. Defaults to the default
  4103. * JavaScript array for the given scope.
  4104. * @param $skip_alter
  4105. * (optional) If set to TRUE, this function skips calling drupal_alter() on
  4106. * $javascript, useful when the calling function passes a $javascript array
  4107. * that has already been altered.
  4108. *
  4109. * @return
  4110. * All JavaScript code segments and includes for the scope as HTML tags.
  4111. *
  4112. * @see drupal_add_js()
  4113. * @see locale_js_alter()
  4114. * @see drupal_js_defaults()
  4115. */
  4116. function drupal_get_js($scope = 'header', $javascript = NULL, $skip_alter = FALSE) {
  4117. if (!isset($javascript)) {
  4118. $javascript = drupal_add_js();
  4119. }
  4120. // If no JavaScript items have been added, or if the only JavaScript items
  4121. // that have been added are JavaScript settings (which don't do anything
  4122. // without any JavaScript code to use them), then no JavaScript code should
  4123. // be added to the page.
  4124. if (empty($javascript) || (isset($javascript['settings']) && count($javascript) == 1)) {
  4125. return '';
  4126. }
  4127. // Allow modules to alter the JavaScript.
  4128. if (!$skip_alter) {
  4129. drupal_alter('js', $javascript);
  4130. }
  4131. // Filter out elements of the given scope.
  4132. $items = array();
  4133. foreach ($javascript as $key => $item) {
  4134. if ($item['scope'] == $scope) {
  4135. $items[$key] = $item;
  4136. }
  4137. }
  4138. // Sort the JavaScript so that it appears in the correct order.
  4139. uasort($items, 'drupal_sort_css_js');
  4140. // Provide the page with information about the individual JavaScript files
  4141. // used, information not otherwise available when aggregation is enabled.
  4142. $setting['ajaxPageState']['js'] = array_fill_keys(array_keys($items), 1);
  4143. unset($setting['ajaxPageState']['js']['settings']);
  4144. drupal_add_js($setting, 'setting');
  4145. // If we're outputting the header scope, then this might be the final time
  4146. // that drupal_get_js() is running, so add the setting to this output as well
  4147. // as to the drupal_add_js() cache. If $items['settings'] doesn't exist, it's
  4148. // because drupal_get_js() was intentionally passed a $javascript argument
  4149. // stripped off settings, potentially in order to override how settings get
  4150. // output, so in this case, do not add the setting to this output.
  4151. if ($scope == 'header' && isset($items['settings'])) {
  4152. $items['settings']['data'][] = $setting;
  4153. }
  4154. $elements = array(
  4155. '#type' => 'scripts',
  4156. '#items' => $items,
  4157. );
  4158. return drupal_render($elements);
  4159. }
  4160. /**
  4161. * The #pre_render callback for the "scripts" element.
  4162. *
  4163. * This callback adds elements needed for <script> tags to be rendered.
  4164. *
  4165. * @param array $elements
  4166. * A render array containing:
  4167. * - '#items': The JS items as returned by drupal_add_js() and altered by
  4168. * drupal_get_js().
  4169. *
  4170. * @return array
  4171. * The $elements variable passed as argument with two more children keys:
  4172. * - "scripts": contains the Javascript items
  4173. * - "settings": contains the Javascript settings items.
  4174. * If those keys are already existing, then the items will be appended and
  4175. * their keys will be preserved.
  4176. *
  4177. * @see drupal_get_js()
  4178. * @see drupal_add_js()
  4179. */
  4180. function drupal_pre_render_scripts(array $elements) {
  4181. $preprocess_js = (variable_get('preprocess_js', FALSE) && (!defined('MAINTENANCE_MODE') || MAINTENANCE_MODE != 'update'));
  4182. // A dummy query-string is added to filenames, to gain control over
  4183. // browser-caching. The string changes on every update or full cache
  4184. // flush, forcing browsers to load a new copy of the files, as the
  4185. // URL changed. Files that should not be cached (see drupal_add_js())
  4186. // get REQUEST_TIME as query-string instead, to enforce reload on every
  4187. // page request.
  4188. $default_query_string = variable_get('css_js_query_string', '0');
  4189. // For inline JavaScript to validate as XHTML, all JavaScript containing
  4190. // XHTML needs to be wrapped in CDATA. To make that backwards compatible
  4191. // with HTML 4, we need to comment out the CDATA-tag.
  4192. $embed_prefix = "\n<!--//--><![CDATA[//><!--\n";
  4193. $embed_suffix = "\n//--><!]]>\n";
  4194. // Since JavaScript may look for arguments in the URL and act on them, some
  4195. // third-party code might require the use of a different query string.
  4196. $js_version_string = variable_get('drupal_js_version_query_string', 'v=');
  4197. $files = array();
  4198. $scripts = isset($elements['scripts']) ? $elements['scripts'] : array();
  4199. $scripts += array('#weight' => 0);
  4200. $settings = isset($elements['settings']) ? $elements['settings'] : array();
  4201. $settings += array('#weight' => $scripts['#weight'] + 10);
  4202. // The index counter is used to keep aggregated and non-aggregated files in
  4203. // order by weight. Use existing scripts count as a starting point.
  4204. $index = count(element_children($scripts)) + 1;
  4205. // Loop through the JavaScript to construct the rendered output.
  4206. $element = array(
  4207. '#type' => 'html_tag',
  4208. '#tag' => 'script',
  4209. '#value' => '',
  4210. '#attributes' => array(
  4211. 'type' => 'text/javascript',
  4212. ),
  4213. );
  4214. foreach ($elements['#items'] as $item) {
  4215. $query_string = empty($item['version']) ? $default_query_string : $js_version_string . $item['version'];
  4216. switch ($item['type']) {
  4217. case 'setting':
  4218. $js_element = $element;
  4219. $js_element['#value_prefix'] = $embed_prefix;
  4220. $js_element['#value'] = 'jQuery.extend(Drupal.settings, ' . drupal_json_encode(drupal_array_merge_deep_array($item['data'])) . ");";
  4221. $js_element['#value_suffix'] = $embed_suffix;
  4222. $settings[] = $js_element;
  4223. break;
  4224. case 'inline':
  4225. $js_element = $element;
  4226. if ($item['defer']) {
  4227. $js_element['#attributes']['defer'] = 'defer';
  4228. }
  4229. $js_element['#value_prefix'] = $embed_prefix;
  4230. $js_element['#value'] = $item['data'];
  4231. $js_element['#value_suffix'] = $embed_suffix;
  4232. $scripts[$index++] = $js_element;
  4233. break;
  4234. case 'file':
  4235. $js_element = $element;
  4236. if (!$item['preprocess'] || !$preprocess_js) {
  4237. if ($item['defer']) {
  4238. $js_element['#attributes']['defer'] = 'defer';
  4239. }
  4240. $query_string_separator = (strpos($item['data'], '?') !== FALSE) ? '&' : '?';
  4241. $js_element['#attributes']['src'] = file_create_url($item['data']) . $query_string_separator . ($item['cache'] ? $query_string : REQUEST_TIME);
  4242. $scripts[$index++] = $js_element;
  4243. }
  4244. else {
  4245. // By increasing the index for each aggregated file, we maintain
  4246. // the relative ordering of JS by weight. We also set the key such
  4247. // that groups are split by items sharing the same 'group' value and
  4248. // 'every_page' flag. While this potentially results in more aggregate
  4249. // files, it helps make each one more reusable across a site visit,
  4250. // leading to better front-end performance of a website as a whole.
  4251. // See drupal_add_js() for details.
  4252. $key = 'aggregate_' . $item['group'] . '_' . $item['every_page'] . '_' . $index;
  4253. $scripts[$key] = '';
  4254. $files[$key][$item['data']] = $item;
  4255. }
  4256. break;
  4257. case 'external':
  4258. $js_element = $element;
  4259. // Preprocessing for external JavaScript files is ignored.
  4260. if ($item['defer']) {
  4261. $js_element['#attributes']['defer'] = 'defer';
  4262. }
  4263. $js_element['#attributes']['src'] = $item['data'];
  4264. $scripts[$index++] = $js_element;
  4265. break;
  4266. }
  4267. }
  4268. // Aggregate any remaining JS files that haven't already been output.
  4269. if ($preprocess_js && count($files) > 0) {
  4270. foreach ($files as $key => $file_set) {
  4271. $uri = drupal_build_js_cache($file_set);
  4272. // Only include the file if was written successfully. Errors are logged
  4273. // using watchdog.
  4274. if ($uri) {
  4275. $preprocess_file = file_create_url($uri);
  4276. $js_element = $element;
  4277. $js_element['#attributes']['src'] = $preprocess_file;
  4278. $scripts[$key] = $js_element;
  4279. }
  4280. }
  4281. }
  4282. // Keep the order of JS files consistent as some are preprocessed and others
  4283. // are not. Make sure any inline or JS setting variables appear last after
  4284. // libraries have loaded.
  4285. $element['scripts'] = $scripts;
  4286. $element['settings'] = $settings;
  4287. return $element;
  4288. }
  4289. /**
  4290. * Adds attachments to a render() structure.
  4291. *
  4292. * Libraries, JavaScript, CSS and other types of custom structures are attached
  4293. * to elements using the #attached property. The #attached property is an
  4294. * associative array, where the keys are the attachment types and the values are
  4295. * the attached data. For example:
  4296. * @code
  4297. * $build['#attached'] = array(
  4298. * 'js' => array(drupal_get_path('module', 'taxonomy') . '/taxonomy.js'),
  4299. * 'css' => array(drupal_get_path('module', 'taxonomy') . '/taxonomy.css'),
  4300. * );
  4301. * @endcode
  4302. *
  4303. * 'js', 'css', and 'library' are types that get special handling. For any
  4304. * other kind of attached data, the array key must be the full name of the
  4305. * callback function and each value an array of arguments. For example:
  4306. * @code
  4307. * $build['#attached']['drupal_add_http_header'] = array(
  4308. * array('Content-Type', 'application/rss+xml; charset=utf-8'),
  4309. * );
  4310. * @endcode
  4311. *
  4312. * External 'js' and 'css' files can also be loaded. For example:
  4313. * @code
  4314. * $build['#attached']['js'] = array(
  4315. * 'http://code.jquery.com/jquery-1.4.2.min.js' => array(
  4316. * 'type' => 'external',
  4317. * ),
  4318. * );
  4319. * @endcode
  4320. *
  4321. * @param $elements
  4322. * The structured array describing the data being rendered.
  4323. * @param $group
  4324. * The default group of JavaScript and CSS being added. This is only applied
  4325. * to the stylesheets and JavaScript items that don't have an explicit group
  4326. * assigned to them.
  4327. * @param $dependency_check
  4328. * When TRUE, will exit if a given library's dependencies are missing. When
  4329. * set to FALSE, will continue to add the libraries, even though one or more
  4330. * dependencies are missing. Defaults to FALSE.
  4331. * @param $every_page
  4332. * Set to TRUE to indicate that the attachments are added to every page on the
  4333. * site. Only attachments with the every_page flag set to TRUE can participate
  4334. * in JavaScript/CSS aggregation.
  4335. *
  4336. * @return
  4337. * FALSE if there were any missing library dependencies; TRUE if all library
  4338. * dependencies were met.
  4339. *
  4340. * @see drupal_add_library()
  4341. * @see drupal_add_js()
  4342. * @see drupal_add_css()
  4343. * @see drupal_render()
  4344. */
  4345. function drupal_process_attached($elements, $group = JS_DEFAULT, $dependency_check = FALSE, $every_page = NULL) {
  4346. // Add defaults to the special attached structures that should be processed differently.
  4347. $elements['#attached'] += array(
  4348. 'library' => array(),
  4349. 'js' => array(),
  4350. 'css' => array(),
  4351. );
  4352. // Add the libraries first.
  4353. $success = TRUE;
  4354. foreach ($elements['#attached']['library'] as $library) {
  4355. if (drupal_add_library($library[0], $library[1], $every_page) === FALSE) {
  4356. $success = FALSE;
  4357. // Exit if the dependency is missing.
  4358. if ($dependency_check) {
  4359. return $success;
  4360. }
  4361. }
  4362. }
  4363. unset($elements['#attached']['library']);
  4364. // Add both the JavaScript and the CSS.
  4365. // The parameters for drupal_add_js() and drupal_add_css() require special
  4366. // handling.
  4367. foreach (array('js', 'css') as $type) {
  4368. foreach ($elements['#attached'][$type] as $data => $options) {
  4369. // If the value is not an array, it's a filename and passed as first
  4370. // (and only) argument.
  4371. if (!is_array($options)) {
  4372. $data = $options;
  4373. $options = NULL;
  4374. }
  4375. // In some cases, the first parameter ($data) is an array. Arrays can't be
  4376. // passed as keys in PHP, so we have to get $data from the value array.
  4377. if (is_numeric($data)) {
  4378. $data = $options['data'];
  4379. unset($options['data']);
  4380. }
  4381. // Apply the default group if it isn't explicitly given.
  4382. if (!isset($options['group'])) {
  4383. $options['group'] = $group;
  4384. }
  4385. // Set the every_page flag if one was passed.
  4386. if (isset($every_page)) {
  4387. $options['every_page'] = $every_page;
  4388. }
  4389. call_user_func('drupal_add_' . $type, $data, $options);
  4390. }
  4391. unset($elements['#attached'][$type]);
  4392. }
  4393. // Add additional types of attachments specified in the render() structure.
  4394. // Libraries, JavaScript and CSS have been added already, as they require
  4395. // special handling.
  4396. foreach ($elements['#attached'] as $callback => $options) {
  4397. if (function_exists($callback)) {
  4398. foreach ($elements['#attached'][$callback] as $args) {
  4399. call_user_func_array($callback, $args);
  4400. }
  4401. }
  4402. }
  4403. return $success;
  4404. }
  4405. /**
  4406. * Adds JavaScript to change the state of an element based on another element.
  4407. *
  4408. * A "state" means a certain property on a DOM element, such as "visible" or
  4409. * "checked". A state can be applied to an element, depending on the state of
  4410. * another element on the page. In general, states depend on HTML attributes and
  4411. * DOM element properties, which change due to user interaction.
  4412. *
  4413. * Since states are driven by JavaScript only, it is important to understand
  4414. * that all states are applied on presentation only, none of the states force
  4415. * any server-side logic, and that they will not be applied for site visitors
  4416. * without JavaScript support. All modules implementing states have to make
  4417. * sure that the intended logic also works without JavaScript being enabled.
  4418. *
  4419. * #states is an associative array in the form of:
  4420. * @code
  4421. * array(
  4422. * STATE1 => CONDITIONS_ARRAY1,
  4423. * STATE2 => CONDITIONS_ARRAY2,
  4424. * ...
  4425. * )
  4426. * @endcode
  4427. * Each key is the name of a state to apply to the element, such as 'visible'.
  4428. * Each value is a list of conditions that denote when the state should be
  4429. * applied.
  4430. *
  4431. * Multiple different states may be specified to act on complex conditions:
  4432. * @code
  4433. * array(
  4434. * 'visible' => CONDITIONS,
  4435. * 'checked' => OTHER_CONDITIONS,
  4436. * )
  4437. * @endcode
  4438. *
  4439. * Every condition is a key/value pair, whose key is a jQuery selector that
  4440. * denotes another element on the page, and whose value is an array of
  4441. * conditions, which must bet met on that element:
  4442. * @code
  4443. * array(
  4444. * 'visible' => array(
  4445. * JQUERY_SELECTOR => REMOTE_CONDITIONS,
  4446. * JQUERY_SELECTOR => REMOTE_CONDITIONS,
  4447. * ...
  4448. * ),
  4449. * )
  4450. * @endcode
  4451. * All conditions must be met for the state to be applied.
  4452. *
  4453. * Each remote condition is a key/value pair specifying conditions on the other
  4454. * element that need to be met to apply the state to the element:
  4455. * @code
  4456. * array(
  4457. * 'visible' => array(
  4458. * ':input[name="remote_checkbox"]' => array('checked' => TRUE),
  4459. * ),
  4460. * )
  4461. * @endcode
  4462. *
  4463. * For example, to show a textfield only when a checkbox is checked:
  4464. * @code
  4465. * $form['toggle_me'] = array(
  4466. * '#type' => 'checkbox',
  4467. * '#title' => t('Tick this box to type'),
  4468. * );
  4469. * $form['settings'] = array(
  4470. * '#type' => 'textfield',
  4471. * '#states' => array(
  4472. * // Only show this field when the 'toggle_me' checkbox is enabled.
  4473. * 'visible' => array(
  4474. * ':input[name="toggle_me"]' => array('checked' => TRUE),
  4475. * ),
  4476. * ),
  4477. * );
  4478. * @endcode
  4479. *
  4480. * The following states may be applied to an element:
  4481. * - enabled
  4482. * - disabled
  4483. * - required
  4484. * - optional
  4485. * - visible
  4486. * - invisible
  4487. * - checked
  4488. * - unchecked
  4489. * - expanded
  4490. * - collapsed
  4491. *
  4492. * The following states may be used in remote conditions:
  4493. * - empty
  4494. * - filled
  4495. * - checked
  4496. * - unchecked
  4497. * - expanded
  4498. * - collapsed
  4499. * - value
  4500. *
  4501. * The following states exist for both elements and remote conditions, but are
  4502. * not fully implemented and may not change anything on the element:
  4503. * - relevant
  4504. * - irrelevant
  4505. * - valid
  4506. * - invalid
  4507. * - touched
  4508. * - untouched
  4509. * - readwrite
  4510. * - readonly
  4511. *
  4512. * When referencing select lists and radio buttons in remote conditions, a
  4513. * 'value' condition must be used:
  4514. * @code
  4515. * '#states' => array(
  4516. * // Show the settings if 'bar' has been selected for 'foo'.
  4517. * 'visible' => array(
  4518. * ':input[name="foo"]' => array('value' => 'bar'),
  4519. * ),
  4520. * ),
  4521. * @endcode
  4522. *
  4523. * @param $elements
  4524. * A renderable array element having a #states property as described above.
  4525. *
  4526. * @see form_example_states_form()
  4527. */
  4528. function drupal_process_states(&$elements) {
  4529. $elements['#attached']['library'][] = array('system', 'drupal.states');
  4530. $elements['#attached']['js'][] = array(
  4531. 'type' => 'setting',
  4532. 'data' => array('states' => array('#' . $elements['#id'] => $elements['#states'])),
  4533. );
  4534. }
  4535. /**
  4536. * Adds multiple JavaScript or CSS files at the same time.
  4537. *
  4538. * A library defines a set of JavaScript and/or CSS files, optionally using
  4539. * settings, and optionally requiring another library. For example, a library
  4540. * can be a jQuery plugin, a JavaScript framework, or a CSS framework. This
  4541. * function allows modules to load a library defined/shipped by itself or a
  4542. * depending module, without having to add all files of the library separately.
  4543. * Each library is only loaded once.
  4544. *
  4545. * @param $module
  4546. * The name of the module that registered the library.
  4547. * @param $name
  4548. * The name of the library to add.
  4549. * @param $every_page
  4550. * Set to TRUE if this library is added to every page on the site. Only items
  4551. * with the every_page flag set to TRUE can participate in aggregation.
  4552. *
  4553. * @return
  4554. * TRUE if the library was successfully added; FALSE if the library or one of
  4555. * its dependencies could not be added.
  4556. *
  4557. * @see drupal_get_library()
  4558. * @see hook_library()
  4559. * @see hook_library_alter()
  4560. */
  4561. function drupal_add_library($module, $name, $every_page = NULL) {
  4562. $added = &drupal_static(__FUNCTION__, array());
  4563. // Only process the library if it exists and it was not added already.
  4564. if (!isset($added[$module][$name])) {
  4565. if ($library = drupal_get_library($module, $name)) {
  4566. // Add all components within the library.
  4567. $elements['#attached'] = array(
  4568. 'library' => $library['dependencies'],
  4569. 'js' => $library['js'],
  4570. 'css' => $library['css'],
  4571. );
  4572. $added[$module][$name] = drupal_process_attached($elements, JS_LIBRARY, TRUE, $every_page);
  4573. }
  4574. else {
  4575. // Requested library does not exist.
  4576. $added[$module][$name] = FALSE;
  4577. }
  4578. }
  4579. return $added[$module][$name];
  4580. }
  4581. /**
  4582. * Retrieves information for a JavaScript/CSS library.
  4583. *
  4584. * Library information is statically cached. Libraries are keyed by module for
  4585. * several reasons:
  4586. * - Libraries are not unique. Multiple modules might ship with the same library
  4587. * in a different version or variant. This registry cannot (and does not
  4588. * attempt to) prevent library conflicts.
  4589. * - Modules implementing and thereby depending on a library that is registered
  4590. * by another module can only rely on that module's library.
  4591. * - Two (or more) modules can still register the same library and use it
  4592. * without conflicts in case the libraries are loaded on certain pages only.
  4593. *
  4594. * @param $module
  4595. * The name of a module that registered a library.
  4596. * @param $name
  4597. * (optional) The name of a registered library to retrieve. By default, all
  4598. * libraries registered by $module are returned.
  4599. *
  4600. * @return
  4601. * The definition of the requested library, if $name was passed and it exists,
  4602. * or FALSE if it does not exist. If no $name was passed, an associative array
  4603. * of libraries registered by $module is returned (which may be empty).
  4604. *
  4605. * @see drupal_add_library()
  4606. * @see hook_library()
  4607. * @see hook_library_alter()
  4608. *
  4609. * @todo The purpose of drupal_get_*() is completely different to other page
  4610. * requisite API functions; find and use a different name.
  4611. */
  4612. function drupal_get_library($module, $name = NULL) {
  4613. $libraries = &drupal_static(__FUNCTION__, array());
  4614. if (!isset($libraries[$module])) {
  4615. // Retrieve all libraries associated with the module.
  4616. $module_libraries = module_invoke($module, 'library');
  4617. if (empty($module_libraries)) {
  4618. $module_libraries = array();
  4619. }
  4620. // Allow modules to alter the module's registered libraries.
  4621. drupal_alter('library', $module_libraries, $module);
  4622. foreach ($module_libraries as $key => $data) {
  4623. if (is_array($data)) {
  4624. // Add default elements to allow for easier processing.
  4625. $module_libraries[$key] += array('dependencies' => array(), 'js' => array(), 'css' => array());
  4626. foreach ($module_libraries[$key]['js'] as $file => $options) {
  4627. $module_libraries[$key]['js'][$file]['version'] = $module_libraries[$key]['version'];
  4628. }
  4629. }
  4630. }
  4631. $libraries[$module] = $module_libraries;
  4632. }
  4633. if (isset($name)) {
  4634. if (!isset($libraries[$module][$name])) {
  4635. $libraries[$module][$name] = FALSE;
  4636. }
  4637. return $libraries[$module][$name];
  4638. }
  4639. return $libraries[$module];
  4640. }
  4641. /**
  4642. * Assists in adding the tableDrag JavaScript behavior to a themed table.
  4643. *
  4644. * Draggable tables should be used wherever an outline or list of sortable items
  4645. * needs to be arranged by an end-user. Draggable tables are very flexible and
  4646. * can manipulate the value of form elements placed within individual columns.
  4647. *
  4648. * To set up a table to use drag and drop in place of weight select-lists or in
  4649. * place of a form that contains parent relationships, the form must be themed
  4650. * into a table. The table must have an ID attribute set. If using
  4651. * theme_table(), the ID may be set as follows:
  4652. * @code
  4653. * $output = theme('table', array('header' => $header, 'rows' => $rows, 'attributes' => array('id' => 'my-module-table')));
  4654. * return $output;
  4655. * @endcode
  4656. *
  4657. * In the theme function for the form, a special class must be added to each
  4658. * form element within the same column, "grouping" them together.
  4659. *
  4660. * In a situation where a single weight column is being sorted in the table, the
  4661. * classes could be added like this (in the theme function):
  4662. * @code
  4663. * $form['my_elements'][$delta]['weight']['#attributes']['class'] = array('my-elements-weight');
  4664. * @endcode
  4665. *
  4666. * Each row of the table must also have a class of "draggable" in order to
  4667. * enable the drag handles:
  4668. * @code
  4669. * $row = array(...);
  4670. * $rows[] = array(
  4671. * 'data' => $row,
  4672. * 'class' => array('draggable'),
  4673. * );
  4674. * @endcode
  4675. *
  4676. * When tree relationships are present, the two additional classes
  4677. * 'tabledrag-leaf' and 'tabledrag-root' can be used to refine the behavior:
  4678. * - Rows with the 'tabledrag-leaf' class cannot have child rows.
  4679. * - Rows with the 'tabledrag-root' class cannot be nested under a parent row.
  4680. *
  4681. * Calling drupal_add_tabledrag() would then be written as such:
  4682. * @code
  4683. * drupal_add_tabledrag('my-module-table', 'order', 'sibling', 'my-elements-weight');
  4684. * @endcode
  4685. *
  4686. * In a more complex case where there are several groups in one column (such as
  4687. * the block regions on the admin/structure/block page), a separate subgroup
  4688. * class must also be added to differentiate the groups.
  4689. * @code
  4690. * $form['my_elements'][$region][$delta]['weight']['#attributes']['class'] = array('my-elements-weight', 'my-elements-weight-' . $region);
  4691. * @endcode
  4692. *
  4693. * $group is still 'my-element-weight', and the additional $subgroup variable
  4694. * will be passed in as 'my-elements-weight-' . $region. This also means that
  4695. * you'll need to call drupal_add_tabledrag() once for every region added.
  4696. *
  4697. * @code
  4698. * foreach ($regions as $region) {
  4699. * drupal_add_tabledrag('my-module-table', 'order', 'sibling', 'my-elements-weight', 'my-elements-weight-' . $region);
  4700. * }
  4701. * @endcode
  4702. *
  4703. * In a situation where tree relationships are present, adding multiple
  4704. * subgroups is not necessary, because the table will contain indentations that
  4705. * provide enough information about the sibling and parent relationships. See
  4706. * theme_menu_overview_form() for an example creating a table containing parent
  4707. * relationships.
  4708. *
  4709. * Note that this function should be called from the theme layer, such as in a
  4710. * .tpl.php file, theme_ function, or in a template_preprocess function, not in
  4711. * a form declaration. Though the same JavaScript could be added to the page
  4712. * using drupal_add_js() directly, this function helps keep template files
  4713. * clean and readable. It also prevents tabledrag.js from being added twice
  4714. * accidentally.
  4715. *
  4716. * @param $table_id
  4717. * String containing the target table's id attribute. If the table does not
  4718. * have an id, one will need to be set, such as <table id="my-module-table">.
  4719. * @param $action
  4720. * String describing the action to be done on the form item. Either 'match'
  4721. * 'depth', or 'order'. Match is typically used for parent relationships.
  4722. * Order is typically used to set weights on other form elements with the same
  4723. * group. Depth updates the target element with the current indentation.
  4724. * @param $relationship
  4725. * String describing where the $action variable should be performed. Either
  4726. * 'parent', 'sibling', 'group', or 'self'. Parent will only look for fields
  4727. * up the tree. Sibling will look for fields in the same group in rows above
  4728. * and below it. Self affects the dragged row itself. Group affects the
  4729. * dragged row, plus any children below it (the entire dragged group).
  4730. * @param $group
  4731. * A class name applied on all related form elements for this action.
  4732. * @param $subgroup
  4733. * (optional) If the group has several subgroups within it, this string should
  4734. * contain the class name identifying fields in the same subgroup.
  4735. * @param $source
  4736. * (optional) If the $action is 'match', this string should contain the class
  4737. * name identifying what field will be used as the source value when matching
  4738. * the value in $subgroup.
  4739. * @param $hidden
  4740. * (optional) The column containing the field elements may be entirely hidden
  4741. * from view dynamically when the JavaScript is loaded. Set to FALSE if the
  4742. * column should not be hidden.
  4743. * @param $limit
  4744. * (optional) Limit the maximum amount of parenting in this table.
  4745. * @see block-admin-display-form.tpl.php
  4746. * @see theme_menu_overview_form()
  4747. */
  4748. function drupal_add_tabledrag($table_id, $action, $relationship, $group, $subgroup = NULL, $source = NULL, $hidden = TRUE, $limit = 0) {
  4749. $js_added = &drupal_static(__FUNCTION__, FALSE);
  4750. if (!$js_added) {
  4751. // Add the table drag JavaScript to the page before the module JavaScript
  4752. // to ensure that table drag behaviors are registered before any module
  4753. // uses it.
  4754. drupal_add_library('system', 'jquery.cookie');
  4755. drupal_add_js('misc/tabledrag.js', array('weight' => -1));
  4756. $js_added = TRUE;
  4757. }
  4758. // If a subgroup or source isn't set, assume it is the same as the group.
  4759. $target = isset($subgroup) ? $subgroup : $group;
  4760. $source = isset($source) ? $source : $target;
  4761. $settings['tableDrag'][$table_id][$group][] = array(
  4762. 'target' => $target,
  4763. 'source' => $source,
  4764. 'relationship' => $relationship,
  4765. 'action' => $action,
  4766. 'hidden' => $hidden,
  4767. 'limit' => $limit,
  4768. );
  4769. drupal_add_js($settings, 'setting');
  4770. }
  4771. /**
  4772. * Aggregates JavaScript files into a cache file in the files directory.
  4773. *
  4774. * The file name for the JavaScript cache file is generated from the hash of
  4775. * the aggregated contents of the files in $files. This forces proxies and
  4776. * browsers to download new JavaScript when the JavaScript changes.
  4777. *
  4778. * The cache file name is retrieved on a page load via a lookup variable that
  4779. * contains an associative array. The array key is the hash of the names in
  4780. * $files while the value is the cache file name. The cache file is generated
  4781. * in two cases. First, if there is no file name value for the key, which will
  4782. * happen if a new file name has been added to $files or after the lookup
  4783. * variable is emptied to force a rebuild of the cache. Second, the cache file
  4784. * is generated if it is missing on disk. Old cache files are not deleted
  4785. * immediately when the lookup variable is emptied, but are deleted after a set
  4786. * period by drupal_delete_file_if_stale(). This ensures that files referenced
  4787. * by a cached page will still be available.
  4788. *
  4789. * @param $files
  4790. * An array of JavaScript files to aggregate and compress into one file.
  4791. *
  4792. * @return
  4793. * The URI of the cache file, or FALSE if the file could not be saved.
  4794. */
  4795. function drupal_build_js_cache($files) {
  4796. $contents = '';
  4797. $uri = '';
  4798. $map = variable_get('drupal_js_cache_files', array());
  4799. // Create a new array so that only the file names are used to create the hash.
  4800. // This prevents new aggregates from being created unnecessarily.
  4801. $js_data = array();
  4802. foreach ($files as $file) {
  4803. $js_data[] = $file['data'];
  4804. }
  4805. $key = hash('sha256', serialize($js_data));
  4806. if (isset($map[$key])) {
  4807. $uri = $map[$key];
  4808. }
  4809. if (empty($uri) || !file_exists($uri)) {
  4810. // Build aggregate JS file.
  4811. foreach ($files as $path => $info) {
  4812. if ($info['preprocess']) {
  4813. // Append a ';' and a newline after each JS file to prevent them from running together.
  4814. $contents .= file_get_contents($path) . ";\n";
  4815. }
  4816. }
  4817. // Remove JS source and source mapping urls or these may cause 404 errors.
  4818. $contents = preg_replace('/\/\/(#|@)\s(sourceURL|sourceMappingURL)=\s*(\S*?)\s*$/m', '', $contents);
  4819. // Prefix filename to prevent blocking by firewalls which reject files
  4820. // starting with "ad*".
  4821. $filename = 'js_' . drupal_hash_base64($contents) . '.js';
  4822. // Create the js/ within the files folder.
  4823. $jspath = 'public://js';
  4824. $uri = $jspath . '/' . $filename;
  4825. // Create the JS file.
  4826. file_prepare_directory($jspath, FILE_CREATE_DIRECTORY);
  4827. if (!file_exists($uri) && !file_unmanaged_save_data($contents, $uri, FILE_EXISTS_REPLACE)) {
  4828. return FALSE;
  4829. }
  4830. // If JS gzip compression is enabled, clean URLs are enabled (which means
  4831. // that rewrite rules are working) and the zlib extension is available then
  4832. // create a gzipped version of this file. This file is served conditionally
  4833. // to browsers that accept gzip using .htaccess rules.
  4834. if (variable_get('js_gzip_compression', TRUE) && variable_get('clean_url', 0) && extension_loaded('zlib')) {
  4835. if (!file_exists($uri . '.gz') && !file_unmanaged_save_data(gzencode($contents, 9, FORCE_GZIP), $uri . '.gz', FILE_EXISTS_REPLACE)) {
  4836. return FALSE;
  4837. }
  4838. }
  4839. $map[$key] = $uri;
  4840. variable_set('drupal_js_cache_files', $map);
  4841. }
  4842. return $uri;
  4843. }
  4844. /**
  4845. * Deletes old cached JavaScript files and variables.
  4846. */
  4847. function drupal_clear_js_cache() {
  4848. variable_del('javascript_parsed');
  4849. variable_del('drupal_js_cache_files');
  4850. file_scan_directory('public://js', '/.*/', array('callback' => 'drupal_delete_file_if_stale'));
  4851. }
  4852. /**
  4853. * Converts a PHP variable into its JavaScript equivalent.
  4854. *
  4855. * We use HTML-safe strings, with several characters escaped.
  4856. *
  4857. * @see drupal_json_decode()
  4858. * @see drupal_json_encode_helper()
  4859. * @ingroup php_wrappers
  4860. */
  4861. function drupal_json_encode($var) {
  4862. // The PHP version cannot change within a request.
  4863. static $php530;
  4864. if (!isset($php530)) {
  4865. $php530 = version_compare(PHP_VERSION, '5.3.0', '>=');
  4866. }
  4867. if ($php530) {
  4868. // Encode <, >, ', &, and " using the json_encode() options parameter.
  4869. return json_encode($var, JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_AMP | JSON_HEX_QUOT);
  4870. }
  4871. // json_encode() escapes <, >, ', &, and " using its options parameter, but
  4872. // does not support this parameter prior to PHP 5.3.0. Use a helper instead.
  4873. include_once DRUPAL_ROOT . '/includes/json-encode.inc';
  4874. return drupal_json_encode_helper($var);
  4875. }
  4876. /**
  4877. * Converts an HTML-safe JSON string into its PHP equivalent.
  4878. *
  4879. * @see drupal_json_encode()
  4880. * @ingroup php_wrappers
  4881. */
  4882. function drupal_json_decode($var) {
  4883. return json_decode($var, TRUE);
  4884. }
  4885. /**
  4886. * Returns data in JSON format.
  4887. *
  4888. * This function should be used for JavaScript callback functions returning
  4889. * data in JSON format. It sets the header for JavaScript output.
  4890. *
  4891. * @param $var
  4892. * (optional) If set, the variable will be converted to JSON and output.
  4893. */
  4894. function drupal_json_output($var = NULL) {
  4895. // We are returning JSON, so tell the browser.
  4896. drupal_add_http_header('Content-Type', 'application/json');
  4897. if (isset($var)) {
  4898. echo drupal_json_encode($var);
  4899. }
  4900. }
  4901. /**
  4902. * Ensures the private key variable used to generate tokens is set.
  4903. *
  4904. * @return
  4905. * The private key.
  4906. */
  4907. function drupal_get_private_key() {
  4908. if (!($key = variable_get('drupal_private_key', 0))) {
  4909. $key = drupal_random_key();
  4910. variable_set('drupal_private_key', $key);
  4911. }
  4912. return $key;
  4913. }
  4914. /**
  4915. * Generates a token based on $value, the user session, and the private key.
  4916. *
  4917. * @param $value
  4918. * An additional value to base the token on.
  4919. *
  4920. * The generated token is based on the session ID of the current user. Normally,
  4921. * anonymous users do not have a session, so the generated token will be
  4922. * different on every page request. To generate a token for users without a
  4923. * session, manually start a session prior to calling this function.
  4924. *
  4925. * @return string
  4926. * A 43-character URL-safe token for validation, based on the user session ID,
  4927. * the hash salt provided from drupal_get_hash_salt(), and the
  4928. * 'drupal_private_key' configuration variable.
  4929. *
  4930. * @see drupal_get_hash_salt()
  4931. */
  4932. function drupal_get_token($value = '') {
  4933. return drupal_hmac_base64($value, session_id() . drupal_get_private_key() . drupal_get_hash_salt());
  4934. }
  4935. /**
  4936. * Validates a token based on $value, the user session, and the private key.
  4937. *
  4938. * @param $token
  4939. * The token to be validated.
  4940. * @param $value
  4941. * An additional value to base the token on.
  4942. * @param $skip_anonymous
  4943. * Set to true to skip token validation for anonymous users.
  4944. *
  4945. * @return
  4946. * True for a valid token, false for an invalid token. When $skip_anonymous
  4947. * is true, the return value will always be true for anonymous users.
  4948. */
  4949. function drupal_valid_token($token, $value = '', $skip_anonymous = FALSE) {
  4950. global $user;
  4951. return (($skip_anonymous && $user->uid == 0) || ($token === drupal_get_token($value)));
  4952. }
  4953. function _drupal_bootstrap_full() {
  4954. static $called = FALSE;
  4955. if ($called) {
  4956. return;
  4957. }
  4958. $called = TRUE;
  4959. require_once DRUPAL_ROOT . '/' . variable_get('path_inc', 'includes/path.inc');
  4960. require_once DRUPAL_ROOT . '/includes/theme.inc';
  4961. require_once DRUPAL_ROOT . '/includes/pager.inc';
  4962. require_once DRUPAL_ROOT . '/' . variable_get('menu_inc', 'includes/menu.inc');
  4963. require_once DRUPAL_ROOT . '/includes/tablesort.inc';
  4964. require_once DRUPAL_ROOT . '/includes/file.inc';
  4965. require_once DRUPAL_ROOT . '/includes/unicode.inc';
  4966. require_once DRUPAL_ROOT . '/includes/image.inc';
  4967. require_once DRUPAL_ROOT . '/includes/form.inc';
  4968. require_once DRUPAL_ROOT . '/includes/mail.inc';
  4969. require_once DRUPAL_ROOT . '/includes/actions.inc';
  4970. require_once DRUPAL_ROOT . '/includes/ajax.inc';
  4971. require_once DRUPAL_ROOT . '/includes/token.inc';
  4972. require_once DRUPAL_ROOT . '/includes/errors.inc';
  4973. // Detect string handling method
  4974. unicode_check();
  4975. // Undo magic quotes
  4976. fix_gpc_magic();
  4977. // Load all enabled modules
  4978. module_load_all();
  4979. // Reset drupal_alter() and module_implements() static caches as these
  4980. // include implementations for vital modules only when called early on
  4981. // in the bootstrap.
  4982. drupal_static_reset('drupal_alter');
  4983. drupal_static_reset('module_implements');
  4984. // Make sure all stream wrappers are registered.
  4985. file_get_stream_wrappers();
  4986. // Ensure mt_rand is reseeded, to prevent random values from one page load
  4987. // being exploited to predict random values in subsequent page loads.
  4988. $seed = unpack("L", drupal_random_bytes(4));
  4989. mt_srand($seed[1]);
  4990. $test_info = &$GLOBALS['drupal_test_info'];
  4991. if (!empty($test_info['in_child_site'])) {
  4992. // Running inside the simpletest child site, log fatal errors to test
  4993. // specific file directory.
  4994. ini_set('log_errors', 1);
  4995. ini_set('error_log', 'public://error.log');
  4996. }
  4997. // Initialize $_GET['q'] prior to invoking hook_init().
  4998. drupal_path_initialize();
  4999. // Let all modules take action before the menu system handles the request.
  5000. // We do not want this while running update.php.
  5001. if (!defined('MAINTENANCE_MODE') || MAINTENANCE_MODE != 'update') {
  5002. // Prior to invoking hook_init(), initialize the theme (potentially a custom
  5003. // one for this page), so that:
  5004. // - Modules with hook_init() implementations that call theme() or
  5005. // theme_get_registry() don't initialize the incorrect theme.
  5006. // - The theme can have hook_*_alter() implementations affect page building
  5007. // (e.g., hook_form_alter(), hook_node_view_alter(), hook_page_alter()),
  5008. // ahead of when rendering starts.
  5009. menu_set_custom_theme();
  5010. drupal_theme_initialize();
  5011. module_invoke_all('init');
  5012. }
  5013. }
  5014. /**
  5015. * Stores the current page in the cache.
  5016. *
  5017. * If page_compression is enabled, a gzipped version of the page is stored in
  5018. * the cache to avoid compressing the output on each request. The cache entry
  5019. * is unzipped in the relatively rare event that the page is requested by a
  5020. * client without gzip support.
  5021. *
  5022. * Page compression requires the PHP zlib extension
  5023. * (http://php.net/manual/ref.zlib.php).
  5024. *
  5025. * @see drupal_page_header()
  5026. */
  5027. function drupal_page_set_cache() {
  5028. global $base_root;
  5029. if (drupal_page_is_cacheable()) {
  5030. // Check whether the current page might be compressed.
  5031. $page_compressed = variable_get('page_compression', TRUE) && extension_loaded('zlib');
  5032. $cache = (object) array(
  5033. 'cid' => $base_root . request_uri(),
  5034. 'data' => array(
  5035. 'path' => $_GET['q'],
  5036. 'body' => ob_get_clean(),
  5037. 'title' => drupal_get_title(),
  5038. 'headers' => array(),
  5039. // We need to store whether page was compressed or not,
  5040. // because by the time it is read, the configuration might change.
  5041. 'page_compressed' => $page_compressed,
  5042. ),
  5043. 'expire' => CACHE_TEMPORARY,
  5044. 'created' => REQUEST_TIME,
  5045. );
  5046. // Restore preferred header names based on the lower-case names returned
  5047. // by drupal_get_http_header().
  5048. $header_names = _drupal_set_preferred_header_name();
  5049. foreach (drupal_get_http_header() as $name_lower => $value) {
  5050. $cache->data['headers'][$header_names[$name_lower]] = $value;
  5051. if ($name_lower == 'expires') {
  5052. // Use the actual timestamp from an Expires header if available.
  5053. $cache->expire = strtotime($value);
  5054. }
  5055. }
  5056. if ($cache->data['body']) {
  5057. if ($page_compressed) {
  5058. $cache->data['body'] = gzencode($cache->data['body'], 9, FORCE_GZIP);
  5059. }
  5060. cache_set($cache->cid, $cache->data, 'cache_page', $cache->expire);
  5061. }
  5062. return $cache;
  5063. }
  5064. }
  5065. /**
  5066. * Executes a cron run when called.
  5067. *
  5068. * Do not call this function from a test. Use $this->cronRun() instead.
  5069. *
  5070. * @return bool
  5071. * TRUE if cron ran successfully and FALSE if cron is already running.
  5072. */
  5073. function drupal_cron_run() {
  5074. // Allow execution to continue even if the request gets canceled.
  5075. @ignore_user_abort(TRUE);
  5076. // Prevent session information from being saved while cron is running.
  5077. $original_session_saving = drupal_save_session();
  5078. drupal_save_session(FALSE);
  5079. // Force the current user to anonymous to ensure consistent permissions on
  5080. // cron runs.
  5081. $original_user = $GLOBALS['user'];
  5082. $GLOBALS['user'] = drupal_anonymous_user();
  5083. // Try to allocate enough time to run all the hook_cron implementations.
  5084. drupal_set_time_limit(240);
  5085. $return = FALSE;
  5086. // Grab the defined cron queues.
  5087. $queues = module_invoke_all('cron_queue_info');
  5088. drupal_alter('cron_queue_info', $queues);
  5089. // Try to acquire cron lock.
  5090. if (!lock_acquire('cron', 240.0)) {
  5091. // Cron is still running normally.
  5092. watchdog('cron', 'Attempting to re-run cron while it is already running.', array(), WATCHDOG_WARNING);
  5093. }
  5094. else {
  5095. // Make sure every queue exists. There is no harm in trying to recreate an
  5096. // existing queue.
  5097. foreach ($queues as $queue_name => $info) {
  5098. DrupalQueue::get($queue_name)->createQueue();
  5099. }
  5100. // Iterate through the modules calling their cron handlers (if any):
  5101. foreach (module_implements('cron') as $module) {
  5102. // Do not let an exception thrown by one module disturb another.
  5103. try {
  5104. module_invoke($module, 'cron');
  5105. }
  5106. catch (Exception $e) {
  5107. watchdog_exception('cron', $e);
  5108. }
  5109. }
  5110. // Record cron time.
  5111. variable_set('cron_last', REQUEST_TIME);
  5112. watchdog('cron', 'Cron run completed.', array(), WATCHDOG_NOTICE);
  5113. // Release cron lock.
  5114. lock_release('cron');
  5115. // Return TRUE so other functions can check if it did run successfully
  5116. $return = TRUE;
  5117. }
  5118. foreach ($queues as $queue_name => $info) {
  5119. if (!empty($info['skip on cron'])) {
  5120. // Do not run if queue wants to skip.
  5121. continue;
  5122. }
  5123. $callback = $info['worker callback'];
  5124. $end = time() + (isset($info['time']) ? $info['time'] : 15);
  5125. $queue = DrupalQueue::get($queue_name);
  5126. while (time() < $end && ($item = $queue->claimItem())) {
  5127. try {
  5128. call_user_func($callback, $item->data);
  5129. $queue->deleteItem($item);
  5130. }
  5131. catch (Exception $e) {
  5132. // In case of exception log it and leave the item in the queue
  5133. // to be processed again later.
  5134. watchdog_exception('cron', $e);
  5135. }
  5136. }
  5137. }
  5138. // Restore the user.
  5139. $GLOBALS['user'] = $original_user;
  5140. drupal_save_session($original_session_saving);
  5141. return $return;
  5142. }
  5143. /**
  5144. * DEPRECATED: Shutdown function: Performs cron cleanup.
  5145. *
  5146. * This function is deprecated because the 'cron_semaphore' variable it
  5147. * references no longer exists. It is therefore no longer used as a shutdown
  5148. * function by Drupal core.
  5149. *
  5150. * @deprecated
  5151. */
  5152. function drupal_cron_cleanup() {
  5153. // See if the semaphore is still locked.
  5154. if (variable_get('cron_semaphore', FALSE)) {
  5155. watchdog('cron', 'Cron run exceeded the time limit and was aborted.', array(), WATCHDOG_WARNING);
  5156. // Release cron semaphore.
  5157. variable_del('cron_semaphore');
  5158. }
  5159. }
  5160. /**
  5161. * Returns information about system object files (modules, themes, etc.).
  5162. *
  5163. * This function is used to find all or some system object files (module files,
  5164. * theme files, etc.) that exist on the site. It searches in several locations,
  5165. * depending on what type of object you are looking for. For instance, if you
  5166. * are looking for modules and call:
  5167. * @code
  5168. * drupal_system_listing("/\.module$/", "modules", 'name', 0);
  5169. * @endcode
  5170. * this function will search the site-wide modules directory (i.e., /modules/),
  5171. * your installation profile's directory (i.e.,
  5172. * /profiles/your_site_profile/modules/), the all-sites directory (i.e.,
  5173. * /sites/all/modules/), and your site-specific directory (i.e.,
  5174. * /sites/your_site_dir/modules/), in that order, and return information about
  5175. * all of the files ending in .module in those directories.
  5176. *
  5177. * The information is returned in an associative array, which can be keyed on
  5178. * the file name ($key = 'filename'), the file name without the extension ($key
  5179. * = 'name'), or the full file stream URI ($key = 'uri'). If you use a key of
  5180. * 'filename' or 'name', files found later in the search will take precedence
  5181. * over files found earlier (unless they belong to a module or theme not
  5182. * compatible with Drupal core); if you choose a key of 'uri', you will get all
  5183. * files found.
  5184. *
  5185. * @param string $mask
  5186. * The preg_match() regular expression for the files to find.
  5187. * @param string $directory
  5188. * The subdirectory name in which the files are found. For example,
  5189. * 'modules' will search in sub-directories of the top-level /modules
  5190. * directory, sub-directories of /sites/all/modules/, etc.
  5191. * @param string $key
  5192. * The key to be used for the associative array returned. Possible values are
  5193. * 'uri', for the file's URI; 'filename', for the basename of the file; and
  5194. * 'name' for the name of the file without the extension. If you choose 'name'
  5195. * or 'filename', only the highest-precedence file will be returned.
  5196. * @param int $min_depth
  5197. * Minimum depth of directories to return files from, relative to each
  5198. * directory searched. For instance, a minimum depth of 2 would find modules
  5199. * inside /modules/node/tests, but not modules directly in /modules/node.
  5200. *
  5201. * @return array
  5202. * An associative array of file objects, keyed on the chosen key. Each element
  5203. * in the array is an object containing file information, with properties:
  5204. * - 'uri': Full URI of the file.
  5205. * - 'filename': File name.
  5206. * - 'name': Name of file without the extension.
  5207. */
  5208. function drupal_system_listing($mask, $directory, $key = 'name', $min_depth = 1) {
  5209. $config = conf_path();
  5210. $searchdir = array($directory);
  5211. $files = array();
  5212. // The 'profiles' directory contains pristine collections of modules and
  5213. // themes as organized by a distribution. It is pristine in the same way
  5214. // that /modules is pristine for core; users should avoid changing anything
  5215. // there in favor of sites/all or sites/<domain> directories.
  5216. $profiles = array();
  5217. $profile = drupal_get_profile();
  5218. // For SimpleTest to be able to test modules packaged together with a
  5219. // distribution we need to include the profile of the parent site (in which
  5220. // test runs are triggered).
  5221. if (drupal_valid_test_ua()) {
  5222. $testing_profile = variable_get('simpletest_parent_profile', FALSE);
  5223. if ($testing_profile && $testing_profile != $profile) {
  5224. $profiles[] = $testing_profile;
  5225. }
  5226. }
  5227. // In case both profile directories contain the same extension, the actual
  5228. // profile always has precedence.
  5229. $profiles[] = $profile;
  5230. foreach ($profiles as $profile) {
  5231. if (file_exists("profiles/$profile/$directory")) {
  5232. $searchdir[] = "profiles/$profile/$directory";
  5233. }
  5234. }
  5235. // Always search sites/all/* as well as the global directories.
  5236. $searchdir[] = 'sites/all/' . $directory;
  5237. if (file_exists("$config/$directory")) {
  5238. $searchdir[] = "$config/$directory";
  5239. }
  5240. // Get current list of items.
  5241. if (!function_exists('file_scan_directory')) {
  5242. require_once DRUPAL_ROOT . '/includes/file.inc';
  5243. }
  5244. foreach ($searchdir as $dir) {
  5245. $files_to_add = file_scan_directory($dir, $mask, array('key' => $key, 'min_depth' => $min_depth));
  5246. // Duplicate files found in later search directories take precedence over
  5247. // earlier ones, so we want them to overwrite keys in our resulting
  5248. // $files array.
  5249. // The exception to this is if the later file is from a module or theme not
  5250. // compatible with Drupal core. This may occur during upgrades of Drupal
  5251. // core when new modules exist in core while older contrib modules with the
  5252. // same name exist in a directory such as sites/all/modules/.
  5253. foreach (array_intersect_key($files_to_add, $files) as $file_key => $file) {
  5254. // If it has no info file, then we just behave liberally and accept the
  5255. // new resource on the list for merging.
  5256. if (file_exists($info_file = dirname($file->uri) . '/' . $file->name . '.info')) {
  5257. // Get the .info file for the module or theme this file belongs to.
  5258. $info = drupal_parse_info_file($info_file);
  5259. // If the module or theme is incompatible with Drupal core, remove it
  5260. // from the array for the current search directory, so it is not
  5261. // overwritten when merged with the $files array.
  5262. if (isset($info['core']) && $info['core'] != DRUPAL_CORE_COMPATIBILITY) {
  5263. unset($files_to_add[$file_key]);
  5264. }
  5265. }
  5266. }
  5267. $files = array_merge($files, $files_to_add);
  5268. }
  5269. return $files;
  5270. }
  5271. /**
  5272. * Sets the main page content value for later use.
  5273. *
  5274. * Given the nature of the Drupal page handling, this will be called once with
  5275. * a string or array. We store that and return it later as the block is being
  5276. * displayed.
  5277. *
  5278. * @param $content
  5279. * A string or renderable array representing the body of the page.
  5280. *
  5281. * @return
  5282. * If called without $content, a renderable array representing the body of
  5283. * the page.
  5284. */
  5285. function drupal_set_page_content($content = NULL) {
  5286. $content_block = &drupal_static(__FUNCTION__, NULL);
  5287. $main_content_display = &drupal_static('system_main_content_added', FALSE);
  5288. if (!empty($content)) {
  5289. $content_block = (is_array($content) ? $content : array('main' => array('#markup' => $content)));
  5290. }
  5291. else {
  5292. // Indicate that the main content has been requested. We assume that
  5293. // the module requesting the content will be adding it to the page.
  5294. // A module can indicate that it does not handle the content by setting
  5295. // the static variable back to FALSE after calling this function.
  5296. $main_content_display = TRUE;
  5297. return $content_block;
  5298. }
  5299. }
  5300. /**
  5301. * #pre_render callback to render #browsers into #prefix and #suffix.
  5302. *
  5303. * @param $elements
  5304. * A render array with a '#browsers' property. The '#browsers' property can
  5305. * contain any or all of the following keys:
  5306. * - 'IE': If FALSE, the element is not rendered by Internet Explorer. If
  5307. * TRUE, the element is rendered by Internet Explorer. Can also be a string
  5308. * containing an expression for Internet Explorer to evaluate as part of a
  5309. * conditional comment. For example, this can be set to 'lt IE 7' for the
  5310. * element to be rendered in Internet Explorer 6, but not in Internet
  5311. * Explorer 7 or higher. Defaults to TRUE.
  5312. * - '!IE': If FALSE, the element is not rendered by browsers other than
  5313. * Internet Explorer. If TRUE, the element is rendered by those browsers.
  5314. * Defaults to TRUE.
  5315. * Examples:
  5316. * - To render an element in all browsers, '#browsers' can be left out or set
  5317. * to array('IE' => TRUE, '!IE' => TRUE).
  5318. * - To render an element in Internet Explorer only, '#browsers' can be set
  5319. * to array('!IE' => FALSE).
  5320. * - To render an element in Internet Explorer 6 only, '#browsers' can be set
  5321. * to array('IE' => 'lt IE 7', '!IE' => FALSE).
  5322. * - To render an element in Internet Explorer 8 and higher and in all other
  5323. * browsers, '#browsers' can be set to array('IE' => 'gte IE 8').
  5324. *
  5325. * @return
  5326. * The passed-in element with markup for conditional comments potentially
  5327. * added to '#prefix' and '#suffix'.
  5328. */
  5329. function drupal_pre_render_conditional_comments($elements) {
  5330. $browsers = isset($elements['#browsers']) ? $elements['#browsers'] : array();
  5331. $browsers += array(
  5332. 'IE' => TRUE,
  5333. '!IE' => TRUE,
  5334. );
  5335. // If rendering in all browsers, no need for conditional comments.
  5336. if ($browsers['IE'] === TRUE && $browsers['!IE']) {
  5337. return $elements;
  5338. }
  5339. // Determine the conditional comment expression for Internet Explorer to
  5340. // evaluate.
  5341. if ($browsers['IE'] === TRUE) {
  5342. $expression = 'IE';
  5343. }
  5344. elseif ($browsers['IE'] === FALSE) {
  5345. $expression = '!IE';
  5346. }
  5347. else {
  5348. $expression = $browsers['IE'];
  5349. }
  5350. // Wrap the element's potentially existing #prefix and #suffix properties with
  5351. // conditional comment markup. The conditional comment expression is evaluated
  5352. // by Internet Explorer only. To control the rendering by other browsers,
  5353. // either the "downlevel-hidden" or "downlevel-revealed" technique must be
  5354. // used. See http://en.wikipedia.org/wiki/Conditional_comment for details.
  5355. $elements += array(
  5356. '#prefix' => '',
  5357. '#suffix' => '',
  5358. );
  5359. if (!$browsers['!IE']) {
  5360. // "downlevel-hidden".
  5361. $elements['#prefix'] = "\n<!--[if $expression]>\n" . $elements['#prefix'];
  5362. $elements['#suffix'] .= "<![endif]-->\n";
  5363. }
  5364. else {
  5365. // "downlevel-revealed".
  5366. $elements['#prefix'] = "\n<!--[if $expression]><!-->\n" . $elements['#prefix'];
  5367. $elements['#suffix'] .= "<!--<![endif]-->\n";
  5368. }
  5369. return $elements;
  5370. }
  5371. /**
  5372. * #pre_render callback to render a link into #markup.
  5373. *
  5374. * Doing so during pre_render gives modules a chance to alter the link parts.
  5375. *
  5376. * @param $elements
  5377. * A structured array whose keys form the arguments to l():
  5378. * - #title: The link text to pass as argument to l().
  5379. * - #href: The URL path component to pass as argument to l().
  5380. * - #options: (optional) An array of options to pass to l().
  5381. *
  5382. * @return
  5383. * The passed-in elements containing a rendered link in '#markup'.
  5384. */
  5385. function drupal_pre_render_link($element) {
  5386. // By default, link options to pass to l() are normally set in #options.
  5387. $element += array('#options' => array());
  5388. // However, within the scope of renderable elements, #attributes is a valid
  5389. // way to specify attributes, too. Take them into account, but do not override
  5390. // attributes from #options.
  5391. if (isset($element['#attributes'])) {
  5392. $element['#options'] += array('attributes' => array());
  5393. $element['#options']['attributes'] += $element['#attributes'];
  5394. }
  5395. // This #pre_render callback can be invoked from inside or outside of a Form
  5396. // API context, and depending on that, a HTML ID may be already set in
  5397. // different locations. #options should have precedence over Form API's #id.
  5398. // #attributes have been taken over into #options above already.
  5399. if (isset($element['#options']['attributes']['id'])) {
  5400. $element['#id'] = $element['#options']['attributes']['id'];
  5401. }
  5402. elseif (isset($element['#id'])) {
  5403. $element['#options']['attributes']['id'] = $element['#id'];
  5404. }
  5405. // Conditionally invoke ajax_pre_render_element(), if #ajax is set.
  5406. if (isset($element['#ajax']) && !isset($element['#ajax_processed'])) {
  5407. // If no HTML ID was found above, automatically create one.
  5408. if (!isset($element['#id'])) {
  5409. $element['#id'] = $element['#options']['attributes']['id'] = drupal_html_id('ajax-link');
  5410. }
  5411. // If #ajax['path] was not specified, use the href as Ajax request URL.
  5412. if (!isset($element['#ajax']['path'])) {
  5413. $element['#ajax']['path'] = $element['#href'];
  5414. $element['#ajax']['options'] = $element['#options'];
  5415. }
  5416. $element = ajax_pre_render_element($element);
  5417. }
  5418. $element['#markup'] = l($element['#title'], $element['#href'], $element['#options']);
  5419. return $element;
  5420. }
  5421. /**
  5422. * #pre_render callback that collects child links into a single array.
  5423. *
  5424. * This function can be added as a pre_render callback for a renderable array,
  5425. * usually one which will be themed by theme_links(). It iterates through all
  5426. * unrendered children of the element, collects any #links properties it finds,
  5427. * merges them into the parent element's #links array, and prevents those
  5428. * children from being rendered separately.
  5429. *
  5430. * The purpose of this is to allow links to be logically grouped into related
  5431. * categories, so that each child group can be rendered as its own list of
  5432. * links if drupal_render() is called on it, but calling drupal_render() on the
  5433. * parent element will still produce a single list containing all the remaining
  5434. * links, regardless of what group they were in.
  5435. *
  5436. * A typical example comes from node links, which are stored in a renderable
  5437. * array similar to this:
  5438. * @code
  5439. * $node->content['links'] = array(
  5440. * '#theme' => 'links__node',
  5441. * '#pre_render' => array('drupal_pre_render_links'),
  5442. * 'comment' => array(
  5443. * '#theme' => 'links__node__comment',
  5444. * '#links' => array(
  5445. * // An array of links associated with node comments, suitable for
  5446. * // passing in to theme_links().
  5447. * ),
  5448. * ),
  5449. * 'statistics' => array(
  5450. * '#theme' => 'links__node__statistics',
  5451. * '#links' => array(
  5452. * // An array of links associated with node statistics, suitable for
  5453. * // passing in to theme_links().
  5454. * ),
  5455. * ),
  5456. * 'translation' => array(
  5457. * '#theme' => 'links__node__translation',
  5458. * '#links' => array(
  5459. * // An array of links associated with node translation, suitable for
  5460. * // passing in to theme_links().
  5461. * ),
  5462. * ),
  5463. * );
  5464. * @endcode
  5465. *
  5466. * In this example, the links are grouped by functionality, which can be
  5467. * helpful to themers who want to display certain kinds of links independently.
  5468. * For example, adding this code to node.tpl.php will result in the comment
  5469. * links being rendered as a single list:
  5470. * @code
  5471. * print render($content['links']['comment']);
  5472. * @endcode
  5473. *
  5474. * (where $node->content has been transformed into $content before handing
  5475. * control to the node.tpl.php template).
  5476. *
  5477. * The pre_render function defined here allows the above flexibility, but also
  5478. * allows the following code to be used to render all remaining links into a
  5479. * single list, regardless of their group:
  5480. * @code
  5481. * print render($content['links']);
  5482. * @endcode
  5483. *
  5484. * In the above example, this will result in the statistics and translation
  5485. * links being rendered together in a single list (but not the comment links,
  5486. * which were rendered previously on their own).
  5487. *
  5488. * Because of the way this function works, the individual properties of each
  5489. * group (for example, a group-specific #theme property such as
  5490. * 'links__node__comment' in the example above, or any other property such as
  5491. * #attributes or #pre_render that is attached to it) are only used when that
  5492. * group is rendered on its own. When the group is rendered together with other
  5493. * children, these child-specific properties are ignored, and only the overall
  5494. * properties of the parent are used.
  5495. */
  5496. function drupal_pre_render_links($element) {
  5497. $element += array('#links' => array());
  5498. foreach (element_children($element) as $key) {
  5499. $child = &$element[$key];
  5500. // If the child has links which have not been printed yet and the user has
  5501. // access to it, merge its links in to the parent.
  5502. if (isset($child['#links']) && empty($child['#printed']) && (!isset($child['#access']) || $child['#access'])) {
  5503. $element['#links'] += $child['#links'];
  5504. // Mark the child as having been printed already (so that its links
  5505. // cannot be mistakenly rendered twice).
  5506. $child['#printed'] = TRUE;
  5507. }
  5508. }
  5509. return $element;
  5510. }
  5511. /**
  5512. * #pre_render callback to append contents in #markup to #children.
  5513. *
  5514. * This needs to be a #pre_render callback, because eventually assigned
  5515. * #theme_wrappers will expect the element's rendered content in #children.
  5516. * Note that if also a #theme is defined for the element, then the result of
  5517. * the theme callback will override #children.
  5518. *
  5519. * @param $elements
  5520. * A structured array using the #markup key.
  5521. *
  5522. * @return
  5523. * The passed-in elements, but #markup appended to #children.
  5524. *
  5525. * @see drupal_render()
  5526. */
  5527. function drupal_pre_render_markup($elements) {
  5528. $elements['#children'] = $elements['#markup'];
  5529. return $elements;
  5530. }
  5531. /**
  5532. * Renders the page, including all theming.
  5533. *
  5534. * @param $page
  5535. * A string or array representing the content of a page. The array consists of
  5536. * the following keys:
  5537. * - #type: Value is always 'page'. This pushes the theming through
  5538. * page.tpl.php (required).
  5539. * - #show_messages: Suppress drupal_get_message() items. Used by Batch
  5540. * API (optional).
  5541. *
  5542. * @see hook_page_alter()
  5543. * @see element_info()
  5544. */
  5545. function drupal_render_page($page) {
  5546. $main_content_display = &drupal_static('system_main_content_added', FALSE);
  5547. // Allow menu callbacks to return strings or arbitrary arrays to render.
  5548. // If the array returned is not of #type page directly, we need to fill
  5549. // in the page with defaults.
  5550. if (is_string($page) || (is_array($page) && (!isset($page['#type']) || ($page['#type'] != 'page')))) {
  5551. drupal_set_page_content($page);
  5552. $page = element_info('page');
  5553. }
  5554. // Modules can add elements to $page as needed in hook_page_build().
  5555. foreach (module_implements('page_build') as $module) {
  5556. $function = $module . '_page_build';
  5557. $function($page);
  5558. }
  5559. // Modules alter the $page as needed. Blocks are populated into regions like
  5560. // 'sidebar_first', 'footer', etc.
  5561. drupal_alter('page', $page);
  5562. // If no module has taken care of the main content, add it to the page now.
  5563. // This allows the site to still be usable even if no modules that
  5564. // control page regions (for example, the Block module) are enabled.
  5565. if (!$main_content_display) {
  5566. $page['content']['system_main'] = drupal_set_page_content();
  5567. }
  5568. return drupal_render($page);
  5569. }
  5570. /**
  5571. * Renders HTML given a structured array tree.
  5572. *
  5573. * Recursively iterates over each of the array elements, generating HTML code.
  5574. *
  5575. * Renderable arrays have two kinds of key/value pairs: properties and
  5576. * children. Properties have keys starting with '#' and their values influence
  5577. * how the array will be rendered. Children are all elements whose keys do not
  5578. * start with a '#'. Their values should be renderable arrays themselves,
  5579. * which will be rendered during the rendering of the parent array. The markup
  5580. * provided by the children is typically inserted into the markup generated by
  5581. * the parent array.
  5582. *
  5583. * HTML generation for a renderable array, and the treatment of any children,
  5584. * is controlled by two properties containing theme functions, #theme and
  5585. * #theme_wrappers.
  5586. *
  5587. * #theme is the theme function called first. If it is set and the element has
  5588. * any children, it is the responsibility of the theme function to render
  5589. * these children. For elements that are not allowed to have any children,
  5590. * e.g. buttons or textfields, the theme function can be used to render the
  5591. * element itself. If #theme is not present and the element has children, each
  5592. * child is itself rendered by a call to drupal_render(), and the results are
  5593. * concatenated.
  5594. *
  5595. * The #theme_wrappers property contains an array of theme functions which will
  5596. * be called, in order, after #theme has run. These can be used to add further
  5597. * markup around the rendered children; e.g., fieldsets add the required markup
  5598. * for a fieldset around their rendered child elements. All wrapper theme
  5599. * functions have to include the element's #children property in their output,
  5600. * as it contains the output of the previous theme functions and the rendered
  5601. * children.
  5602. *
  5603. * For example, for the form element type, by default only the #theme_wrappers
  5604. * property is set, which adds the form markup around the rendered child
  5605. * elements of the form. This allows you to set the #theme property on a
  5606. * specific form to a custom theme function, giving you complete control over
  5607. * the placement of the form's children while not at all having to deal with
  5608. * the form markup itself.
  5609. *
  5610. * drupal_render() can optionally cache the rendered output of elements to
  5611. * improve performance. To use drupal_render() caching, set the element's #cache
  5612. * property to an associative array with one or several of the following keys:
  5613. * - 'keys': An array of one or more keys that identify the element. If 'keys'
  5614. * is set, the cache ID is created automatically from these keys. See
  5615. * drupal_render_cid_create().
  5616. * - 'granularity' (optional): Define the cache granularity using binary
  5617. * combinations of the cache granularity constants, e.g.
  5618. * DRUPAL_CACHE_PER_USER to cache for each user separately or
  5619. * DRUPAL_CACHE_PER_PAGE | DRUPAL_CACHE_PER_ROLE to cache separately for each
  5620. * page and role. If not specified the element is cached globally for each
  5621. * theme and language.
  5622. * - 'cid': Specify the cache ID directly. Either 'keys' or 'cid' is required.
  5623. * If 'cid' is set, 'keys' and 'granularity' are ignored. Use only if you
  5624. * have special requirements.
  5625. * - 'expire': Set to one of the cache lifetime constants.
  5626. * - 'bin': Specify a cache bin to cache the element in. Defaults to 'cache'.
  5627. *
  5628. * This function is usually called from within another function, like
  5629. * drupal_get_form() or a theme function. Elements are sorted internally
  5630. * using uasort(). Since this is expensive, when passing already sorted
  5631. * elements to drupal_render(), for example from a database query, set
  5632. * $elements['#sorted'] = TRUE to avoid sorting them a second time.
  5633. *
  5634. * drupal_render() flags each element with a '#printed' status to indicate that
  5635. * the element has been rendered, which allows individual elements of a given
  5636. * array to be rendered independently and prevents them from being rendered
  5637. * more than once on subsequent calls to drupal_render() (e.g., as part of a
  5638. * larger array). If the same array or array element is passed more than once
  5639. * to drupal_render(), it simply returns an empty string.
  5640. *
  5641. * @param array $elements
  5642. * The structured array describing the data to be rendered.
  5643. *
  5644. * @return string
  5645. * The rendered HTML.
  5646. */
  5647. function drupal_render(&$elements) {
  5648. // Early-return nothing if user does not have access.
  5649. if (empty($elements) || (isset($elements['#access']) && !$elements['#access'])) {
  5650. return '';
  5651. }
  5652. // Do not print elements twice.
  5653. if (!empty($elements['#printed'])) {
  5654. return '';
  5655. }
  5656. // Try to fetch the element's markup from cache and return.
  5657. if (isset($elements['#cache'])) {
  5658. $cached_output = drupal_render_cache_get($elements);
  5659. if ($cached_output !== FALSE) {
  5660. return $cached_output;
  5661. }
  5662. }
  5663. // If #markup is set, ensure #type is set. This allows to specify just #markup
  5664. // on an element without setting #type.
  5665. if (isset($elements['#markup']) && !isset($elements['#type'])) {
  5666. $elements['#type'] = 'markup';
  5667. }
  5668. // If the default values for this element have not been loaded yet, populate
  5669. // them.
  5670. if (isset($elements['#type']) && empty($elements['#defaults_loaded'])) {
  5671. $elements += element_info($elements['#type']);
  5672. }
  5673. // Make any final changes to the element before it is rendered. This means
  5674. // that the $element or the children can be altered or corrected before the
  5675. // element is rendered into the final text.
  5676. if (isset($elements['#pre_render'])) {
  5677. foreach ($elements['#pre_render'] as $function) {
  5678. if (function_exists($function)) {
  5679. $elements = $function($elements);
  5680. }
  5681. }
  5682. }
  5683. // Allow #pre_render to abort rendering.
  5684. if (!empty($elements['#printed'])) {
  5685. return '';
  5686. }
  5687. // Get the children of the element, sorted by weight.
  5688. $children = element_children($elements, TRUE);
  5689. // Initialize this element's #children, unless a #pre_render callback already
  5690. // preset #children.
  5691. if (!isset($elements['#children'])) {
  5692. $elements['#children'] = '';
  5693. }
  5694. // Call the element's #theme function if it is set. Then any children of the
  5695. // element have to be rendered there.
  5696. if (isset($elements['#theme'])) {
  5697. $elements['#children'] = theme($elements['#theme'], $elements);
  5698. }
  5699. // If #theme was not set and the element has children, render them now.
  5700. // This is the same process as drupal_render_children() but is inlined
  5701. // for speed.
  5702. if ($elements['#children'] == '') {
  5703. foreach ($children as $key) {
  5704. $elements['#children'] .= drupal_render($elements[$key]);
  5705. }
  5706. }
  5707. // Let the theme functions in #theme_wrappers add markup around the rendered
  5708. // children.
  5709. if (isset($elements['#theme_wrappers'])) {
  5710. foreach ($elements['#theme_wrappers'] as $theme_wrapper) {
  5711. $elements['#children'] = theme($theme_wrapper, $elements);
  5712. }
  5713. }
  5714. // Filter the outputted content and make any last changes before the
  5715. // content is sent to the browser. The changes are made on $content
  5716. // which allows the output'ed text to be filtered.
  5717. if (isset($elements['#post_render'])) {
  5718. foreach ($elements['#post_render'] as $function) {
  5719. if (function_exists($function)) {
  5720. $elements['#children'] = $function($elements['#children'], $elements);
  5721. }
  5722. }
  5723. }
  5724. // Add any JavaScript state information associated with the element.
  5725. if (!empty($elements['#states'])) {
  5726. drupal_process_states($elements);
  5727. }
  5728. // Add additional libraries, CSS, JavaScript an other custom
  5729. // attached data associated with this element.
  5730. if (!empty($elements['#attached'])) {
  5731. drupal_process_attached($elements);
  5732. }
  5733. $prefix = isset($elements['#prefix']) ? $elements['#prefix'] : '';
  5734. $suffix = isset($elements['#suffix']) ? $elements['#suffix'] : '';
  5735. $output = $prefix . $elements['#children'] . $suffix;
  5736. // Cache the processed element if #cache is set.
  5737. if (isset($elements['#cache'])) {
  5738. drupal_render_cache_set($output, $elements);
  5739. }
  5740. $elements['#printed'] = TRUE;
  5741. return $output;
  5742. }
  5743. /**
  5744. * Renders children of an element and concatenates them.
  5745. *
  5746. * @param array $element
  5747. * The structured array whose children shall be rendered.
  5748. * @param array $children_keys
  5749. * (optional) If the keys of the element's children are already known, they
  5750. * can be passed in to save another run of element_children().
  5751. *
  5752. * @return string
  5753. * The rendered HTML of all children of the element.
  5754. * @see drupal_render()
  5755. */
  5756. function drupal_render_children(&$element, $children_keys = NULL) {
  5757. if ($children_keys === NULL) {
  5758. $children_keys = element_children($element);
  5759. }
  5760. $output = '';
  5761. foreach ($children_keys as $key) {
  5762. if (!empty($element[$key])) {
  5763. $output .= drupal_render($element[$key]);
  5764. }
  5765. }
  5766. return $output;
  5767. }
  5768. /**
  5769. * Renders an element.
  5770. *
  5771. * This function renders an element using drupal_render(). The top level
  5772. * element is shown with show() before rendering, so it will always be rendered
  5773. * even if hide() had been previously used on it.
  5774. *
  5775. * @param $element
  5776. * The element to be rendered.
  5777. *
  5778. * @return
  5779. * The rendered element.
  5780. *
  5781. * @see drupal_render()
  5782. * @see show()
  5783. * @see hide()
  5784. */
  5785. function render(&$element) {
  5786. if (is_array($element)) {
  5787. show($element);
  5788. return drupal_render($element);
  5789. }
  5790. else {
  5791. // Safe-guard for inappropriate use of render() on flat variables: return
  5792. // the variable as-is.
  5793. return $element;
  5794. }
  5795. }
  5796. /**
  5797. * Hides an element from later rendering.
  5798. *
  5799. * The first time render() or drupal_render() is called on an element tree,
  5800. * as each element in the tree is rendered, it is marked with a #printed flag
  5801. * and the rendered children of the element are cached. Subsequent calls to
  5802. * render() or drupal_render() will not traverse the child tree of this element
  5803. * again: they will just use the cached children. So if you want to hide an
  5804. * element, be sure to call hide() on the element before its parent tree is
  5805. * rendered for the first time, as it will have no effect on subsequent
  5806. * renderings of the parent tree.
  5807. *
  5808. * @param $element
  5809. * The element to be hidden.
  5810. *
  5811. * @return
  5812. * The element.
  5813. *
  5814. * @see render()
  5815. * @see show()
  5816. */
  5817. function hide(&$element) {
  5818. $element['#printed'] = TRUE;
  5819. return $element;
  5820. }
  5821. /**
  5822. * Shows a hidden element for later rendering.
  5823. *
  5824. * You can also use render($element), which shows the element while rendering
  5825. * it.
  5826. *
  5827. * The first time render() or drupal_render() is called on an element tree,
  5828. * as each element in the tree is rendered, it is marked with a #printed flag
  5829. * and the rendered children of the element are cached. Subsequent calls to
  5830. * render() or drupal_render() will not traverse the child tree of this element
  5831. * again: they will just use the cached children. So if you want to show an
  5832. * element, be sure to call show() on the element before its parent tree is
  5833. * rendered for the first time, as it will have no effect on subsequent
  5834. * renderings of the parent tree.
  5835. *
  5836. * @param $element
  5837. * The element to be shown.
  5838. *
  5839. * @return
  5840. * The element.
  5841. *
  5842. * @see render()
  5843. * @see hide()
  5844. */
  5845. function show(&$element) {
  5846. $element['#printed'] = FALSE;
  5847. return $element;
  5848. }
  5849. /**
  5850. * Gets the rendered output of a renderable element from the cache.
  5851. *
  5852. * @param $elements
  5853. * A renderable array.
  5854. *
  5855. * @return
  5856. * A markup string containing the rendered content of the element, or FALSE
  5857. * if no cached copy of the element is available.
  5858. *
  5859. * @see drupal_render()
  5860. * @see drupal_render_cache_set()
  5861. */
  5862. function drupal_render_cache_get($elements) {
  5863. if (!in_array($_SERVER['REQUEST_METHOD'], array('GET', 'HEAD')) || !$cid = drupal_render_cid_create($elements)) {
  5864. return FALSE;
  5865. }
  5866. $bin = isset($elements['#cache']['bin']) ? $elements['#cache']['bin'] : 'cache';
  5867. if (!empty($cid) && $cache = cache_get($cid, $bin)) {
  5868. // Add additional libraries, JavaScript, CSS and other data attached
  5869. // to this element.
  5870. if (isset($cache->data['#attached'])) {
  5871. drupal_process_attached($cache->data);
  5872. }
  5873. // Return the rendered output.
  5874. return $cache->data['#markup'];
  5875. }
  5876. return FALSE;
  5877. }
  5878. /**
  5879. * Caches the rendered output of a renderable element.
  5880. *
  5881. * This is called by drupal_render() if the #cache property is set on an
  5882. * element.
  5883. *
  5884. * @param $markup
  5885. * The rendered output string of $elements.
  5886. * @param $elements
  5887. * A renderable array.
  5888. *
  5889. * @see drupal_render_cache_get()
  5890. */
  5891. function drupal_render_cache_set(&$markup, $elements) {
  5892. // Create the cache ID for the element.
  5893. if (!in_array($_SERVER['REQUEST_METHOD'], array('GET', 'HEAD')) || !$cid = drupal_render_cid_create($elements)) {
  5894. return FALSE;
  5895. }
  5896. // Cache implementations are allowed to modify the markup, to support
  5897. // replacing markup with edge-side include commands. The supporting cache
  5898. // backend will store the markup in some other key (like
  5899. // $data['#real-value']) and return an include command instead. When the
  5900. // ESI command is executed by the content accelerator, the real value can
  5901. // be retrieved and used.
  5902. $data['#markup'] = &$markup;
  5903. // Persist attached data associated with this element.
  5904. $attached = drupal_render_collect_attached($elements, TRUE);
  5905. if ($attached) {
  5906. $data['#attached'] = $attached;
  5907. }
  5908. $bin = isset($elements['#cache']['bin']) ? $elements['#cache']['bin'] : 'cache';
  5909. $expire = isset($elements['#cache']['expire']) ? $elements['#cache']['expire'] : CACHE_PERMANENT;
  5910. cache_set($cid, $data, $bin, $expire);
  5911. }
  5912. /**
  5913. * Collects #attached for an element and its children into a single array.
  5914. *
  5915. * When caching elements, it is necessary to collect all libraries, JavaScript
  5916. * and CSS into a single array, from both the element itself and all child
  5917. * elements. This allows drupal_render() to add these back to the page when the
  5918. * element is returned from cache.
  5919. *
  5920. * @param $elements
  5921. * The element to collect #attached from.
  5922. * @param $return
  5923. * Whether to return the attached elements and reset the internal static.
  5924. *
  5925. * @return
  5926. * The #attached array for this element and its descendants.
  5927. */
  5928. function drupal_render_collect_attached($elements, $return = FALSE) {
  5929. $attached = &drupal_static(__FUNCTION__, array());
  5930. // Collect all #attached for this element.
  5931. if (isset($elements['#attached'])) {
  5932. foreach ($elements['#attached'] as $key => $value) {
  5933. if (!isset($attached[$key])) {
  5934. $attached[$key] = array();
  5935. }
  5936. $attached[$key] = array_merge($attached[$key], $value);
  5937. }
  5938. }
  5939. if ($children = element_children($elements)) {
  5940. foreach ($children as $child) {
  5941. drupal_render_collect_attached($elements[$child]);
  5942. }
  5943. }
  5944. // If this was the first call to the function, return all attached elements
  5945. // and reset the static cache.
  5946. if ($return) {
  5947. $return = $attached;
  5948. $attached = array();
  5949. return $return;
  5950. }
  5951. }
  5952. /**
  5953. * Prepares an element for caching based on a query.
  5954. *
  5955. * This smart caching strategy saves Drupal from querying and rendering to HTML
  5956. * when the underlying query is unchanged.
  5957. *
  5958. * Expensive queries should use the query builder to create the query and then
  5959. * call this function. Executing the query and formatting results should happen
  5960. * in a #pre_render callback.
  5961. *
  5962. * @param $query
  5963. * A select query object as returned by db_select().
  5964. * @param $function
  5965. * The name of the function doing this caching. A _pre_render suffix will be
  5966. * added to this string and is also part of the cache key in
  5967. * drupal_render_cache_set() and drupal_render_cache_get().
  5968. * @param $expire
  5969. * The cache expire time, passed eventually to cache_set().
  5970. * @param $granularity
  5971. * One or more granularity constants passed to drupal_render_cid_parts().
  5972. *
  5973. * @return
  5974. * A renderable array with the following keys and values:
  5975. * - #query: The passed-in $query.
  5976. * - #pre_render: $function with a _pre_render suffix.
  5977. * - #cache: An associative array prepared for drupal_render_cache_set().
  5978. */
  5979. function drupal_render_cache_by_query($query, $function, $expire = CACHE_TEMPORARY, $granularity = NULL) {
  5980. $cache_keys = array_merge(array($function), drupal_render_cid_parts($granularity));
  5981. $query->preExecute();
  5982. $cache_keys[] = hash('sha256', serialize(array((string) $query, $query->getArguments())));
  5983. return array(
  5984. '#query' => $query,
  5985. '#pre_render' => array($function . '_pre_render'),
  5986. '#cache' => array(
  5987. 'keys' => $cache_keys,
  5988. 'expire' => $expire,
  5989. ),
  5990. );
  5991. }
  5992. /**
  5993. * Returns cache ID parts for building a cache ID.
  5994. *
  5995. * @param $granularity
  5996. * One or more cache granularity constants. For example, to cache separately
  5997. * for each user, use DRUPAL_CACHE_PER_USER. To cache separately for each
  5998. * page and role, use the expression:
  5999. * @code
  6000. * DRUPAL_CACHE_PER_PAGE | DRUPAL_CACHE_PER_ROLE
  6001. * @endcode
  6002. *
  6003. * @return
  6004. * An array of cache ID parts, always containing the active theme. If the
  6005. * locale module is enabled it also contains the active language. If
  6006. * $granularity was passed in, more parts are added.
  6007. */
  6008. function drupal_render_cid_parts($granularity = NULL) {
  6009. global $theme, $base_root, $user;
  6010. $cid_parts[] = $theme;
  6011. // If Locale is enabled but we have only one language we do not need it as cid
  6012. // part.
  6013. if (drupal_multilingual()) {
  6014. foreach (language_types_configurable() as $language_type) {
  6015. $cid_parts[] = $GLOBALS[$language_type]->language;
  6016. }
  6017. }
  6018. if (!empty($granularity)) {
  6019. $cache_per_role = $granularity & DRUPAL_CACHE_PER_ROLE;
  6020. $cache_per_user = $granularity & DRUPAL_CACHE_PER_USER;
  6021. // User 1 has special permissions outside of the role system, so when
  6022. // caching per role is requested, it should cache per user instead.
  6023. if ($user->uid == 1 && $cache_per_role) {
  6024. $cache_per_user = TRUE;
  6025. $cache_per_role = FALSE;
  6026. }
  6027. // 'PER_ROLE' and 'PER_USER' are mutually exclusive. 'PER_USER' can be a
  6028. // resource drag for sites with many users, so when a module is being
  6029. // equivocal, we favor the less expensive 'PER_ROLE' pattern.
  6030. if ($cache_per_role) {
  6031. $cid_parts[] = 'r.' . implode(',', array_keys($user->roles));
  6032. }
  6033. elseif ($cache_per_user) {
  6034. $cid_parts[] = "u.$user->uid";
  6035. }
  6036. if ($granularity & DRUPAL_CACHE_PER_PAGE) {
  6037. $cid_parts[] = $base_root . request_uri();
  6038. }
  6039. }
  6040. return $cid_parts;
  6041. }
  6042. /**
  6043. * Creates the cache ID for a renderable element.
  6044. *
  6045. * This creates the cache ID string, either by returning the #cache['cid']
  6046. * property if present or by building the cache ID out of the #cache['keys']
  6047. * and, optionally, the #cache['granularity'] properties.
  6048. *
  6049. * @param $elements
  6050. * A renderable array.
  6051. *
  6052. * @return
  6053. * The cache ID string, or FALSE if the element may not be cached.
  6054. */
  6055. function drupal_render_cid_create($elements) {
  6056. if (isset($elements['#cache']['cid'])) {
  6057. return $elements['#cache']['cid'];
  6058. }
  6059. elseif (isset($elements['#cache']['keys'])) {
  6060. $granularity = isset($elements['#cache']['granularity']) ? $elements['#cache']['granularity'] : NULL;
  6061. // Merge in additional cache ID parts based provided by drupal_render_cid_parts().
  6062. $cid_parts = array_merge($elements['#cache']['keys'], drupal_render_cid_parts($granularity));
  6063. return implode(':', $cid_parts);
  6064. }
  6065. return FALSE;
  6066. }
  6067. /**
  6068. * Function used by uasort to sort structured arrays by weight.
  6069. */
  6070. function element_sort($a, $b) {
  6071. $a_weight = (is_array($a) && isset($a['#weight'])) ? $a['#weight'] : 0;
  6072. $b_weight = (is_array($b) && isset($b['#weight'])) ? $b['#weight'] : 0;
  6073. if ($a_weight == $b_weight) {
  6074. return 0;
  6075. }
  6076. return ($a_weight < $b_weight) ? -1 : 1;
  6077. }
  6078. /**
  6079. * Array sorting callback; sorts elements by title.
  6080. */
  6081. function element_sort_by_title($a, $b) {
  6082. $a_title = (is_array($a) && isset($a['#title'])) ? $a['#title'] : '';
  6083. $b_title = (is_array($b) && isset($b['#title'])) ? $b['#title'] : '';
  6084. return strnatcasecmp($a_title, $b_title);
  6085. }
  6086. /**
  6087. * Retrieves the default properties for the defined element type.
  6088. *
  6089. * @param $type
  6090. * An element type as defined by hook_element_info().
  6091. */
  6092. function element_info($type) {
  6093. // Use the advanced drupal_static() pattern, since this is called very often.
  6094. static $drupal_static_fast;
  6095. if (!isset($drupal_static_fast)) {
  6096. $drupal_static_fast['cache'] = &drupal_static(__FUNCTION__);
  6097. }
  6098. $cache = &$drupal_static_fast['cache'];
  6099. if (!isset($cache)) {
  6100. $cache = module_invoke_all('element_info');
  6101. foreach ($cache as $element_type => $info) {
  6102. $cache[$element_type]['#type'] = $element_type;
  6103. }
  6104. // Allow modules to alter the element type defaults.
  6105. drupal_alter('element_info', $cache);
  6106. }
  6107. return isset($cache[$type]) ? $cache[$type] : array();
  6108. }
  6109. /**
  6110. * Retrieves a single property for the defined element type.
  6111. *
  6112. * @param $type
  6113. * An element type as defined by hook_element_info().
  6114. * @param $property_name
  6115. * The property within the element type that should be returned.
  6116. * @param $default
  6117. * (Optional) The value to return if the element type does not specify a
  6118. * value for the property. Defaults to NULL.
  6119. */
  6120. function element_info_property($type, $property_name, $default = NULL) {
  6121. return (($info = element_info($type)) && array_key_exists($property_name, $info)) ? $info[$property_name] : $default;
  6122. }
  6123. /**
  6124. * Sorts a structured array by the 'weight' element.
  6125. *
  6126. * Note that the sorting is by the 'weight' array element, not by the render
  6127. * element property '#weight'.
  6128. *
  6129. * Callback for uasort() used in various functions.
  6130. *
  6131. * @param $a
  6132. * First item for comparison. The compared items should be associative arrays
  6133. * that optionally include a 'weight' element. For items without a 'weight'
  6134. * element, a default value of 0 will be used.
  6135. * @param $b
  6136. * Second item for comparison.
  6137. */
  6138. function drupal_sort_weight($a, $b) {
  6139. $a_weight = (is_array($a) && isset($a['weight'])) ? $a['weight'] : 0;
  6140. $b_weight = (is_array($b) && isset($b['weight'])) ? $b['weight'] : 0;
  6141. if ($a_weight == $b_weight) {
  6142. return 0;
  6143. }
  6144. return ($a_weight < $b_weight) ? -1 : 1;
  6145. }
  6146. /**
  6147. * Array sorting callback; sorts elements by 'title' key.
  6148. */
  6149. function drupal_sort_title($a, $b) {
  6150. if (!isset($b['title'])) {
  6151. return -1;
  6152. }
  6153. if (!isset($a['title'])) {
  6154. return 1;
  6155. }
  6156. return strcasecmp($a['title'], $b['title']);
  6157. }
  6158. /**
  6159. * Checks if the key is a property.
  6160. */
  6161. function element_property($key) {
  6162. return $key[0] == '#';
  6163. }
  6164. /**
  6165. * Gets properties of a structured array element (keys beginning with '#').
  6166. */
  6167. function element_properties($element) {
  6168. return array_filter(array_keys((array) $element), 'element_property');
  6169. }
  6170. /**
  6171. * Checks if the key is a child.
  6172. */
  6173. function element_child($key) {
  6174. return !isset($key[0]) || $key[0] != '#';
  6175. }
  6176. /**
  6177. * Identifies the children of an element array, optionally sorted by weight.
  6178. *
  6179. * The children of a element array are those key/value pairs whose key does
  6180. * not start with a '#'. See drupal_render() for details.
  6181. *
  6182. * @param $elements
  6183. * The element array whose children are to be identified.
  6184. * @param $sort
  6185. * Boolean to indicate whether the children should be sorted by weight.
  6186. *
  6187. * @return
  6188. * The array keys of the element's children.
  6189. */
  6190. function element_children(&$elements, $sort = FALSE) {
  6191. // Do not attempt to sort elements which have already been sorted.
  6192. $sort = isset($elements['#sorted']) ? !$elements['#sorted'] : $sort;
  6193. // Filter out properties from the element, leaving only children.
  6194. $count = count($elements);
  6195. $child_weights = array();
  6196. $i = 0;
  6197. $sortable = FALSE;
  6198. foreach ($elements as $key => $value) {
  6199. if (is_int($key) || $key === '' || $key[0] !== '#') {
  6200. if (is_array($value) && isset($value['#weight'])) {
  6201. $weight = $value['#weight'];
  6202. $sortable = TRUE;
  6203. }
  6204. else {
  6205. $weight = 0;
  6206. }
  6207. // Support weights with up to three digit precision and conserve the
  6208. // insertion order.
  6209. $child_weights[$key] = floor($weight * 1000) + $i / $count;
  6210. }
  6211. $i++;
  6212. }
  6213. // Sort the children if necessary.
  6214. if ($sort && $sortable) {
  6215. asort($child_weights);
  6216. // Put the sorted children back into $elements in the correct order, to
  6217. // preserve sorting if the same element is passed through
  6218. // element_children() twice.
  6219. foreach ($child_weights as $key => $weight) {
  6220. $value = $elements[$key];
  6221. unset($elements[$key]);
  6222. $elements[$key] = $value;
  6223. }
  6224. $elements['#sorted'] = TRUE;
  6225. }
  6226. return array_keys($child_weights);
  6227. }
  6228. /**
  6229. * Returns the visible children of an element.
  6230. *
  6231. * @param $elements
  6232. * The parent element.
  6233. *
  6234. * @return
  6235. * The array keys of the element's visible children.
  6236. */
  6237. function element_get_visible_children(array $elements) {
  6238. $visible_children = array();
  6239. foreach (element_children($elements) as $key) {
  6240. $child = $elements[$key];
  6241. // Skip un-accessible children.
  6242. if (isset($child['#access']) && !$child['#access']) {
  6243. continue;
  6244. }
  6245. // Skip value and hidden elements, since they are not rendered.
  6246. if (isset($child['#type']) && in_array($child['#type'], array('value', 'hidden'))) {
  6247. continue;
  6248. }
  6249. $visible_children[$key] = $child;
  6250. }
  6251. return array_keys($visible_children);
  6252. }
  6253. /**
  6254. * Sets HTML attributes based on element properties.
  6255. *
  6256. * @param $element
  6257. * The renderable element to process.
  6258. * @param $map
  6259. * An associative array whose keys are element property names and whose values
  6260. * are the HTML attribute names to set for corresponding the property; e.g.,
  6261. * array('#propertyname' => 'attributename'). If both names are identical
  6262. * except for the leading '#', then an attribute name value is sufficient and
  6263. * no property name needs to be specified.
  6264. */
  6265. function element_set_attributes(array &$element, array $map) {
  6266. foreach ($map as $property => $attribute) {
  6267. // If the key is numeric, the attribute name needs to be taken over.
  6268. if (is_int($property)) {
  6269. $property = '#' . $attribute;
  6270. }
  6271. // Do not overwrite already existing attributes.
  6272. if (isset($element[$property]) && !isset($element['#attributes'][$attribute])) {
  6273. $element['#attributes'][$attribute] = $element[$property];
  6274. }
  6275. }
  6276. }
  6277. /**
  6278. * Recursively computes the difference of arrays with additional index check.
  6279. *
  6280. * This is a version of array_diff_assoc() that supports multidimensional
  6281. * arrays.
  6282. *
  6283. * @param array $array1
  6284. * The array to compare from.
  6285. * @param array $array2
  6286. * The array to compare to.
  6287. *
  6288. * @return array
  6289. * Returns an array containing all the values from array1 that are not present
  6290. * in array2.
  6291. */
  6292. function drupal_array_diff_assoc_recursive($array1, $array2) {
  6293. $difference = array();
  6294. foreach ($array1 as $key => $value) {
  6295. if (is_array($value)) {
  6296. if (!array_key_exists($key, $array2) || !is_array($array2[$key])) {
  6297. $difference[$key] = $value;
  6298. }
  6299. else {
  6300. $new_diff = drupal_array_diff_assoc_recursive($value, $array2[$key]);
  6301. if (!empty($new_diff)) {
  6302. $difference[$key] = $new_diff;
  6303. }
  6304. }
  6305. }
  6306. elseif (!array_key_exists($key, $array2) || $array2[$key] !== $value) {
  6307. $difference[$key] = $value;
  6308. }
  6309. }
  6310. return $difference;
  6311. }
  6312. /**
  6313. * Sets a value in a nested array with variable depth.
  6314. *
  6315. * This helper function should be used when the depth of the array element you
  6316. * are changing may vary (that is, the number of parent keys is variable). It
  6317. * is primarily used for form structures and renderable arrays.
  6318. *
  6319. * Example:
  6320. * @code
  6321. * // Assume you have a 'signature' element somewhere in a form. It might be:
  6322. * $form['signature_settings']['signature'] = array(
  6323. * '#type' => 'text_format',
  6324. * '#title' => t('Signature'),
  6325. * );
  6326. * // Or, it might be further nested:
  6327. * $form['signature_settings']['user']['signature'] = array(
  6328. * '#type' => 'text_format',
  6329. * '#title' => t('Signature'),
  6330. * );
  6331. * @endcode
  6332. *
  6333. * To deal with the situation, the code needs to figure out the route to the
  6334. * element, given an array of parents that is either
  6335. * @code array('signature_settings', 'signature') @endcode in the first case or
  6336. * @code array('signature_settings', 'user', 'signature') @endcode in the second
  6337. * case.
  6338. *
  6339. * Without this helper function the only way to set the signature element in one
  6340. * line would be using eval(), which should be avoided:
  6341. * @code
  6342. * // Do not do this! Avoid eval().
  6343. * eval('$form[\'' . implode("']['", $parents) . '\'] = $element;');
  6344. * @endcode
  6345. *
  6346. * Instead, use this helper function:
  6347. * @code
  6348. * drupal_array_set_nested_value($form, $parents, $element);
  6349. * @endcode
  6350. *
  6351. * However if the number of array parent keys is static, the value should always
  6352. * be set directly rather than calling this function. For instance, for the
  6353. * first example we could just do:
  6354. * @code
  6355. * $form['signature_settings']['signature'] = $element;
  6356. * @endcode
  6357. *
  6358. * @param $array
  6359. * A reference to the array to modify.
  6360. * @param $parents
  6361. * An array of parent keys, starting with the outermost key.
  6362. * @param $value
  6363. * The value to set.
  6364. * @param $force
  6365. * (Optional) If TRUE, the value is forced into the structure even if it
  6366. * requires the deletion of an already existing non-array parent value. If
  6367. * FALSE, PHP throws an error if trying to add into a value that is not an
  6368. * array. Defaults to FALSE.
  6369. *
  6370. * @see drupal_array_get_nested_value()
  6371. */
  6372. function drupal_array_set_nested_value(array &$array, array $parents, $value, $force = FALSE) {
  6373. $ref = &$array;
  6374. foreach ($parents as $parent) {
  6375. // PHP auto-creates container arrays and NULL entries without error if $ref
  6376. // is NULL, but throws an error if $ref is set, but not an array.
  6377. if ($force && isset($ref) && !is_array($ref)) {
  6378. $ref = array();
  6379. }
  6380. $ref = &$ref[$parent];
  6381. }
  6382. $ref = $value;
  6383. }
  6384. /**
  6385. * Retrieves a value from a nested array with variable depth.
  6386. *
  6387. * This helper function should be used when the depth of the array element being
  6388. * retrieved may vary (that is, the number of parent keys is variable). It is
  6389. * primarily used for form structures and renderable arrays.
  6390. *
  6391. * Without this helper function the only way to get a nested array value with
  6392. * variable depth in one line would be using eval(), which should be avoided:
  6393. * @code
  6394. * // Do not do this! Avoid eval().
  6395. * // May also throw a PHP notice, if the variable array keys do not exist.
  6396. * eval('$value = $array[\'' . implode("']['", $parents) . "'];");
  6397. * @endcode
  6398. *
  6399. * Instead, use this helper function:
  6400. * @code
  6401. * $value = drupal_array_get_nested_value($form, $parents);
  6402. * @endcode
  6403. *
  6404. * A return value of NULL is ambiguous, and can mean either that the requested
  6405. * key does not exist, or that the actual value is NULL. If it is required to
  6406. * know whether the nested array key actually exists, pass a third argument that
  6407. * is altered by reference:
  6408. * @code
  6409. * $key_exists = NULL;
  6410. * $value = drupal_array_get_nested_value($form, $parents, $key_exists);
  6411. * if ($key_exists) {
  6412. * // ... do something with $value ...
  6413. * }
  6414. * @endcode
  6415. *
  6416. * However if the number of array parent keys is static, the value should always
  6417. * be retrieved directly rather than calling this function. For instance:
  6418. * @code
  6419. * $value = $form['signature_settings']['signature'];
  6420. * @endcode
  6421. *
  6422. * @param $array
  6423. * The array from which to get the value.
  6424. * @param $parents
  6425. * An array of parent keys of the value, starting with the outermost key.
  6426. * @param $key_exists
  6427. * (optional) If given, an already defined variable that is altered by
  6428. * reference.
  6429. *
  6430. * @return
  6431. * The requested nested value. Possibly NULL if the value is NULL or not all
  6432. * nested parent keys exist. $key_exists is altered by reference and is a
  6433. * Boolean that indicates whether all nested parent keys exist (TRUE) or not
  6434. * (FALSE). This allows to distinguish between the two possibilities when NULL
  6435. * is returned.
  6436. *
  6437. * @see drupal_array_set_nested_value()
  6438. */
  6439. function &drupal_array_get_nested_value(array &$array, array $parents, &$key_exists = NULL) {
  6440. $ref = &$array;
  6441. foreach ($parents as $parent) {
  6442. if (is_array($ref) && array_key_exists($parent, $ref)) {
  6443. $ref = &$ref[$parent];
  6444. }
  6445. else {
  6446. $key_exists = FALSE;
  6447. $null = NULL;
  6448. return $null;
  6449. }
  6450. }
  6451. $key_exists = TRUE;
  6452. return $ref;
  6453. }
  6454. /**
  6455. * Determines whether a nested array contains the requested keys.
  6456. *
  6457. * This helper function should be used when the depth of the array element to be
  6458. * checked may vary (that is, the number of parent keys is variable). See
  6459. * drupal_array_set_nested_value() for details. It is primarily used for form
  6460. * structures and renderable arrays.
  6461. *
  6462. * If it is required to also get the value of the checked nested key, use
  6463. * drupal_array_get_nested_value() instead.
  6464. *
  6465. * If the number of array parent keys is static, this helper function is
  6466. * unnecessary and the following code can be used instead:
  6467. * @code
  6468. * $value_exists = isset($form['signature_settings']['signature']);
  6469. * $key_exists = array_key_exists('signature', $form['signature_settings']);
  6470. * @endcode
  6471. *
  6472. * @param $array
  6473. * The array with the value to check for.
  6474. * @param $parents
  6475. * An array of parent keys of the value, starting with the outermost key.
  6476. *
  6477. * @return
  6478. * TRUE if all the parent keys exist, FALSE otherwise.
  6479. *
  6480. * @see drupal_array_get_nested_value()
  6481. */
  6482. function drupal_array_nested_key_exists(array $array, array $parents) {
  6483. // Although this function is similar to PHP's array_key_exists(), its
  6484. // arguments should be consistent with drupal_array_get_nested_value().
  6485. $key_exists = NULL;
  6486. drupal_array_get_nested_value($array, $parents, $key_exists);
  6487. return $key_exists;
  6488. }
  6489. /**
  6490. * Provides theme registration for themes across .inc files.
  6491. */
  6492. function drupal_common_theme() {
  6493. return array(
  6494. // From theme.inc.
  6495. 'html' => array(
  6496. 'render element' => 'page',
  6497. 'template' => 'html',
  6498. ),
  6499. 'page' => array(
  6500. 'render element' => 'page',
  6501. 'template' => 'page',
  6502. ),
  6503. 'region' => array(
  6504. 'render element' => 'elements',
  6505. 'template' => 'region',
  6506. ),
  6507. 'status_messages' => array(
  6508. 'variables' => array('display' => NULL),
  6509. ),
  6510. 'link' => array(
  6511. 'variables' => array('text' => NULL, 'path' => NULL, 'options' => array()),
  6512. ),
  6513. 'links' => array(
  6514. 'variables' => array('links' => NULL, 'attributes' => array('class' => array('links')), 'heading' => array()),
  6515. ),
  6516. 'image' => array(
  6517. // HTML 4 and XHTML 1.0 always require an alt attribute. The HTML 5 draft
  6518. // allows the alt attribute to be omitted in some cases. Therefore,
  6519. // default the alt attribute to an empty string, but allow code calling
  6520. // theme('image') to pass explicit NULL for it to be omitted. Usually,
  6521. // neither omission nor an empty string satisfies accessibility
  6522. // requirements, so it is strongly encouraged for code calling
  6523. // theme('image') to pass a meaningful value for the alt variable.
  6524. // - http://www.w3.org/TR/REC-html40/struct/objects.html#h-13.8
  6525. // - http://www.w3.org/TR/xhtml1/dtds.html
  6526. // - http://dev.w3.org/html5/spec/Overview.html#alt
  6527. // The title attribute is optional in all cases, so it is omitted by
  6528. // default.
  6529. 'variables' => array('path' => NULL, 'width' => NULL, 'height' => NULL, 'alt' => '', 'title' => NULL, 'attributes' => array()),
  6530. ),
  6531. 'breadcrumb' => array(
  6532. 'variables' => array('breadcrumb' => NULL),
  6533. ),
  6534. 'help' => array(
  6535. 'variables' => array(),
  6536. ),
  6537. 'table' => array(
  6538. 'variables' => array(
  6539. 'header' => NULL,
  6540. 'footer' => NULL,
  6541. 'rows' => NULL,
  6542. 'attributes' => array(),
  6543. 'caption' => NULL,
  6544. 'colgroups' => array(),
  6545. 'sticky' => TRUE,
  6546. 'empty' => '',
  6547. ),
  6548. ),
  6549. 'tablesort_indicator' => array(
  6550. 'variables' => array('style' => NULL),
  6551. ),
  6552. 'mark' => array(
  6553. 'variables' => array('type' => MARK_NEW),
  6554. ),
  6555. 'item_list' => array(
  6556. 'variables' => array('items' => array(), 'title' => NULL, 'type' => 'ul', 'attributes' => array()),
  6557. ),
  6558. 'more_help_link' => array(
  6559. 'variables' => array('url' => NULL),
  6560. ),
  6561. 'feed_icon' => array(
  6562. 'variables' => array('url' => NULL, 'title' => NULL),
  6563. ),
  6564. 'more_link' => array(
  6565. 'variables' => array('url' => NULL, 'title' => NULL)
  6566. ),
  6567. 'username' => array(
  6568. 'variables' => array('account' => NULL),
  6569. ),
  6570. 'progress_bar' => array(
  6571. 'variables' => array('percent' => NULL, 'message' => NULL),
  6572. ),
  6573. 'indentation' => array(
  6574. 'variables' => array('size' => 1),
  6575. ),
  6576. 'html_tag' => array(
  6577. 'render element' => 'element',
  6578. ),
  6579. // From theme.maintenance.inc.
  6580. 'maintenance_page' => array(
  6581. 'variables' => array('content' => NULL, 'show_messages' => TRUE),
  6582. 'template' => 'maintenance-page',
  6583. ),
  6584. 'update_page' => array(
  6585. 'variables' => array('content' => NULL, 'show_messages' => TRUE),
  6586. ),
  6587. 'install_page' => array(
  6588. 'variables' => array('content' => NULL),
  6589. ),
  6590. 'task_list' => array(
  6591. 'variables' => array('items' => NULL, 'active' => NULL),
  6592. ),
  6593. 'authorize_message' => array(
  6594. 'variables' => array('message' => NULL, 'success' => TRUE),
  6595. ),
  6596. 'authorize_report' => array(
  6597. 'variables' => array('messages' => array()),
  6598. ),
  6599. // From pager.inc.
  6600. 'pager' => array(
  6601. 'variables' => array('tags' => array(), 'element' => 0, 'parameters' => array(), 'quantity' => 9),
  6602. ),
  6603. 'pager_first' => array(
  6604. 'variables' => array('text' => NULL, 'element' => 0, 'parameters' => array()),
  6605. ),
  6606. 'pager_previous' => array(
  6607. 'variables' => array('text' => NULL, 'element' => 0, 'interval' => 1, 'parameters' => array()),
  6608. ),
  6609. 'pager_next' => array(
  6610. 'variables' => array('text' => NULL, 'element' => 0, 'interval' => 1, 'parameters' => array()),
  6611. ),
  6612. 'pager_last' => array(
  6613. 'variables' => array('text' => NULL, 'element' => 0, 'parameters' => array()),
  6614. ),
  6615. 'pager_link' => array(
  6616. 'variables' => array('text' => NULL, 'page_new' => NULL, 'element' => NULL, 'parameters' => array(), 'attributes' => array()),
  6617. ),
  6618. // From menu.inc.
  6619. 'menu_link' => array(
  6620. 'render element' => 'element',
  6621. ),
  6622. 'menu_tree' => array(
  6623. 'render element' => 'tree',
  6624. ),
  6625. 'menu_local_task' => array(
  6626. 'render element' => 'element',
  6627. ),
  6628. 'menu_local_action' => array(
  6629. 'render element' => 'element',
  6630. ),
  6631. 'menu_local_tasks' => array(
  6632. 'variables' => array('primary' => array(), 'secondary' => array()),
  6633. ),
  6634. // From form.inc.
  6635. 'select' => array(
  6636. 'render element' => 'element',
  6637. ),
  6638. 'fieldset' => array(
  6639. 'render element' => 'element',
  6640. ),
  6641. 'radio' => array(
  6642. 'render element' => 'element',
  6643. ),
  6644. 'radios' => array(
  6645. 'render element' => 'element',
  6646. ),
  6647. 'date' => array(
  6648. 'render element' => 'element',
  6649. ),
  6650. 'exposed_filters' => array(
  6651. 'render element' => 'form',
  6652. ),
  6653. 'checkbox' => array(
  6654. 'render element' => 'element',
  6655. ),
  6656. 'checkboxes' => array(
  6657. 'render element' => 'element',
  6658. ),
  6659. 'button' => array(
  6660. 'render element' => 'element',
  6661. ),
  6662. 'image_button' => array(
  6663. 'render element' => 'element',
  6664. ),
  6665. 'hidden' => array(
  6666. 'render element' => 'element',
  6667. ),
  6668. 'textfield' => array(
  6669. 'render element' => 'element',
  6670. ),
  6671. 'form' => array(
  6672. 'render element' => 'element',
  6673. ),
  6674. 'textarea' => array(
  6675. 'render element' => 'element',
  6676. ),
  6677. 'password' => array(
  6678. 'render element' => 'element',
  6679. ),
  6680. 'file' => array(
  6681. 'render element' => 'element',
  6682. ),
  6683. 'tableselect' => array(
  6684. 'render element' => 'element',
  6685. ),
  6686. 'form_element' => array(
  6687. 'render element' => 'element',
  6688. ),
  6689. 'form_required_marker' => array(
  6690. 'render element' => 'element',
  6691. ),
  6692. 'form_element_label' => array(
  6693. 'render element' => 'element',
  6694. ),
  6695. 'vertical_tabs' => array(
  6696. 'render element' => 'element',
  6697. ),
  6698. 'container' => array(
  6699. 'render element' => 'element',
  6700. ),
  6701. );
  6702. }
  6703. /**
  6704. * @addtogroup schemaapi
  6705. * @{
  6706. */
  6707. /**
  6708. * Creates all tables defined in a module's hook_schema().
  6709. *
  6710. * Note: This function does not pass the module's schema through
  6711. * hook_schema_alter(). The module's tables will be created exactly as the
  6712. * module defines them.
  6713. *
  6714. * @param $module
  6715. * The module for which the tables will be created.
  6716. */
  6717. function drupal_install_schema($module) {
  6718. $schema = drupal_get_schema_unprocessed($module);
  6719. _drupal_schema_initialize($schema, $module, FALSE);
  6720. foreach ($schema as $name => $table) {
  6721. db_create_table($name, $table);
  6722. }
  6723. }
  6724. /**
  6725. * Removes all tables defined in a module's hook_schema().
  6726. *
  6727. * Note: This function does not pass the module's schema through
  6728. * hook_schema_alter(). The module's tables will be created exactly as the
  6729. * module defines them.
  6730. *
  6731. * @param $module
  6732. * The module for which the tables will be removed.
  6733. *
  6734. * @return
  6735. * An array of arrays with the following key/value pairs:
  6736. * - success: a boolean indicating whether the query succeeded.
  6737. * - query: the SQL query(s) executed, passed through check_plain().
  6738. */
  6739. function drupal_uninstall_schema($module) {
  6740. $schema = drupal_get_schema_unprocessed($module);
  6741. _drupal_schema_initialize($schema, $module, FALSE);
  6742. foreach ($schema as $table) {
  6743. if (db_table_exists($table['name'])) {
  6744. db_drop_table($table['name']);
  6745. }
  6746. }
  6747. }
  6748. /**
  6749. * Returns the unprocessed and unaltered version of a module's schema.
  6750. *
  6751. * Use this function only if you explicitly need the original
  6752. * specification of a schema, as it was defined in a module's
  6753. * hook_schema(). No additional default values will be set,
  6754. * hook_schema_alter() is not invoked and these unprocessed
  6755. * definitions won't be cached. To retrieve the schema after
  6756. * hook_schema_alter() has been invoked use drupal_get_schema().
  6757. *
  6758. * This function can be used to retrieve a schema specification in
  6759. * hook_schema(), so it allows you to derive your tables from existing
  6760. * specifications.
  6761. *
  6762. * It is also used by drupal_install_schema() and
  6763. * drupal_uninstall_schema() to ensure that a module's tables are
  6764. * created exactly as specified without any changes introduced by a
  6765. * module that implements hook_schema_alter().
  6766. *
  6767. * @param $module
  6768. * The module to which the table belongs.
  6769. * @param $table
  6770. * The name of the table. If not given, the module's complete schema
  6771. * is returned.
  6772. */
  6773. function drupal_get_schema_unprocessed($module, $table = NULL) {
  6774. // Load the .install file to get hook_schema.
  6775. module_load_install($module);
  6776. $schema = module_invoke($module, 'schema');
  6777. if (isset($table) && isset($schema[$table])) {
  6778. return $schema[$table];
  6779. }
  6780. elseif (!empty($schema)) {
  6781. return $schema;
  6782. }
  6783. return array();
  6784. }
  6785. /**
  6786. * Fills in required default values for table definitions from hook_schema().
  6787. *
  6788. * @param $schema
  6789. * The schema definition array as it was returned by the module's
  6790. * hook_schema().
  6791. * @param $module
  6792. * The module for which hook_schema() was invoked.
  6793. * @param $remove_descriptions
  6794. * (optional) Whether to additionally remove 'description' keys of all tables
  6795. * and fields to improve performance of serialize() and unserialize().
  6796. * Defaults to TRUE.
  6797. */
  6798. function _drupal_schema_initialize(&$schema, $module, $remove_descriptions = TRUE) {
  6799. // Set the name and module key for all tables.
  6800. foreach ($schema as $name => &$table) {
  6801. if (empty($table['module'])) {
  6802. $table['module'] = $module;
  6803. }
  6804. if (!isset($table['name'])) {
  6805. $table['name'] = $name;
  6806. }
  6807. if ($remove_descriptions) {
  6808. unset($table['description']);
  6809. foreach ($table['fields'] as &$field) {
  6810. unset($field['description']);
  6811. }
  6812. }
  6813. }
  6814. }
  6815. /**
  6816. * Retrieves the type for every field in a table schema.
  6817. *
  6818. * @param $table
  6819. * The name of the table from which to retrieve type information.
  6820. *
  6821. * @return
  6822. * An array of types, keyed by field name.
  6823. */
  6824. function drupal_schema_field_types($table) {
  6825. $table_schema = drupal_get_schema($table);
  6826. $field_types = array();
  6827. foreach ($table_schema['fields'] as $field_name => $field_info) {
  6828. $field_types[$field_name] = isset($field_info['type']) ? $field_info['type'] : NULL;
  6829. }
  6830. return $field_types;
  6831. }
  6832. /**
  6833. * Retrieves a list of fields from a table schema.
  6834. *
  6835. * The returned list is suitable for use in an SQL query.
  6836. *
  6837. * @param $table
  6838. * The name of the table from which to retrieve fields.
  6839. * @param
  6840. * An optional prefix to to all fields.
  6841. *
  6842. * @return An array of fields.
  6843. */
  6844. function drupal_schema_fields_sql($table, $prefix = NULL) {
  6845. $schema = drupal_get_schema($table);
  6846. $fields = array_keys($schema['fields']);
  6847. if ($prefix) {
  6848. $columns = array();
  6849. foreach ($fields as $field) {
  6850. $columns[] = "$prefix.$field";
  6851. }
  6852. return $columns;
  6853. }
  6854. else {
  6855. return $fields;
  6856. }
  6857. }
  6858. /**
  6859. * Saves (inserts or updates) a record to the database based upon the schema.
  6860. *
  6861. * Do not use drupal_write_record() within hook_update_N() functions, since the
  6862. * database schema cannot be relied upon when a user is running a series of
  6863. * updates. Instead, use db_insert() or db_update() to save the record.
  6864. *
  6865. * @param $table
  6866. * The name of the table; this must be defined by a hook_schema()
  6867. * implementation.
  6868. * @param $record
  6869. * An object or array representing the record to write, passed in by
  6870. * reference. If inserting a new record, values not provided in $record will
  6871. * be populated in $record and in the database with the default values from
  6872. * the schema, as well as a single serial (auto-increment) field (if present).
  6873. * If updating an existing record, only provided values are updated in the
  6874. * database, and $record is not modified.
  6875. * @param $primary_keys
  6876. * To indicate that this is a new record to be inserted, omit this argument.
  6877. * If this is an update, this argument specifies the primary keys' field
  6878. * names. If there is only 1 field in the key, you may pass in a string; if
  6879. * there are multiple fields in the key, pass in an array.
  6880. *
  6881. * @return
  6882. * If the record insert or update failed, returns FALSE. If it succeeded,
  6883. * returns SAVED_NEW or SAVED_UPDATED, depending on the operation performed.
  6884. */
  6885. function drupal_write_record($table, &$record, $primary_keys = array()) {
  6886. // Standardize $primary_keys to an array.
  6887. if (is_string($primary_keys)) {
  6888. $primary_keys = array($primary_keys);
  6889. }
  6890. $schema = drupal_get_schema($table);
  6891. if (empty($schema)) {
  6892. return FALSE;
  6893. }
  6894. $object = (object) $record;
  6895. $fields = array();
  6896. // Go through the schema to determine fields to write.
  6897. foreach ($schema['fields'] as $field => $info) {
  6898. if ($info['type'] == 'serial') {
  6899. // Skip serial types if we are updating.
  6900. if (!empty($primary_keys)) {
  6901. continue;
  6902. }
  6903. // Track serial field so we can helpfully populate them after the query.
  6904. // NOTE: Each table should come with one serial field only.
  6905. $serial = $field;
  6906. }
  6907. // Skip field if it is in $primary_keys as it is unnecessary to update a
  6908. // field to the value it is already set to.
  6909. if (in_array($field, $primary_keys)) {
  6910. continue;
  6911. }
  6912. if (!property_exists($object, $field)) {
  6913. // Skip fields that are not provided, default values are already known
  6914. // by the database.
  6915. continue;
  6916. }
  6917. // Build array of fields to update or insert.
  6918. if (empty($info['serialize'])) {
  6919. $fields[$field] = $object->$field;
  6920. }
  6921. else {
  6922. $fields[$field] = serialize($object->$field);
  6923. }
  6924. // Type cast to proper datatype, except when the value is NULL and the
  6925. // column allows this.
  6926. //
  6927. // MySQL PDO silently casts e.g. FALSE and '' to 0 when inserting the value
  6928. // into an integer column, but PostgreSQL PDO does not. Also type cast NULL
  6929. // when the column does not allow this.
  6930. if (isset($object->$field) || !empty($info['not null'])) {
  6931. if ($info['type'] == 'int' || $info['type'] == 'serial') {
  6932. $fields[$field] = (int) $fields[$field];
  6933. }
  6934. elseif ($info['type'] == 'float') {
  6935. $fields[$field] = (float) $fields[$field];
  6936. }
  6937. else {
  6938. $fields[$field] = (string) $fields[$field];
  6939. }
  6940. }
  6941. }
  6942. if (empty($fields)) {
  6943. return;
  6944. }
  6945. // Build the SQL.
  6946. if (empty($primary_keys)) {
  6947. // We are doing an insert.
  6948. $options = array('return' => Database::RETURN_INSERT_ID);
  6949. if (isset($serial) && isset($fields[$serial])) {
  6950. // If the serial column has been explicitly set with an ID, then we don't
  6951. // require the database to return the last insert id.
  6952. if ($fields[$serial]) {
  6953. $options['return'] = Database::RETURN_AFFECTED;
  6954. }
  6955. // If a serial column does exist with no value (i.e. 0) then remove it as
  6956. // the database will insert the correct value for us.
  6957. else {
  6958. unset($fields[$serial]);
  6959. }
  6960. }
  6961. $query = db_insert($table, $options)->fields($fields);
  6962. $return = SAVED_NEW;
  6963. }
  6964. else {
  6965. $query = db_update($table)->fields($fields);
  6966. foreach ($primary_keys as $key) {
  6967. $query->condition($key, $object->$key);
  6968. }
  6969. $return = SAVED_UPDATED;
  6970. }
  6971. // Execute the SQL.
  6972. if ($query_return = $query->execute()) {
  6973. if (isset($serial)) {
  6974. // If the database was not told to return the last insert id, it will be
  6975. // because we already know it.
  6976. if (isset($options) && $options['return'] != Database::RETURN_INSERT_ID) {
  6977. $object->$serial = $fields[$serial];
  6978. }
  6979. else {
  6980. $object->$serial = $query_return;
  6981. }
  6982. }
  6983. }
  6984. // If we have a single-field primary key but got no insert ID, the
  6985. // query failed. Note that we explicitly check for FALSE, because
  6986. // a valid update query which doesn't change any values will return
  6987. // zero (0) affected rows.
  6988. elseif ($query_return === FALSE && count($primary_keys) == 1) {
  6989. $return = FALSE;
  6990. }
  6991. // If we are inserting, populate empty fields with default values.
  6992. if (empty($primary_keys)) {
  6993. foreach ($schema['fields'] as $field => $info) {
  6994. if (isset($info['default']) && !property_exists($object, $field)) {
  6995. $object->$field = $info['default'];
  6996. }
  6997. }
  6998. }
  6999. // If we began with an array, convert back.
  7000. if (is_array($record)) {
  7001. $record = (array) $object;
  7002. }
  7003. return $return;
  7004. }
  7005. /**
  7006. * @} End of "addtogroup schemaapi".
  7007. */
  7008. /**
  7009. * Parses Drupal module and theme .info files.
  7010. *
  7011. * Info files are NOT for placing arbitrary theme and module-specific settings.
  7012. * Use variable_get() and variable_set() for that.
  7013. *
  7014. * Information stored in a module .info file:
  7015. * - name: The real name of the module for display purposes.
  7016. * - description: A brief description of the module.
  7017. * - dependencies: An array of dependency strings. Each is in the form
  7018. * 'project:module (versions)'; with the following meanings:
  7019. * - project: (optional) Project shortname, recommended to ensure uniqueness,
  7020. * if the module is part of a project hosted on drupal.org. If omitted,
  7021. * also omit the : that follows. The project name is currently ignored by
  7022. * Drupal core but is used for automated testing.
  7023. * - module: (required) Module shortname within the project.
  7024. * - (versions): Optional version information, consisting of one or more
  7025. * comma-separated operator/value pairs or simply version numbers, which
  7026. * can contain "x" as a wildcard. Examples: (>=7.22, <7.28), (7.x-3.x).
  7027. * - package: The name of the package of modules this module belongs to.
  7028. *
  7029. * See forum.info for an example of a module .info file.
  7030. *
  7031. * Information stored in a theme .info file:
  7032. * - name: The real name of the theme for display purposes.
  7033. * - description: Brief description.
  7034. * - screenshot: Path to screenshot relative to the theme's .info file.
  7035. * - engine: Theme engine; typically phptemplate.
  7036. * - base: Name of a base theme, if applicable; e.g., base = zen.
  7037. * - regions: Listed regions; e.g., region[left] = Left sidebar.
  7038. * - features: Features available; e.g., features[] = logo.
  7039. * - stylesheets: Theme stylesheets; e.g., stylesheets[all][] = my-style.css.
  7040. * - scripts: Theme scripts; e.g., scripts[] = my-script.js.
  7041. *
  7042. * See bartik.info for an example of a theme .info file.
  7043. *
  7044. * @param $filename
  7045. * The file we are parsing. Accepts file with relative or absolute path.
  7046. *
  7047. * @return
  7048. * The info array.
  7049. *
  7050. * @see drupal_parse_info_format()
  7051. */
  7052. function drupal_parse_info_file($filename) {
  7053. $info = &drupal_static(__FUNCTION__, array());
  7054. if (!isset($info[$filename])) {
  7055. if (!file_exists($filename)) {
  7056. $info[$filename] = array();
  7057. }
  7058. else {
  7059. $data = file_get_contents($filename);
  7060. $info[$filename] = drupal_parse_info_format($data);
  7061. }
  7062. }
  7063. return $info[$filename];
  7064. }
  7065. /**
  7066. * Parses data in Drupal's .info format.
  7067. *
  7068. * Data should be in an .ini-like format to specify values. White-space
  7069. * generally doesn't matter, except inside values:
  7070. * @code
  7071. * key = value
  7072. * key = "value"
  7073. * key = 'value'
  7074. * key = "multi-line
  7075. * value"
  7076. * key = 'multi-line
  7077. * value'
  7078. * key
  7079. * =
  7080. * 'value'
  7081. * @endcode
  7082. *
  7083. * Arrays are created using a HTTP GET alike syntax:
  7084. * @code
  7085. * key[] = "numeric array"
  7086. * key[index] = "associative array"
  7087. * key[index][] = "nested numeric array"
  7088. * key[index][index] = "nested associative array"
  7089. * @endcode
  7090. *
  7091. * PHP constants are substituted in, but only when used as the entire value.
  7092. * Comments should start with a semi-colon at the beginning of a line.
  7093. *
  7094. * @param $data
  7095. * A string to parse.
  7096. *
  7097. * @return
  7098. * The info array.
  7099. *
  7100. * @see drupal_parse_info_file()
  7101. */
  7102. function drupal_parse_info_format($data) {
  7103. $info = array();
  7104. if (preg_match_all('
  7105. @^\s* # Start at the beginning of a line, ignoring leading whitespace
  7106. ((?:
  7107. [^=;\[\]]| # Key names cannot contain equal signs, semi-colons or square brackets,
  7108. \[[^\[\]]*\] # unless they are balanced and not nested
  7109. )+?)
  7110. \s*=\s* # Key/value pairs are separated by equal signs (ignoring white-space)
  7111. (?:
  7112. ("(?:[^"]|(?<=\\\\)")*")| # Double-quoted string, which may contain slash-escaped quotes/slashes
  7113. (\'(?:[^\']|(?<=\\\\)\')*\')| # Single-quoted string, which may contain slash-escaped quotes/slashes
  7114. ([^\r\n]*?) # Non-quoted string
  7115. )\s*$ # Stop at the next end of a line, ignoring trailing whitespace
  7116. @msx', $data, $matches, PREG_SET_ORDER)) {
  7117. foreach ($matches as $match) {
  7118. // Fetch the key and value string.
  7119. $i = 0;
  7120. foreach (array('key', 'value1', 'value2', 'value3') as $var) {
  7121. $$var = isset($match[++$i]) ? $match[$i] : '';
  7122. }
  7123. $value = stripslashes(substr($value1, 1, -1)) . stripslashes(substr($value2, 1, -1)) . $value3;
  7124. // Parse array syntax.
  7125. $keys = preg_split('/\]?\[/', rtrim($key, ']'));
  7126. $last = array_pop($keys);
  7127. $parent = &$info;
  7128. // Create nested arrays.
  7129. foreach ($keys as $key) {
  7130. if ($key == '') {
  7131. $key = count($parent);
  7132. }
  7133. if (!isset($parent[$key]) || !is_array($parent[$key])) {
  7134. $parent[$key] = array();
  7135. }
  7136. $parent = &$parent[$key];
  7137. }
  7138. // Handle PHP constants.
  7139. if (preg_match('/^\w+$/i', $value) && defined($value)) {
  7140. $value = constant($value);
  7141. }
  7142. // Insert actual value.
  7143. if ($last == '') {
  7144. $last = count($parent);
  7145. }
  7146. $parent[$last] = $value;
  7147. }
  7148. }
  7149. return $info;
  7150. }
  7151. /**
  7152. * Returns a list of severity levels, as defined in RFC 3164.
  7153. *
  7154. * @return
  7155. * Array of the possible severity levels for log messages.
  7156. *
  7157. * @see http://www.ietf.org/rfc/rfc3164.txt
  7158. * @see watchdog()
  7159. * @ingroup logging_severity_levels
  7160. */
  7161. function watchdog_severity_levels() {
  7162. return array(
  7163. WATCHDOG_EMERGENCY => t('emergency'),
  7164. WATCHDOG_ALERT => t('alert'),
  7165. WATCHDOG_CRITICAL => t('critical'),
  7166. WATCHDOG_ERROR => t('error'),
  7167. WATCHDOG_WARNING => t('warning'),
  7168. WATCHDOG_NOTICE => t('notice'),
  7169. WATCHDOG_INFO => t('info'),
  7170. WATCHDOG_DEBUG => t('debug'),
  7171. );
  7172. }
  7173. /**
  7174. * Explodes a string of tags into an array.
  7175. *
  7176. * @see drupal_implode_tags()
  7177. */
  7178. function drupal_explode_tags($tags) {
  7179. // This regexp allows the following types of user input:
  7180. // this, "somecompany, llc", "and ""this"" w,o.rks", foo bar
  7181. $regexp = '%(?:^|,\ *)("(?>[^"]*)(?>""[^"]* )*"|(?: [^",]*))%x';
  7182. preg_match_all($regexp, $tags, $matches);
  7183. $typed_tags = array_unique($matches[1]);
  7184. $tags = array();
  7185. foreach ($typed_tags as $tag) {
  7186. // If a user has escaped a term (to demonstrate that it is a group,
  7187. // or includes a comma or quote character), we remove the escape
  7188. // formatting so to save the term into the database as the user intends.
  7189. $tag = trim(str_replace('""', '"', preg_replace('/^"(.*)"$/', '\1', $tag)));
  7190. if ($tag != "") {
  7191. $tags[] = $tag;
  7192. }
  7193. }
  7194. return $tags;
  7195. }
  7196. /**
  7197. * Implodes an array of tags into a string.
  7198. *
  7199. * @see drupal_explode_tags()
  7200. */
  7201. function drupal_implode_tags($tags) {
  7202. $encoded_tags = array();
  7203. foreach ($tags as $tag) {
  7204. // Commas and quotes in tag names are special cases, so encode them.
  7205. if (strpos($tag, ',') !== FALSE || strpos($tag, '"') !== FALSE) {
  7206. $tag = '"' . str_replace('"', '""', $tag) . '"';
  7207. }
  7208. $encoded_tags[] = $tag;
  7209. }
  7210. return implode(', ', $encoded_tags);
  7211. }
  7212. /**
  7213. * Flushes all cached data on the site.
  7214. *
  7215. * Empties cache tables, rebuilds the menu cache and theme registries, and
  7216. * invokes a hook so that other modules' cache data can be cleared as well.
  7217. */
  7218. function drupal_flush_all_caches() {
  7219. // Change query-strings on css/js files to enforce reload for all users.
  7220. _drupal_flush_css_js();
  7221. registry_rebuild();
  7222. drupal_clear_css_cache();
  7223. drupal_clear_js_cache();
  7224. // Rebuild the theme data. Note that the module data is rebuilt above, as
  7225. // part of registry_rebuild().
  7226. system_rebuild_theme_data();
  7227. drupal_theme_rebuild();
  7228. entity_info_cache_clear();
  7229. node_types_rebuild();
  7230. // node_menu() defines menu items based on node types so it needs to come
  7231. // after node types are rebuilt.
  7232. menu_rebuild();
  7233. // Synchronize to catch any actions that were added or removed.
  7234. actions_synchronize();
  7235. // Don't clear cache_form - in-progress form submissions may break.
  7236. // Ordered so clearing the page cache will always be the last action.
  7237. $core = array('cache', 'cache_path', 'cache_filter', 'cache_bootstrap', 'cache_page');
  7238. $cache_tables = array_merge(module_invoke_all('flush_caches'), $core);
  7239. foreach ($cache_tables as $table) {
  7240. cache_clear_all('*', $table, TRUE);
  7241. }
  7242. // Rebuild the bootstrap module list. We do this here so that developers
  7243. // can get new hook_boot() implementations registered without having to
  7244. // write a hook_update_N() function.
  7245. _system_update_bootstrap_status();
  7246. }
  7247. /**
  7248. * Changes the dummy query string added to all CSS and JavaScript files.
  7249. *
  7250. * Changing the dummy query string appended to CSS and JavaScript files forces
  7251. * all browsers to reload fresh files.
  7252. */
  7253. function _drupal_flush_css_js() {
  7254. // The timestamp is converted to base 36 in order to make it more compact.
  7255. variable_set('css_js_query_string', base_convert(REQUEST_TIME, 10, 36));
  7256. }
  7257. /**
  7258. * Outputs debug information.
  7259. *
  7260. * The debug information is passed on to trigger_error() after being converted
  7261. * to a string using _drupal_debug_message().
  7262. *
  7263. * @param $data
  7264. * Data to be output.
  7265. * @param $label
  7266. * Label to prefix the data.
  7267. * @param $print_r
  7268. * Flag to switch between print_r() and var_export() for data conversion to
  7269. * string. Set $print_r to TRUE when dealing with a recursive data structure
  7270. * as var_export() will generate an error.
  7271. */
  7272. function debug($data, $label = NULL, $print_r = FALSE) {
  7273. // Print $data contents to string.
  7274. $string = check_plain($print_r ? print_r($data, TRUE) : var_export($data, TRUE));
  7275. // Display values with pre-formatting to increase readability.
  7276. $string = '<pre>' . $string . '</pre>';
  7277. trigger_error(trim($label ? "$label: $string" : $string));
  7278. }
  7279. /**
  7280. * Parses a dependency for comparison by drupal_check_incompatibility().
  7281. *
  7282. * @param $dependency
  7283. * A dependency string, which specifies a module dependency, and optionally
  7284. * the project it comes from and versions that are supported. Supported
  7285. * formats include:
  7286. * - 'module'
  7287. * - 'project:module'
  7288. * - 'project:module (>=version, version)'
  7289. *
  7290. * @return
  7291. * An associative array with three keys:
  7292. * - 'name' includes the name of the thing to depend on (e.g. 'foo').
  7293. * - 'original_version' contains the original version string (which can be
  7294. * used in the UI for reporting incompatibilities).
  7295. * - 'versions' is a list of associative arrays, each containing the keys
  7296. * 'op' and 'version'. 'op' can be one of: '=', '==', '!=', '<>', '<',
  7297. * '<=', '>', or '>='. 'version' is one piece like '4.5-beta3'.
  7298. * Callers should pass this structure to drupal_check_incompatibility().
  7299. *
  7300. * @see drupal_check_incompatibility()
  7301. */
  7302. function drupal_parse_dependency($dependency) {
  7303. $value = array();
  7304. // Split out the optional project name.
  7305. if (strpos($dependency, ':')) {
  7306. list($project_name, $dependency) = explode(':', $dependency);
  7307. $value['project'] = $project_name;
  7308. }
  7309. // We use named subpatterns and support every op that version_compare
  7310. // supports. Also, op is optional and defaults to equals.
  7311. $p_op = '(?P<operation>!=|==|=|<|<=|>|>=|<>)?';
  7312. // Core version is always optional: 7.x-2.x and 2.x is treated the same.
  7313. $p_core = '(?:' . preg_quote(DRUPAL_CORE_COMPATIBILITY) . '-)?';
  7314. $p_major = '(?P<major>\d+)';
  7315. // By setting the minor version to x, branches can be matched.
  7316. $p_minor = '(?P<minor>(?:\d+|x)(?:-[A-Za-z]+\d+)?)';
  7317. $parts = explode('(', $dependency, 2);
  7318. $value['name'] = trim($parts[0]);
  7319. if (isset($parts[1])) {
  7320. $value['original_version'] = ' (' . $parts[1];
  7321. foreach (explode(',', $parts[1]) as $version) {
  7322. if (preg_match("/^\s*$p_op\s*$p_core$p_major\.$p_minor/", $version, $matches)) {
  7323. $op = !empty($matches['operation']) ? $matches['operation'] : '=';
  7324. if ($matches['minor'] == 'x') {
  7325. // Drupal considers "2.x" to mean any version that begins with
  7326. // "2" (e.g. 2.0, 2.9 are all "2.x"). PHP's version_compare(),
  7327. // on the other hand, treats "x" as a string; so to
  7328. // version_compare(), "2.x" is considered less than 2.0. This
  7329. // means that >=2.x and <2.x are handled by version_compare()
  7330. // as we need, but > and <= are not.
  7331. if ($op == '>' || $op == '<=') {
  7332. $matches['major']++;
  7333. }
  7334. // Equivalence can be checked by adding two restrictions.
  7335. if ($op == '=' || $op == '==') {
  7336. $value['versions'][] = array('op' => '<', 'version' => ($matches['major'] + 1) . '.x');
  7337. $op = '>=';
  7338. }
  7339. }
  7340. $value['versions'][] = array('op' => $op, 'version' => $matches['major'] . '.' . $matches['minor']);
  7341. }
  7342. }
  7343. }
  7344. return $value;
  7345. }
  7346. /**
  7347. * Checks whether a version is compatible with a given dependency.
  7348. *
  7349. * @param $v
  7350. * The parsed dependency structure from drupal_parse_dependency().
  7351. * @param $current_version
  7352. * The version to check against (like 4.2).
  7353. *
  7354. * @return
  7355. * NULL if compatible, otherwise the original dependency version string that
  7356. * caused the incompatibility.
  7357. *
  7358. * @see drupal_parse_dependency()
  7359. */
  7360. function drupal_check_incompatibility($v, $current_version) {
  7361. if (!empty($v['versions'])) {
  7362. foreach ($v['versions'] as $required_version) {
  7363. if ((isset($required_version['op']) && !version_compare($current_version, $required_version['version'], $required_version['op']))) {
  7364. return $v['original_version'];
  7365. }
  7366. }
  7367. }
  7368. }
  7369. /**
  7370. * Get the entity info array of an entity type.
  7371. *
  7372. * @param $entity_type
  7373. * The entity type, e.g. node, for which the info shall be returned, or NULL
  7374. * to return an array with info about all types.
  7375. *
  7376. * @see hook_entity_info()
  7377. * @see hook_entity_info_alter()
  7378. */
  7379. function entity_get_info($entity_type = NULL) {
  7380. global $language;
  7381. // Use the advanced drupal_static() pattern, since this is called very often.
  7382. static $drupal_static_fast;
  7383. if (!isset($drupal_static_fast)) {
  7384. $drupal_static_fast['entity_info'] = &drupal_static(__FUNCTION__);
  7385. }
  7386. $entity_info = &$drupal_static_fast['entity_info'];
  7387. // hook_entity_info() includes translated strings, so each language is cached
  7388. // separately.
  7389. $langcode = $language->language;
  7390. if (empty($entity_info)) {
  7391. if ($cache = cache_get("entity_info:$langcode")) {
  7392. $entity_info = $cache->data;
  7393. }
  7394. else {
  7395. $entity_info = module_invoke_all('entity_info');
  7396. // Merge in default values.
  7397. foreach ($entity_info as $name => $data) {
  7398. $entity_info[$name] += array(
  7399. 'fieldable' => FALSE,
  7400. 'controller class' => 'DrupalDefaultEntityController',
  7401. 'static cache' => TRUE,
  7402. 'field cache' => TRUE,
  7403. 'load hook' => $name . '_load',
  7404. 'bundles' => array(),
  7405. 'view modes' => array(),
  7406. 'entity keys' => array(),
  7407. 'translation' => array(),
  7408. );
  7409. $entity_info[$name]['entity keys'] += array(
  7410. 'revision' => '',
  7411. 'bundle' => '',
  7412. );
  7413. foreach ($entity_info[$name]['view modes'] as $view_mode => $view_mode_info) {
  7414. $entity_info[$name]['view modes'][$view_mode] += array(
  7415. 'custom settings' => FALSE,
  7416. );
  7417. }
  7418. // If no bundle key is provided, assume a single bundle, named after
  7419. // the entity type.
  7420. if (empty($entity_info[$name]['entity keys']['bundle']) && empty($entity_info[$name]['bundles'])) {
  7421. $entity_info[$name]['bundles'] = array($name => array('label' => $entity_info[$name]['label']));
  7422. }
  7423. // Prepare entity schema fields SQL info for
  7424. // DrupalEntityControllerInterface::buildQuery().
  7425. if (isset($entity_info[$name]['base table'])) {
  7426. $entity_info[$name]['base table field types'] = drupal_schema_field_types($entity_info[$name]['base table']);
  7427. $entity_info[$name]['schema_fields_sql']['base table'] = drupal_schema_fields_sql($entity_info[$name]['base table']);
  7428. if (isset($entity_info[$name]['revision table'])) {
  7429. $entity_info[$name]['schema_fields_sql']['revision table'] = drupal_schema_fields_sql($entity_info[$name]['revision table']);
  7430. }
  7431. }
  7432. }
  7433. // Let other modules alter the entity info.
  7434. drupal_alter('entity_info', $entity_info);
  7435. cache_set("entity_info:$langcode", $entity_info);
  7436. }
  7437. }
  7438. if (empty($entity_type)) {
  7439. return $entity_info;
  7440. }
  7441. elseif (isset($entity_info[$entity_type])) {
  7442. return $entity_info[$entity_type];
  7443. }
  7444. }
  7445. /**
  7446. * Resets the cached information about entity types.
  7447. */
  7448. function entity_info_cache_clear() {
  7449. drupal_static_reset('entity_get_info');
  7450. // Clear all languages.
  7451. cache_clear_all('entity_info:', 'cache', TRUE);
  7452. }
  7453. /**
  7454. * Helper function to extract id, vid, and bundle name from an entity.
  7455. *
  7456. * @param $entity_type
  7457. * The entity type; e.g. 'node' or 'user'.
  7458. * @param $entity
  7459. * The entity from which to extract values.
  7460. *
  7461. * @return
  7462. * A numerically indexed array (not a hash table) containing these
  7463. * elements:
  7464. * - 0: Primary ID of the entity.
  7465. * - 1: Revision ID of the entity, or NULL if $entity_type is not versioned.
  7466. * - 2: Bundle name of the entity, or NULL if $entity_type has no bundles.
  7467. */
  7468. function entity_extract_ids($entity_type, $entity) {
  7469. $info = entity_get_info($entity_type);
  7470. // Objects being created might not have id/vid yet.
  7471. $id = isset($entity->{$info['entity keys']['id']}) ? $entity->{$info['entity keys']['id']} : NULL;
  7472. $vid = ($info['entity keys']['revision'] && isset($entity->{$info['entity keys']['revision']})) ? $entity->{$info['entity keys']['revision']} : NULL;
  7473. if (!empty($info['entity keys']['bundle'])) {
  7474. // Explicitly fail for malformed entities missing the bundle property.
  7475. if (!isset($entity->{$info['entity keys']['bundle']}) || $entity->{$info['entity keys']['bundle']} === '') {
  7476. throw new EntityMalformedException(t('Missing bundle property on entity of type @entity_type.', array('@entity_type' => $entity_type)));
  7477. }
  7478. $bundle = $entity->{$info['entity keys']['bundle']};
  7479. }
  7480. else {
  7481. // The entity type provides no bundle key: assume a single bundle, named
  7482. // after the entity type.
  7483. $bundle = $entity_type;
  7484. }
  7485. return array($id, $vid, $bundle);
  7486. }
  7487. /**
  7488. * Helper function to assemble an object structure with initial ids.
  7489. *
  7490. * This function can be seen as reciprocal to entity_extract_ids().
  7491. *
  7492. * @param $entity_type
  7493. * The entity type; e.g. 'node' or 'user'.
  7494. * @param $ids
  7495. * A numerically indexed array, as returned by entity_extract_ids().
  7496. *
  7497. * @return
  7498. * An entity structure, initialized with the ids provided.
  7499. *
  7500. * @see entity_extract_ids()
  7501. */
  7502. function entity_create_stub_entity($entity_type, $ids) {
  7503. $entity = new stdClass();
  7504. $info = entity_get_info($entity_type);
  7505. $entity->{$info['entity keys']['id']} = $ids[0];
  7506. if (!empty($info['entity keys']['revision']) && isset($ids[1])) {
  7507. $entity->{$info['entity keys']['revision']} = $ids[1];
  7508. }
  7509. if (!empty($info['entity keys']['bundle']) && isset($ids[2])) {
  7510. $entity->{$info['entity keys']['bundle']} = $ids[2];
  7511. }
  7512. return $entity;
  7513. }
  7514. /**
  7515. * Load entities from the database.
  7516. *
  7517. * The entities are stored in a static memory cache, and will not require
  7518. * database access if loaded again during the same page request.
  7519. *
  7520. * The actual loading is done through a class that has to implement the
  7521. * DrupalEntityControllerInterface interface. By default,
  7522. * DrupalDefaultEntityController is used. Entity types can specify that a
  7523. * different class should be used by setting the 'controller class' key in
  7524. * hook_entity_info(). These classes can either implement the
  7525. * DrupalEntityControllerInterface interface, or, most commonly, extend the
  7526. * DrupalDefaultEntityController class. See node_entity_info() and the
  7527. * NodeController in node.module as an example.
  7528. *
  7529. * @param $entity_type
  7530. * The entity type to load, e.g. node or user.
  7531. * @param $ids
  7532. * An array of entity IDs, or FALSE to load all entities.
  7533. * @param $conditions
  7534. * (deprecated) An associative array of conditions on the base table, where
  7535. * the keys are the database fields and the values are the values those
  7536. * fields must have. Instead, it is preferable to use EntityFieldQuery to
  7537. * retrieve a list of entity IDs loadable by this function.
  7538. * @param $reset
  7539. * Whether to reset the internal cache for the requested entity type.
  7540. *
  7541. * @return
  7542. * An array of entity objects indexed by their ids. When no results are
  7543. * found, an empty array is returned.
  7544. *
  7545. * @todo Remove $conditions in Drupal 8.
  7546. *
  7547. * @see hook_entity_info()
  7548. * @see DrupalEntityControllerInterface
  7549. * @see DrupalDefaultEntityController
  7550. * @see EntityFieldQuery
  7551. */
  7552. function entity_load($entity_type, $ids = FALSE, $conditions = array(), $reset = FALSE) {
  7553. if ($reset) {
  7554. entity_get_controller($entity_type)->resetCache();
  7555. }
  7556. return entity_get_controller($entity_type)->load($ids, $conditions);
  7557. }
  7558. /**
  7559. * Loads the unchanged, i.e. not modified, entity from the database.
  7560. *
  7561. * Unlike entity_load() this function ensures the entity is directly loaded from
  7562. * the database, thus bypassing any static cache. In particular, this function
  7563. * is useful to determine changes by comparing the entity being saved to the
  7564. * stored entity.
  7565. *
  7566. * @param $entity_type
  7567. * The entity type to load, e.g. node or user.
  7568. * @param $id
  7569. * The ID of the entity to load.
  7570. *
  7571. * @return
  7572. * The unchanged entity, or FALSE if the entity cannot be loaded.
  7573. */
  7574. function entity_load_unchanged($entity_type, $id) {
  7575. entity_get_controller($entity_type)->resetCache(array($id));
  7576. $result = entity_get_controller($entity_type)->load(array($id));
  7577. return reset($result);
  7578. }
  7579. /**
  7580. * Gets the entity controller for an entity type.
  7581. *
  7582. * @return DrupalEntityControllerInterface
  7583. * The entity controller object for the specified entity type.
  7584. */
  7585. function entity_get_controller($entity_type) {
  7586. $controllers = &drupal_static(__FUNCTION__, array());
  7587. if (!isset($controllers[$entity_type])) {
  7588. $type_info = entity_get_info($entity_type);
  7589. $class = $type_info['controller class'];
  7590. $controllers[$entity_type] = new $class($entity_type);
  7591. }
  7592. return $controllers[$entity_type];
  7593. }
  7594. /**
  7595. * Invoke hook_entity_prepare_view().
  7596. *
  7597. * If adding a new entity similar to nodes, comments or users, you should
  7598. * invoke this function during the ENTITY_build_content() or
  7599. * ENTITY_view_multiple() phases of rendering to allow other modules to alter
  7600. * the objects during this phase. This is needed for situations where
  7601. * information needs to be loaded outside of ENTITY_load() - particularly
  7602. * when loading entities into one another - i.e. a user object into a node, due
  7603. * to the potential for unwanted side-effects such as caching and infinite
  7604. * recursion. By convention, entity_prepare_view() is called after
  7605. * field_attach_prepare_view() to allow entity level hooks to act on content
  7606. * loaded by field API.
  7607. *
  7608. * @param $entity_type
  7609. * The type of entity, i.e. 'node', 'user'.
  7610. * @param $entities
  7611. * The entity objects which are being prepared for view, keyed by object ID.
  7612. * @param $langcode
  7613. * (optional) A language code to be used for rendering. Defaults to the global
  7614. * content language of the current request.
  7615. *
  7616. * @see hook_entity_prepare_view()
  7617. */
  7618. function entity_prepare_view($entity_type, $entities, $langcode = NULL) {
  7619. if (!isset($langcode)) {
  7620. $langcode = $GLOBALS['language_content']->language;
  7621. }
  7622. // To ensure hooks are only run once per entity, check for an
  7623. // entity_view_prepared flag and only process items without it.
  7624. // @todo: resolve this more generally for both entity and field level hooks.
  7625. $prepare = array();
  7626. foreach ($entities as $id => $entity) {
  7627. if (empty($entity->entity_view_prepared)) {
  7628. // Add this entity to the items to be prepared.
  7629. $prepare[$id] = $entity;
  7630. // Mark this item as prepared.
  7631. $entity->entity_view_prepared = TRUE;
  7632. }
  7633. }
  7634. if (!empty($prepare)) {
  7635. module_invoke_all('entity_prepare_view', $prepare, $entity_type, $langcode);
  7636. }
  7637. }
  7638. /**
  7639. * Invoke hook_entity_view_mode_alter().
  7640. *
  7641. * If adding a new entity similar to nodes, comments or users, you should invoke
  7642. * this function during the ENTITY_build_content() or ENTITY_view_multiple()
  7643. * phases of rendering to allow other modules to alter the view mode during this
  7644. * phase. This function needs to be called before field_attach_prepare_view() to
  7645. * ensure that the correct content is loaded by field API.
  7646. *
  7647. * @param $entity_type
  7648. * The type of entity, i.e. 'node', 'user'.
  7649. * @param $entities
  7650. * The entity objects which are being prepared for view, keyed by object ID.
  7651. * @param $view_mode
  7652. * The original view mode e.g. 'full', 'teaser'...
  7653. * @param $langcode
  7654. * (optional) A language code to be used for rendering. Defaults to the global
  7655. * content language of the current request.
  7656. * @return
  7657. * An associative array with arrays of entities keyed by view mode.
  7658. *
  7659. * @see hook_entity_view_mode_alter()
  7660. */
  7661. function entity_view_mode_prepare($entity_type, $entities, $view_mode, $langcode = NULL) {
  7662. if (!isset($langcode)) {
  7663. $langcode = $GLOBALS['language_content']->language;
  7664. }
  7665. // To ensure hooks are never run after field_attach_prepare_view() only
  7666. // process items without the entity_view_prepared flag.
  7667. $entities_by_view_mode = array();
  7668. foreach ($entities as $id => $entity) {
  7669. $entity_view_mode = $view_mode;
  7670. if (empty($entity->entity_view_prepared)) {
  7671. // Allow modules to change the view mode.
  7672. $context = array(
  7673. 'entity_type' => $entity_type,
  7674. 'entity' => $entity,
  7675. 'langcode' => $langcode,
  7676. );
  7677. drupal_alter('entity_view_mode', $entity_view_mode, $context);
  7678. }
  7679. $entities_by_view_mode[$entity_view_mode][$id] = $entity;
  7680. }
  7681. return $entities_by_view_mode;
  7682. }
  7683. /**
  7684. * Returns the URI elements of an entity.
  7685. *
  7686. * @param $entity_type
  7687. * The entity type; e.g. 'node' or 'user'.
  7688. * @param $entity
  7689. * The entity for which to generate a path.
  7690. * @return
  7691. * An array containing the 'path' and 'options' keys used to build the URI of
  7692. * the entity, and matching the signature of url(). NULL if the entity has no
  7693. * URI of its own.
  7694. */
  7695. function entity_uri($entity_type, $entity) {
  7696. $info = entity_get_info($entity_type);
  7697. list($id, $vid, $bundle) = entity_extract_ids($entity_type, $entity);
  7698. // A bundle-specific callback takes precedence over the generic one for the
  7699. // entity type.
  7700. if (isset($info['bundles'][$bundle]['uri callback'])) {
  7701. $uri_callback = $info['bundles'][$bundle]['uri callback'];
  7702. }
  7703. elseif (isset($info['uri callback'])) {
  7704. $uri_callback = $info['uri callback'];
  7705. }
  7706. else {
  7707. return NULL;
  7708. }
  7709. // Invoke the callback to get the URI. If there is no callback, return NULL.
  7710. if (isset($uri_callback) && function_exists($uri_callback)) {
  7711. $uri = $uri_callback($entity);
  7712. // Pass the entity data to url() so that alter functions do not need to
  7713. // lookup this entity again.
  7714. $uri['options']['entity_type'] = $entity_type;
  7715. $uri['options']['entity'] = $entity;
  7716. return $uri;
  7717. }
  7718. }
  7719. /**
  7720. * Returns the label of an entity.
  7721. *
  7722. * See the 'label callback' component of the hook_entity_info() return value
  7723. * for more information.
  7724. *
  7725. * @param $entity_type
  7726. * The entity type; e.g., 'node' or 'user'.
  7727. * @param $entity
  7728. * The entity for which to generate the label.
  7729. *
  7730. * @return
  7731. * The entity label, or FALSE if not found.
  7732. */
  7733. function entity_label($entity_type, $entity) {
  7734. $label = FALSE;
  7735. $info = entity_get_info($entity_type);
  7736. if (isset($info['label callback']) && function_exists($info['label callback'])) {
  7737. $label = $info['label callback']($entity, $entity_type);
  7738. }
  7739. elseif (!empty($info['entity keys']['label']) && isset($entity->{$info['entity keys']['label']})) {
  7740. $label = $entity->{$info['entity keys']['label']};
  7741. }
  7742. return $label;
  7743. }
  7744. /**
  7745. * Returns the language of an entity.
  7746. *
  7747. * @param $entity_type
  7748. * The entity type; e.g., 'node' or 'user'.
  7749. * @param $entity
  7750. * The entity for which to get the language.
  7751. *
  7752. * @return
  7753. * A valid language code or NULL if the entity has no language support.
  7754. */
  7755. function entity_language($entity_type, $entity) {
  7756. $info = entity_get_info($entity_type);
  7757. // Invoke the callback to get the language. If there is no callback, try to
  7758. // get it from a property of the entity, otherwise NULL.
  7759. if (isset($info['language callback']) && function_exists($info['language callback'])) {
  7760. $langcode = $info['language callback']($entity_type, $entity);
  7761. }
  7762. elseif (!empty($info['entity keys']['language']) && isset($entity->{$info['entity keys']['language']})) {
  7763. $langcode = $entity->{$info['entity keys']['language']};
  7764. }
  7765. else {
  7766. // The value returned in D8 would be LANGUAGE_NONE, we cannot use it here to
  7767. // preserve backward compatibility. In fact this function has been
  7768. // introduced very late in the D7 life cycle, mainly as the proper default
  7769. // for field_attach_form(). By returning LANGUAGE_NONE when no language
  7770. // information is available, we would introduce a potentially BC-breaking
  7771. // API change, since field_attach_form() defaults to the default language
  7772. // instead of LANGUAGE_NONE. Moreover this allows us to distinguish between
  7773. // entities that have no language specified from ones that do not have
  7774. // language support at all.
  7775. $langcode = NULL;
  7776. }
  7777. return $langcode;
  7778. }
  7779. /**
  7780. * Attaches field API validation to entity forms.
  7781. */
  7782. function entity_form_field_validate($entity_type, $form, &$form_state) {
  7783. // All field attach API functions act on an entity object, but during form
  7784. // validation, we don't have one. $form_state contains the entity as it was
  7785. // prior to processing the current form submission, and we must not update it
  7786. // until we have fully validated the submitted input. Therefore, for
  7787. // validation, act on a pseudo entity created out of the form values.
  7788. $pseudo_entity = (object) $form_state['values'];
  7789. field_attach_form_validate($entity_type, $pseudo_entity, $form, $form_state);
  7790. }
  7791. /**
  7792. * Copies submitted values to entity properties for simple entity forms.
  7793. *
  7794. * During the submission handling of an entity form's "Save", "Preview", and
  7795. * possibly other buttons, the form state's entity needs to be updated with the
  7796. * submitted form values. Each entity form implements its own builder function
  7797. * for doing this, appropriate for the particular entity and form, whereas
  7798. * modules may specify additional builder functions in $form['#entity_builders']
  7799. * for copying the form values of added form elements to entity properties.
  7800. * Many of the main entity builder functions can call this helper function to
  7801. * re-use its logic of copying $form_state['values'][PROPERTY] values to
  7802. * $entity->PROPERTY for all entries in $form_state['values'] that are not field
  7803. * data, and calling field_attach_submit() to copy field data. Apart from that
  7804. * this helper invokes any additional builder functions that have been specified
  7805. * in $form['#entity_builders'].
  7806. *
  7807. * For some entity forms (e.g., forms with complex non-field data and forms that
  7808. * simultaneously edit multiple entities), this behavior may be inappropriate,
  7809. * so the builder function for such forms needs to implement the required
  7810. * functionality instead of calling this function.
  7811. */
  7812. function entity_form_submit_build_entity($entity_type, $entity, $form, &$form_state) {
  7813. $info = entity_get_info($entity_type);
  7814. list(, , $bundle) = entity_extract_ids($entity_type, $entity);
  7815. // Copy top-level form values that are not for fields to entity properties,
  7816. // without changing existing entity properties that are not being edited by
  7817. // this form. Copying field values must be done using field_attach_submit().
  7818. $values_excluding_fields = $info['fieldable'] ? array_diff_key($form_state['values'], field_info_instances($entity_type, $bundle)) : $form_state['values'];
  7819. foreach ($values_excluding_fields as $key => $value) {
  7820. $entity->$key = $value;
  7821. }
  7822. // Invoke all specified builders for copying form values to entity properties.
  7823. if (isset($form['#entity_builders'])) {
  7824. foreach ($form['#entity_builders'] as $function) {
  7825. $function($entity_type, $entity, $form, $form_state);
  7826. }
  7827. }
  7828. // Copy field values to the entity.
  7829. if ($info['fieldable']) {
  7830. field_attach_submit($entity_type, $entity, $form, $form_state);
  7831. }
  7832. }
  7833. /**
  7834. * Performs one or more XML-RPC request(s).
  7835. *
  7836. * Usage example:
  7837. * @code
  7838. * $result = xmlrpc('http://example.com/xmlrpc.php', array(
  7839. * 'service.methodName' => array($parameter, $second, $third),
  7840. * ));
  7841. * @endcode
  7842. *
  7843. * @param $url
  7844. * An absolute URL of the XML-RPC endpoint.
  7845. * @param $args
  7846. * An associative array whose keys are the methods to call and whose values
  7847. * are the arguments to pass to the respective method. If multiple methods
  7848. * are specified, a system.multicall is performed.
  7849. * @param $options
  7850. * (optional) An array of options to pass along to drupal_http_request().
  7851. *
  7852. * @return
  7853. * For one request:
  7854. * Either the return value of the method on success, or FALSE.
  7855. * If FALSE is returned, see xmlrpc_errno() and xmlrpc_error_msg().
  7856. * For multiple requests:
  7857. * An array of results. Each result will either be the result
  7858. * returned by the method called, or an xmlrpc_error object if the call
  7859. * failed. See xmlrpc_error().
  7860. */
  7861. function xmlrpc($url, $args, $options = array()) {
  7862. require_once DRUPAL_ROOT . '/includes/xmlrpc.inc';
  7863. return _xmlrpc($url, $args, $options);
  7864. }
  7865. /**
  7866. * Retrieves a list of all available archivers.
  7867. *
  7868. * @see hook_archiver_info()
  7869. * @see hook_archiver_info_alter()
  7870. */
  7871. function archiver_get_info() {
  7872. $archiver_info = &drupal_static(__FUNCTION__, array());
  7873. if (empty($archiver_info)) {
  7874. $cache = cache_get('archiver_info');
  7875. if ($cache === FALSE) {
  7876. // Rebuild the cache and save it.
  7877. $archiver_info = module_invoke_all('archiver_info');
  7878. drupal_alter('archiver_info', $archiver_info);
  7879. uasort($archiver_info, 'drupal_sort_weight');
  7880. cache_set('archiver_info', $archiver_info);
  7881. }
  7882. else {
  7883. $archiver_info = $cache->data;
  7884. }
  7885. }
  7886. return $archiver_info;
  7887. }
  7888. /**
  7889. * Returns a string of supported archive extensions.
  7890. *
  7891. * @return
  7892. * A space-separated string of extensions suitable for use by the file
  7893. * validation system.
  7894. */
  7895. function archiver_get_extensions() {
  7896. $valid_extensions = array();
  7897. foreach (archiver_get_info() as $archive) {
  7898. foreach ($archive['extensions'] as $extension) {
  7899. foreach (explode('.', $extension) as $part) {
  7900. if (!in_array($part, $valid_extensions)) {
  7901. $valid_extensions[] = $part;
  7902. }
  7903. }
  7904. }
  7905. }
  7906. return implode(' ', $valid_extensions);
  7907. }
  7908. /**
  7909. * Creates the appropriate archiver for the specified file.
  7910. *
  7911. * @param $file
  7912. * The full path of the archive file. Note that stream wrapper paths are
  7913. * supported, but not remote ones.
  7914. *
  7915. * @return
  7916. * A newly created instance of the archiver class appropriate
  7917. * for the specified file, already bound to that file.
  7918. * If no appropriate archiver class was found, will return FALSE.
  7919. */
  7920. function archiver_get_archiver($file) {
  7921. // Archivers can only work on local paths
  7922. $filepath = drupal_realpath($file);
  7923. if (!is_file($filepath)) {
  7924. throw new Exception(t('Archivers can only operate on local files: %file not supported', array('%file' => $file)));
  7925. }
  7926. $archiver_info = archiver_get_info();
  7927. foreach ($archiver_info as $implementation) {
  7928. foreach ($implementation['extensions'] as $extension) {
  7929. // Because extensions may be multi-part, such as .tar.gz,
  7930. // we cannot use simpler approaches like substr() or pathinfo().
  7931. // This method isn't quite as clean but gets the job done.
  7932. // Also note that the file may not yet exist, so we cannot rely
  7933. // on fileinfo() or other disk-level utilities.
  7934. if (strrpos($filepath, '.' . $extension) === strlen($filepath) - strlen('.' . $extension)) {
  7935. return new $implementation['class']($filepath);
  7936. }
  7937. }
  7938. }
  7939. }
  7940. /**
  7941. * Assembles the Drupal Updater registry.
  7942. *
  7943. * An Updater is a class that knows how to update various parts of the Drupal
  7944. * file system, for example to update modules that have newer releases, or to
  7945. * install a new theme.
  7946. *
  7947. * @return
  7948. * The Drupal Updater class registry.
  7949. *
  7950. * @see hook_updater_info()
  7951. * @see hook_updater_info_alter()
  7952. */
  7953. function drupal_get_updaters() {
  7954. $updaters = &drupal_static(__FUNCTION__);
  7955. if (!isset($updaters)) {
  7956. $updaters = module_invoke_all('updater_info');
  7957. drupal_alter('updater_info', $updaters);
  7958. uasort($updaters, 'drupal_sort_weight');
  7959. }
  7960. return $updaters;
  7961. }
  7962. /**
  7963. * Assembles the Drupal FileTransfer registry.
  7964. *
  7965. * @return
  7966. * The Drupal FileTransfer class registry.
  7967. *
  7968. * @see FileTransfer
  7969. * @see hook_filetransfer_info()
  7970. * @see hook_filetransfer_info_alter()
  7971. */
  7972. function drupal_get_filetransfer_info() {
  7973. $info = &drupal_static(__FUNCTION__);
  7974. if (!isset($info)) {
  7975. // Since we have to manually set the 'file path' default for each
  7976. // module separately, we can't use module_invoke_all().
  7977. $info = array();
  7978. foreach (module_implements('filetransfer_info') as $module) {
  7979. $function = $module . '_filetransfer_info';
  7980. if (function_exists($function)) {
  7981. $result = $function();
  7982. if (isset($result) && is_array($result)) {
  7983. foreach ($result as &$values) {
  7984. if (empty($values['file path'])) {
  7985. $values['file path'] = drupal_get_path('module', $module);
  7986. }
  7987. }
  7988. $info = array_merge_recursive($info, $result);
  7989. }
  7990. }
  7991. }
  7992. drupal_alter('filetransfer_info', $info);
  7993. uasort($info, 'drupal_sort_weight');
  7994. }
  7995. return $info;
  7996. }